Added in API level 21

Summary: Nested Classes | Inherited Constants | Fields | Methods | Inherited Methods

PlaybackState.CustomAction

Kotlin |Java

public static final class PlaybackState.CustomAction
extends Object implements Parcelable

java.lang.Object
↳	android.media.session.PlaybackState.CustomAction

CustomActions can be used to extend the capabilities of the standard transport controls by exposing app specific actions to MediaControllers.

Summary

Nested classes
`class`	`PlaybackState.CustomAction.Builder` Builder for `CustomAction` objects.

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<PlaybackState.CustomAction>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`String`	`getAction()` Returns the action of the `CustomAction`.
`Bundle`	`getExtras()` Returns extras which provide additional application-specific information about the action, or null if none.
`int`	`getIcon()` Returns the resource id of the icon in the `MediaSession's` package.
`CharSequence`	`getName()` Returns the display name of this action.
`String`	`toString()` Returns a string representation of 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 timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

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.

Fields

CREATOR

Added in API level 21

public static final Creator<PlaybackState.CustomAction> CREATOR

Public methods

describeContents

Added in API level 21

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`

getAction

Added in API level 21

public String getAction ()

Returns the action of the CustomAction.

Returns
`String`	The action of the `CustomAction`.

getExtras

Added in API level 21

public Bundle getExtras ()

Returns extras which provide additional application-specific information about the action, or null if none. These arguments are meant to be consumed by a MediaController if it knows how to handle them.

Returns
`Bundle`	Optional arguments for the `CustomAction`.

getIcon

Added in API level 21

public int getIcon ()

Returns the resource id of the icon in the MediaSession's package.

Returns
`int`	The resource id of the icon in the `MediaSession's` package.

getName

Added in API level 21

public CharSequence getName ()

Returns the display name of this action. e.g. "Favorite"

Returns
`CharSequence`	The display name of this `CustomAction`.

toString

Added in API level 21

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 21

public void writeToParcel (Parcel dest, 
                int flags)

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

PlaybackState.CustomAction

Summary

Nested classes

Inherited constants

Fields

Public methods

Inherited methods

Fields

CREATOR

Public methods

describeContents

getAction

getExtras

getIcon

getName

toString

writeToParcel