added in version 22.1.0
belongs to Maven artifact androidx.media:media:1.0.0-beta01

PlaybackStateCompat.CustomAction

public static final class PlaybackStateCompat.CustomAction
extends Object implements Parcelable

java.lang.Object
   ↳ android.support.v4.media.session.PlaybackStateCompat.CustomAction


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

Summary

Nested classes

class PlaybackStateCompat.CustomAction.Builder

Builder for PlaybackStateCompat.CustomAction objects. 

Inherited constants

Fields

public static final Creator<PlaybackStateCompat.CustomAction> CREATOR

Public methods

int describeContents()
static PlaybackStateCompat.CustomAction fromCustomAction(Object customActionObj)

Creates an instance from a framework PlaybackState.CustomAction object.

String getAction()

Returns the action of the PlaybackStateCompat.CustomAction.

Object getCustomAction()

Gets the underlying framework PlaybackState.CustomAction object.

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 Session's package.

CharSequence getName()

Returns the display name of this action.

String toString()
void writeToParcel(Parcel dest, int flags)

Inherited methods

Fields

CREATOR

added in version 22.1.0
public static final Creator<PlaybackStateCompat.CustomAction> CREATOR

Public methods

describeContents

added in version 22.1.0
public int describeContents ()

Returns
int

fromCustomAction

added in version 24.1.0
public static PlaybackStateCompat.CustomAction fromCustomAction (Object customActionObj)

Creates an instance from a framework PlaybackState.CustomAction object.

This method is only supported on API 21+.

Parameters
customActionObj Object: A PlaybackState.CustomAction object, or null if none.

Returns
PlaybackStateCompat.CustomAction An equivalent PlaybackStateCompat.CustomAction object, or null if none.

getAction

added in version 22.1.0
public String getAction ()

Returns the action of the PlaybackStateCompat.CustomAction.

Returns
String The action of the PlaybackStateCompat.CustomAction.

getCustomAction

added in version 24.1.0
public Object getCustomAction ()

Gets the underlying framework PlaybackState.CustomAction object.

This method is only supported on API 21+.

Returns
Object An equivalent PlaybackState.CustomAction object, or null if none.

getExtras

added in version 22.1.0
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 MediaControllerCompat if it knows how to handle them.

Returns
Bundle Optional arguments for the PlaybackStateCompat.CustomAction.

getIcon

added in version 22.1.0
public int getIcon ()

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

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

getName

added in version 22.1.0
public CharSequence getName ()

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

Returns
CharSequence The display name of this PlaybackStateCompat.CustomAction.

toString

public String toString ()

Returns
String

writeToParcel

added in version 22.1.0
public void writeToParcel (Parcel dest, 
                int flags)

Parameters
dest Parcel

flags int