CriAtomExAsrRack类 参考

ASR Rack 更多...

继承自 CriDisposable .

类
struct	Config
	创建ASR Rack用配置结构体 更多...
interface	IPlatformConfig
	用于创建ASR Rack的平台专用配置结构体接口 更多...
struct	PerformanceInfo
	性能信息 更多...
struct	PlatformConfig
	创建ASR Rack用平台专用配置结构体 更多...

Public 成员函数
	CriAtomExAsrRack (Config config, IPlatformConfig platformConfig)
	创建ASR Rack 更多...
	CriAtomExAsrRack (Config config, PlatformConfig platformConfig)
	创建ASR Rack 更多...
void	AttachDspBusSetting (string settingName)
	添加DSP总线设置 更多...
void	DetachDspBusSetting ()
	切断DSP总线设置 更多...
void	ApplyDspBusSnapshot (string snapshotName, int timeMs)
	适用DSP总线快照 更多...
string	GetAppliedDspBusSnapshotName ()
	获取快照名称 更多...
PerformanceInfo	GetPerformanceInfo ()
	获取ASR Rack的性能信息 更多...
void	ResetPerformanceMonitor ()
	重置ASR Rack的性能计测 更多...
override void	Dispose ()
	丢弃ASR Rack 更多...

静态 Public 成员函数
static string	GetAppliedDspBusSnapshotName (CriAtomExAsrRackId rackId)
	获取快照名称 更多...
static PerformanceInfo	GetPerformanceInfoByRackId (CriAtomExAsrRackId rackId=CriAtomExAsrRack.defaultRackId)
	获取ASR Rack的性能信息 更多...
static void	ResetPerformanceMonitorByRackId (CriAtomExAsrRackId rackId=CriAtomExAsrRack.defaultRackId)
	重置ASR Rack的性能计测 更多...
static void	SetAisacControl (CriAtomExAsrRackId rackId, string controlName, float value)
	通过指定名称实现AISAC Control值的设置 更多...
static void	SetAisacControl (CriAtomExAsrRackId rackId, int controlId, float value)
	通过指定ID设置AISAC控制值 更多...
static void	SetDefaultConfig (ref Config config)
	设置预设参数 更多...
static void	GetNumRenderedSamples (CriAtomExAsrRackId rackId, out Int64 numSamples, out Int32 samplingRate)
	获取ASR Rack的总渲染量 更多...
static CriAtomExAsrRackId	GetAmbisonicRackId ()
	获取用于 Ambisonics 播放的 ASR Rack ID 更多...
static CriAtomExAsrRackId	GetChannelBasedAudioRackId ()
	获取用于 Channel-based 播放的 ASR Rack ID 更多...
static CriAtomExAsrRackId	GetObjectBasedAudioRackId ()
	获取 ObjectBasedAudio 播放的 ASR Rack ID 更多...
static CriAtomExAsrRackId	GetPassThroughRackId ()
	获取用于直通播放的 ASR Rack ID 更多...

Public 属性
const CriAtomExAsrRackId	defaultRackId = 0
	预设ASR Rack ID 更多...
const CriAtomExAsrRackId	IllegalRackId = -1
	非法Rack ID 更多...

属性
CriAtomExAsrRackId	rackId [get]
	获取ASR Rack ID 更多...
static CriAtomExAsrRack	Default [get]
	默认 ASR Rack 更多...
static Config	defaultConfig = new CriAtomExAsrRack(defaultRackId) [get]
	预设配置 更多...

详细描述

ASR Rack

构造及析构函数说明

CriAtomExAsrRack ( Config  config, IPlatformConfig  platformConfig  )

inline

创建ASR Rack

参数

config	配置结构体
platformConfig	平台专用参数结构体

返回

ASR Rack

说明:

创建一个ASR Rack。
由该函数创建的ASR Rack必须由Dispose函数销毁。
如果不使用特定的平台参数，请对platformConfig设置null。

CriAtomExAsrRack ( Config  config, PlatformConfig  platformConfig  )

inline

创建ASR Rack

弃用:

削除予定の非推奨APIです。 CriWare.CriAtomExAsrRack.CriAtomExAsrRack(Config, IPlatformConfig) の使用を検討してください。

参数

config	配置结构体
platformConfig	平台专用参数结构体

返回

ASR Rack

说明:

创建ASR Rack。
用本函数创建的ASR Rack，请务必用 Dispose 函数进行丢弃。

成员函数说明

void AttachDspBusSetting ( string  settingName )

inline

添加DSP总线设置

参数

settingName

DSP总线设置的名称

说明:

使用DSP总线设置构建DSP总线，并将其挂载至ASR Rack。
要执行此函数，需要提前使用CriAtomEx::RegisterAcf 函数注册ACF信息

注意:

本函数是完成返回型函数。
执行本函数后，一段时间内，Atom运行库的Server处理将被阻断。
如果在音频播放过程中执行本函数，则可能会发生声音中断等异常， 要调用本函数时，请在场景切换等能够承受负荷变动的时机上进行调用。

参见

CriAtomExAsrRack::DetachDspBusSetting, CriAtomEx::RegisterAcf

void DetachDspBusSetting ( )

inline

切断DSP总线设置

说明:

切断DSP总线设置。

注意:

本函数是完成返回型函数。
执行本函数后，一段时间内，Atom运行库的Server处理将被阻断。
如果在音频播放过程中执行本函数，则可能会发生声音中断等异常， 要调用本函数时，请在场景切换等能够承受负荷变动的时机上进行调用。

参见

CriAtomExAsrRack::AttachDspBusSetting

void ApplyDspBusSnapshot ( string  snapshotName, int  timeMs  )

inline

适用DSP总线快照

参数

snapshotName	DSP总线快照名
timeMs	快照完全反映所需的时间（毫秒）

说明:

将DSP总线快照应用到ASR Rack。
调用此函数时，参数会逐渐变为快照保存值。 变更需要的时间为timeMs毫秒。

static string GetAppliedDspBusSnapshotName ( CriAtomExAsrRackId  rackId )

inlinestatic

获取快照名称

参数

rackId

Rack ID

返回

快照名

说明:

获取当前设置的快照名称。 如果未设置，则返回null。

string GetAppliedDspBusSnapshotName ( )

inline

获取快照名称

返回

快照名

说明:

获取当前设置的快照名称。 如果未设置，则返回null。

PerformanceInfo GetPerformanceInfo ( )

inline

获取ASR Rack的性能信息

返回

ASR Rack的性能信息

说明:

从当前ASR Rack实例获取性能信息。

参见

CriAtomExAsrRack::ResetPerformanceMonitor, CriAtomExAsrRack::GetPerformanceInfoByRackId

static PerformanceInfo GetPerformanceInfoByRackId ( CriAtomExAsrRackId  rackId = CriAtomExAsrRack.defaultRackId )

inlinestatic

获取ASR Rack的性能信息

参数

rackId

Rack ID

返回

ASR Rack的性能信息

说明:

获取指定ID的ASR Rack的性能信息。
如果不指定Rack ID，则返回运行库初始化时生成的预设ASR Rack的性能信息。
如果指定了无效的Rack ID，则返回一个成员变量值全为0的结构体。

参见

CriAtomExAsrRack::ResetPerformanceMonitorByRackId, CriAtomExAsrRack::GetPerformanceInfo

void ResetPerformanceMonitor ( )

inline

重置ASR Rack的性能计测

说明:

重置当前ASR Rack实例的性能测量。

参见

CriAtomExAsrRack::GetPerformanceInfo, CriAtomExAsrRack::ResetPerformanceMonitorByRackId

static void ResetPerformanceMonitorByRackId ( CriAtomExAsrRackId  rackId = CriAtomExAsrRack.defaultRackId )

inlinestatic

重置ASR Rack的性能计测

参数

rackId

Rack ID

说明:

重置指定ID的ASR Rack的性能测量。
如果不指定Rack ID，则会重置运行库初始化时生成的预设ASR Rack性能信息。

参见

CriAtomExAsrRack::GetPerformanceInfoByRackId, CriAtomExAsrRack::ResetPerformanceMonitor

static void SetAisacControl ( CriAtomExAsrRackId  rackId, string  controlName, float  value  )

inlinestatic

通过指定名称实现AISAC Control值的设置

参数

rackId	Rack ID
controlName	AISAC控制器名
value	AISAC控制器值

说明:

通过指定名称设置AISAC Control值

static void SetAisacControl ( CriAtomExAsrRackId  rackId, int  controlId, float  value  )

inlinestatic

通过指定ID设置AISAC控制值

参数

rackId	Rack ID
controlId	AISAC控制器ID
value	AISAC控制器值

说明:

设置指定的ID设置AISAC控制的值。

static void SetDefaultConfig ( ref Config  config )

inlinestatic

设置预设参数

参数

config

初始化配置

说明:

在 CriWare.CriAtomExAsrRack.CriAtomExAsrRack 使用的初始化配置中设置预设参数。

override void Dispose ( )

inline

丢弃ASR Rack

说明:

丢弃ASR Rack。

static void GetNumRenderedSamples ( CriAtomExAsrRackId  rackId, out Int64  numSamples, out Int32  samplingRate  )

inlinestatic

获取ASR Rack的总渲染量

参数

rackId	Rack ID
numSamples	渲染样本数
samplingRate	采样率

说明:

获取ASR Rack的渲染样本数和采样率。

注意:

本函数的渲染样本数的增加模式可能会根据执行中的平台或输出设备而不同。

static CriAtomExAsrRackId GetAmbisonicRackId ( )

inlinestatic

获取用于 Ambisonics 播放的 ASR Rack ID

返回

ASR Rack ID

说明:

获取用于 Ambisonics 播放的 ASR Rack ID。
获取到的ID可以通过CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId)作为CriAtomExAsrRack对象进行处理。

通过注册设置了输出端口“_ambisonics”的 ACF，可以自动创建用于 Ambisonics 播放的 ASR Rack。
获得的 ASR Rack ID 仅在有 ACF 被注册期间有效。
如果取消 ACF 注册，用于 Ambisonics 播放的 ASR Rack也将被删除，并且获取的 ASR Rack ID 将变为无效。
如果未创建用于 Ambisonics 播放的 ASR Rack，则返回 CriAtomExAsrRack.IllegalRackId。

参见

CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId)

static CriAtomExAsrRackId GetChannelBasedAudioRackId ( )

inlinestatic

获取用于 Channel-based 播放的 ASR Rack ID

返回

ASR Rack ID

说明:

获取用于Channel-based播放的 ASR Rack ID。
获取到的ID可以通过CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId)作为CriAtomExAsrRack对象进行处理。

通过在输出端口“_7_1_4”设置中注册一个将“使用专用混音器”指定为 True 的 ACF，会自动创建用于Channel-based播放的 ASR Rack。
获得的 ASR Rack ID 仅在有 ACF 被注册期间有效。
如果取消 ACF 注册，Channel-based播放的 ASR Rack也将被删除，并且获取的 ASR Rack ID 将变为无效。
如果尚未创建用于Channel-based播放的 ASR Rack，则返回 CriAtomExAsrRack.IllegalRackId。

参见

CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId)

static CriAtomExAsrRackId GetObjectBasedAudioRackId ( )

inlinestatic

获取 ObjectBasedAudio 播放的 ASR Rack ID

返回

ASR Rack ID

说明:

获取用于 ObjectBasedAudio 播放的 ASR Rack ID。
获取到的ID可以通过CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId)作为CriAtomExAsrRack对象进行处理。

通过注册设置了输出端口“_object_based_audio”的 ACF，会自动创建用于 ObjectBasedAudio 播放的 ASR Rack。
获得的 ASR Rack ID 仅在有 ACF 被注册期间有效。
如果取消注册 ACF，用于 ObjectBasedAudio 播放的 ASR Rack也将被删除，并且获取的 ASR Rack ID 将变为无效。
如果未创建用于 ObjectBasedAudio 播放的 ASR Rack，则返回 CriAtomExAsrRack.IllegalRackId。

参见

CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId)

static CriAtomExAsrRackId GetPassThroughRackId ( )

inlinestatic

获取用于直通播放的 ASR Rack ID

返回

ASR Rack ID

说明:

获取仅执行直通播放的 ASR Rack的 ID。
获取到的ID可以通过CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId)作为CriAtomExAsrRack对象进行处理。
通过注册具有输出端口“_pass_through”设置的 ACF，可以自动创建用于直通播放的 ASR Rack。
获得的 ASR Rack ID 仅在有 ACF 被注册期间有效。
如果取消 ACF 注册，用于直通播放的 ASR Rack也将被删除，并且获取的 ASR Rack ID 将变为无效。
如果尚未创建用于直通播放的 ASR Rack，则返回 CriAtomExAsrRack.IllegalRackId。

参见

CriAtomExAsrRack.CriAtomExAsrRack(CriAtomExAsrRackId)

类成员变量说明

const CriAtomExAsrRackId defaultRackId = 0

预设ASR Rack ID

说明:

是预设的ASR Rack ID。 要恢复为通常输出时，或者要丢弃已创建的ASR Rack时，请针对各种Player 使用该常量指定ASR Rack ID。

参见

CriAtomExPlayer::SetAsrRackId, CriMana::Player::SetAsrRackId

const CriAtomExAsrRackId IllegalRackId = -1

非法Rack ID

说明:

默认的ASR Rack ID。 ASR Rack创建失败时会返回该值。

属性说明

CriAtomExAsrRackId rackId

get

获取ASR Rack ID

说明:

获取ASR Rack对象的ID。

CriAtomExAsrRack Default

staticget

默认 ASR Rack

说明:

初始化期间自动创建的 ASR Rack。

Config defaultConfig = new CriAtomExAsrRack(defaultRackId)

staticget

预设配置

弃用:

削除予定の非推奨APIです。 CriWare.CriAtomExAsrRack.Config.Default の使用を検討してください。

说明:

是预设配置。

备注:

请根据需要，更改用本属性获取的预设配置

参见

CriAtomExAsrRack::CriAtomExAsrRack

---

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

• CriAtomExAsrRack.cs