会议等待室
方法总览
| 方法名称 | 行为 | 含义描述 |
|---|---|---|
| OnWaitingRoomUserAdded | 通知 | 等候室用户新增通知 |
| OnWaitingRoomUserDeleted | 通知 | 等候室用户删除通知 |
| IsWaitingRoomEnable | 调用 | 等候室是否开启 |
| EnableWaitingRoom | 调用 | 启用或者关闭等候室 |
| GetWaitingUserList | 调用 | 获取当前等候室的成员列表 |
| AdmitToMeeting | 调用 | 允许等候室的某个成员 |
| RefuseToMeeting | 调用 | 拒绝等候室的某个成员 |
| AdmitAllToMeeting | 调用 | 对等候室成员全部允许 |
| RefuseAllToMeeting | 调用 | 对等候室成员全部拒绝 |
| MoveToWaitingRoom | 调用 | 将某个参会成员移至等候室 |
OnWaitingRoomUserAdded
通知描述
等候室用户新增通知
通知定义
void OnWaitingRoomUserAdded(LobbyMemberUserIdList userIdList);
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| userIdList | LobbyMemberUserIdList | 无 |
成员userId列表
struct LobbyMemberUserIdList {
std::vector<int> vecLobbyMemberUserIdList;/** < userId列表 */
}
返回值描述
无返回值。
OnWaitingRoomUserDeleted
通知描述
等候室用户删除通知
通知定义
void OnWaitingRoomUserDeleted(LobbyMemberUserIdList userIdList);
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| userIdList | LobbyMemberUserIdList | 无 |
成员userId列表
struct LobbyMemberUserIdList {
std::vector<int> vecLobbyMemberUserIdList;/** < userId列表 */
}
返回值描述
无返回值。
IsWaitingRoomEnable
接口描述
等候室是否开启
接口定义
bool IsWaitingRoomEnable();
参数描述
无参数。
返回值描述
| 类型 | 含义 |
|---|---|
| bool | 无 |
EnableWaitingRoom
接口描述
启用或者关闭等候室
接口定义
YLSDKERR EnableWaitingRoom(bool bEnable);
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| bEnable | bool | 无 |
返回值描述
| 类型 | 含义 |
|---|---|
| YLSDKERR | 错误码,详情见错误码 YLSDKERR 的定义 |
GetWaitingUserList
接口描述
获取当前等候室的成员列表
接口定义
LobbyMemberList GetWaitingUserList();
参数描述
无参数。
返回值描述
| 类型 | 含义 |
|---|---|
| LobbyMemberList | 等候室的所有成员信息 |
LobbyMemberList 等候室的所有成员信息
struct LobbyMemberList {
std::vector<LobbyMemberInfo> vecLobbyMemberInfoList;/** < 等候室的成员列表 */
}
AdmitToMeeting
接口描述
允许等候室的某个成员
接口定义
YLSDKERR AdmitToMeeting(int userId);
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| userId | int | 无 |
返回值描述
| 类型 | 含义 |
|---|---|
| YLSDKERR | 错误码,详情见错误码 YLSDKERR 的定义 |
RefuseToMeeting
接口描述
拒绝等候室的某个成员
接口定义
YLSDKERR RefuseToMeeting(int userId);
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| userId | int | 无 |
返回值描述
| 类型 | 含义 |
|---|---|
| YLSDKERR | 错误码,详情见错误码 YLSDKERR 的定义 |
AdmitAllToMeeting
接口描述
对等候室成员全部允许
接口定义
YLSDKERR AdmitAllToMeeting();
参数描述
无参数。
返回值描述
| 类型 | 含义 |
|---|---|
| YLSDKERR | 错误码,详情见错误码 YLSDKERR 的定义 |
RefuseAllToMeeting
接口描述
对等候室成员全部拒绝
接口定义
YLSDKERR RefuseAllToMeeting();
参数描述
无参数。
返回值描述
| 类型 | 含义 |
|---|---|
| YLSDKERR | 错误码,详情见错误码 YLSDKERR 的定义 |
MoveToWaitingRoom
接口描述
将某个参会成员移至等候室
接口定义
YLSDKERR MoveToWaitingRoom(int userId);
参数描述
| 参数 | 类型 | 含义 |
|---|---|---|
| userId | int | 无 |
返回值描述
| 类型 | 含义 |
|---|---|
| YLSDKERR | 错误码,详情见错误码 YLSDKERR 的定义 |