InstrumentBuilder


Methods

setColorRange (
colorData Int colorLower Int colorUpper Int
)

Set which noteBuilder object attached to this instrumentBuilder is used.

setNoteBaseRange (
min Int max Int
)

If setNoteBase = -1: setNoteBaseRange sets the range a programmatic  (a note whose pitch is based on color)  noteBase will use.

setNoteBase (
noteBase Int
)

Sets the note that attached noteBuilder objects (with noteRelative set to 1) use as a point of reference for a played note.

If set to -1 the note will be programmatic (a note whose pitch is based on color), with the range set by setNoteBaseRange.

setCurrentNoteSet (
noteSet Int
)

Set which noteBuilder object attached to this instrumentBuilder is used.

setBeatTime (
time Int[]
)

Set in 1/128th notes.

Sets the time signature that allows an instrumentBuilder to activate.

If beatRestrict = 1, beatTime is measured in 1/128th notes. A value of 32 would allow the instrumentBuilder to activate at the first 32/128 — 1/4 — beat of a measure.

If beatRestrict = 0, beatTime is measured in numbers divisible by the document counter with no regard to a measure. A value of 7 would activate at beats 7, 14, 21, 28, etc.

SPAWNS:
If set to a value different than the instrumentBuilder the spawn is attached to, and not a multiple of the instrumentBuilder beatTime, it’s likely that the spawn will only activate sporadically (when the instrumentBuilder beatTime is a multiple or the message beatTime) or never at all.

setLegatoOverlap (
legatoOverlap Int
)

Sets the amount in 1/128th notes that played notes will overlap following notes for legato-enabled instruments in Ableton Live.

setBeatRestrict (
beatRestrict Int
)

Set whether this instrumentBuilder is activated:
0: Once per measure at the beatTime
1: At all multiples of the beatTime

setColorMinMax (
min Int[] max Int[]
)

Sets the minimum and maximum color intensity that allows an object to activate.

Color intensity is calculated based on the amount of color present in RGB color segment assigned to the object, per frame.

setMidiChannel (
channel Int
)

Sets which MIDI channel the instrumentBuilder outputs to.
For Spawn:
-1: Channel of Parent.
MIDI Channel 0 exists for experiments but almost never is used.

setMidiEnable (
enable Int
)

Enable or disable this object.

1: Enabled
0: Disabled

addNote (
notes NoteBuilder
)

Attach a noteBuilder object to this instrumentBuilder.

addTrigger (
trigger TriggerBuilder
)

Attach a triggerBuilder object to this instrumentBuilder.

setVelocityIncrement (
increment Int
)

Sets the amount of color that will allow the instrumentBuilder to progress sequentially to the next note in an attached noteBuilder object.

addSpawn (
spawn SpawnBuilder
)

Attach a spawnBuilder object to this instrumentBuilder.

addMessage (
message MessageBuilder
)

Attach a messageBuilder object to this instrumentBuilder.

setLuma (
amount Int inversion Int
)

Determines how much the global luminance effects an instrumentBuilder’s colorMin — the minimum amount of color that will allow the object to activate.

The amount value effects the maximum amount the luminance can alter the colorMin.

The inversion value will either cause the colorMin to decrease (0) or increase (1).

setCosine (
amount Int inversion Int noiseAmount Int
)

Determines how much the global cosine effects an instrumentBuilder’s colorMin — the minimum amount of color that will allow the object to activate.

The amount value effects the maximum amount the luminance can alter the colorMin.

The inversion value will either cause the colorMin to decrease (0) or increase (1).

The noise value creates noise in the cosine. This value is usually between 0 and 50 but can be higher for greater noise aberrations.

setCosTime (
cosineLength float
)

Time in minutes (decimals allowed) that it takes for the instrument cosine to reach maximum impact.

setFaces (
amount Int inversion Int
)