PlaybackStateCompat.Builder

public final class PlaybackStateCompat.Builder


Builder for PlaybackStateCompat objects.

Summary

Public constructors

Create an empty Builder.

Create a Builder using a PlaybackStateCompat instance to set the initial values.

Public methods

PlaybackStateCompat.Builder

Add a custom action to the playback state.

PlaybackStateCompat.Builder
addCustomAction(String action, String name, int icon)

Add a custom action to the playback state.

PlaybackStateCompat

Creates the playback state object.

PlaybackStateCompat.Builder
setActions(long capabilities)

Set the current capabilities available on this session.

PlaybackStateCompat.Builder

Set the active item in the play queue by specifying its id.

PlaybackStateCompat.Builder
setBufferedPosition(long bufferPosition)

Set the current buffered position in ms.

PlaybackStateCompat.Builder

This method is deprecated.

Use setErrorMessage instead.

PlaybackStateCompat.Builder
setErrorMessage(
    @PlaybackStateCompat.ErrorCode int errorCode,
    CharSequence errorMessage
)

Set the error code with an optional user readable error message.

PlaybackStateCompat.Builder
setExtras(Bundle extras)

Set any custom extras to be included with the playback state.

PlaybackStateCompat.Builder
setState(int state, long position, float playbackSpeed)

Set the current state of playback.

PlaybackStateCompat.Builder
setState(int state, long position, float playbackSpeed, long updateTime)

Set the current state of playback.

Public constructors

Builder

Added in 1.1.0
public Builder()

Create an empty Builder.

Builder

Added in 1.1.0
public Builder(PlaybackStateCompat source)

Create a Builder using a PlaybackStateCompat instance to set the initial values.

Parameters
PlaybackStateCompat source

The playback state to copy.

Public methods

addCustomAction

Added in 1.1.0
public PlaybackStateCompat.Builder addCustomAction(PlaybackStateCompat.CustomAction customAction)

Add a custom action to the playback state. Actions can be used to expose additional functionality to Controllers beyond what is offered by the standard transport controls.

An example of an action would be to start a radio station based on the current item or to skip ahead by 30 seconds.

Parameters
PlaybackStateCompat.CustomAction customAction

The custom action to add to the PlaybackStateCompat.

addCustomAction

Added in 1.1.0
public PlaybackStateCompat.Builder addCustomAction(String action, String name, int icon)

Add a custom action to the playback state. Actions can be used to expose additional functionality to Controllers beyond what is offered by the standard transport controls.

e.g. start a radio station based on the current item or skip ahead by 30 seconds.

Parameters
String action

An identifier for this action. It can be sent back to the MediaSessionCompat through sendCustomAction.

String name

The display name for the action. If text is shown with the action or used for accessibility, this is what should be used.

int icon

The resource action of the icon that should be displayed for the action. The resource should be in the package of the MediaSessionCompat.

build

Added in 1.1.0
public PlaybackStateCompat build()

Creates the playback state object.

setActiveQueueItemId

Added in 1.1.0
public PlaybackStateCompat.Builder setActiveQueueItemId(long id)

Set the active item in the play queue by specifying its id. The default value is UNKNOWN_ID

Parameters
long id

The id of the active item.

setBufferedPosition

Added in 1.1.0
public PlaybackStateCompat.Builder setBufferedPosition(long bufferPosition)

Set the current buffered position in ms. This is the farthest playback point that can be reached from the current position using only buffered content.

setErrorMessage

Added in 1.1.0
Deprecated in 1.1.0
public PlaybackStateCompat.Builder setErrorMessage(CharSequence errorMessage)

Set a user readable error message. This should be set when the state is STATE_ERROR.

setErrorMessage

Added in 1.1.0
public PlaybackStateCompat.Builder setErrorMessage(
    @PlaybackStateCompat.ErrorCode int errorCode,
    CharSequence errorMessage
)

Set the error code with an optional user readable error message. This should be set when the state is STATE_ERROR.

Parameters
@PlaybackStateCompat.ErrorCode int errorCode

The errorCode to set.

CharSequence errorMessage

The user readable error message. Can be null.

setExtras

Added in 1.1.0
public PlaybackStateCompat.Builder setExtras(Bundle extras)

Set any custom extras to be included with the playback state.

Parameters
Bundle extras

The extras to include.

setState

Added in 1.1.0
public PlaybackStateCompat.Builder setState(int state, long position, float playbackSpeed)

Set the current state of playback.

The position must be in ms and indicates the current playback position within the track. If the position is unknown use PLAYBACK_POSITION_UNKNOWN.

The rate is a multiple of normal playback and should be 0 when paused and negative when rewinding. Normal playback rate is 1.0.

The state must be one of the following:

Parameters
int state

The current state of playback.

long position

The position in the current track in ms.

float playbackSpeed

The current rate of playback as a multiple of normal playback.

setState

Added in 1.1.0
public PlaybackStateCompat.Builder setState(int state, long position, float playbackSpeed, long updateTime)

Set the current state of playback.

The position must be in ms and indicates the current playback position within the track. If the position is unknown use PLAYBACK_POSITION_UNKNOWN.

The rate is a multiple of normal playback and should be 0 when paused and negative when rewinding. Normal playback rate is 1.0.

The state must be one of the following:

Parameters
int state

The current state of playback.

long position

The position in the current item in ms.

float playbackSpeed

The current speed of playback as a multiple of normal playback.

long updateTime

The time in the elapsedRealtime timebase that the position was updated at.