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>nw::snd::SoundHandle::Pause Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundHandle.h&gt;
14
15void Pause(
16     bool flag,
17     int fadeFrames
18);
19</pre>
20    </div>
21    <h2>Arguments</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27            <th>Name</th>
28            <td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32          <td>in</td>
33          <th>flag</th>
34          <td>Playback pauses when this is <span>true</span> and restarts if this is <span>false</span>.</td>
35        </tr>
36        <tr>
37          <td>in</td>
38          <th>fadeFrames</th>
39          <td>Number of frames that elapse when fading in and out.</td>
40        </tr> </table>
41    </div>
42    <h2>Return Values</h2>
43    <div class="section">
44                None.
45               </div>
46    <h2>Description</h2>
47    <div class="section">
48      <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>
49    <h2>See Also</h2>
50    <div class="section">
51      <p class="reference"><a href="../../../nw/snd/SoundHandle/IsPause.html">IsPause</a><br /> </p>
52    </div>
53    <h2>Revision History</h2>
54    <div class="section">
55      <dl class="history">
56        <dt>2010/01/15</dt>
57        <dd>Initial version.<br />
58        </dd>
59      </dl>
60    </div>
61  <hr><p>CONFIDENTIAL</p></body>
62</html>