接口总览
本章节介绍了iOS/macOS SDK的HWRtcEngine接口详情。
HWRtcEngine按照其功能可分类为：初始化等基础接口、房间功能、视频管理、辅流管理、共享屏幕、音频管理、音效文件播放管理、自定义视频采集和渲染、自定义音频采集和渲染、设备管理、检测功能、音频增强管理。
单击下图中相应接口名称，可快速跳转到相应接口位置查看其使用方法。
初始化等基础接口
|
接口 |
描述 |
|---|---|
|
创建连麦引擎实例 |
|
|
注销引擎 |
|
|
初始化引擎配置信息 |
|
|
上传日志 |
|
|
打点开关 |
|
|
获取SDK版本号 |
|
|
设置端到端加密模式 |
|
|
设置接入的环境 |
|
|
设置网络带宽限制 |
房间功能
|
接口 |
描述 |
|---|---|
|
加入房间 |
|
|
设置用户的角色，切换角色时使用 |
|
|
签名更新 |
|
|
离开房间 |
|
|
设置用户自己的昵称 |
|
|
创建 跨房（HWRtcConnection）对象，跨房前需先创建连接 |
|
|
添加单个跨房 |
|
|
删除单个跨房 |
|
|
停止所有跨房 |
音频管理
|
接口 |
描述 |
|---|---|
|
设置是否发送本地音频流 |
|
|
设置是否开启麦克风采集音频 |
|
|
订阅或取消订阅远端某个用户音频流 |
|
|
订阅或取消订阅全部远端用户音频流 |
|
|
设置最大音量上报频率 |
|
|
设置麦克风采集的音量（0-100） |
|
|
调整扬声器播放的音量（0-100） |
|
|
共享声音 (只支持macOS) |
|
|
发送音频SEI消息 |
|
|
设置默认的声音播放模式，在房间外调用 |
|
|
设置音频采集回调参数 |
|
|
设置音频场景 |
视频管理
|
接口 |
描述 |
|---|---|
|
设置是否开启摄像头采集视频 |
|
|
设置视频编码参数 |
|
|
大小流模式设置是否开启小流并设置小流编码参数 |
|
|
开启本地预览 |
|
|
关闭本地预览 |
|
|
设置/取消本地预览视图 |
|
|
设置本地视频显示模式和镜像模式 |
|
|
设置远端流视图 |
|
|
设置远端视图显示模式，镜像模式 |
|
|
设置选看指定用户的大流或者小流 |
|
|
设置默认选看远端的大流或者小流 |
|
|
设置是否发送本地视频流 |
|
|
订阅或取消订阅远端某个用户视频流 |
|
|
订阅或取消订阅全部远端用户视频流 |
|
|
设置远端用户渲染视图（发起选看-旧接口） |
|
|
关闭远端用户的渲染视图（停止选看） |
|
|
设置远端下行视频流的分辨率自适应 |
|
|
设置视频编码镜像模式 |
|
|
开始旁路推流 |
|
|
更新旁路推流 |
|
|
停止旁路推流 |
|
|
批量设置远端流视图 |
|
|
设置本地视频另一个窗口显示 |
|
|
设置远端视频另一个窗口显示 |
辅流管理
|
接口 |
描述 |
|---|---|
|
开启辅流渲染视图（发起辅流选看） |
|
|
关闭辅流渲染视图（停止辅流选看） |
|
|
设置辅流视图渲染模式，镜像模式 |
|
|
设置辅流视图角度 |
|
|
设置辅流编码能力 |
|
|
设置是否开启辅流的流畅度优先 |
|
|
推送辅流数据 |
屏幕共享
|
接口 |
描述 |
|---|---|
|
开启屏幕共享 |
|
|
根据AppGroup开启屏幕共享（只支持iOS） |
|
|
关闭屏幕共享 |
|
|
获取共享资源列表 |
|
|
设置共享对象 |
音效文件播放管理
|
接口 |
描述 |
|---|---|
|
开始播放音频文件 |
|
|
停止播放音频文件 |
|
|
暂停播放音频文件 |
|
|
恢复播放音频文件 |
|
|
调节音频文件播放音量 |
|
|
设置本地播放音频音量 |
|
|
获取音频文件播放音量 |
|
|
获取音频文件本地播放音量 |
|
|
获取音频文件时长 |
|
|
获取当前音频播放位置 |
|
|
设置音频播放位置 |
|
|
获取音效总音量 |
|
|
获取指定音效音量 |
|
|
设置音效总音量 |
|
|
设置指定音效音量 |
|
|
播放音效文件 |
|
|
停止播放指定音效 |
|
|
停止播放所有音效 |
|
|
暂停播放指定音效 |
|
|
暂停播放所有音效 |
|
|
恢复播放指定音效 |
|
|
恢复播放所有音效 |
|
|
获取指定音效当前播放位置 |
|
|
设置指定音效播放位置 |
|
|
获取音效文件时长 |
检测功能
|
接口 |
描述 |
|---|---|
|
会前网络质量开启测试 |
|
|
会前网络质量停止测试 |
自定义音频采集和渲染
|
接口 |
描述 |
|---|---|
|
设置是否开启外部音频采集 |
|
|
输入外部音频数据 |
自定义视频采集和渲染
|
接口 |
描述 |
|---|---|
|
设置是否开启外部视频采集 |
|
|
输入外部视频数据 |
|
|
设置媒体数据自渲染 |
|
|
带Format参数设置媒体数据自渲染 |
|
|
辅流输入外部视频数据 |
设备管理
|
接口 |
描述 |
|---|---|
|
设置声音播放模式（只支持iphone） |
|
|
设置摄像头相关参数 |
|
|
切换前后镜头（只支持iphone） |
|
|
音频采集设备测试（只支持macOS） |
|
|
结束音频采集设备测试（只支持macOS） |
|
|
音频播放设备测试（只支持macOS） |
|
|
结束音频播放设备测试（只支持macOS） |
|
|
音频设备回路测试（只支持macOS） |
|
|
结束音频设备回路测试（只支持macOS） |
|
|
视频采集设备测试 |
|
|
结束视频采集设备测试 |
