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>nw::snd::SoundPlayer::SetVolume Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundPlayer.h&gt;
14
15void SetVolume(
16     float volume
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>Player volume ratio (0.0 or higher).</td>
34        </tr> </table>
35    </div>
36    <h2>Return Values</h2>
37    <div class="section">
38                None.
39               </div>
40    <h2>Description</h2>
41    <div class="section">
42      <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>
43    <h2>See Also</h2>
44    <div class="section">
45      <p class="reference"><a href="../../../nw/snd/SoundPlayer/GetVolume.html"><CODE>GetVolume</CODE></a><br /> </p>
46    </div>
47    <h2>Revision History</h2>
48    <div class="section">
49      <dl class="history">
50        <dt>2010/01/15</dt>
51        <dd>Initial version.<br />
52        </dd>
53      </dl>
54    </div>
55  <hr><p>CONFIDENTIAL</p></body>
56</html>