Session2Command
class Session2Command : Parcelable
kotlin.Any | |
↳ | android.media.Session2Command |
This API is not generally intended for third party application developers. Use the AndroidX Media2 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
.
Refer to the AndroidX SessionCommand class for the list of valid commands.
Summary
Nested classes | |
---|---|
This API is not generally intended for third party application developers. |
Constants | |
---|---|
static Int |
Command code for the custom command which can be defined by string action in the |
Inherited constants | |
---|---|
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 | |
Boolean |
Indicates whether some other object is "equal to" this one. |
Int |
Gets the command code of a predefined command. |
String? |
Gets the action of a custom command. |
Bundle? |
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!> |
Constants
COMMAND_CODE_CUSTOM
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
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
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
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
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
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
fun getCommandCode(): Int
Gets the command code of a predefined command. This will return COMMAND_CODE_CUSTOM
for a custom command.
getCustomAction
fun getCustomAction(): String?
Gets the action of a custom command. This will return null
for a predefined command.
getCustomExtras
fun getCustomExtras(): Bundle?
Gets the extra bundle of a custom command. This will return null
for a predefined command.
writeToParcel
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 |