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>SetTrackVolume</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/StreamSoundHandle/Overview.html">StreamSoundHandle</a>::SetTrackVolume</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nw/snd/snd_StreamSoundHandle.h&gt;
14void SetTrackVolume(
15     <span>u32</span> trackBitFlag,
16     <span>f32</span> volume,
17     int frames = 0
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>trackBitFlag</th>
34          <td>Bit flag for each track.</td>
35        </tr>
36        <tr>
37          <td>in</td>
38          <th>volume</th>
39          <td>Volume change ratio.</td>
40        </tr>
41        <tr>
42          <td>in</td>
43          <th>frames</th>
44          <td>Number of frames used for volume change.</td>
45        </tr> </table>
46    </div>
47    <h2>Return Values</h2>
48    <div class="section">
49                None.
50               </div>
51    <h2>Description</h2>
52    <div class="section">
53      <p>Changes the volume of streaming sound tracks.</p><p>Changes the volume of streaming tracks in 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 trackBitFlag argument specifies the track. Tracks are identified from the lower bit in sequence; for example, Track 0, Track 1, Track 2 and so on. The silent status will change for all tracks with enabled bits. For example, to change the silent status of Track 2 and Track 5, use  (1 &lt;&lt; 2) | (1 &lt;&lt; 5); i.e., 0x0024.</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>
54    <h2>Revision History</h2>
55    <div class="section">
56      <dl class="history">
57        <dt>2010/01/22</dt>
58        <dd>Initial version.<br />
59        </dd>
60      </dl>
61    </div>
62  <hr><p>CONFIDENTIAL</p></body>
63</html>
64