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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3294 - (hide annotations) (download) (as text)
Tue Jun 27 23:29:31 2017 UTC (6 years, 9 months ago) by schoenebeck
File MIME type: text/html
File size: 28663 byte(s)
* NKSP: Added function fork().
* NKSP: Added built-in array variable %NKSP_CALLBACK_CHILD_ID[].
* NKSP: Added built-in variable $NKSP_CALLBACK_PARENT_ID.

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

  ViewVC Help
Powered by ViewVC