Controls.pause method

[The feature associated with this page, Windows Media Player SDK, is a legacy feature. It has been superseded by MediaPlayer. MediaPlayer has been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer instead of Windows Media Player SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The pause method pauses playback of the media item.

Syntax

Controls.pause()

Parameters

This method has no parameters.

Return value

This method does not return a value.

Remarks

When a file is paused, Windows Media Player does not give up any system resources, such as the audio device.

Certain media types cannot be paused, such as live streams. To determine whether a particular media type can be paused, use Controls.isAvailable('Pause').

Examples

The following example creates an HTML BUTTON element that uses pause to pause playback. The Player object was created with ID = "Player".

<INPUT TYPE = "BUTTON"  ID = "PAUSE"  NAME = "PAUSE"  VALUE = "||"
    onClick = "

        /* Check first to be sure the operation is valid. */
        if (Player.controls.isAvailable('Pause'))

            /* Pause the Player. */
            Player.controls.pause();
">

Requirements

See also

Controls Object

Controls.isAvailable