# Print output for @column tags ?>
Developers

- Design
- Develop
- Distribute

Developer Console

## Most visited

## Recently visited

## Results for

Summary: Nested Classes | Constants | Inherited Constants | Fields | Methods | Inherited Methods

# 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 `PlaybackStateEvent`

### 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
From interface `android.os.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(Parcel, int)`: 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)`".

### 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
From class `android.media.metrics.Event`
`Bundle` | `getMetricsBundle()` Gets metrics-related information that is not supported by dedicated methods.
`long` | `getTimeSinceCreatedMillis()` Gets time since the corresponding log session is created in millisecond.
From class `java.lang.Object`
`Object` | `clone()` Creates and returns a copy of this object.
`boolean` | `equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void` | `finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>` | `getClass()` Returns the runtime class of this `Object`.
`int` | `hashCode()` Returns a hash code value for the object.
`final void` | `notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void` | `notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String` | `toString()` Returns a string representation of the object.
`final void` | `wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void` | `wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void` | `wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
From interface `android.os.Parcelable`
`abstract int` | `describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void` | `writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

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

### CREATOR

    public static final Creator<PlaybackStateEvent> 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`

### 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 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`.

The `equals` method for class `Object` implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values `x` and `y`, this method returns `true` if and only if `x` and `y` refer to the same object (`x == y` has the value `true`).

Note that it is generally necessary to override the `hashCode` method whenever this method is overridden, so as to maintain the general contract for the `hashCode` method, which states that equal objects must have equal hash codes.

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.

Returns
`int` | Value is `STATE_NOT_STARTED`, `STATE_JOINING_BACKGROUND`, `STATE_JOINING_FOREGROUND`, `STATE_PLAYING`, `STATE_PAUSED`, `STATE_SEEKING`, `STATE_BUFFERING`, `STATE_PAUSED_BUFFERING`, `STATE_SUPPRESSED`, `STATE_SUPPRESSED_BUFFERING`, `STATE_ENDED`, `STATE_STOPPED`, `STATE_FAILED`, `STATE_INTERRUPTED_BY_AD`, or `STATE_ABANDONED`

### 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:

- `LogSessionId`
- `PlaybackSession`

### 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 in `equals` 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(Object)` method, then calling the `hashCode` 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(java.lang.Object)` method, then calling the `hashCode` 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.

As much as is reasonably practical, the hashCode method defined by class `Object` does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

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

Full name *
Email address *
Company / developer name
One of your Play Store app URLs *
Which best describes your business:*
Apps
Games
Apps & Games
*
*