检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
返回结果 状态码 请求发送以后，您会收到响应，其中包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。 对于管理员创建IAM用户接口，如果调用后返回状态码为“201”，则表示请求成功。 响应消息头 对
实时数据 您可以查看音视频通话的规模、体验、网络指标的实时数据和分析图表，实时掌握项目整体动态，及时识别异常通话体验和异常根因。 注意事项 “实时数据”中的数据仅供数据分析和质量问题查询，计费数据请以账单为准。 由于统计数据需要时间，可能会有5分钟以内的延迟。 查询说明 支持查询最近24小时的实时数据。
常用概念 应用标识 应用标识或应用ID，简称appID，是SparkRTC用来区分不同应用的唯一标识，在SparkRTC控制台中创建应用时自动生成。 房间 房间是一个音视频空间，同一房间内的用户可以互相接收对方的实时音视频数据。 SparkRTC使用房间这个虚拟的概念，用于用户之间的相互隔离。
接口总览 本章节介绍了全平台C++ SDK的IHRTCConnection接口详情。 初始化等基础接口 表1 初始化等基础接口 接口 描述 release 释放IHRTCConnection对象资源 getRoomId 获取当前连接房间号 setNetworkBandwidth 设置网络带宽限制
数据洞察 您可以通过查看通话用量和质量数据，了解通话用量和质量的总体趋势、不同维度的分布情况和每天的数据明细。 注意事项 “数据洞察”中的数据仅供数据分析和质量问题查询，计费数据请以账单为准。 查询说明 支持查询最近90天的历史数据。 支持查询的时间跨度最长为31天。 操作步骤 登录实时音视频控制台。
接口按功能说明 初始化等基础接口 表1 初始化等基础接口 接口 描述 windows是否支持 Mac是否支持 iOS是否支持 Android是否支持 createHRtcEngine 创建IHRTCEngine对象 √ √ √ √ getHRtcEngine 获取创建后的IHRTCEngine对象
视频管理 setPriorRemoteVideoStreamType public abstract int setPriorRemoteVideoStreamType(HRTCVideoStreamType type); 【功能说明】 大小流模式，设置所有订阅的远端视频流类型。
启动合流任务 功能介绍 调用此接口创建合流转码任务。 支持纯音频录制和音视频录制： 纯音频录制 encode_template填audio_only，音频合流会动态选择最大三方的声音。 layout_template、layout_panes以及其他视频相关参数都不填，填就忽略。
修改合流任务 功能介绍 调用此接口更新合流任务布局。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/mix-stream-jobs/{job_id}
视频管理 enableLocalVideo virtual int enableLocalVideo(bool enabled) 【功能说明】 设置是否开启摄像头采集视频。 【请求参数】 enable：true表示开启。false表示关闭。 【返回参数】 0：方法调用成功。 >
常见问题 初始化引擎时，countryCode应该如何填写？ countryCode表示区域码，如果对应的是GLOBAL类型，则直接填空字符串，即""，如果是CN类型，则可以填"CN"。具体请参见国家码对照表。 初始化引擎时，domain应该如何填写？ 该字段已废弃，不需要再传值。
查询合流任务 功能介绍 调用此接口查询合流转码任务状态。 调试 您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/mix-stream-jobs/{job_id}
数据类型 本章节列出了iOS/macOS SDK的所有数据类型，您可以结合HWRtcEngine接口和回调进行开发。 表1 数据类型 类型 描述 HWRtcUserInfo 用户信息 HWRtcJoinParam 入会信息 HWRtcVideoEncode 视频编码 HWRtcDeviceInfo
视频管理 enableLocalVideo - (int)enableLocalVideo:(BOOL)enable; 【功能说明】 设置是否开启摄像头采集视频。 【请求参数】 enable：YES表示开启，NO表示关闭。 【返回参数】 0：方法调用成功。 > 0：方法调用失败。
合流录制 场景说明 将房间中的多路音视频进行云端混流，再将混合后的音视频流录制成一个文件。 合流布局 在合流录制模式下，支持分屏九宫格模板和共享屏幕模板（主视窗居左/主视窗居右）两种预设合流布局。同时，也支持用户自定义合流布局样式（自定义视频窗格位置）。 九宫格模板 每个用户画面
示例2：创建合流录制任务 场景描述 示例1：创建单流录制任务已介绍了如何将房间中的每一个用户的音视频流分别录制成独立的文件。若您需要将房间中的多个单流用户录制成一个文件，您可以参考此章节内容调用SparkRTC API进行合流录制。 前提条件 已获取需要使用的SparkRTC服务的终端节点：rtc-api
云资源授权 您可以将OBS桶授权给SparkRTC服务，允许录制文件存储在OBS桶中。 注意事项 授权的OBS桶所在区域必须为华北-北京四。 前提条件 因录制生成的视频文件是存储在OBS服务中的，因此，您需要先开通OBS服务，具体请参见OBS快速入门。 已在OBS服务中创建用于存
流对象（Stream） 本章节介绍了Web SDK的Stream接口详情。 表1 Stream接口 接口 描述 play 播放该音视频流。 stop 停止播放视频流。 resume 恢复播放音视频。 close 关闭音视频。 muteAudio 禁用音频轨道。 muteVideo
获取账号ID 在调用接口的时候，部分URL中需要填入账号ID，所以需要先在管理控制台上获取到账号ID。具体获取步骤如下： 登录管理控制台。 鼠标悬停在右上角的用户名，选择下拉列表中“我的凭证”。 在“API凭证”页面，即可获取对应的账号ID信息。 图1 获取账号ID 父主题： 附录
如何获取密钥？ app_key为华为云SparkRTC针对每个app生成的鉴权密钥，需要安全保存，谨防泄漏。您可以通过以下方式获取： 登录实时音视频控制台。 在左侧导航栏中，选择“应用管理”，进入应用管理页面。 在目标应用行单击应用名称，进入应用详情页面。 “鉴权私钥”可见状态下，复制应用的鉴权私钥。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
