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>SetMasterVolume</title>
8  </head>
9  <body>
10    <h1>nw::snd::SoundSystem::SetMasterVolume Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_SoundSystem.h&gt;
14
15static void SetMasterVolume(
16     float volume,
17     int fadeTimes
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>volume</th>
34          <td>Volume ratio (0.0 or higher).</td>
35        </tr>
36        <tr>
37          <td>in</td>
38          <th>fadeTimes</th>
39          <td>Time over which volume is varied (in milliseconds).</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>This function sets the master volume.</p><p>The master volume affects all sounds played by the sound library. It does not affect sounds played by any other means.</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 sound volume may not result even if 2.0 is set with this function.</p><p>The volume changes over the time specified by <span>fadeTimes</span>. If this function is called during a change in volume, the volume varies over the newly specified time, using the volume value at that point as the reference point.</p></div>
49    <h2>See Also</h2>
50    <div class="section">
51      <p class="reference"><a href="../../../nw/snd/SoundSystem/GetMasterVolume.html"><CODE>GetMasterVolume</CODE></a><br /> </p>
52    </div>
53    <h2>Revision History</h2>
54    <div class="section">
55      <dl class="history">
56        <dt>2010/01/26</dt>
57        <dd>Adjusted the wording.<br />
58        </dd>
59        <dt>2010/01/25</dt>
60        <dd>Added a description of arguments.<br />
61        </dd>
62        <dt>2010/01/15</dt>
63        <dd>Initial version.<br />
64        </dd>
65      </dl>
66    </div>
67  <hr><p>CONFIDENTIAL</p></body>
68</html>