tencent cloud

Tencent Real-Time Communication

소식 및 공지 사항
제품 업데이트
Tencent Cloud 오디오/비디오 단말 SDK 재생 업그레이드 및 권한 부여 인증 추가
TRTC 월간 구독 패키지 출시 관련 안내
제품 소개
제품 개요
기본 개념
제품 기능
제품 장점
응용 시나리오
성능 데이터
구매 가이드
Billing Overview
무료 시간 안내
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
과금 FAQ
Refund Instructions
신규 사용자 가이드
Demo 체험
Call
개요(TUICallKit)
Activate the Service
Run Demo
빠른 통합(TUICallKit)
오프라인 푸시
Conversational Chat
온클라우드 녹화(TUICallKit)
AI Noise Reduction
UI 사용자 정의
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
릴리스 노트
FAQs
라이브 스트리밍
Billing of Video Live Component
Overview
Activating the Service (TUILiveKit)
Demo 실행
No UI Integration
UI Customization
Live Broadcast Monitoring
Video Live Streaming
Voice Chat Room
Advanced Features
Client APIs
Server APIs
Error Codes
Release Notes
FAQs
RTC Engine
Activate Service
SDK 다운로드
API 코드 예시
Usage Guidelines
API 클라이언트 API
고급 기능
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
콘솔 가이드
애플리케이션 관리
사용량 통계
모니터링 대시보드
개발 보조
Solution
Real-Time Chorus
FAQs
과금 개요
기능 관련
UserSig 관련
방화벽 제한 처리
설치 패키지 용량 축소 관련 질문
Andriod 및 iOS 관련
Web 관련
Flutter 관련
Electron 관련
TRTCCalling Web 관련
멀티미디어 품질 관련
기타 질문
Protocols and Policies
컴플라이언스 인증
보안 백서
정보 보안에 관한 참고 사항
Service Level Agreement
Apple Privacy Policy: PrivacyInfo.xcprivacy
TRTC 정책
개인 정보 보호 정책
데이터 처리 및 보안 계약
용어집

TUICallKit

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-11-25 14:28:26

TUICallKit APIs

TUICallKit is an audio/video call component that includes UI elements. You can use its APIs to quickly implement an audio/video call application similar to WeChat. For directions on integration, see Integrating TUICallKit.

API overview

API
Description
login
Log in
logout
Sign out
Sets the user nickname and profile photo.
calls
Start a call.
join
Join the call.
Sets whether to turn on the mute mode.
Sets whether to enable floating windows.
Custom ringtone.
Turn On/Off the Virtual Background feature

Details

login

Future<TUIResult> login(int sdkAppId, String userId, String userSig)
Parameter
Type
Description
sdkAppId
int
User SDKAppID
userId
String
User ID, a string type, can only include English letters (a-z and A-Z), numbers (0-9), hyphens (-), and underscores (_).
userSig
String
User Signature. UserSig is obtained by encrypting information such as sdkAppId and userId using the SDKSecretKey(Signature calculation method). It serves as a ticket for authentication, enabling Tencent Cloud to determine if the current user is authorized to use TRTC services.
return value
TUIResult
Contains code and message information: code is empty ("") means the call is successful; code is not empty ("") means the call failed, see message for the reason of failure

logout

Future<void> logout()

setSelfInfo

This API is used to set the alias and profile photo. The alias cannot exceed 500 bytes, and the profile photo is specified by a URL.
Future<TUIResult> setSelfInfo(String nickname, String avatar)
Parameter
Type
Description
nickName
String
The nick name.
avatar
String
The profile photo.
return value
TUIResult
Contains code and message information: code is empty ("") means the call is successful; code is not empty ("") means the call failed, see message for the reason of failure

calls

Initiate a call. Supported by v2.9+.
Future<TUIResult> calls(List<String> userIdList, TUICallMediaType mediaType, TUICallParams params)
Parameter
Type
Description
userIdList
List<String>
The target user IDs.
callMediaType
The call type, which can be video or audio.
params
Optional Extended call parameters, such as room number, call invitation timeout, offline push of custom content, etc.

join

Actively join the call. Supported by v2.9+.
Future<void> join(String callId)
Parameter
Type
Description
callId
String
Unique ID for this call.

enableMuteMode

This API is used to set whether to turn on the mute mode.
Future<void> enableMuteMode(bool enable)
Parameter
Type
Description
enable
bool
Turn on and off the mute; true means to turn on the mute

enableFloatWindow

This API is used to set whether to enable floating windows. The default value is false, and the floating window button in the top left corner of the call view is hidden. If it is set to true, the button will become visible.
Future<void> enableFloatWindow(bool enable)
Parameter
Type
Description
enable
bool
The default value is false, and the floating window button in the top left corner of the call view is hidden. If it is set to true, the button will become visible.

setCallingBell

Custom ringtone.
Future<void> setCallingBell(String assetName)
Parameter
Type
Description
assetName
String
The path of the ringtone. The ringtone file needs to be added to the assets resource of the main project.

enableVirtualBackground

Turn On/Off the Virtual Background feature. After enabling the Virtual Background feature, you can display the Blurry Background feature button on the UI. Clicking the button will directly enable the Blurry Background feature.
Future<void> enableVirtualBackground(bool enable)
Parameter
Type
Meaning
enable
bool
Turn on, turn off mute; true means mute is on

Deprecated interfaces

call

This API is used to make a (one-to-one) call.
Note:
This interface has been deprecated in v2.9+. It is recommended to use the calls interface instead.
Future<void> call(String userId, TUICallMediaType callMediaType, [TUICallParams? params])
The parameters are described below:
Parameter
Type
Description
userId
String
The target user ID.
callMediaType
The call type, which can be video or audio.

groupCall

This API is used to make a group call.
Note:
This interface has been deprecated in v2.9+. It is recommended to use the calls interface instead.
Future<void> groupCall(String groupId, List<String> userIdList, TUICallMediaType callMediaType,[TUICallParams? params])
The parameters are described below:
Parameter
Type
Description
groupId
String
The group ID.
userIdList
List<String>
The target user IDs.
callMediaType
The call type, which can be video or audio.

joinInGroupCall

This API is used to join a group call.Before making a group call, you need to create an IM group first.
Note:
This interface has been deprecated in v2.9+. It is recommended to use the join interface instead.
Future<void> joinInGroupCall(TUIRoomId roomId, String groupId, TUICallMediaType callMediaType)
Parameter
Type
Description
roomId
TUIRoomID
The room ID.
groupId
String
The group ID.
callMediaType
The call type, which can be video or audio.

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백