reference/functions/nksp_change_pitch_lfo_freq_function.html

<html>
  <head>
    <meta name="author" content="Christian Schoenebeck">
    <title>change_pitch_lfo_freq() function</title>
    <meta name="description" content="Modifies the pitch LFO frequency.">
  </head>
  <body>
    <h1>change_pitch_lfo_freq()</h1>
    <p>
      This function can be used to modify the pitch LFO frequency of active
      voices. Since LFOs are per voice, you need to pass the note ID(s) of
      the voices you want to alter. This function will change the pitch
      LFO frequency of all active voices associated with the requested note.
      So if you are using a layered instrument patch, then it will change
      the pitch LFO frequency of all layers.
    </p>
    <p>
      The LFO frequency changes set by calling this function are always applied relatively to
      all other LFO frequency sources defined for controlling the LFO (i.e. an internal
      constant LFO frequency value, an associated MIDI controller defined in the instrument
      preset to control the LFO frequency, etc.).
      Or in other words: the <code lang="nksp">??frequency??</code> value passed to this
      function will not replace the overall LFO frequency, it will rather be multiplied
      against all other LFO frequency control sources.
    </p>

    <note class="important">
    There will only be audible changes with this function if the pitch LFO is
    actually already turned on (i.e. by enabling it in the instrument patch)
    and only if the LFO is not disabled by other LFO control sources. So you may for
    example set a certain constant internal LFO depth value with the instrument preset
    first, before actually making use of this function.
    </note>

    <note>
    Release Trigger Samples: In case the affected voices cause release trigger
    samples to be spawned later on, the LFO of those release trigger voices
    will not be affected by this function at all. So if you need to control the
    LFO of release trigger samples by script, then you might rather also trigger
    those release trigger samples by script with <code lang="nksp">play_note()</code>
    instead of using the sampler format's internal support for release trigger samples.
    </note>

    <h3>Function Prototype</h3>
    <p/>
    <code lang="nksp">
change_pitch_lfo_freq(??note??, ??frequency??)
    </code>

    <h3>Arguments</h3>
    <table>
      <tr>
        <th>Argument Name</th> <th>Data Type</th> <th>Description</th>
      </tr>
      <tr>
        <td><code>??note??</code></td>
        <td>Note ID Number or Note ID Array</td>
        <td>All voices of this note will be modified.<br>
            [required]</td>
      </tr>
      <tr>
        <td><code>??frequency??</code></td>
        <td>Integer Number</td>
        <td>New LFO Frequency Value (abstract absolute value between <code>0</code> and <code>1000000</code>).<br>
            [required]</td>
      </tr>
    </table>

    <h3>Return Value</h3>
    <p>None.</p>

    <h3>Examples</h3>
    <p>None yet.<p>

    <h3>Availability</h3>
    <p>Since LinuxSampler 2.0.0.svn44.<p>

    <note>
    This function exists only with NKSP, it is not available with KSP.
    </note>

  </body>
</html>
1	schoenebeck	3121	<html>
2			<head>
3			<meta name="author" content="Christian Schoenebeck">
4			<title>change_pitch_lfo_freq() function</title>
5			<meta name="description" content="Modifies the pitch LFO frequency.">
6			</head>
7			<body>
8			<h1>change_pitch_lfo_freq()</h1>
9			<p>
10			This function can be used to modify the pitch LFO frequency 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 frequency 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 frequency of all layers.
16			</p>
17			<p>
18			The LFO frequency changes set by calling this function are always applied relatively to
19			all other LFO frequency sources defined for controlling the LFO (i.e. an internal
20			constant LFO frequency value, an associated MIDI controller defined in the instrument
21			preset to control the LFO frequency, etc.).
22			Or in other words: the <code lang="nksp">??frequency??</code> value passed to this
23			function will not replace the overall LFO frequency, it will rather be multiplied
24			against all other LFO frequency 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_freq(??note??, ??frequency??)
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>??frequency??</code></td>
63			<td>Integer Number</td>
64	schoenebeck	3234	<td>New LFO Frequency Value (abstract absolute value between <code>0</code> and <code>1000000</code>).<br>
65	schoenebeck	3121	[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	schoenebeck	3196	<h3>Availability</h3>
76	schoenebeck	3121	<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>