Added in API level 21

CustomAction


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 for CustomAction objects.

Inherited constants
Public methods
Int

String!

Returns the action of the CustomAction.

Bundle!

Returns extras which provide additional application-specific information about the action, or null if none.

Int

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

CharSequence!

Returns the display name of this action.

String

Unit
writeToParcel(dest: Parcel, flags: Int)

Properties
static Parcelable.Creator<PlaybackState.CustomAction!>

Public methods

describeContents

Added in API level 21
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

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
Return
String a string representation of the object.

writeToParcel

Added in API level 21
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit
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 android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 21
static val CREATOR: Parcelable.Creator<PlaybackState.CustomAction!>