グループ制限なし

説明:

ボイスリミットグループによる制限を解除するための定数です。
criAtomExPlayer_SetGroupNumber 関数に対してこの値を指定すると、 指定されたプレーヤはボイスリミットグループによる制限を受けなくなります。
（空きボイスがあるか、または自身より低プライオリティのボイスがあれば、 ボイスリミットグループに関係なくボイスを取得します。）

参照:

criAtomExPlayer_SetGroupNumber

ループ回数制御用

説明:ループ回数制限なし

プレーヤに指定可能な最大ASRラック数

説明:

1つのプレーヤに対して指定可能なASRラックの最大数です。

参照:

criAtomExPlayer_SetAsrRackIdArray

{\
    (p_config)->voice_allocation_method = CRIATOMEX_ALLOCATE_VOICE_ONCE;\
    (p_config)->max_path_strings = 1;\
    (p_config)->max_path = 0;\
    (p_config)->updates_time = CRI_TRUE;\
    (p_config)->enable_audio_synced_timer = CRI_FALSE;\
    (p_config)->max_aisacs = 8;\
}

プレーヤ作成用コンフィグ構造体にデフォルト値をセット

引数:

[out]

p_config

AtomExプレーヤ作成用コンフィグ構造体へのポインタ

説明:

criAtomExPlayer_Create 関数に設定するコンフィグ構造体 （ CriAtomExPlayerConfig ）に、デフォルトの値をセットします。

参照:

CriAtomExPlayerConfig, criAtomExPlayer_Create

波形フィルタコールバック関数

説明:

引数:

[in]	obj	ユーザ指定オブジェクト
[in]	format	PCMの形式
[in]	num_channels	チャンネル数
[in]	num_samples	サンプル数
[in,out]	data	PCMデータのチャンネル配列

戻り値:

なし

説明:

バスに登録することができる PCM データを受け取るコールバック関数です。

コールバック関数の登録には criAtomExAsr_SetBusFilterCallback 関数を使用します。
コールバック関数を登録すると、サウンドレンダラが音声処理を行う度に、 コールバック関数が実行されるようになります。

フィルタコールバック関数には、 PCM データのフォーマットやチャンネル数、 参照可能なサンプル数、 PCM データを格納した領域のアドレスが返されます。
コールバック内では PCM データの値を直接参照可能になるので、 再生中の音声の振幅をチェックするといった用途に利用可能です。

また、コールバック関数内で PCM データを加工すると、再生音に反映されるため、 PCM データに対してユーザ独自のエフェクトをかけることも可能です。
（ただし、タイムストレッチ処理のようなデータ量が増減する加工を行うことはできません。）

備考:

PCM データはチャンネル単位で分離されています。
（インターリーブされていません。）
サンプル数は32の倍数で、下限は32、上限は256となります。
また、サンプル数はプラットフォームデバイスの出力の進捗に応じて変化します。
第 6 引数（ data 配列）には、各チャンネルの PCM データ配列の先頭アドレスが格納されています。
（二次元配列の先頭アドレスではなく、チャンネルごとの PCM データ配列の先頭アドレスを格納した 一次元のポインタ配列です。）
格納されてくる PCM データはバスに設定されているエフェクトの処理後の音声です。

プラットフォームによって、 PCM データのフォーマットは異なります。
実行環境のデータフォーマットについては、第 3 引数（ format ）で判別可能です。
PCM データのフォーマットが 16 bit 整数型の場合、 format は CRIATOM_PCM_FORMAT_SINT16 となり、 PCM データのフォーマットが 32 bit 浮動小数点数型の場合、 format は CRIATOM_PCM_FORMAT_FLOAT32 となります。
それぞれのケースで PCM データの値域は異なりますのでご注意ください。

• CRIATOM_PCM_FORMAT_SINT16 時は -32768 〜 +32767
• CRIATOM_PCM_FORMAT_FLOAT32 時は -1.0f 〜 +1.0f

（多重音声のミキシングや前段のエフェクトによっては上記範囲を超えた値が出る可能性があります。）

注意:

本コールバック関数内で、AtomライブラリのAPIを実行しないでください。
コールバック関数はAtomライブラリ内のサーバ処理から実行されます。
そのため、サーバ処理への割り込みを考慮しないAPIを実行した場合、 エラーが発生したり、デッドロックが発生する可能性があります。

コールバック関数内で長時間処理をブロックすると、音切れ等の問題が発生する可能性があります。

参照:

criAtomExAsr_SetBusFilterCallback

ボイス確保方式

説明:

AtomEx プレーヤがボイスを確保する際の動作仕様を指定するためのデータ型です。
AtomEx プレーヤを作成する際、 CriAtomExPlayerConfig 構造体のメンバに指定します。

参照:

CriAtomExPlayerConfig, criAtomExPlayer_Create

プレーヤ作成用コンフィグ構造体

説明:

AtomExプレーヤを作成する際に、動作仕様を指定するための構造体です。
criAtomExPlayer_Create 関数の引数に指定します。

作成されるプレーヤは、ハンドル作成時に本構造体で指定された設定に応じて、 内部リソースを必要なだけ確保します。
プレーヤが必要とするワーク領域のサイズは、本構造体で指定されたパラメータに応じて変化します。

注意:

将来的にメンバが増える可能性があるため、 criAtomExPlayer_SetDefaultConfig マクロを使用しない場合には、使用前に必ず構造体をゼロクリアしてください。
（構造体のメンバに不定値が入らないようご注意ください。）

参照:

criAtomExPlayer_Create, criAtomExPlayer_SetDefaultConfig

プレーヤハンドル

説明:

CriAtomExPlayerHn は、音声再生用に作られたプレーヤを操作するためのハンドルです。
criAtomExPlayer_Create 関数で音声再生用のプレーヤを作成すると、 関数はプレーヤ操作用に、この"AtomExプレーヤハンドル"を返します。
データのセットや再生の開始、ステータスの取得等、プレーヤに対して行う操作は、 全てAtomExプレーヤハンドルを介して実行されます。

参照:

criAtomExPlayer_Create

プレーヤステータス

説明:

AtomExプレーヤの再生状態を示す値です。
criAtomExPlayer_GetStatus 関数で取得可能です。

再生状態は、通常以下の順序で遷移します。

1. CRIATOMEXPLAYER_STATUS_STOP
2. CRIATOMEXPLAYER_STATUS_PREP
3. CRIATOMEXPLAYER_STATUS_PLAYING
4. CRIATOMEXPLAYER_STATUS_PLAYEND

AtomExプレーヤ作成直後の状態は、停止状態（ CRIATOMEXPLAYER_STATUS_STOP ）です。
criAtomExPlayer_SetData 関数等でデータをセットし、 criAtomExPlayer_Start 関数を 実行すると、再生準備状態（ CRIATOMEXPLAYER_STATUS_PREP ）に遷移し、再生準備を始めます。
データが充分供給され、再生準備が整うと、ステータスは再生中（ CRIATOMEXPLAYER_STATUS_PLAYING ） に変わり、音声の出力が開始されます。
セットされたデータを全て再生し終えた時点で、ステータスは再生完了 （ CRIATOMEXPLAYER_STATUS_PLAYEND ）に変わります。

備考

AtomExプレーヤは、Atomプレーヤと異なり、1つのプレーヤで複数音の再生が可能です。
そのため、再生中のAtomExプレーヤに対して criAtomExPlayer_Start 関数を実行すると、 2つの音が重なって再生されます。
再生中に criAtomExPlayer_Stop 関数を実行した場合、AtomExプレーヤで再生中の全ての音声 が停止し、ステータスは CRIATOMEXPLAYER_STATUS_STOP に戻ります。
（ criAtomExPlayer_Stop 関数の呼び出しタイミングによっては、 CRIATOMEXPLAYER_STATUS_STOP に遷移するまでに時間がかかる場合があります。）

1つのAtomExプレーヤで複数回 criAtomExPlayer_Start 関数を実行した場合、 1つでも再生準備中の音があれば、ステータスは CRIATOMEXPLAYER_STATUS_PREP 状態になります。
（全ての音声が再生中の状態になるまで、ステータスは CRIATOMEXPLAYER_STATUS_PLAYING 状態に 遷移しません。）
また、 CRIATOMEXPLAYER_STATUS_PLAYING 状態のプレーヤに対し、再度 criAtomExPlayer_Start 関数を実行した場合、ステータスは一時的に CRIATOMEXPLAYER_STATUS_PREP に戻ります。

再生中に不正なデータを読み込んだ場合や、ファイルアクセスに失敗した場合、 ステータスは CRIATOMEXPLAYER_STATUS_ERROR に遷移します。
複数の音声を再生中にある音声でエラーが発生した場合、プレーヤのステータスは 他の音声の状態に関係なく、 CRIATOMEXPLAYER_STATUS_ERROR に遷移します。

参照:

criAtomExPlayer_GetStatus, criAtomExPlayer_SetData, criAtomExPlayer_Start, criAtomExPlayer_Stop

ボイス制御方式

説明:

AtomExプレーヤで再生する音声の発音制御方法を指定するためのデータ型です。
criAtomExPlayer_SetVoiceControlMethod 関数で利用します。

参照:

criAtomExPlayer_SetVoiceControlMethod

スピーカーID

説明:

音声を出力するスピーカーを指定するためのIDです。
criAtomExPlayer_SetSendLevel 関数で利用します。

参照:

criAtomExPlayer_SetSendLevel

再生ID

説明:

criAtomExPlayer_Start 関数実行時に返されるIDです。
プレーヤ単位ではなく、 criAtomExPlayer_Start 関数で再生した個々の音声に対して パラメータ変更や状態取得を行いたい場合、本IDを使用して制御を行う必要があります。
無効な再生IDは::CRIATOMEX_INVALID_PLAYBACK_IDです。

参照:

criAtomExPlayer_Start, criAtomExPlayback_GetStatus, CRIATOMEX_INVALID_PLAYBACK_ID

データ要求コールバック関数

説明:

引数:

[in]	obj	ユーザ指定オブジェクト
[in]	id	再生ID
[in]	player	Atomプレーヤハンドル

戻り値:

なし

説明:

次に再生するデータを指定するためのコールバック関数です。
複数の音声データをシームレスに連結して再生する際に使用します。

コールバック関数の登録には criAtomExPlayer_SetDataRequestCallback 関数を使用します。
登録したコールバック関数は、ボイスが内部的に使用している Atom プレーヤが 連結再生用のデータを要求するタイミングで実行されます。
（前回のデータを読み込み終えて、次に再生すべきデータを要求するタイミングで コールバック関数が実行されます。）

コールバック関数内で criAtomPlayer_SetData 関数等を用いて Atom プレーヤにデータをセットすると、 セットされたデータは現在再生中のデータに続いてシームレスに連結されて再生されます。
また、本関数内で criAtomPlayer_SetPreviousDataAgain 関数を実行することで、 同一データを繰り返し再生し続けることも可能です。

備考:

本関数内でデータを指定しなかった場合、現在のデータを再生し終えた時点で、 AtomEx プレーヤのステータスが CRIATOMEXPLAYER_STATUS_PLAYEND に遷移します。

タイミング等の問題により、データを指定することができないが、ステータスを CRIATOMEXPLAYER_STATUS_PLAYEND に遷移させたくない場合には、コールバック関数内で criAtomPlayer_DeferCallback 関数を実行してください。
criAtomPlayer_DeferCallback 関数を実行することで、約1V後に再度データ要求 コールバック関数が呼び出されます。（コールバック処理をリトライ可能。）
ただし、 criAtomPlayer_DeferCallback 関数を実行した場合、再生が途切れる （連結箇所に一定時間無音が入る）可能性があります。

注意:

本コールバックの第 3 引数（ player ）は、 AtomEx プレーヤではなく、 下位レイヤの Atom プレーヤです。
（ AtomExPlayerHn にキャストすると、アクセス違反等の重大な不具合が発生します。）

複数の波形データを含むキューを再生した場合、 最初に見つかった波形データの再生が終了するタイミングでコールバック関数が実行されます。
そのため、複数の波形データを含むキューに対して連結再生の操作を行った場合、 意図としない組み合わせで波形が連結再生される可能性があります。
本機能を使用する際には、 1 つの波形データのみを含むキューを再生するか、 またはファイルやオンメモリデータ等を再生してください。

現状、コールバックは波形データを再生し始めたボイスに対してのみ割り当てられます。
そのため、波形データ再生後にボイスがバーチャル化した場合、コールバックは実行されません。
（データ終端に到達した時点で、コールバックが実行されずにPLAYEND状態に遷移します。）

本コールバック関数内で、シームレス連結再生以外の制御を行わないでください。
コールバック関数はAtomライブラリ内のサーバ処理から実行されます。
そのため、サーバ処理への割り込みを考慮しないAPIを実行した場合、 エラーが発生したり、デッドロックが発生する可能性があります。

コールバック関数内で実行可能なAPIは、以下のとおりです。

• criAtomExAcb_GetWaveformInfoById（引数のNULL指定は不可）
• criAtomExAcb_GetWaveformInfoByName（引数のNULL指定は不可）
• criAtomExAcb_GetOnMemoryAwbHandle
• criAtomExAcb_GetStreamingAwbHandle
• criAtomPlayer_SetData
• criAtomPlayer_SetFile
• criAtomPlayer_SetContentId
• criAtomPlayer_SetWaveId
• criAtomPlayer_SetPreviousDataAgain
• criAtomPlayer_DeferCallback

本コールバック関数内で長時間処理をブロックすると、音切れ等の問題が発生しますので、 ご注意ください。

参照:

criAtomExPlayer_SetDataRequestCallback, criAtomPlayer_SetData, criAtomPlayer_SetPreviousDataAgain, criAtomPlayer_DeferCallback

波形フィルタコールバック関数

説明:

引数:

[in]	obj	ユーザ指定オブジェクト
[in]	id	再生ID
[in]	format	PCMの形式
[in]	num_channels	チャンネル数
[in]	num_samples	サンプル数
[in,out]	data	PCMデータのチャンネル配列

戻り値:

なし

説明:

デコード結果の PCM データを受け取るコールバック関数です。

コールバック関数の登録には criAtomExPlayer_SetFilterCallback 関数を使用します。
コールバック関数を登録すると、ボイスが音声データをデコードする度に、 コールバック関数が実行されるようになります。

フィルタコールバック関数には、 PCM データのフォーマットやチャンネル数、 参照可能なサンプル数、 PCM データを格納した領域のアドレスが返されます。
コールバック内では PCM データの値を直接参照可能になるので、 再生中の音声の振幅をチェックするといった用途に利用可能です。

また、コールバック関数内で PCM データを加工すると、再生音に反映されるため、 PCM データに対してユーザ独自のエフェクトをかけることも可能です。
（ただし、タイムストレッチ処理のようなデータ量が増減する加工を行うことはできません。）

備考:

PCM データはチャンネル単位で分離されています。
（インターリーブされていません。）
第 6 引数（ data 配列）には、各チャンネルの PCM データ配列の先頭アドレスが格納されています。
（二次元配列の先頭アドレスではなく、チャンネルごとの PCM データ配列の先頭アドレスを格納した 一次元のポインタ配列です。）

プラットフォームによって、 PCM データのフォーマットは異なります。
実行環境のデータフォーマットについては、第 3 引数（ format ）で判別可能です。
PCM データのフォーマットが 16 bit 整数型の場合、 format は CRIATOM_PCM_FORMAT_SINT16 となり、 PCM データのフォーマットが 32 bit 浮動小数点数型の場合、 format は CRIATOM_PCM_FORMAT_FLOAT32 となります。
それぞれのケースで PCM データの値域は異なりますのでご注意ください。

• CRIATOM_PCM_FORMAT_SINT16 時は -32768 〜 +32767
• CRIATOM_PCM_FORMAT_FLOAT32 時は -1.0f 〜 +1.0f

（デコード時点ではクリッピングが行われていないため、 CRIATOM_PCM_FORMAT_FLOAT32 時は上記範囲をわずかに超えた値が出る可能性があります。）

注意:

本コールバック関数内で、AtomライブラリのAPIを実行しないでください。
コールバック関数はAtomライブラリ内のサーバ処理から実行されます。
そのため、サーバ処理への割り込みを考慮しないAPIを実行した場合、 エラーが発生したり、デッドロックが発生する可能性があります。

コールバック関数内で長時間処理をブロックすると、音切れ等の問題が発生する可能性があります。

参照:

criAtomExPlayer_SetFilterCallback

ブロックトランジションコールバック関数

説明:

引数:

[in]	obj	ユーザ指定オブジェクト
[in]	id	再生ID
[in]	index	キュー内のブロックインデックス値

戻り値:

なし

説明:

ブロックシーケンス再生時にブロックトランジションが発生したときに呼び出されるコールバック関数です。

コールバック関数の登録には criAtomExPlayer_SetBlockTransitionCallback 関数を使用します。
コールバック関数を登録すると、ブロックトランジションが発生する度に、 コールバック関数が実行されるようになります。

注意:

本コールバック関数内で、AtomライブラリのAPIを実行しないでください。
コールバック関数はAtomライブラリ内のサーバ処理から実行されます。
そのため、サーバ処理への割り込みを考慮しないAPIを実行した場合、 エラーが発生したり、デッドロックが発生する可能性があります。

コールバック関数内で長時間処理をブロックすると、音切れ等の問題が発生する可能性があります。

参照:

criAtomExPlayer_SetBlockTransitionCallback

再生トラック情報取得コールバック関数

説明:

引数:

[in]	obj	ユーザ指定オブジェクト
[in]	index	再生トラック情報

戻り値:

なし

説明:

ポリフォニックタイプ、トラック遷移タイプ以外のキュー再生時に再生したトラック情報を通知するコールバック関数です。

コールバック関数の登録には criAtomExPlayer_SetPlaybackTrackInfoNotificationCallback 関数を使用します。

注意:

本コールバック関数内で、AtomライブラリのAPIを実行しないでください。
コールバック関数はAtomライブラリ内のサーバ処理から実行されます。
そのため、サーバ処理への割り込みを考慮しないAPIを実行した場合、 エラーが発生したり、デッドロックが発生する可能性があります。

コールバック関数内で長時間処理をブロックすると、音切れ等の問題が発生する可能性があります。

参照:

criAtomExPlayer_SetPlaybackTrackInfoNotificationCallback

パラメータID

説明:

パラメータを指定するためのIDです。
criAtomExPlayer_GetParameterFloat32 関数等で利用します。

参照:

criAtomExPlayer_GetParameterFloat32, criAtomExPlayer_GetParameterSint32, criAtomExPlayer_GetParameterUint32

ボイス確保方式

説明:

AtomEx プレーヤがボイスを確保する際の動作仕様を指定するためのデータ型です。
AtomEx プレーヤを作成する際、 CriAtomExPlayerConfig 構造体のメンバに指定します。

参照:

CriAtomExPlayerConfig, criAtomExPlayer_Create

列挙型の値:

CRIATOMEX_ALLOCATE_VOICE_ONCE	ボイスの確保は1回限り
CRIATOMEX_RETRY_VOICE_ALLOCATION	ボイスを繰り返し確保する

プレーヤステータス

説明:

AtomExプレーヤの再生状態を示す値です。
criAtomExPlayer_GetStatus 関数で取得可能です。

再生状態は、通常以下の順序で遷移します。

1. CRIATOMEXPLAYER_STATUS_STOP
2. CRIATOMEXPLAYER_STATUS_PREP
3. CRIATOMEXPLAYER_STATUS_PLAYING
4. CRIATOMEXPLAYER_STATUS_PLAYEND

AtomExプレーヤ作成直後の状態は、停止状態（ CRIATOMEXPLAYER_STATUS_STOP ）です。
criAtomExPlayer_SetData 関数等でデータをセットし、 criAtomExPlayer_Start 関数を 実行すると、再生準備状態（ CRIATOMEXPLAYER_STATUS_PREP ）に遷移し、再生準備を始めます。
データが充分供給され、再生準備が整うと、ステータスは再生中（ CRIATOMEXPLAYER_STATUS_PLAYING ） に変わり、音声の出力が開始されます。
セットされたデータを全て再生し終えた時点で、ステータスは再生完了 （ CRIATOMEXPLAYER_STATUS_PLAYEND ）に変わります。

備考

AtomExプレーヤは、Atomプレーヤと異なり、1つのプレーヤで複数音の再生が可能です。
そのため、再生中のAtomExプレーヤに対して criAtomExPlayer_Start 関数を実行すると、 2つの音が重なって再生されます。
再生中に criAtomExPlayer_Stop 関数を実行した場合、AtomExプレーヤで再生中の全ての音声 が停止し、ステータスは CRIATOMEXPLAYER_STATUS_STOP に戻ります。
（ criAtomExPlayer_Stop 関数の呼び出しタイミングによっては、 CRIATOMEXPLAYER_STATUS_STOP に遷移するまでに時間がかかる場合があります。）

1つのAtomExプレーヤで複数回 criAtomExPlayer_Start 関数を実行した場合、 1つでも再生準備中の音があれば、ステータスは CRIATOMEXPLAYER_STATUS_PREP 状態になります。
（全ての音声が再生中の状態になるまで、ステータスは CRIATOMEXPLAYER_STATUS_PLAYING 状態に 遷移しません。）
また、 CRIATOMEXPLAYER_STATUS_PLAYING 状態のプレーヤに対し、再度 criAtomExPlayer_Start 関数を実行した場合、ステータスは一時的に CRIATOMEXPLAYER_STATUS_PREP に戻ります。

再生中に不正なデータを読み込んだ場合や、ファイルアクセスに失敗した場合、 ステータスは CRIATOMEXPLAYER_STATUS_ERROR に遷移します。
複数の音声を再生中にある音声でエラーが発生した場合、プレーヤのステータスは 他の音声の状態に関係なく、 CRIATOMEXPLAYER_STATUS_ERROR に遷移します。

参照:

criAtomExPlayer_GetStatus, criAtomExPlayer_SetData, criAtomExPlayer_Start, criAtomExPlayer_Stop

列挙型の値:

CRIATOMEXPLAYER_STATUS_STOP	停止中
CRIATOMEXPLAYER_STATUS_PREP	再生準備中
CRIATOMEXPLAYER_STATUS_PLAYING	再生中
CRIATOMEXPLAYER_STATUS_PLAYEND	再生完了
CRIATOMEXPLAYER_STATUS_ERROR	エラーが発生

ボイス制御方式

説明:

AtomExプレーヤで再生する音声の発音制御方法を指定するためのデータ型です。
criAtomExPlayer_SetVoiceControlMethod 関数で利用します。

参照:

criAtomExPlayer_SetVoiceControlMethod

列挙型の値:

CRIATOMEX_PREFER_LAST	後着優先
CRIATOMEX_PREFER_FIRST	先着優先
CRIATOMEX_PREFER_DATA	データ設定優先

スピーカーID

説明:

音声を出力するスピーカーを指定するためのIDです。
criAtomExPlayer_SetSendLevel 関数で利用します。

参照:

criAtomExPlayer_SetSendLevel

列挙型の値:

CRIATOMEX_SPEAKER_FRONT_LEFT	フロントレフトスピーカー
CRIATOMEX_SPEAKER_FRONT_RIGHT	フロントライトスピーカー
CRIATOMEX_SPEAKER_FRONT_CENTER	フロントセンタースピーカー
CRIATOMEX_SPEAKER_LOW_FREQUENCY	LFE（≒サブウーハー）
CRIATOMEX_SPEAKER_SURROUND_LEFT	サラウンドレフトスピーカー
CRIATOMEX_SPEAKER_SURROUND_RIGHT	サラウンドライトスピーカー
CRIATOMEX_SPEAKER_SURROUND_BACK_LEFT	サラウンドバックレフトスピーカー
CRIATOMEX_SPEAKER_SURROUND_BACK_RIGHT	サラウンドバックライトスピーカー

パラメータID

説明:

パラメータを指定するためのIDです。
criAtomExPlayer_GetParameterFloat32 関数等で利用します。

参照:

criAtomExPlayer_GetParameterFloat32, criAtomExPlayer_GetParameterSint32, criAtomExPlayer_GetParameterUint32

列挙型の値:

CRIATOMEX_PARAMETER_ID_VOLUME	ボリューム
CRIATOMEX_PARAMETER_ID_PITCH	ピッチ
CRIATOMEX_PARAMETER_ID_PAN3D_ANGLE	パンニング3D角度
CRIATOMEX_PARAMETER_ID_PAN3D_DISTANCE	パンニング3D距離
CRIATOMEX_PARAMETER_ID_PAN3D_VOLUME	パンニング3Dボリューム
CRIATOMEX_PARAMETER_ID_PAN_TYPE	パンタイプ
CRIATOMEX_PARAMETER_ID_PAN_SPEAKER_TYPE	パンスピーカータイプ
CRIATOMEX_PARAMETER_ID_PAN_CH0	2Dパン（チャンネル0）
CRIATOMEX_PARAMETER_ID_PAN_CH1	2Dパン（チャンネル1）
CRIATOMEX_PARAMETER_ID_BUS_SEND_LEVEL_0	バスセンドレベル0
CRIATOMEX_PARAMETER_ID_BUS_SEND_LEVEL_1	バスセンドレベル1
CRIATOMEX_PARAMETER_ID_BUS_SEND_LEVEL_2	バスセンドレベル2
CRIATOMEX_PARAMETER_ID_BUS_SEND_LEVEL_3	バスセンドレベル3
CRIATOMEX_PARAMETER_ID_BUS_SEND_LEVEL_4	バスセンドレベル4
CRIATOMEX_PARAMETER_ID_BUS_SEND_LEVEL_5	バスセンドレベル5
CRIATOMEX_PARAMETER_ID_BUS_SEND_LEVEL_6	バスセンドレベル6
CRIATOMEX_PARAMETER_ID_BUS_SEND_LEVEL_7	バスセンドレベル7
CRIATOMEX_PARAMETER_ID_BANDPASS_FILTER_COF_LOW	バンドパスフィルタの低域カットオフ周波数
CRIATOMEX_PARAMETER_ID_BANDPASS_FILTER_COF_HIGH	バンドパスフィルタの高域カットオフ周波数
CRIATOMEX_PARAMETER_ID_BIQUAD_FILTER_TYPE	バイクアッドフィルタのフィルタタイプ
CRIATOMEX_PARAMETER_ID_BIQUAD_FILTER_FREQ	バイクアッドフィルタの周波数
CRIATOMEX_PARAMETER_ID_BIQUAD_FILTER_Q	バイクアッドフィルタのQ値
CRIATOMEX_PARAMETER_ID_BIQUAD_FILTER_GAIN	バイクアッドフィルタのゲイン
CRIATOMEX_PARAMETER_ID_ENVELOPE_ATTACK_TIME	エンベロープのアタックタイム
CRIATOMEX_PARAMETER_ID_ENVELOPE_HOLD_TIME	エンベロープのホールドタイム
CRIATOMEX_PARAMETER_ID_ENVELOPE_DECAY_TIME	エンベロープのディケイタイム
CRIATOMEX_PARAMETER_ID_ENVELOPE_RELEASE_TIME	エンベロープのリリースタイム
CRIATOMEX_PARAMETER_ID_ENVELOPE_SUSTAIN_LEVEL	エンベロープのサスティンレベル
CRIATOMEX_PARAMETER_ID_START_TIME	再生開始位置
CRIATOMEX_PARAMETER_ID_PRIORITY	ボイスプライオリティ
CRIATOMEX_PARAMETER_ID_SILENT_MODE	無音時処理モード
CRIATOMEX_PARAMETER_ID_DSP_PARAMETER_0	インサーションDSPのパラメータ0
CRIATOMEX_PARAMETER_ID_DSP_PARAMETER_1	インサーションDSPのパラメータ1
CRIATOMEX_PARAMETER_ID_DSP_PARAMETER_2	インサーションDSPのパラメータ2
CRIATOMEX_PARAMETER_ID_DSP_PARAMETER_3	インサーションDSPのパラメータ3
CRIATOMEX_PARAMETER_ID_DSP_PARAMETER_4	インサーションDSPのパラメータ4
CRIATOMEX_PARAMETER_ID_DSP_PARAMETER_5	インサーションDSPのパラメータ5
CRIATOMEX_PARAMETER_ID_DSP_PARAMETER_6	インサーションDSPのパラメータ6
CRIATOMEX_PARAMETER_ID_DSP_PARAMETER_7	インサーションDSPのパラメータ7

AtomExPlayer用ワーク領域サイズの計算

引数:

[in]

config

プレーヤ作成用コンフィグ構造体

戻り値:

CriSint32 ワーク領域サイズ

戻り値:

0以上	正常に処理が完了
-1	エラーが発生

説明:

AtomExプレーヤを作成するために必要な、ワーク領域のサイズを取得します。
アロケータを登録せずにAtomExプレーヤを作成する場合、 あらかじめ本関数で計算したワーク領域サイズ分のメモリを ワーク領域として criAtomExPlayer_Create 関数にセットする必要があります。

プレーヤの作成に必要なワークメモリのサイズは、プレーヤ作成用コンフィグ 構造体（ CriAtomExPlayerConfig ）の内容によって変化します。

引数にNULLを指定した場合、デフォルト設定 （ criAtomExPlayer_SetDefaultConfig 適用時と同じパラメータ）で ワーク領域サイズを計算します。
ワーク領域サイズ計算時に失敗した場合、戻り値は -1 になります。
ワーク領域サイズの計算に失敗した理由については、エラーコールバックの メッセージで確認可能です。

備考:

引数 config の情報は、関数内でのみ参照されます。
関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。

注意:

本関数を実行する前に、ライブラリを初期化しておく必要があります。

参照:

CriAtomExPlayerConfig, criAtomExPlayer_Create

AtomExPlayerの作成

引数:

[in]	config	AtomExプレーヤ作成用コンフィグ構造体
[in]	work	ワーク領域
[in]	work_size	ワーク領域サイズ

戻り値:

CriAtomExPlayerHn AtomExプレーヤハンドル

説明:

AtomExプレーヤを作成します。

プレーヤを作成する際には、ライブラリが内部で利用するためのメモリ領域（ワーク領域） を確保する必要があります。
ワーク領域を確保する方法には、以下の2通りの方法があります。
(a) User Allocator方式：メモリの確保／解放に、ユーザが用意した関数を使用する方法。
(b) Fixed Memory方式：必要なメモリ領域を直接ライブラリに渡す方法。

User Allocator方式を用いる場合、ユーザがワーク領域を用意する必要はありません。
workにNULL、work_sizeに0を指定するだけで、必要なメモリを登録済みのメモリ確保関数から確保します。
AtomExプレーヤ作成時に確保されたメモリは、AtomExプレーヤ破棄時（ criAtomExPlayer_Destroy 関数実行時）に解放されます。

Fixed Memory方式を用いる場合、ワーク領域として別途確保済みのメモリ領域を本関数に 設定する必要があります。
ワーク領域のサイズは criAtomExPlayer_CalculateWorkSize 関数で取得可能です。
AtomExプレーヤ作成前に criAtomExPlayer_CalculateWorkSize 関数で取得した サイズ分のメモリを予め確保しておき、本関数に設定してください。
尚、Fixed Memory方式を用いた場合、ワーク領域はAtomExプレーヤの破棄 （ criAtomExPlayer_Destroy 関数）を行なうまでの間、ライブラリ内で利用され続けます。
AtomExプレーヤの破棄を行なう前に、ワーク領域のメモリを解放しないでください。

例:

【User Allocator方式によるAtomExプレーヤの作成】
User Allocator方式を用いる場合、AtomExプレーヤの作成／破棄の手順は以下のようになります。

1. AtomExプレーヤ作成前に、 criAtomEx_SetUserAllocator 関数を用いてメモリ確保／解放関数を登録する。
   
2. AtomExプレーヤ作成用コンフィグ構造体にパラメータをセットする。
   
3. criAtomExPlayer_Create 関数でAtomExプレーヤを作成する。
   （workにはNULL、work_sizeには0を指定する。）
   
4. ハンドルが不要になったら criAtomExPlayer_Destroy 関数でAtomExプレーヤを破棄する。
   

具体的なコードは以下のとおりです。

 // 独自のメモリ確保関数
 void *user_malloc(void *obj, CriUint32 size)
 {
    void *mem;

    // メモリの確保
    mem = malloc(size);

    return (mem);
 }

 // 独自のメモリ解放関数を用意
 void user_free(void *obj, void *mem)
 {
    // メモリの解放
    free(mem);

    return;
 }

 main()
 {
    CriAtomExPlayerConfig config;   // AtomExプレーヤ作成用コンフィグ構造体
    CriAtomExPlayerHn player;       // AtomExプレーヤハンドル
        :
    // 独自のメモリアロケータを登録
    criAtomEx_SetUserAllocator(user_malloc, user_free, NULL);

    // AtomExプレーヤ作成用コンフィグ構造体を設定
    criAtomExPlayer_SetDefaultConfig(&config);

    // AtomExプレーヤの作成
    // ワーク領域にはNULLと0を指定する。
    // →必要なメモリは、登録したメモリ確保関数を使って確保される。
    player = criAtomExPlayer_Create(&config, NULL, 0);
        :
    // 音声再生処理
        :
    // AtomExプレーヤが不要になった時点で破棄
    // →AtomExプレーヤ作成時にライブラリ内で確保されたメモリが解放される。
    criAtomExPlayer_Destroy(player);
        :
 }

※ライブラリ初期化時にメモリ確保／解放関数を登録済みの場合、AtomExプレーヤ作成時 に再度関数を登録する必要はありません。

【Fixed Memory方式によるAtomExプレーヤの作成】
Fixed Memory方式を用いる場合、AtomExプレーヤの作成／破棄の手順は以下のようになります。

1. AtomExプレーヤ作成用コンフィグ構造体にパラメータをセットする。
   
2. AtomExプレーヤの作成に必要なワーク領域のサイズを、 criAtomExPlayer_CalculateWorkSize 関数を使って計算する。
   
3. ワーク領域サイズ分のメモリを確保する。
   
4. criAtomExPlayer_Create 関数でAtomExプレーヤを作成する。
   （workには確保したメモリのアドレスを、work_sizeにはワーク領域のサイズを指定する。）
   
5. ハンドルが不要になったら criAtomExPlayer_Destroy 関数でAtomExプレーヤを破棄する。
   
6. ワーク領域のメモリを解放する。
   

具体的なコードは以下のとおりです。

 main()
 {
    CriAtomExPlayerConfig config;   // AtomExプレーヤ作成用コンフィグ構造体
    CriAtomExPlayerHn player;       // AtomExプレーヤハンドル
    void *work;                     // ワーク領域アドレス
    CriSint32 work_size;            // ワーク領域サイズ
        :
    // AtomExプレーヤ作成用コンフィグ構造体を設定
    criAtomExPlayer_SetDefaultConfig(&config);

    // AtomExプレーヤの作成に必要なワーク領域のサイズを計算
    work_size = criAtomExPlayer_CalculateWorkSize(&config);

    // ワーク領域用にメモリを確保
    work = malloc((size_t)work_size);

    // AtomExプレーヤの作成
    // ワーク領域にはNULLと0を指定する。
    // →確保済みのワーク領域を指定する。
    player = criAtomExPlayer_Create(&config, work, work_size);
        :
    // 音声再生処理
    // →この間、確保したメモリは保持し続ける。
        :
    // AtomExプレーヤが不要になった時点で破棄
    criAtomExPlayer_Destroy(player);

    // 必要なくなったワーク領域を解放する
    free(work);
        :
 }

criAtomExPlayer_Create 関数を実行すると、AtomExプレーヤが作成され、 プレーヤを制御するためのハンドル（ CriAtomExPlayerHn ）が返されます。
データのセット、再生の開始、ステータスの取得等、AtomExプレーヤに対して 行う操作は、全てハンドルに対して行います。

プレーヤの作成に失敗した場合、戻り値として NULL が返されます。
プレーヤの作成に失敗した理由については、エラーコールバックのメッセージで確認可能です。

作成されたAtomExプレーヤハンドルを使用して音声データを再生する手順は以下のとおりです。

1. criAtomExPlayer_SetData 関数を使用して、AtomExプレーヤに再生するデータをセットする。
   （ファイル再生時は、 criAtomExPlayer_SetFile 関数または criAtomExPlayer_SetContentId 関数を使用する。）
   
2. criAtomExPlayer_Start 関数で再生を開始する。
   

備考:

引数 config の情報は、関数内でのみ参照されます。
関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。

注意:

本関数を実行する前に、ライブラリを初期化しておく必要があります。

本関数は完了復帰型の関数です。
AtomExプレーヤの作成にかかる時間は、プラットフォームによって異なります。
ゲームループ等の画面更新が必要なタイミングで本関数を実行するとミリ秒単位で 処理がブロックされ、フレーム落ちが発生する恐れがあります。
AtomExプレーヤの作成／破棄は、シーンの切り替わり等、負荷変動を許容できる タイミングで行うようお願いいたします。

参照:

CriAtomExPlayerConfig, criAtomExPlayer_CalculateWorkSize, CriAtomExPlayerHn, criAtomExPlayer_Destroy, criAtomExPlayer_SetData, criAtomExPlayer_SetFile, criAtomExPlayer_SetContentId, criAtomExPlayer_Start

音声データのセット（キューID指定）

引数:

[in]	player	AtomExプレーヤハンドル
[in]	acb_hn	ACBハンドル
[in]	id	キューID

説明:

キューIDを、AtomExプレーヤに関連付けます。
本関数でキューIDを指定後、 criAtomExPlayer_Start 関数で再生を 開始すると、指定されたキューが再生されます。

例:

 main()
 {
        :
    // 音声データをセット
    criAtomExPlayer_SetCueId(player, acb_hn, 100);

    // セットされた音声データを再生
    criAtomExPlayer_Start(player);
        :
 }

尚、一旦セットしたデータの情報は、他のデータがセットされるまでAtomExプレーヤ内に保持 されます。
そのため、同じデータを何度も再生する場合には、再生毎にデータをセットしなおす必要 はありません。

備考:

第2引数（ ach_hn ）に NULL を指定した場合、全てのACBデータを対象に、指定したキューIDに 合致するデータがないか、ライブラリ内で検索が行われます。
（指定したキューIDを持つACBデータが見つかった時点で、 当該ACBデータのキューがプレーヤにセットされます。）
この際、検索の順序は、ACBデータのロード順とは逆順で行われます。
（後からロードされたデータから優先的に検索が行われます。）

criAtomExPlayer_SetCueId 関数でキューをセットした場合、以下の関数で設定された パラメータは無視されます。

• criAtomExPlayer_SetFormat
• criAtomExPlayer_SetNumChannels
• criAtomExPlayer_SetSamplingRate

（音声フォーマットやチャンネル数、サンプリングレート等の情報は、 ACB ファイルの情報を元に自動的にセットされます。）

参照:

criAtomExPlayer_Start

音声データのセット（キュー名指定）

引数:

[in]	player	AtomExプレーヤハンドル
[in]	acb_hn	ACBハンドル
[in]	cue_name	キュー名 キュー名を、AtomExプレーヤに関連付けます。 本関数でキュー名を指定後、 criAtomExPlayer_Start 関数で再生を 開始すると、指定されたキューが再生されます。

例:

 main()
 {
        :
    // 音声データをセット
    criAtomExPlayer_SetCueName(player, acb_hn, "gun_shot");

    // セットされた音声データを再生
    criAtomExPlayer_Start(player);
        :
 }

尚、一旦セットしたデータの情報は、他のデータがセットされるまでAtomExプレーヤ内に保持 されます。
そのため、同じデータを何度も再生する場合には、再生毎にデータをセットしなおす必要 はありません。

備考:

第2引数（ ach_hn ）に NULL を指定した場合、全てのACBデータを対象に、指定したキュー名に 合致するデータがないか、ライブラリ内で検索が行われます。
（指定したキュー名を持つACBデータが見つかった時点で、 当該ACBデータのキューがプレーヤにセットされます。）
この際、検索の順序は、ACBデータのロード順とは逆順で行われます。
（後からロードされたデータから優先的に検索が行われます。）

criAtomExPlayer_SetCueName 関数でキューをセットした場合、以下の関数で設定された パラメータは無視されます。

• criAtomExPlayer_SetFormat
• criAtomExPlayer_SetNumChannels
• criAtomExPlayer_SetSamplingRate

（音声フォーマットやチャンネル数、サンプリングレート等の情報は、 ACB ファイルの情報を元に自動的にセットされます。）

参照:

criAtomExPlayer_Start

音声データのセット（キューインデックス指定）

引数:

[in]	player	AtomExプレーヤハンドル
[in]	acb_hn	ACBハンドル
[in]	index	キューインデックス キューインデックスを、AtomExプレーヤに関連付けます。 本関数でキューインデックスを指定後、 criAtomExPlayer_Start 関数で再生を 開始すると、指定されたキューが再生されます。

例:

 main()
 {
        :
    // 音声データをセット
    criAtomExPlayer_SetCueIndex(player, acb_hn, 300);

    // セットされた音声データを再生
    criAtomExPlayer_Start(player);
        :
 }

尚、一旦セットしたデータの情報は、他のデータがセットされるまでAtomExプレーヤ内に保持 されます。
そのため、同じデータを何度も再生する場合には、再生毎にデータをセットしなおす必要 はありません。

備考:

第2引数（ ach_hn ）に NULL を指定した場合、全てのACBデータを対象に、指定したキューインデックスに 合致するデータがないか、ライブラリ内で検索が行われます。
（指定したキューインデックスを持つACBデータが見つかった時点で、 当該ACBデータのキューがプレーヤにセットされます。）
この際、検索の順序は、ACBデータのロード順とは逆順で行われます。
（後からロードされたデータから優先的に検索が行われます。）

criAtomExPlayer_SetCueIndex 関数でキューをセットした場合、以下の関数で設定された パラメータは無視されます。

• criAtomExPlayer_SetFormat
• criAtomExPlayer_SetNumChannels
• criAtomExPlayer_SetSamplingRate

（音声フォーマットやチャンネル数、サンプリングレート等の情報は、 ACB ファイルの情報を元に自動的にセットされます。）

本関数を使用することで、キュー名やキューIDを指定せずにプレーヤに対して 音声をセットすることが可能です。
（キュー名やキューIDがわからない場合でも、ACBファイル内のコンテンツを一通り再生 可能なので、デバッグ用途に利用可能です。）

参照:

criAtomExPlayer_Start

音声データのセット（オンメモリデータの指定）

引数:

[in]	player	AtomExプレーヤハンドル
[in]	buffer	バッファアドレス
[in]	size	バッファサイズ

説明:

メモリ上に配置された音声データを、AtomExプレーヤに関連付けます。
本関数でメモリアドレスとサイズを指定後、 criAtomExPlayer_Start 関数で再生を 開始すると、指定されたデータが再生されます。

例:

 main()
 {
        :
    // 音声データをセット
    criAtomExPlayer_SetData(player, buffer, buffer_size);

    // 再生する音声データのフォーマットを指定
    criAtomExPlayer_SetFormat(player, CRIATOMEX_FORMAT_ADX);
    criAtomExPlayer_SetNumChannels(player, 1);
    criAtomExPlayer_SetSamplingRate(player, 24000);

    // セットされた音声データを再生
    criAtomExPlayer_Start(player);
        :
 }

尚、一旦セットしたデータの情報は、他のデータがセットされるまでAtomExプレーヤ内に保持 されます。
そのため、同じデータを何度も再生する場合には、再生毎にデータをセットしなおす必要 はありません。

注意:

プレーヤが記憶するのはバッファのアドレスとサイズのみです。
（バッファ内のデータがコピーされるわけではありません。）
そのため、指定したデータの再生が終了するまでの間、 アプリケーション側でバッファを保持し続ける必要があります。

メモリ再生を行っているAtomExプレーヤを停止させた場合でも、 ライブラリ内には当該メモリ領域を参照しているボイスが存在する可能性があります。
本関数でセットしたメモリ領域を解放する際には、事前に criAtomEx_IsDataPlaying 関数を実行し、当該メモリ領域への参照が行われていないことを確認してください。
criAtomExPlayer_SetData 関数で音声データをセットする場合、以下の関数を使用して 再生する音声データの情報を別途指定する必要があります。

• criAtomExPlayer_SetFormat
• criAtomExPlayer_SetNumChannels
• criAtomExPlayer_SetSamplingRate

参照:

criAtomExPlayer_SetFormat, criAtomExPlayer_Start, criAtomEx_IsDataPlaying

音声データのセット（ファイル名の指定）

引数:

[in]	player	AtomExプレーヤハンドル
[in]	binder	バインダハンドル
[in]	path	ファイルパス

説明:

音声ファイルをAtomExプレーヤに関連付けます。
本関数でファイルを指定後、 criAtomExPlayer_Start 関数で再生を開始すると、 指定されたファイルがストリーミング再生されます。
尚、本関数を実行した時点では、ファイルの読み込みは開始されません。
ファイルの読み込みが開始されるのは、 criAtomExPlayer_Start 関数実行後です。

例:

 main()
 {
        :
    // 音声ファイルをセット
    criAtomExPlayer_SetFile(player, NULL, "sample.hca");

    // 再生する音声データのフォーマットを指定
    criAtomExPlayer_SetFormat(player, CRIATOMEX_FORMAT_HCA);
    criAtomExPlayer_SetNumChannels(player, 2);
    criAtomExPlayer_SetSamplingRate(player, 48000);

    // セットされた音声データを再生
    criAtomExPlayer_Start(player);
        :
 }

尚、一旦セットしたファイルの情報は、他のデータがセットされるまでAtomExプレーヤ内に保持 されます。
そのため、同じデータを何度も再生する場合には、再生毎にデータをセットしなおす必要 はありません。

備考：

データがCPKにパックされていない場合、引数binderにはNULLを指定してください。

注意:

criAtomExPlayer_SetFile 関数を実行すると、 指定したパス文字列がAtomExプレーヤ内に保持されます。
AtomExプレーヤはデフォルト状態ではパス文字列を保持する領域を1つしか確保しません。
（メモリサイズ削減のため。）
しかし、ファイル再生中に別のファイルをAtomExプレーヤにセットしたい場合、 再生中のファイルとセットしたファイルの両方のパスを保持する必要があるため、 2つのパス文字列を保存する領域が必要になります。
2つ以上のファイルを同時に再生したい場合には、プレーヤ作成時に指定する max_path_strings の数を増やす必要があります。
max_path_strings の数を増やすことで、AtomExプレーヤは指定された数分の パス文字列を同時に保存できるようになります。
（max_path_strings に2以上の値を指定することで、 1つのプレーヤで複数のファイルを同時にパス指定で再生することが可能となります。）
ただし、 max_path_strings の値に応じて必要なワーク領域のサイズは増加します。

criAtomExPlayer_SetFile 関数で音声データをセットする場合、以下の関数を使用して 再生する音声データの情報を別途指定する必要があります。

• criAtomExPlayer_SetFormat
• criAtomExPlayer_SetNumChannels
• criAtomExPlayer_SetSamplingRate

参照:

CriAtomExPlayerConfig, criAtomExPlayer_Create, criAtomExPlayer_Start

音声データのセット（CPKコンテンツIDの指定）

引数:

[in]	player	AtomExプレーヤハンドル
[in]	binder	バインダハンドル
[in]	id	コンテンツID

説明:

コンテンツをAtomExプレーヤに関連付けます。
CRI File Systemライブラリを使用してCPKファイル内のコンテンツファイルを ID指定で再生するために使用します。
本関数にバインダとコンテンツIDを指定後、 criAtomExPlayer_Start 関数で再生を 開始すると、指定されたコンテンツファイルがストリーミング再生されます。
尚、本関数を実行した時点では、ファイルの読み込みは開始されません。
ファイルの読み込みが開始されるのは、 criAtomExPlayer_Start 関数実行後です。

例:

 main()
 {
        :
    // CPKファイルをバインド
    criFsBinder_BindCpk(binder, "sample.cpk", work, work_size, &bind_id);

    // バインド完了待ち
    for (;;) {
        // ステータスのチェック
        criFsBinder_GetStatus(binder, &status);
        if (status == CRIFSBINDER_STATUS_COMPLETE) {
            break;
        }

        // サーバ処理の実行
        criFs_ExecuteMain();

        // Vsync待ち等
            :
    }
        :
    // 音声ファイルをセット
    // sample.cpk内の1番のコンテンツをセット
    criAtomExPlayer_SetContentId(player, binder, 1);

    // 再生する音声データのフォーマットを指定
    criAtomExPlayer_SetFormat(player, CRIATOMEX_FORMAT_ADX);
    criAtomExPlayer_SetNumChannels(player, 2);
    criAtomExPlayer_SetSamplingRate(player, 44100);

    // セットされた音声データを再生
    criAtomExPlayer_Start(player);
        :
 }

尚、一旦セットしたファイルの情報は、他のデータがセットされるまでAtomExプレーヤ内に保持 されます。
そのため、同じデータを何度も再生する場合には、再生毎にデータをセットしなおす必要 はありません。

備考：

データがCPKにパックされていない場合、引数binderにはNULLを指定してください。

注意:

criAtomExPlayer_SetContentId 関数で音声データをセットする場合、以下の関数を使用して 再生する音声データの情報を別途指定する必要があります。

• criAtomExPlayer_SetFormat
• criAtomExPlayer_SetNumChannels
• criAtomExPlayer_SetSamplingRate

参照:

CriAtomExPlayerConfig, criAtomExPlayer_Create, criAtomExPlayer_Start

音声データのセット（波形データIDの指定）

引数:

[in]	player	AtomExプレーヤハンドル
[in]	awb	AWBハンドル
[in]	id	波形データID

説明:

再生する波形データをAtomExプレーヤに関連付けます。
本関数にAWBハンドルと波形データIDを指定後、 criAtomExPlayer_Start 関数で再生を 開始すると、指定した波形データがストリーミング再生されます。
尚、本関数を実行した時点では、ファイルの読み込みは開始されません。
ファイルの読み込みが開始されるのは、 criAtomExPlayer_Start 関数実行後です。

例:

 main()
 {
        :
    // AWBのTOC情報をロードしてAWBハンドルを作成
    awb = criAtomAwb_LoadToc(NULL, "sample.awb", NULL, 0);
        :
    // 波形データをセット
    // AWB内の1番の波形データをセット
    criAtomExPlayer_SetWaveId(player, awb, 1);

    // 再生する音声データのフォーマットを指定
    criAtomExPlayer_SetFormat(player, CRIATOMEX_FORMAT_HCA_MX);
    criAtomExPlayer_SetNumChannels(player, 2);
    criAtomExPlayer_SetSamplingRate(player, 32000);

    // セットされた音声データを再生
    criAtomExPlayer_Start(player);
        :
 }

尚、一旦セットしたファイルの情報は、他のデータがセットされるまでAtomExプレーヤ内に保持 されます。
そのため、同じデータを何度も再生する場合には、再生毎にデータをセットしなおす必要 はありません。

注意:

本関数で音声データをセットする場合、 以下の関数を使用して再生する音声データの情報を別途指定する必要があります。

• criAtomExPlayer_SetFormat
• criAtomExPlayer_SetNumChannels
• criAtomExPlayer_SetSamplingRate

本関数でセットした音声を再生中に、 criAtomAwb_Release 関数でデータを破棄しないでください。
AWBファイルを破棄する際には、必ず再生を停止した状態で criAtomAwb_Release 関数を実行してください。

参照:

CriAtomExPlayerConfig, criAtomExPlayer_Create, criAtomExPlayer_Start

再生の開始

引数:

[in]

player

AtomExプレーヤハンドル

戻り値:

CriAtomExPlaybackId 再生ID

説明:

音声データの再生処理を開始します。
本関数を実行する前に、事前に criAtomExPlayer_SetData 関数等を使用し、再生する 音声データをAtomExプレーヤにセットしておく必要があります。
例えば、オンメモリの音声データを再生する場合には、以下のように事前に criAtomExPlayer_SetData 関数を使って音声データをセットした後、本関数を実行する 必要があります。

 main()
 {
        :
    // 音声データをセット
    criAtomExPlayer_SetData(player, buffer, buffer_size);

    // 再生する音声データのフォーマットを指定
    criAtomExPlayer_SetFormat(player, CRIATOMEX_FORMAT_HCA_MX);
    criAtomExPlayer_SetNumChannels(player, 1);
    criAtomExPlayer_SetSamplingRate(player, 24000);

    // セットされた音声データを再生
    criAtomExPlayer_Start(player);
        :
 }

本関数実行後、再生の進み具合（発音が開始されたか、再生が完了したか等）がどうなって いるかは、ステータスを取得することで確認が可能です。
ステータスの取得には、 criAtomExPlayer_GetStatus 関数を使用します。
criAtomExPlayer_GetStatus 関数は以下の5通りのステータスを返します。

1. CRIATOMEXPLAYER_STATUS_STOP
2. CRIATOMEXPLAYER_STATUS_PREP
3. CRIATOMEXPLAYER_STATUS_PLAYING
4. CRIATOMEXPLAYER_STATUS_PLAYEND
5. CRIATOMEXPLAYER_STATUS_ERROR

AtomExプレーヤを作成した時点では、AtomExプレーヤのステータスは停止状態 （ CRIATOMEXPLAYER_STATUS_STOP ）です。
再生する音声データをセット後、本関数を実行することで、AtomExプレーヤのステータスが 準備状態（ CRIATOMEXPLAYER_STATUS_PREP ）に変更されます。
（CRIATOMEXPLAYER_STATUS_PREP は、データ供給やデコードの開始を待っている状態です。）
再生の開始に充分なデータが供給された時点で、AtomExプレーヤはステータスを 再生状態（ CRIATOMEXPLAYER_STATUS_PLAYING ）に変更し、音声の出力を開始します。
セットされたデータを全て再生し終えると、AtomExプレーヤはステータスを再生終了状態 （ CRIATOMEXPLAYER_STATUS_PLAYEND ）に変更します。
尚、再生中にエラーが発生した場合には、AtomExプレーヤはステータスをエラー状態 （ CRIATOMEXPLAYER_STATUS_ERROR ）に変更します。

AtomExプレーヤのステータスをチェックし、ステータスに応じて処理を切り替えることで、 音声の再生状態に連動したプログラムを作成することが可能です。
例えば、音声の再生完了を待って処理を進めたい場合には、以下のようなコードになります。

 main()
 {
        :
    // 音声データをセット
    criAtomExPlayer_SetData(player, buffer, buffer_size);

    // 再生する音声データのフォーマットを指定
    criAtomExPlayer_SetFormat(player, CRIATOMEX_FORMAT_ADX);
    criAtomExPlayer_SetNumChannels(player, 1);
    criAtomExPlayer_SetSamplingRate(player, 22050);

    // セットされた音声データを再生
    criAtomExPlayer_Start(player);

    // 再生完了待ち
    for (;;) {
        // ステータスの取得
        status = criAtomExPlayer_GetStatus(player);

        // ステータスのチェック
        if (status == CRIATOMEXPLAYER_STATUS_PLAYEND) {
            // 再生終了時はループを抜ける
            break;
        }

        // サーバ処理の実行
        criAtomEx_ExecuteMain();

        // 画面表示の更新等
            :
    }
        :
 }

備考:

関数実行時に発音リソースが確保できない場合（全てのボイスが使用中で、なおかつ 他のボイスを奪い取れない場合等）、本関数は CRIATOMEX_INVALID_PLAYBACK_ID を返します。
しかし、戻り値を元にエラーチェックを行わなくても、ほとんどのケースで問題は発生しません。
再生ID（ CriAtomExPlaybackId ）を使用する API に対し、 CRIATOMEX_INVALID_PLAYBACK_ID をセットしたとしても、Atomライブラリは特に何も処理しません。
そのため、デバッグ目的で発音が行われたかどうかをチェックしたい場合を除き、 本関数の結果に応じてアプリケーション側で処理を切り分ける必要はありません。
（ CRIATOMEX_INVALID_PLAYBACK_ID が返された際に、有効な再生IDが返された場合と 同様の処理を行っても、エラーコールバック等は発生しません。）

参照:

criAtomExPlayer_SetData, criAtomExPlayer_SetFile, criAtomExPlayer_GetStatus, criAtomExPlayer_Pause, criAtomEx_ExecuteMain

再生の準備

引数:

[in]

player

AtomExプレーヤハンドル

戻り値:

CriAtomExPlaybackId 再生ID

説明:

音声データの再生を準備します。
本関数を実行する前に、事前に criAtomExPlayer_SetData 関数等を使用し、 再生すべき音声データをAtomExプレーヤにセットしておく必要があります。

本関数を実行すると、ポーズをかけた状態で音声の再生を開始します。
関数実行のタイミングで音声再生に必要なリソースを確保し、 バッファリング（ストリーム再生を行うファイルの読み込み）を開始しますが、 バッファリング完了後も発音は行われません。
（発音可能な状態になっても、ポーズ状態で待機します。）

1音だけを再生するケースでは、本関数は以下のコードと同じ動作をします。

        ：
    // プレーヤをポーズ状態に設定
    criAtomExPlayer_Pause(player, CRI_TRUE);

    // 音声の再生を開始
    id = criAtomExPlayer_Start(player);
        ：

本関数で再生準備を行った音声を発音するには、 本関数が返す再生 ID （ CriAtomExPlaybackId ）に対し、 ::criAtomExPlayback_Pause(id, CRI_FALSE); の操作を行う必要があります。

備考:

ストリーミング再生時には、 criAtomExPlayer_Start 関数で再生を開始しても、 実際に音声の再生が開始されるまでにはタイムラグがあります。
（音声データのバッファリングに時間がかかるため。）

以下の操作を行うことで、ストリーム再生の音声についても、発音のタイミングを 制御することが可能になります。

1. criAtomExPlayer_Prepare 関数で準備を開始する。
2. 手順1.で取得した再生IDのステータスを criAtomExPlayback_GetStatus 関数で確認。
3. ステータスが ::CRIATOMEXPLAYBACK_STATUS_PLAYINGになった時点で criAtomExPlayback_Pause 関数でポーズを解除。
4. ポーズ解除後、次にサーバ処理が動作するタイミングで発音が開始される。

具体的なコードは、以下のとおりです。

 main()
 {
        :
    // 音声データをセット
    criAtomExPlayer_SetFile(player, NULL, "sample.adx");

    // 再生する音声データのフォーマットを指定
    criAtomExPlayer_SetFormat(player, CRIATOMEX_FORMAT_ADX);
    criAtomExPlayer_SetNumChannels(player, 2);
    criAtomExPlayer_SetSamplingRate(player, 48000);

    // セットされた音声データの再生準備を開始
    playback_id = criAtomExPlayer_Prepare(player);
        :
    // 再生準備完了待ち
    for (;;) {
        // 再生ステータスをチェック
        playback_status = criAtomExPlayback_GetStatus(playback_id);
        if (playback_status == CRIATOMEXPLAYBACK_STATUS_PLAYING) {
            // ステータスが再生状態になった時点でループを抜ける
            break;
        }

        // サーバ処理の実行
        criAtomEx_ExecuteMain();

        // 画面表示の更新等
            :
    }

    // ポーズを解除
    criAtomExPlayback_Pause(playback_id, CRI_FALSE);
        :
 }

ポーズ解除処理に criAtomExPlayback_Pause 関数を使用した場合、 本関数による再生準備のためのポーズと、 criAtomExPlayer_Pause 関数による一時停止処理の両方が解除されます。
criAtomExPlayer_Pause 関数でポーズした音声を停止したまま 本関数で再生準備を行った音声を再生したい場合、ポーズの解除に criAtomExPlayer_Resume 関数（または criAtomExPlayback_Resume 関数）をご利用ください。

参照:

criAtomExPlayback_GetStatus, criAtomExPlayback_Pause

再生の停止

引数:

[in]

player

AtomExプレーヤハンドル

説明:

再生の停止要求を発行します。
音声再生中のAtomExプレーヤに対して本関数を実行すると、 AtomExプレーヤは再生を停止（ファイルの読み込みや、発音を停止）し、 ステータスを停止状態（ CRIATOMEXPLAYER_STATUS_STOP ）に遷移します。

備考:

既に停止しているAtomExプレーヤ（ステータスが CRIATOMEXPLAYER_STATUS_PLAYEND や CRIATOMEXPLAYER_STATUS_ERROR のAtomExプレーヤ） に対して本関数を実行すると、 AtomExプレーヤのステータスを CRIATOMEXPLAYER_STATUS_STOP に変更します。

注意:

本関数は完了復帰型の関数ではありません。
そのため、関数内で処理が長時間ブロックすることはありませんが、 関数を抜けた時点では再生が停止していない可能性がある点にご注意ください。
（停止状態になるまでに、時間がかかる場合があります。）
停止を保証する必要がある場合には、本関数呼び出し後、 AtomExプレーヤのステータスが停止状態（CRIATOMEXPLAYER_STATUS_STOP） になることを確認してください。

参照:

criAtomExPlayer_Start, criAtomExPlayer_GetStatus

再生の停止（リリースタイム無視）

引数:

[in]

player

AtomExプレーヤハンドル

説明:

再生の停止要求を発行します。
この際、再生中の音声にエンベロープのリリースタイムが設定されていたとしても、 それを無視して停止します。
音声再生中のAtomExプレーヤに対して本関数を実行すると、 AtomExプレーヤは再生を停止（ファイルの読み込みや、発音を停止）し、 ステータスを停止状態（ CRIATOMEXPLAYER_STATUS_STOP ）に遷移します。

備考:

既に停止しているAtomExプレーヤ（ステータスが CRIATOMEXPLAYER_STATUS_PLAYEND や CRIATOMEXPLAYER_STATUS_ERROR のAtomExプレーヤ） に対して本関数を実行すると、 AtomExプレーヤのステータスを CRIATOMEXPLAYER_STATUS_STOP に変更します。

注意:

本関数は完了復帰型の関数ではありません。
そのため、関数内で処理が長時間ブロックすることはありませんが、 関数を抜けた時点では再生が停止していない可能性がある点にご注意ください。
（停止状態になるまでに、時間がかかる場合があります。）
停止を保証する必要がある場合には、本関数呼び出し後、 AtomExプレーヤのステータスが停止状態（CRIATOMEXPLAYER_STATUS_STOP） になることを確認してください。

参照:

criAtomExPlayer_Start, criAtomExPlayer_GetStatus

全てのプレーヤの再生を停止

説明:

全てのAtomExプレーヤに対し、再生の停止要求を発行します。
本関数を実行すると、AtomExプレーヤは再生を停止（ファイルの読み込みや、発音を停止）し、 ステータスを停止状態（ CRIATOMEXPLAYER_STATUS_STOP ）に遷移します。

備考:

既に停止しているAtomExプレーヤ（ステータスが CRIATOMEXPLAYER_STATUS_PLAYEND や CRIATOMEXPLAYER_STATUS_ERROR のAtomExプレーヤ） についても、 本関数が実行されるとステータスが CRIATOMEXPLAYER_STATUS_STOP に変更されます。

注意:

本関数は完了復帰型の関数ではありません。
そのため、関数内で処理が長時間ブロックすることはありませんが、 関数を抜けた時点では再生が停止していない可能性がある点にご注意ください。
（停止状態になるまでに、時間がかかる場合があります。）
停止を保証する必要がある場合には、本関数呼び出し後、 AtomExプレーヤのステータスが停止状態（CRIATOMEXPLAYER_STATUS_STOP） になることを確認してください。

参照:

criAtomExPlayer_Start, criAtomExPlayer_GetStatus

全てのプレーヤの再生を停止（リリースタイム無視）

説明:

全てのAtomExプレーヤに対し、再生の停止要求を発行します。
この際、再生中の音声にエンベロープのリリースタイムが設定されていたとしても、 それを無視して停止します。
本関数を実行すると、AtomExプレーヤは再生を停止（ファイルの読み込みや、発音を停止）し、 ステータスを停止状態（ CRIATOMEXPLAYER_STATUS_STOP ）に遷移します。

備考:

既に停止しているAtomExプレーヤ（ステータスが CRIATOMEXPLAYER_STATUS_PLAYEND や CRIATOMEXPLAYER_STATUS_ERROR のAtomExプレーヤ） についても、 本関数が実行されるとステータスが CRIATOMEXPLAYER_STATUS_STOP に変更されます。

注意:

本関数は完了復帰型の関数ではありません。
そのため、関数内で処理が長時間ブロックすることはありませんが、 関数を抜けた時点では再生が停止していない可能性がある点にご注意ください。
（停止状態になるまでに、時間がかかる場合があります。）
停止を保証する必要がある場合には、本関数呼び出し後、 AtomExプレーヤのステータスが停止状態（CRIATOMEXPLAYER_STATUS_STOP） になることを確認してください。

参照:

criAtomExPlayer_Start, criAtomExPlayer_GetStatus

ポーズ／ポーズ解除

引数:

[in]	player	AtomExプレーヤハンドル
[in]	sw	スイッチ（CRI_FALSE = ポーズ解除、CRI_TRUE = ポーズ）

説明:

再生のポーズ／ポーズ解除を行います。
sw に CRI_TRUE を指定して本関数を実行すると、AtomExプレーヤは再生中の 音声をポーズ（一時停止）します。
sw に CRI_FALSE を指定して本関数を実行すると、AtomExプレーヤはポーズを 解除し、一時停止していた音声の再生を再開します。

備考:

デフォルト状態（プレーヤ作成直後の状態）では、ポーズは解除されています。

注意:

第2引数（sw）に CRI_FALSE を指定してポーズ解除の操作を行った場合、 本関数でポーズをかけた音声だけでなく、::criAtomExPlayer_Prepare 関数で再生準備中の音声についても再生が開始されてしまいます。
（旧バージョンとの互換性維持のための仕様です。）
本関数でポーズをかけた音声についてのみポーズを解除したい場合、 本関数を使用せず、 criAtomExPlayer_Resume(player, CRIATOMEX_RESUME_PAUSED_PLAYBACK); を実行してポーズ解除を行ってください。

本関数を実行すると、プレーヤで再生している"全ての"音声に対してポーズ／ポーズ解除 の処理が行われます。
再生中の個々の音声に対し、個別にポーズ／ポーズ解除の処理を行う場合には、 criAtomExPlayback_Pause 関数をご利用ください。

参照:

criAtomExPlayer_IsPaused, criAtomExPlayback_Pause, criAtomExPlayer_Resume

ポーズ解除

引数:

[in]	player	AtomExプレーヤハンドル
[in]	mode	ポーズ解除対象

説明:

一時停止状態の解除を行います。
criAtomExPlayer_Pause 関数と異なり、 criAtomExPlayer_Prepare 関数で再生開始待ちの音声と、 criAtomExPlayer_Pause 関数（または criAtomExPlayback_Pause 関数でポーズをかけた音声とを、 個別に再開させることが可能です。

第2引数（mode）に CRIATOMEX_RESUME_PAUSED_PLAYBACK を指定して本関数を実行すると、 ユーザが criAtomExPlayer_Pause 関数（または criAtomExPlayback_Pause 関数）で一時停止状態になった音声の再生が再開されます。
第2引数（mode）に CRIATOMEX_RESUME_PREPARED_PLAYBACK を指定して本関数を実行すると、 ユーザが criAtomExPlayer_Prepare 関数で再生準備を指示した音声の再生が開始されます。

criAtomExPlayer_Pause 関数でポーズ状態のプレーヤに対して criAtomExPlayer_Prepare 関数で再生準備を行った場合、その音声は CRIATOMEX_RESUME_PAUSED_PLAYBACK 指定のポーズ解除処理と、 CRIATOMEX_RESUME_PREPARED_PLAYBACK 指定のポーズ解除処理の両方が行われるまで、再生が開始されません。

備考:

criAtomExPlayer_Pause 関数か criAtomExPlayer_Prepare 関数かに関係なく、 常に再生を開始したい場合には、第2引数（mode）に CRIATOMEX_RESUME_ALL_PLAYBACK を指定して本関数を実行するか、または criAtomExPlayer_Pause(player, CRI_FALSE); を実行してください。

注意:

本関数を実行すると、プレーヤで再生している"全ての"音声に対してポーズ解除 の処理が行われます。
再生中の個々の音声に対し、個別にポーズ解除の処理を行う場合には、 criAtomExPlayback_Resume 関数をご利用ください。

参照:

criAtomExPlayback_Resume, criAtomExPlayer_Pause

ポーズ状態の取得

引数:

[in]

player

AtomExプレーヤハンドル

戻り値:

CriBool ポーズ中かどうか（CRI_FALSE = ポーズされていない、CRI_TRUE = ポーズ中）

説明:

プレーヤがポーズ中かどうかを返します。

注意:

本関数が CRI_TRUE を返すのは、「全ての再生音がポーズ中の場合」のみです。
criAtomExPlayer_Pause 関数実行後、再生ID指定で個々の音声のポーズを解除 （ criAtomExPlayback_Pause 関数を実行）した場合、本関数は CRI_FALSE を 返します。

本関数は criAtomExPlayer_Pause 関数でポーズされた音声と、 criAtomExPlayer_Prepare 関数でポーズされた音声とを区別しません。
（ポーズ方法に関係なく、全ての再生音がポーズされているかどうかのみを判定します。）

参照:

criAtomExPlayer_Pause, criAtomExPlayback_Pause

ステータスの取得

引数:

[in]

player

AtomExプレーヤハンドル

戻り値:

CriAtomExPlayerStatus ステータス

説明:

AtomExプレーヤのステータスを取得します。
ステータスはAtomExプレーヤの再生状態を示す値で、以下の5通りの値が存在します。

1. CRIATOMEXPLAYER_STATUS_STOP
2. CRIATOMEXPLAYER_STATUS_PREP
3. CRIATOMEXPLAYER_STATUS_PLAYING
4. CRIATOMEXPLAYER_STATUS_PLAYEND
5. CRIATOMEXPLAYER_STATUS_ERROR

AtomExプレーヤを作成した時点では、AtomExプレーヤのステータスは停止状態 （ CRIATOMEXPLAYER_STATUS_STOP ）です。
再生する音声データをセット後、::criAtomExPlayer_Start 関数を実行することで、 AtomExプレーヤのステータスが準備状態（ CRIATOMEXPLAYER_STATUS_PREP ）に変更されます。
（CRIATOMEXPLAYER_STATUS_PREP は、データ供給やデコードの開始を待っている状態です。）
再生の開始に充分なデータが供給された時点で、AtomExプレーヤはステータスを 再生状態（ CRIATOMEXPLAYER_STATUS_PLAYING ）に変更し、音声の出力を開始します。
セットされたデータを全て再生し終えると、AtomExプレーヤはステータスを再生終了状態 （ CRIATOMEXPLAYER_STATUS_PLAYEND ）に変更します。
尚、再生中にエラーが発生した場合には、AtomExプレーヤはステータスをエラー状態 （ CRIATOMEXPLAYER_STATUS_ERROR ）に変更します。

AtomExプレーヤのステータスをチェックし、ステータスに応じて処理を切り替えることで、 音声の再生状態に連動したプログラムを作成することが可能です。
例えば、音声の再生完了を待って処理を進めたい場合には、以下のようなコードになります。

 main()
 {
        :
    // 音声データをセット
    criAtomExPlayer_SetData(player, buffer, buffer_size);

    // 再生する音声データのフォーマットを指定
    criAtomExPlayer_SetFormat(player, CRIATOMEX_FORMAT_ADX);
    criAtomExPlayer_SetNumChannels(player, 1);
    criAtomExPlayer_SetSamplingRate(player, 24000);

    // セットされた音声データを再生
    criAtomExPlayer_Start(player);

    // 再生完了待ち
    for (;;) {
        // ステータスの取得
        status = criAtomExPlayer_GetStatus(player);

        // ステータスのチェック
        if (status == CRIATOMEXPLAYER_STATUS_PLAYEND) {
            // 再生終了時はループを抜ける
            break;
        }

        // サーバ処理の実行
        criAtomEx_ExecuteMain();

        // 画面表示の更新等
            :
    }
        :
 }

参照:

criAtomExPlayer_Start

再生中の音声数の取得

引数:

[in]

player

AtomExプレーヤハンドル

戻り値:

CriSint32 再生音数

説明:

プレーヤで現在再生中の音声の数を取得します。

備考:

本関数は、 criAtomExPlayer_Start 関数で再生を行い、今現在も有効な再生IDの数を返します。
（ 使用中のボイス数の数ではありません。複数の波形データを含むシーケンスを1回再生した場合でも、 1つとカウントされます。）
使用中のボイス数を取得したい場合には、 criAtomExVoicePool_GetNumUsedVoices 関数をご利用ください。

参照:

criAtomExPlayer_Start, criAtomExVoicePool_GetNumUsedVoices

最終再生IDの取得

引数:

[in]

player

AtomExプレーヤハンドル

戻り値:

CriSint32 再生ID

説明:

プレーヤで最後に再生した音声の再生IDを取得します。

備考:

参照:

criAtomExPlayer_Start

再生時刻の取得

引数:

[in]

player

AtomExプレーヤハンドル

戻り値:

Sint64 再生時刻（ミリ秒単位）

説明:

AtomExプレーヤで最後に再生した音声の、再生時刻を取得します。

再生時刻が取得できた場合、本関数は 0 以上の値を返します。
再生時刻が取得できない場合（ボイスの取得に失敗した場合等）、本関数は負値を返します。

備考:

同一プレーヤで複数の音声を再生し、本関数を実行した場合、本関数は "最後に"再生した音声の時刻を返します。
複数の音声に対して再生時刻をチェックする必要がある場合には、 再生する音声の数分だけプレーヤを作成するか、または criAtomExPlayback_GetTime 関数をご利用ください。

本関数が返す再生時刻は「再生開始後からの経過時間」です。
ループ再生時や、シームレス連結再生時を行った場合でも、 再生位置に応じて時刻が巻き戻ることはありません。

criAtomExPlayer_Pause 関数でポーズをかけた場合、 再生時刻のカウントアップも停止します。
（ポーズを解除すれば再度カウントアップが再開されます。）
本関数で取得可能な時刻の精度は、サーバ処理の周波数に依存します。
（時刻の更新はサーバ処理単位で行われます。）
より精度の高い時刻を取得する必要がある場合には、本関数の代わりに criAtomExPlayback_GetNumPlayedSamples 関数を使用し、 再生済みサンプル数を取得してください。

注意:

戻り値の型はCriSint64ですが、現状、32bit以上の精度はありません。
再生時刻を元に制御を行う場合、約24日で再生時刻が異常になる点に注意が必要です。
（ 2147483647 ミリ秒を超えた時点で、再生時刻がオーバーフローし、負値になります。）

AtomExプレーヤ作成時、 CriAtomExPlayerConfig 構造体の updates_time を CRI_FALSE に設定した場合、当該プレーヤから再生時刻を取得することはできなくなります。

再生中の音声が発音数制御によって消去された場合、 再生時刻のカウントアップもその時点で停止します。
また、再生開始時点で発音数制御によりボイスが割り当てられなかった場合、 本関数は正しい時刻を返しません。
（負値が返ります。）

ドライブでリードリトライ処理等が発生し、一時的に音声データの供給が途切れた場合でも、 再生時刻のカウントアップが途切れることはありません。
（データ供給停止により再生が停止した場合でも、時刻は進み続けます。）
そのため、本関数で取得した時刻を元に映像との同期を行った場合、 リードリトライ発生毎に同期が大きくズレる可能性があります。
波形データと映像の同期を厳密に取る必要がある場合は、本関数の代わりに criAtomExPlayback_GetNumPlayedSamples 関数を使用し、 再生済みサンプル数との同期を取ってください。

参照:

criAtomExPlayback_GetTime, criAtomExPlayback_GetNumPlayedSamples

フォーマットの指定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	format	フォーマット

説明:

AtomExプレーヤで再生する音声のフォーマットを指定します。
criAtomExPlayer_Start 関数で音声を再生した際、AtomExプレーヤは本関数で 指定されたフォーマットのデータを再生可能なボイスを、ボイスプールから取得します。
関数実行前のデフォルト設定値はADXフォーマットです。

備考:

本関数は、ACBファイルを使用せずに音声を再生する場合にのみセットする必要があります。
キューを再生する場合、フォーマットはキューシートから自動で取得されるため、 別途本関数を実行する必要はありません。

チャンネル数の指定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	num_channels	チャンネル数

説明:

AtomExプレーヤで再生する音声のチャンネル数を指定します。
criAtomExPlayer_Start 関数で音声を再生した際、AtomExプレーヤは本関数で 指定されたチャンネル数のデータを再生可能なボイスを、ボイスプールから取得します。
関数実行前のデフォルト設定値は2チャンネルです。

備考:

本関数は、ACBファイルを使用せずに音声を再生する場合にのみセットする必要があります。
キューを再生する場合、フォーマットはキューシートから自動で取得されるため、 別途本関数を実行する必要はありません。

サンプリングレートの指定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	sampling_rate	サンプリングレート

説明:

AtomExプレーヤで再生する音声のサンプリングレートを指定します。
criAtomExPlayer_Start 関数で音声を再生した際、AtomExプレーヤは本関数で 指定されたサンプリングレートのデータを再生可能なボイスを、ボイスプールから取得します。
関数実行前のデフォルト設定値は ::CRIATOM_DEFAULT_OUTPUT_SAMPLING_RATE です。

備考:

本関数は、ACBファイルを使用せずに音声を再生する場合にのみセットする必要があります。
キューを再生する場合、フォーマットはキューシートから自動で取得されるため、 別途本関数を実行する必要はありません。

サウンドレンダラタイプの指定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	type	サウンドレンダラタイプ

説明:

AtomExプレーヤで再生する音声の出力先サウンドレンダラを指定します。
criAtomExPlayer_Start 関数で音声を再生した際、AtomExプレーヤは本関数で 指定されたサウンドレンダラから出力するボイスを、ボイスプールから取得します。
関数実行前のデフォルト設定値は CRIATOM_SOUND_RENDERER_ANY です。

備考:

CRIATOM_SOUND_RENDERER_ANY を指定した場合、プレーヤはボイスの出力先に関係なく、 最初に見つかったボイスプールを使用して発音を行います。

参照:

CriAtomSoundRendererType

グループ番号の指定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	group_no	グループ番号

説明:

発音時にボイスをどのボイスリミットグループから取得するかを指定します。
group_no に CRIATOMEXPLAYER_NO_GROUP_LIMITATION を指定した場合、 プレーヤはボイスリミットグループによる制限を受けなくなります。
（空きボイスがあるか、または自身より低プライオリティのボイスがあれば、 ボイスリミットグループに関係なくボイスを取得します。）

備考:

criAtomExPlayer_Start 関数で再生を開始した際、 指定したボイスリミットグループのボイスが全て使用中だった場合、 再生した音声が発音されるかどうかは、ボイスプライオリティ制御によって決まります。
（ボイスプライオリティの詳細は criAtomExPlayer_SetVoicePriority 関数の説明をご参照ください。）

キュー再生時に本関数を呼び出すと、データ側に設定されているボイスリミットグループ設定を上書きします（データ側の設定値は無視されます）。
ただし、group_no に CRIATOMEXPLAYER_NO_GROUP_LIMITATION を指定した場合はデータ側に設定されているボイスリミットグループを参照します。

参照:

CRIATOMEXPLAYER_NO_GROUP_LIMITATION, criAtomExPlayer_Start, criAtomExPlayer_SetVoicePriority, criAtomExPlayer_SetVoiceControlMethod

ボイス制御方法の指定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	method	ボイス制御方法

説明:

AtomExプレーヤにボイス制御方法を設定します。
本関数でボイス制御方法をセット後、 criAtomExPlayer_Start 関数で音声を再生すると、 当該プレーヤで再生する波形データには、本関数で指定した制御方式が適用されます。

ボイス制御方法（ method ）には、以下のいずれかが指定可能です。

• CRIATOMEX_PREFER_LAST
• CRIATOMEX_PREFER_FIRST
• CRIATOMEX_PREFER_DATA

空きボイスがない状態で再生中のボイスと同プライオリティの音声を再生した場合、 ボイス制御方式に CRIATOMEX_PREFER_LAST が指定されていれば、 再生中のボイスを停止して新規に音声の再生を開始します。
同条件で CRIATOMEX_PREFER_FIRST が指定されている場合、 新規の再生リクエストがキャンセルされ、既存のボイスが再生を続けます。

CRIATOMEX_PREFER_DATA が指定されている場合、 データにあらかじめ設定されているボイス制御方式（オーサリングツール上で設定した値） が使用されます。
CRIATOMEX_PREFER_DATA を指定しているにもかかわらず、単体ファイル再生等、 データにボイス制御方式が設定されていない場合、 後着優先（ CRIATOMEX_PREFER_LAST ）でボイスが制御されます。

関数実行前のデフォルト設定値はデータ依存（ CRIATOMEX_PREFER_DATA ）です。

備考:

AtomExプレーヤが波形データを再生しようとした際、 当該波形データが所属するボイスリミットグループの発音数が上限に達していた場合や、 ボイスプール内のボイスが全て使用中であった場合、 ボイスプライオリティによる発音制御が行われます。

本関数でセットしたボイス制御方式は、発音制御の際、 再生しようとした波形データのプライオリティと、 再生中の波形データのプライオリティが同プライオリティであった場合に考慮されます。
（ボイスプライオリティによる発音制御の詳細は criAtomExPlayer_SetVoicePriority 関数の説明をご参照ください。）

参照:

criAtomExPlayer_Start, criAtomExPlayer_SetVoicePriority

ボイスプール識別子の指定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	identifier	ボイスプール識別子

説明:

発音時にボイスをどのボイスプールから取得するかを指定します。
本関数を実行すると、プレーヤは以降指定されたボイスプール識別子に一致する ボイスプールからのみボイスを取得します。

備考:

ボイスプール識別子のデフォルト値は 0 です。

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

参照:

CriAtomExStandardVoicePoolConfig, criAtomExVoicePool_AllocateStandardVoicePool, criAtomExPlayer_ResetParameters

HCAデコード先ミキサIDの指定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	mixer_id	ミキサID

説明:

HCA-MXのデコード先ミキサIDを指定します。

備考:

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

注意:

本関数は HCA-MX ボイスを使用する場合にのみ効果があります。
（他のボイスを使用する場合、本関数の設定値は無視されます。）

ミキサIDは再生開始前に設定する必要があります。
既に再生が開始された音声に対し、後からミキサIDを変更することはできません。

参照:

CriAtomExHcaMxVoicePoolConfig, criAtomExVoicePool_AllocateHcaMxVoicePool, criAtomExPlayer_ResetParameters

ASRラックIDの指定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	rack_id	ASRラックID

説明:

ボイスの出力先ASRラックIDを指定します。
複数のASRラックIDを指定したい場合、 criAtomExPlayer_SetAsrRackIdArray 関数を使用してください。

備考:

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

キュー再生時に本関数を呼び出すと、データ側に設定されているパラメータパレットのASRラックID設定を上書きします（データ側の設定値は無視されます）。

注意:

本関数は ボイスのサウンドレンダラタイプにASRを使用する場合にのみ効果があります。
（他のボイスを使用する場合、本関数の設定値は無視されます。）

ASRラックIDは再生開始前に設定する必要があります。
既に再生が開始された音声に対し、後からASRラックIDを変更することはできません。

criAtomExPlayer_SetAsrRackIdArray 関数実行後に本関数を実行すると、 criAtomExPlayer_SetAsrRackIdArray 関数にて 設定した複数のASRラックID設定は上書きされます。

HCA-MX用にエンコードされた音声データには、本関数の設定が適用されません。
HCA-MX用にエンコードされた音声データについて出力先ASRラックIDを設定する場合、 criAtomExHcaMx_SetAsrRackId 関数を使用して、HCA-MXミキサ自体の出力先ASRラックIDを設定してください。

参照:

criAtomExAsr_CreateRack, criAtomExPlayer_SetAsrRackIdArray, criAtomExHcaMx_SetAsrRackId, criAtomExPlayer_ResetParameters

複数のASRラックIDの指定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	rack_id_array	ASRラックIDの配列
[in]	num_racks	ASRラックID指定数

説明:

ボイスの出力先ASRラックIDを複数指定します。
CRIATOMEXPLAYER_MAX_ASR_RACKS に定義された数分のASRラックIDを指定することが可能です。
単一のASRラックIDを指定する場合は、 criAtomExPlayer_SetAsrRackId 関数を使用することでも指定可能です。

備考:

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

キュー再生時に本関数を呼び出すと、データ側に設定されているパラメータパレットのASRラックID設定を上書きします（データ側の設定値は無視されます）。

注意:

本関数は ボイスのサウンドレンダラタイプにASRを使用する場合にのみ効果があります。
（他のボイスを使用する場合、本関数の設定値は無視されます。）

ASRラックIDは再生開始前に設定する必要があります。
既に再生が開始された音声に対し、後からASRラックIDを変更することはできません。

複数のASRラックIDを指定したプレーヤを再生した場合、ボイスはその指定されたASRラックIDの数だけ使用されます。
そのため、事前に指定するASRラックID数分のボイスを確保しておく必要があります。

criAtomExPlayer_SetData 関数等を使用したキュー再生以外の再生時では、本関数にて指定した複数のASRラックIDの内、 1つ目（配列のインデックスが0）の要素に格納されているASRラックIDのみが適用されます。

criAtomExPlayer_SetAsrRackId 関数実行後に本関数を実行すると、 criAtomExPlayer_SetAsrRackId 関数にて 設定したASRラックID設定は上書きされます。

HCA-MX用にエンコードされた音声データには、本関数の設定が適用されません。
HCA-MX用にエンコードされた音声データについて出力先ASRラックIDを設定する場合、 criAtomExHcaMx_SetAsrRackId 関数を使用して、HCA-MXミキサ自体の出力先ASRラックIDを設定してください。

参照:

criAtomExAsr_CreateRack, criAtomExPlayer_SetAsrRackId, criAtomExHcaMx_SetAsrRackId, criAtomExPlayer_ResetParameters

再生開始位置の指定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	start_time_ms	再生開始位置（ミリ秒指定）

説明:

AtomExプレーヤで再生する音声について、再生を開始する位置を指定します。
音声データを途中から再生したい場合、再生開始前に本関数で再生開始位置を 指定する必要があります。

再生開始位置の指定はミリ秒単位で行います。
例えば、 start_time_ms に 10000 をセットして本関数を実行すると、 次に再生する音声データは 10 秒目の位置から再生されます。

備考:

音声データ途中からの再生は、音声データ先頭からの再生に比べ、発音開始の タイミングが遅くなります。
これは、一旦音声データのヘッダを解析後、指定位置にジャンプしてからデータを読み 直して再生を開始するためです。

注意:

start_time_ms には64bit値をセット可能ですが、現状、32bit以上の再生時刻を 指定することはできません。

機種固有の音声フォーマットについても、再生開始位置を指定できない場合があります。

再生開始位置を指定してシーケンスを再生した場合、指定位置よりも前に配置された 波形データは再生されません。
（シーケンス内の個々の波形が途中から再生されることはありません。）

シーケンス準備時間の指定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	seq_prep_time_ms	シーケンス準備時間（ミリ秒指定）

説明:

AtomExプレーヤでシーケンスを再生する場合の、個々のシーケンス要素を再生開始する間に前もって再生準備を行う時間を指定します。
例えば、シーケンス要素がストリーミング再生である場合、指定時間分、前もってファイルの読み込みを行うため、 ストリームによる再生遅延を軽減することができます。
再生開始位置の指定はミリ秒単位で行います。
例えば、 seq_prep_time_ms に 1000 をセットして本関数を実行すると、 実際再生開始タイミングより1秒前に再生準備処理を行います。

備考:

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

注意:

本関数は再生開始前に呼び出す必要があります。再生開始後に呼び出しても既に再生中のシーケンスに対しての適用は行われません。 本関数でシーケンス準備時間を設定して再生を開始すると、再生開始時にシーケンスデータの再生開始位置から設定値までの発音がまとめて 処理されます。このため、再生開始位置から設定値までの間にタイミングをずらして発音を行うような設定があっても、これらは再生開始時に 同期しての再生が行われます。
本関数でシーケンス準備時間を設定すると、ブロックの遷移の判定も指定時間分前にずれます。 例えば、本関数で1秒を設定してブロックデータを再生中に次ブロックの指定を行っても、 現在の再生位置から1秒以内のブロック遷移タイミングでは遷移せず、その次の遷移タイミングで遷移します。

参照:

criAtomExPlayer_ResetParameters

同期再生IDの設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	playback_id	同期対象となる再生ID

説明:

AtomExプレーヤで再生する音声を、指定した再生IDの音声に同期させます。
本関数で再生IDを設定後に音声を再生すると、 その音声は指定された再生IDと同じ再生位置にシークして再生を始めます。

備考:

同期対象の再生IDが無効な場合、音声データの先頭から再生が開始されます。
playback_id に CRIATOMEX_INVALID_PLAYBACK_ID を指定すると、 再生IDの登録がクリアされます。

注意:

本関数は、単体の波形データを再生する場合にのみ利用可能です。
シーケンスデータには利用できません。
（シーケンスデータに対して使用した場合、 シーケンス中で最初に見つかった波形データに対して同期処理が行われてしまいます。）

本関数で再生位置を調整可能なコーデックは、以下のコーデックのみです。

• ADX
• HCA
• Wave

他のコーデックについては、本関数を用いた同期再生は行えません。
（HCA-MXや、ハードウェアデコードを行う音声コーデックでは、本機能は利用できません。）

本機能による再生位置の同期は、可能な限りサンプル単位で行いますが、 1サンプルの誤差なく結合することを保証するものではありません。
（ミリ秒レベルのズレが許容される場合にのみご利用ください。）
また、再生位置の同期精度は、プラットフォームによっても異なります。

本関数と criAtomExPlayer_SetStartTime 関数を併用することはできません。
本関を使用した場合、音声の再生開始位置はライブラリ内で自動的に調整されます。
そのため、本関数と criAtomExPlayer_SetStartTime 関数を併用することはできません。
（ criAtomExPlayer_SetStartTime 関数の設定は無視されます。）

本関数を使用して再生を行った場合、再生開始時にノイズが入る場合があります。
本機能を使用する場合、可能な限りフェードイン処理を併用してください。

本関数を使用してキュー再生を行った場合、 criAtomExPlayer_GetTime 関数や criAtomExPlayback_GetTime 関数による再生時刻の取得は正しく行えません。
再生時刻の確認には、これらの関数の代わりに、 criAtomExPlayback_GetNumPlayedSamples 関数をご利用ください。

参照:

criAtomExPlayback_GetNumPlayedSamples

シーケンス再生レシオの設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	playback_ratio	シーケンス再生レシオ

説明:

AtomExプレーヤで再生するシーケンスの再生レシオを設定します。
再生レシオの設定範囲は 0.0f 〜 2.0f です。
範囲外の値を設定した場合は、下限値もしくは上限値が設定されます。

備考:

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

注意:

本関数による設定値は、シーケンスタイプのキューを再生する場合にのみ適用されます。
シーケンスにて発音する波形データの再生レシオには利用できません。

参照:

criAtomExPlayer_ResetParameters

ループ回数の制限

引数:

[in]	player	AtomExプレーヤハンドル
[in]	count	ループ制限回数

説明:

波形データのループ再生回数を制限します。
例えば、countに1を指定した場合、ループ波形データは1回のみループして再生を終了します。
（ループエンドポイントに到達後、1回だけループスタート位置に戻ります。）

備考:

デフォルト状態では、ループポイント付きの音声データは無限にループ再生されます。
ループ回数を一旦制限した後、ループ回数を再度無限回に戻したい場合には、 count に CRIATOMEXPLAYER_NO_LOOP_LIMITATION を指定してください。

count に CRIATOMEXPLAYER_IGNORE_LOOP を指定することで、 ループポイント付きの音声データをループさせずに再生することも可能です。

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

注意:

ループ制限回数の指定は、音声再生開始前に行う必要があります。
再生中に本関数を実行しても、ループ回数は変更されません。
再生中の任意のタイミングでループ再生を停止したい場合、 ループ再生ではなく、シームレス連結再生で制御を行ってください。

本関数で指定したループ制限回数は、 あらかじめループポイントが設定された波形データを再生する場合にのみ適用されます。
波形データ自体にループポイントが設定されていない場合、 本関数を実行しても何の効果もありません。

本関数を使用してループ回数を指定した場合でも、 ループ終了時にループエンドポイント以降の波形データが再生されることはありません。
（指定回数分ループした後、ループエンドポイントで再生が停止します。）

例外的に、以下の条件を満たす場合に限り、（ループはされませんが） ワンショットでループポイント以降のデータを含めて再生することが可能です。

• criatomencd.exe で -nodelterm を指定してデータをエンコードする。
• 本関数に CRIATOMEXPLAYER_IGNORE_LOOP を指定してから再生を行う。

本関数でループ回数を制限できるのは、ADXコーデックとHCAコーデックのみです。
プラットフォーム依存の音声コーデックに対して本関数を実行しないでください。
（再生が終了しない、ノイズが発生する等の問題が発生します。）

参照:

criAtomExPlayer_ResetParameters

再生パラメータの更新（再生中の音全て）

引数:

[in]

player

AtomExプレーヤハンドル

説明:

AtomExプレーヤに設定されている再生パラメータ（AISACコントロール値を含む）を使用して、 このAtomExプレーヤで再生中の音全ての再生パラメータを更新します。

例:

 CriFloat32 volume;
 // Start playback
 criAtomExPlayer_Start(player);
                :
 criAtomExPlayer_Start(player);
                :
 // Change Volume
 volume = 0.3f;
 criAtomExPlayer_SetVolume(player, volume);
 criAtomExPlayer_UpdateAll(player);

参照:

criAtomExPlayer_Update

再生パラメータの更新（再生ID指定）

引数:

[in]	player	AtomExプレーヤハンドル
[in]	id	再生ID

説明:

AtomExプレーヤに設定されている再生パラメータ（AISACコントロール値を含む）を使用して、 再生IDによって指定された音声の再生パラメータを更新します。

例:

 CriFloat32 volume;
 // Start playback
 id = criAtomExPlayer_Start(player);
                :
 // Change Volume
 volume = 0.3f;
 criAtomExPlayer_SetVolume(player, volume);
 criAtomExPlayer_Update(player, id);

備考:

再生IDは、このAtomExプレーヤで再生された音声を指している必要があります。

参照:

criAtomExPlayer_UpdateAll

再生パラメータの初期化

引数:

[in]

player

AtomExプレーヤハンドル

説明:

AtomExプレーヤに設定されている再生パラメータ（AISACコントロール値を含む）をリセットし、初期状態（未設定状態）に戻します。
本関数呼び出し後、::criAtomExPlayer_Start 関数により再生開始すると、初期状態の再生パラメータで再生されます。

例:

 CriFloat32 volume;
 // Start playback
 id = criAtomExPlayer_Start(player);
                :
 // Change Volume
 volume = 0.3f;
 criAtomExPlayer_SetVolume(player, volume);
 criAtomExPlayer_Update(player, id);
                :
 // Reset Parameters
 criAtomExPlayer_ResetParameters(player);
 id = criAtomExPlayer_Start(player);

備考:

本関数呼び出し後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出したとしても、すでに再生されている音声のパラメータは初期値には戻りません。
すでに再生されている音声のパラメータを変える場合は、明示的に::criAtomExPlayer_SetVolume 関数等を呼び出してください。

本関数でリセットされるパラメータは、各パラメータの設定を行う関数に対象かどうかを記載しているため、そちらを参照して下さい。

なお、本関数では3D音源ハンドルや3Dリスナーハンドル自体のもつパラメータ（位置等）はリセットされません。「AtomExプレーヤに設定されているハンドルが何か」という設定だけがリセットされます。 これらのハンドル自体のパラメータをリセットしたい場合には、それぞれのハンドルのパラメータリセット関数を呼び出してください。

参照:

criAtomEx3dSource_ResetParameters, criAtomEx3dListener_ResetParameters

パラメータの取得（浮動小数点数）

引数:

[in]	player	AtomExプレーヤハンドル
[in]	id	パラメータID

戻り値:

パラメータ設定値

説明:

AtomExプレーヤに設定されている各種パラメータの値を取得します。
値は浮動小数点数で取得されます。

参照:

CriAtomExParameterId, criAtomExPlayer_GetParameterUint32, criAtomExPlayer_GetParameterSint32

パラメータの取得（符号なし整数）

引数:

[in]	player	AtomExプレーヤハンドル
[in]	id	パラメータID

戻り値:

パラメータ設定値

説明:

AtomExプレーヤに設定されている各種パラメータの値を取得します。
値は符号なし整数で取得されます。

参照:

CriAtomExParameterId, criAtomExPlayer_GetParameterFloat32, criAtomExPlayer_GetParameterSint32

パラメータの取得（符号付き整数）

引数:

[in]	player	AtomExプレーヤハンドル
[in]	id	パラメータID

戻り値:

パラメータ設定値

説明:

AtomExプレーヤに設定されている各種パラメータの値を取得します。
値は符号付き整数で取得されます。

参照:

CriAtomExParameterId, criAtomExPlayer_GetParameterFloat32, criAtomExPlayer_GetParameterUint32

ボリュームの設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	volume	ボリューム値

説明:

出力音声のボリュームを指定します。
本関数でボリュームを設定後、::criAtomExPlayer_Start 関数で再生を開始すると、 設定されたボリュームで音声が再生されます。
またボリューム設定後に criAtomExPlayer_Update 関数や criAtomExPlayer_UpdateAll 関数を呼び出すことで、すでに再生された音声のボリュームを更新することも可能です。

ボリューム値は音声データの振幅に対する倍率です（単位はデシベルではありません）。
例えば、1.0fを指定した場合、原音はそのままのボリュームで出力されます。
0.5fを指定した場合、原音波形の振幅を半分にしたデータと同じ音量（-6dB）で 音声が出力されます。
0.0fを指定した場合、音声はミュートされます（無音になります）。
ボリュームのデフォルト値は1.0fです。

例:

    ：
 // ボリュームの設定
 criAtomExPlayer_SetVolume(player, 0.5f);

 // 再生の開始
 // 備考）ボリュームはプレーヤに設定された値（＝0.5f）で再生される。
 id = criAtomExPlayer_Start(player);
    ：
 // ボリュームの変更
 // 注意）この時点では再生中の音声のボリュームは変更されない。
 criAtomExPlayer_SetVolume(player, 0.3f);

 // プレーヤに設定されたボリュームを再生中の音声にも反映
 criAtomExPlayer_Update(player, id);
    ：

備考:

ボリューム値には0.0f以上の値が設定可能です。
（Atomライブラリ Ver.1.21.07より、 ボリューム値に1.0fを超える値を指定できるようになりました。）
1.0fを超える値をセットした場合、プラットフォームによっては、 波形データを元素材よりも大きな音量で再生可能です。
ボリューム値に0.0f未満の値を指定した場合、値は0.0fにクリップされます。
（ボリューム値に負の値を設定した場合でも、 波形データの位相が反転されることはありません。）

キュー再生時、データ側にボリュームが設定されている場合に本関数を呼び出すと、 データ側に設定されている値と本関数による設定値とを乗算した値が適用されます。
例えば、データ側のボリュームが0.8f、AtomExプレーヤのボリュームが0.5fの場合、 実際に適用されるボリュームは0.4fになります。

デシベルで設定したい場合、以下の計算式で変換してから設定してください。

 volume = powf(10.0f, db_vol / 20.0f);

※db_volがデシベル値、volumeがボリューム値です。

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

注意:

1.0fを超えるボリュームを指定する場合、以下の点に注意する必要があります。

• プラットフォームごとに挙動が異なる可能性がある。
• 音割れが発生する可能性がある。

本関数に1.0fを超えるボリューム値を設定した場合でも、 音声が元の波形データよりも大きな音量で再生されるかどうかは、 プラットフォームや音声圧縮コーデックの種別によって異なります。
そのため、マルチプラットフォームタイトルでボリュームを調整する場合には、 1.0fを超えるボリューム値を使用しないことをおすすめします。
（1.0fを超えるボリューム値を指定した場合、同じ波形データを再生した場合でも、 機種ごとに異なる音量で出力される可能性があります。）

また、音量を上げることが可能な機種であっても、 ハードウェアで出力可能な音量には上限があるため、 音割れによるノイズが発生する可能性があります。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, criAtomExPlayer_ResetParameters

ピッチの設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	pitch	ピッチ（セント単位）

説明:

出力音声のピッチを指定します。
本関数でピッチを設定後、::criAtomExPlayer_Start 関数で再生を開始すると、 設定されたピッチで音声が再生されます。
またピッチ後に criAtomExPlayer_Update 関数や criAtomExPlayer_UpdateAll 関数を呼び出すことにより、すでに再生された音声のピッチを更新することが可能です。

ピッチはセント単位で指定します。
1セントは1オクターブの1/1200です。半音は100セントです。
例えば、100.0fを指定した場合、ピッチが半音上がります。-100.0fを指定した場合、 ピッチが半音下がります。
ピッチのデフォルト値は0.0fです。

例:

    ：
 // ピッチの設定
 criAtomExPlayer_SetPitch(player, 100.0f);

 // 再生の開始
 // 備考）ピッチはプレーヤに設定された値（＝0.5f）で再生される。
 id = criAtomExPlayer_Start(player);
    ：
 // ピッチの変更
 // 注意）この時点では再生中の音声のピッチは変更されない。
 criAtomExPlayer_SetPitch(player, -200.0f);

 // プレーヤに設定されたピッチを再生中の音声にも反映
 criAtomExPlayer_Update(player, id);
    ：

備考:

キュー再生時、データ側にピッチが設定されている場合に本関数を呼び出すと、 データ側に設定されている値と本関数による設定値とを加算した値が適用されます。
例えば、データ側のピッチが-100.0f、AtomExプレーヤのピッチが200.0fの場合、 実際に適用されるピッチは100.0fになります。
サンプリングレートの周波数比率で設定したい場合、以下の計算式で変換してから設定してください。

 pitch = 1200.0f*logf(freq_ratio)/logf(2.0f);

※freq_ratioが周波数比率、pitchがピッチの値です。

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

注意:

HCA-MX用にエンコードされた音声データは、ピッチの変更ができません。
（本関数を実行しても、ピッチは変わりません。）
ピッチを変更したい音声については、ADXやHCA等、他のコーデックでエンコードを行ってください。

設定可能な最大ピッチは、音声データのサンプリングレートとボイスプールの最大サンプリングレートに依存します。
例えば、音声データのサンプリングレートが24kHzで、ボイスプールの最大サンプリングレートが48kHzの場合、 設定可能な最大ピッチは1200(周波数比率2倍)になります。

再生サンプリングレートの上下によりピッチを実装しているため、 ピッチを変更すると音程と一緒に再生速度も変化します。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, criAtomExPlayer_SetMaxPitch, criAtomExPlayer_ResetParameters

最大ピッチの設定

引数:

[in]	player	Atomプレーヤハンドル
[in]	pitch	最大ピッチ

説明:

音声の最大ピッチを設定します。
本関数で最大ピッチを指定することで、指定範囲内でのピッチ変更が即座に反映されるようになります。

備考:

Atom Ver.2.10.00以前のライブラリでは、ピッチを上げた際に音が途切れる （再生速度が速くなった結果、音声データの供給が足りなくなる）ケースがありました。
この対策として、Atom Ver.2.10.00ではピッチを上げても音が途切れないよう、 音声を充分にバッファリングしてからピッチを上げるよう動作を変更しています。
修正により、ピッチ操作によって音が途切れることはなくなりましたが、 ピッチを上げる際にバッファリングを待つ時間分だけピッチ変更が遅れる形になるため、 音の変化が以前のバージョンと比べて緩慢になる可能性があります。
（短時間にピッチを上げ下げするケースにおいて、音の鳴り方が変わる可能性があります。）

本関数で最大ピッチをあらかじめ設定した場合、 指定された速度を想定して常にバッファリングが行われるようになるため、 （指定された範囲内の周波数においては）バッファリングなしにピッチ変更が即座に行われます。
短時間にピッチを上げ下げするケースについては、 予想される最大ピッチをあらかじめ本関数で設定してから再生を行ってください。

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

参照:

criAtomExPlayer_SetPitch, criAtomExPlayer_ResetParameters

パンニング3D角度の設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	pan3d_angle	パンニング3D角度（-180.0f〜180.0f：度単位）

説明:

パンニング3D角度を指定します。
本関数でパンニング3D角度を設定後、::criAtomExPlayer_Start 関数により再生開始すると、設定されたパンニング3D角度で再生されます。
また設定後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生された音声のパンニング3D角度を更新することができます。

角度は度単位で指定します。
前方を0度とし、右方向（時計回り）に180.0f、左方向（反時計回り）に-180.0fまで設定できます。
例えば、45.0fを指定した場合、右前方45度に定位します。-45.0fを指定した場合、左前方45度に定位します。

例:

    ：
 // パンニング3D角度の設定
 criAtomExPlayer_SetPan3dAngle(player, 45.0f);

 // 再生の開始
 // 備考）パンニング3D角度はプレーヤに設定された値（＝45.0f）で再生される。
 id = criAtomExPlayer_Start(player);
    ：
 // パンニング3D角度の変更
 // 注意）この時点では再生中の音声のパンニング3D角度は変更されない。
 criAtomExPlayer_SetPan3dAngle(player, -45.0f);

 // プレーヤに設定されたパンニング3D角度を再生中の音声にも反映
 criAtomExPlayer_Update(player, id);
    ：

備考:

キュー再生時、データ側にパンニング3D角度が設定されている場合に本関数を呼び出すと、 データ側に設定されている値と本関数による設定値とを加算した値が適用されます。
例えば、データ側のパンニング3D角度が15.0f、AtomExプレーヤのパンニング3D角度が30.0fの場合、 実際に適用されるパンニング3D角度は45.0fになります。
実際に適用されるパンニング3D角度が180.0fを超える値になった場合、値を-360.0fして範囲内に納めます。
同様に、実際に適用されるボリューム値が-180.0f未満の値になった場合は、値を+360.0fして範囲内に納めます。
（+360.0f, -360.0fしても定位は変わらないため、実質的には-180.0f〜180.0fの範囲を超えて設定可能です。）

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, criAtomExPlayer_ResetParameters

パンニング3D距離の設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	pan3d_interior_distance	パンニング3D距離（-1.0f〜1.0f）

説明:

パンニング3Dでインテリアパンニングを行う際の距離を指定します。
本関数でパンニング3D距離を設定後、::criAtomExPlayer_Start 関数により再生開始すると、設定されたパンニング3D距離で再生されます。
また設定後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生された音声のパンニング3D距離を更新することができます。

距離は、リスナー位置を0.0f、スピーカーの配置されている円周上を1.0fとして、-1.0f〜1.0fの範囲で指定します。
負値を指定すると、パンニング3D角度が180度反転し、逆方向に定位します。

例:

    ：
 // パンニング3D距離の設定
 criAtomExPlayer_SetPan3dInteriorDistance(player, 0.5f);

 // 再生の開始
 // 備考）パンニング3D距離はプレーヤに設定された値（＝0.5f）で再生される。
 id = criAtomExPlayer_Start(player);
    ：
 // パンニング3D距離の変更
 // 注意）この時点では再生中の音声のパンニング3D距離は変更されない。
 // 備考）以下の処理はパン3D角度を180度反転するのと等価
 criAtomExPlayer_SetPan3dInteriorDistance(player, -0.5f);

 // プレーヤに設定されたパンニング3D距離を再生中の音声にも反映
 criAtomExPlayer_Update(player, id);
    ：

備考:

キュー再生時、データ側にパンニング3D距離が設定されている場合に本関数を呼び出すと、 データ側に設定されている値と本関数による設定値とを乗算した値が適用されます。
例えば、データ側のパンニング3D距離が0.8f、AtomExプレーヤのパンニング3D距離が0.5fの場合、 実際に適用されるパンニング3D距離は0.4fになります。
実際に適用されるパンニング3D距離が1.0fを超える値になった場合、値は1.0fにクリップされます。
同様に、実際に適用されるパンニング3D距離が-1.0f未満の値になった場合も、値は-1.0fにクリップされます。

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, criAtomExPlayer_ResetParameters

パンニング3Dボリュームの設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	pan3d_volume	パンニング3Dボリューム（0.0f〜1.0f）

説明:

パンニング3Dのボリュームを指定します。
本関数でパンニング3Dボリュームを設定後、::criAtomExPlayer_Start 関数により再生開始すると、 設定されたパンニング3Dボリュームで再生されます。
また設定後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生された音声のパンニング3Dボリュームを更新することができます。

パンニング3Dボリュームは、パンニング3D成分と、 センター／LFEへの出力レベルとを個別に制御する場合に使用します。
例えば、センドレベルで常にLFEから一定のボリュームで出力させておき、 定位はパンニング3Dでコントロールするような場合です。
値の範囲や扱いは、通常のボリュームと同等です。::criAtomExPlayer_SetVolume 関数を参照してください。

例:

    ：
 // パンニング3Dボリュームの設定
 criAtomExPlayer_SetPan3dVolume(player, 0.8f);

 // 再生の開始
 // 備考）パンニング3Dボリュームはプレーヤに設定された値（＝0.5f）で再生される。
 id = criAtomExPlayer_Start(player);
    ：
 // パンニング3Dボリュームの変更
 // 注意）この時点では再生中の音声のパンニング3Dボリュームは変更されない。
 criAtomExPlayer_SetPan3dVolume(player, 0.7f);

 // プレーヤに設定されたパンニング3Dボリュームを再生中の音声にも反映
 criAtomExPlayer_Update(player, id);
    ：

備考:

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, criAtomExPlayer_SetVolume, criAtomExPlayer_ResetParameters

パンタイプの設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	pan_type	パンタイプ

説明:

パンタイプを指定します。
本関数でパンタイプを設定後、::criAtomExPlayer_Start 関数により再生開始すると、設定されたパンタイプで再生されます。
また設定後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生された音声のパンタイプを更新することができます。

備考:

キュー再生時に本関数を呼び出すと、データ側に設定されているパンタイプ設定を上書きします（データ側の設定値は無視されます）。
通常はデータ側でパンタイプが設定されているため、本関数を呼び出す必要はありません。
ACBファイルを使用せずに音声を再生する場合に、3Dポジショニング処理を有効にするためには、本関数で::CRIATOMEX_PAN_TYPE_3D_POSを設定してください。

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, CriAtomExPanType, criAtomExPlayer_ResetParameters

パンニング時の出力スピーカータイプ設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	pan_speaker_type	パンニング時の出力スピーカータイプ

説明:

パンニング時の出力スピーカータイプを指定します。
本関数でパンニング時の出力スピーカータイプを設定後、::criAtomExPlayer_Start 関数により再生開始すると、設定された出力スピーカータイプでパンニング計算されます。
また設定後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生された音声の出力スピーカータイプを更新することができます。

備考:

本関数の設定はパン3Dと3Dポジショニングにおけるパンニング計算に影響します。
ライブラリ初期化時のデフォルト値は4chパンニング（::CRIATOMEX_PAN_SPEAKER_TYPE_4CH）です。
デフォルト値は::criAtomExPlayer_ChangeDefaultPanSpeakerType 関数にて変更可能です。
ステレオスピーカーのプラットフォームでは、どれを選んだとしても最終的にはステレオにダウンミックスされます。

本パラメータはデータ側には設定できないため、常に本関数の設定値が適用されます。

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, CriAtomExPanSpeakerType, criAtomExPlayer_ResetParameters

MixDownCenterボリュームオフセット値の設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	mixdown_center_volume_offset	MixDownCenterボリュームのオフセット値

説明:

Center, LFE以外の信号をモノラルにミックスしてCenterに出力するためのボリューム値を設定します。
本関数による設定値は、CRI Atom Craftによるデータ設定値に対して加算適用されます。
本関数の第二引数mixdown_center_volume_offsetには0〜1の浮動小数点値で出力ボリュームを設定してください。

注意:

設定値の範囲外確認は行われません。範囲外を設定する際には以下の点に注意してください。
1より大きい値：出力振幅値の増幅によりクリッピングノイズ等が発生することがあります。
負値：データ設定値との和が負となった場合は、正値結果に対して位相を反転した結果が出力されます。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, CriAtomExPanSpeakerType, criAtomExPlayer_ResetParameters

MixDownLFEボリュームオフセット値の設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	mixdown_lfe_volume_offset	MixDownLFEボリュームのオフセット値

説明:

Center, LFE以外の信号をモノラルにミックスしてLFEに出力するためのボリューム値を設定します。
本関数による設定値は、CRI Atom Craftによるデータ設定値に対して加算適用されます。
本関数の第二引数mixdown_lfe_volume_offsetには0〜1の浮動小数点値で出力ボリュームを設定してください。

注意:

設定値の範囲外確認は行われません。範囲外を設定する際には以下の点に注意してください。
1より大きい値：出力振幅値の増幅によりクリッピングノイズ等が発生することがあります。
負値：データ設定値との和が負となった場合は、正値結果に対して位相を反転した結果が出力されます。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, CriAtomExPanSpeakerType, criAtomExPlayer_ResetParameters

パンニング時の出力スピーカータイプ設定のデフォルト値変更

引数:

[in]

pan_speaker_type

パンニング時の出力スピーカータイプ

説明:

パンニング時の出力スピーカータイプのデフォルト値を変更します。
criAtomExPlayer_SetPanSpeakerType 関数を実行していないAtomExプレーヤは、全て本関数で設定した出力スピーカータイプで再生されます。

備考:

本関数の設定はパン3Dと3Dポジショニングにおけるパンニング計算に影響します。
ライブラリ初期化時のデフォルト値は4chパンニング（::CRIATOMEX_PAN_SPEAKER_TYPE_4CH）です。
ステレオスピーカーのプラットフォームでは、どれを選んだとしても最終的にはステレオにダウンミックスされます。

本パラメータはデータ側には設定できないため、常に本関数の設定値が適用されます。

注意:

再生中の音声がデフォルト値を参照するタイミングはユーザーの操作に依存します。
そのため、再生中にデフォルト値を変更した場合、意図したタイミングで変更が反映されるとは限りません。
本関数を使用する場合、初期化時など音声を再生する前に実行するようにしてください。

参照:

criAtomExPlayer_SetPanSpeakerType, CriAtomExPanSpeakerType

パンニング時の角度タイプ設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	pan_angle_type	パンニング時の角度タイプ

説明:

パンニング時の角度タイプを指定します。
角度タイプは、マルチチャンネル（ステレオ、5.1ch等）の音声素材をパンニングするときに、各入力チャンネルをどのような角度として扱うかを表します。
本関数でパンニング時の角度タイプを設定後、::criAtomExPlayer_Start 関数により再生開始すると、設定された角度タイプでパンニング計算されます。
また設定後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生された音声の角度タイプを更新することができます。

備考:

本関数の設定はパン3Dと3Dポジショニングにおけるパンニング計算に影響します。
デフォルト値はオフセット（::CRIATOMEX_PAN_ANGLE_TYPE_OFFSET）です。
本関数は、主にはCRI Audioとの互換用に使用します。 本関数で CRIATOMEX_PAN_ANGLE_TYPE_FIX を設定することで、CRI Audioでのパン3D計算と同じ挙動になります。

本パラメータはデータ側には設定できないため、常に本関数の設定値が適用されます。

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, CriAtomExPanAngleType, criAtomExPlayer_ResetParameters

パンニング時の音の広がり設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	spread	マルチチャンネル音声の広がり

説明:

パンニング時の音の広がりを指定します。
マルチチャンネル（ステレオ、5.1ch等）の音声素材をパンニングするときに、各入力チャンネル間の角度をどれだけ広げるかを指定します。
引数 spread の値域は 0.0 〜 1.0 です。デフォルト値は 1.0 です。
例えばステレオ音声を広がり0.5で再生すると、正面から見て左チャンネルは-15度(-30度*0.5)、右チャンネルは15度(30度*0.5)に定位するようパンニング計算されます。
モノラル音声には影響しません。

備考：

本関数でパンニング時の角度タイプを設定後、::criAtomExPlayer_Start 関数により再生開始すると、設定された広がりでパンニング計算されます。
また設定後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生された音声の広がりを更新することができます。

本パラメータはデータ側には設定できないため、常に本関数の設定値が適用されます。

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, criAtomExPlayer_ResetParameters

センドレベルの設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	ch	チャンネル番号
[in]	spk	スピーカーID
[in]	level	センドレベル値（0.0f〜1.0f）

説明:

センドレベルを指定します。
センドレベルは、音声データの各チャンネルの音声を、どのスピーカーから どの程度の音量で出力するかを指定するための仕組みです。
本関数でセンドレベルを設定後、::criAtomExPlayer_Start 関数により再生開始すると、 設定されたセンドレベルで再生されます。
また設定後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生された音声のセンドレベルを更新することができます。

第2引数のチャンネル番号は"音声データのチャンネル番号"を指定します。
第3引数のスピーカーIDには、指定したチャンネル番号のデータをどのスピーカーから 出力するかを指定し、第4引数では送信時のレベル（ボリューム）を指定します。
例えば、音声データのチャンネル0番のデータをライトスピーカーから フルボリューム（1.0f）で出力したい場合、指定は以下のようになります。

 criAtomExPlayer_SetSendLevel(player, 0, CRIATOMEX_SPEAKER_FRONT_RIGHT, 1.0f);

センドレベル値の範囲や扱いは、ボリュームと同等です。::criAtomExPlayer_SetVolume 関数を参照してください。

なお、センタースピーカーのあるプラットフォームで、モノラル音をセンタースピーカーのみから出力したい場合、 本関数ではなく::criAtomExPlayer_SetPanSpeakerType 関数で::CRIATOMEX_PAN_SPEAKER_TYPE_5CH を設定することをお薦めします。

例:

 CriSint32 ch = 0;  // channel number 0
 CriAtomExSpeakerId spk = CRIATOMEX_SPEAKER_FRONT_CENTER;
 CriFloat32 level = 1.0f;
 // Set send level(ch0 to center)
 criAtomExPlayer_SetSendLevel(player, ch, spk, level);
 // Start playback
 id = criAtomExPlayer_Start(player);
                :
 // Change send level
 level = 0.7f;
 criAtomExPlayer_SetSendLevel(player, ch, spk, level);
 criAtomExPlayer_Update(player, id);

備考:

センドレベルの設定には「自動設定」「手動設定」の2通りが存在します。
AtomExプレーヤを作成した直後や、 criAtomExPlayer_ResetParameters 関数で パラメータをクリアした場合、センドレベルの設定は「自動設定」となります。
これに対し、本関数を実行した場合、センドレベルの設定は「手動設定」になります。
（ユーザが各スピーカーへのセンドレベルをコントロールし、パンニングを行う必要があります。）

「自動設定」の場合、AtomExプレーヤは以下のように音声をルーティングします。

【モノラル音声を再生する場合】
チャンネル0の音声を左右のスピーカーから約0.7f（-3dB）のボリュームで出力します。

【ステレオ音声を再生する場合】
チャンネル0の音声をレフトスピーカーから、 チャンネル1の音声をライトスピーカーから出力します。

【4ch音声を再生する場合】
チャンネル0の音声をレフトスピーカーから、チャンネル1の音声をライトスピーカーから、 チャンネル2の音声をサラウンドレフトスピーカーから、 チャンネル3の音声をサラウンドライトスピーカーからでそれぞれ出力します。

【5.1ch音声を再生する場合】
チャンネル0の音声をレフトスピーカーから、チャンネル1の音声をライトスピーカーから、 チャンネル2の音声をセンタースピーカーから、チャンネル3の音声をLFEから、 チャンネル4の音声をサラウンドレフトスピーカーから、 チャンネル5の音声をサラウンドライトスピーカーからそれぞれ出力します。

【7.1ch音声を再生する場合】
チャンネル0の音声をレフトスピーカーから、チャンネル1の音声をライトスピーカーから、 チャンネル2の音声をセンタースピーカーから、チャンネル3の音声をLFEから、 チャンネル4の音声をサラウンドレフトスピーカーから、 チャンネル5の音声をサラウンドライトスピーカーからそれぞれ出力します。
チャンネル6の音声をサラウンドバックレフトスピーカーから、 チャンネル7の音声をサラウンドバックライトスピーカーからそれぞれ出力します。

これに対し、本関数を用いて「手動設定」を行った場合、音声データのチャンネル数に 関係なく、指定されたセンドレベル設定で音声が出力されます。
（音声データのチャンネル数に応じて、適宜センドレベル設定を切り替える必要があります。）

過去に指定したセンドレベルをクリアし、ルーティングを「自動設定」の状態に戻したい場合は、 criAtomExPlayer_ResetParameters 関数を実行してください。

本パラメータはデータ側には設定できないため、常に本関数の設定値が適用されます。

注意:

センドレベルを設定していないチャンネルについては、音声が出力されません。
例えば、再生する音声データがステレオにもかかわらず、どちらか一方のチャンネルに対して しかセンドレベルが設定されていない場合、センドレベルを設定していないチャンネルの音声 はミュートされます。
センドレベルをコントロールする際には、必ず出力を行いたい全てのチャンネルについてセンド レベルの設定を行ってください。

本関数を用いてセンドレベルを設定した場合、パン3Dや3Dポジショニングの設定は無視されます。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, criAtomExPlayer_SetVolume, criAtomExPlayer_SetPanSpeakerType, criAtomExPlayer_ResetParameters

バスセンドレベルの設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	bus_name	バス名
[in]	level	センドレベル値（0.0f〜1.0f）

説明:

バスセンドレベルを指定します。
バスセンドレベルは、音声をどのバスにどれだけ流すかを指定するための仕組みです。
本関数でバスセンドレベルを設定後、::criAtomExPlayer_Start 関数により再生開始すると、 設定されたバスセンドレベルで再生されます。
また設定後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生された音声のバスセンドレベルを更新することができます。
キュー再生時、データ側にバスセンドレベルが設定されている場合に本関数を呼び出すと、 データ側に設定されている値と本関数による設定値とを乗算した値が適用されます。

第2引数にはDSPバス設定内のバス名を指定します。
第3引数では送信時のレベル（ボリューム）を指定します。

第2引数のバス名で指定したバスが適用中のDSPバス設定に存在しない場合、設定値は無効値として処理されます。
センドレベル値の範囲や扱いは、ボリュームと同等です。::criAtomExPlayer_SetVolume 関数を参照してください。

例:

    ：
 // バスセンドレベルを設定
 cosnt CriChar8* bus_name = "Reverb";
 CriFloat32 level = 0.3f;
 criAtomExPlayer_SetBusSendLevelByName(player, bus_name, level);

 // 再生の開始
 id = criAtomExPlayer_Start(player);
    ：
 // パラメータの変更
 // 注意）この時点では再生中の音声のパラメータは変更されない。
 level = 0.5f;
 criAtomExPlayer_SetBusSendLevelByName(player, bus_name, level);

 // プレーヤに設定されたパラメータを再生中の音声にも反映
 criAtomExPlayer_Update(player, id);
    ：

備考:

本関数に異なるバス名を指定して複数回呼び出すことで、複数のバスに流すこともできます。

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, criAtomExPlayer_SetVolume, criAtomExPlayer_ResetParameters

バスセンドレベルの設定（オフセット指定）

引数:

[in]	player	AtomExプレーヤハンドル
[in]	bus_name	バス名
[in]	level_offset	センドレベル値（0.0f〜1.0f）

説明:

バスセンドレベルをオフセットで指定します。
キュー再生時、データ側にバスセンドレベルが設定されている場合に本関数を呼び出すと、 データ側に設定されている値と本関数による設定値とを加算した値が適用されます。
それ以外の仕様は criAtomExPlayer_SetBusSendLevel 関数と同様です。

備考:

criAtomExPlayer_SetBusSendLevel 関数で 0.0f を設定し、かつ本関数でオフセット値を設定することで、
データ側に設定されていたバスセンドレベルを無視して値が設定可能です。（上書き設定）

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

参照:

criAtomExPlayer_SetBusSendLevel, criAtomExPlayer_ResetParameters

ADX1互換のパンの設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	ch	チャンネル番号
[in]	pan	パン設定値（-1.0f〜1.0f）

説明:

ADX1互換のパン設定関数です。

備考:

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

注意:

本関数はADX1からの移植タイトル用に用意されています。
ADX2環境で新規にパン操作を行うアプリケーションを作成する場合、 criAtomExPlayer_SetPan3dAngle 関数を使用してください。

本関数でパンを設定後、::criAtomExPlayer_Start 関数により再生開始すると、設定されたパンで再生されます。
すでに再生された音声のパンを変更する場合、本関数で新たなパン設定をプレーヤに指定し、 criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数で再生中の音声にそのパラメータを適用する必要があります。

本関数でパンをコントロール可能なのは、モノラル音声とステレオ音声のみです。 また、左右の定位のみコントロールできます。
3ch以上の音声に対してパンをコントロールしたい場合や、前後を含めた定位をコントロールしたい場合には、 criAtomExPlayer_SetPan3dAngle 関数や::criAtomExPlayer_SetSendLevel 関数を使用する必要があります。

再生する音声データがステレオの場合、チャンネル0番とチャンネル1番のそれぞれのパン について、独立してコントロールすることが可能です。
ただし、設定されたパンがモノラル音声向けなのか、ステレオ音声向けなのかは区別 されないため、ステレオ設定用にパン設定を行ったAtomExプレーヤでモノラル音声を再生 した場合、意図としない位置に音源が定位する可能性があります。

再生する音声データがステレオにもかかわらず、どちらか一方のチャンネルに対して しかパンが設定されていない場合、パンを設定していないチャンネルの音声の定位位置 は 0.0f （中央からの出力）になります。
ステレオ音声のパンをコントロールする際には、必ず両方のチャンネルについてパンの 設定を行ってください。

本関数と::criAtomExPlayer_SetPan3dAngle 関数や criAtomExPlayer_SetSendLevel 関数を併用しないでください。
両者を併用した場合、意図しないパンで再生される可能性があります。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, criAtomExPlayer_SetPan3dAngle, criAtomExPlayer_SetSendLevel, criAtomExPlayer_ResetParameters

バンドパスフィルタのパラメータ設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	cof_low	正規化低域カットオフ周波数（0.0f〜1.0f）
[in]	cof_high	正規化高域カットオフ周波数（0.0f〜1.0f）

説明:

バンドパスフィルタのカットオフ周波数を指定します。
本関数でカットオフ周波数を設定後、::criAtomExPlayer_Start 関数により再生開始すると、 設定されたカットオフ周波数でバンドパスフィルタが動作します。
また設定後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生された音声に対してバンドパスフィルタのカットオフ周波数を更新することができます。

正規化カットオフ周波数は、対数軸上の24Hz〜24000Hzを、0.0f〜1.0fに正規化した値です。
例えば、正規化低域カットオフ周波数を0.0f、正規化高域カットオフ周波数を1.0fと指定すると、 バンドパスフィルタは全域が通過し、正規化低域カットオフ周波数を上げるほど、 また正規化高域カットオフ周波数を下げるほど、通過域が狭くなっていきます。

例:

    ：
 // フィルタのパラメータを設定
 CriFloat32 cof_low = 0.0f;
 CriFloat32 cof_high = 0.3f;
 criAtomExPlayer_SetBandpassFilterParameters(player, cof_low, cof_high);

 // 再生の開始
 id = criAtomExPlayer_Start(player);
    ：
 // パラメータの変更
 // 注意）この時点では再生中の音声のパラメータは変更されない。
 cof_low = 0.7f;
 cof_high = 1.0f;
 criAtomExPlayer_SetBandpassFilterParameters(player, cof_low, cof_high);

 // プレーヤに設定されたパラメータを再生中の音声にも反映
 criAtomExPlayer_Update(player, id);
    ：

備考:

キュー再生時、データ側にバンドパスフィルタのパラメータが設定されている場合に本関数を呼び出すと、 以下のように設定されます。

• cof_low
  データに設定された値に対し、「cof_low_rev = 1.0f - cof_low」としてから乗算し、最終的にまた「cof_low = 1.0f - cof_low_rev」と元に戻して適用されます。
  つまり、0.0fを「低域側に最もフィルタを開く」として、開き具合を乗算して適用していく形になります。
• cof_high
  データに設定された値に対し、乗算して適用されます。
  つまり、1.0fを「高域側に最もフィルタを開く」として、開き具合を乗算して適用していく形になります。

実際に適用される正規化カットオフ周波数が1.0fを超える値になった場合、値は1.0fにクリップされます。
同様に、実際に適用される正規化カットオフ周波数が0.0f未満の値になった場合も、値は0.0fにクリップされます。

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, criAtomExPlayer_ResetParameters

バイクアッドフィルタのパラメータ設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	type	フィルタタイプ
[in]	frequency	正規化周波数（0.0f〜1.0f）
[in]	gain	ゲイン（デシベル値）
[in]	q_value	Q値

説明:

バイクアッドフィルタの各種パラメータを指定します。
本関数でパラメータを設定後、::criAtomExPlayer_Start 関数により再生開始すると、 設定されたパラメータでバイクアッドフィルタが動作します。
また設定後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生された音声に対してバイクアッドフィルタのパラメータを更新することができます。

正規化周波数は、対数軸上の24Hz〜24000Hzを、0.0f〜1.0fに正規化した値です。
ゲインはデシベルで指定します。
ゲインはフィルタタイプが以下の場合のみ有効です。

• CRIATOMEX_BIQUAD_FILTER_TYPE_LOWSHELF：ローシェルフフィルタ
• CRIATOMEX_BIQUAD_FILTER_TYPE_HIGHSHELF：ハイシェルフフィルタ
• CRIATOMEX_BIQUAD_FILTER_TYPE_PEAKING：ピーキングフィルタ

例:

    ：
 // フィルタのパラメータを設定
 CriAtomExBiquadFilterType type = CRIATOMEX_BIQUAD_FILTER_TYPE_LOWPASS;
 CriFloat32 frequency = 0.5f;
 CriFloat32 gain = 1.0f;
 CriFloat32 q_value = 3.0f;
 criAtomExPlayer_SetBiquadFilterParameters(player, type, frequency, gain, q_value);

 // 再生の開始
 id = criAtomExPlayer_Start(player);
    ：
 // パラメータの変更
 // 注意）この時点では再生中の音声のパラメータは変更されない。
 frequency = 0.7f;
 criAtomExPlayer_SetBiquadFilterParameters(player, type, frequency, gain, q_value);

 // プレーヤに設定されたパラメータを再生中の音声にも反映
 criAtomExPlayer_Update(player, id);
    ：

備考:

• type
  データに設定された値を上書きします。
• frequency
  データに設定された値に加算されます。
• gain
  データに設定された値に乗算されます。
• q_value
  データに設定された値に加算されます。

実際に適用される正規化カットオフ周波数が1.0fを超える値になった場合、値は1.0fにクリップされます。
同様に、実際に適用される正規化カットオフ周波数が0.0f未満の値になった場合も、値は0.0fにクリップされます。

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

注意:

HCA-MX用にエンコードされた音声データには、バイクアッドフィルタが適用されません。
バイクアッドフィルタを使用したい音声は、ADXやHCA等、他のコーデックでエンコードしてください。

ASRが利用できる環境では、ネイティブボイス出力時にフィルタを使用できません。
ASRが利用可能な環境でバイクアッドフィルタを使用したい場合には、 出力サウンドレンダラをASRに設定する必要があります。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, criAtomExPlayer_ResetParameters

ボイスプライオリティの設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	priority	ボイスプライオリティ（-255〜255）

説明:

AtomExプレーヤにボイスプライオリティを設定します。
本関数でプライオリティをセット後、 criAtomExPlayer_Start 関数で音声を再生すると、 再生された音声は本関数でセットしたプライオリティで発音されます。
また設定後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生された音声のプライオリティを更新することができます。

ボイスプライオリティには、-255〜255の範囲で整数値を指定します。
範囲外の値を設定した場合、範囲に収まるようにクリッピングされます。
関数実行前のデフォルト設定値は0です。

備考:

AtomExプレーヤが波形データを再生しようとした際、 当該波形データが所属するボイスリミットグループの発音数が上限に達していた場合や、 ボイスプール内のボイスが全て使用中であった場合、 ボイスプライオリティによる発音制御が行われます。
（指定された波形データを再生するかどうかを、ボイスプライオリティを元に判定します。）

具体的には、再生を行おうとした波形データのプライオリティが、 現在ボイスで再生中の波形データのプライオリティよりも高い場合、 AtomExプレーヤは再生中のボイスを奪い取り、リクエストされた波形データの再生を開始します。
（再生中の音声が停止され、別の音声が再生されます。）

逆に、再生を行おうとした波形データのプライオリティが、 ボイスで再生中の波形データのプライオリティよりも低い場合、 AtomExプレーヤはリクエストされた波形データの再生を行いません。
（リクエストされた音声は再生されず、再生中の音声が引き続き鳴り続けます。）

再生しようとした波形データのプライオリティが、 ボイスで再生中の波形データのプライオリティと等しい場合、 AtomExプレーヤは発音制御方式（先着優先 or 後着優先）に従い、 以下のような制御が行われます。

• 先着優先時は、再生中の波形データを優先し、リクエストされた波形データを再生しません。
• 後着優先時は、リクエストされた波形データを優先し、ボイスを奪い取ります。

キュー再生時、データ側にボイスプライオリティが設定されている場合に本関数を呼び出すと、 データ側に設定されている値と本関数による設定値とを加算した値が適用されます。
例えば、データ側のプライオリティが255、AtomExプレーヤのプライオリティが45の場合、 実際に適用されるプライオリティは300になります。
本関数で設定可能な値の範囲は-255〜255ですが、ライブラリ内部の計算は::CriSint32の範囲で行われるため、 データ側と加算した結果は-255〜255を超える場合があります。

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

注意:

本関数は、波形データにセットされたボイスプライオリティを制御します。
Atom Craft上でキューに対して設定されたカテゴリキュープライオリティには影響を与えませんので、 ご注意ください。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, criAtomExPlayer_SetVoiceControlMethod, criAtomExPlayer_ResetParameters

AISACコントロール値の設定（コントロールID指定）

引数:

[in]	player	AtomExプレーヤハンドル
[in]	control_id	コントロールID
[in]	control_value	コントロール値（0.0f〜1.0f）

説明:

コントロールID指定でAISACのコントロール値を指定します。
本関数でAISACコントロール値を設定後、::criAtomExPlayer_Start 関数により再生開始すると、 設定されたAISACコントロール値で再生されます。
また設定後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生された音声のAISACコントロール値を更新することができます。
設定したコントロール値を削除するには、::criAtomExPlayer_ClearAisacControls 関数を使用してください。

AISACコントロール値には、0.0f〜1.0fの範囲で実数値を指定します。

例:

    ：
 // AISACコントロール値の設定
 CriAtomExAisacControlId control_id = 0;
 CriFloat32 control_value = 0.5f;
 criAtomExPlayer_SetAisacControlById(player, control_id, control_value);

 // 再生の開始
 id = criAtomExPlayer_Start(player);
    ：
 // パラメータの変更
 // 注意）この時点では再生中の音声のパラメータは変更されない。
 control_value = 0.3f;
 criAtomExPlayer_SetAisacControlById(player, control_id, control_value);

 // プレーヤに設定されたパラメータを再生中の音声にも反映
 criAtomExPlayer_Update(player, id);
    ：

備考:

AISACのコントロールタイプによって、以下のように挙動が変わります。

• オフ
  • 本関数等によるAISACコントロール値が未設定の場合はそのAISACは動作しません。
• オートモジュレーション
  • 本関数の設定値には影響されず、時間経過とともに自動的にAISACコントロール値が変化します。
• ランダム
  • 本関数等によって設定されたAISACコントロール値を中央値として、データに設定されたランダム幅でランダマイズし、最終的なAISACコントロール値を決定します。
  • ランダマイズ処理は再生開始時のパラメータ適用でのみ行われ、再生中の音声に対するAISACコントロール値変更はできません。
  • 再生開始時にAISACコントロール値が設定されていなかった場合、0.0fを中央値としてランダマイズ処理を行います。

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, criAtomExPlayer_SetAisacControlByName, criAtomExPlayer_ClearAisacControls, criAtomExPlayer_ResetParameters

AISACコントロール値の設定（コントロール名指定）

引数:

[in]	player	AtomExプレーヤハンドル
[in]	control_name	コントロール名
[in]	control_value	コントロール値（0.0f〜1.0f）

説明:

コントロール名指定でAISACのコントロール値を指定します。
本関数でAISACコントロール値を設定後、::criAtomExPlayer_Start 関数により再生開始すると、 設定されたAISACコントロール値で再生されます。
また設定後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生された音声のAISACコントロール値を更新することができます。
設定したコントロール値を削除するには、::criAtomExPlayer_ClearAisacControls 関数を使用してください。

AISACコントロール値の扱いは::criAtomExPlayer_SetAisacControlById 関数と同様です。

例:

    ：
 // AISACコントロール値の設定
 const CriChar8 *control_name = "Any";
 CriFloat32 control_value = 0.5f;
 criAtomExPlayer_SetAisacControlByName(player, control_name, control_value);

 // 再生の開始
 id = criAtomExPlayer_Start(player);
    ：
 // パラメータの変更
 // 注意）この時点では再生中の音声のパラメータは変更されない。
 control_value = 0.3f;
 criAtomExPlayer_SetAisacControlByName(player, control_name, control_value);

 // プレーヤに設定されたパラメータを再生中の音声にも反映
 criAtomExPlayer_Update(player, id);
    ：

備考:

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

参照:

criAtomExPlayer_Start, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll, criAtomExPlayer_SetAisacControlById, criAtomExPlayer_ClearAisacControls, criAtomExPlayer_ResetParameters

プレーヤに設定されているAISACコントロール値の削除

引数:

[in]

player

AtomExプレーヤハンドル

説明:

プレーヤに設定されているAISACコントロール値を全て削除します。
また削除後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生中の音声に対してAISACコントロール値の削除が行えます。

参照:

criAtomExPlayer_SetAisacControlById, criAtomExPlayer_SetAisacControlByName, criAtomExPlayer_Update, criAtomExPlayer_UpdateAll

3D音源ハンドルの設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	source	3D音源ハンドル

説明:

3Dポジショニングを実現するための3D音源ハンドルを設定します。
3Dリスナーハンドルと3D音源ハンドルを設定することで、3Dリスナーハンドルと3D音源ハンドルの位置関係等から定位や音量、ピッチ等が自動的に適用されます。
本関数で3D音源ハンドルを設定後、::criAtomExPlayer_Start 関数により再生開始すると、 設定された3D音源ハンドルを参照して再生されます。
また設定後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生された音声が参照する3D音源ハンドルを変更することができます。
sourceにNULLを設定した場合は、すでに設定されている3D音源ハンドルをクリアします。

備考:

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

注意:

3D音源ハンドルのパラメータの変更、更新は、AtomExプレーヤの関数ではなく、3D音源ハンドルの関数を使用して行います。
デフォルトでは、3Dポジショニングの計算は左手座標系で行われます。
右手座標系で各種ベクトルを設定する場合は、ライブラリ初期化時（ criAtomEx_Initialize 関数 ）の設定で CriAtomExConfig::coordinate_system にCRIATOMEX_COORDINATE_SYSTEM_RIGHT_HANDED を指定してください。
ACBファイルを使用せずに音声を再生する場合は、明示的に3Dポジショニングを有効にするために、::criAtomExSetPanType 関数で::CRIATOMEX_PAN_TYPE_3D_POSを設定する必要があります。

本関数と ::CriAtomExPlayer_Set3dSourceListHn 関数はお互いに設定を上書きします。
例えば、::CriAtomExPlayer_Set3dSourceListHn 関数にて3D音源ハンドルリストをAtomExプレーヤに設定後、本関数にてAtomExプレーヤに3D音源ハンドルを設定すると、 AtomExプレーヤには新たに3D音源ハンドルが設定され、既に設定されていた3D音源ハンドルリストはAtomExプレーヤからクリアされます。
本関数を用いてAtomExプレーヤに設定された3D音源ハンドルは、3D音源ハンドルリストに追加することはできません。 もし3D音源ハンドルリストに追加する場合は、既に設定されているAtomExプレーヤの3D音源ハンドルに関する設定をクリアしてください。

例:

 CriAtomEx3dListenerHn listener;
 CriAtomEx3dSourceHn source;
 CriAtomExVector pos;

 listener = criAtomEx3dListener_Create(NULL, NULL, 0);
 source = criAtomEx3dSource_Create(NULL, NULL, 0);
 player = criAtomExPlayer_Create(NULL, NULL, 0);
 criAtomExPlayer_Set3dListenerHn(player, listener);
 criAtomExPlayer_Set3dSourceHn(player, source);

 pos.x = 0.0f;
 pos.y = 0.0f;
 pos.z = 0.0f;
 criAtomEx3dSource_SetPosition(source, &pos);
 criAtomEx3dSource_Update(source);
 // Start playback
 id = criAtomExPlayer_Start(player);
                :
 pos.x += 10.0f;
 criAtomEx3dSource_SetPosition(source, &pos);
 criAtomEx3dSource_Update(source);

参照:

CriAtomEx3dSourceHn, CriAtomEx3dSourceListHn, criAtomExPlayer_Set3dSourceListHn, criAtomEx3dListenerHn, criAtomExPlayer_SetListenerHn, criAtomExPlayer_Update, criAtomExPlayer_ResetParameters

3D音源ハンドルリストの設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	source_list	3D音源ハンドルリスト

説明:

マルチポジショニング再生を実現するための3D音源ハンドルリストを設定します。
3Dリスナーハンドルと3D音源ハンドルリストを設定することで、3Dリスナーハンドルと3D音源ハンドルリスト内の 全ての3D音源ハンドルの位置関係等から定位や音量、ピッチ等が自動的に適用されます。
本関数で3D音源ハンドルリストを設定後、::criAtomExPlayer_Start 関数により再生開始すると、 設定された3D音源ハンドルリストを参照して再生されます。
また設定後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生された音声が参照する3D音源ハンドルリストを変更することができます。
source_listにNULLを設定した場合は、すでに設定されている3D音源ハンドルリストをクリアします。

備考:

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

注意:

3D音源ハンドルリストに追加されている3D音源ハンドルの変更、更新は、AtomExプレーヤの関数ではなく、3D音源ハンドルの関数を使用して行います。
右手座標系で各種ベクトルを設定する場合は、ライブラリ初期化時（ criAtomEx_Initialize 関数 ）の設定で CriAtomExConfig::coordinate_system にCRIATOMEX_COORDINATE_SYSTEM_RIGHT_HANDED を指定してください。
ACBファイルを使用せずに音声を再生する場合は、明示的に3Dポジショニングを有効にするために、::criAtomExSetPanType 関数で::CRIATOMEX_PAN_TYPE_3D_POSを設定する必要があります。

本関数と ::CriAtomExPlayer_Set3dSourceHn 関数はお互いに設定を上書きします。
例えば、::CriAtomExPlayer_Set3dSourceHn 関数にて3D音源ハンドルをAtomExプレーヤに設定後、本関数にてAtomExプレーヤに3D音源ハンドルリストを設定すると、 AtomExプレーヤには新たに3D音源ハンドルリストが設定され、既に設定されていた3D音源ハンドルはAtomExプレーヤからクリアされます。

例:

 CriAtomEx3dListenerHn listener;
 CriAtomEx3dSourceListHn source_list;
 CriAtomEx3dSourceHn source[8];
 CriAtomExVector pos[8];
 CriSint32 i;

 listener = criAtomEx3dListener_Create(NULL, NULL, 0);
 source_list = criAtomEx3dSourceList_Create(NULL, NULL, 0);
 for (i = 0; i < 8; i++) {
     source[i] = criAtomEx3dSource_Create(NULL, NULL, 0);

     pos[i].x = (CriFloat32)i;
     pos[i].y = 0.0f;
     pos[i].z = 0.0f;
     criAtomEx3dSource_SetPosition(source, &pos);
     criAtomEx3dSource_Update(source);

     criAtomEx3dSourceList_Add(source_list, source[i]);
 }

 player = criAtomExPlayer_Create(NULL, NULL, 0);
 criAtomExPlayer_Set3dListenerHn(player, listener);
 criAtomExPlayer_Set3dSourceListHn(player, source_list);

 // Start playback
 id = criAtomExPlayer_Start(player);
                :
 pos[2].x += 25.0f;
 criAtomEx3dSource_SetPosition(source[2], &pos);
 criAtomEx3dSource_Update(source[2]);
 pos[5].z += 10.0f;
 criAtomEx3dSource_SetPosition(source[5], &pos);
 criAtomEx3dSource_Update(source[5]);

参照:

CriAtomEx3dSourceListHn, CriAtomEx3dSourceHn, criAtomExPlayer_Set3dSourceHn, CriAtomEx3dListenerHn, CriAtomExPlayer_Set3dListenerHn, criAtomExPlayer_Update, criAtomExPlayer_ResetParameters

3Dリスナーハンドルの設定

引数:

[in]	player	AtomExプレーヤハンドル
[in]	listener	3Dリスナーハンドル

説明:

3Dポジショニングを実現するための3Dリスナーハンドルを設定します。
3Dリスナーハンドルと3D音源ハンドルまたは3D音源ハンドルリストを設定することで、3Dリスナーと3D音源ハンドルまたは 3D音源ハンドルリスト内の全ての3D音源ハンドルの位置関係等から定位や音量、ピッチ等が自動的に適用されます。
本関数で3Dリスナーハンドルを設定後、::criAtomExPlayer_Start 関数により再生開始すると、 設定された3Dリスナーハンドルを参照して再生されます。
また設定後、::criAtomExPlayer_Update 関数、::criAtomExPlayer_UpdateAll 関数を呼び出すことにより、 すでに再生された音声が参照する3Dリスナーハンドルを変更することができます。
listenerにNULLを設定した場合は、すでに設定されている3Dリスナーハンドルをクリアします。

備考:

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

注意:

3Dリスナーハンドルのパラメータの変更、更新は、AtomExプレーヤの関数ではなく、3Dリスナーハンドルの関数を使用して行います。
デフォルトでは、3Dポジショニングの計算は左手座標系で行われます。
右手座標系で各種ベクトルを設定する場合は、ライブラリ初期化時（ criAtomEx_Initialize 関数 ）の設定で CriAtomExConfig::coordinate_system にCRIATOMEX_COORDINATE_SYSTEM_RIGHT_HANDED を指定してください。
ACBファイルを使用せずに音声を再生する場合は、明示的に3Dポジショニングを有効にするために、::criAtomExSetPanType 関数で::CRIATOMEX_PAN_TYPE_3D_POSを設定する必要があります。

例:

 CriAtomEx3dListenerHn listener;
 CriAtomEx3dSourceHn source;
 CriAtomExVector pos;

 listener = criAtomEx3dListener_Create(NULL, NULL, 0);
 source = criAtomEx3dSource_Create(NULL, NULL, 0);
 player = criAtomExPlayer_Create(NULL, NULL, 0);
 criAtomExPlayer_Set3dListenerHn(player, listener);
 criAtomExPlayer_Set3dSourceHn(player, source);

 pos.x = 0.0f;
 pos.y = 0.0f;
 pos.z = 0.0f;
 criAtomEx3dSource_SetPosition(source, &pos);
 criAtomEx3dSource_Update(source);
 // Start playback
 id = criAtomExPlayer_Start(player);
                :
 pos.x += 10.0f;
 criAtomEx3dSource_SetPosition(source, &pos);
 criAtomEx3dSource_Update(source);

参照:

CriAtomEx3dListenerHn, criAtomExPlayer_Set3dSourceHn, criAtomExPlayer_Update, criAtomExPlayer_ResetParameters

AISACコントロール値の取得（コントロールID指定）

引数:

[in]	player	AtomExプレーヤハンドル
[in]	control_id	コントロールID

戻り値:

CriFloat32 コントロール値（0.0f〜1.0f）、未設定時は-1.0f

説明:

コントロールID指定でAISACのコントロール値を取得します。
指定したコントロールIDのAISACコントロール値が設定されていなかった場合、-1.0fを返します。

注意:

本関数は、AtomExプレーヤに設定されたAISACコントロール値を取得します。
再生中の音声にAISACコントロール値を変更するAISACが設定されていたとしても、その変更結果を取得することはできません。

例:

 CriAtomExAisacControlId control_id = 0;
 CriFloat32 control_value = 0.5f;
 // Set AISAC conrol value
 criAtomExPlayer_SetAisacControlById(player, control_id, control_value);
 // Start playback
 id = criAtomExPlayer_Start(player);
                :
 // Get AISAC control value
 control_value = criAtomExPlayer_GetAisacControlById(player, control_id);

参照:

criAtomExPlayer_SetAisacControlById, criAtomExPlayer_GetAisacControlByName

AISACコントロール値の取得（コントロール名指定）

引数:

[in]	player	AtomExプレーヤハンドル
[in]	control_name	コントロール名

戻り値:

CriFloat32 コントロール値（0.0f〜1.0f）、未設定時は-1.0f

説明:

コントロール名指定でAISACのコントロール値を取得します。
指定したコントロール名のAISACコントロール値が設定されていなかった場合、-1.0fを返します。

注意:

本関数は、AtomExプレーヤに設定されたAISACコントロール値を取得します。
再生中の音声にAISACコントロール値を変更するAISACが設定されていたとしても、その変更結果を取得することはできません。

例:

 const CriChar8 *control_name = "Any";
 CriFloat32 control_value = 0.5f;
 // Set AISAC conrol value
 criAtomExPlayer_SetAisacControlByName(player, control_name, control_value);
 // Start playback
 id = criAtomExPlayer_Start(player);
                :
 // Get AISAC control value
 control_value = criAtomExPlayer_GetAisacControlByName(player, control_name);

参照:

criAtomExPlayer_SetAisacControlByName, criAtomExPlayer_GetAisacControlById

カテゴリの設定（ID指定）

引数:

[in]	player	AtomExプレーヤハンドル
[in]	category_id	カテゴリID

説明:

カテゴリID指定でカテゴリを設定します。
設定したカテゴリ情報を削除するには、 criAtomExPlayer_UnsetCategory 関数を使用します。

備考:

キュー再生時に本関数を呼び出すと、データ側に設定されているカテゴリ設定を上書きします（データ側の設定値は無視されます）。
本関数で設定したカテゴリ情報は、ACFのレジスト、アンレジストを行うとクリアされます。
ACFをレジストしていない状態ではデフォルトカテゴリが使用可能です。 デフォルトカテゴリIDの指定は ::CriAtomExCategoryDefaultId を使用してください。

本パラメータは criAtomExPlayer_ResetParameters 関数にてクリアされます。

例:

 // Set default category
 criAtomExPlayer_SetCategoryById(player, (CriUint32)CRIATOMEXCATEGORY_DEFAULT_ID_BGM);

注意:

カテゴリ設定は再生開始前に行ってください。再生中の音声に対してカテゴリ設定の更新を行うと、カテゴリの再生数カウントが異常になる危険があります。