/[svn]/doc/docbase/instrument_scripts/nksp/reference/functions/nksp_gig_set_dim_zone_function.html
ViewVC logotype

Contents of /doc/docbase/instrument_scripts/nksp/reference/functions/nksp_gig_set_dim_zone_function.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2732 - (show annotations) (download) (as text)
Sun Apr 26 20:54:00 2015 UTC (8 years, 11 months ago) by schoenebeck
File MIME type: text/html
File size: 3730 byte(s)
* Initial import of doc.linuxsampler.org.

1 <html>
2 <head>
3 <meta name="author" content="Christian Schoenebeck">
4 <title>gig_set_dim_zone() function</title>
5 <meta name="description" content="Changes the currently active dimension zone.">
6 </head>
7 <body>
8 <h1>gig_set_dim_zone()</h1>
9 <p>
10 Overrides and selects another active zone of a particular GigaStudio dimension.
11 Usually each dimension is assigned to some MIDI controller, or to
12 note-on velocity or other sources, and by changing the respective MIDI
13 controller or velocity or the respective source, the respective dimension
14 zone is selected accordingly. With this function you have an alternative
15 to change the currently active dimension zone(s) programmatically at any time.
16 </p>
17
18 <h3>Function Prototype</h3>
19 <p/>
20 <code>
21 gig_set_dim_zone(??events??, ??dimension??, ??zone??)
22 </code>
23
24 <h3>Arguments</h3>
25 <table>
26 <tr>
27 <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
28 </tr>
29 <tr>
30 <td><code>??events??</code></td>
31 <td>Event Group ID Number or Event Group ID Array</td>
32 <td>Note on event ID(s) of the note(s) where the current dimension zone
33 shall be changed.<br>
34 [required]</td>
35 </tr>
36 <tr>
37 <td><code>??dimension??</code></td>
38 <td>Dimension ID Number</td>
39 <td>The dimension that shall be changed. You should pass one of the
40 built-in constants (listed below) to select one of the available
41 dimension types.<br>
42 [required]</td>
43 </tr>
44 <tr>
45 <td><code>??zone??</code></td>
46 <td>Integer Number</td>
47 <td>The zone index of the dimension that shall become active.<br>
48 [required]</td>
49 </tr>
50 </table>
51
52 <h3>Return Value</h3>
53 <p>None.</p>
54
55 <h3>Dimension Constants</h3>
56 <p>
57 You should use one of the following built-in constants for the
58 <code>??dimension??</code> argument:
59 <ul>
60 <li><code>$GIG_DIM_CHANNEL</code></li>
61 <li><code>$GIG_DIM_LAYER</code></li>
62 <li><code>$GIG_DIM_VELOCITY</code></li>
63 <li><code>$GIG_DIM_AFTERTOUCH</code></li>
64 <li><code>$GIG_DIM_RELEASE</code></li>
65 <li><code>$GIG_DIM_KEYBOARD</code></li>
66 <li><code>$GIG_DIM_ROUNDROBIN</code></li>
67 <li><code>$GIG_DIM_RANDOM</code></li>
68 <li><code>$GIG_DIM_SMARTMIDI</code></li>
69 <li><code>$GIG_DIM_ROUNDROBINKEY</code></li>
70 <li><code>$GIG_DIM_MODWHEEL</code></li>
71 <li><code>$GIG_DIM_BREATH</code></li>
72 <li><code>$GIG_DIM_FOOT</code></li>
73 <li><code>$GIG_DIM_PORTAMENTOTIME</code></li>
74 <li><code>$GIG_DIM_EFFECT1</code></li>
75 <li><code>$GIG_DIM_EFFECT2</code></li>
76 <li><code>$GIG_DIM_GENPURPOSE1</code></li>
77 <li><code>$GIG_DIM_GENPURPOSE2</code></li>
78 <li><code>$GIG_DIM_GENPURPOSE3</code></li>
79 <li><code>$GIG_DIM_GENPURPOSE4</code></li>
80 <li><code>$GIG_DIM_SUSTAIN</code></li>
81 <li><code>$GIG_DIM_PORTAMENTO</code></li>
82 <li><code>$GIG_DIM_SOSTENUTO</code></li>
83 <li><code>$GIG_DIM_SOFT</code></li>
84 <li><code>$GIG_DIM_GENPURPOSE5</code></li>
85 <li><code>$GIG_DIM_GENPURPOSE6</code></li>
86 <li><code>$GIG_DIM_GENPURPOSE7</code></li>
87 <li><code>$GIG_DIM_GENPURPOSE8</code></li>
88 <li><code>$GIG_DIM_EFFECT1DEPTH</code></li>
89 <li><code>$GIG_DIM_EFFECT2DEPTH</code></li>
90 <li><code>$GIG_DIM_EFFECT3DEPTH</code></li>
91 <li><code>$GIG_DIM_EFFECT4DEPTH</code></li>
92 <li><code>$GIG_DIM_EFFECT5DEPTH</code></li>
93 </ul>
94 </p>
95
96 <h3>Examples</h3>
97 <p>None yet.</p>
98
99 </body>
100 </html>

  ViewVC Help
Powered by ViewVC