检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用前必须 华为云实时音视频服务（SparkRTC）凭借在视频业务领域长期技术积累，快速为行业提供高并发、低延迟、高清流畅、安全可靠的全场景、全互动、全实时的音视频服务，适用于在线教育、云会议、社交文娱等场景。 您可以使用本文档提供的API对华为云实时音视频服务进行相关操作，如应
接口总览 本章节介绍了iOS/macOS SDK的HWRtcConnection接口详情。 HWRtcConnection按照其功能可分类为：初始化等基础接口、房间功能、视频管理、屏幕共享、音频管理。 单击下图中相应接口名称，可快速跳转到相应接口位置查看其使用方法。 初始化等基础接口
修订记录 表1 表1 修订记录 发布日期 修订说明 2023-11-30 实时音视频所有客户端类型均增加“环境准备”章节。 2022-09-30 更新“单流录制”和“合流录制”章节的操作内容。 2021-10-30 第一次正式发布。
视频管理 createRenderer public abstract SurfaceView createRenderer(Context context) 【功能说明】 创建渲染视图。 【请求参数】 context：上下文。 【返回参数】 创建的渲染视图。 updateLocalRenderMode
数据统计分析 查询房间列表 查询用户列表 查询实时规模 查询实时规模分布 查询实时质量数据 查询实时网络 查询用量 查询历史规模 查询历史质量 查询用户通话指标 查询详情事件接口 查询指定项目用户异常体验事件 查询用户异常体验事件 查询异常事件用户分布
播放音频文件（混音） 功能描述 混音是将音频文件和麦克风音频混合，一般用于播放时长较长的背景音乐或者伴奏。同一时间只能播放一个音频文件，播放给房间内的其他用户听。 支持播放本地或在线音乐文件，文件格式支持播放wav、pcm和单声道mp3音频格式。 接口调用流程 实现过程 加入房间并发布本端主流
修改合流任务 功能介绍 调用此接口更新合流任务布局。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/mix-stream-jobs/{job_id}
查询异常事件用户分布 功能介绍 查询指定APP下指定时间内的通话异常明细数据分布情况。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /
查询合流任务 功能介绍 调用此接口查询合流转码任务状态。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/mix-stream-jobs/{job_id}
查询用户异常体验事件 功能介绍 查询指定APP下通话的异常明细数据。 最大查询跨度1天。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v1/rtc/data/abnormal-events
屏幕共享 startScreenShare - (int)startScreenShare; 【功能说明】 开启屏幕共享功能。 【请求参数】 无 【返回参数】 0：成功。 > 0：方法调用失败。具体请参见HWRtcErrorCode。 目前可支持多路辅流共享，若需开启多辅流，请提交工单联系技术支持处理。
通话调查 您可以查看各房间的用户通话质量指标详情，对通话体验和端到端数据进行问题定位和原因分析，有效解决通话质量问题。 注意事项 “通话调查”中的数据仅供数据分析和质量问题查询，计费数据请以账单为准。 由于统计数据需要时间，可能会有5分钟以内的延迟。 查询说明 支持查询的时间跨度最长为14天。
启动合流任务 功能介绍 调用此接口创建合流转码任务。 支持纯音频录制和音视频录制： 纯音频录制 encode_template填audio_only，音频合流会动态选择最大三方的声音。 layout_template、layout_panes以及其他视频相关参数都不填，填就忽略。
初始化等基础接口 create public static synchronized HRTCEngine create(HRTCEngineConfig config, IHRTCEngineEventHandler eventHandler) 【功能说明】 创建SparkRTC引擎实例。
媒体原始数据管理 表1 connection媒体原始数据管理 接口 描述 setVideoFrameObserver 注册原始视频媒体数据监听回调 setVideoFrameObserver - (int)setVideoFrameObserver:(id <HWRtcConne
Windows 前提条件 已提交工单获取SDK包。 环境要求 准备集成开发环境，建议使用Microsoft Visual Studio 2015或以上版本。 支持Windows 7或以上版本的Windows设备。 支持的平台：x86 release。 资源文件列表 头文件目录 lib文件目录
附录 Grs国家/地区码对照表
其他接口 startNetworkTest virtual int startNetworkTest(const HRTCNetworkTestConfig* networkTestConfig) = 0; 【功能说明】 开启网络质量测试，房间外调用，要等探测结束后才能加入房间。
视频管理 setPriorRemoteVideoStreamType public abstract int setPriorRemoteVideoStreamType(HRTCVideoStreamType type); 【功能说明】 大小流模式，设置所有订阅的远端视频流类型。
修订记录 表1 修订记录 修改时间 修改说明 2023-11-30 第十三次正式发布 本次变更如下： 客户端对象（Client）新增旁路推流接口：startLiveStreaming、updateLiveStreaming和stopLiveStreaming。 2022-06-29
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
