检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
主要功能 SparkRTC主要包含基本房间功能和跨房功能，各端主要功能框架，如图1所示。 说明：图1中仅展示各端的统一功能，独属功能详见各端SDK指导。 图1 功能框架 表1 功能说明 类别 功能分类 功能说明 基本功能 初始化等基础接口 主要功能包括创建/销毁RTC引擎、设置日志保存位置等
事件回调（HWRtcEngine） 本章节介绍了iOS/Mac SDK的回调接口HWRtcEngineDelegate的详情。 表1 事件回调说明 接口 描述 onJoinSuccess 成功加入房间回调 onJoinRoomFailure 加入房间失败回调 onRejoinRoomSuccess
浏览器适配 本章节介绍Web SDK支持的浏览器类型、版本以及使用限制。 表1 浏览器适配详情 操作系统类型 浏览器类型 浏览器版本 SDK版本约束 下行（播放） 上行（上麦） 屏幕分享 Windows Chrome浏览器 67+ v1.10.0及以上版本 v2.0.0及以上版本
查询异常事件用户分布 功能介绍 查询指定APP下指定时间内的通话异常明细数据分布情况。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v1
云资源授权 您可以将OBS桶授权给SparkRTC服务，允许录制文件存储在OBS桶中。 注意事项 授权的OBS桶所在区域必须为华北-北京四。 前提条件 因录制生成的视频文件是存储在OBS服务中的，因此，您需要先开通OBS服务，具体请参见OBS快速入门。 已在OBS服务中创建用于存储录制文件的
修订记录 表1 修订记录 修改时间 修改说明 2023-08-28 第二十次正式发布 本次变更如下： 新增OBS桶管理接口组。 新增查询详情事件接口和查询指定项目用户异常体验事件接口。 2023-07-06 第十九次正式发布 本次变更如下： 删除启动单流任务、更新单流任务和启动合流任务接口中的
屏幕共享 startScreenShare - (int)startScreenShare; 【功能说明】 开启屏幕共享功能。 【请求参数】 无 【返回参数】 0：成功。 > 0：方法调用失败。具体请参见HWRtcErrorCode。 目前可支持多路辅流共享，若需开启多辅流，请提交工单联系技术支持处理
查询实时规模分布 功能介绍 对规模相关的数据，根据指定维度按在线用户数排名，获取规模相关的指标在指定维度下的统计数据 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET
接口参考 HWRtcEngine 事件回调（HWRtcEngine） HWRtcConnection 事件回调（HWRtcConnection） 媒体原始数据管理 HWRtcReplay 客户端错误码 服务端错误码 数据类型 事件回调（HWRtcReplay） 父主题： iOS/macOS
接口参考 HRtcEngine 事件回调（IHRTCEngineEventHandler） HRTCConnection 事件回调(IHRTCConnectionEventHandler) 客户端错误码 服务端错误码 数据类型 媒体原始数据管理 父主题： Android SDK
认证鉴权 调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。 AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key）加密调用请求。推荐使用AK/SK认证，其安全性比Token认证要高。 Token认证：通过Token认证调用请求
查询用户异常体验事件 功能介绍 查询指定APP下通话的异常明细数据。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v1/rtc/data
自动诊断 您可以实时查看应用下所有通话体验异常的用户信息及异常明细数据，快速识别通话异常的类型和影响因素。 注意事项 由于统计数据需要时间，可能会有5分钟以内的延迟。 查询说明 支持查询最近24小时的实时数据。 支持查询的时间跨度最长为24小时。 操作步骤 登录实时音视频控制台。
常用概念 应用标识 应用标识或应用ID，简称appID，是SparkRTC用来区分不同应用的唯一标识，在SparkRTC控制台中创建应用时自动生成。 房间 房间是一个音视频空间，同一房间内的用户可以互相接收对方的实时音视频数据。 SparkRTC使用房间这个虚拟的概念，用于用户之间的相互隔离
数据类型 本章节列出了Android SDK的所有数据类型，您可以结合HRtcEngine接口和回调进行开发。 表1 数据类型 类型 描述 HRTCLogInfo 日志信息 HRTCCameraConfig 相机配置 HRTCEncryptionConfig 端到端加密参数 HRTCUserInfo
事件回调（IHRTCEngine） 本章节介绍了全平台C++ SDK的回调接口IHRTCEngineEventHandler的详情。 表1 事件回调说明 接口 描述 onError 错误回调。 onJoinRoomSuccess 成功加入房间回调。 onJoinRoomFailure
常见问题 加入房间时，userName必须填吗？ 非必填。userName、userId由App自定义，但可以相同。 userId：必填，string[64]类型，用户标识，userId需要保证应用内唯一。userId支持的字符包括：a-z、A-Z、0-9、连接符 '-'、下划线
客户端错误码 本章节介绍了iOS/macOS SDK的客户端错误码HWRtcErrorCode的详细信息。 表1 错误码说明 类成员 错误码 描述 错误原因 HWRtcErrorCodeSuccess 0 调用成功 - HWRtcErrorCodeSdkInternalError
获取项目ID 在调用接口的时候，部分URL中需要填入项目ID，所以需要获取到项目ID。您可以通过以下两种方式获取项目ID。 从控制台获取项目ID 调用API获取项目ID 从控制台获取项目ID 登录管理控制台。 鼠标悬停在右上角的用户名，选择下拉列表中“我的凭证”。 在“API凭证”
查询用户通话指标 功能介绍 查询用户通话质量指标数据。 可查询5天内的数据，mid 不为null，查询实时数据时，查询起止时间不超过24个小时，每次查询单个用户时，支持跨天查询。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
