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

    Interface PlaylistSoundData

    interface PlaylistSoundData {
        _id: string | null;
        channel: string;
        description: string;
        fade?: number;
        flags: DocumentFlags;
        name: string;
        path: string;
        pausedTime?: number;
        playing?: boolean;
        repeat?: boolean;
        sort?: number;
        volume?: number;
    }
    Index

    Properties

    _id channel description fade? flags name path pausedTime? playing? repeat? sort? volume?

    Properties

    _id

    _id: string | null

    The _id which uniquely identifies this PlaylistSound document

    channel: string

    A channel in CONST.AUDIO_CHANNELS where this sound is played

    description: string

    The description of this sound

    fade?: number

    A duration in milliseconds to fade volume transition

    flags: DocumentFlags

    An object of optional key/value flags

    name: string

    The name of this sound

    path: string

    The audio file path that is played by this sound

    pausedTime?: number

    The time in seconds at which playback was paused

    playing?: boolean

    Is this sound currently playing?

    repeat?: boolean

    Does this sound loop?

    sort?: number

    The sort order of the PlaylistSound relative to others in the same collection

    volume?: number

    The audio volume of the sound, from 0 to 1

    Settings

    Member Visibility

    On This Page

    Properties