MuteButtonState

Artifact: androidx.media3:media3-ui-compose

@UnstableApi
class MuteButtonState

State that holds all interactions to correctly deal with a UI component representing a Mute button.

Summary

Public constructors
`MuteButtonState(player: Player?)`

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

Public properties
`Boolean`	`isEnabled` true if `player` is not `null` and commands `Player.COMMAND_SET_VOLUME` and `Player.COMMAND_GET_VOLUME` are available.
`Boolean`	`showMuted` true if `player` is not `null` and Player.volume is 0.0f.

Public constructors

MuteButtonState

MuteButtonState(player: Player?)

Public functions

observe

suspend fun observe(): Unit

Subscribes to updates from Player.Events and listens to

Player.EVENT_VOLUME_CHANGED in order to determine whether a mute button should show a mute or unmuted icon.
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 Mute button according to the current state of the Player. Toggled between a muted state (volume of the Player is 0) and non-muted. Does not influence the volume of the device.

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
`mute`
`unmute`
`COMMAND_GET_VOLUME`
`COMMAND_SET_VOLUME`

Public properties

isEnabled

val isEnabled: Boolean

true if player is not null and commands Player.COMMAND_SET_VOLUME and Player.COMMAND_GET_VOLUME are available.

showMuted

val showMuted: Boolean

true if player is not null and Player.volume is 0.0f.