PlaybackStateCompat

Kotlin |Java

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 when the session is not ready for providing its repeat mode.
`int`	`REPEAT_MODE_NONE` Use this value with `MediaControllerCompat.TransportControls.setRepeatMode(int)` to indicate that the playback will be stopped at the end of the playing media list.
`int`	`REPEAT_MODE_ONE` Use this value with `MediaControllerCompat.TransportControls.setRepeatMode(int)` to indicate that the playback of the current playing media item will be repeated.
`int`	`SHUFFLE_MODE_ALL` Use this value with `MediaControllerCompat.TransportControls.setShuffleMode(int)` to indicate that the media list will be played in shuffled order.
`int`	`SHUFFLE_MODE_GROUP` Use this value with `MediaControllerCompat.TransportControls.setShuffleMode(int)` to indicate that the media group will be played in shuffled order.
`int`	`SHUFFLE_MODE_INVALID` `MediaControllerCompat.getShuffleMode()` returns this value when the session is not ready for providing its shuffle mode.
`int`	`SHUFFLE_MODE_NONE` Use this value with `MediaControllerCompat.TransportControls.setShuffleMode(int)` to indicate that the media list will be played in order.
`int`	`STATE_BUFFERING` State indicating this item is currently buffering and will begin playing when enough data has buffered.
`int`	`STATE_CONNECTING` State indicating the class doing playback is currently connecting to a route.
`int`	`STATE_ERROR` State indicating this item is currently in an error state.
`int`	`STATE_FAST_FORWARDING` State indicating this item is currently fast forwarding.
`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.
`int`	`STATE_PAUSED` State indicating this item is currently paused.
`int`	`STATE_PLAYING` State indicating this item is currently playing.
`int`	`STATE_REWINDING` State indicating this item is currently rewinding.
`int`	`STATE_SKIPPING_TO_NEXT` State indicating the player is currently skipping to the next item.
`int`	`STATE_SKIPPING_TO_PREVIOUS` State indicating the player is currently skipping to the previous item.
`int`	`STATE_SKIPPING_TO_QUEUE_ITEM` State indicating the player is currently skipping to a specific item in the queue.
`int`	`STATE_STOPPED` State indicating this item is currently stopped.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR`
`int`	`PARCELABLE_WRITE_RETURN_VALUE`

Fields
`public static final Creator<PlaybackStateCompat>`	`CREATOR`

Public methods
`int`	`describeContents()`
`static PlaybackStateCompat`	`fromPlaybackState(Object stateObj)` Creates an instance from a framework `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.
`List<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.
`Object`	`getPlaybackState()` Gets the underlying framework `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(long action)` Translates a given action into a matched key code defined in `KeyEvent`.
`String`	`toString()`
`void`	`writeToParcel(Parcel dest, int flags)`

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()`
`abstract void`	`writeToParcel(Parcel arg0, int arg1)`

Constants

ACTION_FAST_FORWARD

public static final long ACTION_FAST_FORWARD

Indicates this session supports the fast forward command.

See also:

PlaybackStateCompat.Builder.setActions(long)

Constant Value: 64 (0x0000000000000040)

ACTION_PAUSE

public static final long ACTION_PAUSE

Indicates this session supports the pause command.

See also:

PlaybackStateCompat.Builder.setActions(long)

Constant Value: 2 (0x0000000000000002)

ACTION_PLAY

public static final long ACTION_PLAY

Indicates this session supports the play command.

See also:

PlaybackStateCompat.Builder.setActions(long)

Constant Value: 4 (0x0000000000000004)

ACTION_PLAY_FROM_MEDIA_ID

public static final long ACTION_PLAY_FROM_MEDIA_ID

Indicates this session supports the play from media id command.

See also:

PlaybackStateCompat.Builder.setActions(long)

Constant Value: 1024 (0x0000000000000400)

ACTION_PLAY_FROM_SEARCH

public static final long ACTION_PLAY_FROM_SEARCH

Indicates this session supports the play from search command.

See also:

PlaybackStateCompat.Builder.setActions(long)

Constant Value: 2048 (0x0000000000000800)

ACTION_PLAY_FROM_URI

public static final long ACTION_PLAY_FROM_URI

Indicates this session supports the play from URI command.

See also:

PlaybackStateCompat.Builder.setActions(long)

Constant Value: 8192 (0x0000000000002000)

ACTION_PLAY_PAUSE

public static final long ACTION_PLAY_PAUSE

Indicates this session supports the play/pause toggle command.

See also:

PlaybackStateCompat.Builder.setActions(long)

Constant Value: 512 (0x0000000000000200)

ACTION_PREPARE

public static final long ACTION_PREPARE

Indicates this session supports the prepare command.

See also:

PlaybackStateCompat.Builder.setActions(long)

Constant Value: 16384 (0x0000000000004000)

ACTION_PREPARE_FROM_MEDIA_ID

public static final long ACTION_PREPARE_FROM_MEDIA_ID

Indicates this session supports the prepare from media id command.

See also:

PlaybackStateCompat.Builder.setActions(long)

Constant Value: 32768 (0x0000000000008000)

ACTION_PREPARE_FROM_SEARCH

public static final long ACTION_PREPARE_FROM_SEARCH

Indicates this session supports the prepare from search command.

See also:

PlaybackStateCompat.Builder.setActions(long)

Constant Value: 65536 (0x0000000000010000)

ACTION_PREPARE_FROM_URI

public static final long ACTION_PREPARE_FROM_URI

Indicates this session supports the prepare from URI command.

See also:

PlaybackStateCompat.Builder.setActions(long)

Constant Value: 131072 (0x0000000000020000)

ACTION_REWIND

public static final long ACTION_REWIND

Indicates this session supports the rewind command.

See also:

PlaybackStateCompat.Builder.setActions(long)

Constant Value: 8 (0x0000000000000008)

ACTION_SEEK_TO

public static final long ACTION_SEEK_TO

Indicates this session supports the seek to command.

See also:

PlaybackStateCompat.Builder.setActions(long)

Constant Value: 256 (0x0000000000000100)

ACTION_SET_CAPTIONING_ENABLED

public static final long ACTION_SET_CAPTIONING_ENABLED

Indicates this session supports the set captioning enabled command.

See also:

PlaybackStateCompat.Builder.setActions(long)

Constant Value: 1048576 (0x0000000000100000)

ACTION_SET_PLAYBACK_SPEED

public static final long ACTION_SET_PLAYBACK_SPEED

Indicates this session supports the set playback speed command.

See also:

PlaybackStateCompat.Builder.setActions(long)

Constant Value:

PlaybackStateCompat

Summary

Nested classes

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

ACTION_FAST_FORWARD

ACTION_PAUSE

ACTION_PLAY

ACTION_PLAY_FROM_MEDIA_ID

ACTION_PLAY_FROM_SEARCH

ACTION_PLAY_FROM_URI

ACTION_PLAY_PAUSE

ACTION_PREPARE

ACTION_PREPARE_FROM_MEDIA_ID

ACTION_PREPARE_FROM_SEARCH

ACTION_PREPARE_FROM_URI

ACTION_REWIND

ACTION_SEEK_TO

ACTION_SET_CAPTIONING_ENABLED

ACTION_SET_PLAYBACK_SPEED