setActionHandler

The setActionHandler() property of the MediaSession interface sets an event handler for a media session action.

Syntax

navigator.mediaSession.setActionHandler(type, callback)

Parameters

type

A string representing an action type to listen for. It will be one of play, pause, seekbackward, seekforward, previoustrack, or nexttrack.

callback

Indicates the function to call when the specified action type is invoked. This is a void function, with no parameters.

Returns

void

Example

The following example creates a new media session and assigns action handlers to it:

if ('mediaSession' in navigator){
  navigator.mediaSession.metadata = new MediaMetadata({
    title: "Podcast Episode Title",
    artist: "Podcast Host",
    album: "Podcast Name",
    artwork: [{src: "podcast.jpg"}]
  });
  navigator.mediaSession.setActionHandler('play', function() {});
  navigator.mediaSession.setActionHandler('pause', function() {});
  navigator.mediaSession.setActionHandler('seekbackward', function() {});
  navigator.mediaSession.setActionHandler('seekforward', function() {});
  navigator.mediaSession.setActionHandler('previoustrack', function() {});
  navigator.mediaSession.setActionHandler('nexttrack', function() {});
}

Specifications

Browser Compatibility