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

ReaderPublication

interface ReaderPublication

A publication that has been processed for use by the Reading System.

Inheritors

EpubReaderPublication

PdfReaderPublication

Properties

availableContentPositionTimelineUnits

abstract val availableContentPositionTimelineUnits: List<ContentPositionTimelineUnit>

The units of measure that can be used when creating ContentPositionTimeline objects using this publication.

availableSyncMediaFormats

abstract val availableSyncMediaFormats: List<SyncMediaFormat>

The sync media formats available in this publication.

defaultLocatorUrl

abstract val defaultLocatorUrl: String

The base URL used when creating Locators pointing to content in this publication.

sourcePublication

abstract val sourcePublication: Publication

Additional information about the source publication such as preferred way to render its content, its metadata, etc.

spine

abstract val spine: List<ReaderDocument>

The ordered list of ReaderDocument instances in this publication.

Functions

createTtsSyncMediaTimeline

abstract suspend fun createTtsSyncMediaTimeline(readerDocuments: List<ReaderDocument>, config: TtsSyncMediaTimelineConfiguration, progressCallback: (Double) -> Unit = {}): ColibrioResult<SyncMediaTimeline>

abstract fun createTtsSyncMediaTimeline(readerDocuments: List<ReaderDocument>, config: TtsSyncMediaTimelineConfiguration, onSuccess: (SyncMediaTimeline) -> Unit, onError: (ColibrioException) -> Unit, progressCallback: (Double) -> Unit = {})

Creates a new TTS SyncMediaTimeline from the specified list of ReaderDocuments. The resulting SyncMediaTimeline can be played using a SyncMediaPlayer.

fetchContentLocation

abstract suspend fun fetchContentLocation(navigationItem: ReaderPublicationNavigationItem): ColibrioResult<ContentLocation>

abstract fun fetchContentLocation(navigationItem: ReaderPublicationNavigationItem, onSuccess: (ContentLocation) -> Unit, onError: (ColibrioException) -> Unit)

Get a ContentLocation from a navigationItem. Used for extracting location specific information from the publication.

fetchPublicationNavigation

abstract suspend fun fetchPublicationNavigation(): ColibrioResult<ReaderPublicationNavigation>

abstract fun fetchPublicationNavigation(onSuccess: (ReaderPublicationNavigation) -> Unit, onError: (ColibrioException) -> Unit)

Fetches the ReaderPublicationNavigation of this publication.

fetchResourceData

abstract suspend fun fetchResourceData(resourceUrl: String): ColibrioResult<ByteArray>

abstract fun fetchResourceData(resourceUrl: String, onSuccess: (ByteArray) -> Unit, onError: (ColibrioException) -> Unit)

Fetches a resource from the source publication by URL.

getContentLocation

abstract fun getContentLocation(locator: SimpleLocatorData): ContentLocation

Get a ContentLocation from a locator. Used for extracting location specific information from the publication.