Index to all GPScript runtime library functions as of 02:20PM on April 11, 2024

Note: if the above date is newer than the last release date, some of these functions may not yet available in your current version.
Functions displayed in red have been deprecated.

The GP Script Language Reference manual can be found here.

Function list by category



Ableton

AbletonLink_Enable    AbletonLink_Enabled   

Actions

ClearSongPartSnapshot    CloseAllPluginWindows   

GlobalRackspaceVisible   

InPanelView    InSetlistView    InWiringView   

Next   

Previous    PushSnapshotToVariation   

SaveGigfile    ScrollFrontPanel    ScrollRackspaces    ScrollSetlist    ShowGlobalRackspace    ShowRigManager    SwitchToPanelView    SwitchToSetlistView    SwitchToWiringView   

TakeSongPartSnapshot    ToggleTunerVisible   

Arrays

AppendBoolean    AppendDouble    AppendInteger    AppendString   

ClearArray   

IndexOf   

LargestDouble    LargestInt   

RemoveLast    Reverse   

Size    SmallestDouble    SmallestInt    Sort   

iMax    iMin   

AudioMixer

AudioMixer_GetChannelStripName    AudioMixer_GetNumberOfChannelStrips    AudioMixer_SetChannelStripName   

ChordPro

ChordPro_GoToFractionOfPage    ChordPro_GotoLine    ChordPro_GotoMarker    ChordPro_GotoSongPart   

ExternalApplication

EA_AddArgument    EA_ClearAllArgs    EA_SetProgramName    EA_Start    EA_Stop   

Generators

EnableGenerator   

GetADSRAttackLevel    GetADSRAttackTime    GetADSRDecayTime    GetADSRReleaseTime    GetADSRSustainLevel    GetGeneraterAmplitude    GetGeneratorAmplitude    GetTimersRunning   

InitADSR    IsGeneratorEnabled   

SetADSRAttackLevel    SetADSRAttackTime    SetADSRDecayTime    SetADSRReleaseTime    SetADSRSustainLevel    SetGeneratorCoarseness    SetGeneratorFrequency    SetGeneratorLength    SetGeneratorOneShot    SetTimersRunning    StartAttackPhase    StartReleasePhase    StopOneShotRamp   

TriggerOneShotRamp   

Graphics

ColorToRGB   

RGBToColor   

MIDI

AllNotesOff    AllNotesOff   

BetweenNotes   

GetAfterTouchValue    GetByte    GetCCNumber    GetCCValue    GetChannel    GetMidiInDeviceCount    GetMidiInDeviceFromRigManager    GetMidiInDeviceName    GetMidiMessageSize    GetMidiOutDeviceCount    GetMidiOutDeviceName    GetNoteNumber    GetPitchBendValue    GetPolyTouchNoteNumber    GetPolyTouchNotePressure    GetProgramChangeNumber    GetReleaseVelocity    GetVelocity   

InjectMidiEvent    InjectMidiEventViaRigManager    InjectSysexEvent    InjectSysexEventViaRigManager    IsAfterTouch    IsController    IsNote    IsNoteOff    IsNoteOn    IsPitchBend    IsPolyTouch    IsProgramChange   

MakeAfterTouchMessage    MakeAfterTouchMessageEx    MakeControlChangeMessage    MakeControlChangeMessageEx    MakeMidiMessage    MakeMidiMessage1    MakeMidiMessage2    MakeMidiMessage3    MakeNoteMessage    MakeNoteMessageEx    MakePitchBendMessage    MakePitchBendMessageEx    MakePolyTouchMessage    MakePolyTouchMessageEx    MakeProgramChangeMessage    MakeProgramChangeMessageEx    MidiInDeviceExists    MidiOutDeviceExists   

ReinterpretAsAfterTouch    ReinterpretAsControllerMessage    ReinterpretAsNoteOffMessage    ReinterpretAsNoteOnMessage    ReinterpretAsPitchBend    ReinterpretAsPolyTouchMessage    ReinterpretAsProgramChange   

SendNow    SendNowToMidiOutDevice   

Transpose   

WithCCNumber    WithCCValue    WithChannel    WithNoteNumber    WithNoteNumberAndVelocity    WithProgramChangeNumber    WithTranspose    WithVelocity   

Math

ACos    ASin    ATan    Abs   

CC_LoadFromFile    CC_SaveToFile    CC_Scale    Ceiling    Cos   

DecibelToLinear   

Exp   

Floor   

IntToFloat   

LinearToDecibel    Ln    Log   

Max    MidiToParam    MidiToParamEx    Min   

ParamToMidi    ParamToMidiEx    Power   

Random    RandomRange    Round   

Scale    ScaleInt    ScaleRange    ScaleRangeEx    Sign    Sin    Sqrt   

Tan    ThresholdDetector_Detect    ThresholdDetector_Setup   

MultiChannelNoteTracker

MultiChannelNoteTracker_Clear    MultiChannelNoteTracker_GetHeldNotes    MultiChannelNoteTracker_GetSpecificNoteOnCount    MultiChannelNoteTracker_GotMidiMessage    MultiChannelNoteTracker_GotNote    MultiChannelNoteTracker_GotNoteOff    MultiChannelNoteTracker_GotNoteOn    MultiChannelNoteTracker_IsNoteOffPending    MultiChannelNoteTracker_NoteOnCount    MultiChannelNoteTracker_StopAllPendingNotes    MultiChannelNoteTracker_StopAllPendingNotes   

NoteManagement

AddChordInterval    AutoSustainer_GetHeldNotes    AutoSustainer_Play    AutoSustainer_RespectParameters    AutoSustainer_SetTarget    AutoSustainer_Stop   

FindChordName   

NoteMapper_CreateScale    NoteMapper_GetMappedNotes    NoteMapper_MapNote    NoteMapper_MapNoteToChord    NoteMapper_MapNotes    NoteMapper_Reset   

RemoveChordInterval   

NoteTracker

ClearNoteTracker   

GotNote    GotNoteOff    GotNoteOn   

NoteOnCount    NoteTracker_Clear    NoteTracker_GetHeldNotes    NoteTracker_GetSpecificNoteOnCount    NoteTracker_GotNote    NoteTracker_GotNoteOff    NoteTracker_GotNoteOn    NoteTracker_IsNoteOffPending    NoteTracker_NoteOnCount    NoteTracker_StopAllPendingNotes    NoteTracker_StopAllPendingNotes   

StopAllPendingNotes    StopAllPendingNotes   

OSC

OSC_AppendDoubleArg    OSC_AppendIntArg    OSC_AppendStringArg    OSC_ArgCount    OSC_ClearArgs    OSC_Enabled    OSC_GetArgAsDouble    OSC_GetArgAsInteger    OSC_GetArgAsString    OSC_GetGPListeningPort    OSC_GetIPAddressFromTargetName    OSC_GetPortNumberFromTargetName    OSC_GetTargetNames    OSC_Send    OSC_SendCommand    OSC_SendCommandSpecific    OSC_SendDouble    OSC_SendDoubleSpecific    OSC_SendInteger    OSC_SendIntegerSpecific    OSC_SendSpecific    OSC_SendString    OSC_SendStringSpecific    OSC_SetAddress    OSC_TargetNameExists   

Plugins

ClosePlugin   

GetActivePreset    GetGPPresetList    GetGPPresetListCount    GetMaxNoteFromMidiInBlock    GetMinNoteFromMidiInBlock    GetParameter    GetParameterCount    GetParameterName    GetParameterText    GetPluginCaption    GetPluginInfo    GetPresetCount    GetPresetName    GetTransposeFromMidiInBlock    GetVelocityCurveValue   

IsPluginBypassed   

LoadGPPreset   

OpenPlugin   

PromptToLoadGPUserPreset    PromptToSaveGPUserPreset   

RefreshWidgetsMappedToPlugin    ReplacePlugin   

SaveGPPreset    SelectPreset    SetParameter    SetPluginBypassed    SetPluginCaption    SetPluginEditorXYPosition   

Rackspaces

GetCurrentProgramChangeOrBankNumber    GetCurrentRackspaceIndex    GetCurrentVariation    GetRackspaceBPM    GetRackspaceCount    GetRackspaceIndex    GetRackspaceName    GetRackspaceNameAtIndex    GetVariationCount    GetVariationCountForRackspaceAtIndex    GetVariationName    GetVariationNameForRackspaceAtIndex   

NextRackspace    NextVariation   

PreviousRackspace    PreviousVariation   

SetVariation    SwitchToNextRack    SwitchToNextVariation    SwitchToPreset    SwitchToPrevRack    SwitchToPrevVariation    SwitchToRack    SwitchToRackspace    SwitchToRackspaceByName   

UpdateRackspaceBPM   

ScriptletBlock

BroadcastPluginParameters   

GetContinuousPreviousValue    GetDiscreteParameterItem    GetDiscreteParameterItemCount    GetDiscretePreviousValue    GetIndexOfDiscreteParameterItem    GetIndexOfSubrangeParameterItem    GetParameterCount    GetParameterName    GetSubrangeParameterItem    GetSubrangeParameterItemCount    GetSubrangePreviousValue    GetUserVariable   

OverrideParameterText   

PlayNote    PlayNotes   

SendLater    SendNotesNow    SendNow    SendSysexNow    SetDisplayMessage    SetInfoMessage   

Sequencing

MidiSequence_CollectEventsNow    MidiSequence_EndOfSong    MidiSequence_FingerTap    MidiSequence_FollowGlobalTranspose    MidiSequence_GetCurrentBar    MidiSequence_GetCurrentBeat    MidiSequence_GetCurrentEvents    MidiSequence_GetCurrentTick    MidiSequence_GetResolution    MidiSequence_GetSongLength    MidiSequence_GetTrackCount    MidiSequence_LoadMidiFile    MidiSequence_LoadStandardMidiFile    MidiSequence_MapOutputChannel    MidiSequence_Quantize    MidiSequence_ResetToStart    MidiSequence_ScriptletFingerTap   

Songs

GetChordProFileName    GetCurrentSetlistIndex    GetCurrentSetlistName    GetCurrentSongIndex    GetCurrentSongName    GetCurrentSongPart    GetCurrentSongPartIndex    GetCurrentSongPartName    GetSetlistCount    GetSetlistName    GetSongArtistName    GetSongBPM    GetSongCount    GetSongIndex    GetSongKeySignature    GetSongName    GetSongPartCount    GetSongPartName    GetSongPartTimeSigDenominator    GetSongPartTimeSigNumerator    GetSongTimeSigDenominator    GetSongTimeSigNumerator    GetSongTranspose   

InSetlistMode   

NextSong   

PrevSong   

SetArtistName    SetSongInformation    SetSongName    SetSongPart    SetSongPartName    SongMoveDown    SongMoveUp    SongNextPart    SongPrevPart    SwitchToSetlistByIndex    SwitchToSetlistByName    SwitchToSongByIndex   

Strings

BoolToString   

CopySubstring   

DoubleToString   

FileExists   

GetEnvVariable    GigPerformerDocumentsFolder   

IndexOfSubstring    IntTo7BitHexString    IntToHex    IntToHexString    IntToString   

Length    LoadStringFromTextFile   

MapValueToDiscreteString   

NoteNameToNoteNumber    NoteNumberToNoteName   

ParseCSVString   

ReplaceString    ReplaceStringSection   

SaveStringToTextFile    SetEnvVariable    StringAfterFirstOccurence    StringAfterFirstOccurrence    StringAfterLastOccurence    StringAfterLastOccurrence    StringToBool    StringToDouble    StringToHex    StringToHexString    StringToInt    StringUpToFirstOccurence    StringUpToFirstOccurrence    StringUpToLastOccurence    StringUpToLastOccurrence   

TimeStringToDouble    ToLowercase    ToUppercase    TrimString   

Sysex

SM_ChangeValue    SM_CreateSysex    SM_CreateSysexFromString    SM_GetByte    SM_GetValue    SM_GetValues    SM_Length    SM_Pretty    SM_SendMidiIn    SM_SendMidiOut    SM_SendMidiOutNow    SendSysexExternal    SendSysexInternal    SendSysexInternalLater    SendSysexInternalNow    SendSysexNowToMidiOutDevice   

System

AltKeyDown   

ClearLogWindow    ClockTime    CloseLogWindow    CloseScriptWindow   

DisplayTemporaryMessage   

EnableMetronome    EnablePlayhead   

FormatTime   

GetBPM    GetGlobalTranspose    GetMetronomeVolume    GetTimeSigDenominator    GetTimeSigNumerator   

InEditMode    InTunerView    IsGigLoading    IsMetronomeEnabled    IsPlayheadEnabled    IsRecording   

ModifierKeys   

Notify   

OpenLogWindow    OpenScriptWindow   

Panic    PlayNote    PlayNotes    Print   

RecordInputs   

ScheduleMidiEvent    SendLater    SendNoteMessageWithTranspositionsLater    SendNoteMessageWithTranspositionsNow    SendNoteMessagesLater    SendNoteMessagesNow    SendNowExternal    SendNowRespectingParameters    SetBPM    SetGlobalTranspose    SetMetronomeVolume    SetTimeSignatureDenominator    SetTimeSignatureNumerator    SetWindowTitle    Shell    ShellEx    ShiftKeyDown    ShowChordProWindow    Sleep    StartRecording    StopRecording    SwitchToProgramNumber    SwitchToProgramNumberEx   

Tap    TestSomething    TimeNow    TimeSinceStartup   

Widgets

BindExternalWidget    BindWidget   

GetExternalWidgetHideState    GetExternalWidgetLabel    GetExternalWidgetValue    GetLabelColor    GetWidgetBounds    GetWidgetCurveValue    GetWidgetFillColor    GetWidgetHideState    GetWidgetLabel    GetWidgetMappedParameterValue    GetWidgetOutlineColor    GetWidgetOutlineRoundness    GetWidgetOutlineThickness    GetWidgetPluginMappedParameterNumber    GetWidgetPreviousValue    GetWidgetResetValue    GetWidgetScriptName    GetWidgetValue   

MapWidgetToPlugin   

RedrawWidgetCurve    ResetWidgetValue    ResyncWidget   

SendWidgetToBack    SendWidgetToFront    SetExternalWidgetHideOnPresentation    SetExternalWidgetLabel    SetExternalWidgetValue    SetExternalWidgetValueEx    SetLabelColor    SetWidgetBounds    SetWidgetBoundsFromOtherWidget    SetWidgetCurveValue    SetWidgetFillColor    SetWidgetHideOnPresentation    SetWidgetLabel    SetWidgetOutlineColor    SetWidgetOutlineRoundness    SetWidgetOutlineThickness    SetWidgetResetValue    SetWidgetValue    SetWidgetValueEx   

Windows

GPWindowToBack    GPWindowToFront    GPWindowVisible    GetGPWindowKioskMode    GetGPWindowState    GetGPWindowVisible   

MinimizeOrRestoreGPWindow   

SetGPWindowFullScreen    SetGPWindowKioskMode    SetGPWindowState   

WiringOperations

ChangeSelectedPluginBusLayout   

DuplicateSelectedPlugin   

InsertFavoriteAtMousePosition   

QuickInsertPlugin    QuickReplaceSelectedPlugin   

RemoveSelectedPlugin    RenameSelectedPlugin   

ShowEditorForSelectedPlugin   

List of GPScript built-in functions

ACos : Returns the inverse cos of x

(Back to top)

ASin : Returns the inverse sin of x

(Back to top)

ATan : Returns the inverse tan of x

(Back to top)

AbletonLink_Enable : Enable or disable Ableton Link

(Back to top)

AbletonLink_Enabled : Returns whether Ableton Link is enabled

(Back to top)

Abs : Returns the absolute value of x

(Back to top)

AddChordInterval : Add a user defined chord interval to the chord dictionary

(Back to top)

AllNotesOff : Send All Notes Off and reset controllers

(Back to top)

AllNotesOff : Send All Notes Off and reset controllers

(Back to top)

AltKeyDown : See if alt key is down

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

AudioMixer_GetChannelStripName : Returns the name of the channel strip at the given number - zero indexd

(Back to top)

AudioMixer_GetNumberOfChannelStrips : Returns the number of channels in an audio mixer block

(Back to top)

AudioMixer_SetChannelStripName : Set the name of the channel strip at the given number - zero indexd

(Back to top)

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

(Back to top)

AutoSustainer_Play : Play and sustain an incoming note message through the AutoSustainer

(Back to top)

AutoSustainer_RespectParameters : Indicate whether notes should respect MidiInBlock parameters

(Back to top)

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

(Back to top)

AutoSustainer_Stop : Stop all pending notes

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

BoolToString : Returns a string representation of a boolean value

(Back to top)

BroadcastPluginParameters : Send out the current value of every parameter in the scriptlet

(Back to top)

CC_LoadFromFile : Load a curve that was created with a Curve Component

(Back to top)

CC_SaveToFile : Save a possibly changed curve to file

(Back to top)

CC_Scale : Return the Y value for the inputted x value

(Back to top)

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

(Back to top)

ChangeSelectedPluginBusLayout : Show the bus layout of the selected plugin - if any

(Back to top)

ChordPro_GoToFractionOfPage : Set the top of the Chord Pro window to some fraction of the total page

(Back to top)

ChordPro_GotoLine : Set the top of the Chord Pro window to the given line number

(Back to top)

ChordPro_GotoMarker : Set the top of the Chord Pro window to the given marker name

(Back to top)

ChordPro_GotoSongPart : Set the top of the Chord Pro window to the given songpart

(Back to top)

ClearArray : Resets the array size to 0

(Back to top)

ClearLogWindow : Clear the log window - duh!

(Back to top)

ClearNoteTracker : Reinitializes the note tracker although it is generally not necessary

(Back to top)

ClearSongPartSnapshot : Remove the current snapshot when in setlist mode - fails silently if not in setlist mode

(Back to top)

ClockTime : Gets the current time in milliseconds

(Back to top)

CloseAllPluginWindows : Close all plugins associated with this rackspace or optionally with all rackspaces - in the GigScript the allRackspaces argument MUST be true

(Back to top)

CloseLogWindow : Close the log window - duh!

(Back to top)

ClosePlugin : Close the plugin editor

(Back to top)

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

(Back to top)

ColorToRGB : Convert a color back to R G B A values each between 0.0 and 1.0

(Back to top)

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

(Back to top)

Cos : Returns the cos of x

(Back to top)

DecibelToLinear : Convert db value to its linear equivalent

(Back to top)

DisplayTemporaryMessage : Displays the string at the top of the main window

(Back to top)

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

(Back to top)

DuplicateSelectedPlugin : Duplicates the selected plugin - if any

(Back to top)

EA_AddArgument : Add an argument to an external application manager

(Back to top)

EA_ClearAllArgs : Clear the list of arguments so you can start again

(Back to top)

EA_SetProgramName : Set the name of the program to be run

(Back to top)

EA_Start : Open or run the external application

(Back to top)

EA_Stop : Close or terminate the external application - not guaranteed to work

(Back to top)

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

(Back to top)

EnableMetronome : Turn the metronome on or off

(Back to top)

EnablePlayhead : Start or stop the global playhead

(Back to top)

Exp : Returns e to the power of x

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

FormatTime : Returns a formatted timestamp from a given time in milliseconds

(Back to top)

GPWindowToBack : Put this GP main window behind other windows

(Back to top)

GPWindowToFront : Bring this GP window to the front

(Back to top)

GPWindowVisible : Show or hide GP window

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

GetADSRSustainLevel : Get the level of the sustain phase of an ADSR

(Back to top)

GetActivePreset : Get the index of the current preset in the plugin block

(Back to top)

GetAfterTouchValue : Returns the current aftertouch value of an Aftertouch MIDI message

(Back to top)

GetBPM : Returns the current global BPM value

(Back to top)

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

(Back to top)

GetCCNumber : Returns the Controller Number of a ControlChange MIDI message

(Back to top)

GetCCValue : Returns the Controller value of a ControlChange MIDI message

(Back to top)

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

(Back to top)

GetChordProFileName : Get the name of the associated chordpro file at the given index

(Back to top)

GetContinuousPreviousValue : Get the previous value of this parameter

(Back to top)

GetCurrentProgramChangeOrBankNumber : Returns the PC MSB or LSB of the current varation or song part defined by itemNumber 0 1 2 respectively

(Back to top)

GetCurrentRackspaceIndex : Returns the index of the current rackspace

(Back to top)

GetCurrentSetlistIndex : Get the index of the currently active setlist - returns -1 if not in setlist mode

(Back to top)

GetCurrentSetlistName : Get the name of the current setlist

(Back to top)

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

(Back to top)

GetCurrentSongName : Get the name of the current song

(Back to top)

GetCurrentSongPart : Get the index of the current song part

(Back to top)

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

(Back to top)

GetCurrentSongPartName : Get the name of the current song part

(Back to top)

GetCurrentVariation : Returns the index of the current variation

(Back to top)

GetDiscreteParameterItem : Returns the string item at the given offset for this parameter

(Back to top)

GetDiscreteParameterItemCount : Returns the number of strings defined for this parameter

(Back to top)

GetDiscretePreviousValue : Get the previous value of this parameter

(Back to top)

GetEnvVariable : Return the value of an environment variable

(Back to top)

GetExternalWidgetHideState : Get the current hide state of an external widget

(Back to top)

GetExternalWidgetLabel : Get the current label of an external widget

(Back to top)

GetExternalWidgetValue : Get the current value of an external widget

(Back to top)

GetGPPresetList : Get the Nth chunk of GP Preset names

(Back to top)

GetGPPresetListCount : Returns the number of GP Presets for this plugin

(Back to top)

GetGPWindowKioskMode : Get whether Gig Performer is in kiosk mode

(Back to top)

GetGPWindowState : Get the current state of the main window

(Back to top)

GetGPWindowVisible : See if main window is visible

(Back to top)

GetGeneraterAmplitude : Deprecated - Get the current value of a generator

(Back to top)

GetGeneratorAmplitude : Get the current value of a generator

(Back to top)

GetGlobalTranspose : Get the current transpose value

(Back to top)

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

(Back to top)

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

(Back to top)

GetLabelColor : Get the color of the widget label

(Back to top)

GetMaxNoteFromMidiInBlock : Gets the max note number defined for the keyboard split

(Back to top)

GetMetronomeVolume : Get the metronome volume

(Back to top)

GetMidiInDeviceCount : Returns the number of available MIDI In Devices

(Back to top)

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

(Back to top)

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

(Back to top)

GetMidiMessageSize : Returns the number of bytes in any MIDI Message

(Back to top)

GetMidiOutDeviceCount : Returns the number of available MIDI Out Devices

(Back to top)

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

(Back to top)

GetMinNoteFromMidiInBlock : Gets the min note number defined for the keyboard split

(Back to top)

GetNoteNumber : Returns the note number of a NoteMessage MIDI event

(Back to top)

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

(Back to top)

GetParameterCount : Gets the number of parameters in the plugin block

(Back to top)

GetParameterCount : Get the number of parameters

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

GetPitchBendValue : Returns the pitch bend value from a PitchBend MIDI message

(Back to top)

GetPluginCaption : Gets the caption displayed in the plugin block

(Back to top)

GetPluginInfo : Get information about the actual plugin --- 0=name - 1=manufacturer

(Back to top)

GetPolyTouchNoteNumber : Returns the note number of a PolyTouch MIDI event

(Back to top)

GetPolyTouchNotePressure : Returns the poly pressure value of a PolyTouch MIDI event

(Back to top)

GetPresetCount : Get the number of available presets in the plugin block

(Back to top)

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

(Back to top)

GetProgramChangeNumber : Returns the program change number of a ProgramChangeMessage MIDI event

(Back to top)

GetRackspaceBPM : Gets the BPM value associated with this rackspace

(Back to top)

GetRackspaceCount : Returns the number of rackspaces in the system

(Back to top)

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

(Back to top)

GetRackspaceName : Returns the name of the active rackspace

(Back to top)

GetRackspaceNameAtIndex : Returns the name of the rackspace at the given index

(Back to top)

GetReleaseVelocity : 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

(Back to top)

GetSetlistCount : Returns the number of setlists

(Back to top)

GetSetlistName : Get the name of the setlist at the given index

(Back to top)

GetSongArtistName : Get the artist name of the song at the given index

(Back to top)

GetSongBPM : Get the BPM of the song at the given index

(Back to top)

GetSongCount : Returns the number of songs in the current setlist

(Back to top)

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

(Back to top)

GetSongKeySignature : Get the key signature of the song at the given index

(Back to top)

GetSongName : Get the name of the song at the given index

(Back to top)

GetSongPartCount : Returns the number of parts in the current song

(Back to top)

GetSongPartName : Get the name of the song part at the given index

(Back to top)

GetSongPartTimeSigDenominator : Get the denominator of the time signature of the songpart at the given indices

(Back to top)

GetSongPartTimeSigNumerator : Get the numerator of the time signature of the songpart at the given indices

(Back to top)

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

(Back to top)

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

(Back to top)

GetSongTranspose : Get the transpose amount of the song at the given index

(Back to top)

GetSubrangeParameterItem : Returns the integer item at the given offset for this parameter

(Back to top)

GetSubrangeParameterItemCount : Returns the number of integer values defined for this parameter

(Back to top)

GetSubrangePreviousValue : Get the previous value of this parameter

(Back to top)

GetTimeSigDenominator : Get the denominator of the global time signature

(Back to top)

GetTimeSigNumerator : Get the numerator of the globaltime signature

(Back to top)

GetTimersRunning : Indicates whether global timers are running or stopped

(Back to top)

GetTransposeFromMidiInBlock : Gets the max note number defined for the keyboard split

(Back to top)

GetUserVariable : Get the value of a user defined variable

(Back to top)

GetVariationCount : Returns the number of variations in the current rackspace

(Back to top)

GetVariationCountForRackspaceAtIndex : Returns the number of variations in a specified rackspace

(Back to top)

GetVariationName : Returns the name of a variation

(Back to top)

GetVariationNameForRackspaceAtIndex : Returns the name of a variation in a specified rackspace

(Back to top)

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

(Back to top)

GetVelocityCurveValue : Returns the velocity after applying the scale curve to it

(Back to top)

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

(Back to top)

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

(Back to top)

GetWidgetFillColor : Get the fill color for widgets that support this feature

(Back to top)

GetWidgetHideState : Possibly returns the hide state of a widget - not guaranteed to be correct!

(Back to top)

GetWidgetLabel : Get the label of a widget

(Back to top)

GetWidgetMappedParameterValue : Get the current parameter text of the parameter number of plugin associated with this widget if available

(Back to top)

GetWidgetOutlineColor : Get the outline color for widgets that support this feature

(Back to top)

GetWidgetOutlineRoundness : Get the outline roundness for widgets that support this feature

(Back to top)

GetWidgetOutlineThickness : Get the outline thickness for widgets that support this feature

(Back to top)

GetWidgetPluginMappedParameterNumber : Returns the mapped parameter number of this plugin or -99999 if unmapped

(Back to top)

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

(Back to top)

GetWidgetResetValue : Gets the reset value of the widget

(Back to top)

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

(Back to top)

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

(Back to top)

GigPerformerDocumentsFolder : Returns the root folder where GP content is stored

(Back to top)

GlobalRackspaceVisible : Indicates whether the global rackspace is visible

(Back to top)

GotNote : Track status of an incoming note

(Back to top)

GotNoteOff : Remember that a note was released

(Back to top)

GotNoteOn : Remember that a note was played

(Back to top)

InEditMode : Indicates whether we are in edit mode

(Back to top)

InPanelView : See if we are in panel view

(Back to top)

InSetlistMode : Returns whether we are currently in setlist mode

(Back to top)

InSetlistView : See if we are in the setlist view

(Back to top)

InTunerView : Indicates whether we are in the tuner view

(Back to top)

InWiringView : See if we are in the wiring view

(Back to top)

IndexOf : Returns the index containing the value otherwise returns -1

(Back to top)

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

(Back to top)

InitADSR : Set all parameters of an ADSR in one function call

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

InjectSysexEventViaRigManager : Inject a sysex message to a MidiInDeviceAlias using its Rig Manager name directly

(Back to top)

InsertFavoriteAtMousePosition : Insert the named favorite at the current mouse position

(Back to top)

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

(Back to top)

IntToFloat : Converts an integer to its floating point equivalent

(Back to top)

IntToHex : Converts an integer number to a hex notated readable string

(Back to top)

IntToHexString : Converts an integer number to a hex notated readable string

(Back to top)

IntToString : Returns a string representation of an integer value

(Back to top)

IsAfterTouch : See if the current message is actually an Aftertouch MIDI message

(Back to top)

IsController : See if the current message is actually a CC MIDI message

(Back to top)

IsGeneratorEnabled : Queries the state (start or stopped) of any generator

(Back to top)

IsGigLoading : Returns whether a gig file is currently loading

(Back to top)

IsMetronomeEnabled : See if metronome is running

(Back to top)

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

(Back to top)

IsNoteOff : See if the current message is actually a noteOff message - this is not the same as a NoteOn with 0 velocity

(Back to top)

IsNoteOn : See if the current message is actually a noteOn message

(Back to top)

IsPitchBend : See if the current message is actually a pitchbend message

(Back to top)

IsPlayheadEnabled : Indicates whether the playhead is running

(Back to top)

IsPluginBypassed : Returns whether the plugin block is bypassed

(Back to top)

IsPolyTouch : See if the current message is actually a Polytouch MIDI message

(Back to top)

IsProgramChange : See if the current message is actually a program change message

(Back to top)

IsRecording : Return whether GP is currently recording audio and/or MIDI

(Back to top)

LargestDouble : Returns the maximum value of a double array

(Back to top)

LargestInt : Returns the maximum value in an integer array

(Back to top)

Length : Returns the length of a string

(Back to top)

LinearToDecibel : Convert linear value to its dB equivalent. Returns -99999 if input is invalid

(Back to top)

Ln : Returns the log (base e) of x

(Back to top)

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

(Back to top)

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

(Back to top)

Log : Returns the log (base 10) of x

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

MakeProgramChangeMessage : Returns a new ProgramChange MIDI message with the specified value ranging from 0 to 127. The MIDI channel is 1

(Back to top)

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

(Back to top)

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

(Back to top)

MapWidgetToPlugin : Map a widget to the specified parameter of the specified plugin

(Back to top)

Max : Returns the larger of the two values

(Back to top)

MidiInDeviceExists : Returns whether the physical MIDI in device exists

(Back to top)

MidiOutDeviceExists : Returns whether the physical MIDI Out device exists

(Back to top)

MidiSequence_CollectEventsNow : Collect events at the current position

(Back to top)

MidiSequence_EndOfSong : True if there are no more events in track

(Back to top)

MidiSequence_FingerTap : Send all the available events for each track to its associated MidiInBlock - optionally restart automatically

(Back to top)

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

(Back to top)

MidiSequence_GetCurrentBar : Returns the current bar

(Back to top)

MidiSequence_GetCurrentBeat : Returns the current beat of the current bar

(Back to top)

MidiSequence_GetCurrentEvents : Access the current events at the current grid position for the specified track

(Back to top)

MidiSequence_GetCurrentTick : Returns the current tick offset

(Back to top)

MidiSequence_GetResolution : Get the base resolution of the sequence

(Back to top)

MidiSequence_GetSongLength : Populates and returns a 3 item array containing the length of the song in bar:beat and absolute ticks

(Back to top)

MidiSequence_GetTrackCount : Returns the number of tracks in a loaded MIDI file

(Back to top)

MidiSequence_LoadMidiFile : Loads a midi file and returns the number of tracks

(Back to top)

MidiSequence_LoadStandardMidiFile : Loads a midi file and returns the number of tracks

(Back to top)

MidiSequence_MapOutputChannel : Map the output channel for a track to the specified number between 1-16. Set to 0 to use individual event channel

(Back to top)

MidiSequence_Quantize : Grid quantize - 1 2 4 8 16

(Back to top)

MidiSequence_ResetToStart : Reset to the beginning of the track

(Back to top)

MidiSequence_ScriptletFingerTap : Send all the available events for each track out using the specified associated channel with 0 meaning unchanged - optionally restart automatically - for use in a scriptlet

(Back to top)

MidiToParam : 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

(Back to top)

MidiToParamEx : 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

(Back to top)

Min : Returns the smaller of the two values

(Back to top)

MinimizeOrRestoreGPWindow : Minimize or restore the GP main window

(Back to top)

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

(Back to top)

MultiChannelNoteTracker_Clear : Reinitializes the note tracker for the specified channel

(Back to top)

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

(Back to top)

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

(Back to top)

MultiChannelNoteTracker_GotMidiMessage : Tracks notes and sustain messages automatically

(Back to top)

MultiChannelNoteTracker_GotNote : Track status of an incoming note

(Back to top)

MultiChannelNoteTracker_GotNoteOff : Remember that a note was released

(Back to top)

MultiChannelNoteTracker_GotNoteOn : Remember that a note was played

(Back to top)

MultiChannelNoteTracker_IsNoteOffPending : returns whether a specific note is still down

(Back to top)

MultiChannelNoteTracker_NoteOnCount : Count number of notes still being played

(Back to top)

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

(Back to top)

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

(Back to top)

Next : Switch to next rackspace variation song or song part

(Back to top)

NextRackspace : Switch to the next rackspace

(Back to top)

NextSong : Move to the next song

(Back to top)

NextVariation : Switch to the next variation

(Back to top)

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

(Back to top)

NoteMapper_GetMappedNotes : Returns the note or chord associated with the incoming note

(Back to top)

NoteMapper_MapNote : Define note to be returned given an incoming note

(Back to top)

NoteMapper_MapNoteToChord : Associate a note with a chord

(Back to top)

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

(Back to top)

NoteMapper_Reset : Reset note mapper to defaults

(Back to top)

NoteNameToNoteNumber : returns integer value of a note name

(Back to top)

NoteNumberToNoteName : Returns a string representation of an integer note number

(Back to top)

NoteOnCount : Count number of notes still being played

(Back to top)

NoteTracker_Clear : Reinitializes the note tracker although it is generally not necessary

(Back to top)

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

(Back to top)

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

(Back to top)

NoteTracker_GotNote : Track status of an incoming note

(Back to top)

NoteTracker_GotNoteOff : Remember that a note was released

(Back to top)

NoteTracker_GotNoteOn : Remember that a note was played

(Back to top)

NoteTracker_IsNoteOffPending : returns whether a specific note is still down

(Back to top)

NoteTracker_NoteOnCount : Count number of notes still being played

(Back to top)

NoteTracker_StopAllPendingNotes : Send note offs for all pending notes in the tracker

(Back to top)

NoteTracker_StopAllPendingNotes : Send note offs for all pending notes in the tracker

(Back to top)

Notify : Displays a message on main window that will fade out

(Back to top)

OSC_AppendDoubleArg : Append a double argument to the OSC message

(Back to top)

OSC_AppendIntArg : Append an integer argument to the OSC message

(Back to top)

OSC_AppendStringArg : Append a string argument to the OSC message

(Back to top)

OSC_ArgCount : Returns the number of arguments in an OSC message

(Back to top)

OSC_ClearArgs : Clear all arguments but leave the address pattern

(Back to top)

OSC_Enabled : Returns whether OSC is enabled for this instance

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

OSC_GetGPListeningPort : Return the port on which GP listens for incoming OSC messages

(Back to top)

OSC_GetIPAddressFromTargetName : Returns the IP address or empty string if target does not exist

(Back to top)

OSC_GetPortNumberFromTargetName : Returns the port number or -1 if target does not exist

(Back to top)

OSC_GetTargetNames : Returns the list of available target names

(Back to top)

OSC_Send : Send out the message to the default IP address and port

(Back to top)

OSC_SendCommand : Send an OSC message with no valueo the default ip address and port

(Back to top)

OSC_SendCommandSpecific : Send an OSC message with no arguments to the specified ip address and port

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

OSC_SendSpecific : Send out the message to the specified IP address and port

(Back to top)

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

(Back to top)

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

(Back to top)

OSC_SetAddress : Set the address of an OSC message

(Back to top)

OSC_TargetNameExists : Returns whether a target name has been defined

(Back to top)

OpenLogWindow : Open the log window - duh!

(Back to top)

OpenPlugin : Open the plugin editor

(Back to top)

OpenScriptWindow : Open the script editor window for the current rackspace

(Back to top)

OverrideParameterText : Override the default parameter string of the parameter displayed by a widget

(Back to top)

Panic : Stop all notes in the current rackspace

(Back to top)

ParamToMidi : 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

(Back to top)

ParamToMidiEx : Maps a double value between xMin and xMax - both between 0.0 and 1.0 - into a value between yMinMIDI and yMaxMIDI both with type integer and whose values will be constrained between 0 and 127. Slightly faster than Scale if you can use the expected types so that no conversion is required

(Back to top)

ParseCSVString : Breaksup a single line of a CSV into its parts

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

Power : Returns base raised to the power of exponent

(Back to top)

PrevSong : Move to the previous song

(Back to top)

Previous : Switch to previous rackspace variation song or song part

(Back to top)

PreviousRackspace : Switch to the previous rackspace

(Back to top)

PreviousVariation : Switch to the previous variation

(Back to top)

Print : Displays the string in the log window

(Back to top)

PromptToLoadGPUserPreset : Prompt to load a GP User Preset for the given plugin

(Back to top)

PromptToSaveGPUserPreset : Prompt to save a GP User Preset for the given plugin

(Back to top)

PushSnapshotToVariation : Update the underlying rackspace variation with the current song part overrides - fails silently if not in setlist mode

(Back to top)

QuickInsertPlugin : Uses the Quick Select Dialog to insert a new plugin

(Back to top)

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

(Back to top)

RGBToColor : Convert R G B A values between 0.0 and 1.0 into a color

(Back to top)

Random : Returns a random value between 0.0 and 1.0

(Back to top)

RandomRange : Returns a random integer value between min and max

(Back to top)

RecordInputs : Start or stop recording audio and/or MIDI

(Back to top)

RedrawWidgetCurve : Redraw the curve after making changes to it

(Back to top)

RefreshWidgetsMappedToPlugin : Update widget values to match their mapped parameters - useful when change to plugin preset does not notify the host

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

RemoveChordInterval : Remove a chord interval from the chord dictionary

(Back to top)

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

(Back to top)

RemoveSelectedPlugin : Removes the selected plugin - if any

(Back to top)

RenameSelectedPlugin : Opens the dialog to rename the selected plugin - if any

(Back to top)

ReplacePlugin : Replace the plugin in the specified block - experimental

(Back to top)

ReplaceString : Replace a substring with another string

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

Reverse : Reverse the list of items in the array

(Back to top)

Round : Rounds a floating point number to the nearest integer

(Back to top)

SM_ChangeValue : Change a byte of a sysex message at some index starting at 0. Note that the F0 and F7 bytes cannot themselves be changed

(Back to top)

SM_CreateSysex : Store a sysex message efficiently for manipulation and sending

(Back to top)

SM_CreateSysexFromString : Interpret a string as a sysex and store it for manipulation and sending

(Back to top)

SM_GetByte : Gets the byte at the specified index

(Back to top)

SM_GetValue : Gets the byte at the specified index

(Back to top)

SM_GetValues : Gets the combined bytes starting at the specified index

(Back to top)

SM_Length : Returns the length of a system message

(Back to top)

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

(Back to top)

SM_SendMidiIn : Send a stored sysex message from a MidiIn block

(Back to top)

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

(Back to top)

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

(Back to top)

SaveGPPreset : Saves a GP plugin preset in the background - seriously experimental and probably very unsafe - no way to tell programatically if it was successful

(Back to top)

SaveGigfile : Tries to save the gigfile - displays message in main window indicating success or failure

(Back to top)

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

(Back to top)

Scale : 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

(Back to top)

ScaleInt : 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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

ScrollFrontPanel : Scroll the main panel to the given position as a fraction of the total height

(Back to top)

ScrollRackspaces : Scroll the rackspace view to the given position as a fraction of the total height

(Back to top)

ScrollSetlist : Scroll the setlist view to the given position as a fraction of the total height

(Back to top)

SelectPreset : Change the preset of the block - experimental

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

SendNotesNow : Play a collection of notes now

(Back to top)

SendNow : Send a MIDI event out immediately

(Back to top)

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

(Back to top)

SendNowExternal : Send a MIDI event out immediately through a MIDI Out block

(Back to top)

SendNowRespectingParameters : Send a MIDI event out after applying MidiInBlock parameters

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

SendSysexNow : Send a MIDI sysex message out immediately

(Back to top)

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

(Back to top)

SendWidgetToBack : Put this widget behind other widgets

(Back to top)

SendWidgetToFront : Put this widget in front of other widgets

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

SetADSRSustainLevel : Set the level of the sustain phase of an ADSR

(Back to top)

SetArtistName : Change the name of artist for the song at the specified index

(Back to top)

SetBPM : Set the global BPM value

(Back to top)

SetDisplayMessage : Displays a message at the bottom of a Scriptlet editor window

(Back to top)

SetEnvVariable : Set an environment variable - be careful - may not be persistent

(Back to top)

SetExternalWidgetHideOnPresentation : Set the current hide state of an external widget

(Back to top)

SetExternalWidgetLabel : Set the current label of an external widget

(Back to top)

SetExternalWidgetValue : Set the current value of an external widget

(Back to top)

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

(Back to top)

SetGPWindowFullScreen : Make the GP window be full screen or not fullscreen

(Back to top)

SetGPWindowKioskMode : Make the GP window be kiosk or not kiosk

(Back to top)

SetGPWindowState : Set the state of the main window

(Back to top)

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

(Back to top)

SetGeneratorFrequency : Set the frequency in cycles/second of any Generator

(Back to top)

SetGeneratorLength : Set the length of a generator cycle

(Back to top)

SetGeneratorOneShot : Controls whether a Generator repeats indefinitely or only runs once when triggered

(Back to top)

SetGlobalTranspose : Transpose all incoming MIDI messages by semitones amount

(Back to top)

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

(Back to top)

SetLabelColor : Set the label color of a widgets

(Back to top)

SetMetronomeVolume : Set the metronome volume

(Back to top)

SetParameter : Send a parameter value to the plugin block

(Back to top)

SetPluginBypassed : Bypass or unbypass the plugin block

(Back to top)

SetPluginCaption : Sets the caption displayed in the plugin block

(Back to top)

SetPluginEditorXYPosition : Open a plugin editor and set its position on screen

(Back to top)

SetSongInformation : Change multiple attributes of a song at the specified index - invalid parameters will be ignored

(Back to top)

SetSongName : Change the name of a song at the specified index

(Back to top)

SetSongPart : Switch to another part in the current song

(Back to top)

SetSongPartName : Change the name of the song part at songpart index in a song at the specified song index

(Back to top)

SetTimeSignatureDenominator : Set the denominator of global time signature

(Back to top)

SetTimeSignatureNumerator : Set the numerator of the global time signature

(Back to top)

SetTimersRunning : Start or stop the global timers

(Back to top)

SetVariation : Switch to another variation in the active rackspace

(Back to top)

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

(Back to top)

SetWidgetBoundsFromOtherWidget : Make the target widget have the same position and size as the source

(Back to top)

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

(Back to top)

SetWidgetFillColor : Set the fill color for widgets that support this feature

(Back to top)

SetWidgetHideOnPresentation : Set widget to be hidden when not in edit mode

(Back to top)

SetWidgetLabel : Set the label of a widget

(Back to top)

SetWidgetOutlineColor : Set the outline color for widgets that support this feature

(Back to top)

SetWidgetOutlineRoundness : Set the outline roundness for widgets that support this feature

(Back to top)

SetWidgetOutlineThickness : Set the outline thickness for widgets that support this feature

(Back to top)

SetWidgetResetValue : Set the reset value of any widget

(Back to top)

SetWidgetValue : Set the current value of any widget

(Back to top)

SetWidgetValueEx : Set the current value of any widget - uses modulo arithmetic

(Back to top)

SetWindowTitle : Changes the default rackspace title to the title

(Back to top)

Shell : Run an OS Shell command synchronously returning an implementation defined integer indicating success or failure

(Back to top)

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

(Back to top)

ShiftKeyDown : See if shift key is down

(Back to top)

ShowChordProWindow : Show or hide the ChordPro Window

(Back to top)

ShowEditorForSelectedPlugin : Open the editor for the selected plugin - if any

(Back to top)

ShowGlobalRackspace : Show or hide the global rackspace front panel

(Back to top)

ShowRigManager : Open or close the Rig Manager window

(Back to top)

Sign : Returns 1 if x > 0 -1 if x < 0 0 if x = 0

(Back to top)

Sin : Returns the sin of x

(Back to top)

Size : Returns the size of an array

(Back to top)

Sleep : Delay a script for specified milliseconds - experimental - maybe even dangerous

(Back to top)

SmallestDouble : Returns the minimum value in a double array

(Back to top)

SmallestInt : Returns the minimum value in an integer array

(Back to top)

SongMoveDown : Move to the next part or next song if allowed

(Back to top)

SongMoveUp : Move to the previous part or previous song if allowed

(Back to top)

SongNextPart : Move to the next song part of the current song

(Back to top)

SongPrevPart : Move to the previous song part of the current song

(Back to top)

Sort : Sorts an array in ascending order

(Back to top)

Sqrt : Returns the square root of x

(Back to top)

StartAttackPhase : Trigger the ADS phase of an ADSR

(Back to top)

StartRecording : Start recording now

(Back to top)

StartReleasePhase : Trigger the release phase of the ADSR

(Back to top)

StopAllPendingNotes : Send note offs for all pending notes in the tracker

(Back to top)

StopAllPendingNotes : Send note offs for all pending notes in the tracker

(Back to top)

StopOneShotRamp : Stop a one shot ramp generator before it normally finishes - - experimental

(Back to top)

StopRecording : Stop recording now

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

StringToBool : returns true if string = "true" otherwise false

(Back to top)

StringToDouble : returns double value of string

(Back to top)

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

(Back to top)

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

(Back to top)

StringToInt : returns integer value of string

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

SwitchToNextRack : Switch to the next rackspace

(Back to top)

SwitchToNextVariation : Switch to the next variation

(Back to top)

SwitchToPanelView : Show the rackspace panel view

(Back to top)

SwitchToPreset : Switch to another preset in the rackspace

(Back to top)

SwitchToPrevRack : Switch to the previous rackspace

(Back to top)

SwitchToPrevVariation : Switch to the previous variation

(Back to top)

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

(Back to top)

SwitchToProgramNumberEx : Switch to zero-based program number and optionally use MSB and LSB values if they are greater than -1

(Back to top)

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

(Back to top)

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

(Back to top)

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

(Back to top)

SwitchToSetlistByIndex : Switch to the setlist associated with this index

(Back to top)

SwitchToSetlistByName : Switch to the named setlist

(Back to top)

SwitchToSetlistView : Show the song view

(Back to top)

SwitchToSongByIndex : Switch to the specified song and part

(Back to top)

SwitchToWiringView : Switch to the plugin block wiring view

(Back to top)

TakeSongPartSnapshot : Take a snapshot when in setlist mode - fails silently if not in setlist mode

(Back to top)

Tan : Returns the tan of x

(Back to top)

Tap : Simulates tap tempo command

(Back to top)

TestSomething : Internal use only

(Back to top)

ThresholdDetector_Detect : Return true if we crossed over

(Back to top)

ThresholdDetector_Setup : Define the conditions to detect an edge

(Back to top)

TimeNow : Gets the current time in milliseconds - deprecated

(Back to top)

TimeSinceStartup : Gets the time since computer was started in milliseconds

(Back to top)

TimeStringToDouble : Converts a PROPERLY formatted time string hh:mm::ss::ms to seconds.milliseconds - bogus input will produce bogus output

(Back to top)

ToLowercase : returns double value of string

(Back to top)

ToUppercase : returns double value of string

(Back to top)

ToggleTunerVisible : Switch in or out of tuner view

(Back to top)

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

(Back to top)

TriggerOneShotRamp : Trigger a one shot ramp generator - experimental

(Back to top)

TrimString : Remove leading and trailing spaces from a string

(Back to top)

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

(Back to top)

WithCCNumber : Changes the CC number of a ControlChangeMessage MIDI event

(Back to top)

WithCCValue : Changes the value of a CCMessage MIDI event

(Back to top)

WithChannel : Changes the channel number of any MIDI event.

(Back to top)

WithNoteNumber : Changes the note number of a NoteMessage MIDI event

(Back to top)

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

(Back to top)

WithProgramChangeNumber : Changes the program change value of a program change MIDI message.

(Back to top)

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

(Back to top)

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

(Back to top)

iMax : Returns the index of the largest value of an array

(Back to top)

iMin : Returns the index of the smallest value of an array

(Back to top)