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>SetVolume</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>::SetVolume</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 SetVolume(
15     float volume,
16     int frames = 0
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>volume</th>
33          <td>The volume change ratio (0.0 or greater).</td>
34        </tr>
35        <tr>
36          <td>in</td>
37          <th>frames</th>
38          <td>Number of frames that elapse when the volume changes. 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>Changes the volume of the sound.</p><p>Changes the volume of the sound associated with the handle. If the handle is invalid, the function does nothing.</p><p>The value specified by this function operates independently of other volume parameters, which are mixed together.</p><p>The <span>volume</span> argument specifies a ratio of 0.0 or greater. There is no effect on the volume if 1.0 is specified. If 0.0 is specified, no sound is output. The default value is 1.0.</p><p><B>Note:</B> After being combined with the other volume parameters, the final volume is clamped to the range of 0.0 to 2.0. Twice the original volume may not result even if a value of 2.0 is set with this function.</p><p>The volume changes over the number of frames specified by <span>frames</span>. If this function is called during a volume change, the volume change takes place over the number of newly specified frames, using the volume value at that point as a reference point.</p></div>
48    <h2>Revision History</h2>
49    <div class="section">
50      <dl class="history">
51        <dt>2010/12/24</dt>
52        <dd>Added information about the number of frames.
53        </dd>
54        <dt>2010/01/15</dt>
55        <dd>Initial version.<br />
56        </dd>
57      </dl>
58    </div>
59  <hr><p>CONFIDENTIAL</p></body>
60</html>
61