eligius
    Preparing search index...

    Class EngineFactory

    The EngineFactory is used to create and initialize an IEligiusEngine instance.

    It prepares a resolved configuration and creates the engine based on the class defined in the configuration.

    import { IEngineConfiguration, EngineFactory, EligiusResourceImporter } from 'eligius';
    import * as engineConfig from './my-eligius-config.json';

    const factory = new EngineFactory(new EligiusResourceImporter(), window);

    const { engine } = factory.createEngine((engineConfig as unknown) as IEngineConfiguration);

    engine.init().then(()=> {console.log('Eligius engine ready for business');});

    Implements

    Index

    Constructors

    constructor

    Methods

    createContainerProviderForTimeline createEngine createPlaylistForTimeline createPositionSourceForTimeline createTimelineProviderInfo createTimelineProvidersForConfig destroy

    Constructors

    Methods

    • Creates a container provider based on timeline provider settings.

      The container provider class is resolved dynamically via the resource importer using the systemName property from the configuration.

      Parameters

      Returns IContainerProvider | undefined

      A container provider, or undefined if not configured

      Error if the container provider class cannot be resolved

    • Creates a playlist based on timeline provider settings.

      The playlist class is resolved dynamically via the resource importer using the systemName property from the configuration.

      Parameters

      Returns IPlaylist<unknown> | undefined

      A playlist, or undefined if not configured

      Error if the playlist class cannot be resolved

    • Creates timeline providers for all configured timeline types using the new configuration-driven architecture.

      This method iterates over timelineProviderSettings and creates a ITimelineProviderInfo for each configured timeline type by:

      1. Finding the first timeline that matches the type
      2. Using the timeline's duration for the position source
      3. Assembling components from the settings

      Parameters

      Returns Record<TimelineTypes, ITimelineProviderInfo>

      A record of timeline types to their provider info

      Error if a provider setting has no matching timeline in config

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods