音视频通话

房间内人员管理

1. 功能介绍

房间内人员管理相关接口主要用于:

  • 查询成员信息:获取当前房间中所有成员或指定成员的资料;
  • 控制音频:打开/关闭自己或他人的麦克风,查询音频状态与说话能量;
  • 控制视频:打开/关闭自己或他人的摄像头,查询视频状态;
  • 成员事件通知:监听有人进入/离开房间(详见 进入/离开房间);
  • 强制管理:将指定成员请出房间(详见 进入/离开房间)。
注意:

须在成功进入房间后,方可使用本节房间内人员管理相关接口。

音频、视频的更多能力(设备选择、订阅模式等)见文档「音频能力」「视频能力」栏目。

2. 获取房间中所有人员信息

var members = CRVideo_GetAllMembers();
// members 为 [CRVideo_MemberInfo](TypeDefinitions.md#CRVideo_MemberInfo) 数组

相关 API / 类型:

3. 获取房间中单人员信息

var UID = "user_001";
var info = CRVideo_GetMemberInfo(UID);       // 成员对象,含昵称、音视频状态等
var nick = CRVideo_GetMemberNickName(UID);
var inRoom = CRVideo_IsUserInMeeting(UID);   // true / false

相关 API / 类型:

4. 开关自己或他人的麦克风

var selfID = myUserID;
var otherID = "user_002";

CRVideo_OpenMic(selfID);
CRVideo_CloseMic(otherID);   // 需具备相应权限

var aStatus = CRVideo_GetAudioStatus(otherID);
var energy = CRVideo_GetMicEnergy(otherID);  // 说话能量 0~9
CRVideo_AudioStatusChanged.callback = function(UID, oldStatus, newStatus, opID){
    // UID:状态变化的用户;opID:操作者
}

CRVideo_MicEnergyUpdate.callback = function(UID, oldLevel, newLevel){
}

相关 API:

5. 开关自己或他人的视频

var selfID = myUserID;
var otherID = "user_002";

CRVideo_OpenVideo(selfID);
CRVideo_OpenVideo(otherID);   // 观看远端画面需结合视频 UI 组件
CRVideo_CloseVideo(otherID);

var vStatus = CRVideo_GetVideoStatus(otherID);
CRVideo_VideoStatusChanged.callback = function(UID, oldStatus, newStatus, opID){
}

相关 API:

6. 有人进入 / 离开房间

用法与说明见 进入/离开房间 第 1、2 节。

7. 将他人请出房间

用法与说明见 进入/离开房间 中「请出房间」一节。