Documentation
    Preparing search index...

    Interface MediaMetadata

    Media session metadata. All fields are optional -- a session can be created with no metadata and updated later.

    const metadata: MediaMetadata = {
      title: 'Song Title',
      artist: 'Artist Name',
      album: 'Album Name',
      artwork: { url: 'https://example.com/cover.jpg' },
      duration: 240,
      mediaType: 'audio',
    };
    interface MediaMetadata {
        album?: string;
        artist?: string;
        artwork?: MediaArtwork;
        duration?: number;
        mediaType?: "audio" | "video";
        title?: string;
    }
    Index

    Properties

    album? artist? artwork? duration? mediaType? title?

    Properties

    album?: string

    Album or collection name.

    artist?: string

    Artist or creator name.

    artwork?: MediaArtwork

    Artwork image reference. Supports direct URL or Blossom hash.

    duration?: number

    Total duration in seconds.

    mediaType?: "audio" | "video"

    Media type hint for shell UI.

    title?: string

    Track or media title.

    Settings

    Member Visibility

    On This Page

    Properties