switchRoom method

Future<void> switchRoom(
  1. String fromRoomID,
  2. String toRoomID,
  3. {ZegoRoomConfig? config}
)

使用配置进阶属性的方式切换房间。

支持版本:1.15.0 及以上。 详情描述:使用此函数可以让用户快速从一个房间切换到另外一个房间。 业务场景:若需要快速切换到下一个房间,可调用此函数。 调用时机:登录房间成功后。 使用限制:无。 注意事项:

  1. 当调用此函数后,当前正在推或拉的所有流都将会停止(但本地预览不会停止)。
  2. 为了防止 App 被恶意用户模拟登录,可以在切换房间之前加上鉴权验证,即 config 参数传入的 ZegoRoomConfig 对象中的 token 参数。此参数配置作用于即将切换过去的房间。
  3. 3.5.0 版本开始支持多房间模式(使用函数 setRoomMode 设置 ZegoRoomMode 为 ZEGO_ROOM_MODE_MULTI_ROOM)。
  4. 若登录房间 loginRoom 时传入了 Token 进行登录,则调用 switchroom 切换房间时,必须使用带有 config 参数的 switchroom 接口切换房间,并传入对应 Token 值。 隐私保护申明:请勿在此接口填写用户敏感信息,包括但不限于手机号、身份证号、护照编号、真实姓名等。 相关回调:当用户调用 switchRoom 函数时,将会触发 onRoomStateChanged (2.18.0 之前版本不支持,请使用 onRoomStateUpdate) 回调通知开发者当前用户连接房间的状态。 相关接口:用户可以调用 logoutRoom 函数退出房间。
  • fromRoomID 当前处于的房间 ID。
  • toRoomID 需要登录的下一个房间 ID。
  • config 房间进阶配置。

Implementation

Future<void> switchRoom(String fromRoomID, String toRoomID,
    {ZegoRoomConfig? config}) async {
  return await ZegoExpressImpl.instance
      .switchRoom(fromRoomID, toRoomID, config: config);
}