ViewVC logotype

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 2881 - (show annotations) (download) (as text)
Tue Apr 19 16:09:52 2016 UTC (6 years, 5 months ago) by schoenebeck
File MIME type: text/html
File size: 2668 byte(s)
* NKSP: updated reference documentation for development changes
  regarding play_note(), ignore_event() and ignore_controller()

1 <html>
2 <head>
3 <meta name="author" content="Christian Schoenebeck">
4 <title>ignore_controller() function</title>
5 <meta name="description" content="Drops the given MIDI control change event.">
6 </head>
7 <body>
8 <h1>ignore_controller()</h1>
9 <p>
10 Drops the given MIDI control change event and thus prevents the supplied
11 event to be further processed by the sampler. You can use this function
12 i.e. to filter out MIDI control change events, before they are causing
13 any sound to be changed.
14 </p>
15 <p>
16 The argument this function takes is optional. If you omit passing an
17 argument to this function, then the controller event ID will be used that
18 caused this current <code lang="nksp">controller</code> event handler to be executed.
19 </p>
20 <p>
21 Dropping control change events with this function only succeeds if the
22 event just "recently" occurred. That effectively means you should drop
23 the control change event in the <code>controller</code> event handler
24 before any <code>wait() calls, and before entering any loops that may
25 execute your script for a very long time. Because in both cases the
26 sampler may suspend your script for a certain amount of time and once
27 your script got resumed, the respective control change event may already
28 have entered the sampler's regular event processing chain and thus can no
29 longer be dropped.
30 </p>
31 <p>
32 With NKSP you can also use <code>ignore_event()</code> to drop control
33 change events. So <code>ignore_controller()</code> merely exists due to
34 compatibility reasons with KSP. However when you already know that the
35 event to be dropped is a control change event, then it is recommended to
36 actually call <code>ignore_controller()</code> instead of
37 <code>ignore_event()</code>.
38 </p>
40 <h3>Function Prototype</h3>
41 <p/>
42 <code>
43 ignore_controller([??event-id??])
44 </code>
46 <h3>Arguments</h3>
47 <table>
48 <tr>
49 <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
50 </tr>
51 <tr>
52 <td><code>??event-id??</code></td>
53 <td>Event ID Number</td>
54 <td>MIDI control change event to be dropped.<br>
55 [optional, default: ID of the event handler's event]</td>
56 </tr>
57 </table>
59 <h3>Return Value</h3>
60 <p>None.</p>
62 <h3>Examples</h3>
63 <p>None yet.<p>
65 <note>
66 Dynamic, optional arguments are only supported by NKSP. If you want to
67 retain compatibility to KSP, then you should always pass a parameter
68 to this function.
69 </note>
71 </body>
72 </html>

  ViewVC Help
Powered by ViewVC