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

音声再生の遅延推測値を取得するためのクラスです。 [詳解]

クラス

struct  EstimatorInfo
 ステータス [詳解]
 

公開型

enum  Status { Stop, Processing, Done, Error }
 ステータス [詳解]
 

静的公開メンバ関数

static void InitializeModule ()
 遅延推測処理の初期化 [詳解]
 
static void FinalizeModule ()
 遅延推測処理の終了 [詳解]
 
static CriAtomExLatencyEstimator.EstimatorInfo GetCurrentInfo ()
 遅延推測の情報取得 [詳解]
 

詳解

音声再生の遅延推測値を取得するためのクラスです。

説明:
本クラスでは、Atomサウンドレンダラのバス出力を操作してボリュームを変更したり、 レベルを測定することができます。

列挙型メンバ詳解

enum Status
strong

ステータス

説明:
遅延推測処理の状態を示す値です。
CriWare.CriAtomExLatencyEstimator::GetCurrentInfo 関数で取得可能です。

列挙値
Stop 

初期状態/停止状態

Processing 

遅延時間を推測中

Done 

遅延時間の推測完了

Error 

エラー

関数詳解

static void InitializeModule ( )
inlinestatic

遅延推測処理の初期化

呼び出し条件:
本関数はプラグインの初期化後に呼び出してください。
説明:
音声再生の遅延推測処理を開始します。

CriAtomExLatencyEstimatorクラスを使用して音声の遅延推測値を取得する場合、 必ず本関数で初期化を行う必要があります。
推測値が取得できた、あるいはエラーが発生した場合は、CriAtomExLatencyEstimator.Finalize 関数を呼び出してください。
備考:
本関数の多重呼び出しを許容しますが、呼び出し回数を内部でカウントしており、 実際の初期化処理が実行されるのは、最初の呼び出しの時だけになります。
参照
CriAtomExLatencyEstimator.FinalizeModule
static void FinalizeModule ( )
inlinestatic

遅延推測処理の終了

説明:
音声再生の遅延推測処理を終了します。

遅延推測値の取得が完了したら、本関数を呼び出し推測処理を終了させてください。 また、エラーが発生した場合や、推測処理を中断させる場合にも本関数を呼び出してください。
備考:
CriAtomExLatencyEstimator.InitializeModule関数を複数回呼び出した場合、内部で呼び出し回数(参照カウント)が インクリメントされます。参照カウントが0になるまで終了処理は呼び出されませんので、複数回初期化を行った 場合には参照カウントが0になるまで本関数を呼び出してください。
参照
CriAtomExLatencyEstimator.InitializeModule
static CriAtomExLatencyEstimator.EstimatorInfo GetCurrentInfo ( )
inlinestatic

遅延推測の情報取得

説明:
遅延推測処理の現在の情報を取得します。
取得できる情報は「遅延推測器の状態」「推測遅延時間(ミリ秒)」の2つです。

状態が Status.Done になった時に取得できた estimated_latency が、推測値です。
なお、遅延推測値はすぐには取得できません。Status.Processsingから Status.Doneになるまで、 数十~数百ミリ秒ほどかかります。(必要な時間はAtomの初期化設定や端末により異なります)
Status.Done以外の時の estmated_latency の値は無効値です。必ず Status.Done であることを 確認してから estimated_latency の値を記録してください。

本関数を呼び出して推測値を取得したら、riAtomExLatencyEstimator.Finalizeで処理を終了してください。
参照
CriAtomExLatencyEstimator.InitializeModule, CriAtomExLatencyEstimator.FinalizeModule

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