Session2Token

Kotlin |Java

class Session2Token : Parcelable

kotlin.Any
↳	android.media.Session2Token

This API is not generally intended for third party application developers. Use the AndroidX Media3 session Library for consistent behavior across all devices.

Represents an ongoing MediaSession2 or a MediaSession2Service. If it's representing a session service, it may not be ongoing.

This may be passed to apps by the session owner to allow them to create a MediaController2 to communicate with the session.

It can be also obtained by android.media.session.MediaSessionManager.

Summary

Constants
static Int	`TYPE_SESSION` Type for `MediaSession2`.
static Int	`TYPE_SESSION_SERVICE` Type for `MediaSession2Service`.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
`Session2Token(context: Context, serviceComponent: ComponentName)` Constructor for the token with type `TYPE_SESSION_SERVICE`.

Public methods
Int	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
Bundle	`getExtras()`
String	`getPackageName()`
String?	`getServiceName()`
Int	`getType()`
Int	`getUid()`
Int	`hashCode()` Returns a hash code value for the object.
String	`toString()` Returns a string representation of the object.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<Session2Token!>	`CREATOR`

Constants

TYPE_SESSION

Added in API level 29

static val TYPE_SESSION: Int

Deprecated: Deprecated in Java.

Type for MediaSession2.

Value: 0

TYPE_SESSION_SERVICE

Added in API level 29

static val TYPE_SESSION_SERVICE: Int

Deprecated: Deprecated in Java.

Type for MediaSession2Service.

Value: 1

Public constructors

Session2Token

Added in API level 29

Session2Token(
    context: Context, 
    serviceComponent: ComponentName)

Constructor for the token with type TYPE_SESSION_SERVICE.

Parameters
`context`	Context: The context. This value cannot be `null`.
`serviceComponent`	ComponentName: The component name of the service. This value cannot be `null`.

Public methods

describeContents

Added in API level 29

fun describeContents(): Int

Deprecated: Deprecated in Java.

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.

Return
`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 29

fun equals(other: Any?): Boolean

Deprecated: Deprecated in Java.

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
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getExtras

Added in API level 29

fun getExtras(): Bundle

Deprecated: Deprecated in Java.

Return
`Bundle`	extras of the token. This value cannot be `null`.

See Also

android.media.MediaSession2.Builder#setExtras(Bundle)

getPackageName

Added in API level 29

fun getPackageName(): String

Deprecated: Deprecated in Java.

Return
`String`	package name of the session. This value cannot be `null`.

getServiceName

Added in API level 29

fun getServiceName(): String?

Deprecated: Deprecated in Java.

Return
`String?`	service name of the session. Can be `null` for `TYPE_SESSION`.

getType

Added in API level 29

fun getType(): Int

Deprecated: Deprecated in Java.

Return
`Int`	type of the token. Value is one of the following: `TYPE_SESSION` `TYPE_SESSION_SERVICE`

See Also

#TYPE_SESSION
#TYPE_SESSION_SERVICE

getUid

Added in API level 29

fun getUid(): Int

Deprecated: Deprecated in Java.

Return
`Int`	uid of the session

hashCode

Added in API level 29

fun hashCode(): Int

Deprecated: Deprecated in Java.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Return
`Int`	a hash code value for this object.

toString

Added in API level 29

fun toString(): String

Deprecated: Deprecated in Java.

Returns a string representation of the object.

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 29

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Deprecated: Deprecated in Java.

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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 29

static val CREATOR: Parcelable.Creator<Session2Token!>

Deprecated: Deprecated in Java.