# 接口总览
本章节介绍了Android SDK的HRtcEngine接口详情。
HRtcEngine按照其功能可分类为：初始化等基础接口、房间功能、视频管理、屏幕共享、音频管理、音效文件播放管理、自定义视频采集和渲染、自定义音频采集和渲染、设备管理、检测功能、音频增强管理。
![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/note_3.0-zh-cn.png)
单击下图中相应接口名称，可快速跳转到相应接口位置查看其使用方法。
![](https://support.huaweicloud.com/csdk-rtc/zh-cn_image_0000001164371650.jpg)
#### 初始化等基础接口
表1初始化等基础接口 
| 接口                                                                                                                    | 描述             |
|:---|:---|
| [create](https://support.huaweicloud.com/csdk-rtc/rtc_05_0013.html#rtc_05_0013__section16334153873510)                | 创建SparkRTC引擎实例 |
| [destroy](https://support.huaweicloud.com/csdk-rtc/rtc_05_0013.html#rtc_05_0013__section19355451000)                  | 销毁SparkRTC引擎   |
| [logUpload](https://support.huaweicloud.com/csdk-rtc/rtc_05_0013.html#rtc_05_0013__section19298162745210)             | 上传日志           |
| [disableRejoinRoom](https://support.huaweicloud.com/csdk-rtc/rtc_05_0013.html#rtc_05_0013__section24111741162112)     | 设置是否禁用房间重连功能。  |
| [enableStats](https://support.huaweicloud.com/csdk-rtc/rtc_05_0013.html#rtc_05_0013__section838003643912)             | 打点功能开关         |
| [getVersion](https://support.huaweicloud.com/csdk-rtc/rtc_05_0013.html#rtc_05_0013__section441944416519)              | 获取当前SDK版本号     |
| [setEncryption](https://support.huaweicloud.com/csdk-rtc/rtc_05_0013.html#rtc_05_0013__section0105725134218)          | 设置端到端加密模式      |
| [setAccessResourceType](https://support.huaweicloud.com/csdk-rtc/rtc_05_0013.html#rtc_05_0013__section17206112845914) | 设置接入环境         |
| [setNetworkBandwidth](https://support.huaweicloud.com/csdk-rtc/rtc_05_0013.html#rtc_05_0013__section117575259361)     | 设置网络带宽限制       |
   
#### 房间功能
表2房间功能接口 
| 接口                                                                                                                     | 描述                     |
|:---|:---|
| [joinRoom](https://support.huaweicloud.com/csdk-rtc/rtc_05_0014.html#rtc_05_0014__section05521352232)                  | 加入房间                   |
| [leaveRoom](https://support.huaweicloud.com/csdk-rtc/rtc_05_0014.html#rtc_05_0014__section182931125183617)             | 离开房间                   |
| [changeUserRole](https://support.huaweicloud.com/csdk-rtc/rtc_05_0014.html#rtc_05_0014__section119031354405)           | 设置用户角色                 |
| [renewAuthorization](https://support.huaweicloud.com/csdk-rtc/rtc_05_0014.html#rtc_05_0014__section1149915116525)      | 更新鉴权签名                 |
| [changeUserName](https://support.huaweicloud.com/csdk-rtc/rtc_05_0014.html#rtc_05_0014__section1837210581259)          | 更新用户昵称                 |
| [createConnection](https://support.huaweicloud.com/csdk-rtc/rtc_05_0014.html#rtc_05_0014__section4907123914135)        | 创建跨房（HRTCConnection）对象 |
| [addMultiRoomMediaRelay](https://support.huaweicloud.com/csdk-rtc/rtc_05_0014.html#rtc_05_0014__section12551115916508) | 添加单个跨房                 |
| [removeMultiRoomMediaRelay](https://support.huaweicloud.com/csdk-rtc/rtc_05_0014.html#rtc_05_0014__section16670506513) | 删除单个跨房                 |
| [stopMultiRoomMediaRelay](https://support.huaweicloud.com/csdk-rtc/rtc_05_0014.html#rtc_05_0014__section826416175117)  | 停止所有跨房                 |
   
#### 音频管理
表3音频管理接口 
| 接口                                                                                                                            | 描述               |
|:---|:---|
| [muteLocalAudio](https://support.huaweicloud.com/csdk-rtc/rtc_05_0015.html#rtc_05_0015__section16588164620472)                | 设置是否发送本地音频流      |
| [muteRemoteAudio](https://support.huaweicloud.com/csdk-rtc/rtc_05_0015.html#rtc_05_0015__section1431514215512)                | 设置是否接收对应远端用户的音频流 |
| [muteAllRemoteAudio](https://support.huaweicloud.com/csdk-rtc/rtc_05_0015.html#rtc_05_0015__section642016362569)              | 设置是否接收所有远端用户的音频流 |
| [enableLocalAudioStream](https://support.huaweicloud.com/csdk-rtc/rtc_05_0015.html#rtc_05_0015__section1216010422575)         | 设置是否开启音频采集       |
| [adjustRecordingVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0015.html#rtc_05_0015__section1244439145316)          | 调整录制音量           |
| [adjustPlaybackVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0015.html#rtc_05_0015__section12956337541)             | 调整播放音量           |
| [adjustPlaybackVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0015.html#rtc_05_0015__section1779163717918)           | 调整单个用户播放音量       |
| [sendAudioSeiMsg](https://support.huaweicloud.com/csdk-rtc/rtc_05_0015.html#rtc_05_0015__section82816563584)                  | 发送音频SEI          |
| [setAudioFrameRecordParameters](https://support.huaweicloud.com/csdk-rtc/rtc_05_0015.html#rtc_05_0015__section19447101034614) | 设置音频采集回调参数       |
| [setAudioConfig](https://support.huaweicloud.com/csdk-rtc/rtc_05_0015.html#rtc_05_0015__section46050319516)                   | 设置音频场景           |
   
#### 视频管理
表4视频管理接口 
| 接口                                                                                                                           | 描述                   |
|:---|:---|
| [createRenderer](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section1864113344374)                | 创建渲染视图               |
| [updateLocalRenderMode](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section19191741111418)        | 设置本地窗口显示模式，镜像模式      |
| [setupLocalView](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section369919364393)                 | 设置本地窗口               |
| [pushLocalVideo](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section111882014105118)              | 设置是否发送本地视频流          |
| [setVideoEncoderConfig](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section35551784574)           | 设置视频编码参数             |
| [setNonStandardVideoEncoder](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section85411256193615)   | 设置非标视频编码参数           |
| [setRemoteVideoAdjustResolution](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section558512791910) | 设置订阅视频流的分辨率自适应       |
| [startLocalPreview](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section130914201937)              | 开始本地预览               |
| [stopLocalPreview](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section15196111519414)             | 停止本地预览               |
| [startRemoteStreamView](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section1924015211982)         | 开始订阅远端视频流            |
| [stopRemoteStreamView](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section054283014919)           | 停止订阅远端视频流            |
| [setupRemoteView](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section91261445268)                 | 设置远端窗口视图             |
| [updateRemoteRenderMode](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section1282501012116)        | 设置远端窗口渲染模式，镜像模式      |
| [pullRemoteVideo](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section1597113221911)               | 设置是否接收对应远端用户的视频流     |
| [pullAllRemoteVideo](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section17226112252112)           | 设置是否接收所有远端用户的视频流     |
| [setVideoEncoderMirror](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section1082181715)            | 设置视频编码镜像模式           |
| [enableLocalVideo](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section1978411312820)              | 设置是否开启摄像头采集视频        |
| [enableVideoSuperResolution](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section1235812774918)    | 设置是否开启视频超分           |
| [enableSmallVideoStream](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section18812163015910)       | 开启并设置小流编码参数          |
| [setPriorRemoteVideoStreamType](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section6679174902816) | 设置默认订阅的视频流类型（大流还是小流） |
| [setRemoteVideoStreamType](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section14248165075714)     | 设置当前订阅的视频流类型         |
| [startPublishStream](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section1477155213595)            | 开始旁路推流               |
| [updateTransCoding](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section98313184814)               | 更新旁路推流               |
| [stopPublishStream](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section746517510911)              | 停止旁路推流               |
| [startAllRemoteView](https://support.huaweicloud.com/csdk-rtc/rtc_05_0016.html#rtc_05_0016__section1725113485615)            | 批量设置远端流视图            |
   
#### 屏幕共享
表5屏幕共享接口 
| 接口                                                                                                              | 描述     |
|:---|:---|
| [startScreenShare](https://support.huaweicloud.com/csdk-rtc/rtc_05_0017.html#rtc_05_0017__section18833475515)   | 开启屏幕共享 |
| [stopScreenShare](https://support.huaweicloud.com/csdk-rtc/rtc_05_0017.html#rtc_05_0017__section10970181810550) | 关闭屏幕共享 |
   
#### 辅流管理
表6辅流管理接口 
| 接口                                                                                                                                   | 描述              |
|:---|:---|
| [setAuxiliaryVideoEncodeSmooth](https://support.huaweicloud.com/csdk-rtc/rtc_05_0018.html#rtc_05_0018__section118171919145919)       | 设置是否开启辅流的流畅度优先。 |
| [startRemoteAuxiliaryStreamView](https://support.huaweicloud.com/csdk-rtc/rtc_05_0018.html#rtc_05_0018__section547410123129)         | 开始订阅辅流          |
| [stopRemoteAuxiliaryStreamView](https://support.huaweicloud.com/csdk-rtc/rtc_05_0018.html#rtc_05_0018__section464471181315)          | 停止订阅辅流          |
| [setRemoteAuxiliaryStreamViewRotation](https://support.huaweicloud.com/csdk-rtc/rtc_05_0018.html#rtc_05_0018__section18371658131317) | 设置辅流角度          |
| [updateRemoteAuxiliaryStreamRenderMode](https://support.huaweicloud.com/csdk-rtc/rtc_05_0018.html#rtc_05_0018__section2718922151)    | 设置辅流渲染模式，镜像模式   |
| [setAuxiliaryVideoEncoderConfig](https://support.huaweicloud.com/csdk-rtc/rtc_05_0018.html#rtc_05_0018__section99193211226)          | 设置辅流编码参数        |
| [setAuxExternalVideoCapture](https://support.huaweicloud.com/csdk-rtc/rtc_05_0023.html#rtc_05_0023__section5948203717594)            | 设置是否开启视频辅流外部采集  |
   
#### 音效文件播放管理
表7音效文件播放管理接口 
| 接口                                                                                                                           | 描述              |
|:---|:---|
| [startAudioFile](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section15716145713217)               | 开始播放音频文件        |
| [stopAudioFile](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section877343318225)                  | 停止播放音频文件        |
| [pauseAudioFile](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section57412409225)                  | 暂停播放音频文件        |
| [resumeAudioFile](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section1877964402218)               | 恢复播放音频文件        |
| [isPlayMixMyself](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section1895418521932)               | 是否只有本地可以听到混音    |
| [isMixWithMicrophone](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section209629576317)            | 是否需要替代采集        |
| [adjustAudioFileVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section0195155615161)         | 调整本地和远端音频播放的音量  |
| [adjustAudioFilePlayoutVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section14161121102716) | 调整本地音频播放的音量     |
| [adjustAudioFilePublishVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section17192115222914) | 调整远端音频播放的音量     |
| [getAudioFileVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section1470211174337)            | 获取音频播放的音量       |
| [getAudioFilePlayoutVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section9383629203618)     | 获取音频本地播放的音量     |
| [getAudioFilePublishVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section17317422193810)    | 获取音频远端播放的音量     |
| [getAudioFileDuration](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section20518133273914)         | 获取音频文件的时长       |
| [getAudioFilePosition](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section20314945124210)         | 获取音频文件当前播放位置    |
| [setAudioFilePosition](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section4361155716443)          | 设置音频文件播放位置      |
| [playAudioClip](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section538710347483)                  | 开始播放音效文件        |
| [stopAudioClip](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section1832553115814)                 | 停止播放音效文件        |
| [pauseAudioClip](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section16711659145915)               | 暂停播放音效文件        |
| [resumeAudioClip](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section3987601132)                  | 恢复播放音效文件        |
| [stopAllAudioClips](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section11756210148)               | 停止播放所有音效文件      |
| [pauseAllAudioClips](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section7321633163)               | 暂停播放所有音效文件      |
| [resumeAllAudioClips](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section85908431887)             | 恢复播放所有音效文件      |
| [setAudioClipsVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section746814891013)            | 设置音效播放的最大音量     |
| [getAudioClipsVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section1029095920131)           | 获取音效播放的最大音量     |
| [setVolumeOfAudioClip](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section17771953101516)         | 设置指定音效的播放音量     |
| [getVolumeOfAudioClip](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section1736235182015)          | 获取指定音效的播放音量     |
| [setAudioClipPosition](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section463725662217)           | 设置指定音效文件的播放位置   |
| [getAudioClipCurrentPosition](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section265213236261)    | 获取指定音效文件当前的播放位置 |
| [getAudioClipDuration](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section82718382918)            | 获取音效的文件时长       |
| [preloadAudioClip](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section1637731011315)              | 预加载音效文件         |
| [unloadAudioClip](https://support.huaweicloud.com/csdk-rtc/rtc_05_0019.html#rtc_05_0019__section1878092357)                  | 删除预加载音效文件       |
   
#### 音频增强管理
表8音频增强接口 
| 接口                                                                                                                     | 描述                                                                                                                                    |
|:---|:---|
| [enableUserVolumeNotify](https://support.huaweicloud.com/csdk-rtc/rtc_05_0020.html#rtc_05_0020__section16217114063820) | 设置音量值上报回调函数[onUserVolumeStatsNotify](https://support.huaweicloud.com/csdk-rtc/rtc_05_0025.html#rtc_05_0025__section1022642174710)回调周期 |
   
#### 检测功能
表9检测功能接口 
| 接口                                                                                                               | 描述       |
|:---|:---|
| [startNetworkTest](https://support.huaweicloud.com/csdk-rtc/rtc_05_0021.html#rtc_05_0021__section14389134611372) | 开启会前网络探测 |
| [stopNetworkTest](https://support.huaweicloud.com/csdk-rtc/rtc_05_0021.html#rtc_05_0021__section141075317378)    | 停止会前网络检测 |
   
#### 自定义视频采集和渲染
表10自定义视频采集和渲染接口 
| 接口                                                                                                                                | 描述           |
|:---|:---|
| [setExternalVideoFrameOutputEnable](https://support.huaweicloud.com/csdk-rtc/rtc_05_0023.html#rtc_05_0023__section83051118193520) | 设置视频数据输出使能   |
| [setExternalDataFrameOutputEnable](https://support.huaweicloud.com/csdk-rtc/rtc_05_0023.html#rtc_05_0023__section48811251105815)  | 设置共享数据输出使能   |
| [setExternalVideoCapture](https://support.huaweicloud.com/csdk-rtc/rtc_05_0023.html#rtc_05_0023__section1061143916591)            | 设置是否开启外部视频采集 |
| [pushExternalVideoFrame](https://support.huaweicloud.com/csdk-rtc/rtc_05_0023.html#rtc_05_0023__section142341321455)              | 输入外部视频数据     |
| [pushAuxExternalVideoFrame](https://support.huaweicloud.com/csdk-rtc/rtc_05_0023.html#rtc_05_0023__section26063159116)            | 辅流输入外部视频数据   |
   
#### 自定义音频采集和渲染
表11自定义音频采集和渲染接口 
| 接口                                                                                                                               | 描述           |
|:---|:---|
| [setExternalAudioFrameOutputEnable](https://support.huaweicloud.com/csdk-rtc/rtc_05_0022.html#rtc_05_0022__section1347165516410) | 设置音频数据输出使能   |
| [setExternalAudioCapture](https://support.huaweicloud.com/csdk-rtc/rtc_05_0022.html#rtc_05_0022__section1997697145812)           | 设置是否开启外部音频采集 |
| [pushExternalAudioFrame](https://support.huaweicloud.com/csdk-rtc/rtc_05_0022.html#rtc_05_0022__section145854591406)             | 输入外部音频数据     |
   
#### 设备管理
表12设备管理接口 
| 接口                                                                                                                   | 描述                                 |
|:---|:---|
| [setCameraConfig](https://support.huaweicloud.com/csdk-rtc/rtc_05_0024.html#rtc_05_0024__section868912312248)        | 设置摄像头参数                            |
| [switchCamera](https://support.huaweicloud.com/csdk-rtc/rtc_05_0024.html#rtc_05_0024__section19714055134010)         | 切换摄像头                              |
| [setSpeakerModel](https://support.huaweicloud.com/csdk-rtc/rtc_05_0024.html#rtc_05_0024__section2350548154915)       | 设置声音播放模式                           |
| [setDefaultSpeakerModel](https://support.huaweicloud.com/csdk-rtc/rtc_05_0024.html#rtc_05_0024__section182052614347) | 设置默认的声音播放模式                        |
| [setLayoutDirect](https://support.huaweicloud.com/csdk-rtc/rtc_05_0024.html#rtc_05_0024__section188417321798)        | 设置显示模式，区分横屏还是竖屏，用于保证摄像头方向与本地界面方向一致 |
| [isSpeakerphoneEnabled](https://support.huaweicloud.com/csdk-rtc/rtc_05_0024.html#rtc_05_0024__section1517035510344) | 查询是否启用扬声器                          |