/[svn]/doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html
ViewVC logotype

Contents of /doc/docbase/instrument_scripts/nksp/reference/01_nksp_reference.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3278 - (show annotations) (download) (as text)
Mon Jun 5 19:02:59 2017 UTC (2 years, 11 months ago) by schoenebeck
File MIME type: text/html
File size: 27772 byte(s)
* NKSP: Added abort() function.

1 <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 real-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 <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 lang="nksp">dec()</code></td>
40 <td>Decrements the passed integer variable by one.</td>
41 </tr>
42 <tr>
43 <td><code>inc()</code></td>
44 <td>Increments the passed integer variable by one.</td>
45 </tr>
46 <tr>
47 <td><code>in_range()</code></td>
48 <td>Checks whether a value is between two other values.</td>
49 </tr>
50 <tr>
51 <td><code lang="nksp">message()</code></td>
52 <td>Prints text to the sampler's terminal.</td>
53 </tr>
54 <tr>
55 <td><code>search()</code></td>
56 <td>Search for a certain value within an array.</td>
57 </tr>
58 <tr>
59 <td><code>sort()</code></td>
60 <td>Sort the given array.</td>
61 </tr>
62 <tr>
63 <td><code>exit()</code></td>
64 <td>Stops execution of the current event handler instance.</td>
65 </tr>
66 <tr>
67 <td><code>wait()</code></td>
68 <td>Pauses execution for a certain amount of time.</td>
69 </tr>
70 <tr>
71 <td><code>stop_wait()</code></td>
72 <td>Resumes execution of a suspended script callback.</td>
73 </tr>
74 <tr>
75 <td><code>abs()</code></td>
76 <td>Calculates the absolute value of a given value.</td>
77 </tr>
78 <tr>
79 <td><code>random()</code></td>
80 <td>Random number generator.</td>
81 </tr>
82 <tr>
83 <td><code>min()</code></td>
84 <td>Calculates the minimum value of two given values.</td>
85 </tr>
86 <tr>
87 <td><code>max()</code></td>
88 <td>Calculates the maximum value of two given values.</td>
89 </tr>
90 <tr>
91 <td><code>num_elements()</code></td>
92 <td>Returns the size of the requested array variable.</td>
93 </tr>
94 <tr>
95 <td><code>sh_left()</code></td>
96 <td>Calculates a left bit shifted value.</td>
97 </tr>
98 <tr>
99 <td><code>sh_right()</code></td>
100 <td>Calculates a right bit shifted value.</td>
101 </tr>
102 </table>
103
104 <h3>Common Sampler Functions</h3>
105 <p>
106 Basic sampler related functions, independent from a particular sampler
107 format or sampler engine.
108 </p>
109 <table>
110 <tr>
111 <th>Function</th> <th>Description</th>
112 </tr>
113 <tr>
114 <td><code>play_note()</code></td>
115 <td>Triggers a new note.</td>
116 </tr>
117 <tr>
118 <td><code>change_note()</code></td>
119 <td>Change MIDI note number of note.</td>
120 </tr>
121 <tr>
122 <td><code>change_pan()</code></td>
123 <td>Changes panning of voices (stereo balance).</td>
124 </tr>
125 <tr>
126 <td><code>change_play_pos()</code></td>
127 <td>Change the sample playback position.</td>
128 </tr>
129 <tr>
130 <td><code>change_tune()</code></td>
131 <td>Changes the tuning of voices.</td>
132 </tr>
133 <tr>
134 <td><code>change_tune_time()</code></td>
135 <td>Changes the duration of tuning changes.</td>
136 </tr>
137 <tr>
138 <td><code>change_tune_curve()</code></td>
139 <td>Changes the curve type of tuning changes.</td>
140 </tr>
141 <tr>
142 <td><code>change_vol()</code></td>
143 <td>Changes the volume of voices.</td>
144 </tr>
145 <tr>
146 <td><code>change_vol_time()</code></td>
147 <td>Changes the duration of volume changes.</td>
148 </tr>
149 <tr>
150 <td><code>change_vol_curve()</code></td>
151 <td>Changes the curve type of volume changes.</td>
152 </tr>
153 <tr>
154 <td><code>change_cutoff()</code></td>
155 <td>Changes filter cutoff frequency of voices.</td>
156 </tr>
157 <tr>
158 <td><code>change_reso()</code></td>
159 <td>Changes filter resonance of voices.</td>
160 </tr>
161 <tr>
162 <td><code>change_attack()</code></td>
163 <td>Modifies the attack time of voices.</td>
164 </tr>
165 <tr>
166 <td><code>change_decay()</code></td>
167 <td>Modifies the decay time of voices.</td>
168 </tr>
169 <tr>
170 <td><code>change_release()</code></td>
171 <td>Modifies the release time of voices.</td>
172 </tr>
173 <tr>
174 <td><code>change_amp_lfo_depth()</code></td>
175 <td>Modifies the amplitude LFO depth.</td>
176 </tr>
177 <tr>
178 <td><code>change_amp_lfo_freq()</code></td>
179 <td>Modifies the amplitude LFO frequency.</td>
180 </tr>
181 <tr>
182 <td><code>change_pitch_lfo_depth()</code></td>
183 <td>Modifies the pitch LFO depth.</td>
184 </tr>
185 <tr>
186 <td><code>change_pitch_lfo_freq()</code></td>
187 <td>Modifies the pitch LFO frequency.</td>
188 </tr>
189 <tr>
190 <td><code>change_velo()</code></td>
191 <td>Change MIDI velocity of note.</td>
192 </tr>
193 <tr>
194 <td><code>event_status()</code></td>
195 <td>Checks and returns whether a particular note is still alive.</td>
196 </tr>
197 <tr>
198 <td><code>fade_in()</code></td>
199 <td>Fade the requested note in.</td>
200 </tr>
201 <tr>
202 <td><code>fade_out()</code></td>
203 <td>Fade the requested note out.</td>
204 </tr>
205 <tr>
206 <td><code>get_event_par()</code></td>
207 <td>Get the current value of a specific note parameter.</td>
208 </tr>
209 <tr>
210 <td><code>set_event_par()</code></td>
211 <td>Change the value of a specific note parameter.</td>
212 </tr>
213 <tr>
214 <td><code>set_controller()</code></td>
215 <td>Creates a MIDI control change event.</td>
216 </tr>
217 <tr>
218 <td><code>ignore_event()</code></td>
219 <td>Drops the given event.</td>
220 </tr>
221 <tr>
222 <td><code>ignore_controller()</code></td>
223 <td>Drops the given MIDI control change event.</td>
224 </tr>
225 <tr>
226 <td><code>note_off()</code></td>
227 <td>Releases the requested note.</td>
228 </tr>
229 <tr>
230 <td><code>set_event_mark()</code></td>
231 <td>Adds an event to an event group.</td>
232 </tr>
233 <tr>
234 <td><code>delete_event_mark()</code></td>
235 <td>Removes an event from some event group.</td>
236 </tr>
237 <tr>
238 <td><code>by_marks()</code></td>
239 <td>Returns all events of an event group.</td>
240 </tr>
241 </table>
242
243 <h3>GigaStudio Format Functions</h3>
244 <p>
245 Sampler format specific functions, dedicated to the individual features
246 of the GigaStudio format engine.
247 </p>
248 <table>
249 <tr>
250 <th>Function</th> <th>Description</th>
251 </tr>
252 <tr>
253 <td><code>gig_set_dim_zone()</code></td>
254 <td>Changes the currently active dimension zone.</td>
255 </tr>
256 <tr>
257 <td><code>same_region()</code></td>
258 <td>Check whether two keys are mapped to the same region.</td>
259 </tr>
260 </table>
261
262 <h2>Built-In Variables</h2>
263 <p>
264 These are the built-in variables and built-in constants available with the
265 NKSP realt-time instrument script language.
266 </p>
267
268 <h3>Core Language Variables</h3>
269 <p>
270 Most fundamental NKSP built-in variables, independent from any purpose of
271 being used in a sampler.
272 </p>
273 <table>
274 <tr>
275 <th>Variable</th> <th>Description</th>
276 </tr>
277 <tr>
278 <td><code>$KSP_TIMER</code></td>
279 <td>Preserved for compatiblity reasons with KSP, returns the same value
280 as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).
281 Note that KSP's <code>reset_ksp_timer()</code> function is not available with
282 NKSP. However when calculating time differences between two time
283 stamps taken with <code>$NKSP_REAL_TIMER</code>, calling such a reset
284 function is not required, because the underlying clock does not stop
285 when it reached its value limit (which happens every 71 minutes), instead the clock
286 will automatically restart from zero and the calculated time difference
287 even between such transitions will reflect correct durations.</td>
288 </tr>
289 <tr>
290 <td><code>$NKSP_PERF_TIMER</code></td>
291 <td>Returns the current performance time stamp (in microseconds) of the
292 script running. You may read this variable from time to time to take
293 time stamps which can be used to calculate the time difference
294 (in microseconds) which elapsed between them. A performance time
295 stamp is based on the script's actual CPU execution time. So the
296 internal clock which is used for generating such time stamps is only
297 running forward if the respective script is actually executed by the
298 CPU. Whenever your script is not really executed by the CPU (i.e. because
299 your script got suspended by a wait() call or got forcely suspended due to
300 real-time constraints, or when the entire sampler application got suspended
301 by the OS for other applications or OS tasks) then the underlying internal
302 clock is paused as well.
303 <note class="important">
304 You should only use this built-in variable for script development
305 purposes (i.e. for bench marking the performance of your script).
306 You should <b>not</b> use it with your final production sounds!
307 It is not appropriate for being used in a musical context, because
308 when an offline bounce is performed for instance, the musical timing
309 will be completely unrelated to the CPU execution time. Plus using
310 this variable may cause audio drop outs on some systems. In a musical
311 context you should use <code>$ENGINE_UPTIME</code> instead, which is
312 also safe for offline bounces.
313 </note>
314 <note>
315 On some systems <code>$NKSP_REAL_TIMER</code> and
316 <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
317 difference between them is not implemented for all systems at the moment.
318 </note>
319 </td>
320 </tr>
321 <tr>
322 <td><code>$NKSP_REAL_TIMER</code></td>
323 <td>Returns the current time stamp in reality (in microseconds). You may
324 read this variable from time to time to take
325 time stamps which can be used to calculate the time difference
326 (in microseconds) which elapsed between them. A "real" time
327 stamp is based on an internal clock which constantly proceeds, so this
328 internal clock also continues counting while your script is either suspended
329 (i.e. because your script got suspended by a wait() call or got forcely
330 suspended due to real-time constraints) and it also continues counting
331 even if the entire sampler application got suspended by the OS (i.e. to
332 execute other applications for multi-tasking or to perform OS tasks).
333 <note class="important">
334 You should only use this built-in variable for script development
335 purposes (i.e. for bench marking the performance of your script).
336 You should <b>not</b> use it with your final production sounds!
337 It is not appropriate for being used in a musical context, because
338 when an offline bounce is performed for instance, the musical timing
339 will be completely unrelated to the CPU execution time. Plus using
340 this variable may cause audio drop outs on some systems. In a musical
341 context you should use <code>$ENGINE_UPTIME</code> instead, which is
342 also safe for offline bounces.
343 </note>
344 <note>
345 On some systems <code>$NKSP_REAL_TIMER</code> and
346 <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
347 difference between them is not implemented for all systems at the moment.
348 </note>
349 </td>
350 </tr>
351 <tr>
352 <td><code>$NI_CALLBACK_ID</code></td>
353 <td>Reflects the current event handler instance's unique callback ID.
354 For the same event type there may be more than
355 one event handler instances running. Each one of them has
356 its own callback ID. You can get the current event handler
357 instance's callback ID by reading this built-in variable.</td>
358 </tr>
359 <tr>
360 <td><code>$NI_CALLBACK_TYPE</code></td>
361 <td>Reflects the event type of the current event handler. This variable
362 may reflect one of the following built-in constants:
363 <code>$NI_CB_TYPE_INIT</code>, <code>$NI_CB_TYPE_NOTE</code>,
364 <code>$NI_CB_TYPE_RELEASE</code>, <code>$NI_CB_TYPE_CONTROLLER</code>.</td>
365 </tr>
366 <tr>
367 <td><code>$NI_CB_TYPE_INIT</code></td>
368 <td>Built-in constant reflecting an <code>init</code> event handler type.</td>
369 </tr>
370 <tr>
371 <td><code>$NI_CB_TYPE_NOTE</code></td>
372 <td>Built-in constant reflecting a <code>note</code> event handler type.</td>
373 </tr>
374 <tr>
375 <td><code>$NI_CB_TYPE_RELEASE</code></td>
376 <td>Built-in constant reflecting a <code>release</code> event handler type.</td>
377 </tr>
378 <tr>
379 <td><code>$NI_CB_TYPE_CONTROLLER</code></td>
380 <td>Built-in constant reflecting a <code>controller</code> event handler type.</td>
381 </tr>
382 <tr>
383 <td><code>$NKSP_IGNORE_WAIT</code></td>
384 <td>If this boolean built-in variable is <code>1</code> then all calls of your
385 event handler instance to function <code>wait()</code> will be ignored.
386 This may for example be the case if another event handler instance
387 resumed your paused script by calling <code>stop_wait()</code> and
388 passing <code>1</code> to the 2nd argument of that function.</td>
389 </tr>
390 </table>
391
392 <h3>Common Sampler Variables</h3>
393 <p>
394 Basic sampler related built-in variables and constants, independent from a
395 particular sampler format or sampler engine.
396 </p>
397 <table>
398 <tr>
399 <th>Variable</th> <th>Description</th>
400 </tr>
401 <tr>
402 <td><code>%ALL_EVENTS</code></td>
403 <td>
404 Note IDs of all currently active notes of the current sampler part (a.k.a. sampler channel).
405 This may be passed to many built-in functions like <code>note_off()</code>.
406 This array variable only contains IDs of notes which were launched due
407 to MIDI note-on events. This variable does not contain IDs of child notes
408 (i.e. notes which were launched programmatically by calling <code>play_note()</code>).
409 <note>
410 In contrast to KSP this variable is an integer array type, whereas KSP's
411 pendent of this built-in variable is an integer constant (scalar) called
412 <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
413 parser warning, the behavior will be the same though.
414 </note>
415 </td>
416 </tr>
417 <tr>
418 <td><code>$CC_NUM</code></td>
419 <td>MIDI controller number that caused the <code>controller</code>
420 handler to be executed (only useful in the context of a
421 <code>controller</code> handler).</td>
422 </tr>
423 <tr>
424 <td><code>%CC[]</code></td>
425 <td>Provides access to all current MIDI controller values. This can be
426 used in any context. Use the respective MIDI controller number as
427 index to this integer array variable. For instance <code>%CC[1]</code>
428 would give you the current value of the modulation wheel.
429 </td>
430 </tr>
431 <tr>
432 <td><code>$EVENT_ID</code></td>
433 <td>ID of the event that caused the current event handler to be executed. In
434 the context of a <code>note</code> handler this would be the event
435 ID of the note, within a <code>controller</code> handler it would
436 be the controller event ID, etc.</td>
437 </tr>
438 <tr>
439 <td><code>$EVENT_NOTE</code></td>
440 <td>MIDI note number that caused a note related
441 handler to be executed (only useful in the context of a
442 <code>note</code> or <code>release</code> handler).</td>
443 </tr>
444 <tr>
445 <td><code>$EVENT_VELOCITY</code></td>
446 <td>MIDI velocity value of the note that caused that note related
447 handler to be executed (only useful in the context of a
448 <code>note</code> or <code>release</code> handler).</td>
449 </tr>
450 <tr>
451 <td><code>$EVENT_STATUS_INACTIVE</code></td>
452 <td>Constant bit flag used as possible return value by
453 <code>event_status()</code> in case the requested
454 note is not "alive".</td>
455 </tr>
456 <tr>
457 <td><code>$EVENT_STATUS_NOTE_QUEUE</code></td>
458 <td>Constant bit flag used as possible return value by
459 <code>event_status()</code> in case the requested
460 note is still "alive".</td>
461 </tr>
462 <tr>
463 <td><code>$EVENT_PAR_NOTE</code></td>
464 <td>Constant value symbolizing the "note number" parameter. See
465 <code>get_event_par()</code> and <code>set_event_par()</code>
466 for details.</td>
467 </tr>
468 <tr>
469 <td><code>$EVENT_PAR_TUNE</code></td>
470 <td>Constant value symbolizing the "tune" parameter. See
471 <code>get_event_par()</code> and <code>set_event_par()</code>
472 for details.</td>
473 </tr>
474 <tr>
475 <td><code>$EVENT_PAR_VELOCITY</code></td>
476 <td>Constant value symbolizing the "note velocity" parameter. See
477 <code>get_event_par()</code> and <code>set_event_par()</code>
478 for details.</td>
479 </tr>
480 <tr>
481 <td><code>$EVENT_PAR_VOLUME</code></td>
482 <td>Constant value symbolizing the "volume" parameter. See
483 <code>get_event_par()</code> and <code>set_event_par()</code>
484 for details.</td>
485 </tr>
486 <tr>
487 <td><code>$EVENT_PAR_0</code> to <code>$EVENT_PAR_3</code></td>
488 <td>Four constant values symbolizing the 4 possible user specific
489 parameters, which i.e. might be used to pass data from one script
490 (slot) to another script (slot). See <code>get_event_par()</code>
491 and <code>set_event_par()</code> for details.</td>
492 </tr>
493 <tr>
494 <td><code>%KEY_DOWN[]</code></td>
495 <td>This can be used in any context to check whether a certain MIDI
496 key is currently pressed down. Use the respective MIDI note number
497 as index to this array variable (see also <code>event_status()</code>).</td>
498 </tr>
499 <tr>
500 <td><code>$NKSP_EASE_IN_EASE_OUT</code></td>
501 <td>Used to select a fade curve with "ease in and ease out" shape.</td>
502 </tr>
503 <tr>
504 <td><code>$NKSP_LINEAR</code></td>
505 <td>Used to select a fade curve with linear shape.</td>
506 </tr>
507 <tr>
508 <td><code>$VCC_MONO_AT</code></td>
509 <td>Constant identifying the MIDI monophonic aftertouch controller (also
510 called <i title="Amount of force on held-down key.">
511 MIDI channel pressure
512 </i>). This is somewhat different than in the MIDI standard. With
513 NKSP aftertouch is handled like an additional "regular" MIDI CC controller.
514 Therefore use
515 <code>%CC[$VCC_MONO_AT]</code> to obtain the current aftertouch value
516 in the context of a <code>controller</code> event handler.
517 </td>
518 </tr>
519 <tr>
520 <td><code>$VCC_PITCH_BEND</code></td>
521 <td>Constant identifying the pitch bend wheel controller.
522 This is somewhat different than in the MIDI standard. With
523 NKSP pitch bend is handled like an additional "regular" MIDI CC controller.
524 Therefore use
525 <code>%CC[$VCC_PITCH_BEND]</code> to obtain the current pitch bend wheel value
526 in the context of a <code>controller</code> event handler.</td>
527 </tr>
528 <tr>
529 <td><code>$MARK_1</code> to <code>$MARK_28</code></td>
530 <td>Used to select one of the available 28 event groups.
531 See <code>set_event_mark()</code> for details.</td>
532 </tr>
533 <tr>
534 <td><code>$ENGINE_UPTIME</code></td>
535 <td>Returns the current time stamp (in milliseconds) for being
536 used in a musical context. You may read this variable from time to time
537 to take time stamps which can be used to calculate the time difference
538 (in milliseconds) which elapsed between them. These timing values are
539 based on the internal sample rate and thus it can safely be used to
540 perform musical timing related tasks in your scripts. Especially
541 your script will also continue to behave correctly when an offline bounce
542 of a song is performed.
543 </td>
544 </tr>
545 </table>
546
547 <h3>GigaStudio Format Variables</h3>
548 <p>
549 Sampler format specific built-in variables and constants, dedicated to the
550 individual features of the GigaStudio format engine.
551 </p>
552 <table>
553 <tr>
554 <th>Variable</th> <th>Description</th>
555 </tr>
556 <tr>
557 <td><code>$GIG_DIM_CHANNEL</code></td>
558 <td>Constant that identifies the <i>stereo dimension</i>.</td>
559 </tr>
560 <tr>
561 <td><code>$GIG_DIM_LAYER</code></td>
562 <td>Constant that identifies the <i>layer dimension</i>.</td>
563 </tr>
564 <tr>
565 <td><code>$GIG_DIM_VELOCITY</code></td>
566 <td>Constant that identifies the <i>velocity dimension</i>.</td>
567 </tr>
568 <tr>
569 <td><code>$GIG_DIM_AFTERTOUCH</code></td>
570 <td>Constant that identifies the <i>aftertouch dimension</i>.</td>
571 </tr>
572 <tr>
573 <td><code>$GIG_DIM_RELEASE</code></td>
574 <td>Constant that identifies the <i>release trigger dimension</i>.</td>
575 </tr>
576 <tr>
577 <td><code>$GIG_DIM_KEYBOARD</code></td>
578 <td>Constant that identifies the <i>keyboard position dimension</i>.</td>
579 </tr>
580 <tr>
581 <td><code>$GIG_DIM_ROUNDROBIN</code></td>
582 <td>Constant that identifies the <i>round robin dimension</i>.</td>
583 </tr>
584 <tr>
585 <td><code>$GIG_DIM_RANDOM</code></td>
586 <td>Constant that identifies the <i>random dimension</i>.</td>
587 </tr>
588 <tr>
589 <td><code>$GIG_DIM_SMARTMIDI</code></td>
590 <td>Constant that identifies the <i>start MIDI dimension</i> (a.k.a iMIDI rules).</td>
591 </tr>
592 <tr>
593 <td><code>$GIG_DIM_ROUNDROBINKEY</code></td>
594 <td>Constant that identifies the <i>round robin key dimension</i>.</td>
595 </tr>
596 <tr>
597 <td><code>$GIG_DIM_MODWHEEL</code></td>
598 <td>Constant that identifies the <i>modulation wheel dimension</i>.</td>
599 </tr>
600 <tr>
601 <td><code>$GIG_DIM_SUSTAIN</code></td>
602 <td>Constant that identifies the <i>sustain pedal dimension</i> (a.k.a. hold pedal).</td>
603 </tr>
604 <tr>
605 <td><code>$GIG_DIM_PORTAMENTO</code></td>
606 <td>Constant that identifies the <i>portamento MIDI controller dimension</i>.</td>
607 </tr>
608 <tr>
609 <td><code>$GIG_DIM_SOSTENUTO</code></td>
610 <td>Constant that identifies the <i>sostenuto MIDI controller dimension</i>.</td>
611 </tr>
612 <tr>
613 <td><code>$GIG_DIM_SOFT</code></td>
614 <td>Constant that identifies the <i>soft pedal dimension</i>.</td>
615 </tr>
616 <tr>
617 <td><code>$GIG_DIM_BREATH</code></td>
618 <td>Constant that identifies the <i>breath controller dimension</i>.</td>
619 </tr>
620 <tr>
621 <td><code>$GIG_DIM_FOOT</code></td>
622 <td>Constant that identifies the <i>foot pedal dimension</i>.</td>
623 </tr>
624 <tr>
625 <td><code>$GIG_DIM_PORTAMENTOTIME</code></td>
626 <td>Constant that identifies the <i>portamento time controller dimension</i>.</td>
627 </tr>
628 <tr>
629 <td><code>$GIG_DIM_EFFECT1</code></td>
630 <td>Constant that identifies the <i>effect 1 MIDI controller dimension</i>.</td>
631 </tr>
632 <tr>
633 <td><code>$GIG_DIM_EFFECT2</code></td>
634 <td>Constant that identifies the <i>effect 2 MIDI controller dimension</i>.</td>
635 </tr>
636 <tr>
637 <td><code>$GIG_DIM_EFFECT1DEPTH</code></td>
638 <td>Constant that identifies the <i>effect 1 depth MIDI controller dimension</i>.</td>
639 </tr>
640 <tr>
641 <td><code>$GIG_DIM_EFFECT2DEPTH</code></td>
642 <td>Constant that identifies the <i>effect 2 depth MIDI controller dimension</i>.</td>
643 </tr>
644 <tr>
645 <td><code>$GIG_DIM_EFFECT3DEPTH</code></td>
646 <td>Constant that identifies the <i>effect 3 depth MIDI controller dimension</i>.</td>
647 </tr>
648 <tr>
649 <td><code>$GIG_DIM_EFFECT4DEPTH</code></td>
650 <td>Constant that identifies the <i>effect 4 depth MIDI controller dimension</i>.</td>
651 </tr>
652 <tr>
653 <td><code>$GIG_DIM_EFFECT5DEPTH</code></td>
654 <td>Constant that identifies the <i>effect 5 depth MIDI controller dimension</i>.</td>
655 </tr>
656 <tr>
657 <td><code>$GIG_DIM_GENPURPOSE1</code></td>
658 <td>Constant that identifies the <i>general purpose 1 MIDI controller dimension</i>.</td>
659 </tr>
660 <tr>
661 <td><code>$GIG_DIM_GENPURPOSE2</code></td>
662 <td>Constant that identifies the <i>general purpose 2 MIDI controller dimension</i>.</td>
663 </tr>
664 <tr>
665 <td><code>$GIG_DIM_GENPURPOSE3</code></td>
666 <td>Constant that identifies the <i>general purpose 3 MIDI controller dimension</i>.</td>
667 </tr>
668 <tr>
669 <td><code>$GIG_DIM_GENPURPOSE4</code></td>
670 <td>Constant that identifies the <i>general purpose 4 MIDI controller dimension</i>.</td>
671 </tr>
672 <tr>
673 <td><code>$GIG_DIM_GENPURPOSE5</code></td>
674 <td>Constant that identifies the <i>general purpose 5 MIDI controller dimension</i>.</td>
675 </tr>
676 <tr>
677 <td><code>$GIG_DIM_GENPURPOSE6</code></td>
678 <td>Constant that identifies the <i>general purpose 6 MIDI controller dimension</i>.</td>
679 </tr>
680 <tr>
681 <td><code>$GIG_DIM_GENPURPOSE7</code></td>
682 <td>Constant that identifies the <i>general purpose 7 MIDI controller dimension</i>.</td>
683 </tr>
684 <tr>
685 <td><code>$GIG_DIM_GENPURPOSE8</code></td>
686 <td>Constant that identifies the <i>general purpose 8 MIDI controller dimension</i>.</td>
687 </tr>
688 </table>
689
690 </body>
691 </html>

  ViewVC Help
Powered by ViewVC