PlaybackStateCompat

public static final long ACTION_FAST_FORWARD = 64

Indicates this session supports the fast forward command.

public static final long ACTION_PAUSE = 2

Indicates this session supports the pause command.

public static final long ACTION_PLAY = 4

Indicates this session supports the play command.

public static final long ACTION_PLAY_FROM_MEDIA_ID = 1024

Indicates this session supports the play from media id command.

public static final long ACTION_PLAY_FROM_SEARCH = 2048

Indicates this session supports the play from search command.

public static final long ACTION_PLAY_FROM_URI = 8192

Indicates this session supports the play from URI command.

public static final long ACTION_PLAY_PAUSE = 512

Indicates this session supports the play/pause toggle command.

public static final long ACTION_PREPARE = 16384

Indicates this session supports the prepare command.

public static final long ACTION_PREPARE_FROM_MEDIA_ID = 32768

Indicates this session supports the prepare from media id command.

public static final long ACTION_PREPARE_FROM_SEARCH = 65536

Indicates this session supports the prepare from search command.

public static final long ACTION_PREPARE_FROM_URI = 131072

Indicates this session supports the prepare from URI command.

public static final long ACTION_REWIND = 8

Indicates this session supports the rewind command.

public static final long ACTION_SEEK_TO = 256

Indicates this session supports the seek to command.

public static final long ACTION_SET_CAPTIONING_ENABLED = 1048576

Indicates this session supports the set captioning enabled command.

public static final long ACTION_SET_PLAYBACK_SPEED = 4194304

Indicates this session supports the set playback speed command.

public static final long ACTION_SET_RATING = 128

Indicates this session supports the set rating command.

public static final long ACTION_SET_REPEAT_MODE = 262144

Indicates this session supports the set repeat mode command.

public static final long ACTION_SET_SHUFFLE_MODE = 2097152

Indicates this session supports the set shuffle mode command.

public static final long ACTION_SET_SHUFFLE_MODE_ENABLED = 524288

Indicates this session supports the set shuffle mode enabled command.

public static final long ACTION_SKIP_TO_NEXT = 32

Indicates this session supports the next command.

public static final long ACTION_SKIP_TO_PREVIOUS = 16

Indicates this session supports the previous command.

public static final long ACTION_SKIP_TO_QUEUE_ITEM = 4096

Indicates this session supports the skip to queue item command.

public static final long ACTION_STOP = 1

Indicates this session supports the stop command.

public static final int ERROR_CODE_ACTION_ABORTED = 10

Error code when the action is interrupted due to some external event. The error code should be set when entering STATE_ERROR.

public static final int ERROR_CODE_APP_ERROR = 1

Error code when the application state is invalid to fulfill the request. The error code should be set when entering STATE_ERROR.

public static final int ERROR_CODE_AUTHENTICATION_EXPIRED = 3

Error code when the request cannot be performed because authentication has expired. The error code should be set when entering STATE_ERROR.

public static final int ERROR_CODE_CONCURRENT_STREAM_LIMIT = 5

Error code when too many concurrent streams are detected. The error code should be set when entering STATE_ERROR.

public static final int ERROR_CODE_CONTENT_ALREADY_PLAYING = 8

Error code when the requested content is already playing. The error code should be set when entering STATE_ERROR.

public static final int ERROR_CODE_END_OF_QUEUE = 11

Error code when the playback navigation (previous, next) is not possible because the queue was exhausted. The error code should be set when entering STATE_ERROR.

public static final int ERROR_CODE_NOT_AVAILABLE_IN_REGION = 7

Error code when the content is blocked due to being regionally unavailable. The error code should be set when entering STATE_ERROR.

public static final int ERROR_CODE_NOT_SUPPORTED = 2

Error code when the request is not supported by the application. The error code should be set when entering STATE_ERROR.

public static final int ERROR_CODE_PARENTAL_CONTROL_RESTRICTED = 6

Error code when the content is blocked due to parental controls. The error code should be set when entering STATE_ERROR.

public static final int ERROR_CODE_PREMIUM_ACCOUNT_REQUIRED = 4

Error code when a premium account is required for the request to succeed. The error code should be set when entering STATE_ERROR.

public static final int ERROR_CODE_SKIP_LIMIT_REACHED = 9

Error code when the application cannot skip any more songs because skip limit is reached. The error code should be set when entering STATE_ERROR.

public static final int ERROR_CODE_UNKNOWN_ERROR = 0

This is the default error code and indicates that none of the other error codes applies. The error code should be set when entering STATE_ERROR.

public static final long PLAYBACK_POSITION_UNKNOWN = -1

Use this value for the position to indicate the position is not known.

public static final int REPEAT_MODE_ALL = 2

Use this value with setRepeatMode to indicate that the playback of the playing media list will be repeated.

public static final int REPEAT_MODE_GROUP = 3

Use this value with setRepeatMode to indicate that the playback of the playing media group will be repeated. A group is a logical block of media items which is specified in the section 5.7 of the Bluetooth AVRCP 1.6.

public static final int REPEAT_MODE_INVALID = -1

getRepeatMode returns this value when the session is not ready for providing its repeat mode.

public static final int REPEAT_MODE_NONE = 0

Use this value with setRepeatMode to indicate that the playback will be stopped at the end of the playing media list.

public static final int REPEAT_MODE_ONE = 1

Use this value with setRepeatMode to indicate that the playback of the current playing media item will be repeated.

public static final int SHUFFLE_MODE_ALL = 1

Use this value with setShuffleMode to indicate that the media list will be played in shuffled order.

public static final int SHUFFLE_MODE_GROUP = 2

Use this value with setShuffleMode to indicate that the media group will be played in shuffled order. A group is a logical block of media items which is specified in the section 5.7 of the Bluetooth AVRCP 1.6.

public static final int SHUFFLE_MODE_INVALID = -1

getShuffleMode returns this value when the session is not ready for providing its shuffle mode.

public static final int SHUFFLE_MODE_NONE = 0

Use this value with setShuffleMode to indicate that the media list will be played in order.

public static final int STATE_BUFFERING = 6

State indicating this item is currently buffering and will begin playing when enough data has buffered.

public static final int STATE_CONNECTING = 8

State indicating the class doing playback is currently connecting to a route. Depending on the implementation you may return to the previous state when the connection finishes or enter STATE_NONE. If the connection failed STATE_ERROR should be used.

On devices earlier than API 21, this will appear as STATE_BUFFERING

public static final int STATE_ERROR = 7

State indicating this item is currently in an error state. The error code should also be set when entering this state.

public static final int STATE_FAST_FORWARDING = 4

State indicating this item is currently fast forwarding.

public static final int STATE_NONE = 0

This is the default playback state and indicates that no media has been added yet, or the performer has been reset and has no content to play.

public static final int STATE_PAUSED = 2

State indicating this item is currently paused.

public static final int STATE_PLAYING = 3

State indicating this item is currently playing.

public static final int STATE_REWINDING = 5

State indicating this item is currently rewinding.

public static final int STATE_SKIPPING_TO_NEXT = 10

State indicating the player is currently skipping to the next item.

public static final int STATE_SKIPPING_TO_PREVIOUS = 9

State indicating the player is currently skipping to the previous item.

public static final int STATE_SKIPPING_TO_QUEUE_ITEM = 11

State indicating the player is currently skipping to a specific item in the queue.

On devices earlier than API 21, this will appear as STATE_SKIPPING_TO_NEXT

public static final int STATE_STOPPED = 1

State indicating this item is currently stopped.

public static PlaybackStateCompat fromPlaybackState(Object stateObj)

Creates an instance from a framework android.media.session.PlaybackState object.

This method is only supported on API 21+.

public long getActions()

Get the current actions available on this session. This should use a bitmask of the available actions.

• ACTION_SKIP_TO_PREVIOUS
• ACTION_REWIND
• ACTION_PLAY
• ACTION_PLAY_PAUSE
• ACTION_PAUSE
• ACTION_STOP
• ACTION_FAST_FORWARD
• ACTION_SKIP_TO_NEXT
• ACTION_SEEK_TO
• ACTION_SET_RATING
• ACTION_PLAY_FROM_MEDIA_ID
• ACTION_PLAY_FROM_SEARCH
• ACTION_SKIP_TO_QUEUE_ITEM
• ACTION_PLAY_FROM_URI
• ACTION_PREPARE
• ACTION_PREPARE_FROM_MEDIA_ID
• ACTION_PREPARE_FROM_SEARCH
• ACTION_PREPARE_FROM_URI
• ACTION_SET_REPEAT_MODE
• ACTION_SET_SHUFFLE_MODE
• ACTION_SET_CAPTIONING_ENABLED
• ACTION_SET_PLAYBACK_SPEED

public long getActiveQueueItemId()

Get the id of the currently active item in the queue. If there is no queue or a queue is not supported by the session this will be UNKNOWN_ID.

public long getBufferedPosition()

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

public List<PlaybackStateCompat.CustomAction> getCustomActions()

Get the list of custom actions.

public int getErrorCode()

Get the error code. This should be set when the state is STATE_ERROR.

public CharSequence getErrorMessage()

Get the user readable optional error message. This may be set when the state is STATE_ERROR.

public @Nullable Bundle getExtras()

Get any custom extras that were set on this playback state.

public long getLastPositionUpdateTime()

Get the elapsed real time at which position was last updated. If the position has never been set this will return 0;

public float getPlaybackSpeed()

Get the current playback speed as a multiple of normal playback. This should be negative when rewinding. A value of 1 means normal playback and 0 means paused.

public Object getPlaybackState()

Gets the underlying framework android.media.session.PlaybackState object.

This method is only supported on API 21+.

public long getPosition()

Get the playback position in ms at last position update time.

public int getState()

Get the current state of playback. One of the following:

• STATE_NONE
• STATE_STOPPED
• STATE_PLAYING
• STATE_PAUSED
• STATE_FAST_FORWARDING
• STATE_REWINDING
• STATE_BUFFERING
• STATE_ERROR
• STATE_CONNECTING
• STATE_SKIPPING_TO_PREVIOUS
• STATE_SKIPPING_TO_NEXT
• STATE_SKIPPING_TO_QUEUE_ITEM

public static int toKeyCode(long action)

Translates a given action into a matched key code defined in KeyEvent. The given action should be one of the following:

• ACTION_PLAY
• ACTION_PAUSE
• ACTION_SKIP_TO_NEXT
• ACTION_SKIP_TO_PREVIOUS
• ACTION_STOP
• ACTION_FAST_FORWARD
• ACTION_REWIND
• ACTION_PLAY_PAUSE