更新时间:2024-04-22 GMT+08:00
分享

典型场景接口调用概览

2类接口描述

Web SDK的接口分为主动调用接口消息通知接口

主动调用接口:用户主动调用SDK的接口,用于完成某项任务。接口调用返回Promise对象,用户可以通过链式调用,得到成功和失败结果。

消息通知接口:由华为云会议服务端触发或SDK内部触发的事件通知,SDK以消息通知接口的形式通知给用户。比如入会结果的事件:join_conf_result。

典型场景接口的调用顺序及生命周期

图1 典型场景接口调用时序图

1、建议在项目启动时,优先检查浏览器兼容性(checkSystemRequirements)。

2、从入会,会议控制,到离会,操作结果都是通过事件通知用户,所以建议在入会前创建事件监听(createEventListener),并选择所需的事件建立监听通道。

3、所有接口调用,都会返回Promise对象,用户可以根据链式调用,处理调用成功/失败的场景;以举手为例,调用成功仅代表该接口调用成功,真正举手动作完成,以收到的conf_config_change事件为准。

4、离会时,需要调用SDK的离开接口(leaveConf),如果强制结束进程或者关闭网页,可能会导致该离会用户在其他用户的与会者列表中,仍存在一小段时间。

相关文档