检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
接口参考 主入口（HRTC） 客户端对象（Client） 客户端事件通知（ClientEvent） 流对象（Stream） 本地流对象（LocalStream） 远端流对象（RemoteStream） 流事件通知（RTCStreamEvent） 错误码（RtcError） 客户端错误码
使用限制 在使用实时音视频前，您需要了解本服务的使用限制。 表1 使用限制 限制项 说明 应用创建 若首次使用SparkRTC，则需提交工单联系华为云技术客服进行咨询。 直播间人数 一个直播间最多支持500人同时通话。 Android SDK 系统版本：支持Android 5.0及以上版本。
概述 华为云实时音视频服务提供的云端录制回放功能适用于需要将音视频通话或互动直播过程进行录制和存储的业务场景。云端录制功能包含两种模式，如表1所示。 表1 云端录制模式 模式 说明 适用场景 单流录制 支持单流录制，可按用户进行录制。 支持自启动录制，开启后对房间内每一个流进行录制。
打开设置页面，单击“隐私与安全”，找到摄像头、麦克风权限。分别单击“摄像头”和“麦克风”的“设置”。 进入设置页面，将请求使用摄像头、麦克风权限的网站加入使用列表，并单击“保存更改”。 完成以上设置后，浏览器在需要使用摄像头、麦克风时，就会在页面弹出设备询问框，选择“允许”即可。 搜狗浏览器 打开搜狗浏览器，单击右上角设置图标，单击“选项”。
配置录制规则 SparkRTC服务支持将实时音视频互动内容进行录制并将录制的内容存储到OBS桶中，您可以在OBS服务中对录制的音视频文件进行下载、分享等处理。相关操作流程，如图1所示。 图1 录制流程图 创建桶：创建用于存储SparkRTC录制文件的OBS桶，若已有OBS桶，请直接执行2。
视频管理 enableLocalVideo - (int)enableLocalVideo:(BOOL)enable; 【功能说明】 设置是否开启摄像头采集视频。 【请求参数】 enable：YES表示开启，NO表示关闭。 【返回参数】 0：方法调用成功。 > 0：方法调用失败。
视频管理 enableLocalVideo virtual int enableLocalVideo(bool enabled) 【功能说明】 设置是否开启摄像头采集视频。 【请求参数】 enable：true表示开启。false表示关闭。 【返回参数】 0：方法调用成功。 >
事件回调（HWRtcEngine） 本章节介绍了iOS/Mac SDK的回调接口HWRtcEngineDelegate的详情。 表1 事件回调说明 接口 描述 onJoinSuccess 成功加入房间回调 onJoinRoomFailure 加入房间失败回调 onRejoinRoomSuccess
音频管理 muteRemoteAudio - (int)muteRemoteAudio:(NSString *)userId muted:(BOOL)muted; 【功能说明】 设置是否接收对应远端用户的音频流。 【请求参数】 userId：远端用户的userid，唯一标识。 m
userName：变更的昵称。 【返回参数】 0：方法调用成功。 > 0：方法调用失败。具体请参见HRTCErrorCode。 该接口仅支持房间内调用，更改的昵称会被实时同步到房间内其他用户的用户列表，退出房间不会保存，再次加入房间变更为加入房间时设置的昵称（参考joinRoom接口注意事项）。
流对象（Stream） 本章节介绍了Web SDK的Stream接口详情。 表1 Stream接口 接口 描述 play 播放该音视频流。 stop 停止播放视频流。 resume 恢复播放音视频。 close 关闭音视频。 muteAudio 禁用音频轨道。 muteVideo
单流录制 场景说明 将房间中的每一个用户的音视频流分别录制成独立的文件。 录制机制 SparkRTC提供的单流录制支持自启动模式，即单流自动录制，具体的实现机制如下图所示。 图1 单流录制 图2 单流自动录制 实现流程 创建OBS桶：创建用于存储SparkRTC录制文件的OBS桶，若已有OBS桶，请直接执行2。
流事件通知（RTCStreamEvent） 本章节介绍了Web SDK的RTCStreamEvent事件。 表1 StreamEvent事件 接口 描述 player-state-change 播放状态变更事件。 screen-sharing-stopped 共享屏幕停止事件。 audio-mixing-played
合流录制 场景说明 将房间中的多路音视频进行云端混流，再将混合后的音视频流录制成一个文件。 合流布局 在合流录制模式下，支持分屏九宫格模板和共享屏幕模板（主视窗居左/主视窗居右）两种预设合流布局。同时，也支持用户自定义合流布局样式（自定义视频窗格位置）。 九宫格模板 每个用户画面
通话调查 您可以查看各房间的用户通话质量指标详情，对通话体验和端到端数据进行问题定位和原因分析，有效解决通话质量问题。 注意事项 “通话调查”中的数据仅供数据分析和质量问题查询，计费数据请以账单为准。 由于统计数据需要时间，可能会有5分钟以内的延迟。 查询说明 支持查询的时间跨度最长为14天。
接口按功能说明 初始化等基础接口 表1 初始化等基础接口 接口 描述 windows是否支持 Mac是否支持 iOS是否支持 Android是否支持 createHRtcEngine 创建IHRTCEngine对象 √ √ √ √ getHRtcEngine 获取创建后的IHRTCEngine对象
本地流对象（LocalStream） 该对象继承自Stream对象，并有如下新增接口。 表1 LocalStream接口 接口 描述 initialize 本地流初始化。 setAudioProfile 设置音频流配置。 setVideoProfile 设置视频流配置。 setScreenProfile
屏幕分享 功能描述 屏幕共享用于在音视频会议中，把一个与会者的屏幕内容，以视频的方式分享给其他与会者。屏幕共享可以共享整个桌面，也可以共享某一个程序窗口。 接口调用流程 实现屏幕共享 加入房间 参考接口调用流程中加入房间的时序图步骤加入房间。 创建并播放共享流 入会后调用isSc
SDK使用 移动端（Android/iOS）创建一个房间，是否支持PC端（MAC/Windows）接入？ iOS平台如何缩减安装包体积？ Android平台如何缩减安装包体积？ iOS端是否可以监听远端离开房间？ 背景音乐是否支持循环播放？ SparkRTC是否支持调整背景音乐的播放进度？
userName：变更的昵称。 【返回参数】 0：方法调用成功。 > 0：方法调用失败。具体请参见HWRtcErrorCode。 该接口仅支持房间内调用，更改的昵称会被实时同步到房间内其他用户的用户列表，退出房间不会保存，再次加入房间变更为加入房间时设置的昵称（参考joinRoom接口注意事项）。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
