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

    Interface ISyncMediaTimelineCreateProgressEngineEventData

    The plain JSON version of ISyncMediaTimelineCreateProgressEngineEvent.

    This event is fired multiple times while a SyncMediaTimeline is created.

    In order to listen to this event, call addEngineEventListener on the ReadingSystemEngine instance where the related ReaderPublication is loaded.

    If you create multiple SyncMediaTimelines, you can use the timelineName property to distinguish which SyncMediaTimeline the event targets. You can specify the name of a SyncMediaTimeline in the options object passed to createSyncMediaTimeline().

    As an alternative to this event, you can also specify a progressCallback when calling createSyncMediaTimeline().

    interface ISyncMediaTimelineCreateProgressEngineEventData {
        cancelable: boolean;
        defaultPrevented: boolean;
        done: boolean;
        immediatePropagationStopped: boolean;
        isTrusted: boolean;
        objectType: EngineEventDataObjectType;
        progress: number;
        propagationStopped: boolean;
        readerViewName: string;
        timelineName: string;
        type: keyof IEngineEventTypeMap;
    }

    Hierarchy (View Summary)

    Properties

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

    done: boolean

    Indicates if the SyncMediaTimeline creation process has finished. When this field is true, no more events will be emitted for the SyncMediaTimeline this event is related to.

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

    objectType: EngineEventDataObjectType

    The type of engine event object this JSON structure represents.

    SYNC_MEDIA_TIMELINE_CREATE_PROGRESS_ENGINE_EVENT
    progress: number

    A value between 0 and 1 indicating the progress of the SyncMediaTimeline creation.

    propagationStopped: boolean

    True if stopPropagation() was called on this event.

    readerViewName: string

    The name of the ReaderView this event is related to, if any.

    timelineName: string

    The name of the SyncMediaTimeline this event is related to.

    You can specify the name of a SyncMediaTimeline in the options object passed to createSyncMediaTimeline().

    type: keyof IEngineEventTypeMap

    The type of event.

    Properties