tencent cloud

实时音视频

动态与公告
产品动态
产品近期公告
关于 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

PDF
Mode fokus
Ukuran font
Terakhir diperbarui: 2025-09-03 15:17:24

TUICallKit API 简介

TUICallKit API 是音视频通话组件的含 UI 接口,使用 TUICallKit API,您可以通过简单接口快速实现一个类微信的音视频通话场景,更详细的接入步骤,详情请参见 快速接入TUICallKit。

API 概览

API
含义
login
登录。
logout
退出登录。
calls
发起单人或多人通话
call
进行一对一通话,支持自定义房间ID、通话超时、离线推送内容等。
groupCall
进行群组通话,支持自定义房间ID、通话超时、离线推送内容等。
加入群组通话。
自定义用户的铃声。
设置自己的昵称和头像。
开启/关闭静音模式
打开/关闭铃声。
设置屏幕方向。
on
监听 TUICallKit 事件
off
取消监听 TUICallKit 事件

API 详情

login

登录。这一步骤至关重要,只有在成功登录之后,您才能正常使用 TUICallKit 提供的各项功能。
TUICallKit.login(
{
sdkAppId: 0,
userId: '',
userSig: '',
},
(res) => {
console.log('login success');
},
(errCode, errMsg) => {
console.log('login error');
}
);
参数
类型
含义
sdkAppId
Number
Tencent RTC 控制台 创建的音视频应用的唯一标识 SDKAppID。
userId
String
客户根据自己的业务自定义用户 ID,只允许包含大小写英文字母(a-z A-Z)、数字(0-9)及下划线和连词符。
userSig
String
Tencent RTC 控制台 创建的音视频应用的 SDKSecretKey。

logout

退出登录,退出登录后将不再监听任何 TUICallKit 的事件。
TUICallKit.login(
(res) => {
console.log('login success', res);
},
(errCode, errMsg) => {
console.log('login error', errCode, errMsg);
}
);

calls

发起单人或多人通话。
TUICallKit.calls(
{
userIdList: userIDList,
mediaType: MediaType.Audio,
callParams: {
offlinePushInfo: {
title: '',
desc: '',
},
},
},
() => {
console.log('calls success');
},
() => {
console.log('calls error');
}
);
参数
类型
含义
userIdList
Array<String>
目标用户的 userId 列表
mediaType
MediaType
通话的媒体类型,比如视频通话、语音通话。
MediaType.Audio :语音通话。
MediaType.Video :视频通话。
callParams
通话扩展参数,例如:房间号、通话邀请超时时间,离线推送自定义内容等。

call

拨打电话(1v1通话),支持自定义房间号、通话邀请超时时间,离线推送内容等。
TUICallKit.call(
{
userId: calleeID,
mediaType: MediaType.Audio,
callParams: {
offlinePushInfo: {
title: '',
desc: '',
},
},
},
() => {
console.log('call success');
},
() => {
console.log('call error');
}
);
参数
类型
含义
userId
String
目标用户的 userId
mediaType
MediaType
通话的媒体类型,比如视频通话、语音通话。
MediaType.Audio :语音通话。
MediaType.Video :视频通话。
callParams
通话扩展参数,例如:房间号、通话邀请超时时间,离线推送自定义内容等。

groupCall

发起群组通话。
TUICallKit.groupCall(
{
userIdList: userIDList,
mediaType: MediaType.Audio,
groupId: '',
},
(res) => {
console.log('groupCall success', res);
},
(errCode, errMsg) => {
console.log('groupCall error', errCode, errMsg);
}
);
参数
类型
含义
groupId
String
此次群组通话的群 ID。
userIdList
Array<String>
被呼叫的用户列表。
mediaType
MediaType
通话的媒体类型,比如视频通话、语音通话
MediaType.Audio :语音通话。
MediaType.Video :视频通话。
callParams
通话扩展参数,例如:房间号、通话邀请超时时间,离线推送自定义内容等

joinInGroupCall

加入群组中已有的音视频通话。
TUICallKit.joinInGroupCall(
{
roomId: '',
groupId: '',
mediaType: '',
}
);
参数
类型
含义
roomId
RoomId
此次通话的音视频房间 ID
groupId
String
此次群组通话的群 ID
mediaType
MediaType
通话的媒体类型,比如视频通话、语音通话

setCallingBell

设置自定义来电铃音。
仅限传入本地 MP3 格式的文件地址,需要确保该文件目录是应用可以访问的。
使用 import 方式引入铃声文件。
如需恢复默认铃声,filePath 传空即可。
String filePath = '';
TUICallKit.setCallingBell(filePath);
参数
类型
含义
filePath
String
铃声文件地址

setSelfInfo

设置用户昵称、头像。用户昵称不能超过500字节,用户头像必须是 URL 格式。
var nickname: string = 'user';
var avatar: string = '';
TUICallKit.setSelfInfo(nickname, userAvatar,
(res) => {
console.log('groupCall success', res);
},
(errCode, errMsg) => {
console.log('groupCall error', errCode, errMsg);
}
);
参数如下表所示:
参数
类型
含义
nickname
string
目标用户的昵称
avatar
string
目标用户的头像

enableMuteMode

开启/关闭来电铃声。开启后,收到通话请求时,不会播放来电铃声。
Boolean enable = true
TUICallKit.enableMuteMode(enable);
参数
类型
含义
enable
Boolean
开启/关闭来电铃声。默认 false。

enableVirtualBackground

开启/关闭模糊背景功能。通过调用接口,您可以在 UI 上显示模糊背景的功能按钮,点击按钮可直接启用模糊背景功能。
Boolean enable = true
TUICallKit.enableVirtualBackground(enable);
参数
类型
含义
enable
Boolean
enable = true 显示模糊背景按钮
enable = false 不显示模糊背景按钮

setScreenOrientation

设置屏幕显示模式。
Number orientation = 0
TUICallKit.setScreenOrientation(orientation);
参数
类型
含义
orientation
Number
orientation = 0 :竖屏显示。
orientation = 1 :横屏显示。
orientation = 2 :根据当前设备的状态自动选择最佳的显示方式.

on

您可以通过以下示例代码监听 TUICallKit 事件。事件详情请参见 TUICallEvent
TUICallKit.on(TUICallEvent.onCallReceived, (res: any) => {
console.log('onUserReject userId=' + res.userId);
});
参数
类型
含义
type
String
TUICallKit 您监听的事件,事件列表请参见 TUICallEvent
params
Any
事件所携带的信息,详情请参见 TUICallEvent

off

您可以通过以下示例代码,取消监听 TUICallKit 事件。
TUICallKit.off(TUICallEvent.onCallReceived);

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan