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

    Interface ISyncMediaErrorEngineEvent

    Event used when a SyncMediaPlayer encounters an error.

    interface ISyncMediaErrorEngineEvent {
        approximateElapsedTimeMs: number;
        cancelable: boolean;
        defaultPrevented: boolean;
        error: unknown;
        errorMessage: string;
        errorType: SyncMediaPlayerErrorType;
        immediatePropagationStopped: boolean;
        isTrusted: boolean;
        paused: boolean;
        propagationStopped: boolean;
        readerView: IReaderView;
        segmentIndex: number;
        syncMediaPlayer: ISyncMediaPlayer;
        timelinePosition: ISyncMediaTimelinePosition;
        type: keyof IEngineEventTypeMap;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
        toJSON(): ISyncMediaErrorEngineEventData;
    }

    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()

    error: unknown

    The error that occurred. This should on most cases be an Error object or ColibrioError object but may be of another type.

    errorMessage: string

    If errorData was an instance of Error, it is set to errorData.message, otherwise it is set to null.

    errorType: SyncMediaPlayerErrorType

    The type of error that occurred.

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

    paused: boolean

    If the player has paused due to the error. If true, a "paused" event will also be fired right after this event was fired.

    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 the segment related with the error.

    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