SeekForwardButtonState
@UnstableApi
class SeekForwardButtonState
State that holds all interactions to correctly deal with a UI component representing a seek forward button.
Summary
Public constructors |
|---|
SeekForwardButtonState(player: Player?) |
Public functions |
|
|---|---|
suspend Unit |
observe()Subscribes to updates from |
Unit |
onClick()Handles the interaction with the SeekForwardButton by seeking forward in the current |
Public properties |
|
|---|---|
Boolean |
true if |
Long |
determined by |
Public constructors
Public functions
observe
suspend fun observe(): Unit
Subscribes to updates from Player.Events and listens to
-
Player.EVENT_AVAILABLE_COMMANDS_CHANGEDin order to determine whether the button should be enabled, i.e. respond to user input. -
Player.EVENT_SEEK_FORWARD_INCREMENT_CHANGEDto get the newest seek forward increment.
onClick
fun onClick(): Unit
Handles the interaction with the SeekForwardButton by seeking forward in the current androidx.media3.common.MediaItem by seekForwardAmountMs milliseconds.
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 | |
|---|---|
seekForward |
|
COMMAND_SEEK_FORWARD |
Public properties
isEnabled
val isEnabled: Boolean
true if player is not null and Player.COMMAND_SEEK_FORWARD is available.
seekForwardAmountMs
val seekForwardAmountMs: Long
determined by player's seekForwardIncrement. Defaults to 0 if player is null.