检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
接入鉴权 为保证SparkRTC的通信安全，当用户加入房间时，华为云SparkRTC服务需要对其进行接入鉴权。本章节主要介绍华为云SparkRTC接入鉴权的实现原理及鉴权签名的生成方法。 鉴权原理 华为云SparkRTC系统使用数字签名作为接入鉴权方式，需要在SDK加入房间时设置
开发前准备 前提条件 已提交工单获取SDK包。 环境要求 编译工具推荐安装Microsoft Visual Studio Code 1.43.2或以上版本。 如果客户端用Node.js开发， 推荐安装14.19.1或以上版本。 支持的浏览器详情请参见Web浏览器适配详情。 如果客
客户端对象（Client） 本章节介绍了Web SDK的Client接口详情。 表1 Client接口 接口 描述 join 加入房间。调用该接口让用户加入指定房间，进行音频/视频通话。 leave 离开房间。用户结束通话后须调用该接口离开房间。 publish 加入房间后，发布本地流。
删除应用 功能介绍 调用此接口删除单个应用。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id} 表1 路径参数 参数 是否必选
停止单流任务 功能介绍 调用此接口停止单流任务 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI DELETE /v2/apps/{app_id}/individual
停用应用 功能介绍 调用此接口停用单个应用。 应用停用后，新房间无法新增和加入，已加入的房间可以继续使用。合流、录制功能等也不可用。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
查询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
启动单流任务 功能介绍 调用此接口接口启动单流任务。 API触发单流录制流名规则：{jobtype}_{jobid}_{roomid}_{userid} jobtype取值为's'代表单流录制。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Exp
初始化等基础接口 createHRtcEngine huawei::rtc::IHRTCEngine* createHRtcEngine(void); 【功能说明】 创建IHRTCEngine对象。 【返回参数】 huawei::rtc::IHRTCEngine*：IHRTCEngine对象。
数据类型 本章节列出了Android SDK的所有数据类型，您可以结合HRtcEngine接口和回调进行开发。 表1 数据类型 类型 描述 HRTCLogInfo 日志信息 HRTCCameraConfig 相机配置 HRTCEncryptionConfig 端到端加密参数 HRTCUserInfo
查询单流任务状态 功能介绍 调用此接口查询单流任务状态。 租户的OBS桶内的情况，暂不支持查询。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/ap
修改合流任务 功能介绍 调用此接口更新合流任务布局。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/mix-stream-jobs/{job_id}
数据类型 本章节列出了iOS/macOS SDK的所有数据类型，您可以结合HWRtcEngine接口和回调进行开发。 表1 数据类型 类型 描述 HWRtcUserInfo 用户信息 HWRtcJoinParam 入会信息 HWRtcVideoEncode 视频编码 HWRtcDeviceInfo
数据类型 本章节列出了全平台C++ SDK的所有数据类型，您可以结合IHRTCEngine接口和回调进行开发。 表1 数据类型 类型 描述 HRTCLogConfig 日志信息 HRTCUserInfo 用户信息 HRTCEncryptionConfig 端到端加密参数 HRTCCameraConfig
查询合流任务 功能介绍 调用此接口查询合流转码任务状态。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/mix-stream-jobs/{job_id}
修订记录 表1 修订记录 修改时间 修改说明 2022-06-21 第十八次正式发布 本次变更如下： 新增以下接口： addMultiRoomMediaRelay：添加单个跨房 removeMultiRoomMediaRelay：删除单个跨房 stopMultiRoomMediaRelay：停止所有跨房
客户端事件通知（ClientEvent） 本章节介绍了Web SDK的ClientEvent事件。 表1 ClientEvent事件 接口 描述 peer-join 远端用户进入房间事件。 peer-leave 远端用户退出房间事件。 stream-added 远端流添加事件。 stream-removed
事件回调（IHRTCConnection） 本章节介绍了全平台C++ SDK的回调接口IHRTCEngineEventHandler的详情。 表1 回调 接口 描述 onError 错误回调。 onWarning 警告回调。 onConnectionChangedNotify 连接状态改变回调。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
