CRIWARE Unity Plugin Manual
Last Updated: 2024-07-12
|
AtomExPlayer 更多...
继承自 CriDisposable .
Public 类型 | |
enum | Status { Stop = 0, Prep, Playing, PlayEnd, Error } |
Player状态 更多... | |
enum | TimeStretchParameterId : int { Ratio = 0, FrameTime = 1, Quality = 2 } |
时间拉伸用参数 更多... | |
enum | PitchShifterParameterId : int { Pitch = 0, Formant = 1, Mode = 2 } |
移调器用参数 更多... | |
Public 成员函数 | |
CriAtomExPlayer () | |
创建AtomExPlayer 更多... | |
CriAtomExPlayer (int maxPath, int maxPathStrings) | |
创建AtomExPlayer(单个文件播放用) 更多... | |
CriAtomExPlayer (bool enableAudioSyncedTimer) | |
创建AtomExPlayer(利用音频同步计时器) 更多... | |
CriAtomExPlayer (int maxPath, int maxPathStrings, bool enableAudioSyncedTimer) | |
创建AtomExPlayer(单个文件播放,利用音频同步计时器) 更多... | |
override void | Dispose () |
丢弃AtomExPlayer 更多... | |
void | SetCue (CriAtomExAcb acb, string name) |
设置音频数据(指定Cue名) 更多... | |
void | SetCue (CriAtomExAcb acb, int id) |
设置音频数据(指定Cue ID) 更多... | |
void | SetCueIndex (CriAtomExAcb acb, int index) |
设置音频数据(指定Cue索引) 更多... | |
void | SetContentId (CriFsBinder binder, int contentId) |
设置音频数据(指定CPK内容ID) 更多... | |
void | SetFile (CriFsBinder binder, string path) |
设置音频数据(指定文件名) 更多... | |
void | SetData (byte[] buffer, int size) |
设置音频数据(指定内存中的字节数组) 更多... | |
void | SetData (IntPtr buffer, int size) |
设置音频数据(指定内存中的缓冲区地址) 更多... | |
void | SetFormat (CriAtomEx.Format format) |
指定格式 更多... | |
void | SetNumChannels (int numChannels) |
指定声道数 更多... | |
void | SetSamplingRate (int samplingRate) |
指定采样率 更多... | |
void | PrepareEntryPool (int capacity, bool stopOnEmpty) |
创建连接播放用Entry Pool 更多... | |
int | GetNumEntries () |
连接播放用数据的条目数 更多... | |
int | GetNumConsumedEntries () |
进入播放过程的数据条目数 更多... | |
bool | EntryFile (CriFsBinder binder, string path, bool repeat) |
输入连接播放用数据(指定文件名) 更多... | |
bool | EntryContentId (CriFsBinder binder, int contentId, bool repeat) |
输入连接播放用数据(指定CPK内容ID) 更多... | |
bool | EntryData (byte[] buffer, int size, bool repeat) |
输入连接播放用数据(指定内存中的字节数组) 更多... | |
bool | EntryData (IntPtr buffer, int size, bool repeat) |
输入连接播放用数据(指定内存中的缓冲区地址) 更多... | |
bool | EntryCue (CriAtomExAcb acb, string name, bool repeat) |
输入连接播放用数据(指定Cue名) 更多... | |
CriAtomExPlayback | Start () |
开始播放 更多... | |
CriAtomExPlayback | Prepare () |
准备播放 更多... | |
void | Stop (bool ignoresReleaseTime) |
播放停止 更多... | |
void | Pause () |
暂停 更多... | |
void | Resume (CriAtomEx.ResumeMode mode) |
解除暂停 更多... | |
bool | IsPaused () |
获取暂停状态 更多... | |
void | SetVolume (float volume) |
设置音量 更多... | |
void | SetPitch (float pitch) |
设置音高 更多... | |
void | SetPlaybackRatio (float ratio) |
序列播放速率的设置 更多... | |
void | SetPan3dAngle (float angle) |
设置Panning 3D角度 更多... | |
void | SetPan3dInteriorDistance (float distance) |
设置Panning 3D距离 更多... | |
void | SetPan3dVolume (float volume) |
设置Panning 3D音量 更多... | |
void | SetPanType (CriAtomEx.PanType panType) |
设置Pan类型 更多... | |
void | SetSendLevel (int channel, CriAtomEx.Speaker id, float level) |
设置发送电平 更多... | |
void | SetBiquadFilterParameters (CriAtomEx.BiquadFilterType type, float frequency, float gain, float q) |
设置双二阶滤波器的参数 更多... | |
void | SetBandpassFilterParameters (float cofLow, float cofHigh) |
设置带通滤波器的参数 更多... | |
void | SetBusSendLevel (string busName, float level) |
设置总线发送电平(指定总线名称) 更多... | |
bool | GetBusSendLevel (string busName, out float level) |
获取总线发送量(电平)(指定总线名称) 更多... | |
void | SetBusSendLevel (int busId, float level) |
void | SetBusSendLevelOffset (string busName, float levelOffset) |
设置偏移的总线发送Level(指定总线名) 更多... | |
bool | GetBusSendLevelOffset (string busName, out float level) |
获取总线发送量(电平)的偏移值(指定总线名称) 更多... | |
void | SetBusSendLevelOffset (int busId, float levelOffset) |
void | AttachAisac (string globalAisacName) |
为Player添加AISAC 更多... | |
void | DetachAisac (string globalAisacName) |
从Player切断AISAC 更多... | |
void | SetAisacControl (string controlName, float value) |
设置AISAC控制器值(指定控制器名) 更多... | |
void | SetAisac (string controlName, float value) |
void | SetAisacControl (uint controlId, float value) |
设置AISAC控制器值(指定控制器ID) 更多... | |
void | SetAisac (uint controlId, float value) |
bool | GetAttachedAisacInfo (int aisacAttachedIndex, out CriAtomEx.AisacInfo aisacInfo) |
获取添加在Player上的AISAC的信息。 更多... | |
void | Set3dSource (CriAtomEx3dSource source) |
设置3D声源对象 更多... | |
void | Set3dListener (CriAtomEx3dListener listener) |
设置3D收听者对象 更多... | |
void | SetStartTime (long startTimeMs) |
指定播放开始位置 更多... | |
void | SetFirstBlockIndex (int index) |
设置播放开始块(指定块索引) 更多... | |
void | SetSelectorLabel (string selector, string label) |
设置选择器信息 更多... | |
void | UnsetSelectorLabel (string selector) |
删除所设置的选择器信息 更多... | |
void | ClearSelectorLabels () |
删除所有设置的选择器信息 更多... | |
void | SetCategory (int categoryId) |
设置类别(指定ID) 更多... | |
void | SetCategory (string categoryName) |
设置类别(指定类别名) 更多... | |
void | UnsetCategory () |
删除类别 更多... | |
void | SetCuePriority (int priority) |
设置Cue优先级 更多... | |
void | SetVoicePriority (int priority) |
设置Voice优先级 更多... | |
void | SetVoiceControlMethod (CriAtomEx.VoiceControlMethod method) |
指定Voice控制方法 更多... | |
void | SetPreDelayTime (float time) |
设置预延迟时间 更多... | |
void | SetEnvelopeAttackTime (float time) |
设置EG的Attack时间 更多... | |
void | SetEnvelopeHoldTime (float time) |
设置EG的Hold时间 更多... | |
void | SetEnvelopeDecayTime (float time) |
设置EG的Decay时间 更多... | |
void | SetEnvelopeReleaseTime (float time) |
设置EG的Release时间 更多... | |
void | SetEnvelopeSustainLevel (float level) |
设置EG的Sustain Level 更多... | |
void | AttachFader () |
将渐变器安装至Player 更多... | |
void | DetachFader () |
从Player上删除渐变器 更多... | |
void | SetFadeOutTime (int ms) |
设置渐出时间 更多... | |
void | SetFadeInTime (int ms) |
设置渐入时间 更多... | |
void | SetFadeInStartOffset (int ms) |
设置渐入开始偏移 更多... | |
void | SetFadeOutEndDelay (int ms) |
设置渐出后的延迟时间 更多... | |
bool | IsFading () |
获取是否正在进行渐变处理 更多... | |
void | ResetFaderParameters () |
渐变器参数初始化 更多... | |
void | SetGroupNumber (int group_no) |
指定组编号 更多... | |
void | Update (CriAtomExPlayback playback) |
更新播放参数(CriAtomExPlayback对象单位) 更多... | |
void | UpdateAll () |
更新播放参数(正在播放的所有声音) 更多... | |
void | ResetParameters () |
初始化播放参数 更多... | |
long | GetTime () |
获取播放时间 更多... | |
Status | GetStatus () |
获取状态 更多... | |
float | GetParameterFloat32 (CriAtomEx.Parameter id) |
获取参数(浮点数) 更多... | |
uint | GetParameterUint32 (CriAtomEx.Parameter id) |
获取参数(无符号的整数) 更多... | |
int | GetParameterSint32 (CriAtomEx.Parameter id) |
获取参数(带符号的整数) 更多... | |
void | SetSoundRendererType (CriAtomEx.SoundRendererType type) |
设置输出声音渲染器类型 更多... | |
void | SetRandomSeed (uint seed) |
设置随机数种类 更多... | |
void | Loop (bool sw) |
循环播放切换 更多... | |
void | SetAsrRackId (int asr_rack_id) |
指定ASR Rack ID 更多... | |
void | SetVoicePoolIdentifier (uint identifier) |
设置Voice池标识符 更多... | |
void | SetDspTimeStretchRatio (float ratio) |
设置DSP时间拉伸比率 更多... | |
void | SetDspPitchShifterPitch (float pitch) |
设置DSP移调器的音高移调量 更多... | |
void | SetDspParameter (int id, float value) |
设置DSP参数 更多... | |
void | AttachTween (CriAtomExTween tween) |
AtomExTween的挂载 更多... | |
void | DetachTween (CriAtomExTween tween) |
AtomExTween的卸载 更多... | |
void | DetachTweenAll () |
卸载所有AtomExTween 更多... | |
void | SetEnvelopeAttackCurve (CriAtomEx.CurveType curveType, float strength) |
包络的Attack曲线的设置 更多... | |
void | SetEnvelopeDecayCurve (CriAtomEx.CurveType curveType, float strength) |
包络的Decay曲线的设置 更多... | |
void | SetEnvelopeReleaseCurve (CriAtomEx.CurveType curveType, float strength) |
包络的Release曲线的设置 更多... | |
void | AddOutputPort (CriAtomExOutputPort outputPort) |
添加输出端口对象 更多... | |
void | RemoveOutputPort (CriAtomExOutputPort outputPort) |
卸载输出端口对象 更多... | |
void | ClearOutputPorts () |
清除输出端口对象 更多... | |
void | AddPreferredOutputPort (CriAtomExOutputPort outputPort) |
添加优先输出端口对象 更多... | |
void | RemovePreferredOutputPort (CriAtomExOutputPort outputPort) |
卸载优先输出端口对象 更多... | |
void | RemovePreferredOutputPort (string name) |
卸载优先输出端口对象(名称指定) 更多... | |
void | ClearPreferredOutputPorts () |
清除优先输出端口对象 更多... | |
void | SetScheduleTime (System.Int64 scheduleTime) |
预约播放时间的指定 更多... | |
静态 Public 属性 | |
static readonly uint | MaxOutputPorts = 8 |
在Player中可以指定的最大输出端口数 更多... | |
属性 | |
CriAtomExBeatSync.CbFunc | OnBeatSyncCallback |
注册序列事件回调 更多... | |
CriAtomExSequencer.EventCallback | OnSequenceCallback |
注册节拍同步回调 更多... | |
int | entryPoolCapacity [get] |
可输入的连接播放用数据 | |
AtomExPlayer
|
strong |
Player状态
枚举值 | |
---|---|
Stop |
已停止 |
Prep |
播放准备中 |
Playing |
正在播放 |
PlayEnd |
结束播放 |
Error |
发生错误 |
|
strong |
|
strong |
|
inline |
创建AtomExPlayer
|
inline |
创建AtomExPlayer(单个文件播放用)
maxPath | 最大路径字符串长度 |
maxPathStrings | 同时播放文件数 |
|
inline |
创建AtomExPlayer(利用音频同步计时器)
enableAudioSyncedTimer | 音频同步计时器有效标记 |
|
inline |
创建AtomExPlayer(单个文件播放,利用音频同步计时器)
maxPath | 最大路径字符串长度 |
maxPathStrings | 同时播放文件数 |
enableAudioSyncedTimer | 音频同步计时器有效标记 |
|
inline |
丢弃AtomExPlayer
|
inline |
设置音频数据(指定Cue名)
acb | ACB对象 |
name | Cue名 |
(音频格式、声道数和采样率等信息是根据ACB文件的信息自动设置的)。
|
inline |
设置音频数据(指定Cue ID)
acb | ACB对象 |
id | Cue ID |
(音频格式、声道数和采样率等信息是根据ACB文件的信息自动设置的)。
|
inline |
设置音频数据(指定Cue索引)
acb | ACB对象 |
index | Cue索引 |
(音频格式、声道数和采样率等信息是根据ACB文件的信息自动设置的)
本函数可以用来将音频设置到Player,而不需要指定Cue名称或Cue ID。
(即使不知道Cue名称或Cue ID,ACB文件中的内容也能全部播放, 所以本函数可以用于调试。)
|
inline |
设置音频数据(指定CPK内容ID)
binder | Binder |
contentId | 内容ID |
|
inline |
设置音频数据(指定文件名)
binder | Binder对象 |
path | 文件路径 |
|
inline |
设置音频数据(指定内存中的字节数组)
buffer | 字节数组 |
size | 缓冲区大小 |
|
inline |
设置音频数据(指定内存中的缓冲区地址)
buffer | 缓冲区地址 |
size | 缓冲区大小 |
|
inline |
指定格式
format | 格式 |
|
inline |
指定声道数
numChannels | 声道数 |
|
inline |
指定采样率
samplingRate | 采样率 |
|
inline |
创建连接播放用Entry Pool
capacity | 可输入的数据数 |
stopOnEmpty | Entry Pool空时是否停止 |
|
inline |
连接播放用数据的条目数
|
inline |
进入播放过程的数据条目数
|
inline |
输入连接播放用数据(指定文件名)
binder | Binder对象 |
path | 文件路径 |
repeat | 未输入以下数据时是否重复播放 |
|
inline |
输入连接播放用数据(指定CPK内容ID)
binder | Binder对象 |
contentId | 内容ID |
repeat | 未输入以下数据时是否重复播放 |
|
inline |
输入连接播放用数据(指定内存中的字节数组)
buffer | 内存字节数组 |
size | 缓冲区大小 |
repeat | 未输入以下数据时是否重复播放 |
|
inline |
输入连接播放用数据(指定内存中的缓冲区地址)
buffer | 缓冲区地址 |
size | 缓冲区大小 |
repeat | 未输入以下数据时是否重复播放 |
|
inline |
输入连接播放用数据(指定Cue名)
acb | ACB句柄 |
name | Cue名 |
repeat | 未输入以下数据时是否重复播放 |
|
inline |
开始播放
|
inline |
准备播放
|
inline |
播放停止
ignoresReleaseTime | 是否忽略Release时间 (False = 执行Release处理,True = 忽略Release时间并立即停止) |
|
inline |
暂停
|
inline |
解除暂停
mode | 解除暂停对象 |
|
inline |
获取暂停状态
|
inline |
设置音量
volume | 音量值 |
|
inline |
设置音高
pitch | 音高(音分单位) |
|
inline |
序列播放速率的设置
ratio | 序列播放比率 |
|
inline |
设置Panning 3D角度
angle | Panning 3D角度(-180.0f~180.0f:度单位) |
|
inline |
设置Panning 3D距离
distance | Panning 3D距离(-1.0f~1.0f) |
|
inline |
设置Panning 3D音量
volume | Panning 3D音量(0.0f~1.0f) |
|
inline |
设置Pan类型
panType | Pan类型 |
|
inline |
设置发送电平
channel | 声道编号 |
id | 扬声器ID |
level | 发送Level值(0.0f~1.0f) |
|
inline |
设置双二阶滤波器的参数
type | 滤波器类型 |
frequency | 标准化频率(0.0f~1.0f) |
gain | 增益(分贝值) |
q | Q值 |
|
inline |
设置带通滤波器的参数
cofLow | 标准化低频截止频率(0.0f~1.0f) |
cofHigh | 标准化高频截止频率(0.0f~1.0f) |
|
inline |
设置总线发送电平(指定总线名称)
busName | 总线名 |
level | 发送Level值(0.0f~1.0f) |
|
inline |
获取总线发送量(电平)(指定总线名称)
busName | 总线名 |
level | 发送Level值(0.0f~1.0f) |
|
inline |
|
inline |
设置偏移的总线发送Level(指定总线名)
busName | 总线名 |
levelOffset | 发送Level值(0.0f~1.0f) |
|
inline |
获取总线发送量(电平)的偏移值(指定总线名称)
busName | 总线名 |
level | 发送量(电平)偏移值(0.0f至1.0f) |
|
inline |
|
inline |
为Player添加AISAC
globalAisacName | 添加全局AISAC名 |
|
inline |
从Player切断AISAC
globalAisacName | 删除全局AISAC名 |
|
inline |
设置AISAC控制器值(指定控制器名)
controlName | 控制名 |
value | 控制值(0.0f~1.0f) |
|
inline |
|
inline |
设置AISAC控制器值(指定控制器ID)
controlId | 控制ID |
value | 控制值(0.0f~1.0f) |
|
inline |
|
inline |
获取添加在Player上的AISAC的信息。
aisacAttachedIndex | 添加的AISAC的索引 |
aisacInfo | AISAC信息获取用结构体 |
|
inline |
设置3D声源对象
source | CriAtomEx3dSource对象 |
|
inline |
设置3D收听者对象
listener | 3D收听者对象 |
|
inline |
指定播放开始位置
startTimeMs | 播放开始位置(指定毫秒) |
虽然可以为 startTimeMs 设置64bit值,但目前无法指定32bit以上的 播放时间。
如果指定播放开始位置后播放序列,则将不会播放位于指定位置之前的 波形数据。
(序列内的各波形不会从途中开始播放。)
|
inline |
设置播放开始块(指定块索引)
index | 块索引 |
|
inline |
设置选择器信息
selector | 选择器名 |
label | 标签名 |
|
inline |
删除所设置的选择器信息
selector | 选择器名 |
|
inline |
删除所有设置的选择器信息
|
inline |
设置类别(指定ID)
categoryId | 类别ID |
|
inline |
设置类别(指定类别名)
categoryName | 类别名 |
|
inline |
|
inline |
设置Cue优先级
priority | Cue优先级 |
|
inline |
设置Voice优先级
priority | Voice优先级(-255~255) |
|
inline |
指定Voice控制方法
method | Voice控制方法 |
|
inline |
设置预延迟时间
time | 预延迟时间(0.0f~2000.0f) |
|
inline |
设置EG的Attack时间
time | Attack时间(0.0f~2000.0f) |
|
inline |
设置EG的Hold时间
time | Hold时间(0.0f~2000.0f) |
|
inline |
设置EG的Decay时间
time | Decay时间(0.0f~2000.0f) |
|
inline |
设置EG的Release时间
time | Release时间(0.0f~10000.0f) |
|
inline |
设置EG的Sustain Level
level | Sustain Level(0.0f~2000.0f) |
|
inline |
将渐变器安装至Player
|
inline |
从Player上删除渐变器
|
inline |
设置渐出时间
ms | 渐出时间(指定毫秒) |
|
inline |
设置渐入时间
ms | 渐入时间(指定毫秒) |
|
inline |
设置渐入开始偏移
ms | 渐入开始偏移(指定毫秒) |
|
inline |
设置渐出后的延迟时间
ms | 渐出后的延迟时间(指定毫秒) |
|
inline |
获取是否正在进行渐变处理
|
inline |
渐变器参数初始化
|
inline |
指定组编号
|
inline |
更新播放参数(CriAtomExPlayback对象单位)
playback | CriAtomExPlayback对象 |
|
inline |
更新播放参数(正在播放的所有声音)
: // プレーヤの作成 CriAtomExPlayer player = new CriAtomExPlayer(); : // 再生の開始 CriAtomExPlayback playback = player.Start(); : // ボリュームの変更 // 注意)この時点では再生中の音声のパラメータは変更されない。 player.SetVolume(volume);
// プレーヤに設定されたパラメータを再生中の全ての音声に反映 player.UpdateAll(); :
|
inline |
初始化播放参数
: // プレーヤの作成 CriAtomExPlayer player = new CriAtomExPlayer(); : // ボリュームの変更 player.SetVolume(0.5f);
// 音声を再生 // 備考)ここで再生された音声は0.5fのボリュームで出力される。 CriAtomExPlayback playback1 = player.Start();
// プレーヤに設定されたパラメータをリセット // 備考)プレーヤのボリューム設定がデフォルト値(1.0f)に戻される。 player.ResetParameters();
// 別の音を再生 // 備考)ここで再生された音声は1.0fのボリュームで出力される。 CriAtomExPlayback playback2 = player.Start(); :
|
inline |
获取播放时间
|
inline |
获取状态
|
inline |
获取参数(浮点数)
id | 参数ID |
|
inline |
获取参数(无符号的整数)
id | 参数ID |
|
inline |
获取参数(带符号的整数)
id | 参数ID |
|
inline |
设置输出声音渲染器类型
type | 输出目标的声音渲染器类型 |
|
inline |
设置随机数种类
seed | 随机数种类 |
|
inline |
循环播放切换
sw | 循环切换(True: 循环模式,False: 解除循环模式) |
|
inline |
指定ASR Rack ID
asr_rack_id | ASR Rack ID |
|
inline |
设置Voice池标识符
identifier | Voice池标识符 |
|
inline |
设置DSP时间拉伸比率
ratio | 拉伸比率 |
|
inline |
设置DSP移调器的音高移调量
pitch | 移调量 |
|
inline |
设置DSP参数
id | 参数ID |
value | 参数值 |
|
inline |
AtomExTween的挂载
tween | AtomExTween对象 |
|
inline |
|
inline |
卸载所有AtomExTween
|
inline |
包络的Attack曲线的设置
curveType | 曲线类型 |
strength | 曲线强度 |
|
inline |
包络的Decay曲线的设置
curveType | 曲线类型 |
strength | 曲线强度 |
|
inline |
包络的Release曲线的设置
curveType | 曲线类型 |
strength | 曲线强度 |
|
inline |
添加输出端口对象
outputPort | 输出端口对象 |
|
inline |
卸载输出端口对象
outputPort | 输出端口对象 |
|
inline |
清除输出端口对象
|
inline |
添加优先输出端口对象
outputPort | 输出端口对象 |
|
inline |
卸载优先输出端口对象
outputPort | 输出端口对象 |
|
inline |
卸载优先输出端口对象(名称指定)
name | 输出端口名称 |
|
inline |
清除优先输出端口对象
清除所有已添加到Player的优先输出端口。
清除使用 CriWare.CriAtomExPlayer.AddPreferredOutputPort 添加到播放器的所有优先输出端口对象。
要删除特定的优先输出端口,请使用 CriWare.CriAtomExPlayer.RemovePreferredOutputPort。
移除优先输出端口不会影响已开始播放的音频。
|
inline |
预约播放时间的指定
|
static |
在Player中可以指定的最大输出端口数
|
addremove |
注册序列事件回调
|
addremove |
注册节拍同步回调