PlaybackStateCompat

Kotlin |Java

class PlaybackStateCompat : Parcelable

kotlin.Any
↳	android.support.v4.media.session.PlaybackStateCompat

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

Summary

Nested classes
	Builder Builder for PlaybackStateCompat objects.
	CustomAction CustomActions can be used to extend the capabilities of the standard transport controls by exposing app specific actions to Controllers.

Constants
static Long	ACTION_FAST_FORWARD Indicates this session supports the fast forward command.
static Long	ACTION_PAUSE Indicates this session supports the pause command.
static Long	ACTION_PLAY Indicates this session supports the play command.
static Long	ACTION_PLAY_FROM_MEDIA_ID Indicates this session supports the play from media id command.
static Long	ACTION_PLAY_FROM_SEARCH Indicates this session supports the play from search command.
static Long	ACTION_PLAY_FROM_URI Indicates this session supports the play from URI command.
static Long	ACTION_PLAY_PAUSE Indicates this session supports the play/pause toggle command.
static Long	ACTION_PREPARE Indicates this session supports the prepare command.
static Long	ACTION_PREPARE_FROM_MEDIA_ID Indicates this session supports the prepare from media id command.
static Long	ACTION_PREPARE_FROM_SEARCH Indicates this session supports the prepare from search command.
static Long	ACTION_PREPARE_FROM_URI Indicates this session supports the prepare from URI command.
static Long	ACTION_REWIND Indicates this session supports the rewind command.
static Long	ACTION_SEEK_TO Indicates this session supports the seek to command.
static Long	ACTION_SET_CAPTIONING_ENABLED Indicates this session supports the set captioning enabled command.
static Long	ACTION_SET_RATING Indicates this session supports the set rating command.
static Long	ACTION_SET_REPEAT_MODE Indicates this session supports the set repeat mode command.
static Long	ACTION_SET_SHUFFLE_MODE Indicates this session supports the set shuffle mode command.
static Long	ACTION_SET_SHUFFLE_MODE_ENABLED Indicates this session supports the set shuffle mode enabled command.
static Long	ACTION_SKIP_TO_NEXT Indicates this session supports the next command.
static Long	ACTION_SKIP_TO_PREVIOUS Indicates this session supports the previous command.
static Long	ACTION_SKIP_TO_QUEUE_ITEM Indicates this session supports the skip to queue item command.
static Long	ACTION_STOP Indicates this session supports the stop command.
static Int	ERROR_CODE_ACTION_ABORTED Error code when the action is interrupted due to some external event.
static Int	ERROR_CODE_APP_ERROR Error code when the application state is invalid to fulfill the request.
static Int	ERROR_CODE_AUTHENTICATION_EXPIRED Error code when the request cannot be performed because authentication has expired.
static Int	ERROR_CODE_CONCURRENT_STREAM_LIMIT Error code when too many concurrent streams are detected.
static Int	ERROR_CODE_CONTENT_ALREADY_PLAYING Error code when the requested content is already playing.
static Int	ERROR_CODE_END_OF_QUEUE Error code when the playback navigation (previous, next) is not possible because the queue was exhausted.
static Int	ERROR_CODE_NOT_AVAILABLE_IN_REGION Error code when the content is blocked due to being regionally unavailable.
static Int	ERROR_CODE_NOT_SUPPORTED Error code when the request is not supported by the application.
static Int	ERROR_CODE_PARENTAL_CONTROL_RESTRICTED Error code when the content is blocked due to parental controls.
static Int	ERROR_CODE_PREMIUM_ACCOUNT_REQUIRED Error code when a premium account is required for the request to succeed.
static Int	ERROR_CODE_SKIP_LIMIT_REACHED Error code when the application cannot skip any more songs because skip limit is reached.
static Int	ERROR_CODE_UNKNOWN_ERROR This is the default error code and indicates that none of the other error codes applies.
static Long	PLAYBACK_POSITION_UNKNOWN Use this value for the position to indicate the position is not known.
static Int	REPEAT_MODE_ALL Use this value with MediaControllerCompat.TransportControls#setRepeatMode to indicate that the playback of the playing media list will be repeated.
static Int	REPEAT_MODE_GROUP Use this value with MediaControllerCompat.TransportControls#setRepeatMode to indicate that the playback of the playing media group will be repeated.
static Int	REPEAT_MODE_INVALID MediaControllerCompat.TransportControls#getRepeatMode returns this value when the session is not ready for providing its repeat mode.
static Int	REPEAT_MODE_NONE Use this value with MediaControllerCompat.TransportControls#setRepeatMode to indicate that the playback will be stopped at the end of the playing media list.
static Int	REPEAT_MODE_ONE Use this value with MediaControllerCompat.TransportControls#setRepeatMode to indicate that the playback of the current playing media item will be repeated.
static Int	SHUFFLE_MODE_ALL Use this value with MediaControllerCompat.TransportControls#setShuffleMode to indicate that the media list will be played in shuffled order.
static Int	SHUFFLE_MODE_GROUP Use this value with MediaControllerCompat.TransportControls#setShuffleMode to indicate that the media group will be played in shuffled order.
static Int	SHUFFLE_MODE_INVALID MediaControllerCompat.TransportControls#getShuffleMode returns this value when the session is not ready for providing its shuffle mode.
static Int	SHUFFLE_MODE_NONE Use this value with MediaControllerCompat.TransportControls#setShuffleMode to indicate that the media list will be played in order.
static Int	STATE_BUFFERING State indicating this item is currently buffering and will begin playing when enough data has buffered.
static Int	STATE_CONNECTING State indicating the class doing playback is currently connecting to a route.
static Int	STATE_ERROR State indicating this item is currently in an error state.
static Int	STATE_FAST_FORWARDING State indicating this item is currently fast forwarding.
static Int	STATE_NONE 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.
static Int	STATE_PAUSED State indicating this item is currently paused.
static Int	STATE_PLAYING State indicating this item is currently playing.
static Int	STATE_REWINDING State indicating this item is currently rewinding.
static Int	STATE_SKIPPING_TO_NEXT State indicating the player is currently skipping to the next item.
static Int	STATE_SKIPPING_TO_PREVIOUS State indicating the player is currently skipping to the previous item.
static Int	STATE_SKIPPING_TO_QUEUE_ITEM State indicating the player is currently skipping to a specific item in the queue.
static Int	STATE_STOPPED State indicating this item is currently stopped.

Public methods
Int	describeContents()
static PlaybackStateCompat!	fromPlaybackState(stateObj: Any!) Creates an instance from a framework android.media.session.PlaybackState object.
Long	getActions() Get the current actions available on this session.
Long	getActiveQueueItemId() Get the id of the currently active item in the queue.
Long	getBufferedPosition() Get the current buffered position in ms.
MutableList<PlaybackStateCompat.CustomAction!>!	getCustomActions() Get the list of custom actions.
Int	getErrorCode() Get the error code.
CharSequence!	getErrorMessage() Get the user readable optional error message.
Bundle?	getExtras() Get any custom extras that were set on this playback state.
Long	getLastPositionUpdateTime() Get the elapsed real time at which position was last updated.
Float	getPlaybackSpeed() Get the current playback speed as a multiple of normal playback.
Any!	getPlaybackState() Gets the underlying framework android.media.session.PlaybackState object.
Long	getPosition() Get the playback position in ms at last position update time.
Int	getState() Get the current state of playback.
static Int	toKeyCode(action: Long) Translates a given action into a matched key code defined in KeyEvent.
String	toString()
Unit	writeToParcel(dest: Parcel!, flags: Int)

Properties
static Creator<PlaybackStateCompat!>!	CREATOR

Constants

ACTION_FAST_FORWARD

static val ACTION_FAST_FORWARD: Long

Indicates this session supports the fast forward command.

Value: 1 << 6

See Also