检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
常用概念 应用标识 应用标识或应用ID，简称appID，是SparkRTC用来区分不同应用的唯一标识，在SparkRTC控制台中创建应用时自动生成。 房间 房间是一个音视频空间，同一房间内的用户可以互相接收对方的实时音视频数据。 SparkRTC使用房间这个虚拟的概念，用于用户之间的相互隔离。
20% 下行视频卡顿 5% 下行音频卡顿 3% 明细 展示所有通话体验异常的用户详情，包含通话时间、房间ID、异常用户名、异常环节、异常分类、影响因素和异常源。 图3 异常用户详情 异常环节：通话体验异常发生的环节，包含加入房间和通话。 异常分类：通话体验异常的类型，包含进房慢、视频卡顿和音频卡顿。
应用id state AppState object app状态 scope String RTC覆盖范围。 取值如下： DOMESTIC：国内范围。 OVERSEA：海外范围。 GLOBAL：全球范围。 tenant_name String 账号名 domain String 域名，App对应域名
应用id state AppState object app状态 scope String RTC覆盖范围。 取值如下： DOMESTIC：国内范围。 OVERSEA：海外范围。 GLOBAL：全球范围。 tenant_name String 账号名 domain String 域名，App对应域名
SparkRTC是否支持本地服务端录制？ SparkRTC支持本地服务端录制，但未完全开放，如需使用请提交工单联系华为技术工程师。 本地服务端录制需要使用Linux SDK，可部署在客户Linux 服务器上，使用客户自有的服务器和存储资源。 云端录制无需部署客户自有Linux服务
单击“查看事件”还可查看用户在该房间中的所有操作事件，具体事件类型及ID请参见表1。 房间画像信息：可查看总用户数、最大在线用户数、累计异常用户数、加入房间/5秒加入房间成功率、5秒加入房间成功率、推拉流成功率、录制成功率和音视频卡顿率。 用户列表：可查看每个用户的名称和昵称、通
解散房间 功能介绍 调用此接口解散房间，将该房间中所有用户踢出房间。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/r
配置录制回调 SparkRTC服务提供了录制任务状态回调设置，支持配置HTTP/HTTPS URL，向用户服务器发送POST请求，将录制任务状态信息实时反馈到用户服务器。 回调协议 请求：HTTP POST请求，请求Body的内容为JSON格式。 应答：HTTP STATUS CODE
构造请求 本节介绍REST API请求的组成，并以调用IAM服务的管理员创建IAM用户来说明如何调用API，该API获取用户的Token，Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API：https://bbs.huaweicloud.com/videos/102987。
启动合流任务 功能介绍 调用此接口创建合流转码任务。 支持纯音频录制和音视频录制： 纯音频录制 encode_template填audio_only，音频合流会动态选择最大三方的声音。 layout_template、layout_panes以及其他视频相关参数都不填，填就忽略。
创建应用 功能介绍 调用此接口创建应用。 接口约束 不支持同一租户创建多个app_name相同的应用。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI POST /v2/apps
查询录制规则列表 功能介绍 调用此接口查询录制规则列表。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/record-rules
配置RTC增值（录制）事件回调 功能介绍 调用此接口配置增值（录制）事件上报回调。 当任务发生订阅了的事件时，通过该接口配置的回调地址通知。 回调内容请参见增值（录制）事件回调通知内容。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explore
SDK使用 加入房间前必须有此步骤，检测浏览器是否兼容 SDK。具体接口详情请参见checkSystemRequirements。 1 2 3 4 5 6 7 8 async isBrowserSupport() { let check = await HRTC.ch
查询增值（录制）事件回调配置 功能介绍 调用此接口查询增值（录制）事件回调配置 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/record-callback
开发前准备 前提条件 已提交工单获取SDK包。 环境要求 编译工具推荐安装Microsoft Visual Studio Code 1.43.2或以上版本。 如果客户端用Node.js开发， 推荐安装14.19.1或以上版本。 支持的浏览器详情请参见Web浏览器适配详情。 如果客
常见问题 加入房间时，userName必须填吗？ 非必填。userName、userId由App自定义，但可以相同。 userId：必填，string[64]类型，用户标识，userId需要保证应用内唯一。userId支持的字符包括：a-z、A-Z、0-9、连接符 '-'、下划线
合规使用指南 华为云SparkRTC SDK开发者合规指南 《中华人民共和国个人信息保护法》自2021年11月1日起正式施行后，监管部门、各行业参与方和终端消费者越来越关注用户的隐私保护问题。为了有效治理App、SDK违规收集使用个人信息的现象，监管部门也陆续出台相关标准规范。
状态码 调用实时音视频API时，可能返回的状态码如表1所示。 表1 状态码 返回值 说明 200 OK 请求正常。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 204 No Content 请求完全成功，同时HTTP响应不包含响应体。
修改合流任务 功能介绍 调用此接口更新合流任务布局。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/mix-stream-jobs/{job_id}
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
