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

Annotation of /doc/docbase/instrument_scripts/nksp/reference/functions/nksp_fade_in_function.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3601 - (hide annotations) (download) (as text)
Mon Sep 16 16:03:36 2019 UTC (4 years, 7 months ago) by schoenebeck
File MIME type: text/html
File size: 1963 byte(s)
* NKSP: Added recently added built-in functions to reference docs.
* NKSP: Added info about std units and finalness to existing functions.
* NKSP: Added recently added built-in constants ~NI_MATH_E and ~NI_MATH_PI.

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 schoenebeck 3601 <td>Integer&nbsp;Number&nbsp;or<br>
41     Real&nbsp;Number</td>
42 schoenebeck 3189 <td>Fade-in time in microseconds.<br>
43     [required]</td>
44     </tr>
45     </table>
46    
47     <h3>Return Value</h3>
48     <p>None.</p>
49    
50 schoenebeck 3601 <h3>Remarks</h3>
51     <p>
52     This functions optionally accepts <code>s</code> as standard unit
53     for its argument <code>??duration-us??</code>.
54     </p>
55    
56 schoenebeck 3189 <h3>Examples</h3>
57     <p>None yet.<p>
58    
59     <h3>See also</h3>
60 schoenebeck 3241 <p><code>fade_out()</code>, <code>change_vol()</code><p>
61 schoenebeck 3189
62 schoenebeck 3196 <h3>Availability</h3>
63 schoenebeck 3189 <p>Since LinuxSampler 2.0.0.svn45.<p>
64    
65     </body>
66     </html>

  ViewVC Help
Powered by ViewVC