15 |
|
|
16 |
<h2>Built-In Functions</h2> |
<h2>Built-In Functions</h2> |
17 |
<p> |
<p> |
18 |
These are the built-in functions available with the NKSP realt-time |
These are the built-in functions available with the NKSP real-time |
19 |
instrument script language. |
instrument script language. |
20 |
</p> |
</p> |
21 |
|
|
28 |
<th>Function</th> <th>Description</th> |
<th>Function</th> <th>Description</th> |
29 |
</tr> |
</tr> |
30 |
<tr> |
<tr> |
31 |
|
<td><code lang="nksp">abort()</code></td> |
32 |
|
<td>Stops execution of a script callback.</td> |
33 |
|
</tr> |
34 |
|
<tr> |
35 |
|
<td><code lang="nksp">array_equal()</code></td> |
36 |
|
<td>Check whether two arrays are equal.</td> |
37 |
|
</tr> |
38 |
|
<tr> |
39 |
|
<td><code>fork()</code></td> |
40 |
|
<td>Creates new execution instances (threads).</td> |
41 |
|
</tr> |
42 |
|
<tr> |
43 |
|
<td><code>callback_status()</code></td> |
44 |
|
<td>Returns the current status of a callback (thread).</td> |
45 |
|
</tr> |
46 |
|
<tr> |
47 |
<td><code lang="nksp">dec()</code></td> |
<td><code lang="nksp">dec()</code></td> |
48 |
<td>Decrements the passed integer variable by one.</td> |
<td>Decrements the passed integer variable by one.</td> |
49 |
</tr> |
</tr> |
60 |
<td>Prints text to the sampler's terminal.</td> |
<td>Prints text to the sampler's terminal.</td> |
61 |
</tr> |
</tr> |
62 |
<tr> |
<tr> |
63 |
|
<td><code>search()</code></td> |
64 |
|
<td>Search for a certain value within an array.</td> |
65 |
|
</tr> |
66 |
|
<tr> |
67 |
|
<td><code>sort()</code></td> |
68 |
|
<td>Sort the given array.</td> |
69 |
|
</tr> |
70 |
|
<tr> |
71 |
<td><code>exit()</code></td> |
<td><code>exit()</code></td> |
72 |
<td>Stops execution of the current event handler instance.</td> |
<td>Stops execution of the current event handler instance.</td> |
73 |
</tr> |
</tr> |
123 |
<td>Triggers a new note.</td> |
<td>Triggers a new note.</td> |
124 |
</tr> |
</tr> |
125 |
<tr> |
<tr> |
126 |
|
<td><code>change_note()</code></td> |
127 |
|
<td>Change MIDI note number of note.</td> |
128 |
|
</tr> |
129 |
|
<tr> |
130 |
<td><code>change_pan()</code></td> |
<td><code>change_pan()</code></td> |
131 |
<td>Changes panning of voices (stereo balance).</td> |
<td>Changes panning of voices (stereo balance).</td> |
132 |
</tr> |
</tr> |
133 |
<tr> |
<tr> |
134 |
|
<td><code>change_pan_time()</code></td> |
135 |
|
<td>Changes the duration of panning (stereo balance) changes.</td> |
136 |
|
</tr> |
137 |
|
<tr> |
138 |
|
<td><code>change_pan_curve()</code></td> |
139 |
|
<td>Changes the curve type of panning (stereo balance) changes.</td> |
140 |
|
</tr> |
141 |
|
<tr> |
142 |
|
<td><code>change_play_pos()</code></td> |
143 |
|
<td>Change the sample playback position.</td> |
144 |
|
</tr> |
145 |
|
<tr> |
146 |
<td><code>change_tune()</code></td> |
<td><code>change_tune()</code></td> |
147 |
<td>Changes the tuning of voices.</td> |
<td>Changes the tuning of voices.</td> |
148 |
</tr> |
</tr> |
149 |
<tr> |
<tr> |
150 |
|
<td><code>change_tune_time()</code></td> |
151 |
|
<td>Changes the duration of tuning changes.</td> |
152 |
|
</tr> |
153 |
|
<tr> |
154 |
|
<td><code>change_tune_curve()</code></td> |
155 |
|
<td>Changes the curve type of tuning changes.</td> |
156 |
|
</tr> |
157 |
|
<tr> |
158 |
<td><code>change_vol()</code></td> |
<td><code>change_vol()</code></td> |
159 |
<td>Changes the volume of voices.</td> |
<td>Changes the volume of voices.</td> |
160 |
</tr> |
</tr> |
161 |
<tr> |
<tr> |
162 |
|
<td><code>change_vol_time()</code></td> |
163 |
|
<td>Changes the duration of volume changes.</td> |
164 |
|
</tr> |
165 |
|
<tr> |
166 |
|
<td><code>change_vol_curve()</code></td> |
167 |
|
<td>Changes the curve type of volume changes.</td> |
168 |
|
</tr> |
169 |
|
<tr> |
170 |
<td><code>change_cutoff()</code></td> |
<td><code>change_cutoff()</code></td> |
171 |
<td>Changes filter cutoff frequency of voices.</td> |
<td>Changes filter cutoff frequency of voices.</td> |
172 |
</tr> |
</tr> |
183 |
<td>Modifies the decay time of voices.</td> |
<td>Modifies the decay time of voices.</td> |
184 |
</tr> |
</tr> |
185 |
<tr> |
<tr> |
186 |
|
<td><code>change_sustain()</code></td> |
187 |
|
<td>Modifies the sustain level of voices.</td> |
188 |
|
</tr> |
189 |
|
<tr> |
190 |
<td><code>change_release()</code></td> |
<td><code>change_release()</code></td> |
191 |
<td>Modifies the release time of voices.</td> |
<td>Modifies the release time of voices.</td> |
192 |
</tr> |
</tr> |
207 |
<td>Modifies the pitch LFO frequency.</td> |
<td>Modifies the pitch LFO frequency.</td> |
208 |
</tr> |
</tr> |
209 |
<tr> |
<tr> |
210 |
|
<td><code>change_velo()</code></td> |
211 |
|
<td>Change MIDI velocity of note.</td> |
212 |
|
</tr> |
213 |
|
<tr> |
214 |
<td><code>event_status()</code></td> |
<td><code>event_status()</code></td> |
215 |
<td>Checks and returns whether a particular note is still alive.</td> |
<td>Checks and returns whether a particular note is still alive.</td> |
216 |
</tr> |
</tr> |
217 |
<tr> |
<tr> |
218 |
|
<td><code>fade_in()</code></td> |
219 |
|
<td>Fade the requested note in.</td> |
220 |
|
</tr> |
221 |
|
<tr> |
222 |
|
<td><code>fade_out()</code></td> |
223 |
|
<td>Fade the requested note out.</td> |
224 |
|
</tr> |
225 |
|
<tr> |
226 |
|
<td><code>get_event_par()</code></td> |
227 |
|
<td>Get the current value of a specific note parameter.</td> |
228 |
|
</tr> |
229 |
|
<tr> |
230 |
|
<td><code>set_event_par()</code></td> |
231 |
|
<td>Change the value of a specific note parameter.</td> |
232 |
|
</tr> |
233 |
|
<tr> |
234 |
<td><code>set_controller()</code></td> |
<td><code>set_controller()</code></td> |
235 |
<td>Creates a MIDI control change event.</td> |
<td>Creates a MIDI control change event.</td> |
236 |
</tr> |
</tr> |
273 |
<td><code>gig_set_dim_zone()</code></td> |
<td><code>gig_set_dim_zone()</code></td> |
274 |
<td>Changes the currently active dimension zone.</td> |
<td>Changes the currently active dimension zone.</td> |
275 |
</tr> |
</tr> |
276 |
|
<tr> |
277 |
|
<td><code>same_region()</code></td> |
278 |
|
<td>Check whether two keys are mapped to the same region.</td> |
279 |
|
</tr> |
280 |
</table> |
</table> |
281 |
|
|
282 |
<h2>Built-In Variables</h2> |
<h2>Built-In Variables</h2> |
295 |
<th>Variable</th> <th>Description</th> |
<th>Variable</th> <th>Description</th> |
296 |
</tr> |
</tr> |
297 |
<tr> |
<tr> |
298 |
|
<td><code>$CALLBACK_STATUS_QUEUE</code></td> |
299 |
|
<td>Built-in constant reflecting the status of a callback to be |
300 |
|
alive but suspended. See <code>callback_status()</code> for details.</td> |
301 |
|
</tr> |
302 |
|
<tr> |
303 |
|
<td><code>$CALLBACK_STATUS_RUNNING</code></td> |
304 |
|
<td>Built-in constant reflecting the status of a callback to be |
305 |
|
alive and currently executing. See <code>callback_status()</code> |
306 |
|
for details.</td> |
307 |
|
</tr> |
308 |
|
<tr> |
309 |
|
<td><code>$CALLBACK_STATUS_TERMINATED</code></td> |
310 |
|
<td>Built-in constant reflecting the status of a callback to be |
311 |
|
not alive. See <code>callback_status()</code> for details.</td> |
312 |
|
</tr> |
313 |
|
<tr> |
314 |
<td><code>$KSP_TIMER</code></td> |
<td><code>$KSP_TIMER</code></td> |
315 |
<td>Preserved for compatiblity reasons with KSP, returns the same value |
<td>Preserved for compatiblity reasons with KSP, returns the same value |
316 |
as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details). |
as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details). |
355 |
</td> |
</td> |
356 |
</tr> |
</tr> |
357 |
<tr> |
<tr> |
358 |
|
<td><code>%NKSP_CALLBACK_CHILD_ID[]</code></td> |
359 |
|
<td> |
360 |
|
Reflects the callback IDs of all child threads which the current |
361 |
|
script callback instance spawned by having called <code>fork()</code> before. |
362 |
|
See the latter function for details about this array variable. |
363 |
|
</td> |
364 |
|
</tr> |
365 |
|
<tr> |
366 |
|
<td><code>$NKSP_CALLBACK_PARENT_ID</code></td> |
367 |
|
<td> |
368 |
|
If the current execution thread is a child thread spawned by a <code>fork()</code> |
369 |
|
call before, then this variable reflects the callback ID of the parent |
370 |
|
thread which created this child thread. Otherwise this variable is <code>0</code>. |
371 |
|
See <code>fork()</code> for more details about this variable. |
372 |
|
</td> |
373 |
|
</tr> |
374 |
|
<tr> |
375 |
<td><code>$NKSP_REAL_TIMER</code></td> |
<td><code>$NKSP_REAL_TIMER</code></td> |
376 |
<td>Returns the current time stamp in reality (in microseconds). You may |
<td>Returns the current time stamp in reality (in microseconds). You may |
377 |
read this variable from time to time to take |
read this variable from time to time to take |
513 |
note is still "alive".</td> |
note is still "alive".</td> |
514 |
</tr> |
</tr> |
515 |
<tr> |
<tr> |
516 |
|
<td><code>$EVENT_PAR_NOTE</code></td> |
517 |
|
<td>Constant value symbolizing the "note number" parameter. See |
518 |
|
<code>get_event_par()</code> and <code>set_event_par()</code> |
519 |
|
for details.</td> |
520 |
|
</tr> |
521 |
|
<tr> |
522 |
|
<td><code>$EVENT_PAR_TUNE</code></td> |
523 |
|
<td>Constant value symbolizing the "tune" parameter. See |
524 |
|
<code>get_event_par()</code> and <code>set_event_par()</code> |
525 |
|
for details.</td> |
526 |
|
</tr> |
527 |
|
<tr> |
528 |
|
<td><code>$EVENT_PAR_VELOCITY</code></td> |
529 |
|
<td>Constant value symbolizing the "note velocity" parameter. See |
530 |
|
<code>get_event_par()</code> and <code>set_event_par()</code> |
531 |
|
for details.</td> |
532 |
|
</tr> |
533 |
|
<tr> |
534 |
|
<td><code>$EVENT_PAR_VOLUME</code></td> |
535 |
|
<td>Constant value symbolizing the "volume" parameter. See |
536 |
|
<code>get_event_par()</code> and <code>set_event_par()</code> |
537 |
|
for details.</td> |
538 |
|
</tr> |
539 |
|
<tr> |
540 |
|
<td><code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code></td> |
541 |
|
<td>Four constant values symbolizing the 4 possible user specific |
542 |
|
parameters, which i.e. might be used to pass data from one script |
543 |
|
(slot) to another script (slot). See <code>get_event_par()</code> |
544 |
|
and <code>set_event_par()</code> for details.</td> |
545 |
|
</tr> |
546 |
|
<tr> |
547 |
<td><code>%KEY_DOWN[]</code></td> |
<td><code>%KEY_DOWN[]</code></td> |
548 |
<td>This can be used in any context to check whether a certain MIDI |
<td>This can be used in any context to check whether a certain MIDI |
549 |
key is currently pressed down. Use the respective MIDI note number |
key is currently pressed down. Use the respective MIDI note number |
550 |
as index to this array variable (see also <code>event_status()</code>).</td> |
as index to this array variable (see also <code>event_status()</code>).</td> |
551 |
</tr> |
</tr> |
552 |
<tr> |
<tr> |
553 |
|
<td><code>$NKSP_EASE_IN_EASE_OUT</code></td> |
554 |
|
<td>Used to select a fade curve with "ease in and ease out" shape.</td> |
555 |
|
</tr> |
556 |
|
<tr> |
557 |
|
<td><code>$NKSP_LINEAR</code></td> |
558 |
|
<td>Used to select a fade curve with linear shape.</td> |
559 |
|
</tr> |
560 |
|
<tr> |
561 |
<td><code>$VCC_MONO_AT</code></td> |
<td><code>$VCC_MONO_AT</code></td> |
562 |
<td>Constant identifying the MIDI monophonic aftertouch controller (also |
<td>Constant identifying the MIDI monophonic aftertouch controller (also |
563 |
called <i title="Amount of force on held-down key."> |
called <i title="Amount of force on held-down key."> |
631 |
<td>Constant that identifies the <i>keyboard position dimension</i>.</td> |
<td>Constant that identifies the <i>keyboard position dimension</i>.</td> |
632 |
</tr> |
</tr> |
633 |
<tr> |
<tr> |
634 |
<td><code>$GIG_DIM_ROUNDROBIN"</code></td> |
<td><code>$GIG_DIM_ROUNDROBIN</code></td> |
635 |
<td>Constant that identifies the <i>round robin dimension</i>.</td> |
<td>Constant that identifies the <i>round robin dimension</i>.</td> |
636 |
</tr> |
</tr> |
637 |
<tr> |
<tr> |
739 |
<td>Constant that identifies the <i>general purpose 8 MIDI controller dimension</i>.</td> |
<td>Constant that identifies the <i>general purpose 8 MIDI controller dimension</i>.</td> |
740 |
</tr> |
</tr> |
741 |
</table> |
</table> |
742 |
|
|
743 |
|
<h2>Built-In Preprocessor Conditions</h2> |
744 |
|
<p> |
745 |
|
These are the built-in preprocessor conditions available with the NKSP realt-time |
746 |
|
instrument script language. |
747 |
|
</p> |
748 |
|
|
749 |
|
<h3>Core Language Preprocessor Conditions</h3> |
750 |
|
<p> |
751 |
|
Most fundamental NKSP built-in preprocessor conditions, independent from |
752 |
|
any purpose of being used in a sampler. |
753 |
|
</p> |
754 |
|
<table> |
755 |
|
<tr> |
756 |
|
<th>Condition</th> <th>Description</th> |
757 |
|
</tr> |
758 |
|
<tr> |
759 |
|
<td><code>NKSP_NO_MESSAGE</code></td> |
760 |
|
<td> |
761 |
|
By default this condition is not set. By explicitly enabling this |
762 |
|
condition with <code>SET_CONDITION(NKSP_NO_MESSAGE)</code> it |
763 |
|
causes all subsequent <code>message()</code> calls to be ignored |
764 |
|
and filtered out on preprocessor level. See function <code>message()</code> |
765 |
|
for details. |
766 |
|
</td> |
767 |
|
</tr> |
768 |
|
</table> |
769 |
|
|
770 |
</body> |
</body> |
771 |
</html> |
</html> |