reference/functions/nksp_fade_out_function.html

<html>
  <head>
    <meta name="author" content="Christian Schoenebeck">
    <title>fade_out() function</title>
    <meta name="description" content="Fade the requested note out.">
  </head>
  <body>
    <h1>fade_out()</h1>
    <p>
      This function can be used to fade out the volume of all voices of
      the given note within the requsted amount of time. The volume
      will be faded from the note's current volume to total silence.
      If desired, the respective voices will automatically be stopped
      as soon as they were completely faded out.
    </p>

    <h3>Function Prototype</h3>
    <p/>
    <code lang="nksp">
fade_out(??note??, ??duration-us??, [??stop??])
    </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 faded out.<br>
            [required]</td>
      </tr>
      <tr>
        <td><code>??duration-us??</code></td>
        <td>Integer Number</td>
        <td>Fade-out time in microseconds.<br>
            [required]</td>
      </tr>
      <tr>
        <td><code>??stop??</code></td>
        <td>Integer&nbsp;Number&nbsp;or<br>
            Real&nbsp;Number</td>
        <td>Whether the voice(s) shall be stopped after fade-out completed.<br>
            <code>0</code>: Keep the voices alive, to allow fading them back in for example.<br>
            <code>1</code>: Stop the voices automatically after fade-out.<br>
            [optional, default: <code>1</code>]</td>
      </tr>
    </table>

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

    <h3>Remarks</h3>
    <p>
      This functions optionally accepts <code>s</code> as standard unit
      for its argument <code>??duration-us??</code>.
    </p>

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

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

    <note>
      The third argument of this function <code>??stop??</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	3189	<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	schoenebeck	3190	<td>All voices of this note will be faded out.<br>
32	schoenebeck	3189	[required]</td>
33			</tr>
34			<tr>
35			<td><code>??duration-us??</code></td>
36			<td>Integer Number</td>
37	schoenebeck	3190	<td>Fade-out time in microseconds.<br>
38	schoenebeck	3189	[required]</td>
39			</tr>
40			<tr>
41			<td><code>??stop??</code></td>
42	schoenebeck	3601	<td>Integer Number or<br>
43			Real Number</td>
44	schoenebeck	3189	<td>Whether the voice(s) shall be stopped after fade-out completed.<br>
45	schoenebeck	3233	<code>0</code>: Keep the voices alive, to allow fading them back in for example.<br>
46			<code>1</code>: Stop the voices automatically after fade-out.<br>
47			[optional, default: <code>1</code>]</td>
48	schoenebeck	3189	</tr>
49			</table>
50
51			<h3>Return Value</h3>
52			<p>None.</p>
53
54	schoenebeck	3601	<h3>Remarks</h3>
55			<p>
56			This functions optionally accepts <code>s</code> as standard unit
57			for its argument <code>??duration-us??</code>.
58			</p>
59
60	schoenebeck	3189	<h3>Examples</h3>
61			<p>None yet.<p>
62
63			<h3>See also</h3>
64	schoenebeck	3241	<p><code>fade_in()</code>, <code>change_vol()</code><p>
65	schoenebeck	3189
66	schoenebeck	3196	<h3>Availability</h3>
67	schoenebeck	3189	<p>Since LinuxSampler 2.0.0.svn45.<p>
68
69			<note>
70			The third argument of this function <code>??stop??</code> is only
71			optional with NKSP. If you want to keep compatibility with KSP, then you
72			should always pass a value for that third argument of this function.
73			</note>
74
75			</body>
76			</html>