API 概览

TUICallKit(含 UI 组件)

TUICallKit 是音视频通话组件的含 UI 组件,您可以通过该组件快速实现一个类微信的音视频通话场景。
API
描述
init
初始化 TUICallKit 组件实例
call
发起 1v1 通话,支持自定义房间号、通话邀请超时时间,离线推送内容等
groupCall
发起群组通话,支持自定义房间号、通话邀请超时时间,离线推送内容等
主动加入当前的群组通话中,v3.1.2+ 支持
设置自定义来电铃音,v3.0.0+ 支持
设置用户昵称和头像,v2.2.0+ 支持
开启/关闭来电铃声,v3.1.2+ 支持
开启/关闭悬浮窗功能,v3.1.0+ 支持
开启/关闭模糊背景的功能按钮,v3.2.4+ 支持
设置 TUICallKit 组件通话语言
隐藏按钮,v3.2.9+ 支持
设置本地用户通话界面背景图,v3.2.9+ 支持
设置远端用户通话界面背景图,v3.2.9+ 支持
设置通话界面布局模式,v3.3.0+ 支持
设置摄像头是否默认打开,v3.3.0+ 支持
destroyed
销毁 TUICallKit 组件实例

TUICallEngine (无 UI 接口)

TUICallEngine API 是音视频通话组件的无 UI 接口,您可以使用这套 API 根据您的业务需求自定义封装。
API
描述
创建 TUICallEngine 实例(单例模式)
销毁 TUICallEngine 实例(单例模式)
on
监听事件
off
取消监听事件
login
登录接口
logout
登出接口
设置用户昵称和头像
call
发起 1v1 通话
groupCall
群聊邀请通话
accept
接听通话
reject
拒绝通话
hangup
结束通话
音视频通话切换
启动远端画面渲染
停止远端画面渲染
启动本地画面渲染,注意:后续将废弃,建议使用 openCamera
停止本地画面渲染,注意:后续将废弃,建议使用 closeCamera
开启摄像头
关闭摄像头
切换前后置摄像头,注意:仅移动端支持。v3.0.0+ 支持
打开麦克风
关闭麦克风
设置视频质量
获取设备列表
切换摄像头或麦克风设备
开启/关闭 AI 降噪
开启/关闭 TUICallEngine 的多设备登录模式。v2.1.1+ 支持
开关/设置背景虚化,v3.0.6+ 支持
开关/设置图片背景虚化,v3.0.6+ 支持

事件类型定义

TUICallEvent 是 TUICallEngine 对应的事件类,您可以通过监听如下事件,来监听自己感兴趣的事件。
EVENT
描述
通话过程中错误事件
SDK 进入 ready 状态时收到该事件
用户重复登录,被踢下线
xxxx 用户接通的事件
xxxx 用户加入通话的事件
xxxx 用户离开通话的事件
xxxx 用户拒绝通话的事件
xxxx 用户不响应的事件
xxxx 用户忙线的事件
xxxx 用户是否有视频流的事件
xxxx 用户是否有音频流的事件
所有用户音量大小的反馈事件
群聊更新邀请列表收到该事件
通话接通的事件,v1.4.6+ 支持
通话请求的事件, 后续废弃,建议使用 TUICallEvent.ON_CALL_RECEIVED
通话请求的事件,v1.4.6+ 支持
通话取消的事件, 后续废弃,建议使用 TUICallEvent.ON_CALL_CANCELED
通话取消的事件,v1.4.6+ 支持
通话接通时抛出的事件
通话结束的事件
设备列表更新的事件
通话的媒体类型发生改变的回调
所有用户网络质量的事件,v3.0.7+ 支持

文档链接