OctaveShift(shiftUp) → {Array.<NoteDetails>}

Class representing an Octave Shift modification.

An Octave Shift modification causes a note to be played a full octave higher or lower than written.

new OctaveShift(shiftUp) → {Array.<NoteDetails>}
modifications/OctaveShift.mjs, line 10

Constructs a new OctaveShift modification object.

Parameters:
Name Type Description
shiftUp boolean

Whether this is an octave shift up or down
Returns:
Array.<NoteDetails> -

List of NoteDetails to replace the original note

Extends

Classes

OctaveShift
OctaveShift

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(opt details) → {Array.<NoteDetails>}
modifications/ModificationBase.mjs, line 58

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

Parameters:
Name Type Attributes Description
details Object | null <optional>

Optional details used to refine the requested modification
Returns:
Array.<NoteDetails> -

List of NoteDetails to replace the original note

Overrides:

static canModifySequence() → {boolean}
modifications/OctaveShift.mjs, line 52

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/OctaveShift.mjs, line 34

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