Options
All
  • Public
  • Public/Protected
  • All
Menu

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() or SyncMediaPlayer.setReaderViewSynchronizationWaitBehavior(). Please contact Colibrio if you are missing a specific type of synchronization behaviour.

Hierarchy

  • IEngineEvent
    • ISyncMediaReaderViewSynchronizationStateChangedEngineEvent

Index

Properties

Readonly cancelable

cancelable: boolean

If this event's default action is cancelable. See respective engine event for its definition of default action.

Readonly defaultPrevented

defaultPrevented: boolean

If this event's default action has been canceled/prevented by a call to preventDefault()

Readonly immediatePropagationStopped

immediatePropagationStopped: boolean

True if stopImmediatePropagation() was called on this event.

Readonly isTrusted

isTrusted: boolean

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".

Readonly propagationStopped

propagationStopped: boolean

True if stopPropagation() was called on this event.

Readonly readerView

readerView: IReaderView

The ReaderView instance this event is related to.

Readonly state

Describes the synchronization state between the SyncMediaPlayer and the ReaderView.

Readonly syncMediaPlayer

syncMediaPlayer: ISyncMediaPlayer

The SyncMediaPlayer instance this event is related to.

Readonly type

The type of event.

Methods

preventDefault

  • preventDefault(): void
  • Prevent the event's default action. See the respective engine event for its definition of default action.

    Returns void

stopImmediatePropagation

  • stopImmediatePropagation(): void

stopPropagation

  • stopPropagation(): void
  • 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.

    Returns void

toJSON

Generated using TypeDoc