Obtaining the Cloud Meeting Room List

GetVmrList

API Description

This API is used to obtain the cloud meeting room list.

Precautions

Call this API after login.
This API is an asynchronous API. The return value only indicates whether the API is successfully called. The actual service processing result is returned in the corresponding callback function.

Method Definition

    
         HWM_SDK_AGENT_API hwmsdk::HwmErrCode GetVmrList();

Callback Function

This API has been deprecated. Use the new callback OnGetVmrInfoListResult.

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

New callback

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

Parameter Description

None

Return Values

**Table 1** Return values
Type	Description
HwmErrCode	If 0 is returned, the operation is successful. If other values are returned, the operation fails. For details about values returned upon failures, see Common Error Codes.

**Table 2** HwmVmrInfo description
Parameter	Type	Description
vmrConferenceId	char[]	Fixed meeting ID of the cloud meeting room.
vmrId	char[]	Unique cloud meeting room ID.
chairmanPwd	char[]	Host password of the cloud meeting room.
guestPwd	char[]	Guest password of the cloud meeting room.
type	HwmVmrIdType	Cloud meeting room type.
maxParties	int	Maximum number of participants in the cloud meeting room.
name	char[]	Cloud meeting room name.
allowGuestStartConf	bool	Whether to allow guests to join the meeting ahead of the host.
joinConfRestrictionType	HwmJoinConfPermissionType	Users who are allowed to join the meeting.
isOpenWaitingRoom	bool	Waiting room status.

**Table 3** Enumerated values of HwmVmrIdType
Enumerated Value	Description
PERSONAL_MEETING_ID	Personal meeting ID.
CLOUD_MEETING_ROOM_ID	Cloud meeting room ID.

**Table 4** HwmVmrListInfo description
Parameter	Type	Description
numOfVmrs	unsigned int	Number of cloud meeting rooms.
vmrs	HwmVmrInfo	Cloud meeting room information.
isEnableShareVmr	bool	Whether shared cloud meeting rooms are available.

Sample Code

    
         /**
* Obtain the cloud meeting room list.
*/
void demoBookConfDlg::GetVmrList()
{
    int ret = hwmsdkagent::GetVmrList();
    if (hwmsdk::HWM_COMMON_SUCCESS != ret)
    {
        AfxMessageBox(_T("GetVmrList error"));
    }
}