/[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 3247 - (hide annotations) (download) (as text)
Sun May 28 22:28:23 2017 UTC (6 years, 10 months ago) by schoenebeck
File MIME type: text/html
File size: 27520 byte(s)
* NKSP: Added function change_vol_curve() and change_tune_curve().
* NKSP: Added built-in constants $NKSP_EASE_IN_EASE_OUT and $NKSP_LINEAR.

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 3247 <td><code>change_tune_curve()</code></td>
131     <td>Changes the curve type of tuning changes.</td>
132     </tr>
133     <tr>
134 schoenebeck 2932 <td><code>change_vol()</code></td>
135     <td>Changes the volume of voices.</td>
136     </tr>
137     <tr>
138 schoenebeck 3189 <td><code>change_vol_time()</code></td>
139     <td>Changes the duration of volume changes.</td>
140     </tr>
141     <tr>
142 schoenebeck 3247 <td><code>change_vol_curve()</code></td>
143     <td>Changes the curve type of volume changes.</td>
144     </tr>
145     <tr>
146 schoenebeck 2936 <td><code>change_cutoff()</code></td>
147     <td>Changes filter cutoff frequency of voices.</td>
148     </tr>
149     <tr>
150     <td><code>change_reso()</code></td>
151     <td>Changes filter resonance of voices.</td>
152     </tr>
153     <tr>
154 schoenebeck 2954 <td><code>change_attack()</code></td>
155     <td>Modifies the attack time of voices.</td>
156     </tr>
157     <tr>
158     <td><code>change_decay()</code></td>
159     <td>Modifies the decay time of voices.</td>
160     </tr>
161     <tr>
162     <td><code>change_release()</code></td>
163     <td>Modifies the release time of voices.</td>
164     </tr>
165     <tr>
166 schoenebeck 3121 <td><code>change_amp_lfo_depth()</code></td>
167     <td>Modifies the amplitude LFO depth.</td>
168     </tr>
169     <tr>
170     <td><code>change_amp_lfo_freq()</code></td>
171     <td>Modifies the amplitude LFO frequency.</td>
172     </tr>
173     <tr>
174     <td><code>change_pitch_lfo_depth()</code></td>
175     <td>Modifies the pitch LFO depth.</td>
176     </tr>
177     <tr>
178     <td><code>change_pitch_lfo_freq()</code></td>
179     <td>Modifies the pitch LFO frequency.</td>
180     </tr>
181     <tr>
182 schoenebeck 3215 <td><code>change_velo()</code></td>
183     <td>Change MIDI velocity of note.</td>
184     </tr>
185     <tr>
186 schoenebeck 2936 <td><code>event_status()</code></td>
187     <td>Checks and returns whether a particular note is still alive.</td>
188     </tr>
189     <tr>
190 schoenebeck 3189 <td><code>fade_in()</code></td>
191     <td>Fade the requested note in.</td>
192     </tr>
193     <tr>
194     <td><code>fade_out()</code></td>
195     <td>Fade the requested note out.</td>
196     </tr>
197     <tr>
198 schoenebeck 3194 <td><code>get_event_par()</code></td>
199     <td>Get the current value of a specific note parameter.</td>
200     </tr>
201     <tr>
202     <td><code>set_event_par()</code></td>
203     <td>Change the value of a specific note parameter.</td>
204     </tr>
205     <tr>
206 schoenebeck 2732 <td><code>set_controller()</code></td>
207     <td>Creates a MIDI control change event.</td>
208     </tr>
209     <tr>
210     <td><code>ignore_event()</code></td>
211     <td>Drops the given event.</td>
212     </tr>
213     <tr>
214     <td><code>ignore_controller()</code></td>
215     <td>Drops the given MIDI control change event.</td>
216     </tr>
217     <tr>
218     <td><code>note_off()</code></td>
219     <td>Releases the requested note.</td>
220     </tr>
221     <tr>
222     <td><code>set_event_mark()</code></td>
223     <td>Adds an event to an event group.</td>
224     </tr>
225     <tr>
226     <td><code>delete_event_mark()</code></td>
227     <td>Removes an event from some event group.</td>
228     </tr>
229     <tr>
230     <td><code>by_marks()</code></td>
231     <td>Returns all events of an event group.</td>
232     </tr>
233     </table>
234    
235     <h3>GigaStudio Format Functions</h3>
236     <p>
237     Sampler format specific functions, dedicated to the individual features
238     of the GigaStudio format engine.
239     </p>
240     <table>
241     <tr>
242     <th>Function</th> <th>Description</th>
243     </tr>
244     <tr>
245     <td><code>gig_set_dim_zone()</code></td>
246     <td>Changes the currently active dimension zone.</td>
247     </tr>
248 schoenebeck 3229 <tr>
249     <td><code>same_region()</code></td>
250     <td>Check whether two keys are mapped to the same region.</td>
251     </tr>
252 schoenebeck 2732 </table>
253    
254     <h2>Built-In Variables</h2>
255     <p>
256     These are the built-in variables and built-in constants available with the
257     NKSP realt-time instrument script language.
258     </p>
259 schoenebeck 2944
260     <h3>Core Language Variables</h3>
261     <p>
262     Most fundamental NKSP built-in variables, independent from any purpose of
263     being used in a sampler.
264     </p>
265     <table>
266     <tr>
267     <th>Variable</th> <th>Description</th>
268     </tr>
269     <tr>
270     <td><code>$KSP_TIMER</code></td>
271     <td>Preserved for compatiblity reasons with KSP, returns the same value
272     as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).
273     Note that KSP's <code>reset_ksp_timer()</code> function is not available with
274     NKSP. However when calculating time differences between two time
275     stamps taken with <code>$NKSP_REAL_TIMER</code>, calling such a reset
276     function is not required, because the underlying clock does not stop
277     when it reached its value limit (which happens every 71 minutes), instead the clock
278     will automatically restart from zero and the calculated time difference
279     even between such transitions will reflect correct durations.</td>
280     </tr>
281     <tr>
282     <td><code>$NKSP_PERF_TIMER</code></td>
283     <td>Returns the current performance time stamp (in microseconds) of the
284     script running. You may read this variable from time to time to take
285     time stamps which can be used to calculate the time difference
286     (in microseconds) which elapsed between them. A performance time
287     stamp is based on the script's actual CPU execution time. So the
288     internal clock which is used for generating such time stamps is only
289     running forward if the respective script is actually executed by the
290     CPU. Whenever your script is not really executed by the CPU (i.e. because
291     your script got suspended by a wait() call or got forcely suspended due to
292     real-time constraints, or when the entire sampler application got suspended
293     by the OS for other applications or OS tasks) then the underlying internal
294     clock is paused as well.
295     <note class="important">
296     You should only use this built-in variable for script development
297     purposes (i.e. for bench marking the performance of your script).
298     You should <b>not</b> use it with your final production sounds!
299     It is not appropriate for being used in a musical context, because
300     when an offline bounce is performed for instance, the musical timing
301     will be completely unrelated to the CPU execution time. Plus using
302     this variable may cause audio drop outs on some systems. In a musical
303     context you should use <code>$ENGINE_UPTIME</code> instead, which is
304     also safe for offline bounces.
305     </note>
306     <note>
307     On some systems <code>$NKSP_REAL_TIMER</code> and
308     <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
309     difference between them is not implemented for all systems at the moment.
310     </note>
311     </td>
312     </tr>
313     <tr>
314     <td><code>$NKSP_REAL_TIMER</code></td>
315     <td>Returns the current time stamp in reality (in microseconds). You may
316     read this variable from time to time to take
317     time stamps which can be used to calculate the time difference
318     (in microseconds) which elapsed between them. A "real" time
319     stamp is based on an internal clock which constantly proceeds, so this
320     internal clock also continues counting while your script is either suspended
321     (i.e. because your script got suspended by a wait() call or got forcely
322     suspended due to real-time constraints) and it also continues counting
323     even if the entire sampler application got suspended by the OS (i.e. to
324     execute other applications for multi-tasking or to perform OS tasks).
325     <note class="important">
326     You should only use this built-in variable for script development
327     purposes (i.e. for bench marking the performance of your script).
328     You should <b>not</b> use it with your final production sounds!
329     It is not appropriate for being used in a musical context, because
330     when an offline bounce is performed for instance, the musical timing
331     will be completely unrelated to the CPU execution time. Plus using
332     this variable may cause audio drop outs on some systems. In a musical
333     context you should use <code>$ENGINE_UPTIME</code> instead, which is
334     also safe for offline bounces.
335     </note>
336     <note>
337     On some systems <code>$NKSP_REAL_TIMER</code> and
338     <code>$NKSP_PERF_TIMER</code> will actually return the same value. So the
339     difference between them is not implemented for all systems at the moment.
340     </note>
341     </td>
342     </tr>
343 schoenebeck 2949 <tr>
344 schoenebeck 3247 <td><code>$NKSP_EASE_IN_EASE_OUT</code></td>
345     <td>Used to select a fade curve with "ease in and ease out" shape.</td>
346     </tr>
347     <tr>
348     <td><code>$NKSP_LINEAR</code></td>
349     <td>Used to select a fade curve with linear shape.</td>
350     </tr>
351     <tr>
352 schoenebeck 2949 <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 schoenebeck 2944 </table>
391    
392 schoenebeck 2732 <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 schoenebeck 3074 <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 schoenebeck 3077 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 schoenebeck 3079 (i.e. notes which were launched programmatically by calling <code>play_note()</code>).
409 schoenebeck 3074 <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 schoenebeck 3075 <code>$ALL_EVENTS</code>. Using the latter with NKSP will cause a
413 schoenebeck 3074 parser warning, the behavior will be the same though.
414     </note>
415     </td>
416     </tr>
417     <tr>
418 schoenebeck 2732 <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 schoenebeck 2937 <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 schoenebeck 3194 <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 schoenebeck 2732 <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 schoenebeck 2936 as index to this array variable (see also <code>event_status()</code>).</td>
498 schoenebeck 2732 </tr>
499     <tr>
500     <td><code>$VCC_MONO_AT</code></td>
501     <td>Constant identifying the MIDI monophonic aftertouch controller (also
502     called <i title="Amount of force on held-down key.">
503     MIDI channel pressure
504     </i>). This is somewhat different than in the MIDI standard. With
505     NKSP aftertouch is handled like an additional "regular" MIDI CC controller.
506     Therefore use
507     <code>%CC[$VCC_MONO_AT]</code> to obtain the current aftertouch value
508     in the context of a <code>controller</code> event handler.
509     </td>
510     </tr>
511     <tr>
512     <td><code>$VCC_PITCH_BEND</code></td>
513     <td>Constant identifying the pitch bend wheel controller.
514     This is somewhat different than in the MIDI standard. With
515     NKSP pitch bend is handled like an additional "regular" MIDI CC controller.
516     Therefore use
517 schoenebeck 2936 <code>%CC[$VCC_PITCH_BEND]</code> to obtain the current pitch bend wheel value
518 schoenebeck 2732 in the context of a <code>controller</code> event handler.</td>
519     </tr>
520     <tr>
521     <td><code>$MARK_1</code> to <code>$MARK_28</code></td>
522     <td>Used to select one of the available 28 event groups.
523     See <code>set_event_mark()</code> for details.</td>
524     </tr>
525 schoenebeck 2944 <tr>
526     <td><code>$ENGINE_UPTIME</code></td>
527     <td>Returns the current time stamp (in milliseconds) for being
528     used in a musical context. You may read this variable from time to time
529     to take time stamps which can be used to calculate the time difference
530     (in milliseconds) which elapsed between them. These timing values are
531     based on the internal sample rate and thus it can safely be used to
532     perform musical timing related tasks in your scripts. Especially
533     your script will also continue to behave correctly when an offline bounce
534     of a song is performed.
535     </td>
536     </tr>
537 schoenebeck 2732 </table>
538    
539     <h3>GigaStudio Format Variables</h3>
540     <p>
541     Sampler format specific built-in variables and constants, dedicated to the
542     individual features of the GigaStudio format engine.
543     </p>
544     <table>
545     <tr>
546     <th>Variable</th> <th>Description</th>
547     </tr>
548     <tr>
549     <td><code>$GIG_DIM_CHANNEL</code></td>
550     <td>Constant that identifies the <i>stereo dimension</i>.</td>
551     </tr>
552     <tr>
553     <td><code>$GIG_DIM_LAYER</code></td>
554     <td>Constant that identifies the <i>layer dimension</i>.</td>
555     </tr>
556     <tr>
557     <td><code>$GIG_DIM_VELOCITY</code></td>
558     <td>Constant that identifies the <i>velocity dimension</i>.</td>
559     </tr>
560     <tr>
561     <td><code>$GIG_DIM_AFTERTOUCH</code></td>
562     <td>Constant that identifies the <i>aftertouch dimension</i>.</td>
563     </tr>
564     <tr>
565     <td><code>$GIG_DIM_RELEASE</code></td>
566     <td>Constant that identifies the <i>release trigger dimension</i>.</td>
567     </tr>
568     <tr>
569     <td><code>$GIG_DIM_KEYBOARD</code></td>
570     <td>Constant that identifies the <i>keyboard position dimension</i>.</td>
571     </tr>
572     <tr>
573 schoenebeck 3229 <td><code>$GIG_DIM_ROUNDROBIN</code></td>
574 schoenebeck 2732 <td>Constant that identifies the <i>round robin dimension</i>.</td>
575     </tr>
576     <tr>
577     <td><code>$GIG_DIM_RANDOM</code></td>
578     <td>Constant that identifies the <i>random dimension</i>.</td>
579     </tr>
580     <tr>
581     <td><code>$GIG_DIM_SMARTMIDI</code></td>
582     <td>Constant that identifies the <i>start MIDI dimension</i> (a.k.a iMIDI rules).</td>
583     </tr>
584     <tr>
585     <td><code>$GIG_DIM_ROUNDROBINKEY</code></td>
586     <td>Constant that identifies the <i>round robin key dimension</i>.</td>
587     </tr>
588     <tr>
589     <td><code>$GIG_DIM_MODWHEEL</code></td>
590     <td>Constant that identifies the <i>modulation wheel dimension</i>.</td>
591     </tr>
592     <tr>
593     <td><code>$GIG_DIM_SUSTAIN</code></td>
594     <td>Constant that identifies the <i>sustain pedal dimension</i> (a.k.a. hold pedal).</td>
595     </tr>
596     <tr>
597     <td><code>$GIG_DIM_PORTAMENTO</code></td>
598     <td>Constant that identifies the <i>portamento MIDI controller dimension</i>.</td>
599     </tr>
600     <tr>
601     <td><code>$GIG_DIM_SOSTENUTO</code></td>
602     <td>Constant that identifies the <i>sostenuto MIDI controller dimension</i>.</td>
603     </tr>
604     <tr>
605     <td><code>$GIG_DIM_SOFT</code></td>
606     <td>Constant that identifies the <i>soft pedal dimension</i>.</td>
607     </tr>
608     <tr>
609     <td><code>$GIG_DIM_BREATH</code></td>
610     <td>Constant that identifies the <i>breath controller dimension</i>.</td>
611     </tr>
612     <tr>
613     <td><code>$GIG_DIM_FOOT</code></td>
614     <td>Constant that identifies the <i>foot pedal dimension</i>.</td>
615     </tr>
616     <tr>
617     <td><code>$GIG_DIM_PORTAMENTOTIME</code></td>
618     <td>Constant that identifies the <i>portamento time controller dimension</i>.</td>
619     </tr>
620     <tr>
621     <td><code>$GIG_DIM_EFFECT1</code></td>
622     <td>Constant that identifies the <i>effect 1 MIDI controller dimension</i>.</td>
623     </tr>
624     <tr>
625     <td><code>$GIG_DIM_EFFECT2</code></td>
626     <td>Constant that identifies the <i>effect 2 MIDI controller dimension</i>.</td>
627     </tr>
628     <tr>
629     <td><code>$GIG_DIM_EFFECT1DEPTH</code></td>
630     <td>Constant that identifies the <i>effect 1 depth MIDI controller dimension</i>.</td>
631     </tr>
632     <tr>
633     <td><code>$GIG_DIM_EFFECT2DEPTH</code></td>
634     <td>Constant that identifies the <i>effect 2 depth MIDI controller dimension</i>.</td>
635     </tr>
636     <tr>
637     <td><code>$GIG_DIM_EFFECT3DEPTH</code></td>
638     <td>Constant that identifies the <i>effect 3 depth MIDI controller dimension</i>.</td>
639     </tr>
640     <tr>
641     <td><code>$GIG_DIM_EFFECT4DEPTH</code></td>
642     <td>Constant that identifies the <i>effect 4 depth MIDI controller dimension</i>.</td>
643     </tr>
644     <tr>
645     <td><code>$GIG_DIM_EFFECT5DEPTH</code></td>
646     <td>Constant that identifies the <i>effect 5 depth MIDI controller dimension</i>.</td>
647     </tr>
648     <tr>
649     <td><code>$GIG_DIM_GENPURPOSE1</code></td>
650     <td>Constant that identifies the <i>general purpose 1 MIDI controller dimension</i>.</td>
651     </tr>
652     <tr>
653     <td><code>$GIG_DIM_GENPURPOSE2</code></td>
654     <td>Constant that identifies the <i>general purpose 2 MIDI controller dimension</i>.</td>
655     </tr>
656     <tr>
657     <td><code>$GIG_DIM_GENPURPOSE3</code></td>
658     <td>Constant that identifies the <i>general purpose 3 MIDI controller dimension</i>.</td>
659     </tr>
660     <tr>
661     <td><code>$GIG_DIM_GENPURPOSE4</code></td>
662     <td>Constant that identifies the <i>general purpose 4 MIDI controller dimension</i>.</td>
663     </tr>
664     <tr>
665     <td><code>$GIG_DIM_GENPURPOSE5</code></td>
666     <td>Constant that identifies the <i>general purpose 5 MIDI controller dimension</i>.</td>
667     </tr>
668     <tr>
669     <td><code>$GIG_DIM_GENPURPOSE6</code></td>
670     <td>Constant that identifies the <i>general purpose 6 MIDI controller dimension</i>.</td>
671     </tr>
672     <tr>
673     <td><code>$GIG_DIM_GENPURPOSE7</code></td>
674     <td>Constant that identifies the <i>general purpose 7 MIDI controller dimension</i>.</td>
675     </tr>
676     <tr>
677     <td><code>$GIG_DIM_GENPURPOSE8</code></td>
678     <td>Constant that identifies the <i>general purpose 8 MIDI controller dimension</i>.</td>
679     </tr>
680     </table>
681    
682     </body>
683     </html>

  ViewVC Help
Powered by ViewVC