colibrio-reader-framework/com.colibrio.readingsystem.formatadapter.epub/EpubContentPositionTimelineOptions

EpubContentPositionTimelineOptions

sealed class EpubContentPositionTimelineOptions

Base interface for all options types that can be used when creating ContentPositionTimeline for EPUB Publications.

Types

class Characters(val fetchWithLowPriority: Boolean = false, val serializedData: String? = null, val mappingOptions: EpubCharactersContentPositionTimelineMappingOptions = EpubCharactersContentPositionTimelineMappingOptions()) : EpubContentPositionTimelineOptions

Options object used when creating ContentPositionTimeline for EPUB Publications, using CHARACTERS as unit of measurement.

Documents

class Documents(val fetchWithLowPriority: Boolean = false, val serializedData: String? = null) : EpubContentPositionTimelineOptions

Options object used when creating ContentPositionTimeline for EPUB Publications, using DOCUMENTS as unit of measurement.

Pages

class Pages(val fetchWithLowPriority: Boolean = false, val serializedData: String? = null) : EpubContentPositionTimelineOptions

Options object used when creating ContentPositionTimeline for EPUB Publications, using PAGES as unit of measurement.

Words

class Words(val fetchWithLowPriority: Boolean = false, val serializedData: String? = null, val mappingOptions: EpubWordsContentPositionTimelineMappingOptions = EpubWordsContentPositionTimelineMappingOptions()) : EpubContentPositionTimelineOptions

Options object used when creating ContentPositionTimeline for EPUB Publications, using WORDS as unit of measurement.

Functions

serialize

open fun serialize(generator: JsonGenerator)

Properties

fetchWithLowPriority

val fetchWithLowPriority: Boolean = false

Fetch operations might impact rendering and animation performance. If this is set to true, the timeline will wait for higher priority tasks to finish instead of executing the fetch operations immediately.

serializedData

val serializedData: String? = null

Pass the data from ContentPositionTimeline.toSerializedData() that you saved from a previous instance. Settings this option allows the timeline to be built more quickly.

unit

val unit: ContentPositionTimelineUnit

The unit of measurement used by the ContentPositionTimeline.

Inheritors