MediaControl 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 MediaControl
static struct winrt::Windows::Media::MediaControl
public static class MediaControl
Public Shared Class MediaControl
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
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 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.

ArtistName 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.

IsPlaying 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.

SoundLevel 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.

TrackName 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.

Events

ChannelDownPressed 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.

ChannelUpPressed 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.

FastForwardPressed 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.

NextTrackPressed 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.

PausePressed 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.

PlayPauseTogglePressed 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.

PlayPressed 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.

PreviousTrackPressed 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.

RecordPressed 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.

RewindPressed 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.

SoundLevelChanged 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.

StopPressed 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.

See Also