leaveChannelEx abstract method

Future<void> leaveChannelEx({
  1. required RtcConnection connection,
  2. LeaveChannelOptions? options,
})

设置频道选项并离开频道。

调用该方法后,SDK 会终止音视频互动、离开当前频道,并会释放会话相关的所有资源。 调用 joinChannelEx 成功加入频道后,必须调用本方法结束通话,否则无法开始下一次通话。 该方法是异步操作,调用返回时并没有真正退出频道。 如果你调用了 leaveChannel 后,会同时离开 joinChannel 及 joinChannelEx 加入的频道。 如果你调用了该方法后立即调用 release 方法,SDK 将不会触发 onLeaveChannel 回调。

  • connection Connection 信息。详见 RtcConnection 。
  • options 离开频道的选项,详见 LeaveChannelOptions 。 该参数仅支持设置 LeaveChannelOptions 中的 stopMicrophoneRecording 成员,设置其他成员均不生效。

Returns 方法成功调用时,无返回值;方法调用失败时,会抛出 AgoraRtcException 异常,你需要捕获异常并进行处理。详见错误码了解详情和解决建议。

Implementation

Future<void> leaveChannelEx(
    {required RtcConnection connection, LeaveChannelOptions? options});