检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
1.0.15 更新内容 支持外邀与会者入会 切换到后台后是否允许麦克风收音 支持新辅流 父主题: 版本更新内容
1.0.16 更新内容 支持自定义按钮 带宽消耗优化(小画面优化成180P) 移动端媒体设备权限授权优化 父主题: 版本更新内容
场景2:实名入会 描述 如果要实名入会,需要使用App ID鉴权,获取token,然后再调用SDK的joinConf接口,最后,监听join_conf_result事件。 实名入会:先鉴权登录,再加入会议。 匿名入会:不鉴权登录,就加入会议。 joinConf接口中的token字段为可选
1.0.0 更新内容 首次发布。 父主题: 版本更新内容
1.0.7 更新内容 1、解决chrome 103版本共享兼容性问题 父主题: 版本更新内容
典型场景接口调用概览 2类接口描述 Web SDK的接口分为主动调用接口、消息通知接口。 主动调用接口:用户主动调用SDK的接口,用于完成某项任务。接口调用返回Promise对象,用户可以通过链式调用,得到成功和失败结果。 消息通知接口:由华为云会议服务端触发或SDK内部触发的事件通知
场景4:会议控制操作 描述 考虑到大部分使用SDK进行二次开发的场景,SDK提供了静音开关,视频开关,扬声器开关,共享,举手等一系列会控操作,通过setConfConfig接口可以个性化设置,通过getConfConfig接口,可以获取实时信息; 业务流程 本流程以设置共享为例,通过调用
加入会议 接口描述 该接口用于加入会议。 注意事项 该接口可以在登录和未登录状态下加入会议。加入会议的方式有两种: 未登录:会议ID+会议密码(或Random码)入会。入参无需传入token字段 已登录: 会议ID + 会议密码 + Token 通过邮件会议通知中的会议链接入会时,
离开会议 接口描述 该接口用于离开会议。 注意事项 请在调用加入会议接口后再调用此接口 方法定义 1 leaveConf(params) : Promise<Result> 相关事件 离会结果通知 参数描述 表1 参数说明 参数 是否必须 类型 描述 params 是 object
错误码参考 表1 HwmErrCode枚举说明 retCode retMsg 描述 0 success. 成功 1 fail. 失败 10000 SDK internal error. SDK内部错误 10001 Network error. 网络错误,如SSL证书等问题导致的接口不通
场景5:离开会议 描述 在第三方网页需要离开会议时,需要调用SDK的leaveConf接口,如果强制结束进程或者关闭网页,可能会导致该离会用户在其他用户的与会者列表中,仍存在一小段时间。 业务流程 需要离开会议时,先调用leaveConf接口,然后处理回调事件leave_conf_result
会控操作 setConfConfig 接口描述 进行会控操作 注意事项 请在调用加入会议接口后再调用此接口 方法定义 1 setConfConfig(config):Promise<Result> 相关事件 会控状态变更通知 参数描述 表1 参数说明 参数 是否必须 类型 描述
场景1:入会前准备 出于安全考虑,现代浏览器对音视频的自动播放策略存在限制。如果存在未与页面交互,直接入会的场景,可能影响音视频正常播放,需要主动引导用户点击页面。 描述 在入会之前,需要先确保当前浏览器兼容,创建事件监听。 业务流程 加入会议前,调用checkSystemRequirements
查询会控状态 getConfConfig 接口描述 该接口查询当前会控设置的状态 注意事项 请在调用加入会议接口后再调用此接口 方法定义 1 getConfConfig(configName):Promise<Config> 参数描述 表1 参数说明 参数 是否必须 类型 描述
场景3:视图界面定制 描述 考虑到大部分使用SDK二次开发的场景下,视图可能有不同要求,SDK提供与会者窗口、聊天窗口、会控条、标题、弹幕等组件的显示与隐藏,通过setViewConfig接口可以个性化设置,通过getViewConfig接口,可以获取实时信息; 业务流程 本流程以设置聊天窗口显示
设置视图显示 注意事项 请在调用加入会议接口后再调用此接口。 接口描述 Web SDK中已经提供了会议中的界面,界面上的部分元素是否显示通过该接口配置。 图1 会议窗口的显示控制 如图上图所示,当前SDK支持的窗口显示控制包含: 1. 窗口标题栏 2. 聊天框 3. 与会者列表 4
创建事件监听对象 接口描述 用于创建事件监听对象。 注意事项 该接口的返回对象可用于监听会议的事件,建议提前创建好并监听 调用on方法监听时,可监听的事件可使用获取事件列表获取 方法定义 1 createEventListener: EventEmitter 参数描述 无。 返回值
入会离会通知 入会结果通知 离会结果通知 父主题: 事件通知参考
检查运行环境 接口描述 调用此接口,主要检查当前系统是否可运行SDK,当前运行环境支持见9.1概述-表1 环境要求。 方法定义 1 checkSystemRequirements():Promise<Result> 参数描述 无。 返回值 Result的结构参考9.7.1返回结构参考
会议状态变更通知 网络研讨暂停状态变化通知 被动离开会议通知 父主题: 事件通知参考