Web SDK 浏览器适配 开发前准备 SDK使用 基本使用逻辑 接口参考 常见问题 修订记录
浏览器适配 本章节介绍Web SDK支持的浏览器类型、版本以及使用限制。 表1 浏览器适配详情 操作系统类型 浏览器类型 浏览器版本 SDK版本约束 下行(播放) 上行(上麦) 屏幕分享 Windows Chrome浏览器 67+ v1.10.0及以上版本 v2.0.0及以上版本
Web端支持监听远端离开房间吗? 支持监听远端退房事件,建议使用客户端事件中的client.on('peer-leave') 事件实现远端用户退房通知。 父主题: SDK使用
Web端SDK可以获取当前音量大小吗? 可以调用getAudioLevel接口获取当前音量大小。 父主题: SDK使用
实现音视频通话(Web) 环境准备 屏幕分享 通话质量监测 播放音频文件(混音) 切换音频模式 父主题: 实现音视频通话
客户端错误码 本章节介绍了Web SDK的客户端错误码RtcErrorCode的详细信息。 表1 错误码说明 类成员 错误码 描述 错误原因或建议处理方式 RTC_ERR_CODE_SUCCESS 0 success 成功。 RTC_ERR_CODE_RTC_SDK_ERROR 90000001
Web SDK中的checkSystemRequirements接口为什么会调用异常? 请排查Web SDK版本号是否在2.0.2到2.0.9.300之间。这些版本支持strictCheckBrowser参数,该参数用于强校验微信浏览器白名单功能,存在兼容性风险。 请务必在2023
接口参考 主入口(HRTC) 客户端对象(Client) 客户端事件通知(ClientEvent) 流对象(Stream) 本地流对象(LocalStream) 远端流对象(RemoteStream) 流事件通知(RTCStreamEvent) 错误码(RtcError) 客户端错误码
错误码(RtcError) getCode getCode(): number 【功能说明】 获取错误码。 【请求参数】 无 【返回参数】 number类型,错误码值。 getMsg getMsg(): string 【功能说明】 获取错误描述。 【请求参数】 无 【返回参数】 string
开发前准备 前提条件 已提交工单获取SDK包。 环境要求 编译工具推荐安装Microsoft Visual Studio Code 1.43.2或以上版本。 如果客户端用Node.js开发, 推荐安装14.19.1或以上版本。 支持的浏览器详情请参见Web浏览器适配详情。 如果客户端用
远端流对象(RemoteStream) 该对象继承自Stream对象。 getUserName getUserName(): string 【功能说明】 获取远端流所属用户的用户名 【请求参数】 无 【返回参数】 string类型,远端流所属用户的用户名。 父主题: 接口参考
修订记录 表1 修订记录 修改时间 修改说明 2023-11-30 第十三次正式发布 本次变更如下: 客户端对象(Client)新增旁路推流接口:startLiveStreaming、updateLiveStreaming和stopLiveStreaming。 2022-06-29
流对象(Stream) 本章节介绍了Web SDK的Stream接口详情。 表1 Stream接口 接口 描述 play 播放该音视频流。 stop 停止播放视频流。 resume 恢复播放音视频。 close 关闭音视频。 muteAudio 禁用音频轨道。 muteVideo
常见问题 加入房间时,userName必须填吗? 非必填。userName、userId由App自定义,但可以相同。 userId:必填,string[64]类型,用户标识,userId需要保证应用内唯一。userId支持的字符包括:a-z、A-Z、0-9、连接符 '-'、下划线
环境准备 详情请参考开发前准备。 父主题: 实现音视频通话(Web)
基本使用逻辑 创建新的项目工程,导入 SDK 后,需要创建客户端并获取本地音视频设备信息。 创建本地流并初始化。 当用户加入房间后,将通过回调的方式通知房间内的其他用户,收到用户加入的回调后,可以对音视频流进行订阅、取消订阅等其它操作。 在会中,也可以对本地录音或播放设备等进行配置
屏幕分享 功能描述 屏幕共享用于在音视频会议中,把一个与会者的屏幕内容,以视频的方式分享给其他与会者。屏幕共享可以共享整个桌面,也可以共享某一个程序窗口。 接口调用流程 实现屏幕共享 加入房间 参考接口调用流程中加入房间的时序图步骤加入房间。 创建并播放共享流 入会后调用isScreenShareSupported
SDK使用 加入房间前必须有此步骤,检测浏览器是否兼容 SDK。具体接口详情请参见checkSystemRequirements。 1 2 3 4 5 6 7 8 async isBrowserSupport() { let check = await HRTC.checkSystemRequirements
主入口(HRTC) 本章节介绍了Web SDK的HRTC接口详情。 表1 主入口接口 接口 描述 checkSystemRequirements 检测浏览器是否兼容SparkRTC Web SDK。 须知: 如果Web SDK版本在2.0.2到2.0.9.300之间,需要在2023
Web端如何切换摄像头和麦克风? 音视频输入设备通过设备ID(deviceId)标识,每个音视频设备均有一个唯一的设备ID,您可以通过getDevices方法获取。设备ID是随机生成的,部分情况下同一个设备的ID可能会改变,因此建议您每次切换设备时都先调用getDevices获取设备
您即将访问非华为云网站,请注意账号财产安全