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

    Interface PlaylistData

    interface PlaylistData {
        _id: string | null;
        _stats: DocumentStats;
        channel: string;
        description: string;
        fade?: number;
        flags: DocumentFlags;
        folder: string | null;
        mode?: number;
        name: string;
        ownership?: object;
        playing?: boolean;
        seed?: number;
        sort?: number;
        sorting: string;
        sounds: PlaylistSoundData[];
    }
    Index

    Properties

    _id _stats channel description fade? flags folder mode? name ownership? playing? seed? sort? sorting sounds

    Properties

    _id

    _id: string | null

    The _id which uniquely identifies this Playlist document

    _stats

    _stats: DocumentStats

    An object of creation and access information

    channel: string

    A channel in CONST.AUDIO_CHANNELS where all sounds in this playlist are played

    description: string

    The description of this playlist

    fade?: number

    A duration in milliseconds to fade volume transition

    flags: DocumentFlags

    An object of optional key/value flags

    folder: string | null

    The _id of a Folder which contains this playlist

    mode?: number

    The playback mode for sounds in this playlist

    name: string

    The name of this playlist

    ownership?: object

    An object which configures ownership of this Playlist

    playing?: boolean

    Is this playlist currently playing?

    seed?: number

    A seed used for playlist randomization to guarantee that all clients generate the same random order.

    sort?: number

    The numeric sort value which orders this playlist relative to its siblings

    sorting: string

    The sorting mode used for this playlist.

    sounds: PlaylistSoundData[]

    A Collection of PlaylistSounds embedded documents which belong to this playlist

    Settings

    Member Visibility

    On This Page

    Properties