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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3215 - (show annotations) (download) (as text)
Thu May 25 15:08:50 2017 UTC (3 years, 2 months ago) by schoenebeck
File MIME type: text/html
File size: 1855 byte(s)
* NKSP: Added functions change_note() and change_velo().

1 <html>
2 <head>
3 <meta name="author" content="Christian Schoenebeck">
4 <title>change_note() function</title>
5 <meta name="description" content="Change MIDI note number of note.">
6 </head>
7 <body>
8 <h1>change_note()</h1>
9 <p>
10 Changes the MIDI note number of the requested note.
11 </p>
12 <p>
13 Changing the note number with this function only succeeds if the
14 respective note is new. That effectively means you should change the
15 note number before any <code lang="nksp">wait()</code> calls, and before
16 entering any loops that may execute your script for a very long time.
17 Because in both cases the sampler may suspend your script for a certain
18 amount of time and once your script got resumed, the respective event
19 and the resulting note may already have entered the sampler's regular
20 event processing chain and thus the note's note number can no longer be
21 changed.
22 </p>
23
24 <h3>Function Prototype</h3>
25 <p/>
26 <code>
27 change_note(??event-id??, ??note-number??)
28 </code>
29
30 <h3>Arguments</h3>
31 <table>
32 <tr>
33 <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
34 </tr>
35 <tr>
36 <td><code>??event-id??</code></td>
37 <td>Event ID Number</td>
38 <td>Event ID of the note to change.<br>
39 [required]</td>
40 </tr>
41 <tr>
42 <td><code>??note-number??</code></td>
43 <td>Integer Number</td>
44 <td>New MIDI note number (<code>0</code> to <code>127</code>).<br>
45 [required]</td>
46 </tr>
47 </table>
48
49 <h3>Return Value</h3>
50 <p>None.</p>
51
52 <h3>Examples</h3>
53 <p>None yet.</p>
54
55 <h3>See also</h3>
56 <p><code>set_event_par()</code>, <code>change_velo()</code><p>
57
58 <h3>Availability</h3>
59 <p>Since LinuxSampler 2.0.0.svn49.<p>
60
61 </body>
62 </html>

  ViewVC Help
Powered by ViewVC