CRIWARE Unity Plugin Manual  Last Updated: 2024-07-12
CriAtomExLatencyEstimator类 参考

用于获取音频播放延迟推测值的类。 更多...

struct  EstimatorInfo
 状态 更多...
 

Public 类型

enum  Status { Stop, Processing, Done, Error }
 状态 更多...
 

静态 Public 成员函数

static void InitializeModule ()
 延迟推测处理初始化 更多...
 
static void FinalizeModule ()
 结束延迟推测处理 更多...
 
static CriAtomExLatencyEstimator.EstimatorInfo GetCurrentInfo ()
 获取延迟推测信息 更多...
 

详细描述

用于获取音频播放延迟推测值的类。

说明:
在本类中。可以操作Atom声音渲染器的总线输出,更改音量, 或测量Level。

成员枚举类型说明

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

获取延迟推测信息

说明:
获取延迟推测处理的当前信息。
能够获取的信息是“延迟推测器的状态”、“推测延迟时间(毫秒)”这两个。

状态更改为 Status.Done 时可以获取的 estimated_latency 是推测值。
此外,无法立即获取延迟推测值。从Status.Processsing到 Status.Done, 需要数十~数百毫秒左右。(所需时间根据Atom初始化设置和终端而有所不同)
Status.Done以外时的 estmated_latency 的值是无效值。请务必确认是 Status.Done 后 再记录 estimated_latency 的值。

调用本函数并获取推测值后,请用riAtomExLatencyEstimator.Finalize结束处理。
参见
CriAtomExLatencyEstimator.InitializeModule, CriAtomExLatencyEstimator.FinalizeModule

该类的文档由以下文件生成: