一、核心功能
·会中呼叫：房间内任意参与者均可呼叫房间外任意成员加入房间。
·获取会中呼叫用户列表：可以获取指定房间的会中呼叫的用户列表。
二、核心概念
在开始集成之前，需要通过下表了解一下 RoomStore 中与会中呼叫相关的几个核心概念：
| 核心概念 | 核心职责与描述 |
| RoomCallStatus | 代表会中呼叫的状态，包含：none（默认态）。calling（呼叫中）。timeout（呼叫超时）。rejected（呼叫被拒绝）。 |
| RoomCallResult | 代表会中呼叫的结果，包含：success（呼叫成功）。alreadyInCalling（已在呼叫中）。alreadyInRoom（已在房间中）。 |
| CallRejectionReason | 代表呼叫被拒绝的原因，目前仅支持：rejected（主动拒绝）。inOtherRoom（在其他房间中）。 |
| RoomCall | 代表会中呼叫业务的核心数据结构。负责存储呼叫者信息、被呼叫者信息、以及当前呼叫状态。 |
| RoomListener | 代表房间动态的实时事件。其中包含会中呼叫相关的事件。 |
| RoomStore | 这是与房间全生命周期相关的核心类。功能包含：发起会中呼叫，响应会中呼叫，获取房间的会中呼叫列表，并通过订阅其 RoomListener 来接收与会中呼叫相关的实时动态事件。 |
三、步骤1：组件集成
请参考 接入概览 集成 AtomicXCore SDK，并已完成 实现登录逻辑 部分接入。
四、1. 发起呼叫
作为呼叫方调用 RoomStore 的 callUserToRoom 接口，可以批量呼叫用户进房。
import 'package:atomic_x_core/atomicxcore.dart';Future<void> callUserToRoom({ required List<String> userIDList, int timeout = 30, String? extensionInfo,}) async { final result = await RoomStore.shared.callUserToRoom( roomID: "roomID", userIDList: userIDList, timeout: timeout, extensionInfo: extensionInfo, ); if (result.isSuccess) { print("呼叫用户请求发送成功"); } else { print("呼叫用户失败: [错误码: ${result.errorCode}]: ${result.errorMessage}"); }}
五、2. 取消呼叫
作为呼叫方调用 RoomStore 的 cancelCall 接口，可以批量取消正在呼叫的申请。
import 'package:atomic_x_core/atomicxcore.dart';Future<void> cancelCall(List<String> userIDList) async { final result = await RoomStore.shared.cancelCall( roomID: "roomID", userIDList: userIDList, ); if (result.isSuccess) { print("取消呼叫成功"); } else { print("取消呼叫失败: [错误码: ${result.errorCode}]: ${result.errorMessage}"); }}
六、3. 获取呼叫列表信息
进入房间后，调用 RoomStore 的 getPendingCalls 接口，可以分页查询当前房间正在呼叫的用户列表信息。
import 'package:atomic_x_core/atomicxcore.dart';Future<void> getPendingCalls(String roomID, String? cursor) async { // cursor 为分页游标，首次调用时传入 null，获取第一页数据，后续调用时传入上次返回的 cursor 值。 final result = await RoomStore.shared.getPendingCalls( roomID: roomID, cursor: cursor, ); if (result.isSuccess) { print("获取呼叫列表成功，列表信息: ${result.data}, 分页游标: ${result.cursor}"); } else { print("获取呼叫列表失败: [错误码: ${result.errorCode}]: ${result.errorMessage}"); }}
七、4. 订阅会中呼叫事件
作为呼叫方订阅 RoomStore 的 RoomListener 能够实时获取呼叫的生命周期事件。通过监听以下回调，可以精准捕捉呼叫的最终结果并据此更新 UI 状态或执行后续业务逻辑。
import 'package:atomic_x_core/atomicxcore.dart';late RoomListener _listener;/// 订阅会中呼叫相关事件void addRoomCallListener() { _listener = RoomListener( onCallTimeout: (roomInfo, call) { print("呼叫超时 房间信息: ${roomInfo.roomID}, 呼叫者: ${call.caller.userID}"); }, onCallAccepted: (roomInfo, call) { print("呼叫已被接受 房间信息: ${roomInfo.roomID}, 被呼叫者: ${call.callee.userID}"); }, onCallRejected: (roomInfo, call, reason) { print("呼叫被拒绝 房间信息: ${roomInfo.roomID}, 被呼叫者: ${call.callee.userID}, 拒绝原因: $reason"); }, ); RoomStore.shared.addRoomListener(_listener);}void removeRoomCallListener() { RoomStore.shared.removeRoomListener(_listener);}
呼叫事件函数详细说明
| 事件函数 | 触发时机与说明 |
| onCallTimeout | 呼叫超时。当呼叫请求在预设的时间内（由调用 callUserToRoom 时指定）未得到被呼叫方的响应时触发。此时，呼叫自动结束，呼叫方通常需要提示“对方无人接听”。 |
| onCallAccepted | 呼叫被接受。被呼叫方主动点击了“接听”或“接受”按钮。收到此回调后，表示被呼叫者即将进入房间，呼叫方应更新 UI 状态，例如将该用户从“呼叫中”列表移除，并等待后续的成员进房通知来刷新成员列表。 |
| onCallRejected | 呼叫被拒绝。被呼叫方主动拒绝了通话请求，或者因为被呼叫方当前正处于其他房间中而自动拒绝。回调中通常包含拒绝原因（如主动拒绝或在其他房间中）。 |
八、1. 订阅会中呼叫事件
作为被呼叫方订阅 RoomStore 的 RoomListener 可以实时监听并响应来自呼叫方的呼叫行为。以下是构建呼叫提醒界面以及维护呼叫链路状态的关键事件。
import 'package:atomic_x_core/atomicxcore.dart';late RoomListener _listener;/// 订阅会中呼叫相关事件void addRoomCallListener() { _listener = RoomListener( onCallReceived: (roomInfo, call, extensionInfo) { print("收到房间呼叫 房间信息: ${roomInfo.roomID}, 呼叫者: ${call.caller.userID}, 扩展信息: $extensionInfo"); }, onCallCancelled: (roomInfo, call) { print("呼叫被取消 房间信息: ${roomInfo.roomID}, 呼叫者: ${call.caller.userID}"); }, onCallRevokedByAdmin: (roomInfo, call, operatorUser) { print("呼叫被管理员移除 房间信息: ${roomInfo.roomID}, 呼叫者: ${call.caller.userID}, 移除操作者: ${operatorUser.userID}"); }, onCallHandledByOtherDevice: (roomInfo, isAccepted) { print("呼叫已被其他设备处理 房间信息: ${roomInfo.roomID}, 处理结果: $isAccepted"); }, ); RoomStore.shared.addRoomListener(_listener);}void removeRoomCallListener() { RoomStore.shared.removeRoomListener(_listener);}
事件函数详细说明
| 事件函数 | 触发时机与说明 |
| onCallReceived | 收到呼叫邀请。当有其他用户向你发起入会邀请时触发。收到此回调后，被呼叫方通常应立即弹出“呼叫提醒”界面，展示呼叫者信息、房间信息，并提供“接听”和“拒绝”按钮。 |
| onCallCancelled | 呼叫被发起方取消。呼叫方在你未做出响应前，主动撤回了呼叫请求。收到此回调后，被呼叫方应立即关闭当前的来电界面，并提示“对方已取消呼叫”，以恢复应用正常操作流程。 |
| onCallRevokedByAdmin | 呼叫被管理员撤销。房间管理员或后台系统因权限变更、房间解散等原因强行终止了该笔呼叫邀请。收到此通知后，被呼叫方需立即停止呼叫流程并隐藏相关 UI，处理逻辑通常类似于呼叫被取消。 |
| onCallHandledByOtherDevice | 呼叫已在其他设备处理。当用户在多个设备（例如手机和 iPad）同时登录时，如果呼叫已在其中一台设备上被处理（接受或拒绝），当前设备会收到此通知，用于同步 UI 状态并自动消除呼叫界面。 |
九、2. 接受呼叫、拒绝呼叫
作为被呼叫方调用 RoomStore 的 acceptCall 或者 rejectCall 接口，处理接受或者拒绝呼叫邀请。
import 'package:atomic_x_core/atomicxcore.dart';late RoomListener _listener;/// 订阅会中呼叫相关事件void addRoomCallListener() { _listener = RoomListener( onCallReceived: (roomInfo, call, extensionInfo) { print("收到房间呼叫 房间信息: ${roomInfo.roomID}, 呼叫者: ${call.caller.userID}, 扩展信息: $extensionInfo"); // 接受、拒绝呼叫邀请操作 }, ); RoomStore.shared.addRoomListener(_listener);}void removeRoomCallListener() { RoomStore.shared.removeRoomListener(_listener);}// 接受呼叫邀请Future<void> acceptCall(String roomID) async { final result = await RoomStore.shared.acceptCall(roomID); if (result.isSuccess) { print("接受呼叫成功，房间ID: $roomID"); } else { print("接受呼叫失败: [错误码: ${result.errorCode}] ${result.errorMessage}"); }}// 拒绝呼叫邀请Future<void> rejectCall(String roomID, {CallRejectionReason reason = CallRejectionReason.rejected}) async { final result = await RoomStore.shared.rejectCall( roomID: roomID, reason: reason, ); if (result.isSuccess) { print("拒绝呼叫成功，房间ID: $roomID"); } else { print("拒绝呼叫失败: [错误码: ${result.errorCode}] ${result.errorMessage}"); }}
十、API 文档
| Store/Component | 功能描述 | API 文档 |
| RoomStore | 房间全生命周期管理：创建并加入 / 加入 / 离开 / 结束房间 / 更新、获取房间信息 / 预定房间 / 呼叫房间外成员 / 监听房间内被动事件（例如房间解散，房间信息更新等）。 | API 文档 |
十一、联系我们
如果你在接入或使用过程中有任何疑问或者建议，欢迎 联系我们 提交反馈。