player-playback-engine/com.tidal.sdk.player.playbackengine/PlaybackEngine

PlaybackEngine

interface PlaybackEngine : Action, Query, Configuration

This should be implemented in order to play media.

Properties

abstract val assetPosition: Float

Gets the current asset position, in seconds, from the active MediaProduct, as Float.

abstract val events: Flow<Event>

Gets the stream of events describing happenings that consumers may want to react to. Backpressure not handled.

loudnessNormalizationMode

abstract var loudnessNormalizationMode: LoudnessNormalizationMode

Get or set LoudnessNormalizationMode to use when playing.

loudnessNormalizationPreAmp

abstract var loudnessNormalizationPreAmp: Int

Get or set loudnessNormalizationPreAmp as Int to use when playing.

abstract val mediaProduct: MediaProduct?

Gets the currently active MediaProduct. May be null, most likely if current state is PlaybackState.IDLE.

abstract val outputDevice: OutputDevice

Gets the current output device, as OutputDevice.

playbackContext

abstract val playbackContext: PlaybackContext?

Gets the currently active PlaybackContext. May be null, most likely if current state is PlaybackState.IDLE.

abstract val playbackState: PlaybackState

Gets the currently active PlaybackState.

streamingCellularAudioQuality

abstract var streamingCellularAudioQuality: AudioQuality

Get or set AudioQuality to use when streaming over cellular.

streamingWifiAudioQuality

abstract var streamingWifiAudioQuality: AudioQuality

Get or set AudioQuality to use when streaming over WiFi.

videoSurfaceView

abstract var videoSurfaceView: AspectRatioAdjustingSurfaceView?

Sets or clears an AspectRatioAdjustingSurfaceView for the player to use for video playback.

Functions

abstract fun load(mediaProduct: MediaProduct)

Resets playback and immediately transition to set selected MediaProduct. Playback state will immediately change to PlaybackState.NOT_PLAYING. When this call returns, the requested media product is considered the active one.

abstract fun pause()

Pauses playback of active MediaProduct.

abstract fun play()

Starts playback of active MediaProduct.

abstract fun release()

Releases all resources required by this instance exclusively.

abstract fun reset()

Resets the playback engine to its initial state, effectively a stop action.

abstract fun seek(time: Float)

Changes asset position in the active media product.

abstract fun setNext(mediaProduct: MediaProduct?)

Playback makes an implicit transition to the selected MediaProduct once the currently active finishes playing.

abstract fun setRepeatOne(enable: Boolean)

Sets repeat one mode on or off. Repeat all is handled by the host.

abstract fun skipToNext()

Changes the currently loaded media product to the one set previously via setNext, implicitly continuing playback if it was ongoing.