Package-level declarations
Types
Used when ReaderView's active gesture type has changed.
This view serves as an entry point for the Colibrio reading system. It encapsulates a WebView component responsible for rendering publication content and provides access to a ReadingSystemEngine instance.
A TtsSynthesizer implementation based on the Android Text to speech API android.speech.tts.TextToSpeech.
Used to customize utterances to be spoken by the ColibrioTtsSynthesizer
The default implementation of a WebChromeClient.
Represents a location within a ReaderPublication and methods to extract information related to that location.
Used for fetching publication text content related to a ContentLocation.
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.
Describes the different units of measure that can be used with ContentPositionTimelines.
Used for decrypting publication resources, encrypted with a specific encryption method.
Used to identify the subtype of EngineEvent
Possible values for EngineEventData.type
Contains information about a media resource related with certain an EngineEvent.
Contains information about the publication content targeted by an EngineEvent.
Describes the framework component that was the target of an EngineEvent.
Describes a node in the publication content that was a target for an event such as "pointerdown" or "click".
Describes the node types of EngineEventTargetNodeData instances.
Used to identify subtypes of EngineEventTarget
Describes an XML element in the publication content that was a target for an event such as "pointerdown" or "click".
Contains all metadata items extracted from an EPUB publication.
Used with ReadingSystemEngine.loadEpub to load EPUB publications using a RandomAccessDataSource.
Format specific API for an EPUB ReaderPublication.
Used with ReadingSystemEngine.loadEpub to load EPUB publications using a ResourceProvider.
Options for fetching navigation item references from a ContentLocation.
The result object for ContentLocation.fetchNavigationItemReferences
Options related to ReaderView.focusOnReadingPosition() deciding which elements should receive focus.
The serializable version of IKeyboardEngineEvent, used for "keydown" and "keyup" events.
Used for events related to Colibrio License Server validation.
Configuration object used when creating SyncMediaTimeline objects for EPUB Media Overlays.
The EngineEvent type used for "click" and "contextmenu" events.
Describes the navigation actions that can be performed on a ReaderView.
Describes the different type of navigation collections.
Describes the contents in the ReaderView as a one-dimensional timeline of all pages.
Represents the data in a PageProgressionTimeline.
Options set using IReaderViewOptions.pageProgressionTimelineOptions
Describes a position within a PageProgressionTimeline
Describes a range in the PageProgressionTimeline.
Describes how a PageProgressionTimeline was calculated.
Contains all metadata items extracted from a PDF publication.
Used with ReadingSystemEngine.loadPdf to load PDF publications using a RandomAccessDataSource.
Format specific API for an PDF ReaderPublication.
The EngineEvent type used for pointer events.
Option to set which pointer types are allowed for PointerEvents in the ReaderView.
Describes the source publication that was loaded into a ReadingSystemEngine.
Used for various publication media element related events.
Contains all metadata extracted from a publication.
NOTE: This interface is being simplified to be easier to use and will be released in an upcoming release.
NOTE: This interface is being simplified to be easier to use and will be released in an upcoming release.
Allows you to set styling options of the rendered publication.
Possible values for PublicationStyleOptions.defaultFontFamily
Options for overriding the text alignment in a publication.
A content document that has been processed for use by the Reading System.
How an event was acted upon by the content document before it was parsed into an EngineEvent.
A publication that has been processed for use by the Reading System.
Options controlling how Clipboard actions behave in ReaderPublications
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.
Represents a collection of ReaderPublicationNavigationItemData in a tree structure. Note that some NavigationCollectionTypes such as PAGE_LIST are flat lists of ReaderPublicationNavigationItemData.
Represents an item within a ReaderPublicationNavigationCollection.
Describes a reference to an item in the publication navigation.
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.
ReaderViewAnnotationLayers are used for creating and rendering ReaderViewAnnotations. Annotation layers are created using ReaderView.createAnnotationLayer and are rendered on top of publication content.
Options related with the presentation of ReaderViewAnnotations.
The data class representing an EngineEvent related to a ReaderView.
Options for gestures performed on the ReaderView.
The gesture types for user interactions with a ReaderView.
Options object used with ReaderView.goTo()
Options for changing the behavior and appearance of a ReaderView.
Possible values for ReaderViewOptions.defaultStartPageSpreadSlot
The global direction in which the Publication content flows.
Options used for configuring the panZoom gesture on a ReaderView. Part of IReaderViewOptions.gestureOptions
Information about a renderer's current scroll position.
Options for swipe navigation gestures, set by IReaderViewOptions.gestureOptions
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.
Options for the ReaderViewTransformManager.
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 is the entry point to the Colibrio Reading System API. It is used for loading publications, accessing the ReaderView, creating SyncMediaPlayers and more.
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.
Event data object used when a scroll action has ended in a scrolling renderer such as the SingleDocumentScrollRenderer.
Represents a search result item containing a search match.
EngineEvent type used for "selectionChanged" events.
Engine event type used for "swipeNavigationGestureProgress" events.
Describes a reference to a range within an audio SyncMediaObject.
Contains information related to an ISyncMediaEngineEventTarget.
Event used when a SyncMediaPlayer encounters an error.
The SyncMedia formats supported by the framework.
Options specifying the behavior for managed synchronization between a SyncMediaPlayer and a ReaderView.
Represents a media resource in a SyncMediaTimeline.
Base type used for referencing media objects within a SyncMediaSegment.
Types used for determining the correct subtype of ISyncMediaObjectRef.
Options object used with SyncMediaPlayer.setPlaybackRange.
Used for playing synchronized media such as EPUB Media Overlays or TTS (Text-To-Speech).
Used when creating a new SyncMediaPlayer using ReadingSystemEngine.createSyncMediaPlayer(). These options cannot be changed after the SyncMediaPlayer has been created.
Describes the position of the SyncMediaPlayer relative to the visible content in a ReaderView.
Used for events related to range playback in the SyncMediaPlayer.
Describes why a playback range was removed from a ISyncMediaPlayer.
Used with SyncMediaPlayer.attemptReaderViewSynchronization()
Describes the synchronization state between a SyncMediaPlayer and a ReaderView.
The synchronization behavior for the SyncMediaPlayer when it is attached to a ReaderView.
Contains a locator and its corresponding SyncMediaTimelinePosition.
Represents a segment within a SyncMediaTimeline, containing information about all SyncMediaObjectRefs that will be played in parallel.
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.
A target related with a SyncMediaSegment, such as the DOM node being spoken by TTS, or active element when playing media overlays.
The type of action that triggered the syncMediaReaderViewSynchronizationStateChanged event.
A SyncMediaTimeline describes arbitrary media (such as audio or video) and how to synchronize them with the publication content.
Describes a position within a SyncMediaTimeline instance.
Describes a range within a SyncMediaTimeline.
Type used for TTS that is based from text extracted from ContentBlocks.
Describes all supported text alignments in publication content.
Options object used with ReaderDocumentSearch.createTextQuery.
Describes how to treat whitespace in the source content when using IReaderDocumentSearch.createTextQuery.
Used with ITextSearchResultOptions, describing how the text in SearchResultItem.textBefore and the SearchResultItem.textAfter is computed.
Options object controlling the data available in search result items
Options controlling how to animate the ReaderView when applying a new active transform using the IReaderViewTransformManager.
A collection of common easing functions when performing animations. Can be used with the various transform methods in IReaderViewTransformManager.
Options related to IReaderViewTransformManager.zoomToClientRect().
Configuration object used when creating TTS SyncMediaTimeline.
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.
Used by ITtsSynthesizer implementations to report its playback state.
Contains the position, dimensions, and locator of a line or replaced element.
Options used with ReaderView.fetchRectsForVisibleContent().
A serializable result object returned from IReaderView.fetchRectsForVisibleContent().
Describes what type of content a IVisibleContentRect represents.
A page fully visible or partially visible in the ReaderView.
Indicates the severity of a WebView console message.
Functions
Creates a PublicationStyleFontFace using an asset font file.