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 政策
隐私协议
数据处理和安全协议
词汇表

GiftStore

PDF
聚焦模式
字号
最后更新时间: 2026-03-05 17:36:40

简介

GiftStore 提供了一套完整的礼物管理 API,包括发送礼物、刷新礼物列表、设置语言和监听礼物事件。
通过该类,可以在直播间内实现礼物互动功能。
重要:
使用 GiftStore.create 工厂方法创建 GiftStore 实例,需要传入有效的直播间 ID。
说明:
礼物状态更新通过 giftState 发布者传递。订阅它以接收房间内礼物数据的实时更新。

功能特性

礼物发送:支持向当前房间发送指定礼物。
礼物列表:获取和刷新当前房间可用的礼物列表。
语言设置:设置礼物信息的展示语言。
事件监听:监听礼物接收事件。

可订阅数据

GiftState 的字段描述如下:
属性名
类型
描述
usableGifts
StateFlow<List<GiftCategory>>
当前房间可用的所有礼物分类及礼物列表。

API 列表

函数名
描述
创建礼物管理实例。
礼物事件回调。
礼物事件回调。
发送礼物。
刷新可用礼物列表。
设置展示语言。

创建实例

GiftStore.create

创建礼物管理实例。

观察状态和事件

addGiftListener

礼物事件回调

removeGiftListener

礼物事件回调

礼物操作

sendGift

向当前房间发送指定礼物
abstract fun sendGift(
giftID: String,
count: Int,
completion: CompletionHandler?
)
版本信息
从 3.5 版本开始支持。
参数说明
参数名
类型
是否必填
描述
giftID
String
必填
要发送的礼物唯一标识 ID。
count
Int
必填
单次发送的礼物数量。
completion
必填
完成回调(成功/失败状态)。

refreshUsableGifts

手动刷新当前房间的可用礼物列表。
abstract fun refreshUsableGifts(completion: CompletionHandler?)
版本信息
从 3.5 版本开始支持。
参数说明
参数名
类型
是否必填
描述
completion
必填
完成回调(成功时可通过 state 获取最新礼物列表,失败时返回错误信息)。

setLanguage

设置礼物信息的展示语言。
abstract fun setLanguage(language: String)
版本信息
从 3.5 版本开始支持。
参数说明
参数名
类型
是否必填
描述
language
String
必填
语言代码("zh-CN" 表示中文,"en" 表示英文),设置完成展示界面刷新后礼物名称、描述等会同步更新为对应语言。

数据结构

Gift

礼物数据模型,包含单个礼物的完整属性信息。
属性
类型
说明
giftID
String
礼物ID。
name
String
礼物名称。
desc
String
礼物描述。
iconURL
String
礼物图标图片的网络 URL,用于加载礼物缩略图。
resourceURL
String
礼物动效资源文件的网络 URL,用于加载礼物展示动效。
level
Long
礼物等级,用于区分礼物稀有度或价值层级。
coins
Long
礼物价格(金币)。
extensionInfo
Map<String, String>
礼物扩展信息,可自定义字段(如特效类型、赠送限制等)。

GiftCategory

礼物分类。
属性
类型
说明
categoryID
String
分类唯一标识 ID,用于区分不同礼物分类。
name
String
分类展示名称,用于 UI 分类显示(如 "热门礼物","高级礼物")。
desc
String
分类描述信息,用于说明该分类的特点。
extensionInfo
Map<String, String>
分类扩展信息,包含自定义字段(如排序权重、显示样式等)。
giftList
List<Gift>
当前分类下的所有礼物列表。

GiftState

礼物状态,管理当前房间的礼物数据状态,支持实时更新并可被订阅监听。
属性
类型
说明
usableGifts
StateFlow<List<GiftCategory>>
当前房间可用的所有礼物分类及礼物列表。

GiftListener

礼物事件,用于接收直播间/语音聊天房内的礼物动态。
方法
onReceiveGift: 收到新礼物消息的事件回调。当直播间/语音聊天房内有其他观众发送礼物时,会触发该事件并返回相关信息。
open fun onReceiveGift(liveID: String, gift: Gift, count: Int, sender: LiveUserInfo) {}
参数名
类型
说明
liveID
String
直播间ID。
gift
礼物信息。
count
Int
礼物数量。
sender
礼物发送者信息。

帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈