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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2940 - (show annotations) (download) (as text)
Tue Jul 12 09:50:03 2016 UTC (3 years, 3 months ago) by schoenebeck
File MIME type: text/html
File size: 1923 byte(s)
* NKSP: Corrections to play_note() and note_off() descriptions.

1 <html>
2 <head>
3 <meta name="author" content="Christian Schoenebeck">
4 <title>note_off() function</title>
5 <meta name="description" content="Releases the requested note.">
6 </head>
7 <body>
8 <h1>note_off()</h1>
9 <p>
10 Releases a note by passing the note's event ID to this function.
11 This is almost like sending a MIDI note off event programmatically, however
12 a call to this function will only release one single note instead,
13 a call to this function does not cause a <code>release</code>
14 event handler to be executed, nor will any MIDI specific note-off handling
15 be done (i.e. it will have no effect on the status of built-in array variable
16 <code>%KEY_DOWN[]</code>).
17 </p>
18
19 <h3>Function Prototype</h3>
20 <p/>
21 <code>
22 note_off(??event-id??, [??velocity??])
23 </code>
24
25 <h3>Arguments</h3>
26 <table>
27 <tr>
28 <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
29 </tr>
30 <tr>
31 <td><code>??event-id??</code></td>
32 <td>Event ID Number or Event ID Array</td>
33 <td>Note ID(s) of the note(s) to be released.<br>
34 [required]</td>
35 </tr>
36 <tr>
37 <td><code>??velocity??</code></td>
38 <td>Integer Number</td>
39 <td>MIDI note off velocity value.<br>
40 [optional, default: 127]</td>
41 </tr>
42 </table>
43
44 <h3>Return Value</h3>
45 <p>None.</p>
46
47 <h3>Examples</h3>
48 <p>None yet.<p>
49
50 <note>
51 Passing an array of event IDs is only supported by NKSP. If you want
52 to keep compatibility to KSP, then you should only pass a single
53 event ID to this function.
54 </note>
55
56 <note>
57 The second argument of this function <code>??velocity??</code> is only
58 supported by NKSP. If you want to keep compatibility with KSP, then you
59 should only pass one argument to this function.
60 </note>
61
62 </body>
63 </html>

  ViewVC Help
Powered by ViewVC