eligius
    Preparing search index...

    Interface IPlaylist<TItem>

    Interface for managing a collection of timeline items.

    A playlist allows switching between multiple timeline configurations (e.g., multiple videos, multiple animation sequences).

    playlist.onItemChange((item) => {
      console.log(`Switched to: ${item.uri}`);
    });

    playlist.selectItem('chapter-2');
    interface IPlaylist<TItem = unknown> {
        currentItem: TItem;
        items: readonly TItem[];
        onItemChange(callback: (item: TItem) => void): void;
        selectItem(identifier: string): void;
    }

    Type Parameters

    • TItem = unknown

      Type of playlist items (default: unknown)

    Implemented by

    Index

    Properties

    currentItem items

    Methods

    onItemChange selectItem

    Properties

    currentItem: TItem

    Currently active playlist item

    items: readonly TItem[]

    All items in the playlist

    Methods

    • Register a callback for item changes.

      Called whenever the current item changes via selectItem().

      Parameters

      • callback: (item: TItem) => void

        Function receiving the new current item

      Returns void

    • Select a playlist item by identifier.

      Parameters

      • identifier: string

        Unique identifier for the item (e.g., URI, ID)

      Returns void

      If no item matches the identifier

    Settings

    Member Visibility

    On This Page

    Properties
    Methods