接口按功能说明
初始化等基础接口
接口 |
描述 |
windows是否支持 |
Mac是否支持 |
iOS是否支持 |
Android是否支持 |
---|---|---|---|---|---|
创建IHRTCEngine对象 |
√ |
√ |
√ |
√ |
|
获取创建后的IHRTCEngine对象 |
√ |
√ |
√ |
√ |
|
开启打点统计,在initialize前调用 |
√ |
√ |
√ |
√ |
|
IHRtcEngine对象初始化函数 |
√ |
√ |
√ |
√ |
|
释放IHRtcEngine对象资源,退出时调用 |
√ |
√ |
√ |
√ |
|
开启日志上传 |
√ |
√ |
√ |
√ |
|
获取当前SDK版本号 |
√ |
√ |
√ |
√ |
|
获取系统音频设备管理对象 |
√ |
√ |
√ |
√ |
|
获取系统视频设备管理对象 |
√ |
√ |
√ |
√ |
|
设置jvm context 仅安卓使用 |
× |
× |
× |
√ |
|
设置端到端加密模式 |
√ |
√ |
√ |
√ |
|
设置接入环境 |
√ |
√ |
√ |
√ |
|
设置网络带宽限制 |
√ |
√ |
√ |
√ |
|
设置Appid |
√ |
√ |
√ |
√ |
房间功能
接口 |
描述 |
windows是否支持 |
Mac是否支持 |
iOS是否支持 |
Android是否支持 |
---|---|---|---|---|---|
加入房间 |
√ |
√ |
√ |
√ |
|
离开房间 |
√ |
√ |
√ |
√ |
|
签名更新 |
√ |
√ |
√ |
√ |
|
设置用户的角色,切换角色时使用 |
√ |
√ |
√ |
√ |
|
设置用户自己的昵称 |
√ |
√ |
√ |
√ |
|
创建连接。跨房前需先创建连接 |
√ |
√ |
√ |
√ |
|
添加单个跨房 |
√ |
√ |
√ |
√ |
|
删除单个跨房 |
√ |
√ |
√ |
√ |
|
停止所有跨房 |
√ |
√ |
√ |
√ |
|
订阅AI字幕 |
√ |
√ |
√ |
√ |
视频管理
接口 |
描述 |
windows是否支持 |
Mac是否支持 |
iOS是否支持 |
Android是否支持 |
---|---|---|---|---|---|
设置是否开启本地摄像头采集视频 |
√ |
√ |
√ |
√ |
|
设置视频发流编码参数 |
√ |
√ |
√ |
√ |
|
大小流模式设置是否开启小流并设置小流编码参数 |
√ |
√ |
√ |
√ |
|
开始本地预览 |
√ |
√ |
√ |
√ |
|
关闭本地预览 |
√ |
√ |
√ |
√ |
|
设置本地渲染视图 |
√ |
√ |
√ |
√ |
|
设置本地视图渲染模式,镜像模式 |
√ |
√ |
√ |
√ |
|
设置远端流渲染视图(发起选看,参数置空则停止选看) |
√ |
√ |
√ |
√ |
|
设置远端用户视图渲染模式,镜像模式 |
√ |
√ |
√ |
√ |
|
大小流模式,设置远端视频流类型 |
√ |
√ |
√ |
√ |
|
大小流模式,设置所有订阅的远端视频流类型。 |
√ |
√ |
√ |
√ |
|
设置是否发送本地视频流 |
√ |
√ |
√ |
√ |
|
设置是否接收所有用户的视频流 |
√ |
√ |
√ |
√ |
|
设置远端用户渲染视图(发起选看-老接口) |
√ |
√ |
√ |
√ |
|
关闭远端用户的渲染视图(停止选看) |
√ |
√ |
√ |
√ |
|
设置是否开启远端分辨率自适应 |
√ |
√ |
√ |
√ |
|
设置编码器输出的画面(本地发流)镜像模式 |
√ |
√ |
√ |
√ |
|
设置摄像头参数 |
× |
× |
√ |
√ |
|
切换摄像头,移动端 |
× |
x |
√ |
√ |
|
批量设置远端流视图 |
√ |
√ |
√ |
√ |
|
设置远端流视图旋转角度 |
× |
x |
√ |
√ |
|
设置远端流视图方向(横竖屏) |
× |
x |
√ |
√ |
|
设置关闭视频发流时发送的图片 |
√ |
√ |
√ |
√ |
|
设置是否接收所用户的视频流 |
√ |
√ |
√ |
√ |
|
设置是否开启美颜功能 |
× |
x |
√ |
√ |
|
设置是否开启增亮功能 |
√ |
× |
x |
x |
|
设置是否开启重力感应 |
× |
x |
√ |
x |
|
开始旁路推流 |
√ |
√ |
√ |
√ |
|
更新旁路推流 |
√ |
√ |
√ |
√ |
|
停止旁路推流 |
√ |
√ |
√ |
√ |
|
插入/删除水印 |
√ |
x |
x |
x |
|
设置本地视频背景虚化 |
√ |
x |
x |
√ |
|
设置本地视频背景替换 |
√ |
x |
x |
√ |
|
设置本地视频另一个窗口显示 |
√ |
√ |
x |
x |
|
设置远端视频另一个窗口显示 |
√ |
√ |
x |
x |
辅流管理
接口 |
描述 |
windows是否支持 |
Mac是否支持 |
iOS是否支持 |
Android是否支持 |
---|---|---|---|---|---|
设置远端辅流视图旋转角度 |
× |
x |
√ |
√ |
|
开启辅流渲染视图(发起辅流选看) |
√ |
√ |
x |
√ |
|
关闭辅流渲染视图(停止辅流选看) |
√ |
√ |
x |
√ |
|
设置辅流视图显示模式,镜像模式 |
√ |
√ |
x |
√ |
|
设置远端辅流视图方向(横竖屏) |
× |
x |
√ |
√ |
|
设置辅流编码参数 |
√ |
√ |
x |
√ |
|
设置是否开启辅流的流畅度优先(降低辅流选看分辨率) |
√ |
√ |
x |
√ |
屏幕共享
接口 |
描述 |
windows是否支持 |
Mac是否支持 |
iOS是否支持 |
Android是否支持 |
---|---|---|---|---|---|
获取屏幕可共享对象列表 |
√ |
√ |
x |
√ |
|
选择屏幕共享对象 |
√ |
√ |
x |
√ |
|
开启屏幕共享 |
√ |
√ |
x |
√ |
|
停止屏幕共享 |
√ |
√ |
x |
√ |
|
将指定窗口加入屏幕共享排除列表 |
√ |
√ |
x |
√ |
|
将指定窗口从屏幕共享排除列表中移除 |
√ |
√ |
x |
√ |
|
将所有窗口从屏幕共享排除列表中移除 |
√ |
√ |
x |
√ |
|
获取屏幕可共享对象列表,包含缩略图 |
√ |
x |
x |
x |
音频管理
接口 |
描述 |
windows是否支持 |
Mac是否支持 |
iOS是否支持 |
Android是否支持 |
---|---|---|---|---|---|
设置是否开启麦克风音频采集 |
√ |
√ |
√ |
√ |
|
设置麦克风采集的音量(0-100) |
√ |
√ |
√ |
√ |
|
调整扬声器播放的音量(0-100) |
√ |
√ |
√ |
√ |
|
设置是否开启系统音频采集、发送 |
√ |
√ |
x |
x |
|
设置是否发送本地音频流 |
√ |
√ |
√ |
√ |
|
设置是否接收指定远端用户的音频流 |
√ |
√ |
√ |
√ |
|
设置是否接收远端所有用户的音频流 |
√ |
√ |
√ |
√ |
|
设置开启/关闭所有用户音量值上报并设置上报周期 |
√ |
√ |
√ |
√ |
|
设置声音播放模式 |
x |
x |
√ |
√ |
|
开始语音通话回路测试 |
√ |
x |
x |
x |
|
停止语音直播回路测试 |
√ |
x |
x |
x |
|
设置默认声音播放模式 |
x |
x |
√ |
√ |
|
设置是否开启音频降噪功能 |
√ |
√ |
√ |
√ |
|
发送音频SEI消息 |
√ |
√ |
√ |
√ |
|
设置音频采集回调的参数 |
√ |
√ |
√ |
√ |
音频文件播放管理
接口 |
描述 |
windows是否支持 |
Mac是否支持 |
iOS是否支持 |
Android是否支持 |
---|---|---|---|---|---|
播放音频文件 |
√ |
√ |
√ |
√ |
|
停止播放音频文件 |
√ |
√ |
√ |
√ |
|
暂停播放音频文件 |
√ |
√ |
√ |
√ |
|
恢复播放音频文件 |
√ |
√ |
√ |
√ |
|
调整音频音量 |
√ |
√ |
√ |
√ |
|
调整本地播放音频音量 |
√ |
√ |
√ |
√ |
|
获取音频音量 |
√ |
√ |
√ |
√ |
|
获取本地播放音频音量 |
√ |
√ |
√ |
√ |
|
获取音频时长 |
√ |
√ |
√ |
√ |
|
获取音频播放位置 |
√ |
√ |
√ |
√ |
|
设置音频播放位置 |
√ |
√ |
√ |
√ |
|
获取音效总音量 |
√ |
√ |
√ |
√ |
|
设置音效总音量 |
√ |
√ |
√ |
√ |
|
获取指定音效音量 |
√ |
√ |
√ |
√ |
|
设置指定音效音量 |
√ |
√ |
√ |
√ |
|
播放音效文件 |
√ |
√ |
√ |
√ |
|
停止播放指定音效 |
√ |
√ |
√ |
√ |
|
停止播放所有音效 |
√ |
√ |
√ |
√ |
|
暂停播放指定音效 |
√ |
√ |
√ |
√ |
|
暂停播放所有音效 |
√ |
√ |
√ |
√ |
|
恢复播放指定音效 |
√ |
√ |
√ |
√ |
|
恢复播放所有音效 |
√ |
√ |
√ |
√ |
|
获取指定音效当前播放位置 |
√ |
√ |
√ |
√ |
|
设置指定音效播放位置 |
√ |
√ |
√ |
√ |
|
获取音效文件时长 |
√ |
√ |
√ |
√ |
自采集自渲染
接口 |
描述 |
windows是否支持 |
Mac是否支持 |
iOS是否支持 |
Android是否支持 |
---|---|---|---|---|---|
设置是否开启外部视频自采集 |
√ |
√ |
√ |
√ |
|
推送外部视频数据 |
√ |
√ |
√ |
√ |
|
设置是否开启视频流自渲染 |
√ |
√ |
√ |
√ |
|
设置是否开启辅流自渲染 |
√ |
√ |
√ |
√ |
|
设置是否开启外部音频自采集 |
√ |
√ |
√ |
√ |
|
推送外部音频数据 |
√ |
√ |
√ |
√ |
|
设置是否开启音频流自渲染 |
√ |
√ |
√ |
√ |
其他接口
接口 |
描述 |
windows是否支持 |
Mac是否支持 |
iOS是否支持 |
Android是否支持 |
---|---|---|---|---|---|
开启会前网络质量测试 |
√ |
√ |
√ |
√ |
|
停止会前网络质量测试 |
√ |
√ |
√ |
√ |
|
设置使用场景 |
√ |
√ |
√ |
√ |