MediaControl class (Windows)

1 out of 3 rated this helpful - Rate this topic

Describes the object that applications register with, to receive media focus and transport control notifications.

Syntax


var mediaControl = Windows.Media.MediaControl;

Attributes

MarshalingBehaviorAttribute(Agile)
StaticAttribute(Windows.Media.IMediaControl, NTDDI_WIN8)
ThreadingAttribute(MTA)
VersionAttribute(NTDDI_WIN8)

Members

The MediaControl class has these types of members:

Events
Methods
Properties

Events

The MediaControl class has these events.

Event	Description
ChannelDownPressed	Event raised when a ChannelDown command is issued to the application.
ChannelUpPressed	Event raised when a ChannelUp command is issued to the application.
FastForwardPressed	Event raised when a FastForward command is issued to the application.
NextTrackPressed	Event raised when a NextTrack command is issued to the application.
PausePressed	Event raised when a Pause command is issued to the application.
PlayPauseTogglePressed	Event raised when a PlayPauseToggle command is issued to the application.
PlayPressed	Event raised when a Play command is issued to the application.
PreviousTrackPressed	Event raised when a PreviousTrack command is issued to the application.
RecordPressed	Event raised when a Record command is issued to the application.
RewindPressed	Event raised when a Rewind command is issued to the application.
SoundLevelChanged	Event raised when the sound level changes.
StopPressed	Event raised when a Stop command is issued to the application.

Methods

The MediaControl class inherits methods from the Object class (C#/VB/C++).

Properties

The MediaControl class has these properties.

Property	Access type	Description
AlbumArt	Read/write	Gets or sets the path to the artwork for the album cover.
ArtistName	Read/write	Gets or sets the name of the artist.
IsPlaying	Read/write	Gets or sets the state of the Play button.
SoundLevel	Read-only	Gets the current sound level.
TrackName	Read/write	Gets or sets the track name.

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.

JavaScript


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

Requirements

Minimum supported client	Windows 8 [Windows Store apps only]
Minimum supported server	Windows Server 2012 [Windows Store apps only]
Namespace	Windows.Media Windows::Media [C++]
Metadata	Windows.winmd

MediaControl class