CriAtom类 参考

用于控制音频播放总体的组件。 更多...

继承自 CriMonoBehaviour .

Public 类型
enum	SpeakerMapping : System.Int32 {   Auto = 0, Monaural, Stereo, Ch5_1,   Ch7_1, Ch5_1_2, Ch7_1_2, Ch7_1_4,   Ambisonics1p, Ambisonics2p, Ambisonics3p, Object,   Custom }
	混音器的扬声器映射类型 更多...

静态 Public 成员函数
static void	AttachDspBusSetting (string settingName)
	添加DSP总线设置 更多...
static void	DetachDspBusSetting ()
	切断DSP总线设置 更多...
static CriAtomCueSheet	GetCueSheet (string name)
	获取Cue Sheet 更多...
static CriAtomCueSheet	AddCueSheet (string name, string acbFile, string awbFile, CriFsBinder binder=null)
	添加Cue Sheet 更多...
static CriAtomCueSheet	AddCueSheetAsync (string name, string acbFile, string awbFile, CriFsBinder binder=null, bool loadAwbOnMemory=false)
	以异步方式添加Cue Sheet 更多...
static CriAtomCueSheet	AddCueSheet (string name, byte[] acbData, string awbFile, CriFsBinder awbBinder=null)
	添加Cue Sheet（从内存读取） 更多...
static CriAtomCueSheet	AddCueSheetAsync (string name, byte[] acbData, string awbFile, CriFsBinder awbBinder=null, bool loadAwbOnMemory=false)
	以异步方式添加Cue Sheet（内存读取） 更多...
static void	RemoveCueSheet (string name)
	删除Cue Sheet 更多...
static CriAtomExAcb	GetAcb (string cueSheetName)
	获取ACB对象 更多...
static void	SetCategoryVolume (string name, float volume)
	通过指定类别名来设置类别音量。 更多...
static void	SetCategoryVolume (int id, float volume)
	通过类别ID指定来设置类别音量。 更多...
static float	GetCategoryVolume (string name)
	通过指定类别名来获取类别音量。 更多...
static float	GetCategoryVolume (int id)
	通过类别ID指定来获取类别音量。 更多...
static void	SetBusAnalyzer (string busName, bool sw)
	启用总线信息获取。 更多...
static void	SetBusAnalyzer (bool sw)
	启用所有获取的总线信息。 更多...
static CriAtomExAsr.BusAnalyzerInfo	GetBusAnalyzerInfo (string busName)
	获取总线信息。 更多...
static CriAtomExAsr.BusAnalyzerInfo	GetBusAnalyzerInfo (int busId)

属性
static bool	CueSheetsAreLoading [get]
	Cue Sheet加载完成检查 更多...

详细描述

用于控制音频播放总体的组件。

说明:

各场景需要分别准备一个。
如果在UnityEditor上使用CRI Atom窗口创建了 CriAtomSource， 则会自动创建称为“CRIWARE”的对象。通常情况下，用户不需要创建。

成员枚举类型说明

enum SpeakerMapping : System.Int32

strong

混音器的扬声器映射类型

说明:

指定ASR的扬声器映射。

参见

CriAtomExAsrRack.Config.speakerMapping, CriAtomConfig.speakerMapping

枚举值
Auto	自动设置
Monaural	1ch
Stereo	2ch
Ch5_1	5.1ch
Ch7_1	7.1ch
Ch5_1_2	5.1.2ch
Ch7_1_2	7.1.2ch
Ch7_1_4	7.1.4ch
Ambisonics1p	1st order Ambisonics
Ambisonics2p	2st order Ambisonics
Ambisonics3p	3st order Ambisonics
Object	Object Base Audio
Custom	Custom Speaker Mapping

成员函数说明

static void AttachDspBusSetting ( string  settingName )

inlinestatic

添加DSP总线设置

参数

settingName

DSP总线设置的名称

说明:

从DSP总线设置构建DSP总线，添加至声音渲染器。
如果希望切换目前设置的DSP总线设置，请首先切断一次后，再次进行添加。

注意:

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

参见

CriAtom::DetachDspBusSetting

static void DetachDspBusSetting ( )

inlinestatic

切断DSP总线设置

说明:

切断DSP总线设置。

注意:

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

参见

CriAtom::DetachDspBusSetting

static CriAtomCueSheet GetCueSheet ( string  name )

inlinestatic

获取Cue Sheet

参数

name	Cue Sheet名

返回

Cue Sheet对象

说明:

按照参数中指定的Cue Sheet名，获取已注册的Cue Sheet对象。

static CriAtomCueSheet AddCueSheet ( string  name, string  acbFile, string  awbFile, CriFsBinder  binder = null  )

inlinestatic

添加Cue Sheet

参数

name	Cue Sheet名
acbFile	ACB文件路径
awbFile	AWB文件路径
binder	Binder对象(选项)

返回

Cue Sheet对象

说明:

从参数中指定的文件路径信息来添加Cue Sheet。
可以同时注册多个Cue Sheet。

如果针对各文件路径指定了相对路径，将会从 StreamingAssets 文件夹以相对路径来加载文件。
如果指定了绝对路径或URL，将会以所指定的路径来加载文件。

如果要通过打包成CPK文件的ACB文件和AWB文件来添加Cue Sheet， 请指定在binder参数中Bind了CPK的Binder。
此外，Binder功能在ADXLE无法使用。

static CriAtomCueSheet AddCueSheetAsync ( string  name, string  acbFile, string  awbFile, CriFsBinder  binder = null, bool  loadAwbOnMemory = false  )

inlinestatic

以异步方式添加Cue Sheet

参数

name	Cue Sheet名
acbFile	ACB文件路径
awbFile	AWB文件路径
binder	Binder对象(选项)
loadAwbOnMemory	是否将AWB文件加载至内存上(选项)

返回

Cue Sheet对象

说明:

根据参数中指定的文件路径信息，以异步方式添加Cue Sheet。
可以同时注册多个Cue Sheet。

如果针对各文件路径指定了相对路径，将会从 StreamingAssets 文件夹以相对路径来加载文件。
如果指定了绝对路径或URL，将会以所指定的路径来加载文件。

如果要通过打包成CPK文件的ACB文件和AWB文件来添加Cue Sheet， 请指定在binder参数中Bind了CPK的Binder。
此外，Binder功能在ADXLE无法使用。

返回值的Cue Sheet对象的 CriAtomCueSheet::isLoading 成员返回 true 期间为正在加载状态。
请务必确认返回 false 后再执行Cue播放等操作。

loadAwbOnMemory 为 false 时，仅会在内存上加载AWB文件的头文件部分来进行串流播放。
如果将 loadAwbOnMemory 设置为 true，则会将整个AWB文件加载至内存上，成为实际的内存播放。
在WebGL(Editor执行时)，出于内部原因， loadAwbOnMemory 会强行成为true。

static CriAtomCueSheet AddCueSheet ( string  name, byte[]  acbData, string  awbFile, CriFsBinder  awbBinder = null  )

inlinestatic

添加Cue Sheet（从内存读取）

参数

name	Cue Sheet名
acbData	ACB数据
awbFile	AWB文件路径
awbBinder	AWB用Binder对象(选项)

返回

Cue Sheet对象

说明:

从参数中指定的数据和文件路径信息来添加Cue Sheet。
可以同时注册多个Cue Sheet。

如果针对文件路径指定了相对路径，将会从 StreamingAssets 文件夹以相对路径来加载文件。
如果指定了绝对路径或URL，将会以所指定的路径来加载文件。

如果要通过打包成CPK文件的AWB文件来添加Cue Sheet， 请指定在awbBinder参数中Bind了CPK的Binder。
此外，Binder功能在ADXLE无法使用。

static CriAtomCueSheet AddCueSheetAsync ( string  name, byte[]  acbData, string  awbFile, CriFsBinder  awbBinder = null, bool  loadAwbOnMemory = false  )

inlinestatic

以异步方式添加Cue Sheet（内存读取）

参数

name	Cue Sheet名
acbData	ACB数据
awbFile	AWB文件路径
awbBinder	AWB用Binder对象(选项)
loadAwbOnMemory	是否将AWB文件加载至内存上(选项)

返回

Cue Sheet对象

说明:

从参数中指定的数据和文件路径信息来添加Cue Sheet。
可以同时注册多个Cue Sheet。

如果针对文件路径指定了相对路径，将会从 StreamingAssets 文件夹以相对路径来加载文件。
如果指定了绝对路径或URL，将会以所指定的路径来加载文件。

如果要通过打包成CPK文件的AWB文件来添加Cue Sheet， 请指定在awbBinder参数中Bind了CPK的Binder。
此外，Binder功能在ADXLE无法使用。

返回值的Cue Sheet对象的 CriAtomCueSheet::isLoading 成员返回 true 期间为正在加载状态。
请务必确认返回 false 后再执行Cue播放等操作。

loadAwbOnMemory 为 false 时，仅会在内存上加载AWB文件的头文件部分来进行串流播放。
如果将 loadAwbOnMemory 设置为 true，则会将整个AWB文件加载至内存上，成为实际的内存播放。
在WebGL(Editor执行时)，出于内部原因， loadAwbOnMemory 会强行成为true。

static void RemoveCueSheet ( string  name )

inlinestatic

删除Cue Sheet

参数

name	Cue Sheet名

说明:

删除已添加的Cue Sheet。

static CriAtomExAcb GetAcb ( string  cueSheetName )

inlinestatic

获取ACB对象

参数

cueSheetName

Cue Sheet名

返回

ACB对象

说明:

针对所指定的Cue Sheet来获取ACB对象。

static void SetCategoryVolume ( string  name, float  volume  )

inlinestatic

通过指定类别名来设置类别音量。

参数

name	类别名
volume	音量

static void SetCategoryVolume ( int  id, float  volume  )

inlinestatic

通过类别ID指定来设置类别音量。

参数

id	类别ID
volume	音量

static float GetCategoryVolume ( string  name )

inlinestatic

通过指定类别名来获取类别音量。

参数

name

类别名

返回

音量

static float GetCategoryVolume ( int  id )

inlinestatic

通过类别ID指定来获取类别音量。

参数

id

类别ID

返回

音量

static void SetBusAnalyzer ( string  busName, bool  sw  )

inlinestatic

启用总线信息获取。

参数

busName	DSP总线名
sw	True: 将获取设置为有效。False: 将获取设置为无效。

static void SetBusAnalyzer ( bool  sw )

inlinestatic

启用所有获取的总线信息。

参数

sw	True: 将获取设置为有效。False: 将获取设置为无效。

static CriAtomExAsr.BusAnalyzerInfo GetBusAnalyzerInfo ( string  busName )

inlinestatic

获取总线信息。

参数

busName

DSP总线名

返回

DSP总线信息

static CriAtomExAsr.BusAnalyzerInfo GetBusAnalyzerInfo ( int  busId )

inlinestatic

弃用:

将被删除的非推荐API。 请考虑使用 CriAtom.GetBusAnalyzerInfo(string busName) 。

属性说明

bool CueSheetsAreLoading

staticget

Cue Sheet加载完成检查

说明:

检查所有Cue Sheet的加载完成。

---

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

• CriAtom.cs