动态与公告

产品动态

产品近期公告

关于 TRTC Live 正式上线的公告

关于TRTC Conference 正式版上线的公告

Conference 商业化版本即将推出

关于多人音视频 Conference 开启内测公告

关于音视频通话 Call 正式版上线的公告

关于腾讯云音视频终端 SDK 播放升级及新增授权校验的公告

关于 TRTC 应用订阅套餐服务上线的相关说明

产品简介

产品概述

基本概念

产品功能

产品优势

应用场景

性能数据

购买指南

计费概述

免费时长说明

月订阅

现收现付

TRTC 逾期与暂停政策

常见问题解答

退款说明

新手指引

Demo 体验

视频通话 SDK

组件介绍

开通服务

跑通 Demo

快速接入

离线唤醒

会话聊天

云端录制

AI 降噪

界面定制

Chat 集成通话能力

更多特性

无 UI 集成

服务端 API

客户端 API

解决方案

错误码表

发布日志

常见问题

视频会议 SDK

组件介绍（TUIRoomKit）

开通服务（TUIRoomKit）

跑通 Demo（TUIRoomKit）

快速接入（TUIRoomKit）

屏幕共享（TUIRoomKit）

预定会议（TUIRoomKit）

会中呼叫（TUIRoomKit）

界面定制（TUIRoomKit）

虚拟背景（TUIRoomKit）

会议控制（TUIRoomKit）

云端录制（TUIRoomKit）

AI 降噪（TUIRoomKit）

会中聊天（TUIRoomKit）

机器人推流（TUIRoomKit）

更多特性（TUIRoomKit）

客户端 API（TUIRoomKit）

服务端 API（TUIRoomKit）

常见问题（TUIRoomKit）

错误码 (TUIRoomKit)

SDK更新日志（TUIRoomKit）

直播与语聊 SDK

Live 视频直播计费说明

组件介绍

开通服务（TUILiveKit）

跑通 Demo

无 UI 集成

UI 自定义

直播监播

视频直播

语聊房

高级功能

客户端 API

服务端 API

错误码

发布日志

常见问题

RTC Engine

开通服务

SDK 下载

API-Example

接入指引

API-参考手册

高级功能

AI 集成

概述

MCP 配置

Skills 配置

集成指南

常见问题

RTC RESTFUL API

History

Introduction

API Category

Room Management APIs

Stream mixing and relay APIs

On-cloud recording APIs

Data Monitoring APIs

Pull stream Relay Related interface

Web Record APIs

AI Service APIs

Cloud Slicing APIs

Cloud Moderation APIs

Making API Requests

Call Quality Monitoring APIs

Usage Statistics APIs

Data Types

Appendix

Error Codes

控制台指南

应用管理

套餐包管理

用量统计

监控仪表盘

开发辅助

解决方案

实时合唱

常见问题

迁移指南

计费相关

功能相关

UserSig 相关

应对防火墙限制相关

缩减安装包体积相关

Andriod 与 iOS 相关

Web 端相关

Flutter 相关

Electron 相关

TRTCCalling Web 相关

音视频质量相关

其他问题

旧版文档

RTC RoomEngine SDK（旧）

集成 TUIRoom (Web)

集成 TUIRoom (Android)

集成 TUIRoom (iOS)

集成 TUIRoom (Flutter)

集成 TUIRoom (Electron)

TUIRoom API 查询

实现云端录制与回放（旧）

监控仪表盘计费（旧）

协议与策略

安全合规认证

安全白皮书

信息安全说明

服务等级协议

苹果隐私策略：PrivacyInfo.xcprivacy

TRTC 政策

隐私协议

数据处理和安全协议

词汇表

TUICallKit（含 UI）

PDF

聚焦模式

字号

最后更新时间： 2026-02-24 16:22:50

TUICallKit API 简介
TUICallKit API 是音视频通话组件的含 UI 接口，使用 TUICallKit API，您可以通过简单接口快速实现一个类微信的音视频通话场景，更详细的接入步骤，详情请参见 快速接入 TUICallKit。
API 概览
API
描述
﻿createInstance﻿
创建 TUICallKit 实例（单例模式）。
﻿setSelfInfo﻿
设置用户的头像、昵称。
﻿calls﻿
发起单人或多人通话。
﻿join﻿
主动加入通话。
﻿setCallingBell﻿
设置自定义来电铃声。
﻿enableMuteMode﻿
开启/关闭静音模式。
﻿enableFloatWindow﻿
开启/关闭悬浮窗功能。
﻿enableIncomingBanner﻿
开启/关闭来电横幅显示。
﻿setScreenOrientation﻿
设置通话界面显示方向。
﻿enableVirtualBackground﻿
设置模糊背景。
API 详情
createInstance
创建 TUICallKit 的单例。
Kotlin
Java
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
﻿
fun createInstance(context: Context): TUICallKit
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit;
﻿
TUICallKit createInstance(Context context);
setSelfInfo
设置用户昵称、头像。用户昵称不能超过 500 字节，用户头像必须是 URL 格式。
Kotlin
Java
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
﻿
fun setSelfInfo(nickname: String?, avatar: String?, completion: CompletionHandler?);
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit;
﻿
void setSelfInfo(String nickname, String avatar, CompletionHandler completion);
参数如下表所示：
参数
类型
含义
nickname
String
目标用户的昵称。
avatar
String
目标用户的头像。
completion
CompletionClosure
异步操作的结果回调。
calls
﻿发
起单人或多人通话。
kotlin
Java
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
import io.trtc.tuikit.atomicxcore.api.call.CallMediaType
import io.trtc.tuikit.atomicxcore.api.call.CallParams
﻿
fun calls(
    userIdList: List<String>, mediaType: CallMediaType,
    params: CallParams?, completion: CompletionHandler?
);
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit;
import io.trtc.tuikit.atomicxcore.api.call.CallMediaType;
import io.trtc.tuikit.atomicxcore.api.call.CallParams;
﻿
void calls(List<String> userIdList, CallMediaType mediaType, CallParams params, CompletionHandler completion);
参数如下表所示：
参数
类型
含义
userIdList
List<String>
目标用户的 userId 列表。
mediaType
﻿CallMediaType﻿
通话的媒体类型，例如视频通话、语音通话。
params
﻿CallParams﻿
通话扩展参数，例如：房间号、通话邀请超时时间等。
completion
CompletionClosure
异步操作的结果回调。
join
﻿主
动加入通话。
Kotlin
Java
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
 
fun join(callId: String?, completion: CompletionHandler?);
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit;
 
void join(String callId, CompletionHandler completion);
参数如下表所示：
参数
类型
含义
callId
String
此次通话的唯一 ID。
completion
CompletionClosure
异步操作的结果回调。
setCallingBell
设置自定义来电铃声。
这里仅限传入本地文件地址，需要确保该文件目录是应用可以访问的。
铃声设置后与设备绑定，更换用户，铃声依旧会生效。
如需恢复默认铃声，filePath传空即可。
Kotlin
Java
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
﻿
fun setCallingBell(filePath: String?);
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit;
﻿
void setCallingBell(String filePath);
enableMuteMode
开启/关闭静音模式。
默认为false，开启后，收到通话请求，不会播放来电铃声。
Kotlin
Java
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
﻿
fun enableMuteMode(enable: Boolean);
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit;
﻿
void enableMuteMode(boolean enable);
enableFloatWindow
开启/关闭悬浮窗功能。
默认为false，通话界面左上角的悬浮窗按钮隐藏，设置为 true 后显示。
Kotlin
Java
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
﻿
fun enableFloatWindow(enable: Boolean);
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit;
﻿
void enableFloatWindow(boolean enable);
enableIncomingBanner
开启/关闭来电横幅显示。
默认为false，被叫端收到邀请后默认弹出全屏通话等待界面。开启后先展示一个横幅，然后根据需要拉起全屏通话界面。
Kotlin
Java
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
﻿
fun enableIncomingBanner(enable: Boolean);
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit;
﻿
void enableIncomingBanner(boolean enable);
setScreenOrientation
设置通话界面显示方向。
默认为竖屏，orientation：0-竖屏、1-横屏、2-自动。
Kotlin
Java
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
﻿
fun setScreenOrientation(orientation: Int);
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit;
﻿
void setScreenOrientation(int orientation);
enableVirtualBackground
设置模糊背景。
默认值为：false。
import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
﻿
fun enableVirtualBackground(enable: Boolean);
废弃接口
call
拨打电话（1v1通话）。
注意：
v2.9+版本废弃，建议使用 calls 接口。
Kotlin
Java
fun call(userId: String, mediaType: TUICallDefine.MediaType)
 void call(String userId, TUICallDefine.MediaType mediaType)
参数如下表所示：
参数
类型
含义
userId
String
目标用户的 userId。
mediaType
﻿TUICallDefine.MediaType﻿
通话的媒体类型，例如视频通话、语音通话。
call
拨打电话（1v1通话），支持自定义房间号、通话邀请超时时间，离线推送内容等。
注意：
v2.9+版本废弃，建议使用 calls 接口。
Kotlin
Java
fun call(
    userId: String, mediaType: TUICallDefine.MediaType,
    params: CallParams?, callback: TUICommonDefine.Callback?
)
 void call(String userId, TUICallDefine.MediaType mediaType, 
           TUICallDefine.CallParams params, TUICommonDefine.Callback callback)
参数如下表所示：
参数
类型
含义
userId
String
目标用户的 userId。
mediaType
﻿TUICallDefine.MediaType﻿
通话的媒体类型，例如视频通话、语音通话。
params
﻿TUICallDefine.CallParams﻿
通话扩展参数，例如：房间号、通话邀请超时时间，离线推送自定义内容等。
groupCall
发起群组通话。
注意：
v2.9+版本废弃，建议使用 calls 接口。
使用群组通话前需要创建即时通信 Chat 群组，如果已经创建，请忽略。
群组的创建详见：Chat 群组管理 ，或者您也可以直接使用 Chat TUIKit，一站式集成聊天、通话等场景。
Kotlin
Java
fun groupCall(groupId: String, userIdList: List<String?>?, mediaType: TUICallDefine.MediaType)
void groupCall(String groupId, List<String> userIdList, TUICallDefine.MediaType mediaType);
参数如下表所示：
参数
类型
含义
groupId
String
此次群组通话的群 ID。
userIdList
List
目标用户的 userId 列表。
mediaType
﻿TUICallDefine.MediaType﻿
通话的媒体类型，例如视频通话、语音通话。
groupCall
发起群组通话，支持自定义房间号、通话邀请超时时间，离线推送内容等。
注意：
v2.9+版本废弃，建议使用 calls 接口。
使用群组通话前需要创建即时通信 Chat 群组，如果已经创建，请忽略。
群组的创建详见：Chat 群组管理 ，或者您也可以直接使用 Chat TUIKit，一站式集成聊天、通话等场景。
Kotlin
Java
fun groupCall(
    groupId: String, userIdList: List<String?>?, mediaType: TUICallDefine.MediaType, 
    params: CallParams?, callback: TUICommonDefine.Callback?
)
void groupCall(String groupId, List<String> userIdList, TUICallDefine.MediaType mediaType, 
               TUICallDefine.CallParams params, TUICommonDefine.Callback callback);
参数如下表所示：
参数
类型
含义
groupId
String
此次群组通话的群 ID。
userIdList
List
目标用户的 userId 列表。
mediaType
﻿TUICallDefine.MediaType﻿
通话的媒体类型，例如视频通话、语音通话。
params
﻿TUICallDefine.CallParams﻿
通话扩展参数，例如：房间号、通话邀请超时时间，离线推送自定义内容等。
joinInGroupCall
加入群组中已有的音视频通话。
注意：
v2.9+版本废弃，建议使用 join 接口。
加入群组中已有的音视频通话前，需要提前创建或加入即时通信 Chat 群组，并且群组中已有用户在通话中，如果已经创建，请忽略。
群组的创建详见：Chat 群组管理 ，或者您也可以直接使用 Chat TUIKit，一站式集成聊天、通话等场景。
Kotlin
Java
fun joinInGroupCall(roomId: RoomId?, groupId: String?, mediaType: TUICallDefine.MediaType?) 
void joinInGroupCall(TUICommonDefine.RoomId roomId, String groupId, TUICallDefine.MediaType callMediaType);
参数如下表所示：
参数
类型
含义
roomId
﻿TUICommonDefine.RoomId﻿
此次通话的音视频房间 ID。
groupId
String
此次群组通话的群 ID。
mediaType
﻿TUICallDefine.MediaType﻿
通话的媒体类型，例如视频通话、语音通话。
disableControlButton
隐藏指定按钮。
说明：
目前支持隐藏以下按钮：
Camera（摄像头）、Microphone（麦克风）、AudioDevice（音频设备）、SwitchCamera（切换摄像头）、InviteUser（邀请用户）。
v3.2.+ 版本支持。
Kotlin
Java
fun disableControlButton(button: Constants.ControlButton?)
void disableControlButton(Constants.ControlButton button);
参数
类型
说明
button
ControlButton
需要隐藏的按钮。

帮助和支持

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

填写满意度调查问卷，共创更好文档体验。

文档反馈

tencent cloud

实时音视频

TUICallKit（含 UI）

TUICallKit API 简介

API 概览

API 详情

createInstance

setSelfInfo

calls

join

setCallingBell

enableMuteMode

enableFloatWindow

enableIncomingBanner

setScreenOrientation

enableVirtualBackground

废弃接口

call

call

groupCall

groupCall

joinInGroupCall

disableControlButton

帮助和支持

API	描述
createInstance	创建 TUICallKit 实例（单例模式）。
setSelfInfo	设置用户的头像、昵称。
calls	发起单人或多人通话。
join	主动加入通话。
setCallingBell	设置自定义来电铃声。
enableMuteMode	开启/关闭静音模式。
enableFloatWindow	开启/关闭悬浮窗功能。
enableIncomingBanner	开启/关闭来电横幅显示。
setScreenOrientation	设置通话界面显示方向。
enableVirtualBackground	设置模糊背景。

参数	类型	含义
nickname	String	目标用户的昵称。
avatar	String	目标用户的头像。
completion	CompletionClosure	异步操作的结果回调。

参数	类型	说明
button	ControlButton	需要隐藏的按钮。