NNS_SndArcStrmPrepare

構文

#include <nnsys/snd.h>
BOOL NNS_SndArcStrmPrepare(
        NNSSndStrmHandle* handle,
        int strmNo,
        u32 offset );

引数

handle ストリームハンドルのポインタです。
strmNo ストリーム番号です。
offset 開始オフセット位置です。msec単位です。

返り値

成功した場合は、TRUEを返します。失敗すると、FALSEが返ります。

説明

ストリームの準備を行います。 プレイヤー番号などをプログラムから指定する場合は、 NNS_SndArcStrmPrepareEx関数または、 NNS_SndArcStrmPrepareEx2関数を使います。

あらかじめ、 NNS_SndArcStrmInit関数で、 サウンドアーカイブストリームライブラリが初期化されている必要があります。

ストリームハンドルhandleは、あらかじめ、NNS_SndStrmHandleInit関数で、1度だけ初期化しておかなければなりません。 この関数を呼びだすと、ストリームハンドルに既に結びつけられていたストリームは切り離されます(停止するわけではありません)。 関数に成功すると、ストリームハンドルにストリームが結びつけられます。

開始オフセット位置offsetに、0以外の値を入れると、ストリームデータの途中から再生することができます。

準備が完了したかどうかは、NNS_SndArcStrmIsPrepared関数で 調べることができます。 準備完了したストリームを再生するためには、 NNS_SndArcStrmStartPrepared関数を呼びだします。

ストリーム再生に使用するチャンネルは、この関数内で確保されます。確保するチャンネルがシーケンス再生で使用中だった場合、 発音中の音は強制的に止められます。 チャンネル確保のタイミングを制御したい場合は、前もって NNS_SndArcStrmAllocChannel関数を呼びだします。

ストリームデータがステレオだった場合、チャンネル0は左から、チャンネル1は右から出力されます。 この設定は、NNS_SndArcStrmSetChannelPan関数で変更することができます。

関数の失敗には、以下の原因が考えられます。

  • ストリーム番号が無効
  • 既に再生中のストリームよりも優先度が低い
  • ストリームプレイヤーが使用するチャンネルが別用途で使用中

参照

NNS_SndArcStrmPrepareEx, NNS_SndArcStrmPrepareEx2, NNS_SndArcStrmInit, NNS_SndStrmHandleInit, NNS_SndArcStrmIsPrepared, NNS_SndArcStrmStartPrepared, NNS_SndArcStrmAllocChannel, NNS_SndArcStrmSetChannelPan

履歴

2004/11/26 NNS_SndArcStrmPrepareEx関数の説明を分離
2004/10/05 NNS_SndArcStrmPrepareEx関数追加
2004/08/10 初版