检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
获取项目ID 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。您可以通过以下两种方式获取项目ID。 从控制台获取项目ID 调用API获取项目ID 从控制台获取项目ID 登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中“我的凭证”。 在“API凭证”页面的项目列表中查看项目ID。
删除录制规则 功能介绍 调用此接口删除录制规则,对于正在使用的录制规则,不允许删除。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI DELETE /v2/apps/
停用应用 功能介绍 调用此接口停用单个应用。 应用停用后,新房间无法新增和加入,已加入的房间可以继续使用。合流、录制功能等也不可用。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
辅流管理 setAuxiliaryVideoEncodeSmooth public abstract int setAuxiliaryVideoEncodeSmooth(boolean enabled); 【功能说明】 设置是否开启辅流的流畅度优先。 【请求参数】 enable:
事件回调(IHRTCEngine) 本章节介绍了全平台C++ SDK的回调接口IHRTCEngineEventHandler的详情。 表1 事件回调说明 接口 描述 onError 错误回调。 onJoinRoomSuccess 成功加入房间回调。 onJoinRoomFailure
更新单流任务 功能介绍 调用此接口修改单流任务。 仅部分场景支持修改。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/i
配置RTC增值(录制)事件回调 功能介绍 调用此接口配置增值(录制)事件上报回调。 当任务发生订阅了的事件时,通过该接口配置的回调地址通知。 回调内容请参见增值(录制)事件回调通知内容。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explore
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id} 表1 路径参数 参数
接入鉴权 为保证SparkRTC的通信安全,当用户加入房间时,华为云SparkRTC服务需要对其进行接入鉴权。本章节主要介绍华为云SparkRTC接入鉴权的实现原理及鉴权签名的生成方法。 鉴权原理 华为云SparkRTC系统使用数字签名作为接入鉴权方式,需要在SDK加入房间时设置
辅流管理 setRemoteAuxiliaryStreamViewRotation virtual int setRemoteAuxiliaryStreamViewRotation(const char *userId, HRTCVideoRotation rotation) 【功能说明】
查询单流任务状态 功能介绍 调用此接口查询单流任务状态。 租户的OBS桶内的情况,暂不支持查询。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/ap
查询用户通话指标 功能介绍 查询用户通话质量指标数据。 可查询5天内的数据,mid 不为null,查询实时数据时,查询起止时间不超过24个小时,每次查询单个用户时,支持跨天查询。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自
事件回调(IHRTCEngineEventHandler) 本章节介绍了Android SDK的回调接口IHRTCEngineEventHandler的详情。 表1 回调接口 接口 描述 onError 错误回调 onJoinRoomSuccess 加入房间成功回调 onJoinRoomFailure
启动单流任务 功能介绍 调用此接口接口启动单流任务。 API触发单流录制流名规则:{jobtype}_{jobid}_{roomid}_{userid} jobtype取值为's'代表单流录制。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Exp
视频管理 enableLocalVideo virtual int enableLocalVideo(bool enabled) 【功能说明】 设置是否开启摄像头采集视频。 【请求参数】 enable:true表示开启。false表示关闭。 【返回参数】 0:方法调用成功。 >
查询OBS桶列表 功能介绍 查询OBS桶列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/rtc-ops/buckets 请求参数 表1 请求Header参数
视频管理 enableLocalVideo - (int)enableLocalVideo:(BOOL)enable; 【功能说明】 设置是否开启摄像头采集视频。 【请求参数】 enable:YES表示开启,NO表示关闭。 【返回参数】 0:方法调用成功。 > 0:方法调用失败。
客户端对象(Client) 本章节介绍了Web SDK的Client接口详情。 表1 Client接口 接口 描述 join 加入房间。调用该接口让用户加入指定房间,进行音频/视频通话。 leave 离开房间。用户结束通话后须调用该接口离开房间。 publish 加入房间后,发布本地流。
客户端错误码 本章节介绍了iOS/macOS SDK的客户端错误码HWRtcErrorCode的详细信息。 表1 错误码说明 类成员 错误码 描述 错误原因 HWRtcErrorCodeSuccess 0 调用成功 - HWRtcErrorCodeSdkInternalError
辅流管理 startRemoteAuxiliaryStreamView - (int)startRemoteAuxiliaryStreamView:(HWRtcVideoCanvas *)streamView streamType:(HWRtcStreamType)streamType;