# Print output for @column tags ?>
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.
Nested classes | |
---|---|
class |
PlaybackState.Builder
Builder for |
class |
PlaybackState.CustomAction
|
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 |
---|
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 | |
---|---|
public static final long ACTION_FAST_FORWARD
Indicates this session supports the fast forward command.
See also:
Constant Value: 64 (0x0000000000000040)
public static final long ACTION_PAUSE
Indicates this session supports the pause command.
See also:
Constant Value: 2 (0x0000000000000002)
public static final long ACTION_PLAY
Indicates this session supports the play command.
See also:
Constant Value: 4 (0x0000000000000004)
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)
public static final long ACTION_PLAY_FROM_URI
Indicates this session supports the play from URI command.
See also:
Constant Value: 8192 (0x0000000000002000)
public static final long ACTION_PLAY_PAUSE
Indicates this session supports the play/pause toggle command.
See also:
Constant Value: 512 (0x0000000000000200)
public static final long ACTION_PREPARE
Indicates this session supports the prepare command.
See also:
Constant Value: 16384 (0x0000000000004000)
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)
public static final long ACTION_PREPARE_FROM_URI
Indicates this session supports the prepare from URI command.
See also:
Constant Value: 131072 (0x0000000000020000)
public static final long ACTION_REWIND
Indicates this session supports the rewind command.
See also:
Constant Value: 8 (0x0000000000000008)
public static final long ACTION_SEEK_TO
Indicates this session supports the seek to command.
See also:
Constant Value: 256 (0x0000000000000100)
public static final long ACTION_SET_RATING
Indicates this session supports the set rating command.
See also:
Constant Value: 128 (0x0000000000000080)
public static final long ACTION_SKIP_TO_NEXT
Indicates this session supports the next command.
See also:
Constant Value: 32 (0x0000000000000020)
public static final long ACTION_SKIP_TO_PREVIOUS
Indicates this session supports the previous command.
See also:
Constant Value: 16 (0x0000000000000010)
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)
public static final long ACTION_STOP
Indicates this session supports the stop command.
See also:
Constant Value: 1 (0x0000000000000001)
public static final long PLAYBACK_POSITION_UNKNOWN
Use this value for the position to indicate the position is not known.
Constant Value: -1 (0xffffffffffffffff)
public static final int STATE_BUFFERING
State indicating this item is currently buffering and will begin playing when enough data has buffered.
Constant Value: 6 (0x00000006)
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.
Constant Value: 8 (0x00000008)
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.
Constant Value: 7 (0x00000007)
public static final int STATE_FAST_FORWARDING
State indicating this item is currently fast forwarding.
Constant Value: 4 (0x00000004)
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)
public static final int STATE_PAUSED
State indicating this item is currently paused.
Constant Value: 2 (0x00000002)
public static final int STATE_PLAYING
State indicating this item is currently playing.
Constant Value: 3 (0x00000003)
public static final int STATE_REWINDING
State indicating this item is currently rewinding.
Constant Value: 5 (0x00000005)
public static final int STATE_SKIPPING_TO_NEXT
State indicating the player is currently skipping to the next item.
Constant Value: 10 (0x0000000a)
public static final int STATE_SKIPPING_TO_PREVIOUS
State indicating the player is currently skipping to the previous item.
Constant Value: 9 (0x00000009)
public static final int STATE_SKIPPING_TO_QUEUE_ITEM
State indicating the player is currently skipping to a specific item in the queue.
Constant Value: 11 (0x0000000b)
public static final int STATE_STOPPED
State indicating this item is currently stopped.
Constant Value: 1 (0x00000001)
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 |
public long getActions ()
Get the current actions available on this session. This should use a bitmask of the available actions.
PlaybackState#ACTION_SKIP_TO_PREVIOUS
PlaybackState#ACTION_REWIND
PlaybackState#ACTION_PLAY
PlaybackState#ACTION_PAUSE
PlaybackState#ACTION_STOP
PlaybackState#ACTION_FAST_FORWARD
PlaybackState#ACTION_SKIP_TO_NEXT
PlaybackState#ACTION_SEEK_TO
PlaybackState#ACTION_SET_RATING
PlaybackState#ACTION_PLAY_PAUSE
PlaybackState#ACTION_PLAY_FROM_MEDIA_ID
PlaybackState#ACTION_PLAY_FROM_SEARCH
PlaybackState#ACTION_SKIP_TO_QUEUE_ITEM
PlaybackState#ACTION_PLAY_FROM_URI
PlaybackState#ACTION_PREPARE
PlaybackState#ACTION_PREPARE_FROM_MEDIA_ID
PlaybackState#ACTION_PREPARE_FROM_SEARCH
PlaybackState#ACTION_PREPARE_FROM_URI
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 , and ACTION_PREPARE_FROM_URI |
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 . |
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 |
public List<PlaybackState.CustomAction> getCustomActions ()
Get the list of custom actions.
Returns | |
---|---|
List<PlaybackState.CustomAction> |
public CharSequence getErrorMessage ()
Get a user readable error message. This should be set when the state is
PlaybackState#STATE_ERROR
.
Returns | |
---|---|
CharSequence |
public Bundle getExtras ()
Get any custom extras that were set on this playback state.
Returns | |
---|---|
Bundle |
The extras for this state or null. |
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. |
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. |
public long getPosition ()
Get the current playback position in ms.
Returns | |
---|---|
long |
public int getState ()
Get the current state of playback. One of the following:
PlaybackState#STATE_NONE
PlaybackState#STATE_STOPPED
PlaybackState#STATE_PLAYING
PlaybackState#STATE_PAUSED
PlaybackState#STATE_FAST_FORWARDING
PlaybackState#STATE_REWINDING
PlaybackState#STATE_BUFFERING
PlaybackState#STATE_ERROR
PlaybackState#STATE_CONNECTING
PlaybackState#STATE_SKIPPING_TO_PREVIOUS
PlaybackState#STATE_SKIPPING_TO_NEXT
PlaybackState#STATE_SKIPPING_TO_QUEUE_ITEM
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. |
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 |