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

CoGuestStore

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

Introduction

Co-guest feature enables real-time interaction between hosts and audience members through a seat-based system. CoGuestStore provides a comprehensive set of APIs to manage the entire co-guest lifecycle.
Important:
Always use the factory method create(liveID:) with a valid live room ID to create a CoGuestStore instance. Do not attempt to initialize directly.
Note:
Co-guest state updates are delivered through the state publisher. Subscribe to it to receive real-time updates about connected users, invitations and applications.
Warning:
If a co-guest request does not receive a response within the specified timeout, an event with NoResponseReason.timeout will be triggered. Always handle timeout scenarios in your UI.

Features

Bidirectional Invitation:Hosts can invite audience members, and audience members can also apply to join
State Management:Real-time tracking of connected users, invitations and applications
Event-Driven Architecture:Provides separate event streams for host and guest roles
Timeout Handling:Built-in timeout mechanism for invitations and applications

Subscribable Data

CoGuestState fields are described below:
Property
Type
Description
connected
List of users already on seats.
invitees
List of users invited by host.
applicants
List of users who applied for co-guest received by host.
candidates
List of candidate users for co-guest.

API List

Function
Description
Create object instance.
Host-side event publisher.
Guest-side event publisher.
Guest applies for co-guest.
Guest cancels application.
Host accepts application.
Host rejects application.
Host invites guest to co-guest.
Host cancels invitation.
Guest accepts invitation.
Guest rejects invitation.
End co-guest session.

Creating Instance

create

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

hostEventPublisher

Host-side event publisher

guestEventPublisher

Guest-side event publisher

Guest Operations

applyForSeat

Apply to go on seat
public func applyForSeat(seatIndex: Int = -1, timeout: TimeInterval, extraInfo: String?, completion: CompletionClosure?) { fatalError("\\(#function) must be overridden by subclass") }
Request to join co-guest session as an audience member. After calling this method, a co-guest request is sent to all hosts in the live room. The request will remain active until: • Host accepts via acceptApplication • Host rejects via rejectApplication • Timeout expires • You cancel via cancelApplication
Version
Supported since version 3.5.
Notes
Note:
If no host responds within the timeout, {ref2} event with NoResponseReason/timeout will be triggered.
Parameters
Parameter
Type
Required
Description
seatIndex
Int
Required
Seat index, -1 means auto-assign seat.
timeout
TimeInterval
Required
Timeout (unit: seconds).
extraInfo
String?
Required
Extra information.
completion
Required
Completion callback.

cancelApplication

Cancel seat application
public func cancelApplication(completion: CompletionClosure?) { fatalError("\\(#function) must be overridden by subclass") }
Cancel a previously sent co-guest application. After calling this method, all hosts will be notified of the application cancellation.
Version
Supported since version 3.5.
Notes
Note:
If the application has already been processed by a host, the cancellation may have no effect.
Parameters
Parameter
Type
Required
Description
completion
Required
Completion callback.

acceptApplication

Accept seat application
public func acceptApplication(userID: String, completion: CompletionClosure?) { fatalError("\\(#function) must be overridden by subclass") }
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
userID
String
Required
User ID.
completion
Required
Completion callback.

rejectApplication

Reject seat application
public func rejectApplication(userID: String, completion: CompletionClosure?) { fatalError("\\(#function) must be overridden by subclass") }
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
userID
String
Required
User ID.
completion
Required
Completion callback.

Host Operations

inviteToSeat

Invite audience to seat
public func inviteToSeat(userID: String, seatIndex: Int = -1, timeout: TimeInterval, extraInfo: String?, completion: CompletionClosure?) { fatalError("\\(#function) must be overridden by subclass") }
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
userID
String
Required
Invited user ID.
seatIndex
Int
Required
Seat index, -1 means auto-assign seat.
timeout
TimeInterval
Required
Timeout (unit: seconds).
extraInfo
String?
Required
Extra information.
completion
Required
Completion callback.

cancelInvitation

Cancel seat invitation
public func cancelInvitation(inviteeID: String, completion: CompletionClosure?) { fatalError("\\(#function) must be overridden by subclass") }
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
inviteeID
String
Required
Invited user ID.
completion
Required
Completion callback.

acceptInvitation

Accept seat invitation
public func acceptInvitation(inviterID: String, completion: CompletionClosure?) { fatalError("\\(#function) must be overridden by subclass") }
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
inviterID
String
Required
Inviter user ID.
completion
Required
Completion callback.

rejectInvitation

Reject seat invitation
public func rejectInvitation(inviterID: String, completion: CompletionClosure?) { fatalError("\\(#function) must be overridden by subclass") }
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
inviterID
String
Required
Inviter user ID.
completion
Required
Completion callback.

Connection Control

disConnect

Disconnect co-guest
public func disConnect(completion: CompletionClosure?) { fatalError("\\(#function) must be overridden by subclass") }
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
completion
Required
Completion callback.

Data Structures

NoResponseReason

Reason for no response to co-guest invitation sent by host or co-guest request initiated by audience
Enum Value
Value
Description
timeout
0
Request timeout.
alreadySeated
1
User already on seat.

HostEvent

Callback events received on host side
Enum Value
Description
onGuestApplicationReceived
This callback is triggered when an audience applies for co-guest.
onGuestApplicationCancelled
This callback is triggered when an audience cancels co-guest application.
onGuestApplicationProcessedByOtherHost
This callback is triggered when an audience's co-guest application is processed by another host.
onHostInvitationResponded
This callback is triggered when a co-guest invitation sent by host receives a response from audience.
onHostInvitationNoResponse
This callback is triggered when a co-guest invitation sent by host receives no response.

GuestEvent

Callback events received on guest side
Enum Value
Description
onHostInvitationReceived
This callback is triggered when receiving a co-guest invitation from host.
onHostInvitationCancelled
This callback is triggered when host cancels co-guest invitation.
onGuestApplicationResponded
This callback is triggered when audience's co-guest application receives a response from host.
onGuestApplicationNoResponse
This callback is triggered when audience's co-guest application receives no response.
onKickedOffSeat
This callback is triggered when audience is kicked off seat by host.

CoGuestState

Co-guest related state data provided externally by CoGuestStore
Property
Type
Description
connected
List of users already on seats.
invitees
List of users invited by host.
applicants
List of users who applied for co-guest received by host.
candidates
List of candidate users for co-guest.

Usage Example

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

// Subscribe to state changes
store.state.subscribe { state in
print("Connected users: \\(state.connected.count)")
print("Pending applications: \\(state.applicants.count)")
}

// Subscribe to host events (for hosts)
store.hostEventPublisher.sink { event in
switch event {
case .onGuestApplicationReceived(let guestUser):
print("Received application from \\(guestUser.userName)")
// Show accept/reject UI
case .onHostInvitationResponded(let isAccept, let guestUser):
print("Audience \\(guestUser.userName) \\(isAccept ? "accepted" : "rejected")")
default:
break
}
}

// Host: Accept application
store.acceptApplication(userID: "user_456") { code, message in
if code == 0 {
print("Application accepted successfully")
}
}


도움말 및 지원

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

피드백