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

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.

Constructors

Link copied to clipboard
fun Words(fetchWithLowPriority: Boolean = false, serializedData: String? = null, mappingOptions: EpubWordsContentPositionTimelineMappingOptions = EpubWordsContentPositionTimelineMappingOptions())

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
open override fun serialize(generator: JsonGenerator)

Properties

Link copied to clipboard
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.

Link copied to clipboard
val mappingOptions: EpubWordsContentPositionTimelineMappingOptions

Options specifying how words and media elements should be mapped to timeline positions.

Link copied to clipboard
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.

Link copied to clipboard
val unit: ContentPositionTimelineUnit

The unit of measurement used by the ContentPositionTimeline.