MediaSession.metadata

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The metadata property of the MediaSession interface contains a MediaMetadata object providing descriptive information about the currently playing media, or null if the metadata has not been set. This metadata is provided by the browser to the device for presentation in any standard media control user interface the device might offer.

Syntax

var mediaMetadata = navigator.mediaSession.metadata;
navigator.mediaSession.metadata = mediaMetadata;

Value

An instance of MediaMetadata containing information about the media currently being played.

Example

The following example checks for compatibility and creates a new media session with the relevant metadata:

if ('mediaSession' in navigator) {
  navigator.mediaSession.metadata = new MediaMetadata({
    title: 'Unforgettable',
    artist: 'Nat King Cole',
    album: 'The Ultimate Collection (Remastered)',
    artwork: [
      { src: 'https://dummyimage.com/96x96',   sizes: '96x96',   type: 'image/png' },
      { src: 'https://dummyimage.com/128x128', sizes: '128x128', type: 'image/png' },
      { src: 'https://dummyimage.com/192x192', sizes: '192x192', type: 'image/png' },
      { src: 'https://dummyimage.com/256x256', sizes: '256x256', type: 'image/png' },
      { src: 'https://dummyimage.com/384x384', sizes: '384x384', type: 'image/png' },
      { src: 'https://dummyimage.com/512x512', sizes: '512x512', type: 'image/png' },
    ]
  });

}

Specifications

Specification
Media Session Standard # dom-mediasession-metadata

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
`metadata`	73	79	82 71	No	60	15	No	57	82 Firefox exposes the API, but does not provide a corresponding user-facing media control interface.	43	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/metadata

Name	Web APIs
Version
Badge
Last Updated	2022-04-27T09:33:08Z