PlayPauseButtonState

Artifact: androidx.media3:media3-ui-compose

View Source

@UnstableApi
class PlayPauseButtonState

---

State that converts the necessary information from the Player to correctly deal with a UI component representing a PlayPause button.

Summary

Public constructors
PlayPauseButtonState(player: Player?)

Public functions
suspend Unit	observe() Subscribes to updates from Player.Events and listens to
Unit	onClick() Handles the interaction with the PlayPause button according to the current state of the Player.

Public properties
Boolean	isEnabled true if player is not null, Player.COMMAND_PLAY_PAUSE is available and we have something in the Timeline to play.
Boolean	showPlay true if player is null or shouldShowPlayButton is true.

Public constructors

PlayPauseButtonState

PlayPauseButtonState(player: Player?)

Public functions

observe

suspend fun observe(): Unit

Subscribes to updates from Player.Events and listens to

• Player.EVENT_PLAYBACK_STATE_CHANGED and Player.EVENT_PLAY_WHEN_READY_CHANGED in order to determine whether a play or a pause button should be presented on a UI element for playback control.

• Player.EVENT_AVAILABLE_COMMANDS_CHANGED in order to determine whether the button should be enabled, i.e. respond to user input.

onClick

fun onClick(): Unit

Handles the interaction with the PlayPause button according to the current state of the Player.

The Player update that follows can take a form of Player.play, Player.pause, Player.prepare or Player.seekToDefaultPosition.

This method must only be programmatically called if the state is enabled. However, it can be freely provided into containers that take care of skipping the onClick if a particular UI node is not enabled (see Compose Clickable Modifier).

See also
handlePlayButtonAction
handlePauseButtonAction
shouldShowPlayButton
COMMAND_PLAY_PAUSE
COMMAND_GET_CURRENT_MEDIA_ITEM

Public properties

isEnabled

val isEnabled: Boolean

true if player is not null, Player.COMMAND_PLAY_PAUSE is available and we have something in the Timeline to play.

showPlay

val showPlay: Boolean

true if player is null or shouldShowPlayButton is true.