logoutRoom method

Future<ZegoRoomLogoutResult> logoutRoom(
  1. [String? roomID]
)

退出指定房间 ID 的房间，并带有回调。

支持版本：1.1.0 及以上。 详情描述：该接口会退出房间名为 roomID 的房间。 业务场景：在同一个房间内用户可以进行直播、音视频通话等。 调用时机：登录房间成功后，若不再使用房间功能，用户可以调用函数 logoutRoom。 使用限制：无。 注意事项：1. 退出房间会停止该用户的所有推拉流，引擎会停止，SDK 内部会主动停止本地预览。如果切换房间想保留预览能力，请使用 switchRoom 函数。2. 若用户登出房间，但传入 roomID 与已登录房间名不同，SDK 会返回失败。 相关回调：调用此函数后会收到 onRoomStateChanged (2.18.0 之前版本不支持，请使用 onRoomStateUpdate) 回调通知成功退出房间，同时同房间其他用户会接收到 onRoomUserUpdate 回调通知（开启 isUserStatusNotify 配置的前提下）。 相关接口：用户可以调用 loginRoom、switchRoom 函数登录或更换房间。

  • roomID 房间 ID，最大长度为 128 字节的字符串。\n 注意事项：\n 1. 仅支持数字，英文字符 和 '~', '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+', '=', '-', '`', ';', '’', ',', '.', '<', '>', '/', '\'。\n 2. 如果需要与 Web SDK 互通，请不要使用 '%'。
  • Returns 本次登出房间结果

Implementation

Future<ZegoRoomLogoutResult> logoutRoom([String? roomID]) async {
  return await ZegoExpressImpl.instance.logoutRoom(roomID);
}