Copyright (c) 2025 Tencent. All rights reserved.
Module: TUILiveGiftManager @ TUIKitEngine
Function: 直播 礼物相关接口。
TUILiveGiftManager
TUILiveGiftManager
函数列表 | 描述 |
礼物数量变更回调 | |
收到礼物消息回调 | |
收到点赞消息回调 | |
添加事件回调 | |
移除事件回调 | |
获取礼物列表 | |
发送礼物 | |
发送点赞 | |
房主获取礼物数量 | |
获取点赞数量 |
结构体类型
函数列表 | 描述 |
礼物信息 | |
礼物分类信息 | |
礼物数量请求结果 |
OnGiftCountChanged
礼物数量变更回调
OnGiftCountChanged onGiftCountChanged = (String roomId,int totalGiftsSent,int totalGiftCoins,int totalUniqueGiftSenders) {};
参数 | 描述 |
roomId | 直播间 ID |
totalGiftsSent | 礼物数量 |
totalGiftCoins | 礼物价值 |
totalUniqueGiftSenders | 礼物发送者数量 |
OnReceiveGiftMessage
收到礼物消息回调
OnReceiveGiftMessage onReceiveGiftMessage = (String roomId,TUIGiftInfo giftInfo,int count,TUIUserInfo sender) {};
参数 | 描述 |
roomId | 直播间 ID |
giftInfo | 礼物信息 |
count | 礼物数量 |
sender | 礼物发送者信息 |
OnReceiveLikesMessage
收到点赞消息回调
OnReceiveLikesMessage onReceiveLikesMessage = (String roomId,int totalLikesReceived,TUIUserInfo sender) {};
参数 | 描述 |
roomId | 直播间 ID |
totalLikesReceived | 点赞数量 |
sender | 点赞发送者信息 |
addObserver
添加事件回调
void addObserver(TUILiveGiftObserver observer);
参数 | 描述 |
observer | 监听的实例 |
removeObserver
移除事件回调
void removeObserver(TUILiveGiftObserver observer);
参数 | 描述 |
observer | 监听的实例 |
getGiftList
获取礼物列表
Future<TUIValueCallBack<List<TUIGiftCategory>>> getGiftList(String roomId);
参数 | 描述 |
roomId | 直播间 ID |
sendGift
发送礼物
Future<TUIActionCallback> sendGift(String roomId,String giftId,int count);
参数 | 描述 |
roomId | 直播间 ID |
giftId | 礼物 ID |
count | 礼物数量 |
sendLike
发送点赞
Future<TUIActionCallback> sendLike(String roomId,int count);
参数 | 描述 |
roomId | 直播间 ID |
count | 点赞数量 |
getGiftCountByAnchor
房主获取礼物数量
Future<TUIValueCallBack<TUIGiftCountRequestResult>> getGiftCountByAnchor(String roomId);
参数 | 描述 |
roomId | 直播间 ID |
getLikesCount
获取点赞数量
Future<TUIValueCallBack<int>> getLikesCount(String roomId);
参数 | 描述 |
roomId | 直播间 ID |
TUIGiftInfo
礼物信息
枚举类型 | 描述 |
giftId | Gift 礼物 ID |
name | Gift 礼物名称 |
desc | Gift 礼物描述 |
iconUrl | Gift 礼物图标 URL |
resourceUrl | Gift 礼物资源 URL |
level | Gift 礼物等级 |
coins | Gift 礼物价格 |
extensionInfo | Gift 礼物扩展自定义信息 |
TUIGiftCategory
礼物分类信息
枚举类型 | 描述 |
categoryId | Gift 分类 ID |
name | Gift 分类名称 |
desc | Gift 分类描述 |
extensionInfo | Gift 分类扩展自定义信息 |
giftList | Gift 分类礼物列表 |
TUIGiftCountRequestResult
礼物数量请求结果
枚举类型 | 描述 |
totalGiftsSent | 礼物数量 |
totalGiftCoins | 礼物价值 |
totalUniqueGiftSenders | 礼物发送者数量 |