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

CoHostStore

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

Introduction

Cross-room connection feature allows hosts from different live rooms to interact in real-time. CoHostStore provides a comprehensive set of APIs to manage the entire cross-room connection lifecycle.
Important:
Always use the factory method CoHostStore.create with a valid live room ID to create a CoHostStore instance. Do not attempt to initialize directly.
Note:
Connection state updates are delivered through the coHostState publisher. Subscribe to it to receive real-time updates about connection status, connected hosts, invitations and applications.
Warning:
If a connection request does not receive a response within the specified timeout, the timeout event will be triggered. Always handle timeout scenarios in your UI.

Features

Bidirectional Connection:Hosts can initiate connection requests to other hosts, and also receive connection requests from other hosts
State Management:Real-time tracking of connection status, connected hosts, invitation list and applicants
Event-Driven Architecture:Provides connection event stream for monitoring various connection state changes
Layout Templates:Supports multiple connection layout templates, such as dynamic grid layout and 1-to-6 layout

Subscribable Data

CoHostState fields are described below:
Property
Type
Description
coHostStatus
StateFlow<CoHostStatus>
Real-time cross-room connection status.
connected
StateFlow<List<SeatUserInfo>>
List of hosts currently connected with current live room.
invitees
StateFlow<List<SeatUserInfo>>
List of hosts to whom requests have been sent.
applicant
StateFlow<SeatUserInfo?>
Host who initiated connection request to current live room.
candidatesCursor
StateFlow<String>
Recommended user list cursor.
candidates
StateFlow<List<SeatUserInfo>>
Recommended user list.

API List

Function
Description
Create object instance.
Connection event callbacks.
Connection event callbacks.
Initiate connection request.
Cancel connection request.
Accept connection request.
Reject connection request.
Exit connection.
Get recommended host list.

Creating Instance

CoHostStore.create

Create object instance

Observing State and Events

addCoHostListener

Add connection callback listener
abstract fun addCoHostListener(
listener: CoHostListener?
)
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
listener
Required
Listener.

removeCoHostListener

Remove connection callback listener
abstract fun removeCoHostListener(
listener: CoHostListener?
)
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
listener
Required
Listener.

Connection Operations

requestHostConnection

Initiate host connection request
abstract fun requestHostConnection(
targetHostLiveID: String?,
layoutTemplate: CoHostLayoutTemplate,
timeout: Int,
extraInfo: String?,
completion: CompletionHandler?
)
Initiate a cross-room connection request to target host. After calling this method, a connection request is sent to the target host. The request will remain active until: • Target host accepts via acceptHostConnection(fromHostLiveID:completion:) • Target host rejects via rejectHostConnection(fromHostLiveID:completion:) • Timeout expires • You cancel via cancelHostConnection(toHostLiveID:completion:)
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
targetHostLiveID
String?
Required
Target host's live room ID.
layoutTemplate
Required
Connection layout template.
timeout
Int
Required
Request timeout (unit: seconds).
extraInfo
String?
Required
Extension information.
completion
Required
Callback for successful request initiation.

cancelHostConnection

Cancel host connection request
abstract fun cancelHostConnection(
toHostLiveID: String?,
completion: CompletionHandler?
)
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
toHostLiveID
String?
Required
Target host's live room ID.
completion
Required
Callback for successful cancellation.

acceptHostConnection

Accept host connection request
abstract fun acceptHostConnection(
fromHostLiveID: String?,
completion: CompletionHandler?
)
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
fromHostLiveID
String?
Required
Live room ID of the host initiating connection request.
completion
Required
Callback for successful acceptance.

rejectHostConnection

Reject host connection request
abstract fun rejectHostConnection(
fromHostLiveID: String?,
completion: CompletionHandler?
)
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
fromHostLiveID
String?
Required
Live room ID of the host initiating connection request.
completion
Required
Callback for successful rejection.

exitHostConnection

Exit host connection
abstract fun exitHostConnection(
completion: CompletionHandler?
)
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
completion
Required
Callback for successful exit from connection.

getCoHostCandidates

Get recommended host list that can connect with current host
abstract fun getCoHostCandidates(
cursor: String,
completion: CompletionHandler?
)
Version
Supported since version 3.5.
Parameters
Parameter
Type
Required
Description
cursor
String
Required
Cursor.
completion
Required
Completion callback.

Data Structures

CoHostStatus

Current user's cross-room connection status
Enum Value
Value
Description
CONNECTED
0
Currently connected with other hosts.
DISCONNECTED
1
Not connected with other hosts.

CoHostLayoutTemplate

Connection layout template
Enum Value
Value
Description
HOST_VOICE_CONNECTION
2
Voice chat room connection layout.
HOST_DYNAMIC_GRID
600
Host dynamic grid layout.
HOST_DYNAMIC_1V6
601
Host dynamic 1v6 layout.

CoHostListener

Connection request callback events
Methods
Method
Description
onCoHostRequestReceived
This callback is triggered when a connection request is received.
onCoHostRequestCancelled
This callback is triggered when a connection request is cancelled.
onCoHostRequestAccepted
This callback is triggered when a connection request is accepted.
onCoHostRequestRejected
This callback is triggered when a connection request is rejected.
onCoHostRequestTimeout
This callback is triggered when a connection request times out.
onCoHostUserJoined
This callback is triggered when a user joins the connection.
onCoHostUserLeft
This callback is triggered when a user leaves the connection.

CoHostState

Cross-room connection related state data provided externally by CoHostStore
Property
Type
Description
coHostStatus
StateFlow<CoHostStatus>
Real-time cross-room connection status.
connected
StateFlow<List<SeatUserInfo>>
List of hosts currently connected with current live room.
invitees
StateFlow<List<SeatUserInfo>>
List of hosts to whom requests have been sent.
applicant
StateFlow<SeatUserInfo?>
Host who initiated connection request to current live room.
candidatesCursor
StateFlow<String>
Recommended user list cursor.
candidates
StateFlow<List<SeatUserInfo>>
Recommended user list.

Usage Example

// Create store instance
val store = CoHostStore.create("live_room_123")

// Subscribe to state changes
lifecycleScope.launch {
store.coHostState.coHostStatus.collect { status ->
println("Connection status: $status")
}
}

lifecycleScope.launch {
store.coHostState.connected.collect { connected ->
println("Connected hosts: ${connected.size}")
}
}

// Add connection event listener
store.addCoHostListener(object : CoHostListener() {
override fun onCoHostRequestReceived(inviter: SeatUserInfo, extensionInfo: String) {
println("Received connection request from ${inviter.userName}")
// Show accept/reject UI
}
override fun onCoHostRequestAccepted(invitee: SeatUserInfo) {
println("Connection request accepted by ${invitee.userName}")
}
override fun onCoHostUserJoined(userInfo: SeatUserInfo) {
println("Host ${userInfo.userName} joined connection")
}
})

// Initiate connection request
store.requestHostConnection(
targetHostLiveID = "target_live_id",
layoutTemplate = CoHostLayoutTemplate.HOST_DYNAMIC_GRID,
timeout = 30,
extraInfo = "",
completion = { code, message ->
if (code == 0) {
println("Connection request sent successfully")
}
}
)


ヘルプとサポート

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

フィードバック