tencent cloud

Tencent Real-Time Communication

소식 및 공지 사항
제품 업데이트
Tencent Cloud 오디오/비디오 단말 SDK 재생 업그레이드 및 권한 부여 인증 추가
TRTC 월간 구독 패키지 출시 관련 안내
제품 소개
제품 개요
기본 개념
제품 기능
제품 장점
응용 시나리오
성능 데이터
구매 가이드
Billing Overview
무료 시간 안내
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
과금 FAQ
Refund Instructions
신규 사용자 가이드
Demo 체험
Call
개요(TUICallKit)
Activate the Service
Run Demo
빠른 통합(TUICallKit)
오프라인 푸시
Conversational Chat
온클라우드 녹화(TUICallKit)
AI Noise Reduction
UI 사용자 정의
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
릴리스 노트
FAQs
라이브 스트리밍
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 클라이언트 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
FAQs
과금 개요
기능 관련
UserSig 관련
방화벽 제한 처리
설치 패키지 용량 축소 관련 질문
Andriod 및 iOS 관련
Web 관련
Flutter 관련
Electron 관련
TRTCCalling Web 관련
멀티미디어 품질 관련
기타 질문
Protocols and Policies
컴플라이언스 인증
보안 백서
정보 보안에 관한 참고 사항
Service Level Agreement
Apple Privacy Policy: PrivacyInfo.xcprivacy
TRTC 정책
개인 정보 보호 정책
데이터 처리 및 보안 계약
용어집
문서Tencent Real-Time Communication라이브 스트리밍Client APIsiOSGiftStore

GiftStore

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-03-05 17:06:13

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 create(liveID:) factory method to create a GiftStore instance, passing a valid live room ID.
Note:
Gift state updates are delivered through the state 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
All gift categories and gift lists available in the current room.

API List

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

Creating Instance

create

Create gift management instance.
public static func create(liveID: String) -> GiftStore {
    let store: GiftStoreImpl = StoreFactory.shared.getStore(liveId: liveID)
    return store
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
liveID
String
Required
Live room ID.

Observing State and Events

giftEventPublisher

Gift event publisher

Gift Operations

sendGift

Send a specified gift to the current room
public func sendGift(giftID: String,
                     count: UInt,
                     completion: CompletionClosure?) {
    fatalError("\\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
giftID
String
Required
Unique identifier ID of the gift to send.
count
UInt
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.
public func refreshUsableGifts(completion: CompletionClosure?) {
    fatalError("\\(#function) must be overridden by subclass")
}
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.
public func setLanguage(_ language: String) {
    fatalError("\\(#function) must be overridden by subclass")
}
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
UInt
Gift level, used to distinguish gift rarity or value tier.
coins
UInt
Gift price (coins).
extensionInfo
[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
[String: String]
Category extension information, containing custom fields (such as sorting weight, display style, etc.).
giftList
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
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.
case onReceiveGift(liveID: String, gift: Gift, count: UInt8, sender: LiveUserInfo)
Parameter
Type
Description
liveID
String
Live room ID.
gift
Gift information.
count
UInt8
Gift count.
sender
Gift sender information.
이전 주제: DeviceStore다음 주제: LikeStore

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백