PlayerRepository

interface PlayerRepository

Functions

addMedia

abstract fun addMedia(media: Media)

Adds a Media to the end of the playlist.

abstract fun addMedia(index: Int, media: Media)

Adds a Media at the given index of the playlist.

clearMediaList

abstract fun clearMediaList()

Clears the playlist.

getCurrentMediaIndex

abstract fun getCurrentMediaIndex(): Int

Returns the index of the current Media.

getMediaAt

abstract fun getMediaAt(index: Int): Media?

Returns the Media at the given index.

getMediaCount

abstract fun getMediaCount(): Int

Returns the number of Media in the playlist.

getSeekBackIncrement

abstract fun getSeekBackIncrement(): Duration

Returns the seekBack increment.

getSeekForwardIncrement

abstract fun getSeekForwardIncrement(): Duration

Returns the seekForward increment.

hasNextMedia

abstract fun hasNextMedia(): Boolean

Returns whether a next Media exists.

hasPreviousMedia

abstract fun hasPreviousMedia(): Boolean

Returns whether a previous Media exists.

pause

abstract fun pause()

Pauses playback.

play

abstract fun play()

Resumes playback as soon as player is ready.

prepare

abstract fun prepare()

Prepares the player.

release

abstract fun release()

Releases the player.

removeMedia

abstract fun removeMedia(index: Int)

Removes the Media at the given index of the playlist.

seekBack

abstract fun seekBack()

Seeks back in the current media by seek back increment.

seekForward

abstract fun seekForward()

Seek forward in the current media by seek forward increment.

seekToDefaultPosition

abstract fun seekToDefaultPosition(mediaIndex: Int)

Seeks to the default position associated with the specified Media.

setMedia

abstract fun setMedia(media: Media)

Clears the playlist, adds the specified Media and resets the position to the default position.

setMediaList

abstract fun setMediaList(mediaList: List<Media>)

Clears the playlist, adds the specified Media list and resets the position to the default position.

setMediaListAndPlay

abstract fun setMediaListAndPlay(mediaList: List<Media>, index: Int)

Clears the playlist, adds the specified Media list and plays the Media at the position of the index passed as param.

setShuffleModeEnabled

abstract fun setShuffleModeEnabled(shuffleModeEnabled: Boolean)

Sets whether shuffling of Media is enabled.

skipToNextMedia

abstract fun skipToNextMedia()

Skips to the default position of next Media.

skipToPreviousMedia

abstract fun skipToPreviousMedia()

Skips to the default position of previous Media.

Properties

availableCommands

abstract val availableCommands: StateFlow<Set<Command>>

Returns the player's currently available commands.

connected

abstract val connected: StateFlow<Boolean>

Returns whether the repository is currently connected to a working Player.

currentMedia

abstract val currentMedia: StateFlow<Media?>

Returns the current Media playing, or that would play when player starts playing.

currentState

abstract val currentState: StateFlow<PlayerState>

Returns the player's current state.

mediaPosition

abstract val mediaPosition: StateFlow<MediaPosition?>

Returns the current media position of the player.

shuffleModeEnabled

abstract val shuffleModeEnabled: StateFlow<Boolean>

Returns the current value for shuffling of Media mode.