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 정책
개인 정보 보호 정책
데이터 처리 및 보안 계약
용어집

BattleStore

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

Introduction

PK feature enables real-time interactive battles between hosts. BattleStore provides a comprehensive set of APIs to manage the entire PK lifecycle.
Important:
Always use the factory method create(liveID:) with a valid live room ID to create a BattleStore instance. Do not attempt to initialize directly.
Note:
PK state updates are delivered through the state publisher. Subscribe to it to receive real-time updates about PK information, participating users, and scores.
Warning:
If a PK request does not receive a response within the specified timeout, a timeout event will be triggered. Always handle timeout scenarios in the UI.

Features

PK Request Management:Hosts can initiate PK requests, and invitees can accept or reject
State Management:Real-time tracking of PK information, participating users, and scores
Event-Driven Architecture:Provides complete PK event callbacks
Timeout Handling:Built-in timeout mechanism for PK requests

Subscribable Data

BattleState fields are described below:
Property
Type
Description
currentBattleInfo
Current PK information.
battleUsers
PK user list.
battleScore
[String: UInt]
PK score mapping.

API List

Function
Description
Create BattleStore instance.
PK event publisher.
Initiate PK request.
Cancel PK request.
Accept PK request.
Reject PK request.
Exit PK.

Creating Instance

create

Create BattleStore instance
public static func create(liveID: String) -> BattleStore {
let store: BattleStoreImpl = 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

battleEventPublisher

PK event publisher

PK Operations

requestBattle

Initiate PK request
public func requestBattle(config: BattleConfig, userIDList: [String], timeout: TimeInterval, completion: BattleRequestClosure?) {
fatalError("\\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
config
Required
PK configuration.
userIDList
[String]
Required
List of user IDs to join PK.
timeout
TimeInterval
Required
Request timeout duration.
completion
BattleRequestClosure?
Required
Callback for successful request initiation.

cancelBattleRequest

Cancel PK request
public func cancelBattleRequest(battleId: String, userIdList: [String], completion: CompletionClosure?) {
fatalError("\\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
battleId
String
Required
PK ID.
userIdList
[String]
Required
User ID list.
completion
Required
Callback for successful cancellation.

acceptBattle

Accept PK request
public func acceptBattle(battleID: String, completion: CompletionClosure?) {
fatalError("\\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
battleID
String
Required
PK ID.
completion
Required
Callback for successful acceptance.

rejectBattle

Reject PK request
public func rejectBattle(battleID: String, completion: CompletionClosure?) {
fatalError("\\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
battleID
String
Required
PK ID.
completion
Required
Callback for successful rejection.

exitBattle

Exit PK
public func exitBattle(battleID: String, completion: CompletionClosure?) {
fatalError("\\(#function) must be overridden by subclass")
}
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
battleID
String
Required
PK ID.
completion
Required
Callback for successful exit.

Data Structures

BattleEndedReason

Reason for PK ending received by users in an ongoing PK
Enum Value
Value
Description
timeOver
0
PK countdown ended.
allMemberExit
1
All PK members exited.

BattleEvent

PK-related callback events received
Enum Value
Description
onBattleStarted
This callback is triggered when PK officially starts, notifying all participants that PK has begun.
onBattleEnded
This callback is triggered when PK ends.
onUserJoinBattle
This callback is triggered when a user joins PK.
onUserExitBattle
This callback is triggered when a user exits PK.
onBattleRequestReceived
This callback is triggered when a PK request is received.
onBattleRequestCancelled
This callback is triggered when a PK request is cancelled.
onBattleRequestTimeout
This callback is triggered when a PK request times out.
onBattleRequestAccept
This callback is triggered when a PK request is accepted.
onBattleRequestReject
This callback is triggered when a PK request is rejected.

BattleConfig

PK configuration information set when sending a PK request
Property
Type
Description
duration
TimeInterval
PK duration (unit: seconds).
needResponse
Bool
Whether the invitee needs to reply with accept/reject.
extensionInfo
String
Extension information.

BattleInfo

PK information
Property
Type
Description
battleID
String
PK ID.
config
PK configuration information set when sending a PK request.
startTime
UInt
PK start marker timestamp (unit: seconds).
endTime
UInt
PK end marker timestamp (unit: seconds).

BattleState

PK-related state data provided by BattleStore
Property
Type
Description
currentBattleInfo
Current PK information.
battleUsers
PK user list.
battleScore
[String: UInt]
PK score mapping.

BattleRequestCallback

PK request callback
Callback interface for PK requests, used to handle success or failure results of PK requests.
Methods
onSuccess: Success callback.
fun onSuccess(battleInfo: BattleInfo, resultMap: Map<String, Int>)
Parameter
Type
Description
battleInfo
PK information, containing detailed configuration and status of the PK.
resultMap
Map<String, Int>
Response result callback for PK request.
onError: Failure callback.
fun onError(code: Int, desc: String)
Parameter
Type
Description
code
Int
Error code.
desc
String
Error description.

Usage Example

// Create store instance
let store = BattleStore.create(liveID: "live_room_123")

// Subscribe to state changes
store.state.subscribe { state in
if let battleInfo = state.currentBattleInfo {
print("Current PK ID: \\(battleInfo.battleID)")
}
print("PK user count: \\(state.battleUsers.count)")
}

// Subscribe to PK events
store.battleEventPublisher.sink { event in
switch event {
case .onBattleStarted(let battleInfo, let inviter, let invitees):
print("PK started, initiator: \\(inviter.userName)")
case .onBattleEnded(let battleInfo, let reason):
print("PK ended, reason: \\(reason)")
default:
break
}
}

// Initiate PK request
let config = BattleConfig(duration: 300, needResponse: true)
store.requestBattle(config: config, userIDList: ["user_456"], timeout: 30) { result in
switch result {
case .success(let (battleInfo, resultMap)):
print("PK request successful: \\(battleInfo.battleID)")
case .failure(let error):
print("PK request failed: \\(error)")
}
}


도움말 및 지원

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

피드백