检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询应用列表 功能介绍 调用此接口查询应用列表。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps 表1 Query参数 参数 是否必选 参数类型
常用概念 应用标识 应用标识或应用ID，简称appID，是SparkRTC用来区分不同应用的唯一标识，在SparkRTC控制台中创建应用时自动生成。 房间 房间是一个音视频空间，同一房间内的用户可以互相接收对方的实时音视频数据。 SparkRTC使用房间这个虚拟的概念，用于用户之间的相互隔离。
应用管理 您可以在实时音视频控制台创建应用并查询应用的基本信息，应用创建后，您可以使用应用对应的App ID和域名进入互动频道。 注意事项 首次使用华为云实时音视频服务，请先提交工单联系华为云技术客服进行业务咨询。 创建应用 登录实时音视频控制台。 在左侧导航栏中，选择“应用管理”，进入“应用管理”页面。
合规使用指南 华为云SparkRTC SDK开发者合规指南 《中华人民共和国个人信息保护法》自2021年11月1日起正式施行后，监管部门、各行业参与方和终端消费者越来越关注用户的隐私保护问题。为了有效治理App、SDK违规收集使用个人信息的现象，监管部门也陆续出台相关标准规范。
API概览 华为云实时音视频服务对应的接口列表如下所示，在调用媒体处理API前，您需要先获取用户Token，Token可以用于调用其他API时鉴权，具体如何调用媒体处理API请参考应用示例。 应用管理接口 表1 应用管理接口 接口 说明 POST /v2/apps 创建应用 GET
服务端如何计算Signature？ //认证用的app_key和app_id硬编码至代码中或以明文形式存储会有极大风险。建议密文形式配置存储在文件或者环境变量中，使用时解密，以确保安全。本例以app_key和app_id存放至环境变量为例，运行前请先在本地环境中设置完成环境变量APP_KEY和APP_ID。
接入鉴权 为保证SparkRTC的通信安全，当用户加入房间时，华为云SparkRTC服务需要对其进行接入鉴权。本章节主要介绍华为云SparkRTC接入鉴权的实现原理及鉴权签名的生成方法。 鉴权原理 华为云SparkRTC系统使用数字签名作为接入鉴权方式，需要在SDK加入房间时设置
错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 RTC.00001001 OperationUnauthorized: get DomainID fail please check X-Auth-Token
示例1：创建单流录制任务 场景描述 若您需要对某一个房间的实时音视频进行录制，可以在加入房间后，调用录制接口创建单流录制任务。 前提条件 已获取需要使用的SparkRTC服务的终端节点：rtc-api.myhuaweicloud.com。 已创建用于存储录制文件的OBS桶，并完成OBS桶授权。您可以通过调用OBS
示例2：创建合流录制任务 场景描述 示例1：创建单流录制任务已介绍了如何将房间中的每一个用户的音视频流分别录制成独立的文件。若您需要将房间中的多个单流用户录制成一个文件，您可以参考此章节内容调用SparkRTC API进行合流录制。 前提条件 已获取需要使用的SparkRTC服务的终端节点：rtc-api
屏幕共享 startScreenShare - (int)startScreenShare; 【功能说明】 开启屏幕共享功能。 【请求参数】 无 【返回参数】 0：成功。 > 0：方法调用失败。具体请参见HWRtcErrorCode。 目前可支持多路辅流共享，若需开启多辅流，请提交工单联系技术支持处理。
查询用户通话指标 功能介绍 查询用户通话质量指标数据。 可查询5天内的数据，mid 不为null，查询实时数据时，查询起止时间不超过24个小时，每次查询单个用户时，支持跨天查询。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自
查询房间列表 功能介绍 指定时间范围查询这段期间创建的房间列表。 最大查询跨度90天。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v1/{project_id}/rtc/rooms
修订记录 表1 修订记录 修改时间 修改说明 2022-06-21 第六次正式发布 本次变更如下： 新增以下接口： addMultiRoomMediaRelay：添加单个跨房 removeMultiRoomMediaRelay：删除单个跨房 stopMultiRoomMediaRelay：停止所有跨房
查询用户列表 功能介绍 指定时间范围查询这段期间加入房间的用户列表。 最大查询跨度90天。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v1/{project_id}/rtc/users
查询实时规模分布 功能介绍 对规模相关的数据，根据指定维度按在线用户数排名，获取规模相关的指标在指定维度下的统计数据 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET
单流录制 场景说明 将房间中的每一个用户的音视频流分别录制成独立的文件。 录制机制 SparkRTC提供的单流录制支持自启动模式，即单流自动录制，具体的实现机制如下图所示。 图1 单流录制 图2 单流自动录制 实现流程 创建OBS桶：创建用于存储SparkRTC录制文件的OBS桶，若已有OBS桶，请直接执行2。
入门指引 首次使用SparkRTC，您需要完成如下操作： 注册华为账号：单击进入注册页面。 完成实名认证：单击进入实名认证。 账户充值：为确保正常使用SparkRTC，您需要进行账户充值（超过1元）。 提交工单联系华为云技术客服，进行业务咨询。 图1 入门流程 SparkRTC的入门操作流程说明如表1所示。
注册回调（IHRTCMediaEngine） 表1 IHRTCMediaEngine 接口 描述 setVideoFrameObserver 注册原始视频媒体数据监听回调 setAudioFrameObserver 注册原始音频媒体数据监听回调 setEncDecryptFrameObserver
查询用量 功能介绍 查询过去的某一时间段内各种业务的用量数据 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v1/{project_id}/rtc/history/usage
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
