Defines a Replayer cue

interface ICue {
    Description: null | string;
    Duration: null | number;
    Id: string;
    OmitFadeIn: boolean;
    OmitPreRoll: boolean;
    Remarks: null | string;
    Shortcut: null | string;
    Time: null | number;
}

Implemented by

Properties

Description: null | string

A short description of the cue, e.g. "Verse 1" or "Chorus"

Duration: null | number

The calculated duration of the cue

Remarks

This is only defined if there is a subsequent cue, or if it is the last queue in a track, the track length is known.

Devdoc

This must get recalculated if the set of cues changes, or the track is loaded/unloaded. It must never get persisted.

Id: string

A unique identifier for this cue.

Remarks

To work correctly, this identifier must be unique among all currently loaded compilations. Best, to make it universally unique by using a UUID.

Devdoc

This identifier allows to recognise this item over multiple edits

OmitFadeIn: boolean

Whether to omit the possibly defined default/track fade-in for this cue.

OmitPreRoll: boolean

Whether to omit the possibly defined default/track pre-roll for this cue.

Remarks: null | string

Remarks to this cue, e.g. performance instructions

Shortcut: null | string

A mnemonic that can serve as keyboard shortcut for this cue

Time: null | number