Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface ISyncMediaReaderViewSynchronizationStateChangedEngineEventData

    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.

    interface ISyncMediaReaderViewSynchronizationStateChangedEngineEventData {
        cancelable: boolean;
        defaultPrevented: boolean;
        immediatePropagationStopped: boolean;
        isTrusted: boolean;
        objectType: EngineEventDataObjectType;
        propagationStopped: boolean;
        readerViewName: string;
        state: ISyncMediaReaderViewSynchronizationStateData;
        syncMediaPlayerName: string;
        type: keyof IEngineEventTypeMap;
    }

    Hierarchy (View Summary)

    Properties

    cancelable: boolean

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

    defaultPrevented: boolean

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

    immediatePropagationStopped: boolean

    True if stopImmediatePropagation() was called on this event.

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

    objectType: EngineEventDataObjectType

    The type of engine event object this JSON structure represents.

    SYNC_MEDIA_VIEW_SYNCHRONIZATION_STATE_CHANGED_ENGINE_EVENT
    propagationStopped: boolean

    True if stopPropagation() was called on this event.

    readerViewName: string

    The name of the ReaderView this event is related to, if any.

    state: ISyncMediaReaderViewSynchronizationStateData
    syncMediaPlayerName: string
    type: keyof IEngineEventTypeMap

    The type of event.

    Properties