更新时间:2025-01-09 GMT+08:00
分享

获取VMR列表

getVmrInfo

接口描述

该接口用于获取VMR列表。

注意事项

该接口在已登录状态下才能调用。

方法定义

1
getVmrInfo(): Promise<HWMQueryVmrInfoResult>;

参数描述

无。

返回值

表1 HWMQueryVmrInfoResult参数说明

参数

类型

描述

result

SDKERR

接口调用结果,HWM_SDKERR_SUCCESS表示成功,详细请参考错误码参考

reasonDesc

string

错误描述。

personalVmrInfo

HWMVmrInfoModel

个人会议室信息。

cloudVmrList

HWMVmrInfoListModel

云会议室列表。

表2 HWMVmrInfoModel参数说明

参数

类型

描述

confId

string

云会议室上的固定会议ID。

vmrId

string

云会议室唯一ID。

hostPwd

string

云会议室主持人密码。

guestPwd

string

云会议室来宾密码。

meetingIdType

MeetingIdType

云会议室类型。

maxParties

number

云会议室最大方数。

isEnable

boolean

云会议室是否可用

name

string

会议室名称。

allowGuestStartConf

boolean

允许来宾启动会议

confAllowJoinUser

ConfAllowJoinUserType

允许入会范围限制。默认所有用户。

isEnableShareVmr

bool

是否开启共享vmr。

表3 枚举MeetingIdType说明

枚举值

描述

HWM_PERSONAL_MEETING_TYPE

个人会议ID。

HWM_CLOUD_MEETING_TYPE

云会议室ID。

表4 HWMVmrInfoListModel参数说明

参数

类型

描述

vmrs

Array<HWMVmrInfoModel>

云会议室信息。

示例代码

1
2
3
4
5
6
7
8
9
/**
* 获取Vmr列表
*/
handleGetVmrList(){
    UISDK.getConfMgrApi().getVmrInfo().then((res) => {
      const message: string = res.result === SDKERR.HWM_SDKERR_SUCCESS ? '获取Vmr列表成功' : '获取Vmr列表失败';
      console.log(message);
    })
}

相关文档