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

    Interface ISyncMediaSegmentActiveEngineEvent

    Used for the engine event "syncMediaSegmentActive"

    interface ISyncMediaSegmentActiveEngineEvent {
        approximateElapsedTimeMs: number;
        cancelable: boolean;
        defaultPrevented: boolean;
        immediatePropagationStopped: boolean;
        isTrusted: boolean;
        propagationStopped: boolean;
        readerView: IReaderView;
        segmentIndex: number;
        syncMediaPlayer: ISyncMediaPlayer;
        targets: ISyncMediaSegmentTarget[];
        timelinePosition: ISyncMediaTimelinePosition;
        type: keyof IEngineEventTypeMap;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
        toJSON(): ISyncMediaSegmentActiveEngineEventData;
    }

    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.

    segmentIndex: number

    The index in the timeline of the current active SyncMediaSegment.

    syncMediaPlayer: ISyncMediaPlayer

    The media player related with this event.

    targets: ISyncMediaSegmentTarget[]

    The targets related with the segment, such as the DOM node being spoken by TTS, or active element when playing media overlays.

    The number of targets and their types are format specific.

    EPUB Media Overlays reports two targets. One with type "application/smil+xml" containing the "par" node backing this segment (including references to parent "seq" nodes). One with type "application/xhtml+xml" containing the html node targeted by the "par" node.

    Each node contains a start and end SyncMediaTimelinePosition. If you for example want to allow user's to skip content such as "table" elements, you can search for nodes with nodeName == "table" and skip to that node's endPosition.

    timelinePosition: ISyncMediaTimelinePosition

    The current player timeline position.

    type: keyof IEngineEventTypeMap

    The type of event.

    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