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?, displayMode: @DisplayMode Int)

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	showBuffering
Boolean	showPlay true if player is null or shouldShowPlayButton is true.
Boolean	showReplay true if the replay indicator should be shown based on the displayMode.
Boolean	showRetry true if the retry indicator should be shown based on the displayMode.

Public constructors

PlayPauseButtonState

PlayPauseButtonState(
    player: Player?,
    displayMode: @DisplayMode Int = SHOW_BUFFERING_ALWAYS or SHOW_REPLAY_ON_ENDED or SHOW_RETRY_ON_ERROR
)

Parameters
displayMode: @DisplayMode Int = SHOW_BUFFERING_ALWAYS or SHOW_REPLAY_ON_ENDED or SHOW_RETRY_ON_ERROR	The @DisplayMode specifying when to show buffering, replay, or retry.

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.

It will have no effect if no suitable player method is available to handle the play request.

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. See shouldEnablePlayPauseButton for more details.

showBuffering

val showBuffering: Boolean

showPlay

val showPlay: Boolean

true if player is null or shouldShowPlayButton is true. Note that showReplay and showRetry are further specifications of this state, meaning if either is true, showPlay will also be true. Callers may prefer to prioritize showing retry and replay indicators over a generic play indicator.

showReplay

val showReplay: Boolean

true if the replay indicator should be shown based on the displayMode.

showRetry

val showRetry: Boolean

true if the retry indicator should be shown based on the displayMode.