Android APIs
public static final class

PlaybackState.CustomAction.Builder

extends Object
java.lang.Object
   ↳ android.media.session.PlaybackState.CustomAction.Builder

Class Overview

Builder for PlaybackState.CustomAction objects.

Summary

Public Constructors
PlaybackState.CustomAction.Builder(String action, CharSequence name, int icon)
Creates a PlaybackState.CustomAction builder with the id, name, and icon set.
Public Methods
PlaybackState.CustomAction build()
Build and return the PlaybackState.CustomAction instance with the specified values.
PlaybackState.CustomAction.Builder setExtras(Bundle extras)
Set optional extras for the PlaybackState.CustomAction.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PlaybackState.CustomAction.Builder (String action, CharSequence name, int icon)

Added in API level 21

Creates a PlaybackState.CustomAction builder with the id, name, and icon set.

Parameters
action The action of the PlaybackState.CustomAction.
name The display name of the PlaybackState.CustomAction. This name will be displayed along side the action if the UI supports it.
icon The icon resource id of the PlaybackState.CustomAction. This resource id must be in the same package as the MediaSession. It will be displayed with the custom action if the UI supports it.

Public Methods

public PlaybackState.CustomAction build ()

Added in API level 21

Build and return the PlaybackState.CustomAction instance with the specified values.

Returns

public PlaybackState.CustomAction.Builder setExtras (Bundle extras)

Added in API level 21

Set optional extras for the PlaybackState.CustomAction. These extras are meant to be consumed by a MediaController if it knows how to handle them. Keys should be fully qualified (e.g. "com.example.MY_ARG") to avoid collisions.

Parameters
extras Optional extras for the PlaybackState.CustomAction.
Returns
  • this.