Built-in Variables and Constants

This variable returns the script slot of the current script (zero-based, i.e. the first script slot is 0).

Each index of this variable array points to the group with the same index.

If a group is selected for editing, the corresponding array cell contains a 1, otherwise 0.

This variable returns a value of 1 if the command that triggered the on async_complete callback has successfully completed its action. 0 if the command could not complete its action, e.g. file not found. 

This variable returns the ID of the command that triggered the on async_complete callback.

This constant is to be used in the <generic> part of the engine parameter commands to point to the instrument bus level. Add the index of the bus you wish to address, e.g. $NI_BUS_OFFSET + 2 will point to instrument bus 3.

This variable returns the total amount of groups in an instrument.

This variable returns the total amount of output channels of the respective Kontakt multi, not counting Aux channels.

This variable returns the total amount of zones in an instrument.

This variable returns the amount of played voices for the current instrument.

This variable returns the amount of played voices for all instruments.             

This variable returns the group index of the currently viewed group in Kontakt's instrument edit view.

The following path variables are available:

$GET_FOLDER_LIBRARY_DIR

If used with a patch which belongs to a Kontakt Player encoded library: library folder.

If used with an unencoded patch: the User Content folder, which is found as follows:

macOS: /Users/<UserName>/Documents/Native Instruments/User Content/

Windows: C:\Users\<UserName>\Documents\Native Instruments\User Content\

$GET_FOLDER_FACTORY_DIR

The factory data folder of Kontakt, mainly used for loading factory IR samples.

Note: This is not the Kontakt Factory Library folder!

$GET_FOLDER_PATCH_DIR

The folder in which the patch is saved.

If the patch was not saved before, an empty string is returned.

$GET_FOLDER_RC_DIR

The folder in which the Resource Container is saved. This path is generally recommended to be used when referencing other files in the library structure (for example, NKA or MIDI files), since the path to Resource Container is the same for Kontakt Player encoded library and unencoded patches.

If no Resource Container is set for the insturment, an empty string is returned.

User access for the two voice limits (Standard and High Quality) of the Time Machine Pro, to be used with set_voice_limit() and get_voice_limit().

$NI_VL_TMPRO_STANDARD

$NI_VL_TMRPO_HQ

This constant addresses all groups in the instrument when used with disallow_group(), allow_group() or set_event_par_arr() functions.

This constant addresses all events in functions which deal with an event ID number.

It also works with MIDI object commands that require a MIDI event ID.

These constants can be used to create a bitmask that is used to group events at will. It is intended to be used with by_marks() , set_event_mark(), get_event_mark(), delete_event_mark(), mf_set_mark() and mf_get_mark() commands.

This variable array contains the current value for the specified MIDI CC (continuous controller) message.

This variable contains the MIDI CC (continuous controller) number of the controller which triggered the on controller callback.

This variable array updates itself whenever a MIDI CC value is changed - 1 if the specified MIDI CC value has changed, 0 otherwise.

This variable contains the unique ID number of the event which triggered the on note or on release callback.

This variable contains the unique ID number of the currently selected MIDI event, i.e. the MIDI event at the position marker.

This variable contains the note number of the event which triggered the on note or on release callback.

This variable contains the velocity of the note which triggered the on note callback.

These are values returned by event_status() command:

$EVENT_STATUS_INACTIVE

$EVENT_STATUS_NOTE_QUEUE

Multi script only:

$EVENT_STATUS_MIDI_QUEUE

This variable array contains indices of those groups that are affected by the current MIDI Note On or Note Off events.

The size of the array changes depending on the number of groups the event affects, so use the num_elements() command to get the correct array size.

The returned indices come before any allow_group() or disallow_group() commands, so it can be used to analyze the mapping of the instrument.

This variable contains 1 if the key which triggered the callback is still held, 0 otherwise.

This variable array contains current values of MIDI Polyphonic Aftertouch for all MIDI note numbers.

This variable contains the note number of the MIDI Polyphonic Aftertouch event which triggered the on poly_at callback.

This variable contains the address of a received RPN or NRPN message (0 ... 16383).

This variable contains the value of a received RPN or NRPN message (0 ... 16383).

This constant specifies Virtual Continuous Controller for mono aftertouch (MIDI Channel Pressure message), mainly for use in on controller callback or set_controller() command.

This constant specifies Virtual Continuous Controller for MIDI Pitch Bend messages, mainly for use in on controller callback or set_controller() command.

This constant specifies Virtual Note Controller for MIDI 2.0 Per-Note Pitch Bend messages, mainly for use in on_note_controller callback, or set_note_controller() command.

This variable array contains the current state of all keys. 1 if the key is held, 0 otherwise.

This variable array contains 1 if a note, independent of the octave, is held. 0 otherwise. Due to this, the note number should be a value between 0 (C) and 11 (B).

These variables return the current date and time as set by the operating system, in form of integer values.

$NI_DATE_YEAR

$NI_DATE_MONTH (1 ... 12)

$NI_DATE_DAY (1 ... 31)

$NI_TIME_HOUR (0 ... 23)

$NI_TIME_MINUTE (0 ... 59)

$NI_TIME_SECOND (0 ... 59)

This variable returns the time of a MIDI Note On message in microseconds from the beginning of the current bar, with respect to the current tempo.

This variable returns the duration in microseconds of one bar with respect to the current tempo.

It only works if the clock is running, otherwise it will return 0.

You can also retrieve the duration of one bar by using $SIGNATURE_NUM and $SIGNATURE_DENOM in combination with various $DURATION_ constants.

This variable returns the duration of a quarter note in microseconds, with respect to the current tempo. Also available:

$DURATION_EIGHTH

$DURATION_SIXTEENTH

$DURATION_QUARTER_TRIPLET

$DURATION_EIGHTH_TRIPLET

$DURATION_SIXTEENTH_TRIPLET

This variable returns the time period in milliseconds (not microseconds!) that has passed since the instantiation of Kontakt. The engine uptime is calculated from the sample rate and can thus be used in musical contexts, (eg. building arpeggiators or sequencers) as it remains in sync, even in an offline bounce.

This variable returns the time period in microseconds that has passed since Kontakt was instantiated.

It can be reset with reset_ksp_timer.

The KSP timer is based on the CPU clock and thus runs at a constant rate, regardless of whether or not Kontakt is being used in real time. As such, it should be used to test the efficiency of scripts and not to make musical calculations.

This variable returns the host’s current song position at 960 PPQ (pulses per quarter note).

This variable contains 1 if the host's transport is running, 0 otherwise.

This variable contains the numerator of the current time signature, i.e. 4/4.

This variable contains the denominator of the current time signature, i.e. 4/4.

These constants are used to control the unit parameter of time-related controls (e.g. Delay Time, Envelope Attack etc.) with engine parameter variables like $ENGINE_PAR_DL_TIME_UNIT.

$NI_SYNC_UNIT_ABS (not synchronized to tempo)

$NI_SYNC_UNIT_WHOLE

$NI_SYNC_UNIT_WHOLE_TRIPLET

$NI_SYNC_UNIT_HALF

$NI_SYNC_UNIT_HALF_TRIPLET

$NI_SYNC_UNIT_QUARTER

$NI_SYNC_UNIT_QUARTER_TRIPLET

$NI_SYNC_UNIT_8TH

$NI_SYNC_UNIT_8TH_TRIPLET

$NI_SYNC_UNIT_16TH

$NI_SYNC_UNIT_16TH_TRIPLET

$NI_SYNC_UNIT_32ND

$NI_SYNC_UNIT_32ND_TRIPLET

$NI_SYNC_UNIT_64TH

$NI_SYNC_UNIT_64TH_TRIPLET

$NI_SYNC_UNIT_256TH

$NI_SYNC_UNIT_ZONE (only applies to the Speed parameter in certain Source module sampler modes)

This variable array contains the duration since note start in microseconds for each key. Mostly only makes sense in on release callback.

This variable returns the start of current bar in ticks (at 960 PPQ) from the start of the host project.

Note: Since the AAX plugin format doesn't provide this information, this variable will return -1 in ProTools!

This variable returns the ID of the UI widget which triggered the on ui_control or on ui_controls callbacks.on ui_controls

This variable returns 1 if the GUI of Kontakt is not available or loadable. Currently this is only possible when Kontakt is used in Maschine+. When Kontakt is used in a regular host, it will still return 0 even if the GUI is not visible.

This variable returns 1 if Kontakt is running standalone, 0 if it's loaded as a plugin in a host.

This constant returns the value of π (approximately 3.14159…).

This constant returns the value of e (approximately 2.71828…).