eligius
    Preparing search index...

    Interface IEligiusEngine

    The Eligius timeline engine with explicit, testable API

    interface IEligiusEngine {
        container: JQuery<HTMLElement> | undefined;
        currentTimelineUri: string;
        duration: number | undefined;
        engineRoot: JQuery<HTMLElement>;
        playState: "playing" | "paused" | "stopped";
        position: number;
        destroy(): Promise<void>;
        init(): Promise<IPositionSource>;
        on<K extends keyof EngineEvents>(
            event: K,
            handler: (...args: EngineEvents[K]) => void,
        ): () => void;
        pause(): void;
        seek(position: number): Promise<number>;
        start(): Promise<void>;
        stop(): void;
        switchTimeline(uri: string, position?: number): Promise<void>;
    }

    Implemented by

    Index

    Properties

    container currentTimelineUri duration engineRoot playState position

    Methods

    destroy init on pause seek start stop switchTimeline

    Properties

    container: JQuery<HTMLElement> | undefined

    Container element for the active timeline provider

    currentTimelineUri: string

    URI of the currently active timeline

    duration: number | undefined

    Timeline duration in seconds, undefined if not yet available

    engineRoot: JQuery<HTMLElement>

    Root element of the engine (container selector)

    playState: "playing" | "paused" | "stopped"

    Current playback state

    position: number

    Current timeline position in seconds

    Methods

    • Destroy the engine Cleans up resources, ends actions, removes event listeners

      Returns Promise<void>

    • Initialize the engine Creates layout, initializes timeline provider, executes init actions

      Returns Promise<IPositionSource>

      The initialized position source

    • Subscribe to engine events

      Type Parameters

      Parameters

      • event: K

        Event name

      • handler: (...args: EngineEvents[K]) => void

        Event handler

      Returns () => void

      Unsubscribe function

    • Pause playback

      Returns void

    • Seek to a specific position

      Parameters

      • position: number

        Target position in seconds

      Returns Promise<number>

      Actual position after seek

    • Start playback

      Returns Promise<void>

      If autoplay is blocked (video provider)

    • Stop playback and reset to beginning

      Returns void

    • Switch to a different timeline

      Parameters

      • uri: string

        Timeline URI to switch to

      • Optionalposition: number

        Optional starting position

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods