Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction#nestedclasses) \| [Inherited Constants](https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction#inhconstants) \| [Fields](https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction#lfields) \| [Methods](https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction#inhmethods)

# PlaybackState.CustomAction

*** ** * ** ***


`
public
static
final

class
PlaybackState.CustomAction
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


implements

https://developer.android.com/reference/android/os/Parcelable


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.media.session.PlaybackState.CustomAction |

<br />

*** ** * ** ***

`https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction` can be used to extend the capabilities of
the standard transport controls by exposing app specific actions to
`https://developer.android.com/reference/android/media/session/MediaController`.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction.Builder` Builder for `https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction` objects. |

| ### Inherited constants |
|---|
| From interface `https://developer.android.com/reference/android/os/Parcelable` |---|---| | `int` | `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction>` | `https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction#CREATOR` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction#getAction()() ` Returns the action of the `https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction`. |
| ` https://developer.android.com/reference/android/os/Bundle` | ` https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction#getExtras()() ` Returns extras which provide additional application-specific information about the action, or null if none. |
| ` int` | ` https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction#getIcon()() ` Returns the resource id of the icon in the `https://developer.android.com/reference/android/media/session/MediaSession` package. |
| ` https://developer.android.com/reference/java/lang/CharSequence` | ` https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction#getName()() ` Returns the display name of this action. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||
| From interface ` https://developer.android.com/reference/android/os/Parcelable ` |---|---| | ` abstract int` | ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. | | ` abstract void` | ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. | ||

## Fields

### CREATOR

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<PlaybackState.CustomAction> CREATOR
```

<br />

<br />

## Public methods

### describeContents

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### getAction

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getAction ()
```

Returns the action of the `https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | The action of the `https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction`. <br /> |

### getExtras

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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
`https://developer.android.com/reference/android/media/session/MediaController` if it knows how to handle them.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/os/Bundle` | Optional arguments for the `https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction`. <br /> |

### getIcon

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getIcon ()
```

Returns the resource id of the icon in the `https://developer.android.com/reference/android/media/session/MediaSession` package.

<br />

| Returns ||
|---|---|
| `int` | The resource id of the icon in the `https://developer.android.com/reference/android/media/session/MediaSession` package. <br /> |

### getName

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public CharSequence getName ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/CharSequence` | The display name of this `https://developer.android.com/reference/android/media/session/PlaybackState.CustomAction`. <br /> |

### toString

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### writeToParcel

Added in [API level 21](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: The Parcel in which the object should be written. This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |