CRIWARE Unity Plugin Manual  Last Updated: 2024-02-07
CriAtom クラス

サウンド再生全体を制御するためのコンポーネントです。 [詳解]

CriMonoBehaviourを継承しています。

公開型

enum  SpeakerMapping : System.Int32 {
  Auto = 0, Monaural, Stereo, Ch5_1,
  Ch7_1, Ch5_1_2, Ch7_1_2, Ch7_1_4,
  Ambisonics1p, Ambisonics2p, Ambisonics3p, Object,
  Custom
}
 ミキサーのスピーカーマッピング種別 [詳解]
 

静的公開メンバ関数

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)
 バス情報を取得します。 [詳解]
 
static CriAtomExAsr.BusAnalyzerInfo GetBusAnalyzerInfo (int busId)
 

プロパティ

static bool CueSheetsAreLoading [get]
 キューシートのロード完了チェック [詳解]
 

詳解

サウンド再生全体を制御するためのコンポーネントです。

説明:
各シーンにひとつ用意しておく必要があります。
UnityEditor上でCRI Atomウィンドウを使用して CriAtomSource を作成した場合、 「CRIWARE」という名前を持つオブジェクトとして自動的に作成されます。通常はユーザーが作成する必要はありません。

列挙型メンバ詳解

enum SpeakerMapping : System.Int32
strong

ミキサーのスピーカーマッピング種別

説明:
ASRのスピーカーマッピングを指定します。
参照
CriAtomExAsrRack.Config.speakerMapping, CriAtomConfig.speakerMapping
列挙値
Auto 

自動設定

Monaural 

1ch

Stereo 

2ch

Ch5_1 

5.1ch

Ch7_1 

7.1ch

Ch5_1_2 

5.1.2ch

Ch7_1_2 

7.1.2ch

Ch7_1_4 

7.1.4ch

Ambisonics1p 

1st order Ambisonics

Ambisonics2p 

2st order Ambisonics

Ambisonics3p 

3st order Ambisonics

Object 

Object Base Audio

Custom 

Custom Speaker Mapping

関数詳解

static void AttachDspBusSetting ( string  settingName)
inlinestatic

DSPバス設定のアタッチ

引数
settingNameDSPバス設定の名前
説明:
DSPバス設定からDSPバスを構築してサウンドレンダラにアタッチします。
現在設定中のDSPバス設定を切り替える場合は、一度デタッチしてから再アタッチしてください。
注意:
本関数は完了復帰型の関数です。
本関数を実行すると、しばらくの間Atomライブラリのサーバ処理がブロックされます。
音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。
参照
CriAtom::DetachDspBusSetting
static void DetachDspBusSetting ( )
inlinestatic

DSPバス設定のデタッチ

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

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

キューシートの取得

引数
nameキューシート名
戻り値
キューシートオブジェクト
説明:
引数に指定したキューシート名を元に登録済みのキューシートオブジェクトを取得します。
static CriAtomCueSheet AddCueSheet ( string  name,
string  acbFile,
string  awbFile,
CriFsBinder  binder = null 
)
inlinestatic

キューシートの追加

引数
nameキューシート名
acbFileACBファイルパス
awbFileAWBファイルパス
binderバインダオブジェクト(オプション)
戻り値
キューシートオブジェクト
説明:
引数に指定したファイルパス情報を元にキューシートの追加を行います。
同時に複数のキューシートを登録することが可能です。

各ファイルパスに対して相対パスを指定した場合は StreamingAssets フォルダからの相対でファイルをロードします。
絶対パス、あるいはURLを指定した場合には指定したパスでファイルをロードします。

CPKファイルにパッキングされたACBファイルとAWBファイルからキューシートを追加する場合は、 binder引数にCPKをバインドしたバインダを指定してください。
なお、バインダ機能はADXLEではご利用になれません。
static CriAtomCueSheet AddCueSheetAsync ( string  name,
string  acbFile,
string  awbFile,
CriFsBinder  binder = null,
bool  loadAwbOnMemory = false 
)
inlinestatic

非同期でのキューシートの追加

引数
nameキューシート名
acbFileACBファイルパス
awbFileAWBファイルパス
binderバインダオブジェクト(オプション)
loadAwbOnMemoryAWBファイルをメモリ上にロードするか(オプション)
戻り値
キューシートオブジェクト
説明:
引数に指定したファイルパス情報を元に、非同期でキューシートの追加を行います。
同時に複数のキューシートを登録することが可能です。

各ファイルパスに対して相対パスを指定した場合は StreamingAssets フォルダからの相対でファイルをロードします。
絶対パス、あるいはURLを指定した場合には指定したパスでファイルをロードします。

CPKファイルにパッキングされたACBファイルとAWBファイルからキューシートを追加する場合は、 binder引数にCPKをバインドしたバインダを指定してください。
なお、バインダ機能はADXLEではご利用になれません。

戻り値のキューシートオブジェクトの CriAtomCueSheet::isLoading メンバが true を返す間はロード中です。
必ず false を返すのを確認してからキューの再生等を行うようにしてください。

loadAwbOnMemory が false の場合、AWBファイルのヘッダ部分のみをメモリ上にロードしストリーム再生を行います。
loadAwbOnMemory を true に設定すると、AWBファイル全体をメモリ上にロードするため実質メモリ再生になります。
WebGL(Editor実行時)では内部都合上、 loadAwbOnMemory が強制的にtrueになります。
static CriAtomCueSheet AddCueSheet ( string  name,
byte[]  acbData,
string  awbFile,
CriFsBinder  awbBinder = null 
)
inlinestatic

キューシートの追加(メモリからの読み込み)

引数
nameキューシート名
acbDataACBデータ
awbFileAWBファイルパス
awbBinderAWB用バインダオブジェクト(オプション)
戻り値
キューシートオブジェクト
説明:
引数に指定したデータとファイルパス情報からキューシートの追加を行います。
同時に複数のキューシートを登録することが可能です。

ファイルパスに対して相対パスを指定した場合は StreamingAssets フォルダからの相対でファイルをロードします。
絶対パス、あるいはURLを指定した場合には指定したパスでファイルをロードします。

CPKファイルにパッキングされたAWBファイルからキューシートを追加する場合は、 awbBinder引数にCPKをバインドしたバインダを指定してください。
なお、バインダ機能はADXLEではご利用になれません。
static CriAtomCueSheet AddCueSheetAsync ( string  name,
byte[]  acbData,
string  awbFile,
CriFsBinder  awbBinder = null,
bool  loadAwbOnMemory = false 
)
inlinestatic

非同期でのキューシートの追加(メモリからの読み込み)

引数
nameキューシート名
acbDataACBデータ
awbFileAWBファイルパス
awbBinderAWB用バインダオブジェクト(オプション)
loadAwbOnMemoryAWBファイルをメモリ上にロードするか(オプション)
戻り値
キューシートオブジェクト
説明:
引数に指定したデータとファイルパス情報からキューシートの追加を行います。
同時に複数のキューシートを登録することが可能です。

ファイルパスに対して相対パスを指定した場合は StreamingAssets フォルダからの相対でファイルをロードします。
絶対パス、あるいはURLを指定した場合には指定したパスでファイルをロードします。

CPKファイルにパッキングされたAWBファイルからキューシートを追加する場合は、 awbBinder引数にCPKをバインドしたバインダを指定してください。
なお、バインダ機能はADXLEではご利用になれません。

戻り値のキューシートオブジェクトの CriAtomCueSheet::isLoading メンバが true を返す間はロード中です。
必ず false を返すのを確認してからキューの再生等を行うようにしてください。

loadAwbOnMemory が false の場合、AWBファイルのヘッダ部分のみをメモリ上にロードしストリーム再生を行います。
loadAwbOnMemory を true に設定すると、AWBファイル全体をメモリ上にロードするため実質メモリ再生になります。
WebGL(Editor実行時)では内部都合上、 loadAwbOnMemory が強制的にtrueになります。
static void RemoveCueSheet ( string  name)
inlinestatic

キューシートの削除

引数
nameキューシート名
説明:
追加済みのキューシートを削除します。
static CriAtomExAcb GetAcb ( string  cueSheetName)
inlinestatic

ACBオブジェクトの取得

引数
cueSheetNameキューシート名
戻り値
ACBオブジェクト
説明:
指定したキューシートに対応するACBオブジェクトを取得します。
static void SetCategoryVolume ( string  name,
float  volume 
)
inlinestatic

カテゴリ名指定でカテゴリボリュームを設定します。

引数
nameカテゴリ名
volumeボリューム
static void SetCategoryVolume ( int  id,
float  volume 
)
inlinestatic

カテゴリID指定でカテゴリボリュームを設定します。

引数
idカテゴリID
volumeボリューム
static float GetCategoryVolume ( string  name)
inlinestatic

カテゴリ名指定でカテゴリボリュームを取得します。

引数
nameカテゴリ名
戻り値
ボリューム
static float GetCategoryVolume ( int  id)
inlinestatic

カテゴリID指定でカテゴリボリュームを取得します。

引数
idカテゴリID
戻り値
ボリューム
static void SetBusAnalyzer ( string  busName,
bool  sw 
)
inlinestatic

バス情報取得を有効にします。

引数
busNameDSPバス名
swTrue: 取得を有効にする。 False: 取得を無効にする
static void SetBusAnalyzer ( bool  sw)
inlinestatic

全てのバス情報取得を有効にします。

引数
swTrue: 取得を有効にする。 False: 取得を無効にする
static CriAtomExAsr.BusAnalyzerInfo GetBusAnalyzerInfo ( string  busName)
inlinestatic

バス情報を取得します。

引数
busNameDSPバス名
戻り値
DSPバス情報
static CriAtomExAsr.BusAnalyzerInfo GetBusAnalyzerInfo ( int  busId)
inlinestatic
非推奨:
削除予定の非推奨APIです。 CriAtom.GetBusAnalyzerInfo(string busName)の使用を検討してください。

プロパティ詳解

bool CueSheetsAreLoading
staticget

キューシートのロード完了チェック

説明:
全てのキューシートのロード完了をチェックします。

このクラス詳解は次のファイルから抽出されました: