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 <nitro/snd.h></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> 18<code class="funcprototype">void SND_SetTrackMuteEx( 19 int <var>playerNo</var>, 20 u32 <var>trackBitMask</var>, 21 SNDSeqMute <var>mute</var> );</code><br></pre></dd> 22</dl> 23<div class="refsection" lang="ja"><a name="IDA4NAU"></a> 24<h2>Arguments</h2> 25 26 <div class="variablelist"> 27<table border="0"> 28<col align="left" valign="top"> 29<tbody> 30<tr> 31<td><em><strong><code>playerNo</code></strong></em></td> 32<td>The player number. Takes a value between 0 and 15.</td> 33</tr> 34<tr> 35<td><em><strong><code>trackBitMask</code></strong></em></td> 36<td>This is the track bit mask. It designates which track to use.</td> 37</tr> 38<tr> 39<td><em><strong><code>flag</code></strong></em></td> 40<td>Flag indicating whether to mute or unmute. <CODE>TRUE</CODE> mutes; <CODE>FALSE</CODE> unmutes.</td> 41</tr> 42<tr> 43<td><em><strong><code>mute</code></strong></em></td> 44<td>Represents the mute setting.</td> 45</tr> 46</tbody> 47</table> 48</div> 49 50 </div> 51<div class="refsection" lang="ja"><a name="IDACPAU"></a> 52<h2>Return Values</h2> 53 54<p>None.</p> 55 </div> 56<div class="refsection" lang="ja"><a name="IDAJPAU"></a> 57<h2>Description</h2> 58 <p> 59Mutes or unmutes the tracks of the sequence being played by the Player specified by <SPAN class="argument">playerNo</SPAN>. 60</p> 61 <p> 62The track bit mask, <SPAN class="argument">trackBitMask</SPAN>, designates which track to manipulate. Each bit expresses a track in descending order with track 0 as the lowest-order bit. Operations are performed only on the tracks whose bits are standing. 63</p> 64 <p> 65If a track is muted using the <CODE>SND_SetTrackMute</CODE> function, the sound immediately stops. Use the <CODE>SND_SetTrackMuteEx</CODE> function if you do not want it to stop immediately. 66</p> 67 <p> 68Select from the following values for the mute setting <SPAN class="argument">mute</SPAN>: 69</p> 70<div class="table"><a name="IDAGQAU"></a><p class="title"><b>Table: SNDSeqMute</b></p> 71<table summary="SNDSeqMute" border="1"> 72<colgroup><col><col></colgroup> 73<thead> 74<tr> 75<th>Label</th> 76<th>Description</th> 77</tr> 78</thead> 79<tbody> 80<tr> 81<td>SND_SEQ_MUTE_OFF</td> 82<td>Unmutes</td> 83</tr> 84<tr> 85<td>SND_SEQ_MUTE_NO_STOP</td> 86<td>Mutes without stopping the currently playing audio</td> 87</tr> 88<tr> 89<td>SND_SEQ_MUTE_RELEASE</td> 90<td>Releases the audio currently playing and mutes</td> 91</tr> 92<tr> 93<td>SND_SEQ_MUTE_STOP</td> 94<td>Immediately stops the currently playing audio and mutes</td> 95</tr> 96</tbody> 97</table> 98</div> 99 <div class="note"> 100<h3 class="title">Note</h3> 101<p> 102If currently playing audio is stopped by muting, that audio does not resume when the track is unmuted. 103</p> 104<p> 105If a mute setting is already configured inside the sequence data, the most recently configured setting becomes the valid one. 106</p> 107<p> 108This function is an ARM7 command 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. 109</p> 110<p> 111If 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. 112</p> 113</div> 114 </div> 115<h2>See Also</h2> 116<p><code><a href="SND_FlushCommand.html">SND_FlushCommand</a><BR><a href="SND_GetCurrentCommandTag.html">SND_GetCurrentCommandTag</a><BR><a href="SND_IsFinishedCommandTag.html">SND_IsFinishedCommandTag</a><BR><a href="SND_WaitForCommandProc.html">SND_WaitForCommandProc</a></code></p> 117<h2>Revision History</h2> 118<p> 1192006/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. 120</p> 121</div> 122<hr><p>CONFIDENTIAL</p></body> 123</html> 124
