MediaBrowserCompat.MediaItem

public static class MediaBrowserCompat.MediaItem
extends Object implements Parcelable

java.lang.Object
   ↳ android.support.v4.media.MediaBrowserCompat.MediaItem


A class with information on a single media item for use in browsing/searching media. MediaItems are application dependent so we cannot guarantee that they contain the right values.

Summary

Constants

int FLAG_BROWSABLE

Flag: Indicates that the item has children of its own.

int FLAG_PLAYABLE

Flag: Indicates that the item is playable.

Inherited constants

Fields

public static final Creator<MediaBrowserCompat.MediaItem> CREATOR

Public constructors

MediaBrowserCompat.MediaItem(MediaDescriptionCompat description, int flags)

Create a new MediaItem for use in browsing media.

Public methods

int describeContents()
static MediaBrowserCompat.MediaItem fromMediaItem(Object itemObj)

Creates an instance from a framework MediaBrowser.MediaItem object.

static List<MediaBrowserCompat.MediaItem> fromMediaItemList(List<?> itemList)

Creates a list of MediaBrowserCompat.MediaItem objects from a framework MediaBrowser.MediaItem object list.

MediaDescriptionCompat getDescription()

Returns the description of the media.

int getFlags()

Gets the flags of the item.

String getMediaId()

Returns the media id in the MediaDescriptionCompat for this item.

boolean isBrowsable()

Returns whether this item is browsable.

boolean isPlayable()

Returns whether this item is playable.

String toString()
void writeToParcel(Parcel out, int flags)

Inherited methods

Constants

FLAG_BROWSABLE

public static final int FLAG_BROWSABLE

Flag: Indicates that the item has children of its own.

Constant Value: 1 (0x00000001)

FLAG_PLAYABLE

public static final int FLAG_PLAYABLE

Flag: Indicates that the item is playable.

The id of this item may be passed to MediaControllerCompat.TransportControls.playFromMediaId(String, Bundle) to start playing it.

Constant Value: 2 (0x00000002)

Fields

CREATOR

public static final Creator<MediaBrowserCompat.MediaItem> CREATOR

Public constructors

MediaBrowserCompat.MediaItem

public MediaBrowserCompat.MediaItem (MediaDescriptionCompat description, 
                int flags)

Create a new MediaItem for use in browsing media.

Parameters
description MediaDescriptionCompat: The description of the media, which must include a media id.

flags int: The flags for this item.

Public methods

describeContents

public int describeContents ()

Returns
int

fromMediaItem

public static MediaBrowserCompat.MediaItem fromMediaItem (Object itemObj)

Creates an instance from a framework MediaBrowser.MediaItem object.

This method is only supported on API 21+. On API 20 and below, it returns null.

Parameters
itemObj Object: A MediaBrowser.MediaItem object.

Returns
MediaBrowserCompat.MediaItem An equivalent MediaBrowserCompat.MediaItem object, or null if none.

fromMediaItemList

public static List<MediaBrowserCompat.MediaItem> fromMediaItemList (List<?> itemList)

Creates a list of MediaBrowserCompat.MediaItem objects from a framework MediaBrowser.MediaItem object list.

This method is only supported on API 21+. On API 20 and below, it returns null.

Parameters
itemList List: A list of MediaBrowser.MediaItem objects.

Returns
List<MediaBrowserCompat.MediaItem> An equivalent list of MediaBrowserCompat.MediaItem objects, or null if none.

getDescription

public MediaDescriptionCompat getDescription ()

Returns the description of the media.

Returns
MediaDescriptionCompat

getFlags

public int getFlags ()

Gets the flags of the item.

Returns
int

getMediaId

public String getMediaId ()

Returns the media id in the MediaDescriptionCompat for this item.

Returns
String

isBrowsable

public boolean isBrowsable ()

Returns whether this item is browsable.

Returns
boolean

See also:

isPlayable

public boolean isPlayable ()

Returns whether this item is playable.

Returns
boolean

See also:

toString

public String toString ()

Returns
String

writeToParcel

public void writeToParcel (Parcel out, 
                int flags)

Parameters
out Parcel

flags int