Class EligiusEngine

The Eligius timeline engine with explicit, testable API.

This engine is responsible for starting and stopping the given timeline provider and triggering the actions associated with positions along the timeline.

Implements

IEligiusEngine

Index

Constructors

constructor

new EligiusEngine(
    configuration: IResolvedEngineConfiguration,
    eventbus: IEventbus,
    timelineProviders: Record<TimelineTypes, ITimelineProviderInfo>,
    languageManager: LanguageManager,
): EligiusEngine
Parameters
- configuration: IResolvedEngineConfiguration
- eventbus: IEventbus
- timelineProviders: Record<TimelineTypes, ITimelineProviderInfo>
- languageManager: LanguageManager
Returns EligiusEngine
- Defined in eligius-engine.ts:129

Accessors

container

get container(): JQuery<HTMLElement> | undefined
Container element for the active timeline provider

Returns JQuery<HTMLElement> | undefined
Implementation of IEligiusEngine.container
- Defined in eligius-engine.ts:120

currentTimelineUri

get currentTimelineUri(): string
URI of the currently active timeline

Returns string
Implementation of IEligiusEngine.currentTimelineUri
- Defined in eligius-engine.ts:115

duration

get duration(): number | undefined
Timeline duration in seconds, undefined if not yet available

Returns number | undefined
Implementation of IEligiusEngine.duration
- Defined in eligius-engine.ts:102

engineRoot

get engineRoot(): JQuery<HTMLElement>
Root element of the engine (container selector)

Returns JQuery<HTMLElement>
Implementation of IEligiusEngine.engineRoot
- Defined in eligius-engine.ts:125

playState

get playState(): "playing" | "paused" | "stopped"
Current playback state (derived from position source state)

Returns "playing" | "paused" | "stopped"
Implementation of IEligiusEngine.playState
- Defined in eligius-engine.ts:107

position

get position(): number
Current timeline position in seconds (supports fractional values)

Returns number
Implementation of IEligiusEngine.position
- Defined in eligius-engine.ts:97

Methods

destroy

destroy(): Promise<void>
Cleans up all the necessary parts that the engine initialized.
- It ends the currently active operations and the init actions.
- It removes all its eventbus listeners, handlers and interceptors.
- It destroys all of its timeline providers
- It empties the HTML element indicated by the containerSelector configuration property.
Returns Promise<void>
Implementation of IEligiusEngine.destroy
- Defined in eligius-engine.ts:432

init

init(): Promise<IPositionSource>
Initializes the engine by creating the HTML layout and the first time line by executing its initActions.

Returns Promise<IPositionSource>
Implementation of IEligiusEngine.init
- Defined in eligius-engine.ts:314

on

on<K extends keyof EngineEvents>(
event: K,
handler: (...args: EngineEvents[K]) => void,
): () => void
Subscribe to engine events
Type Parameters
- K extends keyof EngineEvents
Parameters
- event: K
  Event name
- handler: (...args: EngineEvents[K]) => void
  Event handler
Returns () => void
Unsubscribe function
Implementation of IEligiusEngine.on
- Defined in eligius-engine.ts:146

pause

pause(): void
Pause playback

Returns void
Implementation of IEligiusEngine.pause
- Defined in eligius-engine.ts:174

seek

seek(position: number): Promise<number>
Seek to a specific position
Parameters
- position: number
  Target position in seconds
Returns Promise<number>
Actual position after seek
Implementation of IEligiusEngine.seek
- Defined in eligius-engine.ts:202

start

start(): Promise<void>
Start playback

Returns Promise<void>
Throws
If autoplay is blocked (video provider)
Implementation of IEligiusEngine.start
- Defined in eligius-engine.ts:161

stop

stop(): void
Stop playback and reset to beginning

Returns void
Implementation of IEligiusEngine.stop
- Defined in eligius-engine.ts:187

switchTimeline

switchTimeline(uri: string, position?: number): Promise<void>
Switch to a different timeline
Parameters
- uri: string
  Timeline URI to switch to
- position: number = 0
  Optional starting position
Returns Promise<void>
Implementation of IEligiusEngine.switchTimeline
- Defined in eligius-engine.ts:253

`Static`sortActionsPerPosition

sortActionsPerPosition(actions: ActionMethod[]): ActionMethod[]
Parameters
- actions: ActionMethod[]
Returns ActionMethod[]
- Defined in eligius-engine.ts:591

`Static`sortTimelines

sortTimelines(timelines: Record<number, ActionMethod[]>[]): void
Parameters
- timelines: Record<number, ActionMethod[]>[]
Returns void
- Defined in eligius-engine.ts:580

Class EligiusEngine

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns EligiusEngine

Accessors

container

Returns JQuery<HTMLElement> | undefined

currentTimelineUri

Returns string

duration

Returns number | undefined

engineRoot

Returns JQuery<HTMLElement>

playState

Returns "playing" | "paused" | "stopped"

position

Returns number

Methods

destroy

Returns Promise<void>

init

Returns Promise<IPositionSource>

on

Type Parameters

Parameters

Returns () => void

pause

Returns void

seek

Parameters

Returns Promise<number>

start

Returns Promise<void>

Throws

stop

Returns void

switchTimeline

Parameters

Returns Promise<void>

StaticsortActionsPerPosition

Parameters

Returns ActionMethod[]

StaticsortTimelines

Parameters

Returns void

Settings

On This Page

`Static`sortActionsPerPosition

`Static`sortTimelines