Added in API level 31

PlaybackStateEvent

---

Kotlin |Java

class PlaybackStateEvent : Event, Parcelable

kotlin.Any
↳	android.media.metrics.Event
	↳	android.media.metrics.PlaybackStateEvent

Playback state event.

Summary

Nested classes
	Builder A builder for PlaybackStateEvent

Constants
static Int	STATE_ABANDONED Playback is abandoned before reaching the end of the media.
static Int	STATE_BUFFERING Playback is buffering to resume active playback.
static Int	STATE_ENDED Playback has reached the end of the media.
static Int	STATE_FAILED Playback is stopped due a fatal error and can be retried.
static Int	STATE_INTERRUPTED_BY_AD Playback is interrupted by an ad.
static Int	STATE_JOINING_BACKGROUND Playback is buffering in the background for initial playback start
static Int	STATE_JOINING_FOREGROUND Playback is buffering in the foreground for initial playback start
static Int	STATE_NOT_STARTED Playback has not started (initial state)
static Int	STATE_PAUSED Playback is paused but ready to play
static Int	STATE_PAUSED_BUFFERING Playback is buffering while paused.
static Int	STATE_PLAYING Playback is actively playing
static Int	STATE_SEEKING Playback is handling a seek.
static Int	STATE_STOPPED Playback is stopped and can be restarted.
static Int	STATE_SUPPRESSED Playback is suppressed (e.g. due to audio focus loss).
static Int	STATE_SUPPRESSED_BUFFERING Playback is suppressed (e.g. due to audio focus loss) while buffering to resume a playback.

Inherited constants

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public methods
Int	describeContents()
Boolean	equals(other: Any?) Indicates whether some other object is "equal to" this one.
Bundle	getMetricsBundle() Gets metrics-related information that is not supported by dedicated methods.
Int	getState() Gets playback state.
Long	getTimeSinceCreatedMillis() Gets time since the corresponding playback session is created in millisecond.
Int	hashCode()
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<PlaybackStateEvent!>	CREATOR

Constants

STATE_ABANDONED

Added in API level 31

static val STATE_ABANDONED: Int

Playback is abandoned before reaching the end of the media.

Value: 15

STATE_BUFFERING

Added in API level 31

static val STATE_BUFFERING: Int

Playback is buffering to resume active playback.

Value: 6

STATE_ENDED

Added in API level 31

static val STATE_ENDED: Int

Playback has reached the end of the media.

Value: 11

STATE_FAILED

Added in API level 31

static val STATE_FAILED: Int

Playback is stopped due a fatal error and can be retried.

Value: 13

STATE_INTERRUPTED_BY_AD

Added in API level 31

static val STATE_INTERRUPTED_BY_AD: Int

Playback is interrupted by an ad.

Value: 14

STATE_JOINING_BACKGROUND

Added in API level 31

static val STATE_JOINING_BACKGROUND: Int

Playback is buffering in the background for initial playback start

Value: 1

STATE_JOINING_FOREGROUND

Added in API level 31

static val STATE_JOINING_FOREGROUND: Int

Playback is buffering in the foreground for initial playback start

Value: 2

STATE_NOT_STARTED

Added in API level 31

static val STATE_NOT_STARTED: Int

Playback has not started (initial state)

Value: 0

STATE_PAUSED

Added in API level 31

static val STATE_PAUSED: Int

Playback is paused but ready to play

Value: 4

STATE_PAUSED_BUFFERING

Added in API level 31

static val STATE_PAUSED_BUFFERING: Int

Playback is buffering while paused.

Value: 7

STATE_PLAYING

Added in API level 31

static val STATE_PLAYING: Int

Playback is actively playing

Value: 3

STATE_SEEKING

Added in API level 31

static val STATE_SEEKING: Int

Playback is handling a seek.

Value: 5

STATE_STOPPED

Added in API level 31

static val STATE_STOPPED: Int

Playback is stopped and can be restarted.

Value: 12

STATE_SUPPRESSED

Added in API level 31

static val STATE_SUPPRESSED: Int

Playback is suppressed (e.g. due to audio focus loss).

Value: 9

STATE_SUPPRESSED_BUFFERING

Added in API level 31

static val STATE_SUPPRESSED_BUFFERING: Int

Playback is suppressed (e.g. due to audio focus loss) while buffering to resume a playback.

Value: 10

Public methods

describeContents

Added in API level 31

fun describeContents(): Int

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 31

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj	the reference object with which to compare.
o	This value may be null.

Return
Boolean	true if this object is the same as the obj argument; false otherwise.

getMetricsBundle

Added in API level 31

fun getMetricsBundle(): Bundle

Gets metrics-related information that is not supported by dedicated methods.

It is intended to be used for backwards compatibility by the metrics infrastructure.

Return
Bundle	This value cannot be null.

getState

Added in API level 31

fun getState(): Int

Gets playback state.

Return

Int

Value is android.media.metrics.PlaybackStateEvent#STATE_NOT_STARTED, android.media.metrics.PlaybackStateEvent#STATE_JOINING_BACKGROUND, android.media.metrics.PlaybackStateEvent#STATE_JOINING_FOREGROUND, android.media.metrics.PlaybackStateEvent#STATE_PLAYING, android.media.metrics.PlaybackStateEvent#STATE_PAUSED, android.media.metrics.PlaybackStateEvent#STATE_SEEKING, android.media.metrics.PlaybackStateEvent#STATE_BUFFERING, android.media.metrics.PlaybackStateEvent#STATE_PAUSED_BUFFERING, android.media.metrics.PlaybackStateEvent#STATE_SUPPRESSED, android.media.metrics.PlaybackStateEvent#STATE_SUPPRESSED_BUFFERING, android.media.metrics.PlaybackStateEvent#STATE_ENDED, android.media.metrics.PlaybackStateEvent#STATE_STOPPED, android.media.metrics.PlaybackStateEvent#STATE_FAILED, android.media.metrics.PlaybackStateEvent#STATE_INTERRUPTED_BY_AD, or android.media.metrics.PlaybackStateEvent#STATE_ABANDONED

getTimeSinceCreatedMillis

Added in API level 31

fun getTimeSinceCreatedMillis(): Long

Gets time since the corresponding playback session is created in millisecond.

Return
Long	the timestamp since the playback is created, or -1 if unknown. Value is -1 or greater

See Also

• android.media.metrics.LogSessionId
• android.media.metrics.PlaybackSession

hashCode

Added in API level 31

fun hashCode(): Int

Return
Int	a hash code value for this object.

writeToParcel

Added in API level 31

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest	Parcel: This value cannot be null.
flags	Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 31

static val CREATOR: Parcelable.Creator<PlaybackStateEvent!>