Class Cue

The Cue class contains static methods for slightly more nice and intuitive creation of cues.

Hierarchy

Cue

Index

Constructors

Methods

afterBeats afterMs when

Constructors

constructor

new Cue(): Cue
Returns Cue

Methods

`Static` afterBeats

afterBeats(metronome: IMetronome, beatCount: number, action: (() => void)): BeatCue
Creates a new instance of BeatCue.

Returns
Parameters
- metronome: IMetronome
  
  The metronome to use for counting beats.
- beatCount: number
  
  The number of beats to wait before performing some action.
- action: (() => void)
  
  The action to perform once the cue has finished waiting.
  - - (): void
    - Returns void
Returns BeatCue
- Defined in Cue.ts:220

`Static` afterMs

afterMs(msCount: number, action: (() => void)): MsCue
Creates a new instance of MsCue.

Returns
Parameters
- msCount: number
  
  The number of milliseconds to wait before performing some action.
- action: (() => void)
  
  The action to perform once the cue has finished waiting.
  - - (): void
    - Returns void
Returns MsCue
- Defined in Cue.ts:209

`Static` when

when(condition: (() => boolean), action: (() => void)): ConditionalCue
Creates a new instance of ConditionalCue.

Returns
Parameters
- condition: (() => boolean)
  
  The condition which must be satisfied before performing some action.
  - - (): boolean
    - Returns boolean
- action: (() => void)
  
  The action to perform once the cue has finished waiting.
  - - (): void
    - Returns void
Returns ConditionalCue
- Defined in Cue.ts:199

Generated using TypeDoc