Most visited

Recently visited

MediaDescriptionCompat

public final class MediaDescriptionCompat
extends Object implements Parcelable

java.lang.Object
   ↳ 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 getDescription().

Summary

Nested classes

class MediaDescriptionCompat.Builder

Builder for MediaDescriptionCompat objects. 

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 instance's marshaled 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.

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
From interface android.os.Parcelable

Fields

CREATOR

Creator<MediaDescriptionCompat> CREATOR

Public methods

describeContents

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

fromMediaDescription

MediaDescriptionCompat fromMediaDescription (Object descriptionObj)

Creates an instance from a framework MediaDescription object.

This method is only supported on API 21+.

Parameters
descriptionObj Object: A MediaDescription object, or null if none.
Returns
MediaDescriptionCompat An equivalent MediaMetadataCompat object, or null if none.

getDescription

CharSequence getDescription ()

Returns a description suitable for display or null.

Returns
CharSequence A description or null.

getExtras

Bundle getExtras ()

Returns any extras that were added to the description.

Returns
Bundle A bundle of extras or null.

getIconBitmap

Bitmap getIconBitmap ()

Returns a bitmap icon suitable for display or null.

Returns
Bitmap An icon or null.

getIconUri

Uri getIconUri ()

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

Returns
Uri An icon uri or null.

getMediaDescription

Object getMediaDescription ()

Gets the underlying framework MediaDescription object.

This method is only supported on LOLLIPOP and later.

Returns
Object An equivalent MediaDescription object, or null if none.

getMediaId

String getMediaId ()

Returns the media id or null. See METADATA_KEY_MEDIA_ID.

Returns
String

getMediaUri

Uri getMediaUri ()

Returns a Uri representing this content or null.

Returns
Uri A media Uri or null.

getSubtitle

CharSequence getSubtitle ()

Returns a subtitle suitable for display or null.

Returns
CharSequence A subtitle or null.

getTitle

CharSequence getTitle ()

Returns a title suitable for display or null.

Returns
CharSequence A title or null.

toString

String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

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

Returns
String a string representation of the object.

writeToParcel

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.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

Hooray!