media/com.splendo.kaluga.media/MediaPlayer/Controls

Controls

data class Controls(val play: MediaPlayer.Controls.Play? = null, val pause: MediaPlayer.Controls.Pause? = null, val unpause: MediaPlayer.Controls.Unpause? = null, val stop: MediaPlayer.Controls.Stop? = null, val seek: MediaPlayer.Controls.Seek? = null, val setRate: MediaPlayer.Controls.SetRate? = null, val setLoopMode: MediaPlayer.Controls.SetLoopMode? = null, val awaitPreparation: MediaPlayer.Controls.AwaitPreparation? = null, val displayError: MediaPlayer.Controls.DisplayError? = null)

The controls available to manage playback on a MediaPlayer

Constructors

Controls

constructor(play: MediaPlayer.Controls.Play? = null, pause: MediaPlayer.Controls.Pause? = null, unpause: MediaPlayer.Controls.Unpause? = null, stop: MediaPlayer.Controls.Stop? = null, seek: MediaPlayer.Controls.Seek? = null, setRate: MediaPlayer.Controls.SetRate? = null, setLoopMode: MediaPlayer.Controls.SetLoopMode? = null, awaitPreparation: MediaPlayer.Controls.AwaitPreparation? = null, displayError: MediaPlayer.Controls.DisplayError? = null)

Types

AwaitPreparation

data object AwaitPreparation : MediaPlayer.Controls.ControlType

A ControlType that indicates a MediaPlayer is preparing its PlayableMedia

ControlType

sealed class ControlType

A type of control to manage playback on a MediaPlayer

DisplayError

class DisplayError(val error: PlaybackError) : MediaPlayer.Controls.ControlType

A ControlType that indicates a MediaPlayer is in an error state

Pause

class Pause(val perform: suspend () -> Unit) : MediaPlayer.Controls.ControlType

A ControlType that allows a MediaPlayer to be paused

Play

class Play(val perform: suspend (PlaybackState.PlaybackParameters) -> Unit) : MediaPlayer.Controls.ControlType

A ControlType that allows a MediaPlayer to be started

Seek

class Seek(val perform: suspend (Duration) -> Boolean) : MediaPlayer.Controls.ControlType

A ControlType that allows a MediaPlayer to seek its current playback to a given Duration

SetLoopMode

class SetLoopMode(val currentLoopMode: PlaybackState.LoopMode, val perform: suspend (PlaybackState.LoopMode) -> Unit) : MediaPlayer.Controls.ControlType

A ControlType that provides and adjusts the PlaybackState.LoopMode of the current playback of a MediaPlayer

SetRate

class SetRate(val currentRate: Float, val perform: suspend (Float) -> Unit) : MediaPlayer.Controls.ControlType

A ControlType that provides and adjusts the rate of the current playback of a MediaPlayer

Stop

class Stop(val perform: suspend () -> Unit) : MediaPlayer.Controls.ControlType

A ControlType that allows a MediaPlayer to be stopped

Unpause

class Unpause(val perform: suspend () -> Unit) : MediaPlayer.Controls.ControlType

A ControlType that allows a MediaPlayer to be resumed after being paused

Properties

awaitPreparation

val awaitPreparation: MediaPlayer.Controls.AwaitPreparation? = null

the AwaitPreparation control available

controlTypes

val controlTypes: Set<MediaPlayer.Controls.ControlType>

A set of all ControlType currently available

displayError

val displayError: MediaPlayer.Controls.DisplayError? = null

the DisplayError control available

pause

val pause: MediaPlayer.Controls.Pause? = null

the Pause control available

play

val play: MediaPlayer.Controls.Play? = null

the Play control available

seek

val seek: MediaPlayer.Controls.Seek? = null

the Seek control available

setLoopMode

val setLoopMode: MediaPlayer.Controls.SetLoopMode? = null

the SetLoopMode control available

setRate

val setRate: MediaPlayer.Controls.SetRate? = null

the SetRate control available

stop

val stop: MediaPlayer.Controls.Stop? = null

the Stop control available

unpause

val unpause: MediaPlayer.Controls.Unpause? = null

the Unpause control available

Functions

getControlType

inline fun <Type : MediaPlayer.Controls.ControlType> getControlType(): Type?

Gets a given ControlType if available

tryPause

suspend fun tryPause(): Boolean

Attempts to do Pause.perform on pause if it exists

tryPlay

suspend fun tryPlay(playbackParameters: PlaybackState.PlaybackParameters = PlaybackState.PlaybackParameters()): Boolean

Attempts to do Play.perform on play if it exists

trySeek

suspend fun trySeek(duration: Duration): Boolean

Attempts to do Seek.perform on seek if it exists

trySetLoopMode

suspend fun trySetLoopMode(loopMode: PlaybackState.LoopMode): Boolean

Attempts to do SetLoopMode.perform on setLoopMode if it exists

trySetRate

suspend fun trySetRate(rate: Float): Boolean

Attempts to do SetRate.perform on setRate if it exists

tryStop

suspend fun tryStop(): Boolean

Attempts to do Stop.perform on stop if it exists

tryUnpause

suspend fun tryUnpause(): Boolean

Attempts to do Unpause.perform on unpause if it exists