TUICallKit(含 UI 组件)
TUICallKit 是音视频通话组件的含 UI 组件,您可以通过该组件快速实现一个类微信的音视频通话场景。
<TUICallKit/>:UI 通话组件主体。
<TUICallKitMini/>:UI 通话悬浮窗,若开启最小化功能,则 <TUICallKitMini/> 必须被放置在页面中。注意:v2.3.2+ 已废弃。
TUICallKitServer 是通话实例,提供的 API 接口如下。
API | 描述 |
初始化 TUICallKit。 | |
发起 1v1 通话 | |
发起群组通话 | |
主动加入当前的群组通话中 | |
设置自定义来电铃音 | |
设置用户昵称和头像 | |
开启/关闭来电铃声 | |
开启/关闭悬浮窗功能 | |
设置 TUICallKit 组件通话语言 | |
销毁 TUICallKit |
TUICallEngine (无 UI 接口)
TUICallEngine API 是音视频通话组件的无 UI 接口,您可以使用这套 API 根据您的业务需求自定义封装。
API | 描述 |
创建 TUICallEngine 实例(单例模式) | |
销毁 TUICallEngine 实例(单例模式) | |
监听事件 | |
取消监听事件 | |
登录接口 | |
登出接口 | |
设置用户昵称和头像 | |
发起 1v1 通话 | |
群聊邀请通话 | |
接听通话 | |
拒绝通话 | |
结束通话 | |
音视频通话切换 | |
启动远端画面渲染 | |
停止远端画面渲染 | |
启动本地画面渲染,注意:后续将废弃,建议使用 openCamera | |
停止本地画面渲染,注意:后续将废弃,建议使用 closeCamera | |
开启摄像头 | |
关闭摄像头 | |
打开麦克风 | |
关闭麦克风 | |
设置视频质量 | |
获取设备列表 | |
切换摄像头或麦克风设备 | |
开启/关闭 AI 降噪 |
事件类型定义
TUICallEvent 是 TUICallEngine 对应的回调事件类,您可以通过此回调,来监听自己感兴趣的回调事件。
EVENT | 描述 |
SDK 内部发生了错误 | |
SDK 进入 ready 状态时收到该回调 | |
重复登录,收到该回调说明被踢出房间 | |
如果有用户接听,那么会收到此回调 | |
如果有用户同意进入通话,那么会收到此回调 | |
如果有用户同意离开通话,那么会收到此回调 | |
用户拒绝通话 | |
邀请用户无应答 | |
邀请方忙线 | |
作为被邀请方会收到,收到该回调说明本次通话超时未应答 | |
远端用户开启/关闭了摄像头, 会收到该回调 | |
远端用户开启/关闭了麦克风, 会收到该回调 | |
远端用户说话音量调整, 会收到该回调 | |
群聊更新邀请列表收到该回调 | |
被邀请进行通话 | |
作为被邀请方会收到,收到该回调说明本次通话被取消了 | |
收到该回调说明本次通话结束了 | |
设备列表更新收到该回调 | |
通话类型切换收到该回调 |
文档链接
?
?