kodio-core/space.kodio.core/Player

Player

class Player

High-level wrapper around AudioPlaybackSession providing a simplified API.

Example Usage

val player = Kodio.player()

// Load and play a recording
player.load(recording)
player.start()

// Control playback
player.pause()
player.resume()
player.stop()

// Clean up
player.release()

// Or use with structured concurrency
Kodio.play(recording) { player ->
    player.start()
    player.awaitComplete()
} // auto-released

Properties

val isFinished: Boolean

Whether playback has finished.

val isPaused: Boolean

Whether the player is paused.

val isPlaying: Boolean

Whether the player is currently playing audio.

val isReady: Boolean

Whether the player is ready to play (has audio loaded). This includes Ready, Paused, and Finished states where audio is available.

val sessionState: AudioSessionState

The current unified state of the player.

val stateFlow: StateFlow<AudioPlaybackSession.State>

Flow of state changes for observing the player.

Functions

suspend fun awaitComplete()

Waits for playback to complete (finish or error).

suspend fun load(recording: AudioRecording)

Loads an AudioRecording for playback.

suspend fun loadAudioFlow(audioFlow: AudioFlow)

Loads an AudioFlow for playback (legacy compatibility).

fun pause()

Pauses playback. Can be resumed with resume.

Releases resources associated with this player. The player should not be used after calling this method.

fun resume()

Resumes paused playback.

suspend fun start()

Starts playback.

fun stop()

Stops playback and resets to the beginning.

suspend fun toggle(): Boolean?

Toggles between playing and paused states.

underlyingSession

fun ~~underlyingSession~~(): AudioPlaybackSession

Access the underlying session for advanced use cases.

inline fun <T> Player.use(block: (Player) -> T): T

Extension for using Player with Kotlin's use pattern. Ensures proper cleanup even if an exception occurs.