1 |
<html> |
2 |
<head> |
3 |
<meta name="author" content="Christian Schoenebeck"> |
4 |
<title>fade_out() function</title> |
5 |
<meta name="description" content="Fade the requested note out."> |
6 |
</head> |
7 |
<body> |
8 |
<h1>fade_out()</h1> |
9 |
<p> |
10 |
This function can be used to fade out the volume of all voices of |
11 |
the given note within the requsted amount of time. The volume |
12 |
will be faded from the note's current volume to total silence. |
13 |
If desired, the respective voices will automatically be stopped |
14 |
as soon as they were completely faded out. |
15 |
</p> |
16 |
|
17 |
<h3>Function Prototype</h3> |
18 |
<p/> |
19 |
<code lang="nksp"> |
20 |
fade_out(??note??, ??duration-us??, [??stop??]) |
21 |
</code> |
22 |
|
23 |
<h3>Arguments</h3> |
24 |
<table> |
25 |
<tr> |
26 |
<th>Argument Name</th> <th>Data Type</th> <th>Description</th> |
27 |
</tr> |
28 |
<tr> |
29 |
<td><code>??note??</code></td> |
30 |
<td>Note ID Number or Note ID Array</td> |
31 |
<td>All voices of this note will be faded out.<br> |
32 |
[required]</td> |
33 |
</tr> |
34 |
<tr> |
35 |
<td><code>??duration-us??</code></td> |
36 |
<td>Integer Number</td> |
37 |
<td>Fade-out time in microseconds.<br> |
38 |
[required]</td> |
39 |
</tr> |
40 |
<tr> |
41 |
<td><code>??stop??</code></td> |
42 |
<td>Integer Number</td> |
43 |
<td>Whether the voice(s) shall be stopped after fade-out completed.<br> |
44 |
<code>0</code>: Keep the voices alive, to allow fading them back in for example.<br> |
45 |
<code>1</code>: Stop the voices automatically after fade-out.<br> |
46 |
[optional, default: <code>1</code>]</td> |
47 |
</tr> |
48 |
</table> |
49 |
|
50 |
<h3>Return Value</h3> |
51 |
<p>None.</p> |
52 |
|
53 |
<h3>Examples</h3> |
54 |
<p>None yet.<p> |
55 |
|
56 |
<h3>See also</h3> |
57 |
<p><code>fade_in()</code>, <code>change_vol()</code><p> |
58 |
|
59 |
<h3>Availability</h3> |
60 |
<p>Since LinuxSampler 2.0.0.svn45.<p> |
61 |
|
62 |
<note> |
63 |
The third argument of this function <code>??stop??</code> is only |
64 |
optional with NKSP. If you want to keep compatibility with KSP, then you |
65 |
should always pass a value for that third argument of this function. |
66 |
</note> |
67 |
|
68 |
</body> |
69 |
</html> |