Event fired when the value returned by ReaderView.getActiveGestureType() has changed.
Event fired after the active renderer has changed and the new renderer has been attached to the ReaderView.
Event fired when the ReaderView's active transform has changed. This happens when performing a pan-zoom gesture, or when calling transform methods on the ReaderViewTransformManager, such as zoomToEventPosition().
Fired when a mouse click event occurred on a ReaderViewAnnotation.
Fired when contextmenu event occurred on a ReaderViewAnnotation.
Fired when a ReaderViewAnnotation references content that is intersecting with the current visible range.
Fired when a ReaderViewAnnotation references content that is no longer intersecting the current visible range.
Fired when a pointerenter event occurred on a ReaderViewAnnotation.
Fired when a pointerleave event occurred on a ReaderViewAnnotation.
Fired when the boolean value returned by ReaderView.canPerformGoto() has changed.
Fired when the boolean value returned by ReaderView.canPerformNext() has changed.
Fired when the boolean value returned by ReaderView.canPerformPrevious() has changed.
Event fired when a click occurs in a page.
Event used for reporting progress when a ContentPositionTimeline is created for a ReaderPublication.
This event is fired at the ReadingSystemEngine instance where the ReaderPublication was loaded, thus you
need to call addEngineEventListener on that ReadingSystemEngine instance to listen on this event.
Event fired when a double click occurs in a page.
Event fired when a key is pressed.
Event fired when a key is released.
Event fired when Colibrio License server decided to block the Reading Session. This can happen:
If the Reading Session is blocked continuously for a grace period exceeding 30 days, the Reading system functionality may be limited. Please refer to your Product Commercial Agreement for details.
This event is only applicable when using Colibrio Reader Cloud License SDK.
Event fired when Colibrio License server continued an existing Reading Session instead of registering a new one. The Offline Reading Session stored on the device is also updated.
This event is only applicable when using Colibrio Reader Cloud License SDK.
Event fired when device is offline, but an Offline Reading Session is available.
This event is only applicable when using Colibrio Reader Cloud License SDK.
Event fired when there is a problem connecting to the license server. The client will try again after a short delay.
Reasons why this might happen:
Event fired when a new Reading Session has been registered with the Colibrio License server. The Reading Session is also stored on the device (Offline Reading Session) and will be valid for the duration defined in your Product Commercial Agreement.
This event is only applicable when using Colibrio Reader Cloud License SDK.
The current time position in a media element changed.
This event fires several times every second while the media is playing.
A media element in the publication loaded in a visible page. This is always the first event fired for a specific media element.
Initially the media element is in paused state and not ready.
A media element in the publication was unloaded from a visible page. This means that the media element is paused and cannot be interacted with anymore. No more events will be seen for that specific media element.
A media element in the publication was paused.
A media element in the publication started playing.
A media element have buffered enough data to start playback
A media element in the publication has finished seeking to a new position.
A media element in the publication don't have enough data to continue playback.
Fires when a navigation action has completed or has been canceled.
Fired when a "navigation intent" occurs that was NOT initiated by a call to ReaderView.next(), ReaderView.previous(), ReaderView.goToStart() or ReaderView.goTo().
Some examples are:
Default action: Navigate to the intended locator, only if the locator points to a readerDocument assigned to the ReaderView. Otherwise, do nothing.
Fired when a new navigation action has started, or replaces an existing ongoing navigation.
Event fired when all offscreen content currently loaded by the active renderer have rendered.
Event fired when offscreen content starts rendering.
This event is fired when a PageProgressionTimeline has been recalculated and can be retrieved from the ReaderView.
This event is fired when a PageProgressionTimeline is being recalculated due to a ReaderView configuration change such as a window resize or if ReaderViewOptions changes.
This event is fired multiple times while the timeline is being recalculated with the progress of the operation. The timeline is not available during this process.
The timeline recalculation operation is finished when a "pageProgressionTimelineRecalculated" event is fired.
This event is fired when the visible range of a PageProgressionTimeline has changed.
Fired when a 'pointercancel' or 'touchcancel' event occurs in a page.
Fired when a 'pointerdown','touchstart' or 'mousedown' event occurs in a page.
Fired when a 'pointermove','touchmove' or 'mousemove' event occurs in a page.
Fired when a 'pointerup','touchend' or 'mouseup' event occurs in a page.
Fired when a reader document has been loaded by a ReaderView for rendering.
Fired when a reader document has been unloaded by the ReaderView, it is no longer rendered.
Fired when the contents returned by ReaderView.toJSON() has changed.
Fired when the current reading position has changed for a ReaderView.
Fired when a scroll has been canceled, due to a ReaderView configuration change, or if the renderer had to abort
the scrolling due to a navigation.
You can get the new height using IReaderView.getScrollState()
Fired when a scrolling renderer has finished scrolling.
Fired when a scrolling renderer's scrollHeight has changed, either due to navigation or due to scripts inside a document changing the height of the document.
Fired when a scrolling renderer has started to scroll.
Fired when a renderer has ended transition/animation
Fired when a renderer has started a transition/animation
Fired when the current selection has changed in content documents.
Fired when a swipe navigation is in progress.
The SyncMediaPlayer has reached the end of the timeline.
Fired when an error occurred in the SyncMediaPlayer.
The "paused" property of the SyncMediaPlayer has changed to true, and playback has stopped.
The "paused" property of the SyncMediaPlayer has changed to false. The player will resume playback when ready.
Event fired when the SyncMediaPlayer reached the end of a playback range provided in the setPlaybackRange() method.
Event fired when a playback range in the SyncMediaPlayer is removed.
The synchronization state between the SyncMediaPlayer and the ReaderView has changed. If managed synchronization is enabled, the framework has already acted on the state change. If managed synchronization is disabled, you might need to navigate the ReaderView, or seek to a new timeline position in order to make them synchronized.
Before you use this event to try to achieve a specific synchronization behaviour between the ReaderView and
SyncMediaPlayer, please note that synchronization is an advanced topic. It is very likely that what you are
trying to achieve is already available through SyncMediaPlayer.setManagedReaderViewSynchronizationOptions() or
SyncMediaPlayer.setReaderViewSynchronizationWaitBehavior(). Please contact Colibrio if you are missing a
specific type of synchronization behaviour.
The SyncMediaPlayer has enough data to start playing, and is not waiting for ReaderView synchronization. If the "paused" property of the player is false, the playback will resume immediately.
The SyncMediaPlayer has seeked to a new position in the timeline.
The SyncMediaPlayer has started seeking to a new position in the timeline. The seeking operation has completed when the syncMediaPlayerSeeked event fires.
Fired when a new SyncMediaSegment is active in the SyncMediaPlayer.
The event object contains additional information about the targets related with the segment. For example, when playing EPUB Media Overlays, the event object will contain information about the current "par" node and its parent "seq" nodes, as well as the targeted HTML node.
This event should be used by clients to implement "escapability"
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.
This event fires when SyncMediaPlayer finishes playing a SyncMediaSegment.
The SyncMediaSegment that finished playing can be retrieved using the event object's timelinePosition property.
Note that this event does not fire for the active segment if the player seeks to a new position before the end of the segment was reached.
Event used for reporting progress when a SyncMediaTimeline is created for a ReaderPublication.
This event is fired at the ReadingSystemEngine instance where the ReaderPublication was loaded, thus you
need to call addEngineEventListener on that ReadingSystemEngine instance to listen on this event.
The current SyncMediaTimelinePosition of the SyncMediaPlayer has changed. During playback, this method is called approximately every 100ms.
The SyncMediaPlayer is waiting for data, or is waiting for ReaderView synchronization. The player will fire 'syncMediaPlayerReady' when it is no longer waiting for data or ReaderView synchronization.
Fired when the current visible pages has been completed rendering.
Event fired when visible content starts rendering.
Fired when the list of visible pages inside a ReaderView has changed.
Fired when a ReaderView's visible range has changed.
Generated using TypeDoc
Contains the complete list of EngineEvent types, and their corresponding event classes, that the framework uses.