tencent cloud

Tencent Real-Time Communication

お知らせ・リリースノート
製品アップデート情報
Tencent Cloudオーディオビデオ端末SDKの再生アップグレードおよび承認チェック追加に関するお知らせ
TRTCアプリケーションのサブスクリプションパッケージサービスのリリースに関する説明について
製品の説明
製品概要
基礎概念
製品の機能
製品の強み
ユースケース
性能データ
購入ガイド
Billing Overview
無料時間の説明
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
課金に関するよくあるご質問
Refund Instructions
初心者ガイド
Demo体験
Call
コンポーネントの説明(TUICallKit)
Activate the Service
Run Demo
クイック導入
オフライン通知
Conversational Chat
クラウドレコーディング(TUICallKit)
AI Noise Reduction
インターフェースのカスタマイズ
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
公開ログ
よくある質問
ライブ配信
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
高度な機能
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
よくあるご質問
課金関連問題
機能関連
UserSig関連
ファイアウォールの制限の対応関連
インストールパッケージの圧縮に関するご質問
AndriodおよびiOS関連
Web端末関連
Flutter関連
Electron関連
TRTCCalling Web関連
オーディオビデオ品質関連
その他のご質問
旧バージョンのドキュメント
TUIRoom(Web)の統合
TUIRoom (Android)の統合
TUIRoom (iOS)の統合
TUIRoom (Flutter)の統合
TUIRoom (Electron)の統合
TUIRoom APIのクエリー
クラウドレコーディングと再生の実現(旧)
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.

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック