If this event's default action is cancelable. See respective engine event for its definition of default action.
If this event's default action has been canceled/prevented by a call to preventDefault()
True if stopImmediatePropagation() was called on this event.
If this event runs in a "trusted" context, i.e. the event callback is executed during a user-generated event such as "click" or "pointerdown".
True if stopPropagation() was called on this event.
The ReaderView instance this event is related to.
Describes the synchronization state between the SyncMediaPlayer and the ReaderView.
The SyncMediaPlayer instance this event is related to.
The type of event.
Prevent the event's default action. See the respective engine event for its definition of default action.
Stops this event from propagating to anymore listener.
Stops this event from propagating to listeners on the ReadingSystemEngine instance, if called from a listener added to a ReaderView instance. If the event has already propagated to the ReadingSystemEngine instance, calling this method has no effect.
Get this event as a plain JSON object.
Generated using TypeDoc
Fires when the synchronization state between the ReaderView and the SyncMediaPlayer has changed.
If managed ReaderView synchronization has been disabled (see
SyncMediaPlayer.setManagedReaderViewSynchronizationOptions()
) you may need to either navigate the ReaderView or seek the SyncMediaPlayer in order for them to stay synchronized.If managed ReaderView synchronization is enabled, you don't need to act on this event.
Before you use this data 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()
orSyncMediaPlayer.setReaderViewSynchronizationWaitBehavior()
. Please contact Colibrio if you are missing a specific type of synchronization behaviour.