MediaDescription

Kotlin |Java

open class MediaDescription : Parcelable

kotlin.Any
↳	android.media.MediaDescription

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 MediaMetadata#getDescription().

Summary

Nested classes
open	`Builder` Builder for `MediaDescription` objects.

Constants
static Long	`BT_FOLDER_TYPE_ALBUMS` The type of folder that contains folders categorized by album as specified in the section 6.
static Long	`BT_FOLDER_TYPE_ARTISTS` The type of folder that contains folders categorized by artist as specified in the section 6.
static Long	`BT_FOLDER_TYPE_GENRES` The type of folder that contains folders categorized by genre as specified in the section 6.
static Long	`BT_FOLDER_TYPE_MIXED` The type of folder that is unknown or contains media elements of mixed types as specified in the section 6.
static Long	`BT_FOLDER_TYPE_PLAYLISTS` The type of folder that contains folders categorized by playlist as specified in the section 6.
static Long	`BT_FOLDER_TYPE_TITLES` The type of folder that contains media elements only as specified in the section 6.
static Long	`BT_FOLDER_TYPE_YEARS` The type of folder that contains folders categorized by year as specified in the section 6.
static String	`EXTRA_BT_FOLDER_TYPE` Used as a long extra field to indicate the bluetooth folder type of the media item as specified in the section 6.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
open Int	`describeContents()`
open Boolean	`equals(other: Any?)`
open CharSequence?	`getDescription()` Returns a description suitable for display or null.
open Bundle?	`getExtras()` Returns any extras that were added to the description.
open Bitmap?	`getIconBitmap()` Returns a bitmap icon suitable for display or null.
open Uri?	`getIconUri()` Returns a Uri for an icon suitable for display or null.
open String?	`getMediaId()` Returns the media id or null.
open Uri?	`getMediaUri()` Returns a Uri representing this content or null.
open CharSequence?	`getSubtitle()` Returns a subtitle suitable for display or null.
open CharSequence?	`getTitle()` Returns a title suitable for display or null.
open String	`toString()`
open Unit	`writeToParcel(dest: Parcel, flags: Int)`

Properties
static Parcelable.Creator<MediaDescription!>	`CREATOR`

Constants

BT_FOLDER_TYPE_ALBUMS

Added in API level 26

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: 2L

BT_FOLDER_TYPE_ARTISTS

Added in API level 26

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: 3L

BT_FOLDER_TYPE_GENRES

Added in API level 26

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: 4L

BT_FOLDER_TYPE_MIXED

Added in API level 26

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: 0L

BT_FOLDER_TYPE_PLAYLISTS

Added in API level 26

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: 5L

BT_FOLDER_TYPE_TITLES

Added in API level 26

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: 1L

BT_FOLDER_TYPE_YEARS

Added in API level 26

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: 6L

EXTRA_BT_FOLDER_TYPE

Added in API level 26

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 MediaBrowser.MediaItem with MediaBrowser.MediaItem#FLAG_BROWSABLE. The value should be one of the following:

BT_FOLDER_TYPE_MIXED
BT_FOLDER_TYPE_TITLES
BT_FOLDER_TYPE_ALBUMS
BT_FOLDER_TYPE_ARTISTS
BT_FOLDER_TYPE_GENRES
BT_FOLDER_TYPE_PLAYLISTS
BT_FOLDER_TYPE_YEARS

Value: "android.media.extra.BT_FOLDER_TYPE"

See Also

#getExtras()

Public methods

describeContents

Added in API level 21

open fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 21

open fun equals(other: Any?): Boolean

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getDescription

Added in API level 21

open fun getDescription(): CharSequence?

Returns a description suitable for display or null.

Return
`CharSequence?`	A description or null.

getExtras

Added in API level 21

open fun getExtras(): Bundle?

Returns any extras that were added to the description.

Return
`Bundle?`	A bundle of extras or null.

getIconBitmap

Added in API level 21

open fun getIconBitmap(): Bitmap?

Returns a bitmap icon suitable for display or null.

Return
`Bitmap?`	An icon or null.

getIconUri

Added in API level 21

open fun getIconUri(): Uri?

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

Return
`Uri?`	An icon uri or null.

getMediaId

Added in API level 21

open fun getMediaId(): String?

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

getMediaUri

Added in API level 23

open fun getMediaUri(): Uri?

Returns a Uri representing this content or null.

Return
`Uri?`	A media Uri or null.

getSubtitle

Added in API level 21

open fun getSubtitle(): CharSequence?

Returns a subtitle suitable for display or null.

Return
`CharSequence?`	A subtitle or null.

getTitle

Added in API level 21

open fun getTitle(): CharSequence?

Returns a title suitable for display or null.

Return
`CharSequence?`	A title or null.

toString

Added in API level 21

open fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 21

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

Parameters
`dest`	Parcel: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	Int: Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 21

static val CREATOR: Parcelable.Creator<MediaDescription!>