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 ポリシー
プライバシーポリシー
データ処理とセキュリティ契約
用語集

GiftStore

PDF
フォーカスモード
フォントサイズ
最終更新日: 2026-03-05 17:36:40

Introduction

GiftStore provides a complete set of gift management APIs, including sending gifts, refreshing gift lists, setting language, and listening to gift events.
Through this class, gift interaction features can be implemented in live rooms.
Important:
Use the GiftStore.create factory method to create a GiftStore instance, passing a valid live room ID.
Note:
Gift state updates are delivered through the giftState publisher. Subscribe to it to receive real-time updates of gift data in the room.

Features

Gift Sending:Support sending specified gifts to the current room
Gift List:Get and refresh the available gift list in the current room
Language Setting:Set the display language for gift information
Event Listening:Listen to gift receiving events

Subscribable Data

GiftState fields are described below:
Property
Type
Description
usableGifts
StateFlow<List<GiftCategory>>
All gift categories and gift lists available in the current room.

API List

Function
Description
Create gift management instance.
Gift event callbacks.
Gift event callbacks.
Send gift.
Refresh available gift list.
Set display language.

Creating Instance

GiftStore.create

Create gift management instance

Observing State and Events

addGiftListener

Gift event callbacks

removeGiftListener

Gift event callbacks

Gift Operations

sendGift

Send a specified gift to the current room
abstract fun sendGift(
giftID: String,
count: Int,
completion: CompletionHandler?
)
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
giftID
String
Required
Unique identifier ID of the gift to send.
count
Int
Required
Number of gifts to send at once.
completion
Required
Completion callback (success/failure status).

refreshUsableGifts

Manually refresh the available gift list in the current room.
abstract fun refreshUsableGifts(completion: CompletionHandler?)
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
completion
Required
Completion callback (on success, the latest gift list can be obtained through state; on failure, error information is returned).

setLanguage

Set the display language for gift information.
abstract fun setLanguage(language: String)
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
language
String
Required
Language code ("zh-CN" for Chinese, "en" for English). After setting, gift names, descriptions, etc. will be updated to the corresponding language when the display interface is refreshed.

Data Structures

Gift

Gift data model, containing complete attribute information of a single gift.
Property
Type
Description
giftID
String
Gift ID.
name
String
Gift name.
desc
String
Gift description.
iconURL
String
Network URL of the gift icon image, used to load gift thumbnails.
resourceURL
String
Network URL of the gift animation resource file, used to load gift display animations.
level
Long
Gift level, used to distinguish gift rarity or value tier.
coins
Long
Gift price (coins).
extensionInfo
Map<String, String>
Gift extension information, customizable fields (such as effect type, sending restrictions, etc.).

GiftCategory

Gift category.
Property
Type
Description
categoryID
String
Category unique identifier ID, used to distinguish different gift categories.
name
String
Category display name, used for UI category display (such as "Popular Gifts", "Premium Gifts").
desc
String
Category description information, used to explain the characteristics of this category.
extensionInfo
Map<String, String>
Category extension information, containing custom fields (such as sorting weight, display style, etc.).
giftList
List<Gift>
All gifts under the current category.

GiftState

Gift state, managing the gift data state of the current room, supporting real-time updates and subscription listening.
Property
Type
Description
usableGifts
StateFlow<List<GiftCategory>>
All gift categories and gift lists available in the current room.

GiftListener

Gift event, used to receive gift dynamics in live rooms/voice chat rooms.
Methods
onReceiveGift: Event callback when receiving a new gift message. This event is triggered when other viewers send gifts in the live room/voice chat room, returning relevant information.
open fun onReceiveGift(liveID: String, gift: Gift, count: Int, sender: LiveUserInfo) {}
Parameter
Type
Description
liveID
String
Live room ID.
gift
Gift information.
count
Int
Gift count.
sender
Gift sender information.

ヘルプとサポート

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

フィードバック