MediaControl
MediaControl
MediaControl
MediaControl
Class
Definition
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Describes the object that applications register with, to receive media focus and transport control notifications.
public : static class MediaControlpublic static class MediaControlPublic Static Class MediaControl// You can use this class in JavaScript.
- Attributes
| Device family |
Windows Desktop Extension SDK (introduced v10.0.10240.0)
Xbox One Extensions for the UWP (introduced v10.0.10586.0)
|
| API contract |
Windows.Media.MediaControlContract (introduced v1)
|
Remarks
The MediaControl class provides access to button press events. These events can be monitored, and can modify the response and behavior of an audio-aware app. Here is a JavaScript code snippet that shows how to add event listeners to a MediaControl object. It then shows how to write code to handle those events.
// Assign the Windows.Media.MediaControl button object to
// the user-defined mediaControls variable
mediaControls = Windows.Media.MediaControl;
// Add event listeners for the buttons
mediaControls.addEventListener(“PlayPressed”, play, false);
mediaControls.addEventListener(“PausePressed”, pause, false);
mediaControls.addEventListener(“PlayPauseTogglePressed”, playpausetoggle, false);
mediaControls.addEventListener(“NextTrackPressed”, nexttrack, false);
mediaControls.addEventListener(“PreviousTrackPressed”, previoustrack, false);
mediaControls.addEventListener(“SoundLevelChanged”, soundlevelchanged, false);
// Add code for event handlers for the events
function play() {
document.getElementById(“audiotag”).play();
}
function pause() {
document.getElementById(“audiotag”).pause();
}
function playpausetoggle() {
//<code goes here to handle the PlayPauseToggle event>
}
...
// Additional code to handle the other events
To see the complete listing for this example, see How to configure keys for media controls.
Properties
AlbumArt AlbumArt AlbumArt AlbumArt
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Gets or sets the path to the artwork for the album cover.
public : static Uri AlbumArt { get; set; }public static Uri AlbumArt { get; set; }Public Static ReadWrite Property AlbumArt As Uri// You can use this property in JavaScript.
- Value
- Uri Uri Uri Uri
Path to the artwork for the album cover.
Remarks
If you provide an invalid path for the album art property, it will cause an exception to be thrown. The only valid URI formats are ms-appx:// and ms-appdata://.
ArtistName ArtistName ArtistName ArtistName
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Gets or sets the name of the artist.
public : static PlatForm::String ArtistName { get; set; }public static string ArtistName { get; set; }Public Static ReadWrite Property ArtistName As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The name of the artist.
IsPlaying IsPlaying IsPlaying IsPlaying
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Gets or sets the state of the Play button.
public : static PlatForm::Boolean IsPlaying { get; set; }public static bool IsPlaying { get; set; }Public Static ReadWrite Property IsPlaying As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
The state of the Play button.
Remarks
IsPlaying is a Boolean value that indicates the state of the Play button. You can retrieve or set this value. You can also use the current value to make programmatic decisions about the behavior of the app.
- See Also
SoundLevel SoundLevel SoundLevel SoundLevel
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Gets the current sound level.
public : static SoundLevel SoundLevel { get; }public static SoundLevel SoundLevel { get; }Public Static ReadOnly Property SoundLevel As SoundLevel// You can use this property in JavaScript.
The current sound level.
Remarks
Note that the sound level of an application is tied to the state of its render streams only, and not to the states of its capture or loopback streams.
- See Also
TrackName TrackName TrackName TrackName
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Gets or sets the track name.
public : static PlatForm::String TrackName { get; set; }public static string TrackName { get; set; }Public Static ReadWrite Property TrackName As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The name of the track.
Events
ChannelDownPressed ChannelDownPressed ChannelDownPressed ChannelDownPressed
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Event raised when a ChannelDown command is issued to the application.
public : static event EventHandler ChannelDownPressed<object>public static event EventHandler ChannelDownPressed<object>Public Static Event ChannelDownPressed<object>// You can use this event in JavaScript.
ChannelUpPressed ChannelUpPressed ChannelUpPressed ChannelUpPressed
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Event raised when a ChannelUp command is issued to the application.
public : static event EventHandler ChannelUpPressed<object>public static event EventHandler ChannelUpPressed<object>Public Static Event ChannelUpPressed<object>// You can use this event in JavaScript.
FastForwardPressed FastForwardPressed FastForwardPressed FastForwardPressed
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Event raised when a FastForward command is issued to the application.
public : static event EventHandler FastForwardPressed<object>public static event EventHandler FastForwardPressed<object>Public Static Event FastForwardPressed<object>// You can use this event in JavaScript.
NextTrackPressed NextTrackPressed NextTrackPressed NextTrackPressed
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Event raised when a NextTrack command is issued to the application.
public : static event EventHandler NextTrackPressed<object>public static event EventHandler NextTrackPressed<object>Public Static Event NextTrackPressed<object>// You can use this event in JavaScript.
- See Also
PausePressed PausePressed PausePressed PausePressed
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Event raised when a Pause command is issued to the application.
public : static event EventHandler PausePressed<object>public static event EventHandler PausePressed<object>Public Static Event PausePressed<object>// You can use this event in JavaScript.
- See Also
PlayPauseTogglePressed PlayPauseTogglePressed PlayPauseTogglePressed PlayPauseTogglePressed
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Event raised when a PlayPauseToggle command is issued to the application.
public : static event EventHandler PlayPauseTogglePressed<object>public static event EventHandler PlayPauseTogglePressed<object>Public Static Event PlayPauseTogglePressed<object>// You can use this event in JavaScript.
- See Also
PlayPressed PlayPressed PlayPressed PlayPressed
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Event raised when a Play command is issued to the application.
public : static event EventHandler PlayPressed<object>public static event EventHandler PlayPressed<object>Public Static Event PlayPressed<object>// You can use this event in JavaScript.
- See Also
PreviousTrackPressed PreviousTrackPressed PreviousTrackPressed PreviousTrackPressed
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Event raised when a PreviousTrack command is issued to the application.
public : static event EventHandler PreviousTrackPressed<object>public static event EventHandler PreviousTrackPressed<object>Public Static Event PreviousTrackPressed<object>// You can use this event in JavaScript.
- See Also
RecordPressed RecordPressed RecordPressed RecordPressed
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Event raised when a Record command is issued to the application.
public : static event EventHandler RecordPressed<object>public static event EventHandler RecordPressed<object>Public Static Event RecordPressed<object>// You can use this event in JavaScript.
RewindPressed RewindPressed RewindPressed RewindPressed
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Event raised when a Rewind command is issued to the application.
public : static event EventHandler RewindPressed<object>public static event EventHandler RewindPressed<object>Public Static Event RewindPressed<object>// You can use this event in JavaScript.
SoundLevelChanged SoundLevelChanged SoundLevelChanged SoundLevelChanged
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Event raised when the sound level changes.
public : static event EventHandler SoundLevelChanged<object>public static event EventHandler SoundLevelChanged<object>Public Static Event SoundLevelChanged<object>// You can use this event in JavaScript.
- See Also
StopPressed StopPressed StopPressed StopPressed
Note
MediaControl may be altered or unavailable for releases after Windows 8.1. Instead, use SystemMediaTransportControls.
Event raised when a Stop command is issued to the application.
public : static event EventHandler StopPressed<object>public static event EventHandler StopPressed<object>Public Static Event StopPressed<object>// You can use this event in JavaScript.