ShuffleButtonState

Artifact: androidx.media3:media3-ui-compose

@UnstableApi
class ShuffleButtonState

State that holds all interactions to correctly deal with a UI component representing a Shuffle On/Off button.

Summary

Public constructors
`ShuffleButtonState(player: Player?)`

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

Public properties
`Boolean`	`isEnabled` true if `player` is not `null` and `Player.COMMAND_SET_SHUFFLE_MODE` is available.
`Boolean`	`shuffleOn` true if `player` is not `null` and Player.shuffleModeEnabled is enabled.

Public constructors

ShuffleButtonState

ShuffleButtonState(player: Player?)

Public functions

observe

suspend fun observe(): Unit

Subscribes to updates from Player.Events and listens to

Player.EVENT_SHUFFLE_MODE_ENABLED_CHANGED in order to determine the latest Player.getShuffleModeEnabled.
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 ShuffleButton according to the current state of the Player.

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
`setShuffleModeEnabled`
`COMMAND_SET_SHUFFLE_MODE`

Public properties

isEnabled

val isEnabled: Boolean

true if player is not null and Player.COMMAND_SET_SHUFFLE_MODE is available.

shuffleOn

val shuffleOn: Boolean

true if player is not null and Player.shuffleModeEnabled is enabled.