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

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

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

revision 2742 by schoenebeck, Wed Apr 29 00:22:59 2015 UTC revision 3252 by schoenebeck, Mon May 29 22:42:46 2017 UTC
# Line 9  Line 9 
9      <p>      <p>
10        Releases a note by passing the note's event ID to this function.        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        This is almost like sending a MIDI note off event programmatically, however
12        a call to this function will only affect one single note instead.        a call to this function will only release one single note instead,
13      </p>        a call to this function does not cause a <code lang="nksp">release</code>
14      <p>        event handler to be executed, nor will any MIDI specific note-off handling
15        The argument this function takes is optional. If you omit passing an        be done (i.e. it will have no effect on the status of built-in array variable
16        argument to this function, then the controller event ID will be used that        <code>%KEY_DOWN[]</code>).
       caused this current <code lang="nksp">controller</code> event handler to be executed.  
     </p>  
     <p>  
       There is also an <code>ignore_event()</code> function. With  
       NKSP the two functions are both doing the same thing though.  
       The two exist merely due to compatibility reasons with KSP.  
17      </p>      </p>
18    
19      <h3>Function Prototype</h3>      <h3>Function Prototype</h3>
# Line 36  note_off(??event-id??, [??velocity??]) Line 30  note_off(??event-id??, [??velocity??])
30        <tr>        <tr>
31          <td><code>??event-id??</code></td>          <td><code>??event-id??</code></td>
32          <td>Event ID Number or Event ID Array</td>          <td>Event ID Number or Event ID Array</td>
33          <td>Event ID(s) of the note(s) to be released.<br>          <td>Note ID(s) of the note(s) to be released.<br>
34              [required]</td>              [required]</td>
35        </tr>        </tr>
36        <tr>        <tr>
37          <td><code>??velocity??</code></td>          <td><code>??velocity??</code></td>
38          <td>Integer Number</td>          <td>Integer Number</td>
39          <td>MIDI note off velocity value.<br>          <td>MIDI note off velocity value.<br>
40              [optional, default: 127]</td>              [optional, default: <code>127</code>]</td>
41        </tr>        </tr>
42      </table>      </table>
43            
# Line 53  note_off(??event-id??, [??velocity??]) Line 47  note_off(??event-id??, [??velocity??])
47      <h3>Examples</h3>      <h3>Examples</h3>
48      <p>None yet.<p>      <p>None yet.<p>
49    
50        <h3>See also</h3>
51        <p><code>ignore_event()</code>, <code>play_note()</code>, <code>set_controller()</code><p>
52    
53        <h3>Availability</h3>
54        <p>Since LinuxSampler 2.0.0<p>
55    
56      <note>      <note>
57        Passing an array of event IDs is only supported by NKSP. If you want        Passing an array of event IDs is only supported by NKSP. If you want
58        to keep compatibility to KSP, then you should only pass a single        to keep compatibility to KSP, then you should only pass a single
Legend:
Removed from v.2742  
changed lines
  Added in v.3252
  ViewVC Help
Powered by ViewVC