colibrio-reader-framework/com.colibrio.readingsystem.base/ReadingSystemEngine

ReadingSystemEngine

ReadingSystemEngine is the entry point to the Colibrio Reading System API. It is used for loading publications, accessing the ReaderView, creating SyncMediaPlayers and more.

You get an engine instance from ColibrioReadingSystemView.readingSystemEngine.

Loading publications

Call loadEpub or loadPdf to load a publication into the ReadingSystemEngine. The returned ReaderPublication can be used with the readerView to render content.

Engine Events

The reading system lets you listen and react to events. This can for example be, the user clicking a link or an image, or a ReaderView navigating to the next page.

You can use the various add event listener methods on the framework classes such as the ReaderView.

Properties

readerDocumentSearch

abstract val readerDocumentSearch: ReaderDocumentSearch

Gets the API that can be used for searching in ReaderDocuments.

readerPublications

abstract val readerPublications: List<ReaderPublication>

Currently loaded ReaderPublications.

readerView

abstract val readerView: ReaderView

The ReaderView is responsible for everything related to presentation and navigation of publication contents.

syncMediaPlayers

abstract val syncMediaPlayers: List<SyncMediaPlayer>

All SyncMediaPlayer instances created using this ReadingSystemEngine.

Functions

addOnLicenseEventListener

abstract fun ~~addOnLicenseEventListener~~(listener: OnLicenseEventListener)

Adds an instance of OnLicenseEventListener to receive events related to Colibrio License Server validation.

createSyncMediaPlayer

abstract suspend fun createSyncMediaPlayer(colibrioAudioPlayer: ColibrioAudioPlayer): ColibrioResult<SyncMediaPlayer>

Creates a new SyncMediaPlayer from an existing ColibrioAudioPlayer.

abstract suspend fun createSyncMediaPlayer(timeline: SyncMediaTimeline, options: SyncMediaPlayerInitOptions = SyncMediaPlayerInitOptions()): ColibrioResult<SyncMediaPlayer>

Creates a new SyncMediaPlayer. Use for playing synchronized media such as EPUB Media Overlays or TTS (Text-To-Speech). You can create SyncMediaTimeline instances from publications using the format specific ReaderPublication instances. For example EpubReaderPublication.createMediaOverlaySyncMediaTimeline() or PdfReaderPublication.createTtsSyncMediaTimeline()`.

createZipResourceProvider

abstract suspend fun createZipResourceProvider(dataSource: RandomAccessDataSource, zipResourceProviderOptions: ZipResourceProviderOptions = ZipResourceProviderOptions()): ColibrioResult<ZipResourceProvider>

abstract fun createZipResourceProvider(dataSource: RandomAccessDataSource, zipResourceProviderOptions: ZipResourceProviderOptions = ZipResourceProviderOptions(), onSuccess: (ZipResourceProvider) -> Unit, onError: (ColibrioException) -> Unit)

Creates a new ZipResourceProvider using byte data provided by dataSource. The dataSource must return data from a valid ZIP file, such as an EPUB file for example.

destroySyncMediaPlayer

abstract fun destroySyncMediaPlayer(player: SyncMediaPlayer)

Destroys a SyncMediaPlayer created using this ReadingSystemEngine. Throws an error if the SyncMediaPlayer was not created using this ReadingSystemEngine.

loadEpub

abstract suspend fun loadEpub(config: EpubRandomAccessDataSourceLoadConfig): ColibrioResult<EpubReaderPublication>

abstract suspend fun loadEpub(config: EpubResourceProviderLoadConfig): ColibrioResult<EpubReaderPublication>

abstract fun loadEpub(config: EpubRandomAccessDataSourceLoadConfig, onSuccess: (EpubReaderPublication) -> Unit, onError: (ColibrioException) -> Unit)

abstract fun loadEpub(config: EpubResourceProviderLoadConfig, onSuccess: (EpubReaderPublication) -> Unit, onError: (ColibrioException) -> Unit)

Loads an EPUB file into the ReadingSystemEngine.

loadPdf

abstract suspend fun loadPdf(config: PdfRandomAccessDataSourceLoadConfig): ColibrioResult<PdfReaderPublication>

abstract fun loadPdf(config: PdfRandomAccessDataSourceLoadConfig, onSuccess: (PdfReaderPublication) -> Unit, onError: (ColibrioException) -> Unit)

Loads a PDF file into the ReadingSystemEngine.

removeOnLicenseEventListener

abstract fun ~~removeOnLicenseEventListener~~(listener: OnLicenseEventListener)

Removes a previously added instance of OnLicenseEventListener.

unloadPublication

abstract fun unloadPublication(readerPublication: ReaderPublication)

Unloads readerPublication from the reading system. readerPublication must have been loaded using this ReadingSystemEngine instance, and its readerDocuments must not currently be in use by readerView.