subscribeAllRemoteAudio abstract method

Future<int> subscribeAllRemoteAudio(
  1. bool subscribe
)

订阅或取消订阅所有远端用户的音频主流。 (后续加入的用户也同样生效)

加入房间时,默认订阅所有远端用户的音频主流,您可以通过本接口取消订阅所有远端用户的音频主流。

调用时机

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

业务场景

适用于重要会议需要一键全体静音的场景。

说明

  • 设置该方法的 subscribe 参数为 true 后,对后续加入房间的用户同样生效。
  • 在开启自动订阅(默认)时,设置该方法的 subscribe 参数为 false 可以实现取消订阅所有远端用户的音频流,但此时无法再调用 subscribeRemoteAudio 方法单独订阅指定远端用户的音频流。

参数说明

subscribe 是否订阅指定用户的音频主流:

  • true: 订阅音频流(默认)
  • false: 取消订阅音频流

返回值

  • 0(OK):方法调用成功。
  • 其他:方法调用失败。
    • 30005(invalidState):状态错误,比如引擎尚未初始化。
    • 30105(userNotFound):未找到指定用户。
    • 30106(invalidUserId):非法指定用户,比如订阅了本端。
    • 30107(mediaNotStarted):媒体会话未建立,比如对端未开启音频主流。
    • 30108(sourceNotFound):媒体源未找到,比如对端未开启音频主流。
    • 30101(roomNotJoined): 尚未加入房间。

Implementation

Future<int> subscribeAllRemoteAudio(bool subscribe);