CustomAction

Kotlin |Java

class CustomAction : Parcelable

kotlin.Any
↳	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
	`Builder` Builder for `CustomAction` objects.

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 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.
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<PlaybackState.CustomAction!>	`CREATOR`

Public methods

describeContents

Added in API level 21

fun describeContents(): Int

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 `CONTENTS_FILE_DESCRIPTOR`

getAction

Added in API level 21

fun getAction(): String!

Returns the action of the CustomAction.

Return
`String!`	The action of the `CustomAction`.

getExtras

Added in API level 21

fun getExtras(): Bundle!

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.

Return
`Bundle!`	Optional arguments for the `CustomAction`.

getIcon

Added in API level 21

fun getIcon(): Int

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

Return
`Int`	The resource id of the icon in the `MediaSession's` package.

getName

Added in API level 21

fun getName(): CharSequence!

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

Return
`CharSequence!`	The display name of this `CustomAction`.

toString

Added in API level 21

fun toString(): String

Returns a string representation of the object.

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 21

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

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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `PARCELABLE_WRITE_RETURN_VALUE`

Properties

CREATOR

Added in API level 21

static val CREATOR: Parcelable.Creator<PlaybackState.CustomAction!>