Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Interface _PlaylistDirectoryRenderContext

    interface _PlaylistDirectoryRenderContext {
        controls: {
            environment: PlaylistDirectoryVolumeContext;
            expanded: boolean;
            interface: PlaylistDirectoryVolumeContext;
            music: PlaylistDirectoryVolumeContext;
        };
        currentlyPlaying: {
            class: string;
            location: { bottom: boolean; top: boolean };
            pin: { caret: string; label: string };
            sounds: PlaylistSoundRenderContext[];
        };
        tree: PlaylistDirectoryTreeContext;
    }
    Index

    Properties

    controls: {
        environment: PlaylistDirectoryVolumeContext;
        expanded: boolean;
        interface: PlaylistDirectoryVolumeContext;
        music: PlaylistDirectoryVolumeContext;
    }

    Volume control context.

    Type Declaration

    currentlyPlaying: {
        class: string;
        location: { bottom: boolean; top: boolean };
        pin: { caret: string; label: string };
        sounds: PlaylistSoundRenderContext[];
    }

    Currently playing context.

    Type Declaration

    • class: string

      The CSS class of the currently playing widget.

    • location: { bottom: boolean; top: boolean }

      Location information for the currently playing widget.

      • bottom: boolean

        The widget is affixed to the bottom of the directory.

      • top: boolean

        The widget is affixed to the top of the directory.

    • pin: { caret: string; label: string }

      Render context for the currently playing pin icon.

      • caret: string

        The icon class.

      • label: string

        The icon tooltip.

    • sounds: PlaylistSoundRenderContext[]

      Render context for the currently playing PlaylistSound documents.

    Render context for the directory tree.