1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html>
2<head>
3<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
4<title>SND_SetTrackMute*</title>
5<link rel="stylesheet" href="../css/nitro.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
7</head>
8<body>
9<div class="refentry" lang="ja"><a name="IDAFLAU"></a><div class="titlepage">
10<div></div>
11<div></div>
12</div>
13<h1>SND_SetTrackMute* <IMG src="../image/NTR.gif" width="24" height="12" border="0" align=middle><IMG src="../image/TWL.gif" width="24" height="12" border="0" align=middle></h1>
14<h2>Syntax</h2>
15<dl>
16<dd><pre class="funcsynopsisinfo"><code>#include &lt;nitro/snd.h&gt;</code></pre></dd>
17<dd><pre class="funcprototype"><code class="funcprototype">void SND_SetTrackMute( int <var>playerNo</var>, u32 <var>trackBitMask</var>, BOOL <var>flag</var> );</code><br><code class="funcprototype">void SND_SetTrackMuteEx(
18        int <var>playerNo</var>,
19        u32 <var>trackBitMask</var>,
20        SNDSeqMute <var>mute</var> );</code><br></pre></dd>
21</dl>
22<div class="refsection" lang="ja"><a name="IDA4NAU"></a>
23      <h2>Arguments</h2>
24
25      <div class="variablelist">
26<table border="0">
27<col align="left" valign="top">
28<tbody>
29<tr>
30<td><em><strong><code>playerNo</code></strong></em></td>
31<td>The player number. Takes a value between 0 and 15.</td>
32</tr>
33<tr>
34<td><em><strong><code>trackBitMask</code></strong></em></td>
35<td>This is the track bit mask. It designates which track to use.</td>
36</tr>
37<tr>
38<td><em><strong><code>flag</code></strong></em></td>
39<td>Flag indicating whether to mute track or release mute. TRUE = Mute; FALSE = Release. </td>
40</tr>
41<tr>
42<td><em><strong><code>mute</code></strong></em></td>
43<td>Represents the mute setting.</td>
44</tr>
45</tbody>
46</table>
47</div>
48
49    </div>
50<div class="refsection" lang="ja"><a name="IDACPAU"></a>
51      <h2>Return Values</h2>
52
53      <p>None.</p>
54    </div>
55<div class="refsection" lang="ja"><a name="IDAJPAU"></a>
56      <h2>Description</h2>
57      <p>
58Mutes or releases muting on the tracks of the sequence being played by the Player specified by <code>playerNo</code>.
59</p>
60      <p>
61The track bit mask, <em><strong><code>trackBitMask</code></strong></em>, designates which track to use. Each bit expresses a track in descending order track 0 as the lowest bit. Operations are performed only on tracks with active bits.
62</p>
63      <p>
64If a track is muted using the <tt class="function">SND_SetTrackMute</tt> function, the sound immediately stops. Use the <tt class="function">SND_SetTrackMuteEx</tt> function if you do not want it to stop immediately.
65</p>
66      <p>
67Select from the following values for the mute setting <code>mute</code>:
68</p>
69      <div class="table"><a name="IDAGQAU"></a><p class="title"><b>Table SNDSeqMute</b></p>
70<table summary="SNDSeqMute" border="1">
71<colgroup><col><col></colgroup>
72<thead>
73<tr>
74<th>Label</th>
75<th>Description</th>
76</tr>
77</thead>
78<tbody>
79<tr>
80<td>SND_SEQ_MUTE_OFF</td>
81<td>Releases mute</td>
82</tr>
83<tr>
84<td>SND_SEQ_MUTE_NO_STOP</td>
85<td>Mutes without stopping the currently playing sound</td>
86</tr>
87<tr>
88<td>SND_SEQ_MUTE_RELEASE</td>
89<td>Releases the sound currently playing and mutes</td>
90</tr>
91<tr>
92<td>SND_SEQ_MUTE_STOP</td>
93<td>Immediately stops the currently playing sound and mutes</td>
94</tr>
95</tbody>
96</table>
97</div>
98      <div class="note">
99<h3 class="title">Note</h3>
100<p>
101If a currently playing sound is stopped by muting, that sound does not resume when mute is released.
102</p>
103<p>
104If a mute setting is already set inside the sequence data, a value set later will become valid.
105</p>
106<p>
107This function is an ARM7 reserved function. After this function is called, its processing will occur only after the command is issued with the <tt class="function"><a href="SND_FlushCommand.html">SND_FlushCommand</a></tt> function.
108</p>
109<p>
110If program execution must be synchronized with process completion, first use the <tt class="function"><a href="SND_GetCurrentCommandTag.html">SND_GetCurrentCommandTag</a></tt> function to obtain the command tag immediately after calling this function. Then, after the command is issued, use the command tag and call either the <tt class="function"><a href="SND_IsFinishedCommandTag.html">SND_IsFinishedCommandTag</a></tt> or <tt class="function"><a href="SND_WaitForCommandProc.html">SND_WaitForCommandProc</a></tt> function to confirm that processing has finished or to wait for it to complete.
111</p>
112</div>
113    </div>
114<h2>See Also</h2>
115<p><code><a href="SND_FlushCommand.html">SND_FlushCommand</a>, <a href="SND_GetCurrentCommandTag.html">SND_GetCurrentCommandTag</a>, <a href="SND_IsFinishedCommandTag.html">SND_IsFinishedCommandTag</a>, <a href="SND_WaitForCommandProc.html">SND_WaitForCommandProc</a></code></p>
116<h2>Revision History</h2>
117<p>
1182006/03/20 Added the <code>SNDSetTrackMuteEx</code> function. <br>2005/02/17 Added a note about ARM7 command processing. <br>2004/07/01 Initial version.
119</p>
120</div>
121<hr><p>CONFIDENTIAL</p></body>
122</html>
123