player/su.pank.yamapi.player

Package-level declarations

Types

data class PlaybackItem(val id: String, val title: String, val artists: List<String>, val durationMillis: Long?, val artworkUrl: String?)

Presentation-safe metadata for the active track.

PlaybackUrl

class PlaybackUrl(val value: String)

Short-lived signed URL with a redacted string representation.

PlaybackUrlUnavailableException

class PlaybackUrlUnavailableException : IllegalStateException

Player

class Player

Cross-platform playback controller.

PlayerFailure

enum PlayerFailure : Enum<PlayerFailure>

PlayerPhase

enum PlayerPhase : Enum<PlayerPhase>

PlayerState

data class PlayerState(val phase: PlayerPhase = PlayerPhase.IDLE, val item: PlaybackItem? = null, val queue: List<PlaybackItem> = emptyList(), val currentIndex: Int = -1, val repeatMode: RepeatMode = RepeatMode.OFF, val isShuffled: Boolean = false, val positionMillis: Long = 0, val bufferedPositionMillis: Long = 0, val durationMillis: Long? = null, val failure: PlayerFailure? = null)

Public player state. Signed media URLs are intentionally absent.

RepeatMode

enum RepeatMode : Enum<RepeatMode>

Functions

createAndroidMediaSession

fun createAndroidMediaSession(context: Context, exoPlayer: ExoPlayer): MediaSession

Builds a MediaSession over the same ExoPlayer used by createAndroidPlayer.

fun createAndroidMediaSession(context: Context, exoPlayer: ExoPlayer, player: Player, scope: CoroutineScope): MediaSession

Builds a MediaSession whose system next/previous commands control the common queue. The host supplies a service-owned scope and remains responsible for releasing the session.

createAndroidPlayer

fun createAndroidPlayer(context: Context): Player

Creates an owned Media3 player with audio-focus handling enabled.

fun createAndroidPlayer(exoPlayer: ExoPlayer, releasePlayerOnClose: Boolean = false): Player

Wraps an existing ExoPlayer. This is the preferred factory for a host-owned MediaSessionService; the host keeps lifecycle control by default.

createIosPlayer

fun createIosPlayer(): Player

Creates an iOS player backed by AVPlayer and system media controls.

createWebPlayer

fun createWebPlayer(): Player

Creates a browser-backed player using an HTMLAudioElement.

playbackUrl

suspend fun Track.playbackUrl(): PlaybackUrl

Resolves this track into the best full, direct playback URL.