Class Cue

Implements a Replayer cue

Implements

Constructors

constructor

Properties

Description Duration Id OmitFadeIn OmitPreRoll Remarks Shortcut Time

Methods

empty

Constructors

constructor

  • new Cue(description, remarks, shortcut, time, duration, omitPreRoll, omitFadeIn, id): Cue

  • Creates a new cue

    Parameters

    • description: null | string
    • remarks: null | string
    • shortcut: null | string
    • time: null | number
    • duration: null | number
    • omitPreRoll: boolean
    • omitFadeIn: boolean
    • id: string

    Returns Cue

Properties

Description

Description: null | string = null

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

Duration

Duration: null | number = null

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

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

OmitFadeIn: boolean = false

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

OmitPreRoll

OmitPreRoll: boolean = false

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

Remarks

Remarks: null | string = null

Remarks to this cue, e.g. performance instructions

Shortcut

Shortcut: null | string = null

A mnemonic that can serve as keyboard shortcut for this cue

Time

Time: null | number = null

Inherit Doc

Methods

Static empty

Settings

Member Visibility

Theme

On This Page

constructorDescriptionDurationIdOmitFadeInOmitPreRollRemarksShortcutTimeempty