サウンド再生全体を制御するためのコンポーネントです。
[詳細]
すべてのメンバ一覧
Static Public メソッド |
| static void | AttachDspBusSetting (string settingName) |
| | DSPバス設定のアタッチ
|
| static void | DetachDspBusSetting () |
| | DSPバス設定のデタッチ
|
| static CriAtomCueSheet | GetCueSheet (string name) |
| | キューシートの取得
|
| static CriAtomCueSheet | AddCueSheet (string name, string acbFile, string awbFile, CriFsBinder binder=null) |
| | キューシートの追加
|
| static CriAtomCueSheet | AddCueSheetAsync (string name, string acbFile, string awbFile, CriFsBinder binder=null, bool loadAwbOnMemory=false) |
| | 非同期でのキューシートの追加
|
| static CriAtomCueSheet | AddCueSheet (string name, byte[] acbData, string awbFile, CriFsBinder awbBinder=null) |
| | キューシートの追加(メモリからの読み込み)
|
| static CriAtomCueSheet | AddCueSheetAsync (string name, byte[] acbData, string awbFile, CriFsBinder awbBinder=null, bool loadAwbOnMemory=false) |
| | 非同期でのキューシートの追加(メモリからの読み込み)
|
| static void | RemoveCueSheet (string name) |
| | キューシートの削除
|
| static CriAtomExAcb | GetAcb (string cueSheetName) |
| | ACBオブジェクトの取得
|
| static void | SetCategoryVolume (string name, float volume) |
| | カテゴリ名指定でカテゴリボリュームを設定します。
|
| static void | SetCategoryVolume (int id, float volume) |
| | カテゴリID指定でカテゴリボリュームを設定します。
|
| static float | GetCategoryVolume (string name) |
| | カテゴリ名指定でカテゴリボリュームを取得します。
|
| static float | GetCategoryVolume (int id) |
| | カテゴリID指定でカテゴリボリュームを取得します。
|
| static void | SetBusAnalyzer (string busName, bool sw) |
| | バス情報取得を有効にします。
|
| static void | SetBusAnalyzer (bool sw) |
| | 全てのバス情報取得を有効にします。
|
| static CriAtomExAsr.BusAnalyzerInfo | GetBusAnalyzerInfo (string busName) |
| | バス情報を取得します。
|
説明
サウンド再生全体を制御するためのコンポーネントです。
- 説明:
- 各シーンにひとつ用意しておく必要があります。
UnityEditor上でCRI Atomウィンドウを使用して CriAtomSource を作成した場合、 「CRIWARE」という名前を持つオブジェクトとして自動的に作成されます。通常はユーザーが作成する必要はありません。
関数
| static void AttachDspBusSetting |
( |
string |
settingName | ) |
|
|
inlinestatic |
DSPバス設定のアタッチ
- 引数:
-
- 説明:
- DSPバス設定からDSPバスを構築してサウンドレンダラにアタッチします。
現在設定中のDSPバス設定を切り替える場合は、一度デタッチしてから再アタッチしてください。
- 注意:
- 本関数は完了復帰型の関数です。
本関数を実行すると、しばらくの間Atomライブラリのサーバ処理がブロックされます。
音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。
- 参照:
- CriAtom::DetachDspBusSetting
| static void DetachDspBusSetting |
( |
| ) |
|
|
inlinestatic |
DSPバス設定のデタッチ
- 説明:
- DSPバス設定をデタッチします。
- 注意:
- 本関数は完了復帰型の関数です。
本関数を実行すると、しばらくの間Atomライブラリのサーバ処理がブロックされます。
音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。
- 参照:
- CriAtom::DetachDspBusSetting
| static CriAtomCueSheet GetCueSheet |
( |
string |
name | ) |
|
|
inlinestatic |
キューシートの取得
- 引数:
-
- 戻り値:
- キューシートオブジェクト
- 説明:
- 引数に指定したキューシート名を元に登録済みのキューシートオブジェクトを取得します。
| static CriAtomCueSheet AddCueSheet |
( |
string |
name, |
|
|
string |
acbFile, |
|
|
string |
awbFile, |
|
|
CriFsBinder |
binder = null |
|
) |
| |
|
inlinestatic |
キューシートの追加
- 引数:
-
| name | キューシート名 |
| acbFile | ACBファイルパス |
| awbFile | AWBファイルパス |
| binder | バインダオブジェクト(オプション) |
- 戻り値:
- キューシートオブジェクト
- 説明:
- 引数に指定したファイルパス情報を元にキューシートの追加を行います。
同時に複数のキューシートを登録することが可能です。
各ファイルパスに対して相対パスを指定した場合は StreamingAssets フォルダからの相対でファイルをロードします。
絶対パス、あるいはURLを指定した場合には指定したパスでファイルをロードします。
CPKファイルにパッキングされたACBファイルとAWBファイルからキューシートを追加する場合は、 binder引数にCPKをバインドしたバインダを指定してください。
なお、バインダ機能はADX2LEではご利用になれません。
| static CriAtomCueSheet AddCueSheetAsync |
( |
string |
name, |
|
|
string |
acbFile, |
|
|
string |
awbFile, |
|
|
CriFsBinder |
binder = null, |
|
|
bool |
loadAwbOnMemory = false |
|
) |
| |
|
inlinestatic |
非同期でのキューシートの追加
- 引数:
-
| name | キューシート名 |
| acbFile | ACBファイルパス |
| awbFile | AWBファイルパス |
| binder | バインダオブジェクト(オプション) |
| loadAwbOnMemory | AWBファイルをメモリ上にロードするか(オプション) |
- 戻り値:
- キューシートオブジェクト
- 説明:
- 引数に指定したファイルパス情報を元に、非同期でキューシートの追加を行います。
同時に複数のキューシートを登録することが可能です。
各ファイルパスに対して相対パスを指定した場合は StreamingAssets フォルダからの相対でファイルをロードします。
絶対パス、あるいはURLを指定した場合には指定したパスでファイルをロードします。
CPKファイルにパッキングされたACBファイルとAWBファイルからキューシートを追加する場合は、 binder引数にCPKをバインドしたバインダを指定してください。
なお、バインダ機能はADX2LEではご利用になれません。
戻り値のキューシートオブジェクトの CriAtomCueSheet::isLoading メンバが true を返す間はロード中です。
必ず false を返すのを確認してからキューの再生等を行うようにしてください。
loadAwbOnMemory が false の場合、AWBファイルのヘッダ部分のみをメモリ上にロードしストリーム再生を行います。
loadAwbOnMemory を true に設定すると、AWBファイル全体をメモリ上にロードするため実質メモリ再生になります。
| static CriAtomCueSheet AddCueSheet |
( |
string |
name, |
|
|
byte[] |
acbData, |
|
|
string |
awbFile, |
|
|
CriFsBinder |
awbBinder = null |
|
) |
| |
|
inlinestatic |
キューシートの追加(メモリからの読み込み)
- 引数:
-
| name | キューシート名 |
| acbData | ACBデータ |
| awbFile | AWBファイルパス |
| awbBinder | AWB用バインダオブジェクト(オプション) |
- 戻り値:
- キューシートオブジェクト
- 説明:
- 引数に指定したデータとファイルパス情報からキューシートの追加を行います。
同時に複数のキューシートを登録することが可能です。
ファイルパスに対して相対パスを指定した場合は StreamingAssets フォルダからの相対でファイルをロードします。
絶対パス、あるいはURLを指定した場合には指定したパスでファイルをロードします。
CPKファイルにパッキングされたAWBファイルからキューシートを追加する場合は、 awbBinder引数にCPKをバインドしたバインダを指定してください。
なお、バインダ機能はADX2LEではご利用になれません。
| static CriAtomCueSheet AddCueSheetAsync |
( |
string |
name, |
|
|
byte[] |
acbData, |
|
|
string |
awbFile, |
|
|
CriFsBinder |
awbBinder = null, |
|
|
bool |
loadAwbOnMemory = false |
|
) |
| |
|
inlinestatic |
非同期でのキューシートの追加(メモリからの読み込み)
- 引数:
-
| name | キューシート名 |
| acbData | ACBデータ |
| awbFile | AWBファイルパス |
| awbBinder | AWB用バインダオブジェクト(オプション) |
| loadAwbOnMemory | AWBファイルをメモリ上にロードするか(オプション) |
- 戻り値:
- キューシートオブジェクト
- 説明:
- 引数に指定したデータとファイルパス情報からキューシートの追加を行います。
同時に複数のキューシートを登録することが可能です。
ファイルパスに対して相対パスを指定した場合は StreamingAssets フォルダからの相対でファイルをロードします。
絶対パス、あるいはURLを指定した場合には指定したパスでファイルをロードします。
CPKファイルにパッキングされたAWBファイルからキューシートを追加する場合は、 awbBinder引数にCPKをバインドしたバインダを指定してください。
なお、バインダ機能はADX2LEではご利用になれません。
戻り値のキューシートオブジェクトの CriAtomCueSheet::isLoading メンバが true を返す間はロード中です。
必ず false を返すのを確認してからキューの再生等を行うようにしてください。
loadAwbOnMemory が false の場合、AWBファイルのヘッダ部分のみをメモリ上にロードしストリーム再生を行います。
loadAwbOnMemory を true に設定すると、AWBファイル全体をメモリ上にロードするため実質メモリ再生になります。
| static void RemoveCueSheet |
( |
string |
name | ) |
|
|
inlinestatic |
キューシートの削除
- 引数:
-
- 説明:
- 追加済みのキューシートを削除します。
ACBオブジェクトの取得
- 引数:
-
- 戻り値:
- ACBオブジェクト
- 説明:
- 指定したキューシートに対応するACBオブジェクトを取得します。
| static void SetCategoryVolume |
( |
string |
name, |
|
|
float |
volume |
|
) |
| |
|
inlinestatic |
カテゴリ名指定でカテゴリボリュームを設定します。
- 引数:
-
| static void SetCategoryVolume |
( |
int |
id, |
|
|
float |
volume |
|
) |
| |
|
inlinestatic |
カテゴリID指定でカテゴリボリュームを設定します。
- 引数:
-
| static float GetCategoryVolume |
( |
string |
name | ) |
|
|
inlinestatic |
カテゴリ名指定でカテゴリボリュームを取得します。
- 引数:
-
- 戻り値:
- ボリューム
| static float GetCategoryVolume |
( |
int |
id | ) |
|
|
inlinestatic |
カテゴリID指定でカテゴリボリュームを取得します。
- 引数:
-
- 戻り値:
- ボリューム
| static void SetBusAnalyzer |
( |
string |
busName, |
|
|
bool |
sw |
|
) |
| |
|
inlinestatic |
バス情報取得を有効にします。
- 引数:
-
| busName | DSPバス名 |
| sw | true: 取得を有効にする。 false: 取得を無効にする |
| static void SetBusAnalyzer |
( |
bool |
sw | ) |
|
|
inlinestatic |
全てのバス情報取得を有効にします。
- 引数:
-
| sw | true: 取得を有効にする。 false: 取得を無効にする |
バス情報を取得します。
- 引数:
-
- 戻り値:
- DSPバス情報
プロパティ
キューシートのロード完了チェック
- 説明:
- 全てのキューシートのロード完了をチェックします。