List of Functions¶
Ableton¶
Actions¶
- CloseAllPluginWindows(allRackspaces) Autotype¶
Close all plugins associated with this rackspace or optionally with all rackspaces - in the GigScript the allRackspaces argument MUST be true
- Parameters
allRackspaces (Boolean) –
- DuplicatePluginUnderMouse() Autotype¶
Duplicates the plugin - if any - under the mouse
- GlobalRackspaceVisible() Autotype¶
Indicates whether the global rackspace is visible
- Return type
- Next() Autotype¶
Switch to next rackspace variation song or song part
- Previous() Autotype¶
Switch to previous rackspace variation song or song part
- QuickReplacePluginUnderMouse() Autotype¶
Use dialog to replace the plugin - if any - under the mouse
- RemovePluginUnderMouse() Autotype¶
Removes the plugin - if any - under the mouse
- ShowGlobalRackspace(show) Autotype¶
Show or hide the global rackspace view
- Parameters
show (Boolean) –
- SwitchToPanelView() Autotype¶
Show the rackspace panel view
- SwitchToSetlistView() Autotype¶
Show the song view
- SwitchToWiringView() Autotype¶
Switch to the plugin block wiring view
- ToggleTunerVisible() Autotype¶
Switch in or out of tuner view
Arrays¶
- AppendBoolean(a, value) Autotype¶
Append the boolean to the end of the array if there is room otherwise fail silently
Deprecated
Use
<--operator instead
- AppendDouble(a, value) Autotype¶
Append the double to the end of the array if there is room otherwise fail silently
Deprecated
Use
<--operator instead
- AppendInteger(a, value) Autotype¶
Append the integer to the end of the array if there is room otherwise fail silently
Deprecated
Use
<--operator instead
- AppendString(a, value) Autotype¶
Append the string to the end of the array if there is room otherwise fail silently
Deprecated
Use
<--operator instead
- ClearArray(a) Autotype¶
Resets the array size to 0
- Parameters
a (array) –
- IndexOf(a, value) Autotype¶
Returns the index containing the value otherwise returns -1
- LargestDouble(a) Autotype¶
Returns the maximum value of a double array
- LargestInt(a) Autotype¶
Returns the maximum value in an integer array
- RemoveLast(a) Autotype¶
Remove the last item in the array and so reducing the array size by 1
- Parameters
a (array) –
- Reverse(a) Autotype¶
Reverse the list of items in the array
- Parameters
a (array) –
- SmallestDouble(a) Autotype¶
Returns the minimum value in a double array
- SmallestInt(a) Autotype¶
Returns the minimum value in an integer array
- Sort(a, ascending) Autotype¶
Sorts an array in ascending order
- Parameters
a (array) –
ascending (Boolean) –
- iMax(a) Autotype¶
Returns the index of the largest value of an array
- Parameters
a (array) –
- Return type
ChordPro¶
- ChordPro_GoToFractionOfPage(fraction) Autotype¶
Set the top of the Chord Pro window to some fraction of the total page
- Parameters
fraction (Double) –
- ChordPro_GotoLine(lineNumber) Autotype¶
Set the top of the Chord Pro window to the given line number
- Parameters
lineNumber (Integer) –
ExternalApplication¶
- EA_AddArgument(ea, arg) Autotype¶
Add an argument to an external application manager
- Parameters
ea (ExternalApplication) –
arg (String) –
- EA_ClearAllArgs(ea) Autotype¶
Clear the list of arguments so you can start again
- Parameters
ea (ExternalApplication) –
- EA_SetProgramName(ea, name) Autotype¶
Set the name of the program to be run
- Parameters
ea (ExternalApplication) –
name (String) –
- EA_Start(ea) Autotype¶
Open or run the external application
- Parameters
ea (ExternalApplication) –
- EA_Stop(ea) Autotype¶
Close or terminate the external application - not guaranteed to work
- Parameters
ea (ExternalApplication) –
Generators¶
- EnableGenerator(f, enable) Autotype¶
Enables or disables any generator (LFO, ramp, squarewave, ADSR, etc)
- GetADSRAttackLevel(f) Autotype¶
Get the maximum volume level of the attack phase of an ADSR
- GetADSRAttackTime(f) Autotype¶
Get the time in milliseconds of the attack phase of an ADSR
- GetADSRDecayTime(f) Autotype¶
Get the time in milliseconds of the decay phase of an ADSR
- GetADSRReleaseTime(f) Autotype¶
Get the time in milliseconds of the total release time of an ADSR
- GetADSRSustainLevel(f) Autotype¶
Get the level of the sustain phase of an ADSR
- GetGeneraterAmplitude(f) Autotype¶
Get the current value of a generator
Deprecated
- GetGeneratorAmplitude(f) Autotype¶
Get the current value of a generator
- GetTimersRunning() Autotype¶
Indicates whether global timers are running or stopped
- Return type
- InitADSR(f, attackTime, attackLevel, decayTime, sustainLevel, releaseTime) Autotype¶
Set all parameters of an ADSR in one function call
- IsGeneratorEnabled(f) Autotype¶
Queries the state (start or stopped) of any generator
- SetADSRAttackLevel(f, level) Autotype¶
Set the maximum volume level of the attack phase of an ADSR
- SetADSRAttackTime(f, milliseconds) Autotype¶
Set the time in milliseconds of the attack phase of an ADSR
- SetADSRDecayTime(f, milliseconds) Autotype¶
Set the time in milliseconds of the decay phase of an ADSR
- SetADSRReleaseTime(f, milliseconds) Autotype¶
Set the time in milliseconds of the total release time of an ADSR
- SetADSRSustainLevel(f, level) Autotype¶
Set the level of the sustain phase of an ADSR
- SetGeneratorCoarseness(f, milliseconds) Autotype¶
Controls the jitter time of a callback (trading off accuracy against CPU cycles)
- SetGeneratorFrequency(f, hertz) Autotype¶
Set the frequency in cycles/second of any Generator
- SetGeneratorLength(f, milliseconds) Autotype¶
Set the length of a generator cycle
- SetGeneratorOneShot(f, oneshot) Autotype¶
Controls whether an Generator repeats indefinitely or only runs once when triggered
MIDI¶
- AllNotesOff(p) Autotype¶
Send All Notes Off and reset controllers
- Parameters
p (MidiInBlock) –
- AllNotesOff() Autotype
Send All Notes Off and reset controllers
- BetweenNotes(lowerNote, note, upperNote) Autotype¶
Returns true if the MIDI Note message is between the lower and higher values exclusive
- Parameters
lowerNote (Integer) –
note (NoteMessage) –
upperNote (Integer) –
- Return type
- GetAfterTouchValue(m) Autotype¶
Returns the current aftertouch value of an Aftertouch MIDI message
- Parameters
m (AfterTouchMessage) –
- Return type
- GetByte(m, byteNumber) Autotype¶
Returns one of the byte values of a MIDI message. The byteNumber must be within the range 0..2
- Parameters
m (MidiMessage) –
byteNumber (Integer) –
- Return type
- GetCCNumber(m) Autotype¶
Returns the Controller Number of a ControlChange MIDI message
- Parameters
m (ControlChangeMessage) –
- Return type
- GetCCValue(m) Autotype¶
Returns the Controller value of a ControlChange MIDI message
- Parameters
m (ControlChangeMessage) –
- Return type
- GetChannel(m) Autotype¶
Returns the MIDI channel number (between 1 and 16) of any MIDI message
- Parameters
m (MidiMessage) –
- Return type
- GetMidiInDeviceCount() Autotype¶
Returns the number of available MIDI In Devices
- Return type
- GetMidiInDeviceFromRigManager(rmDeviceName) Autotype¶
Find the name of a physical MidiIn device given its RigManager name
- GetMidiInDeviceName(index) Autotype¶
Returns the name of the MIDI In Device at the specified index
- GetMidiMessageSize(m) Autotype¶
Returns the number of bytes in any MIDI Message
- Parameters
m (MidiMessage) –
- Return type
- GetMidiOutDeviceCount() Autotype¶
Returns the number of available MIDI Out Devices
- Return type
- GetMidiOutDeviceName(index) Autotype¶
Returns the name of the MIDI Out Device at the specified index
- GetNoteNumber(m) Autotype¶
Returns the note number of a NoteMessage MIDI event
- Parameters
m (NoteMessage) –
- Return type
- GetPitchBendValue(m) Autotype¶
Returns the pitch bend value from a PitchBend MIDI message
- Parameters
m (PitchBendMessage) –
- Return type
- GetPolyTouchNoteNumber(m) Autotype¶
Returns the note number of a PolyTouch MIDI event
- Parameters
m (PolyTouchMessage) –
- Return type
- GetProgramChangeNumber(m) Autotype¶
Returns the program change number of a ProgramChangeMessage MIDI event
- Parameters
m (ProgramChangeMessage) –
- Return type
- GetReleaseVelocity(m) Autotype¶
Returns the release velocity of a NoteOffEvent MIDI message. You need to make sure that the message is in fact a NoteOff or the result will always be 0
- Parameters
m (NoteMessage) –
- Return type
- GetVelocity(m) Autotype¶
Returns the velocity of a NoteEvent MIDI message. The value will be between 0 and 127
- Parameters
m (NoteMessage) –
- Return type
- InjectMidiEvent(physicalDeviceName, m) Autotype¶
Inject a message to any Midi Input Port with the specified physical device name
- Parameters
physicalDeviceName (String) –
m (MidiMessage) –
- InjectMidiEventViaRigManager(rmDeviceAliasName, m) Autotype¶
Inject a message to a MidiInDeviceAlias using its Rig Manager name directly
- Parameters
rmDeviceAliasName (MidiInDeviceAlias) –
m (MidiMessage) –
- IsAfterTouch(m) Autotype¶
See if the current message is actually an Aftertouch MIDI message
- Parameters
m (MidiMessage) –
- Return type
- IsController(m) Autotype¶
See if the current message is actually a CC MIDI message
- Parameters
m (MidiMessage) –
- Return type
- IsNote(m) Autotype¶
See if the current message is a NoteOn or a NoteOff message
- Parameters
m (MidiMessage) –
- Return type
- IsNoteOff(m) Autotype¶
See if the current message is actually a noteOff message - this is not the same as a NoteOn with 0 velocity
- Parameters
m (MidiMessage) –
- Return type
- IsNoteOn(m) Autotype¶
See if the current message is actually a noteOn message
- Parameters
m (MidiMessage) –
- Return type
- IsPitchBend(m) Autotype¶
See if the current message is actually a pitchbend message
- Parameters
m (MidiMessage) –
- Return type
- IsPolyTouch(m) Autotype¶
See if the current message is actually a Polytouch MIDI message
- Parameters
m (MidiMessage) –
- Return type
- IsProgramChange(m) Autotype¶
See if the current message is actually a program change message
- Parameters
m (MidiMessage) –
- Return type
- MakeAfterTouchMessage(value) Autotype¶
Returns an Aftertouch MIDI message with the specified value. The MIDI channel is 1
- Parameters
value (Integer) –
- Return type
- MakeAfterTouchMessageEx(value, channel) Autotype¶
Returns an Aftertouch MIDI message with the specified value and MIDI channel
- Parameters
- Return type
- MakeControlChangeMessage(number, value) Autotype¶
Returns a CC MIDI message with the specified CC number and value. The MIDI channel is 1
- Parameters
- Return type
- MakeControlChangeMessageEx(number, value, channel) Autotype¶
Returns a CC MIDI message with the specified CC number and value and MIDI channel
- Parameters
- Return type
- MakeMidiMessage(byte0, byte1, byte2) Autotype¶
Create an three byte MIDI message - you are on your own so make sure you get the values correct
Deprecated
- Parameters
- Return type
- MakeMidiMessage1(byte0) Autotype¶
Create one byte MIDI message - you are on your own so make sure you get the value correct
- Parameters
byte0 (Integer) –
- Return type
- MakeMidiMessage2(byte0, byte1) Autotype¶
Create a 2 byte MIDI message - you are on your own so make sure you get the values correct
- Parameters
- Return type
- MakeMidiMessage3(byte0, byte1, byte2) Autotype¶
Create an three byte MIDI message - you are on your own so make sure you get the values correct
- Parameters
- Return type
- MakeNoteMessage(number, velocity) Autotype¶
Returns a Note MIDI message with the specified note number and velocity. The MIDI channel is 1
- Parameters
- Return type
- MakeNoteMessageEx(number, velocity, channel) Autotype¶
Returns a Note MIDI message with the specified note number and velocity and MIDI channel
- Parameters
- Return type
- MakePitchBendMessage(value) Autotype¶
Returns a new Pitchbend MIDI message with the specified value. The MIDI channel is 1
- Parameters
value (Integer) –
- Return type
- MakePitchBendMessageEx(value, channel) Autotype¶
Returns a new Pitchbend MIDI message with the specified value and MIDI channel
- Parameters
- Return type
- MakePolyTouchMessage(number, pressure) Autotype¶
Returns a Polytouch MIDI message with the specified note number and pressure amount. The MIDI channel is 1
- Parameters
- Return type
- MakePolyTouchMessageEx(number, pressure, channel) Autotype¶
Returns a Polytouch - sometimes called poly pressure - MIDI message with the specified note number and pressure ammount and MIDI channel
- Parameters
- Return type
- MakeProgramChangeMessage(value) Autotype¶
Returns a new ProgramChange MIDI message with the specified value ranging from 0 to 127. The MIDI channel is 1
- Parameters
value (Integer) –
- Return type
- MakeProgramChangeMessageEx(value, channel) Autotype¶
Returns a new ProgramChange MIDI message with the specified value ranging from 0 to 127 and with the specified MIDI channel
- Parameters
- Return type
- MidiInDeviceExists(deviceName) Autotype¶
Returns whether the physical MIDI in device exists
- MidiOutDeviceExists(deviceName) Autotype¶
Returns whether the physical MIDI Out device exists
- ReinterpretAsAfterTouch(m, UseThirdByte) Autotype¶
Reinterpret an arbitrary MIDI message - you need to know what you are doing
- Parameters
m (MidiMessage) –
UseThirdByte (Boolean) –
- Return type
- ReinterpretAsControllerMessage(m) Autotype¶
Reinterpret an arbitrary MIDI message - you need to know what you are doing
- Parameters
m (MidiMessage) –
- Return type
- ReinterpretAsNoteOffMessage(m) Autotype¶
Reinterpret an arbitrary MIDI message - you need to know what you are doing
- Parameters
m (MidiMessage) –
- Return type
- ReinterpretAsNoteOnMessage(m) Autotype¶
Reinterpret an arbitrary MIDI message - you need to know what you are doing
- Parameters
m (MidiMessage) –
- Return type
- ReinterpretAsPitchBend(m) Autotype¶
Reinterpret an arbitrary MIDI message - you need to know what you are doing
- Parameters
m (MidiMessage) –
- Return type
- ReinterpretAsPolyTouchMessage(m) Autotype¶
Reinterpret an arbitrary MIDI message - you need to know what you are doing
- Parameters
m (MidiMessage) –
- Return type
- ReinterpretAsProgramChange(m, UseThirdByte) Autotype¶
Reinterpret an arbitrary MIDI message - you need to know what you are doing
- Parameters
m (MidiMessage) –
UseThirdByte (Boolean) –
- Return type
- SendNow(p, m) Autotype¶
Send a MIDI event out immediately
- Parameters
p (MidiInBlock) –
m (MidiMessage) –
- SendNowToMidiOutDevice(deviceName, m) Autotype¶
Send a MIDI event out immediately through a physical MIDI Out device
- Parameters
deviceName (String) –
m (MidiMessage) –
- Transpose(m, steps) Autotype¶
Returns a note that has been transposed chromatically by the number of steps
Deprecated
Use
WithTranspose()- Parameters
m (NoteMessage) –
steps (Integer) –
- Return type
- WithCCNumber(m, number) Autotype¶
Changes the CC number of a ControlChangeMessage MIDI event
- Parameters
m (ControlChangeMessage) –
number (Integer) –
- Return type
- WithCCValue(m, v) Autotype¶
Changes the value of a CCMessage MIDI event
- Parameters
m (ControlChangeMessage) –
v (Integer) –
- Return type
- WithChannel(m, channel) Autotype¶
Changes the channel number of any MIDI event.
- Parameters
m (MidiMessage) –
channel (Integer) –
- Return type
- WithNoteNumber(m, number) Autotype¶
Changes the note number of a NoteMessage MIDI event
- Parameters
m (NoteMessage) –
number (Integer) –
- Return type
- WithNoteNumberAndVelocity(m, n, v) Autotype¶
Changes the note number and the velocity value of a NoteMessage MIDI event. Setting to 0 will make the message be a NoteOff
- Parameters
m (NoteMessage) –
n (Integer) –
v (Integer) –
- Return type
- WithTranspose(m, steps) Autotype¶
Returns a note that has been transposed chromatically by the number of steps
- Parameters
m (NoteMessage) –
steps (Integer) –
- Return type
- WithVelocity(m, v) Autotype¶
Changes the velocity value of a NoteMessage MIDI event. Setting to 0 will make the message be a NoteOff
- Parameters
m (NoteMessage) –
v (Integer) –
- Return type
Math¶
- CC_LoadFromFile(cc, filename) Autotype¶
Load a curve that was created with a Curve Component
- Parameters
cc (CurveComponent) –
filename (String) –
- Return type
- CC_SaveToFile(cc, filename) Autotype¶
Save a possibly changed curve to file
- Parameters
cc (CurveComponent) –
filename (String) –
- Return type
- CC_Scale(cc, x) Autotype¶
Return the Y value for the inputted x value
- Parameters
cc (CurveComponent) –
x (Double) –
- Return type
- Ceiling(x) Autotype¶
Rounds x upward returning the smallest integral value that is not less than x
- Floor(x) Autotype¶
Rounds x downward returning the largest integral value that is not greater than x
- IntToFloat(x) Autotype¶
Converts an integer to its floating point equivalent
- MidiToParam(m) Autotype¶
Maps an integer value between 0 and 127 into a floating point value between 0.0 and 1.0 and is a specialized (slightly) faster version of the generic Scale function
- MidiToParamEx(x, xMin, xMax, yMin, yMax) Autotype¶
Maps a value between xMin and xMax both with type integer into a value between yMin and yMax both with type double. Slightly faster than Scale if you can use the expected types so that no conversion is required
- ParamToMidi(m) Autotype¶
Maps an double value between 0.0 and 1.0 into an integer value between 0 and 127 and is a specialized (slightly) faster version of the generic Scale function
- ParamToMidiEx(x, xMin, xMax, yMin, yMax) Autotype¶
Maps a double value between xMin and xMax - both between 0.0 and 1.0 - into a value between yMin and yMax both with type integer. Slightly faster than Scale if you can use the expected types so that no conversion is required
- Power(base, exponent) Autotype¶
Returns base raised to the power of exponent
- RandomRange(min, max) Autotype¶
Returns a random integer value between min and max
- Round(x) Autotype¶
Rounds a floating point number to the nearest integer
- Scale(x, xMin, xMax, yMin, yMax) Autotype¶
Maps a value between xMin and xMax into a value between yMin and yMax. Integers will be converted to doubles. See MidiToParam and ParamToMidi for slightly faster implementations
- ScaleInt(x, xMin, xMax, yMin, yMax) Autotype¶
Maps a value between xMin and xMax into a value between yMin and yMax. Doubles will be truncated to integers. See MidiToParam and ParamToMidi for slightly faster implementations
- ScaleRange(x, yMin, yMax) Autotype¶
Maps a double value between 0.0 and 1.0 into a rounded integer value between yMin and yMax
- ScaleRangeEx(x, xMin, xMax, yMin, yMax) Autotype¶
Maps a double value between xMin and xMax into a rounded integer value between yMin and yMax
- Sign(x) Autotype¶
Returns 1 if x > 0 -1 if x < 0 0 if x = 0
- ThresholdDetector_Detect(td, newValue) Autotype¶
Return true if we crossed over
- Parameters
td (ThresholdDetector) –
newValue (Double) –
- Return type
- ThresholdDetector_Setup(td, crossOver, initialValue, upDirection) Autotype¶
Define the conditions to detect an edge
- Parameters
td (ThresholdDetector) –
crossOver (Double) –
initialValue (Double) –
upDirection (Boolean) –
MultiChannelNoteTracker¶
- MultiChannelNoteTracker_Clear(mt, channel) Autotype¶
Reinitializes the note tracker for the specified channel
- Parameters
mt (MultiChannelNoteTracker) –
channel (Integer) –
- MultiChannelNoteTracker_GetHeldNotes(mt, channel) Autotype¶
returns all currently held down notes as an integer array without velocities
- Parameters
mt (MultiChannelNoteTracker) –
channel (Integer) –
- Return type
Integer array
- MultiChannelNoteTracker_GetSpecificNoteOnCount(mt, noteNumber, channel) Autotype¶
Count how many times a specific note on has been played without a corresponding note off
- Parameters
mt (MultiChannelNoteTracker) –
noteNumber (Integer) –
channel (Integer) –
- Return type
- MultiChannelNoteTracker_GotNote(mt, note) Autotype¶
Track status of an incoming note
- Parameters
mt (MultiChannelNoteTracker) –
note (NoteMessage) –
- MultiChannelNoteTracker_GotNoteOff(mt, noteNumber, channel) Autotype¶
Remember that a note was released
- Parameters
mt (MultiChannelNoteTracker) –
noteNumber (Integer) –
channel (Integer) –
- MultiChannelNoteTracker_GotNoteOn(mt, noteNumber, channel) Autotype¶
Remember that a note was played
- Parameters
mt (MultiChannelNoteTracker) –
noteNumber (Integer) –
channel (Integer) –
- MultiChannelNoteTracker_IsNoteOffPending(mt, noteNumber, channel) Autotype¶
returns whether a specific note is still down
- Parameters
mt (MultiChannelNoteTracker) –
noteNumber (Integer) –
channel (Integer) –
- Return type
- MultiChannelNoteTracker_NoteOnCount(mt, channel) Autotype¶
Count number of notes still being played
- Parameters
mt (MultiChannelNoteTracker) –
channel (Integer) –
- Return type
- MultiChannelNoteTracker_StopAllPendingNotes(m, nt) Autotype¶
Send note offs for all pending notes on all channels in the tracker
- Parameters
m (MidiInBlock) –
nt (NoteTracker) –
- MultiChannelNoteTracker_StopAllPendingNotes(nt) Autotype
Send note offs for all pending notes on all channels in the tracker
- Parameters
nt (MultiChannelNoteTracker) –
NoteManagement¶
- AddChordInterval(cr, interval, chordName) Autotype¶
Add a user defined chord interval to the chord dictionary
- Parameters
cr (ChordRecognizer) –
interval (Integer array) –
chordName (String) –
- AutoSustainer_GetHeldNotes(sustainer) Autotype¶
returns all currently held down notes as an integer array without velocities - experimental
- Parameters
sustainer (AutoSustainer) –
- Return type
Integer array
- AutoSustainer_Play(sustainer, m) Autotype¶
Play and sustain an incoming note message through the AutoSustainer
- Parameters
sustainer (AutoSustainer) –
m (NoteMessage) –
- AutoSustainer_RespectParameters(sustainer, respect) Autotype¶
Indicate whether notes should respect MidiInBlock parameters
- Parameters
sustainer (AutoSustainer) –
respect (Boolean) –
- AutoSustainer_SetTarget(sustainer, m) Autotype¶
Specify the MidiInBlock to use for sending out notes using this AutoSustainer object
- Parameters
sustainer (AutoSustainer) –
m (MidiInBlock) –
- AutoSustainer_Stop(sustainer) Autotype¶
Stop all pending notes
- Parameters
sustainer (AutoSustainer) –
- FindChordName(cr, nt) Autotype¶
Given a note tracker with pending notes - get the string name of the chord
- Parameters
cr (ChordRecognizer) –
nt (NoteTracker) –
- Return type
- NoteMapper_CreateScale(nm, rootNote, scale) Autotype¶
Given a root note and an array of 12 offsets - create a scale covering the entire MIDI note range
- Parameters
nm (NoteMapper) –
rootNote (Integer) –
scale (Integer array) –
- NoteMapper_GetMappedNotes(nm, note) Autotype¶
Returns the note or chord associated with the incoming note
- Parameters
nm (NoteMapper) –
note (Integer) –
- Return type
Integer array
- NoteMapper_MapNote(nm, note, mapToNote) Autotype¶
Define note to be returned given an incoming note
- Parameters
nm (NoteMapper) –
note (Integer) –
mapToNote (Integer) –
- NoteMapper_MapNoteToChord(nm, note, chord) Autotype¶
Associate a note with a chord
- Parameters
nm (NoteMapper) –
note (Integer) –
chord (Integer array) –
- NoteMapper_MapNotes(nm, source, dest) Autotype¶
Map a list of source notes to replacement notes - both arrays must be same size
- Parameters
nm (NoteMapper) –
source (Integer array) –
dest (Integer array) –
- NoteMapper_Reset(nm) Autotype¶
Reset note mapper to defaults
- Parameters
nm (NoteMapper) –
- RemoveChordInterval(cr, interval) Autotype¶
Remove a chord interval from the chord dictionary
- Parameters
cr (ChordRecognizer) –
interval (Integer array) –
NoteTracker¶
- ClearNoteTracker(nt) Autotype¶
Reinitializes the note tracker although it is generally not necessary
Deprecated
- Parameters
nt (NoteTracker) –
- GotNote(nt, note) Autotype¶
Track status of an incoming note
Deprecated
- Parameters
nt (NoteTracker) –
note (NoteMessage) –
- GotNoteOff(nt, noteNumber) Autotype¶
Remember that a note was released
Deprecated
- Parameters
nt (NoteTracker) –
noteNumber (Integer) –
- GotNoteOn(nt, noteNumber) Autotype¶
Remember that a note was played
Deprecated
- Parameters
nt (NoteTracker) –
noteNumber (Integer) –
- NoteOnCount(nt) Autotype¶
Count number of notes still being played
Deprecated
- Parameters
nt (NoteTracker) –
- Return type
- NoteTracker_Clear(nt) Autotype¶
Reinitializes the note tracker although it is generally not necessary
- Parameters
nt (NoteTracker) –
- NoteTracker_GetHeldNotes(nt) Autotype¶
returns all currently held down notes as an integer array without velocities
- Parameters
nt (NoteTracker) –
- Return type
Integer array
- NoteTracker_GetSpecificNoteOnCount(nt, noteNumber) Autotype¶
Count how many times a specific note on has been played without a corresponding note off
- Parameters
nt (NoteTracker) –
noteNumber (Integer) –
- Return type
- NoteTracker_GotNote(nt, note) Autotype¶
Track status of an incoming note
- Parameters
nt (NoteTracker) –
note (NoteMessage) –
- NoteTracker_GotNoteOff(nt, noteNumber) Autotype¶
Remember that a note was released
- Parameters
nt (NoteTracker) –
noteNumber (Integer) –
- NoteTracker_GotNoteOn(nt, noteNumber) Autotype¶
Remember that a note was played
- Parameters
nt (NoteTracker) –
noteNumber (Integer) –
- NoteTracker_IsNoteOffPending(nt, noteNumber) Autotype¶
returns whether a specific note is still down
- Parameters
nt (NoteTracker) –
noteNumber (Integer) –
- Return type
- NoteTracker_NoteOnCount(nt) Autotype¶
Count number of notes still being played
- Parameters
nt (NoteTracker) –
- Return type
- NoteTracker_StopAllPendingNotes(m, nt) Autotype¶
Send note offs for all pending notes in the tracker
- Parameters
m (MidiInBlock) –
nt (NoteTracker) –
- NoteTracker_StopAllPendingNotes(nt) Autotype
Send note offs for all pending notes in the tracker
- Parameters
nt (NoteTracker) –
- StopAllPendingNotes(m, nt) Autotype¶
Send note offs for all pending notes in the tracker
Deprecated
- Parameters
m (MidiInBlock) –
nt (NoteTracker) –
- StopAllPendingNotes(nt) Autotype
Send note offs for all pending notes in the tracker
Deprecated
- Parameters
nt (NoteTracker) –
OSC¶
- OSC_AppendDoubleArg(m, value) Autotype¶
Append a double argument to the OSC message
- Parameters
m (OSCMessage) –
value (Double) –
- OSC_AppendIntArg(m, value) Autotype¶
Append an integer argument to the OSC message
- Parameters
m (OSCMessage) –
value (Integer) –
- OSC_AppendStringArg(m, value) Autotype¶
Append a string argument to the OSC message
- Parameters
m (OSCMessage) –
value (String) –
- OSC_ArgCount(m) Autotype¶
Returns the number of arguments in an OSC message
- Parameters
m (OSCMessage) –
- Return type
- OSC_ClearArgs(m) Autotype¶
Clear all arguments but leave the address pattern
- Parameters
m (OSCMessage) –
- OSC_GetArgAsDouble(m, index) Autotype¶
Returns the argument at the index - 0 based - as a double
- Parameters
m (OSCMessage) –
index (Integer) –
- Return type
- OSC_GetArgAsInteger(m, index) Autotype¶
Returns the argument at the index - 0 based - as an integer
- Parameters
m (OSCMessage) –
index (Integer) –
- Return type
- OSC_GetArgAsString(m, index) Autotype¶
Returns the argument at the index - 0 based - as a String
- Parameters
m (OSCMessage) –
index (Integer) –
- Return type
- OSC_GetGPListeningPort() Autotype¶
Return the port on which GP listens for incoming OSC messages
- Return type
- OSC_Send(m) Autotype¶
Send out the message to the default IP address and port
- Parameters
m (OSCMessage) –
- OSC_SendDouble(address, value) Autotype¶
Send an OSC message with a value of type double to the default ip address and port
- OSC_SendDoubleSpecific(address, value, ipAddress, port) Autotype¶
Send an OSC message with a value of type double to the specified ip address and port
- OSC_SendInteger(address, value) Autotype¶
Send an OSC message with a value of type integer to the default ip address and port
- OSC_SendIntegerSpecific(address, value, ipAddress, port) Autotype¶
Send an OSC message with a value of type integer to the specified ip address and port
- OSC_SendSpecific(m, ipAddress, port) Autotype¶
Send out the message to the specified IP address and port
- Parameters
m (OSCMessage) –
ipAddress (String) –
port (Integer) –
- OSC_SendString(address, value) Autotype¶
Send an OSC message with a value of type String to the default ip address and port
- OSC_SendStringSpecific(address, value, ipAddress, port) Autotype¶
Send an OSC message with a value of type String to the specified ip address and port
- OSC_SetAddress(m, address) Autotype¶
Set the address of an OSC message
- Parameters
m (OSCMessage) –
address (String) –
Plugins¶
- GUI_CreateNewWidget(left, top, width, height) Autotype¶
Returns ID of new widget
- GetActivePreset(p) Autotype¶
Get the index of the current preset in the plugin block
- GetGPPresetList(p, chunkN) Autotype¶
Get the Nth chunk of GP Preset names
- GetGPPresetListCount(p) Autotype¶
Returns the number of GP Presets for this plugin
- GetMaxNoteFromMidiInBlock(aBlock) Autotype¶
Gets the max note number defined for the keyboard split
- Parameters
aBlock (MidiInBlock) –
- Return type
- GetMinNoteFromMidiInBlock(aBlock) Autotype¶
Gets the min note number defined for the keyboard split
- Parameters
aBlock (MidiInBlock) –
- Return type
- GetParameter(p, index) Autotype¶
Gets the current parameter value associated with a parameter index of the plugin block. The value will be between 0.0 and 1.0
- GetParameterCount(p) Autotype¶
Gets the number of parameters in the plugin block
- GetParameterName(p, index) Autotype¶
Gets the name for the parameter index of the plugin block if available.
- GetParameterText(p, index) Autotype¶
Gets the value as text of the given parameter index of the plugin block if available.
- GetPluginCaption(p) Autotype¶
Gets the caption displayed in the plugin block
- GetPluginInfo(p, infoCode) Autotype¶
Get information about the actual plugin — 0=name - 1=manufacturer
- GetPresetCount(p) Autotype¶
Get the number of available presets in the plugin block
- GetPresetName(p, index) Autotype¶
Get the name of the preset at the given index of the plugin block
- GetTransposeFromMidiInBlock(aBlock) Autotype¶
Gets the max note number defined for the keyboard split
- Parameters
aBlock (MidiInBlock) –
- Return type
- GetVelocityCurveValue(aBlock, velocity) Autotype¶
Returns the velocity after applying the scale curve to it
- Parameters
aBlock (MidiInBlock) –
velocity (Integer) –
- Return type
- IsPluginBypassed(p) Autotype¶
Returns whether the plugin block is bypassed
- LoadGPPreset(p, presetName) Autotype¶
Load a GP plugin preset in the background - seriously experimental and probably very unsafe
- ReplacePlugin(p, name) Autotype¶
Replace the plugin in the specified block - experimental
- SelectPreset(p, index) Autotype¶
Change the preset of the block - experimental
- SetParameter(p, index, value) Autotype¶
Send a parameter value to the plugin block
- SetPluginBypassed(p, bypass) Autotype¶
Bypass or unbypass the plugin block
- SetPluginCaption(p, newCaption) Autotype¶
Sets the caption displayed in the plugin block
Rackspaces¶
- GetRackspaceIndex(name) Autotype¶
Returns the name of the rackspace at the given index. Returns -1 if rackspace does not exist
- GetRackspaceNameAtIndex(index) Autotype¶
Returns the name of the rackspace at the given index
- GetVariationCount() Autotype¶
Returns the number of variations in the current rackspace
- Return type
- GetVariationCountForRackspaceAtIndex(rackspaceIndex) Autotype¶
Returns the number of variations in a specified rackspace
- GetVariationName(index) Autotype¶
Returns the name of a variation
- GetVariationNameForRackspaceAtIndex(rackspaceIndex, variationIndex) Autotype¶
Returns the name of a variation in a specified rackspace
- NextRackspace() Autotype¶
Switch to the next rackspace
- NextVariation() Autotype¶
Switch to the next variation
- PreviousRackspace() Autotype¶
Switch to the previous rackspace
- PreviousVariation() Autotype¶
Switch to the previous variation
- SetVariation(index) Autotype¶
Switch to another variation in the active rackspace
- Parameters
index (Integer) –
- SwitchToNextRack() Autotype¶
Switch to the next rackspace
Deprecated
Use
NextRackspace()instead.
- SwitchToNextVariation() Autotype¶
Switch to the next variation
Deprecated
Use
NextVariation()instead.
- SwitchToPreset(newPreset) Autotype¶
Switch to another preset in the rackspace
Deprecated
Use
SetVariation()instead.- Parameters
newPreset (Integer) –
- SwitchToPrevRack() Autotype¶
Switch to the previous rackspace
Deprecated
Use
PreviousRackspace()instead.
- SwitchToPrevVariation() Autotype¶
Switch to the previous variation
Deprecated
Use
PreviousVariation()instead.
- SwitchToRack(newRackspaceNumber, newPreset) Autotype¶
Switch to another rackspace by number and potentially to a specific newPreset in that rackspace
Deprecated
Use
SwitchToRackspace()instead.
- SwitchToRackspace(newRackspaceNumber, newVariationNumber) Autotype¶
Switch to another rackspace by number and potentially to a specific variation in that rackspace
- SwitchToRackspaceByName(name, newVariationNumber) Autotype¶
Switch to another rackspace by name and potentially to a specific variation in that rackspace
ScriptletBlock¶
- GetContinuousPreviousValue(p) Autotype¶
Get the previous value of this parameter
- Parameters
p (Continuous) –
- Return type
- GetDiscreteParameterItem(p, offset) Autotype¶
Returns the string item at the given offset for this parameter
- GetDiscreteParameterItemCount(p) Autotype¶
Returns the number of strings defined for this parameter
- GetDiscretePreviousValue(p) Autotype¶
Get the previous value of this parameter
- GetIndexOfDiscreteParameterItem(p, itemToFind) Autotype¶
Find the index of a discrete item and returns -1 if the item is not found
- GetIndexOfSubrangeParameterItem(p, itemToFind) Autotype¶
Find the index of a subrange item and returns -1 if the item is not found
- GetParameterCount() Autotype
Get the number of parameters
- Return type
- GetParameterName(p) Autotype
Returns the name of the parameter - preferring the alias if defined
- GetSubrangeParameterItem(p, offset) Autotype¶
Returns the integer item at the given offset for this parameter
- GetSubrangeParameterItemCount(p) Autotype¶
Returns the number of integer values defined for this parameter
- GetSubrangePreviousValue(p) Autotype¶
Get the previous value of this parameter
- PlayNote(noteNumber, velocity, channel, startTimeMS, duration) Autotype¶
Send a noteOn event at startTimeMS and a noteOff event at durationMS later. If duration is less than 1 then we make it 1
- PlayNotes(noteNumbers, velocity, channel, startTimeMS, duration) Autotype¶
Play a collection of note at startTimeMS and stop them durationMS later. If duration is less than 1 then we make it 1
- SendLater(m, delayInMS) Autotype¶
Schedule a MIDI event to be sent out in the future - only for use in a Scriptlet
- Parameters
m (MidiMessage) –
delayInMS (Double) –
- SendNotesNow(noteNumbers, velocity, channel) Autotype¶
Play a collection of notes now
- SendNow(m) Autotype
Send a MIDI event out immediately - only for use in a Scriptlet
- Parameters
m (MidiMessage) –
- SendSysexNow(m) Autotype¶
Send a MIDI sysex message out immediately
- Parameters
m (SysexMessage) –
Sequencing¶
- MidiSequence_CollectEventsNow(sequence) Autotype¶
Collect events at the current position - Experimental - not yet supported - do not even ask!
- Parameters
sequence (MidiSequence) –
- MidiSequence_EndOfSong(sequence) Autotype¶
True if there are no more events in track - Experimental - not yet supported - do not even ask!
- Parameters
sequence (MidiSequence) –
- Return type
- MidiSequence_FollowGlobalTranspose(sequence, trackNumber, follow) Autotype¶
When true MIDI note events will be transposed by the global transpose amount
- Parameters
sequence (MidiSequence) –
trackNumber (Integer) –
follow (Boolean) –
- MidiSequence_GetCurrentBar(sequence) Autotype¶
Returns the current bar - Experimental - not yet supported - do not even ask!
- Parameters
sequence (MidiSequence) –
- Return type
- MidiSequence_GetCurrentBeat(sequence) Autotype¶
Returns the current beat of the current bar - Experimental - not yet supported - do not even ask!
- Parameters
sequence (MidiSequence) –
- Return type
- MidiSequence_GetCurrentEvents(sequence, trackNumber) Autotype¶
Access the current events at the current grid position for the specified track - Experimental - not yet supported - do not even ask!
- Parameters
sequence (MidiSequence) –
trackNumber (Integer) –
- Return type
MidiMessage array
- MidiSequence_GetCurrentTick(sequence) Autotype¶
Returns the current tick offset - Experimental - not yet supported - do not even ask!
- Parameters
sequence (MidiSequence) –
- Return type
- MidiSequence_GetResolution(sequence) Autotype¶
Get the base resolution of the sequence - Experimental - not yet supported - do not even ask!
- Parameters
sequence (MidiSequence) –
- MidiSequence_GetTrackCount(sequence) Autotype¶
Returns the number of tracks in a loaded MIDI file - Experimental - not yet supported - do not even ask!
- Parameters
sequence (MidiSequence) –
- Return type
- MidiSequence_LoadMidiFile(sequence, fromFile) Autotype¶
Loads a midi file and returns the number of tracks - Experimental - not yet supported - do not even ask!
- Parameters
sequence (MidiSequence) –
fromFile (String) –
- Return type
- MidiSequence_MapOutputChannel(sequence, trackNumber, channel) Autotype¶
Map the output channel for a track to the specified number between 1-16. Set to 0 to use individual event channel - Experimental - not yet supported - do not even ask!
- Parameters
sequence (MidiSequence) –
trackNumber (Integer) –
channel (Integer) –
- MidiSequence_Quantize(sequence, q) Autotype¶
Grid quantize - 1 2 4 8 16 - Experimental - not yet supported - do not even ask!
- Parameters
sequence (MidiSequence) –
q (Integer) –
- MidiSequence_ResetToStart(sequence) Autotype¶
Reset to the beginning of the track - Experimental - not yet supported - do not even ask!
- Parameters
sequence (MidiSequence) –
Songs¶
- GetActiveSetlistIndex() Autotype¶
Get the index of the currently active setlist - returns -1 if not in setlist mode
- GetCurrentSongIndex() Autotype¶
Get the index of the current song - negative 1 if it does not exist
- Return type
- GetSetlistName(index) Autotype¶
Get the name of the setlist at the given index
- GetSongArtistName(index) Autotype¶
Get the artist name of the song at the given index
- GetSongBPM(index) Autotype¶
Get the BPM of the song at the given index
- GetSongIndex(songname) Autotype¶
Get the index of the song for the given name - negative 1 if it does not exist
- GetSongKeySignature(index) Autotype¶
Get the key signature of the song at the given index
- GetSongName(index) Autotype¶
Get the name of the song at the given index
- GetSongPartName(index) Autotype¶
Get the name of the song part at the given index
- GetSongTimeSigDenominator(index) Autotype¶
Get the denominator of the time signature of the song at the given index
- GetSongTimeSigNumerator(index) Autotype¶
Get the numerator of the time signature of the song at the given index
- GetSongTranspose(index) Autotype¶
Get the transpose amount of the song at the given index
- NextSong() Autotype¶
Move to the next song
- PrevSong() Autotype¶
Move to the previous song
- SetSongPart(index) Autotype¶
Switch to another part in the current song
- Parameters
index (Integer) –
- SongMoveDown() Autotype¶
Move to the next part or next song if allowed
- SongMoveUp() Autotype¶
Move to the previous part or previous song if allowed
- SongNextPart() Autotype¶
Move to the next song part of the current song
- SongPrevPart() Autotype¶
Move to the previous song part of the current song
Strings¶
- BoolToString(b) Autotype¶
Returns a string representation of a boolean value
- CopySubstring(source, startIndex, length) Autotype¶
Return the section of the source string based on the start index and desired length
- DoubleToString(d, places) Autotype¶
Converts a double to a string with the specified number of places
- FileExists(filename) Autotype¶
Check if a file exists - experimental and unsupported - this could easily blow up Gig Performer or overwrite - returns whether saved
- GigPerformerDocumentsFolder() Autotype¶
Returns the root folder where GP content is stored
- Return type
- IndexOfSubstring(source, substring, caseSensitive) Autotype¶
Return the zero-based index of the substring or -1 if substring not found
- IntTo7BitHexString(i, minByteLength) Autotype¶
Converts an integer number to at least minByteLength sequence of 7 bit hex bytes - intended for use with sysex messages
- IntToHex(i) Autotype¶
Converts an integer number to its hex equivalent
Deprecated
Use
IntToHexString()
- IntToHexString(i) Autotype¶
Converts an integer number to its hex equivalent
- IntToString(i) Autotype¶
Returns a string representation of an integer value
- LoadStringFromTextFile(filename) Autotype¶
Load the contents of a file into a string - experimental and unsupported - this could easily blow up Gig Performer
- MapValueToDiscreteString(x, values) Autotype¶
Select a string based on the proportional fractional value between 0.0 and 1.0
- NoteNameToNoteNumber(s) Autotype¶
returns integer value of a note name
- NoteNumberToNoteName(i) Autotype¶
Returns a string representation of an integer note number
- ParseCSVString(line) Autotype¶
Breaksup a single line of a CSV into its parts
- Parameters
line (String) –
- Return type
String array
- ReplaceString(source, replaceThis, withThat, caseSensitive) Autotype¶
Replace a substring with another string
- ReplaceStringSection(source, startIndex, length, newSubstring) Autotype¶
Extract a substring defined by startIndex and length and insert a new substring into that position
- SaveStringToTextFile(filename, text) Autotype¶
Save a string to a file - experimental and unsupported - this could easily blow up Gig Performer or overwrite - returns whether saved
- StringAfterFirstOccurence(source, substringToStartFrom, includeSubstring, ignoreCase) Autotype¶
Return the section of the source string after the first occurrence of substringToStartFrom - optionally including the substring
Deprecated
- StringAfterFirstOccurrence(source, substringToStartFrom, includeSubstring, ignoreCase) Autotype¶
Return the section of the source string after the first occurrence of substringToStartFrom - optionally including the substring
- StringAfterLastOccurence(source, substringToFind, includeSubstring, ignoreCase) Autotype¶
Return the section of the source string after the last occurrence of substringToFind - optionally including the substring
Deprecated
- StringAfterLastOccurrence(source, substringToFind, includeSubstring, ignoreCase) Autotype¶
Return the section of the source string after the last occurrence of substringToFind - optionally including the substring
- StringToBool(s) Autotype¶
returns true if string = “true” otherwise false
- StringToDouble(s) Autotype¶
returns double value of string
- StringToHex(s) Autotype¶
Converts text characters to their hex equivalent values - intended for use with sysex messages
Deprecated
- StringToHexString(s) Autotype¶
Converts text characters to their hex equivalent values - intended for use with sysex messages
- StringToInt(s) Autotype¶
returns integer value of string
- StringUpToFirstOccurence(source, substringToEndWith, includeSubstring, ignoreCase) Autotype¶
Return the section of the source string up to the first occurrence of substringToEndWith - optionally including the substring
Deprecated
- StringUpToFirstOccurrence(source, substringToEndWith, includeSubstring, ignoreCase) Autotype¶
Return the section of the source string up to the first occurrence of substringToEndWith - optionally including the substring
- StringUpToLastOccurence(source, substringToFind, includeSubstring, ignoreCase) Autotype¶
Return the section of the source string up to the last occurrence of substringToFind - optionally including the substring
Deprecated
- StringUpToLastOccurrence(source, substringToFind, includeSubstring, ignoreCase) Autotype¶
Return the section of the source string up to the last occurrence of substringToFind - optionally including the substring
Sysex¶
- SM_ChangeValue(sm, index, newValue) Autotype¶
Change a byte of a sysex message at some index starting at 0. Note that the F0 and F7 bytes cannot themselves be changed
- Parameters
sm (SysexMessage) –
index (Integer) –
newValue (Integer) –
- SM_CreateSysex(sm, m) Autotype¶
Store a sysex message efficiently for manipulation and sending
Deprecated
It is no longer necessary to create sysex objects
- Parameters
sm (SysexManager) –
m (SysexMessage) –
- SM_CreateSysexFromString(sm, s) Autotype¶
Interpret a string as a sysex and store it for manipulation and sending
Deprecated
Strings can now be assigned directly to variables of type SysexMessage
- Parameters
sm (SysexManager) –
s (String) –
- SM_GetByte(sm, index) Autotype¶
Gets the byte at the specified index
Deprecated
Use
SM_GetValue()- Parameters
sm (SysexMessage) –
index (Integer) –
- Return type
- SM_GetValue(sm, index) Autotype¶
Gets the byte at the specified index
- Parameters
sm (SysexMessage) –
index (Integer) –
- Return type
- SM_GetValues(sm, first, second) Autotype¶
Gets the combined bytes starting at the specified index
- Parameters
sm (SysexMessage) –
first (Integer) –
second (Integer) –
- Return type
- SM_Length(sm) Autotype¶
Returns the length of a system message
- Parameters
sm (SysexMessage) –
- Return type
- SM_Pretty(m, blockSize, uppercase) Autotype¶
Returns a nicely formatted sysex message - possibly breaking it up into small blocks between 1 and 8 - blocksize of 0 will display indexing
- Parameters
m (SysexMessage) –
blockSize (Integer) –
uppercase (Boolean) –
- Return type
- SM_SendMidiIn(sm, midiIn) Autotype¶
Send a stored sysex message from a MidiIn block
Deprecated
- Parameters
sm (SysexMessage) –
midiIn (MidiInBlock) –
- SM_SendMidiOut(sm, midiOut) Autotype¶
Send a stored sysex message from a MidiOut block to an external MIDI device
Deprecated
SendSysexExternal
- Parameters
sm (SysexMessage) –
midiOut (MidiOutBlock) –
- SM_SendMidiOutNow(midiOut, sm) Autotype¶
Send a sysex message through a MidiOut block to an external MIDI device
Deprecated
SendSysexExternal
- Parameters
midiOut (MidiOutBlock) –
sm (SysexMessage) –
- SendSysexExternal(p, m) Autotype¶
Send a MIDI sysex message out immediately through a MIDI Out block
- Parameters
p (MidiOutBlock) –
m (SysexMessage) –
- SendSysexInternal(p, m) Autotype¶
Send a MIDI sysex message out immediately from a MIDI In block
Deprecated
- Parameters
p (MidiInBlock) –
m (SysexMessage) –
- SendSysexInternalLater(p, m, delayInMS) Autotype¶
Send a MIDI sysex message out at some specified time in the future from a MIDI In block
- Parameters
p (MidiInBlock) –
m (SysexMessage) –
delayInMS (Double) –
- SendSysexInternalNow(p, m) Autotype¶
Send a MIDI sysex message out immediately from a MIDI In block
- Parameters
p (MidiInBlock) –
m (SysexMessage) –
- SendSysexNowToMidiOutDevice(deviceName, m) Autotype¶
Send a MIDI sysex message out immediately through a MIDI output device
- Parameters
deviceName (String) –
m (SysexMessage) –
System¶
- ClearLogWindow() Autotype¶
Clear the script log window - duh!
- CloseLogWindow() Autotype¶
Close the script log window - duh!
- CloseScriptWindow() Autotype¶
Close the script editor window - if open - for the current rackspace
- FormatTime(timeInMS, format) Autotype¶
Returns a formatted timestamp from a given time in milliseconds
- GetTimeSigDenominator() Autotype¶
Get the denominator of the global time signature
- Return type
- ModifierKeys() Autotype¶
Returns the state of the various modifier keys: 1-Shift 2-Ctrl 4-Option 8-Cmd
- Return type
- OpenLogWindow() Autotype¶
Open the script log window - duh!
- OpenScriptWindow() Autotype¶
Open the script editor window for the current rackspace
- Panic() Autotype¶
Stop all notes in the current rackspace
- PlayNote(p, noteNumber, velocity, channel, startTimeMS, duration) Autotype
Send a noteOn event at startTimeMS and a noteOff event at durationMS later. If duration is less than 1 then we make it 1
- PlayNotes(p, noteNumbers, velocity, channel, startTimeMS, duration) Autotype
Play a collection of note at startTimeMS and stop them durationMS later. If duration is less than 1 then we make it 1
- RecordInputs(enable) Autotype¶
Start or stop recording audio input to file
- Parameters
enable (Boolean) –
- ScheduleMidiEvent(p, m, delayInMS) Autotype¶
Schedule a MIDI event to be reprocessed at some specified time in the future
- Parameters
p (MidiInBlock) –
m (MidiMessage) –
delayInMS (Double) –
- SendLater(p, m, delayInMS) Autotype
Schedule a MIDI event to be sent out at some specified time in the future
- Parameters
p (MidiInBlock) –
m (MidiMessage) –
delayInMS (Double) –
- SendNoteMessageWithTranspositionsLater(p, m, transpositions, delayInMS) Autotype¶
Send multiple MIDI noteon or noteoff events out some milliseconds later using note number added to each offset in the array
- Parameters
p (MidiInBlock) –
m (NoteMessage) –
transpositions (Integer array) –
delayInMS (Double) –
- SendNoteMessageWithTranspositionsNow(p, m, transpositions) Autotype¶
Send multiple note on or note off events out immediately using note number added to each offset in the array
- Parameters
p (MidiInBlock) –
m (NoteMessage) –
transpositions (Integer array) –
- SendNoteMessagesLater(p, noteNumbers, velocity, channel, delayInMS) Autotype¶
Create a chord of note on or off events using the array of note numbers and send it out some milliseconds later
- Parameters
p (MidiInBlock) –
noteNumbers (Integer array) –
velocity (Integer) –
channel (Integer) –
delayInMS (Double) –
- SendNoteMessagesNow(p, noteNumbers, velocity, channel) Autotype¶
Create a chord of note on or off events using the array of note numbers and send it out immediately
- Parameters
p (MidiInBlock) –
noteNumbers (Integer array) –
velocity (Integer) –
channel (Integer) –
- SendNowExternal(p, m) Autotype¶
Send a MIDI event out immediately through a MIDI Out block
- Parameters
p (MidiOutBlock) –
m (MidiMessage) –
- SendNowRespectingParameters(p, m) Autotype¶
Send a MIDI event out after applying MidiInBlock parameters
- Parameters
p (MidiInBlock) –
m (MidiMessage) –
- SetGlobalTranspose(semitones) Autotype¶
Transpose all incoming MIDI messages by semitones amount
- Parameters
semitones (Integer) –
- SetTimeSignatureDenominator(denominator) Autotype¶
Set the denominator of global time signature
- Parameters
denominator (Integer) –
- SetTimeSignatureNumerator(numerator) Autotype¶
Set the numerator of the global time signature
- Parameters
numerator (Integer) –
- SetWindowTitle(title) Autotype¶
Changes the default rackspace title to the title
- Parameters
title (String) –
- Shell(command) Autotype¶
Run an OS Shell command (Mac only) returning an integer indicating success or failure
- ShellEx(command) Autotype¶
Run an OS Shell command (Mac only) that returns the output of the command
- SwitchToProgramNumber(programNumber, bankNumber) Autotype¶
Switch to zero-based program number and bank Number if latter is greater than -1
- Tap() Autotype¶
Simulates tap tempo command
- TimeNow() Autotype¶
Gets the current time in milliseconds - deprecated
Deprecated
- Return type
Widgets¶
- BindExternalWidget(ew, widgetName, rackspaceName) Autotype¶
Access a widget in another rackspace - boolean return value indicates whether widget was found - experimental
- Parameters
ew (ExternalWidget) –
widgetName (String) –
rackspaceName (String) –
- Return type
- BindWidget(ew, widgetName) Autotype¶
Access a widget in the rackspace containing this scriptlet - boolean return value indicates whether widget was found - experimental
- Parameters
ew (ExternalWidget) –
widgetName (String) –
- Return type
- GetExternalWidgetValue(ew) Autotype¶
Get the current value of an external widget - experimental
- Parameters
ew (ExternalWidget) –
- Return type
- GetWidgetBounds(p, bounds) Autotype¶
Fill the first four fields of the bounds array with the widget position and size on a panel
- GetWidgetCurveValue(w, x) Autotype¶
For some value x - returns the y value of a widget after applying the scale curve to it
- GetWidgetPreviousValue(w) Autotype¶
Gets the previous value (position) of the widget. The value will be between 0.0 and 1.0
- GetWidgetResetValue(w) Autotype¶
Gets the reset value of the widget
- GetWidgetScriptName(p) Autotype¶
Gets the scripting name of this widget. Useful when widget is passed as a parameter somewhere
- GetWidgetValue(w) Autotype¶
Gets the current value (position) of the widget. The value will be between 0.0 and 1.0
- MapWidgetToPlugin(w, plugin, parameterNumber) Autotype¶
Map a widget to the specified parameter of the specified plugin
- ResetWidgetValue(p) Autotype¶
Reset the widget to its default value - same as double clicking on the widget
- Parameters
p (Widget) –
- ResyncWidget(p) Autotype¶
Resend the message to sync an external associated physical control with the widget
- Parameters
p (Widget) –
- SetExternalWidgetValue(ew, newValue) Autotype¶
Set the current value of an external widget - experimental
- Parameters
ew (ExternalWidget) –
newValue (Double) –
- SetExternalWidgetValueEx(ew, newValue) Autotype¶
Set the current value of an external widget - experimental - uses modulo arithmetic
- Parameters
ew (ExternalWidget) –
newValue (Double) –
- SetWidgetBounds(p, bounds) Autotype¶
Set a widget x y width height on a panel from the first four fields of the bound array
- SetWidgetCurveValue(w, x, y) Autotype¶
Returns the value of a widget after applying the scale curve to it
- SetWidgetResetValue(p, value) Autotype¶
Set the reset value of any widget
- SetWidgetValue(p, value) Autotype¶
Set the current value of any widget
Windows¶
- GPWindowToBack() Autotype¶
Put this GP main window behind other windows
- GPWindowToFront() Autotype¶
Bring this GP window to the front
- MinimizeOrRestoreGPWindow(minimize) Autotype¶
Minimize or restore the GP main window
- Parameters
minimize (Boolean) –
- SetGPWindowFullScreen(fullScreen) Autotype¶
Make the GP window be full screen or not fullscreen
- Parameters
fullScreen (Boolean) –