检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
合规使用指南 华为云SparkRTC SDK开发者合规指南 《中华人民共和国个人信息保护法》自2021年11月1日起正式施行后，监管部门、各行业参与方和终端消费者越来越关注用户的隐私保护问题。为了有效治理App、SDK违规收集使用个人信息的现象，监管部门也陆续出台相关标准规范。 您作为开发者为最终用户提供服务
服务端错误码 当SDK运行出现网络、媒体相关等错误时，SDK无法自动恢复，需要APP干预或进行用户提示。该错误码由服务端产生，通过onError返回。 表1 服务端错误码 错误码 描述 错误原因 RTC.10000001 内部错误 程序或环境问题 RTC.31000000 节点不存在
Grs国家/地区码对照表 DR1：中国区 国家/地区名（中文全称） 国家/地区名（英文全称） 国家/地区码（英文缩写） 中国 China CN DR2：亚非拉（新加坡） 国家/地区名（中文全称） 国家/地区名（英文全称） 国家/地区码（英文缩写） 阿联酋 The United Arab
修订记录 表1 修订记录 修改时间 修改说明 2023-11-30 第十三次正式发布 本次变更如下： 客户端对象（Client）新增旁路推流接口：startLiveStreaming、updateLiveStreaming和stopLiveStreaming。 2022-06-29
屏幕共享 功能描述 基于苹果的Replaykit方案，支持用户分享整个系统的屏幕内容，但需要App额外提供一个Extension扩展组件，可实现跨应用屏幕共享。 创建App Group 由于华为云SparkRTC是通过App Goup进行进程间的数据通信的，所以需要创建一个App
查询单流任务状态 功能介绍 调用此接口查询单流任务状态。 租户的OBS桶内的情况，暂不支持查询。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id} 表1 路径参数 参数
更新单流任务 功能介绍 调用此接口修改单流任务。 仅部分场景支持修改。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/individual-stream-jobs
查询应用列表 功能介绍 调用此接口查询应用列表。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps 表1 Query参数 参数 是否必选 参数类型
示例1：创建单流录制任务 场景描述 若您需要对某一个房间的实时音视频进行录制，可以在加入房间后，调用录制接口创建单流录制任务。 前提条件 已获取需要使用的SparkRTC服务的终端节点：rtc-api.myhuaweicloud.com。 已创建用于存储录制文件的OBS桶，并完成OBS
数据类型 本章节列出了iOS/macOS SDK的所有数据类型，您可以结合HWRtcEngine接口和回调进行开发。 表1 数据类型 类型 描述 HWRtcUserInfo 用户信息 HWRtcJoinParam 入会信息 HWRtcVideoEncode 视频编码 HWRtcDeviceInfo
启动单流任务 功能介绍 调用此接口接口启动单流任务。 API触发单流录制流名规则：{jobtype}_{jobid}_{roomid}_{userid} jobtype取值为's'代表单流录制。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer
示例2：创建合流录制任务 场景描述 示例1：创建单流录制任务已介绍了如何将房间中的每一个用户的音视频流分别录制成独立的文件。若您需要将房间中的多个单流用户录制成一个文件，您可以参考此章节内容调用SparkRTC API进行合流录制。 前提条件 已获取需要使用的SparkRTC服务的终端节点
隐私声明 华为云SparkRTC SDK是由华为云计算有限公司（以下简称“我们”或“华为云”）面向华为云客户提供，方便用户接入实时音视频。华为云客户根据开发文档和用户指南，在其应用中集成SparkRTC SDK后，我们将通过被集成的SparkRTC SDK向华为云客户面向的最终用户
客户端对象（Client） 本章节介绍了Web SDK的Client接口详情。 表1 Client接口 接口 描述 join 加入房间。调用该接口让用户加入指定房间，进行音频/视频通话。 leave 离开房间。用户结束通话后须调用该接口离开房间。 publish 加入房间后，发布本地流
查询合流任务 功能介绍 调用此接口查询合流转码任务状态。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/mix-stream-jobs
客户端事件通知（ClientEvent） 本章节介绍了Web SDK的ClientEvent事件。 表1 ClientEvent事件 接口 描述 peer-join 远端用户进入房间事件。 peer-leave 远端用户退出房间事件。 stream-added 远端流添加事件。 stream-removed
修改合流任务 功能介绍 调用此接口更新合流任务布局。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/mix-stream-jobs
启动合流任务 功能介绍 调用此接口创建合流转码任务。 支持纯音频录制和音视频录制： 纯音频录制 encode_template填audio_only，音频合流会动态选择最大三方的声音。 layout_template、layout_panes以及其他视频相关参数都不填，填就忽略。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
