音频频谱
- Unity
更新时间不可用
DisableAudioSpectrumMonitor
关闭音频频谱监测。
public abstract int DisableAudioSpectrumMonitor();调用 EnableAudioSpectrumMonitor 后,如果你想关闭音频频谱监测,请调用该方法。
注: 该方法在加入频道前后均可调用。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
EnableAudioSpectrumMonitor
开启音频频谱监测。
public abstract int EnableAudioSpectrumMonitor(int intervalInMS = 100);如果你想获取本地或远端用户的音频频谱数据,请注册音频频谱观测器并开启音频频谱监测。
注: 该方法在加入频道前后均可调用。
参数
| 参数名 | 描述 |
|---|---|
intervalInMS | SDK 触发 OnLocalAudioSpectrum 和 OnRemoteAudioSpectrum 回调的时间间隔(毫秒)。 默认值为 100 毫秒。取值不得少于 10 毫秒,否则该方法会调用失败。 |
返回值
-
0: 方法调用成功。
-
< 0: 方法调用失败。详见错误码了解详情和解决建议。
- -2: 参数设置错误。
所属接口类
RegisterAudioSpectrumObserver
注册音频频谱观测器。
public abstract int RegisterAudioSpectrumObserver(IAudioSpectrumObserver observer);成功注册音频频谱观测器并调用 EnableAudioSpectrumMonitor 开启音频频谱监测后,SDK 会按照你设置的时间间隔报告你在 IAudioSpectrumObserver 类中实现的回调。
注: 该方法在加入频道前后均可调用。
参数
| 参数名 | 描述 |
|---|---|
observer | 音频频谱观测器。详见 IAudioSpectrumObserver。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
UnregisterAudioSpectrumObserver
取消注册音频频谱观测器。
public abstract int UnregisterAudioSpectrumObserver();调用 RegisterAudioSpectrumObserver 后,如果你想取消注册音频频谱观测器,请调用该方法。
注: 该方法在加入频道前后均可调用。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。详见错误码了解详情和解决建议。
所属接口类
OnLocalAudioSpectrum
获取本地音频频谱。
public virtual bool OnLocalAudioSpectrum(AudioSpectrumData data)
{
return true;
}成功调用 RegisterAudioSpectrumObserver 实现 IAudioSpectrumObserver 中的 OnLocalAudioSpectrum 回调并调用 EnableAudioSpectrumMonitor 开启音频频谱监测后,SDK 会按照你设置的时间间隔触发该回调,报告编码前的本地音频数据的频谱。
参数
| 参数名 | 描述 |
|---|---|
data | 本地用户的音频频谱数据。详见 AudioSpectrumData。 |
返回值
是否接收频谱数据:
- true: 接收。
- false: 不接收。
所属接口类
OnRemoteAudioSpectrum
获取远端音频频谱。
public virtual bool OnRemoteAudioSpectrum(UserAudioSpectrumInfo[] spectrums, uint spectrumNumber)
{
return true;
}成功调用 RegisterAudioSpectrumObserver 实现 IAudioSpectrumObserver 中的 OnRemoteAudioSpectrum 回调并调用 EnableAudioSpectrumMonitor 开启音频频谱监测后,SDK 会按照你设置的时间间隔触发该回调,报告接收到的远端音频数据的频谱。
参数
| 参数名 | 描述 |
|---|---|
spectrums | 远端用户的音频频谱信息,详见 UserAudioSpectrumInfo。 数组数量等于 SDK 监测到的远端用户数量,数组为空表示没有监测到远端用户的音频频谱。 |
spectrumNumber |
返回值
是否接收频谱数据:
- true: 接收。
- false: 不接收。