# Print output for @column tags ?> PlaybackState - Android SDK | Android Developers
Developer Console

Most visited

Recently visited

Results for

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 PlaybackState#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_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_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

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.

boolean isActive()

Returns whether this is considered as an active playback state.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

ACTION_FAST_FORWARD

public static final long ACTION_FAST_FORWARD

Indicates this session supports the fast forward command.

See also:

Constant Value: 64 (0x0000000000000040)

ACTION_PAUSE

public static final long ACTION_PAUSE

Indicates this session supports the pause command.

See also:

Constant Value: 2 (0x0000000000000002)

ACTION_PLAY

public static final long ACTION_PLAY

Indicates this session supports the play command.

See also:

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:

Constant Value: 1024 (0x0000000000000400) 

public static final long ACTION_PLAY_FROM_SEARCH

Indicates this session supports the play from search command.

See also:

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:

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:

Constant Value: 512 (0x0000000000000200)

ACTION_PREPARE

public static final long ACTION_PREPARE

Indicates this session supports the prepare command.

See also:

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:

Constant Value: 32768 (0x0000000000008000) 

public static final long ACTION_PREPARE_FROM_SEARCH

Indicates this session supports the prepare from search command.

See also:

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:

Constant Value: 131072 (0x0000000000020000)

ACTION_REWIND

public static final long ACTION_REWIND

Indicates this session supports the rewind command.

See also:

Constant Value: 8 (0x0000000000000008)

ACTION_SEEK_TO

public static final long ACTION_SEEK_TO

Indicates this session supports the seek to command.

See also:

Constant Value: 256 (0x0000000000000100)

ACTION_SET_PLAYBACK_SPEED

public static final long ACTION_SET_PLAYBACK_SPEED

Indicates this session supports the set playback speed command.

See also:

Constant Value: 4194304 (0x0000000000400000)

ACTION_SET_RATING

public static final long ACTION_SET_RATING

Indicates this session supports the set rating command.

See also:

Constant Value: 128 (0x0000000000000080)

ACTION_SKIP_TO_NEXT

public static final long ACTION_SKIP_TO_NEXT

Indicates this session supports the next command.

See also:

Constant Value: 32 (0x0000000000000020)

ACTION_SKIP_TO_PREVIOUS

public static final long ACTION_SKIP_TO_PREVIOUS

Indicates this session supports the previous command.

See also:

Constant Value: 16 (0x0000000000000010)

ACTION_SKIP_TO_QUEUE_ITEM

public static final long ACTION_SKIP_TO_QUEUE_ITEM

Indicates this session supports the skip to queue item command.

See also:

Constant Value: 4096 (0x0000000000001000)

ACTION_STOP

public static final long ACTION_STOP

Indicates this session supports the stop command.

See also:

Constant Value: 1 (0x0000000000000001)

PLAYBACK_POSITION_UNKNOWN

public static final long PLAYBACK_POSITION_UNKNOWN

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

Constant Value: -1 (0xffffffffffffffff)

STATE_BUFFERING

public static final int STATE_BUFFERING

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

See also:

Constant Value: 6 (0x00000006)

STATE_CONNECTING

public static final 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.

See also:

Constant Value: 8 (0x00000008)

STATE_ERROR

public static final int STATE_ERROR

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

See also:

Constant Value: 7 (0x00000007)

STATE_FAST_FORWARDING

public static final int STATE_FAST_FORWARDING

State indicating this item is currently fast forwarding.

See also:

Constant Value: 4 (0x00000004)

STATE_NONE

public static final 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.

See also:

Constant Value: 0 (0x00000000)

STATE_PAUSED

public static final int STATE_PAUSED

State indicating this item is currently paused.

See also:

Constant Value: 2 (0x00000002)

STATE_PLAYING

public static final int STATE_PLAYING

State indicating this item is currently playing.

See also:

Constant Value: 3 (0x00000003)

STATE_REWINDING

public static final int STATE_REWINDING

State indicating this item is currently rewinding.

See also:

Constant Value: 5 (0x00000005)

STATE_SKIPPING_TO_NEXT

public static final int STATE_SKIPPING_TO_NEXT

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

See also:

Constant Value: 10 (0x0000000a)

STATE_SKIPPING_TO_PREVIOUS

public static final int STATE_SKIPPING_TO_PREVIOUS

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

See also:

Constant Value: 9 (0x00000009)

STATE_SKIPPING_TO_QUEUE_ITEM

public static final int STATE_SKIPPING_TO_QUEUE_ITEM

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

See also:

Constant Value: 11 (0x0000000b)

STATE_STOPPED

public static final int STATE_STOPPED

State indicating this item is currently stopped.

See also:

Constant Value: 1 (0x00000001)

Fields

CREATOR

public static final Creator<PlaybackState> CREATOR

Public methods

describeContents

public 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(android.os.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. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

getActions

public long getActions ()

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

Returns
long Value is either 0 or a combination of ACTION_STOP, ACTION_PAUSE, ACTION_PLAY, ACTION_REWIND, ACTION_SKIP_TO_PREVIOUS, ACTION_SKIP_TO_NEXT, ACTION_FAST_FORWARD, ACTION_SET_RATING, ACTION_SEEK_TO, ACTION_PLAY_PAUSE, 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, and ACTION_SET_PLAYBACK_SPEED

getActiveQueueItemId

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 MediaSession.QueueItem#UNKNOWN_ID.

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

getBufferedPosition

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.

Returns
long

getCustomActions

public List<PlaybackState.CustomAction> getCustomActions ()

Get the list of custom actions.

Returns
List<PlaybackState.CustomAction>

getErrorMessage

public CharSequence getErrorMessage ()

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

Returns
CharSequence

getExtras

public Bundle getExtras ()

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

Returns
Bundle The extras for this state or null.

getLastPositionUpdateTime

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;

Returns
long The last time the position was updated.

getPlaybackSpeed

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.

Returns
float The current speed of playback.

getPosition

public long getPosition ()

Get the current playback position in ms.

Returns
long

getState

public int getState ()

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

Returns
int Value is STATE_NONE, STATE_STOPPED, STATE_PAUSED, STATE_PLAYING, STATE_FAST_FORWARDING, STATE_REWINDING, STATE_BUFFERING, STATE_ERROR, STATE_CONNECTING, STATE_SKIPPING_TO_PREVIOUS, STATE_SKIPPING_TO_NEXT, or STATE_SKIPPING_TO_QUEUE_ITEM

isActive

public boolean isActive ()

Returns whether this is considered as an active playback state.

The playback state is considered as an active if the state is one of the following:

Returns
boolean

toString

public 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

public 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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES
Get news & tips
Blog Support

Except as noted, this content is licensed under Apache 2.0. For details and restrictions, see the Content License.

Android 7.0 r1 —

About Android Auto TV Wear Legal