1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7    <title>Stop</title>
8  </head>
9  <body>
10    <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/snd/Overview.html">snd</a>::<a href="../../../nw/snd/SoundHandle/Overview.html">SoundHandle</a>::Stop</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundHandle.h&gt;
14void Stop(
15     int fadeFrames
16);
17</pre>
18    </div>
19    <h2>Arguments</h2>
20    <div class="section">
21      <table class="arguments">
22        <thead>
23          <tr>
24            <td width="15" />
25            <th>Name</th>
26            <td>Description</td>
27          </tr>
28        </thead>
29        <tr>
30          <td>in</td>
31          <th>fadeFrames</th>
32          <td>Number of elapsed frames during a fade-out. The number of frames is based on the number of calls to <a href="../../../nw/snd/SoundArchivePlayer/Update.html">SoundArchivePlayer::Update</a>. </td>
33        </tr> </table>
34    </div>
35    <h2>Return Values</h2>
36    <div class="section">
37                None.
38               </div>
39    <h2>Description</h2>
40    <div class="section">
41      <p>Stops the sound.</p><p>Stops the sound associated with the handle. If the handle is invalid, the function does nothing.</p><p>You can fade out over the number of frames specified by <span>fadeFrames</span>. Fade-out is not performed when 0 has been specified. However, in the case of sound being generated in sequence sound, sound stops after the sound for the release of the envelope was generated, and all attenuation has been completed.</p><p>The volume control for fade-out is also used for fade-in. The number of fade-out frames correlates to the speed of change from maximum volume to silence. If a fade-out is specified during a fade-in, or in other similar situations, it may complete sooner than the specified frame count.</p></div>
42    <h2>See Also</h2>
43    <div class="section">
44      <p class="reference"><a href="../../../nw/snd/SoundHandle/Pause.html">Pause</a><br /> </p>
45    </div>
46    <h2>Revision History</h2>
47    <div class="section">
48      <dl class="history">
49        <dt>2010/12/24</dt>
50        <dd>Added information about the number of frames.
51        </dd>
52        <dt>2010/01/15</dt>
53        <dd>Initial version.<br />
54        </dd>
55      </dl>
56    </div>
57  <hr><p>CONFIDENTIAL</p></body>
58</html>
59