检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
接口总览 本章节介绍了全平台C++ SDK的IHRTCEngine接口详情。 IHRTCEngine按照其功能可分类为：初始化等基础接口、房间功能、视频管理、辅流管理、屏幕共享、音频管理、音效文件播放管理、自采集自渲染、其他接口。 单击下图中相应接口名称，可快速跳转到相应接口位置查看其使用方法。
口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。 X-Project-Id 否 String
本地服务端录制需要使用Linux SDK，可部署在客户Linux 服务器上，使用客户自有的服务器和存储资源。 云端录制无需部署客户自有Linux服务器，减轻了研发和运维的压力，更轻量便捷。 父主题： 录制相关
enableUserVolumeNotify(int interval); 【功能说明】 设置音量值上报回调函数(onUserVolumeStatsNotify)的回调周期。 【请求参数】 interval：音量值上报周期，默认关闭音量回调。 0：关闭音量回调。 [100，10000]：有效值范围，单位
onAudioFramePlayback void onAudioFramePlayback(HRTCAudioFrame audioFrame) 【功能说明】 需要播放的音频数据回调，从接口回调中取到音频数据以作后处理。 【回调参数】 audioFrame：音频数据格式 ，具体请参见HRTCAudioFrame。
设置是否开启外部视频采集。需要在加入房间前调用。 【请求参数】 enable：YES表示开启，NO表示关闭。默认为NO。 format：设置外部采集的视频格式，默认为I420（即yuv420P）。 【返回参数】 0：方法调用成功。 > 0：方法调用失败。具体请参见HWRtcErrorCode。
设置是否开启外部视频采集。 【请求参数】 enable：true表示开启视频自采集，false表示取消视频自采集。默认值为false。 format：设置外部采集的视频格式，默认为I420（即yuv420P）。 【返回参数】 0：方法调用成功。 > 0：方法调用失败。具体请参见HRTCErrorCode。
横屏重力感应，3表示重力感应，4表示竖屏模式且不会随设备旋转改变采集角度，5表示adaptive模式，适用非dns模式推流外的大部分场景，能自动适配app的布局，自动调整采集方向。 【返回参数】 无 父主题： HRtcEngine
口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。 X-Project-Id 否 String
设置音效播放的最大音量 getAudioClipsVolume 获取音效播放的最大音量 setVolumeOfAudioClip 设置指定音效的播放音量 getVolumeOfAudioClip 获取指定音效的播放音量 setAudioClipPosition 设置指定音效文件的播放位置
设置是否接收所有远端用户的音频流。 【请求参数】 mute：true表示取消音频流接收，false表示开启音频流接收。 【返回参数】 0：成功。 > 0：失败。具体请参见客户端错误码。 取消所有音频流接收，同时也会取消接收新加入用户的音频流。 开启所有音频流接收，同时也会开启接收新加入用户的音频流。
权签名的生成方法。 参数说明 表1 参数说明 参数 说明 X-Rtc-Rand 消息请求头中的随机数。 X-Rtc-Timestamp 消息请求头中的时间戳。 X-Rtc-Signature 消息请求头中的签名。 msg 消息请求中body体的内容。 生成录制回调鉴权签名的方法 将如下参数拼接为一个字符串。
String 应用的状态： ACTIVATION：应用开启 DEACTIVATION：应用停用 ARREARS：应用欠费 offset 否 Integer 查询结果起始编号，此处代表分页的页码，默认为0。 limit 否 Integer 查询结果集数量，此处代表每一页的条数，最小为1，最大为100。默认为100。
edNotify ：会议中修改用户昵称的接口及本地和远端会收到的回调。 createConnection：加入多房间（跨房）前，与要跨入的房间先建立连接的接口，跨一个房间建立一个连接。 setDefaultSpeakerModel：设置默认的声音播放模式。 onMediaConn
setVolume4TopThree(volume) 开启/禁用音频最大三方模式的音轨 调用muteAudio4TopThree接口可以开启/禁用音频最大三方模式的音轨，true表示禁用音频最大三方模式的音轨，false表示开启音频最大三方模式的音轨。 示例代码如下： this.client.muteAudio4TopThree(true)
*)userid muted:(BOOL)muted; 【功能说明】 订阅或取消订阅对应远端用户的音频流。同一时间所有房间最多只能接收17路音频流。 【请求参数】 userid : 远端用户的id，唯一的标识。 muted：YES表示取消订阅，NO表示订阅。默认值 NO。 【返回参数】 0：方法调用成功。
Name不能为空或空字符串，该名称可从getScreenShareSources接口获取。 如设置的rect为NSRect(0,0,0,0)，则会根据共享的id和名称取得相应对象的默认区域作为共享范围。 adjustAudioShareVolume - (int)adjustAu
多辅流场景，一个用户同时只能订阅一条辅流；当前正在订阅用户A的辅流，需要订阅另一个用户B的辅流时，需要先停止订阅用户A的辅流，再订阅用户B的辅流。 stopRemoteAuxiliaryStreamView virtual int stopRemoteAuxiliaryStreamView(const
口获取（响应消息头中X-Subject-Token的值）。 Authorization 否 String 使用AK/SK方式认证时必选，携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选，请求的发生时间。 X-Project-Id 否 String
数据统计分析中增加查询服务端实时通话指标和查询流量数据分布接口。 修改创建或更新录制规则接口的“record_prefix”参数，增加自定义特殊变量的说明。 修改“使用前必读”中的API流控限制。 增加启动合流任务的请求示例。 2021-08-05 第三次正式发布 本次变更如下： 新增数据统计分析接口。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
