检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
更新录制规则 功能介绍 调用此接口更新录制规则。 接口约束 如果规则修改后，修改后的规则对正在录制的流无效。 修改后对新的流有效，生效时间为5分钟，即修改规则5分钟后的录制任务会使用新规则进行录制。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API E
创建或更新录制规则 功能介绍 调用此接口创建或更新录制规则。 若当前app在请求的location中无录制规则，则会创建新的录制规则 若当前app在请求的location中已有录制规则，则会更新原来的录制规则 接口约束 一个app在一个location最多创建一个录制规则。 调试
查询用户通话指标 功能介绍 查询用户通话质量指标数据。 可查询5天内的数据，mid 不为null，查询实时数据时，查询起止时间不超过24个小时，每次查询单个用户时，支持跨天查询。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自
查询历史质量 功能介绍 查询质量指标过去每天的体验数据，可查询最近31天的数据。当天未结束，无法查询到当天的体验数据。 最大查询跨度31天。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
查询合流任务 功能介绍 调用此接口查询合流转码任务状态。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/mix-stream-jobs/{job_id}
修改合流任务 功能介绍 调用此接口更新合流任务布局。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/mix-stream-jobs/{job_id}
示例1：创建单流录制任务 场景描述 若您需要对某一个房间的实时音视频进行录制，可以在加入房间后，调用录制接口创建单流录制任务。 前提条件 已获取需要使用的SparkRTC服务的终端节点：rtc-api.myhuaweicloud.com。 已创建用于存储录制文件的OBS桶，并完成OBS桶授权。您可以通过调用OBS
状态码 调用实时音视频API时，可能返回的状态码如表1所示。 表1 状态码 返回值 说明 200 OK 请求正常。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 204 No Content 请求完全成功，同时HTTP响应不包含响应体。
启动合流任务 功能介绍 调用此接口创建合流转码任务。 支持纯音频录制和音视频录制： 纯音频录制 encode_template填audio_only，音频合流会动态选择最大三方的声音。 layout_template、layout_panes以及其他视频相关参数都不填，填就忽略。
构造请求 本节介绍REST API请求的组成，并以调用IAM服务的管理员创建IAM用户来说明如何调用API，该API获取用户的Token，Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API：https://bbs.huaweicloud.com/videos/102987。
示例2：创建合流录制任务 场景描述 示例1：创建单流录制任务已介绍了如何将房间中的每一个用户的音视频流分别录制成独立的文件。若您需要将房间中的多个单流用户录制成一个文件，您可以参考此章节内容调用SparkRTC API进行合流录制。 前提条件 已获取需要使用的SparkRTC服务的终端节点：rtc-api
获取项目ID 在调用接口的时候，部分URL中需要填入项目ID，所以需要获取到项目ID。您可以通过以下两种方式获取项目ID。 从控制台获取项目ID 调用API获取项目ID 从控制台获取项目ID 登录管理控制台。 鼠标悬停在右上角的用户名，选择下拉列表中“我的凭证”。 图1 管理控制台
客户端错误码 本章节介绍了iOS/macOS SDK的客户端错误码HWRtcErrorCode的详细信息。 表1 错误码说明 类成员 错误码 描述 错误原因 HWRtcErrorCodeSuccess 0 调用成功 - HWRtcErrorCodeSdkInternalError
客户端错误码 本章节介绍了Web SDK的客户端错误码RtcErrorCode的详细信息。 表1 错误码说明 类成员 错误码 描述 错误原因或建议处理方式 RTC_ERR_CODE_SUCCESS 0 success 成功。 RTC_ERR_CODE_RTC_SDK_ERROR 90000001
客户端错误码 本章节介绍了SDK的客户端错误码HRtcErrorCode的详细信息。 表1 类成员说明 类成员 错误码 描述 错误原因 HRTC_ERR_CODE_SUCCESS 0 成功 - HRTC_ERR_CODE_SDK_INTERNAL_ERROR 90000001 SDK内部系统错误
客户端错误码 本章节介绍了SDK的客户端错误码HRTCErrorCode的详细信息。 当SDK运行出现网络、媒体相关等错误时，SDK无法自动恢复，需要App干预或进行用户提示。 枚举 错误码 描述 错误原因 HRTC_ERR_CODE_SUCCESS 0 成功 - HRTC_ER
客户端事件通知（ClientEvent） 本章节介绍了Web SDK的ClientEvent事件。 表1 ClientEvent事件 接口 描述 peer-join 远端用户进入房间事件。 peer-leave 远端用户退出房间事件。 stream-added 远端流添加事件。 stream-removed
数据类型 本章节列出了Android SDK的所有数据类型，您可以结合HRtcEngine接口和回调进行开发。 表1 数据类型 类型 描述 HRTCLogInfo 日志信息 HRTCCameraConfig 相机配置 HRTCEncryptionConfig 端到端加密参数 HRTCUserInfo
数据类型 本章节列出了iOS/macOS SDK的所有数据类型，您可以结合HWRtcEngine接口和回调进行开发。 表1 数据类型 类型 描述 HWRtcUserInfo 用户信息 HWRtcJoinParam 入会信息 HWRtcVideoEncode 视频编码 HWRtcDeviceInfo
数据类型 本章节列出了全平台C++ SDK的所有数据类型，您可以结合IHRTCEngine接口和回调进行开发。 表1 数据类型 类型 描述 HRTCLogConfig 日志信息 HRTCUserInfo 用户信息 HRTCEncryptionConfig 端到端加密参数 HRTCCameraConfig
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
