房间内人员管理
1. 功能介绍
房间内人员管理相关接口主要用于:
- 查询成员信息:获取当前房间中所有成员或指定成员的详细资料;
- 控制音频:打开 / 关闭自己或他人的麦克风,查询麦克风状态、能量;
- 控制视频:打开 / 关闭自己或他人的视频,查询视频状态;
- 成员事件通知:监听有人进入 / 离开房间的通知;
- 强制管理:将指定成员请出房间。
以上接口均通过 RTCMeeting 对象提供,使用前需确保已成功进入房间。
2. 获取房间中所有人员信息
- 调用接口:getAllMembers
- 功能:获取当前房间中所有成员的完整信息列表。
// 获取当前房间所有成员信息
NSMutableArray <MemberInfo *> *members = [[RTCMeeting shareInstance] getAllMembers];
- 相关结构体:
3. 获取房间中单人员信息
- 调用接口:getMemberInfo
- 功能:获取指定用户在当前房间中的详细信息。
NSString* userID = @"user_001";
MemberInfo *info = [[RTCMeeting shareInstance] getMemberInfo:info];
if (info)
{
// 获取成功,可使用 info 中的各字段
}
else
{
// 获取失败(例如用户已不在房间中)
}
- 相关结构体:
4. 开关自已或他人的麦克风
- 调用接口:
- 打开麦克风:openMic
- 关闭麦克风:closeMic
- 查询麦克风状态:getAudioStatus
- 查询说话能量:getMicEnergy
- 通知回调:
- 麦克风状态变化通知:audioStatusChanged
- 说话能量变化通知:micEnergyUpdate
NSString *selfID = @"my_uerid"; // 自己的用户ID
NSString *otherID = @"user_002"; // 需要控制的他人ID
// 打开自己的麦克风
[[RTCMeeting shareInstance] openMic:selfID];
// 作为主持人 / 管理员,打开或关闭他人的麦(前提是有相应权限)
[[RTCMeeting shareInstance] openMic:otherID];
// 或关闭他人的麦
[[RTCMeeting shareInstance] closeMic:otherID];
// 查询某人的麦克风状态
AUDIO_STATUS micStatus = [[RTCMeeting shareInstance] getAudioStatus:otherID];
// 获取某人在房间内的说话能量等级(0~9)
int energy = [[RTCMeeting shareInstance] getMicEnergy:otherID];
- 回调示例(监听麦克风状态变化):
- (void)audioStatusChanged:(NSString *)userID oldStatus:(AUDIO_STATUS)oldStatus newStatus:(AUDIO_STATUS)newStatus
{
// userID : 状态发生变化的用户
// oprUserID: 发起本次操作的用户(可能是本人,也可能是主持人)
// 在此更新 UI,例如显示谁被静音 / 解除静音
}
// 初始化时注册回调
[[RTCMeeting shareInstance] registerMeetingCallback:cb];
5. 开关自已或他人的视频
- 调用接口:
- 打开视频:openVideo
- 关闭视频:closeVideo
- 查询视频状态:getVideoStatus
- 通知回调:
- 视频状态变化通知:videoStatusChanged
NSString* selfID = g_sdkMain->getUserID();
NSString* otherID = "user_002";
// 打开自己的视频
[[RTCMeeting shareInstance] openVideo(selfID);
// 打开他人的视频(通常用于观看远端视频,需结合渲染 Canvas 使用)
[[RTCMeeting shareInstance] openVideo(otherID);
// 关闭自己的或他人的视频
[[RTCMeeting shareInstance] closeVideo(selfID);
[[RTCMeeting shareInstance] closeVideo(otherID);
// 查询视频状态
CRVIDEOSDK_VSTATUS vStatus = [[RTCMeeting shareInstance] getVideoStatus(otherID);
- 回调示例(监听视频状态变化):
- (void)videoStatusChanged:(NSString *)userID oldStatus:(VIDEO_STATUS)oldStatus newStatus:(VIDEO_STATUS)newStatus
{
// 根据 newStatus 更新该用户的视频图标 / 画面显示等
}
6. 有人进入房间通知
- 回调接口:userEnterMeeting
- 功能:当有其他用户成功进入当前房间时触发,用于更新成员列表、提示有人加入等。
// 有人进入房间
- (void)userEnterMeeting:(NSString *)userID
{
// userID 为新进入房间的用户ID
// 例如:刷新成员列表,弹出“某某进入房间”的提示
};
// 启动阶段注册回调
[[RTCMeeting shareInstance] registerMeetingCallback:cb];
进入房间成功时,房间中其他成员均会收到该回调。
7. 有人离开房间通知
- 回调接口:userLeftMeeting
- 功能:当有用户主动离开房间、掉线或被请出房间时触发,用于更新成员列表、布局等。
// 有人离开房间
- (void)userLeftMeeting:(NSString *)userID
{
// userID 为离开房间的用户ID
// 例如:从成员列表中移除,回收其视频窗口资源等
}
当因网络异常等原因导致用户掉线时,服务器在超时后也会触发离开房间通知。
8. 将他人请出房间
- 调用接口:kickout
- 回调接口:kickoutRslt、meetingDropped、userLeftMeeting
- 功能:将指定用户从当前房间中强制移除,常用于主持人踢人、违规用户处理等场景。
NSString* targetUserID = @"user_003";
// 作为主持人,将某人请出房间
[[RTCMeeting shareInstance] kickout:targetUserID];
// 请出结果回调
- (void)kickoutRslt:(CRVIDEOSDK_ERR_DEF)sdkErr userID:(NSString*)userID
{
if (sdkErr == CRVIDEOSDKERR_NOERR)
{
// 请出成功,可在本地做提示或更新 UI
}
else
{
// 请出失败,根据错误码给出相应提示
}
}
- 相关行为说明:
- 被请出用户会收到 meetingDropped 通知,原因值为 CRVIDEOSDK_DROPPED_KICKOUT;
- 房间中剩余成员(包括操作者)会收到 userLeftMeeting 通知;
- 应用层可据此弹出提示、更新房间 UI 布局等。