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/SoundPlayer/Overview.html">SoundPlayer</a>::SetVolume</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundPlayer.h&gt;
14void SetVolume(
15     float volume
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>volume</th>
32          <td>Player volume ratio (0.0 or higher).</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>Changes a player's volume.</p><p>The player volume affects all sounds currently being played in the player.</p><p>The value specified by this function operates independently of all other volume parameters set for sound, 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></div>
42    <h2>See Also</h2>
43    <div class="section">
44      <p class="reference"><a href="../../../nw/snd/SoundPlayer/GetVolume.html"><CODE>GetVolume</CODE></a><br /> </p>
45    </div>
46    <h2>Revision History</h2>
47    <div class="section">
48      <dl class="history">
49        <dt>2010/01/15</dt>
50        <dd>Initial version.<br />
51        </dd>
52      </dl>
53    </div>
54  <hr><p>CONFIDENTIAL</p></body>
55</html>
56