Save the date! Android Dev Summit is coming to Sunnyvale, CA on Oct 23-24, 2019.

MediaDescriptionCompat

class MediaDescriptionCompat : Parcelable
kotlin.Any
   ↳ android.support.v4.media.MediaDescriptionCompat

A simple set of metadata for a media item suitable for display. This can be created using the Builder or retrieved from existing metadata using MediaMetadataCompat#getDescription().

Summary

Nested classes

Builder for MediaDescriptionCompat objects.

Constants
static Long

The type of folder that contains folders categorized by album as specified in the section 6.

static Long

The type of folder that contains folders categorized by artist as specified in the section 6.

static Long

The type of folder that contains folders categorized by genre as specified in the section 6.

static Long

The type of folder that is unknown or contains media elements of mixed types as specified in the section 6.

static Long

The type of folder that contains folders categorized by playlist as specified in the section 6.

static Long

The type of folder that contains media elements only as specified in the section 6.

static Long

The type of folder that contains folders categorized by year as specified in the section 6.

static String

Used as a long extra field to indicate the bluetooth folder type of the media item as specified in the section 6.

static String

Used as a long extra field to indicate the download status of the media item.

static Long

The status value to indicate the media item is downloaded for later offline playback.

static Long

The status value to indicate the media item is being downloaded.

static Long

The status value to indicate the media item is not downloaded.

Public methods
Int

static MediaDescriptionCompat!
fromMediaDescription(descriptionObj: Any!)

Creates an instance from a framework android.media.MediaDescription object.

CharSequence?

Returns a description suitable for display or null.

Bundle?

Returns any extras that were added to the description.

Bitmap?

Returns a bitmap icon suitable for display or null.

Uri?

Returns a Uri for an icon suitable for display or null.

Any!

Gets the underlying framework android.media.MediaDescription object.

String?

Returns the media id or null.

Uri?

Returns a Uri representing this content or null.

CharSequence?

Returns a subtitle suitable for display or null.

CharSequence?

Returns a title suitable for display or null.

String

Unit
writeToParcel(dest: Parcel!, flags: Int)

Properties
static Creator<MediaDescriptionCompat!>!

Constants

BT_FOLDER_TYPE_ALBUMS

static val BT_FOLDER_TYPE_ALBUMS: Long

The type of folder that contains folders categorized by album as specified in the section 6.10.2.2 of the Bluetooth AVRCP 1.5.

Value: 2

BT_FOLDER_TYPE_ARTISTS

static val BT_FOLDER_TYPE_ARTISTS: Long

The type of folder that contains folders categorized by artist as specified in the section 6.10.2.2 of the Bluetooth AVRCP 1.5.

Value: 3

BT_FOLDER_TYPE_GENRES

static val BT_FOLDER_TYPE_GENRES: Long

The type of folder that contains folders categorized by genre as specified in the section 6.10.2.2 of the Bluetooth AVRCP 1.5.

Value: 4

BT_FOLDER_TYPE_MIXED

static val BT_FOLDER_TYPE_MIXED: Long

The type of folder that is unknown or contains media elements of mixed types as specified in the section 6.10.2.2 of the Bluetooth AVRCP 1.5.

Value: 0

BT_FOLDER_TYPE_PLAYLISTS

static val BT_FOLDER_TYPE_PLAYLISTS: Long

The type of folder that contains folders categorized by playlist as specified in the section 6.10.2.2 of the Bluetooth AVRCP 1.5.

Value: 5

BT_FOLDER_TYPE_TITLES

static val BT_FOLDER_TYPE_TITLES: Long

The type of folder that contains media elements only as specified in the section 6.10.2.2 of the Bluetooth AVRCP 1.5.

Value: 1

BT_FOLDER_TYPE_YEARS

static val BT_FOLDER_TYPE_YEARS: Long

The type of folder that contains folders categorized by year as specified in the section 6.10.2.2 of the Bluetooth AVRCP 1.5.

Value: 6

EXTRA_BT_FOLDER_TYPE

static val EXTRA_BT_FOLDER_TYPE: String

Used as a long extra field to indicate the bluetooth folder type of the media item as specified in the section 6.10.2.2 of the Bluetooth AVRCP 1.5. This is valid only for MediaBrowserCompat.MediaItem with MediaBrowserCompat.MediaItem#FLAG_BROWSABLE. The value should be one of the following:

Value: "android.media.extra.BT_FOLDER_TYPE"

See Also

EXTRA_DOWNLOAD_STATUS

static val EXTRA_DOWNLOAD_STATUS: String

Used as a long extra field to indicate the download status of the media item. The value should be one of the following:

Value: "android.media.extra.DOWNLOAD_STATUS"

See Also

STATUS_DOWNLOADED

static val STATUS_DOWNLOADED: Long

The status value to indicate the media item is downloaded for later offline playback.

Value: 2

STATUS_DOWNLOADING

static val STATUS_DOWNLOADING: Long

The status value to indicate the media item is being downloaded.

Value: 1

STATUS_NOT_DOWNLOADED

static val STATUS_NOT_DOWNLOADED: Long

The status value to indicate the media item is not downloaded.

Value: 0

Public methods

describeContents

fun describeContents(): Int

fromMediaDescription

static fun fromMediaDescription(descriptionObj: Any!): MediaDescriptionCompat!

Creates an instance from a framework android.media.MediaDescription object.

This method is only supported on API 21+.

Parameters
descriptionObj Any!: A android.media.MediaDescription object, or null if none.
Return
MediaDescriptionCompat!: An equivalent MediaMetadataCompat object, or null if none.

getDescription

@Nullable fun getDescription(): CharSequence?

Returns a description suitable for display or null.

Return
CharSequence?: A description or null.

getExtras

@Nullable fun getExtras(): Bundle?

Returns any extras that were added to the description.

Return
Bundle?: A bundle of extras or null.

getIconBitmap

@Nullable fun getIconBitmap(): Bitmap?

Returns a bitmap icon suitable for display or null.

Return
Bitmap?: An icon or null.

getIconUri

@Nullable fun getIconUri(): Uri?

Returns a Uri for an icon suitable for display or null.

Return
Uri?: An icon uri or null.

getMediaDescription

fun getMediaDescription(): Any!

Gets the underlying framework android.media.MediaDescription object.

This method is only supported on android.os.Build.VERSION_CODES#LOLLIPOP and later.

Return
Any!: An equivalent android.media.MediaDescription object, or null if none.

getMediaId

@Nullable fun getMediaId(): String?

Returns the media id or null. See MediaMetadataCompat#METADATA_KEY_MEDIA_ID.

getMediaUri

@Nullable fun getMediaUri(): Uri?

Returns a Uri representing this content or null.

Return
Uri?: A media Uri or null.

getSubtitle

@Nullable fun getSubtitle(): CharSequence?

Returns a subtitle suitable for display or null.

Return
CharSequence?: A subtitle or null.

getTitle

@Nullable fun getTitle(): CharSequence?

Returns a title suitable for display or null.

Return
CharSequence?: A title or null.

toString

fun toString(): String

writeToParcel

fun writeToParcel(dest: Parcel!, flags: Int): Unit

Properties

CREATOR

static val CREATOR: Creator<MediaDescriptionCompat!>!