@tencent-rtc/mcp 1.3.9 → 1.4.0

package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md

@@ -1,8 +1,5 @@
 `LiveListStore` is the core module of **AtomicXCore** responsible for managing the live room list, creating and joining rooms, and maintaining room state. With `LiveListStore`, you can implement comprehensive live streaming lifecycle management in your application.
 
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/fe0864bbc90511f09e745254007c27c5.png)
-
-
 ## Core Features
 - **Live Room List Fetching**: Retrieve all currently public live rooms, returned one page at a time.
 
@@ -10,58 +7,20 @@
 
 - **Real-Time Event Listening**: Listen for key events such as live session end or users being removed from a room.
 
-
 ## Core Concepts
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >**Core Concept**</td>
-
-<td rowspan="1" colSpan="1" >**Type**</td>
-
-<td rowspan="1" colSpan="1" >**Core Responsibility & Description**</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`LiveInfo`</td>
-
-<td rowspan="1" colSpan="1" >`struct`</td>
-
-<td rowspan="1" colSpan="1" >- Represents the complete information model of a live room. <br>- Includes the live room ID (`liveID`), name (`liveName`), owner information (`liveOwner`), and custom metadata (`metaData`), among other properties.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`LiveListState`</td>
-
-<td rowspan="1" colSpan="1" >`struct`</td>
-
-<td rowspan="1" colSpan="1" >- Represents the current state of the live list module. <br>- The core property `liveList` is a StateFlow containing the fetched live room list; <br>- `currentLive` represents the information of the live room the user is currently in.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`LiveListEvent`</td>
-
-<td rowspan="1" colSpan="1" >`enum`</td>
-
-<td rowspan="1" colSpan="1" >Handles global live room events, including `.onLiveEnded` (live ended) and `.onKickedOutOfLive` (user removed from live), for responding to key room state changes.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`LiveListStore`</td>
-
-<td rowspan="1" colSpan="1" >`class`</td>
-
-<td rowspan="1" colSpan="1" >- The core management class for interacting with the live room list and room lifecycle. <br>- It is a global singleton responsible for all operations such as creating, joining, and updating live room information.</td>
-</tr>
-</table>
-
+| **Core Concept** | **Type** | **Core Responsibility & Description** |
+| --- | --- | --- |
+| `LiveInfo` | `struct` | - Represents the complete information model of a live room.<br>- Includes the live room ID (`liveID`), name (`liveName`), owner information (`liveOwner`), and custom metadata (`metaData`), among other properties. |
+| `LiveListState` | `struct` | - Represents the current state of the live list module.<br>- The core property `liveList` is a StateFlow containing the fetched live room list;<br>- `currentLive` represents the information of the live room the user is currently in. |
+| `LiveListEvent` | `enum` | Handles global live room events, including `.onLiveEnded` (live ended) and `.onKickedOutOfLive` (user removed from live), for responding to key room state changes. |
+| `LiveListStore` | `class` | - The core management class for interacting with the live room list and room lifecycle.<br>- It is a global singleton responsible for all operations such as creating, joining, and updating live room information. |
 
 ## Implementation
 
 ### Step 1: Component Integration
-- **Video Live Streaming**：Refer to [Quick Start](https://write.woa.com/document/194571606121816064) to integrate AtomicXCore and complete the implementation of the [Host Video Streaming](https://write.woa.com/document/194571606121816064) and [Audience Join and Watch](https://write.woa.com/document/194571606121816064) features.
-
-- **Voice Chat Room**：Refer to [Quick Start](https://write.woa.com/document/194571595685527552) to integrate AtomicXCore and complete the implementation of the [Host Audio Streaming](https://write.woa.com/document/194571595685527552) and [Audience Join and Watch](https://write.woa.com/document/194571595685527552) features.
+- **Video Live Streaming**：Refer to Quick Start to integrate AtomicXCore and complete the implementation of the Host Video Streaming and Audience Join and Watch features.
 
+- **Voice Chat Room**：Refer to Quick Start to integrate AtomicXCore and complete the implementation of the Host Audio Streaming and Audience Join and Watch features.
 
 ### Step 2: Implement Audience Entry from Live Room List
 
@@ -85,7 +44,7 @@ class LiveListViewController: UIViewController, UICollectionViewDataSource, UICo
         bindStore()
         fetchLiveList()
     }
-    
+
     private func bindStore() {
         // Subscribe to state to automatically receive list updates
         liveListStore.state
@@ -105,7 +64,7 @@ class LiveListViewController: UIViewController, UICollectionViewDataSource, UICo
             }
         }
     }
-    
+
     // Called when the user taps a cell in the list
     func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath) {
         let selectedLiveInfo = liveList[indexPath.item]
@@ -114,7 +73,7 @@ class LiveListViewController: UIViewController, UICollectionViewDataSource, UICo
         audienceVC.modalPresentationStyle = .fullScreen
         present(audienceVC, animated: true)
     }
-    
+
     // --- UICollectionViewDataSource, Delegate, and UI setup methods ---
     private func setupUI() {
         let layout = UICollectionViewFlowLayout()
@@ -129,7 +88,7 @@ class LiveListViewController: UIViewController, UICollectionViewDataSource, UICo
     func collectionView(_ collectionView: UICollectionView, numberOfItemsInSection section: Int) -> Int {
         return liveList.count
     }
-    
+
     func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell {
         let cell = collectionView.dequeueReusableCell(withReuseIdentifier: "LiveCell", for: indexPath)
         cell.backgroundColor = .lightGray // Customize your cell style
@@ -137,7 +96,7 @@ class LiveListViewController: UIViewController, UICollectionViewDataSource, UICo
         // ... (e.g.: cell.titleLabel.text = liveInfo.liveName)
         return cell
     }
-    
+
     func collectionView(_ collectionView: UICollectionView, layout collectionViewLayout: UICollectionViewLayout, sizeForItemAt indexPath: IndexPath) -> CGSize {
         // Adjust cell size for single or double column layout as needed
         let width = (view.bounds.width - 30) / 2
@@ -147,80 +106,16 @@ class LiveListViewController: UIViewController, UICollectionViewDataSource, UICo
 ```
 
 #### LiveInfo Parameter Reference
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >**Parameter Name**</td>
-
-<td rowspan="1" colSpan="1" >**Type**</td>
-
-<td rowspan="1" colSpan="1" >**Description**</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`liveID`</td>
-
-<td rowspan="1" colSpan="1" >`String`</td>
-
-<td rowspan="1" colSpan="1" >Unique identifier for the live room</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`liveName`</td>
-
-<td rowspan="1" colSpan="1" >`String`</td>
-
-<td rowspan="1" colSpan="1" >Title of the live room</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`coverURL`</td>
-
-<td rowspan="1" colSpan="1" >`String`</td>
-
-<td rowspan="1" colSpan="1" >URL of the live room cover image</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`liveOwner`</td>
-
-<td rowspan="1" colSpan="1" >[LiveUserInfo](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveuserinfo)</td>
-
-<td rowspan="1" colSpan="1" >Personal information of the room owner</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`totalViewerCount`</td>
-
-<td rowspan="1" colSpan="1" >`Int`</td>
-
-<td rowspan="1" colSpan="1" >Total number of viewers in the live room</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`categoryList`</td>
-
-<td rowspan="1" colSpan="1" >`[NSNumber]`</td>
-
-<td rowspan="1" colSpan="1" >List of category tags for the live room</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`notice`</td>
-
-<td rowspan="1" colSpan="1" >`String`</td>
-
-<td rowspan="1" colSpan="1" >Announcement information for the live room</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`metaData`</td>
-
-<td rowspan="1" colSpan="1" >`[String: String]`</td>
-
-<td rowspan="1" colSpan="1" >Developer-defined metadata for implementing complex business scenarios</td>
-</tr>
-</table>
-
+| **Parameter Name** | **Type** | **Description** |
+| --- | --- | --- |
+| `liveID` | `String` | Unique identifier for the live room |
+| `liveName` | `String` | Title of the live room |
+| `coverURL` | `String` | URL of the live room cover image |
+| `liveOwner` | [LiveUserInfo](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveuserinfo) | Personal information of the room owner |
+| `totalViewerCount` | `Int` | Total number of viewers in the live room |
+| `categoryList` | `[NSNumber]` | List of category tags for the live room |
+| `notice` | `String` | Announcement information for the live room |
+| `metaData` | `[String: String]` | Developer-defined metadata for implementing complex business scenarios |
 
 ## Advanced Features
 
@@ -228,9 +123,6 @@ class LiveListViewController: UIViewController, UICollectionViewDataSource, UICo
 
 On the live plaza page, users can select category tags such as "Hot", "Music", "Games", etc. When a tag is selected, the live room list dynamically filters to display only rooms in the chosen category, helping users quickly discover relevant content.
 
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/7dcde616ab4b11f0a68e5254001c06ec.png)
-
-
 #### Implementation
 
 Use the `categoryList` property in the `LiveInfo` model. When the host sets a category at the start of the stream, the `LiveInfo` object returned by `fetchLiveList` includes this category data. After fetching the full live room list, filter it on the client side based on the selected category and update the UI.
@@ -321,17 +213,13 @@ class LiveListViewController: UIViewController, UICollectionViewDataSource, UICo
 Users can switch between live rooms by swiping up or down. When a new live room is centered on the screen, its video will automatically start preview playback; when it is swiped away or no longer visible on the screen, playback will automatically stop to save bandwidth and device resources.
 
 > **Note：**
-> 
+>
 
 > **Swipe-to-Play **is currently only supported for Video Live Streaming.
-> 
-
+>
 
 #### Interaction Flow
 
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/9e134120c90711f087ad52540099c741.webp)
-
-
 #### Implementation
 
 `LiveCoreView` supports multiple instances. Create a separate `LiveCoreView` for each `UICollectionViewCell`. By listening to the scroll delegate methods of `UICollectionView`, you can control when the `LiveCoreView` in each cell should start or stop streaming, enabling "play on swipe in, stop on swipe out".
@@ -409,32 +297,10 @@ class LiveFeedViewController: UIViewController, UICollectionViewDataSource, UICo
 ## **API Documentation**
 
 For detailed information on all public interfaces, properties, and methods of [LiveListStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveliststore) and related classes, refer to the official API documentation included with the [AtomicXCore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore) framework. The relevant Stores used in this document are as follows:
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >**Store/Component**</td>
-
-<td rowspan="1" colSpan="1" >**Feature Description**</td>
-
-<td rowspan="1" colSpan="1" >**API Documentation**</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >LiveCoreView</td>
-
-<td rowspan="1" colSpan="1" >- Core view component for live video stream display and interaction. <br>- Responsible for video stream rendering and view widget handling, supporting scenarios such as host streaming, audience co-hosting, and host linking.</td>
-
-<td rowspan="1" colSpan="1" >[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/livecoreview)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >LiveListStore</td>
-
-<td rowspan="1" colSpan="1" >Full lifecycle management of live rooms: create, join, leave, destroy rooms; query room list; modify live information (name, announcement, etc.); listen to live status (such as being removed or ended).</td>
-
-<td rowspan="1" colSpan="1" >[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveliststore)</td>
-</tr>
-</table>
-
+| **Store/Component** | **Feature Description** | **API Documentation** |
+| --- | --- | --- |
+| LiveCoreView | - Core view component for live video stream display and interaction.<br>- Responsible for video stream rendering and view widget handling, supporting scenarios such as host streaming, audience co-hosting, and host linking. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/livecoreview) |
+| LiveListStore | Full lifecycle management of live rooms: create, join, leave, destroy rooms; query room list; modify live information (name, announcement, etc.); listen to live status (such as being removed or ended). | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveliststore) |
 
 ## FAQs
 
@@ -450,7 +316,7 @@ We recommend two approaches:
 
 **Approach 1 (Recommended): Use seatLayoutTemplateID for differentiation.**
 
-This template ID defines the room layout. For supported template IDs and effects, refer to [Run And Test](https://write.woa.com/document/194571606121816064).
+This template ID defines the room layout. For supported template IDs and effects, refer to Run And Test.
 - **Step 1: Specify ID when creating a room**
 
   - When calling `LiveListStore.shared.createLive`, set the `seatLayoutTemplateID` property of `LiveInfo` based on your business scenario:
@@ -462,18 +328,15 @@ This template ID defines the room layout. For supported template IDs and effects
 - **Step 2: Filter when fetching the list**
 
   - On the client side, after receiving the list in `LiveListStore.state.liveList`, determine the business scenario by checking the template ID range.
-      
 
       > **Note：**
-      > 
+      >
 
       > If the seatLayoutTemplateID does not match your business scenario (voice chat room or video live room), seat layout features may not work as expected.
-      > 
-
+      >
 
       **Approach 2:****Add a business prefix to **`liveID`**.**
 
-
       This is an optional, application-layer convention to help you filter rooms quickly.
 
 - **Step 1: Add prefix when creating a room**

package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audience-list.md

@@ -1,8 +1,5 @@
 `LiveAudienceStore` is a module in `AtomicXCore` designed for managing audience information in live streaming rooms. With `LiveAudienceStore`, you can implement a comprehensive audience list and management system for your live streaming application.
 
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/125802a4c6b511f09e745254007c27c5.png)
-
-
 ## Core Features
 - **Real-Time Audience List**: Retrieve and display all audience information currently present in the live room.
 
@@ -14,58 +11,20 @@
 
 - **Room Management**: The host or administrator can remove (kick out) any regular viewer from the live room.
 
-
 ## Core Concepts
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >**Core Concept**</td>
-
-<td rowspan="1" colSpan="1" >**Type**</td>
-
-<td rowspan="1" colSpan="1" >**Core Responsibilities & Description**</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`LiveUserInfo`</td>
-
-<td rowspan="1" colSpan="1" >data class</td>
-
-<td rowspan="1" colSpan="1" >Represents the basic information model of an audience member (user). It contains the user's unique identifier (`userID`), nickname (`userName`), and avatar URL (`avatarURL`).</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`LiveAudienceState`</td>
-
-<td rowspan="1" colSpan="1" >data class</td>
-
-<td rowspan="1" colSpan="1" >Represents the current state of the audience module. Its core property `audienceList` is a StateFlow that stores the real-time state of the audience list; `audienceCount` represents the real-time state of the current total number of viewers.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`LiveAudienceListener`</td>
-
-<td rowspan="1" colSpan="1" >abstract class</td>
-
-<td rowspan="1" colSpan="1" >Represents real-time audience activity events. It includes `onAudienceJoined` (audience joins) and `onAudienceLeft` (audience leaves), used for incremental updates to the audience list.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`LiveAudienceStore`</td>
-
-<td rowspan="1" colSpan="1" >abstract class</td>
-
-<td rowspan="1" colSpan="1" >This is the core management class for interacting with audience list functionality. Through it, you can obtain audience list snapshots, perform management operations, and subscribe to its `LiveAudienceListener` for real-time updates.</td>
-</tr>
-</table>
-
+| **Core Concept** | **Type** | **Core Responsibilities & Description** |
+| --- | --- | --- |
+| `LiveUserInfo` | data class | Represents the basic information model of an audience member (user). It contains the user's unique identifier (`userID`), nickname (`userName`), and avatar URL (`avatarURL`). |
+| `LiveAudienceState` | data class | Represents the current state of the audience module. Its core property `audienceList` is a StateFlow that stores the real-time state of the audience list; `audienceCount` represents the real-time state of the current total number of viewers. |
+| `LiveAudienceListener` | abstract class | Represents real-time audience activity events. It includes `onAudienceJoined` (audience joins) and `onAudienceLeft` (audience leaves), used for incremental updates to the audience list. |
+| `LiveAudienceStore` | abstract class | This is the core management class for interacting with audience list functionality. Through it, you can obtain audience list snapshots, perform management operations, and subscribe to its `LiveAudienceListener` for real-time updates. |
 
 ## Implementation Guide
 
 ### Step 1: Component Integration
-- **Video Live Streaming**: Please refer to [Quick Start](https://write.woa.com/document/194571606056804352) to integrate AtomicXCore
-
-- **Voice Chat Room**: Please refer to [Quick Start](https://write.woa.com/document/194571595678187521) to integrate AtomicXCore.
+- **Video Live Streaming**: Please refer to Quick Start to integrate AtomicXCore
 
+- **Voice Chat Room**: Please refer to Quick Start to integrate AtomicXCore.
 
 ### Step 2: Initialize and Retrieve the Audience List
 
@@ -86,11 +45,11 @@ class AudienceManager(
     // Expose the [full] audience list state flow for UI layer subscription
     private val _audienceList = MutableStateFlow<List<LiveUserInfo>>(emptyList())
     val audienceList: StateFlow<List<LiveUserInfo>> = _audienceList.asStateFlow()
-    
+
     // Expose the audience count state flow
     private val _audienceCount = MutableStateFlow(0)
     val audienceCount: StateFlow<Int> = _audienceCount.asStateFlow()
-    
+
     init {
         // 1. Subscribe to state and events, see next section for implementation
         subscribeToAudienceState()
@@ -113,7 +72,7 @@ class AudienceManager(
             }
         })
     }
-    
+
     // ... subsequent code
 }
 ```
@@ -132,7 +91,7 @@ class AudienceManager {
             }
         }
 
-        scope.launch {   
+        scope.launch {
             // audienceCount is the real-time total
             audienceStore.liveAudienceState.audienceCount.collect { count ->
                 _audienceCount.value = count
@@ -200,7 +159,7 @@ class AudienceManager {
             override fun onSuccess() {
                 println("Successfully promoted user $userId to administrator")
             }
-            
+
             override fun onFailure(code: Int, desc: String) {
                 println("Failed to set administrator: $desc")
             }
@@ -276,40 +235,11 @@ class LiveRoomManager(
 ## API Documentation
 
 For detailed information on all public interfaces, properties, and methods of [LiveAudienceStore](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-live-audience-store/index.html) and its related classes, refer to the official API documentation included with the [AtomicX Core](https://tencent-rtc.github.io/TUIKit_Android/index.html) framework. The relevant Stores used in this document are as follows:
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >**Store/Component**</td>
-
-<td rowspan="1" colSpan="1" >**Feature Description**</td>
-
-<td rowspan="1" colSpan="1" >**API Documentation**</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >LiveCoreView</td>
-
-<td rowspan="1" colSpan="1" >Core view component for live video stream display and interaction: responsible for video stream rendering and view widget handling, supporting scenarios such as host streaming, audience co-hosting, and host-to-host connection.</td>
-
-<td rowspan="1" colSpan="1" >[API Documentation](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.view/-live-core-view/index.html)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >LiveAudienceStore</td>
-
-<td rowspan="1" colSpan="1" >Audience management: obtain real-time audience list (ID / name / avatar), count audience numbers, and listen for audience join/leave events.</td>
-
-<td rowspan="1" colSpan="1" >[API Documentation](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.view/-live-core-view/index.html)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >BarrageStore</td>
-
-<td rowspan="1" colSpan="1" >Barrage feature: send text/custom barrage, maintain barrage list, and listen to barrage status in real time.</td>
-
-<td rowspan="1" colSpan="1" >[API Documentation](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.barrage/-barrage-store/index.html)</td>
-</tr>
-</table>
-
+| **Store/Component** | **Feature Description** | **API Documentation** |
+| --- | --- | --- |
+| LiveCoreView | Core view component for live video stream display and interaction: responsible for video stream rendering and view widget handling, supporting scenarios such as host streaming, audience co-hosting, and host-to-host connection. | [API Documentation](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.view/-live-core-view/index.html) |
+| LiveAudienceStore | Audience management: obtain real-time audience list (ID / name / avatar), count audience numbers, and listen for audience join/leave events. | [API Documentation](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.view/-live-core-view/index.html) |
+| BarrageStore | Barrage feature: send text/custom barrage, maintain barrage list, and listen to barrage status in real time. | [API Documentation](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.barrage/-barrage-store/index.html) |
 
 ## FAQs
 
@@ -330,5 +260,4 @@ The update of `audienceCount` is not always strictly real-time. The mechanism is
 
 - **What does this mean for developers?**
 
-
    `audienceCount` is a near real-time, high-precision estimate, but in extreme high-concurrency scenarios, there may be brief delays or data loss. We recommend using it for UI display only, and not as the sole basis for billing, statistics, or other scenarios requiring absolute accuracy.