文字コード

説明:

文字コード（文字符号化方式）を表します。

列挙型の値:

Utf8	UTF-8
Sjis	Shift_JIS

ボイス確保方式

説明:

CriAtomExPlayer がボイスを確保する際の動作仕様を指定するためのデータ型です。

参照:

CriAtomExPlayer::CriAtomExPlayer

列挙型の値:

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

バイクアッドフィルタのタイプ

説明:

バイクアッドフィルタのタイプを指定するためのデータ型です。
CriAtomExPlayer::SetBiquadFilterParameters 関数で利用します。

参照:

CriAtomExPlayer::SetBiquadFilterParameters

列挙型の値:

Off	フィルタ無効
LowPass	ローパスフィルタ
HighPass	ハイパスフィルタ
Notch	ノッチフィルタ
LowShelf	ローシェルフフィルタ
HighShelf	ハイシェルフフィルタ
Peaking	ピーキングフフィルタ

ポーズ解除方法

説明:

ポーズを解除する対象を指定するためのデータ型です。
CriAtomExPlayer::Resume 関数、および ::CriAtomExPlayback::Resume 関数の引数として使用します。

参照:

CriAtomExPlayer::Resume, CriAtomExPlayback::Resume

列挙型の値:

AllPlayback	一時停止方法に関係なく再生を再開
PausedPlayback	Pause関数でポーズをかけた音声のみ再生を再開
PreparedPlayback	Prepare関数で再生準備を指示した音声の再生を開始

パンタイプ

説明:

どのようにして定位計算を行うかを指定するためのデータ型です。
CriAtomExPlayer::SetPanType 関数で利用します。

参照:

criAtomExPlayer::SetPanType

列挙型の値:

Pan3d	パン3Dで定位を計算
Pos3d	3Dポジショニングで定位を計算
Auto	AtomExプレーヤに3D音源／3Dリスナーが設定されている場合は3Dポジショニングで、 設定されていない場合はパン3Dで、それぞれ定位を計算します。

ボイス制御方式

説明:

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

参照:

CriAtomExPlayer::SetVoiceControlMethod

列挙型の値:

PreferLast	後着優先
PreferFirst	先着優先

パラメータID

説明:

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

参照:

CriAtomExPlayer::GetParameterFloat32, CriAtomExPlayer::GetParameterSint32, CriAtomExPlayer::GetParameterUint32

列挙型の値:

Volume	ボリューム
Pitch	ピッチ
Pan3dAngle	パンニング3D角度
Pan3dDistance	パンニング3D距離
Pan3dVolume	パンニング3Dボリューム
BusSendLevel0	バスセンドレベル0
BusSendLevel1	バスセンドレベル1
BusSendLevel2	バスセンドレベル2
BusSendLevel3	バスセンドレベル3
BusSendLevel4	バスセンドレベル4
BusSendLevel5	バスセンドレベル5
BusSendLevel6	バスセンドレベル6
BusSendLevel7	バスセンドレベル7
BandPassFilterCofLow	バンドパスフィルタの低域カットオフ周波数
BandPassFilterCofHigh	バンドパスフィルタの高域カットオフ周波数
BiquadFilterType	バイクアッドフィルタのフィルタタイプ
BiquadFilterFreq	バイクアッドフィルタの周波数
BiquadFIlterQ	バイクアッドフィルタのQ値
BiquadFilterGain	バイクアッドフィルタのゲイン
EnvelopeAttackTime	エンベロープのアタックタイム
EnvelopeHoldTime	エンベロープのホールドタイム
EnvelopeDecayTime	エンベロープのディケイタイム
EnvelopeReleaseTime	エンベロープのリリースタイム
EnvelopeSustainLevel	エンベロープのサスティンレベル
StartTime	再生開始位置
Priority	ボイスプライオリティ

スピーカーID

説明:

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

参照:

CriAtomExPlayer::SetSendLevel

列挙型の値:

FrontLeft	フロントレフトスピーカー
FrontRight	フロントライトスピーカー
FrontCenter	フロントセンタースピーカー
LowFrequency	LFE（≒サブウーハー）
SurroundLeft	サラウンドレフトスピーカー
SurroundRight	サラウンドライトスピーカー
SurroundBackLeft	サラウンドバックレフトスピーカー
SurroundBackRight	サラウンドバックライトスピーカー

フォーマット種別

説明:

AtomExプレーヤで再生する音声のフォーマットを指定するためのデータ型です。
CriAtomExPlayer::SetFormat 関数で利用します。

参照:

CriAtomExPlayer::SetFormat

列挙型の値:

ADX	ADX
HCA	HCA
HCA_MX	HCA-MX
WAVE	Wave

キュータイプ

参照:

CriAtomEx::CueInfo

列挙型の値:

Polyphonic	ポリフォニック
Sequential	シーケンシャル
Shuffle	シャッフル再生
Random	ランダム
RandomNoRepeat	ランダム非連続（前回再生した音以外をランダムに鳴らす）
SwitchGameVariable	スイッチ再生（ゲーム変数を参照して再生トラックの切り替える）
ComboSequential	コンボシーケンシャル（「コンボ時間」内に連続コンボが決まるとシーケンシャル、最後までいくと「コンボループバック」地点に戻る）
SwitchSelector	セレクタ

ACFファイルの登録

引数:

binder	バインダ
acfPath	ACFファイルのファイルパス

説明:

ACFファイルをロードし、ライブラリに取り込みます。

参照:

CriAtomEx::UnregisterAcf

ACFデータの登録

引数:

acfData

ACFデータ

説明:

メモリ上に配置されたACFデータをロードし、ライブラリに取り込みます。

注意:

引数として渡すデータのバッファアドレスは、ガベージコレクターに移動されないように アプリケーション側で事前に固定したものを渡してください。
また、メモリの固定解除はACFファイルの登録解除後、またはライブラリ終了処理後に行ってください。

参照:

CriAtomEx::UnregisterAcf

ACFファイルの登録解除

説明:

ACFファイルの登録を解除します。

参照:

CriAtomEx::RegisterAcf

DSPバス設定のアタッチ

引数:

settingName

DSPバス設定の名前

説明:

DSPバス設定からDSPバスを構築してサウンドレンダラにアタッチします。
本関数を実行するには、あらかじめ CriAtomEx::RegisterAcf 関数でACF情報を登録しておく必要があります

        ：
    // ACFファイルの読み込みと登録
    CriAtomEx.RegisterAcf("Sample.acf");

    // DSPバス設定の適用
    CriAtomEx.AttachDspBusSetting("DspBusSetting_0");
        ：

注意:

本関数は完了復帰型の関数です。
本関数を実行すると、しばらくの間Atomライブラリのサーバ処理がブロックされます。
音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。

参照:

CriAtomEx::DetachDspBusSetting, CriAtomEx::RegisterAcf

DSPバス設定のデタッチ

説明:

DSPバス設定をデタッチします。

注意:

本関数は完了復帰型の関数です。
本関数を実行すると、しばらくの間Atomライブラリのサーバ処理がブロックされます。
音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。

参照:

CriAtomEx::AttachDspBusSetting

DSPバススナップショットの適用

引数:

snapshot_name	DSPバススナップショット名
time_ms	スナップショットが完全に反映されるまでの時間（ミリ秒）

説明:

DSPバススナップショットを適用します。
本関数を呼び出すとスナップショットのパラメータに変化します。 完全に変化を終えるまでに、time_ms ミリ秒かかります。

ゲーム変数の総数の取得

戻り値:

ゲーム変数の総数

説明:

ACFファイル内に登録されているゲーム変数の総数を取得します。

注意:

本関数を実行する前に、ACFファイルを登録しておく必要があります。
ACFファイルが登録されていない場合、-1が返ります。

ゲーム変数情報の取得（インデックス指定）

引数:

index	ゲーム変数インデックス
info	ゲーム変数情報

戻り値:

情報が取得できたかどうか？

説明:

ゲーム変数インデックスからゲーム変数情報を取得します。
指定したインデックスのゲーム変数が存在しない場合、falseが返ります。

注意:

本関数を実行する前に、ACFファイルを登録しておく必要があります。

ゲーム変数の取得

引数:

game_variable_id

ゲーム変数ID

戻り値:

ゲーム変数値

説明:

ACFファイル内に登録されているゲーム変数値を取得します。

注意:

本関数を実行する前に、ACFファイルを登録しておく必要があります。

ゲーム変数の取得

引数:

game_variable_name

ゲーム変数名

戻り値:

ゲーム変数値

説明:

ACFファイル内に登録されているゲーム変数値を取得します。

注意:

本関数を実行する前に、ACFファイルを登録しておく必要があります。

ゲーム変数の設定

引数:

game_variable_id	ゲーム変数ID
game_variable_value	ゲーム変数値

説明:

ACFファイル内に登録されているゲーム変数に値を設定します。
設定可能な範囲は0.0f〜1.0fの間です。

注意:

本関数を実行する前に、ACFファイルを登録しておく必要があります。

ゲーム変数の設定

引数:

game_variable_name	ゲーム変数名
game_variable_value	ゲーム変数値

説明:

ACFファイル内に登録されているゲーム変数に値を設定します。
設定可能な範囲は0.0f〜1.0fの間です。

注意:

本関数を実行する前に、ACFファイルを登録しておく必要があります。

乱数種の設定

引数:

seed

乱数種

説明:

CRI Atomライブラリ全体で共有する疑似乱数生成器に乱数種を設定します。
乱数種を設定することにより、各種ランダム再生処理に再現性を持たせることができます。
AtomExプレーヤごとに再現性を持たせたい場合は、 CriAtomExPlayer::SetRandomSeed 関数を使用してください。
再現性の必要がなく、実行ごとに乱数種を切り替えたい場合は、本関数 ではなく、 CriAtomConfig::useRandomSeedWithTime プロパティを使用してください。

注意:

本関数は CriAtomSource または CriAtomExPlayer の生成前に呼び出す必要が あります。乱数種を設定する前に作成されたものについては影響を受けません。

参照:

CriAtomExPlayer::SetRandomSeed

パフォーマンスモニタのリセット

説明:

現在までの計測結果を破棄します。
パフォーマンスモニタは、ライブラリ初期化直後からパフォーマンス情報の取得を開始し、 計測結果を累積します。
以前の計測結果を今後の計測に含めたくない場合には、 本関数を実行し、累積された計測内容を一旦破棄する必要があります。

参照:

CriAtomEx::GetPerformanceInfo

パフォーマンス情報の取得

説明:

パフォーマンス情報を取得します。

参照:

CriAtomEx::PerformanceInfo, CriAtomEx::ResetPerformanceMonitor

セレクタに対するグローバル参照ラベルの設定

引数:

selector_index	セレクタインデックス
label_index	ラベルインデックス

説明:

ACFファイル内に登録されているセレクタに対してグローバル参照されるラベルを設定します。

注意:

本関数を実行する前に、ACFファイルを登録しておく必要があります。

参照:

CriAtomEx::SetGlobalLabelToSelectorByName

セレクタに対するグローバル参照ラベルの設定

引数:

selector_name	セレクタ名
label_name	ラベル名

説明:

ACFファイル内に登録されているセレクタに対してグローバル参照されるラベルを設定します。

注意:

本関数を実行する前に、ACFファイルを登録しておく必要があります。

参照:

CriAtomEx::SetGlobalLabelToSelectorByIndex

[iOS] サウンド出力停止の確認

説明:

サウンド出力が停止しているかどうかの確認を行います。
trueの場合、サウンド出力が停止しています。
アプリケーションをポーズしていないにも関わらず本関数がtrueを返した場合は、 アプリケーションに検知されないシステムの割り込み等により、サウンド出力が妨げられています。
音声と同期した処理を行う場合には、本関数によりサウンド出力状態を確認し、 必要に応じてポーズ処理を追加してください。 　

注意:

本関数はiOS専用APIです。