华为云首页用户手册

华为云会议 MEETING-获取VMR列表:GetVmrList

时间：2024-10-28 14:49:38

华为云会议 MEETING

GetVmrList

接口描述

该接口用于获取VMR列表。

注意事项

该接口在已登录状态下才能调用。
该接口为异步接口，返回值只代表接口是否调用成功，实际业务处理结果在对应的回调函数中返回。

方法定义

  
       HWM_SDK_AGENT_API hwmsdk::HwmErrCode GetVmrList();

回调函数

该接口已废弃，请参考新回调OnGetVmrInfoListResult

  
       virtual void OnGetVmrListResult(hwmsdk::HwmErrCode ret, const char* reason, const HwmVmrInfo* vmrInfoList, unsigned int listLen) {};

新回调

  
       virtual void OnGetVmrInfoListResult(hwmsdk::HwmErrCode ret, const char* reason, const HwmVmrListInfo* vmrListInfo) {};

参数描述

无。

返回值

表1 返回值
类型	描述
HwmErrCode	成功返回0，其他值表示失败。失败返回值见错误码参考。

表2 结构体HwmVmrInfo参数说明
参数	类型	描述
vmrConferenceId	char[]	云会议室上的固定会议ID。
vmrId	char[]	云会议室唯一ID。
chairmanPwd	char[]	云会议室主持人密码。
guestPwd	char[]	云会议室来宾密码。
type	HwmVmrIdType	云会议室类型。
maxParties	int	云会议室最大方数。
name	char[]	会议室名称。
allowGuestStartConf	bool	是否允许来宾提前启动会议。
joinConfRestrictionType	HwmJoinConfPermissionType	允许入会范围限制。
isOpenWaitingRoom	bool	等候室开启开关。

表3 枚举HwmVmrIdType说明
枚举值	描述
PERSONAL_MEETING_ID	个人会议ID。
CLOUD_MEETING_ROOM_ID	云会议室ID。

表4 结构体HwmVmrListInfo参数说明
参数	类型	描述
numOfVmrs	unsigned int	云会议室个数。
vmrs	HwmVmrInfo	云会议室信息。
isEnableShareVmr	bool	是否开启共享vmr。

示例代码

  
       /**
* 获取Vmr列表
*/
void demoBookConfDlg::GetVmrList()
{
    int ret = hwmsdkagent::GetVmrList();
    if (hwmsdk::HWM_COMMON_SUC CES S != ret)
    {
        AfxMessageBox(_T("GetVmrList error"));
    }
}