MediaMetadataCompat
public final class MediaMetadataCompat implements Parcelable
Contains metadata about an item, such as the title, artist, etc.
Summary
Nested types |
|---|
public final class MediaMetadataCompat.BuilderUse to build MediaMetadata objects. |
Constants |
|
|---|---|
static final Parcelable.Creator<MediaMetadataCompat> |
|
static final String |
METADATA_KEY_ADVERTISEMENT = "android.media.metadata.ADVERTISEMENT"Whether the media is an advertisement. |
static final String |
METADATA_KEY_ALBUM = "android.media.metadata.ALBUM"The album title for the media. |
static final String |
METADATA_KEY_ALBUM_ART = "android.media.metadata.ALBUM_ART"The artwork for the album of the media's original source as a |
static final String |
METADATA_KEY_ALBUM_ARTIST = "android.media.metadata.ALBUM_ARTIST"The artist for the album of the media's original source. |
static final String |
METADATA_KEY_ALBUM_ART_URI = "android.media.metadata.ALBUM_ART_URI"The artwork for the album of the media's original source as a Uri style String. |
static final String |
METADATA_KEY_ART = "android.media.metadata.ART"The artwork for the media as a |
static final String |
METADATA_KEY_ARTIST = "android.media.metadata.ARTIST"The artist of the media. |
static final String |
METADATA_KEY_ART_URI = "android.media.metadata.ART_URI"The artwork for the media as a Uri style String. |
static final String |
METADATA_KEY_AUTHOR = "android.media.metadata.AUTHOR"The author of the media. |
static final String |
METADATA_KEY_BT_FOLDER_TYPE = "android.media.metadata.BT_FOLDER_TYPE"The bluetooth folder type of the media specified in the section 6.10.2.2 of the Bluetooth AVRCP 1.5. |
static final String |
METADATA_KEY_COMPILATION = "android.media.metadata.COMPILATION"The compilation status of the media. |
static final String |
METADATA_KEY_COMPOSER = "android.media.metadata.COMPOSER"The composer of the media. |
static final String |
METADATA_KEY_DATE = "android.media.metadata.DATE"The date the media was created or published. |
static final String |
METADATA_KEY_DISC_NUMBER = "android.media.metadata.DISC_NUMBER"The disc number for the media's original source. |
static final String |
METADATA_KEY_DISPLAY_DESCRIPTION = "android.media.metadata.DISPLAY_DESCRIPTION"A description that is suitable for display to the user. |
static final String |
METADATA_KEY_DISPLAY_ICON = "android.media.metadata.DISPLAY_ICON"An icon or thumbnail that is suitable for display to the user. |
static final String |
METADATA_KEY_DISPLAY_ICON_URI = "android.media.metadata.DISPLAY_ICON_URI"An icon or thumbnail that is suitable for display to the user. |
static final String |
METADATA_KEY_DISPLAY_SUBTITLE = "android.media.metadata.DISPLAY_SUBTITLE"A subtitle that is suitable for display to the user. |
static final String |
METADATA_KEY_DISPLAY_TITLE = "android.media.metadata.DISPLAY_TITLE"A title that is suitable for display to the user. |
static final String |
METADATA_KEY_DOWNLOAD_STATUS = "android.media.metadata.DOWNLOAD_STATUS"The download status of the media which will be used for later offline playback. |
static final String |
METADATA_KEY_DURATION = "android.media.metadata.DURATION"The duration of the media in ms. |
static final String |
METADATA_KEY_GENRE = "android.media.metadata.GENRE"The genre of the media. |
static final String |
METADATA_KEY_MEDIA_ID = "android.media.metadata.MEDIA_ID"A String key for identifying the content. |
static final String |
METADATA_KEY_MEDIA_URI = "android.media.metadata.MEDIA_URI"A Uri formatted String representing the content. |
static final String |
METADATA_KEY_NUM_TRACKS = "android.media.metadata.NUM_TRACKS"The number of tracks in the media's original source. |
static final String |
METADATA_KEY_RATING = "android.media.metadata.RATING"The overall rating for the media. |
static final String |
METADATA_KEY_TITLE = "android.media.metadata.TITLE"The title of the media. |
static final String |
METADATA_KEY_TRACK_NUMBER = "android.media.metadata.TRACK_NUMBER"The track number for the media. |
static final String |
METADATA_KEY_USER_RATING = "android.media.metadata.USER_RATING"The user's rating for the media. |
static final String |
METADATA_KEY_WRITER = "android.media.metadata.WRITER"The writer of the media. |
static final String |
METADATA_KEY_YEAR = "android.media.metadata.YEAR"The year the media was created or published as a long. |
Public methods |
|
|---|---|
boolean |
containsKey(String key)Returns true if the given key is contained in the metadata |
int |
|
static MediaMetadataCompat |
fromMediaMetadata(Object metadataObj)Creates an instance from a framework |
Bitmap |
Return a |
Bundle |
Gets a copy of the bundle for this metadata object. |
MediaDescriptionCompat |
Returns a simple description of this metadata for display purposes. |
long |
Returns the value associated with the given key, or 0L if no long exists for the given key. |
Object |
Gets the underlying framework |
RatingCompat |
Return a |
String |
Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key. |
CharSequence |
Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key. |
Set<String> |
keySet()Returns a Set containing the Strings used as keys in this metadata. |
int |
size()Get the number of fields in this metadata. |
void |
writeToParcel(Parcel dest, int flags) |
Inherited Constants |
||||
|---|---|---|---|---|
|
Constants
METADATA_KEY_ADVERTISEMENT
public static final String METADATA_KEY_ADVERTISEMENT = "android.media.metadata.ADVERTISEMENT"
Whether the media is an advertisement. A value of 0 indicates it is not an advertisement. A value of 1 or non-zero indicates it is an advertisement. If not specified, this value is set to 0 by default.
METADATA_KEY_ALBUM
public static final String METADATA_KEY_ALBUM = "android.media.metadata.ALBUM"
The album title for the media.
METADATA_KEY_ALBUM_ART
public static final String METADATA_KEY_ALBUM_ART = "android.media.metadata.ALBUM_ART"
The artwork for the album of the media's original source as a Bitmap. The artwork should be relatively small and may be scaled down if it is too large. For higher resolution artwork METADATA_KEY_ALBUM_ART_URI should be used instead.
METADATA_KEY_ALBUM_ARTIST
public static final String METADATA_KEY_ALBUM_ARTIST = "android.media.metadata.ALBUM_ARTIST"
The artist for the album of the media's original source.
METADATA_KEY_ALBUM_ART_URI
public static final String METADATA_KEY_ALBUM_ART_URI = "android.media.metadata.ALBUM_ART_URI"
The artwork for the album of the media's original source as a Uri style String.
METADATA_KEY_ART
public static final String METADATA_KEY_ART = "android.media.metadata.ART"
The artwork for the media as a Bitmap. The artwork should be relatively small and may be scaled down if it is too large. For higher resolution artwork METADATA_KEY_ART_URI should be used instead.
METADATA_KEY_ARTIST
public static final String METADATA_KEY_ARTIST = "android.media.metadata.ARTIST"
The artist of the media.
METADATA_KEY_ART_URI
public static final String METADATA_KEY_ART_URI = "android.media.metadata.ART_URI"
The artwork for the media as a Uri style String.
METADATA_KEY_AUTHOR
public static final String METADATA_KEY_AUTHOR = "android.media.metadata.AUTHOR"
The author of the media.
METADATA_KEY_BT_FOLDER_TYPE
public static final String METADATA_KEY_BT_FOLDER_TYPE = "android.media.metadata.BT_FOLDER_TYPE"
The bluetooth folder type of the media specified in the section 6.10.2.2 of the Bluetooth AVRCP 1.5. It should be one of the following:
METADATA_KEY_COMPILATION
public static final String METADATA_KEY_COMPILATION = "android.media.metadata.COMPILATION"
The compilation status of the media.
METADATA_KEY_COMPOSER
public static final String METADATA_KEY_COMPOSER = "android.media.metadata.COMPOSER"
The composer of the media.
METADATA_KEY_DATE
public static final String METADATA_KEY_DATE = "android.media.metadata.DATE"
The date the media was created or published. The format is unspecified but RFC 3339 is recommended.
METADATA_KEY_DISC_NUMBER
public static final String METADATA_KEY_DISC_NUMBER = "android.media.metadata.DISC_NUMBER"
The disc number for the media's original source.
METADATA_KEY_DISPLAY_DESCRIPTION
public static final String METADATA_KEY_DISPLAY_DESCRIPTION = "android.media.metadata.DISPLAY_DESCRIPTION"
A description that is suitable for display to the user. When displaying more information for media described by this metadata this should be preferred to other fields if present.
METADATA_KEY_DISPLAY_ICON
public static final String METADATA_KEY_DISPLAY_ICON = "android.media.metadata.DISPLAY_ICON"
An icon or thumbnail that is suitable for display to the user. When displaying an icon for media described by this metadata this should be preferred to other fields if present. This must be a Bitmap. The icon should be relatively small and may be scaled down if it is too large. For higher resolution artwork METADATA_KEY_DISPLAY_ICON_URI should be used instead.
METADATA_KEY_DISPLAY_ICON_URI
public static final String METADATA_KEY_DISPLAY_ICON_URI = "android.media.metadata.DISPLAY_ICON_URI"
An icon or thumbnail that is suitable for display to the user. When displaying more information for media described by this metadata the display description should be preferred to other fields when present. This must be a Uri style String.
METADATA_KEY_DISPLAY_SUBTITLE
public static final String METADATA_KEY_DISPLAY_SUBTITLE = "android.media.metadata.DISPLAY_SUBTITLE"
A subtitle that is suitable for display to the user. When displaying a second line for media described by this metadata this should be preferred to other fields if present.
METADATA_KEY_DISPLAY_TITLE
public static final String METADATA_KEY_DISPLAY_TITLE = "android.media.metadata.DISPLAY_TITLE"
A title that is suitable for display to the user. This will generally be the same as METADATA_KEY_TITLE but may differ for some formats. When displaying media described by this metadata this should be preferred if present.
METADATA_KEY_DOWNLOAD_STATUS
public static final String METADATA_KEY_DOWNLOAD_STATUS = "android.media.metadata.DOWNLOAD_STATUS"
The download status of the media which will be used for later offline playback. It should be one of the following:
METADATA_KEY_DURATION
public static final String METADATA_KEY_DURATION = "android.media.metadata.DURATION"
The duration of the media in ms. A negative duration indicates that the duration is unknown (or infinite).
METADATA_KEY_GENRE
public static final String METADATA_KEY_GENRE = "android.media.metadata.GENRE"
The genre of the media.
METADATA_KEY_MEDIA_ID
public static final String METADATA_KEY_MEDIA_ID = "android.media.metadata.MEDIA_ID"
A String key for identifying the content. This value is specific to the service providing the content. If used, this should be a persistent unique key for the underlying content.
METADATA_KEY_MEDIA_URI
public static final String METADATA_KEY_MEDIA_URI = "android.media.metadata.MEDIA_URI"
A Uri formatted String representing the content. This value is specific to the service providing the content. It may be used with playFromUri to initiate playback when provided by a MediaBrowserCompat connected to the same app.
METADATA_KEY_NUM_TRACKS
public static final String METADATA_KEY_NUM_TRACKS = "android.media.metadata.NUM_TRACKS"
The number of tracks in the media's original source.
METADATA_KEY_RATING
public static final String METADATA_KEY_RATING = "android.media.metadata.RATING"
The overall rating for the media.
| See also | |
|---|---|
RatingCompat |
METADATA_KEY_TITLE
public static final String METADATA_KEY_TITLE = "android.media.metadata.TITLE"
The title of the media.
METADATA_KEY_TRACK_NUMBER
public static final String METADATA_KEY_TRACK_NUMBER = "android.media.metadata.TRACK_NUMBER"
The track number for the media.
METADATA_KEY_USER_RATING
public static final String METADATA_KEY_USER_RATING = "android.media.metadata.USER_RATING"
The user's rating for the media.
| See also | |
|---|---|
RatingCompat |
METADATA_KEY_WRITER
public static final String METADATA_KEY_WRITER = "android.media.metadata.WRITER"
The writer of the media.
METADATA_KEY_YEAR
public static final String METADATA_KEY_YEAR = "android.media.metadata.YEAR"
The year the media was created or published as a long.
Public methods
containsKey
public boolean containsKey(String key)
Returns true if the given key is contained in the metadata
| Parameters | |
|---|---|
String key |
a String key |
| Returns | |
|---|---|
boolean |
true if the key exists in this metadata, false otherwise |
fromMediaMetadata
public static MediaMetadataCompat fromMediaMetadata(Object metadataObj)
Creates an instance from a framework android.media.MediaMetadata object.
This method is only supported on LOLLIPOP and later.
| Parameters | |
|---|---|
Object metadataObj |
A |
| Returns | |
|---|---|
MediaMetadataCompat |
An equivalent |
getBitmap
public Bitmap getBitmap(String key)
Return a Bitmap for the given key or null if no bitmap exists for the given key.
| Parameters | |
|---|---|
String key |
The key the value is stored under |
getBundle
public Bundle getBundle()
Gets a copy of the bundle for this metadata object. This is available to support backwards compatibility.
| Returns | |
|---|---|
Bundle |
A copy of the bundle for this metadata object. |
getDescription
public MediaDescriptionCompat getDescription()
Returns a simple description of this metadata for display purposes.
| Returns | |
|---|---|
MediaDescriptionCompat |
A simple description of this metadata. |
getLong
public long getLong(String key)
Returns the value associated with the given key, or 0L if no long exists for the given key.
| Parameters | |
|---|---|
String key |
The key the value is stored under |
| Returns | |
|---|---|
long |
a long value |
getMediaMetadata
public Object getMediaMetadata()
Gets the underlying framework android.media.MediaMetadata object.
This method is only supported on LOLLIPOP and later.
| Returns | |
|---|---|
Object |
An equivalent |
getRating
public RatingCompat getRating(String key)
Return a RatingCompat for the given key or null if no rating exists for the given key.
| Parameters | |
|---|---|
String key |
The key the value is stored under |
| Returns | |
|---|---|
RatingCompat |
A |
getString
public String getString(String key)
Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
| Parameters | |
|---|---|
String key |
The key the value is stored under |
| Returns | |
|---|---|
String |
a String value, or null |
getText
public CharSequence getText(String key)
Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
| Parameters | |
|---|---|
String key |
The key the value is stored under |
| Returns | |
|---|---|
CharSequence |
a CharSequence value, or null |
keySet
public Set<String> keySet()
Returns a Set containing the Strings used as keys in this metadata.