Interface PlaylistData

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

Properties

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

Properties

_id

_id: null | string

The _id which uniquely identifies this Playlist document

_stats

_stats: DocumentStats

An object of creation and access information

channel

channel: string

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

description

description: string

The description of this playlist

Optionalfade

fade?: number

A duration in milliseconds to fade volume transition

flags

flags: DocumentFlags

An object of optional key/value flags

folder

folder: null | string

The _id of a Folder which contains this playlist

Optionalmode

mode?: number

The playback mode for sounds in this playlist

name

name: string

The name of this playlist

Optionalownership

ownership?: object

An object which configures ownership of this Playlist

Optionalplaying

playing?: boolean

Is this playlist currently playing?

Optionalseed

seed?: number

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

Optionalsort

sort?: number

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

sorting

sorting: string

The sorting mode used for this playlist.

sounds

sounds: PlaylistSoundData[]

A Collection of PlaylistSounds embedded documents which belong to this playlist

Settings

Member Visibility

On This Page

Properties