Android APIs
public final class

MediaDescriptionCompat

extends Object
implements Parcelable
java.lang.Object
   ↳ android.support.v4.media.MediaDescriptionCompat

Class Overview

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

Summary

Nested Classes
class MediaDescriptionCompat.Builder Builder for MediaDescriptionCompat objects. 
[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<MediaDescriptionCompat> CREATOR
Public Methods
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
static MediaDescriptionCompat fromMediaDescription(Object descriptionObj)
Creates an instance from a framework MediaDescription object.
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.
Object getMediaDescription()
Gets the underlying framework MediaDescription object.
String getMediaId()
Returns the media id 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 containing a concise, human-readable description of this object.
void writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<MediaDescriptionCompat> CREATOR

Public Methods

public int describeContents ()

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

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public static MediaDescriptionCompat fromMediaDescription (Object descriptionObj)

Creates an instance from a framework MediaDescription object.

This method is only supported on API 21+.

Parameters
descriptionObj A MediaDescription object, or null if none.
Returns

public CharSequence getDescription ()

Returns a description suitable for display or null.

Returns
  • A description or null.

public Bundle getExtras ()

Returns any extras that were added to the description.

Returns
  • A bundle of extras or null.

public Bitmap getIconBitmap ()

Returns a bitmap icon suitable for display or null.

Returns
  • An icon or null.

public Uri getIconUri ()

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

Returns
  • An icon uri or null.

public Object getMediaDescription ()

Gets the underlying framework MediaDescription object.

This method is only supported on LOLLIPOP and later.

Returns

public String getMediaId ()

Returns the media id or null. See METADATA_KEY_MEDIA_ID.

public CharSequence getSubtitle ()

Returns a subtitle suitable for display or null.

Returns
  • A subtitle or null.

public CharSequence getTitle ()

Returns a title suitable for display or null.

Returns
  • A title or null.

public String toString ()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression: 

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.

public void writeToParcel (Parcel dest, int flags)

Flatten this object in to a Parcel.

Parameters
dest The Parcel in which the object should be written.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.