MediaMetadata

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

The MediaMetadata interface of the Media Session API allows a web page to provide rich media metadata for display in a platform UI.

Constructor

MediaMetadata()

Creates a new MediaMetaData object.

Instance properties

MediaMetadata.album

Returns or sets the name of the album or collection containing the media to be played.

MediaMetadata.artist

Returns or sets the name of the artist, group, creator, etc. of the media to be played.

MediaMetadata.artwork

Returns or sets an array of images associated with playing media.

MediaMetadata.chapterInfo Read only Experimental

Returns an array of chapter information metadata associated with playing media, represented by ChapterInformation object instances.

MediaMetadata.title

Returns or sets the title of the media to be played.

Examples

The following example checks for browser compatibility and sets the current metadata for the media session.

js
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
# the-mediametadata-interface

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
MediaMetadata
MediaMetadata() constructor
album
artist
artwork
chapterInfo
Experimental
title

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
Partial support
Partial support
No support
No support
Experimental. Expect behavior to change in the future.
See implementation notes.