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

用于输入外部音频的AuxIn 更多...

继承自 CriDisposable .

struct  Config
 AuxIn创建用配置结构体 更多...
 

Public 成员函数

 CriAtomExAuxIn (Config?config=null)
 创建AuxIn 更多...
 
override void Dispose ()
 丢弃AuxIn 更多...
 
void Start ()
 AuxIn播放开始 更多...
 
void Stop ()
 AuxIn播放停止 更多...
 
void SetFormat (int numChannels, int samplingRate)
 设置格式 更多...
 
void GetFormat (out int numChannels, out int samplingRate)
 获取格式 更多...
 
void SetVolume (float volume)
 设置音量 更多...
 
void SetFrequencyRatio (float frequencyRatio)
 设置频率调整比率 更多...
 
void SetBusSendLevel (string busName, float level)
 设置总线发送Level 更多...
 
void SetInputReadStream (CriAudioReadStream stream)
 设置读取串流 更多...
 

详细描述

用于输入外部音频的AuxIn

说明:
AuxIn可以将ADX的外部的音频数据汇入ADX的DSP总线。
执行输入的数据播放开始、状态获取、输入的数据写入等控制。

构造及析构函数说明

CriAtomExAuxIn ( Config config = null)
inline

创建AuxIn

参数
configAuxIn创建用配置结构体
返回
AtomAuxIn句柄
说明:
创建音频输入用的AuxIn。
AuxIn可以将ADX的外部的音频数据汇入ADX的DSP总线。

要开始播放音频时,执行 CriWare.CriAtomExAuxIn::Start 函数。
输入的音频会经过 CriWare.CriAtomExAuxIn::SetInputReadStream 中指定的回调函数 传递至AuxIn。
注意:
本函数是完成返回型函数。在不同的平台上,执行所需的时间也会不同。
要创建/丢弃麦克风时,请在场景切换等 能承受负荷变动的时候进行操作。
参见
CriAtomExAuxIn::Dispose

成员函数说明

override void Dispose ( )
inline

丢弃AuxIn

说明:
丢弃AuxIn。
注意:
本函数是完成返回型函数。在不同的平台上,执行所需的时间也会不同。
要创建/丢弃麦克风时,请在场景切换等 能承受负荷变动的时候进行操作。
参见
CriAtomExAuxIn::CriAtomExAuxIn
void Start ( )
inline

AuxIn播放开始

说明:
开始AuxIn播放。
参见
CriAtomExAuxIn::Stop
void Stop ( )
inline

AuxIn播放停止

说明:
停止AuxIn播放。
参见
CriAtomExAuxIn::Start
void SetFormat ( int  numChannels,
int  samplingRate 
)
inline

设置格式

参数
numChannels声道数
samplingRate采样频率
说明:
设置用于播放的音频的格式。
需要在调用 CriWare.CriAtomExAuxIn::Start 前进行设置。
参见
CriAtomExAuxIn::GetFormat
void GetFormat ( out int  numChannels,
out int  samplingRate 
)
inline

获取格式

参数
numChannels声道数
samplingRate采样频率
说明:
获取由 CriWare.CriAtomExAuxIn::SetFormat 设置的格式信息。
参见
CriAtomExAuxIn::SetFormat
void SetVolume ( float  volume)
inline

设置音量

参数
volume音量值
说明:
设置AuxIn的音频的音量。

音量值是针对音频数据的振幅的倍率(单位不是分贝)。
例如,指定为1.0f时,将按照原有的音量输出原音。
指定为0.5f时,将会以等同于原音波形一半振幅的音量(-6dB) 来输出音频。
指定为0.0f时,音频将被静音(更改为无音状态)。
void SetFrequencyRatio ( float  frequencyRatio)
inline

设置频率调整比率

参数
frequencyRatio频率调整比(0.25f~4.0f)
说明:
设置AuxIn的音频的频率调整比。
频率调整比是音频数据的频率和播放频率的比率,相当于播放速度的倍率。
如果频率比超过1.0f,则音频数据将会比原音更高的速度进行播放, 如果不到1.0f,则音频数据将会以比原音更低的速度进行播放。

频率比也会影响到音频的音高。
例如,以1.0f的频率比来播放时,音频数据将会以与原音相同的音高进行播放, 但如果将频率比更改为2.0f,则音高将会提升一个音阶。
(这是因为播放速度是2倍。)
注意:
如果在频率比设置了超过1.0f的值,则要播放的音频数据会比通常 更快消耗,因此需要更快地提供音频数据。
如果在频率比设置了超过1.0f的值,则需要考虑频率比, 来设置创建AuxIn时指定的最大采样率的值。
(需要为创建AuxIn时指定的 CriWare.CriAtomExAuxIn::Config 结构体 的 maxSamplingRate 的值指定用“原音的采样率×频率比” 计算的值。)
void SetBusSendLevel ( string  busName,
float  level 
)
inline

设置总线发送Level

参数
busName总线名
levelLevel值(0.0f~1.0f)
说明:
设置AuxIn的音频的总线发送Level。
总线发送Level是一种用于指定将音频发送至那根总线,以及发送量的机制。

在第2参数中指定DSP总线设置内的总线名。
用第3参数指定发送时的Level(音量)。

如果用第2参数的总线名指定的总线在目前适用中的DSP总线设置中不存在,则设置值将会被作为无效值进行处理。
发送Level值的范围和操作与音量相同。请参照 CriWare.CriAtomExAuxIn::SetVolume 函数。
void SetInputReadStream ( CriAudioReadStream  stream)
inline

设置读取串流

参数
stream读取串流
说明:
设置AuxIn的输入方向的读取串流。
回调函数在大多数平台上会从其他线程被调用 因此被调用的一侧需要安装线程安全。

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