PlaybackStateEvent.Builder

Kotlin |Java

public static final class PlaybackStateEvent.Builder
extends Object

java.lang.Object
↳	android.media.metrics.PlaybackStateEvent.Builder

A builder for PlaybackStateEvent

Summary

Public constructors
`Builder()` Creates a new Builder.

Public methods
`PlaybackStateEvent`	`build()` Builds the instance.
`PlaybackStateEvent.Builder`	`setMetricsBundle(Bundle metricsBundle)` Sets metrics-related information that is not supported by dedicated methods.
`PlaybackStateEvent.Builder`	`setState(int value)` Sets playback state.
`PlaybackStateEvent.Builder`	`setTimeSinceCreatedMillis(long value)` Sets timestamp since the creation in milliseconds.

Inherited methods

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 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`	`wait(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`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Builder

Added in API level 31

public Builder ()

Creates a new Builder.

Public methods

build

Added in API level 31

public PlaybackStateEvent build ()

Builds the instance.

Returns
`PlaybackStateEvent`	This value cannot be `null`.

setMetricsBundle

Added in API level 31

public PlaybackStateEvent.Builder setMetricsBundle (Bundle metricsBundle)

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

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

Parameters
`metricsBundle`	`Bundle`: This value cannot be `null`.

Returns
`PlaybackStateEvent.Builder`	This value cannot be `null`.

setState

Added in API level 31

public PlaybackStateEvent.Builder setState (int value)

Sets playback state.

Parameters

Parameters
`value`	`int`: Value is `PlaybackStateEvent.STATE_NOT_STARTED`, `PlaybackStateEvent.STATE_JOINING_BACKGROUND`, `PlaybackStateEvent.STATE_JOINING_FOREGROUND`, `PlaybackStateEvent.STATE_PLAYING`, `PlaybackStateEvent.STATE_PAUSED`, `PlaybackStateEvent.STATE_SEEKING`, `PlaybackStateEvent.STATE_BUFFERING`, `PlaybackStateEvent.STATE_PAUSED_BUFFERING`, `PlaybackStateEvent.STATE_SUPPRESSED`, `PlaybackStateEvent.STATE_SUPPRESSED_BUFFERING`, `PlaybackStateEvent.STATE_ENDED`, `PlaybackStateEvent.STATE_STOPPED`, `PlaybackStateEvent.STATE_FAILED`, `PlaybackStateEvent.STATE_INTERRUPTED_BY_AD`, or `PlaybackStateEvent.STATE_ABANDONED`

value

int: Value is PlaybackStateEvent.STATE_NOT_STARTED, PlaybackStateEvent.STATE_JOINING_BACKGROUND, PlaybackStateEvent.STATE_JOINING_FOREGROUND, PlaybackStateEvent.STATE_PLAYING, PlaybackStateEvent.STATE_PAUSED, PlaybackStateEvent.STATE_SEEKING, PlaybackStateEvent.STATE_BUFFERING, PlaybackStateEvent.STATE_PAUSED_BUFFERING, PlaybackStateEvent.STATE_SUPPRESSED, PlaybackStateEvent.STATE_SUPPRESSED_BUFFERING, PlaybackStateEvent.STATE_ENDED, PlaybackStateEvent.STATE_STOPPED, PlaybackStateEvent.STATE_FAILED, PlaybackStateEvent.STATE_INTERRUPTED_BY_AD, or PlaybackStateEvent.STATE_ABANDONED

Returns
`PlaybackStateEvent.Builder`	This value cannot be `null`.

setTimeSinceCreatedMillis

Added in API level 31

public PlaybackStateEvent.Builder setTimeSinceCreatedMillis (long value)

Sets timestamp since the creation in milliseconds.

Parameters
`value`	`long`: the timestamp since the creation in milliseconds. -1 indicates the value is unknown. Value is -1 or greater

Returns
`PlaybackStateEvent.Builder`	This value cannot be `null`.

See also:

PlaybackStateEvent.getTimeSinceCreatedMillis()