检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 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
enableUserVolumeNotify(int interval); 【功能说明】 设置音量值上报回调函数(onUserVolumeStatsNotify)的回调周期。 【请求参数】 interval:音量值上报周期,默认关闭音量回调。 0:关闭音量回调。 [100,10000]:有效值范围,单位
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String
口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String
onAudioFramePlayback void onAudioFramePlayback(HRTCAudioFrame audioFrame) 【功能说明】 需要播放的音频数据回调,从接口回调中取到音频数据以作后处理。 【回调参数】 audioFrame:音频数据格式 ,具体请参见HRTCAudioFrame。
设置是否开启外部视频采集。 【请求参数】 enable:true表示开启视频自采集,false表示取消视频自采集。默认值为false。 format:设置外部采集的视频格式,默认为I420(即yuv420P)。 【返回参数】 0:方法调用成功。 > 0:方法调用失败。具体请参见HRTCErrorCode。
口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String
口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String
90000004:SDK发出的加入房间信令响应超时 90100009:web侧没有收到MSP下发的配置信息 90100008:websocket链路建链失败 10000001:服务侧返回的异常信息 31000003:服务侧返回的异常信息 32000030:服务侧返回的异常信息 15:浏览器设置sdp异常
90000004:SDK发出的加入房间信令响应超时 90100009:web侧没有收到MSP下发的配置信息 90100008:websocket链路建链失败 10000001:服务侧返回的异常信息 31000003:服务侧返回的异常信息 32000030:服务侧返回的异常信息 15:浏览器设置sdp异常
口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String
口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String
口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String
设置是否接收所有远端用户的音频流。 【请求参数】 mute:true表示取消音频流接收,false表示开启音频流接收。 【返回参数】 0:成功。 > 0:失败。具体请参见客户端错误码。 取消所有音频流接收,同时也会取消接收新加入用户的音频流。 开启所有音频流接收,同时也会开启接收新加入用户的音频流。
口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String
口获取(响应消息头中X-Subject-Token的值)。 Authorization 否 String 使用AK/SK方式认证时必选,携带的鉴权信息。 X-Sdk-Date 否 String 使用AK/SK方式认证时必选,请求的发生时间。 X-Project-Id 否 String
权签名的生成方法。 参数说明 表1 参数说明 参数 说明 X-Rtc-Rand 消息请求头中的随机数。 X-Rtc-Timestamp 消息请求头中的时间戳。 X-Rtc-Signature 消息请求头中的签名。 msg 消息请求中body体的内容。 生成录制回调鉴权签名的方法 将如下参数拼接为一个字符串。
String 应用的状态: ACTIVATION:应用开启 DEACTIVATION:应用停用 ARREARS:应用欠费 offset 否 Integer 查询结果起始编号,此处代表分页的页码,默认为0。 limit 否 Integer 查询结果集数量,此处代表每一页的条数,最小为1,最大为100。默认为100。
设置是否接收所有远端用户的音频流。 【请求参数】 mute:true表示取消音频流接收,false表示开启音频流接收。 【返回参数】 0:成功。 > 0:失败。具体请参见客户端错误码。 取消所有音频流接收,同时也会取消接收新加入用户的音频流。 开启所有音频流接收,同时也会开启接收新加入用户的音频流。