Global

Type Definitions

EffectParameter

Composite object type for holding a set of concrete Effect parameter details.

Properties:
Name Type Description
name string

Name of the effect parameter

type string

Type of effect parameter value (either "string" or "number")

validValues Array.<(string|number)>

For "string" types, a listing of all valid values; for "number" types, the min/max values

defaultValue string | number

Default effect value before any updates

Key

Composite object type for holding all key-related information.

Properties:
Name Type Description
signature number

Numerical KeySignature indicator based on its circle of fifths position

offsets Array.<number>

Array containing all pitch offsets in the current key signature where the offset for C is at index 0

MidiEventCallback(event)

Required function prototype to use when registering a MIDI device callback.

Parameters:
Name Type Description
event MIDIMessageEvent

Object containing the detected MIDI event

See:

ModificationDetails

Composite object type for holding a set of note modification details.

Properties:
Name Type Attributes Description
type number

Underlying ModificationType

value Object <optional>

Modification-specific values (i.e., slur length, glissando ending note)

See:

RecordCompleteCallback(clip)

Required function prototype to use when registering a recording completion callback.

Parameters:
Name Type Description
clip MidiClip | AudioClip

Instance of the fully recorded clip

See:

Tempo

Composite object type for holding all tempo-related information.

Properties:
Name Type Description
beatBase number

Note Duration corresponding to a global beat

beatsPerMinute number

Number of global beats per minute

timeSignatureNumerator number

Number of beats per measure

timeSignatureDenominator number

Note Duration corresponding to a measure beat

measureLengthSeconds number

Length (in seconds) of a measure