Interface PlaylistSoundData

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

Properties

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

Properties

_id

_id: null | string

The _id which uniquely identifies this PlaylistSound document

channel

channel: string

A channel in CONST.AUDIO_CHANNELS where this sound is played

description

description: string

The description of this sound

Optionalfade

fade?: number

A duration in milliseconds to fade volume transition

flags

flags: DocumentFlags

An object of optional key/value flags

name

name: string

The name of this sound

path

path: string

The audio file path that is played by this sound

OptionalpausedTime

pausedTime?: number

The time in seconds at which playback was paused

Optionalplaying

playing?: boolean

Is this sound currently playing?

Optionalrepeat

repeat?: boolean

Does this sound loop?

Optionalsort

sort?: number

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

Optionalvolume

volume?: number

The audio volume of the sound, from 0 to 1

Settings

Member Visibility

On This Page

Properties