@tencent-rtc/mcp 1.6.6 → 1.6.8

package/resource/knowledge/roomkit/core-sdk/flutter/room-state.md

@@ -1,325 +0,0 @@
-`RoomStore` 专职负责 `AtomicXCore` 中的房间事务管理，提供从房间创建到解散的完整流程控制接口。通过 `RoomStore` 提供的接口（例如获取及更新房间信息），可高效开发出一套成熟的房间管理体系。
-
-## 核心功能
-- **创建并加入房间**：房主通过调用该接口可以直接创建并进入房间。
-
-- **加入房间**：参与者通过调用该接口可以直接进入已存在的房间。
-
-- **离开房间**：参与者通过调用该接口可以退出已进入的房间。
-
-- **结束房间**：房主通过调用该接口可以结束当前房间，如果房间内还有其他参与者，此时参与者会收到`onRoomEnded`事件。
-
-- **更新房间信息**：房主或管理员通过调用该接口可以更新房间信息，目前支持更新房间名称，房间密码。
-
-- **获取房间信息**：通过调用该接口可以获取房间的详细信息。
-
-## 核心概念
-
-在开始集成之前，需要通过下表了解一下`RoomStore`相关的几个核心概念：
-| <strong>核心概念</strong> | <strong>核心职责与描述</strong> |
-| --- | --- |
-| <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomInfo-class.html">RoomInfo</a> | 代表房间信息的核心数据模型，封装了房间的完整信息和状态管理能力。<br>核心功能包括：<br>- 房间基本信息管理（房间 ID、名称、创建者）。<br>- 实时状态跟踪（参与者数量、房间状态、创建时间）。<br>- 房间调度功能（预约时间、参会者列表、提醒设置）。<br>- 全面的权限控制（密码保护、设备管控、消息管理）。 |
-| <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomState-class.html">RoomState</a> | 代表房间状态管理的核心数据结构，负责维护用户的房间相关状态信息。<br>核心属性：<br>- <code>scheduledRoomList</code> 存储了当前账号下所有预约的房间列表信息。<br>- <code>scheduledRoomListCursor</code>  则代表预约房间列表的分页快照。<br>- <code>currentRoom</code> 则代表当前所在房间的状态信息。 |
-| <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener-class.html">RoomListener</a> | 代表房间动态的实时事件。主要事件分为两大类：预约房间事件和房间结束事件。 |
-| <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStore-class.html">RoomStore</a> | 这是与房间全生命周期相关的核心类。功能包含：获取预约房间列表快照、执行房间管理操作，并通过 <code>addRoomListener</code> 方法来接收实时动态事件。 |
-
-## 实现步骤
-
-### 步骤1：组件集成
-
-请参考 接入概览 集成 **AtomicXCore SDK**，并已完成 实现登录逻辑 部分接入。
-
-### 步骤2：**创建并加入房间**
-
-##### 实现方式：
-1. **配置房间初始化参数：**初始化`CreateRoomOptions`创建房间配置项设置房间名称，房间密码。
-
-2. **房间权限预设：**设置房间内全场成员权限，例如全体静音，全体禁画等。
-
-3. **创建并加入房间：**调用`RoomStore`的`createAndJoinRoom`接口执行核心操作。
-
-##### 示例代码：
-``` java
-import 'package:atomic_x_core/atomicxcore.dart';
-
-void createAndJoinRoom() async {
-  // 1. 配置房间初始化参数
-  // CreateRoomOptions 用于定义房间的基础属性及初始权限控制
-  final options = CreateRoomOptions(
-    roomName: '我的讨论会',        // 设置房间对外展示的名称
-    password: '',                 // 设置房间进入密码（若无需密码则留空）
-    // 2. 房间权限预设
-    isAllCameraDisabled: false,      // 全员开启/禁用摄像头的初始状态
-    isAllMessageDisabled: false,     // 全员开启/禁言的初始状态
-    isAllMicrophoneDisabled: false,  // 全员开启/静音的初始状态
-    isAllScreenShareDisabled: false, // 全员禁止/允许屏幕分享的初始状态
-  );
-
-  // 3. 创建并加入房间
-  // 该方法会自动处理房间创建（如果不存在）和加入逻辑
-  final result = await RoomStore.shared.createAndJoinRoom(
-    roomID: widget.roomID,
-    roomType: RoomType.standard,
-    options: options,
-  );
-
-  if (result.isSuccess) {
-    debugPrint('创建并加入房间成功');
-  } else {
-    debugPrint('创建并加入房间失败 [错误码: ${result.errorCode}]: ${result.errorMessage}');
-  }
-}
-```
-
-##### createAndJoinRoom 接口参数详细说明
-| 参数名 | 类型 | 必填 | 说明 |
-| --- | --- | --- | --- |
-| <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母（区分大小写）、下划线（_）和连字符（-）。避免使用空格和中文字符。 |
-| <code>roomType</code> | <code>String</code> | 是 | 房间类型<br>- standard：标准房间，所有成员可自由音视频互动。<br>- webinar：大型研讨会房间，区分嘉宾和观众角色，观众默认无上麦权限。 |
-| <code>options</code> | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/CreateRoomOptions-class.html">CreateRoomOptions</a> | 是 | 房间创建选项配置对象。 |
-
-##### CreateRoomOptions 结构体详细说明
-
-|参数名|类型|必填|默认值|说明|
-|---------|---------|---------|---------|---------|
-|roomName|String|否|""|房间名称。若不设置，系统可能会使用默认名称。|
-|password|String|否|""|房间密码。设置后，其他用户加入房间时需输入密码。|
-|isAllMicrophoneDisabled|bool|否|false|是否全员禁止开启麦克风。开启后，除房主/管理员外，普通参与者默认禁止打开麦克风。|
-|isAllCameraDisabled|bool|否|false|是否全员禁止开启摄像头。开启后，除房主/管理员外，普通参与者默认禁止打开摄像头。|
-|isAllScreenShareDisabled|bool|否|false|是否全员禁止发起屏幕共享。开启后，仅房主/管理员可进行屏幕共享。|
-|isAllMessageDisabled|bool|否|false|是否全员禁止发送聊天消息（禁言）。开启后，普通参与者无法在房间内发送文字消息。|
-
-### 步骤3：加入房间
-
-参与者需要加入房间时，调用`RoomStore`的`joinRoom`接口，即可加入房间，此时房间内其他参与者会收到参与者加入房间事件通知（[onParticipantJoined](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_participant_store/RoomParticipantListener/onParticipantJoined.html)）。
-``` java
-import 'package:atomic_x_core/atomicxcore.dart';
-
-Future<void> joinRoom() async {
-  // 调用 RoomStore 加入房间接口
-  // 该操作会验证房间是否存在、用户是否被禁入以及密码是否正确
-  final result = await RoomStore.shared.joinRoom(
-    roomID: targetRoomID,        // 目标房间 ID
-    roomType: RoomType.standard, // 目标房间类型
-    password: roomPassword,      // 房间密码，若房间未设置密码则传空字符串或null
-  );
-
-  if (result.isSuccess) {
-    print("加入房间成功");
-  } else {
-    print("加入房间失败 [错误码: ${result.errorCode}]: ${result.errorMessage}");
-  }
-}
-```
-
-##### joinRoom 接口参数详细说明
-| 参数名 | 类型 | 必填 | 说明 |
-| --- | --- | --- | --- |
-| <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母（区分大小写）、下划线（_）和连字符（-）。避免使用空格和中文字符。 |
-| <code>roomType</code> | <code>RoomType</code> | 是 | 房间类型<br>- standard：标准房间，所有成员可自由音视频互动。<br>- webinar：大型研讨会房间，区分嘉宾和观众角色，观众默认无上麦权限。 |
-| <code>password</code> | <code>String</code> | 否 | - 房间密码，空字符串 "" 通常表示该房间不设密码。<br>- 限制长度为 0-32 字节。<br>- 推荐使用 4-8 位纯数字，方便移动端输入。设置后，其他用户加入房间时需输入密码。建议不要存储明文敏感信息。 |
-
-### 步骤4：离开房间
-
-当参与者要离开房间时，通过调用`RoomStore`的`leaveRoom`接口即可离开房间，此时房间内其他参与者都会收到参与者离开房间事件通知（[onParticipantLeft](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_participant_store/RoomParticipantListener/onParticipantLeft.html)）。
-``` java
-import 'package:atomic_x_core/atomicxcore.dart';
-
-Future<void> leaveRoom() async {
-  // 1. 业务逻辑说明
-  // leaveRoom 接口用于普通成员或房主主动退出房间
-  // 与 endRoom 不同，房主调用 leaveRoom 只会让自己离开，房间依然存在
-
-  // 2. 调用 RoomStore 离开房间接口
-  // 该操作会停止音视频流传输，并通知服务器将当前用户移出房间
-  final result = await RoomStore.shared.leaveRoom();
-
-  if (result.code == 0) {
-    print("离开房间成功");
-  } else {
-    print("离开房间失败 [错误码: ${result.errorCode}]: ${result.errorMessage}");
-  }
-}
-
-```
-
-### **步骤5：结束房间**
-
-当房主期望结束房间时，调用`RoomStore`的`endRoom`接口即可结束当前房间。结束房间后，房间内的所有参与者都会收到房间结束事件（[onRoomEnded](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener/onRoomEnded.html)）。
-``` java
-import 'package:atomic_x_core/atomicxcore.dart';
-
-Future<void> endRoom() async {
-
-  // 1. 业务逻辑说明
-  // endRoom 接口用于永久解散当前房间
-  // 注意：该操作通常仅限房主（Owner）执行，解散后所有成员将被强制退出
-
-  // 2. 调用 RoomStore 解散房间接口
-  // 该方法会向服务器发送解散指令，并通知所有在线参与者房间已结束
-  final result = await RoomStore.shared.endRoom();
-
-  if (result.isSuccess) {
-    debugPrint('结束房间成功');
-  } else {
-    debugPrint('结束房间失败 [错误码: ${result.errorCode}]: ${result.errorMessage}');
-  }
-}
-```
-
-### **步骤6：更新房间信息**
-
-当房主期望更新房间名称或者更改房间密码时，调用`RoomStore`的`updateRoomInfo`接口即可更新房间信息。更新后房间内的参与者会收到房间状态变更通知。
-``` java
-import 'package:atomic_x_core/atomicxcore.dart';
-
-Future<void> updateRoomInfo() async {
-  // 1. 配置房间更新参数
-  // UpdateRoomOptions 用于定义需要更新的房间属性
-  final options = UpdateRoomOptions(
-    roomName: "新的会议室名称",  // 更新房间显示名称
-  );
-
-  // 2. 设置修改标志位
-  // modifyFlagList 用于指定具体要更新哪些字段
-  final modifyFlagList = [
-    UpdateRoomOptionsModifyFlag.roomName,  // 标记需要更新房间名称
-  ];
-
-  // 3. 调用 RoomStore 更新房间信息接口
-  // 该方法会向服务器提交更新请求，并同步给所有房间成员
-  final result = await RoomStore.shared.updateRoomInfo(
-    roomID: "roomID",
-    options: options,
-    modifyFlagList: modifyFlagList,
-  );
-
-  if (result.isSuccess) {
-    print("更新房间信息成功");
-  } else {
-    print("更新房间信息失败 [错误码: ${result.errorCode}]: ${result.errorMessage}");
-  }
-}
-
-```
-
-##### updateRoomInfo 接口参数详细说明
-| 参数名 | 类型 | 必填 | 说明 |
-| --- | --- | --- | --- |
-| <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母（区分大小写）、下划线（_）和连字符（-）。避免使用空格和中文字符。 |
-| <code>options</code> | <code>UpdateRoomOptions</code> | 是 | - 更新房间属性配置对象。<br>- 详细用法请参考：UpdateRoomOptions 结构体详细说明 |
-| <code>modifyFlag</code> | <code>UpdateRoomOptionsModifyFlag</code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>房间密码</strong>。<br>- 详细用法请参考：UpdateRoomOptionsModifyFlag 详细说明。 |
-
-**UpdateRoomOptions 结构体详细说明**
-| 参数名 | 类型 | 必填 | 说明 |
-| --- | --- | --- | --- |
-| <code>roomName</code> | <code>String</code> | 否 | - 房间名称，可以不设置，默认为空字符串。<br>- 限制长度为 0-60 字节。<br>- 支持中英文、数字、特殊字符。 |
-| <code>password</code> | <code>String</code> | 否 | - 房间密码，空字符串 "" 通常表示该房间不设密码。<br>- 限制长度为 0-32 字节。<br>- 推荐使用 4-8 位纯数字，方便移动端输入。设置后，其他用户加入房间时需输入密码。建议不要存储明文敏感信息。 |
-
-**UpdateRoomOptionsModifyFlag 详细说明**
-| 参数名 | 类型 | 必填 | 说明 |
-| --- | --- | --- | --- |
-| <code>roomName</code> | <code>int</code> | 否 | - 修改房间名称时的标识位。<br>- 当修改<code>UpdateRoomOptions</code>中的<code>roomName</code>后，需要同步向<code>modifyFlagList</code>中加入<code>roomName</code>标识位。 |
-| <code>password</code> | <code>int</code> | 否 | - 修改房间密码时的标识位。<br>- 当修改<code>UpdateRoomOptions</code>中的<code>password</code>后，需要同步向<code>modifyFlagList</code>中加入<code>password</code>标识位。 |
-
-### 步骤7：获取房间信息
-
-进入房间成功后调用`RoomStore`的`getRoomInfo`接口即可获取到房间详细信息。
-``` java
-import 'package:atomic_x_core/atomicxcore.dart';
-
-Future<void> getRoomInfo() async {
-  // 1. 业务逻辑说明
-  // getRoomInfo 接口用于获取指定房间的详细信息
-  // 可以获取房间名称、创建者、参与者数量、权限设置等完整信息
-
-  // 2. 调用 RoomStore 获取房间信息接口
-  // 该操作会从服务器获取最新的房间状态和配置信息
-  final result = await RoomStore.shared.getRoomInfo("roomID");
-
-  if (result.code == 0) {
-    print("获取房间信息成功，roomInfo: ${result.roomInfo}");
-  } else {
-    print("获取房间信息失败 [错误码: ${result.errorCode}]: ${result.errorMessage}");
-  }
-}
-```
-
-### 步骤8：监听房间实时事件及状态变化
-
-订阅`RoomEvent`房间内的被动事件。以订阅房间结束事件为例，示例代码如下：
-``` java
-import 'package:atomic_x_core/atomicxcore.dart';
-
-// RoomPage 代表房间主视图
-class RoomPage extends StatefulWidget {
-  const RoomPage({super.key});
-
-  @override
-  State<RoomPage> createState() => _RoomPageState();
-}
-
-class _RoomPageState extends State<RoomPage> {
-  // 房间事件监听器
-  late final RoomListener _roomListener;
-
-  @override
-  void initState() {
-    super.initState();
-
-    /// 创建监听器，设置各事件回调
-    _roomListener = RoomListener(
-      onRoomEnded: (roomInfo) {
-        print("房间已结束: ${roomInfo.roomName}");
-      },
-       // ... 处理其他 RoomListener 事件 ...
-    );
-
-    /// 调用此方法添加监听器，订阅房间被动事件
-    RoomStore.shared.addRoomListener(_roomListener);
-  }
-
-  @override
-  void dispose() {
-    // 调用此方法移除监听器，避免内存泄漏
-    RoomStore.shared.removeRoomListener(_roomListener);
-    super.dispose();
-  }
-}
-```
-
-订阅`RoomState`房间属性状态变化。以订阅当前所在房间信息变化为例，示例代码如下：
-``` java
-ValueListenableBuilder(
-  valueListenable: RoomStore.shared.state.currentRoom,
-  builder: (context, currentRoom, _) {
-    return Container();  // 需要监听房间信息的widget
-  },
-),
-```
-
-## API 文档
-| <strong>Store</strong> | <strong>功能描述</strong> | <strong>API文档</strong> |
-| --- | --- | --- |
-| <strong>RoomStore</strong> | 房间全生命周期管理：创建并加入 / 加入 / 离开 / 结束房间 / 更新、获取房间信息 / 房间预约 / 呼叫房间外成员 / 监听房间内被动事件（如房间解散，房间信息更新等）。 | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStore-class.html">API 文档</a> |
-
-## 常见问题
-
-### `RoomInfo` 中的参与人数（`participantCount`）是如何更新的？时机和频率是怎样的？
-
-`participantCount` 的更新并非总是实时的，其机制如下：
-- **主动进出房间**：当用户主动加入或正常退出房间时，参与人数的变更通知会即时触发。您会很快在 `RoomState` 中的`currentRoom`观察到 `participantCount` 的变化。
-
-- **异常掉线**：当用户因网络问题、应用崩溃等原因异常掉线时，系统需要通过心跳机制来判断其真实状态。只有当该用户连续 90 秒没有心跳后，系统才会判定其为离线，并触发人数变更通知。
-
-- **更新机制与频率控制：**
-
-  - 无论是即时触发还是延迟触发，所有的人数变更通知都是以消息的形式在房间内广播的。
-
-  - 房间内每秒的消息总量有上限，单房间消息频控是**每秒 40 条消息**。
-
-  - **关键点：**在“弹幕风暴”消息流量极高的场景下，如果房间内的消息速率超过了 40条/秒 的阈值，为了保证核心消息（例如弹幕）的送达，**人数变更的消息可能会被频控策略丢弃**。
-
-      **这对开发者意味着什么？**
-
-      `participantCount` 是一个非常接近实时的**高精度估算值**，但在极端高并发场景下，它可能存在短暂的延迟或数据丢失。因此，我们建议您将其用于 **UI 展示**，而不应作为计费、统计等需要绝对精准场景的唯一依据。

package/resource/knowledge/roomkit/core-sdk/flutter/schedule-room.md

@@ -1,325 +0,0 @@
-`RoomStore` 是 `AtomicXCore` 的房间管理核心模块，涵盖了预定房间体系。本章节详细介绍了如何利用 `RoomStore` 高效完成预定房间功能的开发与接入。
-
-## 核心功能
-- **预定、取消预定房间**：任何用户均可完成预定房间，取消预定房间功能。
-
-- **更新预定房间信息：**对已预定的房间进行房间信息更新，包含：房间名称，开始时间，结束时间。
-
-- **获取预定房间列表**：获取当前账户下所有预定的房间列表信息。
-
-- **获取预定房间的参与成员列表**：获取指定预定房间的参与成员列表信息。
-
-- **添加、移除预定房间参与成员**：对已预定的房间可以添加、移除参与成员。
-
-## 核心概念
-
-在开始集成之前，您可能需要通过下表了解一下`RoomStore`中与预定房间相关的几个核心概念：
-| <strong>核心概念</strong> | <strong>核心职责与描述</strong> |
-| --- | --- |
-| <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStatus.html">RoomStatus</a> | 代表当前房间的状态，包含：<code>scheduled</code>（预定状态），<code>running</code>（进行中）。 |
-| <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/ScheduleRoomOptions-class.html">ScheduleRoomOptions</a> | 代表预定房间的核心数据结构，包含：开始时间，结束时间，预定成员列表等。 |
-| <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomState-class.html">RoomState</a> | 代表房间状态管理的核心数据结构，负责维护用户的房间相关状态信息。<br>核心属性：<br>- <code>scheduledRoomList</code> 存储了当前账号下所有预定的房间列表信息。<br>- <code>scheduledRoomListCursor</code> 则代表预定房间列表的分页游标。 |
-| <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener-class.html">RoomListener</a> | 代表房间动态的实时事件。其中包含预定房间相关的事件。 |
-| <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStore-class.html">RoomStore</a> | 这是与房间全生命周期相关的核心类。通过它，您可以主动发起预定房间，获取预定房间列表等功能，并通过 <code>addRoomListener</code> 方法来接收与预定房间相关的实时动态事件。 |
-
-## 实现步骤
-
-### 步骤1：组件集成
-
-请参考 接入概览 集成 **AtomicXCore SDK**，并已完成 实现登录逻辑 部分接入。
-
-### 步骤2：预定房间功能
-
-#### **一、预定房间**
-
-##### 实现方式：
-1. **配置预定房间初始化参数：**初始化 `ScheduleRoomOptions` 预定房间配置项设置房间名称，房间密码、开始时间、结束时间、参与者、房间信息等。
-
-2. **房间权限预设：**设置房间内全场成员权限，例如全体静音，全体禁画等。
-
-3. **预定房间：**调用 `RoomStore` 的 `scheduleRoom` 接口执行核心操作。
-
-##### 示例代码：
-``` java
-import 'package:atomic_x_core/atomicxcore.dart';
-
-Future<void> scheduleRoom() async {
-  final startTime = DateTime.now().millisecondsSinceEpoch ~/ 1000 + 60 * 15; // 计算开始时间：当前时间 + 15分钟后开始
-  final endTime = startTime + 60 * 30; // 计算结束时间：开始时间 + 30分钟（房间持续30分钟）
-  final reminderSeconds = 60 * 5; // 设置提醒时间：房间开始前5分钟提醒
-
-  // 创建预定房间选项配置
-  final options = ScheduleRoomOptions(
-    roomName: "房间名称",
-    scheduleStartTime: startTime,
-    scheduleEndTime: endTime,
-    reminderSecondsBeforeStart: reminderSeconds,
-    scheduleAttendees: ["user01", "user02", "user03"], // 设置预定参与者列表（用户ID数组）
-    password: "房间密码", // 设置房间密码（可选，空字符串表示无密码）
-    isAllMicrophoneDisabled: false, // 设置是否默认禁用所有参与者的麦克风（false = 允许开启麦克风）
-    isAllCameraDisabled: false, // 设置是否默认禁用所有参与者的摄像头（false = 允许开启摄像头）
-    isAllScreenShareDisabled: false, // 设置是否默认禁用所有参与者的屏幕共享（false = 允许屏幕共享）
-    isAllMessageDisabled: false, // 设置是否默认禁用所有参与者的消息功能（false = 允许发送消息）
-  );
-
-  final result = await RoomStore.shared.scheduleRoom(
-    roomID: "roomID",
-    options: options,
-  );
-
-  if (result.isSuccess) {
-    print("预定房间成功");
-  } else {
-    print("预定房间失败: [错误码: ${result.errorCode}] ${result.errorMessage}");
-  }
-}
-```
-
-##### scheduleRoom 接口参数详细说明
-| 参数名 | 类型 | 必填 | 说明 |
-| --- | --- | --- | --- |
-| <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母（区分大小写）、下划线（_）和连字符（-）。避免使用空格和中文字符。 |
-| <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法请参考：ScheduleRoomOptions 结构体详细说明 |
-
-##### ScheduleRoomOptions 结构体详细说明
-| 参数名 | 类型 | 必填 | 说明 |
-| --- | --- | --- | --- |
-| roomName | String | 否 | - 房间名称，可以不设置，默认为空字符串。<br>- 限制长度为 0-60 字节。<br>- 支持中英文、数字、特殊字符。 |
-| password | String | 否 | - 房间密码，空字符串 <code>""</code> 通常表示该房间不设密码。<br>- 限制长度为 0-32 字节。<br>- 推荐使用 4-8 位纯数字，方便移动端输入。设置后，其他用户加入房间时需输入密码。建议不要存储明文敏感信息。 |
-| scheduleStartTime | int | 是 | - 预定的房间开始时间（Unix 时间戳，单位：秒）。<br>- 取值必须大于当前时间。<br>- 推荐设置为未来的整分时间。例如：1736164800（代表 2025-01-06 20:00:00）。 |
-| scheduleEndTime | int | 是 | - 预定的房间结束时间（Unix 时间戳，单位：秒）。<br>- 取值必须大于 scheduleStartTime。<br>- 建议根据预期时长设置。例如：scheduleStartTime + 3600（预定 1 小时时长的房间）。 |
-| reminderSecondsBeforeStart | int | 否 | - 房间开始前的提醒时间（单位：秒）。用于系统触发开始提醒。<br>- 推荐设置为 300（5分钟）或 900（15分钟），用于在 App 端触发本地通知。 |
-| scheduleAttendees | List<String> | 否 | - 预定参与者的用户 ID 列表，在预定房间时设置，系统将向这些用户发送预定邀请。<br>- 获取方式请参考 获取指定预定房间的参与成员列表。 |
-| isAllMicrophoneDisabled | bool | 否 | - 是否全员禁止打开麦克风。开启后，除房主/管理员外，普通参与者默认禁止打开麦克风。<br>- 参数含义：<br>- true : 禁止。<br>- false ：取消禁止 （默认值）。 |
-| isAllCameraDisabled | bool | 否 | - 是否全员禁止打开摄像头。开启后，除房主/管理员外，普通参与者默认禁止打开摄像头。<br>- 参数含义：<br>- true : 禁止。<br>- false ：取消禁止（默认值）。 |
-| isAllScreenShareDisabled | bool | 否 | - 是否全员禁止发起屏幕共享。开启后，仅房主/管理员可进行屏幕共享。<br>- 参数含义：<br>- true : 禁止。<br>- false ：取消禁止（默认值）。 |
-| isAllMessageDisabled | bool | 否 | - 是否全员禁止发送聊天消息（禁言）。开启后，普通参与者无法在房间内发送文字消息。<br>- 参数含义：<br>- true : 禁止。<br>- false ：取消禁止（默认值）。 |
-
-#### **二、取消房间预定**
-- **预定房间者：**调用`RoomStore`的`cancelScheduledRoom`接口，实现取消预定房间功能。
-
-   ``` java
-   import 'package:atomic_x_core/atomicxcore.dart';
-
-   Future<void> cancelScheduledRoom(String roomID) async {
-     final result = await RoomStore.shared.cancelScheduledRoom(roomID);
-
-     if (result.isSuccess) {
-       print("取消预定房间成功");
-     } else {
-       print("取消预定房间失败: [错误码: ${result.errorCode}] ${result.errorMessage}");
-     }
-   }
-   ```
-
-#### **三、更新预定房间**
-- **房间预定者：**调用`RoomStore`的`updateScheduledRoom`接口，实现更新预定**房间名称**、**开始时间**、**结束时间**。
-
-   ``` java
-   import 'package:atomic_x_core/atomicxcore.dart';
-
-   Future<void> updateScheduledRoom() async {
-     final newStartTime = DateTime.now().millisecondsSinceEpoch ~/ 1000 + 60 * 30; // 计算预定时间：当前时间 + 30分钟后开始
-     final newEndTime = newStartTime + 60 * 45; // 计算结束时间：开始时间 + 45分钟（房间持续45分钟）
-
-     final options = ScheduleRoomOptions(
-       roomName: "房间名称",
-       scheduleStartTime: newStartTime,
-       scheduleEndTime: newEndTime,
-     );
-
-     final modifyFlagList = [
-       ScheduleRoomOptionsModifyFlag.roomName,
-       ScheduleRoomOptionsModifyFlag.scheduleStartTime,
-       ScheduleRoomOptionsModifyFlag.scheduleEndTime,
-     ];
-
-     final result = await RoomStore.shared.updateScheduledRoom(
-       roomID: "roomID",
-       options: options,
-       modifyFlagList: modifyFlagList,
-     );
-
-     if (result.isSuccess) {
-       print("更新预定房间成功");
-     } else {
-       print("更新预定房间失败: [错误码: ${result.errorCode}] ${result.errorMessage}");
-     }
-   }
-   ```
-
-##### updateScheduledRoom 接口参数详细说明
-| 参数名 | 类型 | 必填 | 说明 |
-| --- | --- | --- | --- |
-| roomID | String | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母（区分大小写）、下划线（_）和连字符（-）。避免使用空格和中文字符。 |
-| options | ScheduleRoomOptions | 是 | - 预定房间配置对象。<br>- 详细用法请参考：ScheduleRoomOptions 结构体详细说明 |
-| modifyFlagList | List<ScheduleRoomOptionsModifyFlag> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>开始时间</strong>、<strong>结束时间。</strong><br>- 详细用法请参考：ScheduleRoomOptionsModifyFlag 详细说明。 |
-
-**ScheduleRoomOptionsModifyFlag 详细说明**
-| 参数名 | 说明 |
-| --- | --- |
-| <code>roomName</code> | - 修改预定房间名称时的标识位。<br>- 当修改<code>ScheduleRoomOptions</code>中的<code>roomName</code>后，需要同步向<code>modifyFlagList</code>中添加<code>roomName</code>标识位。 |
-| <code>scheduleStartTime</code> | - 修改预定房间开始时间时的标识位。<br>- 当修改<code>ScheduleRoomOptions</code>中的<code>scheduleStartTime</code>后，需要同步向<code>modifyFlagList</code>中添加<code>scheduleStartTime</code>标识位。 |
-| <code>scheduleEndTime</code> | - 修改预定房间结束时间时的标识位。<br>- 当修改<code>ScheduleRoomOptions</code>中的<code>scheduleEndTime</code>后，需要同步向<code>modifyFlagList</code>中添加<code>scheduleEndTime</code>标识位。 |
-
-#### **四、添加、删除参与成员**
-- **预定房间者：**调用 `RoomStore` 的 `addScheduledAttendees` 或者 `removeScheduledAttendees` 接口，可以为已预定的房间内批量添加或移除预定参与者。
-
-   ``` java
-   import 'package:atomic_x_core/atomicxcore.dart';
-
-   Future<void> addScheduledAttendees(String roomID, List<String> userIDList) async {
-     final result = await RoomStore.shared.addScheduledAttendees(
-       roomID: roomID,
-       userIDList: userIDList,
-     );
-
-     if (result.isSuccess) {
-       print("添加预定参与者成功");
-     } else {
-       print("添加预定参与者失败: [错误码: ${result.errorCode}] ${result.errorMessage}");
-     }
-   }
-
-   Future<void> removeScheduledAttendees(String roomID, List<String> userIDList) async {
-     final result = await RoomStore.shared.removeScheduledAttendees(
-       roomID: roomID,
-       userIDList: userIDList,
-     );
-
-     if (result.isSuccess) {
-       print("移除预定参与者成功");
-     } else {
-       print("移除预定参与者失败: [错误码: ${result.errorCode}] ${result.errorMessage}");
-     }
-   }
-   ```
-
-### 步骤3：获取预定房间列表
-- **任意用户：**调用`RoomStore`的`getScheduledRoomList`接口，均可获取到自己账号下所有预定的房间列表信息。
-
-   ``` java
-   import 'package:atomic_x_core/atomicxcore.dart';
-
-   /// 获取预定房间列表
-   Future<void> getScheduledRoomList({String? cursor}) async {
-     /// [cursor] 为分页游标，首次调用时传入 null，获取第一页数据， 后续调用时传入上次返回的 nextCursor 值
-     final result = await RoomStore.shared.getScheduledRoomList(cursor);
-
-     if (result.isSuccess) {
-       final roomList = result.data;
-       final nextCursor = result.cursor;
-       print("获取预定房间列表成功");
-     } else {
-       print("获取预定房间列表失败: [错误码: ${result.errorCode}] ${result.errorMessage}");
-     }
-   }
-   ```
-
-### 步骤4：获取指定预定房间的参与成员列表
-- **任意用户：**调用`RoomStore`的`getScheduledAttendees`接口，可获取到指定预定房间的参与成员列表信息。
-
-   ``` java
-   import 'package:atomic_x_core/atomicxcore.dart';
-
-   /// 获取预定房间的参与者列表
-   /// - [roomID]: 房间ID，用于标识要查询参与者列表的预定房间
-   /// - [cursor] 为分页游标，首次调用时传入 null，获取第一页数据， 后续调用时传入上次返回的 nextCursor 值
-   Future<void> getScheduledAttendees(String roomID, {String? cursor}) async {
-     final result = await RoomStore.shared.getScheduledAttendees(
-       roomID: roomID,
-       cursor: cursor,
-     );
-
-     if (result.isSuccess) {
-       final attendees = result.data;
-       final nextCursor = result.cursor;
-       print("获取预定房间参与者列表成功");
-     } else {
-       print("获取预定房间参与者列表失败: [错误码: ${result.errorCode}] ${result.errorMessage}");
-     }
-   }
-   ```
-
-### 步骤5：监听预定房间事件及状态
-- 订阅`RoomEvent`预定房间相关的被动事件，示例代码如下：
-
-   ``` java
-   import 'package:atomic_x_core/atomicxcore.dart';
-
-   late RoomListener _roomListener;
-
-   /// 订阅预定房间相关事件
-   void subscribeScheduledRoomEvents() {
-     _roomListener = RoomListener(
-       onAddedToScheduledRoom: (roomInfo) {
-         print("已被添加到预定房间 房间信息: $roomInfo");
-       },
-       onRemovedFromScheduledRoom: (roomInfo, operatorUser) {
-         print("已被移除预定房间 房间信息: $roomInfo, 移除者: $operatorUser");
-       },
-       onScheduledRoomCancelled: (roomInfo, operatorUser) {
-         print("预定房间被取消 房间信息: $roomInfo, 取消者: $operatorUser");
-       },
-       onScheduledRoomStartingSoon: (roomInfo) {
-         print("预定房间即将开始 房间信息: $roomInfo");
-       },
-       onRoomEnded: (roomInfo) {
-         print("房间已结束 房间信息: $roomInfo");
-       },
-     );
-
-     RoomStore.shared.addRoomListener(_roomListener);
-   }
-
-   /// 取消订阅预定房间相关事件
-   void unsubscribeScheduledRoomEvents() {
-     RoomStore.shared.removeRoomListener(_roomListener);
-   }
-   ```
-- 订阅`RoomState`预定房间列表状态变化，示例代码如下：
-
-   ``` java
-   import 'package:flutter/material.dart';
-   import 'package:atomic_x_core/atomicxcore.dart';
-
-   /// 订阅预定房间列表状态变化
-   Widget buildScheduledRoomListWidget() {
-     return ValueListenableBuilder(
-       valueListenable: RoomStore.shared.state.scheduledRoomList,
-       builder: (context, scheduledRoomList, child) {
-         print("预定房间列表变化 房间列表信息: $scheduledRoomList");
-
-         // 根据 scheduledRoomList 构建 UI
-         return Container();
-       },
-     );
-   }
-   ```
-
-## API 文档
-
-|**Store/Component**|**功能描述**|**API文档**|
-|---------|---------|---------|
-|**RoomStore**|房间全生命周期管理：创建并加入 / 加入 / 离开 / 结束房间 / 更新、获取房间信息 / 房间预定 / 呼叫房间外成员 / 监听房间内被动事件（例如房间解散，房间信息更新等）。|[API 文档](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStore-class.html)|
-
-## 常见问题
-
-### 当预定房间后，无法收到`RoomEvent`的`onScheduledRoomStartingSoon`事件。
-
-如果您在预定房间后未收到即将开始的事件通知，请按照以下两个核心要点进行检查：
-1. **检查提醒参数配置** (`reminderSecondsBeforeStart`)
-
-- 触发机制：`onScheduledRoomStartingSoon` 事件的触发高度依赖于预定配置类 `ScheduleRoomOptions` 中的 `reminderSecondsBeforeStart` 属性。
-
-- 默认行为：该属性的默认值为 0，代表“不开启提醒”。
-
-- 解决建议：请确保在预定房间时明确设置该参数。该参数单位为**秒**，表示在房间开始前多少秒推送事件通知。
-
-2. **验证预定时间逻辑**
-
-- 计算公式：系统触发提醒的前提是：预定开始时间 (`scheduleStartTime`) - 当前时间 > 提醒偏移量 (`reminderSecondsBeforeStart`)。
-
-- 场景说明：如果您的房间开始时间设置得过近（例如 5 分钟后开始），而提醒时间设置得过大（例如设置 10 分钟前提醒），系统将无法捕捉到触发时机，从而导致事件丢失。
-
-- 解决建议：请确保预定的开始时间距离当前时刻，大于您所设置的提醒秒数。