PlaybackState

@UnstableApi
class PlaybackState

A general-purpose, read-only state holder that observes and exposes the core playback states of a Player reactively for Compose UIs.

This state is decoupled from any specific UI component and is ideal for driving overlays, shimmers, or custom control layouts.

Summary

Public constructors
`PlaybackState(player: Player?)`

Public functions
`suspend Nothing?`	`observe()` Subscribes to updates from `Player.Events` and listens to:

Public properties
`Boolean`	`isPlaying` Whether the player is actively playing.
`Boolean`	`playWhenReady` Whether the player should play when ready.
`Int`	`playbackState` The raw @Player.State of the player.
`Int`	`playbackSuppressionReason` The reason why playback is suppressed even if `playWhenReady` is true, or `Player.PLAYBACK_SUPPRESSION_REASON_NONE` if playback is not suppressed.
`PlaybackException?`	`playerError` The last error that caused playback to fail, or null if there is no error.

PlaybackState(player: Player?)

suspend fun observe(): Nothing?

Subscribes to updates from Player.Events and listens to:

Player.EVENT_PLAYBACK_STATE_CHANGED, Player.EVENT_PLAY_WHEN_READY_CHANGED and Player.EVENT_PLAYBACK_SUPPRESSION_REASON_CHANGED in order to determine whether the player is buffering, has ended, or is playing.
Player.EVENT_IS_PLAYING_CHANGED in order to determine whether the player is actively playing.
Player.EVENT_PLAYER_ERROR in order to determine whether a playback error occurred.

val isPlaying: Boolean

Whether the player is actively playing.

val playWhenReady: Boolean

Whether the player should play when ready.

val playbackState: Int

The raw @Player.State of the player.

val playbackSuppressionReason: Int

The reason why playback is suppressed even if playWhenReady is true, or Player.PLAYBACK_SUPPRESSION_REASON_NONE if playback is not suppressed.

val playerError: PlaybackException?

The last error that caused playback to fail, or null if there is no error.