added in version 22.1.0
belongs to Maven artifact com.android.support:support-media-compat:28.0.0-alpha1
Summary: Constants | Inherited Constants | Fields | Ctors | Methods | Inherited Methods | [Expand All]

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)

Creates a new MediaSessionCompat.QueueItem.

Public methods

int describeContents()
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()

Gets the description for this item.

long getQueueId()

Gets the queue id for this item.

Object getQueueItem()

Gets the underlying MediaSession.QueueItem.

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

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Constants

UNKNOWN_ID

added in version 22.1.0 
int UNKNOWN_ID

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

Constant Value: -1 (0xffffffff)

Fields

CREATOR

added in version 22.1.0 
Creator<MediaSessionCompat.QueueItem> CREATOR

Public constructors

MediaSessionCompat.QueueItem

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

Creates 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.1.0
int describeContents ()

Returns
int

fromQueueItem

added in version 25.1.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 25.1.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.1.0
MediaDescriptionCompat getDescription ()

Gets the description for this item.

Returns
MediaDescriptionCompat

getQueueId

added in version 22.1.0
long getQueueId ()

Gets the queue id for this item.

Returns
long

getQueueItem

added in version 22.1.0
Object getQueueItem ()

Gets the underlying MediaSession.QueueItem.

On builds before LOLLIPOP null is returned.

Returns
Object The underlying MediaSession.QueueItem or null.

toString

String toString ()

Returns
String

writeToParcel

added in version 22.1.0
void writeToParcel (Parcel dest,
                int flags)

Parameters
dest Parcel

flags int