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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3196 - (show annotations) (download) (as text)
Sat May 20 14:27:01 2017 UTC (4 years, 2 months ago) by schoenebeck
File MIME type: text/html
File size: 3100 byte(s)
- Fixed copy pasted typo all over the entire docbase.

1 <html>
2 <head>
3 <meta name="author" content="Christian Schoenebeck">
4 <title>change_pitch_lfo_depth() function</title>
5 <meta name="description" content="Modifies the pitch LFO depth.">
6 </head>
7 <body>
8 <h1>change_pitch_lfo_depth()</h1>
9 <p>
10 This function can be used to modify the pitch LFO depth of active
11 voices. Since LFOs are per voice, you need to pass the note ID(s) of
12 the voices you want to alter. This function will change the pitch
13 LFO depth of all active voices associated with the requested note.
14 So if you are using a layered instrument patch, then it will change
15 the pitch LFO depth of all layers.
16 </p>
17 <p>
18 The LFO depth changes set by calling this function are always applied relatively to
19 all other LFO depth sources defined for controlling the LFO (i.e. an internal
20 constant LFO depth value, an associated MIDI controller defined in the instrument
21 preset to control the LFO depth, etc.).
22 Or in other words: the <code lang="nksp">??depth??</code> value passed to this
23 function will not replace the overall LFO depth, it will rather be multiplied
24 against all other LFO depth control sources.
25 </p>
26
27 <note class="important">
28 There will only be audible changes with this function if the pitch LFO is
29 actually already turned on (i.e. by enabling it in the instrument patch)
30 and only if the LFO is not disabled by other LFO control sources. So you may for
31 example set a certain constant internal LFO depth value with the instrument preset
32 first, before actually making use of this function.
33 </note>
34
35 <note>
36 Release Trigger Samples: In case the affected voices cause release trigger
37 samples to be spawned later on, the LFO of those release trigger voices
38 will not be affected by this function at all. So if you need to control the
39 LFO of release trigger samples by script, then you might rather also trigger
40 those release trigger samples by script with <code lang="nksp">play_note()</code>
41 instead of using the sampler format's internal support for release trigger samples.
42 </note>
43
44 <h3>Function Prototype</h3>
45 <p/>
46 <code lang="nksp">
47 change_pitch_lfo_depth(??note??, ??depth??)
48 </code>
49
50 <h3>Arguments</h3>
51 <table>
52 <tr>
53 <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
54 </tr>
55 <tr>
56 <td><code>??note??</code></td>
57 <td>Note ID Number or Note ID Array</td>
58 <td>All voices of this note will be modified.<br>
59 [required]</td>
60 </tr>
61 <tr>
62 <td><code>??depth??</code></td>
63 <td>Integer Number</td>
64 <td>New LFO Depth Value (abstract absolute value between 0 and 1000000).<br>
65 [required]</td>
66 </tr>
67 </table>
68
69 <h3>Return Value</h3>
70 <p>None.</p>
71
72 <h3>Examples</h3>
73 <p>None yet.<p>
74
75 <h3>Availability</h3>
76 <p>Since LinuxSampler 2.0.0.svn44.<p>
77
78 <note>
79 This function exists only with NKSP, it is not available with KSP.
80 </note>
81
82 </body>
83 </html>

  ViewVC Help
Powered by ViewVC