enableAudioVolumeIndication abstract method

Future<int> enableAudioVolumeIndication(
  1. bool enable,
  2. int interval,
  3. {bool vad = false}
)

启用说话者音量提示。通过此接口可以实现允许 SDK 定期向 App 反馈房间内发音频流的用户和瞬时音量最高的远端用户(最多 3 位,包括本端)的音量相关信息,即当前谁在说话以及说话者的音量。

调用时机

请在引擎初始化之后调用此接口,且该方法在加入房间前后均可调用。

业务场景

适用于通过发言者的人声相关信息做出 UI 上的音量展示的场景,或根据发言者的音量大小进行视图布局的动态调整。

说明

  • 该方法设置内部引擎为启用状态,在 leaveChannel 后设置失效,将恢复至默认。如果您离开房间后重新加入房间,需要重新调用本接口。
  • 建议设置本地采集音量为默认值(100)或小于该值,否则可能会导致音质问题。
  • 该方法仅设置应用程序中的采集信号音量,不修改设备音量,也不会影响伴音、音效等的音量;若您需要修改设备音量,请调用设备管理相关接口。

参数说明

enable 是否启用说话者音量提示。

  • true:启用说话者音量提示。
  • false:关闭说话者音量提示。

interval 指定音量提示的时间间隔。单位为毫秒。必须设置为 100 毫秒的整数倍值,建议设置为 200 毫秒以上。

vad 是否启用本地采集人声监测:

  • true:启用本地采集人声监测。
  • false:关闭本地采集人声监测。 相关回调

启用该方法后,只要房间内有发流用户,无论是否有人说话,SDK 都会在加入房间后根据预设的时间间隔触发 onRemoteAudioVolumeIndication 回调。

返回值

  • 0(OK):方法调用成功。
  • 其他:方法调用失败。
    • 30001(errFatal):内部错误,比如音频相关模块未初始化成功。
    • 30003(invalidParam):参数错误,比如时间间隔小于 100ms。
    • 30005(invalidState):状态错误,比如引擎尚未初始化。

Implementation

Future<int> enableAudioVolumeIndication(bool enable, int interval,
    {bool vad = false});