Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#nestedclasses) \| [Constants](https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#constants) \| [Inherited Constants](https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#inhconstants) \| [Fields](https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#lfields) \| [Methods](https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#inhmethods)

# PlaybackStateEvent

*** ** * ** ***


`
public

final

class
PlaybackStateEvent
`


`


`

`

extends https://developer.android.com/reference/android/media/metrics/Event


`

`


implements

https://developer.android.com/reference/android/os/Parcelable


`

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) |||
| ↳ | [android.media.metrics.Event](https://developer.android.com/reference/android/media/metrics/Event) ||
|   | ↳ | android.media.metrics.PlaybackStateEvent |

<br />

*** ** * ** ***

Playback state event.

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent.Builder` A builder for `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent` |

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

| ### Inherited constants |
|---|
| From interface `https://developer.android.com/reference/android/os/Parcelable` |---|---| | `int` | `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor. | | `int` | `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent>` | `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#CREATOR` |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object o) ` Indicates whether some other object is "equal to" this one. |
| ` https://developer.android.com/reference/android/os/Bundle` | ` https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#getMetricsBundle()() ` Gets metrics-related information that is not supported by dedicated methods. |
| ` int` | ` https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#getState()() ` Gets playback state. |
| ` long` | ` https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#getTimeSinceCreatedMillis()() ` Gets time since the corresponding playback session is created in millisecond. |
| ` int` | ` https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#hashCode()() ` Returns a hash code value for the object. |
| ` void` | ` https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) ` Flatten this object in to a Parcel. |

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

## Constants

### STATE_ABANDONED

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_ABANDONED
```

Playback is abandoned before reaching the end of the media.

<br />

Constant Value:

15
(0x0000000f)


### STATE_BUFFERING

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_BUFFERING
```

Playback is buffering to resume active playback.

<br />

Constant Value:

6
(0x00000006)


### STATE_ENDED

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_ENDED
```

Playback has reached the end of the media.

<br />

Constant Value:

11
(0x0000000b)


### STATE_FAILED

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_FAILED
```

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

<br />

Constant Value:

13
(0x0000000d)


### STATE_INTERRUPTED_BY_AD

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_INTERRUPTED_BY_AD
```

Playback is interrupted by an ad.

<br />

Constant Value:

14
(0x0000000e)


### STATE_JOINING_BACKGROUND

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_JOINING_BACKGROUND
```

Playback is buffering in the background for initial playback start

<br />

Constant Value:

1
(0x00000001)


### STATE_JOINING_FOREGROUND

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_JOINING_FOREGROUND
```

Playback is buffering in the foreground for initial playback start

<br />

Constant Value:

2
(0x00000002)


### STATE_NOT_STARTED

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_NOT_STARTED
```

Playback has not started (initial state)

<br />

Constant Value:

0
(0x00000000)


### STATE_PAUSED

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_PAUSED
```

Playback is paused but ready to play

<br />

Constant Value:

4
(0x00000004)


### STATE_PAUSED_BUFFERING

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_PAUSED_BUFFERING
```

Playback is buffering while paused.

<br />

Constant Value:

7
(0x00000007)


### STATE_PLAYING

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_PLAYING
```

Playback is actively playing

<br />

Constant Value:

3
(0x00000003)


### STATE_SEEKING

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_SEEKING
```

Playback is handling a seek.

<br />

Constant Value:

5
(0x00000005)


### STATE_STOPPED

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_STOPPED
```

Playback is stopped and can be restarted.

<br />

Constant Value:

12
(0x0000000c)


### STATE_SUPPRESSED

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_SUPPRESSED
```

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

<br />

Constant Value:

9
(0x00000009)


### STATE_SUPPRESSED_BUFFERING

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATE_SUPPRESSED_BUFFERING
```

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

<br />

Constant Value:

10
(0x0000000a)


## Fields

### CREATOR

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<PlaybackStateEvent> CREATOR
```

<br />

<br />

## Public methods

### describeContents

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`,
the return value of this method must include the
`https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### equals

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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


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.

<br />

| Parameters ||
|---|---|
| `o` | `Object`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getMetricsBundle

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/os/Bundle` | This value cannot be `null`. <br /> |

### getState

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getState ()
```

Gets playback state.

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#STATE_NOT_STARTED` - `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#STATE_JOINING_BACKGROUND` - `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#STATE_JOINING_FOREGROUND` - `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#STATE_PLAYING` - `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#STATE_PAUSED` - `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#STATE_SEEKING` - `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#STATE_BUFFERING` - `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#STATE_PAUSED_BUFFERING` - `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#STATE_SUPPRESSED` - `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#STATE_SUPPRESSED_BUFFERING` - `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#STATE_ENDED` - `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#STATE_STOPPED` - `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#STATE_FAILED` - `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#STATE_INTERRUPTED_BY_AD` - `https://developer.android.com/reference/android/media/metrics/PlaybackStateEvent#STATE_ABANDONED` |

### getTimeSinceCreatedMillis

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public long getTimeSinceCreatedMillis ()
```

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

<br />

| Returns ||
|---|---|
| `long` | the timestamp since the playback is created, or -1 if unknown. Value is -1 or greater <br /> |

**See also:**

- `https://developer.android.com/reference/android/media/metrics/LogSessionId`
- `https://developer.android.com/reference/android/media/metrics/PlaybackSession`

### hashCode

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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
`https://developer.android.com/reference/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 `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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.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 `https://developer.android.com/reference/java/lang/Object#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.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### writeToParcel

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |