- 最新动态
- 服务公告
- 产品介绍
- 快速入门
- 用户指南
- 最佳实践
- API参考
-
客户端SDK参考
- 使用前必读
- SDK概述
- 隐私声明
- 合规使用指南
- Android SDK
- iOS/macOS SDK
- All Platform C++ SDK
- Web SDK
- 接入鉴权
- 附录
- 修订记录
-
常见问题
-
产品咨询
- SparkRTC支持哪些平台?
- SparkRTC Demo怎么体验?
- 在进行Windows的Demo使用或集成SDK时,提示微软C++标准库缺失,该如何获取?
- SparkRTC支持接入微信小程序吗?
- 实时音视频是什么?
- 实时音视频和直播有什么区别?
- SparkRTC是否支持在国外使用?
- SparkRTC RoomID是什么?取值区间值是多少?
- SparkRTC最多可以同时创建多少个房间?
- SparkRTC UserID是什么?取值范围是多少?
- 怎么理解SparkRTC的角色Role?
- SparkRTC最多可以支持多少个人同时视频通话?
- 实时音视频的时延是多少?
- SparkRTC是否支持连麦互动?
- SparkRTC是否支持双向的桌面推送?
- 实时音视频支持私有化部署吗?
- PC端实时音视频支持USB摄像头吗?
- 计费购买
- Signature相关
- 录制相关
-
SDK使用
- 移动端(Android/iOS)创建一个房间,是否支持PC端(MAC/Windows)接入?
- iOS平台如何缩减安装包体积?
- Android平台如何缩减安装包体积?
- iOS端是否可以监听远端离开房间?
- 背景音乐是否支持循环播放?
- SparkRTC是否支持调整背景音乐的播放进度?
- 支持监听房间成员进出房间吗?
- 如何监测断网和重连?
- 支持首帧渲染回调吗?能否监听画面开始渲染?
- 如何设置上行视频码率、分辨率和帧率?
- 有没有推荐的画面质量(码率、分辨率、帧率)相关参数配置?
- 如何实现横屏视频通话?
- 是否支持网络测速?如何操作?
- 是否支持音量大小提示?
- 自定义渲染支持哪些格式?
- SparkRTC支持iOS后台运行吗?
- 移动端如何实现录屏(屏幕分享)?
- 多人视频会议中,移动端和Web端可以进入同一房间吗?
- SparkRTC的Web端、移动端、PC端是不是同步的?
- Android SDK是否支持自定义采集数据?
- SparkRTC支持旁路推流吗?
- Windows端如何才能采集到被分享应用播放的声音?
- SDK是否支持断线重连机制?
- 如何创建房间?
- 两台手机同时运行SparkRTC APP,为什么无法互通?
- 鉴权是如何生成的?在什么时候生成?
- onVideoStats、onAudioStatus、onSubStreamStats回调触发时为什么程序会崩溃?
- 为什么本端听筒能听到自己的声音?
- setExternalAudioCapture(音频自采集)、setExternalVideoCapture(视频自采集)、setExternalMediaFrameOutput(视频自渲染)能在进入房间后开启吗?
- SparkRTC是否支持设置镜像画面?
- SparkRTC音视频过程中的上下行码率、分辨率、丢包率、音频采样率等信息怎么获取?
- SparkRTC是否支持设置本地采集音量?是否支持设置每个远端用户的播放音量?
- enableLocalVideo和muteLocalVideo有什么区别?
- enableLocalAudioStream和muteLocalAudio有什么区别?
- SparkRTC是否支持对房间进行权限校验?
- 接入PC端是否支持屏幕分享功能?
- SparkRTC是否支持将本地视频文件分享到实时音视频中?
- SparkRTC是否支持单纯的实时音频?
- 一个房间里可以同时有多路屏幕分享吗?
- SparkRTC是否支持1080P?
- 是否支持视频画面截图功能?
- 播放背景音乐是否支持在线音乐?
- 同一个页面中,可以创建N个RTC对象,通过N个UserID,分别登录到N个房间吗?
- Web端用宽高设置的推流分辨率适用于所有浏览器吗?
- Web端SDK在使用过程中拔掉摄像头,摄像头列表里面的数据如何清除?
- Web端SDK可以获取当前音量大小吗?
- Web端支持监听远端离开房间吗?
- Web端通话过程中为什么会出现回声、杂音、噪声、声音小?
- Web端如何切换摄像头和麦克风?
- SparkRTC支持白板功能吗?
- 相同UserID支持同时进入多个房间吗?
- SparkRTC房间的生命周期是多久?
- SparkRTC多人视频通话支持蓝牙耳机吗?
- SparkRTC多人视频通话支持仅订阅2/3/4人音频吗?
- 指定窗口分享,当窗口大小变化时,视频流的分辨率会跟着变化吗?
- 视频通话支持悬浮窗、大小画面切换功能吗?
- 发送自定义消息接口能实现聊天室、弹幕等功能吗?
- 支持查询所有的UserID吗?
- Web SDK中的checkSystemRequirements接口为什么会调用异常?
- 问题排查
-
产品咨询
- 文档下载
- 通用参考
链接复制成功!
主入口(HRTC)
本章节介绍了Web SDK的HRTC接口详情。
接口 |
描述 |
---|---|
检测浏览器是否兼容SparkRTC Web SDK。
须知:
如果Web SDK版本在2.0.2到2.0.9.300之间,需要在2023年10月29日前更新至2.0.9.301及之后的版本,否则会导致checkSystemRequirements接口不可用。影响范围为微信浏览器。 |
|
获取SparkRTC Web SDK版本。 |
|
获取媒体输入输出设备列表。 |
|
获取摄像头设备列表。 |
|
获取麦克风设备列表。 |
|
获取扬声器设备列表。 |
|
检查是否支持屏幕共享。 |
|
创建一个实时音视频通话的客户端对象。一个Client对应于一个房间。 |
|
创建一个本地流对象。流分为主流和辅流。主流指从摄像头和麦克风采集的音视频流,辅流是从共享屏幕采集的音视频流。 |
|
设置日志级别。 |
checkSystemRequirements
如果Web SDK版本在2.0.2到2.0.9.300之间,需要在2023年10月29日前更新至2.0.9.301及之后的版本,否则会导致checkSystemRequirements接口不可用。影响范围为微信浏览器。
(static) checkSystemRequirements(strictCheckWechatBrowser : boolean): Promise<boolean>
【功能说明】
检测浏览器是否兼容SparkRTC Web SDK。
【请求参数】
strictCheckBrowser:可选,boolean类型,默认值为true 。true表示使用白名单放通支持的移动端浏览器(白名单由华为侧统一配置管理),false表示不使用白名单,该参数为2.0.2版本新增。
【返回参数】
Promise<boolean>:返回一个Promise对象,true表示浏览器兼容SparkRTC Web SDK,如果不兼容,则返回对应Error异常。
getDevices
(static) getDevices(): Promise<MediaDeviceInfo[]>
【功能说明】
获取媒体输入输出设备列表。在用户未授权摄像头或麦克风访问权限之前,“label”及“deviceId”可能为空。因此,建议在用户授权访问后,再调用此接口获取设备列表。
授权浏览器的摄像头/麦克风访问权限的方法,请参见授权浏览器摄像头/麦克风访问权限的方法。
【请求参数】
无
【返回参数】
Promise<MediaDeviceInfo[]>:媒体输入输出设备列表。MediaDeviceInfo为Web API基本接口。
getCameras
(static) getCameras(): Promise<MediaDeviceInfo[]>
【功能说明】
获取摄像头设备列表。在用户未授权摄像头访问权限之前,“label”及“deviceId” 可能为空。因此建议在用户授权访问后,再调用此接口获取设备列表。
授权浏览器的摄像头/麦克风访问权限的方法,请参见授权浏览器摄像头/麦克风访问权限的方法。
【请求参数】
无
【返回参数】
Promise<MediaDeviceInfo[]>:摄像头设备列表。MediaDeviceInfo 为Web API基本接口。
getMicrophones
(static) getMicrophones(): Promise<MediaDeviceInfo[]>
【功能说明】
获取麦克风设备列表。在用户未授权麦克风访问权限之前,“label”及“deviceId”可能为空。因此建议在用户授权访问后,再调用此接口获取设备列表。
授权浏览器的摄像头/麦克风访问权限的方法,请参见授权浏览器摄像头/麦克风访问权限的方法。
【请求参数】
无
【返回参数】
Promise<MediaDeviceInfo[]>:麦克风设备列表。MediaDeviceInfo为Web API基本接口。
getSpeakers
(static) getSpeakers(): Promise<MediaDeviceInfo[]>
【功能说明】
获取扬声器设备列表。
【请求参数】
无
【返回参数】
Promise<MediaDeviceInfo[]>:扬声器设备列表。MediaDeviceInfo为Web API基本接口。
isScreenShareSupported
(static) isScreenShareSupported(): boolean
【功能说明】
检查浏览器是否支持屏幕共享。
【请求参数】
无
【返回参数】
boolean:true表示支持,false表示不支持。
createClient
(static)createClient(config: ClientConfig): Client
【功能说明】
创建一个实时音视频通话的客户端对象。一个客户端对象只能同时加入一个房间。可以创建多个客户端对象同时加入多个房间。
【请求参数】
config:必选,ClientConfig类型, 客户端对象配置信息。
- appId:必选,string[128]类型,应用ID,只有App ID相同的应用程序才能进入同一个房间进行互动。应用的appId请参考应用管理进行获取。
- domain:可选,string[128]类型,服务器的域名。需要与注册到SparkRTC平台的合法企业域名保持一致,该参数在SDK 1.0+版本中必填,SDK 2.0+版本中非必填。
- countryCode: 可选,string[2]类型,需要满足ISO 3166-1的2位字母的国家码要求。表示业务接入点的国家码,SDK会根据设置将业务接入到对应区域的服务,如:CN表示中国大陆,US表示美国,HK表示中国香港。countryCode值的填写具体请参见国家码对照表。该参数为2.0.3版本新增,且为必选参数,从2.0.7版本开始,修改为可选参数。
}
【返回参数】
Client:客户端对象。
createStream
(static) createStream(config: StreamConfig): Stream
【功能说明】
创建本地流对象。
【请求参数】
config:必选,StreamConfig类型,指定创建流的参数。
- screen:可选,boolean类型,如果为true表示该流对象采集的是辅流音视频。辅流即共享屏幕的流。默认值为false,即该流对象采集的是主流音视频。
- video:可选,boolean类型,指定是否采集主流的视频,主流即摄像头的流。默认值为false。
- audio:可选,boolean类型,指定是否采集主流的音频。默认值为false。screen为false的时候该参数有效。
- microphoneId:可选,string类型,在audio为true的时候有效,表示采集音频的源麦克风设备Id。如果不传,系统自动设置默认值。
- cameraId:可选,string类型,在video为true的时候有效,表示采集视频的摄像头设备Id。如果不传,系统自动设置默认值。
- facingMode:可选,string类型,在video为true的时候有效,user表示前置摄像头,environment表示后置摄像头。
- screenAudio:可选,boolean类型,是否包含屏幕共享背景音。默认值为false。该功能仅支持Windows平台Chrome浏览器 74及以上版本。该字段为1.4.0版本新增。
- audioSource:可选,MediaStreamTrack类型,表示输入音轨对象。通过指定Track设置音频。MediaStreamTrack为Web API基本接口。
- videoSource:可选,MediaStreamTrack类型,表示输入视轨对象。通过指定Track设置主流视频。MediaStreamTrack为Web API基本接口。
- mirror:可选,boolean类型,表示主流的本地视频是否镜像。默认值为false。
- userId:可选,string类型,表示该流归属的userId。
}
【返回参数】
Stream:流对象。
- 在采集主流有两种方式:
- 通过“audioSource”和“videoSource”设置音频和视频主流。这种模式下不支持大小流。
- 通过“audio/microphoneId”和“video/cameraId/facingMode”设置音频和视频主流。
- 如果未指定任何的音频源和视频源,则创建的流对象不包含音频流和视频流,无法播放。
- 如果采集视频,同一个Stream对象不能同时采集主流和辅流。
- 如果需要包含屏幕共享背景音,需要设置screen和screenAudio均为true,该参数仅在1.4.0 及以上版本生效。