TwlIPL_commit-99/add-ins/TwlSystem/man/ja_JP/snd/NNS_SndPlayerSetTrackMute.html

134 lines
4.4 KiB
HTML
Executable File

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=Shift_JIS">
<title>NNS_SndPlayerSetTrackMute*</title>
<link rel="stylesheet" href="../css/nitro.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
</head>
<body>
<div class="refentry" lang="ja"><a name="IDAKKAU"></a><div class="titlepage">
<div></div>
<div></div>
</div>
<h1>NNS_SndPlayerSetTrackMute*</h1>
<h2>構文</h2>
<dl>
<dd><pre class="funcsynopsisinfo"><code>#include &lt;nnsys/snd.h&gt;</code></pre></dd>
<dd><pre class="funcprototype"><code class="funcprototype">void NNS_SndPlayerSetTrackMute(
NNSSndHandle* <var>handle</var>,
u16 <var>trackBitMask</var>,
BOOL <var>flag</var> );</code><br><code class="funcprototype">void NNS_SndPlayerSetTrackMuteEx(
NNSSndHandle* <var>handle</var>,
u16 <var>trackBitMask</var>,
NNSSndSeqMute <var>mute</var> );</code><br></pre></dd>
</dl>
<div class="refsection" lang="ja"><a name="IDADNAU"></a>
<h2>引数</h2>
<div class="variablelist">
<table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><em><strong><code>handle</code></strong></em></td>
<td>サウンドハンドルのポインタです。</td>
</tr>
<tr>
<td><em><strong><code>trackBitMask</code></strong></em></td>
<td>トラックビットマスクです。</td>
</tr>
<tr>
<td><em><strong><code>flag</code></strong></em></td>
<td>ミュートするかやめるかのフラグです。TRUEならミュートし、FALSEならミュートを解除します。</td>
</tr>
<tr>
<td><em><strong><code>mute</code></strong></em></td>
<td>ミュート設定です。</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsection" lang="ja"><a name="IDAHOAU"></a>
<h2>返り値</h2>
<p>なし。</p>
</div>
<div class="refsection" lang="ja"><a name="IDAOOAU"></a>
<h2>説明</h2>
<p>
シーケンストラックをミュートしたり、やめたりします。
</p>
<p>
サウンドハンドル<em><strong><code>handle</code></strong></em>に、結びつけられたシーケンスのトラックをミュートしたりやめたりします。
サウンドハンドルが無効の場合は、何もしません。
</p>
<p>
<em><strong><code>trackBitMask</code></strong></em>で、設定するトラックを指定します。
下位ビットから順に、トラック0、トラック1、トラック2、、、を表し、ビットが立っているトラック全てに対して、
ミュートの設定を変更します。
例えば、トラック2とトラック5のミュート設定を変更したい場合は、 (1 &lt;&lt; 2) | (1 &lt;&lt; 5) すなわち、0x0024 とします。
</p>
<p>
<tt class="function">NNS_SndPlayerSetTrackMute</tt>関数で、ミュートを行うと、
発音中の音は即座に停止します。
即座に停止させたくない場合は、<tt class="function">NNS_SndPlayerSetTrackMuteEx</tt>関数を使います。
</p>
<p>
ミュート設定<em><strong><code>mute</code></strong></em>は、下記の値から選択します。
</p>
<div class="table"><a name="IDAKPAU"></a><p class="title"><b>表 . NNSSndSeqMute</b></p>
<table summary="NNSSndSeqMute" border="1">
<colgroup><col><col></colgroup>
<thead>
<tr>
<th>ラベル</th>
<th>説明</th>
</tr>
</thead>
<tbody>
<tr>
<td>NNS_SND_SEQ_MUTE_OFF</td>
<td>ミュート解除</td>
</tr>
<tr>
<td>NNS_SND_SEQ_MUTE_NO_STOP</td>
<td>発音中の音を止めずにミュート</td>
</tr>
<tr>
<td>NNS_SND_SEQ_MUTE_RELEASE</td>
<td>発音中の音をリリースしてミュート</td>
</tr>
<tr>
<td>NNS_SND_SEQ_MUTE_STOP</td>
<td>発音中の音を即座に止めてミュート</td>
</tr>
</tbody>
</table>
</div>
<div class="note">
<h3 class="title">注意</h3>
<p>
<tt class="function">NNS_SndPlayerSetTrackMuteEx</tt>関数は、SDKバージョン3.1以降で使用できます。
</p>
<p>
<tt class="function">NNS_SndPlayerSetTrackMute</tt>関数でトラックをミュート、
もしくは、<tt class="function">NNS_SndPlayerSetTrackMuteEx</tt>関数で<span class="symbol">NNS_SND_SEQ_MUTE_STOP</span>
指定した場合、
発音中の音は全て強制的に止められ、それ以降の発音は行われなくなります。
ミュートを解除すると、発音が行われるようになりますが、すぐに音が鳴り出すわけではありません。次のノートオンから鳴り始めることに注意してください。
</p>
<p>
シーケンスデータ中でも、ミュート設定をしていた場合は、
後から設定した方が有効になります。
</p>
</div>
</div>
<h2>参照</h2>
<p>なし。</p>
<h2>履歴</h2>
<p>2006/03/20 NNS_SndPlayerSetTrackMuteEx関数追加<br>2004/06/01 サウンドハンドルはシーケンスと結びつくように記述修正<br>2004/04/01 初版<br></p>
</div>
</body>
</html>