Class CriAtomHcaMx
CriAtomHcaMx API
Inherited Members
Namespace: CriWare
Assembly: CriWare.CriAtom.dll
Syntax
public static class CriAtomHcaMxMethods
CalculateWorkSize(in Config)
LE ProHCA-MX初期化用ワーク領域サイズの計算
Declaration
Parameters
| Type | Name | Description |
|---|---|---|
| CriAtomHcaMx.Config | config | HCA-MX初期化用コンフィグ構造体 |
Returns
| Type | Description |
|---|---|
| int | CriSint32 ワーク領域サイズ |
Remarks
説明: HCA-MXの初期化に必要なワーク領域のサイズを取得します。 SetUserAllocator(delegate* unmanaged[Cdecl]<IntPtr, uint, IntPtr>, delegate* unmanaged[Cdecl]<IntPtr, IntPtr, void>, IntPtr) メソッドによるアロケーター登録を行わずに Initialize(in Config) 関数でHCA-MXの初期化を行う場合、 本関数で計算したサイズ分のメモリをワーク領域として渡す必要があります。 ワーク領域サイズの計算に失敗すると、本関数は -1 を返します。 ワーク領域サイズの計算に失敗した理由については、エラーコールバックのメッセージで確認可能です。
備考: HCA-MXの初期化に必要なワークメモリのサイズは、HCA-MX初期化用コンフィグ 構造体（ CriAtomHcaMx.Config ）の内容によって変化します。 引数にnullを指定した場合、デフォルト設定 （ SetDefaultConfig(out Config) 適用時と同じパラメーター）で ワーク領域サイズを計算します。 引数 config の情報は、関数内でのみ参照されます。 関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。
See Also
Finalize()
LE ProHCA-MXの終了
Declaration
Remarks
説明: HCA-MXの終了処理を行います。 本関数を実行することで、HCA-MXデータの出力が停止されます。 SetUserAllocator(delegate* unmanaged[Cdecl]<IntPtr, uint, IntPtr>, delegate* unmanaged[Cdecl]<IntPtr, IntPtr, void>, IntPtr) メソッドを使用してアロケーターを登録済みの場合、 HCA-MX初期化時に確保されたメモリ領域が解放されます。 （HCA-MX初期化時にワーク領域を渡した場合、本関数実行後であれば ワーク領域を解放可能です。）
注意: 本関数は完了復帰型の関数です。 本関数を実行すると、しばらくの間Atomライブラリのサーバー処理がブロックされます。 音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。
See Also
Initialize(in Config)
LE ProHCA-MXの初期化
Declaration
Parameters
| Type | Name | Description |
|---|---|---|
| CriAtomHcaMx.Config | config | HCA-MX初期化用コンフィグ構造体 |
Remarks
説明: HCA-MXの初期化を行います。 本関数を実行することで、HCA-MXデータの出力機能が起動されます。
備考: HCA-MXの初期化に必要なワークメモリのサイズは、HCA-MX初期化用コンフィグ 構造体（ CriAtomHcaMx.Config ）の内容によって変化します。 引数にnullを指定した場合、デフォルト設定 （ SetDefaultConfig(out Config) 適用時と同じパラメーター）で初期化処理を行います。 引数 config の情報は、関数内でのみ参照されます。 関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。
注意: 本関数を実行する前に、ライブラリを初期化しておく必要があります。 本関数は完了復帰型の関数です。 本関数を実行すると、しばらくの間Atomライブラリのサーバー処理がブロックされます。 音声再生中に本関数を実行すると、音途切れ等の不具合が発生する可能性があるため、 本関数の呼び出しはシーンの切り替わり等、負荷変動を許容できるタイミングで行ってください。 本関数を実行後、必ず対になる Finalize() 関数を実行してください。 また、 Finalize() 関数を実行するまでは、本関数を再度実行しないでください。
See Also
SetBusSendLevelByName(int, ArgString, float)
LE Proミキサーのバスセンドレベル設定
Declaration
Parameters
| Type | Name | Description |
|---|---|---|
| int | mixerId | ミキサーID |
| ArgString | busName | バス名 |
| float | level | センドレベル値（0.0f～1.0f） |
Remarks
説明: ミキサーのバスセンドレベルを設定します。 デフォルト状態では、HCA-MXのデコード結果はミキサーに格納された後、 バス0へ1.0fのレベルで送信されます。 本関数を使用することで、デコード結果を他のバスへもセンドすることが可能になります。 （ミキサーごとに異なるバスエフェクトを適用可能になります。）
SetConfigForWorkSizeCalculation(in Config)
LE Proワーク領域サイズ計算用コンフィグ構造体の設定
Declaration
Parameters
| Type | Name | Description |
|---|---|---|
| CriAtomHcaMx.Config | config | HCA-MX初期化用コンフィグ構造体 |
Remarks
説明: ワーク領域サイズの計算用に、HCA-MX初期化用コンフィグ構造体 （ CriAtomHcaMx.Config 構造体）を仮登録します。 HCA-MXプレーヤーの作成に必要なワーク領域のサイズは、 HCA-MX初期化時（ Initialize(in Config) 関数実行時） に設定する構造体のパラメーターによって変化します。 そのため、通常はプレーヤーの作成に必要なワーク領域サイズを計算する前に、 HCA-MXを初期化する必要があります。 本関数を使用してHCA-MX初期化用コンフィグ構造体を登録した場合、 CalculateWorkSizeForHcaMxPlayer(in PlayerConfig) 関数が初期化処理なしに使用可能となります。
備考: 引数（ config ）に null を指定した場合、デフォルト設定 （ SetDefaultConfigForHcaMxPlayer(out PlayerConfig) 適用時と同じパラメーター）でワーク領域サイズを計算します。 現状、本関数で一旦コンフィグ構造体を設定すると、 設定前の状態（未初期化状態でのワーク領域サイズ計算をエラーとする動作） に戻すことができなくなります。 （関数を再度実行してパラメーターを上書きすることは可能です。）
注意: 本関数で登録した初期化用コンフィグ構造体は、 HCA-MX未初期化状態でのワーク領域サイズ計算にしか使用されません。 HCA-MX初期化後には本関数に設定したパラメーターではなく、 初期化時に指定されたパラメーターがワーク領域サイズの計算に使用されます。 （本関数で登録する構造体のパラメーターと、 HCA-MX初期化時に使用する構造体のパラメーターが異なる場合、 ワーク領域サイズが不足し、オブジェクトの作成に失敗する恐れがあります。）
See Also
SetDefaultConfig(out Config)
LE ProHCA-MX初期化コンフィグ構造体にデフォルト値をセット
Declaration
Parameters
| Type | Name | Description |
|---|---|---|
| CriAtomHcaMx.Config | pConfig | コンフィグ |
Remarks
See Also
SetFrequencyRatio(int, float)
LE Proミキサーの出力周波数調整比の設定
Declaration
Parameters
| Type | Name | Description |
|---|---|---|
| int | mixerId | ミキサーID |
| float | ratio | センドレベル値（0.25f～4.0f） |
Remarks
説明: ミキサーの出力周波数調整比を設定します。 周波数調整比は、音声データの周波数と再生周波数の比率で、再生速度の倍率と等価です。 周波数比が1.0fを超える場合、音声データは原音より高速に再生され、 1.0f未満の場合は、音声データは原音より低速で再生されます。 本関数を使用することで、対象のミキサーを使用する全てのプレーヤーの再生速度を 変更することができます（個々のプレーヤーの再生速度は変更できません）。