muteLocalAudioStream abstract method

Future<int> muteLocalAudioStream(
  1. bool mute
)

开启或关闭本地音频的采集和发送。 该方法用于向网络发送或取消发送本地音频数据，不影响本地音频的采集状态，也不影响接收或播放远端音频流。

调用时机

请在初始化后调用该方法，且该方法在加入房间前后均可调用。

说明

  • 该方法设置内部引擎为启用状态，在 leaveChannel 后仍然有效。

参数说明

mute 是否关闭本地音频的发送：

  • true: 不发送本地音频。
  • false : 发送本地音频。

相关回调

若本地用户在说话，成功调用该方法后，房间内其他用户会收到 NERtcChannelEventCallback.onUserAudioMute 回调。

相关接口 enableMediaPub：在需要开启本地音频采集（监测本地用户音量）但不发送音频流的情况下，您也可以调用enableMediaPub方法。

两者的差异在于，muteLocalAudioStream 仍然保持与服务器的音频通道连接，而 enableMediaPub 表示断开此通道，因此若您的实际业务场景为多人并发的大房间，建议您调用 enableMediaPub 方法。

返回值

  • 0（OK）：方法调用成功。
  • 其他：方法调用失败。
    • 30005（invalidState)：状态错误，比如引擎尚未初始化。
    • 30101（roomNotJoined）：尚未加入房间。
    • 30107（mediaNotStarted）：媒体会话未建立，比如对端未开启音频流。
    • 30200（connectionNotFound）: 连接未建立。

Implementation

Future<int> muteLocalAudioStream(bool mute);