PlaybackStateEvent
public
final
class
PlaybackStateEvent
extends Event
implements
Parcelable
java.lang.Object | ||
↳ | android.media.metrics.Event | |
↳ | android.media.metrics.PlaybackStateEvent |
Playback state event.
Summary
Nested classes | |
---|---|
class |
PlaybackStateEvent.Builder
A builder for |
Constants | |
---|---|
int |
STATE_ABANDONED
Playback is abandoned before reaching the end of the media. |
int |
STATE_BUFFERING
Playback is buffering to resume active playback. |
int |
STATE_ENDED
Playback has reached the end of the media. |
int |
STATE_FAILED
Playback is stopped due a fatal error and can be retried. |
int |
STATE_INTERRUPTED_BY_AD
Playback is interrupted by an ad. |
int |
STATE_JOINING_BACKGROUND
Playback is buffering in the background for initial playback start |
int |
STATE_JOINING_FOREGROUND
Playback is buffering in the foreground for initial playback start |
int |
STATE_NOT_STARTED
Playback has not started (initial state) |
int |
STATE_PAUSED
Playback is paused but ready to play |
int |
STATE_PAUSED_BUFFERING
Playback is buffering while paused. |
int |
STATE_PLAYING
Playback is actively playing |
int |
STATE_SEEKING
Playback is handling a seek. |
int |
STATE_STOPPED
Playback is stopped and can be restarted. |
int |
STATE_SUPPRESSED
Playback is suppressed (e.g. due to audio focus loss). |
int |
STATE_SUPPRESSED_BUFFERING
Playback is suppressed (e.g. due to audio focus loss) while buffering to resume a playback. |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<PlaybackStateEvent> |
CREATOR
|
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
boolean
|
equals(Object o)
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()
Returns a hash code value for the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Constants
STATE_ABANDONED
public static final int STATE_ABANDONED
Playback is abandoned before reaching the end of the media.
Constant Value: 15 (0x0000000f)
STATE_BUFFERING
public static final int STATE_BUFFERING
Playback is buffering to resume active playback.
Constant Value: 6 (0x00000006)
STATE_ENDED
public static final int STATE_ENDED
Playback has reached the end of the media.
Constant Value: 11 (0x0000000b)
STATE_FAILED
public static final int STATE_FAILED
Playback is stopped due a fatal error and can be retried.
Constant Value: 13 (0x0000000d)
STATE_INTERRUPTED_BY_AD
public static final int STATE_INTERRUPTED_BY_AD
Playback is interrupted by an ad.
Constant Value: 14 (0x0000000e)
STATE_JOINING_BACKGROUND
public static final int STATE_JOINING_BACKGROUND
Playback is buffering in the background for initial playback start
Constant Value: 1 (0x00000001)
STATE_JOINING_FOREGROUND
public static final int STATE_JOINING_FOREGROUND
Playback is buffering in the foreground for initial playback start
Constant Value: 2 (0x00000002)
STATE_NOT_STARTED
public static final int STATE_NOT_STARTED
Playback has not started (initial state)
Constant Value: 0 (0x00000000)
STATE_PAUSED
public static final int STATE_PAUSED
Playback is paused but ready to play
Constant Value: 4 (0x00000004)
STATE_PAUSED_BUFFERING
public static final int STATE_PAUSED_BUFFERING
Playback is buffering while paused.
Constant Value: 7 (0x00000007)
STATE_PLAYING
public static final int STATE_PLAYING
Playback is actively playing
Constant Value: 3 (0x00000003)
STATE_SEEKING
public static final int STATE_SEEKING
Playback is handling a seek.
Constant Value: 5 (0x00000005)
STATE_STOPPED
public static final int STATE_STOPPED
Playback is stopped and can be restarted.
Constant Value: 12 (0x0000000c)
STATE_SUPPRESSED
public static final int STATE_SUPPRESSED
Playback is suppressed (e.g. due to audio focus loss).
Constant Value: 9 (0x00000009)
STATE_SUPPRESSED_BUFFERING
public static final int STATE_SUPPRESSED_BUFFERING
Playback is suppressed (e.g. due to audio focus loss) while buffering to resume a playback.
Constant Value: 10 (0x0000000a)
Fields
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 |
equals
public boolean equals (Object o)
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
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons 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 | |
---|---|
o |
Object : This value may be null . |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getMetricsBundle
public Bundle getMetricsBundle ()
Gets metrics-related information that is not supported by dedicated methods.
It is intended to be used for backwards compatibility by the metrics infrastructure.
Returns | |
---|---|
Bundle |
This value cannot be null . |
getState
public int getState ()
Gets playback state.
getTimeSinceCreatedMillis
public long getTimeSinceCreatedMillis ()
Gets time since the corresponding playback session is created in millisecond.
Returns | |
---|---|
long |
the timestamp since the playback is created, or -1 if unknown. Value is -1 or greater |
See also:
hashCode
public int hashCode ()
Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
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
hashCode
method must consistently return the same integer, provided no information used inequals
comparisons 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
equals
method, then calling thehashCode
method 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
equals
method, then calling thehashCode
method 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.
Returns | |
---|---|
int |
a hash code value for this object. |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
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.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-11 UTC.