实时音视频 SparkRTC
实时音视频 SparkRTC
本产品内“
”的所有结果
本产品内“
”的所有结果
最新动态
服务公告
版本规划
【下线公告】实时音视频服务下线客户端SDK
产品介绍
什么是实时音视频？
产品优势
应用场景
功能特性
使用限制
常用概念
计费说明
快速入门
入门指引
用户指南
功能介绍
应用管理
云端录制管理
配置录制规则
配置录制回调
视镜（Beta）
通话调查
数据洞察
实时数据
自动诊断
用量统计
云资源授权
最佳实践
云端录制与回放
概述
单流录制
合流录制
实现音视频通话
实现音视频通话（Android）
环境准备
屏幕分享
通话中质量监测
播放音效文件
播放音乐文件
原始音频数据（音频前后处理）
音频自采集和音频自渲染
原始视频数据（视频前后处理）
自定义视频采集
自定义视频渲染
加入多频道（跨房）
实现音视频通话（iOS）
环境准备
屏幕共享
通话质量监测
播放音效
播放音乐
原始音频数据（音频前后处理）
音频自采集和音频自渲染
原始视频数据（视频前后处理）
自定义视频采集
自定义视频渲染
加入多频道（跨房）
实现音视频通话（MAC）
环境准备
屏幕分享
通话质量监测
播放音效
播放音乐
原始音频数据（音频前后处理）
音频自采集和音频自渲染
原始视频数据（视频前后处理）
自定义视频采集
自定义视频渲染
加入多频道（跨房）
实现音视频通话（Windows）
环境准备
屏幕分享
通话质量监测
播放音效
播放音乐
原始音频数据（音频前后处理）
音频自采集和音频自渲染
原始视频数据（视频前后处理）
自定义视频采集
自定义视频渲染
加入多频道（跨房）
实现音视频通话（Web）
环境准备
屏幕分享
通话质量监测
播放音频文件（混音）
切换音频模式
修订记录
API参考
使用前必须
API概览
如何调用API
构造请求
认证鉴权
返回结果
应用示例
示例1：创建单流录制任务
示例2：创建合流录制任务
应用管理
创建应用
查询应用列表
查询单个应用
删除应用
启用应用
停用应用
录制规则管理
创建或更新录制规则
查询录制规则列表
查询录制规则
更新录制规则
删除录制规则
自动录制配置
更新自动录制配置
查询自动录制配置
应用回调管理
配置RTC增值（录制）事件回调
查询增值（录制）事件回调配置
合流任务管理
启动合流任务
查询合流任务
修改合流任务
停止合流任务
单流任务管理
启动单流任务
查询单流任务状态
停止单流任务
更新单流任务
房间管理
踢除在线用户
解散房间
OBS桶管理
查询OBS桶列表
查询OBS桶下对象列表
OBS桶授权及取消授权
数据统计分析
查询房间列表
查询用户列表
查询实时规模
查询实时规模分布
查询实时质量数据
查询实时网络
查询用量
查询历史规模
查询历史质量
查询用户通话指标
查询详情事件接口
查询指定项目用户异常体验事件
查询用户异常体验事件
查询异常事件用户分布
附录
状态码
错误码
获取项目ID
获取账号ID
地区名称缩写
接收增值（录制）事件回调通知内容
修订记录
客户端SDK参考
使用前必读
主要功能
文档基本使用技巧
常见问题分析解决办法
SDK概述
隐私声明
合规使用指南
Android SDK
开发前准备
SDK使用
基本使用逻辑
接口参考
HRtcEngine
接口总览
初始化等基础接口
房间功能
音频管理
视频管理
屏幕共享
辅流管理
音效文件播放管理
音频增强管理
检测功能
自定义音频采集和渲染
自定义视频采集和渲染
设备管理
事件回调（IHRTCEngineEventHandler）
HRTCConnection
接口总览
初始化等基础接口
房间功能
音频管理
视频管理
辅流管理
自定义渲染
事件回调(IHRTCConnectionEventHandler)
客户端错误码
服务端错误码
数据类型
媒体原始数据管理
注册回调（IHRTCMediaEngine）
事件回调（IHRTCVideoFrameObserver）
事件回调（IHRTCAudioFrameObserver）
事件回调（IHRTCEncDecryptFrameObserver）
常见问题
修订记录
iOS/macOS SDK
开发前准备
iOS开发前准备
macOS开发前准备
SDK使用
基本使用逻辑
接口参考
HWRtcEngine
接口总览
初始化等基础接口
房间功能
音频管理
视频管理
辅流管理
屏幕共享
音效文件播放管理
检测功能
自定义音频采集和渲染
自定义视频采集和渲染
设备管理
事件回调（HWRtcEngine）
HWRtcConnection
接口总览
初始化等基础接口
房间功能
音频管理
视频管理
辅流管理
媒体原始数据管理
事件回调（HWRtcConnection）
媒体原始数据管理
注册回调（IHRTCMediaEngine）
事件回调（HWRtcMediaEngineVideoDelegate）
事件回调（HWRtcMediaEngineAudioDelegate）
HWRtcReplay
客户端错误码
服务端错误码
数据类型
事件回调（HWRtcReplay）
常见问题
修订记录
All Platform C++ SDK
开发前准备
Android
iOS
Mac
Windows
SDK使用
基本使用逻辑
接口参考
IHRTCEngine
接口总览
接口按功能说明
初始化等基础接口
房间功能
音频管理
视频管理
辅流管理
屏幕共享
音频文件播放管理
自采集自渲染
其他接口
事件回调（IHRTCEngine）
IHRTCConnection
接口总览
初始化等基础接口
房间功能
音频管理
视频管理
辅流管理
事件回调（IHRTCConnection）
音频设备管理
视频设备管理
共享屏幕资源管理
媒体原始数据管理
注册回调（IHRTCMediaEngine）
事件回调(IHRTCVideoFrameObserver)
事件回调(IHRTCAudioFrameObserver)
事件回调(IHRTCConnectionVideoFrameObserver)
事件回调（IHRTCEncDecryptFrameObserver）
客户端错误码
服务端错误码
HRTC码率帧率配置推荐
数据类型
常见问题
修订记录
Web SDK
浏览器适配
开发前准备
SDK使用
基本使用逻辑
接口参考
主入口（HRTC）
客户端对象（Client）
客户端事件通知（ClientEvent）
流对象（Stream）
本地流对象（LocalStream）
远端流对象（RemoteStream）
流事件通知（RTCStreamEvent）
错误码（RtcError）
客户端错误码
服务端错误码
授权浏览器摄像头/麦克风访问权限的方法
常见问题
修订记录
接入鉴权
附录
Grs国家/地区码对照表
修订记录
常见问题
产品咨询
SparkRTC支持哪些平台？
SparkRTC Demo怎么体验？
在进行Windows的Demo使用或集成SDK时，提示微软C++标准库缺失，该如何获取？
SparkRTC支持接入微信小程序吗？
实时音视频是什么？
实时音视频和直播有什么区别？
SparkRTC是否支持在国外使用？
SparkRTC RoomID是什么？取值区间值是多少？
SparkRTC最多可以同时创建多少个房间？
SparkRTC UserID是什么？取值范围是多少？
怎么理解SparkRTC的角色Role？
SparkRTC最多可以支持多少个人同时视频通话？
实时音视频的时延是多少？
SparkRTC是否支持连麦互动？
SparkRTC是否支持双向的桌面推送？
实时音视频支持私有化部署吗？
PC端实时音视频支持USB摄像头吗？
计费购买
SparkRTC有哪些计费项？
SparkRTC中既订阅视频也有音频时，视频按分辨率收费还要加上音频费用吗？
纯音频场景下不同码率的音频计费有区别吗？
如何查看账单及扣费明细？
能否直接开通后付费？
为什么房间里只有一个人且没有发生音视频通话也会产生费用？
Signature相关
什么是Signature？
如何获取密钥？
服务端如何计算Signature？
录制相关
SparkRTC如何实现云端录制？
SparkRTC云端录制文件存储在哪里？
SparkRTC是否支持本地服务端录制？
单流录制模式和合流录制模式有什么区别？
如何恢复已删除的录音文件？
如何对录制回调进行鉴权？
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接口为什么会调用异常？
问题排查
SparkRTC通话出现无声、黑屏、卡顿等如何排查？
为什么入会的时候没有声音？
为什么视频会出现卡顿？
如何处理视频黑屏问题？
为什么无法打开摄像头？
什么原因导致跨房不成功？
SparkRTC启动云端录制但没有生成录制文件怎么排查？
集成SparkRTC加入房间失败是什么原因？
文档下载
通用参考
产品术语
云服务等级协议（SLA）
白皮书资源
支持区域
系统权限