检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 RTC.00001001 OperationUnauthorized: get DomainID fail please check X-Auth-Token
解散房间 功能介绍 调用此接口解散房间,将该房间中所有用户踢出房间。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/rooms
如何创建房间? 房间是由SparkRTC后台在客户端进房时自动创建的,您无需手动创建房间,只需调用客户端的相关接口加入房间即可。具体接口详情请参见客户端SDK参考。 父主题: SDK使用
单流录制 场景说明 将房间中的每一个用户的音视频流分别录制成独立的文件。 录制机制 SparkRTC提供的单流录制支持自启动模式,即单流自动录制,具体的实现机制如下图所示。 图1 单流录制 图2 单流自动录制 实现流程 创建OBS桶:创建用于存储SparkRTC录制文件的OBS桶,
查询自动录制配置 功能介绍 调用此接口查询自动录制配置 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/auto-record-mode
查询合流任务 功能介绍 调用此接口查询合流转码任务状态。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/mix-stream-jobs
通话调查 您可以查看各房间的用户通话质量指标详情,对通话体验和端到端数据进行问题定位和原因分析,有效解决通话质量问题。 注意事项 “通话调查”中的数据仅供数据分析和质量问题查询,计费数据请以账单为准。 由于统计数据需要时间,可能会有5分钟以内的延迟。 查询说明 支持查询的时间跨度最长为
创建应用 功能介绍 调用此接口创建应用。 接口约束 不支持同一租户创建多个app_name相同的应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2
删除应用 功能介绍 调用此接口删除单个应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id} 表1 路径参数 参数 是否必选
启用应用 功能介绍 调用此接口启用单个应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/enable 表1 路径参数
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户来说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com
返回结果 状态码 请求发送以后,您会收到响应,其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
SparkRTC音视频过程中的上下行码率、分辨率、丢包率、音频采样率等信息怎么获取? 可以通过onRtcStats() 接口获取到上下行码率、分辨率、丢包率、音频采样率等统计信息。 父主题: SDK使用
SparkRTC支持白板功能吗? 不支持,白板功能是为APP层级的应用。 父主题: SDK使用
SparkRTC支持旁路推流吗? 支持,具体请参见startPublishStream、updateTransCoding、stopPublishStream接口。 父主题: SDK使用
查询应用列表 功能介绍 调用此接口查询应用列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps 表1 Query参数 参数 是否必选 参数类型
示例2:创建合流录制任务 场景描述 示例1:创建单流录制任务已介绍了如何将房间中的每一个用户的音视频流分别录制成独立的文件。若您需要将房间中的多个单流用户录制成一个文件,您可以参考此章节内容调用SparkRTC API进行合流录制。 前提条件 已获取需要使用的SparkRTC服务的终端节点
打点开关 muteAudioRoute bool 是否禁音频路由 enableAudio bool 音频模块开关 enableVideo bool 视频模块开关 enableShare bool 共享模块开关 audioScene HRTCAudioSceneType 音频场景,会议
statsInfo:会议期间的统计信息,具体请参见HRTCStatsInfo。
配置录制回调 SparkRTC服务提供了录制任务状态回调设置,支持配置HTTP/HTTPS URL,向用户服务器发送POST请求,将录制任务状态信息实时反馈到用户服务器。 回调协议 请求:HTTP POST请求,请求Body的内容为JSON格式。 应答:HTTP STATUS CODE