检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
停止合流任务 功能介绍 调用此接口停止已下发的合流转码任务。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id}/mix-stream-jobs
查询录制规则列表 功能介绍 调用此接口查询录制规则列表。 调试 您可以在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
停用应用 功能介绍 调用此接口停用单个应用。 应用停用后,新房间无法新增和加入,已加入的房间可以继续使用。合流、录制功能等也不可用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能
OBS桶授权及取消授权 功能介绍 OBS桶授权及取消授权。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/rtc-ops/buckets/authentication
启动单流任务 功能介绍 调用此接口接口启动单流任务。 API触发单流录制流名规则:{jobtype}_{jobid}_{roomid}_{userid} jobtype取值为's'代表单流录制。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer
删除应用 功能介绍 调用此接口删除单个应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id} 表1 路径参数 参数 是否必选
查询OBS桶列表 功能介绍 查询OBS桶列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/rtc-ops/buckets 请求参数 表1 请求Header
启用应用 功能介绍 调用此接口启用单个应用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/apps/{app_id}/enable 表1 路径参数
查询OBS桶下对象列表 功能介绍 查询OBS桶下对象列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/rtc-ops/buckets/objects
音频管理 muteRemoteAudio - (int)muteRemoteAudio:(NSString *)userId muted:(BOOL)muted; 【功能说明】 设置是否接收对应远端用户的音频流。 【请求参数】 userId:远端用户的userid,唯一标识。 muted
初始化等基础接口 createHRtcEngine huawei::rtc::IHRTCEngine* createHRtcEngine(void); 【功能说明】 创建IHRTCEngine对象。 【返回参数】 huawei::rtc::IHRTCEngine*:IHRTCEngine
合规使用指南 华为云SparkRTC SDK开发者合规指南 《中华人民共和国个人信息保护法》自2021年11月1日起正式施行后,监管部门、各行业参与方和终端消费者越来越关注用户的隐私保护问题。为了有效治理App、SDK违规收集使用个人信息的现象,监管部门也陆续出台相关标准规范。 您作为开发者为最终用户提供服务
更新录制规则 功能介绍 调用此接口更新录制规则。 接口约束 如果规则修改后,修改后的规则对正在录制的流无效。 修改后对新的流有效,生效时间为5分钟,即修改规则5分钟后的录制任务会使用新规则进行录制。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer
流对象(Stream) 本章节介绍了Web SDK的Stream接口详情。 表1 Stream接口 接口 描述 play 播放该音视频流。 stop 停止播放视频流。 resume 恢复播放音视频。 close 关闭音视频。 muteAudio 禁用音频轨道。 muteVideo
查询单流任务状态 功能介绍 调用此接口查询单流任务状态。 租户的OBS桶内的情况,暂不支持查询。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps
创建或更新录制规则 功能介绍 调用此接口创建或更新录制规则。 若当前app在请求的location中无录制规则,则会创建新的录制规则 若当前app在请求的location中已有录制规则,则会更新原来的录制规则 接口约束 一个app在一个location最多创建一个录制规则。 调试
客户端错误码 本章节介绍了Web SDK的客户端错误码RtcErrorCode的详细信息。 表1 错误码说明 类成员 错误码 描述 错误原因或建议处理方式 RTC_ERR_CODE_SUCCESS 0 success 成功。 RTC_ERR_CODE_RTC_SDK_ERROR 90000001
隐私声明 华为云SparkRTC SDK是由华为云计算有限公司(以下简称“我们”或“华为云”)面向华为云客户提供,方便用户接入实时音视频。华为云客户根据开发文档和用户指南,在其应用中集成SparkRTC SDK后,我们将通过被集成的SparkRTC SDK向华为云客户面向的最终用户
修改合流任务 功能介绍 调用此接口更新合流任务布局。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/mix-stream-jobs