ViewVC logotype

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 2936 - (show annotations) (download) (as text)
Sun Jul 10 14:44:04 2016 UTC (4 years, 3 months ago) by schoenebeck
File MIME type: text/html
File size: 3277 byte(s)
* NKSP: Added built-in script function "change_cutoff()".
* NKSP: Added built-in script function "change_reso()".
* NKSP: Added built-in script function "event_status()".
* NKSP language tour: Added bitwise operators.

1 <html>
2 <head>
3 <meta name="author" content="Christian Schoenebeck">
4 <title>change_cutoff() function</title>
5 <meta name="description" content="Modifies the filter cutoff frequency of voices of a particular note.">
6 </head>
7 <body>
8 <h1>change_cutoff()</h1>
9 <p>
10 This function can be used to modify the filter cutoff frequency of active
11 voices during their entire life time. You need to pass the
12 note ID of the voices you want to alter. This function will change the
13 cutoff frequency of all active voices associated with the requested note. So if you
14 are using a layered instrument patch, then it will change the cutoff frequency of
15 all layers.
16 </p>
17 <p>
18 The cutoff frequency changes set by calling this function are always applied relatively to
19 the cutoff frequency calculated by the synthesis model and sampler format. That means
20 the various sources of cutoff frequency factors like Filter Envelopes,
21 Filter LFOs and other cutoff frequency factors that may be defined by the
22 instrument patch, are always processed and calculated for the voices first,
23 and the final cutoff frequency applied is always a relative combination of all those
24 factors and the one set with this function call.
25 Or in other words: you cannot replace the cutoff frequency set by other synthesis
26 sources with this function.
27 </p>
29 <note class="important">
30 There will only be audible changes with this function if a filter is
31 actually already turned on (i.e. by enabling it in the instrument patch)
32 and only if the filter is not closed by other sources (i.e. cutoff frequency
33 should be set open in the instrument patch).
34 </note>
36 <note>
37 Release Trigger Samples: In case the affected voices cause release trigger
38 samples to be spawned later on, the cutoff frequency of those release trigger voices
39 will not be affected by this function at all. So if you need to control the
40 cutoff frequency of release trigger samples by script, then you might rather also trigger
41 those release trigger samples by script with <code lang="nksp">play_note()</code>
42 instead of using the sampler format's internal support for release trigger samples.
43 </note>
45 <h3>Function Prototype</h3>
46 <p/>
47 <code lang="nksp">
48 change_cutoff(??note??, ??cutoff??)
49 </code>
51 <h3>Arguments</h3>
52 <table>
53 <tr>
54 <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
55 </tr>
56 <tr>
57 <td><code>??note??</code></td>
58 <td>Note ID Number</td>
59 <td>All voices of this note will be modified.<br>
60 [required]</td>
61 </tr>
62 <tr>
63 <td><code>??cutoff??</code></td>
64 <td>Integer Number</td>
65 <td>New Cutoff Frequency (abstract absolute value between 0 and 1000000).<br>
66 [required]</td>
67 </tr>
68 </table>
70 <h3>Return Value</h3>
71 <p>None.</p>
73 <h3>Examples</h3>
74 <p>None yet.<p>
76 <h3>Availabilty</h3>
77 <p>Since LinuxSampler 2.0.0.svn12.<p>
79 <note>
80 This function exists only with NKSP, it is not available with KSP, because
81 KSP does not allow to change filter parameters on note level.
82 </note>
84 </body>
85 </html>

  ViewVC Help
Powered by ViewVC