检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
iOS 前提条件 已提交工单获取SDK包。 环境要求 准备XCODE集成开发。 准备iOS 8.0及以上的iPhone真机。 支持的终端CPU架构：arm64，arm32。 SDK集成 解压iOS SDK包。 将iOS SDK包中的HWRTCEngine动态库和RTC.bundle文件导入创建的XCODE工程中。
获取项目ID 在调用接口的时候，部分URL中需要填入项目ID，所以需要获取到项目ID。您可以通过以下两种方式获取项目ID。 从控制台获取项目ID 调用API获取项目ID 从控制台获取项目ID 登录管理控制台。 鼠标悬停在右上角的用户名，选择下拉列表中“我的凭证”。 在“API凭证”页面的项目列表中查看项目ID。
iOS开发前准备 前提条件 已提交工单获取SDK包。 环境要求 准备XCODE集成开发。 准备iOS 8.0及以上的iPhone真机。 支持的终端CPU架构：arm64，arm32。 SDK集成 解压iOS SDK包。 将iOS SDK包中的HWRTCEngine动态库和RTC.
修订记录 表1 修订记录 修改时间 修改说明 2023-11-30 第十三次正式发布 本次变更如下： 客户端对象（Client）新增旁路推流接口：startLiveStreaming、updateLiveStreaming和stopLiveStreaming。 2022-06-29
接口总览 本章节介绍了Android SDK的HRtcEngine接口详情。 HRtcEngine按照其功能可分类为：初始化等基础接口、房间功能、视频管理、屏幕共享、音频管理、音效文件播放管理、自定义视频采集和渲染、自定义音频采集和渲染、设备管理、检测功能、音频增强管理。 单击下
接口总览 本章节介绍了iOS/macOS SDK的HWRtcEngine接口详情。 HWRtcEngine按照其功能可分类为：初始化等基础接口、房间功能、视频管理、辅流管理、共享屏幕、音频管理、音效文件播放管理、自定义视频采集和渲染、自定义音频采集和渲染、设备管理、检测功能、音频增强管理。
接口按功能说明 初始化等基础接口 表1 初始化等基础接口 接口 描述 windows是否支持 Mac是否支持 iOS是否支持 Android是否支持 createHRtcEngine 创建IHRTCEngine对象 √ √ √ √ getHRtcEngine 获取创建后的IHRTCEngine对象
查询增值（录制）事件回调配置 功能介绍 调用此接口查询增值（录制）事件回调配置 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/record-callback
配置RTC增值（录制）事件回调 功能介绍 调用此接口配置增值（录制）事件上报回调。 当任务发生订阅了的事件时，通过该接口配置的回调地址通知。 回调内容请参见增值（录制）事件回调通知内容。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explore
示例1：创建单流录制任务 场景描述 若您需要对某一个房间的实时音视频进行录制，可以在加入房间后，调用录制接口创建单流录制任务。 前提条件 已获取需要使用的SparkRTC服务的终端节点：rtc-api.myhuaweicloud.com。 已创建用于存储录制文件的OBS桶，并完成OBS桶授权。您可以通过调用OBS
事件回调（IHRTCEngineEventHandler） 本章节介绍了Android SDK的回调接口IHRTCEngineEventHandler的详情。 表1 回调接口 接口 描述 onError 错误回调 onJoinRoomSuccess 加入房间成功回调 onJoinRoomFailure
查询单流任务状态 功能介绍 调用此接口查询单流任务状态。 租户的OBS桶内的情况，暂不支持查询。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/ap
客户端事件通知（ClientEvent） 本章节介绍了Web SDK的ClientEvent事件。 表1 ClientEvent事件 接口 描述 peer-join 远端用户进入房间事件。 peer-leave 远端用户退出房间事件。 stream-added 远端流添加事件。 stream-removed
查询应用列表 功能介绍 调用此接口查询应用列表。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps 表1 Query参数 参数 是否必选 参数类型
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id} 表1 路径参数 参数
更新单流任务 功能介绍 调用此接口修改单流任务。 仅部分场景支持修改。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/i
事件回调(IHRTCConnectionEventHandler) 本章节介绍了Android SDK的回调接口IHRTCConnectionEventHandler的详情。 表1 回调接口 接口 描述 onError 错误回调 onJoinRoomSuccess 加入房间成功回调
事件回调（IHRTCConnection） 本章节介绍了全平台C++ SDK的回调接口IHRTCEngineEventHandler的详情。 表1 回调 接口 描述 onError 错误回调。 onWarning 警告回调。 onConnectionChangedNotify 连接状态改变回调。
启动单流任务 功能介绍 调用此接口接口启动单流任务。 API触发单流录制流名规则：{jobtype}_{jobid}_{roomid}_{userid} jobtype取值为's'代表单流录制。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Exp
事件回调（IHRTCEngine） 本章节介绍了全平台C++ SDK的回调接口IHRTCEngineEventHandler的详情。 表1 事件回调说明 接口 描述 onError 错误回调。 onJoinRoomSuccess 成功加入房间回调。 onJoinRoomFailure
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
