/[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 3121 by schoenebeck, Fri Apr 21 19:45:29 2017 UTC revision 3294 by schoenebeck, Tue Jun 27 23:29:31 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>
36            <td>Check whether two arrays are equal.</td>
37          </tr>
38          <tr>
39            <td><code>fork()</code></td>
40            <td>Creates new execution instances.</td>
41          </tr>
42          <tr>
43          <td><code lang="nksp">dec()</code></td>          <td><code lang="nksp">dec()</code></td>
44          <td>Decrements the passed integer variable by one.</td>          <td>Decrements the passed integer variable by one.</td>
45        </tr>        </tr>
# Line 44  Line 56 
56          <td>Prints text to the sampler's terminal.</td>          <td>Prints text to the sampler's terminal.</td>
57        </tr>        </tr>
58        <tr>        <tr>
59            <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          <td><code>exit()</code></td>          <td><code>exit()</code></td>
68          <td>Stops execution of the current event handler instance.</td>          <td>Stops execution of the current event handler instance.</td>
69        </tr>        </tr>
# Line 99  Line 119 
119          <td>Triggers a new note.</td>          <td>Triggers a new note.</td>
120        </tr>        </tr>
121        <tr>        <tr>
122            <td><code>change_note()</code></td>
123            <td>Change MIDI note number of note.</td>
124          </tr>
125          <tr>
126          <td><code>change_pan()</code></td>          <td><code>change_pan()</code></td>
127          <td>Changes panning of voices (stereo balance).</td>          <td>Changes panning of voices (stereo balance).</td>
128        </tr>        </tr>
129        <tr>        <tr>
130            <td><code>change_play_pos()</code></td>
131            <td>Change the sample playback position.</td>
132          </tr>
133          <tr>
134          <td><code>change_tune()</code></td>          <td><code>change_tune()</code></td>
135          <td>Changes the tuning of voices.</td>          <td>Changes the tuning of voices.</td>
136        </tr>        </tr>
137        <tr>        <tr>
138            <td><code>change_tune_time()</code></td>
139            <td>Changes the duration of tuning changes.</td>
140          </tr>
141          <tr>
142            <td><code>change_tune_curve()</code></td>
143            <td>Changes the curve type of tuning changes.</td>
144          </tr>
145          <tr>
146          <td><code>change_vol()</code></td>          <td><code>change_vol()</code></td>
147          <td>Changes the volume of voices.</td>          <td>Changes the volume of voices.</td>
148        </tr>        </tr>
149        <tr>        <tr>
150            <td><code>change_vol_time()</code></td>
151            <td>Changes the duration of volume changes.</td>
152          </tr>
153          <tr>
154            <td><code>change_vol_curve()</code></td>
155            <td>Changes the curve type of volume changes.</td>
156          </tr>
157          <tr>
158          <td><code>change_cutoff()</code></td>          <td><code>change_cutoff()</code></td>
159          <td>Changes filter cutoff frequency of voices.</td>          <td>Changes filter cutoff frequency of voices.</td>
160        </tr>        </tr>
# Line 147  Line 191 
191          <td>Modifies the pitch LFO frequency.</td>          <td>Modifies the pitch LFO frequency.</td>
192        </tr>        </tr>
193        <tr>        <tr>
194            <td><code>change_velo()</code></td>
195            <td>Change MIDI velocity of note.</td>
196          </tr>
197          <tr>
198          <td><code>event_status()</code></td>          <td><code>event_status()</code></td>
199          <td>Checks and returns whether a particular note is still alive.</td>          <td>Checks and returns whether a particular note is still alive.</td>
200        </tr>        </tr>
201        <tr>        <tr>
202            <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            <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          <td><code>set_controller()</code></td>          <td><code>set_controller()</code></td>
219          <td>Creates a MIDI control change event.</td>          <td>Creates a MIDI control change event.</td>
220        </tr>        </tr>
# Line 193  Line 257 
257          <td><code>gig_set_dim_zone()</code></td>          <td><code>gig_set_dim_zone()</code></td>
258          <td>Changes the currently active dimension zone.</td>          <td>Changes the currently active dimension zone.</td>
259        </tr>        </tr>
260          <tr>
261            <td><code>same_region()</code></td>
262            <td>Check whether two keys are mapped to the same region.</td>
263          </tr>
264      </table>      </table>
265    
266      <h2>Built-In Variables</h2>      <h2>Built-In Variables</h2>
# Line 255  Line 323 
323          </td>          </td>
324        </tr>        </tr>
325        <tr>        <tr>
326            <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          <td><code>$NKSP_REAL_TIMER</code></td>          <td><code>$NKSP_REAL_TIMER</code></td>
344          <td>Returns the current time stamp in reality (in microseconds). You may          <td>Returns the current time stamp in reality (in microseconds). You may
345              read this variable from time to time to take              read this variable from time to time to take
# Line 396  Line 481 
481              note is still "alive".</td>              note is still "alive".</td>
482        </tr>        </tr>
483        <tr>        <tr>
484            <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          <td><code>%KEY_DOWN[]</code></td>          <td><code>%KEY_DOWN[]</code></td>
516          <td>This can be used in any context to check whether a certain MIDI          <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              key is currently pressed down. Use the respective MIDI note number
518              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>
519        </tr>        </tr>
520        <tr>        <tr>
521            <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          <td><code>$VCC_MONO_AT</code></td>          <td><code>$VCC_MONO_AT</code></td>
530          <td>Constant identifying the MIDI monophonic aftertouch controller (also          <td>Constant identifying the MIDI monophonic aftertouch controller (also
531              called <i title="Amount of force on held-down key.">              called <i title="Amount of force on held-down key.">
# Line 475  Line 599 
599          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>          <td>Constant that identifies the <i>keyboard position dimension</i>.</td>
600        </tr>        </tr>
601        <tr>        <tr>
602          <td><code>$GIG_DIM_ROUNDROBIN"</code></td>          <td><code>$GIG_DIM_ROUNDROBIN</code></td>
603          <td>Constant that identifies the <i>round robin dimension</i>.</td>          <td>Constant that identifies the <i>round robin dimension</i>.</td>
604        </tr>        </tr>
605        <tr>        <tr>
Legend:
Removed from v.3121  
changed lines
  Added in v.3294
  ViewVC Help
Powered by ViewVC