MediaMetadata

Kotlin |Java

public final class MediaMetadata

Metadata of a MediaItem, playlist, or a combination of multiple sources of .

Summary

Nested types
`public final class MediaMetadata.Builder` A builder for `MediaMetadata` instances.
`@Documented @Retention(value = RetentionPolicy.SOURCE) @Target(value = ) @IntDef(value = ) public annotation MediaMetadata.FolderType` This annotation is deprecated. Use `isBrowsable` to indicate if an item is a browsable folder and use `mediaType` to indicate the type of the folder.
`@Documented @Retention(value = RetentionPolicy.SOURCE) @Target(value = ElementType.TYPE_USE) @IntDef(value = ) public annotation MediaMetadata.MediaType` The type of content described by the media item.
`@Documented @Retention(value = RetentionPolicy.SOURCE) @Target(value = ) @IntDef(value = ) public annotation MediaMetadata.PictureType` The picture type of the artwork.

Constants
`static final MediaMetadata`	`EMPTY` Empty `MediaMetadata`.
`static final int`	`FOLDER_TYPE_ALBUMS = 2` This field is deprecated. Use `isBrowsable` set to true and `mediaType` set to `MEDIA_TYPE_FOLDER_ALBUMS` instead.
`static final int`	`FOLDER_TYPE_ARTISTS = 3` This field is deprecated. Use `isBrowsable` set to true and `mediaType` set to `MEDIA_TYPE_FOLDER_ARTISTS` instead.
`static final int`	`FOLDER_TYPE_GENRES = 4` This field is deprecated. Use `isBrowsable` set to true and `mediaType` set to `MEDIA_TYPE_FOLDER_GENRES` instead.
`static final int`	`FOLDER_TYPE_MIXED = 0` This field is deprecated. Use `isBrowsable` set to true and `mediaType` set to `MEDIA_TYPE_FOLDER_MIXED` instead.
`static final int`	`FOLDER_TYPE_NONE = -1` This field is deprecated. Use `isBrowsable` set to false instead.
`static final int`	`FOLDER_TYPE_PLAYLISTS = 5` This field is deprecated. Use `isBrowsable` set to true and `mediaType` set to `MEDIA_TYPE_FOLDER_PLAYLISTS` instead.
`static final int`	`FOLDER_TYPE_TITLES = 1` This field is deprecated. Use `isBrowsable` set to true instead.
`static final int`	`FOLDER_TYPE_YEARS = 6` This field is deprecated. Use `isBrowsable` set to true and `mediaType` set to `MEDIA_TYPE_FOLDER_YEARS` instead.
`static final int`	`MEDIA_TYPE_ALBUM = 10` `MediaType` for a group of items (e.g., `music`) belonging to an album.
`static final int`	`MEDIA_TYPE_ARTIST = 11` `MediaType` for a group of items (e.g., `music`) from the same artist.
`static final int`	`MEDIA_TYPE_AUDIO_BOOK = 15` `MediaType` for a group of items forming an audio book.
`static final int`	`MEDIA_TYPE_AUDIO_BOOK_CHAPTER = 2` `MediaType` for an audio book chapter.
`static final int`	`MEDIA_TYPE_FOLDER_ALBUMS = 21` `MediaType` for a folder containing `albums`.
`static final int`	`MEDIA_TYPE_FOLDER_ARTISTS = 22` `MediaType` for a folder containing `artists`.
`static final int`	`MEDIA_TYPE_FOLDER_AUDIO_BOOKS = 26` `MediaType` for a folder containing `audio books`.
`static final int`	`MEDIA_TYPE_FOLDER_GENRES = 23` `MediaType` for a folder containing `genres`.
`static final int`	`MEDIA_TYPE_FOLDER_MIXED = 20` `MediaType` for a folder with mixed or undetermined content.
`static final int`	`MEDIA_TYPE_FOLDER_MOVIES = 35` `MediaType` for a folder containing `movies`.
`static final int`	`MEDIA_TYPE_FOLDER_NEWS = 32` `MediaType` for a folder containing `news`.
`static final int`	`MEDIA_TYPE_FOLDER_PLAYLISTS = 24` `MediaType` for a folder containing `playlists`.
`static final int`	`MEDIA_TYPE_FOLDER_PODCASTS = 27` `MediaType` for a folder containing `podcasts`.
`static final int`	`MEDIA_TYPE_FOLDER_RADIO_STATIONS = 31` `MediaType` for a folder containing `radio stations`.
`static final int`	`MEDIA_TYPE_FOLDER_TRAILERS = 34` `MediaType` for a folder containing `movie trailers`.
`static final int`	`MEDIA_TYPE_FOLDER_TV_CHANNELS = 28` `MediaType` for a folder containing `TV channels`.
`static final int`	`MEDIA_TYPE_FOLDER_TV_SERIES = 29` `MediaType` for a folder containing `TV series`.
`static final int`	`MEDIA_TYPE_FOLDER_TV_SHOWS = 30` `MediaType` for a folder containing `TV shows`.
`static final int`	`MEDIA_TYPE_FOLDER_VIDEOS = 33` `MediaType` for a folder containing `videos`.
`static final int`	`MEDIA_TYPE_FOLDER_YEARS = 25` `MediaType` for a folder containing `years`.
`static final int`	`MEDIA_TYPE_GENRE = 12` `MediaType` for a group of items (e.g., `music`) of the same genre.
`static final int`	`MEDIA_TYPE_MIXED = 0` Media of undetermined type or a mix of multiple `media types`.
`static final int`	`MEDIA_TYPE_MOVIE = 8` `MediaType` for a movie.
`static final int`	`MEDIA_TYPE_MUSIC = 1` `MediaType` for music.
`static final int`	`MEDIA_TYPE_NEWS = 5` `MediaType` for news.
`static final int`	`MEDIA_TYPE_PLAYLIST = 13` `MediaType` for a group of items (e.g., `music`) forming a playlist.
`static final int`	`MEDIA_TYPE_PODCAST = 16` `MediaType` for a group of items belonging to a podcast.
`static final int`	`MEDIA_TYPE_PODCAST_EPISODE = 3` `MediaType` for a podcast episode.
`static final int`	`MEDIA_TYPE_RADIO_STATION = 4` `MediaType` for a radio station.
`static final int`	`MEDIA_TYPE_TRAILER = 7` `MediaType` for a movie trailer.
`static final int`	`MEDIA_TYPE_TV_CHANNEL = 17` `MediaType` for a group of items that are part of a TV channel.
`static final int`	`MEDIA_TYPE_TV_SEASON = 19` `MediaType` for a group of items that are part of a TV series.
`static final int`	`MEDIA_TYPE_TV_SERIES = 18` `MediaType` for a group of items that are part of a TV series.
`static final int`	`MEDIA_TYPE_TV_SHOW = 9` `MediaType` for a TV show.
`static final int`	`MEDIA_TYPE_VIDEO = 6` `MediaType` for a video.
`static final int`	`MEDIA_TYPE_YEAR = 14` `MediaType` for a group of items (e.g., `music`) from the same year.
`static final int`	`PICTURE_TYPE_ARTIST_PERFORMER = 8`
`static final int`	`PICTURE_TYPE_A_BRIGHT_COLORED_FISH = 17`
`static final int`	`PICTURE_TYPE_BACK_COVER = 4`
`static final int`	`PICTURE_TYPE_BAND_ARTIST_LOGO = 19`
`static final int`	`PICTURE_TYPE_BAND_ORCHESTRA = 10`
`static final int`	`PICTURE_TYPE_COMPOSER = 11`
`static final int`	`PICTURE_TYPE_CONDUCTOR = 9`
`static final int`	`PICTURE_TYPE_DURING_PERFORMANCE = 15`
`static final int`	`PICTURE_TYPE_DURING_RECORDING = 14`
`static final int`	`PICTURE_TYPE_FILE_ICON = 1`
`static final int`	`PICTURE_TYPE_FILE_ICON_OTHER = 2`
`static final int`	`PICTURE_TYPE_FRONT_COVER = 3`
`static final int`	`PICTURE_TYPE_ILLUSTRATION = 18`
`static final int`	`PICTURE_TYPE_LEAD_ARTIST_PERFORMER = 7`
`static final int`	`PICTURE_TYPE_LEAFLET_PAGE = 5`
`static final int`	`PICTURE_TYPE_LYRICIST = 12`
`static final int`	`PICTURE_TYPE_MEDIA = 6`
`static final int`	`PICTURE_TYPE_MOVIE_VIDEO_SCREEN_CAPTURE = 16`
`static final int`	`PICTURE_TYPE_OTHER = 0`
`static final int`	`PICTURE_TYPE_PUBLISHER_STUDIO_LOGO = 20`
`static final int`	`PICTURE_TYPE_RECORDING_LOCATION = 13`

Public fields
`final @Nullable CharSequence`	`albumArtist` Optional album artist.
`final @Nullable CharSequence`	`albumTitle` Optional album title.
`final @Nullable CharSequence`	`artist` Optional artist.
`final @Nullable byte[]`	`artworkData` Optional artwork data as a compressed byte array.
`final @Nullable @MediaMetadata.PictureType Integer`	`@MediaMetadata.PictureType artworkDataType` Optional `PictureType` of the artwork data.
`final @Nullable Uri`	`artworkUri` Optional artwork `Uri`.
`final @Nullable CharSequence`	`compilation` Optional compilation.
`final @Nullable CharSequence`	`composer` Optional composer.
`final @Nullable CharSequence`	`conductor` Optional conductor.
`final @Nullable CharSequence`	`description` Optional description.
`final @Nullable Integer`	`discNumber` Optional disc number.
`final @Nullable CharSequence`	`displayTitle` Optional display title.
`final @Nullable Long`	`durationMs` Optional duration, non-negative and in milliseconds.
`final @Nullable Bundle`	`extras` Optional extras `Bundle`.
`final @Nullable @MediaMetadata.FolderType Integer`	`@MediaMetadata.FolderType folderType` This field is deprecated. Use `isBrowsable` to indicate if an item is a browsable folder and use `mediaType` to indicate the type of the folder.
`final @Nullable CharSequence`	`genre` Optional genre.
`final @Nullable Boolean`	`isBrowsable` Optional boolean to indicate that the media is a browsable folder.
`final @Nullable Boolean`	`isPlayable` Optional boolean to indicate that the media is playable.
`final @Nullable @MediaMetadata.MediaType Integer`	`@MediaMetadata.MediaType mediaType` Optional `MediaType`.
`final @Nullable Rating`	`overallRating` Optional overall `Rating`.
`final @Nullable Integer`	`recordingDay` Optional day of the recording date.
`final @Nullable Integer`	`recordingMonth` Optional month of the recording date.
`final @Nullable Integer`	`recordingYear` Optional year of the recording date.
`final @Nullable Integer`	`releaseDay` Optional day of the release date.
`final @Nullable Integer`	`releaseMonth` Optional month of the release date.
`final @Nullable Integer`	`releaseYear` Optional year of the release date.
`final @Nullable CharSequence`	`station` Optional name of the station streaming the media.
`final @Nullable CharSequence`	`subtitle` Optional subtitle.
`final ImmutableList<String>`	`@UnstableApi supportedCommands` The IDs of the supported commands of this media item (see for instance `CommandButton.sessionCommand.customAction` of the Media3 session module).
`final @Nullable CharSequence`	`title` Optional title.
`final @Nullable Integer`	`totalDiscCount` Optional total number of discs.
`final @Nullable Integer`	`totalTrackCount` Optional total number of tracks.
`final @Nullable Integer`	`trackNumber` Optional track number.
`final @Nullable Rating`	`userRating` Optional user `Rating`.
`final @Nullable CharSequence`	`writer` Optional writer.
`final @Nullable Integer`	`@UnstableApi year` This field is deprecated. Use `recordingYear` instead.

Public methods
`MediaMetadata.Builder`	`buildUpon()` Returns a new `Builder` instance with the current `MediaMetadata` fields.
`boolean`	`equals(@Nullable Object obj)` Note: Equality checking does not consider `extras`.
`static MediaMetadata`	`@UnstableApi fromBundle(Bundle bundle)` Restores a `MediaMetadata` from a `Bundle`.
`int`	`hashCode()`
`Bundle`	`@UnstableApi toBundle()`

Constants

EMPTY

public static final MediaMetadata EMPTY

Empty MediaMetadata.</

MediaMetadata

Summary

Nested types

Constants

Public fields

Public methods

Constants

EMPTY