TUICallEngine API 是音视频通话组件的无 UI 接口,如果 TUICallKit 的交互并不满足您的需求,您可以使用这套 API 根据您的业务需求自定义封装。
说明:
为提供更优质的音视频通信能力,原 tuicall-engine-webrtc 包已正式停止维护,建议开发者迁移至 @tencentcloud/call-engine-js 新包。
新包对接口进行了优化调整,部分旧版接口不再兼容,同步提供更简洁、稳定的新接口方案。
API 概览
API | 描述 |
创建 TUICallEngine 实例(单例模式)。 | |
销毁 TUICallEngine 实例(单例模式)。 | |
监听事件。 | |
取消监听事件。 | |
登录接口。 | |
登出接口。 | |
设置用户昵称和头像。 | |
发起单人或多人通话。 | |
主动加入通话。 | |
接听通话。 | |
拒绝通话。 | |
结束通话。 | |
通话类型切换。 | |
启动远端画面渲染。 | |
停止远端画面渲染。 | |
开启摄像头。 | |
关闭摄像头。 | |
切换前后置摄像头,仅移动端支持。 | |
打开麦克风。 | |
关闭麦克风。 | |
设置视频分辨率。 | |
获取设备列表。 | |
切换摄像头或麦克风设备。 | |
开启/关闭 AI 降噪。 | |
开启/关闭 TUICallEngine 的多设备登录模式。 | |
开关/设置背景虚化。 | |
开关/设置图片背景虚化。 |
废弃接口
API | 描述 |
拨打电话(1v1通话),建议使用 calls 接口。 | |
发起群组通话,建议使用 calls 接口。 | |
启动本地画面渲染,建议使用 openCamera。 | |
停止本地画面渲染,建议使用 closeCamera。 | |
主动加入此次群组通话,建议使用 join 接口。 |