Session2Command
classSession2Command: 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 | |
|---|---|
|
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 |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| 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()Returns a hash code value for the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<Session2Command!> | |
Constants
COMMAND_CODE_CUSTOM
static valCOMMAND_CODE_CUSTOM: Int
Deprecated: Deprecated in Java.
Command code for the custom command which can be defined by string action in the Session2Command.
Value: 0Public 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
fundescribeContents(): 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
|
equals
funequals(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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons 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
fungetCommandCode(): Int
Deprecated: Deprecated in Java.
Gets the command code of a predefined command. This will return COMMAND_CODE_CUSTOM for a custom command.
getCustomAction
fungetCustomAction(): String?
Deprecated: Deprecated in Java.
Gets the action of a custom command. This will return null for a predefined command.
getCustomExtras
fungetCustomExtras(): Bundle?
Deprecated: Deprecated in Java.
Gets the extra bundle of a custom command. This will return null for a predefined command.
hashCode
funhashCode(): 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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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. |
writeToParcel
funwriteToParcel(
dest: Parcel,
flags: Int
): Unit
Deprecated: Deprecated in Java.
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 the following:
|
Properties
CREATOR
static valCREATOR: Parcelable.Creator<Session2Command!>
Deprecated: Deprecated in Java.