检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
接入鉴权 为保证SparkRTC的通信安全，当用户加入房间时，华为云SparkRTC服务需要对其进行接入鉴权。本章节主要介绍华为云SparkRTC接入鉴权的实现原理及鉴权签名的生成方法。 鉴权原理 华为云SparkRTC系统使用数字签名作为接入鉴权方式，需要在SDK加入房间时设置
查询应用列表 功能介绍 调用此接口查询应用列表。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps 表1 Query参数 参数 是否必选 参数类型
查询录制规则列表 功能介绍 调用此接口查询录制规则列表。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/record-rules
查询录制规则 功能介绍 调用此接口查询指定录制规则。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/record-rules/{rule_id}
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id} 表1 路径参数 参数
修订记录 表1 修订记录 修改时间 修改说明 2023-08-28 第二十次正式发布 本次变更如下： 新增OBS桶管理接口组。 新增查询详情事件接口和查询指定项目用户异常体验事件接口。 2023-07-06 第十九次正式发布 本次变更如下： 删除启动单流任务、更新单流任务和启动合
查询用户异常体验事件 功能介绍 查询指定APP下通话的异常明细数据。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v1/rtc/data/abnormal-events
配置录制回调 SparkRTC服务提供了录制任务状态回调设置，支持配置HTTP/HTTPS URL，向用户服务器发送POST请求，将录制任务状态信息实时反馈到用户服务器。 回调协议 请求：HTTP POST请求，请求Body的内容为JSON格式。 应答：HTTP STATUS CODE
修订记录 表1 修订记录 发布日期 修改说明 最新时间 实时音视频各端SDK的修订记录，详见各端节点下的“修订记录”。 2020-03-30 第一次正式商用发布。
查询合流任务 功能介绍 调用此接口查询合流转码任务状态。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/mix-stream-jobs/{job_id}
主要功能 SparkRTC主要包含基本房间功能和跨房功能，各端主要功能框架，如图1所示。 说明：图1中仅展示各端的统一功能，独属功能详见各端SDK指导。 图1 功能框架 表1 功能说明 类别 功能分类 功能说明 基本功能 初始化等基础接口 主要功能包括创建/销毁RTC引擎、设置日志保存位置等。
房间功能 joinRoom public abstract int joinRoom(HRTCJoinParam joinParam); 【功能说明】 加入房间。 【请求参数】 joinParam：入会参数，具体请参见HRTCJoinParam。 【返回参数】 0：成功。 1：失败。具体请参见客户端错误码。
单流录制 场景说明 将房间中的每一个用户的音视频流分别录制成独立的文件。 录制机制 SparkRTC提供的单流录制支持自启动模式，即单流自动录制，具体的实现机制如下图所示。 图1 单流录制 图2 单流自动录制 实现流程 创建OBS桶：创建用于存储SparkRTC录制文件的OBS桶，若已有OBS桶，请直接执行2。
房间功能 joinRoom - (int)joinRoom:(HWRtcJoinParam * _Nonnull)joinParam; 【功能说明】 加入房间。该方法让用户加入通话房间。如果已在通话中，用户必须调用leaveRoom退出当前通话，才能进入下一个房间。 【请求参数】
检测功能 startNetworkTest - (int)startNetworkTest:(HWRtcNetworkTestConfig *_Nonnull)netWorkTestConfig; 【功能说明】 会前网络质量开启测试，房间外调用，要等探测结束后才能加入房间。 【请求参数】
查询实时规模分布 功能介绍 对规模相关的数据，根据指定维度按在线用户数排名，获取规模相关的指标在指定维度下的统计数据 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET
音频管理 muteLocalAudio - (int)muteLocalAudio:(BOOL)mute; 【功能说明】 设置是否关闭本地音频流发送。 【请求参数】 mute：YES表示关闭音频流发送，NO表示开启音频流发送。 【返回参数】 0：方法调用成功。 > 0：方法调用失
应用管理 您可以在实时音视频控制台创建应用并查询应用的基本信息，应用创建后，您可以使用应用对应的App ID和域名进入互动频道。 注意事项 首次使用华为云实时音视频服务，请先提交工单联系华为云技术客服进行业务咨询。 停用或删除应用会导致业务不可用，请谨慎处理。 创建应用 登录实时音视频控制台。
修改合流任务 功能介绍 调用此接口更新合流任务布局。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/mix-stream-jobs/{job_id}
停用应用 功能介绍 调用此接口停用单个应用。 应用停用后，新房间无法新增和加入，已加入的房间可以继续使用。合流、录制功能等也不可用。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
