構成 | Public 型 | Static Public メソッド | Public 変数
クラス CriAtomEx

Atomライブラリのグローバルクラスです。 [詳細]

すべてのメンバ一覧

構成

struct  AisacControlInfo
 AISACコントロール情報取得用構造体 [詳細]
struct  AisacInfo
 AISAC情報取得用構造体 [詳細]
struct  CueInfo
 キュー情報 [詳細]
struct  NativeVector
 3次元ベクター構造体 [詳細]
struct  PerformanceInfo
 パフォーマンス情報 [詳細]
struct  ResourceUsage
 各種リソースの使用状況 [詳細]
struct  WaveformInfo
 音声波形情報 [詳細]

Public 型

enum  CharacterEncoding { Utf8, Sjis }
 文字コード [詳細]
enum  SoundRendererType
 サウンドレンダラタイプ [詳細]
enum  VoiceAllocationMethod { Once, Retry }
 ボイス確保方式 [詳細]
enum  BiquadFilterType {
  Off, LowPass, HighPass, Notch,
  LowShelf, HighShelf, Peaking
}
 バイクアッドフィルタのタイプ [詳細]
enum  ResumeMode { AllPlayback = 0, PausedPlayback = 1, PreparedPlayback = 2 }
 ポーズ解除方法 [詳細]
enum  PanType { Unknown = -1, Pan3d = 0, Pos3d, Auto }
 パンタイプ [詳細]
enum  VoiceControlMethod { PreferLast = 0, PreferFirst }
 ボイス制御方式 [詳細]
enum  Parameter {
  Volume = 0, Pitch = 1, Pan3dAngle = 2, Pan3dDistance = 3,
  Pan3dVolume = 4, BusSendLevel0 = 9, BusSendLevel1 = 10, BusSendLevel2 = 11,
  BusSendLevel3 = 12, BusSendLevel4 = 13, BusSendLevel5 = 14, BusSendLevel6 = 15,
  BusSendLevel7 = 16, BandPassFilterCofLow = 17, BandPassFilterCofHigh = 18, BiquadFilterType = 19,
  BiquadFilterFreq = 20, BiquadFIlterQ = 21, BiquadFilterGain = 22, EnvelopeAttackTime = 23,
  EnvelopeHoldTime = 24, EnvelopeDecayTime = 25, EnvelopeReleaseTime = 26, EnvelopeSustainLevel = 27,
  StartTime = 28, Priority = 31
}
 パラメータID [詳細]
enum  Speaker {
  FrontLeft = 0, FrontRight = 1, FrontCenter = 2, LowFrequency = 3,
  SurroundLeft = 4, SurroundRight = 5, SurroundBackLeft = 6, SurroundBackRight = 7
}
 スピーカーID [詳細]
enum  Format {
  ADX = 0x00000001, HCA = 0x00000003, HCA_MX = 0x00000004, WAVE = 0x00000005,
  RAW_PCM = 0x00000006
}
 フォーマット種別 [詳細]
enum  CueType {
  Polyphonic, Sequential, Shuffle, Random,
  RandomNoRepeat, SwitchGameVariable, ComboSequential, SwitchSelector
}
 キュータイプ [詳細]

Static Public メソッド

static void RegisterAcf (CriFsBinder binder, string acfPath)
 ACFファイルの登録
static void RegisterAcf (IntPtr acfData, int dataSize)
 ACFデータの登録
static void UnregisterAcf ()
 ACFファイルの登録解除
static void AttachDspBusSetting (string settingName)
 DSPバス設定のアタッチ
static void DetachDspBusSetting ()
 DSPバス設定のデタッチ
static void ApplyDspBusSnapshot (string snapshot_name, int time_ms)
 DSPバススナップショットの適用
static int GetNumGameVariables ()
 ゲーム変数の総数の取得
static bool GetGameVariableInfo (ushort index, out GameVariableInfo info)
 ゲーム変数情報の取得(インデックス指定)
static float GetGameVariable (uint game_variable_id)
 ゲーム変数の取得
static float GetGameVariable (string game_variable_name)
 ゲーム変数の取得
static void SetGameVariable (uint game_variable_id, float game_variable_value)
 ゲーム変数の設定
static void SetGameVariable (string game_variable_name, float game_variable_value)
 ゲーム変数の設定
static void SetRandomSeed (uint seed)
 乱数種の設定
static void ResetPerformanceMonitor ()
 パフォーマンスモニタのリセット
static void GetPerformanceInfo (out PerformanceInfo info)
 パフォーマンス情報の取得
static void SetGlobalLabelToSelectorByIndex (ushort selector_index, ushort label_index)
 セレクタに対するグローバル参照ラベルの設定
static void SetGlobalLabelToSelectorByName (string selector_name, string label_name)
 セレクタに対するグローバル参照ラベルの設定
static void Lock ()
 サーバ処理の割り込みの防止
static void Unlock ()
 サーバ処理の割り込み防止の解除
static void SetOutputAudioDevice_PC (string deviceId)
 [PC] 出力デバイスの設定(デバイスID指定)
static bool LoadAudioDeviceList_PC ()
 [PC] 出力デバイスリストの初期化
static int GetNumAudioDevices_PC ()
 [PC] 出力デバイス数の取得
static string GetAudioDeviceName_PC (int index)
 [PC] 出力デバイス名の取得(インデクス指定)
static void SetOutputAudioDevice_PC (int index)
 [PC] 出力デバイスの設定(インデクス指定)
static bool IsSoundStopped_IOS ()
 [iOS] サウンド出力停止の確認

Public 変数

const uint InvalidAisacControlId = 0xffffu
 AISACコントロールIDの無効値

説明

Atomライブラリのグローバルクラスです。

説明:
Atomライブラリに対する設定関数や、Atomライブラリ内で共有する変数型を含むクラスです。

列挙型

文字コード

説明:
文字コード(文字符号化方式)を表します。
列挙型の値:
Utf8 

UTF-8

Sjis 

Shift_JIS

サウンドレンダラタイプ

説明:
CriAtomExPlayer が内部で作成するサウンドレンダラの種別をを表します。

ボイス確保方式

説明:
CriAtomExPlayer がボイスを確保する際の動作仕様を指定するためのデータ型です。
参照:
CriAtomExPlayer::CriAtomExPlayer
列挙型の値:
Once 

ボイスの確保は1回限り

Retry 

ボイスを繰り返し確保する

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

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

フィルタ無効

LowPass 

ローパスフィルタ

HighPass 

ハイパスフィルタ

Notch 

ノッチフィルタ

LowShelf 

ローシェルフフィルタ

HighShelf 

ハイシェルフフィルタ

Peaking 

ピーキングフフィルタ

enum ResumeMode

ポーズ解除方法

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

一時停止方法に関係なく再生を再開

PausedPlayback 

Pause関数でポーズをかけた音声のみ再生を再開

PreparedPlayback 

Prepare関数で再生準備を指示した音声の再生を開始

enum PanType

パンタイプ

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

パンタイプが判明していない状態

Pan3d 

パン3Dで定位を計算

Pos3d 

3Dポジショニングで定位を計算

Auto 

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

ボイス制御方式

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

後着優先

PreferFirst 

先着優先

enum Parameter

パラメータ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 

ボイスプライオリティ

enum Speaker

スピーカーID

説明:
音声を出力するスピーカーを指定するためのIDです。
CriAtomExPlayer::SetSendLevel 関数で利用します。
参照:
CriAtomExPlayer::SetSendLevel
列挙型の値:
FrontLeft 

フロントレフトスピーカー

FrontRight 

フロントライトスピーカー

FrontCenter 

フロントセンタースピーカー

LowFrequency 

LFE(≒サブウーハー)

SurroundLeft 

サラウンドレフトスピーカー

SurroundRight 

サラウンドライトスピーカー

SurroundBackLeft 

サラウンドバックレフトスピーカー

SurroundBackRight 

サラウンドバックライトスピーカー

enum Format

フォーマット種別

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

ADX

HCA 

HCA

HCA_MX 

HCA-MX

WAVE 

Wave

RAW_PCM 

RawPCM

enum CueType

キュータイプ

参照:
CriAtomEx::CueInfo
列挙型の値:
Polyphonic 

ポリフォニック

Sequential 

シーケンシャル

Shuffle 

シャッフル再生

Random 

ランダム

RandomNoRepeat 

ランダム非連続(前回再生した音以外をランダムに鳴らす)

SwitchGameVariable 

スイッチ再生(ゲーム変数を参照して再生トラックの切り替える)

ComboSequential 

コンボシーケンシャル(「コンボ時間」内に連続コンボが決まるとシーケンシャル、最後までいくと「コンボループバック」地点に戻る)

SwitchSelector 

セレクタ


関数

static void RegisterAcf ( CriFsBinder  binder,
string  acfPath 
)
inlinestatic

ACFファイルの登録

引数:
binderバインダ
acfPathACFファイルのファイルパス
説明:
ACFファイルをロードし、ライブラリに取り込みます。
参照:
CriAtomEx::UnregisterAcf
static void RegisterAcf ( IntPtr  acfData,
int  dataSize 
)
inlinestatic

ACFデータの登録

引数:
acfDataACFデータ
dataSizeACFデータのサイズ
説明:
メモリ上に配置されたACFデータをロードし、ライブラリに取り込みます。
注意:
引数として渡すデータのバッファアドレスは、ガベージコレクターに移動されないように アプリケーション側で事前に固定したものを渡してください。
また、メモリの固定解除はACFファイルの登録解除後、またはライブラリ終了処理後に行ってください。
参照:
CriAtomEx::UnregisterAcf
static void UnregisterAcf ( )
inlinestatic

ACFファイルの登録解除

説明:
ACFファイルの登録を解除します。
参照:
CriAtomEx::RegisterAcf
static void AttachDspBusSetting ( string  settingName)
inlinestatic

DSPバス設定のアタッチ

引数:
settingNameDSPバス設定の名前
説明:
DSPバス設定からDSPバスを構築してサウンドレンダラにアタッチします。
本関数を実行するには、あらかじめ CriAtomEx::RegisterAcf 関数でACF情報を登録しておく必要があります
// ACFファイルの読み込みと登録
  CriAtomEx.RegisterAcf("Sample.acf");

  // DSPバス設定の適用
  CriAtomEx.AttachDspBusSetting("DspBusSetting_0");
      :
注意:
本関数は完了復帰型の関数です。
本関数を実行すると、しばらくの間Atomライブラリのサーバ処理がブロックされます。
音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。
参照:
CriAtomEx::DetachDspBusSetting, CriAtomEx::RegisterAcf
static void DetachDspBusSetting ( )
inlinestatic

DSPバス設定のデタッチ

説明:
DSPバス設定をデタッチします。
注意:
本関数は完了復帰型の関数です。
本関数を実行すると、しばらくの間Atomライブラリのサーバ処理がブロックされます。
音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。
参照:
CriAtomEx::AttachDspBusSetting
static void ApplyDspBusSnapshot ( string  snapshot_name,
int  time_ms 
)
inlinestatic

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

引数:
snapshot_nameDSPバススナップショット名
time_msスナップショットが完全に反映されるまでの時間(ミリ秒)
説明:
DSPバススナップショットを適用します。
本関数を呼び出すとスナップショットのパラメータに変化します。 完全に変化を終えるまでに、time_ms ミリ秒かかります。
static int GetNumGameVariables ( )
inlinestatic

ゲーム変数の総数の取得

戻り値:
ゲーム変数の総数
説明:
ACFファイル内に登録されているゲーム変数の総数を取得します。
注意:
本関数を実行する前に、ACFファイルを登録しておく必要があります。
ACFファイルが登録されていない場合、-1が返ります。
static bool GetGameVariableInfo ( ushort  index,
out GameVariableInfo  info 
)
inlinestatic

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

引数:
indexゲーム変数インデックス
infoゲーム変数情報
戻り値:
情報が取得できたかどうか?
説明:
ゲーム変数インデックスからゲーム変数情報を取得します。
指定したインデックスのゲーム変数が存在しない場合、Falseが返ります。
注意:
本関数を実行する前に、ACFファイルを登録しておく必要があります。
static float GetGameVariable ( uint  game_variable_id)
inlinestatic

ゲーム変数の取得

引数:
game_variable_idゲーム変数ID
戻り値:
ゲーム変数値
説明:
ACFファイル内に登録されているゲーム変数値を取得します。
注意:
本関数を実行する前に、ACFファイルを登録しておく必要があります。
static float GetGameVariable ( string  game_variable_name)
inlinestatic

ゲーム変数の取得

引数:
game_variable_nameゲーム変数名
戻り値:
ゲーム変数値
説明:
ACFファイル内に登録されているゲーム変数値を取得します。
注意:
本関数を実行する前に、ACFファイルを登録しておく必要があります。
static void SetGameVariable ( uint  game_variable_id,
float  game_variable_value 
)
inlinestatic

ゲーム変数の設定

引数:
game_variable_idゲーム変数ID
game_variable_valueゲーム変数値
説明:
ACFファイル内に登録されているゲーム変数に値を設定します。
設定可能な範囲は0.0f〜1.0fの間です。
注意:
本関数を実行する前に、ACFファイルを登録しておく必要があります。
static void SetGameVariable ( string  game_variable_name,
float  game_variable_value 
)
inlinestatic

ゲーム変数の設定

引数:
game_variable_nameゲーム変数名
game_variable_valueゲーム変数値
説明:
ACFファイル内に登録されているゲーム変数に値を設定します。
設定可能な範囲は0.0f〜1.0fの間です。
注意:
本関数を実行する前に、ACFファイルを登録しておく必要があります。
static void SetRandomSeed ( uint  seed)
inlinestatic

乱数種の設定

引数:
seed乱数種
説明:
CRI Atomライブラリ全体で共有する疑似乱数生成器に乱数種を設定します。
乱数種を設定することにより、各種ランダム再生処理に再現性を持たせることができます。
AtomExプレーヤごとに再現性を持たせたい場合は、 CriAtomExPlayer::SetRandomSeed 関数を使用してください。
再現性の必要がなく、実行ごとに乱数種を切り替えたい場合は、本関数 ではなく、 CriAtomConfig::useRandomSeedWithTime プロパティを使用してください。
注意:
本関数は CriAtomSource または CriAtomExPlayer の生成前に呼び出す必要が あります。乱数種を設定する前に作成されたものについては影響を受けません。
参照:
CriAtomExPlayer::SetRandomSeed
static void ResetPerformanceMonitor ( )
inlinestatic

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

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

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

説明:
パフォーマンス情報を取得します。
参照:
CriAtomEx::PerformanceInfo, CriAtomEx::ResetPerformanceMonitor
static void SetGlobalLabelToSelectorByIndex ( ushort  selector_index,
ushort  label_index 
)
inlinestatic

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

引数:
selector_indexセレクタインデックス
label_indexラベルインデックス
説明:
ACFファイル内に登録されているセレクタに対してグローバル参照されるラベルを設定します。
注意:
本関数を実行する前に、ACFファイルを登録しておく必要があります。
参照:
CriAtomEx::SetGlobalLabelToSelectorByName
static void SetGlobalLabelToSelectorByName ( string  selector_name,
string  label_name 
)
inlinestatic

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

引数:
selector_nameセレクタ名
label_nameラベル名
説明:
ACFファイル内に登録されているセレクタに対してグローバル参照されるラベルを設定します。
注意:
本関数を実行する前に、ACFファイルを登録しておく必要があります。
参照:
CriAtomEx::SetGlobalLabelToSelectorByIndex
static void Lock ( )
inlinestatic

サーバ処理の割り込みの防止

説明:
サーバ処理の割り込み抑止します。
本関数実行後、 CriAtomEx::Unlock 関数実行までの間、サーバ処理の動作が抑止されます。
複数のAPIを同一オーディオフレーム内で確実に実行したい場合には、本関数でサーバ処理の 割り込みを防止し、それらの関数を実行してください。
参照:
CriAtomEx::Unlock
static void Unlock ( )
inlinestatic

サーバ処理の割り込み防止の解除

説明:
CriAtomEx::Lock 関数による、サーバ処理の割り込み防止を解除します。
参照:
CriAtomEx::Lock
static void SetOutputAudioDevice_PC ( string  deviceId)
inlinestatic

[PC] 出力デバイスの設定(デバイスID指定)

引数:
deviceIdデバイスID
説明:
Atomからの音声出力先となるデバイスIDを設定します。
static bool LoadAudioDeviceList_PC ( )
inlinestatic

[PC] 出力デバイスリストの初期化

説明:
Atomからの音声出力先となるデバイスリストを初期化します。
本関数の呼び出し後、 CriAtomEx::GetNumAudioDevices_PC でのデバイス数を取得や、 CriAtomEx::GetAudioDeviceName_PC でのデバイス名の取得が可能になります。
参照:
CriAtomEx::GetNumAudioDevices_PC, CriAtomEx::GetAudioDeviceName_PC
static int GetNumAudioDevices_PC ( )
inlinestatic

[PC] 出力デバイス数の取得

戻り値:
出力デバイス数
説明:
Atomからの音声出力先として選択可能なデバイス数を取得します。
事前に CriAtomEx::LoadAudioDeviceList_PC を呼び出して プラグイン内でのデバイスリストを初期化してから、本関数を呼び出してください。
参照:
CriAtomEx::LoadAudioDeviceList_PC
static string GetAudioDeviceName_PC ( int  index)
inlinestatic

[PC] 出力デバイス名の取得(インデクス指定)

引数:
indexデバイスインデクス
戻り値:
出力デバイス名
説明:
Atomからの音声出力先として選択可能なデバイスの名前を取得します。
事前に CriAtomEx::LoadAudioDeviceList_PC を呼び出して プラグイン内でのデバイスリストを初期化してから、本関数を呼び出してください。
参照:
CriAtomEx::LoadAudioDeviceList_PC
static void SetOutputAudioDevice_PC ( int  index)
inlinestatic

[PC] 出力デバイスの設定(インデクス指定)

引数:
indexデバイスインデクス
説明:
Atomからの音声出力先となるデバイスを設定します。
事前に CriAtomEx::LoadAudioDeviceList_PC を呼び出して プラグイン内でのデバイスリストを初期化してから、本関数を呼び出してください。
参照:
CriAtomEx::LoadAudioDeviceList_PC
static bool IsSoundStopped_IOS ( )
inlinestatic

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

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

CRI Middleware logo Copyright (c) 2012 CRI Middleware Co., Ltd. CRIWARE Unity Plug-inマニュアル 2021-02-05 更新