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

AtomEx声音对象 更多...

继承自 CriDisposable .

Public 成员函数

 CriAtomExSoundObject (bool enableVoiceLimitScope, bool enableCategoryCueLimitScope)
 创建声音对象 更多...
 
override void Dispose ()
 丢弃声音对象 更多...
 
void AddPlayer (CriAtomExPlayer player)
 添加AtomExPlayer 更多...
 
void DeletePlayer (CriAtomExPlayer player)
 删除AtomExPlayer 更多...
 
void DeleteAllPlayers ()
 删除所有AtomExPlayer 更多...
 

详细描述

AtomEx声音对象

说明:
是声音对象类。
对于与应用程序内的“物体”、“空间”、“状況”等关联而注册的 Player,可以统一进行音频控制。

构造及析构函数说明

CriAtomExSoundObject ( bool  enableVoiceLimitScope,
bool  enableCategoryCueLimitScope 
)
inline

创建声音对象

参数
enableVoiceLimitScope是否启用Voice限数范围
enableCategoryCueLimitScope是否启用类别Cue限数范围
返回
声音对象
说明:
创建声音对象。
如果为 enableVoiceLimitScope 指定 True,则从该声音对象上 关联的ExPlayer播放的音频的发声数仅会在 该声音对象内计数,并进行Voice限数组的 发声数控制。
如果为 enableCategoryCueLimit 指定 True,则从该声音对象上 关联的ExPlayer播放的Cue的类别播放数仅会在 该声音对象内计数,并进行播放数控制。
参见
CriAtomExSoundObject::Dispose

成员函数说明

override void Dispose ( )
inline

丢弃声音对象

说明:
丢弃声音对象。
一旦执行了本函数,创建声音对象时,在DLL内取得的资源 将全部被释放。
参见
CriAtomExSoundObject::CriAtomExSoundObject
void AddPlayer ( CriAtomExPlayer  player)
inline

添加AtomExPlayer

参数
playerAtomExPlayer
说明:
为声音对象添加AtomExPlayer。
添加的AtomExPlayer将会与声音对象建立关联, 受到以下列出的来自声音对象的影响。
  • 发声数制限和事件功能影响的范围(作用区域)的限定
  • 播放控制(停止、暂停等)
  • 参数控制
    要从声音对象中删除所添加的AtomExPlayer时, 请调用 CriAtomExSoundObject::DeletePlayer 函数。
注意:
调用本函数时,请确保要添加的AtomExPlayer不在音频播放状态。
如果指定了正在播放的AtomExPlayer,添加时会执行播放停止。
参见
CriAtomExSoundObject::DeletePlayer, CriAtomExSoundObject::DeleteAllPlayers, CriAtomExPlayer::nativeHandle
void DeletePlayer ( CriAtomExPlayer  player)
inline

删除AtomExPlayer

参数
playerAtomExPlayer的原生(Native)句柄
说明:
从声音对象删除AtomExPlayer。
削除的AtomExPlayer将会切断与声音对象的关联,将不会再受到 声音对象的影响。
注意:
调用本函数时,请确保要删除的AtomExPlayer不在音频播放状态,然后再将其删除。
如果指定了正在播放的AtomExPlayer,删除时会执行播放停止。
参见
CriAtomExSoundObject::AddPlayer, CriAtomExSoundObject::DeleteAllPlayers, CriAtomExPlayer::nativeHandle
void DeleteAllPlayers ( )
inline

删除所有AtomExPlayer

说明:
删除声音对象中关联的所有AtomExPlayer。
削除的AtomExPlayer将会切断与声音对象的关联,将不会再受到 声音对象的影响。
注意:
调用本函数时,请确保要删除的AtomExPlayer不在音频播放状态,然后再将其删除。
如果指定了正在播放的AtomExPlayer,删除时会执行播放停止。
参见
CriAtomExSoundObject::AddPlayer, CriAtomExSoundObject::DeletePlayer

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