MediaSession.playbackState
The playbackState
property of the MediaSession
interface indicates whether the current media session is playing or paused.
Syntax
let playbackState = mediaSession.playbackState; mediaSession.playbackState = playbackState;
Value
A DOMString
indicating the current playback state of the media session. The value may be one of the following:
none
-
The browsing context doesn't currently know the current playback state, or the playback state is not available at this time.
paused
-
The browser's media session is currently paused. Playback may be resumed.
playing
-
The browser's media session is currently playing media, which can be paused.
Example
The following example sets up two functions for playing and pausing, then uses them as callbacks with the relevant action handlers. Each function harnesses the playbackState
property to indicate whether the audio is playing or paused.
const actionHandlers = [ // play [ 'play', async function() { // play our audio await audioEl.play(); // set playback state navigator.mediaSession.playbackState = "playing"; // update our status element updateStatus(allMeta[index], 'Action: play | Track is playing...') } ], [ 'pause', () => { // pause out audio audioEl.pause(); // set playback state navigator.mediaSession.playbackState = "paused"; // update our status element updateStatus(allMeta[index], 'Action: pause | Track has been paused...'); } ], ] for (const [action, handler] of actionHandlers) { try { navigator.mediaSession.setActionHandler(action, handler); } catch (error) { console.log(`The media session action "${action}" is not supported yet.`); } }
Specifications
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
playbackState |
73 |
79 |
82
71
|
No |
Yes |
15 |
No |
57 |
82
Firefox exposes the API, but does not provide a corresponding user-facing media control interface.
|
No |
15 |
7.0 |
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/MediaSession/playbackState