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

Annotation of /doc/docbase/instrument_scripts/nksp/reference/functions/nksp_ignore_event_function.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2742 - (hide annotations) (download) (as text)
Wed Apr 29 00:22:59 2015 UTC (8 years, 11 months ago) by schoenebeck
File MIME type: text/html
File size: 1476 byte(s)
- Fixed code lang attribute in all NKSP reference articles.

1 schoenebeck 2732 <html>
2     <head>
3     <meta name="author" content="Christian Schoenebeck">
4     <title>ignore_event() function</title>
5     <meta name="description" content="Drops the given event.">
6     </head>
7     <body>
8     <h1>ignore_event()</h1>
9     <p>
10     Drops the given event and thus prevents the supplied event to be further
11     processed by the sampler. You can use this function i.e. to filter out
12     MIDI note on and MIDI note off events, before they are causing new notes
13     to be triggered.
14     </p>
15     <p>
16 schoenebeck 2742 There is also an <code lang="nksp">ignore_controller()</code> function. With
17 schoenebeck 2732 NKSP the two functions are both doing the same thing though.
18     The two exist merely due to compatibility reasons with KSP.
19     </p>
20    
21     <h3>Function Prototype</h3>
22     <p/>
23     <code>
24     ignore_event(??event-id??)
25     </code>
26    
27     <h3>Arguments</h3>
28     <table>
29     <tr>
30     <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
31     </tr>
32     <tr>
33     <td><code>??event-id??</code></td>
34     <td>Event ID Number or Event ID Array</td>
35     <td>MIDI event(s) to be dropped.<br>
36     [required]</td>
37     </tr>
38     </table>
39    
40     <h3>Return Value</h3>
41     <p>None.</p>
42    
43     <h3>Examples</h3>
44     <p>None yet.<p>
45    
46     <note>
47     Passing an array of event IDs is only supported by NKSP. If you want
48     to keep compatibility to KSP, then you should only pass a single
49     event ID to this function.
50     </note>
51    
52     </body>
53     </html>

  ViewVC Help
Powered by ViewVC