PlaybackStateEvent
class PlaybackStateEvent : Event, Parcelable
| kotlin.Any | ||
| ↳ | android.media.metrics.Event | |
| ↳ | android.media.metrics.PlaybackStateEvent | |
Playback state event.
Summary
| Nested classes | |
|---|---|
|
A builder for |
|
| Constants | |
|---|---|
| static Int |
Playback is abandoned before reaching the end of the media. |
| static Int |
Playback is buffering to resume active playback. |
| static Int |
Playback has reached the end of the media. |
| static Int |
Playback is stopped due a fatal error and can be retried. |
| static Int |
Playback is interrupted by an ad. |
| static Int |
Playback is buffering in the background for initial playback start |
| static Int |
Playback is buffering in the foreground for initial playback start |
| static Int |
Playback has not started (initial state) |
| static Int |
Playback is paused but ready to play |
| static Int |
Playback is buffering while paused. |
| static Int |
Playback is actively playing |
| static Int |
Playback is handling a seek. |
| static Int |
Playback is stopped and can be restarted. |
| static Int |
Playback is suppressed (e.g. due to audio focus loss). |
| static Int |
Playback is suppressed (e.g. due to audio focus loss) while buffering to resume a playback. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Bundle |
Gets metrics-related information that is not supported by dedicated methods. |
| Int |
getState()Gets playback state. |
| Long |
Gets time since the corresponding playback session is created in millisecond. |
| Int |
hashCode()Returns a hash code value for the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<PlaybackStateEvent!> | |
Constants
STATE_ABANDONED
static val STATE_ABANDONED: Int
Playback is abandoned before reaching the end of the media.
Value: 15STATE_BUFFERING
static val STATE_BUFFERING: Int
Playback is buffering to resume active playback.
Value: 6STATE_ENDED
static val STATE_ENDED: Int
Playback has reached the end of the media.
Value: 11STATE_FAILED
static val STATE_FAILED: Int
Playback is stopped due a fatal error and can be retried.
Value: 13STATE_INTERRUPTED_BY_AD
static val STATE_INTERRUPTED_BY_AD: Int
Playback is interrupted by an ad.
Value: 14STATE_JOINING_BACKGROUND
static val STATE_JOINING_BACKGROUND: Int
Playback is buffering in the background for initial playback start
Value: 1STATE_JOINING_FOREGROUND
static val STATE_JOINING_FOREGROUND: Int
Playback is buffering in the foreground for initial playback start
Value: 2STATE_NOT_STARTED
static val STATE_NOT_STARTED: Int
Playback has not started (initial state)
Value: 0STATE_PAUSED
static val STATE_PAUSED: Int
Playback is paused but ready to play
Value: 4STATE_PAUSED_BUFFERING
static val STATE_PAUSED_BUFFERING: Int
Playback is buffering while paused.
Value: 7STATE_PLAYING
static val STATE_PLAYING: Int
Playback is actively playing
Value: 3STATE_SEEKING
static val STATE_SEEKING: Int
Playback is handling a seek.
Value: 5STATE_STOPPED
static val STATE_STOPPED: Int
Playback is stopped and can be restarted.
Value: 12STATE_SUPPRESSED
static val STATE_SUPPRESSED: Int
Playback is suppressed (e.g. due to audio focus loss).
Value: 9STATE_SUPPRESSED_BUFFERING
static val STATE_SUPPRESSED_BUFFERING: Int
Playback is suppressed (e.g. due to audio focus loss) while buffering to resume a playback.
Value: 10Public methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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
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
fun getState(): Int
Gets playback state.
| Return | |
|---|---|
Int |
Value is one of the following: |
getTimeSinceCreatedMillis
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 |
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Return | |
|---|---|
Int |
a hash code value for this object. |
writeToParcel
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 the following:
|