房间内人员管理
1. 功能介绍
房间内人员管理相关接口主要用于:
- 查询成员信息:获取当前房间中所有成员或指定成员的详细资料;
- 控制音频:打开 / 关闭自己或他人的麦克风,查询麦克风状态、能量;
- 控制视频:打开 / 关闭自己或他人的视频,查询视频状态;
- 成员事件通知:监听有人进入 / 离开房间的通知;
- 强制管理:将指定成员请出房间。
以上接口均通过 CrSDK 提供,使用前需确保已成功进入房间。
2. 获取房间中所有人员信息
- 调用接口:getAllMembers
- 功能:获取当前房间中所有成员的完整信息列表。
import { CrSDK } from '@cr/react-native-rtc';
const mems = await CrSDK.instance.getAllMembers();
- 相关结构体:MemberInfo
3. 获取房间中单人员信息
- 调用接口:getMemberInfo
- 功能:获取指定用户在当前房间中的详细信息。
const userID = 'user_001';
const info = await CrSDK.instance.getMemberInfo(userID);
- 相关结构体:MemberInfo
4. 开关自已或他人的麦克风
调用接口:
- 打开麦克风:openMic
- 关闭麦克风:closeMic
- 查询麦克风状态:getAudioStatus
- 查询说话能量:getMicEnergy
通知回调:
- 麦克风状态变化通知:onAudioStatusChanged
- 说话能量变化通知:onMicEnergyUpdate
const selfID = 'my_userid'; // 自己的用户ID
const otherID = 'user_002'; // 需要控制的他人ID
// 打开自己的麦克风
await CrSDK.instance.openMic(selfID);
// 作为主持人 / 管理员,打开或关闭他人的麦(前提是有相应权限)
await CrSDK.instance.openMic(otherID);
// 或关闭他人的麦
await CrSDK.instance.closeMic(otherID);
- 回调示例(监听麦克风状态变化):
import { CrSDKNotifier, NOTIFIER_EVENT, CR_ASTATUS } from '@cr/react-native-rtc';
class AudioListener extends CrSDKNotifier {
audioStatusChanged(asc: { userId: string; newStatus: CR_ASTATUS; oldStatus: CR_ASTATUS }) {
// asc.userId:状态发生变化的用户
// asc.newStatus / asc.oldStatus:新/旧状态
// 在此更新 UI,例如显示谁被静音 / 解除静音
}
}
const listener = new AudioListener();
listener.addCrNotifierListener([NOTIFIER_EVENT.audioStatusChanged]);
5. 开关自已或他人的视频
调用接口:
- 打开视频:openVideo
- 关闭视频:closeVideo
- 查询视频状态:getVideoStatus
通知回调:
- 视频状态变化通知:onVideoStatusChanged
const selfID = 'my_userid';
const otherID = 'user_002';
// 打开自己的视频
await CrSDK.instance.openVideo(selfID);
// 打开他人的视频(通常用于观看远端视频)
await CrSDK.instance.openVideo(otherID);
// 关闭自己的或他人的视频
await CrSDK.instance.closeVideo(selfID);
await CrSDK.instance.closeVideo(otherID);
- 回调示例(监听视频状态变化):
import { CrSDKNotifier, NOTIFIER_EVENT, CR_VSTATUS } from '@cr/react-native-rtc';
class VideoListener extends CrSDKNotifier {
videoStatusChanged(vsc: { userId: string; newStatus: CR_VSTATUS; oldStatus: CR_VSTATUS }) {
// 根据 vsc.newStatus 更新该用户的视频图标 / 画面显示等
}
}
const listener = new VideoListener();
listener.addCrNotifierListener([NOTIFIER_EVENT.videoStatusChanged]);
6. 有人进入房间通知
- 回调接口:onUserEnterMeeting
- 功能:当有其他用户成功进入当前房间时触发,用于更新成员列表、提示有人加入等。
import { CrSDKNotifier, NOTIFIER_EVENT } from '@cr/react-native-rtc';
class RoomListener extends CrSDKNotifier {
userEnterMeeting(userID: string) {
// userID 为新进入房间的用户ID
// 例如:刷新成员列表,弹出"某某进入房间"的提示
}
}
const listener = new RoomListener();
listener.addCrNotifierListener([NOTIFIER_EVENT.userEnterMeeting]);
进入房间成功时,房间中其他成员均会收到该回调。
7. 有人离开房间通知
- 回调接口:onUserLeftMeeting
- 功能:当有用户主动离开房间、掉线或被请出房间时触发,用于更新成员列表、布局等。
class RoomListener extends CrSDKNotifier {
userLeftMeeting(userID: string) {
// userID 为离开房间的用户ID
// 例如:从成员列表中移除,回收其视频窗口资源等
}
}
const listener = new RoomListener();
listener.addCrNotifierListener([NOTIFIER_EVENT.userLeftMeeting]);
当因网络异常等原因导致用户掉线时,服务器在超时后也会触发离开房间通知。
8. 将他人请出房间
调用接口:
功能:将指定用户从当前房间中强制移除,常用于主持人踢人、违规用户处理等场景。
const targetUserID = 'user_003';
// 作为主持人,将某人请出房间
const errCode = await CrSDK.instance.kickout(targetUserID);
if (errCode === 0) {
// 请出房间成功
}
相关行为说明:
- 被请出用户会收到 onMeetingDropped 通知,原因值为 MEETING_DROPPED_REASON.CRVIDEOSDK_DROPPED_KICKOUT;
- 房间中剩余成员(包括操作者)会收到 onUserLeftMeeting 通知;
- 应用层可据此弹出提示、更新房间 UI 布局等。