接口功能
该接口用于获取VMR列表。注意事项:1、该接口在已登录状态下才能调用。
函数原型
getVmrList(onGetVmrListResult?: (ret: SDKERR, reason: string, vmrListInfo: VmrListInfo) => void): void
请求参数
表1 入参说明
| 参数名称 |
是否必选 |
参数类型 |
参数说明 |
| onGetVmrListResult |
Y |
(ret: SDKERR, reason: string, vmrListInfo: VmrListInfo) => void |
Vmr列表通知,获取Vmr列表请求返回 |
回调方法参数说明:
(ret: SDKERR, reason: string, vmrListInfo: VmrListInfo) => void
表2 入参说明
| 参数名称 |
参数类型 |
参数说明 |
| ret |
SDKERR 请参考错误码参考 |
错误码 |
| reason |
string |
错误描述 |
| vmrListInfo |
VmrListInfo |
Vmr列表信息 |
表3 VmrListInfo
| 参数名称 |
参数类型 |
参数说明 |
| vmrs |
Array<VmrInfo> |
云会议室信息 |
| isEnableShareVmr |
boolean |
是否开启共享vmr |
表4 VmrInfo
| 参数名称 |
参数类型 |
参数说明 |
| vmrConfId |
string |
云会议室上的固定会议ID。 |
| vmrId |
string |
云会议室唯一ID。 |
| hostPwd |
string |
云会议室主持人密码。 |
| guestPwd |
string |
云会议室来宾密码。 |
| vmrType |
VmrIdType |
云会议室类型。 |
| maxParties |
number |
云会议室最大方数。 |
| isEnable |
boolean |
云会议室是否可用 |
| name |
string |
会议室名称。 |
| allowGuestStartConf |
boolean |
允许来宾启动会议 |
| confAllowJoinUser |
ConfAllowJoinUserType |
允许入会范围限制。默认所有用户。 |
| isOpenWaitingRoom |
boolean |
等候室开启开关。 说明:需要等候室功能开通后才能生效 |
表5 VmrIdType枚举说明
| 枚举名称 |
枚举值 |
枚举说明 |
| RANDOM_MEETING_ID |
0 |
随机会议id |
| PERSONAL_MEETING_ID |
1 |
个人会议id |
| CLOUD_MEETING_ROOM_ID |
2 |
云会议室id |
表6 ConfAllowJoinUserType枚举说明
| 枚举名称 |
枚举值 |
枚举说明 |
| CONF_ALLOW_JOIN_ANYONE |
0 |
所有用户。 |
| CONF_ALLOW_JOIN_LOGINED_USER |
1 |
已登录用户。 |
| CONF_ALLOW_JOIN_IN_COMPANY_USER |
2 |
企业内用户。 |
| CONF_ALLOW_JOIN_INVITED_USER |
3 |
被邀请用户。 |