enableLocalAudio abstract method

Future<int> enableLocalAudio(
  1. bool enable
)

更新权限密钥。(暂不支持该功能)

通过此接口可以实现当用户权限被变更

使用前提

请确保已开通高级 Token 鉴权功能，具体请联系网易云信商务经理。

调用时机

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

业务场景

适用于变更指定用户加入、创建房间或上下麦时发布流相关权限的场景。

参数说明

key 新的权限密钥。

返回值

  • 0（OK）：方法调用成功。
  • 其他：方法调用失败。
    • 30005（invalidState)：状态错误，比如引擎尚未初始化。 Future

调用时机

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

说明

  • 加入房间后，语音功能默认为开启状态。
  • 该方法设置内部引擎为启用状态，在 leaveChannel 后仍然有效。
  • 该方法不影响接收或播放远端音频流，enableLocalAudio(false) 适用于只下行不上行音频流的场景。
  • 开启或关闭本地音频采集的操作不会影响伴音/音效接口的使用，比如 enableLocalAudio(false) 后仍可以调用 NERtcAudioMixingManager.startAudioMixing 方法播放音乐文件。
  • 该方法会操作音频硬件设备，建议避免频繁开关，否则可能导致设备异常。

参数说明

enable 是否启用本地音频的采集和发送：

  • true: 开启本地音频采集。
  • false : 关闭本地音频采集。关闭后，远端用户会接收不到本地用户的音频流；但本地用户依然可以接收到远端用户的音频流。

相关回调

相关接口

muteLocalAudioStream：两者的差异在于，enableLocalAudio 用于开启本地语音采集及处理，而 muteLocalAudioStream 用于停止或继续发送本地音频流。

  • 0（OK）：方法调用成功。
  • 其他：方法调用失败。

Implementation

/// 开启或关闭本地音频的采集和发送。 通过本接口可以实现开启或关闭本地语音功能，进行本地音频采集及处理。
///
/// **调用时机**
///
/// 请在引擎初始化之后调用此接口，且该方法在加入房间前后均可调用。
///
/// **说明**
/// * 加入房间后，语音功能默认为开启状态。
/// * 该方法设置内部引擎为启用状态，在 [leaveChannel] 后仍然有效。
/// * 该方法不影响接收或播放远端音频流，enableLocalAudio(false) 适用于只下行不上行音频流的场景。
/// * 开启或关闭本地音频采集的操作不会影响伴音/音效接口的使用，比如 enableLocalAudio(false) 后仍可以调用 [NERtcAudioMixingManager.startAudioMixing] 方法播放音乐文件。
/// * 该方法会操作音频硬件设备，建议避免频繁开关，否则可能导致设备异常。
///
///
///
/// **参数说明**
///
/// [enable] 是否启用本地音频的采集和发送：
///   * true: 开启本地音频采集。
///   * false : 关闭本地音频采集。关闭后，远端用户会接收不到本地用户的音频流；但本地用户依然可以接收到远端用户的音频流。
///
/// **相关回调**
/// * 开启音频采集后，远端会触发 [NERtcChannelEventCallback.onUserAudioStart] 回调。
/// * 关闭音频采集后，远端会触发 [NERtcChannelEventCallback.onUserAudioStop] 回调。
///
/// **相关接口**
///
/// [muteLocalAudioStream]：两者的差异在于，[enableLocalAudio] 用于开启本地语音采集及处理，而 [muteLocalAudioStream] 用于停止或继续发送本地音频流。
///
///  *  0（OK）：方法调用成功。
///  *  其他：方法调用失败。
Future<int> enableLocalAudio(bool enable);