eligius
    Preparing search index...

    Interface IPlaylistConfig<TItem>

    Configuration for a playlist.

    Playlists manage collections of items (e.g., video chapters) that can be selected and navigated. They are resolved dynamically via the resource importer using systemName.

    Built-in playlists:

    • SimplePlaylist: Basic playlist with array of items
    const config: IPlaylistConfig = {
      systemName: 'SimplePlaylist',
      items: [{ uri: '/video1.mp4' }, { uri: '/video2.mp4' }],
      identifierKey: 'uri',
    };
    interface IPlaylistConfig<TItem = unknown> {
        identifierKey: string;
        items: TItem[];
        systemName: string;
        [key: string]: unknown;
    }

    Type Parameters

    • TItem = unknown

      The type of items in the playlist

    Indexable

    • [key: string]: unknown

      Additional configuration options passed to the playlist constructor. Use this for custom playlist implementations.

    Index

    Properties

    identifierKey items systemName

    Properties

    identifierKey: string

    Property key used to identify items. Used when selecting items by identifier (e.g., 'uri', 'id', 'chapterId').

    items: TItem[]

    The items in the playlist

    systemName: string

    Name of the playlist class to instantiate. Resolved via the resource importer.

    Built-in options: 'SimplePlaylist'

    Settings

    Member Visibility

    On This Page

    Properties