• UIKit
  • 服务端 API
Call/
UIKit/
Web/
客户端 API/
Engine APIs/
UIKit
  • 概览
    • 产品介绍
    • 开通服务
    • 价格中心
      • 免费时长
      • Call 包月套餐
      • 订阅套餐时长计费说明
  • 开始集成
    • 跑通 Demo
    • 集成
      • Web&H5 (React)
      • Web&H5 (Vue3)
    • userSig 鉴权
  • 基础功能
    • Conversational Chat
      • Vue3
      • React
    • 自定义 UI
    • 设置昵称、头像
    • 群通话
    • 悬浮窗
    • 自定义铃声
    • 设置分辨率和填充模式
    • 监控通话状态
    • 设置语言
  • 高级功能
    • 虚拟背景
    • AI 降噪
    • 云端录制
  • 客户端 API
    • UIKit APIs
      • API Overview
      • TUICallKit
    • Engine APIs
      • TUICallEngine
      • TUICallEvent
  • Solution
    • WhatsApp Clone
  • 常见问题
    • 全平台
    • Web
    • 错误码
    • 发布日志

TUICallEngine

TUICallEngine API 是音视频通话组件的无 UI 接口,如果 TUICallKit 的交互并不满足您的需求,您可以使用这套 API 根据您的业务需求自定义封装。
说明:
为提供更优质的音视频通信能力,原 tuicall-engine-webrtc 包已正式停止维护,建议开发者迁移至 @tencentcloud/call-engine-js 新包。
新包对接口进行了优化调整,部分旧版接口不再兼容,同步提供更简洁、稳定的新接口方案。

API 概览

API
描述
创建 TUICallEngine 实例(单例模式)
销毁 TUICallEngine 实例(单例模式)
on
监听事件
off
取消监听事件
login
登录接口
logout
登出接口
设置用户昵称和头像
calls
发起单人或多人通话
join
主动加入通话
accept
接听通话
reject
拒绝通话
hangup
结束通话
启动远端画面渲染
停止远端画面渲染
开启摄像头
关闭摄像头
切花前后置摄像头,注意:仅移动端支持。
打开麦克风
关闭麦克风
设置视频质量
获取设备列表
切换摄像头或麦克风设备
开启/关闭 AI 降噪
开启/关闭 TUICallEngine 的多设备登录模式
开关/设置背景虚化
开关/设置图片背景虚化

废弃接口

API
描述
call
拨打电话(1v1通话),建议使用 calls 接口
groupCall
发起群组通话,建议使用 calls 接口
启动本地画面渲染,建议使用 openCamera
停止本地画面渲染,建议使用 closeCamera
主动加入此次群组通话,建议使用 join 接口
音视频通话切换

在技术社区提问