音频频谱
- Flutter
更新时间不可用
disableAudioSpectrumMonitor
关闭音频频谱监测。
Future<void> disableAudioSpectrumMonitor();调用 enableAudioSpectrumMonitor 后,如果你想关闭音频频谱监测,请调用该方法。
注: 该方法在加入频道前后均可调用。
返回值
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
enableAudioSpectrumMonitor
开启音频频谱监测。
Future<void> enableAudioSpectrumMonitor({int intervalInMS = 100});如果你想获取本地或远端用户的音频频谱数据,请注册音频频谱观测器并开启音频频谱监测。
注: 该方法在加入频道前后均可调用。
参数
| 参数名 | 描述 |
|---|---|
intervalInMS | SDK 触发 onLocalAudioSpectrum 和 onRemoteAudioSpectrum 回调的时间间隔(毫秒)。 默认值为 100 毫秒。取值不得少于 10 毫秒,否则该方法会调用失败。 |
返回值
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
registerAudioSpectrumObserver
注册音频频谱观测器。
void registerAudioSpectrumObserver(AudioSpectrumObserver observer);成功注册音频频谱观测器并调用 enableAudioSpectrumMonitor 开启音频频谱监测后,SDK 会按照你设置的时间间隔报告你在 AudioSpectrumObserver 类中实现的回调。
注: 该方法在加入频道前后均可调用。
参数
| 参数名 | 描述 |
|---|---|
observer | 音频频谱观测器。详见 AudioSpectrumObserver。 |
返回值
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
unregisterAudioSpectrumObserver
取消注册音频频谱观测器。
void unregisterAudioSpectrumObserver(AudioSpectrumObserver observer);调用 registerAudioSpectrumObserver 后,如果你想取消注册音频频谱观测器,请调用该方法。
注: 该方法在加入频道前后均可调用。
返回值
方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。
所属接口类
onLocalAudioSpectrum
获取本地音频频谱。
final void Function(AudioSpectrumData data)? onLocalAudioSpectrum;成功调用 registerAudioSpectrumObserver 实现 AudioSpectrumObserver 中的 onLocalAudioSpectrum 回调并调用 enableAudioSpectrumMonitor 开启音频频谱监测后,SDK 会按照你设置的时间间隔触发该回调,报告编码前的本地音频数据的频谱。
参数
| 参数名 | 描述 |
|---|---|
data | 本地用户的音频频谱数据。详见 AudioSpectrumData。 |
所属接口类
onRemoteAudioSpectrum
获取远端音频频谱。
final void Function(
List<UserAudioSpectrumInfo> spectrums, int spectrumNumber)?
onRemoteAudioSpectrum;成功调用 registerAudioSpectrumObserver 实现 AudioSpectrumObserver 中的 onRemoteAudioSpectrum 回调并调用 enableAudioSpectrumMonitor 开启音频频谱监测后,SDK 会按照你设置的时间间隔触发该回调,报告接收到的远端音频数据的频谱。
参数
| 参数名 | 描述 |
|---|---|
spectrums | 远端用户的音频频谱信息,详见 UserAudioSpectrumInfo。 数组数量等于 SDK 监测到的远端用户数量,数组为空表示没有监测到远端用户的音频频谱。 |
spectrumNumber |