1 |
schoenebeck |
3189 |
<html> |
2 |
|
|
<head> |
3 |
|
|
<meta name="author" content="Christian Schoenebeck"> |
4 |
|
|
<title>fade_in() function</title> |
5 |
|
|
<meta name="description" content="Fade the requested note in."> |
6 |
|
|
</head> |
7 |
|
|
<body> |
8 |
|
|
<h1>fade_in()</h1> |
9 |
|
|
<p> |
10 |
|
|
This function can be used to fade in the volume of all voices of |
11 |
|
|
the given note within the requsted amount of time. If this |
12 |
|
|
function is called right when the note was spawned, then this |
13 |
|
|
function automatically fades the volume of the note's voices |
14 |
|
|
from total silence to its final neutral, maximum volume |
15 |
|
|
(<code lang="none">0 dB</code>). If this function is rather called |
16 |
|
|
somewhere in between the regular life time of the note, then |
17 |
|
|
this function fades the note's volume from its current volume |
18 |
|
|
to its final neutral, maximum volume (<code lang="none">0 dB</code>) instead. |
19 |
|
|
</p> |
20 |
|
|
|
21 |
|
|
<h3>Function Prototype</h3> |
22 |
|
|
<p/> |
23 |
|
|
<code lang="nksp"> |
24 |
|
|
fade_in(??note??, ??duration-us??) |
25 |
|
|
</code> |
26 |
|
|
|
27 |
|
|
<h3>Arguments</h3> |
28 |
|
|
<table> |
29 |
|
|
<tr> |
30 |
|
|
<th>Argument Name</th> <th>Data Type</th> <th>Description</th> |
31 |
|
|
</tr> |
32 |
|
|
<tr> |
33 |
|
|
<td><code>??note??</code></td> |
34 |
|
|
<td>Note ID Number or Note ID Array</td> |
35 |
|
|
<td>All voices of this note will be faded in.<br> |
36 |
|
|
[required]</td> |
37 |
|
|
</tr> |
38 |
|
|
<tr> |
39 |
|
|
<td><code>??duration-us??</code></td> |
40 |
|
|
<td>Integer Number</td> |
41 |
|
|
<td>Fade-in time in microseconds.<br> |
42 |
|
|
[required]</td> |
43 |
|
|
</tr> |
44 |
|
|
</table> |
45 |
|
|
|
46 |
|
|
<h3>Return Value</h3> |
47 |
|
|
<p>None.</p> |
48 |
|
|
|
49 |
|
|
<h3>Examples</h3> |
50 |
|
|
<p>None yet.<p> |
51 |
|
|
|
52 |
|
|
<h3>See also</h3> |
53 |
schoenebeck |
3241 |
<p><code>fade_out()</code>, <code>change_vol()</code><p> |
54 |
schoenebeck |
3189 |
|
55 |
schoenebeck |
3196 |
<h3>Availability</h3> |
56 |
schoenebeck |
3189 |
<p>Since LinuxSampler 2.0.0.svn45.<p> |
57 |
|
|
|
58 |
|
|
</body> |
59 |
|
|
</html> |