PlaybackState.CustomAction

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

Inherited constants

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 PlaybackState.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

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(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.

getAction

added in API level 21
public String getAction ()

Returns the action of the PlaybackState.CustomAction.

Returns
String The action of the PlaybackState.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 PlaybackState.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 PlaybackState.CustomAction.

toString

added in API level 21
public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

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.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.