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

    Interface ISyncMediaSegmentDurationChangedEngineEvent

    This event fires after the duration of a SyncMediaTimelineSegment has been updated. This can happen when the SyncMediaPlayer has received additional information about a segment's duration (such as after loading the media) and it did not match with the approximated value. The segment has been updated with the new duration value and the total duration of the timeline has also been updated.

    interface ISyncMediaSegmentDurationChangedEngineEvent {
        approximateElapsedTimeMs: number;
        cancelable: boolean;
        defaultPrevented: boolean;
        immediatePropagationStopped: boolean;
        isTrusted: boolean;
        newDurationMs: number;
        oldDurationMs: number;
        propagationStopped: boolean;
        readerView: IReaderView;
        segmentIndex: number;
        syncMediaPlayer: ISyncMediaPlayer;
        timelinePosition: ISyncMediaTimelinePosition;
        type: keyof IEngineEventTypeMap;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
        toJSON(): ISyncMediaSegmentDurationChangedEngineEventData;
    }

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

    newDurationMs: number

    The new duration of the segment in milliseconds.

    oldDurationMs: number

    The old duration of the segment in milliseconds.

    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 of this segment within the timeline's segment list.

    syncMediaPlayer: ISyncMediaPlayer

    The media player related with this event.

    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