Slur()

Class representing a Slur modification.

A Slur modification causes a sequence of notes to be played as if belonging to a single phrase. This translates to a slight crescendo/descrescendo over the course of the sequence, as well as a somewhat early release of the final note.

new Slur()
modifications/Slur.mjs, line 13

Constructs a new Slur modification object.

Extends

Classes

Slur
Slur

Members

key :Key
modifications/ModificationBase.mjs, line 34

Overrides:

tempo :Tempo
modifications/ModificationBase.mjs, line 32

Overrides:

unmodifiedDetails :NoteDetails
modifications/ModificationBase.mjs, line 36

Overrides:

Methods

getModifiedNoteDetails(details) → {Array.<NoteDetails>}
modifications/Slur.mjs, line 70

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 1) totalNumNotes: Total number of notes present in 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}
modifications/Slur.mjs, line 47

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>>>}
modifications/Slur.mjs, line 29

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