接口总览
本章节介绍了Android SDK的HRtcEngine接口详情。
HRtcEngine按照其功能可分类为：初始化等基础接口、房间功能、视频管理、屏幕共享、音频管理、音效文件播放管理、自定义视频采集和渲染、自定义音频采集和渲染、设备管理、检测功能、音频增强管理。
单击下图中相应接口名称，可快速跳转到相应接口位置查看其使用方法。
初始化等基础接口
|
接口 |
描述 |
|---|---|
|
创建SparkRTC引擎实例 |
|
|
销毁SparkRTC引擎 |
|
|
上传日志 |
|
|
设置是否禁用房间重连功能。 |
|
|
打点功能开关 |
|
|
获取当前SDK版本号 |
|
|
设置端到端加密模式 |
|
|
设置接入环境 |
|
|
设置网络带宽限制 |
房间功能
|
接口 |
描述 |
|---|---|
|
加入房间 |
|
|
离开房间 |
|
|
设置用户角色 |
|
|
更新鉴权签名 |
|
|
更新用户昵称 |
|
|
创建跨房（HRTCConnection）对象 |
|
|
添加单个跨房 |
|
|
删除单个跨房 |
|
|
停止所有跨房 |
音频管理
|
接口 |
描述 |
|---|---|
|
设置是否发送本地音频流 |
|
|
设置是否接收对应远端用户的音频流 |
|
|
设置是否接收所有远端用户的音频流 |
|
|
设置是否开启音频采集 |
|
|
调整录制音量 |
|
|
调整播放音量 |
|
|
调整单个用户播放音量 |
|
|
发送音频SEI |
|
|
设置音频采集回调参数 |
|
|
设置音频场景 |
视频管理
|
接口 |
描述 |
|---|---|
|
创建渲染视图 |
|
|
设置本地窗口显示模式，镜像模式 |
|
|
设置本地窗口 |
|
|
设置是否发送本地视频流 |
|
|
设置视频编码参数 |
|
|
设置非标视频编码参数 |
|
|
设置订阅视频流的分辨率自适应 |
|
|
开始本地预览 |
|
|
停止本地预览 |
|
|
开始订阅远端视频流 |
|
|
停止订阅远端视频流 |
|
|
设置远端窗口视图 |
|
|
设置远端窗口渲染模式，镜像模式 |
|
|
设置是否接收对应远端用户的视频流 |
|
|
设置是否接收所有远端用户的视频流 |
|
|
设置视频编码镜像模式 |
|
|
设置是否开启摄像头采集视频 |
|
|
设置是否开启视频超分 |
|
|
开启并设置小流编码参数 |
|
|
设置默认订阅的视频流类型（大流还是小流） |
|
|
设置当前订阅的视频流类型 |
|
|
开始旁路推流 |
|
|
更新旁路推流 |
|
|
停止旁路推流 |
|
|
批量设置远端流视图 |
屏幕共享
|
接口 |
描述 |
|---|---|
|
开启屏幕共享 |
|
|
关闭屏幕共享 |
辅流管理
|
接口 |
描述 |
|---|---|
|
设置是否开启辅流的流畅度优先。 |
|
|
开始订阅辅流 |
|
|
停止订阅辅流 |
|
|
设置辅流角度 |
|
|
设置辅流渲染模式，镜像模式 |
|
|
设置辅流编码参数 |
|
|
设置是否开启视频辅流外部采集 |
音效文件播放管理
|
接口 |
描述 |
|---|---|
|
开始播放音频文件 |
|
|
停止播放音频文件 |
|
|
暂停播放音频文件 |
|
|
恢复播放音频文件 |
|
|
是否只有本地可以听到混音 |
|
|
是否需要替代采集 |
|
|
调整本地和远端音频播放的音量 |
|
|
调整本地音频播放的音量 |
|
|
调整远端音频播放的音量 |
|
|
获取音频播放的音量 |
|
|
获取音频本地播放的音量 |
|
|
获取音频远端播放的音量 |
|
|
获取音频文件的时长 |
|
|
获取音频文件当前播放位置 |
|
|
设置音频文件播放位置 |
|
|
开始播放音效文件 |
|
|
停止播放音效文件 |
|
|
暂停播放音效文件 |
|
|
恢复播放音效文件 |
|
|
停止播放所有音效文件 |
|
|
暂停播放所有音效文件 |
|
|
恢复播放所有音效文件 |
|
|
设置音效播放的最大音量 |
|
|
获取音效播放的最大音量 |
|
|
设置指定音效的播放音量 |
|
|
获取指定音效的播放音量 |
|
|
设置指定音效文件的播放位置 |
|
|
获取指定音效文件当前的播放位置 |
|
|
获取音效的文件时长 |
|
|
预加载音效文件 |
|
|
删除预加载音效文件 |
音频增强管理
|
接口 |
描述 |
|---|---|
|
设置音量值上报回调函数onUserVolumeStatsNotify回调周期 |
检测功能
|
接口 |
描述 |
|---|---|
|
开启会前网络探测 |
|
|
停止会前网络检测 |
自定义视频采集和渲染
|
接口 |
描述 |
|---|---|
|
设置视频数据输出使能 |
|
|
设置共享数据输出使能 |
|
|
设置是否开启外部视频采集 |
|
|
输入外部视频数据 |
|
|
辅流输入外部视频数据 |
自定义音频采集和渲染
|
接口 |
描述 |
|---|---|
|
设置音频数据输出使能 |
|
|
设置是否开启外部音频采集 |
|
|
输入外部音频数据 |
设备管理
|
接口 |
描述 |
|---|---|
|
设置摄像头参数 |
|
|
切换摄像头 |
|
|
设置声音播放模式 |
|
|
设置默认的声音播放模式 |
|
|
设置显示模式，区分横屏还是竖屏，用于保证摄像头方向与本地界面方向一致 |
|
|
查询是否启用扬声器 |
