--- doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html 2019/08/29 12:29:10 3579
+++ doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html 2019/08/29 13:44:35 3580
@@ -34,12 +34,12 @@
| Stops execution of a script callback. |
- array_equal() |
- Check whether two arrays are equal. |
+ abs() |
+ Calculates the absolute value of a given value. |
- fork() |
- Creates new execution instances (threads). |
+ array_equal() |
+ Check whether two arrays are equal. |
callback_status() |
@@ -50,56 +50,44 @@
Decrements the passed integer variable by one. |
- inc() |
- Increments the passed integer variable by one. |
-
-
- in_range() |
- Checks whether a value is between two other values. |
+ exit() |
+ Stops execution of the current event handler instance. |
- message() |
- Prints text to the sampler's terminal. |
+ fork() |
+ Creates new execution instances (threads). |
- search() |
- Search for a certain value within an array. |
+ inc() |
+ Increments the passed integer variable by one. |
- sort() |
- Sort the given array. |
+ in_range() |
+ Checks whether a value is between two other values. |
- exit() |
- Stops execution of the current event handler instance. |
+ max() |
+ Calculates the maximum value of two given values. |
- wait() |
- Pauses execution for a certain amount of time. |
+ message() |
+ Prints text to the sampler's terminal. |
- stop_wait() |
- Resumes execution of a suspended script callback. |
+ min() |
+ Calculates the minimum value of two given values. |
- abs() |
- Calculates the absolute value of a given value. |
+ num_elements() |
+ Returns the size of the requested array variable. |
random() |
Random number generator. |
- min() |
- Calculates the minimum value of two given values. |
-
-
- max() |
- Calculates the maximum value of two given values. |
-
-
- num_elements() |
- Returns the size of the requested array variable. |
+ search() |
+ Search for a certain value within an array. |
sh_left() |
@@ -109,8 +97,20 @@
sh_right() |
Calculates a right bit shifted value. |
+
+ sort() |
+ Sort the given array. |
+
+
+ stop_wait() |
+ Resumes execution of a suspended script callback. |
+
+
+ wait() |
+ Pauses execution for a certain amount of time. |
+
-
+
Common Sampler Functions
Basic sampler related functions, independent from a particular sampler
@@ -121,124 +121,124 @@
Function | Description |
- play_note() |
- Triggers a new note. |
+ by_marks() |
+ Returns all events of an event group. |
- change_note() |
- Change MIDI note number of note. |
+ change_amp_lfo_depth() |
+ Modifies the amplitude LFO depth. |
- change_pan() |
- Changes panning of voices (stereo balance). |
+ change_amp_lfo_freq() |
+ Modifies the amplitude LFO frequency. |
- change_pan_time() |
- Changes the duration of panning (stereo balance) changes. |
+ change_attack() |
+ Modifies the amplitude attack time of voices. |
- change_pan_curve() |
- Changes the curve type of panning (stereo balance) changes. |
+ change_cutoff() |
+ Changes filter cutoff frequency of voices. |
- change_play_pos() |
- Change the sample playback position. |
+ change_cutoff_attack() |
+ Modifies the filter cutoff attack time of voices. |
- change_tune() |
- Changes the tuning of voices. |
+ change_cutoff_decay() |
+ Modifies the filter cutoff decay time of voices. |
- change_tune_time() |
- Changes the duration of tuning changes. |
+ change_cutoff_lfo_depth() |
+ Modifies the filter cutoff LFO depth. |
- change_tune_curve() |
- Changes the curve type of tuning changes. |
+ change_cutoff_lfo_freq() |
+ Modifies the filter cutoff LFO frequency. |
- change_vol() |
- Changes the volume of voices. |
+ change_cutoff_release() |
+ Modifies the filter cutoff release time of voices. |
- change_vol_time() |
- Changes the duration of volume changes. |
+ change_cutoff_sustain() |
+ Modifies the filter cutoff sustain level of voices. |
- change_vol_curve() |
- Changes the curve type of volume changes. |
+ change_decay() |
+ Modifies the amplitude decay time of voices. |
- change_cutoff() |
- Changes filter cutoff frequency of voices. |
+ change_note() |
+ Change MIDI note number of note. |
- change_reso() |
- Changes filter resonance of voices. |
+ change_pan() |
+ Changes panning of voices (stereo balance). |
- change_attack() |
- Modifies the amplitude attack time of voices. |
+ change_pan_curve() |
+ Changes the curve type of panning (stereo balance) changes. |
- change_decay() |
- Modifies the amplitude decay time of voices. |
+ change_pan_time() |
+ Changes the duration of panning (stereo balance) changes. |
- change_sustain() |
- Modifies the amplitude sustain level of voices. |
+ change_pitch_lfo_depth() |
+ Modifies the pitch LFO depth. |
- change_release() |
- Modifies the amplitude release time of voices. |
+ change_pitch_lfo_freq() |
+ Modifies the pitch LFO frequency. |
-
- change_cutoff_attack() |
- Modifies the filter cutoff attack time of voices. |
+ change_play_pos() |
+ Change the sample playback position. |
- change_cutoff_decay() |
- Modifies the filter cutoff decay time of voices. |
+ change_release() |
+ Modifies the amplitude release time of voices. |
- change_cutoff_sustain() |
- Modifies the filter cutoff sustain level of voices. |
+ change_reso() |
+ Changes filter resonance of voices. |
- change_cutoff_release() |
- Modifies the filter cutoff release time of voices. |
+ change_sustain() |
+ Modifies the amplitude sustain level of voices. |
-
- change_amp_lfo_depth() |
- Modifies the amplitude LFO depth. |
+ change_tune() |
+ Changes the tuning of voices. |
- change_amp_lfo_freq() |
- Modifies the amplitude LFO frequency. |
+ change_tune_curve() |
+ Changes the curve type of tuning changes. |
-
- change_cutoff_lfo_depth() |
- Modifies the filter cutoff LFO depth. |
+ change_tune_time() |
+ Changes the duration of tuning changes. |
- change_cutoff_lfo_freq() |
- Modifies the filter cutoff LFO frequency. |
+ change_velo() |
+ Change MIDI velocity of note. |
-
- change_pitch_lfo_depth() |
- Modifies the pitch LFO depth. |
+ change_vol() |
+ Changes the volume of voices. |
- change_pitch_lfo_freq() |
- Modifies the pitch LFO frequency. |
+ change_vol_curve() |
+ Changes the curve type of volume changes. |
- change_velo() |
- Change MIDI velocity of note. |
+ change_vol_time() |
+ Changes the duration of volume changes. |
+
+
+ delete_event_mark() |
+ Removes an event from some event group. |
event_status() |
@@ -257,39 +257,35 @@
Get the current value of a specific note parameter. |
- set_event_par() |
- Change the value of a specific note parameter. |
-
-
- set_controller() |
- Creates a MIDI control change event. |
+ ignore_controller() |
+ Drops the given MIDI control change event. |
ignore_event() |
Drops the given event. |
- ignore_controller() |
- Drops the given MIDI control change event. |
-
-
note_off() |
Releases the requested note. |
- set_event_mark() |
- Adds an event to an event group. |
+ play_note() |
+ Triggers a new note. |
- delete_event_mark() |
- Removes an event from some event group. |
+ set_controller() |
+ Creates a MIDI control change event. |
- by_marks() |
- Returns all events of an event group. |
+ set_event_mark() |
+ Adds an event to an event group. |
+
+
+ set_event_par() |
+ Change the value of a specific note parameter. |
-
+
GigaStudio Format Functions
Sampler format specific functions, dedicated to the individual features