MediaMetadata

Kotlin |Java

class MediaMetadata : CustomVersionedParcelable

androidx.media2.common.MediaMetadata

Contains metadata about an item, such as the title, artist, etc. This is optional, but you'd better to provide this as much as possible when you're using media widget and/or session APIs.

The media widget components build its UI based on the metadata here. For an example, androidx.media2.widget.MediaControlView will show title from the metadata.

The androidx.media2.session.MediaLibraryService.MediaLibrarySession would require some metadata values when it provides MediaItems to androidx.media2.session.MediaBrowser.

Topics covered here:

Media ID
Browsable type
Playable
Duration
User rating

`Media ID`

If set, the media ID must be the persistent key for the underlying media contents, so androidx.media2.session.MediaController and androidx.media2.session.MediaBrowser can store the information and reuse it later. Some APIs requires a media ID (e.g. androidx.media2.session.MediaController#setRating, so you'd better specify one.

Typical example of using media ID is the URI of the contents, but use it with the caution because the metadata is shared across the process in plain text.

The androidx.media2.session.MediaLibraryService.MediaLibrarySession would require it for the library root, so androidx.media2.session.MediaBrowser can call subsequent androidx.media2.session.MediaBrowser#getChildren with the ID.

`Browsable type`

Browsable defines whether the media item has children and type of children if any. With this, androidx.media2.session.MediaBrowser can know whether the subsequent androidx.media2.session.MediaBrowser#getChildren would successfully run.

The androidx.media2.session.MediaLibraryService.MediaLibrarySession would require the explicit browsable type for the media items returned by the androidx.media2.session.MediaLibraryService.MediaLibrarySession.MediaLibrarySessionCallback.

`Playable type`

Playable defines whether the media item can be played or not. It may be possible for a playlist to contain a media item which isn't playable in order to show a disabled media item.

The androidx.media2.session.MediaLibraryService.MediaLibrarySession would require the explicit playable value for the media items returned by the androidx.media2.session.MediaLibraryService.MediaLibrarySession.MediaLibrarySessionCallback.

The duration is the length of the contents. The androidx.media2.session.MediaController can only get the duration through the metadata. This tells when would the playback ends, and also tells about the allowed range of androidx.media2.session.MediaController#seekTo(long).

If it's not set by developer, androidx.media2.session.MediaSession would update the duration in the metadata with the SessionPlayer#getDuration().

`User rating`

Prefer to have unrated user rating instead of null, so androidx.media2.session.MediaController can know the possible user rating type for calling androidx.media2.session.MediaController#setRating(String, Rating).

Summary

Nested classes
	`Builder` Use to build MediaMetadatax objects.

Constants
static Long	`BROWSABLE_TYPE_ALBUMS` The type of browsable that contains browsable items categorized by album.
static Long	`BROWSABLE_TYPE_ARTISTS` The type of browsable that contains browsable items categorized by artist.
static Long	`BROWSABLE_TYPE_GENRES` The type of browsable that contains browsable items categorized by genre.
static Long	`BROWSABLE_TYPE_MIXED` The type of browsable that is unknown or contains media items of mixed types.
static Long	`BROWSABLE_TYPE_NONE` The type of browsable for non-browsable media item.
static Long	`BROWSABLE_TYPE_PLAYLISTS` The type of browsable that contains browsable items categorized by playlist.
static Long	`BROWSABLE_TYPE_TITLES` The type of browsable that only contains playable media items.
static Long	`BROWSABLE_TYPE_YEARS` The type of browsable that contains browsable items categorized by year.
static String	`METADATA_KEY_ADVERTISEMENT` The metadata key for a `Long` typed value to retrieve the information about whether the media is an advertisement.
static String	`METADATA_KEY_ALBUM` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about the album title for the media.
static String	`METADATA_KEY_ALBUM_ART` The metadata key for a `Bitmap` typed value to retrieve the information about the artwork for the album of the media's original source.
static String	`METADATA_KEY_ALBUM_ARTIST` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about the artist for the album of the media's original source.
static String	`METADATA_KEY_ALBUM_ART_URI` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about the Uri of the artwork for the album of the media's original source.
static String	`METADATA_KEY_ART` The metadata key for a `Bitmap` typed value to retrieve the information about the artwork for the media.
static String	`METADATA_KEY_ARTIST` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about the artist of the media.
static String	`METADATA_KEY_ART_URI` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about Uri of the artwork for the media.
static String	`METADATA_KEY_AUTHOR` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about the author of the media.
static String	`METADATA_KEY_BROWSABLE` The metadata key for a `Long` typed value to retrieve the information about the type of browsable.
static String	`METADATA_KEY_COMPILATION` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about the compilation status of the media.
static String	`METADATA_KEY_COMPOSER` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about the composer of the media.
static String	`METADATA_KEY_DATE` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about the date the media was created or published.
static String	`METADATA_KEY_DISC_NUMBER` The metadata key for a `Long` typed value to retrieve the information about the disc number for the media's original source.
static String	`METADATA_KEY_DISPLAY_DESCRIPTION` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about the description that is suitable for display to the user.
static String	`METADATA_KEY_DISPLAY_ICON` The metadata key for a `Bitmap` typed value to retrieve the information about the icon or thumbnail that is suitable for display to the user.
static String	`METADATA_KEY_DISPLAY_ICON_URI` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about the Uri of icon or thumbnail that is suitable for display to the user.
static String	`METADATA_KEY_DISPLAY_SUBTITLE` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about the subtitle that is suitable for display to the user.
static String	`METADATA_KEY_DISPLAY_TITLE` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about the title that is suitable for display to the user.
static String	`METADATA_KEY_DOWNLOAD_STATUS` The metadata key for a `Long` typed value to retrieve the information about the download status of the media which will be used for later offline playback.
static String	`METADATA_KEY_DURATION` The metadata key for a `Long` typed value to retrieve the information about the duration of the media in ms.
static String	`METADATA_KEY_EXTRAS` A `Bundle` extra.
static String	`METADATA_KEY_GENRE` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about the genre of the media.
static String	`METADATA_KEY_MEDIA_ID` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about the media ID of the content.
static String	`METADATA_KEY_MEDIA_URI` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about the Uri of the content.
static String	`METADATA_KEY_NUM_TRACKS` The metadata key for a `Long` typed value to retrieve the information about the number of tracks in the media's original source.
static String	`METADATA_KEY_PLAYABLE` The metadata key for a `Long` typed value to retrieve the information about whether the media is playable.
static String	`METADATA_KEY_RATING` The metadata key for a `Rating` typed value to retrieve the information about the overall rating for the media.
static String	`METADATA_KEY_TITLE` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about the title of the media.
static String	`METADATA_KEY_TRACK_NUMBER` The metadata key for a `Long` typed value to retrieve the information about the track number for the media.
static String	`METADATA_KEY_USER_RATING` The metadata key for a `Rating` typed value to retrieve the information about the user's rating for the media.
static String	`METADATA_KEY_WRITER` The metadata key for a `CharSequence` or `String` typed value to retrieve the information about the writer of the media.
static String	`METADATA_KEY_YEAR` The metadata key for a `Long` typed value to retrieve the information about the year the media was created or published.
static Long	`STATUS_DOWNLOADED` The status value to indicate the media item is downloaded for later offline playback.
static Long	`STATUS_DOWNLOADING` The status value to indicate the media item is being downloaded.
static Long	`STATUS_NOT_DOWNLOADED` The status value to indicate the media item is not downloaded.

Public methods
Boolean	`containsKey(@NonNull key: String)` Returns true if the given key is contained in the metadata
Bitmap?	`getBitmap(@NonNull key: String)` Return a `Bitmap` for the given key or null if no bitmap exists for the given key.
Bundle?	`getExtras()` Get the extra `Bundle` from the metadata object.
Float	`getFloat(@NonNull key: String)` Return the value associated with the given key, or 0.
Long	`getLong(@NonNull key: String)` Returns the value associated with the given key, or 0L if no long exists for the given key.
String?	`getMediaId()` Returns the media id,