compose/space.kodio.compose/PlayerState

PlayerState

class PlayerState

State holder for audio playback in Compose.

Provides a simplified, reactive API for playing audio that integrates with Compose's state management.

Example Usage

@Composable
fun AudioPlayer(recording: AudioRecording) {
    val playerState = rememberPlayerState(recording)

    Column {
        // Show playback status
        Text(
            when {
                playerState.isLoading -> "Loading..."
                playerState.isPlaying -> "Playing"
                playerState.isPaused -> "Paused"
                playerState.isFinished -> "Finished"
                else -> "Ready"
            }
        )

        // Play/Pause button
        Button(
            onClick = { playerState.toggle() },
            enabled = playerState.isReady && !playerState.isLoading
        ) {
            Text(if (playerState.isPlaying) "Pause" else "Play")
        }

        // Stop button
        Button(onClick = { playerState.stop() }) {
            Text("Stop")
        }
    }
}

Properties

val error: AudioError?

The most recent error, if any.

val hasError: Boolean

Whether there is an error.

val hasRecording: Boolean

Whether a recording is loaded.

val isFinished: Boolean

Whether playback has finished.

val isLoading: Boolean

Whether the player is loading audio.

val isPaused: Boolean

Whether the player is paused.

val isPlaying: Boolean

Whether the player is currently playing.

val isReady: Boolean

Whether the player is ready (has audio loaded and can play).

val recording: AudioRecording?

The currently loaded recording.

Functions

fun clearError()

Clears the current error.

fun load(recording: AudioRecording)

Loads an AudioRecording for playback.

suspend fun loadAsync(recording: AudioRecording)

Loads an AudioRecording for playback (suspend version).

fun pause()

Pauses playback.

fun play()

Starts or resumes playback.

suspend fun playAsync()

Starts or resumes playback (suspend version).

fun reset()

Resets the player state and unloads any recording.

suspend fun resetAsync()

Resets the player state and unloads any recording (suspend version).

fun stop()

Stops playback and resets to the beginning.

fun toggle()

Toggles between playing and paused states.

suspend fun toggleAsync(): Boolean?

Toggles between playing and paused states (suspend version).