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

116 lines
5.5 KiB
HTML
Executable File
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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_SndArcPlayerStartSeq*</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="IDAKKWT"></a><div class="titlepage">
<div></div>
<div></div>
</div>
<h1>NNS_SndArcPlayerStartSeq*</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">BOOL NNS_SndArcPlayerStartSeq( NNSSndHandle* <var>handle</var>, int <var>seqNo</var> );</code><br><code class="funcprototype">BOOL NNS_SndArcPlayerStartSeqEx(
NNSSndHandle* <var>handle</var>,
int <var>playerNo</var>,
int <var>bankNo</var>,
int <var>playerPrio</var>,
int <var>seqNo</var> );</code><br></pre></dd>
</dl>
<div class="refsection" lang="ja"><a name="IDAQNWT"></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>seqNo</code></strong></em></td>
<td>シーケンス番号です。</td>
</tr>
<tr>
<td><em><strong><code>playerNo</code></strong></em></td>
<td>プレイヤー番号です。</td>
</tr>
<tr>
<td><em><strong><code>bankNo</code></strong></em></td>
<td>バンク番号です。</td>
</tr>
<tr>
<td><em><strong><code>playerPrio</code></strong></em></td>
<td>プレイヤープライオリティです。値の範囲は0127で、大きいほど優先度が高くなります。</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsection" lang="ja"><a name="IDA1OWT"></a>
<h2>返り値</h2>
<p>再生に成功した場合は、TRUEを返します。失敗すると、FALSEが返ります。 </p>
</div>
<div class="refsection" lang="ja"><a name="IDACPWT"></a>
<h2>説明</h2>
<p>
シーケンスを再生します。
</p>
<p>
<tt class="function">NNS_SndArcPlayerStartSeq</tt>関数では、プレイヤー番号などのパラメータは、サウンドデータでの指定に基づいて設定されます。 <tt class="function">NNS_SndArcPlayerStartSeqEx</tt>関数を使うと、プレイヤー番号やバンク番号、プレイヤープライオリティをプログラム側で指定できます。ただし、 <em><strong><code>playerNo</code></strong></em><em><strong><code>bankNo</code></strong></em><em><strong><code>playerPrio</code></strong></em>の引数のうち、-1を指定したものは、サウンドデータで設定したパラメータが使用されます。
</p>
<p>
あらかじめ、
<tt class="function"><a href="NNS_SndArcInit.html">NNS_SndArcInit</a></tt>関数または、
<tt class="function"><a href="NNS_SndArcInitOnMemory.html">NNS_SndArcInitOnMemory</a></tt>関数で
サウンドアーカイブが初期化されている必要があります。
</p>
<p>
サウンドハンドル<em><strong><code>handle</code></strong></em>は、あらかじめ、<tt class="function"><a href="NNS_SndHandleInit.html">NNS_SndHandleInit</a></tt>関数で、1度だけ初期化しておかなければなりません。
この関数を呼びだすと、サウンドハンドルに既に結びつけられていたシーケンスは切り離されます(停止するわけではありません)。
再生に成功すると、サウンドハンドルにシーケンスが結びつけられます。
</p>
<p>
関数内では、必要なサウンドデータがメモリ上にあるかどうかを確認するために、
<tt class="function"><a href="NNS_SndArcGetFileAddress.html">NNS_SndArcGetFileAddress</a></tt>関数を呼びだします。
データがメモリ上にない場合、プレイヤーヒープへのロードを試みます。
プレイヤーヒープが無いまたは、十分なサイズで無い場合には、シーケンスの再生に失敗します。
</p>
<p>
後で<tt class="function"><a href="NNS_SndPlayerStopSeq.html">NNS_SndPlayerStopSeqBySeqNo</a></tt>関数を使って、
シーケンス番号を指定してシーケンスを停止できるように、
関数内で<tt class="function"><a href="NNS_SndPlayerSetSeqNo.html">NNS_SndPlayerSetSeqNo</a></tt>関数を呼びだしています。
</p>
<p>
サウンドデータで設定されている、発音プライオリティや音量の値を再設定したい場合は、シーケンス開始直後に、
<tt class="function"><a href="NNS_SndPlayerSetChannelPriority.html">NNS_SndPlayerSetChannelPriority</a></tt>関数や、
<tt class="function"><a href="NNS_SndPlayerSetInitialVolume.html">NNS_SndPlayerSetInitialVolume</a></tt>関数を呼びだします。
</p>
<p>
再生の失敗には、以下の原因が考えられます。
</p>
<div class="itemizedlist">
<ul type="disc">
<li>シーケンス番号が無効</li>
<li>既に再生中のシーケンスよりも優先度が低い</li>
<li>データがメモリ上に無いか、ロードに失敗した</li>
</ul>
</div>
</div>
<h2>参照</h2>
<p><a href="NNS_SndArcInit.html">NNS_SndArcInit</a>, <a href="NNS_SndArcInitOnMemory.html">NNS_SndArcInitOnMemory</a>, <a href="NNS_SndHandleInit.html">NNS_SndHandleInit</a>, <a href="NNS_SndArcGetFileAddress.html">NNS_SndArcGetFileAddress</a>, <a href="NNS_SndPlayerStopSeq.html">NNS_SndPlayerStopSeqBySeqNo</a>, <a href="NNS_SndPlayerSetSeqNo.html">NNS_SndPlayerSetSeqNo</a>, <a href="NNS_SndPlayerSetChannelPriority.html">NNS_SndPlayerSetChannelPriority</a>, <a href="NNS_SndPlayerSetInitialVolume.html">NNS_SndPlayerSetInitialVolume</a></p>
<h2>履歴</h2>
<p>2004/11/30 返り値の型が間違っていたのを修正<br>2004/06/01 NNS_SndArcPlayerStartSeqWithPlayerNoを拡張して、
NNS_SndArcPlayerStartSeqExに変更。
プレイヤーヒープに関する説明を追加。
<br>2004/04/19 NNS_SndArcPlayerStartSeq, NNS_SndArcPlayerStartSeqWithPlayerNoのマニュアルを統合<br>2004/04/01 初版<br></p>
</div>
</body>
</html>