Most visited

Recently visited

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.

MediaDescriptionCompat getDescription()

Get the description for this item.

long getQueueId()

Get the queue id for this item.

Object getQueueItem()

Get the underlying MediaSession.QueueItem.

static MediaSessionCompat.QueueItem obtain(Object queueItem)

Obtain a compat wrapper for an existing 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

int UNKNOWN_ID

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

Constant Value: -1 (0xffffffff)

Fields

Public constructors

MediaSessionCompat.QueueItem

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

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.

getDescription

MediaDescriptionCompat getDescription ()

Get the description for this item.

Returns
MediaDescriptionCompat

getQueueId

long getQueueId ()

Get the queue id for this item.

Returns
long

getQueueItem

Object getQueueItem ()

Get the underlying MediaSession.QueueItem.

On builds before LOLLIPOP null is returned.

Returns
Object The underlying MediaSession.QueueItem or null.

obtain

MediaSessionCompat.QueueItem obtain (Object queueItem)

Obtain a compat wrapper for an existing QueueItem.

Parameters
queueItem Object: The MediaSession.QueueItem to wrap.
Returns
MediaSessionCompat.QueueItem A compat wrapper for the provided item.

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!