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>Pause</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>::Pause</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 Pause(
15     bool flag,
16     int fadeFrames
17);
18</pre>
19    </div>
20    <h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26            <th>Name</th>
27            <td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31          <td>in</td>
32          <th>flag</th>
33          <td>Playback pauses when this is <span>true</span> and restarts if this is <span>false</span>.</td>
34        </tr>
35        <tr>
36          <td>in</td>
37          <th>fadeFrames</th>
38          <td>Number of frames that elapse when fading in and out. The number of frames is based on the number of calls to <a href="../../../nw/snd/SoundArchivePlayer/Update.html">SoundArchivePlayer::Update</a>. </td>
39        </tr> </table>
40    </div>
41    <h2>Return Values</h2>
42    <div class="section">
43                None.
44               </div>
45    <h2>Description</h2>
46    <div class="section">
47      <p>Pauses or restarts a sound.</p><p>Pauses or restarts the sound associated with the handle. If the handle is invalid, the function does nothing.</p><p>You can pause the sound while fading out or restart it while fading in for the number of frames specified by <span>fadeFrames</span>. If 0 is specified, the sound stops or restarts immediately.</p><p>The fade used during pause/restart operates independently for the fade-in used with restart and the fade-out used with pause. The number of frames that elapse when fading correlates to the speed of change from maximum volume to silence and vice versa. A fade operation may therefore complete in less than the specified number of frames if, for example, it is started in the middle of another one.</p></div>
48    <h2>See Also</h2>
49    <div class="section">
50      <p class="reference"><a href="../../../nw/snd/SoundHandle/IsPause.html">IsPause</a><br /> </p>
51    </div>
52    <h2>Revision History</h2>
53    <div class="section">
54      <dl class="history">
55        <dt>2010/12/24</dt>
56        <dd>Added information about the number of frames.
57        </dd>
58        <dt>2010/01/15</dt>
59        <dd>Initial version.<br />
60        </dd>
61      </dl>
62    </div>
63  <hr><p>CONFIDENTIAL</p></body>
64</html>
65