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

Package-level declarations

Types

class ActiveGestureTypeChangedEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.ACTIVE_GESTURE_TYPE_CHANGED_ENGINE_EVENT, val type: EngineEventDataType, val newGestureType: ReaderViewGestureType?, val oldGestureType: ReaderViewGestureType?) : ReaderViewEngineEventData

Used when ReaderView's active gesture type has changed.

ColibrioReaderFramework

object ColibrioReaderFramework

ColibrioReadingSystemView

class ColibrioReadingSystemView @JvmOverloads constructor(context: Context, attributeSet: AttributeSet? = null, defStyleArg: Int = 0) : FrameLayout, CoroutineScope

ColibrioTtsSynthesizer

class ColibrioTtsSynthesizer(textToSpeech: TextToSpeech) : UtteranceProgressListener, TtsSynthesizer, CoroutineScope

A TtsSynthesizer implementation based on the Android Text to speech API android.speech.tts.TextToSpeech.

ContentLocation

interface ContentLocation

Represents a location within a ReaderPublication and methods to extract information related to that location.

ContentLocationContentResolver

interface ContentLocationContentResolver

Used for fetching publication text content related to a ContentLocation.

ContentPositionTimeline

interface ContentPositionTimeline

A ContentPositionTimeline is used for describing positions within ReaderPublication content as integers. The timeline starts at position 0 and its length can be retrieved using the length property.

ContentPositionTimelineUnit

enum ContentPositionTimelineUnit : Enum<ContentPositionTimelineUnit>

Describes the different units of measure that can be used with ContentPositionTimelines.

EncryptionMethod

interface EncryptionMethod

Used for decrypting publication resources, encrypted with a specific encryption method.

EngineEventData

open class EngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.ENGINE_EVENT, val type: EngineEventDataType)

EngineEventDataObjectType

enum EngineEventDataObjectType : Enum<EngineEventDataObjectType>

Used to identify the subtype of EngineEvent

EngineEventDataType

enum EngineEventDataType : Enum<EngineEventDataType>

Possible values for EngineEventData.type

EngineEventMediaResourceData

data class EngineEventMediaResourceData(val isDataUrl: Boolean, val isRemoteUrl: Boolean, val mediaTypeCategory: MediaTypeCategory, val resourceUrl: String?)

Contains information about a media resource related with certain an EngineEvent.

EngineEventTargetData

open class EngineEventTargetData(val frameworkComponent: EngineEventTargetFrameworkComponent, val locator: SimpleLocatorData?, val mediaType: String, val nodeData: EngineEventTargetXmlElementNodeData?, val objectType: EngineEventTargetObjectType = EngineEventTargetObjectType.ENGINE_EVENT_TARGET, val readerDocumentIndexInSpine: Int?)

Contains information about the publication content targeted by an EngineEvent.

EngineEventTargetFrameworkComponent

enum EngineEventTargetFrameworkComponent : Enum<EngineEventTargetFrameworkComponent>

Describes the framework component that was the target of an EngineEvent.

EngineEventTargetNodeData

open class EngineEventTargetNodeData(val nodeType: EngineEventTargetNodeType = EngineEventTargetNodeType.UNKNOWN, val parent: EngineEventTargetNodeData?)

Describes a node in the publication content that was a target for an event such as "pointerdown" or "click".

EngineEventTargetNodeType

enum EngineEventTargetNodeType : Enum<EngineEventTargetNodeType>

Describes the node types of EngineEventTargetNodeData instances.

EngineEventTargetObjectType

enum EngineEventTargetObjectType : Enum<EngineEventTargetObjectType>

Used to identify subtypes of EngineEventTarget

EngineEventTargetXmlElementNodeData

open class EngineEventTargetXmlElementNodeData(val nodeType: EngineEventTargetNodeType = EngineEventTargetNodeType.XML_ELEMENT, val parent: EngineEventTargetXmlElementNodeData?, val attributes: List<AttributeData>, val namespaceURI: String?, val nodeName: String, val prefix: String?) : EngineEventTargetNodeData

Describes an XML element in the publication content that was a target for an event such as "pointerdown" or "click".

EpubPublicationMetadata

class EpubPublicationMetadata(epubPublicationMetadataData: EpubPublicationMetadataData) : PublicationMetadata

Contains all metadata items extracted from an EPUB publication.

EpubRandomAccessDataSourceLoadConfig

class EpubRandomAccessDataSourceLoadConfig(val publicationDataSource: RandomAccessDataSource, val readingSessionOptions: ReadingSessionOptions, val readerPublicationOptions: EpubReaderPublicationOptions = EpubReaderPublicationOptions(), val encryptionMethods: List<EncryptionMethod> = emptyList(), val zipResourceProviderOptions: ZipResourceProviderOptions = ZipResourceProviderOptions())

Used with ReadingSystemEngine.loadEpub to load EPUB publications using a RandomAccessDataSource.

EpubReaderPublication

interface EpubReaderPublication : ReaderPublication

Format specific API for an EPUB ReaderPublication.

EpubResourceProviderLoadConfig

class EpubResourceProviderLoadConfig(val resourceProvider: ResourceProvider, val readingSessionOptions: ReadingSessionOptions, val readerPublicationOptions: EpubReaderPublicationOptions = EpubReaderPublicationOptions(), val hashSignature: String, val encryptionMethods: List<EncryptionMethod> = emptyList())

Used with ReadingSystemEngine.loadEpub to load EPUB publications using a ResourceProvider.

FetchNavigationItemReferencesOptions

data class FetchNavigationItemReferencesOptions(val collectionTypes: List<NavigationCollectionType>? = null, val greedy: Boolean = false)

Options for fetching navigation item references from a ContentLocation.

FetchNavigationItemReferencesResultData

data class FetchNavigationItemReferencesResultData(val itemsAfter: List<ReaderPublicationNavigationItemReferenceData>, val itemsBefore: List<ReaderPublicationNavigationItemReferenceData>, val itemsInRange: List<ReaderPublicationNavigationItemReferenceData>)

The result object for ContentLocation.fetchNavigationItemReferences()

FocusOnReadingPositionOptions

data class FocusOnReadingPositionOptions(val focusOnPageContainer: Boolean, val focusOnPageBodyElement: Boolean, val focusNearContentLocation: Boolean)

Options related to ReaderView.focusOnReadingPosition() deciding which elements should receive focus.

KeyboardEngineEventData

class KeyboardEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.KEYBOARD_ENGINE_EVENT, val type: EngineEventDataType, val code: String, val isComposing: Boolean, val key: String, val keyCode: Int, val location: Int, val modifiers: KeyboardModifierStates, val readerDocumentEventState: ReaderDocumentEventState, val repeated: Boolean, val target: EngineEventTargetData?, val userGenerated: Boolean) : ReaderViewEngineEventData

The serializable version of IKeyboardEngineEvent, used for "keydown" and "keyup" events.

KeyboardModifierStates

data class KeyboardModifierStates(val alt: Boolean, val altGraph: Boolean, val capsLock: Boolean, val control: Boolean, val meta: Boolean, val numLock: Boolean, val os: Boolean, val scrollLock: Boolean, val shift: Boolean)

Contains the state of modifier keys for a IKeyboardEngineEvent.

LicenseEngineEventData

class LicenseEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.LICENSE_ENGINE_EVENT, val type: EngineEventDataType, val publicationToken: String, val reason: String?, val userToken: String) : EngineEventData

Used for events related to Colibrio License Server validation.

MediaOverlaySyncMediaTimelineConfiguration

class MediaOverlaySyncMediaTimelineConfiguration(val audioRendererOptions: SyncMediaAudioRendererOptions = SyncMediaAudioRendererOptions())

Configuration object used when creating SyncMediaTimeline objects for EPUB Media Overlays.

MouseEngineEventData

open class MouseEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.MOUSE_ENGINE_EVENT, val type: EngineEventDataType, val buttons: Int, val clientX: Double, val clientY: Double, val ctrlKey: Boolean, val mediaResource: EngineEventMediaResourceData?, val metaKey: Boolean, val pageX: Double, val pageY: Double, val readerDocumentEventState: ReaderDocumentEventState, val relativeClientX: Double, val relativeClientY: Double, val relativeScreenX: Double, val relativeScreenY: Double, val screenX: Double, val screenY: Double, val target: EngineEventTargetData?, val userGenerated: Boolean) : ReaderViewEngineEventData

The EngineEvent type used for "click" and "contextmenu" events.

NavigationAction

enum NavigationAction : Enum<NavigationAction>

Describes the navigation actions that can be performed on a ReaderView.

NavigationCollectionType

enum NavigationCollectionType : Enum<NavigationCollectionType>

Describes the different type of navigation collections.

NavigationEndedEngineEventData

class NavigationEndedEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.NAVIGATION_ENDED_ENGINE_EVENT, val type: EngineEventDataType, val navigationAction: NavigationAction) : ReaderViewEngineEventData

NavigationIntentEngineEventData

class NavigationIntentEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.NAVIGATION_INTENT_ENGINE_EVENT, val type: EngineEventDataType, val internalNavigation: Boolean, val locator: SimpleLocatorData, val readerDocumentIndexInSpine: Int?, val relatedEvent: MouseEngineEventData?, val sourceReaderDocumentIndexInSpine: Int?) : ReaderViewEngineEventData

NavigationStartedEngineEventData

class NavigationStartedEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.NAVIGATION_STARTED_ENGINE_EVENT, val type: EngineEventDataType, val dueToRenderingConfigChanged: Boolean, val navigationAction: NavigationAction, val replacedOngoingNavigation: Boolean) : ReaderViewEngineEventData

PageProgressionTimeline

interface PageProgressionTimeline

Describes the contents in the ReaderView as a one-dimensional timeline of all pages.

PageProgressionTimelineData

data class PageProgressionTimelineData(val timelineType: PageProgressionTimelineType, val totalNumberOfPages: Int, val visibleTimelineRange: PageProgressionTimelineRangeData)

Represents the data in a PageProgressionTimeline.

PageProgressionTimelineOptions

data class PageProgressionTimelineOptions(val delayRecalculationUntilPagesVisible: Boolean = true, val enabled: Boolean = true, val forceCompleteRendition: Boolean = false)

Options set using IReaderViewOptions.pageProgressionTimelineOptions

PageProgressionTimelinePositionData

data class PageProgressionTimelinePositionData(val offset: Double, val pageIndex: Int)

Describes a position within a PageProgressionTimeline

PageProgressionTimelineRangeData

data class PageProgressionTimelineRangeData(val end: PageProgressionTimelinePositionData, val start: PageProgressionTimelinePositionData)

Describes a range in the PageProgressionTimeline.

PageProgressionTimelineType

enum PageProgressionTimelineType : Enum<PageProgressionTimelineType>

Describes how a PageProgressionTimeline was calculated.

PdfPublicationMetadata

class PdfPublicationMetadata(pdfPublicationMetadataData: PdfPublicationMetadataData) : PublicationMetadata

Contains all metadata items extracted from a PDF publication.

PdfRandomAccessDataSourceLoadConfig

class PdfRandomAccessDataSourceLoadConfig(val publicationDataSource: RandomAccessDataSource, val readingSessionOptions: ReadingSessionOptions, val readerPublicationOptions: PdfReaderPublicationOptions = PdfReaderPublicationOptions(), val publicationOptions: PdfPublicationOptions = PdfPublicationOptions())

Used with ReadingSystemEngine.loadPdf to load PDF publications using a RandomAccessDataSource.

PdfReaderPublication

interface PdfReaderPublication : ReaderPublication

Format specific API for an PDF ReaderPublication.

PointerEngineEventData

class PointerEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.POINTER_ENGINE_EVENT, val type: EngineEventDataType, val buttons: Int, val clientX: Double, val clientY: Double, val ctrlKey: Boolean, val mediaResource: EngineEventMediaResourceData?, val metaKey: Boolean, val pageX: Double, val pageY: Double, val readerDocumentEventState: ReaderDocumentEventState, val relativeClientX: Double, val relativeClientY: Double, val relativeScreenX: Double, val relativeScreenY: Double, val screenX: Double, val screenY: Double, val target: EngineEventTargetData?, val userGenerated: Boolean, val isPrimary: Boolean, val pointerId: Int, val pointerType: String) : MouseEngineEventData

The EngineEvent type used for pointer events.

PointerTypeOptions

data class PointerTypeOptions(val mouse: Boolean = false, val pen: Boolean = false, val touch: Boolean = true)

Option to set which pointer types are allowed for PointerEvents in the ReaderView.

Publication

interface Publication

Describes the source publication that was loaded into a ReadingSystemEngine.

PublicationLoadConfiguration

sealed class ~~PublicationLoadConfiguration~~

Used with ReadingSystemEngine.loadPublication().

PublicationMediaElementEngineEventData

class PublicationMediaElementEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.PUBLICATION_MEDIA_ELEMENT_ENGINE_EVENT, val type: EngineEventDataType, val currentTimeMs: Int, val durationMs: Int, val mediaResource: EngineEventMediaResourceData, val target: EngineEventTargetData) : ReaderViewEngineEventData

Used for various publication media element related events.

PublicationMetadata

open class PublicationMetadata

Contains all metadata extracted from a publication.

PublicationStyleFontDefaults

data class PublicationStyleFontDefaults(val cursive: String? = null, val fallback: String, val fantasy: String? = null, val monospace: String? = null, val sansSerif: String? = null, val serif: String? = null)

NOTE: This interface is being simplified to be easier to use and will be released in an upcoming release.

PublicationStyleFontFace

data class PublicationStyleFontFace(val family: String, val mediaType: MediaType, val src: String)

PublicationStyleFontSelector

data class PublicationStyleFontSelector(val family: String, val selector: String)

PublicationStyleFontSet

data class PublicationStyleFontSet(val defaults: PublicationStyleFontDefaults, val fontFaces: List<PublicationStyleFontFace>, val selectors: List<PublicationStyleFontSelector> = emptyList())

NOTE: This interface is being simplified to be easier to use and will be released in an upcoming release.

PublicationStyleOptions

data class PublicationStyleOptions(val defaultFontFamily: PublicationStyleOptionsDefaultFontFamily = PublicationStyleOptionsDefaultFontFamily.SERIF, val fontSet: PublicationStyleFontSet? = null, val fontSizeScaleFactor: Double = 1.0, val lineHeightScaleFactor: Double = 1.0, val pageMargins: RectMargins? = null, val palette: PublicationStylePalette? = null, val textAlignment: PublicationStyleTextAlignmentOptions? = null)

Allows you to set styling options of the rendered publication.

PublicationStyleOptionsDefaultFontFamily

enum PublicationStyleOptionsDefaultFontFamily : Enum<PublicationStyleOptionsDefaultFontFamily>

Possible values for PublicationStyleOptions.defaultFontFamily

PublicationStylePalette

data class PublicationStylePalette(val accent: String, val backgroundDark: String, val backgroundLight: String, val foregroundDark: String, val foregroundLight: String)

Allows you to override the palette used for rendering the publication.

PublicationStyleTextAlignmentOptions

data class PublicationStyleTextAlignmentOptions(val preserved: List<TextAlignment>, val defaultAlignment: TextAlignment)

Options for overriding the text alignment in a publication.

ReaderDocument

interface ReaderDocument

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

ReaderDocumentData

data class ReaderDocumentData(val availableSyncMediaFormats: List<SyncMediaFormat>, val indexInSpine: Int, val locator: SimpleLocatorData, val reflowable: Boolean, val renderable: Boolean, val sourceContentDocumentIndexInSpine: Int)

Describes a serializable version of IReaderDocument

ReaderDocumentEventState

enum ReaderDocumentEventState : Enum<ReaderDocumentEventState>

How an event was acted upon by the content document before it was parsed into an EngineEvent.

ReaderPublication

interface ReaderPublication

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

ReaderPublicationClipboardOptions

data class ReaderPublicationClipboardOptions(val allowCopy: Boolean = true, val textToPrependOnCopy: String? = null, val textToAppendOnCopy: String? = null)

Options controlling how Clipboard actions behave in ReaderPublications

ReaderPublicationData

data class ReaderPublicationData(val availableContentPositionTimelineUnits: List<ContentPositionTimelineUnit>, val availableSyncMediaFormats: List<SyncMediaFormat>, val defaultLocatorUrl: String, val sourcePublicationHashSignature: String, val spine: List<ReaderDocumentData>)

Represents a serializable version of ReaderPublication, returned when calling ReaderPublication.toJSON();

ReaderPublicationNavigationCollectionData

data class ReaderPublicationNavigationCollectionData(val children: List<ReaderPublicationNavigationItemData>, val index: Int, val title: String?, val type: NavigationCollectionType)

Represents a collection of ReaderPublicationNavigationItemData in a tree structure. Note that some NavigationCollectionTypes such as PAGE_LIST are flat lists of ReaderPublicationNavigationItemData.

ReaderPublicationNavigationData

data class ReaderPublicationNavigationData(val navigationCollections: List<ReaderPublicationNavigationCollectionData>)

Contains the complete publication navigation as defined in the source publication. For example, in EPUB this equates to the NAV document or the NCX document.

ReaderPublicationNavigationItemData

data class ReaderPublicationNavigationItemData(val children: List<ReaderPublicationNavigationItemData>, val id: Int, val isTargetingReaderDocumentInSpine: Boolean, val locator: SimpleLocatorData?, val parentId: Int?, val textContent: String)

ReaderPublicationNavigationItemReferenceData

data class ReaderPublicationNavigationItemReferenceData(val collectionIndex: Int, val collectionType: NavigationCollectionType, val navigationItemId: Int, val readerDocumentIndexInSpine: Int, val readerPublicationDefaultLocatorUrl: String)

Describes a reference to an item in the publication navigation.

ReaderView

interface ReaderView

ReaderViewAnnotation

interface ReaderViewAnnotation

A ReaderViewAnnotation can either reference a range of publication content or a position (point) within publication content. ReaderViewAnnotations are rendered inside a ReaderViewAnnotationLayer, which in turn is rendered on top of publication content.

ReaderViewAnnotationLayer

interface ReaderViewAnnotationLayer

ReaderViewAnnotationLayers are used for creating and rendering ReaderViewAnnotations. Annotation layers are created using ReaderView.createAnnotationLayer and are rendered on top of publication content.

ReaderViewAnnotationLayerOptions

data class ReaderViewAnnotationLayerOptions(val layerClassName: String? = null, val layerStyle: Map<String, String>? = null, val annotationInputEngineEventsEnabled: Boolean = false, val zIndex: Int = 0)

Options related with the ReaderViewAnnotationLayer.

ReaderViewAnnotationOptions

data class ReaderViewAnnotationOptions(val containerClassName: String? = null, val containerStyle: Map<String, String>? = null, val positionClassName: String? = null, val positionStyle: Map<String, String>? = null, val rangeClassName: String? = null, val rangeStyle: Map<String, String>? = null)

Options related with the presentation of ReaderViewAnnotations.

ReaderViewEngineEventData

open class ReaderViewEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.READER_VIEW_ENGINE_EVENT, val type: EngineEventDataType) : EngineEventData

The data class representing an EngineEvent related to a ReaderView.

ReaderViewGestureOptions

data class ReaderViewGestureOptions(val panZoom: ReaderViewPanZoomGestureOptions = ReaderViewPanZoomGestureOptions(), val swipeNavigation: ReaderViewSwipeNavigationGestureOptions = ReaderViewSwipeNavigationGestureOptions())

Options for gestures performed on the ReaderView.

ReaderViewGestureType

enum ReaderViewGestureType : Enum<ReaderViewGestureType>

The gesture types for user interactions with a ReaderView.

ReaderViewGotoOptions

data class ReaderViewGotoOptions(val setReadingPositionToVisibleRangeStart: Boolean = false)

Options object used with ReaderView.goTo()

ReaderViewOptions

data class ReaderViewOptions(val defaultPageAspectRatio: Double = 0.66666666666, val defaultPageProgressionDirection: ReaderViewPageProgressionDirection = ReaderViewPageProgressionDirection.LTR, val defaultStartPageSpreadSlot: ReaderViewOptionsDefaultStartPageSpreadSlot = ReaderViewOptionsDefaultStartPageSpreadSlot.AUTO, val emitPointerMoveEventsOnHover: Boolean = false, val forcePageAspectRatio: Double? = null, val forcePageProgressionDirection: ReaderViewPageProgressionDirection? = null, val gestureOptions: ReaderViewGestureOptions = ReaderViewGestureOptions(), val pageProgressionTimelineOptions: PageProgressionTimelineOptions = PageProgressionTimelineOptions(), val publicationStyleOptions: PublicationStyleOptions = PublicationStyleOptions(), val refreshDelayMs: Int = 200, val rendererTransitionAnimationDurationMs: Int? = null, val rendererTransitionTimeoutMs: Int = 500, val transformManagerOptions: ReaderViewTransformManagerOptions = ReaderViewTransformManagerOptions())

Options for changing the behavior and appearance of a ReaderView.

ReaderViewOptionsDefaultStartPageSpreadSlot

enum ReaderViewOptionsDefaultStartPageSpreadSlot : Enum<ReaderViewOptionsDefaultStartPageSpreadSlot>

Possible values for ReaderViewOptions.defaultStartPageSpreadSlot

ReaderViewPageProgressionDirection

enum ReaderViewPageProgressionDirection : Enum<ReaderViewPageProgressionDirection>

The global direction in which the Publication content flows.

ReaderViewPanZoomGestureOptions

data class ReaderViewPanZoomGestureOptions(val allowSinglePointerPan: Boolean = true, val maxPanOffsetHorizontal: String = "50%", val maxPanOffsetVertical: String = "50%", val maxScaleFactor: Double = 5.0, val pinchZoomThresholdPx: Int = 32, val pointerTypes: PointerTypeOptions = PointerTypeOptions(), val removeTransformOnZoomOutGesture: Boolean = true)

Options used for configuring the panZoom gesture on a ReaderView. Part of IReaderViewOptions.gestureOptions

ReaderViewScrollStateData

data class ReaderViewScrollStateData(val rendererClientHeight: Double, val scrollTop: Double, val scrollHeight: Double, val scrolling: Boolean)

Information about a renderer's current scroll position.

ReaderViewStateData

data class ReaderViewStateData(val activeGestureType: ReaderViewGestureType?, val activeNavigationAction: NavigationAction?, val activeTransform: TransformData?, val allowedGestureTypes: List<ReaderViewGestureType>, val atEnd: Boolean, val atStart: Boolean, val canPerformGoTo: Boolean, val canPerformNext: Boolean, val canPerformPrevious: Boolean, val canTransform: Boolean, val contentSelectionEnabled: Boolean, val destroyed: Boolean, val offscreenContentRendering: Boolean, val pageProgressionDirection: ReaderViewPageProgressionDirection?, val readingPosition: SimpleLocatorData?, val responsiveRendererSelectionEnabled: Boolean, val scriptedContentDocumentEventHandlersEnabled: Boolean, val scrollState: ReaderViewScrollStateData?, val visibleContentRendering: Boolean, val visiblePages: List<VisiblePageData>, val visibleRange: SimpleLocatorData?)

The ReaderView state as a JSON serializable object.

ReaderViewSwipeNavigationGestureOptions

data class ReaderViewSwipeNavigationGestureOptions(val pointerDragThresholdPx: Int = 32, val pointerTypes: PointerTypeOptions = PointerTypeOptions())

Options for swipe navigation gestures, set by IReaderViewOptions.gestureOptions

ReaderViewTransformManager

interface ReaderViewTransformManager

Used for programmatically managing transformations of the ReaderView, such as scaling and translating. You can for example use this to zoom to a position when a user clicks on the ReaderView.

ReaderViewTransformManagerOptions

data class ReaderViewTransformManagerOptions(val maxPanOffsetHorizontal: Length? = null, val maxPanOffsetVertical: Length? = null, val maxScaleFactor: Double? = null, val removeTransformAnimationDurationMs: Int = 300, val removeTransformOnNavigation: Boolean = true)

Options for the ReaderViewTransformManager.

ReadingSessionOptions

data class ReadingSessionOptions(val publicationToken: String? = null, val userToken: String)

This data is used to identify reading session using a combination of a user token and publication token. The values that should be used are dependent on your Product Commercial Agreement. This data should be anonymized in order to protect the user's privacy. This information will be sent to Colibrio License Server.

ReadingSystemEngine

interface ReadingSystemEngine

Renderer

sealed class Renderer

A Renderer is responsible for the presentation of the ReaderPublication. For example, the Renderer.Stack presents the publication as a series of pages stacked on top of each other like a deck of cards.

RendererScrollEngineEventData

class RendererScrollEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.RENDERER_SCROLL_ENGINE_EVENT, val type: EngineEventDataType, val scrollDistance: Double, val scrollTop: Double, val userGenerated: Boolean) : ReaderViewEngineEventData

Event data object used when a scroll action has ended in a scrolling renderer such as the SingleDocumentScrollRenderer.

SearchResultItem

data class SearchResultItem(val locator: SimpleLocatorData, val matchingText: String, val readerDocumentIndexInSpine: Int, val textAfter: String, val textBefore: String)

Represents a search result item containing a search match.

SelectionChangedEngineEventData

class SelectionChangedEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.SELECTION_CHANGED_ENGINE_EVENT, val type: EngineEventDataType, val isRange: Boolean, val locator: SimpleLocatorData?, val readerDocumentIndexInSpine: Int?, val selectionText: String?) : ReaderViewEngineEventData

EngineEvent type used for "selectionChanged" events.

SyncMediaAudioRef

class SyncMediaAudioRef(val endMs: Int?, val objectIndex: Int, val startMs: Int) : SyncMediaObjectRef

Describes a reference to a range within an audio SyncMediaObject.

SyncMediaEngineEventData

open class SyncMediaEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.SYNC_MEDIA_ENGINE_EVENT, val type: EngineEventDataType, val approximateElapsedTimeMs: Int, val syncMediaTimelinePosition: SyncMediaTimelinePositionData) : EngineEventData

SyncMediaEngineEventTargetXmlElementNodeData

class SyncMediaEngineEventTargetXmlElementNodeData(val nodeType: EngineEventTargetNodeType = EngineEventTargetNodeType.SYNC_MEDIA_XML_ELEMENT, val parent: SyncMediaEngineEventTargetXmlElementNodeData?, val attributes: List<AttributeData>, val namespaceURI: String?, val nodeName: String, val prefix: String?, val endPosition: SyncMediaTimelinePositionData, val startPosition: SyncMediaTimelinePositionData) : EngineEventTargetXmlElementNodeData

Contains information related to an ISyncMediaEngineEventTarget.

SyncMediaErrorEngineEventData

class SyncMediaErrorEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.SYNC_MEDIA_ERROR_ENGINE_EVENT, val type: EngineEventDataType, val approximateElapsedTimeMs: Int, val syncMediaTimelinePosition: SyncMediaTimelinePositionData, val error: String, val errorMessage: String?, val errorType: SyncMediaPlayerErrorType, val paused: Boolean, val segmentIndex: Int) : SyncMediaEngineEventData

Event used when a SyncMediaPlayer encounters an error.

SyncMediaFormat

enum SyncMediaFormat : Enum<SyncMediaFormat>

The SyncMedia formats supported by the framework.

SyncMediaManagedReaderViewSynchronizationOptions

data class SyncMediaManagedReaderViewSynchronizationOptions(val alwaysSeekToSegmentStart: Boolean = false, val enabled: Boolean = true, val minimumTimeToDisplayPagesWithSyncMedia: Int = 0, val navigateOnVisibleRangeEndReached: Boolean = true, val skipPagesWithoutSyncMedia: Boolean = false, val timeToDisplayPagesWithoutSyncMedia: Int = 2000)

Options specifying the behavior for managed synchronization between a SyncMediaPlayer and a ReaderView.

SyncMediaObjectData

data class SyncMediaObjectData(val durationMs: Int?, val resourceMetadata: WebResourceMetadata)

Represents a media resource in a SyncMediaTimeline.

SyncMediaObjectRef

open class SyncMediaObjectRef(val type: SyncMediaObjectRefType)

Base type used for referencing media objects within a SyncMediaSegment.

SyncMediaObjectRefType

enum SyncMediaObjectRefType : Enum<SyncMediaObjectRefType>

Types used for determining the correct subtype of ISyncMediaObjectRef.

SyncMediaPlayer

interface SyncMediaPlayer

Used for playing synchronized media such as EPUB Media Overlays or TTS (Text-To-Speech).

SyncMediaPlayerCreateOptions

data class SyncMediaPlayerCreateOptions(val audioRenderer: SyncMediaAudioRenderer = SyncMediaAudioRenderer.WebAudioRenderer)

Used with ReadingSystemEngine.createSyncMediaPlayer to configure the SyncMediaPlayer

SyncMediaPlayerErrorType

enum SyncMediaPlayerErrorType : Enum<SyncMediaPlayerErrorType>

SyncMediaPlayerInitOptions

data class SyncMediaPlayerInitOptions(val addDefaultMediaObjectRenderers: Boolean = true, val preloadAheadMs: Int = 20000, val preloadBehindMs: Int = 5000)

Used when creating a new SyncMediaPlayer using ReadingSystemEngine.createSyncMediaPlayer(). These options cannot be changed after the SyncMediaPlayer has been created.

SyncMediaPositionRelativeToVisibleRange

enum SyncMediaPositionRelativeToVisibleRange : Enum<SyncMediaPositionRelativeToVisibleRange>

Describes the position of the SyncMediaPlayer relative to the visible content in a ReaderView.

SyncMediaReaderViewSynchronizationMethod

enum SyncMediaReaderViewSynchronizationMethod : Enum<SyncMediaReaderViewSynchronizationMethod>

Used with SyncMediaPlayer.attemptReaderViewSynchronization()

SyncMediaReaderViewSynchronizationStateData

data class SyncMediaReaderViewSynchronizationStateData(val mediaPlayerPositionRelativeToVisibleRange: SyncMediaPositionRelativeToVisibleRange, val nextTimelineRange: SyncMediaTimelineRangeData?, val previousTimelineRange: SyncMediaTimelineRangeData?, val resolvedMediaPlayerPosition: SyncMediaResolvedLocatorData, val resolvedReaderViewReadingPosition: SyncMediaResolvedLocatorData, val triggeredBy: SyncMediaSyncEventTrigger, val visibleTimelineRange: SyncMediaTimelineRangeData)

Describes the synchronization state between a SyncMediaPlayer and a ReaderView.

SyncMediaReaderViewSynchronizationWaitBehavior

enum SyncMediaReaderViewSynchronizationWaitBehavior : Enum<SyncMediaReaderViewSynchronizationWaitBehavior>

The synchronization behavior for the SyncMediaPlayer when it is attached to a ReaderView.

SyncMediaResolvedLocatorData

data class SyncMediaResolvedLocatorData(val locator: SimpleLocatorData, val readerDocumentIndexInSpine: Int, val syncMediaTimelinePosition: SyncMediaTimelinePositionData)

Contains a locator and its corresponding SyncMediaTimelinePosition.

SyncMediaSegmentActiveEngineEventData

class SyncMediaSegmentActiveEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.SYNC_MEDIA_SEGMENT_ACTIVE_ENGINE_EVENT, val type: EngineEventDataType, val approximateElapsedTimeMs: Int, val syncMediaTimelinePosition: SyncMediaTimelinePositionData, val segmentIndex: Int, val targets: List<SyncMediaSegmentTargetData>) : SyncMediaEngineEventData

SyncMediaSegmentData

data class SyncMediaSegmentData(val approximateDurationMs: Int, val durationType: SyncMediaSegmentDurationType, val readerDocumentIndexInSpine: Int, val refs: List<SyncMediaObjectRef>)

Represents a segment within a SyncMediaTimeline, containing information about all SyncMediaObjectRefs that will be played in parallel.

SyncMediaSegmentDurationChangedEngineEventData

class SyncMediaSegmentDurationChangedEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.SYNC_MEDIA_SEGMENT_DURATION_CHANGED_EVENT, val type: EngineEventDataType, val approximateElapsedTimeMs: Int, val syncMediaTimelinePosition: SyncMediaTimelinePositionData, val newDurationMs: Int, val oldDurationMs: Int, val segmentIndex: Int) : SyncMediaEngineEventData

This event fires after the duration of a SyncMediaTimelineSegment has been updated. This can happen when the SyncMediaPlayer has received additional information about a segment's duration (such as after loading the media) and it did not match with the approximated value. The segment has been updated with the new duration value and the total duration of the timeline has also been updated.

SyncMediaSegmentDurationType

enum SyncMediaSegmentDurationType : Enum<SyncMediaSegmentDurationType>

SyncMediaSegmentTargetData

class SyncMediaSegmentTargetData(val frameworkComponent: EngineEventTargetFrameworkComponent, val locator: SimpleLocatorData?, val mediaType: String, val nodeData: SyncMediaEngineEventTargetXmlElementNodeData?, val objectType: EngineEventTargetObjectType = EngineEventTargetObjectType.SYNC_MEDIA_SEGMENT_TARGET, val readerDocumentIndexInSpine: Int?) : EngineEventTargetData

A target related with a SyncMediaSegment, such as the DOM node being spoken by TTS, or active element when playing media overlays.

SyncMediaSyncEventTrigger

enum SyncMediaSyncEventTrigger : Enum<SyncMediaSyncEventTrigger>

The type of action that triggered the syncMediaReaderViewSynchronizationStateChanged event.

SyncMediaTimeline

interface SyncMediaTimeline

A SyncMediaTimeline describes arbitrary media (such as audio or video) and how to synchronize them with the publication content.

SyncMediaTimelineData

data class SyncMediaTimelineData(val approximateDurationMs: Int, val mediaObjectRefTypes: List<SyncMediaObjectRefType>, val mediaObjects: List<SyncMediaObjectData>, val publicationHashSignature: String, val readerDocumentIndexes: List<Int>, val readerPublicationDefaultLocatorUrl: String, val segments: List<SyncMediaSegmentData>, val syncMediaFormat: SyncMediaFormat)

A SyncMediaTimeline is created by calling any of the createSyncMediaTimeline() methods on a ReaderPublication. Each publication format supports different sync media formats. EPUB supports Media Overlays as well as content block based TTS, whereas PDF only supports content block based TTS. For example: EpubReaderPublication.createMediaOverlaySyncMediaTimeline() or EpubReaderPublication.createTtsSyncMediaTimeline()

SyncMediaTimelinePositionData

data class SyncMediaTimelinePositionData(val segmentIndex: Int, val offsetWithinSegmentMs: Int)

Describes a position within a SyncMediaTimeline instance.

SyncMediaTimelineRangeData

data class SyncMediaTimelineRangeData(val end: SyncMediaTimelinePositionData, val start: SyncMediaTimelinePositionData)

Describes a range within a SyncMediaTimeline from a start position up to, but not including the end position.

SyncMediaTtsContentBlockRef

class SyncMediaTtsContentBlockRef(val sources: List<SyncMediaTtsContentBlockRefSource>, val text: LocalizableString) : SyncMediaObjectRef

Type used for TTS that is based from text extracted from ContentBlocks.

SyncMediaTtsContentBlockRefSource

data class SyncMediaTtsContentBlockRefSource(val contentBlockId: Int, val endOffset: Int, val srcMap: String, val startOffset: Int, val ttsOffset: Int)

Describes how the TTS text was generated from a ContentBlock.

SyncMediaWaitingEngineEventData

class SyncMediaWaitingEngineEventData(val objectType: EngineEventDataObjectType = EngineEventDataObjectType.SYNC_MEDIA_WAITING_ENGINE_EVENT, val type: EngineEventDataType, val approximateElapsedTimeMs: Int, val syncMediaTimelinePosition: SyncMediaTimelinePositionData, val waitingForMediaObjectRenderers: Boolean, val waitingForReaderViewSynchronization: Boolean) : SyncMediaEngineEventData

TextAlignment

enum TextAlignment : Enum<TextAlignment>

Describes all supported text alignments in publication content.

TextSearchQueryOptions

data class TextSearchQueryOptions(val ignoreCase: Boolean = true, val searchResultOptions: TextSearchResultOptions = TextSearchResultOptions(), val whitespaceMode: TextSearchQueryWhitespaceMode = TextSearchQueryWhitespaceMode.COLLAPSE)

Options object used with ReaderDocumentSearch.createTextQuery.

TextSearchQueryWhitespaceMode

enum TextSearchQueryWhitespaceMode : Enum<TextSearchQueryWhitespaceMode>

Describes how to treat whitespace in the source content when using IReaderDocumentSearch.createTextQuery.

TextSearchResultExpandMode

enum TextSearchResultExpandMode : Enum<TextSearchResultExpandMode>

Used with ITextSearchResultOptions, describing how the text in SearchResultItem.textBefore and the SearchResultItem.textAfter is computed.

TextSearchResultOptions

data class TextSearchResultOptions(val expandMode: TextSearchResultExpandMode = TextSearchResultExpandMode.EXPAND_TO_WORD_BOUNDARY, val numberOfCharactersAfter: Int = 40, val numberOfCharactersBefore: Int = 40)

Options object controlling the data available in search result items

TransformAnimationOptions

data class TransformAnimationOptions(val durationMs: Int? = null, val easing: String = "cubic-bezier(0.4, 0.0, 0.2, 1)")

Options controlling how to animate the ReaderView when applying a new active transform using the IReaderViewTransformManager.

TransformData

data class TransformData(val scale: Double, val x: Double, val y: Double, val animating: Boolean = false, val userGestureActive: Boolean = false)

Describes a 2D transform.

TransformEasing

object TransformEasing

A collection of common easing functions when performing animations. Can be used with the various transform methods in IReaderViewTransformManager.

TransformRectZoomOptions

data class TransformRectZoomOptions(val animationOptions: TransformAnimationOptions? = null, val maxScaleFactor: Double? = null)

Options related to IReaderViewTransformManager.zoomToClientRect().

TtsSyncMediaTimelineConfiguration

class TtsSyncMediaTimelineConfiguration(val ttsSynthesizer: TtsSynthesizer, val highlightLayer: ReaderViewAnnotationLayer? = null, val rendererOptions: SyncMediaTtsContentBlockRendererOptions = SyncMediaTtsContentBlockRendererOptions(), val contentTransformOptions: SyncMediaTtsTimelineContentTransformationOptions = SyncMediaTtsTimelineContentTransformationOptions())

Configuration object used when creating TTS SyncMediaTimeline.

TtsSynthesizer

interface TtsSynthesizer

Base interface used for implementing TTS speech synthesizers. A ITtsSynthesizer maintains a queue of ITtsUtteranceData and manages its playback. A newly created TtsSynthesizer is in paused state, has its volume set to 1.0 and playback rate set to 1.0.

TtsSynthesizerCallbacks

interface TtsSynthesizerCallbacks

Used by ITtsSynthesizer implementations to report its playback state.

TtsUtteranceData

data class TtsUtteranceData(val charOffset: Int, val id: Int, val text: LocalizableString)

VisibleContentRectData

data class VisibleContentRectData(val clientRect: Rect, val locator: SimpleLocatorData, val nodeData: EngineEventTargetNodeData? = null, val type: VisibleContentRectType)

Contains the position, dimensions, and locator of a line or replaced element.

VisibleContentRectsOptions

data class VisibleContentRectsOptions(val includeNodeData: Boolean = false)

Options used with ReaderView.fetchRectsForVisibleContent().

VisibleContentRectsResultData

data class VisibleContentRectsResultData(val boundingClientRect: Rect?, val locator: SimpleLocatorData, val rects: List<VisibleContentRectData>)

A serializable result object returned from IReaderView.fetchRectsForVisibleContent().

VisibleContentRectType

enum VisibleContentRectType : Enum<VisibleContentRectType>

Describes what type of content a IVisibleContentRect represents.

VisiblePageData

data class VisiblePageData(val boundingClientRect: Rect?, val pageIndexInReflowedDocument: Int, val pageSpreadSlot: PageSpreadSlot, val rangeLocator: SimpleLocatorData, val readerDocumentIndexInSpine: Int, val startLocator: SimpleLocatorData)

A page fully visible or partially visible in the ReaderView.

WebViewLogLevel

enum WebViewLogLevel : Enum<WebViewLogLevel>

Indicates the severity of a WebView console message.

WpAudiobookRandomAccessDataSourceLoadConfig

class WpAudiobookRandomAccessDataSourceLoadConfig(val publicationDataSource: RandomAccessDataSource, val readingSessionOptions: ReadingSessionOptions, val readerPublicationOptions: WpAudiobookReaderPublicationOptions = WpAudiobookReaderPublicationOptions(), val zipResourceProviderOptions: ZipResourceProviderOptions = ZipResourceProviderOptions())

Used with ReadingSystemEngine.loadWpAudiobook to load a W3C Audiobook Web Publication packaged as an LPF file, using a RandomAccessDataSource.

WpAudiobookReaderPublication

interface WpAudiobookReaderPublication : ReaderPublication

Format specific API for W3C Audiobook Web Publications.

WpAudiobookResourceProviderLoadConfig

class WpAudiobookResourceProviderLoadConfig(val resourceProvider: ResourceProvider, val readingSessionOptions: ReadingSessionOptions, val readerPublicationOptions: WpAudiobookReaderPublicationOptions = WpAudiobookReaderPublicationOptions(), val hashSignature: String)

Used with ReadingSystemEngine.loadWpAudiobook to load a W3C Audiobook Web Publication using a ResourceProvider.

WpAudiobookSyncMediaTimelineConfiguration

class WpAudiobookSyncMediaTimelineConfiguration(val audioRendererOptions: SyncMediaAudioRendererOptions = SyncMediaAudioRendererOptions())

Configuration object used when creating SyncMediaTimeline objects from WpAudiobookReaderPublications.

WpPublicationMetadata

class WpPublicationMetadata(wpPublicationMetadataData: WpPublicationMetadataData) : PublicationMetadata

Contains all metadata items extracted from a WP publication.