Added in API level 21

Summary: Nested Classes | Constants | Inherited Constants | Fields | Methods | Inherited Methods

MediaDescription

---

Kotlin |Java

public class MediaDescription
extends Object implements Parcelable

java.lang.Object
↳	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
class	MediaDescription.Builder Builder for MediaDescription objects.

Constants
long	BT_FOLDER_TYPE_ALBUMS 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.
long	BT_FOLDER_TYPE_ARTISTS 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.
long	BT_FOLDER_TYPE_GENRES 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.
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.10.2.2 of the Bluetooth AVRCP 1.5.
long	BT_FOLDER_TYPE_PLAYLISTS 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.
long	BT_FOLDER_TYPE_TITLES The type of folder that contains media elements only as specified in the section 6.10.2.2 of the Bluetooth AVRCP 1.5.
long	BT_FOLDER_TYPE_YEARS 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.
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.10.2.2 of the Bluetooth AVRCP 1.5.

Inherited constants

From interface android.os.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(Parcel, int): 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)".

Fields
public static final Creator<MediaDescription>	CREATOR

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
CharSequence	getDescription() Returns a description suitable for display or null.
Bundle	getExtras() Returns any extras that were added to the description.
Bitmap	getIconBitmap() Returns a bitmap icon suitable for display or null.
Uri	getIconUri() Returns a Uri for an icon suitable for display or null.
String	getMediaId() Returns the media id or null.
Uri	getMediaUri() Returns a Uri representing this content or null.
CharSequence	getSubtitle() Returns a subtitle suitable for display or null.
CharSequence	getTitle() Returns a title suitable for display or null.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Constants

BT_FOLDER_TYPE_ALBUMS

Added in API level 26

public static final long BT_FOLDER_TYPE_ALBUMS

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.

Constant Value: 2 (0x0000000000000002)

BT_FOLDER_TYPE_ARTISTS

Added in API level 26

public static final long BT_FOLDER_TYPE_ARTISTS

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.

Constant Value: 3 (0x0000000000000003)

BT_FOLDER_TYPE_GENRES

Added in API level 26

public static final long BT_FOLDER_TYPE_GENRES

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.

Constant Value: 4 (0x0000000000000004)

BT_FOLDER_TYPE_MIXED

Added in API level 26

public static final 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.10.2.2 of the Bluetooth AVRCP 1.5.

Constant Value: 0 (0x0000000000000000)

BT_FOLDER_TYPE_PLAYLISTS

Added in API level 26

public static final long BT_FOLDER_TYPE_PLAYLISTS

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.

Constant Value: 5 (0x0000000000000005)

BT_FOLDER_TYPE_TITLES

Added in API level 26

public static final long BT_FOLDER_TYPE_TITLES

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

Constant Value: 1 (0x0000000000000001)

BT_FOLDER_TYPE_YEARS

Added in API level 26

public static final long BT_FOLDER_TYPE_YEARS

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.

Constant Value: 6 (0x0000000000000006)

EXTRA_BT_FOLDER_TYPE

Added in API level 26

public static final 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.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

See also:

• getExtras()

Constant Value: "android.media.extra.BT_FOLDER_TYPE"

Fields

CREATOR

Added in API level 21

public static final Creator<MediaDescription> CREATOR

Public methods

describeContents

Added in API level 21

public int describeContents ()

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.

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

equals

Added in API level 21

public boolean equals (Object o)

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
o	Object: the reference object with which to compare.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getDescription

Added in API level 21

public CharSequence getDescription ()

Returns a description suitable for display or null.

Returns
CharSequence	A description or null.

getExtras

Added in API level 21

public Bundle getExtras ()

Returns any extras that were added to the description.

Returns
Bundle	A bundle of extras or null.

getIconBitmap

Added in API level 21

public Bitmap getIconBitmap ()

Returns a bitmap icon suitable for display or null.

Returns
Bitmap	An icon or null.

getIconUri

Added in API level 21

public Uri getIconUri ()

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

Returns
Uri	An icon uri or null.

getMediaId

Added in API level 21

public String getMediaId ()

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

Returns
String

getMediaUri

Added in API level 23

public Uri getMediaUri ()

Returns a Uri representing this content or null.

Returns
Uri	A media Uri or null.

getSubtitle

Added in API level 21

public CharSequence getSubtitle ()

Returns a subtitle suitable for display or null.

Returns
CharSequence	A subtitle or null.

getTitle

Added in API level 21

public CharSequence getTitle ()

Returns a title suitable for display or null.

Returns
CharSequence	A title or null.

toString

Added in API level 21

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 21

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES