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

用于执行以类别为单位的参数控制的类。 更多...

struct  ReactAisacModulationParameter
 AISAC调制触发器参数结构体 更多...
 
struct  ReactDuckerParameter
 REACT的Ducker参数结构体 更多...
 
struct  ReactFadeParameter
 REACT渐变参数结构体 更多...
 
struct  ReactParameter
 REACT驱动参数结构体 更多...
 

Public 类型

enum  ReactType : int { Ducker = 0, AisacModulationTrigger }
 REACT类型 更多...
 
enum  ReactDuckerTargetType : int { Volume = 0, AisacControlValue }
 REACT的闪避目标 更多...
 
enum  ReactDuckerCurveType : int {
  Linear = CriAtomEx.CurveType.Linear, Square = CriAtomEx.CurveType.Square, SquareReverse = CriAtomEx.CurveType.SquareReverse, SCurve = CriAtomEx.CurveType.SCurve,
  FlatAtHalf = CriAtomEx.CurveType.FlatAtHalf
}
 
enum  ReactHoldType { WhilePlaying, FixedTime }
 REACT保持类型 更多...
 
enum  ReactStatus {
  Stop = 0, FadeOut, Hold, FadeIn,
  Error
}
 REACT的执行状态 更多...
 

静态 Public 成员函数

static void SetVolume (string name, float volume)
 指定名称来针对类别设置音量 更多...
 
static void SetVolume (int id, float volume)
 通过指定ID来设置针对类别的音量设置 更多...
 
static float GetVolume (string name)
 指定名称来获取类别音量 更多...
 
static float GetVolume (int id)
 通过指定ID来获取类别音量 更多...
 
static void Mute (string name, bool mute)
 指定名称来设置类别静音状态 更多...
 
static void Mute (int id, bool mute)
 通过指定ID来设置类别静音状态 更多...
 
static bool IsMuted (string name)
 指定名称来获取类别静音状态 更多...
 
static bool IsMuted (int id)
 通过指定ID来获取类别静音状态 更多...
 
static void Solo (string name, bool solo, float muteVolume)
 指定名称来设置类别的独奏状态 更多...
 
static void Solo (int id, bool solo, float muteVolume)
 通过指定ID来设置类别独奏状态 更多...
 
static bool IsSoloed (string name)
 指定名称来获取类别的独奏状态 更多...
 
static bool IsSoloed (int id)
 通过指定ID来获取类别的独奏状态 更多...
 
static void Pause (string name, bool pause)
 指定名称来进行类别的暂停或解除暂停 更多...
 
static void Pause (int id, bool pause)
 通过指定ID来进行类别的暂停或解除暂停 更多...
 
static bool IsPaused (string name)
 通过指定ID来获取类别的暂停状态 更多...
 
static bool IsPaused (int id)
 指定名称来进行类别的暂停或解除暂停 更多...
 
static void SetAisacControl (string name, string controlName, float value)
 指定名称来设置针对类别AISAC控制器值 更多...
 
static void SetAisac (string name, string controlName, float value)
 
static void SetAisacControl (int id, int controlId, float value)
 通过指定ID指定来设置针对类别的AISAC控制器值 更多...
 
static void SetAisac (int id, int controlId, float value)
 
static void SetReactParameter (string name, ReactParameter parameter)
 设置REACT驱动参数 更多...
 
static bool GetReactParameter (string name, out ReactParameter parameter)
 获取REACT驱动参数 更多...
 
static bool GetAttachedAisacInfoById (uint id, int aisacAttachedIndex, out CriAtomEx.AisacInfo aisacInfo)
 通过指定ID来获取AISAC信息 更多...
 
static bool GetAttachedAisacInfoByName (string name, int aisacAttachedIndex, out CriAtomEx.AisacInfo aisacInfo)
 通过指定名称来获取AISAC信息 更多...
 
static bool GetCurrentAisacControlValue (string categoryName, string aisacControlName, out float controlValue)
 通过指定名称来获取AISAC信息 更多...
 
static ReactStatus GetReactStatus (string reactName)
 REACT的执行状态的获取
更多...
 
static void Stop (int id)
 通过指定ID停止在所属类别中正在发声的Cue 更多...
 
static void Stop (string name)
 通过指定名称在所属类别中停止正在发声的Cue 更多...
 
static void StopWithoutReleaseTime (int id)
 通过指定ID立即停止在所属类别中正在发声的Cue 更多...
 
static void StopWithoutReleaseTime (string name)
 通过指定名称在所属类别中即时停止正在发声的Cue 更多...
 
static float GetTotalVolume (int id)
 通过指定ID来获取最终类别音量 更多...
 
static float GetTotalVolume (string name)
 通过指定名称在所属类别中即时停止正在发声的Cue 更多...
 
static void SetFadeInTime (int id, ushort ms)
 通过指定ID来设置渐入时间 更多...
 
static void SetFadeInTime (string name, ushort ms)
 通过指定名称来设置渐入时间 更多...
 
static void SetFadeOutTime (int id, ushort ms)
 通过指定ID来设置渐出时间 更多...
 
static void SetFadeOutTime (string name, ushort ms)
 通过指定名称来设置渐出时间 更多...
 
static bool ResetAllAisacControl (int id)
 通过指定ID将类别中设置的所有AISAC控制值设置为预设值 更多...
 
static bool ResetAllAisacControl (string name)
 通过指定名称来针对类别设置的所有AISAC控制器值并设置为预设值 更多...
 
static void AttachAisac (int id, string globalAisacName)
 通过指定ID在类别上挂载AISAC 更多...
 
static void AttachAisac (string name, string globalAisacName)
 通过指定名称从类别中挂载AISAC 更多...
 
static void DetachAisac (int id, string globalAisacName)
 通过指定ID从类别中卸除AISAC 更多...
 
static void DetachAisac (string name, string globalAisacName)
 通过指定名称从类别中卸载AISAC 更多...
 
static void DetachAisacAll (int id)
 通过指定ID从类别中卸除所有AISAC 更多...
 
static void DetachAisacAll (string name)
 通过指定名称从类别中卸载所有AISAC 更多...
 
static int GetNumAttachedAisacs (int id)
 通过指定ID获取在类别中挂载的AISAC数量 更多...
 
static int GetNumAttachedAisacs (string name)
 通过指定名称获取在类别中挂载的AISAC数量 更多...
 
static int GetNumCuePlayingCount (int id)
 通过指定ID获取在所属类别中正在发声的Cue数量 更多...
 
static int GetNumCuePlayingCount (string name)
 通过指定名称在所属类别中获取正在发声的Cue数量 更多...
 

详细描述

用于执行以类别为单位的参数控制的类。

说明:
用于执行以类别为单位的参数控制的类。

成员枚举类型说明

enum ReactType : int
strong

REACT类型

说明:
REACT的类型。
参见
CriAtomExCategory::GetReactParameter, CriAtomExCategory::SetReactParameter
枚举值
Ducker 

Ducker

AisacModulationTrigger 

AISAC调制触发器

enum ReactDuckerTargetType : int
strong

REACT的闪避目标

说明:
REACT的闪避对象的类型。
参见
CriAtomExCategory::GetReactParameter, CriAtomExCategory::SetReactParameter
枚举值
Volume 

音量Ducker

AisacControlValue 

AISAC控制器值的Ducker

enum ReactDuckerCurveType : int
strong
弃用:
将被删除的非推荐API。 请考虑使用 CriWare.CriAtomEx.CurveType
枚举值
Linear 

直线

Square 

低速变化

SquareReverse 

高速变化

SCurve 

S型曲线

FlatAtHalf 

倒S型曲线

enum ReactHoldType
strong

REACT保持类型

说明:
REACT保持(衰减时间维持)类型。
参见
CriAtomExCategory::GetReactParameter, CriAtomExCategory::SetReactParameter
枚举值
WhilePlaying 

播放中执行Hold

FixedTime 

执行固定时间的Hold

enum ReactStatus
strong

REACT的执行状态

说明:
此值显示了REACT的执行状态
参见
CriAtomExCategory::GetReactStatus
枚举值
Stop 

已停止

FadeOut 

执行开始中

Hold 

继续执行中

FadeIn 

执行结束中

Error 

错误

成员函数说明

static void SetVolume ( string  name,
float  volume 
)
inlinestatic

指定名称来针对类别设置音量

参数
name类别名
volume音量值
说明:
指定名称来针对类别设置音量。
static void SetVolume ( int  id,
float  volume 
)
inlinestatic

通过指定ID来设置针对类别的音量设置

参数
id类别ID
volume音量值
说明:
指定ID来针对类别设置音量。
static float GetVolume ( string  name)
inlinestatic

指定名称来获取类别音量

参数
name类别名
返回
类别音量
说明:
指定名称来获取类别所适用的音量值。
static float GetVolume ( int  id)
inlinestatic

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

参数
id类别ID
返回
类别音量
说明:
指定ID来获取类别所适用的音量值。
static void Mute ( string  name,
bool  mute 
)
inlinestatic

指定名称来设置类别静音状态

参数
name类别名
mute静音状态(False = 解除静音,True = 静音)
说明:
指定名称来设置类别的静音状态。
static void Mute ( int  id,
bool  mute 
)
inlinestatic

通过指定ID来设置类别静音状态

参数
id类别ID
mute静音状态(False = 解除静音,True = 静音)
说明:
指定ID来设置类别的静音状态。
static bool IsMuted ( string  name)
inlinestatic

指定名称来获取类别静音状态

参数
name类别名
返回
静音状态(False = 非静音,True = 静音中)
说明:
指定名称来获取类别的静音状态。
static bool IsMuted ( int  id)
inlinestatic

通过指定ID来获取类别静音状态

参数
id类别ID
返回
静音状态(False = 非静音,True = 静音中)
说明:
指定ID来获取类别的静音状态。
static void Solo ( string  name,
bool  solo,
float  muteVolume 
)
inlinestatic

指定名称来设置类别的独奏状态

参数
name类别名
solo独奏状态(False = 独奏解除,True = 独奏)
muteVolume适用于其他类别的静音音量值
说明:
指定名称来设置类别的独奏状态。
在 muteVolume 指定的音量, 会针对同一类别组内所属的类别进行适用。
static void Solo ( int  id,
bool  solo,
float  muteVolume 
)
inlinestatic

通过指定ID来设置类别独奏状态

参数
id类别ID
solo独奏状态(False = 独奏解除,True = 独奏)
muteVolume适用于其他类别的静音音量值
说明:
指定ID来设置类别的独奏状态。
在 muteVolume 指定的音量, 会针对同一类别组内所属的类别进行适用。
static bool IsSoloed ( string  name)
inlinestatic

指定名称来获取类别的独奏状态

参数
name类别名
返回
独奏状态(False = 非独奏状态,True = 正在独奏)
说明:
指定名称来获取类别的独奏状态。
static bool IsSoloed ( int  id)
inlinestatic

通过指定ID来获取类别的独奏状态

参数
id类别ID
返回
独奏状态(False = 非独奏状态,True = 正在独奏)
说明:
指定ID来获取类别的独奏状态。
static void Pause ( string  name,
bool  pause 
)
inlinestatic

指定名称来进行类别的暂停或解除暂停

参数
name类别名
pause切换(False = 暂停解除,True = 暂停)
说明:
指定名称来进行类别的暂停或解除暂停。
除了用名称指定类别以外, 其余的规格与 CriWare.CriAtomExCategory::Pause(int, bool) 函数相同。
参见
CriAtomExCategory::Pause(int, bool)
static void Pause ( int  id,
bool  pause 
)
inlinestatic

通过指定ID来进行类别的暂停或解除暂停

参数
id类别ID
pause切换(False = 暂停解除,True = 暂停)
说明:
指定ID来进行类别的暂停或解除暂停。
备注:
类别的暂停与AtomExPlayer/播放声音的暂停 ( CriWare.CriAtomExPlayer::Pause 函数和 CriWare.CriAtomExPlayback::Pause 函数的暂停)不同, 音频的最终暂停状态是考量各自的暂停状态来决定的。
也就是说,如果有一方是暂停状态,则为暂停;如果双方是暂停解除状态时,则为暂停解除。
参见
CriAtomExCategory::Pause(string, bool)
static bool IsPaused ( string  name)
inlinestatic

通过指定ID来获取类别的暂停状态

参数
name类别ID
返回
暂停状态(False = 未暂停,True = 暂停中)
说明:
指定ID来获取类别的暂停状态。
static bool IsPaused ( int  id)
inlinestatic

指定名称来进行类别的暂停或解除暂停

参数
id类别名
返回
暂停状态(False = 未暂停,True = 暂停中)
说明:
指定名称来获取类别的暂停状态。
static void SetAisacControl ( string  name,
string  controlName,
float  value 
)
inlinestatic

指定名称来设置针对类别AISAC控制器值

参数
name类别名
controlNameAISAC控制器名
valueAISAC控制器值
说明:
指定名称来针对类别设置AISAC控制器值。
除了用名称指定类别和AISAC控制以外, 其余的规格与 CriWare.CriAtomExCategory::SetAisacControl 函数相同。
参见
CriAtomExCategory::SetAisacControl(int, int, float)
static void SetAisac ( string  name,
string  controlName,
float  value 
)
inlinestatic
弃用:
将被删除的非推荐API。 请考虑使用 CriWare.CriAtomExCategory.SetAisacControl
static void SetAisacControl ( int  id,
int  controlId,
float  value 
)
inlinestatic

通过指定ID指定来设置针对类别的AISAC控制器值

参数
id类别ID
controlIdAISAC控制器ID
valueAISAC控制器值
说明:
指定ID来针对类别设置AISAC控制器值。
注意:
关于设置了Cue和音轨的AISAC, 比起比Player的AISAC控制器值设置, 会更加优先类别的AISAC控制器值来参照
关于类别中添加的AISAC, 始终仅会参照类别中设置的AISAC控制器值
参见
CriAtomExCategory::SetAisacControl(string, string, float)
static void SetAisac ( int  id,
int  controlId,
float  value 
)
inlinestatic
弃用:
将被删除的非推荐API。 请考虑使用 CriWare.CriAtomExCategory.SetAisacControl
static void SetReactParameter ( string  name,
ReactParameter  parameter 
)
inlinestatic

设置REACT驱动参数

参数
nameREACT名
parameterREACT驱动参数结构体
说明:
设置驱动REACT的参数。
注意:
REACT动作时无法设置参数(会发生警告)。
如果指定了不存在的REACT名,则会返回错误回调。
参见
CriAtomExCategory::GetReactParameter, CriAtomExCategory::GetReactStatus
static bool GetReactParameter ( string  name,
out ReactParameter  parameter 
)
inlinestatic

获取REACT驱动参数

参数
nameREACT名
parameterREACT驱动参数结构体
说明:
获取用于驱动REACT的参数的当前值。
注意:
如果指定了不存在的REACT名,则会发生错误回调,返回CRI_False。
如果指定了不存在的REACT名,则会返回错误回调。
参见
CriAtomExCategory::SetReactParameter
static bool GetAttachedAisacInfoById ( uint  id,
int  aisacAttachedIndex,
out CriAtomEx.AisacInfo  aisacInfo 
)
inlinestatic

通过指定ID来获取AISAC信息

参数
id类别ID
aisacAttachedIndex添加的AISAC的索引
aisacInfoAISAC信息获取用结构体
说明:
指定ID来获取类别中添加的AISAC的信息。
注意:
指定了不存在的类别时,或指定了无效的索引时,将会返回False。
参见
CriAtomExCategory::GetNumAttachedAisacs
static bool GetAttachedAisacInfoByName ( string  name,
int  aisacAttachedIndex,
out CriAtomEx.AisacInfo  aisacInfo 
)
inlinestatic

通过指定名称来获取AISAC信息

参数
name类别名
aisacAttachedIndex添加的AISAC的索引
aisacInfoAISAC信息获取用结构体
说明:
指定名称来获取类别中添加的AISAC的信息。
注意:
指定了不存在的类别时,或指定了无效的索引时,将会返回False。
参见
CriAtomExCategory::GetNumAttachedAisacs
static bool GetCurrentAisacControlValue ( string  categoryName,
string  aisacControlName,
out float  controlValue 
)
inlinestatic

通过指定名称来获取AISAC信息

参数
categoryName类别名
aisacControlNameAISAC控制器名
controlValueAISAC控制器的当前值
返回
是否已获取当前值(已获取:true / 未能获取:false)
说明:
获取在类别中挂载的AISAC控制器的当前值。
注意:
指定了不存在的类别时,或指定了无效的索引时,将会返回False。
参见
CriAtomExCategory::GetNumAttachedAisacs
static ReactStatus GetReactStatus ( string  reactName)
inlinestatic

REACT的执行状态的获取

参数
reactNameREACT名
返回
REACT的执行状态
说明:
获取REACT的执行状态
注意:
如果指定了不存在的REACT名,则会发生错误回调并返回ReactStatus.Error。
static void Stop ( int  id)
inlinestatic

通过指定ID停止在所属类别中正在发声的Cue

参数
id类别ID
说明:
在指定了的所属类别中停止正在发声的Cue。
static void Stop ( string  name)
inlinestatic

通过指定名称在所属类别中停止正在发声的Cue

参数
name类别名
说明:
在指定了的所属类别中停止正在发声的Cue。
static void StopWithoutReleaseTime ( int  id)
inlinestatic

通过指定ID立即停止在所属类别中正在发声的Cue

参数
id类别ID
说明:
在指定了的所属类别中即时停止正在发声的Cue。
static void StopWithoutReleaseTime ( string  name)
inlinestatic

通过指定名称在所属类别中即时停止正在发声的Cue

参数
name类别名
说明:
在指定了的所属类别中即时停止正在发声的Cue。
static float GetTotalVolume ( int  id)
inlinestatic

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

参数
id类别ID
返回
类别音量
说明:
通过指定ID来获取受REACT、AISAC等影响后的类别的音量值。E242
备注:
由于为了获取类别的最终音量值需要进行参数的计算处理,此函数负荷较大。
static float GetTotalVolume ( string  name)
inlinestatic

通过指定名称在所属类别中即时停止正在发声的Cue

参数
name类别名
返回
类别音量
说明:
通过指定ID来获取受REACT、AISAC等影响后的类别的音量值。E242
备注:
由于为了获取类别的最终音量值需要进行参数的计算处理,此函数负荷较大。
static void SetFadeInTime ( int  id,
ushort  ms 
)
inlinestatic

通过指定ID来设置渐入时间

参数
id类别ID
ms渐入时间(毫秒)
说明:
设置类别的淡入时间。
该淡入时间在解除暂停时使用。
static void SetFadeInTime ( string  name,
ushort  ms 
)
inlinestatic

通过指定名称来设置渐入时间

参数
name类别名
ms渐入时间(毫秒)
说明:
设置类别的淡入时间。
该淡入时间在解除暂停时使用。
static void SetFadeOutTime ( int  id,
ushort  ms 
)
inlinestatic

通过指定ID来设置渐出时间

参数
id类别ID
ms渐出时间(毫秒)
说明:
设置类别的淡出时间。
该淡出时间在执行暂停时使用。
static void SetFadeOutTime ( string  name,
ushort  ms 
)
inlinestatic

通过指定名称来设置渐出时间

参数
name类别名
ms渐出时间(毫秒)
说明:
设置类别的淡出时间。
该淡出时间在执行暂停时使用。
static bool ResetAllAisacControl ( int  id)
inlinestatic

通过指定ID将类别中设置的所有AISAC控制值设置为预设值

参数
id类别ID
返回
设置是否成功(true: 成功, false: 失败)
说明:
将挂载在类别上的所有AISAC控制值设置为其预设值。
指定不存在的类别会返回false。
static bool ResetAllAisacControl ( string  name)
inlinestatic

通过指定名称来针对类别设置的所有AISAC控制器值并设置为预设值

参数
name类别名
返回
设置是否成功(true: 成功, false: 失败)
说明:
将挂载在类别上的所有AISAC控制值设置为其预设值。
指定不存在的类别会返回false。
参见
CriAtomExCategory::GetNumAttachedAisacs
static void AttachAisac ( int  id,
string  globalAisacName 
)
inlinestatic

通过指定ID在类别上挂载AISAC

参数
id类别ID
globalAisacName添加全局AISAC名
说明:
将 AISAC 挂载到该类别。
通过挂载 AISAC,即使Cue或音轨中未预先设置AISAC,也可以获得 AISAC 的效果。

如果 AISAC 挂载失败,函数内会发生错误回调。
请检查错误信息以了解失败的原因。
备注:
只能挂载全局设置(ACF 文件)中所包含的全局 AISAC。
要获得 AISAC 的效果,您需要像设置在Cue或者音轨上的 AISAC 一样,设置合适的 AISAC 控制值。
注意:
即使为Cue或音轨设置了“改变 AISAC 控制值的 AISAC”,由其产生的 AISAC 控制值变化也不会影响挂载到类别上的 AISAC。
对于挂载到类别的 AISAC,仅有对该类别设置的 AISAC 控制值会被参照。
当前不支持类型为“自动调制”和“随机”的AISAC的挂载。
目前,可以挂载到一个类别的 AISAC 的最大数量固定为 8。
参见
CriAtomExCategory::DetachAisac
static void AttachAisac ( string  name,
string  globalAisacName 
)
inlinestatic

通过指定名称从类别中挂载AISAC

参数
name类别名
globalAisacName添加全局AISAC名
说明:
将 AISAC 挂载到该类别。
通过挂载 AISAC,即使Cue或音轨中未预先设置AISAC,也可以获得 AISAC 的效果。

如果 AISAC 挂载失败,函数内会发生错误回调。
请检查错误信息以了解失败的原因。
备注:
只能挂载全局设置(ACF 文件)中所包含的全局 AISAC。
要获得 AISAC 的效果,您需要像设置在Cue或者音轨上的 AISAC 一样,设置合适的 AISAC 控制值。
注意:
即使为Cue或音轨设置了“改变 AISAC 控制值的 AISAC”,由其产生的 AISAC 控制值变化也不会影响挂载到类别上的 AISAC。
对于挂载到类别的 AISAC,仅有对该类别设置的 AISAC 控制值会被参照。
当前不支持类型为“自动调制”和“随机”的AISAC的挂载。
目前,可以挂载到一个类别的 AISAC 的最大数量固定为 8。
参见
CriAtomExCategory::DetachAisac
static void DetachAisac ( int  id,
string  globalAisacName 
)
inlinestatic

通过指定ID从类别中卸除AISAC

参数
id类别ID
globalAisacName删除全局AISAC名
说明:
从类别中卸除AISAC。

如果 AISAC 卸除失败,函数内会发生错误回调。
请检查错误信息以了解失败的原因。
参见
CriAtomExCategory::AttachAisac
static void DetachAisac ( string  name,
string  globalAisacName 
)
inlinestatic

通过指定名称从类别中卸载AISAC

参数
name类别名
globalAisacName删除全局AISAC名
说明:
从类别中卸除AISAC。

如果 AISAC 卸除失败,函数内会发生错误回调。
请检查错误信息以了解失败的原因。
参见
CriAtomExCategory::AttachAisac
static void DetachAisacAll ( int  id)
inlinestatic

通过指定ID从类别中卸除所有AISAC

参数
id类别ID
说明:
从类别切断(删除)所有的AISAC。
static void DetachAisacAll ( string  name)
inlinestatic

通过指定名称从类别中卸载所有AISAC

参数
name类别名
说明:
从类别切断(删除)所有的AISAC。
static int GetNumAttachedAisacs ( int  id)
inlinestatic

通过指定ID获取在类别中挂载的AISAC数量

参数
id类别ID
返回
在类别中挂载的的AISAC数量
说明:
获取挂载至该类别的AISAC的数量。
指定不存在的类别会返回负值。
static int GetNumAttachedAisacs ( string  name)
inlinestatic

通过指定名称获取在类别中挂载的AISAC数量

参数
name类别名
返回
在类别中挂载的的AISAC数量
说明:
获取挂载至该类别的AISAC的数量。
指定不存在的类别会返回负值。
static int GetNumCuePlayingCount ( int  id)
inlinestatic

通过指定ID获取在所属类别中正在发声的Cue数量

参数
id类别ID
返回
在所属类别中正在发声的Cue数量
说明:
获取属于该类别的发音Cue的数量。
指定不存在的类别会返回负值。
static int GetNumCuePlayingCount ( string  name)
inlinestatic

通过指定名称在所属类别中获取正在发声的Cue数量

参数
name类别名
返回
在所属类别中正在发声的Cue数量
说明:
获取属于该类别的发音Cue的数量。
指定不存在的类别会返回负值。

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