MediaSession.QueueItem

public static final class MediaSession.QueueItem
extends Object implements Parcelable

java.lang.Object
   ↳ android.media.session.MediaSession.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

Fields

public static final Creator<MediaSession.QueueItem> CREATOR

Public constructors

QueueItem(MediaDescription description, long id)

Create a new MediaSession.QueueItem.

Public methods

int describeContents()

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

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

MediaDescription getDescription()

Get the description for this item.

long getQueueId()

Get the queue id for this item.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

UNKNOWN_ID

Added in API level 21
public static final int UNKNOWN_ID

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

Constant Value: -1 (0xffffffff)

Fields

CREATOR

Added in API level 21
public static final Creator<MediaSession.QueueItem> CREATOR

Public constructors

QueueItem

Added in API level 21
public QueueItem (MediaDescription description, 
                long id)

Create a new MediaSession.QueueItem.

Parameters
description MediaDescription: The MediaDescription 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 API level 21
public 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(android.os.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. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 21
public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getDescription

Added in API level 21
public MediaDescription getDescription ()

Get the description for this item.

Returns
MediaDescription

getQueueId

Added in API level 21
public long getQueueId ()

Get the queue id for this item.

Returns
long

toString

Added in API level 21
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 21
public 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. This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES