检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询实时规模分布 功能介绍 对规模相关的数据，根据指定维度按在线用户数排名，获取规模相关的指标在指定维度下的统计数据 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET
SDK使用 检测浏览器是否兼容 SDK。具体接口详情请参见checkSystemRequirements。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 async isBrowserSupport() { let check =
入门指引 首次使用SparkRTC，您需要完成如下操作： 注册华为账号：单击进入注册页面。 完成实名认证：单击进入实名认证。 账户充值：为确保正常使用SparkRTC，您需要进行账户充值（超过1元）。 提交工单联系华为云技术客服，进行业务咨询。 图1 入门流程 SparkRTC的入门操作流程说明如表
客户端错误码 本章节介绍了iOS/macOS SDK的客户端错误码HWRtcErrorCode的详细信息。 表1 错误码说明 类成员 错误码 描述 错误原因 HWRtcErrorCodeSuccess 0 调用成功 - HWRtcErrorCodeSdkInternalError
更新自动录制配置 功能介绍 更新自动录制配置，租户可以开启自动单流录制或者停用自动单流录制（仅支持单流录制）。 接口约束 开启自动单流录制功能之后，只针对新创建的房间有效，对开启自动录制功能之前已经创建的房间不生效。 单流自动录制任务的流名规则： {appid}_{roomid}_
配置RTC增值（录制）事件回调 功能介绍 调用此接口配置增值（录制）事件上报回调。 当任务发生订阅了的事件时，通过该接口配置的回调地址通知。 回调内容请参见增值（录制）事件回调通知内容。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer
启动单流任务 功能介绍 调用此接口接口启动单流任务。 API触发单流录制流名规则：{jobtype}_{jobid}_{roomid}_{userid} jobtype取值为's'代表单流录制。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer
查询历史规模 功能介绍 查询指标过去每天的规模数量，可查询最近31天的数据。当天未结束，无法查到当天的房间数与用户数。 最大查询跨度31天。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能
查询用户通话指标 功能介绍 查询用户通话质量指标数据。 可查询5天内的数据，mid 不为null，查询实时数据时，查询起止时间不超过24个小时，每次查询单个用户时，支持跨天查询。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成
查询历史质量 功能介绍 查询质量指标过去每天的体验数据，可查询最近31天的数据。当天未结束，无法查询到当天的体验数据。 最大查询跨度31天。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能
更新录制规则 功能介绍 调用此接口更新录制规则。 接口约束 如果规则修改后，修改后的规则对正在录制的流无效。 修改后对新的流有效，生效时间为5分钟，即修改规则5分钟后的录制任务会使用新规则进行录制。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer
创建或更新录制规则 功能介绍 调用此接口创建或更新录制规则。 若当前app在请求的location中无录制规则，则会创建新的录制规则 若当前app在请求的location中已有录制规则，则会更新原来的录制规则 接口约束 一个app在一个location最多创建一个录制规则。 调试
附录 状态码 错误码 获取项目ID 获取账号ID 地区名称缩写 接收增值（录制）事件回调通知内容
【回调参数】 networkTestResult：主要包括测试成功与否、上行和下行的网络带宽、丢包、延时和抖动，具体请参见HRTCNetworkTestResult。
合规使用指南 华为云SparkRTC SDK开发者合规指南 《中华人民共和国个人信息保护法》自2021年11月1日起正式施行后，监管部门、各行业参与方和终端消费者越来越关注用户的隐私保护问题。为了有效治理App、SDK违规收集使用个人信息的现象，监管部门也陆续出台相关标准规范。 您作为开发者为最终用户提供服务
客户端事件通知（ClientEvent） 本章节介绍了Web SDK的ClientEvent事件。 表1 ClientEvent事件 接口 描述 peer-join 远端用户进入房间事件。 peer-leave 远端用户退出房间事件。 stream-added 远端流添加事件。 stream-removed
启动合流任务 功能介绍 调用此接口创建合流转码任务。 支持纯音频录制和音视频录制： 纯音频录制 encode_template填audio_only，音频合流会动态选择最大三方的声音。 layout_template、layout_panes以及其他视频相关参数都不填，填就忽略。
【回调参数】 networkTestResult：主要包括测试成功与否、上行和下行的网络带宽、丢包、延时和抖动，具体请参见HRTCNetworkTestResult。
主入口（HRTC） 本章节介绍了Web SDK的HRTC接口详情。 表1 主入口接口 接口 描述 checkSystemRequirements 检测浏览器是否兼容SparkRTC Web SDK。 须知： 如果Web SDK版本在2.0.2到2.0.9.300之间，需要在2023
SDK使用 创建引擎并初始化。 域名不需要设置，由SDK自动获取。appId获取方法请参见创建应用。 1 2 3 4 5 6 7 8 9 10 11 12 _rtcEngine = [HWRtcEngine sharedEngine]; HWRtcEngineConfig
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
