MediaPlaybackCommandManager
MediaPlaybackCommandManager
MediaPlaybackCommandManager
MediaPlaybackCommandManager
Class
Definition
Specifies the behavior of and receives events from the System Media Transport Controls. Use this class to customize the interaction between a MediaPlayer and the System Media Transport Controls.
public : sealed class MediaPlaybackCommandManager : IMediaPlaybackCommandManagerpublic sealed class MediaPlaybackCommandManager : IMediaPlaybackCommandManagerPublic NotInheritable Class MediaPlaybackCommandManager Implements IMediaPlaybackCommandManager// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Remarks
Get an instance of the MediaPlaybackCommandManager by accessing the CommandManager property of a MediaPlayer object.
For how-to guidance for integrating with the SMTC, see Integrate with the System Media Transport Controls.
Properties
AutoRepeatModeBehavior AutoRepeatModeBehavior AutoRepeatModeBehavior AutoRepeatModeBehavior
Gets an object that defines the behavior when the Auto-repeat control in the System Media Transport Controls is toggled.
public : MediaPlaybackCommandManagerCommandBehavior AutoRepeatModeBehavior { get; }public MediaPlaybackCommandManagerCommandBehavior AutoRepeatModeBehavior { get; }Public ReadOnly Property AutoRepeatModeBehavior As MediaPlaybackCommandManagerCommandBehavior// You can use this property in JavaScript.
- Value
- MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior
An object that defines the behavior when the Auto-repeat control is toggled.
FastForwardBehavior FastForwardBehavior FastForwardBehavior FastForwardBehavior
Gets an object that defines the behavior when the Fast-forward button in the System Media Transport Controls is tapped.
public : MediaPlaybackCommandManagerCommandBehavior FastForwardBehavior { get; }public MediaPlaybackCommandManagerCommandBehavior FastForwardBehavior { get; }Public ReadOnly Property FastForwardBehavior As MediaPlaybackCommandManagerCommandBehavior// You can use this property in JavaScript.
- Value
- MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior
An object that defines the behavior when the Fast-forward button is tapped.
IsEnabled IsEnabled IsEnabled IsEnabled
Gets or sets a value indicating whether the MediaPlaybackCommandManager is enabled.
public : PlatForm::Boolean IsEnabled { get; set; }public bool IsEnabled { get; set; }Public ReadWrite Property IsEnabled As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
True if the MediaPlaybackCommandManager is enabled; otherwise, false.
Remarks
If your app scenario requires manual control of the System Media Transport Controls you can disable the MediaPlaybackCommandManager and using the events and properties of the SystemMediaTransportControls directly.
Note
If you disable the MediaPlaybackCommandManager by setting IsEnabled to false, it will break the link between the MediaPlayer the TransportControls provided by the MediaPlayerElement, so the built-in transport controls will no longer automatically control the playback of the player. Instead, you must implement your own controls to control the MediaPlayer.
MediaPlayer MediaPlayer MediaPlayer MediaPlayer
Gets the MediaPlayer instance associated with the MediaPlaybackCommandManager.
public : MediaPlayer MediaPlayer { get; }public MediaPlayer MediaPlayer { get; }Public ReadOnly Property MediaPlayer As MediaPlayer// You can use this property in JavaScript.
The MediaPlayer instance associated with the MediaPlaybackCommandManager.
Remarks
You get an instance of the MediaPlaybackCommandManager by accessing the CommandManager property of a MediaPlayer object. This property gives you a reference to the media player from which the command manager was obtained.
NextBehavior NextBehavior NextBehavior NextBehavior
Gets an object that defines the behavior when the Next button in the System Media Transport Controls is tapped.
public : MediaPlaybackCommandManagerCommandBehavior NextBehavior { get; }public MediaPlaybackCommandManagerCommandBehavior NextBehavior { get; }Public ReadOnly Property NextBehavior As MediaPlaybackCommandManagerCommandBehavior// You can use this property in JavaScript.
- Value
- MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior
An object that defines the behavior when the Next button is tapped.
PauseBehavior PauseBehavior PauseBehavior PauseBehavior
Gets an object that defines the behavior when the Pause button in the System Media Transport Controls is tapped.
public : MediaPlaybackCommandManagerCommandBehavior PauseBehavior { get; }public MediaPlaybackCommandManagerCommandBehavior PauseBehavior { get; }Public ReadOnly Property PauseBehavior As MediaPlaybackCommandManagerCommandBehavior// You can use this property in JavaScript.
- Value
- MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior
An object that defines the behavior when the Pause button is tapped.
PlayBehavior PlayBehavior PlayBehavior PlayBehavior
Gets an object that defines the behavior when the Play button in the System Media Transport Controls is tapped.
public : MediaPlaybackCommandManagerCommandBehavior PlayBehavior { get; }public MediaPlaybackCommandManagerCommandBehavior PlayBehavior { get; }Public ReadOnly Property PlayBehavior As MediaPlaybackCommandManagerCommandBehavior// You can use this property in JavaScript.
- Value
- MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior
An object that defines the behavior when the Pause button is tapped.
PositionBehavior PositionBehavior PositionBehavior PositionBehavior
Gets an object that defines the behavior when the playback position control in the System Media Transport Controls is moved.
public : MediaPlaybackCommandManagerCommandBehavior PositionBehavior { get; }public MediaPlaybackCommandManagerCommandBehavior PositionBehavior { get; }Public ReadOnly Property PositionBehavior As MediaPlaybackCommandManagerCommandBehavior// You can use this property in JavaScript.
- Value
- MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior
An object that defines the behavior when the playback position control is moved.
PreviousBehavior PreviousBehavior PreviousBehavior PreviousBehavior
Gets an object that defines the behavior when the Previous button in the System Media Transport Controls is tapped.
public : MediaPlaybackCommandManagerCommandBehavior PreviousBehavior { get; }public MediaPlaybackCommandManagerCommandBehavior PreviousBehavior { get; }Public ReadOnly Property PreviousBehavior As MediaPlaybackCommandManagerCommandBehavior// You can use this property in JavaScript.
- Value
- MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior
An object that defines the behavior when the Previous button is tapped.
RateBehavior RateBehavior RateBehavior RateBehavior
Gets an object that defines the behavior when the playback rate is changed using the System Media Transport Controls.
public : MediaPlaybackCommandManagerCommandBehavior RateBehavior { get; }public MediaPlaybackCommandManagerCommandBehavior RateBehavior { get; }Public ReadOnly Property RateBehavior As MediaPlaybackCommandManagerCommandBehavior// You can use this property in JavaScript.
- Value
- MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior
An object that defines the behavior when the playback rate is changed.
RewindBehavior RewindBehavior RewindBehavior RewindBehavior
Gets an object that defines the behavior when the Rewind button in the System Media Transport Controls is tapped.
public : MediaPlaybackCommandManagerCommandBehavior RewindBehavior { get; }public MediaPlaybackCommandManagerCommandBehavior RewindBehavior { get; }Public ReadOnly Property RewindBehavior As MediaPlaybackCommandManagerCommandBehavior// You can use this property in JavaScript.
- Value
- MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior
An object that defines the behavior when the Rewind button is tapped.
ShuffleBehavior ShuffleBehavior ShuffleBehavior ShuffleBehavior
Gets an object that defines the behavior when the Shuffle button in the System Media Transport Controls is toggled.
public : MediaPlaybackCommandManagerCommandBehavior ShuffleBehavior { get; }public MediaPlaybackCommandManagerCommandBehavior ShuffleBehavior { get; }Public ReadOnly Property ShuffleBehavior As MediaPlaybackCommandManagerCommandBehavior// You can use this property in JavaScript.
- Value
- MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior MediaPlaybackCommandManagerCommandBehavior
An object that defines the behavior when the Shuffle button is toggled.
Events
AutoRepeatModeReceived AutoRepeatModeReceived AutoRepeatModeReceived AutoRepeatModeReceived
Occurs when the command manager receives a command from the Auto-repeat control of the System Media Transport Controls.
public : event TypedEventHandler AutoRepeatModeReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs>public event TypedEventHandler AutoRepeatModeReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs>Public Event AutoRepeatModeReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerAutoRepeatModeReceivedEventArgs>// You can use this event in JavaScript.
FastForwardReceived FastForwardReceived FastForwardReceived FastForwardReceived
Occurs when the command manager receives a command from the Fast-forward button of the System Media Transport Controls.
public : event TypedEventHandler FastForwardReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerFastForwardReceivedEventArgs>public event TypedEventHandler FastForwardReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerFastForwardReceivedEventArgs>Public Event FastForwardReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerFastForwardReceivedEventArgs>// You can use this event in JavaScript.
NextReceived NextReceived NextReceived NextReceived
Occurs when the command manager receives a command from the Next button of the System Media Transport Controls.
public : event TypedEventHandler NextReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerNextReceivedEventArgs>public event TypedEventHandler NextReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerNextReceivedEventArgs>Public Event NextReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerNextReceivedEventArgs>// You can use this event in JavaScript.
PauseReceived PauseReceived PauseReceived PauseReceived
Occurs when the command manager receives a command from the Pause button of the System Media Transport Controls.
public : event TypedEventHandler PauseReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerPauseReceivedEventArgs>public event TypedEventHandler PauseReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerPauseReceivedEventArgs>Public Event PauseReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerPauseReceivedEventArgs>// You can use this event in JavaScript.
PlayReceived PlayReceived PlayReceived PlayReceived
Occurs when the command manager receives a command from the Play control of the System Media Transport Controls.
public : event TypedEventHandler PlayReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerPlayReceivedEventArgs>public event TypedEventHandler PlayReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerPlayReceivedEventArgs>Public Event PlayReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerPlayReceivedEventArgs>// You can use this event in JavaScript.
PositionReceived PositionReceived PositionReceived PositionReceived
Occurs when the command manager receives a command changing the current playback position from the System Media Transport Controls.
public : event TypedEventHandler PositionReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerPositionReceivedEventArgs>public event TypedEventHandler PositionReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerPositionReceivedEventArgs>Public Event PositionReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerPositionReceivedEventArgs>// You can use this event in JavaScript.
PreviousReceived PreviousReceived PreviousReceived PreviousReceived
Occurs when the command manager receives a command from the Previous button of the System Media Transport Controls.
public : event TypedEventHandler PreviousReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerPreviousReceivedEventArgs>public event TypedEventHandler PreviousReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerPreviousReceivedEventArgs>Public Event PreviousReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerPreviousReceivedEventArgs>// You can use this event in JavaScript.
RateReceived RateReceived RateReceived RateReceived
Occurs when the command manager receives a command changing the current playback rate from the System Media Transport Controls.
public : event TypedEventHandler RateReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerRateReceivedEventArgs>public event TypedEventHandler RateReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerRateReceivedEventArgs>Public Event RateReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerRateReceivedEventArgs>// You can use this event in JavaScript.
RewindReceived RewindReceived RewindReceived RewindReceived
Occurs when the command manager receives a command from the Rewind button of the System Media Transport Controls.
public : event TypedEventHandler RewindReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerRewindReceivedEventArgs>public event TypedEventHandler RewindReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerRewindReceivedEventArgs>Public Event RewindReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerRewindReceivedEventArgs>// You can use this event in JavaScript.
ShuffleReceived ShuffleReceived ShuffleReceived ShuffleReceived
Occurs when the command manager receives a command from the Shuffle control of the System Media Transport Controls.
public : event TypedEventHandler ShuffleReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerShuffleReceivedEventArgs>public event TypedEventHandler ShuffleReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerShuffleReceivedEventArgs>Public Event ShuffleReceived<MediaPlaybackCommandManager, MediaPlaybackCommandManagerShuffleReceivedEventArgs>// You can use this event in JavaScript.