房间内人员管理
1. 功能介绍
房间内人员管理相关接口主要用于:
- 查询成员信息:获取当前房间中所有成员或指定成员的详细资料;
- 控制音频:打开 / 关闭自己或他人的麦克风,查询麦克风状态、能量;
- 控制视频:打开 / 关闭自己或他人的视频,查询视频状态;
- 成员事件通知:监听有人进入 / 离开房间的通知;
- 强制管理:将指定成员请出房间。
以上接口均通过 RTCSDK 实例提供,使用前需确保已成功进入房间。
2. 获取房间中所有人员信息
- 调用接口:getAllMembers
- 功能:获取当前房间中所有成员的完整信息列表。
const rtcsdk = new RTCSDK();
const members = rtcsdk.getAllMembers();
// members 为数组,每项包含 userID、nickName、isHost 等字段
members.forEach((mb) => {
console.log(mb.userID, mb.nickName);
});
- 相关结构体:MemberInfo
3. 获取房间中单人员信息
- 调用接口:getMemberInfo
- 功能:获取指定用户在当前房间中的详细信息。
const rtcsdk = new RTCSDK();
const info = rtcsdk.getMemberInfo("user_001");
if (info) {
console.log(info.nickName, info.isHost);
}
- 相关结构体:MemberInfo
4. 开关自己或他人的麦克风
- 调用接口:
- 打开麦克风:openMic
- 关闭麦克风:closeMic
- 查询麦克风状态:getMicStatus
- 查询说话能量:getUserMicEnergy
const rtcsdk = new RTCSDK();
const selfID = "my_userid";
const otherID = "user_002";
// 打开自己的麦克风
rtcsdk.openMic(selfID);
// 作为主持人/管理员,打开或关闭他人的麦
rtcsdk.openMic(otherID);
rtcsdk.closeMic(otherID);
// 查询某人的麦克风状态
const micStatus = rtcsdk.getMicStatus(otherID);
// 获取某人在房间内的说话能量等级(0~9)
const energy = rtcsdk.getUserMicEnergy(otherID);
- 回调示例(监听麦克风状态变化):
rtcsdk.on('notifyMicStatusChanged', (data) => {
const { userID, oldStatus, newStatus, operatorID } = data;
// 在此更新 UI,例如显示谁被静音 / 解除静音
});
5. 开关自己或他人的视频
- 调用接口:
- 打开视频:openVideo
- 关闭视频:closeVideo
- 查询视频状态:getVideoStatus
const rtcsdk = new RTCSDK();
const selfID = "my_userid";
const otherID = "user_002";
// 打开自己的视频
rtcsdk.openVideo(selfID);
// 打开他人的视频(用于观看远端视频)
rtcsdk.openVideo(otherID);
// 查询视频状态
const vStatus = rtcsdk.getVideoStatus(otherID);
- 回调示例(监听视频状态变化):
rtcsdk.on('notifyVideoStatusChanged', (data) => {
const { userID, oldStatus, newStatus } = data;
// 根据 newStatus 更新该用户的视频图标 / 画面显示等
});
6. 有人进入房间通知
rtcsdk.on('notifyUserEnterMeeting', (data) => {
const { userID } = data;
// 例如:刷新成员列表,弹出"某某进入房间"的提示
});
7. 有人离开房间通知
rtcsdk.on('notifyUserLeftMeeting', (data) => {
const { userID } = data;
// 从成员列表中移除,回收其视频窗口资源等
});
8. 将他人请出房间
- 调用接口:kickout
- 回调接口:kickoutRslt
const rtcsdk = new RTCSDK();
rtcsdk.kickout("user_003");
rtcsdk.on('kickoutRslt', (data) => {
const { sdkErr, userID } = data;
if (sdkErr === 0) {
// 请出成功
}
});
- 被请出用户会收到 notifyMeetingDropped 通知;
- 房间中剩余成员会收到 notifyUserLeftMeeting 通知。