检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id} 表1 路径参数 参数
创建应用 功能介绍 调用此接口创建应用。 接口约束 不支持同一租户创建多个app_name相同的应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2
查询用户通话指标 功能介绍 查询用户通话质量指标数据。 可查询5天内的数据,mid 不为null,查询实时数据时,查询起止时间不超过24个小时,每次查询单个用户时,支持跨天查询。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成
查询历史规模 功能介绍 查询指标过去每天的规模数量,可查询最近31天的数据。当天未结束,无法查到当天的房间数与用户数。 最大查询跨度31天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能
查询实时规模 功能介绍 获取规模相关的指标在某一时间段内每分钟的统计数据。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/{project_id
停用应用 功能介绍 调用此接口停用单个应用。 应用停用后,新房间无法新增和加入,已加入的房间可以继续使用。合流、录制功能等也不可用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能
配置RTC增值(录制)事件回调 功能介绍 调用此接口配置增值(录制)事件上报回调。 当任务发生订阅了的事件时,通过该接口配置的回调地址通知。 回调内容请参见增值(录制)事件回调通知内容。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer
查询实时网络 功能介绍 获取实时网络数据相关指标在某一时间段内每分钟的统计数据。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1/{
查询实时质量数据 功能介绍 获取实时质量数据的相关指标在某一时间段内每分钟的统计数据。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v1
如何对录制回调进行鉴权? 为保证录制回调通信安全,租户可以配置录制回调参数“回调秘钥”,对录制回调消息进行鉴权。本章节介绍录制回调鉴权签名的生成方法。 参数说明 表1 参数说明 参数 说明 X-Rtc-Rand 消息请求头中的随机数。 X-Rtc-Timestamp 消息请求头中的时间戳
查询应用列表 功能介绍 调用此接口查询应用列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps 表1 Query参数 参数 是否必选 参数类型
接入鉴权 为保证SparkRTC的通信安全,当用户加入房间时,华为云SparkRTC服务需要对其进行接入鉴权。本章节主要介绍华为云SparkRTC接入鉴权的实现原理及鉴权签名的生成方法。 鉴权原理 华为云SparkRTC系统使用数字签名作为接入鉴权方式,需要在SDK加入房间时设置“
Web端如何切换摄像头和麦克风? 音视频输入设备通过设备ID(deviceId)标识,每个音视频设备均有一个唯一的设备ID,您可以通过getDevices方法获取。设备ID是随机生成的,部分情况下同一个设备的ID可能会改变,因此建议您每次切换设备时都先调用getDevices获取设备
如何获取密钥? app_key为华为云SparkRTC针对每个app生成的鉴权密钥,需要安全保存,谨防泄漏。您可以通过以下方式获取: 登录实时音视频控制台。 在左侧导航栏中,选择“应用管理”,进入应用管理页面。 在目标应用行单击应用名称,进入应用详情页面。 “鉴权私钥”可见状态下,
云资源授权 您可以将OBS桶授权给SparkRTC服务,允许录制文件存储在OBS桶中。 注意事项 授权的OBS桶所在区域必须为华北-北京四。 前提条件 因录制生成的视频文件是存储在OBS服务中的,因此,您需要先开通OBS服务,具体请参见OBS快速入门。 已在OBS服务中创建用于存储录制文件的
更新录制规则 功能介绍 调用此接口更新录制规则。 接口约束 如果规则修改后,修改后的规则对正在录制的流无效。 修改后对新的流有效,生效时间为5分钟,即修改规则5分钟后的录制任务会使用新规则进行录制。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer
常用概念 应用标识 应用标识或应用ID,简称appID,是SparkRTC用来区分不同应用的唯一标识,在SparkRTC控制台中创建应用时自动生成。 房间 房间是一个音视频空间,同一房间内的用户可以互相接收对方的实时音视频数据。 SparkRTC使用房间这个虚拟的概念,用于用户之间的相互隔离
通过enableUserVolumeNotify开启并设置回调周期,禁音检测以6次音量回调为一个上报周期,enableUserVolumeNotify的参数建议设置成200(即最快1200ms触发禁音检测回调一次)。
配置录制规则 SparkRTC服务支持将实时音视频互动内容进行录制并将录制的内容存储到OBS桶中,您可以在OBS服务中对录制的音视频文件进行下载、分享等处理。相关操作流程,如图1所示。 图1 录制流程图 创建桶:创建用于存储SparkRTC录制文件的OBS桶,若已有OBS桶,请直接执行
配置录制回调 SparkRTC服务提供了录制任务状态回调设置,支持配置HTTP/HTTPS URL,向用户服务器发送POST请求,将录制任务状态信息实时反馈到用户服务器。 回调协议 请求:HTTP POST请求,请求Body的内容为JSON格式。 应答:HTTP STATUS CODE