colibrio-reader-framework/com.colibrio.readingsystem.audio/ColibrioAudioPlayer

ColibrioAudioPlayer

Used for controlling and configuring native audio playback.

Players are created and managed by the ColibrioMediaService.

Note that there can only be one ColibrioAudioPlayer at a time. If another one is created either by using ReadingSystemEngine.createSyncMediaPlayer with a SyncMediaAudioRenderer.NativeAudioRenderer or by using ColibrioMediaService.createAudioPlayer, the existing one will be destroyed.

Functions

addOnSyncMediaPlayerEventListener

abstract fun addOnSyncMediaPlayerEventListener(listener: OnMediaPlayerEventListener)

Adds an instance of OnMediaPlayerEventListener to the player.

destroy

abstract fun destroy()

Destroys this ColibrioAudioPlayer instance, which results in ignoring all subsequent calls to its methods. This method does nothing if already destroyed.

pause

abstract fun pause()

Pauses media playback.

play

abstract fun play()

Attempts to resume playback from the current timeline position as soon as the player is ready. The player will pause if it fails to resume playback.

removeOnSyncMediaPlayerEventListener

abstract fun removeOnSyncMediaPlayerEventListener(listener: OnMediaPlayerEventListener)

Removes an instance of OnMediaPlayerEventListener from the player.

seekToApproximateTimeMs

abstract fun seekToApproximateTimeMs(timeInMs: Int)

Seeks to the approximate time from timeline start in milliseconds.

seekToNextSegment

abstract fun seekToNextSegment()

Seeks to the next segment in the timeline, if such segment exists.

seekToPreviousSegment

abstract fun seekToPreviousSegment()

Seeks to the previous segment in the timeline, if such segment exists.

seekToTimelinePosition

abstract fun seekToTimelinePosition(position: SyncMediaTimelinePositionData)

Seeks to the given position in the timeline.

setMediaCommands

abstract fun setMediaCommands(mediaCommands: ColibrioMediaCommands)

Updates the media commands.

setMediaSessionMetadata

abstract fun setMediaSessionMetadata(mediaSessionMetadata: ColibrioMediaSessionMetadata)

Updates the media session metadata.

Properties

approximateElapsedTimeMs

abstract val approximateElapsedTimeMs: Int

Gets the approximate elapsed time from timeline start to current position in milliseconds.

atEnd

abstract val atEnd: Boolean

If the player has reached the end of the timeline.

atStart

abstract val atStart: Boolean

If the player is at the start of the timeline.

destroyed

abstract val destroyed: Boolean

True if this player has been destroyed. In that case, any calls to its methods will be ignored.

muted

abstract var muted: Boolean

Gets/sets if audio should be muted.

paused

abstract val paused: Boolean

If the player is currently in paused state

playbackRate

abstract var playbackRate: Double

Gets/sets the playback rate. This must be a value between 0.25 and 5.0, where 1.0 is "normal speed". Values lower than 1.0 make the media play slower than normal, higher values make it play faster.

ready

abstract val ready: Boolean

Returns true if the player is ready to play. Returns false if the player is currently seeking or waiting for data to be loaded.

seeking

abstract val seeking: Boolean

Returns true if the player is currently seeking to a new timeline position

timelinePosition

abstract val timelinePosition: SyncMediaTimelinePositionData

The current timeline position of the player

totalDurationMs

abstract val totalDurationMs: Int

The total duration of the timeline in milliseconds

volume

abstract var volume: Double

Gets/sets the volume as a value between 0.0 and 1.0.