Crescendo(isDecrescendo)

Class representing a Crescendo modification.

A Crescendo modification causes a sequence of notes to be played with increasing loudness over time.

new Crescendo(isDecrescendo)

Constructs a new Crescendo modification object.

Parameters:
Name Type Description
isDecrescendo boolean

Whether this modification represents a decrescendo/diminuendo

Extends

Classes

Crescendo

Members

key :Key

Overrides:

tempo :Tempo

Overrides:

unmodifiedDetails :NoteDetails

Overrides:

Methods

getModifiedNoteDetails(details) → {Array.<NoteDetails>}

Returns a list of all modified notes, durations, and velocities as generated by the corresponding modification class.

The details variable must contain the following two keys:

noteIndex: Which note this modification applies to within the total modified phrase (starting at 0) totalNumNotes: Total number of notes present in the modified phrase endingDynamic: Desired dynamic at the end of the modified phrase

Parameters:
Name Type Description
details Object.<string, number>

Information about the total modified phrase and this note's place in it

Returns:
Array.<NoteDetails> -

List of NoteDetails to replace the original note

Overrides:

static canModifySequence() → {boolean}

Returns whether this modification can be used to modify a sequence of notes.

Returns:
boolean -

Whether this modification can be used to modify a sequence of notes

static getParameters() → {Object.<string, Object.<string, Array.<string>>>}

Returns a list of all parameters available for use in this modification, including whether the parameter is required or optional when playing back either a "sequence" or just a single "note".

Returns:
Object.<string, Object.<string, Array.<string>>> -

List of modification-specific parameter keys and when they are required