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

Package-level declarations

Types

interface AudioDocument

Represents an audio resource within an audio publication.

AudioPublication

interface AudioPublication

The base interface for all audio publications loaded into the AudioReadingSystemEngine.

AudioReadingSystemEngine

object AudioReadingSystemEngine

This is the entry point for the Colibrio background audio playback services.

interface AudioTimeline

An AudioTimeline represents the playback order of the audio publication content.

ColibrioAudioPlayer

interface ColibrioAudioPlayer

Used for controlling and configuring native audio playback.

ColibrioAudioPlayerConfig

data class ColibrioAudioPlayerConfig(val audioTimeline: AudioTimeline, val mediaSessionMetadata: ColibrioMediaSessionMetadata, val mediaCommands: ColibrioMediaCommands, val mediaSessionTimelineMode: MediaSessionTimelineMode = MediaSessionTimelineMode.FullTimeline)

Used with AudioReadingSystemEngine.createAudioPlayer to create an audio player.

ColibrioAudioPlayerException

sealed class ColibrioAudioPlayerException : ColibrioException

ColibrioMediaCommands

data class ColibrioMediaCommands(val playCommandProperties: AudioCommandProperties, val pauseCommandProperties: AudioCommandProperties, val rewindCommand: SeekCommand, val fastForwardCommand: SeekCommand, val skipBackwardCommand: SkipCommand, val skipForwardCommand: SkipCommand, val seekBarEnabled: Boolean) : Parcelable

Holds the properties used for configuring media commands.

ColibrioMediaSession

interface ColibrioMediaSession

Used for controlling the media session, such as:

ColibrioMediaSessionMetadata

data class ColibrioMediaSessionMetadata(val title: String, val artist: String, val artwork: Bitmap?, val smallIconResId: Int, val mediaSessionPendingIntent: PendingIntent) : Parcelable

Holds the properties used for configuring the metadata of the media session.

MediaSessionTimelineMode

sealed class MediaSessionTimelineMode

Controls how the media session seekbar is presented to the user.

MediaSessionTimelineSectionChangedEventData

data class MediaSessionTimelineSectionChangedEventData(val oldSectionRange: SyncMediaTimelineRangeData?, val newSectionRange: SyncMediaTimelineRangeData?)

Event data representing the change of media session timeline section.

MediaSessionTimelineSectionChangedListener

interface MediaSessionTimelineSectionChangedListener

Used for reporting when the active media session timeline section changes.

OnMediaPlayerEventListener

interface OnMediaPlayerEventListener

Used for events related to ColibrioAudioPlayer state changes.

SyncMediaAudioRenderer

sealed class SyncMediaAudioRenderer

The audio renderer used for audio playback