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