IWMPControls::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
public void pause();
Public Sub pause()
Implements IWMPControls.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.
To determine whether a particular media type can be paused, pass the System.String value "pause" to the IWMPControls.isAvailable property (the IWMPControls.get_isAvailable method in C#).
Examples
The following example uses pause to pause playback of the current media item in response to the Click event of a button. The AxWMPLib.AxWindowsMediaPlayer object is represented by the variable named player.
private void pauseButton_Click(object o, System.EventArgs args)
{
// To get all of the available functionality of the player controls, cast the
// value returned by player.Ctlcontrols to a WMPLib.IWMPControls3 interface.
WMPLib.IWMPControls3 controls = (WMPLib.IWMPControls3)player.Ctlcontrols;
// Check first to be sure the operation is valid.
if (controls.get_isAvailable("pause"))
{
controls.pause();
}
}
Public Sub pauseButton_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles pauseButton.Click
' To get all of the available functionality of the player controls, Dim the
' value returned by player.Ctlcontrols as a WMPLib.IWMPControls3 interface.
Dim controls As WMPLib.IWMPControls3 = player.Ctlcontrols
' Check first to be sure the operation is valid.
If (controls.isAvailable("pause")) Then
controls.pause()
End If
End Sub
Requirements
| Requirement | Value |
|---|---|
| Version |
Windows Media Player 9 Series or later |
| Namespace |
WMPLib |
| Assembly |
|