PlaybackStateCompat

public final class PlaybackStateCompat
extends Object implements Parcelable

java.lang.Object
   ↳ android.support.v4.media.session.PlaybackStateCompat


Playback state for a MediaSessionCompat. This includes a state like STATE_PLAYING, the current playback position, and the current control capabilities.

Summary

Nested classes

class PlaybackStateCompat.Builder

Builder for PlaybackStateCompat objects. 

class PlaybackStateCompat.CustomAction

CustomActions can be used to extend the capabilities of the standard transport controls by exposing app specific actions to Controllers

Constants

long ACTION_FAST_FORWARD

Indicates this session supports the fast forward command.

long ACTION_PAUSE

Indicates this session supports the pause command.

long ACTION_PLAY

Indicates this session supports the play command.

long ACTION_PLAY_FROM_MEDIA_ID

Indicates this session supports the play from media id command.

long ACTION_PLAY_FROM_SEARCH

Indicates this session supports the play from search command.

long ACTION_PLAY_FROM_URI

Indicates this session supports the play from URI command.

long ACTION_PLAY_PAUSE

Indicates this session supports the play/pause toggle command.

long ACTION_PREPARE

Indicates this session supports the prepare command.

long ACTION_PREPARE_FROM_MEDIA_ID

Indicates this session supports the prepare from media id command.

long ACTION_PREPARE_FROM_SEARCH

Indicates this session supports the prepare from search command.

long ACTION_PREPARE_FROM_URI

Indicates this session supports the prepare from URI command.

long ACTION_REWIND

Indicates this session supports the rewind command.

long ACTION_SEEK_TO

Indicates this session supports the seek to command.

long ACTION_SET_CAPTIONING_ENABLED

Indicates this session supports the set captioning enabled command.

long ACTION_SET_PLAYBACK_SPEED

Indicates this session supports the set playback speed command.

long ACTION_SET_RATING

Indicates this session supports the set rating command.

long ACTION_SET_REPEAT_MODE

Indicates this session supports the set repeat mode command.

long ACTION_SET_SHUFFLE_MODE

Indicates this session supports the set shuffle mode command.

long ACTION_SET_SHUFFLE_MODE_ENABLED

This constant is deprecated. Use ACTION_SET_SHUFFLE_MODE instead.

long ACTION_SKIP_TO_NEXT

Indicates this session supports the next command.

long ACTION_SKIP_TO_PREVIOUS

Indicates this session supports the previous command.

long ACTION_SKIP_TO_QUEUE_ITEM

Indicates this session supports the skip to queue item command.

long ACTION_STOP

Indicates this session supports the stop command.

int ERROR_CODE_ACTION_ABORTED

Error code when the action is interrupted due to some external event.

int ERROR_CODE_APP_ERROR

Error code when the application state is invalid to fulfill the request.

int ERROR_CODE_AUTHENTICATION_EXPIRED

Error code when the request cannot be performed because authentication has expired.

int ERROR_CODE_CONCURRENT_STREAM_LIMIT

Error code when too many concurrent streams are detected.

int ERROR_CODE_CONTENT_ALREADY_PLAYING

Error code when the requested content is already playing.

int ERROR_CODE_END_OF_QUEUE

Error code when the playback navigation (previous, next) is not possible because the queue was exhausted.

int ERROR_CODE_NOT_AVAILABLE_IN_REGION

Error code when the content is blocked due to being regionally unavailable.

int ERROR_CODE_NOT_SUPPORTED

Error code when the request is not supported by the application.

int ERROR_CODE_PARENTAL_CONTROL_RESTRICTED

Error code when the content is blocked due to parental controls.

int ERROR_CODE_PREMIUM_ACCOUNT_REQUIRED

Error code when a premium account is required for the request to succeed.

int ERROR_CODE_SKIP_LIMIT_REACHED

Error code when the application cannot skip any more songs because skip limit is reached.

int ERROR_CODE_UNKNOWN_ERROR

This is the default error code and indicates that none of the other error codes applies.

long PLAYBACK_POSITION_UNKNOWN

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

int REPEAT_MODE_ALL

Use this value with MediaControllerCompat.TransportControls.setRepeatMode(int) to indicate that the playback of the playing media list will be repeated.

int REPEAT_MODE_GROUP

Use this value with MediaControllerCompat.TransportControls.setRepeatMode(int) to indicate that the playback of the playing media group will be repeated.

int REPEAT_MODE_INVALID

MediaControllerCompat.getRepeatMode() returns this value