reference/functions/nksp_change_vol_function.html

<html>
  <head>
    <meta name="author" content="Christian Schoenebeck">
    <title>change_vol() function</title>
    <meta name="description" content="Modifies the volume of voices of a particular note.">
  </head>
  <body>
    <h1>change_vol()</h1>
    <p>
      This function can be used to modify the volume of active voices during
      their entire life time. So you may for example implement very sophisticated
      volume envelopes by script by using this function. You need to pass the
      note ID of the voices you want to alter. This function will change the
      volume of all active voices associated with the requested note. So if you
      are using a layered instrument patch, then it will change the volume of
      all layers.
    </p>
    <p>
      Internally the sampler always fades the volume from its current value to
      the new volume as requested, however that volume fade by default is so fast
      that it sounds like its value jumps directly from its old to the new value,
      it is yet slow enough though to avoid undesired click sounds. You may also
      override that automated fade time explicitly by calling
      <code lang="nksp">change_vol_time()</code> before calling the
      <code lang="nksp">change_vol()</code> function.
    </p>
    <p>
      The volume changes set by calling this function are always applied relatively to
      the volume calculated by the synthesis model and sampler format. That means
      the various sources of volume factors like MIDI CC #7, Amplitute Envelopes,
      Amplitutude LFOs and other volume factors that may be defined by the
      instrument patch, are always processed and calculated for the voices first,
      and the final volume applied is always a relative combination of all those
      factors and the one set with this function call. This does also not change
      when you pass <code>1</code> for argument <code>??relative??</code>.
      Or in other words: you cannot replace the volume set by other synthesis
      sources with this function.
    </p>

    <note class="important">
    Release Trigger Samples: In case the affected voices cause release trigger
    samples to be spawned later on, the volume of those release trigger voices
    will not be affected by this function at all. So if you need to control the
    volume 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_vol(??note??, ??volume??, [??relative??])
    </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>??volume??</code></td>
        <td>Integer Number</td>
        <td>Volume change in Milli dB.
            A positive value increases the volume,
            a negative value decreases the volume.<br>
            [required]</td>
      </tr>
      <tr>
        <td><code>??relative??</code></td>
        <td>Integer Number</td>
        <td>Whether change_vol() calls should be relative to each other.<br>
            0: A call to <code>change_vol()</code> upon the same note will
               replace the volume change value set by previous
               <code>change_vol()</code> calls upon the same note.<br>
            1: Successive calls to <code>change_vol()</code> upon the same
               note will be relatively applied against each other.<br>
            [optional, default: 0]</td>
      </tr>
    </table>

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

    <h3>Examples</h3>
    <p>None yet.<p>
    
    <h3>See also</h3>
    <p><code>change_vol_time()</code>, <code>fade_in()</code>, <code>fade_out()</code><p>

    <h3>Availabilty</h3>
    <p>Since LinuxSampler 2.0.0.svn11.<p>

    <note>
      The third argument of this function <code>??relative??</code> is only
      optional with NKSP. If you want to keep compatibility with KSP, then you
      should always pass a value for that third argument of this function.
    </note>

  </body>
</html>
1	schoenebeck	2932	<html>
2			<head>
3			<meta name="author" content="Christian Schoenebeck">
4			<title>change_vol() function</title>
5			<meta name="description" content="Modifies the volume of voices of a particular note.">
6			</head>
7			<body>
8			<h1>change_vol()</h1>
9			<p>
10			This function can be used to modify the volume of active voices during
11			their entire life time. So you may for example implement very sophisticated
12			volume envelopes by script by using this function. You need to pass the
13			note ID of the voices you want to alter. This function will change the
14			volume of all active voices associated with the requested note. So if you
15			are using a layered instrument patch, then it will change the volume of
16			all layers.
17			</p>
18			<p>
19	schoenebeck	3189	Internally the sampler always fades the volume from its current value to
20			the new volume as requested, however that volume fade by default is so fast
21			that it sounds like its value jumps directly from its old to the new value,
22			it is yet slow enough though to avoid undesired click sounds. You may also
23			override that automated fade time explicitly by calling
24			<code lang="nksp">change_vol_time()</code> before calling the
25			<code lang="nksp">change_vol()</code> function.
26			</p>
27			<p>
28	schoenebeck	2933	The volume changes set by calling this function are always applied relatively to
29	schoenebeck	2932	the volume calculated by the synthesis model and sampler format. That means
30			the various sources of volume factors like MIDI CC #7, Amplitute Envelopes,
31			Amplitutude LFOs and other volume factors that may be defined by the
32			instrument patch, are always processed and calculated for the voices first,
33			and the final volume applied is always a relative combination of all those
34			factors and the one set with this function call. This does also not change
35			when you pass <code>1</code> for argument <code>??relative??</code>.
36			Or in other words: you cannot replace the volume set by other synthesis
37			sources with this function.
38			</p>
39
40			<note class="important">
41			Release Trigger Samples: In case the affected voices cause release trigger
42			samples to be spawned later on, the volume of those release trigger voices
43			will not be affected by this function at all. So if you need to control the
44			volume of release trigger samples by script, then you might rather also trigger
45			those release trigger samples by script with <code lang="nksp">play_note()</code>
46			instead of using the sampler format's internal support for release trigger samples.
47			</note>
48
49			<h3>Function Prototype</h3>
50			<p/>
51			<code lang="nksp">
52			change_vol(??note??, ??volume??, [??relative??])
53			</code>
54
55			<h3>Arguments</h3>
56			<table>
57			<tr>
58			<th>Argument Name</th> <th>Data Type</th> <th>Description</th>
59			</tr>
60			<tr>
61			<td><code>??note??</code></td>
62	schoenebeck	2944	<td>Note ID Number or Note ID Array</td>
63	schoenebeck	2932	<td>All voices of this note will be modified.<br>
64			[required]</td>
65			</tr>
66			<tr>
67			<td><code>??volume??</code></td>
68			<td>Integer Number</td>
69			<td>Volume change in Milli dB.
70			A positive value increases the volume,
71	schoenebeck	3189	a negative value decreases the volume.<br>
72			[required]</td>
73	schoenebeck	2932	</tr>
74			<tr>
75			<td><code>??relative??</code></td>
76			<td>Integer Number</td>
77			<td>Whether change_vol() calls should be relative to each other.<br>
78			0: A call to <code>change_vol()</code> upon the same note will
79			replace the volume change value set by previous
80			<code>change_vol()</code> calls upon the same note.<br>
81			1: Successive calls to <code>change_vol()</code> upon the same
82			note will be relatively applied against each other.<br>
83			[optional, default: 0]</td>
84			</tr>
85			</table>
86
87			<h3>Return Value</h3>
88			<p>None.</p>
89
90			<h3>Examples</h3>
91			<p>None yet.<p>
92	schoenebeck	3189
93			<h3>See also</h3>
94			<p><code>change_vol_time()</code>, <code>fade_in()</code>, <code>fade_out()</code><p>
95	schoenebeck	2932
96			<h3>Availabilty</h3>
97			<p>Since LinuxSampler 2.0.0.svn11.<p>
98
99	schoenebeck	3189	<note>
100			The third argument of this function <code>??relative??</code> is only
101			optional with NKSP. If you want to keep compatibility with KSP, then you
102			should always pass a value for that third argument of this function.
103			</note>
104
105	schoenebeck	2932	</body>
106			</html>