@tencent-rtc/mcp 1.3.9 → 1.4.1

package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-room-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/100032603567/a3e16b96b00111f0bb7b525400bf7822.png)
-
-
 ## Core Features
 - **Live Room List Fetching**: Retrieve a paginated list of all currently public live rooms.
 
@@ -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" >`data class`</td>
-
-<td rowspan="1" colSpan="1" >Represents the complete information model of a live room. 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" >`data class`</td>
-
-<td rowspan="1" colSpan="1" >Represents the current state of the live list module. The core property liveList is a StateFlow containing the fetched live room list; currentLive represents the information of the live room the user is currently in.</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`LiveListListener`</td>
-
-<td rowspan="1" colSpan="1" >`abstract class`</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" >`abstract class`</td>
-
-<td rowspan="1" colSpan="1" >The core management class for interacting with the live room list and room lifecycle. 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` | `data class` | Represents the complete information model of a live room. Includes the live room ID (liveID), name (liveName), owner information (liveOwner), and custom metadata (metaData), among other properties. |
+| `LiveListState` | `data class` | Represents the current state of the live list module. The core property liveList is a StateFlow containing the fetched live room list; currentLive represents the information of the live room the user is currently in. |
+| `LiveListListener` | `abstract class` | Handles global live room events, including onLiveEnded (live ended) and onKickedOutOfLive (user removed from live), for responding to key room state changes. |
+| `LiveListStore` | `abstract class` | The core management class for interacting with the live room list and room lifecycle. 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/194571606056804352) to integrate AtomicXCore and complete the implementation of the [Host Video Streaming](https://write.woa.com/document/194571606056804352) and [Audience Join and Watch](https://write.woa.com/document/194571606056804352) features.
-
-- **Voice Chat Room**：Refer to [Quick Start](https://write.woa.com/document/194571595678187521) to integrate AtomicXCore and complete the implementation of the [Host Audio Streaming](https://write.woa.com/document/194571595678187521) and [Audience Join and Watch](https://write.woa.com/document/194571595678187521) 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
 
@@ -131,7 +90,6 @@ class LiveListActivity : AppCompatActivity() {
         startActivity(intent)
     }
 
-
     // --- RecyclerView related methods ---
     private fun setupUI() {
         recyclerView = findViewById(R.id.recyclerView)
@@ -182,80 +140,16 @@ class LiveListAdapter(
 ```
 
 #### 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" >Cover image URL for the live room</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`liveOwner`</td>
-
-<td rowspan="1" colSpan="1" >[LiveUserInfo](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-live-user-info/index.html)</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" >`List<Int>`</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" >`Map<String, String>`</td>
-
-<td rowspan="1" colSpan="1" >Developer-defined metadata for implementing advanced 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` | Cover image URL for the live room |
+| `liveOwner` | [LiveUserInfo](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-live-user-info/index.html) | Personal information of the room owner |
+| `totalViewerCount` | `Int` | Total number of viewers in the live room |
+| `categoryList` | `List<Int>` | List of category tags for the live room |
+| `notice` | `String` | Announcement information for the live room |
+| `metaData` | `Map<String, String>` | Developer-defined metadata for implementing advanced business scenarios |
 
 ## Advanced Features
 
@@ -263,9 +157,6 @@ class LiveListAdapter(
 
 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/100032603567/ecdcbe1db00311f09e195254007c27c5.png)
-
-
 #### Implementation
 
 Use the `categoryList` property in the `LiveInfo` model. When the host selects a category while going live, the `fetchLiveList` API returns LiveInfo objects that include these category details. After retrieving the full live room list, filter it on the client based on the user’s selected category and refresh the UI.
@@ -357,17 +248,13 @@ class LiveListActivity : AppCompatActivity() {
 Users can switch between live rooms by swiping up and down. When a new live room is centered on the screen, the video preview automatically starts playing. When it leaves the screen, playback stops automatically 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/a4e1a14bc6c011f09e745254007c27c5.webp)
-
-
 #### Implementation
 
 `LiveCoreView` supports multiple instances. Create a separate `LiveCoreView` for each `RecyclerView.ViewHolder`. By monitoring the scroll state of the `RecyclerView`, you can precisely control when to start or stop streaming in each ViewHolder, achieving "play on swipe in, stop on swipe out" behavior.
@@ -390,7 +277,7 @@ import io.trtc.tuikit.atomicxcore.api.view.LiveCoreView
 // 1. Custom RecyclerView.ViewHolder, containing a LiveCoreView internally
 class LiveFeedViewHolder(itemView: View) : RecyclerView.ViewHolder(itemView) {
     private var liveCoreView: LiveCoreView? = null
-    
+
     fun setLiveInfo(liveInfo: LiveInfo) {
         // Create a new LiveCoreView for the new live info
         liveCoreView = LiveCoreView(itemView.context, viewType = CoreViewType.PLAY_VIEW)
@@ -406,7 +293,7 @@ class LiveFeedViewHolder(itemView: View) : RecyclerView.ViewHolder(itemView) {
     fun startPlay(roomId: String) {
         liveCoreView?.startPreviewLiveStream(roomId, false, callback = null)
     }
-    
+
     fun stopPlay(roomId: String) {
         liveCoreView?.stopPreviewLiveStream(roomId)
     }
@@ -414,7 +301,7 @@ class LiveFeedViewHolder(itemView: View) : RecyclerView.ViewHolder(itemView) {
 
 // 2. Manage playback logic in the Activity
 class LiveFeedActivity : AppCompatActivity() {
-    
+
     private lateinit var recyclerView: RecyclerView
     private var liveList: List<LiveInfo> = emptyList()
     private var currentPlayingPosition: Int = -1
@@ -458,7 +345,7 @@ class LiveFeedActivity : AppCompatActivity() {
                     currentViewHolder.stopPlay(liveInfo.liveID)
                 }
             }
-            
+
             // Start new playback
             val newViewHolder = recyclerView.findViewHolderForAdapterPosition(position)
             if (newViewHolder is LiveFeedViewHolder) {
@@ -468,13 +355,13 @@ class LiveFeedActivity : AppCompatActivity() {
             }
         }
     }
-    
+
     // RecyclerView Adapter
     inner class LiveFeedAdapter(
         private var liveList: List<LiveInfo>,
         private val onItemClick: (Int) -> Unit
     ) : RecyclerView.Adapter<LiveFeedViewHolder>() {
-        
+
         override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): LiveFeedViewHolder {
             val view = LayoutInflater.from(parent.context)
                 .inflate(R.layout.item_live_feed, parent, false)
@@ -497,32 +384,10 @@ class LiveFeedActivity : AppCompatActivity() {
 ## API Documentation
 
 For detailed information on all public interfaces, properties, and methods of [LiveListStore](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-live-list-store/index.html) and related classes, refer to the official API documentation included with the [AtomicXCore](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 linking.</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" >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_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-live-list-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 linking. | [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) |
+| 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_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-live-list-store/index.html) |
 
 ## FAQs
 
@@ -538,7 +403,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/194571606056804352).
+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:
@@ -550,18 +415,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**
@@ -571,5 +433,3 @@ This template ID defines the room layout. For supported template IDs and effects
 - **Step 2: Check prefix when fetching the list**
 
   - On the client side, after fetching the list, distinguish rooms by checking the liveID prefix.
-
-