PlayerRepository

interface PlayerRepository

Functions

addMediaItem

abstract fun addMediaItem(mediaItem: MediaItem)

Adds a media item to the end of the playlist.

abstract fun addMediaItem(index: Int, mediaItem: MediaItem)

Adds a media item at the given index of the playlist.

clearMediaItems

abstract fun clearMediaItems()

Clears the playlist.

getCurrentMediaItemIndex

abstract fun getCurrentMediaItemIndex(): Int

Returns the index of the current media item.

getMediaItemAt

abstract fun getMediaItemAt(index: Int): MediaItem?

Returns the media item at the given index.

getMediaItemCount

abstract fun getMediaItemCount(): Int

Returns the number of media items in the playlist.

getSeekBackIncrement

abstract fun getSeekBackIncrement(): Duration

Returns the seekBack increment.

getSeekForwardIncrement

abstract fun getSeekForwardIncrement(): Duration

Returns the seekForward increment.

hasNextMediaItem

abstract fun hasNextMediaItem(): Boolean

Returns whether a next media item exists.

hasPreviousMediaItem

abstract fun hasPreviousMediaItem(): Boolean

Returns whether a previous media item exists.

pause

abstract fun pause()

Pauses playback.

play

abstract fun play()

Resumes playback as soon as player is ready.

abstract fun play(mediaItemIndex: Int)

Play media item at given index as soon as player is ready.

prepare

abstract fun prepare()

Prepares the player.

release

abstract fun release()

Releases the player.

removeMediaItem

abstract fun removeMediaItem(index: Int)

Removes the media item at the given index of the playlist.

seekBack

abstract fun seekBack()

Seeks back in the current media item by seek back increment.

seekForward

abstract fun seekForward()

Seek forward in the current media item by seek forward increment.

setMediaItem

abstract fun setMediaItem(mediaItem: MediaItem)

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

setMediaItems

abstract fun setMediaItems(mediaItems: List<MediaItem>)

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

setShuffleModeEnabled

abstract fun setShuffleModeEnabled(shuffleModeEnabled: Boolean)

Sets whether shuffling of media items is enabled.

skipToNextMediaItem

abstract fun skipToNextMediaItem()

Skips to the default position of next media item.

skipToPreviousMediaItem

abstract fun skipToPreviousMediaItem()

Skips to the default position of previous media item.

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.

currentMediaItem

abstract val currentMediaItem: StateFlow<MediaItem?>

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

currentState

abstract val currentState: StateFlow<PlayerState>

Returns the player's current state.

mediaItemPosition

abstract val mediaItemPosition: StateFlow<MediaItemPosition?>

Returns the current media item position of the player.

shuffleModeEnabled

abstract val shuffleModeEnabled: StateFlow<Boolean>

Returns the current value for shuffling of media items mode.