检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
获取项目ID 在调用接口的时候,部分URL中需要填入项目ID,所以需要获取到项目ID。您可以通过以下两种方式获取项目ID。 从控制台获取项目ID 调用API获取项目ID 从控制台获取项目ID 登录管理控制台。 鼠标悬停在右上角的用户名,选择下拉列表中“我的凭证”。 在“API凭证”页面的项目列表中查看项目ID。
配置RTC增值(录制)事件回调 功能介绍 调用此接口配置增值(录制)事件上报回调。 当任务发生订阅了的事件时,通过该接口配置的回调地址通知。 回调内容请参见增值(录制)事件回调通知内容。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explore
接口总览 本章节介绍了Android SDK的HRTCConnection接口详情。 HRTCConnection按照其功能可分类为:初始化等基础接口、房间功能、音频管理、视频管理、屏幕共享。 单击下图中相应接口名称,可快速跳转到相应接口位置查看其使用方法。 表1 初始化等基础接口
创建或更新录制规则 功能介绍 调用此接口创建或更新录制规则。 若当前app在请求的location中无录制规则,则会创建新的录制规则 若当前app在请求的location中已有录制规则,则会更新原来的录制规则 接口约束 一个app在一个location最多创建一个录制规则。 调试
视频管理 createRenderer public abstract SurfaceView createRenderer(Context context) 【功能说明】 创建渲染视图。 【请求参数】 context:上下文。 【返回参数】 创建的渲染视图。 updateLocalRenderMode
原始音频数据(音频前后处理) 功能描述 音视频传输过程中,我们可以对采集到的音视频数据进行前处理和后处理,获取想要的播放效果。 对于有自行处理音视频数据需求的场景,HWRtcEngine SDK 提供原始数据功能,您可以在将数据发送给编码器前进行前处理,对捕捉到的音频信号或视频帧
查询录制规则列表 功能介绍 调用此接口查询录制规则列表。 调试 您可以在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/{rule_id}
房间功能 joinRoom virtual int joinRoom(const HRTCJoinParam &joinParam) 【功能说明】 加入房间。该方法让用户加入通话房间。 【请求参数】 joinParam:入会参数。具体请参见HRTCJoinParam。 【返回参数】
合规使用指南 华为云SparkRTC SDK开发者合规指南 《中华人民共和国个人信息保护法》自2021年11月1日起正式施行后,监管部门、各行业参与方和终端消费者越来越关注用户的隐私保护问题。为了有效治理App、SDK违规收集使用个人信息的现象,监管部门也陆续出台相关标准规范。
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的管理员创建IAM用户来说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987。
客户端事件通知(ClientEvent) 本章节介绍了Web SDK的ClientEvent事件。 表1 ClientEvent事件 接口 描述 peer-join 远端用户进入房间事件。 peer-leave 远端用户退出房间事件。 stream-added 远端流添加事件。 stream-removed
音频管理 muteLocalAudio public abstract int muteLocalAudio(boolean mute); 【功能说明】 设置是否发送本地音频流。 【请求参数】 mute:true表示不发送,false表示发送。 【返回参数】 0:成功。 >0:失败。具体请参见客户端错误码。
更新录制规则 功能介绍 调用此接口更新录制规则。 接口约束 如果规则修改后,修改后的规则对正在录制的流无效。 修改后对新的流有效,生效时间为5分钟,即修改规则5分钟后的录制任务会使用新规则进行录制。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API E
客户端错误码 本章节介绍了iOS/macOS SDK的客户端错误码HWRtcErrorCode的详细信息。 表1 错误码说明 类成员 错误码 描述 错误原因 HWRtcErrorCodeSuccess 0 调用成功 - HWRtcErrorCodeSdkInternalError
浏览器适配 本章节介绍Web SDK支持的浏览器类型、版本以及使用限制。 表1 浏览器适配详情 操作系统类型 浏览器类型 浏览器版本 SDK版本约束 下行(播放) 上行(上麦) 屏幕分享 Windows Chrome浏览器 67+ v1.10.0及以上版本 v2.0.0及以上版本
客户端错误码 本章节介绍了SDK的客户端错误码HRtcErrorCode的详细信息。 表1 类成员说明 类成员 错误码 描述 错误原因 HRTC_ERR_CODE_SUCCESS 0 成功 - HRTC_ERR_CODE_SDK_INTERNAL_ERROR 90000001 SDK内部系统错误
视频管理 enableLocalVideo virtual int enableLocalVideo(bool enabled) 【功能说明】 设置是否开启摄像头采集视频。 【请求参数】 enable:true表示开启。false表示关闭。 【返回参数】 0:方法调用成功。 >
客户端错误码 本章节介绍了SDK的客户端错误码HRTCErrorCode的详细信息。 当SDK运行出现网络、媒体相关等错误时,SDK无法自动恢复,需要App干预或进行用户提示。 枚举 错误码 描述 错误原因 HRTC_ERR_CODE_SUCCESS 0 成功 - HRTC_ER
流对象(Stream) 本章节介绍了Web SDK的Stream接口详情。 表1 Stream接口 接口 描述 play 播放该音视频流。 stop 停止播放视频流。 resume 恢复播放音视频。 close 关闭音视频。 muteAudio 禁用音频轨道。 muteVideo