1 |
schoenebeck |
2732 |
<html> |
2 |
|
|
<head> |
3 |
|
|
<meta name="author" content="Christian Schoenebeck"> |
4 |
|
|
<title>NKSP Reference</title> |
5 |
|
|
<urlpath>Reference</urlpath> |
6 |
|
|
<navpath>Reference Manual</navpath> |
7 |
|
|
<meta name="description" content="Reference documentation of the NKSP real-time instrument script language."> |
8 |
|
|
</head> |
9 |
|
|
<body> |
10 |
|
|
<h1>NKSP Reference</h1> |
11 |
|
|
<p> |
12 |
|
|
This document gives you an overview of all built-in functions and built-in |
13 |
|
|
variables provided by the NKSP real-time instrument script language. |
14 |
|
|
</p> |
15 |
|
|
|
16 |
|
|
<h2>Built-In Functions</h2> |
17 |
|
|
<p> |
18 |
|
|
These are the built-in functions available with the NKSP realt-time |
19 |
|
|
instrument script language. |
20 |
|
|
</p> |
21 |
|
|
|
22 |
|
|
<h3>Core Language Functions</h3> |
23 |
|
|
<p> |
24 |
|
|
Most fundamental NKSP functions, independent from any purpose of being used in a sampler. |
25 |
|
|
</p> |
26 |
|
|
<table> |
27 |
|
|
<tr> |
28 |
|
|
<th>Function</th> <th>Description</th> |
29 |
|
|
</tr> |
30 |
|
|
<tr> |
31 |
schoenebeck |
2946 |
<td><code lang="nksp">dec()</code></td> |
32 |
|
|
<td>Decrements the passed integer variable by one.</td> |
33 |
|
|
</tr> |
34 |
|
|
<tr> |
35 |
|
|
<td><code>inc()</code></td> |
36 |
|
|
<td>Increments the passed integer variable by one.</td> |
37 |
|
|
</tr> |
38 |
|
|
<tr> |
39 |
schoenebeck |
2742 |
<td><code lang="nksp">message()</code></td> |
40 |
schoenebeck |
2732 |
<td>Prints text to the sampler's terminal.</td> |
41 |
|
|
</tr> |
42 |
|
|
<tr> |
43 |
|
|
<td><code>exit()</code></td> |
44 |
|
|
<td>Stops execution of the current event handler instance.</td> |
45 |
|
|
</tr> |
46 |
|
|
<tr> |
47 |
|
|
<td><code>wait()</code></td> |
48 |
|
|
<td>Pauses execution for a certain amount of time.</td> |
49 |
|
|
</tr> |
50 |
|
|
<tr> |
51 |
schoenebeck |
2949 |
<td><code>stop_wait()</code></td> |
52 |
|
|
<td>Resumes execution of a suspended script callback.</td> |
53 |
|
|
</tr> |
54 |
|
|
<tr> |
55 |
schoenebeck |
2732 |
<td><code>abs()</code></td> |
56 |
|
|
<td>Calculates the absolute value of a given value.</td> |
57 |
|
|
</tr> |
58 |
|
|
<tr> |
59 |
|
|
<td><code>random()</code></td> |
60 |
|
|
<td>Random number generator.</td> |
61 |
|
|
</tr> |
62 |
|
|
<tr> |
63 |
|
|
<td><code>num_elements()</code></td> |
64 |
|
|
<td>Returns the size of the requested array variable.</td> |
65 |
|
|
</tr> |
66 |
schoenebeck |
2966 |
<tr> |
67 |
|
|
<td><code>sh_left()</code></td> |
68 |
|
|
<td>Calculates a left bit shifted value.</td> |
69 |
|
|
</tr> |
70 |
|
|
<tr> |
71 |
|
|
<td><code>sh_right()</code></td> |
72 |
|
|
<td>Calculates a right bit shifted value.</td> |
73 |
|
|
</tr> |
74 |
schoenebeck |
2732 |
</table> |
75 |
|
|
|
76 |
|
|
<h3>Common Sampler Functions</h3> |
77 |
|
|
<p> |
78 |
|
|
Basic sampler related functions, independent from a particular sampler |
79 |
|
|
format or sampler engine. |
80 |
|
|
</p> |
81 |
|
|
<table> |
82 |
|
|
<tr> |
83 |
|
|
<th>Function</th> <th>Description</th> |
84 |
|
|
</tr> |
85 |
|
|
<tr> |
86 |
|
|
<td><code>play_note()</code></td> |
87 |
|
|
<td>Triggers a new note.</td> |
88 |
|
|
</tr> |
89 |
|
|
<tr> |
90 |
schoenebeck |
2932 |
<td><code>change_pan()</code></td> |
91 |
|
|
<td>Changes panning of voices (stereo balance).</td> |
92 |
|
|
</tr> |
93 |
|
|
<tr> |
94 |
|
|
<td><code>change_tune()</code></td> |
95 |
|
|
<td>Changes the tuning of voices.</td> |
96 |
|
|
</tr> |
97 |
|
|
<tr> |
98 |
|
|
<td><code>change_vol()</code></td> |
99 |
|
|
<td>Changes the volume of voices.</td> |
100 |
|
|
</tr> |
101 |
|
|
<tr> |
102 |
schoenebeck |
2936 |
<td><code>change_cutoff()</code></td> |
103 |
|
|
<td>Changes filter cutoff frequency of voices.</td> |
104 |
|
|
</tr> |
105 |
|
|
<tr> |
106 |
|
|
<td><code>change_reso()</code></td> |
107 |
|
|
<td>Changes filter resonance of voices.</td> |
108 |
|
|
</tr> |
109 |
|
|
<tr> |
110 |
schoenebeck |
2954 |
<td><code>change_attack()</code></td> |
111 |
|
|
<td>Modifies the attack time of voices.</td> |
112 |
|
|
</tr> |
113 |
|
|
<tr> |
114 |
|
|
<td><code>change_decay()</code></td> |
115 |
|
|
<td>Modifies the decay time of voices.</td> |
116 |
|
|
</tr> |
117 |
|
|
<tr> |
118 |
|
|
<td><code>change_release()</code></td> |
119 |
|
|
<td>Modifies the release time of voices.</td> |
120 |
|
|
</tr> |
121 |
|
|
<tr> |
122 |
schoenebeck |
2936 |
<td><code>event_status()</code></td> |
123 |
|
|
<td>Checks and returns whether a particular note is still alive.</td> |
124 |
|
|
</tr> |
125 |
|
|
<tr> |
126 |
schoenebeck |
2732 |
<td><code>set_controller()</code></td> |
127 |
|
|
<td>Creates a MIDI control change event.</td> |
128 |
|
|
</tr> |
129 |
|
|
<tr> |
130 |
|
|
<td><code>ignore_event()</code></td> |
131 |
|
|
<td>Drops the given event.</td> |
132 |
|
|
</tr> |
133 |
|
|
<tr> |
134 |
|
|
<td><code>ignore_controller()</code></td> |
135 |
|
|
<td>Drops the given MIDI control change event.</td> |
136 |
|
|
</tr> |
137 |
|
|
<tr> |
138 |
|
|
<td><code>note_off()</code></td> |
139 |
|
|
<td>Releases the requested note.</td> |
140 |
|
|
</tr> |
141 |
|
|
<tr> |
142 |
|
|
<td><code>set_event_mark()</code></td> |
143 |
|
|
<td>Adds an event to an event group.</td> |
144 |
|
|
</tr> |
145 |
|
|
<tr> |
146 |
|
|
<td><code>delete_event_mark()</code></td> |
147 |
|
|
<td>Removes an event from some event group.</td> |
148 |
|
|
</tr> |
149 |
|
|
<tr> |
150 |
|
|
<td><code>by_marks()</code></td> |
151 |
|
|
<td>Returns all events of an event group.</td> |
152 |
|
|
</tr> |
153 |
|
|
</table> |
154 |
|
|
|
155 |
|
|
<h3>GigaStudio Format Functions</h3> |
156 |
|
|
<p> |
157 |
|
|
Sampler format specific functions, dedicated to the individual features |
158 |
|
|
of the GigaStudio format engine. |
159 |
|
|
</p> |
160 |
|
|
<table> |
161 |
|
|
<tr> |
162 |
|
|
<th>Function</th> <th>Description</th> |
163 |
|
|
</tr> |
164 |
|
|
<tr> |
165 |
|
|
<td><code>gig_set_dim_zone()</code></td> |
166 |
|
|
<td>Changes the currently active dimension zone.</td> |
167 |
|
|
</tr> |
168 |
|
|
</table> |
169 |
|
|
|
170 |
|
|
<h2>Built-In Variables</h2> |
171 |
|
|
<p> |
172 |
|
|
These are the built-in variables and built-in constants available with the |
173 |
|
|
NKSP realt-time instrument script language. |
174 |
|
|
</p> |
175 |
schoenebeck |
2944 |
|
176 |
|
|
<h3>Core Language Variables</h3> |
177 |
|
|
<p> |
178 |
|
|
Most fundamental NKSP built-in variables, independent from any purpose of |
179 |
|
|
being used in a sampler. |
180 |
|
|
</p> |
181 |
|
|
<table> |
182 |
|
|
<tr> |
183 |
|
|
<th>Variable</th> <th>Description</th> |
184 |
|
|
</tr> |
185 |
|
|
<tr> |
186 |
|
|
<td><code>$KSP_TIMER</code></td> |
187 |
|
|
<td>Preserved for compatiblity reasons with KSP, returns the same value |
188 |
|
|
as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details). |
189 |
|
|
Note that KSP's <code>reset_ksp_timer()</code> function is not available with |
190 |
|
|
NKSP. However when calculating time differences between two time |
191 |
|
|
stamps taken with <code>$NKSP_REAL_TIMER</code>, calling such a reset |
192 |
|
|
function is not required, because the underlying clock does not stop |
193 |
|
|
when it reached its value limit (which happens every 71 minutes), instead the clock |
194 |
|
|
will automatically restart from zero and the calculated time difference |
195 |
|
|
even between such transitions will reflect correct durations.</td> |
196 |
|
|
</tr> |
197 |
|
|
<tr> |
198 |
|
|
<td><code>$NKSP_PERF_TIMER</code></td> |
199 |
|
|
<td>Returns the current performance time stamp (in microseconds) of the |
200 |
|
|
script running. You may read this variable from time to time to take |
201 |
|
|
time stamps which can be used to calculate the time difference |
202 |
|
|
(in microseconds) which elapsed between them. A performance time |
203 |
|
|
stamp is based on the script's actual CPU execution time. So the |
204 |
|
|
internal clock which is used for generating such time stamps is only |
205 |
|
|
running forward if the respective script is actually executed by the |
206 |
|
|
CPU. Whenever your script is not really executed by the CPU (i.e. because |
207 |
|
|
your script got suspended by a wait() call or got forcely suspended due to |
208 |
|
|
real-time constraints, or when the entire sampler application got suspended |
209 |
|
|
by the OS for other applications or OS tasks) then the underlying internal |
210 |
|
|
clock is paused as well. |
211 |
|
|
<note class="important"> |
212 |
|
|
You should only use this built-in variable for script development |
213 |
|
|
purposes (i.e. for bench marking the performance of your script). |
214 |
|
|
You should <b>not</b> use it with your final production sounds! |
215 |
|
|
It is not appropriate for being used in a musical context, because |
216 |
|
|
when an offline bounce is performed for instance, the musical timing |
217 |
|
|
will be completely unrelated to the CPU execution time. Plus using |
218 |
|
|
this variable may cause audio drop outs on some systems. In a musical |
219 |
|
|
context you should use <code>$ENGINE_UPTIME</code> instead, which is |
220 |
|
|
also safe for offline bounces. |
221 |
|
|
</note> |
222 |
|
|
<note> |
223 |
|
|
On some systems <code>$NKSP_REAL_TIMER</code> and |
224 |
|
|
<code>$NKSP_PERF_TIMER</code> will actually return the same value. So the |
225 |
|
|
difference between them is not implemented for all systems at the moment. |
226 |
|
|
</note> |
227 |
|
|
</td> |
228 |
|
|
</tr> |
229 |
|
|
<tr> |
230 |
|
|
<td><code>$NKSP_REAL_TIMER</code></td> |
231 |
|
|
<td>Returns the current time stamp in reality (in microseconds). You may |
232 |
|
|
read this variable from time to time to take |
233 |
|
|
time stamps which can be used to calculate the time difference |
234 |
|
|
(in microseconds) which elapsed between them. A "real" time |
235 |
|
|
stamp is based on an internal clock which constantly proceeds, so this |
236 |
|
|
internal clock also continues counting while your script is either suspended |
237 |
|
|
(i.e. because your script got suspended by a wait() call or got forcely |
238 |
|
|
suspended due to real-time constraints) and it also continues counting |
239 |
|
|
even if the entire sampler application got suspended by the OS (i.e. to |
240 |
|
|
execute other applications for multi-tasking or to perform OS tasks). |
241 |
|
|
<note class="important"> |
242 |
|
|
You should only use this built-in variable for script development |
243 |
|
|
purposes (i.e. for bench marking the performance of your script). |
244 |
|
|
You should <b>not</b> use it with your final production sounds! |
245 |
|
|
It is not appropriate for being used in a musical context, because |
246 |
|
|
when an offline bounce is performed for instance, the musical timing |
247 |
|
|
will be completely unrelated to the CPU execution time. Plus using |
248 |
|
|
this variable may cause audio drop outs on some systems. In a musical |
249 |
|
|
context you should use <code>$ENGINE_UPTIME</code> instead, which is |
250 |
|
|
also safe for offline bounces. |
251 |
|
|
</note> |
252 |
|
|
<note> |
253 |
|
|
On some systems <code>$NKSP_REAL_TIMER</code> and |
254 |
|
|
<code>$NKSP_PERF_TIMER</code> will actually return the same value. So the |
255 |
|
|
difference between them is not implemented for all systems at the moment. |
256 |
|
|
</note> |
257 |
|
|
</td> |
258 |
|
|
</tr> |
259 |
schoenebeck |
2949 |
<tr> |
260 |
|
|
<td><code>$NI_CALLBACK_ID</code></td> |
261 |
|
|
<td>Reflects the current event handler instance's unique callback ID. |
262 |
|
|
For the same event type there may be more than |
263 |
|
|
one event handler instances running. Each one of them has |
264 |
|
|
its own callback ID. You can get the current event handler |
265 |
|
|
instance's callback ID by reading this built-in variable.</td> |
266 |
|
|
</tr> |
267 |
|
|
<tr> |
268 |
|
|
<td><code>$NI_CALLBACK_TYPE</code></td> |
269 |
|
|
<td>Reflects the event type of the current event handler. This variable |
270 |
|
|
may reflect one of the following built-in constants: |
271 |
|
|
<code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>, |
272 |
|
|
<code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td> |
273 |
|
|
</tr> |
274 |
|
|
<tr> |
275 |
|
|
<td><code>$NI_CB_TYPE_INIT</code></td> |
276 |
|
|
<td>Built-in constant reflecting an <code>init</code> event handler type.</td> |
277 |
|
|
</tr> |
278 |
|
|
<tr> |
279 |
|
|
<td><code>$NI_CB_TYPE_NOTE</code></td> |
280 |
|
|
<td>Built-in constant reflecting a <code>note</code> event handler type.</td> |
281 |
|
|
</tr> |
282 |
|
|
<tr> |
283 |
|
|
<td><code>$NI_CB_TYPE_RELEASE</code></td> |
284 |
|
|
<td>Built-in constant reflecting a <code>release</code> event handler type.</td> |
285 |
|
|
</tr> |
286 |
|
|
<tr> |
287 |
|
|
<td><code>$NI_CB_TYPE_CONTROLLER</code></td> |
288 |
|
|
<td>Built-in constant reflecting a <code>controller</code> event handler type.</td> |
289 |
|
|
</tr> |
290 |
|
|
<tr> |
291 |
|
|
<td><code>$NKSP_IGNORE_WAIT</code></td> |
292 |
|
|
<td>If this boolean built-in variable is <code>1</code> then all calls of your |
293 |
|
|
event handler instance to function <code>wait()</code> will be ignored. |
294 |
|
|
This may for example be the case if another event handler instance |
295 |
|
|
resumed your paused script by calling <code>stop_wait()</code> and |
296 |
|
|
passing <code>1</code> to the 2nd argument of that function.</td> |
297 |
|
|
</tr> |
298 |
schoenebeck |
2944 |
</table> |
299 |
|
|
|
300 |
schoenebeck |
2732 |
<h3>Common Sampler Variables</h3> |
301 |
|
|
<p> |
302 |
|
|
Basic sampler related built-in variables and constants, independent from a |
303 |
|
|
particular sampler format or sampler engine. |
304 |
|
|
</p> |
305 |
|
|
<table> |
306 |
|
|
<tr> |
307 |
|
|
<th>Variable</th> <th>Description</th> |
308 |
|
|
</tr> |
309 |
|
|
<tr> |
310 |
|
|
<td><code>$CC_NUM</code></td> |
311 |
|
|
<td>MIDI controller number that caused the <code>controller</code> |
312 |
|
|
handler to be executed (only useful in the context of a |
313 |
|
|
<code>controller</code> handler).</td> |
314 |
|
|
</tr> |
315 |
|
|
<tr> |
316 |
|
|
<td><code>%CC[]</code></td> |
317 |
|
|
<td>Provides access to all current MIDI controller values. This can be |
318 |
|
|
used in any context. Use the respective MIDI controller number as |
319 |
|
|
index to this integer array variable. For instance <code>%CC[1]</code> |
320 |
|
|
would give you the current value of the modulation wheel. |
321 |
|
|
</td> |
322 |
|
|
</tr> |
323 |
|
|
<tr> |
324 |
|
|
<td><code>$EVENT_ID</code></td> |
325 |
|
|
<td>ID of the event that caused the current event handler to be executed. In |
326 |
|
|
the context of a <code>note</code> handler this would be the event |
327 |
|
|
ID of the note, within a <code>controller</code> handler it would |
328 |
|
|
be the controller event ID, etc.</td> |
329 |
|
|
</tr> |
330 |
|
|
<tr> |
331 |
|
|
<td><code>$EVENT_NOTE</code></td> |
332 |
|
|
<td>MIDI note number that caused a note related |
333 |
|
|
handler to be executed (only useful in the context of a |
334 |
|
|
<code>note</code> or <code>release</code> handler).</td> |
335 |
|
|
</tr> |
336 |
|
|
<tr> |
337 |
|
|
<td><code>$EVENT_VELOCITY</code></td> |
338 |
|
|
<td>MIDI velocity value of the note that caused that note related |
339 |
|
|
handler to be executed (only useful in the context of a |
340 |
|
|
<code>note</code> or <code>release</code> handler).</td> |
341 |
|
|
</tr> |
342 |
|
|
<tr> |
343 |
schoenebeck |
2937 |
<td><code>$EVENT_STATUS_INACTIVE</code></td> |
344 |
|
|
<td>Constant bit flag used as possible return value by |
345 |
|
|
<code>event_status()</code> in case the requested |
346 |
|
|
note is not "alive".</td> |
347 |
|
|
</tr> |
348 |
|
|
<tr> |
349 |
|
|
<td><code>$EVENT_STATUS_NOTE_QUEUE</code></td> |
350 |
|
|
<td>Constant bit flag used as possible return value by |
351 |
|
|
<code>event_status()</code> in case the requested |
352 |
|
|
note is still "alive".</td> |
353 |
|
|
</tr> |
354 |
|
|
<tr> |
355 |
schoenebeck |
2732 |
<td><code>%KEY_DOWN[]</code></td> |
356 |
|
|
<td>This can be used in any context to check whether a certain MIDI |
357 |
|
|
key is currently pressed down. Use the respective MIDI note number |
358 |
schoenebeck |
2936 |
as index to this array variable (see also <code>event_status()</code>).</td> |
359 |
schoenebeck |
2732 |
</tr> |
360 |
|
|
<tr> |
361 |
|
|
<td><code>$VCC_MONO_AT</code></td> |
362 |
|
|
<td>Constant identifying the MIDI monophonic aftertouch controller (also |
363 |
|
|
called <i title="Amount of force on held-down key."> |
364 |
|
|
MIDI channel pressure |
365 |
|
|
</i>). This is somewhat different than in the MIDI standard. With |
366 |
|
|
NKSP aftertouch is handled like an additional "regular" MIDI CC controller. |
367 |
|
|
Therefore use |
368 |
|
|
<code>%CC[$VCC_MONO_AT]</code> to obtain the current aftertouch value |
369 |
|
|
in the context of a <code>controller</code> event handler. |
370 |
|
|
</td> |
371 |
|
|
</tr> |
372 |
|
|
<tr> |
373 |
|
|
<td><code>$VCC_PITCH_BEND</code></td> |
374 |
|
|
<td>Constant identifying the pitch bend wheel controller. |
375 |
|
|
This is somewhat different than in the MIDI standard. With |
376 |
|
|
NKSP pitch bend is handled like an additional "regular" MIDI CC controller. |
377 |
|
|
Therefore use |
378 |
schoenebeck |
2936 |
<code>%CC[$VCC_PITCH_BEND]</code> to obtain the current pitch bend wheel value |
379 |
schoenebeck |
2732 |
in the context of a <code>controller</code> event handler.</td> |
380 |
|
|
</tr> |
381 |
|
|
<tr> |
382 |
|
|
<td><code>$MARK_1</code> to <code>$MARK_28</code></td> |
383 |
|
|
<td>Used to select one of the available 28 event groups. |
384 |
|
|
See <code>set_event_mark()</code> for details.</td> |
385 |
|
|
</tr> |
386 |
schoenebeck |
2944 |
<tr> |
387 |
|
|
<td><code>$ENGINE_UPTIME</code></td> |
388 |
|
|
<td>Returns the current time stamp (in milliseconds) for being |
389 |
|
|
used in a musical context. You may read this variable from time to time |
390 |
|
|
to take time stamps which can be used to calculate the time difference |
391 |
|
|
(in milliseconds) which elapsed between them. These timing values are |
392 |
|
|
based on the internal sample rate and thus it can safely be used to |
393 |
|
|
perform musical timing related tasks in your scripts. Especially |
394 |
|
|
your script will also continue to behave correctly when an offline bounce |
395 |
|
|
of a song is performed. |
396 |
|
|
</td> |
397 |
|
|
</tr> |
398 |
schoenebeck |
2732 |
</table> |
399 |
|
|
|
400 |
|
|
<h3>GigaStudio Format Variables</h3> |
401 |
|
|
<p> |
402 |
|
|
Sampler format specific built-in variables and constants, dedicated to the |
403 |
|
|
individual features of the GigaStudio format engine. |
404 |
|
|
</p> |
405 |
|
|
<table> |
406 |
|
|
<tr> |
407 |
|
|
<th>Variable</th> <th>Description</th> |
408 |
|
|
</tr> |
409 |
|
|
<tr> |
410 |
|
|
<td><code>$GIG_DIM_CHANNEL</code></td> |
411 |
|
|
<td>Constant that identifies the <i>stereo dimension</i>.</td> |
412 |
|
|
</tr> |
413 |
|
|
<tr> |
414 |
|
|
<td><code>$GIG_DIM_LAYER</code></td> |
415 |
|
|
<td>Constant that identifies the <i>layer dimension</i>.</td> |
416 |
|
|
</tr> |
417 |
|
|
<tr> |
418 |
|
|
<td><code>$GIG_DIM_VELOCITY</code></td> |
419 |
|
|
<td>Constant that identifies the <i>velocity dimension</i>.</td> |
420 |
|
|
</tr> |
421 |
|
|
<tr> |
422 |
|
|
<td><code>$GIG_DIM_AFTERTOUCH</code></td> |
423 |
|
|
<td>Constant that identifies the <i>aftertouch dimension</i>.</td> |
424 |
|
|
</tr> |
425 |
|
|
<tr> |
426 |
|
|
<td><code>$GIG_DIM_RELEASE</code></td> |
427 |
|
|
<td>Constant that identifies the <i>release trigger dimension</i>.</td> |
428 |
|
|
</tr> |
429 |
|
|
<tr> |
430 |
|
|
<td><code>$GIG_DIM_KEYBOARD</code></td> |
431 |
|
|
<td>Constant that identifies the <i>keyboard position dimension</i>.</td> |
432 |
|
|
</tr> |
433 |
|
|
<tr> |
434 |
|
|
<td><code>$GIG_DIM_ROUNDROBIN"</code></td> |
435 |
|
|
<td>Constant that identifies the <i>round robin dimension</i>.</td> |
436 |
|
|
</tr> |
437 |
|
|
<tr> |
438 |
|
|
<td><code>$GIG_DIM_RANDOM</code></td> |
439 |
|
|
<td>Constant that identifies the <i>random dimension</i>.</td> |
440 |
|
|
</tr> |
441 |
|
|
<tr> |
442 |
|
|
<td><code>$GIG_DIM_SMARTMIDI</code></td> |
443 |
|
|
<td>Constant that identifies the <i>start MIDI dimension</i> (a.k.a iMIDI rules).</td> |
444 |
|
|
</tr> |
445 |
|
|
<tr> |
446 |
|
|
<td><code>$GIG_DIM_ROUNDROBINKEY</code></td> |
447 |
|
|
<td>Constant that identifies the <i>round robin key dimension</i>.</td> |
448 |
|
|
</tr> |
449 |
|
|
<tr> |
450 |
|
|
<td><code>$GIG_DIM_MODWHEEL</code></td> |
451 |
|
|
<td>Constant that identifies the <i>modulation wheel dimension</i>.</td> |
452 |
|
|
</tr> |
453 |
|
|
<tr> |
454 |
|
|
<td><code>$GIG_DIM_SUSTAIN</code></td> |
455 |
|
|
<td>Constant that identifies the <i>sustain pedal dimension</i> (a.k.a. hold pedal).</td> |
456 |
|
|
</tr> |
457 |
|
|
<tr> |
458 |
|
|
<td><code>$GIG_DIM_PORTAMENTO</code></td> |
459 |
|
|
<td>Constant that identifies the <i>portamento MIDI controller dimension</i>.</td> |
460 |
|
|
</tr> |
461 |
|
|
<tr> |
462 |
|
|
<td><code>$GIG_DIM_SOSTENUTO</code></td> |
463 |
|
|
<td>Constant that identifies the <i>sostenuto MIDI controller dimension</i>.</td> |
464 |
|
|
</tr> |
465 |
|
|
<tr> |
466 |
|
|
<td><code>$GIG_DIM_SOFT</code></td> |
467 |
|
|
<td>Constant that identifies the <i>soft pedal dimension</i>.</td> |
468 |
|
|
</tr> |
469 |
|
|
<tr> |
470 |
|
|
<td><code>$GIG_DIM_BREATH</code></td> |
471 |
|
|
<td>Constant that identifies the <i>breath controller dimension</i>.</td> |
472 |
|
|
</tr> |
473 |
|
|
<tr> |
474 |
|
|
<td><code>$GIG_DIM_FOOT</code></td> |
475 |
|
|
<td>Constant that identifies the <i>foot pedal dimension</i>.</td> |
476 |
|
|
</tr> |
477 |
|
|
<tr> |
478 |
|
|
<td><code>$GIG_DIM_PORTAMENTOTIME</code></td> |
479 |
|
|
<td>Constant that identifies the <i>portamento time controller dimension</i>.</td> |
480 |
|
|
</tr> |
481 |
|
|
<tr> |
482 |
|
|
<td><code>$GIG_DIM_EFFECT1</code></td> |
483 |
|
|
<td>Constant that identifies the <i>effect 1 MIDI controller dimension</i>.</td> |
484 |
|
|
</tr> |
485 |
|
|
<tr> |
486 |
|
|
<td><code>$GIG_DIM_EFFECT2</code></td> |
487 |
|
|
<td>Constant that identifies the <i>effect 2 MIDI controller dimension</i>.</td> |
488 |
|
|
</tr> |
489 |
|
|
<tr> |
490 |
|
|
<td><code>$GIG_DIM_EFFECT1DEPTH</code></td> |
491 |
|
|
<td>Constant that identifies the <i>effect 1 depth MIDI controller dimension</i>.</td> |
492 |
|
|
</tr> |
493 |
|
|
<tr> |
494 |
|
|
<td><code>$GIG_DIM_EFFECT2DEPTH</code></td> |
495 |
|
|
<td>Constant that identifies the <i>effect 2 depth MIDI controller dimension</i>.</td> |
496 |
|
|
</tr> |
497 |
|
|
<tr> |
498 |
|
|
<td><code>$GIG_DIM_EFFECT3DEPTH</code></td> |
499 |
|
|
<td>Constant that identifies the <i>effect 3 depth MIDI controller dimension</i>.</td> |
500 |
|
|
</tr> |
501 |
|
|
<tr> |
502 |
|
|
<td><code>$GIG_DIM_EFFECT4DEPTH</code></td> |
503 |
|
|
<td>Constant that identifies the <i>effect 4 depth MIDI controller dimension</i>.</td> |
504 |
|
|
</tr> |
505 |
|
|
<tr> |
506 |
|
|
<td><code>$GIG_DIM_EFFECT5DEPTH</code></td> |
507 |
|
|
<td>Constant that identifies the <i>effect 5 depth MIDI controller dimension</i>.</td> |
508 |
|
|
</tr> |
509 |
|
|
<tr> |
510 |
|
|
<td><code>$GIG_DIM_GENPURPOSE1</code></td> |
511 |
|
|
<td>Constant that identifies the <i>general purpose 1 MIDI controller dimension</i>.</td> |
512 |
|
|
</tr> |
513 |
|
|
<tr> |
514 |
|
|
<td><code>$GIG_DIM_GENPURPOSE2</code></td> |
515 |
|
|
<td>Constant that identifies the <i>general purpose 2 MIDI controller dimension</i>.</td> |
516 |
|
|
</tr> |
517 |
|
|
<tr> |
518 |
|
|
<td><code>$GIG_DIM_GENPURPOSE3</code></td> |
519 |
|
|
<td>Constant that identifies the <i>general purpose 3 MIDI controller dimension</i>.</td> |
520 |
|
|
</tr> |
521 |
|
|
<tr> |
522 |
|
|
<td><code>$GIG_DIM_GENPURPOSE4</code></td> |
523 |
|
|
<td>Constant that identifies the <i>general purpose 4 MIDI controller dimension</i>.</td> |
524 |
|
|
</tr> |
525 |
|
|
<tr> |
526 |
|
|
<td><code>$GIG_DIM_GENPURPOSE5</code></td> |
527 |
|
|
<td>Constant that identifies the <i>general purpose 5 MIDI controller dimension</i>.</td> |
528 |
|
|
</tr> |
529 |
|
|
<tr> |
530 |
|
|
<td><code>$GIG_DIM_GENPURPOSE6</code></td> |
531 |
|
|
<td>Constant that identifies the <i>general purpose 6 MIDI controller dimension</i>.</td> |
532 |
|
|
</tr> |
533 |
|
|
<tr> |
534 |
|
|
<td><code>$GIG_DIM_GENPURPOSE7</code></td> |
535 |
|
|
<td>Constant that identifies the <i>general purpose 7 MIDI controller dimension</i>.</td> |
536 |
|
|
</tr> |
537 |
|
|
<tr> |
538 |
|
|
<td><code>$GIG_DIM_GENPURPOSE8</code></td> |
539 |
|
|
<td>Constant that identifies the <i>general purpose 8 MIDI controller dimension</i>.</td> |
540 |
|
|
</tr> |
541 |
|
|
</table> |
542 |
|
|
|
543 |
|
|
</body> |
544 |
|
|
</html> |