Skip to content

Most visited

Recently visited

navigation

MediaSessionCompat.QueueItem

public static final class MediaSessionCompat.QueueItem
extends Object implements Parcelable

java.lang.Object
   ↳ android.support.v4.media.session.MediaSessionCompat.QueueItem


A single item that is part of the play queue. It contains a description of the item and its id in the queue.

Summary

Constants

int UNKNOWN_ID

This id is reserved.

Inherited constants

From interface android.os.Parcelable

Fields

public static final Creator<MediaSessionCompat.QueueItem> CREATOR

Public constructors

MediaSessionCompat.QueueItem(MediaDescriptionCompat description, long id)

Create a new MediaSessionCompat.QueueItem.

Public methods

int describeContents()

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

static MediaSessionCompat.QueueItem fromQueueItem(Object queueItem)

Creates an instance from a framework MediaSession.QueueItem object.

static List<MediaSessionCompat.QueueItem> fromQueueItemList(List<?> itemList)

Creates a list of MediaSessionCompat.QueueItem objects from a framework MediaSession.QueueItem object list.

MediaDescriptionCompat getDescription()

Get the description for this item.

long getQueueId()

Get the queue id for this item.

Object getQueueItem()

Get the underlying MediaSession.QueueItem.

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

Constants

UNKNOWN_ID

added in version 22.0.0
int UNKNOWN_ID

This id is reserved. No items can be explicitly assigned this id.

Constant Value: -1 (0xffffffff)

Fields

Public constructors

MediaSessionCompat.QueueItem

added in version 22.0.0
MediaSessionCompat.QueueItem (MediaDescriptionCompat description, 
                long id)

Create a new MediaSessionCompat.QueueItem.

Parameters
description MediaDescriptionCompat: The MediaDescriptionCompat for this item.

id long: An identifier for this item. It must be unique within the play queue and cannot be UNKNOWN_ID.

Public methods

describeContents

added in version 22.0.0
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.

fromQueueItem

added in version 24.2.0
MediaSessionCompat.QueueItem fromQueueItem (Object queueItem)

Creates an instance from a framework MediaSession.QueueItem object.

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

Parameters
queueItem Object: A MediaSession.QueueItem object.

Returns
MediaSessionCompat.QueueItem An equivalent MediaSessionCompat.QueueItem object, or null if none.

fromQueueItemList

added in version 24.2.0
List<MediaSessionCompat.QueueItem> fromQueueItemList (List<?> itemList)

Creates a list of MediaSessionCompat.QueueItem objects from a framework MediaSession.QueueItem object list.

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

Parameters
itemList List: A list of MediaSession.QueueItem objects.

Returns
List<MediaSessionCompat.QueueItem> An equivalent list of MediaSessionCompat.QueueItem objects, or null if none.

getDescription

added in version 22.0.0
MediaDescriptionCompat getDescription ()

Get the description for this item.

Returns
MediaDescriptionCompat

getQueueId

added in version 22.0.0
long getQueueId ()

Get the queue id for this item.

Returns
long

getQueueItem

added in version 22.0.0
Object getQueueItem ()

Get the underlying MediaSession.QueueItem.

On builds before LOLLIPOP null is returned.

Returns
Object The underlying MediaSession.QueueItem 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

added in version 22.0.0
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.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.