检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
事件回调（IHRTCConnection） 本章节介绍了全平台C++ SDK的回调接口IHRTCEngineEventHandler的详情。 表1 回调 接口 描述 onError 错误回调。 onWarning 警告回调。 onConnectionChangedNotify 连接状态改变回调
接口总览 本章节介绍了iOS/macOS SDK的HWRtcConnection接口详情。 HWRtcConnection按照其功能可分类为：初始化等基础接口、房间功能、视频管理、屏幕共享、音频管理。 单击下图中相应接口名称，可快速跳转到相应接口位置查看其使用方法。 初始化等基础接口
查询实时规模分布 功能介绍 对规模相关的数据，根据指定维度按在线用户数排名，获取规模相关的指标在指定维度下的统计数据 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET
流事件通知（RTCStreamEvent） 本章节介绍了Web SDK的RTCStreamEvent事件。 表1 StreamEvent事件 接口 描述 player-state-change 播放状态变更事件。 screen-sharing-stopped 共享屏幕停止事件。 audio-mixing-played
启动单流任务 功能介绍 调用此接口接口启动单流任务。 API触发单流录制流名规则：{jobtype}_{jobid}_{roomid}_{userid} jobtype取值为's'代表单流录制。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer
初始化等基础接口 create public static synchronized HRTCEngine create(HRTCEngineConfig config, IHRTCEngineEventHandler eventHandler) 【功能说明】 创建SparkRTC
本地流对象（LocalStream） 该对象继承自Stream对象，并有如下新增接口。 表1 LocalStream接口 接口 描述 initialize 本地流初始化。 setAudioProfile 设置音频流配置。 setVideoProfile 设置视频流配置。 setScreenProfile
常见问题 加入房间时，userName必须填吗？ 非必填。userName、userId由App自定义，但可以相同。 userId：必填，string[64]类型，用户标识，userId需要保证应用内唯一。userId支持的字符包括：a-z、A-Z、0-9、连接符 '-'、下划线
入门指引 首次使用SparkRTC，您需要完成如下操作： 注册华为账号：单击进入注册页面。 完成实名认证：单击进入实名认证。 账户充值：为确保正常使用SparkRTC，您需要进行账户充值（超过1元）。 提交工单联系华为云技术客服，进行业务咨询。 图1 入门流程 SparkRTC的入门操作流程说明如表
获取项目ID 在调用接口的时候，部分URL中需要填入项目ID，所以需要获取到项目ID。您可以通过以下两种方式获取项目ID。 从控制台获取项目ID 调用API获取项目ID 从控制台获取项目ID 登录管理控制台。 鼠标悬停在右上角的用户名，选择下拉列表中“我的凭证”。 在“API凭证”
修订记录 表1 修订记录 修改时间 修改说明 2022-06-21 第六次正式发布 本次变更如下： 新增以下接口： addMultiRoomMediaRelay：添加单个跨房 removeMultiRoomMediaRelay：删除单个跨房 stopMultiRoomMediaRelay
SparkRTC UserID是什么？取值范围是多少？ UserID是实时音视频服务用来区分应用中用户的唯一标识。 用户标识是用户在实时音视频服务中的一个表示，开发者按照规范自定义UserID。 命名规则：可自定义，支持64个字节的大小写字母、数字、下划线（_）中划线（-）随机组合
初始化等基础接口 release virtual void release() 【功能说明】 释放IHRTCConnection对象，如果未离会，会自动离会再释放连接，会触发onDestroyConnection回调。 如果资源已经释放，不能继续使用该对象，需要重新调用createConnection
主要功能 SparkRTC主要包含基本房间功能和跨房功能，各端主要功能框架，如图1所示。 说明：图1中仅展示各端的统一功能，独属功能详见各端SDK指导。 图1 功能框架 表1 功能说明 类别 功能分类 功能说明 基本功能 初始化等基础接口 主要功能包括创建/销毁RTC引擎、设置日志保存位置等
初始化等基础接口 setEncryption public abstract int setEncryption(HRTCEncryptionConfig encryptionParam); 【功能说明】 设置端到端加密方式。需要在加入房间前设置生效。其中sdk加密模式，需要设置16
文档基本使用技巧 技巧1：基本使用逻辑说明 用时序图展示各端接口使用顺序，单击相应接口可以快速查看相关接口使用方法。 技巧2：接口总览说明 包括SparkRTC接口总体功能流程图和接口列表，根据功能分类可以快速查找具体功能单个接口，方便接口对接。 技巧3：单个接口使用须知 接口使用时注意使用的时机
音频文件播放管理 音频文件播放使用ffmpeg能力，在播放在线url时受windows平台自身特性影响，断网时会立刻停止播放（SparkRTC内部无缓存设计），若对该场景体验有要求，建议业务通过先下载到本地再播放的形式使用。 startAudioFile virtual int startAudioFile
浏览器适配 本章节介绍Web SDK支持的浏览器类型、版本以及使用限制。 表1 浏览器适配详情 操作系统类型 浏览器类型 浏览器版本 SDK版本约束 下行（播放） 上行（上麦） 屏幕分享 Windows Chrome浏览器 67+ v1.10.0及以上版本 v2.0.0及以上版本
修订记录 表1 修订记录 修改时间 修改说明 2023-08-28 第二十次正式发布 本次变更如下： 新增OBS桶管理接口组。 新增查询详情事件接口和查询指定项目用户异常体验事件接口。 2023-07-06 第十九次正式发布 本次变更如下： 删除启动单流任务、更新单流任务和启动合流任务接口中的
视频管理 setupRemoteView virtual int setupRemoteView(const char* userId, view_t view) 【功能说明】 设置远端流渲染视图（新选看接口），该接口不影响收流。 【请求参数】 userId：远端用户的唯一标识。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
