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()
Indicates if the SyncMediaTimeline creation process has finished. When this field is true, no more events will be emitted for the SyncMediaTimeline this event is related to.
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".
A value between 0 and 1 indicating the progress of the SyncMediaTimeline creation.
True if stopPropagation() was called on this event.
The ReaderView instance this event is related to, if any.
The name of the SyncMediaTimeline this event is related to.
You can specify the name of a SyncMediaTimeline in the options object
passed to createSyncMediaTimeline()
.
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 instance as a plain JSON object.
Generated using TypeDoc
This event is fired multiple times while a SyncMediaTimeline is created.
In order to listen to this event, call
addEngineEventListener
on the ReadingSystemEngine instance where the related ReaderPublication is loaded.If you create multiple SyncMediaTimelines, you can use the
timelineName
property to distinguish which SyncMediaTimeline the event targets. You can specify the name of a SyncMediaTimeline in the options object passed tocreateSyncMediaTimeline()
.As an alternative to this event, you can also specify a
progressCallback
when callingcreateSyncMediaTimeline()
.