tencent cloud

Tencent Real-Time Communication

Release Notes and Announcements
Release Notes
Recent Product Announcement
TRTC Live (TUILiveKit) Product Launch Announcement
TRTC Conference Official Editions Launched
The commercial version of Conference is coming soon
Terms and Conditions Applicable to $9.9 Starter Package
Rules for the "First Subscription $100 Discount" Promotion
Announcement on the Start of Beta Testing for Multi-person Audio and Video Conference
TRTC Call Official Editions Launched
License Required for Video Playback in New Version of LiteAV SDK
TRTC to Offer Monthly Packages
Product Introduction
Overview
Concepts
Features
Strengths
Use Cases
Performance Statistics
Tencent RTC Quickplay: Experience Ultimate Real-Time Audio and Video Interaction!
Purchase Guide
Billing Overview
Free Minutes
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
FAQs
Refund Instructions
User Tutorial
Free Demo
Call
Overview
Activate the Service
Run Demo
Integration
Offline Call Push
Conversational Chat
On-Cloud Recording
AI Noise Reduction
UI Customization
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
Release Notes
FAQs
Conference
Overview(TUIRoomKit)
Activate the Service (TUIRoomKit)
Run Demo(TUIRoomKit)
Integration(TUIRoomKit)
Screen Sharing (TUIRoomKit)
Schedule a meeting (TUIRoomKit)
In-meeting Call (TUIRoomKit)
UI Customization(TUIRoomKit)
Virtual Background (TUIRoomKit)
Conference Control (TUIRoomKit)
Cloud Recording (TUIRoomKit)
AI Noise Reduction (TUIRoomKit)
In-Conference Chat (TUIRoomKit)
Robot Streaming (TUIRoomKit)
Enhanced Features (TUIRoomKit)
Client APIs (TUIRoomKit)
Server APIs (TUIRoomKit)
FAQs (TUIRoomKit)
Error Code (TUIRoomKit)
SDK Update Log (TUIRoomKit)
Live
Billing of Video Live Component
Overview
Activating the Service (TUILiveKit)
Run 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 Download
API Examples
Usage Guidelines
API Reference Manual
Advanced Features
AI Integration
Overview
Configure MCP Server
Install Skills
Integration Guide
FAQ
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
Console Guide
Application Management
Package Management
Usage Statistics
Monitoring Dashboard
Development Assistance
Solution
Real-Time Chorus
FAQs
Migration Guide
Billing
Features
UserSig
Firewall Restrictions
How to Downsize Installation Package
Android and iOS
Web
Flutter
Electron
TRTCCalling for Web
Audio and Video Quality
Others
Legacy Documentation
RTC RoomEngine SDK(Old)
Integrating TUIRoom (Web)
Integrating TUIRoom (Android)
Integrating TUIRoom (iOS)
Integrating TUIRoom (Flutter)
Integrating TUIRoom (Electron)
TUIRoom APIs
On-Cloud Recording and Playback (Old)
RTC Analytics Monthly Packages (Previous Version)
Protocols and Policies
Compliance
Security White Paper
Notes on Information Security
Service Level Agreement
Apple Privacy Policy: PrivacyInfo.xcprivacy
TRTC Policy
Privacy Policy
Data Processing And Security Agreement
Glossary

TUILiveGiftManager

PDF
Focus Mode
Font Size
Last updated: 2025-09-29 20:10:08
Copyright (c) 2025 Tencent. All rights reserved.
Module: TUILiveGiftManager @ TUIKitEngine
Function: APIs for live stream gifts.

TUILiveGiftManager

TUILiveGiftManager

Function List
Description
Gift quantity change callback
Gift message callback
Like message callback
add event callback
remove event callback
gift list
sendGift
send a gift
sendLike
Send a like
Number of gifts obtained by the room owner
Number of likes obtained

Struct Type

Function List
Description
gift information
gift classification information
Number of gifts Request result

OnGiftCountChanged

Gift quantity change callback
OnGiftCountChanged onGiftCountChanged = (String roomId,
int totalGiftsSent,
int totalGiftCoins,
int totalUniqueGiftSenders) {};
Parameter
Description
roomId
liveRoomId
totalGiftsSent
Number of gifts
totalGiftCoins
Gift value
totalUniqueGiftSenders
Number of gift senders

OnReceiveGiftMessage

Gift message callback
OnReceiveGiftMessage onReceiveGiftMessage = (String roomId,
TUIGiftInfo giftInfo,
int count,
TUIUserInfo sender) {};
Parameter
Description
roomId
liveRoomId
giftInfo
gift information
count
Number of gifts
sender
Gift sender information

OnReceiveLikesMessage

Like message callback
OnReceiveLikesMessage onReceiveLikesMessage = (String roomId,
int totalLikesReceived,
TUIUserInfo sender) {};
Parameter
Description
roomId
liveRoomId
totalLikesReceived
Number of likes
sender
Like sender information

addObserver

add event callback
void addObserver(TUILiveGiftObserver observer);
Parameter
Description
observer
instance of listen

removeObserver

remove event callback
void removeObserver(TUILiveGiftObserver observer);
Parameter
Description
observer
instance of listen

getGiftList

gift list
Future<TUIValueCallBack<List<TUIGiftCategory>>> getGiftList(String roomId);
Parameter
Description
roomId
liveRoomId

sendGift

send a gift
Future<TUIActionCallback> sendGift(String roomId,
String giftId,
int count);
Parameter
Description
roomId
liveRoomId
giftId
gift ID
count
Number of gifts

sendLike

Send a like
Future<TUIActionCallback> sendLike(String roomId,
int count);
Parameter
Description
roomId
liveRoomId
count
Number of likes

getGiftCountByAnchor

Number of gifts obtained by the room owner
Future<TUIValueCallBack<TUIGiftCountRequestResult>> getGiftCountByAnchor(String roomId);
Parameter
Description
roomId
liveRoomId

getLikesCount

Number of likes obtained
Future<TUIValueCallBack<int>> getLikesCount(String roomId);
Parameter
Description
roomId
liveRoomId

TUIGiftInfo

gift information
Enumeration Types
Description
giftId
Gift ID
name
Gift name
desc
Gift description
iconUrl
Gift icon URL
resourceUrl
Gift resource URL
level
Gift level
coins
Gift price
extensionInfo
Gift custom information

TUIGiftCategory

gift classification information
Enumeration Types
Description
categoryId
Gift category ID
name
Gift category name
desc
Gift category description
extensionInfo
Gift custom information
giftList
Gift category gift list

TUIGiftCountRequestResult

Number of gifts Request result
Enumeration Types
Description
totalGiftsSent
Number of gifts
totalGiftCoins
Gift value
totalUniqueGiftSenders
Number of gift senders



Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback