RoomParticipantStore 是 AtomicXCore 中专用于房间成员管理的模块。该模块为研讨会场景提供了核心能力,支持构建完整的成员管理体系。

功能介绍
研讨会成员管理模块涵盖了房间内用户信息展示以及权限处理的全套能力:
双角色列表展示: 动态呈现房间内嘉宾列表与观众列表,展示昵称、角色、音频状态。
嘉宾与观众互转: 支持将观众提升为嘉宾赋予发言权限,或将嘉宾降级为观众。
权限控制: 支持房主或管理员执行将成员移出房间、全员禁言等管理操作。
分级管理: 支持对房主、管理员、嘉宾及观众实现差异化的权限策略。
核心功能
获取嘉宾列表:获取当前房间内的嘉宾列表,嘉宾可以开启麦克风与其他嘉宾进行语音互动。
获取观众列表:获取当前房间内观众列表信息。
搜索房间内成员:搜索所在房间内的指定用户。
将观众提升为嘉宾:将观众提升为嘉宾,提升为嘉宾的用户可以开启麦克风与房间内其他的嘉宾互动。
将嘉宾降级为观众:将嘉宾降级为观众, 降级为观众的用户无法与房间内的嘉宾进行语音互动。
设置/撤销管理员:房主可以将房间其他成员设置为管理员,同时也可撤销房间内的管理员。
将成员移出房间:房主或者管理员可以将房间内任意一名成员移出房间。
核心概念
在开始集成之前,需要通过下表了解一下
RoomParticipantStore 相关的几个核心概念:核心概念 | 类型 | 核心职责与描述 |
struct | 代表嘉宾的核心数据模型,封装了嘉宾的完整信息和状态管理能力,可以开启/关闭 麦克风。 核心功能包括:嘉宾基本信息管理(用户 ID 、用户名称、用户头像、房间内角色身份)、设备状态管理(麦克风状态,摄像头状态,屏幕分享状态,消息状态)。 | |
struct | 代表房间内成员状态管理的核心数据结构,负责维护房间内成员相关状态信息。 核心属性: participantList 嘉宾列表。audienceList 观众列表。adminList 管理员列表。localParticipant 代表自身所在房间内的信息。 | |
enum | 代表房间内成员相关的实时事件。 | |
class | 这是成员控制相关的核心类。功能包含:控制房间内嘉宾音视频状态、执行成员管理,嘉宾观众角色切换等操作,并通过订阅其 participantEventPublisher 来接收实时事件。 |
实现步骤
步骤1:组件集成
步骤2:获取嘉宾列表
在加入房间后,调用
RoomParticipantStore 的 getParticipantList 接口获取到房间内嘉宾列表。import Foundationimport AtomicXCorefunc getParticipantList() {// 1. 业务逻辑说明// 前提:需要先完成进房操作,通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")// 2. 首次获取嘉宾列表(从头开始)// 支持分页加载,可以通过 cursor 参数实现增量获取var initialCursor: String? = nil // nil 表示从第一页开始获取participantStore.getParticipantList(cursor: initialCursor) { result inswitch result {case .success(let participantInfo):print("成功获取参与者列表,数量: \\(participantInfo.0.count)")case .failure(let error):print("获取参与者列表失败 [错误码: \\(error.code)]: \\(error.message)")}}}
步骤3:获取观众列表
在加入房间后,通过调用
RoomParticipantStore 的 getAudienceList 接口获取房间内的观众列表。import Foundationimport AtomicXCorefunc getAudienceList() {// 前提:需要先完成进房操作, 并且进房时 roomType 设置为 WEBINAR 类型。// 1. 业务逻辑说明// 通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")// 2. 首次获取观众列表(从头开始)// 支持分页加载,可以通过 cursor 参数实现增量获取let initialCursor: String? = nil // nil 表示从第一页开始获取participantStore.getAudienceList(cursor: initialCursor) { result inswitch result {case .success(let audienceInfo):print("获取观众列表成功,观众数量: \\(audienceInfo.0.count)")case .failure(let error):print("获取观众列表失败 [错误码: \\(error.code)]: \\(error.message)")}}}
步骤4:搜索房间内成员
进入房间成功后,可以通过调用
RoomParticipantStore 的 searchUsers 接口搜索房间内的成员。import Foundationimport AtomicXCorefunc searchUsers() {// 前提:需要先完成进房操作。// 1. 业务逻辑说明// 通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")// 2. 通过用户名称为关键字搜索房间内成员let keyword = "userName"participantStore.searchUsers(keyword: keyword) { result inswitch result {case .success(let usersInfo):print("搜索房间成员成功,成员数量: \\(usersInfo.0.count)")case .failure(let error):print("搜索房间成员失败 [错误码: \\(error.code)]: \\(error.message)")}}}
步骤5:将观众提升为嘉宾
作为房主或管理员,调用
RoomParticipantStore 的 promoteAudienceToParticipant 接口可以将房间内的观众提升成为嘉宾。import Foundationimport AtomicXCorefunc promoteAudienceToParticipant(userID: String) {// 前提:需要先完成进房操作。// 1. 业务逻辑说明// 通过进房的 roomID 创建 RoomParticipantStore 实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")// 2. 调用 RoomParticipantStore 提升观众为参与者接口// 注意:只有房主或管理员才有权限执行此操作。participantStore.promoteAudienceToParticipant(userID: userID) { result inswitch result {case .success():print("提升为参与者成功")case .failure(let error):print("提升为参与者失败 [错误码: \\(error.code)]: \\(error.message)")}}}
作为房间内成员订阅
RoomParticipantStore 的 participantEventPublisher 中的 onAudiencePromotedToParticipant 事件,被动接收观众提升为嘉宾的变化通知。import Foundationimport AtomicXCoreimport Combineprivate var cancellableSet = Set<AnyCancellable>()private func subscribeParticipantEvent() {// 1. 业务逻辑说明// 前提:需要先完成进房操作,通过进房的 roomID 创建 RoomParticipantStore 实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")// 2. 订阅参与者事件// participantEventPublisher 会推送所有参与者相关的事件participantStore.participantEventPublisher.receive(on: DispatchQueue.main) // 确保在主线程处理 UI 逻辑.sink { event inswitch event {case .onAudiencePromotedToParticipant(userInfo: let userInfo):print("观众被提升为参与者,userInfo: \\(userInfo)")default: break}}.store(in: &cancellableSet)}
步骤6:将嘉宾降级为观众
作为房主或管理员,调用
RoomParticipantStore 的 demoteParticipantToAudience 接口可以将房间内的嘉宾降级成为观众。import Foundationimport AtomicXCorefunc demoteParticipantToAudience(userID: String) {// 前提:需要先完成进房操作。// 1. 业务逻辑说明// 通过进房的 roomID 创建 RoomParticipantStore 实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")// 2. 调用 RoomParticipantStore 降级参与者为观众接口// 注意:只有房主或管理员才有权限执行此操作。participantStore.demoteParticipantToAudience(userID: userID) { result inswitch result {case .success():print("降级为观众成功")case .failure(let error):print("降级为观众失败 [错误码: \\(error.code)]: \\(error.message)")}}}
作为房间内成员订阅
RoomParticipantStore 的 participantEventPublisher 中的 onParticipantDemotedToAudience 事件,被动接收嘉宾降级为观众的变化通知。import Foundationimport AtomicXCoreimport Combineprivate var cancellableSet = Set<AnyCancellable>()private func subscribeParticipantEvent() {// 1. 业务逻辑说明// 前提:需要先完成进房操作,通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")// 1. 订阅参与者事件// participantEventPublisher 会推送所有参与者相关的事件participantStore.participantEventPublisher.receive(on: DispatchQueue.main) // 确保在主线程处理 UI 逻辑.sink { event inswitch event {case .onParticipantDemotedToAudience(userInfo: let userInfo):print("参与者被降级为观众,userInfo: \\(userInfo)")default: break}}.store(in: &cancellableSet)}
步骤7:设置/撤销管理员
作为房主,调用
RoomParticipantStore 的 setAdmin 接口,指定房间内任意一位用户为管理员,也可以将管理员身份撤销。import Foundationimport AtomicXCore// 业务逻辑说明// 前提:需要先完成进房操作,通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")/// 设置用户为管理员func setUserAsAdmin(userID: String) {participantStore.setAdmin(userID: userID) { result inswitch result {case .success:print("成功设置用户 \\(userID) 为管理员")case .failure(let error):print("设置管理员失败 [错误码: \\(error.code)]: \\(error.message)")}}}/// 撤销用户的管理员权限func revokeUserAdmin(userID: String) {participantStore.revokeAdmin(userID: userID) { result inswitch result {case .success:print("成功撤销用户 \\(userID) 的管理员权限")case .failure(let error):print("撤销管理员失败 [错误码: \\(error.code)]: \\(error.message)")}}}
订阅
RoomParticipantStore 的 participantEventPublisher 中的 onAdminSet 和 onAdminRevoked 事件,被动接收身份变化通知。import Foundationimport AtomicXCoreimport Combine// 业务逻辑说明// 前提:需要先完成进房操作,通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")private var cancellableSet = Set<AnyCancellable>()/// 订阅参与者相关事件private func subscribeParticipantEvents() {participantStore.participantEventPublisher.receive(on: DispatchQueue.main) // 确保在主线程处理UI相关逻辑.sink { event inswitch event {case .onAdminSet(let userInfo):print("设置管理员事件通知,userInfo: \\(userInfo)")case .onAdminRevoked(let userInfo):print("撤销管理员事件通知,userInfo: \\(userInfo)")default: break}}.store(in: &cancellableSet)}
步骤8:将成员移出房间
作为房主和管理员,调用
RoomParticipantStore 的 kickUser 可以将房间内成员移出房间。import Foundationimport AtomicXCore// 业务逻辑说明// 前提:需要先完成进房操作,通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")func kickUser(userID: String) {// 1. 业务逻辑说明// kickUser 接口用于将指定用户移出房间// 注意:只有房主或管理员才有权限执行此操作// 被移出的用户将立即离开房间,并收到相应的通知// 2. 调用 RoomParticipantStore 移出用户接口participantStore.kickUser(userID: userID) { result inswitch result {case .success():print("用户移出成功,被移出用户: \\(userID)")case .failure(let error):print("移出用户失败 [错误码: \\(error.code)]: \\(error.message)")}}}
订阅
RoomParticipantStore 的 participantEventPublisher 中的 onKickedFromRoom 事件,被动接收自己被移出房间通知。import Foundationimport AtomicXCoreimport Combine// 业务逻辑说明// 前提:需要先完成进房操作,通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")private var cancellableSet = Set<AnyCancellable>()/// 订阅参与者相关事件private func subscribeParticipantEvent() {participantStore.participantEventPublisher.receive(on: DispatchQueue.main) // 确保在主线程处理UI相关逻辑.sink { event inswitch event {case .onKickedFromRoom(let reason, let message):print("已被移出房间,被移出原因:\\(reason), 额外信息:\\(message)")default:break}}.store(in: &cancellableSet)}
步骤9:关闭嘉宾媒体设备
作为房主和管理员,调用
RoomParticipantStore 的 closeParticipantDevice 可以主动关闭嘉宾的摄像头,麦克风。import Foundationimport AtomicXCore// 业务逻辑说明// 前提:需要先完成进房操作,通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")func closeParticipantDevice(userID: String, device: DeviceType) {// 1. 业务逻辑说明// closeParticipantDevice 接口用于房主或管理员关闭指定参与者的某个设备// 被关闭的用户会收到设备被关闭通知// 2. 调用 RoomParticipantStore 关闭参与者设备接口participantStore.closeParticipantDevice(userID: userID, device: device) { result inswitch result {case .success():print("关闭参与者设备成功 - 用户: \\(userID), 设备: \\(device)")case .failure(let error):print("关闭参与者设备失败: [错误码: \\(error.code)]: \\(error.message)")}}}
说明:
closeParticipantDevice 仅对嘉宾生效,观众无音视频设备权限,无需执行此操作。订阅
RoomParticipantStore 的 RoomParticipantListener 中的 onParticipantDeviceClosed 事件,被动接收设备被关闭通知,并在UI上做出提示。import Foundationimport AtomicXCoreimport Combine// 业务逻辑说明// 前提:需要先完成进房操作,通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")private var cancellableSet = Set<AnyCancellable>()/// 订阅参与者相关事件private func subscribeDeviceClosedEvent() {participantStore.participantEventPublisher.receive(on: DispatchQueue.main) // 确保在主线程处理UI相关逻辑.sink { event inswitch event {case .onParticipantDeviceClosed(let device, let operatorUser):print("设备被关闭 - 设备: \\(device), 操作者: \\(operatorUser.userName)")default:break}}.store(in: &cancellableSet)}
步骤10:管理会中聊天权限
作为房主和管理员,调用
RoomParticipantStore 的 disableUserMessage 对指定用户进行单独禁言操作,被禁言的用户将记录在 messageDisabledUserList 中。import Foundationimport AtomicXCoreimport Combine// 业务逻辑说明// 前提:需要先完成进房操作,通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")private var cancellableSet = Set<AnyCancellable>()func disableUserMessage(userID: String, disable: Bool) {// 1. 业务逻辑说明// disableUserMessage 接口用于房主或管理员 禁用/解禁 指定成员聊天// 被 禁用/解禁 的用户会收到聊天被 禁用/解禁 通知// 2. 调用 RoomParticipantStore 禁用/解禁 成员聊天接口participantStore.disableUserMessage(userID: userID, disable: disable) { result inswitch result {case .success():print("\\(disable ? "禁用" : "启用") 成功 - 用户: \\(userID)")case .failure(let err):print("\\(disable ? "禁用" : "启用") 用户聊天失败 - 错误码: \\(err.code), 错误信息: \\(err.message)")}}}
说明:
messageDisabledUserList 仅在研讨会(Webinar)房间中有效,记录当前被单独禁言的用户列表。订阅
RoomParticipantStore 的 participantEventPublisher 中的 onUserMessageDisabled 事件,被动接收聊天被禁止/解禁 通知,并在UI上做出提示。import Foundationimport AtomicXCoreimport Combine// 业务逻辑说明// 前提:需要先完成进房操作,通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")private var cancellableSet = Set<AnyCancellable>()/// 订阅参与者相关事件private func subscribeDeviceClosedEvent() {participantStore.participantEventPublisher.receive(on: DispatchQueue.main) // 确保在主线程处理UI相关逻辑.sink { event inswitch event {case .onUserMessageDisabled(let disable, let user):print("用户信息被\\(disable ? "禁用" : "启用"), 操作者: \\(user.userName)")default:break}}.store(in: &cancellableSet)}
步骤11:全体静音、全体禁画
作为房主和管理员,调用
RoomParticipantStore 的 disableAllDevices 接口设置全员静音,全员禁用摄像头,全员禁用屏幕分享。开启后,房间内嘉宾的音视频开启权限将被限制,无法自主打开麦克风/摄像头/屏幕分享。import Foundationimport AtomicXCore// 业务逻辑说明// 前提:需要先完成进房操作,通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")func disableAllDevices(device: DeviceType, disable: Bool) {// 1. 业务逻辑说明// disableAllDevices 接口用于房主或管理员设置房间禁用、解禁房间内全体成员麦克风,摄像头// 设置后房间内参与者会收到禁用、解禁通知// 2. 调用 RoomParticipantStore 禁用、解禁全体设备接口participantStore.disableAllDevices(device: device, disable: disable) { result inswitch result {case .success():let action = disable ? "禁用" : "启用"print("\\(action)所有\\(device)成功")case .failure(let error):let action = disable ? "禁用" : "启用"print("\\(action)所有\\(device)失败 [错误码: \\(error.code)]: \\(error.message)")}}}
订阅
RoomParticipantStore 的 participantEventPublisher 中的 onAllDevicesDisabled 事件,可以监听全员静音或禁画指令,并在 UI 界面同步受控状态。受限状态下,摄像头与麦克风的主动开启功能将被锁定,参与者需发起开启申请,待房主或管理员核准授权后方可使用。import Foundationimport AtomicXCoreimport Combine// 业务逻辑说明// 前提:需要先完成进房操作,通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")private var cancellableSet = Set<AnyCancellable>()/// 设置全局设备事件监听private func subscribeAllDevicesDisabledEvent() {participantStore.participantEventPublisher.receive(on: DispatchQueue.main) // 确保在主线程处理UI相关逻辑.sink { event inswitch event {case .onAllDevicesDisabled(let device, let disable, let operatorUser):let action = disable ? "禁用" : "启用"print("所有\\(device)被\\(action) - 操作者: \\(operatorUser.userName)")default:break}}.store(in: &cancellableSet)}
步骤12:全体禁止聊天
作为房主和管理员,调用
RoomParticipantStore 的 disableAllMessages 接口设置全员禁止聊天。开启后,房间内成员聊天信息将被限制。import Foundationimport AtomicXCore// 业务逻辑说明// 前提:需要先完成进房操作,通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")func disableAllMessages(disable: Bool) {// 1. 业务逻辑说明// disableAllMessages 接口用于房主或管理员设置房间禁用、解禁房间内全体成员聊天// 设置后房间内成员会收到禁用、解禁通知// 2. 调用 RoomParticipantStore 禁用、解禁全体成员聊天participantStore.disableAllMessages(disable: disable) { result inswitch result {case .success():let action = disable ? "禁用" : "启用"print("全体成员发言\\(action)成功")case .failure(let error):let action = disable ? "禁用" : "启用"print("全体成员发言\\(action)失败 [错误码: \\(error.code)]: \\(error.message)")}}}
订阅
RoomParticipantStore 的 participantEventPublisher 中 onAllMessagesDisabled 事件。import Foundationimport AtomicXCoreimport Combine// 业务逻辑说明// 前提:需要先完成进房操作,通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")private var cancellableSet = Set<AnyCancellable>()/// 设置全局设备事件监听private func subscribeAllDevicesDisabledEvent() {participantStore.participantEventPublisher.receive(on: DispatchQueue.main) // 确保在主线程处理UI相关逻辑.sink { event inswitch event {case .onAllMessagesDisabled(let disable, let operatorUser):let action = disable ? "禁用" : "启用"print("聊天被\\(action) - 操作者: \\(operatorUser.userName)")default:break}}.store(in: &cancellableSet)}
步骤13:监听事件
订阅
RoomParticipantEvent 事件。以订阅设备请求为例,示例代码如下:import Foundationimport AtomicXCoreimport Combine// 业务逻辑说明// 前提:需要先完成进房操作,通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")private var cancellableSet = Set<AnyCancellable>()/// 设置全局设备事件监听private func subscribeAllDevicesDisabledEvent() {participantStore.participantEventPublisher.receive(on: DispatchQueue.main) // 确保在主线程处理UI相关逻辑.sink { event inswitch event {case .onDeviceRequestReceived(let request):print("设备请求 - 设备类型: \\(request.device), 用户: \\(request.senderUserID)")default:break}}.store(in: &cancellableSet)}
订阅
RoomParticipantState 成员相关的属性状态变化。以订阅房间内正在说话的用户为例,示例代码如下:import Foundationimport AtomicXCoreimport Combine// 业务逻辑说明// 前提:需要先完成进房操作,通过进房的roomID创建RoomParticipantStore实例let participantStore = RoomParticipantStore.create(roomID: "webinar_123456")private var cancellableSet = Set<AnyCancellable>()/// 设置参与者状态监听private func subscribeParticipantState() {participantStore.state.subscribe(StatePublisherSelector(keyPath: \\.speakingUsers)).map { $0 }.removeDuplicates { oldValue, newValue in// 比较两个字典是否相同,避免重复处理return oldValue == newValue}.receive(on: DispatchQueue.main).sink { speakingUsers inprint("说话用户状态变更 - 当前说话用户数: \\(speakingUsers.count)")}.store(in: &cancellableSet)}
API 文档
Store/Component | 功能描述 | API 文档 |
RoomParticipantStore | 房间内成员管理:设置管理员 / 转移房主 / 获取嘉宾列表 / 移出房间 / 嘉宾设备控制(例如关闭、邀请打开麦克风等)。 |