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

Diff of /doc/docbase/instrument_scripts/nksp/reference/functions/nksp_ignore_controller_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 2881 by schoenebeck, Tue Apr 19 16:09:52 2016 UTC
# Line 10  Line 10 
10        Drops the given MIDI control change event and thus prevents the supplied        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        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        i.e. to filter out MIDI control change events, before they are causing
13        the sound to be changed.        any sound to be changed.
14      </p>      </p>
15      <p>      <p>
16        The argument this function takes is optional. If you omit passing an        The argument this function takes is optional. If you omit passing an
# Line 18  Line 18 
18        caused this current <code lang="nksp">controller</code> event handler to be executed.        caused this current <code lang="nksp">controller</code> event handler to be executed.
19      </p>      </p>
20      <p>      <p>
21        There is also an <code>ignore_event()</code> function. With        Dropping control change events with this function only succeeds if the
22        NKSP the two functions are both doing the same thing though.        event just "recently" occurred. That effectively means you should drop
23        The two exist merely due to compatibility reasons with KSP.        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>      </p>
39    
40      <h3>Function Prototype</h3>      <h3>Function Prototype</h3>

Legend:
Removed from v.2742  
changed lines
  Added in v.2881

  ViewVC Help
Powered by ViewVC