List of Functions

Ableton

Enable or disable Ableton Link

Parameters

enable (Boolean) –

Returns whether Ableton Link is enabled

Return type

Boolean

Actions

CloseAllPluginWindows(allRackspaces: Boolean)

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()

Duplicates the plugin - if any - under the mouse

InPanelView() Returns Boolean

See if we are in panel view

Return type

Boolean

InSetlistView() Returns Boolean

See if we are in wiring view

Return type

Boolean

InTunerView() Returns Boolean

Indicates whether we are in the tuner view

Return type

Boolean

InWiringView() Returns Boolean

See if we are in wiring view

Return type

Boolean

Next()

Switch to next rackspace variation song or song part

Previous()

Switch to previous rackspace variation song or song part

QuickReplacePluginUnderMouse()

Use dialog to replace the plugin - if any - under the mouse

RemovePluginUnderMouse()

Removes the plugin - if any - under the mouse

SwitchToPanelView()

Show the rackspace panel view

SwitchToSetlistView()

Show the song view

SwitchToWiringView()

Switch to the plugin block wiring view

ToggleTunerVisible()

Switch in or out of tuner view

Arrays

AppendBoolean(a: Boolean array, value: Boolean)

Append the boolean to the end of the array if there is room otherwise fail silently

Deprecated

Use <-- operator instead

Parameters
AppendDouble(a: Double array, value: Double) Autotype

Append the double to the end of the array if there is room otherwise fail silently

Deprecated

Use <-- operator instead

Parameters
AppendInteger(a: Integer array, value: Integer) Autotype

Append the integer to the end of the array if there is room otherwise fail silently

Deprecated

Use <-- operator instead

Parameters
AppendString(a: String array, value: String)

Append the string to the end of the array if there is room otherwise fail silently

Deprecated

Use <-- operator instead

Parameters
ClearArray(a: array) Autotype

Resets the array size to 0

Parameters

a (array) –

IndexOf(a: Integer array, value: Integer) Returns Integer

Returns the index containing the value otherwise returns -1

Parameters
Return type

Integer

LargestDouble(a: Double array) Returns Double

Returns the maximum value of a double array

Parameters

a (Double array) –

Return type

Double

LargestInt(a: Integer array) Returns Integer

Returns the maximum value in an integer array

Parameters

a (Integer array) –

Return type

Integer

RemoveLast(a: array) Autotype

Remove the last item in the array and so reducing the array size by 1

Parameters

a (array) –

Reverse(a: array) Autotype

Reverse the list of items in the array

Parameters

a (array) –

Size(a: array)    Autotype Returns Integer

Returns the size of an array

Parameters

a (array) –

Return type

Integer

SmallestDouble(a: Double array) Returns Double

Returns the minimum value in a double array

Parameters

a (Double array) –

Return type

Double

SmallestInt(a: Integer array) Returns Integer

Returns the minimum value in an integer array

Parameters

a (Integer array) –

Return type

Integer

Sort(a: array, ascending: Boolean) Autotype

Sorts an array in ascending order

Parameters
  • a (array) –

  • ascending (Boolean) –

iMax(a: array)    Autotype Returns Integer

Returns the index of the largest value of an array

Parameters

a (array) –

Return type

Integer

iMin(a: array)    Autotype Returns Integer

Returns the index of the smallest value of an array

Parameters

a (array) –

Return type

Integer

ExternalApplication

EA_AddArgument(ea: ExternalApplication, arg: String)

Add an argument to an external application manager

Parameters
EA_ClearAllArgs(ea: ExternalApplication)

Clear the list of arguments so you can start again

Parameters

ea (ExternalApplication) –

EA_SetProgramName(ea: ExternalApplication, name: String)

Set the name of the program to be run

Parameters
EA_Start(ea: ExternalApplication)

Open or run the external application

Parameters

ea (ExternalApplication) –

EA_Stop(ea: ExternalApplication)

Close or terminate the external application - not guaranteed to work

Parameters

ea (ExternalApplication) –

Generators

EnableGenerator(f: Generator, enable: Boolean) Autotype

Enables or disables any generator (LFO, ramp, squarewave, ADSR, etc)

Parameters
GetADSRAttackLevel(f: ADSR) Returns Double

Get the maximum volume level of the attack phase of an ADSR

Parameters

f (ADSR) –

Return type

Double

GetADSRAttackTime(f: ADSR) Returns Integer

Get the time in milliseconds of the attack phase of an ADSR

Parameters

f (ADSR) –

Return type

Integer

GetADSRDecayTime(f: ADSR) Returns Integer

Get the time in milliseconds of the decay phase of an ADSR

Parameters

f (ADSR) –

Return type

Integer

GetADSRReleaseTime(f: ADSR) Returns Integer

Get the time in milliseconds of the total release time of an ADSR

Parameters

f (ADSR) –

Return type

Integer

GetADSRSustainLevel(f: ADSR) Returns Double

Get the level of the sustain phase of an ADSR

Parameters

f (ADSR) –

Return type

Double

GetGeneraterAmplitude(f: Generator)    Autotype Returns Double

Get the current value of a generator

Deprecated

Use GetGeneratorAmplitude()

Parameters

f (Generator) –

Return type

Double

GetGeneratorAmplitude(f: Generator)    Autotype Returns Double

Get the current value of a generator

Parameters

f (Generator) –

Return type

Double

GetTimersRunning() Returns Boolean

Indicates whether global timers are running or stopped

Return type

Boolean

InitADSR(f: ADSR, attackTime: Integer, attackLevel: Double, decayTime: Integer, sustainLevel: Double, releaseTime: Integer)

Set all parameters of an ADSR in one function call

Parameters
IsGeneratorEnabled(f: Generator)    Autotype Returns Boolean

Queries the state (start or stopped) of any generator

Parameters

f (Generator) –

Return type

Boolean

SetADSRAttackLevel(f: ADSR, level: Double)

Set the maximum volume level of the attack phase of an ADSR

Parameters
SetADSRAttackTime(f: ADSR, milliseconds: Integer)

Set the time in milliseconds of the attack phase of an ADSR

Parameters
SetADSRDecayTime(f: ADSR, milliseconds: Integer)

Set the time in milliseconds of the decay phase of an ADSR

Parameters
SetADSRReleaseTime(f: ADSR, milliseconds: Integer)

Set the time in milliseconds of the total release time of an ADSR

Parameters
SetADSRSustainLevel(f: ADSR, level: Double)

Set the level of the sustain phase of an ADSR

Parameters
SetGeneratorCoarseness(f: Generator, milliseconds: Integer) Autotype

Controls the jitter time of a callback (trading off accuracy against CPU cycles)

Parameters
SetGeneratorFrequency(f: Generator, hertz: Double) Autotype

Set the frequency in cycles/second of any Generator

Parameters
SetGeneratorLength(f: Generator, milliseconds: Integer) Autotype

Set the length of a generator cycle

Parameters
SetGeneratorOneShot(f: Generator, oneshot: Boolean) Autotype

Controls whether an Generator repeats indefinitely or only runs once when triggered

Parameters
SetTimersRunning(run: Boolean)

Start or stop the global timers

Parameters

run (Boolean) –

StartAttackPhase(f: ADSR)

Trigger the ADS phase of an ADSR

Parameters

f (ADSR) –

StartReleasePhase(f: ADSR)

Trigger the release phase of the ADSR

Parameters

f (ADSR) –

MIDI

AllNotesOff(p: MidiInBlock)

Send All Notes Off and reset controllers

Parameters

p (MidiInBlock) –

AllNotesOff()

Send All Notes Off and reset controllers

BetweenNotes(lowerNote: Integer, note: NoteMessage, upperNote: Integer) Returns Boolean

Returns true if the MIDI Note message is between the lower and higher values exclusive

Parameters
Return type

Boolean

GetAfterTouchValue(m: AfterTouchMessage) Returns Integer

Returns the current aftertouch value of an Aftertouch MIDI message

Parameters

m (AfterTouchMessage) –

Return type

Integer

GetByte(m: MidiMessage, byteNumber: Integer)    Autotype Returns Integer

Returns one of the byte values of a MIDI message. The byteNumber must be within the range 0..2

Parameters
Return type

Integer

GetCCNumber(m: ControlChangeMessage) Returns Integer

Returns the Controller Number of a ControlChange MIDI message

Parameters

m (ControlChangeMessage) –

Return type

Integer

GetCCValue(m: ControlChangeMessage) Returns Integer

Returns the Controller value of a ControlChange MIDI message

Parameters

m (ControlChangeMessage) –

Return type

Integer

GetChannel(m: MidiMessage)    Autotype Returns Integer

Returns the MIDI channel number (between 1 and 16) of any MIDI message

Parameters

m (MidiMessage) –

Return type

Integer

GetMidiInDeviceCount() Returns Integer

Returns the number of available MIDI In Devices

Return type

Integer

GetMidiInDeviceFromRigManager(rmDeviceName: String) Returns String

Find the name of a physical MidiIn device given its RigManager name

Parameters

rmDeviceName (String) –

Return type

String

GetMidiInDeviceName(index: Integer) Returns String

Returns the name of the MIDI In Device at the specified index

Parameters

index (Integer) –

Return type

String

GetMidiMessageSize(m: MidiMessage)    Autotype Returns Integer

Returns the number of bytes in any MIDI Message

Parameters

m (MidiMessage) –

Return type

Integer

GetMidiOutDeviceCount() Returns Integer

Returns the number of available MIDI Out Devices

Return type

Integer

GetMidiOutDeviceName(index: Integer) Returns String

Returns the name of the MIDI Out Device at the specified index

Parameters

index (Integer) –

Return type

String

GetNoteNumber(m: NoteMessage) Returns Integer

Returns the note number of a NoteMessage MIDI event

Parameters

m (NoteMessage) –

Return type

Integer

GetPitchBendValue(m: PitchBendMessage) Returns Integer

Returns the pitch bend value from a PitchBend MIDI message

Parameters

m (PitchBendMessage) –

Return type

Integer

GetPolyTouchNoteNumber(m: PolyTouchMessage) Returns Integer

Returns the note number of a PolyTouch MIDI event

Parameters

m (PolyTouchMessage) –

Return type

Integer

GetProgramChangeNumber(m: ProgramChangeMessage) Returns Integer

Returns the program change number of a ProgramChangeMessage MIDI event

Parameters

m (ProgramChangeMessage) –

Return type

Integer

GetReleaseVelocity(m: NoteMessage) Returns Integer

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

Integer

GetVelocity(m: NoteMessage) Returns Integer

Returns the velocity of a NoteEvent MIDI message. The value will be between 0 and 127

Parameters

m (NoteMessage) –

Return type

Integer

InjectMidiEvent(physicalDeviceName: String, m: MidiMessage) Autotype

Inject a message to any Midi Input Port with the specified physical device name

Parameters
InjectMidiEventViaRigManager(rmDeviceAliasName: MidiInDeviceAlias, m: MidiMessage) Autotype

Inject a message to a MidiInDeviceAlias using its Rig Manager name directly

Parameters
IsAfterTouch(m: MidiMessage)    Autotype Returns Boolean

See if the current message is actually an Aftertouch MIDI message

Parameters

m (MidiMessage) –

Return type

Boolean

IsController(m: MidiMessage)    Autotype Returns Boolean

See if the current message is actually a CC MIDI message

Parameters

m (MidiMessage) –

Return type

Boolean

IsNote(m: MidiMessage)    Autotype Returns Boolean

See if the current message is a NoteOn or a NoteOff message

Parameters

m (MidiMessage) –

Return type

Boolean

IsNoteOff(m: MidiMessage)    Autotype Returns Boolean

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

Boolean

IsNoteOn(m: MidiMessage)    Autotype Returns Boolean

See if the current message is actually a noteOn message

Parameters

m (MidiMessage) –

Return type

Boolean

IsPitchBend(m: MidiMessage)    Autotype Returns Boolean

See if the current message is actually a pitchbend message

Parameters

m (MidiMessage) –

Return type

Boolean

IsPolyTouch(m: MidiMessage)    Autotype Returns Boolean

See if the current message is actually a Polytouch MIDI message

Parameters

m (MidiMessage) –

Return type

Boolean

IsProgramChange(m: MidiMessage)    Autotype Returns Boolean

See if the current message is actually a program change message

Parameters

m (MidiMessage) –

Return type

Boolean

MakeAfterTouchMessage(value: Integer) Returns AfterTouchMessage

Returns an Aftertouch MIDI message with the specified value. The MIDI channel is 1

Parameters

value (Integer) –

Return type

AfterTouchMessage

MakeAfterTouchMessageEx(value: Integer, channel: Integer) Returns AfterTouchMessage

Returns an Aftertouch MIDI message with the specified value and MIDI channel

Parameters
Return type

AfterTouchMessage

MakeControlChangeMessage(number: Integer, value: Integer) Returns ControlChangeMessage

Returns a CC MIDI message with the specified CC number and value. The MIDI channel is 1

Parameters
Return type

ControlChangeMessage

MakeControlChangeMessageEx(number: Integer, value: Integer, channel: Integer) Returns ControlChangeMessage

Returns a CC MIDI message with the specified CC number and value and MIDI channel

Parameters
Return type

ControlChangeMessage

MakeMidiMessage(byte0: Integer, byte1: Integer, byte2: Integer) Returns MidiMessage

Create an three byte MIDI message - you are on your own so make sure you get the values correct

Deprecated

Use MakeMidiMessage3()

Parameters
Return type

MidiMessage

MakeMidiMessage1(byte0: Integer) Returns MidiMessage

Create one byte MIDI message - you are on your own so make sure you get the value correct

Parameters

byte0 (Integer) –

Return type

MidiMessage

MakeMidiMessage2(byte0: Integer, byte1: Integer) Returns MidiMessage

Create a 2 byte MIDI message - you are on your own so make sure you get the values correct

Parameters
Return type

MidiMessage

MakeMidiMessage3(byte0: Integer, byte1: Integer, byte2: Integer) Returns MidiMessage

Create an three byte MIDI message - you are on your own so make sure you get the values correct

Parameters
Return type

MidiMessage

MakeNoteMessage(number: Integer, velocity: Integer) Returns NoteMessage

Returns a Note MIDI message with the specified note number and velocity. The MIDI channel is 1

Parameters
Return type

NoteMessage

MakeNoteMessageEx(number: Integer, velocity: Integer, channel: Integer) Returns NoteMessage

Returns a Note MIDI message with the specified note number and velocity and MIDI channel

Parameters
Return type

NoteMessage

MakePitchBendMessage(value: Integer) Returns PitchBendMessage

Returns a new Pitchbend MIDI message with the specified value. The MIDI channel is 1

Parameters

value (Integer) –

Return type

PitchBendMessage

MakePitchBendMessageEx(value: Integer, channel: Integer) Returns PitchBendMessage

Returns a new Pitchbend MIDI message with the specified value and MIDI channel

Parameters
Return type

PitchBendMessage

MakePolyTouchMessage(number: Integer, pressure: Integer) Returns PolyTouchMessage

Returns a Polytouch MIDI message with the specified note number and pressure amount. The MIDI channel is 1

Parameters
Return type

PolyTouchMessage

MakePolyTouchMessageEx(number: Integer, pressure: Integer, channel: Integer) Returns PolyTouchMessage

Returns a Polytouch - sometimes called poly pressure - MIDI message with the specified note number and pressure amount and MIDI channel

Parameters
Return type

PolyTouchMessage

MakeProgramChangeMessage(value: Integer) Returns ProgramChangeMessage

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

ProgramChangeMessage

MakeProgramChangeMessageEx(value: Integer, channel: Integer) Returns ProgramChangeMessage

Returns a new ProgramChange MIDI message with the specified value ranging from 0 to 127 and with the specified MIDI channel

Parameters
Return type

ProgramChangeMessage

MidiInDeviceExists(deviceName: String) Returns Boolean

Returns whether the physical MIDI in device exists

Parameters

deviceName (String) –

Return type

Boolean

MidiOutDeviceExists(deviceName: String) Returns Boolean

Returns whether the physical MIDI Out device exists

Parameters

deviceName (String) –

Return type

Boolean

ReinterpretAsAfterTouch(m: MidiMessage, UseThirdByte: Boolean)    Autotype Returns NoteMessage

Reinterpret an arbitrary MIDI message - you need to know what you are doing

Parameters
Return type

NoteMessage

ReinterpretAsControllerMessage(m: MidiMessage)    Autotype Returns NoteMessage

Reinterpret an arbitrary MIDI message - you need to know what you are doing

Parameters

m (MidiMessage) –

Return type

NoteMessage

ReinterpretAsNoteOffMessage(m: MidiMessage)    Autotype Returns NoteMessage

Reinterpret an arbitrary MIDI message - you need to know what you are doing

Parameters

m (MidiMessage) –

Return type

NoteMessage

ReinterpretAsNoteOnMessage(m: MidiMessage)    Autotype Returns NoteMessage

Reinterpret an arbitrary MIDI message - you need to know what you are doing

Parameters

m (MidiMessage) –

Return type

NoteMessage

ReinterpretAsPitchBend(m: MidiMessage)    Autotype Returns NoteMessage

Reinterpret an arbitrary MIDI message - you need to know what you are doing

Parameters

m (MidiMessage) –

Return type

NoteMessage

ReinterpretAsPolyTouchMessage(m: MidiMessage)    Autotype Returns NoteMessage

Reinterpret an arbitrary MIDI message - you need to know what you are doing

Parameters

m (MidiMessage) –

Return type

NoteMessage

ReinterpretAsProgramChange(m: MidiMessage, UseThirdByte: Boolean)    Autotype Returns NoteMessage

Reinterpret an arbitrary MIDI message - you need to know what you are doing

Parameters
Return type

NoteMessage

SendNow(p: MidiInBlock, m: MidiMessage) Autotype

Send a MIDI event out immediately

Parameters
SendNowToMidiOutDevice(deviceName: String, m: MidiMessage) Autotype

Send a MIDI event out immediately through a physical MIDI Out device

Parameters
Transpose(m: NoteMessage, steps: Integer) Returns NoteMessage

Returns a note that has been transposed chromatically by the number of steps

Deprecated

Use WithTranspose()

Parameters
Return type

NoteMessage

WithCCNumber(m: ControlChangeMessage, number: Integer) Returns ControlChangeMessage

Changes the CC number of a ControlChangeMessage MIDI event

Parameters
Return type

ControlChangeMessage

WithCCValue(m: ControlChangeMessage, v: Integer) Returns ControlChangeMessage

Changes the value of a CCMessage MIDI event

Parameters
Return type

ControlChangeMessage

WithChannel(m: MidiMessage, channel: Integer)    Autotype Returns MidiMessage

Changes the channel number of any MIDI event.

Parameters
Return type

MidiMessage

WithNoteNumber(m: NoteMessage, number: Integer) Returns NoteMessage

Changes the note number of a NoteMessage MIDI event

Parameters
Return type

NoteMessage

WithNoteNumberAndVelocity(m: NoteMessage, n: Integer, v: Integer) Returns NoteMessage

Changes the note number and the velocity value of a NoteMessage MIDI event. Setting to 0 will make the message be a NoteOff

Parameters
Return type

NoteMessage

WithTranspose(m: NoteMessage, steps: Integer) Returns NoteMessage

Returns a note that has been transposed chromatically by the number of steps

Parameters
Return type

NoteMessage

WithVelocity(m: NoteMessage, v: Integer) Returns NoteMessage

Changes the velocity value of a NoteMessage MIDI event. Setting to 0 will make the message be a NoteOff

Parameters
Return type

NoteMessage

Math

ACos(x: Double)    Autotype Returns Double

Returns the inverse cos of x

Parameters

x (Double) –

Return type

Double

ASin(x: Double)    Autotype Returns Double

Returns the inverse sin of x

Parameters

x (Double) –

Return type

Double

ATan(x: Double)    Autotype Returns Double

Returns the inverse tan of x

Parameters

x (Double) –

Return type

Double

Abs(x: Double)    Autotype Returns Double

Returns the absolute value of x

Parameters

x (Double) –

Return type

Double

CC_LoadFromFile(cc: CurveComponent, filename: String) Returns Boolean

Load a curve that was created with a Curve Component

Parameters
Return type

Boolean

CC_SaveToFile(cc: CurveComponent, filename: String) Returns Boolean

Save a possibly changed curve to file

Parameters
Return type

Boolean

CC_Scale(cc: CurveComponent, x: Double) Returns Double

Return the Y value for the inputted x value

Parameters
Return type

Double

Ceiling(x: Double)    Autotype Returns Integer

Rounds x upward returning the smallest integral value that is not less than x

Parameters

x (Double) –

Return type

Integer

Cos(x: Double)    Autotype Returns Double

Returns the cos of x

Parameters

x (Double) –

Return type

Double

Exp(x: Double)    Autotype Returns Double

Returns e to the power of x

Parameters

x (Double) –

Return type

Double

Floor(x: Double)    Autotype Returns Integer

Rounds x downward returning the largest integral value that is not greater than x

Parameters

x (Double) –

Return type

Integer

IntToFloat(x: Integer) Returns Double

Converts an integer to its floating point equivalent

Parameters

x (Integer) –

Return type

Double

Ln(x: Double)    Autotype Returns Double

Returns the log (base e) of x

Parameters

x (Double) –

Return type

Double

Log(x: Double)    Autotype Returns Double

Returns the log (base 10) of x

Parameters

x (Double) –

Return type

Double

MidiToParam(m: Integer) Returns Double

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

Parameters

m (Integer) –

Return type

Double

MidiToParamEx(x: Integer, xMin: Integer, xMax: Integer, yMin: Double, yMax: Double)    Autotype Returns Double

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

Parameters
Return type

Double

ParamToMidi(m: Double) Returns Integer

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

Parameters

m (Double) –

Return type

Integer

ParamToMidiEx(x: Double, xMin: Double, xMax: Double, yMin: Integer, yMax: Integer)    Autotype Returns Integer

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

Parameters
Return type

Integer

Power(base: Double, exponent: Double)    Autotype Returns Double

Returns base raised to the power of exponent

Parameters
Return type

Double

Random() Returns Double

Returns a random value between 0.0 and 1.0

Return type

Double

RandomRange(min: Integer, max: Integer) Returns Integer

Returns a random integer value between min and max

Parameters
Return type

Integer

Round(x: Double)    Autotype Returns Integer

Rounds a floating point number to the nearest integer

Parameters

x (Double) –

Return type

Integer

Scale(x: Double, xMin: Double, xMax: Double, yMin: Double, yMax: Double)    Autotype Returns Double

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

Parameters
Return type

Double

ScaleInt(x: Integer, xMin: Integer, xMax: Integer, yMin: Integer, yMax: Integer)    Autotype Returns Integer

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

Parameters
Return type

Integer

ScaleRange(x: Double, yMin: Integer, yMax: Integer)    Autotype Returns Integer

Maps a double value between 0.0 and 1.0 into a rounded integer value between yMin and yMax

Parameters
Return type

Integer

ScaleRangeEx(x: Double, xMin: Double, xMax: Double, yMin: Integer, yMax: Integer)    Autotype Returns Integer

Maps a double value between xMin and xMax into a rounded integer value between yMin and yMax

Parameters
Return type

Integer

Sign(x: Double)    Autotype Returns Integer

Returns 1 if x > 0 -1 if x < 0 0 if x - 0

Parameters

x (Double) –

Return type

Integer

Sin(x: Double)    Autotype Returns Double

Returns the sin of x

Parameters

x (Double) –

Return type

Double

Sqrt(x: Double)    Autotype Returns Double

Returns the square root of x

Parameters

x (Double) –

Return type

Double

Tan(x: Double)    Autotype Returns Double

Returns the tan of x

Parameters

x (Double) –

Return type

Double

ThresholdDetector_Detect(td: ThresholdDetector, newValue: Double) Returns Boolean

Return true if we crossed over

Parameters
Return type

Boolean

ThresholdDetector_Setup(td: ThresholdDetector, crossOver: Double, initialValue: Double, upDirection: Boolean)

Define the conditions to detect an edge

Parameters

MultiChannelNoteTracker

MultiChannelNoteTracker_Clear(mt: MultiChannelNoteTracker, channel: Integer)

Reinitializes the note tracker for the specified channel

Parameters
MultiChannelNoteTracker_GetHeldNotes(mt: MultiChannelNoteTracker, channel: Integer) Returns Integer array

returns all currently held down notes as an integer array without velocities

Parameters
Return type

Integer array

MultiChannelNoteTracker_GetSpecificNoteOnCount(mt: MultiChannelNoteTracker, noteNumber: Integer, channel: Integer) Returns Integer

Count how many times a specific note on has been played without a corresponding note off

Parameters
Return type

Integer

MultiChannelNoteTracker_GotNote(mt: MultiChannelNoteTracker, note: NoteMessage)

Track status of an incoming note

Parameters
MultiChannelNoteTracker_GotNoteOff(mt: MultiChannelNoteTracker, noteNumber: Integer, channel: Integer)

Remember that a note was released

Parameters
MultiChannelNoteTracker_GotNoteOn(mt: MultiChannelNoteTracker, noteNumber: Integer, channel: Integer)

Remember that a note was played

Parameters
MultiChannelNoteTracker_IsNoteOffPending(mt: MultiChannelNoteTracker, noteNumber: Integer, channel: Integer) Returns Boolean

returns whether a specific note is still down

Parameters
Return type

Boolean

MultiChannelNoteTracker_NoteOnCount(mt: MultiChannelNoteTracker, channel: Integer) Returns Integer

Count number of notes still being played

Parameters
Return type

Integer

MultiChannelNoteTracker_StopAllPendingNotes(m: MidiInBlock, nt: NoteTracker)

Send note offs for all pending notes on all channels in the tracker

Parameters
MultiChannelNoteTracker_StopAllPendingNotes(nt: MultiChannelNoteTracker)

Send note offs for all pending notes on all channels in the tracker

Parameters

nt (MultiChannelNoteTracker) –

NoteManagement

AddChordInterval(cr: ChordRecognizer, interval: Integer array, chordName: String)

Add a user defined chord interval to the chord dictionary

Parameters
AutoSustainer_GetHeldNotes(sustainer: AutoSustainer) Returns Integer array

returns all currently held down notes as an integer array without velocities - experimental

Parameters

sustainer (AutoSustainer) –

Return type

Integer array

AutoSustainer_Play(sustainer: AutoSustainer, m: NoteMessage)

Play and sustain an incoming note message through the AutoSustainer

Parameters
AutoSustainer_RespectParameters(sustainer: AutoSustainer, respect: Boolean)

Indicate whether notes should respect MidiInBlock parameters

Parameters
AutoSustainer_SetTarget(sustainer: AutoSustainer, m: MidiInBlock)

Specify the MidiInBlock to use for sending out notes using this AutoSustainer object

Parameters
AutoSustainer_Stop(sustainer: AutoSustainer)

Stop all pending notes

Parameters

sustainer (AutoSustainer) –

FindChordName(cr: ChordRecognizer, nt: NoteTracker) Returns String

Given a note tracker with pending notes - get the string name of the chord

Parameters
Return type

String

NoteMapper_CreateScale(nm: NoteMapper, rootNote: Integer, scale: Integer array)

Given a root note and an array of 12 offsets - create a scale covering the entire MIDI note range

Parameters
NoteMapper_GetMappedNotes(nm: NoteMapper, note: Integer) Returns Integer array

Returns the note or chord associated with the incoming note

Parameters
Return type

Integer array

NoteMapper_MapNote(nm: NoteMapper, note: Integer, mapToNote: Integer)

Define note to be returned given an incoming note

Parameters
NoteMapper_MapNoteToChord(nm: NoteMapper, note: Integer, chord: Integer array)

Associate a note with a chord

Parameters
NoteMapper_MapNotes(nm: NoteMapper, source: Integer array, dest: Integer array)

Map a list of source notes to replacement notes - both arrays must be same size

Parameters
NoteMapper_Reset(nm: NoteMapper)

Reset note mapper to defaults

Parameters

nm (NoteMapper) –

RemoveChordInterval(cr: ChordRecognizer, interval: Integer array)

Remove a chord interval from the chord dictionary

Parameters

NoteTracker

ClearNoteTracker(nt: NoteTracker)

Reinitializes the note tracker although it is generally not necessary

Deprecated

Use NoteTracker_Clear()

Parameters

nt (NoteTracker) –

GotNote(nt: NoteTracker, note: NoteMessage)

Track status of an incoming note

Deprecated

Use NoteTracker_GotNote()

Parameters
GotNoteOff(nt: NoteTracker, noteNumber: Integer)

Remember that a note was released

Deprecated

Use NoteTracker_GotNoteOff()

Parameters
GotNoteOn(nt: NoteTracker, noteNumber: Integer)

Remember that a note was played

Deprecated

Use NoteTracker_GotNoteOn()

Parameters
NoteOnCount(nt: NoteTracker) Returns Integer

Count number of notes still being played

Deprecated

Use NoteTracker_NoteOnCount()

Parameters

nt (NoteTracker) –

Return type

Integer

NoteTracker_Clear(nt: NoteTracker)

Reinitializes the note tracker although it is generally not necessary

Parameters

nt (NoteTracker) –

NoteTracker_GetHeldNotes(nt: NoteTracker) Returns Integer array

returns all currently held down notes as an integer array without velocities

Parameters

nt (NoteTracker) –

Return type

Integer array

NoteTracker_GetSpecificNoteOnCount(nt: NoteTracker, noteNumber: Integer) Returns Integer

Count how many times a specific note on has been played without a corresponding note off

Parameters
Return type

Integer

NoteTracker_GotNote(nt: NoteTracker, note: NoteMessage)

Track status of an incoming note

Parameters
NoteTracker_GotNoteOff(nt: NoteTracker, noteNumber: Integer)

Remember that a note was released

Parameters
NoteTracker_GotNoteOn(nt: NoteTracker, noteNumber: Integer)

Remember that a note was played

Parameters
NoteTracker_IsNoteOffPending(nt: NoteTracker, noteNumber: Integer) Returns Boolean

returns whether a specific note is still down

Parameters
Return type

Boolean

NoteTracker_NoteOnCount(nt: NoteTracker) Returns Integer

Count number of notes still being played

Parameters

nt (NoteTracker) –

Return type

Integer

NoteTracker_StopAllPendingNotes(m: MidiInBlock, nt: NoteTracker)

Send note offs for all pending notes in the tracker

Parameters
NoteTracker_StopAllPendingNotes(nt: NoteTracker)

Send note offs for all pending notes in the tracker

Parameters

nt (NoteTracker) –

StopAllPendingNotes(m: MidiInBlock, nt: NoteTracker)

Send note offs for all pending notes in the tracker

Parameters
StopAllPendingNotes(nt: NoteTracker)

Send note offs for all pending notes in the tracker

Parameters

nt (NoteTracker) –

OSC

OSC_AppendDoubleArg(m: OSCMessage, value: Double)

Append a double argument to the OSC message

Parameters
OSC_AppendIntArg(m: OSCMessage, value: Integer)

Append an integer argument to the OSC message

Parameters
OSC_AppendStringArg(m: OSCMessage, value: String)

Append a string argument to the OSC message

Parameters
OSC_ArgCount(m: OSCMessage) Returns Integer

Returns the number of arguments in an OSC message

Parameters

m (OSCMessage) –

Return type

Integer

OSC_ClearArgs(m: OSCMessage)

Clear all arguments but leave the address pattern

Parameters

m (OSCMessage) –

OSC_Enabled() Returns Boolean

Returns whether OSC is enabled for this instance

Return type

Boolean

OSC_GetArgAsDouble(m: OSCMessage, index: Integer) Returns Double

Returns the argument at the index - 0 based - as a double

Parameters
Return type

Double

OSC_GetArgAsInteger(m: OSCMessage, index: Integer) Returns Integer

Returns the argument at the index - 0 based - as an integer

Parameters
Return type

Integer

OSC_GetArgAsString(m: OSCMessage, index: Integer) Returns String

Returns the argument at the index - 0 based - as a String

Parameters
Return type

String

OSC_GetGPListeningPort() Returns Integer

Return the port on which GP listens for incoming OSC messages

Return type

Integer

OSC_Send(m: OSCMessage)

Send out the message to the default IP address and port

Parameters

m (OSCMessage) –

OSC_SendDouble(address: String, value: Double)

Send an OSC message with a value of type double to the default ip address and port

Parameters
OSC_SendDoubleSpecific(address: String, value: Double, ipAddress: String, port: Integer)

Send an OSC message with a value of type double to the specified ip address and port

Parameters
OSC_SendInteger(address: String, value: Integer)

Send an OSC message with a value of type integer to the default ip address and port

Parameters
OSC_SendIntegerSpecific(address: String, value: Integer, ipAddress: String, port: Integer)

Send an OSC message with a value of type integer to the specified ip address and port

Parameters
OSC_SendSpecific(m: OSCMessage, ipAddress: String, port: Integer)

Send out the message to the specified IP address and port

Parameters
OSC_SendString(address: String, value: String)

Send an OSC message with a value of type String to the default ip address and port

Parameters
OSC_SendStringSpecific(address: String, value: String, ipAddress: String, port: Integer)

Send an OSC message with a value of type String to the specified ip address and port

Parameters
OSC_SetAddress(m: OSCMessage, address: String)

Set the address of an OSC message

Parameters

Plugins

ClosePlugin(p: Block) Autotype

Close the plugin editor

Parameters

p (Block) –

GUI_CreateNewWidget(left: Double, top: Double, width: Double, height: Double) Returns Integer

Returns ID of new widget

Parameters
Return type

Integer

GetActivePreset(p: Block)    Autotype Returns Integer

Get the index of the current preset in the plugin block

Parameters

p (Block) –

Return type

Integer

GetGPPresetList(p: Block, chunkN: Integer)    Autotype Returns String array

Get the Nth chunk of GP Preset names

Parameters
Return type

String array

GetGPPresetListCount(p: Block)    Autotype Returns Integer

Returns the number of GP Presets for this plugin

Parameters

p (Block) –

Return type

Integer

GetMaxNoteFromMidiInBlock(aBlock: MidiInBlock) Returns Integer

Gets the max note number defined for the keyboard split

Parameters

aBlock (MidiInBlock) –

Return type

Integer

GetMinNoteFromMidiInBlock(aBlock: MidiInBlock) Returns Integer

Gets the min note number defined for the keyboard split

Parameters

aBlock (MidiInBlock) –

Return type

Integer

GetParameter(p: Block, index: Integer)    Autotype Returns Double

Gets the current parameter value associated with a parameter index of the plugin block. The value will be between 0.0 and 1.0

Parameters
Return type

Double

GetParameterCount(p: Block)    Autotype Returns Integer

Gets the number of parameters in the plugin block

Parameters

p (Block) –

Return type

Integer

GetParameterName(p: Block, index: Integer)    Autotype Returns String

Gets the name for the parameter index of the plugin block if available.

Parameters
Return type

String

GetParameterText(p: Block, index: Integer)    Autotype Returns String

Gets the value as text of the given parameter index of the plugin block if available.

Parameters
Return type

String

GetPluginCaption(p: Block)    Autotype Returns String

Gets the caption displayed in the plugin block

Parameters

p (Block) –

Return type

String

GetPluginInfo(p: Block, infoCode: Integer)    Autotype Returns String

Get information about the actual plugin — 0-name - 1-manufacturer

Parameters
Return type

String

GetPresetCount(p: Block)    Autotype Returns Integer

Get the number of available presets in the plugin block

Parameters

p (Block) –

Return type

Integer

GetPresetName(p: Block, index: Integer)    Autotype Returns String

Get the name of the preset at the given index of the plugin block

Parameters
Return type

String

GetTransposeFromMidiInBlock(aBlock: MidiInBlock) Returns Integer

Gets the max note number defined for the keyboard split

Parameters

aBlock (MidiInBlock) –

Return type

Integer

GetVelocityCurveValue(aBlock: MidiInBlock, velocity: Integer) Returns Integer

Returns the velocity after applying the scale curve to it

Parameters
Return type

Integer

IsPluginBypassed(p: Block)    Autotype Returns Boolean

Returns whether the plugin block is bypassed

Parameters

p (Block) –

Return type

Boolean

LoadGPPreset(p: Block, presetName: String) Autotype

Load a GP plugin preset in the background - seriously experimental and probably very unsafe

Parameters
OpenPlugin(p: Block) Autotype

Open the plugin editor

Parameters

p (Block) –

ReplacePlugin(p: Block, name: String) Autotype

Replace the plugin in the specified block - experimental

Parameters
SelectPreset(p: Block, index: Integer) Autotype

Change the preset of the block - experimental

Parameters
SetParameter(p: Block, index: Integer, value: Double) Autotype

Send a parameter value to the plugin block

Parameters
SetPluginBypassed(p: Block, bypass: Boolean) Autotype

Bypass or unbypass the plugin block

Parameters
SetPluginCaption(p: Block, newCaption: String) Autotype

Sets the caption displayed in the plugin block

Parameters
SetPluginEditorXYPosition(p: Block, x: Integer, y: Integer) Autotype

Open a plugin editor and set its position on screen

Parameters

Rackspaces

GetCurrentRackspaceIndex() Returns Integer

Returns the index of the current rackspace

Return type

Integer

GetCurrentVariation() Returns Integer

Returns the index of the current variation

Return type

Integer

GetRackspaceBPM() Returns Double

Gets the BPM value associated with this rackspace

Return type

Double

GetRackspaceCount() Returns Integer

Returns the number of rackspaces in the system

Return type

Integer

GetRackspaceIndex(name: String) Returns Integer

Returns the name of the rackspace at the given index. Returns -1 if rackspace does not exist

Parameters

name (String) –

Return type

Integer

GetRackspaceName() Returns String

Returns the name of the active rackspace

Return type

String

GetRackspaceNameAtIndex(index: Integer) Returns String

Returns the name of the rackspace at the given index

Parameters

index (Integer) –

Return type

String

GetVariationCount() Returns Integer

Returns the number of variations in the current rackspace

Return type

Integer

GetVariationCountForRackspaceAtIndex(rackspaceIndex: Integer) Returns Integer

Returns the number of variations in a specified rackspace

Parameters

rackspaceIndex (Integer) –

Return type

Integer

GetVariationName(index: Integer) Returns String

Returns the name of a variation

Parameters

index (Integer) –

Return type

String

GetVariationNameForRackspaceAtIndex(rackspaceIndex: Integer, variationIndex: Integer) Returns String

Returns the name of a variation in a specified rackspace

Parameters
Return type

String

NextRackspace()

Switch to the next rackspace

NextVariation()

Switch to the next variation

PreviousRackspace()

Switch to the previous rackspace

PreviousVariation()

Switch to the previous variation

SetVariation(index: Integer)

Switch to another variation in the active rackspace

Parameters

index (Integer) –

SwitchToNextRack()

Switch to the next rackspace

Deprecated

Use NextRackspace() instead.

SwitchToNextVariation()

Switch to the next variation

Deprecated

Use NextVariation() instead.

SwitchToPreset(newPreset: Integer)

Switch to another preset in the rackspace

Deprecated

Use SetVariation() instead.

Parameters

newPreset (Integer) –

SwitchToPrevRack()

Switch to the previous rackspace

Deprecated

Use PreviousRackspace() instead.

SwitchToPrevVariation()

Switch to the previous variation

Deprecated

Use PreviousVariation() instead.

SwitchToRack(newRackspaceNumber: Integer, newPreset: Integer)

Switch to another rackspace by number and potentially to a specific newPreset in that rackspace

Deprecated

Use SwitchToRackspace() instead.

Parameters
SwitchToRackspace(newRackspaceNumber: Integer, newVariationNumber: Integer)

Switch to another rackspace by number and potentially to a specific variation in that rackspace

Parameters
SwitchToRackspaceByName(name: String, newVariationNumber: Integer)

Switch to another rackspace by name and potentially to a specific variation in that rackspace

Parameters
UpdateRackspaceBPM(bpm: Double)

Update the rackspace with this BPM value - does not mark gigfile dirty

Parameters

bpm (Double) –

ScriptletBlock

GetContinuousPreviousValue(p: Continuous) Returns Double

Get the previous value of this parameter

Parameters

p (Continuous) –

Return type

Double

GetDiscreteParameterItem(p: Discrete, offset: Integer) Returns String

Returns the string item at the given offset for this parameter

Parameters
Return type

String

GetDiscreteParameterItemCount(p: Discrete) Returns Integer

Returns the number of strings defined for this parameter

Parameters

p (Discrete) –

Return type

Integer

GetDiscretePreviousValue(p: Discrete) Returns String

Get the previous value of this parameter

Parameters

p (Discrete) –

Return type

String

GetIndexOfDiscreteParameterItem(p: Discrete, itemToFind: String) Returns Integer

Find the index of a discrete item and returns -1 if the item is not found

Parameters
Return type

Integer

GetIndexOfSubrangeParameterItem(p: Subrange, itemToFind: Integer) Returns Integer

Find the index of a subrange item and returns -1 if the item is not found

Parameters
Return type

Integer

GetParameterCount() Returns Integer

Get the number of parameters

Return type

Integer

GetParameterName(p: Parameter) Returns String

Returns the name of the parameter - preferring the alias if defined

Parameters

p (Parameter) –

Return type

String

GetSubrangeParameterItem(p: Subrange, offset: Integer) Returns Integer

Returns the integer item at the given offset for this parameter

Parameters
Return type

Integer

GetSubrangeParameterItemCount(p: Subrange) Returns Integer

Returns the number of integer values defined for this parameter

Parameters

p (Subrange) –

Return type

Integer

GetSubrangePreviousValue(p: Subrange) Returns Integer

Get the previous value of this parameter

Parameters

p (Subrange) –

Return type

Integer

PlayNote(noteNumber: Integer, velocity: Integer, channel: Integer, startTimeMS: Integer, duration: Integer)

Send a noteOn event at startTimeMS and a noteOff event at durationMS later. If duration is less than 1 then we make it 1

Parameters
PlayNotes(noteNumbers: Integer array, velocity: Integer, channel: Integer, startTimeMS: Integer, duration: Integer)

Play a collection of note at startTimeMS and stop them durationMS later. If duration is less than 1 then we make it 1

Parameters
SendLater(m: MidiMessage, delayInMS: Double) Autotype

Schedule a MIDI event to be sent out in the future - only for use in a Scriptlet

Parameters
SendNotesNow(noteNumbers: Integer array, velocity: Integer, channel: Integer)

Play a collection of notes now

Parameters
SendNow(m: MidiMessage) Autotype

Send a MIDI event out immediately - only for use in a Scriptlet

Parameters

m (MidiMessage) –

SendSysexNow(m: SysexMessage) Autotype

Send a MIDI sysex message out immediately

Parameters

m (SysexMessage) –

SetDisplayMessage(value: String)

Displays a message at the bottom of a Scriptlet editor window

Parameters

value (String) –

SetInfoMessage(value: String)

Defines an info message to be displayed when user clicks on I button

Parameters

value (String) –

Sequencing

MidiSequence_CollectEventsNow(sequence: MidiSequence)

Collect events at the current position - Experimental - not yet supported - do not even ask!

Parameters

sequence (MidiSequence) –

MidiSequence_EndOfSong(sequence: MidiSequence) Returns Boolean

True if there are no more events in track - Experimental - not yet supported - do not even ask!

Parameters

sequence (MidiSequence) –

Return type

Boolean

MidiSequence_FollowGlobalTranspose(sequence: MidiSequence, trackNumber: Integer, follow: Boolean)

When true MIDI note events will be transposed by the global transpose amount

Parameters
MidiSequence_GetCurrentBar(sequence: MidiSequence) Returns Integer

Returns the current bar - Experimental - not yet supported - do not even ask!

Parameters

sequence (MidiSequence) –

Return type

Integer

MidiSequence_GetCurrentBeat(sequence: MidiSequence) Returns Integer

Returns the current beat of the current bar - Experimental - not yet supported - do not even ask!

Parameters

sequence (MidiSequence) –

Return type

Integer

MidiSequence_GetCurrentEvents(sequence: MidiSequence, trackNumber: Integer) Returns MidiMessage array

Access the current events at the current grid position for the specified track - Experimental - not yet supported - do not even ask!

Parameters
Return type

MidiMessage array

MidiSequence_GetCurrentTick(sequence: MidiSequence) Returns Integer

Returns the current tick offset - Experimental - not yet supported - do not even ask!

Parameters

sequence (MidiSequence) –

Return type

Integer

MidiSequence_GetResolution(sequence: MidiSequence)

Get the base resolution of the sequence - Experimental - not yet supported - do not even ask!

Parameters

sequence (MidiSequence) –

MidiSequence_GetTrackCount(sequence: MidiSequence) Returns Integer

Returns the number of tracks in a loaded MIDI file - Experimental - not yet supported - do not even ask!

Parameters

sequence (MidiSequence) –

Return type

Integer

MidiSequence_LoadMidiFile(sequence: MidiSequence, fromFile: String) Returns Integer

Loads a midi file and returns the number of tracks - Experimental - not yet supported - do not even ask!

Parameters
Return type

Integer

MidiSequence_MapOutputChannel(sequence: MidiSequence, trackNumber: Integer, channel: Integer)

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
MidiSequence_Quantize(sequence: MidiSequence, q: Integer)

Grid quantize - 1 2 4 8 16 - Experimental - not yet supported - do not even ask!

Parameters
MidiSequence_ResetToStart(sequence: MidiSequence)

Reset to the beginning of the track - Experimental - not yet supported - do not even ask!

Parameters

sequence (MidiSequence) –

Songs

GetCurrentSetlistName() Returns String

Get the name of the current setlist

Return type

String

GetCurrentSongIndex() Returns Integer

Get the index of the current song - negative 1 if it does not exist

Return type

Integer

GetCurrentSongName() Returns String

Get the name of the current song

Return type

String

GetCurrentSongPart() Returns Integer

Get the index of the current song part

Return type

Integer

GetCurrentSongPartName() Returns String

Get the name of the current song part

Return type

String

GetSongArtistName(index: Integer) Returns String

Get the artist name of the song at the given index

Parameters

index (Integer) –

Return type

String

GetSongBPM(index: Integer) Returns Double

Get the BPM of the song at the given index

Parameters

index (Integer) –

Return type

Double

GetSongCount() Returns Integer

Returns the number of songs in the current setlist

Return type

Integer

GetSongIndex(songname: String) Returns Integer

Get the index of the song for the given name - negative 1 if it does not exist

Parameters

songname (String) –

Return type

Integer

GetSongKeySignature(index: Integer) Returns String

Get the key signature of the song at the given index

Parameters

index (Integer) –

Return type

String

GetSongName(index: Integer) Returns String

Get the name of the song at the given index

Parameters

index (Integer) –

Return type

String

GetSongPartCount() Returns Integer

Returns the number of parts in the current song

Return type

Integer

GetSongPartName(index: Integer) Returns String

Get the name of the song part at the given index

Parameters

index (Integer) –

Return type

String

GetSongTimeSigDenominator(index: Integer) Returns Integer

Get the denominator of the time signature of the song at the given index

Parameters

index (Integer) –

Return type

Integer

GetSongTimeSigNumerator(index: Integer) Returns Integer

Get the numerator of the time signature of the song at the given index

Parameters

index (Integer) –

Return type

Integer

GetSongTranspose(index: Integer) Returns Integer

Get the transpose amount of the song at the given index

Parameters

index (Integer) –

Return type

Integer

InSetlistMode() Returns Boolean

Returns whether we are currently in setlist mode

Return type

Boolean

NextSong()

Move to the next song

PrevSong()

Move to the previous song

SetSongPart(index: Integer)

Switch to another part in the current song

Parameters

index (Integer) –

SongMoveDown()

Move to the next part or next song if allowed

SongMoveUp()

Move to the previous part or previous song if allowed

SongNextPart()

Move to the next song part of the current song

SongPrevPart()

Move to the previous song part of the current song

SwitchToSongByIndex(songIndex: Integer, partIndex: Integer) Returns Boolean

Switch to the specified song and part

Parameters
Return type

Boolean

Strings

BoolToString(b: Boolean) Returns String

Returns a string representation of a boolean value

Parameters

b (Boolean) –

Return type

String

CopySubstring(source: String, startIndex: Integer, length: Integer) Returns String

Return the section of the source string based on the start index and desired length

Parameters
Return type

String

DoubleToString(d: Double, places: Integer) Returns String

Converts a double to a string with the specified number of places

Parameters
Return type

String

FileExists(filename: String) Returns Boolean

Check if a file exists - experimental and unsupported - this could easily blow up Gig Performer or overwrite - returns whether saved

Parameters

filename (String) –

Return type

Boolean

GigPerformerDocumentsFolder() Returns String

Returns the root folder where GP content is stored

Return type

String

IndexOfSubstring(source: String, substring: String, caseSensitive: Boolean) Returns Integer

Return the zero-based index of the substring or -1 if substring not found

Parameters
Return type

Integer

IntTo7BitHexString(i: Integer, minByteLength: Integer) Returns String

Converts an integer number to at least minByteLength sequence of 7 bit hex bytes - intended for use with sysex messages

Parameters
Return type

String

IntToHex(i: Integer) Returns String

Converts an integer number to its hex equivalent

Deprecated

Use IntToHexString()

Parameters

i (Integer) –

Return type

String

IntToHexString(i: Integer) Returns String

Converts an integer number to its hex equivalent

Parameters

i (Integer) –

Return type

String

IntToString(i: Integer) Returns String

Returns a string representation of an integer value

Parameters

i (Integer) –

Return type

String

Length(s: String) Returns Integer

Returns the length of a string

Parameters

s (String) –

Return type

Integer

LoadStringFromTextFile(filename: String) Returns String

Load the contents of a file into a string - experimental and unsupported - this could easily blow up Gig Performer

Parameters

filename (String) –

Return type

String

MapValueToDiscreteString(x: Double, values: String array) Returns String

Select a string based on the proportional fractional value between 0.0 and 1.0

Parameters
Return type

String

NoteNameToNoteNumber(s: String) Returns Integer

returns integer value of a note name

Parameters

s (String) –

Return type

Integer

NoteNumberToNoteName(i: Integer) Returns String

Returns a string representation of an integer note number

Parameters

i (Integer) –

Return type

String

ParseCSVString(line: String) Returns String array

Breaks up a single line of a CSV into its parts

Parameters

line (String) –

Return type

String array

ReplaceString(source: String, replaceThis: String, withThat: String, caseSensitive: Boolean) Returns String

Replace a substring with another string

Parameters
Return type

String

ReplaceStringSection(source: String, startIndex: Integer, length: Integer, newSubstring: String) Returns String

Extract a substring defined by startIndex and length and insert a new substring into that position

Parameters
Return type

String

SaveStringToTextFile(filename: String, text: String) Returns Boolean

Save a string to a file - experimental and unsupported - this could easily blow up Gig Performer or overwrite - returns whether saved

Parameters
Return type

Boolean

StringAfterFirstOccurence(source: String, substringToStartFrom: String, includeSubstring: Boolean, ignoreCase: Boolean) Returns String

Return the section of the source string after the first occurrence of substringToStartFrom - optionally including the substring

Parameters
Return type

String

StringAfterFirstOccurrence(source: String, substringToStartFrom: String, includeSubstring: Boolean, ignoreCase: Boolean) Returns String

Return the section of the source string after the first occurrence of substringToStartFrom - optionally including the substring

Parameters
Return type

String

StringAfterLastOccurence(source: String, substringToFind: String, includeSubstring: Boolean, ignoreCase: Boolean) Returns String

Return the section of the source string after the last occurrence of substringToFind - optionally including the substring

Parameters
Return type

String

StringAfterLastOccurrence(source: String, substringToFind: String, includeSubstring: Boolean, ignoreCase: Boolean) Returns String

Return the section of the source string after the last occurrence of substringToFind - optionally including the substring

Parameters
Return type

String

StringToBool(s: String) Returns Boolean

returns true if string - “true” otherwise false

Parameters

s (String) –

Return type

Boolean

StringToDouble(s: String) Returns Double

returns double value of string

Parameters

s (String) –

Return type

Double

StringToHex(s: String) Returns String

Converts text characters to their hex equivalent values - intended for use with sysex messages

Deprecated

Use StringToHexString()

Parameters

s (String) –

Return type

String

StringToHexString(s: String) Returns String

Converts text characters to their hex equivalent values - intended for use with sysex messages

Parameters

s (String) –

Return type

String

StringToInt(s: String) Returns Integer

returns integer value of string

Parameters

s (String) –

Return type

Integer

StringUpToFirstOccurence(source: String, substringToEndWith: String, includeSubstring: Boolean, ignoreCase: Boolean) Returns String

Return the section of the source string up to the first occurrence of substringToEndWith - optionally including the substring

Parameters
Return type

String

StringUpToFirstOccurrence(source: String, substringToEndWith: String, includeSubstring: Boolean, ignoreCase: Boolean) Returns String

Return the section of the source string up to the first occurrence of substringToEndWith - optionally including the substring

Parameters
Return type

String

StringUpToLastOccurence(source: String, substringToFind: String, includeSubstring: Boolean, ignoreCase: Boolean) Returns String

Return the section of the source string up to the last occurrence of substringToFind - optionally including the substring

Parameters
Return type

String

StringUpToLastOccurrence(source: String, substringToFind: String, includeSubstring: Boolean, ignoreCase: Boolean) Returns String

Return the section of the source string up to the last occurrence of substringToFind - optionally including the substring

Parameters
Return type

String

ToLowercase(s: String) Returns String

returns double value of string

Parameters

s (String) –

Return type

String

ToUppercase(s: String) Returns String

returns double value of string

Parameters

s (String) –

Return type

String

TrimString(source: String) Returns String

Remove leading and trailing spaces from a string

Parameters

source (String) –

Return type

String

Sysex

SM_ChangeValue(sm: SysexMessage, index: Integer, newValue: Integer)

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_CreateSysex(sm: SysexManager, m: SysexMessage) Autotype

Store a sysex message efficiently for manipulation and sending

Deprecated

It is no longer necessary to create sysex objects

Parameters
SM_CreateSysexFromString(sm: SysexManager, s: String)

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_GetByte(sm: SysexMessage, index: Integer) Returns Integer

Gets the byte at the specified index

Deprecated

Use SM_GetValue()

Parameters
Return type

Integer

SM_GetValue(sm: SysexMessage, index: Integer) Returns Integer

Gets the byte at the specified index

Parameters
Return type

Integer

SM_GetValues(sm: SysexMessage, first: Integer, second: Integer) Returns Integer

Gets the combined bytes starting at the specified index

Parameters
Return type

Integer

SM_Length(sm: SysexMessage) Returns Integer

Returns the length of a system message

Parameters

sm (SysexMessage) –

Return type

Integer

SM_Pretty(m: SysexMessage, blockSize: Integer, uppercase: Boolean) Returns String

Returns a nicely formatted sysex message - possibly breaking it up into small blocks between 1 and 8 - blocksize of 0 will display indexing

Parameters
Return type

String

SM_SendMidiIn(sm: SysexMessage, midiIn: MidiInBlock)

Send a stored sysex message from a MidiIn block

Deprecated

Use SendSysexInternalNow()

Parameters
SM_SendMidiOut(sm: SysexMessage, midiOut: MidiOutBlock)

Send a stored sysex message from a MidiOut block to an external MIDI device

Deprecated

SendSysexExternal

Parameters
SM_SendMidiOutNow(midiOut: MidiOutBlock, sm: SysexMessage)

Send a sysex message through a MidiOut block to an external MIDI device

Deprecated

SendSysexExternal

Parameters
SendSysexExternal(p: MidiOutBlock, m: SysexMessage)

Send a MIDI sysex message out immediately through a MIDI Out block

Parameters
SendSysexInternal(p: MidiInBlock, m: SysexMessage)

Send a MIDI sysex message out immediately from a MIDI In block

Deprecated

Use SendSysexInternalNow()

Parameters
SendSysexInternalLater(p: MidiInBlock, m: SysexMessage, delayInMS: Double)

Send a MIDI sysex message out at some specified time in the future from a MIDI In block

Parameters
SendSysexInternalNow(p: MidiInBlock, m: SysexMessage)

Send a MIDI sysex message out immediately from a MIDI In block

Parameters
SendSysexNowToMidiOutDevice(deviceName: String, m: SysexMessage) Autotype

Send a MIDI sysex message out immediately through a MIDI output device

Parameters

System

AltKeyDown() Returns Boolean

See if alt key is down

Return type

Boolean

ClearLogWindow()

Clear the script log window - duh!

ClockTime() Returns Double

Gets the current time in milliseconds

Return type

Double

CloseLogWindow()

Close the script log window - duh!

CloseScriptWindow()

Close the script editor window - if open - for the current rackspace

EnableMetronome(enable: Boolean)

Turn the metronome on or off

Parameters

enable (Boolean) –

EnablePlayhead(enable: Boolean)

Start or stop the global playhead

Parameters

enable (Boolean) –

FormatTime(timeInMS: Double, format: String) Returns String

Returns a formatted timestamp from a given time in milliseconds

Parameters
Return type

String

GetBPM() Returns Double

Returns the current global BPM value

Return type

Double

GetGlobalTranspose() Returns Integer

Get the current transpose value

Return type

Integer

GetMetronomeVolume() Returns Double

Get the metronome volume

Return type

Double

GetTimeSigDenominator() Returns Integer

Get the denominator of the global time signature

Return type

Integer

GetTimeSigNumerator() Returns Integer

Get the numerator of the global time signature

Return type

Integer

IsMetronomeEnabled() Returns Boolean

See if metronome is running

Return type

Boolean

IsPlayheadEnabled() Returns Boolean

Indicates whether the playhead is running

Return type

Boolean

ModifierKeys() Returns Integer

Returns the state of the various modifier keys: 1-Shift 2-Ctrl 4-Option 8-Cmd

Return type

Integer

Notify(s: String)

Displays a message on main window that will fade out

Parameters

s (String) –

OpenLogWindow()

Open the script log window - duh!

OpenScriptWindow()

Open the script editor window for the current rackspace

Panic()

Stop all notes in the current rackspace

PlayNote(p: MidiInBlock, noteNumber: Integer, velocity: Integer, channel: Integer, startTimeMS: Integer, duration: Integer)

Send a noteOn event at startTimeMS and a noteOff event at durationMS later. If duration is less than 1 then we make it 1

Parameters
PlayNotes(p: MidiInBlock, noteNumbers: Integer array, velocity: Integer, channel: Integer, startTimeMS: Integer, duration: Integer)

Play a collection of note at startTimeMS and stop them durationMS later. If duration is less than 1 then we make it 1

Parameters
Print(s: String) Autotype

Displays the string in the GPScript Logger window

Parameters

s (String) –

RecordInputs(enable: Boolean)

Start or stop recording audio input to file

Parameters

enable (Boolean) –

ScheduleMidiEvent(p: MidiInBlock, m: MidiMessage, delayInMS: Double) Autotype

Schedule a MIDI event to be reprocessed at some specified time in the future

Parameters
SendLater(p: MidiInBlock, m: MidiMessage, delayInMS: Double) Autotype

Schedule a MIDI event to be sent out at some specified time in the future

Parameters
SendNoteMessageWithTranspositionsLater(p: MidiInBlock, m: NoteMessage, transpositions: Integer array, delayInMS: Double)

Send multiple MIDI noteon or noteoff events out some milliseconds later using note number added to each offset in the array

Parameters
SendNoteMessageWithTranspositionsNow(p: MidiInBlock, m: NoteMessage, transpositions: Integer array)

Send multiple note on or note off events out immediately using note number added to each offset in the array

Parameters
SendNoteMessagesLater(p: MidiInBlock, noteNumbers: Integer array, velocity: Integer, channel: Integer, delayInMS: Double)

Create a chord of note on or off events using the array of note numbers and send it out some milliseconds later

Parameters
SendNoteMessagesNow(p: MidiInBlock, noteNumbers: Integer array, velocity: Integer, channel: Integer)

Create a chord of note on or off events using the array of note numbers and send it out immediately

Parameters
SendNowExternal(p: MidiOutBlock, m: MidiMessage) Autotype

Send a MIDI event out immediately through a MIDI Out block

Parameters
SendNowRespectingParameters(p: MidiInBlock, m: MidiMessage) Autotype

Send a MIDI event out after applying MidiInBlock parameters

Parameters
SetBPM(bpm: Double) Autotype

Set the global BPM value

Parameters

bpm (Double) –

SetGlobalTranspose(semitones: Integer)

Transpose all incoming MIDI messages by semitones amount

Parameters

semitones (Integer) –

SetMetronomeVolume(volume: Double)

Set the metronome volume

Parameters

volume (Double) –

SetTimeSignatureDenominator(denominator: Integer)

Set the denominator of global time signature

Parameters

denominator (Integer) –

SetTimeSignatureNumerator(numerator: Integer)

Set the numerator of the global time signature

Parameters

numerator (Integer) –

SetWindowTitle(title: String)

Changes the default rackspace title to the title

Parameters

title (String) –

Shell(command: String) Returns Integer

Run an OS Shell command (Mac only) returning an integer indicating success or failure

Parameters

command (String) –

Return type

Integer

ShellEx(command: String) Returns String

Run an OS Shell command (Mac only) that returns the output of the command

Parameters

command (String) –

Return type

String

ShiftKeyDown() Returns Boolean

See if shift key is down

Return type

Boolean

ShowChordProWindow(show: Boolean)

Show or hide the ChordPro Window

Parameters

show (Boolean) –

SwitchToProgramNumber(programNumber: Integer, bankNumber: Integer)

Switch to zero-based program number and bank Number if latter is greater than -1

Parameters
Tap()

Simulates tap tempo command

TimeNow() Returns Integer

Gets the current time in milliseconds - deprecated

Deprecated

Use TimeSinceStartup()

Return type

Integer

TimeSinceStartup() Returns Double

Gets the time since computer was started in milliseconds

Return type

Double

Widgets

BindExternalWidget(ew: ExternalWidget, widgetName: String, rackspaceName: String) Returns Boolean

Access a widget in another rackspace - boolean return value indicates whether widget was found - experimental

Parameters
Return type

Boolean

BindWidget(ew: ExternalWidget, widgetName: String) Returns Boolean

Access a widget in the rackspace containing this scriptlet - boolean return value indicates whether widget was found - experimental

Parameters
Return type

Boolean

GetExternalWidgetValue(ew: ExternalWidget) Returns Double

Get the current value of an external widget - experimental

Parameters

ew (ExternalWidget) –

Return type

Double

GetWidgetBounds(p: Widget, bounds: Integer array)

Fill the first four fields of the bounds array with the widget position and size on a panel

Parameters
GetWidgetCurveValue(w: Widget, x: Double)    Autotype Returns Double

For some value x - returns the y value of a widget after applying the scale curve to it

Parameters
Return type

Double

GetWidgetLabel(w: Widget) Returns String

Get the label of a widget

Parameters

w (Widget) –

Return type

String

GetWidgetPreviousValue(w: Widget)    Autotype Returns Double

Gets the previous value (position) of the widget. The value will be between 0.0 and 1.0

Parameters

w (Widget) –

Return type

Double

GetWidgetResetValue(w: Widget)    Autotype Returns Double

Gets the reset value of the widget

Parameters

w (Widget) –

Return type

Double

GetWidgetScriptName(p: Widget) Returns String

Gets the scripting name of this widget. Useful when widget is passed as a parameter somewhere

Parameters

p (Widget) –

Return type

String

GetWidgetValue(w: Widget)    Autotype Returns Double

Gets the current value (position) of the widget. The value will be between 0.0 and 1.0

Parameters

w (Widget) –

Return type

Double

RedrawWidgetCurve(w: Widget)

Redraw the curve after making changes to it

Parameters

w (Widget) –

ResetWidgetValue(p: Widget) Autotype

Reset the widget to its default value - same as double clicking on the widget

Parameters

p (Widget) –

ResyncWidget(p: Widget) Autotype

Resend the message to sync an external associated physical control with the widget

Parameters

p (Widget) –

SetExternalWidgetValue(ew: ExternalWidget, newValue: Double)

Set the current value of an external widget - experimental

Parameters
SetExternalWidgetValueEx(ew: ExternalWidget, newValue: Double)

Set the current value of an external widget - experimental - uses modulo arithmetic

Parameters
SetWidgetBounds(p: Widget, bounds: Integer array)

Set a widget x y width height on a panel from the first four fields of the bound array

Parameters
SetWidgetCurveValue(w: Widget, x: Double, y: Double) Autotype

Returns the value of a widget after applying the scale curve to it

Parameters
SetWidgetLabel(w: Widget, text: String) Autotype

Set the label of a widget

Parameters
SetWidgetResetValue(p: Widget, value: Double) Autotype

Set the reset value of any widget

Parameters
SetWidgetValue(p: Widget, value: Double) Autotype

Set the current value of any widget

Parameters
SetWidgetValueEx(p: Widget, value: Double) Autotype

Set the current value of any widget - uses modulo arithmetic

Parameters

Windows

GPWindowToBack()

Put this GP main window behind other windows

GPWindowToFront()

Bring this GP window to the front

GPWindowVisible(visible: Boolean)

Show or hide GP window

Parameters

visible (Boolean) –

GetGPWindowKioskMode() Returns Boolean

Get whether Gig Performer is in kiosk mode

Return type

Boolean

GetGPWindowState() Returns String

Get the current state of the main window

Return type

String

GetGPWindowVisible() Returns Boolean

See if main window is visible

Return type

Boolean

MinimizeOrRestoreGPWindow(minimize: Boolean)

Minimize or restore the GP main window

Parameters

minimize (Boolean) –

SetGPWindowFullScreen(fullScreen: Boolean)

Make the GP window be full screen or not fullscreen

Parameters

fullScreen (Boolean) –

SetGPWindowKioskMode(kiosk: Boolean)

Make the GP window be kiosk or not kiosk

Parameters

kiosk (Boolean) –

SetGPWindowState(state: String)

Set the state of the main window

Parameters

state (String) –