/[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 3229 - (hide annotations) (download) (as text)
Sun May 28 15:22:55 2017 UTC (5 years, 2 months ago) by schoenebeck
File MIME type: text/html
File size: 26971 byte(s)
* NKSP: Added built-in function same_region().

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

  ViewVC Help
Powered by ViewVC