Session2Command

Kotlin |Java

class Session2Command : Parcelable

kotlin.Any
↳	android.media.Session2Command

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

Define a command that a MediaController2 can send to a MediaSession2.

If getCommandCode() isn't COMMAND_CODE_CUSTOM), it's predefined command. If getCommandCode() is COMMAND_CODE_CUSTOM), it's custom command and getCustomAction() shouldn't be null.

Summary

Nested classes
	`Result` This API is not generally intended for third party application developers.

Constants
static Int	`COMMAND_CODE_CUSTOM` Command code for the custom command which can be defined by string action in the `Session2Command`.

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
`Session2Command(commandCode: Int)` Constructor for creating a command predefined in AndroidX media2.
`Session2Command(action: String, extras: Bundle?)` Constructor for creating a custom command.

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
Int	`getCommandCode()` Gets the command code of a predefined command.
String?	`getCustomAction()` Gets the action of a custom command.
Bundle?	`getCustomExtras()` Gets the extra bundle of a custom command.
Int	`hashCode()`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

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

Constants

COMMAND_CODE_CUSTOM

Added in API level 29

static val COMMAND_CODE_CUSTOM: Int

Command code for the custom command which can be defined by string action in the Session2Command.

Value: 0

Public constructors

Session2Command

Added in API level 29

Session2Command(commandCode: Int)

Constructor for creating a command predefined in AndroidX media2.

Parameters
`commandCode`	Int: A command code for a command predefined in AndroidX media2.

Session2Command

Added in API level 29

Session2Command(
    action: String, 
    extras: Bundle?)

Constructor for creating a custom command.

Parameters
`action`	String: The action of this custom command. This value cannot be `null`.
`extras`	Bundle?: An extra bundle for this custom command. This value may be `null`.

Public methods

describeContents

Added in API level 29

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 29

fun equals(other: Any?): Boolean

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`	This value may be `null`.

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

getCommandCode

Added in API level 29

fun getCommandCode(): Int

Gets the command code of a predefined command. This will return COMMAND_CODE_CUSTOM for a custom command.

getCustomAction

Added in API level 29

fun getCustomAction(): String?

Gets the action of a custom command. This will return null for a predefined command.

getCustomExtras

Added in API level 29

fun getCustomExtras(): Bundle?

Gets the extra bundle of a custom command. This will return null for a predefined command.

hashCode

Added in API level 29

fun hashCode(): Int

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

writeToParcel

Added in API level 29

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

Flatten this object in to a Parcel.

Parameters
`dest`	Parcel: 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 `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 29

static val CREATOR: Parcelable.Creator<Session2Command!>