Class CriAtomAsr

CriAtomAsr API

Inheritance
object
CriAtomAsr
Inherited Members
Namespace: CriWare
Assembly: CriWare.CriAtom.dll
Syntax
public static class CriAtomAsr

Methods

CalculateWorkSize(in Config)

ASR初期化用ワーク領域サイズの計算

Declaration
public static int CalculateWorkSize(in CriAtomAsr.Config config)
Parameters
Type Name Description
CriAtomAsr.Config config

ASR初期化用コンフィグ構造体
Returns
Type Description
int
Remarks

説明: ASR（Atom Sound Renderer）の初期化に必要なワーク領域のサイズを取得します。 SetUserAllocator(delegate* unmanaged[Cdecl]<IntPtr, uint, IntPtr>, delegate* unmanaged[Cdecl]<IntPtr, IntPtr, void>, IntPtr) メソッドによるアロケーター登録を行わずに Initialize(in Config, IntPtr, int) 関数でASRの初期化を行う場合、 本関数で計算したサイズ分のメモリをワーク領域として渡す必要があります。 ワーク領域サイズの計算に失敗すると、本関数は -1 を返します。 ワーク領域サイズの計算に失敗した理由については、エラーコールバックのメッセージで確認可能です。

備考: ASRの初期化に必要なワークメモリのサイズは、ASR初期化用コンフィグ 構造体（ CriAtomAsr.Config ）の内容によって変化します。 引数にnullを指定した場合、デフォルト設定 （ SetDefaultConfig(out Config) 適用時と同じパラメーター）で ワーク領域サイズを計算します。 引数 config の情報は、関数内でのみ参照されます。 関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。

See Also

Finalize()

ASRの終了

Declaration
public static void Finalize()
Remarks

説明: ASR（Atom Sound Renderer）の終了処理を行います。 本関数を実行することで、レンダリング結果の出力が停止されます。 SetUserAllocator(delegate* unmanaged[Cdecl]<IntPtr, uint, IntPtr>, delegate* unmanaged[Cdecl]<IntPtr, IntPtr, void>, IntPtr) メソッドを使用してアロケーターを登録済みの場合、 ASR初期化時に確保されたメモリ領域が解放されます。 （ASR初期化時にワーク領域を渡した場合、本関数実行後であれば ワーク領域を解放可能です。）

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

See Also

Initialize(in Config, IntPtr, int)

ASRの初期化

Declaration
public static void Initialize(in CriAtomAsr.Config config, IntPtr work = default, int workSize = 0)
Parameters
Type Name Description
CriAtomAsr.Config config

ASR初期化用コンフィグ構造体
IntPtr work

ワーク領域
int workSize

ワーク領域サイズ
Remarks

説明: ASR（Atom Sound Renderer）の初期化を行います。 本関数を実行することでASRが起動され、レンダリング結果の出力を開始します。

備考: ASRの初期化に必要なワークメモリのサイズは、ASR初期化用コンフィグ 構造体（ CriAtomAsr.Config ）の内容によって変化します。 引数にnullを指定した場合、デフォルト設定 （ SetDefaultConfig(out Config) 適用時と同じパラメーター）で初期化処理を行います。 引数 config の情報は、関数内でのみ参照されます。 関数を抜けた後は参照されませんので、関数実行後に config の領域を解放しても 問題ありません。

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

See Also

SetDefaultConfig(out Config)

CriAtomAsr.Configへのデフォルトパラメーターをセット

Declaration
public static void SetDefaultConfig(out CriAtomAsr.Config pConfig)
Parameters
Type Name Description
CriAtomAsr.Config pConfig

初期化用コンフィグ構造体へのポインタ
Remarks

説明: Initialize(in Config, IntPtr, int) 関数に設定するコンフィグ構造体（ CriAtomAsr.Config ）に、 デフォルトの値をセットします。

See Also