Most visited

Recently visited

Results for

Session2Command

public final class Session2Command
extends Object implements Parcelable

java.lang.Object
↳	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
`class`	`Session2Command.Result` This API is not generally intended for third party application developers.

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

Inherited constants

From interface android.os.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(Parcel, int)`: 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)`".

Fields
`public static final Creator<Session2Command>`	`CREATOR`

Public constructors
`Session2Command(int commandCode)` Constructor for creating a command predefined in AndroidX media2.
`Session2Command(String action, Bundle extras)` Constructor for creating a custom command.

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean`	`equals(Object obj)` 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()` Returns a hash code value for the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

COMMAND_CODE_CUSTOM

public static final int COMMAND_CODE_CUSTOM

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

Constant Value: 0 (0x00000000)

Fields

CREATOR

public static final Creator<Session2Command> CREATOR

Public constructors

Session2Command

public Session2Command (int commandCode)

Constructor for creating a command predefined in AndroidX media2.

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

Session2Command

public Session2Command (String action, 
                Bundle extras)

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

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

public boolean equals (Object obj)

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
`obj`	`Object`: This value may be `null`.

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

getCommandCode

public int getCommandCode ()

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

Returns
`int`

getCustomAction

public String getCustomAction ()

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

Returns
`String`

getCustomExtras

public Bundle getCustomExtras ()

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

Returns
`Bundle`

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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(Object) 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(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
`int`	a hash code value for this object.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Annotations

Interfaces

Classes

Exceptions

Most visited

Recently visited

Results for

Session2Command

Summary

Nested classes

Constants

Inherited constants

Fields

Public constructors

Public methods

Inherited methods

Constants

COMMAND_CODE_CUSTOM

Fields

CREATOR

Public constructors

Session2Command

Session2Command

Public methods

describeContents

equals

getCommandCode

getCustomAction

getCustomExtras

hashCode

writeToParcel