Skip to content

Most visited

Recently visited

navigation

PlaybackState

public final class PlaybackState
extends Object implements Parcelable

java.lang.Object
   ↳ android.media.session.PlaybackState


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

Summary

Nested classes

class PlaybackState.Builder

Builder for PlaybackState objects. 

class PlaybackState.CustomAction

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

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_RATING

Indicates this session supports the set rating command.

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.

long PLAYBACK_POSITION_UNKNOWN

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

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 new destination.

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

Fields

public static final Creator<PlaybackState> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

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<PlaybackState.CustomAction> getCustomActions()

Get the list of custom actions.

CharSequence getErrorMessage()

Get a user readable 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.

long getPosition()

Get the current playback position in ms.

int getState()

Get the current state of playback.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Constants

ACTION_FAST_FORWARD

added in API level 21
long ACTION_FAST_FORWARD

Indicates this session supports the fast forward command.

See also:

Constant Value: 64 (0x0000000000000040)

ACTION_PAUSE

added in API level 21
long ACTION_PAUSE

Indicates this session supports the pause command.

See also:

Constant Value: 2 (0x0000000000000002)

ACTION_PLAY

added in API level 21
long ACTION_PLAY

Indicates this session supports the play command.

See also:

Constant Value: 4 (0x0000000000000004)

ACTION_PLAY_FROM_MEDIA_ID

added in API level 21
long ACTION_PLAY_FROM_MEDIA_ID

Indicates this session supports the play from media id command.

See also:

Constant Value: 1024 (0x0000000000000400)

ACTION_PLAY_FROM_SEARCH

added in API level 21
long ACTION_PLAY_FROM_SEARCH

Indicates this session supports the play from search command.

See also:

Constant Value: 2048 (0x0000000000000800)

ACTION_PLAY_FROM_URI

added in API level 23
long ACTION_PLAY_FROM_URI

Indicates this session supports the play from URI command.

See also:

Constant Value: 8192 (0x0000000000002000)

ACTION_PLAY_PAUSE

added in API level 21
long ACTION_PLAY_PAUSE

Indicates this session supports the play/pause toggle command.

See also:

Constant Value: 512 (0x0000000000000200)

ACTION_PREPARE

added in API level 24
long ACTION_PREPARE

Indicates this session supports the prepare command.

See also:

Constant Value: 16384 (0x0000000000004000)

ACTION_PREPARE_FROM_MEDIA_ID

added in API level 24
long ACTION_PREPARE_FROM_MEDIA_ID

Indicates this session supports the prepare from media id command.

See also:

Constant Value: 32768 (0x0000000000008000)

ACTION_PREPARE_FROM_SEARCH

added in API level 24
long ACTION_PREPARE_FROM_SEARCH

Indicates this session supports the prepare from search command.

See also:

Constant Value: 65536 (0x0000000000010000)

ACTION_PREPARE_FROM_URI

added in API level 24
long ACTION_PREPARE_FROM_URI

Indicates this session supports the prepare from URI command.

See also:

Constant Value: 131072 (0x0000000000020000)

ACTION_REWIND

added in API level 21
long ACTION_REWIND

Indicates this session supports the rewind command.

See also:

Constant Value: 8 (0x0000000000000008)

ACTION_SEEK_TO

added in API level 21
long ACTION_SEEK_TO

Indicates this session supports the seek to command.

See also:

Constant Value: 256 (0x0000000000000100)

ACTION_SET_RATING

added in API level 21
long ACTION_SET_RATING

Indicates this session supports the set rating command.

See also:

Constant Value: 128 (0x0000000000000080)

ACTION_SKIP_TO_NEXT

added in API level 21
long ACTION_SKIP_TO_NEXT

Indicates this session supports the next command.

See also:

Constant Value: 32 (0x0000000000000020)

ACTION_SKIP_TO_PREVIOUS

added in API level 21
long ACTION_SKIP_TO_PREVIOUS

Indicates this session supports the previous command.

See also:

Constant Value: 16 (0x0000000000000010)

ACTION_SKIP_TO_QUEUE_ITEM

added in API level 21
long ACTION_SKIP_TO_QUEUE_ITEM

Indicates this session supports the skip to queue item command.

See also:

Constant Value: 4096 (0x0000000000001000)

ACTION_STOP

added in API level 21
long ACTION_STOP

Indicates this session supports the stop command.

See also:

Constant Value: 1 (0x0000000000000001)

PLAYBACK_POSITION_UNKNOWN

added in API level 21
long PLAYBACK_POSITION_UNKNOWN

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

Constant Value: -1 (0xffffffffffffffff)

STATE_BUFFERING

added in API level 21
int STATE_BUFFERING

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

Constant Value: 6 (0x00000006)

STATE_CONNECTING

added in API level 21
int STATE_CONNECTING

State indicating the class doing playback is currently connecting to a new destination. 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.

Constant Value: 8 (0x00000008)

STATE_ERROR

added in API level 21
int STATE_ERROR

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

Constant Value: 7 (0x00000007)

STATE_FAST_FORWARDING

added in API level 21
int STATE_FAST_FORWARDING

State indicating this item is currently fast forwarding.

Constant Value: 4 (0x00000004)

STATE_NONE

added in API level 21
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.

Constant Value: 0 (0x00000000)

STATE_PAUSED

added in API level 21
int STATE_PAUSED

State indicating this item is currently paused.

Constant Value: 2 (0x00000002)

STATE_PLAYING

added in API level 21
int STATE_PLAYING

State indicating this item is currently playing.

Constant Value: 3 (0x00000003)

STATE_REWINDING

added in API level 21
int STATE_REWINDING

State indicating this item is currently rewinding.

Constant Value: 5 (0x00000005)

STATE_SKIPPING_TO_NEXT

added in API level 21
int STATE_SKIPPING_TO_NEXT

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

Constant Value: 10 (0x0000000a)

STATE_SKIPPING_TO_PREVIOUS

added in API level 21
int STATE_SKIPPING_TO_PREVIOUS

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

Constant Value: 9 (0x00000009)

STATE_SKIPPING_TO_QUEUE_ITEM

added in API level 21
int STATE_SKIPPING_TO_QUEUE_ITEM

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

Constant Value: 11 (0x0000000b)

STATE_STOPPED

added in API level 21
int STATE_STOPPED

State indicating this item is currently stopped.

Constant Value: 1 (0x00000001)

Fields

CREATOR

added in API level 21
Creator<PlaybackState> CREATOR

Public methods

describeContents

added in API level 21
int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

getActiveQueueItemId

added in API level 21
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.

Returns
long The id of the currently active item in the queue or UNKNOWN_ID.

getBufferedPosition

added in API level 21
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.

Returns
long

getCustomActions

added in API level 21
List<PlaybackState.CustomAction> getCustomActions ()

Get the list of custom actions.

Returns
List<PlaybackState.CustomAction>

getErrorMessage

added in API level 21
CharSequence getErrorMessage ()

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

Returns
CharSequence

getExtras

added in API level 22
Bundle getExtras ()

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

Returns
Bundle The extras for this state or null.

getLastPositionUpdateTime

added in API level 21
long getLastPositionUpdateTime ()

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

Returns
long The last time the position was updated.

getPlaybackSpeed

added in API level 21
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.

Returns
float The current speed of playback.

getPosition

added in API level 21
long getPosition ()

Get the current playback position in ms.

Returns
long

toString

added in API level 21
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

writeToParcel

added in API level 21
void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.

flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience. (Dec 2017 Android Platform & Tools Survey)