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

    Interface ISyncMediaWaitingEngineEvent

    EngineEvent type used for "syncMediaWaiting" events. Event fired when 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.

    interface ISyncMediaWaitingEngineEvent {
        approximateElapsedTimeMs: number;
        cancelable: boolean;
        defaultPrevented: boolean;
        immediatePropagationStopped: boolean;
        isTrusted: boolean;
        propagationStopped: boolean;
        readerView: IReaderView;
        syncMediaPlayer: ISyncMediaPlayer;
        timelinePosition: ISyncMediaTimelinePosition;
        type: keyof IEngineEventTypeMap;
        waitingForMediaObjectRenderers: boolean;
        waitingForReaderViewSynchronization: boolean;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
        toJSON(): ISyncMediaWaitingEngineEventData;
    }

    Hierarchy (View Summary)

    Properties

    approximateElapsedTimeMs: number

    The approximate elapsed time from timeline start in milliseconds

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

    propagationStopped: boolean

    True if stopPropagation() was called on this event.

    readerView: IReaderView

    The ReaderView instance this event is related to, if any.

    syncMediaPlayer: ISyncMediaPlayer

    The media player related with this event.

    timelinePosition: ISyncMediaTimelinePosition

    The current player timeline position.

    type: keyof IEngineEventTypeMap

    The type of event.

    waitingForMediaObjectRenderers: boolean

    If the media player is waiting for the attached SyncMediaObjectRenderers to become ready. A SyncMediaObjectRenderer can be waiting on audio or video to load for example.

    waitingForReaderViewSynchronization: boolean

    If the media player is waiting for synchronization with the ReaderView until it can continue playback.

    Methods

    • Prevent the event's default action. See the respective engine event for its definition of default action.

      Returns 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

    Properties
    Methods