目录
#
产品概述
公有云产品概述
私有云产品概述
产品动态
客户端 SDK
Web SDK
微信小程序 SDK
服务端 OpenAPI
产品计费
计费规则
欠费说明
资源获取
升级指南
客户端升级指南
Android 客户端升级指南
iOS 客户端升级指南
macOS 客户端升级指南
Windows 客户端升级指南
Linux 客户端升级指南
Web 客户端升级指南
Electron 客户端升级指南
（占位）Flutter 客户端升级指南
快速开始
开通服务
使用 Token 完成鉴权
设置视频发布参数
跑通快速开始 Demo
Android
iOS (Objective-C)
iOS (Swift)
macOS (Objective-C)
macOS (Swift)
Windows
Linux 桌面版
Linux 命令行版
Web
微信小程序
Electron
Flutter
构建基础应用
Android
iOS
macOS
Windows
Web
Electron
Flutter
微信小程序
Unity
抖音小程序
抖音小游戏
最佳实践
连接状态提示
设置音频属性
通话质量监测
通话打断和恢复
订阅模式设置
减小 App 体积
场景方案
在线 KTV
排麦独唱
场景介绍
Demo 体验
场景搭建（iOS）
场景搭建（Android）
体验进阶
双人合唱
场景介绍
Demo 体验
场景搭建（iOS）
场景搭建（Android）
（占位）体验进阶
下载歌词/歌曲（iOS)
下载歌词/歌曲（Android）
一起看直播
场景介绍
Demo 体验
场景搭建（iOS)
场景搭建（Android）
（占位）体验进阶
一起看抖音
场景介绍
Demo 体验
场景搭建（iOS）
场景搭建（Android）
体验进阶
游戏房
场景介绍
Demo 体验
场景搭建（iOS）
场景搭建（Android）
（占位）体验进阶
音视频通话
场景介绍
Demo 体验
场景搭建（iOS）
场景搭建（Android）
体验进阶
多人音视频
场景介绍
Demo 体验
场景搭建（iOS）
场景搭建（Android）
场景搭建（Windows）
场景搭建（Web）
场景搭建（抖音小程序）
秀场直播连麦
场景介绍
视频互动
Demo 体验
场景搭建（iOS）
场景搭建（Android）
体验进阶
互动直播
Demo 体验
场景搭建（iOS）
场景搭建（Android）
体验进阶
语音聊天室
场景介绍
Demo 体验
场景搭建（iOS)
场景搭建（Android）
体验进阶
云端会议
整体方案设计
场景阐述
核心功能
大班课
场景介绍
Demo 体验
场景搭建
小班课
场景介绍
场景搭建
狼人杀
场景介绍
Demo 体验
场景搭建（抖音小游戏）
高级功能
音视频通信功能
通话前网络检测
Native 端通话前网络质量检测
Web 端通话前网络质量检测
自定义采集和渲染
Native 端自定义音频采集和渲染
Native 端自定义视频采集
Native 端自定义视频渲染
Web 端自定义音视频采集
自定义视频编解码
推送多路流
同一用户加入多个房间
跨房间转发媒体流
音视频流回退
发布和订阅公共流
在防火墙限制下进行通话
音视频效果
发送和接收媒体补充增强信息(SEI)
使用混音功能
镜像
智能美化特效（付费版）
基础美颜
Native 端基础美颜
Web 端基础美颜
虚拟背景
Native 端虚拟背景
Web 端虚拟背景
视频采集旋转方向
自定义视频处理
自定义音频处理
获取音量信息
空间音频
范围语音
实时语音识别 ASR
视频帧朝向
Web 端 AI 降噪插件
添加视频水印
屏幕共享
Android 端屏幕共享
iOS 端屏幕共享
PC 端屏幕共享
Mac 安装 VeRTC 虚拟声卡
Web 端屏幕共享
Electron 端屏幕共享
云端媒体处理
云端录制
关于云端录制
自定义录制文件名
在控制台开启&关闭云端录制
自动录制
转推直播
关于转推直播
客户端发起转推直播
本地服务端录制
产品概述
资源获取
开启本地服务端录制
收集崩溃日志
性能数据
输入在线媒体流
（占位）关于输入在线媒体流
业务管理
细分配置下发
查看通话数据
消息通知服务
开通消息通知服务
回调格式参考
消息事件参考
接收消息通知回调
开启音频选路
音视频设备管理
移动端设置音频路由
实时信令
产品概述
发版说明
使用限制
数据和统计
产品计费
计费规则
欠费说明
使用 RTC SDK 实时信令功能
API 参考
客户端与客户端通信
客户端与业务服务器通信
使用独立 RTS SDK
资源获取
跑通快速开始
Android
iOS
Web
API 参考
Android
概览
API 详情
回调
错误码
类型详情
iOS
概览
API 详情
回调
错误码
类型详情
Web
概览
API 详情
事件
错误码
数据类型
白板常见问题
互动白板
白板产品概述
白板资源获取
产品计费
白板计费规则
欠费说明
体验和跑通白板 Demo
Android
iOS
Web
构建白板应用
Android
iOS
Web
微信小程序
高级功能
自定义光标图标
文档上传
在 RTC 房间共享白板
客户端 API 参考
发版说明
Android
概览
API 详情
回调
错误码
类型详情
iOS
概览
API 详情
回调
错误码
类型详情
Web
概览
API 详情
回调
错误码
类型详情
版本升级指引
微信小程序
概览
API 详情
回调
错误码
类型详情
Open API 参考
文档转码
白板录制
白板常见问题
白板历史文档归档
即时通讯 IM
产品概述
产品动态
客户端 SDK
服务端 OpenAPI
产品计费
计费规则
欠费说明
资源获取
快速开始
开通服务
Token 鉴权
不含 UI 集成方案
Android
iOS
Web
微信小程序
含 UI 集成方案
Android
iOS
Web
跑通快速开始 Demo
Android
iOS
Web
高级功能
消息相关
会话相关
群组相关
直播群功能
好友关系
第三方回调
开通回调通知服务
回调签名验证
回调格式参考
回调事件列表
控制台功能
简介
应用管理
数据统计
客户端 API 参考
Android
概览
API 详情
回调
错误码
类型详情
iOS
概览
API 详情
回调
错误码
类型详情
Web
概览
API 详情
事件
错误码
类型详情
微信小程序
概览
API 详情
事件
错误码
类型详情
服务端 OpenAPI 参考
服务端 OpenAPI 简介
调用 OpenAPI
对 OpenAPI 请求进行签名
成员相关
会话成员管理
批量添加群聊成员 BatchAddConversationParticipant
批量删除群聊成员 BatchDeleteConversationParticipant
批量修改群聊成员详情 BatchModifyConversationParticipant
修改会话成员已读位置 ModifyParticipantReadIndex
批量禁言/拉黑会话成员 BatchAddBlockParticipants
批量取消禁言/取消拉黑会话成员 BatchDeleteBlockParticipants
批量添加直播群管理员 BatchAddManager
批量移除直播群管理员 BatchRemoveManager
批量添加全员禁言下白名单成员 BatchAddWhitelistParticipant
批量移除全员禁言下白名单成员 BatchRemoveWhitelistParticipant
会话成员查询
查询会话成员数量 GetConversationUserCount
查询会话成员已读位置 GetParticipantReadIndex
分批扫描群聊中的成员详细信息 ScanConversationParticipantList
批量查询会话成员详细信息 BatchGetConversationParticipant
判断用户是否在会话中 IsUserInConversation
分批获得禁言/拉黑成员列表 BatchGetBlockParticipants
批量查询全员禁言下白名单成员 BatchGetWhitelistParticipant
查询直播群成员状态 QueryLiveParticipantStatus
会话相关
会话管理
创建会话 CreateConversation
修改会话信息 ModifyConversation
修改用户对会话的设置 ModifyConversationSetting
解散群聊 DestroyConversation
会话查询
查询成员对会话的设置 GetConversationSetting
查询用户拥有会话 GetUserConversations
批量查询会话 BatchGetConversations
消息相关
消息管理
发送消息 SendMessage
删除用户消息 DeleteMessage
删除会话消息 DeleteConversationMessage
撤回用户消息 RecallMessage
修改消息扩展字段 ModifyMessage
消息查询
批量查询消息 GetMessages
分批查询会话中的消息 GetConversationMessages
用户相关
用户状态
查询用户在线状态 QueryOnlineStatus
好友管理
添加好友 AddFriend
删除好友 DeleteFriend
更新好友 UpdateFriend
查询好友列表 ListFriend
校验好友关系 IsFriend
全员广播
注册广播用户 RegisterUsers
注销广播用户 UnRegisterUsers
更新用户标签 BatchUpdateUserTags
查询注册用户 BatchGetUser
全员广播 UserBroadcast
数据结构
错误码
关于产品
产品术语
相关协议
视频云服务专用条款
【即时通讯】服务等级协议
即时通讯 IM SDK 协议
即时通讯 IM（SDK）隐私政策
即时通讯 IM（SDK）开发者使用合规规范
即时通讯 IM 应用协议
veIM（应用）免责声明
veIM（应用）隐私政策
veIM（应用）用户协议
veIM（应用）个人信息收集清单
veIM（应用）申请操作系统权限列表
veIM（应用）第三方信息共享清单
常见问题
控制台功能
功能简介
应用管理
管理 AppKey
监控台
数据和统计
诊断工具
实时监控
告警通知
嵌入 RTC 控制台
客户端 API 参考
Android 3.52
概览
API 详情
回调
错误码
类型详情
iOS 3.52
概览
API 详情
回调
错误码
类型详情
macOS 3.52
概览
API 详情
回调
错误码
类型详情
Windows 3.52
概览
API 详情
回调
错误码
类型详情
Linux 3.52
概览
API 详情
回调
错误码
类型详情
Web 4.55
概览
API 详情
事件
错误码
数据类型
微信小程序
概览
API 详情
事件
错误码
Electron 3.52
概览
API 详情
回调
错误码
类型详情
Flutter 3.51
Uni-App
概览
API 详情
回调
错误码
类型详情
Unity
概览
API 详情
回调
错误码
类型详情
服务端 OpenAPI 参考
服务端 OpenAPI 简介
调用 OpenAPI
对 OpenAPI 请求进行签名
房间管理
封禁音视频流 BanUserStream
解封音视频流 UnbanUserStream
封禁房间&用户 BanRoomUser
更新房间&用户封禁规则 UpdateBanRoomUserRule
移出用户 KickUser
解散房间 DismissRoom
云端录制
2022-06-01
开始云端录制 StartRecord
更新云端录制 UpdateRecord
结束云端录制 StopRecord
查询录制任务状态 GetRecordTask
2020-12-01
开始云端录制 StartRecord
更新云端录制 UpdateRecord
结束云端录制 StopRecord
查询录制任务状态 GetRecordTask
转推直播
开始合流转推 StartPushMixedStreamToCDN
开始单流转推 StartPushSingleStreamToCDN
更新合流转推 UpdatePushMixedStreamToCDN
结束转推直播 StopPushStreamToCDN
查询合流转推任务状态 GetPushMixedStreamToCDNTask
查询单流转推任务状态 GetPushSingleStreamToCDNTask
单流转推
音频切片
2022-06-01
开启音频切片 StartSegment
更新音频切片 UpdateSegment
结束音频切片 StopSegment
查询音频切片任务状态 GetSegmentTask
2020-12-01
开启音频切片 StartSegment
更新音频切片 UpdateSegment
结束音频切片 StopSegment
抽帧截图
2022-06-01
开启抽帧截图 StartSnapshot
更新抽帧参数 UpdateSnapshot
关闭抽帧截图 StopSnapshot
查询抽帧截图任务状态 GetSnapshotTask
2020-12-01
开启抽帧截图 StartSnapshot
更新抽帧参数 UpdateSnapshot
关闭抽帧截图 StopSnapshot
输入在线媒体流
开始在线媒体流输入 StartRelayStream
更新在线媒体流输入 UpdateRelayStream
停止在线媒体流输入 StopRelayStream
查询输入媒体流任务 ListRelayStream
公共流
发布公共流 StartPushPublicStream
更新公共流 UpdatePublicStreamParam
停止发布公共流 StopPushPublicStream
云录屏
开启云录屏 StartWebCast
结束云录屏 StopWebCast
查询云录屏任务状态 GetWebCastTask
获取数据指标
获取通话时长数据 ListUsages
获取离线质量数据 ListQuality
获取实时质量数据 ListRealTimeQuality
获取离线运营数据 ListOperationData
获取实时运营数据 ListRealTimeOperationData
获取离线运营指标维度分布数据 ListOperationDistribution
获取离线分布质量数据 ListQualityDistribution
获取实时分布质量数据 ListRealTimeQualityDistribution
获取用户实时推流状态 GetUserStreamState
获取通话质量指标 ListCallDetail
获取离线通话房间列表 ListRoomInfo
获取离线用户通话详情 ListUserInfo
应用管理
创建应用 CreateApp
启用&停用应用 ModifyAppStatus
查询应用 ListApps
业务标识管理
添加业务标识 AddBusinessID
修改业务标识名称 ModifyBusinessRemarks
获取业务标识 GetAllBusinessID
删除业务标识 DeleteBusinessID
实时消息通信
发送房间外点对点消息 SendUnicast
发送房间内点对点消息 SendRoomUnicast
发送房间内广播消息 SendBroadcast
批量发送房间内点对点消息 BatchSendRoomUnicast
音视频内容安全
开启审核 StartDetection
停止审核 StopDetection
任务状态查询 ListDetectionTask
回调审核结果 DetectionResult
歌曲查询
搜索音乐列表 SearchMusics
查询歌曲列表 ListMusics
查询热歌榜单 ListHotMusic
数据结构
2022-06-01
2020-12-01
错误码
关于产品
基础术语
相关协议
视频云服务专用条款
【实时音视频】服务等级协议
开源软件合规声明
veRTC SDK 协议
veRTC（SDK）隐私政策
veRTC（SDK）开发者使用合规规范
veRTC 应用协议
veRTC（应用）免责声明
veRTC（应用）隐私政策
veRTC（应用）用户协议
veRTC（应用）第三方信息共享清单
veRTC（应用）个人信息收集清单
veRTC（应用）申请操作系统权限列表
常见问题
集成相关
参数赋值规范
在开发 Android 应用时，如何进行混淆配置？
切换自定义和内部视频采集/编码模块
获取房间内用户信息
获取远端隐身用户加入和离开房间的消息
使用手机硬件耳返功能的依赖配置
如何创建和配置 App Group
Web 端自动播放策略
如何集成 CV SDK 动态库
如何集成 CV SDK 静态库？
OpenCL 库 Android 12 适配说明
用户和媒体流上限
通话音量和媒体音量有什么区别？
Electron 集成相关
质量相关
消除音频噪声
排查无声问题
排查音频卡顿问题
排查视频卡顿问题
排查摄像头启动异常
排查视频模糊问题
排查视频画面异常
开启摄像头时，画面初始偏暗，逐渐变亮
微信小程序 SDK 相关
微信小程序 SDK 媒体能力上限
如何解决暂停接收远端视频流后音频出现高延时
如何解决网络断开重连后用户无法进房
uni-app 编译报错 TypeError: Converting circular structure to JSON
Web SDK 浏览器兼容性
Web SDK 已知问题与解决方案
客户端日志相关
test
历史版本文档归档