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

107 lines
4.6 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_SndArcStrmPrepare</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_SndArcStrmPrepare</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_SndArcStrmPrepare(
NNSSndStrmHandle* <var>handle</var>,
int <var>strmNo</var>,
u32 <var>offset</var> );</code><br></pre></dd>
</dl>
<div class="refsection" lang="ja"><a name="IDAQMWT"></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>strmNo</code></strong></em></td>
<td>ストリーム番号です。</td>
</tr>
<tr>
<td><em><strong><code>offset</code></strong></em></td>
<td>開始オフセット位置です。msec単位です。</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="refsection" lang="ja"><a name="IDANNWT"></a>
<h2>返り値</h2>
<p>成功した場合は、TRUEを返します。失敗すると、FALSEが返ります。
</p>
</div>
<div class="refsection" lang="ja"><a name="IDAUNWT"></a>
<h2>説明</h2>
<p>
ストリームの準備を行います。
プレイヤー番号などをプログラムから指定する場合は、
<tt class="function"><a href="NNS_SndArcStrmPrepareEx.html">NNS_SndArcStrmPrepareEx</a></tt>関数または、
<tt class="function"><a href="NNS_SndArcStrmPrepareEx2.html">NNS_SndArcStrmPrepareEx2</a></tt>関数を使います。
</p>
<p>
あらかじめ、
<tt class="function"><a href="NNS_SndArcStrmInit.html">NNS_SndArcStrmInit</a></tt>関数で、
サウンドアーカイブストリームライブラリが初期化されている必要があります。
</p>
<p>
ストリームハンドル<em><strong><code>handle</code></strong></em>は、あらかじめ、<tt class="function"><a href="NNS_SndStrmHandleInit.html">NNS_SndStrmHandleInit</a></tt>関数で、1度だけ初期化しておかなければなりません。
この関数を呼びだすと、ストリームハンドルに既に結びつけられていたストリームは切り離されます(停止するわけではありません)。
関数に成功すると、ストリームハンドルにストリームが結びつけられます。
</p>
<p>
開始オフセット位置<em><strong><code>offset</code></strong></em>に、0以外の値を入れると、ストリームデータの途中から再生することができます。
</p>
<p>
準備が完了したかどうかは、<tt class="function"><a href="NNS_SndArcStrmIsPrepared.html">NNS_SndArcStrmIsPrepared</a></tt>関数で
調べることができます。
準備完了したストリームを再生するためには、
<tt class="function"><a href="NNS_SndArcStrmStartPrepared.html">NNS_SndArcStrmStartPrepared</a></tt>関数を呼びだします。
</p>
<p>
ストリーム再生に使用するチャンネルは、この関数内で確保されます。確保するチャンネルがシーケンス再生で使用中だった場合、
発音中の音は強制的に止められます。
チャンネル確保のタイミングを制御したい場合は、前もって
<tt class="function"><a href="NNS_SndArcStrmAllocChannel.html">NNS_SndArcStrmAllocChannel</a></tt>関数を呼びだします。
</p>
<p>
ストリームデータがステレオだった場合、チャンネル0は左から、チャンネル1は右から出力されます。
この設定は、<tt class="function"><a href="NNS_SndArcStrmSetChannelPan.html">NNS_SndArcStrmSetChannelPan</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_SndArcStrmPrepareEx.html">NNS_SndArcStrmPrepareEx</a>, <a href="NNS_SndArcStrmPrepareEx2.html">NNS_SndArcStrmPrepareEx2</a>, <a href="NNS_SndArcStrmInit.html">NNS_SndArcStrmInit</a>, <a href="NNS_SndStrmHandleInit.html">NNS_SndStrmHandleInit</a>, <a href="NNS_SndArcStrmIsPrepared.html">NNS_SndArcStrmIsPrepared</a>, <a href="NNS_SndArcStrmStartPrepared.html">NNS_SndArcStrmStartPrepared</a>, <a href="NNS_SndArcStrmAllocChannel.html">NNS_SndArcStrmAllocChannel</a>, <a href="NNS_SndArcStrmSetChannelPan.html">NNS_SndArcStrmSetChannelPan</a></p>
<h2>履歴</h2>
<p>2004/11/26 NNS_SndArcStrmPrepareEx関数の説明を分離<br>2004/10/05 NNS_SndArcStrmPrepareEx関数追加<br>2004/08/10 初版<br></p>
</div>
</body>
</html>