# 接口总览
本章节介绍了iOS/macOS SDK的HWRtcEngine接口详情。
HWRtcEngine按照其功能可分类为：初始化等基础接口、房间功能、视频管理、辅流管理、共享屏幕、音频管理、音效文件播放管理、自定义视频采集和渲染、自定义音频采集和渲染、设备管理、检测功能、音频增强管理。
![](https://support.huaweicloud.com/csdk-rtc/public_sys-resources/note_3.0-zh-cn.png)
单击下图中相应接口名称，可快速跳转到相应接口位置查看其使用方法。
![](https://support.huaweicloud.com/csdk-rtc/zh-cn_image_0000001208716689.jpg)
#### 初始化等基础接口
表1初始化等基础接口 
| 接口                                                                                                                    | 描述        |
|:---|:---|
| [sharedEngine](https://support.huaweicloud.com/csdk-rtc/rtc_05_0054.html#rtc_05_0054__section209051452115920)         | 创建连麦引擎实例  |
| [destroy](https://support.huaweicloud.com/csdk-rtc/rtc_05_0054.html#rtc_05_0054__section89051752195910)               | 注销引擎      |
| [initWithConfig](https://support.huaweicloud.com/csdk-rtc/rtc_05_0054.html#rtc_05_0054__section54041302507)           | 初始化引擎配置信息 |
| [logUpload](https://support.huaweicloud.com/csdk-rtc/rtc_05_0054.html#rtc_05_0054__section1594415523598)              | 上传日志      |
| [setEnableRtcStats](https://support.huaweicloud.com/csdk-rtc/rtc_05_0054.html#rtc_05_0054__section6970115295918)      | 打点开关      |
| [getVersion](https://support.huaweicloud.com/csdk-rtc/rtc_05_0054.html#rtc_05_0054__section1655161131316)             | 获取SDK版本号  |
| [setEncrytionParam](https://support.huaweicloud.com/csdk-rtc/rtc_05_0054.html#rtc_05_0054__section1883583610534)      | 设置端到端加密模式 |
| [setAccessResourceType](https://support.huaweicloud.com/csdk-rtc/rtc_05_0054.html#rtc_05_0054__section17206112845914) | 设置接入的环境   |
| [setNetworkBandwidth](https://support.huaweicloud.com/csdk-rtc/rtc_05_0054.html#rtc_05_0054__section154013151346)     | 设置网络带宽限制  |
   
#### 房间功能
表2房间功能接口 
| 接口                                                                                                                     | 描述                                 |
|:---|:---|
| [joinRoom](https://support.huaweicloud.com/csdk-rtc/rtc_05_0055.html#rtc_05_0055__section8907115215594)                | 加入房间                               |
| [changeUserRole](https://support.huaweicloud.com/csdk-rtc/rtc_05_0055.html#rtc_05_0055__section7908952135910)          | 设置用户的角色，切换角色时使用                    |
| [renewAuthorization](https://support.huaweicloud.com/csdk-rtc/rtc_05_0055.html#rtc_05_0055__section592115527594)       | 签名更新                               |
| [leaveRoom](https://support.huaweicloud.com/csdk-rtc/rtc_05_0055.html#rtc_05_0055__section209254523595)                | 离开房间                               |
| [changeUserName](https://support.huaweicloud.com/csdk-rtc/rtc_05_0055.html#rtc_05_0055__section153811943172113)        | 设置用户自己的昵称                          |
| [createConnection](https://support.huaweicloud.com/csdk-rtc/rtc_05_0055.html#rtc_05_0055__section27153266344)          | 创建 跨房（HWRtcConnection）对象，跨房前需先创建连接 |
| [addMultiRoomMediaRelay](https://support.huaweicloud.com/csdk-rtc/rtc_05_0055.html#rtc_05_0055__section12551115916508) | 添加单个跨房                             |
| [removeMultiRoomMediaRelay](https://support.huaweicloud.com/csdk-rtc/rtc_05_0099.html#rtc_05_0099__section16670506513) | 删除单个跨房                             |
| [stopMultiRoomMediaRelay](https://support.huaweicloud.com/csdk-rtc/rtc_05_0055.html#rtc_05_0055__section826416175117)  | 停止所有跨房                             |
   
#### 音频管理
表3音频管理接口 
| 接口                                                                                                                            | 描述                 |
|:---|:---|
| [muteLocalAudio](https://support.huaweicloud.com/csdk-rtc/rtc_05_0056.html#rtc_05_0056__section14916155211594)                | 设置是否发送本地音频流        |
| [enableLocalAudioStream](https://support.huaweicloud.com/csdk-rtc/rtc_05_0056.html#rtc_05_0056__section28374325569)           | 设置是否开启麦克风采集音频      |
| [muteRemoteAudio](https://support.huaweicloud.com/csdk-rtc/rtc_05_0056.html#rtc_05_0056__section794925214599)                 | 订阅或取消订阅远端某个用户音频流   |
| [muteAllRemoteAudio](https://support.huaweicloud.com/csdk-rtc/rtc_05_0056.html#rtc_05_0056__section1795016529592)             | 订阅或取消订阅全部远端用户音频流   |
| [setVolumeNotifyInterval](https://support.huaweicloud.com/csdk-rtc/rtc_05_0056.html#rtc_05_0056__section37939461531)          | 设置最大音量上报频率         |
| [adjustRecordingVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0056.html#rtc_05_0056__section1244439145316)          | 设置麦克风采集的音量（0-100）  |
| [adjustPlaybackVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0056.html#rtc_05_0056__section1395412217499)           | 调整扬声器播放的音量（0-100）  |
| [setShareComputerSound](https://support.huaweicloud.com/csdk-rtc/rtc_05_0056.html#rtc_05_0056__section1669419351180)          | 共享声音 (只支持macOS)    |
| [sendAudioSeiMsg](https://support.huaweicloud.com/csdk-rtc/rtc_05_0056.html#rtc_05_0056__section82816563584)                  | 发送音频SEI消息          |
| [setDefaultSpeakerModel](https://support.huaweicloud.com/csdk-rtc/rtc_05_0056.html#rtc_05_0056__section182052614347)          | 设置默认的声音播放模式，在房间外调用 |
| [setAudioFrameRecordParameters](https://support.huaweicloud.com/csdk-rtc/rtc_05_0056.html#rtc_05_0056__section19447101034614) | 设置音频采集回调参数         |
| [setAudioConfig](https://support.huaweicloud.com/csdk-rtc/rtc_05_0056.html#rtc_05_0056__section46050319516)                   | 设置音频场景             |
   
#### 视频管理
表4视频管理接口 
| 接口                                                                                                                             | 描述                     |
|:---|:---|
| [enableLocalVideo](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section120911211174)                 | 设置是否开启摄像头采集视频          |
| [setVideoEncoderConfig](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section5907852165911)           | 设置视频编码参数               |
| [enableSmallVideoStream](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section3390341101916)          | 大小流模式设置是否开启小流并设置小流编码参数 |
| [startLocalPreview](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section195642044182316)             | 开启本地预览                 |
| [stopLocalPreview](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section1385816372418)                | 关闭本地预览                 |
| [setupLocalVideo](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section1391115528594)                 | 设置/取消本地预览视图            |
| [updateLocalRenderMode](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section77818279227)             | 设置本地视频显示模式和镜像模式        |
| [setupRemoteView](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section16919123510315)                | 设置远端流视图                |
| [updateRemoteRenderMode](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section73014843815)            | 设置远端视图显示模式，镜像模式        |
| [setRemoteVideoStreamType](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section18388359123913)       | 设置选看指定用户的大流或者小流        |
| [setPriorRemoteVideoStreamType](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section93774712710)     | 设置默认选看远端的大流或者小流        |
| [pushLocalVideo](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section17218192516194)                 | 设置是否发送本地视频流            |
| [pullRemoteVideo](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section1570316192208)                 | 订阅或取消订阅远端某个用户视频流       |
| [pullAllRemoteVideo](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section1952293815208)              | 订阅或取消订阅全部远端用户视频流       |
| [startRemoteStreamView](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section16912135212596)          | 设置远端用户渲染视图（发起选看-旧接口）   |
| [stopRemoteStreamView](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section09130527598)              | 关闭远端用户的渲染视图（停止选看）      |
| [setRemoteVideoAdjustResolution](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section15740162310517) | 设置远端下行视频流的分辨率自适应       |
| [setVideoEncoderMirror](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section095235218590)            | 设置视频编码镜像模式             |
| [startPublishStream](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section2619142912118)              | 开始旁路推流                 |
| [updateTransCoding](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section143116169135)                | 更新旁路推流                 |
| [stopPublishStream](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section191021117101410)             | 停止旁路推流                 |
| [startAllRemoteView](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section2051213523118)              | 批量设置远端流视图              |
| [appendLocalView](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section17802165522413)                | 设置本地视频另一个窗口显示          |
| [appendRemoteView](https://support.huaweicloud.com/csdk-rtc/rtc_05_0057.html#rtc_05_0057__section59552482820)                  | 设置远端视频另一个窗口显示          |
   
#### 辅流管理
表5辅流管理接口 
| 接口                                                                                                                                   | 描述               |
|:---|:---|
| [startRemoteAuxiliaryStreamView](https://support.huaweicloud.com/csdk-rtc/rtc_05_0058.html#rtc_05_0058__section9769030181115)        | 开启辅流渲染视图（发起辅流选看） |
| [stopRemoteAuxiliaryStreamView](https://support.huaweicloud.com/csdk-rtc/rtc_05_0058.html#rtc_05_0058__section10770530201110)        | 关闭辅流渲染视图（停止辅流选看） |
| [updateRemoteAuxiliaryStreamRenderMode](https://support.huaweicloud.com/csdk-rtc/rtc_05_0058.html#rtc_05_0058__section1177063020110) | 设置辅流视图渲染模式，镜像模式  |
| [setRemoteAuxiliaryStreamViewRotation](https://support.huaweicloud.com/csdk-rtc/rtc_05_0058.html#rtc_05_0058__section154531628439)   | 设置辅流视图角度         |
| [setAuxiliaryVideoEncoderConfig](https://support.huaweicloud.com/csdk-rtc/rtc_05_0058.html#rtc_05_0058__section54941958102419)       | 设置辅流编码能力         |
| [setAuxiliaryVideoEncodeSmooth](https://support.huaweicloud.com/csdk-rtc/rtc_05_0058.html#rtc_05_0058__section1581063315017)         | 设置是否开启辅流的流畅度优先   |
| [pushAuxExternalVideoFrame](https://support.huaweicloud.com/csdk-rtc/rtc_05_0058.html#rtc_05_0058__section493014447129)              | 推送辅流数据           |
   
#### 屏幕共享
表6屏幕共享接口 
| 接口                                                                                                                       | 描述                       |
|:---|:---|
| [startScreenShare](https://support.huaweicloud.com/csdk-rtc/rtc_05_0059.html#rtc_05_0059__section3855145871418)          | 开启屏幕共享                   |
| [startScreenShareWithAppGroup](https://support.huaweicloud.com/csdk-rtc/rtc_05_0059.html#rtc_05_0059__section2905144517) | 根据AppGroup开启屏幕共享（只支持iOS） |
| [stopScreenShare](https://support.huaweicloud.com/csdk-rtc/rtc_05_0059.html#rtc_05_0059__section17786125001718)          | 关闭屏幕共享                   |
| [getScreenShareSources](https://support.huaweicloud.com/csdk-rtc/rtc_05_0059.html#rtc_05_0059__section16140162553510)    | 获取共享资源列表                 |
| [setScreenShareTarget](https://support.huaweicloud.com/csdk-rtc/rtc_05_0059.html#rtc_05_0059__section1858962804415)      | 设置共享对象                   |
   
#### 音效文件播放管理
表7音频文件播放管理接口 
| 接口                                                                                                                         | 描述           |
|:---|:---|
| [startAudioFile](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section1295385213597)              | 开始播放音频文件     |
| [stopAudioFile](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section1095575275916)               | 停止播放音频文件     |
| [pauseAudioFile](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section199561452105911)            | 暂停播放音频文件     |
| [resumeAudioFile](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section49570521595)               | 恢复播放音频文件     |
| [adjustAudioFileVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section575110491068)        | 调节音频文件播放音量   |
| [adjustAudioFilePlayoutVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section159416242816) | 设置本地播放音频音量   |
| [getAudioFileVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section1986318138126)          | 获取音频文件播放音量   |
| [getAudioFilePlayoutVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section550220134139)    | 获取音频文件本地播放音量 |
| [getAudioFileDuration](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section22831357131918)       | 获取音频文件时长     |
| [getAudioFileCurrentPosition](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section311435992019)  | 获取当前音频播放位置   |
| [setAudioFilePosition](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section133028395212)         | 设置音频播放位置     |
| [getAudioClipsVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section112781043811)          | 获取音效总音量      |
| [getVolumeOfAudioClip](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section1648712418229)        | 获取指定音效音量     |
| [setAudioClipsVolume](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section25442023172312)        | 设置音效总音量      |
| [setVolumeOfAudioClip](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section392701122416)         | 设置指定音效音量     |
| [playAudioClip](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section876449112412)                | 播放音效文件       |
| [stopAudioClip](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section49713434318)                 | 停止播放指定音效     |
| [stopAllAudioClips](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section14591417184515)          | 停止播放所有音效     |
| [pauseAudioClip](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section1970423324919)              | 暂停播放指定音效     |
| [pauseAllAudioClips](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section18660171813508)         | 暂停播放所有音效     |
| [resumeAudioClip](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section1820115795117)             | 恢复播放指定音效     |
| [resumeAllAudioClips](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section7401454185213)         | 恢复播放所有音效     |
| [getAudioClipCurrentPosition](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section1395884217533) | 获取指定音效当前播放位置 |
| [setAudioClipPosition](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section18885161795514)       | 设置指定音效播放位置   |
| [getAudioClipDuration](https://support.huaweicloud.com/csdk-rtc/rtc_05_0060.html#rtc_05_0060__section22321159195610)       | 获取音效文件时长     |
   
#### 检测功能
表8检测功能接口 
| 接口                                                                                                               | 描述         |
|:---|:---|
| [startNetworkTest](https://support.huaweicloud.com/csdk-rtc/rtc_05_0061.html#rtc_05_0061__section49671252165914) | 会前网络质量开启测试 |
| [stopNetworkTest](https://support.huaweicloud.com/csdk-rtc/rtc_05_0061.html#rtc_05_0061__section896845218593)    | 会前网络质量停止测试 |
   
#### 自定义音频采集和渲染
表9自定义音频采集和渲染接口 
| 接口                                                                                                                     | 描述           |
|:---|:---|
| [setExternalAudioCapture](https://support.huaweicloud.com/csdk-rtc/rtc_05_0062.html#rtc_05_0062__section1695913526591) | 设置是否开启外部音频采集 |
| [pushExternalAudioFrame](https://support.huaweicloud.com/csdk-rtc/rtc_05_0062.html#rtc_05_0062__section1096315211591)  | 输入外部音频数据     |
   
#### 自定义视频采集和渲染
表10自定义视频采集和渲染接口 
| 接口                                                                                                                                     | 描述                 |
|:---|:---|
| [setExternalVideoCapture](https://support.huaweicloud.com/csdk-rtc/rtc_05_0063.html#rtc_05_0063__section129616522599)                  | 设置是否开启外部视频采集       |
| [pushExternalVideoFrame](https://support.huaweicloud.com/csdk-rtc/rtc_05_0063.html#rtc_05_0063__section16964105245910)                 | 输入外部视频数据           |
| [setExternalMediaFrameOutput](https://support.huaweicloud.com/csdk-rtc/rtc_05_0063.html#rtc_05_0063__section696510529596)              | 设置媒体数据自渲染          |
| [setExternalVideoFrameOutputWithFormat](https://support.huaweicloud.com/csdk-rtc/rtc_05_0063.html#rtc_05_0063__section139021359171216) | 带Format参数设置媒体数据自渲染 |
| [pushAuxExternalVideoFrame](https://support.huaweicloud.com/csdk-rtc/rtc_05_0063.html#rtc_05_0063__section26063159116)                 | 辅流输入外部视频数据         |
   
#### 设备管理
表11设备管理接口 
| 接口                                                                                                                      | 描述                   |
|:---|:---|
| [setSpeakerModel](https://support.huaweicloud.com/csdk-rtc/rtc_05_0064.html#rtc_05_0064__section2918135219592)          | 设置声音播放模式（只支持iphone）  |
| [setCameraConfig](https://support.huaweicloud.com/csdk-rtc/rtc_05_0064.html#rtc_05_0064__section714517587553)           | 设置摄像头相关参数            |
| [switchCamera](https://support.huaweicloud.com/csdk-rtc/rtc_05_0064.html#rtc_05_0064__section2091945235910)             | 切换前后镜头（只支持iphone）    |
| [recordingDeviceTest](https://support.huaweicloud.com/csdk-rtc/rtc_05_0064.html#rtc_05_0064__section866803017541)       | 音频采集设备测试（只支持macOS）   |
| [finishRecordingDeviceTest](https://support.huaweicloud.com/csdk-rtc/rtc_05_0064.html#rtc_05_0064__section457832717419) | 结束音频采集设备测试（只支持macOS） |
| [playbackDeviceTest](https://support.huaweicloud.com/csdk-rtc/rtc_05_0064.html#rtc_05_0064__section21581945358)         | 音频播放设备测试（只支持macOS）   |
| [finishPlaybackDeviceTest](https://support.huaweicloud.com/csdk-rtc/rtc_05_0064.html#rtc_05_0064__section1929934920710) | 结束音频播放设备测试（只支持macOS） |
| [echoTest](https://support.huaweicloud.com/csdk-rtc/rtc_05_0064.html#rtc_05_0064__section89472052481)                   | 音频设备回路测试（只支持macOS）   |
| [finishEchoTest](https://support.huaweicloud.com/csdk-rtc/rtc_05_0064.html#rtc_05_0064__section1755875614103)           | 结束音频设备回路测试（只支持macOS） |
| [cameraDeviceTest](https://support.huaweicloud.com/csdk-rtc/rtc_05_0064.html#rtc_05_0064__section1873923714127)         | 视频采集设备测试             |
| [finishCameraDeviceTest](https://support.huaweicloud.com/csdk-rtc/rtc_05_0064.html#rtc_05_0064__section111721755161611) | 结束视频采集设备测试           |