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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 3223 by schoenebeck, Fri May 26 19:14:44 2017 UTC revision 3297 by schoenebeck, Wed Jun 28 10:48:30 2017 UTC
# Line 15  Line 15 
15    
16      <h2>Built-In Functions</h2>      <h2>Built-In Functions</h2>
17      <p>      <p>
18        These are the built-in functions available with the NKSP realt-time        These are the built-in functions available with the NKSP real-time
19        instrument script language.        instrument script language.
20      </p>      </p>
21    
# Line 28  Line 28 
28          <th>Function</th> <th>Description</th>          <th>Function</th> <th>Description</th>
29        </tr>        </tr>
30        <tr>        <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>          <td><code lang="nksp">array_equal()</code></td>
36          <td>Check whether two arrays are equal.</td>          <td>Check whether two arrays are equal.</td>
37        </tr>        </tr>
38        <tr>        <tr>
39            <td><code>fork()</code></td>
40            <td>Creates new execution instances (threads).</td>
41          </tr>
42          <tr>
43            <td><code>callback_status()</code></td>
44            <td>Returns the current status of a callback (thread).</td>
45          </tr>
46          <tr>
47          <td><code lang="nksp">dec()</code></td>          <td><code lang="nksp">dec()</code></td>
48          <td>Decrements the passed integer variable by one.</td>          <td>Decrements the passed integer variable by one.</td>
49        </tr>        </tr>
# Line 119  Line 131 
131          <td>Changes panning of voices (stereo balance).</td>          <td>Changes panning of voices (stereo balance).</td>
132        </tr>        </tr>
133        <tr>        <tr>
134            <td><code>change_play_pos()</code></td>
135            <td>Change the sample playback position.</td>
136          </tr>
137          <tr>
138          <td><code>change_tune()</code></td>          <td><code>change_tune()</code></td>
139          <td>Changes the tuning of voices.</td>          <td>Changes the tuning of voices.</td>
140        </tr>        </tr>
# Line 127  Line 143 
143          <td>Changes the duration of tuning changes.</td>          <td>Changes the duration of tuning changes.</td>
144        </tr>        </tr>
145        <tr>        <tr>
146            <td><code>change_tune_curve()</code></td>
147            <td>Changes the curve type of tuning changes.</td>
148          </tr>
149          <tr>
150          <td><code>change_vol()</code></td>          <td><code>change_vol()</code></td>
151          <td>Changes the volume of voices.</td>          <td>Changes the volume of voices.</td>
152        </tr>        </tr>
# Line 135  Line 155 
155          <td>Changes the duration of volume changes.</td>          <td>Changes the duration of volume changes.</td>
156        </tr>        </tr>
157        <tr>        <tr>
158            <td><code>change_vol_curve()</code></td>
159            <td>Changes the curve type of volume changes.</td>
160          </tr>
161          <tr>
162          <td><code>change_cutoff()</code></td>          <td><code>change_cutoff()</code></td>
163          <td>Changes filter cutoff frequency of voices.</td>          <td>Changes filter cutoff frequency of voices.</td>
164        </tr>        </tr>
# Line 237  Line 261 
261          <td><code>gig_set_dim_zone()</code></td>          <td><code>gig_set_dim_zone()</code></td>
262          <td>Changes the currently active dimension zone.</td>          <td>Changes the currently active dimension zone.</td>
263        </tr>        </tr>
264          <tr>
265            <td><code>same_region()</code></td>
266            <td>Check whether two keys are mapped to the same region.</td>
267          </tr>
268      </table>      </table>
269    
270      <h2>Built-In Variables</h2>      <h2>Built-In Variables</h2>
# Line 255  Line 283 
283          <th>Variable</th> <th>Description</th>          <th>Variable</th> <th>Description</th>
284        </tr>        </tr>
285        <tr>        <tr>
286            <td><code>$CALLBACK_STATUS_QUEUE</code></td>
287            <td>Built-in constant reflecting the status of a callback to be
288                alive but suspended. See <code>callback_status()</code> for details.</td>
289          </tr>
290          <tr>
291            <td><code>$CALLBACK_STATUS_RUNNING</code></td>
292            <td>Built-in constant reflecting the status of a callback to be
293                alive and currently executing. See <code>callback_status()</code>
294                for details.</td>
295          </tr>
296          <tr>
297            <td><code>$CALLBACK_STATUS_TERMINATED</code></td>
298            <td>Built-in constant reflecting the status of a callback to be
299                not alive. See <code>callback_status()</code> for details.</td>
300          </tr>
301          <tr>
302          <td><code>$KSP_TIMER</code></td>          <td><code>$KSP_TIMER</code></td>
303          <td>Preserved for compatiblity reasons with KSP, returns the same value          <td>Preserved for compatiblity reasons with KSP, returns the same value
304             as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).             as <code>$NKSP_REAL_TIMER</code> (refer to the latter for details).
# Line 299  Line 343 
343          </td>          </td>
344        </tr>        </tr>
345        <tr>        <tr>
346            <td><code>%NKSP_CALLBACK_CHILD_ID[]</code></td>
347            <td>
348              Reflects the callback IDs of all child threads which the current
349              script callback instance spawned by having called <code>fork()</code> before.
350              See the latter function for details about this array variable.
351            </td>
352          </tr>
353          <tr>
354            <td><code>$NKSP_CALLBACK_PARENT_ID</code></td>
355            <td>
356              If the current execution thread is a child thread spawned by a <code>fork()</code>
357              call before, then this variable reflects the callback ID of the parent
358              thread which created this child thread. Otherwise this variable is <code>0</code>.
359              See <code>fork()</code> for more details about this variable.
360            </td>
361          </tr>
362          <tr>
363          <td><code>$NKSP_REAL_TIMER</code></td>          <td><code>$NKSP_REAL_TIMER</code></td>
364          <td>Returns the current time stamp in reality (in microseconds). You may          <td>Returns the current time stamp in reality (in microseconds). You may
365              read this variable from time to time to take              read this variable from time to time to take
# Line 477  Line 538 
538              as index to this array variable (see also <code>event_status()</code>).</td>              as index to this array variable (see also <code>event_status()</code>).</td>
539        </tr>        </tr>
540        <tr>        <tr>
541            <td><code>$NKSP_EASE_IN_EASE_OUT</code></td>
542            <td>Used to select a fade curve with "ease in and ease out" shape.</td>
543          </tr>
544          <tr>
545            <td><code>$NKSP_LINEAR</code></td>
546            <td>Used to select a fade curve with linear shape.</td>
547          </tr>
548          <tr>
549          <td><code>$VCC_MONO_AT</code></td>          <td><code>$VCC_MONO_AT</code></td>
550          <td>Constant identifying the MIDI monophonic aftertouch controller (also          <td>Constant identifying the MIDI monophonic aftertouch controller (also
551              called <i title="Amount of force on held-down key.">              called <i title="Amount of force on held-down key.">
# Line 550  Line 619 
619          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>
620        </tr>        </tr>
621        <tr>        <tr>
622          <td><code>$GIG_DIM_ROUNDROBIN"</code></td>          <td><code>$GIG_DIM_ROUNDROBIN</code></td>
623          <td>Constant that identifies the <i>round robin dimension</i>.</td>          <td>Constant that identifies the <i>round robin dimension</i>.</td>
624        </tr>        </tr>
625        <tr>        <tr>
Legend:
Removed from v.3223  
changed lines
  Added in v.3297
  ViewVC Help
Powered by ViewVC