Atom运行库的全局类。更多...

类
struct	AisacControlInfo
	AISAC控制器信息获取用结构体更多...

struct	AisacInfo
	AISAC信息获取用结构体更多...

struct	CuboidExtent
	3D声源的立方体形状参数更多...

struct	CueInfo
	Cue信息更多...

struct	CueLinkInfo
	Cue链接回调信息更多...

struct	CuePos3dInfo
	Cue的3D信息更多...

struct	FormatInfo
	音频数据格式信息更多...

struct	GameVariableInfo
	用于获取游戏变量信息的结构体更多...

struct	NativeVector
	3维矢量结构体更多...

struct	PerformanceInfo
	性能信息更多...

struct	Randomize3dConfig
	3D声源位置随机化相关的配置结构体更多...

struct	ResourceUsage
	各种资源的使用情况更多...

struct	SpeakerAngles6ch
	输出扬声器角度（5.1声道）更多...

struct	SpeakerAngles8ch
	输出扬声器角度（7.1声道）更多...

struct	WaveformInfo
	音频波形信息更多...

Public 类型
enum	CharacterEncoding : int { Utf8, Sjis }
	字符代码更多...

enum	SoundRendererType { Default = 0, Native = 1, Asr = 2 , Spatial = 4, Hw1 = (0 << 16) \| Native, Hw2 = (1 << 16) \| Native, Hw3 = (2 << 16) \| Native, Hw4 = (3 << 16) \| Native, Haptic = (0 << 16) \| Extended, Pseudo = (1 << 16) \| Extended, SpatialChannels = (0 << 16) \| Spatial, Ambisonics = (1 << 16) \| Spatial, Passtrough = (2 << 16) \| Spatial, Object = (3 << 16) \| Spatial }
	声音渲染器类型更多...

enum	VoiceAllocationMethod { Once, Retry }
	Voice取得方式更多...

enum	BiquadFilterType { Off, LowPass, HighPass, Notch, LowShelf, HighShelf, Peaking }
	双二阶滤波器的类型更多...

enum	ResumeMode { AllPlayback = 0, PausedPlayback = 1, PreparedPlayback = 2 }
	解除暂停方法更多...

enum	PanType { Unknown = -1, Pan3d = 0, Pos3d, Auto }
	Pan类型更多...

enum	VoiceControlMethod { PreferLast = 0, PreferFirst }
	Voice控制方式更多...

enum	Parameter { Volume = 0, Pitch = 1, Pan3dAngle = 2, Pan3dDistance = 3, Pan3dVolume = 4, BusSendLevel0 = 9, BusSendLevel1 = 10, BusSendLevel2 = 11, BusSendLevel3 = 12, BusSendLevel4 = 13, BusSendLevel5 = 14, BusSendLevel6 = 15, BusSendLevel7 = 16, BandPassFilterCofLow = 17, BandPassFilterCofHigh = 18, BiquadFilterType = 19, BiquadFilterFreq = 20, BiquadFIlterQ = 21, BiquadFilterGain = 22, EnvelopeAttackTime = 23, EnvelopeHoldTime = 24, EnvelopeDecayTime = 25, EnvelopeReleaseTime = 26, EnvelopeSustainLevel = 27, StartTime = 28, Priority = 31 }
	参数ID 更多...

enum	Speaker { FrontLeft = 0, FrontRight = 1, FrontCenter = 2, LowFrequency = 3, SurroundLeft = 4, SurroundRight = 5, SurroundBackLeft = 6, SurroundBackRight = 7 }
	扬声器ID 更多...

enum	Format : uint { ADX = 0x00000001, HCA = 0x00000003, HCA_MX = 0x00000004, WAVE = 0x00000005, RAW_PCM = 0x00000006, AUDIO_BUFFER = 0x00000009, HW1 = 0x00010001, HW2 = 0x00010002, HW3 = 0x00010003, MP3 = HW3 }
	格式类型更多...

enum	CurveType : int { Linear = 0, Square = 1, SquareReverse = 2, SCurve = 3, FlatAtHalf = 4 }
	曲线类型更多...

enum	PlaybackPositionUpdateType
	3D声源播放位置更新类型更多...

enum	Randomize3dCalcType : int { None = -1, Rectangle = 0, Cuboid = 1, Circle = 2, Cylinder = 3, Sphere = 4, List = 6 }
	3D声源的位置随机化的位置坐标计算方法更多...

enum	Randomize3dParamType { None, Width, Depth, Height, Radius }
	3D声源位置随机化中位置坐标计算参数的内容定义更多...

enum	CueType { Polyphonic, Sequential, Shuffle, Random, RandomNoRepeat, SwitchGameVariable, ComboSequential, SwitchSelector }
	Cue类型更多...

enum	SilentMode : System.Int32 { Normal = 0, Stop = 1, Virtual = 2, VirtualRetrigger = 3 }
	静音时的处理模式更多...

Public 成员函数
delegate void	CueLinkCbFunc (ref CueLinkInfo info)
	Cue链接回调更多...

静态 Public 成员函数
static void	SetSpeakerAngle (SpeakerAngles6ch speakerAngle)
	扬声器角度设置（5.1声道）更多...

static void	SetSpeakerAngle (SpeakerAngles8ch speakerAngle)
	扬声器角度设置（7.1声道）更多...

static void	SetVirtualSpeakerAngle (SpeakerAngles6ch speakerAngle)
	虚拟扬声器角度设置（5.1声道）更多...

static void	SetVirtualSpeakerAngle (SpeakerAngles8ch speakerAngle)
	虚拟扬声器角度设置（7.1声道）更多...

static void	ControlVirtualSpeakerSetting (bool sw)
	虚拟扬声器设置的开/关更多...

static bool	RegisterAcf (CriFsBinder binder, string acfPath)
	注册ACF文件更多...

static bool	RegisterAcf (IntPtr acfData, int dataSize)
	注册ACF数据更多...

static int	GetExtraWorkSizeForRegisterAcfData ()
	获取注册 ACF 数据时所需的额外工作区大小更多...

static bool	RegisterAcf (byte[] acfData)

static void	UnregisterAcf ()
	解除ACF文件的注册更多...

static string	GetAppliedDspBusSnapshotName ()
	获取快照名称更多...

static void	AttachDspBusSetting (string settingName)
	添加DSP总线设置更多...

static void	DetachDspBusSetting ()
	切断DSP总线设置更多...

static void	ApplyDspBusSnapshot (string snapshot_name, int time_ms)
	适用DSP总线快照更多...

static int	GetNumGameVariables ()
	获取游戏变量总数更多...

static bool	GetGameVariableInfo (ushort index, out GameVariableInfo info)
	获取游戏变量信息（指定索引）更多...

static float	GetGameVariable (uint game_variable_id)
	获取游戏变量更多...

static float	GetGameVariable (string game_variable_name)
	获取游戏变量更多...

static void	SetGameVariable (uint game_variable_id, float game_variable_value)
	设置游戏变量更多...

static void	SetGameVariable (string game_variable_name, float game_variable_value)
	设置游戏变量更多...

static void	SetRandomSeed (uint seed)
	设置随机数种类更多...

static void	ResetPerformanceMonitor ()
	重置性能监视器更多...

static void	GetPerformanceInfo (out PerformanceInfo info)
	获取性能信息更多...

static void	SetGlobalLabelToSelectorByIndex (ushort selector_index, ushort label_index)
	设置针对选择器的全局参照标签更多...

static void	SetGlobalLabelToSelectorByName (string selector_name, string label_name)
	设置针对选择器的全局参照标签更多...

static void	PauseTimer (bool sw)
	暂停计时器更多...

static void	Lock ()
	Server处理的中断防止更多...

static void	Unlock ()
	解除中断Server处理更多...

static void	SetVirtualSideSpeakerEnabled_PC (bool isEnable)
	[PC] 启用虚拟侧扬声器输出更多...

static void	SetOutputAudioDevice_PC (string deviceId)
	[PC] 输出设备的设置(指定设备ID) 更多...

static void	SetOutputHapticDevice_PC (int index, CriAtom.HapticDeviceType_WASAPI device_type)
	[PC] 振动输出设备的设置(指定index) 更多...

static string	GetOutputAudioDeviceId_PC (out bool isDefaultDevice)
	[PC] 获取输出设备（设备ID）更多...

static int	GetOutputAudioDeviceIndex_PC (out bool isDefaultDevice)
	[PC] 获取输出设备（索引）更多...

static bool	LoadAudioDeviceList_PC ()
	[PC] 输出设备列表的初始化更多...

static int	GetNumAudioDevices_PC ()
	[PC] 获取输出设备数量更多...

static string	GetAudioDeviceName_PC (int index)
	[PC] 获取输出设备名(指定index) 更多...

static void	SetOutputAudioDevice_PC (int index)
	[PC] 输出设备的设置(指定index) 更多...

static void	EnableBackgroundPlayback_IOS ()
	[iOS] 开始后台播放更多...

static void	DisableBackgroundPlayback_IOS ()
	[iOS] 结束后台播放更多...

static bool	IsInterruptedOtherAudio_IOS ()
	[iOS] 获取中断标记更多...

static void	ResumeAudio_IOS ()
	[iOS] 恢复音频播放更多...

static bool	IsSoundStopped_IOS ()
	[iOS] 确认音频输出停止更多...

static void	EnableAudioSessionRestoration_IOS (bool flag)
	[iOS] 启用AudioSession恢复处理更多...

static void	EnableBusSendOffsetWhenLevelNotExist (bool enable)
	设置在没有设置发送Level值时启用偏移值更多...

static void	SetSpatialAudioEnabled_WASAPI (CriAtomEx.SoundRendererType type, bool sw)
	启用空间音频功能更多...

Public 属性
const AisacControlId	InvalidAisacControlId = 0xffffffffu
	AISAC控制器ID的无效值

属性
static CueLinkCbFunc	OnCueLinkCallback
	注册Cue链接回调更多...

详细描述

Atom运行库的全局类。

说明:: 包含针对Atom运行库的设置函数以及在Atom运行库内共享的变量型的类。

成员枚举类型说明

enum CharacterEncoding : int

strong

字符代码

说明:: 显示文字代码（文字符号化方式）。

枚举值
Utf8	UTF-8
Sjis	Shift_JIS

enum SoundRendererType

strong

声音渲染器类型

说明:: 代表在 CriWare.CriAtomExPlayer 内部创建的声音渲染器的类型。

枚举值
Default	不限制输出方式
Native	输出至平台运行时库
Asr	输出至Atom Sound Renderer
Spatial	空间音频输出
Hw1	机型专用定义1
Hw2	机型专用定义2
Hw3	机型专用定义3
Hw4	机型专用定义4
Haptic	振动
Pseudo	静音
SpatialChannels	Channel Based Audio
Ambisonics	Ambisonics
Passtrough	Non-Spatial
Object	Object Based Audio

enum VoiceAllocationMethod

strong

Voice取得方式

说明:: CriWare.CriAtomExPlayer 是用于指定确保Voice时操作规范的数据类型。

参见: CriAtomExPlayer::CriAtomExPlayer

枚举值
Once	仅限1次取得Voice
Retry	重复取得Voice

enum BiquadFilterType

strong

双二阶滤波器的类型

说明:: 用于指定双二阶滤波器类型的数据类型。
通过 CriWare.CriAtomExPlayer::SetBiquadFilterParameters 函数来使用。

参见: CriAtomExPlayer::SetBiquadFilterParameters

枚举值
Off	无效滤波器
LowPass	低通滤波器
HighPass	高通滤波器
Notch	陷波滤波器
LowShelf	低架滤波器
HighShelf	高架滤波器
Peaking	峰值滤波器

enum ResumeMode

strong

解除暂停方法

说明:: 是用于指定解除暂停对象的数据类型。
作为 CriWare.CriAtomExPlayer::Resume 函数以及 CriWare.CriAtomExPlayback::Resume 函数的参数使用。

参见: CriAtomExPlayer::Resume, CriAtomExPlayback::Resume

枚举值
AllPlayback	无论暂停方法如何都重新开始播放
PausedPlayback	仅重新开始播放用Pause函数暂停的音频
PreparedPlayback	开始用Prepare函数指示了播放准备的音频

enum PanType

strong

Pan类型

说明:: 用于指定如何执行定位计算的数据类型。
通过 CriWare.CriAtomExPlayer::SetPanType 函数来使用。

参见: CriAtomExPlayer::SetPanType

枚举值
Unknown	Pan类型未知
Pan3d	用Pan3D计算定位
Pos3d	通过3D定位来计算定位
Auto	如果AtomExPlayer上设置了3D声源／3D收听者，则将以3D定位来计算定位，如果未设置，则将以Pan3D来计算定位。

enum VoiceControlMethod

strong

Voice控制方式

说明:: 用于指定用AtomExPlayer播放的音频发声控制方法的数据类型。
通过 CriWare.CriAtomExPlayer::SetVoiceControlMethod 函数来使用。

参见: CriAtomExPlayer::SetVoiceControlMethod

枚举值
PreferLast	后发优先
PreferFirst	先发优先

enum Parameter

strong

参数ID

说明:: 用于指定参数的ID。
用于 CriWare.CriAtomExPlayer::GetParameterFloat32 函数等。

参见: CriAtomExPlayer::GetParameterFloat32, CriAtomExPlayer::GetParameterSint32, CriAtomExPlayer::GetParameterUint32

枚举值
Volume	音量
Pitch	音高
Pan3dAngle	Panning 3D角度
Pan3dDistance	Panning 3D距离
Pan3dVolume	Panning 3D音量
BusSendLevel0	总线发送Level 0
BusSendLevel1	总线发送Level 1
BusSendLevel2	总线发送Level 2
BusSendLevel3	总线发送Level 3
BusSendLevel4	总线发送Level 4
BusSendLevel5	总线发送Level 5
BusSendLevel6	总线发送Level 6
BusSendLevel7	总线发送Level 7
BandPassFilterCofLow	带通滤波器的低频截止频率
BandPassFilterCofHigh	带通滤波器的高频截止频率
BiquadFilterType	双二阶滤波器的滤波器类型
BiquadFilterFreq	双二阶滤波器的频率
BiquadFIlterQ	双二阶滤波器的Q值
BiquadFilterGain	双二阶滤波器的增益
EnvelopeAttackTime	EG的Attack时间
EnvelopeHoldTime	EG的Hold时间
EnvelopeDecayTime	EG的Decay时间
EnvelopeReleaseTime	EG的Release时间
EnvelopeSustainLevel	EG的Sustain Level
StartTime	播放开始位置
Priority	Voice优先级

enum Speaker

strong

扬声器ID

说明:: 是用于指定音频输出扬声器的ID。
通过 CriWare.CriAtomExPlayer::SetSendLevel 函数来使用。

参见: CriAtomExPlayer::SetSendLevel

枚举值
FrontLeft	前置左侧扬声器
FrontRight	前置右侧扬声器
FrontCenter	前置中置扬声器
LowFrequency	LFE（≒低音炮）
SurroundLeft	环绕声左侧扬声器
SurroundRight	环绕声右侧扬声器
SurroundBackLeft	环绕声左后侧扬声器
SurroundBackRight	环绕声右后侧扬声器

enum Format : uint

strong

格式类型

说明:: 用于指定用AtomExPlayer播放的音频格式的数据类型。
通过 CriWare.CriAtomExPlayer::SetFormat 函数来使用。

参见: CriAtomExPlayer::SetFormat

枚举值
ADX	ADX
HCA	HCA
HCA_MX	HCA-MX
WAVE	Wave
RAW_PCM	RawPCM
AUDIO_BUFFER	Audio Buffer
HW1	硬件特有
HW2	硬件特有
HW3	硬件特有
MP3	MP3播放

enum CurveType : int

strong

曲线类型

说明:: 作为包络曲线或REACT的Ducking曲线所使用的曲线类型。

参见: CriAtomExPlayer::SetEnvelopeAttackCurve, CriAtomExPlayer::SetEnvelopeDecayCurve, CriAtomExPlayer::SetEnvelopeReleaseCurve, CriAtomExCategory::GetReactParameter, CriAtomExCategory::SetReactParameter

枚举值
Linear	直线
Square	低速变化
SquareReverse	高速变化
SCurve	S型曲线
FlatAtHalf	倒S型曲线

enum PlaybackPositionUpdateType

strong

3D声源播放位置更新类型

说明:: 该数据类型用于设置在3D定位播放过程中更新3D声源位置时的播放位置行为。
用于 CriAtomExPlayer::Set3dSourcePlaybackPositionUpdateType 函数。

备注:: 此参数在波形数据开始播放时应用。播放过程中进行的更改不会生效。

参见: CriAtomExPlayer::Set3dSourcePlaybackPositionUpdateType

enum Randomize3dCalcType : int

strong

3D声源的位置随机化的位置坐标计算方法

说明:: 3D声源位置随机化中位置坐标计算方法的定义。

参见: CriAtomEx::Randomize3dConfig

枚举值
None	无设置
Rectangle	矩形
Cuboid	长方体
Circle	圆形
Cylinder	圆柱体
Sphere	球体
List	坐标列表

enum Randomize3dParamType

strong

3D声源位置随机化中位置坐标计算参数的内容定义

说明:: 确定随机位置计算方法（即表示坐标范围的形状）的参数的定义。

参见: CriAtomEx::randomize3dParamTable, CriAtomEx::Randomize3dConfig::GetParamByType, CriAtomEx::Randomize3dConfig::SetParamByType

枚举值
None	未使用
Width	宽度
Depth	纵深
Height	高度
Radius	半径

enum CueType

strong

Cue类型

参见: CriAtomEx::CueInfo

枚举值
Polyphonic	复音
Sequential	顺序
Shuffle	乱序播放
Random	随机
RandomNoRepeat	随机非连续（随机播放上次播放的声音以外的其他声音）
SwitchGameVariable	切换播放（参照游戏变量来切换播放音轨）
ComboSequential	顺序连击（如果在“连击时间”内确定连续组合，则为顺序，如果到达最后，则将会返回“组合环回”地点）
SwitchSelector	选择器

enum SilentMode : System.Int32

strong

静音时的处理模式

说明:

该数据类型用于指定无声时的处理模式。
是否有沉默是通过以下任意一个值是否变为0来判断的。

音量
基于3D Panning计算结果的音量
基于3D定位计算结果的音量

注意:: 请注意，发送电平或2D Pan的设置值不能被判断为静音。

枚举值
Normal	不执行任何操作说明: 静音时不进行特殊处理。（预设值）
Stop	停止说明: 静音时会自动停止。
Virtual	虚拟化说明: 静音时会自动虚拟化。
VirtualRetrigger	以再触发型虚拟化说明: 静音时，会自动以再触发型虚拟化。

成员函数说明

static void SetSpeakerAngle ( SpeakerAngles6ch speakerAngle )

inlinestatic

扬声器角度设置（5.1声道）

参数

speakerAngle 输出扬声器角度

说明:: 设置在计算Pan3D和3D Positioning时使用的输出扬声器的角度（排列）。
以正面方向为0度，在-180度至180度之间设置角度。

frontLeftとfrontRightの位置を入れ替えるような設定をした場合、意図しない挙動になる可能性があります。

注意:: 更改低频角度不会更改Pan3D或3D Positioning计算结果。
角度是针对每个扬声器系统独立设置的。

static void SetSpeakerAngle ( SpeakerAngles8ch speakerAngle )

inlinestatic

扬声器角度设置（7.1声道）

参数

speakerAngle 输出扬声器角度

说明:: 设置在计算Pan3D和3D Positioning时使用的输出扬声器的角度（排列）。
以正面方向为0度，在-180度至180度之间设置角度。

frontLeftとfrontRightの位置を入れ替えるような設定をした場合、意図しない挙動になる可能性があります。

注意:: 更改低频角度不会更改Pan3D或3D Positioning计算结果。
角度是针对每个扬声器系统独立设置的。

static void SetVirtualSpeakerAngle ( SpeakerAngles6ch speakerAngle )

inlinestatic

虚拟扬声器角度设置（5.1声道）

参数

speakerAngle 输出扬声器角度

说明:: 设置对虚拟扬声器计算Pan3D和3D Positioning时
使用的输出扬声器的角度（排列）。

注意:: 除非在 CriWare.CriAtomEx::ControlVirtualSpeakerSetting 函数中启用了虚拟扬声器设置，否则此函数中的设置不会反映在Pan3D或3D Positioning计算中。

static void SetVirtualSpeakerAngle ( SpeakerAngles8ch speakerAngle )

inlinestatic

虚拟扬声器角度设置（7.1声道）

参数

speakerAngle 输出扬声器角度

说明:: 设置对虚拟扬声器计算Pan3D和3D Positioning时
使用的输出扬声器的角度（排列）。

注意:: 除非在 CriWare.CriAtomEx::ControlVirtualSpeakerSetting 函数中启用了虚拟扬声器设置，否则此函数中的设置不会反映在Pan3D或3D Positioning计算中。

static void ControlVirtualSpeakerSetting ( bool sw )

inlinestatic

虚拟扬声器设置的开/关

参数

sw	切换（False = 禁用，True = 启用）

说明:: 打开/关闭在计算Pan3D或者3D Positioning时使用虚拟扬声器设置的功能。
启用此设置后，将从 CriWare.CriAtomEx::SetVirtualSpeakerAngle 函数设置的虚拟扬声器角度播放多声道声音。

注意:: 预设状态为“禁用”。
另外，如果在播放过程中“启用”了任何Voice，则该Voice设置不会立即反映在Pan3D或3D Positioning计算中。此设置将在下一次Voice播放中被应用。

delegate void CueLinkCbFunc ( ref CueLinkInfo info )

Cue链接回调

参数

info Cue链接回调信息

说明:: Cue链接回调的函数型。

参见: CriAtomEx::OnCueLinkCallback

static bool RegisterAcf	(	CriFsBinder	binder,
		string	acfPath
	)

inlinestatic

注册ACF文件

参数

binder	Binder
acfPath	ACF文件的路径

说明:: 加载ACF文件，读入程序库内。

参见: CriAtomEx::UnregisterAcf

static bool RegisterAcf	(	IntPtr	acfData,
		int	dataSize
	)

inlinestatic

注册ACF数据

参数

acfData	ACF数据
dataSize	ACF数据大小

说明:: 加载内存上配置的ACF数据，将其导入程序库内。

注意:: 为防止作为参数传递的数据的缓冲区地址被收入垃圾回收器中，请事先在应用程序侧传递固定的地址。
此外，内存的固定解除请在解除了ACF文件的注册后，或结束了程序库处理后进行操作。

参见: CriAtomEx::UnregisterAcf

static int GetExtraWorkSizeForRegisterAcfData ( )

inlinestatic

获取注册 ACF 数据时所需的额外工作区大小

返回: 额外工作区大小（以字节为单位）

说明:: 获取从内存中注册用于游戏内预览的ACF 数据时，需要在ACF 数据末尾额外分配的工作区大小。

说明:: 将内存中的ACF 数据传递给CriWare.CriAtomEx::RegisterAcf(IntPtr, int)函数时，应分配一块内存区域，其中包含 ACF 数据本体，以及紧随其后的、大小为本函数返回值的额外工作区。

参见: CriAtomEx::RegisterAcf

static bool RegisterAcf ( byte[] acfData )

inlinestatic

弃用:: 将被删除的非推荐API。请考虑使用 CriWare.CriAtomEx.RegisterAcf(IntPtr, int) 。

static void UnregisterAcf ( )

inlinestatic

解除ACF文件的注册

说明:: 解除ACF文件的注册。

参见: CriAtomEx::RegisterAcf

static string GetAppliedDspBusSnapshotName ( )

inlinestatic

获取快照名称

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

static void AttachDspBusSetting ( string settingName )

inlinestatic

添加DSP总线设置

参数

settingName DSP总线设置的名称

说明:: 从DSP总线设置构建DSP总线，添加至声音渲染器。
要执行本函数时，需要事先 CriAtomEx::RegisterAcf 注册函数ACF信息

：

// ACFファイルの読み込みと登録

CriAtomEx.RegisterAcf("Sample.acf");

// DSPバス設定の適用

CriAtomEx.AttachDspBusSetting("DspBusSetting_0");

：

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

参见: CriAtomEx::DetachDspBusSetting, CriAtomEx::RegisterAcf

static void DetachDspBusSetting ( )

inlinestatic

切断DSP总线设置

说明:: 切断DSP总线设置。

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

参见: CriAtomEx::AttachDspBusSetting

static void ApplyDspBusSnapshot	(	string	snapshot_name,
		int	time_ms
	)

inlinestatic

适用DSP总线快照

参数

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

说明:: 适用DSP总线快照。
调用本函数后，将会更改为快照的参数。完成变化需要time_ms 毫秒。

static int GetNumGameVariables ( )

inlinestatic

获取游戏变量总数

返回: 游戏变量总数

说明:: 获取ACF文件内注册的游戏变量的总数。

注意:: 执行本函数前，需要事先注册ACF文件。
如果尚未注册ACF文件，则将会返回-1。

static bool GetGameVariableInfo	(	ushort	index,
		out GameVariableInfo	info
	)

inlinestatic

获取游戏变量信息（指定索引）

参数

index	游戏变量索引
info	游戏变量信息

返回: 是否获取了信息

说明:: 从游戏变量索引获取游戏变量信息。
如果指定的索引的游戏变量不存在，将会返回False。

注意:: 执行本函数前，需要事先注册ACF文件。

static float GetGameVariable ( uint game_variable_id )

inlinestatic

获取游戏变量

参数

game_variable_id 游戏变量ID

返回: 游戏变量值

说明:: 获取ACF文件内注册的游戏变量值。

注意:: 执行本函数前，需要事先注册ACF文件。

static float GetGameVariable ( string game_variable_name )

inlinestatic

获取游戏变量

参数

game_variable_name 游戏变量名

返回: 游戏变量值

说明:: 获取ACF文件内注册的游戏变量值。

注意:: 执行本函数前，需要事先注册ACF文件。

static void SetGameVariable	(	uint	game_variable_id,
		float	game_variable_value
	)

inlinestatic

设置游戏变量

参数

game_variable_id	游戏变量ID
game_variable_value	游戏变量值

说明:: 为ACF文件内注册的游戏变量值设置值。
设置可能范围为0.0f～1.0f之间。

注意:: 执行本函数前，需要事先注册ACF文件。

static void SetGameVariable	(	string	game_variable_name,
		float	game_variable_value
	)

inlinestatic

设置游戏变量

参数

game_variable_name	游戏变量名
game_variable_value	游戏变量值

说明:: 为ACF文件内注册的游戏变量值设置值。
设置可能范围为0.0f～1.0f之间。

注意:: 执行本函数前，需要事先注册ACF文件。

static void SetRandomSeed ( uint seed )

inlinestatic

设置随机数种类

参数

seed 随机数种类

说明:: 为CRI Atom运行库总体共享的伪随机数发生器设置随机数种类。
通过设置随机数种类，可以让各种随机播放处理具备再现性。
如果想让各AtomExPlayer分别具备再现性，请使用 CriWare.CriAtomExPlayer::SetRandomSeed 函数。
如不需要再现性，而是希望在每次执行时切换随机数种类，则请不要使用本函数而是使用 CriWare.CriAtomConfig::useRandomSeedWithTime 属性。

注意:: 本函数需要在创建 CriWare.CriAtomSource 或 CriWare.CriAtomExPlayer 前进行调用。如果是设置随机数种类之前创建的，则不会受影响。

参见: CriWare.CriAtomExPlayer::SetRandomSeed

static void ResetPerformanceMonitor ( )

inlinestatic

重置性能监视器

说明:: 丢弃到当前为止的测量结果。
性能监视器会在程序库初始化之后，开始获取性能信息，并累积测量结果。
如果不希望将以前的测量结果包含在今后的测量中，请执行本函数，将累积的测量内容丢弃掉。

参见: CriAtomEx::GetPerformanceInfo

static void GetPerformanceInfo ( out PerformanceInfo info )

inlinestatic

获取性能信息

说明:: 获取性能信息。

参见: CriAtomEx::PerformanceInfo, CriAtomEx::ResetPerformanceMonitor

static void SetGlobalLabelToSelectorByIndex	(	ushort	selector_index,
		ushort	label_index
	)

inlinestatic

设置针对选择器的全局参照标签

参数

selector_index	选择器索引
label_index	标签索引

说明:: 针对ACF文件内注册的选择器，设置全局参照的标签。

注意:: 执行本函数前，需要事先注册ACF文件。

参见: CriAtomEx::SetGlobalLabelToSelectorByName

static void SetGlobalLabelToSelectorByName	(	string	selector_name,
		string	label_name
	)

inlinestatic

设置针对选择器的全局参照标签

参数

selector_name	选择器名
label_name	标签名

说明:: 针对ACF文件内注册的选择器，设置全局参照的标签。

注意:: 执行本函数前，需要事先注册ACF文件。

参见: CriAtomEx::SetGlobalLabelToSelectorByIndex

static void PauseTimer ( bool sw )

inlinestatic

暂停计时器

参数

sw	true：暂停计时器、false：重新开始计时器

说明:: 暫停/重新开始Atom库中的主计时器。
主计时器暂停之后，序列的时间累进将会停止。

备注:: 本函数功能面向于在休眠或暂停应用程序时，
计时器会继续行进的平台设计。
在应用程序转换到休眠或暂停状态之前
先使用本函数暂停主计时器，可以在停止期间避免序列继续前进。

注意:: 使用本函数暂停的对象仅为Atom库中的主计时器。
需要暂停音频时，请使用 CriAtomExAsr.PauseOutputVoice 。

static void Lock ( )

inlinestatic

Server处理的中断防止

说明:: 抑制Server处理的中断。
执行本函数后，在执行 CriWare.CriAtomEx::Unlock 函数之前，Server处理动作将被抑制。
如果想在同一个音频帧内确实执行多个API，请通过本函数防止Server处理中断，并执行这些函数。

参见: CriAtomEx::Unlock

static void Unlock ( )

inlinestatic

解除中断Server处理

说明:: 解除 CriWare.CriAtomEx::Lock 函数实现的Server处理的中断预防。

参见: CriAtomEx::Lock

static void SetVirtualSideSpeakerEnabled_PC ( bool isEnable )

inlinestatic

[PC] 启用虚拟侧扬声器输出

参数

isEnable 是否启用虚拟侧扬声器输出

说明:: 使用空间音频功能时，在以后置扬声器代替侧扬声器的5.1声道配置中，侧扬声器输出会通过前置扬声器和后置扬声器进行虚拟呈现。如果禁用虚拟侧扬声器输出，所有侧扬声器输出都会从后置扬声器播放。

备注:: 在当前库中，虚拟侧扬声器输出默认被禁用。
如需启用此功能，请指定 true 并执行。

static void SetOutputAudioDevice_PC ( string deviceId )

inlinestatic

[PC] 输出设备的设置(指定设备ID)

参数

deviceId 设备ID

说明:: 设置从Atom输出音频的设备的ID。

static void SetOutputHapticDevice_PC	(	int	index,
		CriAtom.HapticDeviceType_WASAPI	device_type
	)

inlinestatic

[PC] 振动输出设备的设置(指定index)

参数

index	设备索引
device_type	触觉设备类型

说明:: 设定Atom的振动输出设备。
请在调用此函数前，事先调用 CriAtomEx::LoadAudioDeviceList_PC 函数来初始化插件内部的设备列表。

参见: CriAtomEx::LoadAudioDeviceList_PC

static string GetOutputAudioDeviceId_PC ( out bool isDefaultDevice )

inlinestatic

[PC] 获取输出设备（设备ID）

参数

isDefaultDevice 是否为默认设备

说明:: 获取作为 Atom 音频输出目标的设备 ID。

static int GetOutputAudioDeviceIndex_PC ( out bool isDefaultDevice )

inlinestatic

[PC] 获取输出设备（索引）

参数

isDefaultDevice 是否为默认设备

说明:: 获取 Atom 将输出音频的设备的索引。

static bool LoadAudioDeviceList_PC ( )

inlinestatic

[PC] 输出设备列表的初始化

说明:: 初始化可用作从Atom的音频输出目标的设备列表。
在调用本函数后，使用 CriAtomEx::GetNumAudioDevices_PC 函数可以获取设备数量，使用 CriAtomEx::GetAudioDeviceName_PC 函数可以获取设备名。

参见: CriAtomEx::GetNumAudioDevices_PC, CriAtomEx::GetAudioDeviceName_PC

static int GetNumAudioDevices_PC ( )

inlinestatic

[PC] 获取输出设备数量

返回: 输出设备数量

说明:: 获取可以在Atom中选择作为音频输出目标的设备数量。
请在调用此函数前，事先调用 CriAtomEx::LoadAudioDeviceList_PC 函数来初始化插件内部的设备列表。最大返回值为32。

参见: CriAtomEx::LoadAudioDeviceList_PC

static string GetAudioDeviceName_PC ( int index )

inlinestatic

[PC] 获取输出设备名(指定index)

参数

index 设备索引

返回: 输出设备名

说明:: 获取可以在Atom中选择作为音频输出目标的设备名。
请在调用此函数前，事先调用 CriAtomEx::LoadAudioDeviceList_PC 函数来初始化插件内部的设备列表。

参见: CriAtomEx::LoadAudioDeviceList_PC

static void SetOutputAudioDevice_PC ( int index )

inlinestatic

[PC] 输出设备的设置(指定index)

参数

index 设备索引

说明:: 设定Atom的音频输出设备。
请在调用此函数前，事先调用 CriAtomEx::LoadAudioDeviceList_PC 函数来初始化插件内部的设备列表。

参见: CriAtomEx::LoadAudioDeviceList_PC

static void EnableBackgroundPlayback_IOS ( )

inlinestatic

[iOS] 开始后台播放

说明:: 通知Atom库开始后台播放。

static void DisableBackgroundPlayback_IOS ( )

inlinestatic

[iOS] 结束后台播放

说明:: 通知Atom库后台播放已结束。

static bool IsInterruptedOtherAudio_IOS ( )

inlinestatic

[iOS] 获取中断标记

说明:: Atom 库的音频因外部因素导致音频中断而停止时，则返回true。
如果启用并初始化了 CriWareInitializer 组件的“启用操作系统通知处理”设置，Atom 库音频将自动恢复。自动恢复完成后返回false。
如果使用 CriWare.CriAtomEx.EnableBackgroundPlayback_IOS 启用后台播放，则自动恢复将被禁用。
要恢复音频，请调用 CriWare.CriAtomEx.ResumeAudio_IOS 来恢复音频。

static void ResumeAudio_IOS ( )

inlinestatic

[iOS] 恢复音频播放

说明:: 启用后台播放时，恢复已被停止的音频。仅当 CriWare.CriAtomEx.IsInterruptedOtherAudio_IOS 返回 true 时有效。

static bool IsSoundStopped_IOS ( )

inlinestatic

[iOS] 确认音频输出停止

说明:: 确认音频输出是否已停止。
True时，音频输出已停止。
如果应用程序未处于暂停状态，但本函数却返回了True，则表示由于应用程序未检测到的系统中断等，妨碍音频输出。
如果要执行和音频同步的处理，请确认本函数的音频输出状态，根据需要添加暂停处理。

注意:: 本函数是iOS专用API。

static void EnableAudioSessionRestoration_IOS ( bool flag )

inlinestatic

[iOS] 启用AudioSession恢复处理

参数

flag 是否启用恢复处理

说明:

设置是否自动对来自其他应用程序或系统的音频中断进行恢复处理。
在音频独占输出模式下（ CriAtomConfig.iosOverrideIPodMusic 为true时），设置是否响应其他应用程序的中断并恢复音频。
预设为“启用”，中断发生时将立即恢复音频。
如果要暂时禁用恢复处理以执行以下处理，请将参数设为 false 并调用此函数。

需要在用户输入文本时支持语音输入
需要临时使用CRIWARE之外带音频播放功能的模块（例如：使用WebView播放视频）时
另外，为了避免应用程序的音频无法恢复的问题，上述处理完成后请将参数设为true再次调用此函数。

注意:: 本函数是iOS专用API。

static void EnableBusSendOffsetWhenLevelNotExist ( bool enable )

inlinestatic

设置在没有设置发送Level值时启用偏移值

参数

enable 启用标记

说明:

在CriWare.CriAtomExPlayer.SetBusSendLevelOffset 设置设置发送量时，
即使数据侧没有设置发送Level值时，是否也添加偏移值。
与此标记设置相对应的行为如下。

true: 对所有总线指定偏移量
false: 仅对在数据端设置了发送目标的总线指定偏移量
系统预设值为true。
对于正在播放的音频，更改会在应用参数更新时反映。

static void SetSpatialAudioEnabled_WASAPI	(	CriAtomEx.SoundRendererType	type,
		bool	sw
	)

inlinestatic

启用空间音频功能

参数

type	声音渲染器类型
sw	是否启用该功能（true = 启用，false = 禁用）

说明:: 启用空间音频功能（Microsoft Spatial Sound）。
type 参数用于指定要启用或禁用空间音频功能的声音渲染器。

备注:: 在当前库中，空间音频功能默认为启用状态。
因此，除非想要禁用空间音频功能，否则无需显式调用本函数。

注意:: 本函数必须在CriWareInitializer的Awake执行之前调用。
此外，仅在SoundRendererType不是Native（内部与"Hw1"为相同值）时才使用本函数。
对 SoundRendererType 为 Native/Hw1 的输出目标进行设置时，不应使用本函数。
应在 CriWareInitializer 组件 - PC Config - Microsoft Spatial Sound 项目中进行设置。

属性说明

CueLinkCbFunc OnCueLinkCallback

staticaddremove

注册Cue链接回调

说明:: 注册一个回调函数，用于在Cue播放过程中处理Cue链接时接收其信息。
注册的回调函数在处理回调事件后，会立即在应用程序主线程的更新时刻执行。

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

CriAtomEx.cs

类

Public 类型

Public 成员函数

静态 Public 成员函数

Public 属性

属性

详细描述

成员枚举类型说明

成员函数说明

属性说明