Added in API level 21

MediaDescription


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 for MediaDescription 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.

Inherited constants
Public methods
open Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

open Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

open CharSequence?

Returns a description suitable for display or null.

open Bundle?

Returns any extras that were added to the description.

open Bitmap?

Returns a bitmap icon suitable for display or null.

open Uri?

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

open String?

Returns the media id or null.

open Uri?

Returns a Uri representing this content or null.

open CharSequence?

Returns a subtitle suitable for display or null.

open CharSequence?

Returns a title suitable for display or null.

open String

Returns a string representation of the object.

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

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<MediaDescription!>

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:

Value: "android.media.extra.BT_FOLDER_TYPE"

See Also

Public methods

describeContents

Added in API level 21
open fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

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

equals

Added in API level 21
open fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

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

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

Added in API level 21
open fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

Flatten this object in to a Parcel.

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 the following:

Properties

CREATOR

Added in API level 21
static val CREATOR: Parcelable.Creator<MediaDescription!>