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

    Interface IPublicationMediaElementEngineEvent

    Event type used for various publication media element related events.

    interface IPublicationMediaElementEngineEvent {
        cancelable: boolean;
        currentTimeMs: number;
        defaultPrevented: boolean;
        durationMs: number;
        immediatePropagationStopped: boolean;
        isTrusted: boolean;
        mediaResource: IEngineEventMediaResource;
        paused: boolean;
        propagationStopped: boolean;
        readerView: IReaderView;
        ready: boolean;
        target: IEngineEventTarget;
        type: keyof IEngineEventTypeMap;
        preventDefault(): void;
        stopImmediatePropagation(): void;
        stopPropagation(): void;
        toJSON(): IPublicationMediaElementEngineEventData;
    }

    Hierarchy (View Summary)

    Properties

    cancelable: boolean

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

    currentTimeMs: number

    The current playback position in the media element, in milliseconds.

    defaultPrevented: boolean

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

    durationMs: number

    The total duration of the media in milliseconds.

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

    mediaResource: IEngineEventMediaResource

    Contains additional information about the media resource and methods to access media content.

    paused: boolean

    If the media element is paused.

    propagationStopped: boolean

    True if stopPropagation() was called on this event.

    readerView: IReaderView

    The ReaderView instance this event is related to.

    ready: boolean

    If the media element has enough data to play.

    target: IEngineEventTarget

    Contains additional information about the element.

    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