@tencent-rtc/mcp 1.3.2 → 1.3.3

package/resource/doc/livekit/live/android/live-integration.md

@@ -0,0 +1,972 @@
+This document guides you through building a basic live streaming app with host broadcasting and audience viewing capabilities using the core component [LiveCoreView](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) from the **AtomicXCore SDK**.
+
+### Core Features
+
+**LiveCoreView** is a lightweight View component purpose-built for live streaming scenarios. It serves as the foundation of your live streaming implementation, encapsulating all complex streaming technologies—including stream publishing and playback, co-hosting, and audio/video rendering. Use LiveCoreView as the "canvas" for your live video, enabling you to focus on developing your custom UI and interactions.
+
+The following view hierarchy diagram illustrates the position and role of **LiveCoreView** within the live streaming interface:
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/cb1167dec42d11f0b4a7525400454e06.png)
+
+
+## Core Concepts
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >**Core Concept**</td>
+
+<td rowspan="1" colSpan="1" >**Core Responsibility**</td>
+
+<td rowspan="1" colSpan="1" >**Key API / Property**</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >LiveCoreView</td>
+
+<td rowspan="1" colSpan="1" >Handles publishing, playing, and rendering audio/video streams. Provides adapter interfaces for integrating custom UI components (e.g., user info, PK progress bar).</td>
+
+<td rowspan="1" colSpan="1" >- `viewType`:<br>  - `CoreViewType.PUSH_VIEW` (host publishing view)<br>  - `CoreViewType.PLAY_VIEW` (audience playback view)<br>- `setLiveId()`: Binds the live room ID for this view.<br>- `setVideoViewAdapter():` Adapter for custom video display UI slots.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >LiveListStore</td>
+
+<td rowspan="1" colSpan="1" >Manages the complete live room lifecycle (create, join, leave), synchronizes state, and listens for passive events (e.g., live ended, kicked out).</td>
+
+<td rowspan="1" colSpan="1" >- `createLive()`: Start live stream as host.<br>- `endLive()`: End live stream as host.<br>- `joinLive()`: Audience joins live room.<br>- `leaveLive()`: Leave live room.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >LiveInfo</td>
+
+<td rowspan="1" colSpan="1" >Defines room parameters before going live, such as room ID, seat layout mode, max co-hosts, etc.</td>
+
+<td rowspan="1" colSpan="1" >- `liveID`: Unique room identifier.<br>- `seatLayoutTemplateID`: Layout template ID (e.g., 600 for dynamic grid).</td>
+</tr>
+</table>
+
+
+## Preparation
+
+### Step 1: Activate the Service
+
+See [Activate Service](https://write.woa.com/document/141936672617742336) to obtain either the trial or paid version of the SDK.Then, go to [the Console](https://console.trtc.io/app) for application management, and get the following:
+- `SDKAppID`: Application identifier (required). Tencent Cloud uses `SDKAppId` for billing and details.
+
+- `SDKSecretKey`: Application secret key, used to initialize the configuration file with secret information.
+
+   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/a3996d5cc44911f08c0e52540044a08e.png)
+
+
+### Step 2: Import AtomicXCore into Your Project
+
+**Install the component**: Add the dependency `implementation 'com.tencent.atomicx:atomicxcore:latest`' to your `build.gradle` file, then perform a **Gradle****Sync**.
+``` gradle
+dependencies {
+    implementation 'io.trtc.uikit:atomicx-core:latest.release'
+    api "io.trtc.uikit:rtc_room_engine:3.4.0.1306"
+    api "io.trtc.uikit:atomicx-core:3.4.0.1307"
+    api "com.tencent.liteav:LiteAVSDK_Professional:12.8.0.19279"
+    api "com.tencent.imsdk:imsdk-plus:8.7.7201"
+    // Other dependencies...
+}
+```
+
+### Step 3: Implement Login Logic
+
+Call `LoginStore.shared.login` in your project to complete login. **This is required before you can use any functionality in AtomicXCore**.
+
+> **Note：**
+> 
+
+> We recommend calling `LoginStore.shared.login` after your app's own user authentication is successful to ensure clear and consistent login logic.
+> 
+
+``` java
+import android.os.Bundle
+import androidx.appcompat.app.AppCompatActivity
+import io.trtc.tuikit.atomicxcore.api.login.LoginStore
+import io.trtc.tuikit.atomicxcore.api.CompletionHandler
+import android.util.Log
+
+class MainActivity : AppCompatActivity() {
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+
+        LoginStore.shared.login(
+            this,              // context
+            1400000001,        // Replace with your SDKAppID
+            "test_001",        // Replace with your UserID
+            "xxxxxxxxxxx",     // Replace with your UserSig
+            object : CompletionHandler {
+                override fun onSuccess() {
+                    // Handle login success
+                    Log.d("Login", "login success")
+                }
+
+                override fun onFailure(code: Int, desc: String) {
+                    // Handle login failure
+                    Log.e("Login", "login failed, code: $code, error: $desc")
+                }
+            }
+        )
+    }
+}
+```
+
+**Login API Parameter Description**
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Parameter</td>
+
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >SDKAppID</td>
+
+<td rowspan="1" colSpan="1" >Int</td>
+
+<td rowspan="1" colSpan="1" >Get this from [TRTC console > Application management](https://console.trtc.io/app).</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >UserID</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >The unique ID for the current user. Must contain only English letters, numbers, hyphens, and underscores.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >userSig</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >A ticket for Tencent Cloud authentication. Please note:<br>- **Development Environment**: You can use the local `GenerateTestUserSig.genTestSig` function to generate a UserSig or generate a temporary UserSig via the [UserSig Generation Tool](https://console.trtc.io/usersig).<br>- **Production Environment**: To prevent key leakage, you must use a server-side method to generate UserSig. For details, see [Generating UserSig on the Server](https://write.woa.com/document/89644530319802368).<br>- For more information, see [How to Calculate and Use UserSig](https://write.woa.com/document/89644530319802368).</td>
+</tr>
+</table>
+
+
+## Building a Basic Live Room
+
+### Step 1: Implement Host Video Streaming
+
+Follow these steps to quickly set up host video streaming:
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/a7cb5d4ac45311f0b4a7525400454e06.png)
+
+
+> **Note：**
+> 
+
+> For a complete implementation, refer to [VideoLiveAnchorActivity.kt](https://github.com/Tencent-RTC/TUIKit_Android/blob/main/live/tuilivekit/src/main/java/com/trtc/uikit/livekit/livestream/VideoLiveAnchorActivity.kt) in the open-source TUILiveKit project.
+> 
+
+1. **Initialize the Broadcaster Streaming View**
+
+
+   In your host `Activity`, create a LiveCoreView instance and set viewType to `PUSH_VIEW` (publishing view).
+
+   ``` java
+   import io.trtc.tuikit.atomicxcore.api.view.CoreViewType
+   import io.trtc.tuikit.atomicxcore.api.view.LiveCoreView
+   import android.os.Bundle
+   import androidx.appcompat.app.AppCompatActivity
+   import androidx.constraintlayout.widget.ConstraintLayout
+   
+   class YourAnchorActivity : AppCompatActivity() {
+       private lateinit var coreView: LiveCoreView
+   
+       override fun onCreate(savedInstanceState: Bundle?) {
+           super.onCreate(savedInstanceState)
+   
+           coreView = LiveCoreView(this, viewType = CoreViewType.PUSH_VIEW)
+           coreView.setLiveID("test_live_001")
+   
+           setupUI()
+       }
+   
+       private fun setupUI() {
+           setContentView(R.layout.activity_anchor)
+   
+           val container = findViewById<ConstraintLayout>(R.id.container)
+           container.addView(coreView)
+   
+           val params = ConstraintLayout.LayoutParams(
+               ConstraintLayout.LayoutParams.MATCH_PARENT,
+               ConstraintLayout.LayoutParams.MATCH_PARENT
+           )
+           params.topMargin = 36
+           params.bottomMargin = 96
+           coreView.layoutParams = params
+       }
+   }
+   ```
+2. **Open Camera and Microphone**
+
+
+   Call the `openLocalCamera` and `openLocalMicrophone` methods of `DeviceStore` to enable the camera and microphone. **No additional action is required—LiveCoreView will automatically preview the current camera video stream**.
+
+   ``` java
+   import androidx.appcompat.app.AppCompatActivity
+   import android.os.Bundle
+   import io.trtc.tuikit.atomicxcore.api.device.DeviceStore
+   
+   class YourAnchorActivity : AppCompatActivity() {
+       // ... other code ...
+   
+       override fun onCreate(savedInstanceState: Bundle?) {
+           super.onCreate(savedInstanceState)
+           setupUI()
+           openDevices()
+       }
+   
+       private fun openDevices() {
+           DeviceStore.shared().openLocalCamera(true, completion = null)
+           DeviceStore.shared().openLocalMicrophone(completion = null)
+       }
+   }
+   ```
+3. **Start Live Streaming**
+
+
+   Start the live stream by calling `createLive` on `LiveListStore`.
+
+   ``` java
+   import android.util.Log
+   import androidx.appcompat.app.AppCompatActivity
+   import io.trtc.tuikit.atomicxcore.api.live.LiveInfo
+   import io.trtc.tuikit.atomicxcore.api.live.LiveInfoCompletionHandler
+   import io.trtc.tuikit.atomicxcore.api.live.LiveListStore
+   
+   class YourAnchorActivity : AppCompatActivity() {
+       // ... other code ...
+   
+       private fun startLive() {
+           val liveInfo = LiveInfo().apply {
+               liveID = "test_live_001"
+               liveName = "test live"
+               seatLayoutTemplateID = 600 // Default: dynamic grid layout
+               keepOwnerOnSeat = true
+           }
+           LiveListStore.shared().createLive(liveInfo, object: LiveInfoCompletionHandler {
+               override fun onFailure(code: Int, desc: String) {
+                   Log.e("Live", "startLive error: $desc")
+               }
+   
+               override fun onSuccess(liveInfo: LiveInfo) {
+                   Log.d("Live", "startLive success")
+               }
+           })
+       }
+   }
+   ```
+
+   `LiveInfo`** Parameter Description:**
+
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >**Parameter Name**</td>
+
+<td rowspan="1" colSpan="1" >**Type**</td>
+
+<td rowspan="1" colSpan="1" >**Required**</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" >Yes</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" >No</td>
+
+<td rowspan="1" colSpan="1" >Title of 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" >No</td>
+
+<td rowspan="1" colSpan="1" >Announcement message for the live room.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`isMessageDisable`</td>
+
+<td rowspan="1" colSpan="1" >`Boolean`</td>
+
+<td rowspan="1" colSpan="1" >No</td>
+
+<td rowspan="1" colSpan="1" >Disable chat (true = yes, false = no).</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`isPublicVisible`</td>
+
+<td rowspan="1" colSpan="1" >`Boolean`</td>
+
+<td rowspan="1" colSpan="1" >No</td>
+
+<td rowspan="1" colSpan="1" >Room is publicly visible (true = yes, false = no).</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`isSeatEnabled`</td>
+
+<td rowspan="1" colSpan="1" >`Boolean`</td>
+
+<td rowspan="1" colSpan="1" >No</td>
+
+<td rowspan="1" colSpan="1" >Enable seat (co-host) functionality (true = yes, false = no).</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`keepOwnerOnSeat`</td>
+
+<td rowspan="1" colSpan="1" >`Boolean`</td>
+
+<td rowspan="1" colSpan="1" >No</td>
+
+<td rowspan="1" colSpan="1" >Keep the owner on a seat.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`maxSeatCount`</td>
+
+<td rowspan="1" colSpan="1" >`Int`</td>
+
+<td rowspan="1" colSpan="1" >Yes</td>
+
+<td rowspan="1" colSpan="1" >Maximum number of seats.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`seatMode`</td>
+
+<td rowspan="1" colSpan="1" >[TakeSeatMode](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-take-seat-mode/index.html)</td>
+
+<td rowspan="1" colSpan="1" >No</td>
+
+<td rowspan="1" colSpan="1" >Seat mode (FREE: free to take seat, APPLY: apply to take seat).</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`seatLayoutTemplateID`</td>
+
+<td rowspan="1" colSpan="1" >`Int`</td>
+
+<td rowspan="1" colSpan="1" >Yes</td>
+
+<td rowspan="1" colSpan="1" >Seat layout template ID.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`coverURL`</td>
+
+<td rowspan="1" colSpan="1" >`String`</td>
+
+<td rowspan="1" colSpan="1" >No</td>
+
+<td rowspan="1" colSpan="1" >Cover image URL for the live room.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`backgroundURL`</td>
+
+<td rowspan="1" colSpan="1" >`String`</td>
+
+<td rowspan="1" colSpan="1" >No</td>
+
+<td rowspan="1" colSpan="1" >Background image URL for the live room.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`categoryList`</td>
+
+<td rowspan="1" colSpan="1" >`List`<br></td>
+
+<td rowspan="1" colSpan="1" >No</td>
+
+<td rowspan="1" colSpan="1" >List of category tags for the live room.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`activityStatus`</td>
+
+<td rowspan="1" colSpan="1" >`Int`</td>
+
+<td rowspan="1" colSpan="1" >No</td>
+
+<td rowspan="1" colSpan="1" >Live activity status.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >`isGiftEnabled`</td>
+
+<td rowspan="1" colSpan="1" >`Boolean`</td>
+
+<td rowspan="1" colSpan="1" >No</td>
+
+<td rowspan="1" colSpan="1" >Whether to enable gift functionality (true: yes, false: no).</td>
+</tr>
+</table>
+
+4. **End Live Streaming**
+
+
+   When the live stream ends, call the `endLive` method of `LiveListStore`. The SDK will handle stopping the stream and destroying the room.
+
+   ``` java
+   import android.util.Log
+   import androidx.appcompat.app.AppCompatActivity
+   import com.tencent.cloud.tuikit.engine.extension.TUILiveListManager
+   import io.trtc.tuikit.atomicxcore.api.device.DeviceStore
+   import io.trtc.tuikit.atomicxcore.api.live.LiveListStore
+   import io.trtc.tuikit.atomicxcore.api.live.StopLiveCompletionHandler
+   
+   class YourAnchorActivity : AppCompatActivity() {
+       // ... other code ...
+   
+       private fun stopLive() {
+           LiveListStore.shared().endLive(object : StopLiveCompletionHandler {
+               override fun onSuccess(statisticsData: TUILiveListManager.LiveStatisticsData) {
+                   Log.d("Live", "endLive success, duration: ${statisticsData.liveDuration}, totalViewers: ${statisticsData.totalViewers}")
+               }
+   
+               override fun onFailure(code: Int, desc: String) {
+                   Log.e("Live", "endLive error: $desc")
+               }
+           })
+       }
+   
+       override fun onDestroy() {
+           super.onDestroy()
+           stopLive()
+           DeviceStore.shared().closeLocalCamera()
+           DeviceStore.shared().closeLocalMicrophone()
+           Log.d("Live", "YourAnchorActivity onDestroy")
+       }
+   }
+   ```
+
+### Step 2: Implement Audience Join and Watch
+
+Follow these steps to enable audience viewing:
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/d1926a32c45311f0a0935254007c27c5.png)
+
+
+> **Note：**
+> 
+
+> For a complete reference implementation of audience viewing logic, see [VideoLiveAudienceActivity.kt](https://github.com/Tencent-RTC/TUIKit_Android/blob/main/live/tuilivekit/src/main/java/com/trtc/uikit/livekit/livestream/VideoLiveAudienceActivity.kt) in the open-source TUILiveKit project.
+> 
+
+1. **Add Audience Playback View**
+
+
+   In your audience `Activity`, create a `LiveCoreView` instance and set `viewType` to `PLAY_VIEW` (playback view).
+
+   ``` java
+   import io.trtc.tuikit.atomicxcore.api.view.CoreViewType
+   import io.trtc.tuikit.atomicxcore.api.view.LiveCoreView
+   import android.os.Bundle
+   import androidx.appcompat.app.AppCompatActivity
+   import androidx.constraintlayout.widget.ConstraintLayout
+   
+   // YourAudienceActivity represents your audience viewing Activity
+   class YourAudienceActivity : AppCompatActivity() {
+   
+       // 1. Initialize the audience playback view
+       private lateinit var coreView: LiveCoreView
+   
+       override fun onCreate(savedInstanceState: Bundle?) {
+           super.onCreate(savedInstanceState)
+   
+           // 2. Initialize the view
+           coreView = LiveCoreView(this, viewType = CoreViewType.PLAY_VIEW)
+           coreView.setLiveId("test_live_001")
+   
+           // UI layout
+           setupUI()
+       }
+   
+       private fun setupUI() {
+           setContentView(R.layout.activity_audience)
+   
+           // 3. Add the playback view to your layout
+           val container = findViewById<ConstraintLayout>(R.id.container)
+           container.addView(coreView)
+   
+           // Set layout parameters
+           val params = ConstraintLayout.LayoutParams(
+               ConstraintLayout.LayoutParams.MATCH_PARENT,
+               ConstraintLayout.LayoutParams.MATCH_PARENT
+           )
+           params.topMargin = 36
+           params.bottomMargin = 96
+           coreView.layoutParams = params
+       }
+   }
+   ```
+2. **Join the Live Room**
+
+
+   Call the `joinLive` method of `LiveListStore` to join the live stream. **No additional setup is required—LiveCoreView will automatically play the video stream.**
+
+   ``` java
+   import io.trtc.tuikit.atomicxcore.api.live.LiveInfo
+   import io.trtc.tuikit.atomicxcore.api.live.LiveInfoCompletionHandler
+   import io.trtc.tuikit.atomicxcore.api.live.LiveListStore
+   import android.os.Bundle
+   import androidx.appcompat.app.AppCompatActivity
+   import android.util.Log
+   
+   // YourAudienceActivity represents your audience viewing Activity
+   class YourAudienceActivity : AppCompatActivity() {
+   
+       // ... other code ...
+   
+       override fun onCreate(savedInstanceState: Bundle?) {
+           super.onCreate(savedInstanceState)
+           setupUI()
+           // 1. Join the live room (liveID must match the host's)
+           LiveListStore.shared().joinLive(liveID, object : LiveInfoCompletionHandler {
+               override fun onFailure(code: Int, desc: String) {
+                   Log.e("Live", "joinLive error: $desc")
+               }
+   
+               override fun onSuccess(liveInfo: LiveInfo) {
+                   Log.d("Live", "joinLive success")
+               }
+           })
+       }
+   }
+   ```
+3. **Exit the Live Room**
+
+
+   When the audience leaves, call the `leaveLive` method of `LiveListStore`. The SDK will automatically stop playback and exit the room.
+
+   ``` java
+   import io.trtc.tuikit.atomicxcore.api.live.LiveListStore
+   import io.trtc.tuikit.atomicxcore.api.CompletionHandler
+   import androidx.appcompat.app.AppCompatActivity
+   import android.util.Log
+   
+   // YourAudienceActivity represents your audience viewing Activity
+   class YourAudienceActivity : AppCompatActivity() {
+   
+       // ... other code ...
+   
+       // Exit the live room
+       private fun leaveLive() {
+           LiveListStore.shared().leaveLive(object : CompletionHandler {
+               override fun onSuccess() {
+                   Log.d("Live", "leaveLive success")
+               }
+   
+               override fun onFailure(code: Int, desc: String) {
+                   Log.e("Live", "leaveLive error: $desc")
+               }
+           })
+       }
+   
+       // Always call leaveLive when Activity is destroyed
+       override fun onDestroy() {
+           super.onDestroy()
+           leaveLive()
+           Log.d("Live", "YourAudienceActivity onDestroy")
+       }
+   }
+   ```
+
+### Step 3: Listen for Live Events
+
+After joining a live room, you should handle passive events such as the host ending the stream or the audience being removed for violations. If you do not listen for these events, the audience UI may remain in an invalid state, impacting user experience.
+
+Implement the `LiveListListener` interface and register it with `LiveListStore`:
+``` java
+import io.trtc.tuikit.atomicxcore.api.live.LiveEndedReason
+import io.trtc.tuikit.atomicxcore.api.live.LiveKickedOutReason
+import io.trtc.tuikit.atomicxcore.api.live.LiveListListener
+import io.trtc.tuikit.atomicxcore.api.live.LiveListStore
+import android.os.Bundle
+import androidx.appcompat.app.AppCompatActivity
+import android.util.Log
+
+// YourAudienceActivity represents your audience viewing Activity
+class YourAudienceActivity : AppCompatActivity() {
+    
+    // ... (coreView, liveId, setupUI, joinLive, leaveLive, etc.) ...
+
+    // 2. Define a LiveListListener instance
+    private val liveListListener = object : LiveListListener() {
+        override fun onLiveEnded(liveID: String, reason: LiveEndedReason, message: String) {
+            // Listen for live stream end
+            Log.d("Live", "Live ended. liveID: $liveID, reason: $reason, message: $message")
+            // Handle exit logic, e.g., finish()
+            // finish()
+        }
+
+        override fun onKickedOutOfLive(liveID: String, reason: LiveKickedOutReason, message: String) {
+            // Listen for being kicked out of the live room
+            Log.d("Live", "Kicked out of live. liveID: $liveID, reason: $reason, message: $message")
+            // Handle exit logic
+            // finish()
+        }
+    }
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        setupUI() 
+        
+        // 3. Register the listener
+        LiveListStore.shared().addLiveListListener(liveListListener)
+
+        // 4. Join the live room
+        joinLive()
+    }
+    
+    // ... joinLive() and leaveLive() methods ...
+
+    override fun onDestroy() {
+        super.onDestroy()
+        // 5. Remove the listener to prevent memory leaks
+        LiveListStore.shared().removeLiveListListener(liveListListener)
+        leaveLive()
+        Log.d("Live", "YourAudienceActivity onDestroy")
+    }
+}
+```
+
+### Run and Test
+
+After integrating `LiveCoreView`, you will have a pure video rendering view with full live streaming capabilities, but without any interactive UI. To add interactive features, see [Enriching the Live Streaming Scene](https://write.woa.com/#789ad452-eaf1-433f-905d-fcb2945c1505).
+<table>
+<tr>
+<td rowspan="1" colSpan="1" ></td>
+
+<td rowspan="1" colSpan="1" >Dynamic Grid Layout</td>
+
+<td rowspan="1" colSpan="1" >Floating Window Layout</td>
+
+<td rowspan="1" colSpan="1" >Fixed Grid Layout</td>
+
+<td rowspan="1" colSpan="1" >Fixed Window Layout</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Template ID**</td>
+
+<td rowspan="1" colSpan="1" >600</td>
+
+<td rowspan="1" colSpan="1" >601</td>
+
+<td rowspan="1" colSpan="1" >800</td>
+
+<td rowspan="1" colSpan="1" >801</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Description**</td>
+
+<td rowspan="1" colSpan="1" >Default layout; grid size adjusts dynamically based on number of co-hosts.</td>
+
+<td rowspan="1" colSpan="1" >Co-hosts are displayed as floating windows.</td>
+
+<td rowspan="1" colSpan="1" >Fixed number of co-hosts; each occupies a fixed grid.</td>
+
+<td rowspan="1" colSpan="1" >Fixed number of co-hosts; guests are displayed as fixed windows.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Example**</td>
+
+<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/394f3851a5b511f09936525400e889b2.png)</td>
+
+<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/395e0e3da5b511f0930a5254007c27c5.png)</td>
+
+<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/39427c02a5b511f0b1565254001c06ec.png)</td>
+
+<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/3942f453a5b511f091df5254005ef0f7.png)</td>
+</tr>
+</table>
+
+
+## Advanced Features
+
+### Synchronizing Custom State in Live Streaming Room
+
+In Live Streaming Room, hosts may need to synchronize custom information with all participants, such as the current room topic or background music. The `metaData` feature of `LiveListStore` supports this use case.
+
+#### Implementation
+
+On the host side, set custom information using the `updateLiveMetaData` API. `AtomicXCore` synchronizes these changes in real time to all participants. On the audience side, subscribe to `LiveListState.currentLive` and listen for changes in `metaData`. When a relevant key is updated, parse its value and update your business logic.
+
+#### Example Code
+``` kotlin
+import io.trtc.tuikit.atomicxcore.api.LiveListStore
+import io.trtc.tuikit.atomicxcore.api.CompletionHandler
+import com.google.gson.Gson
+import io.trtc.tuikit.atomicxcore.api.MetaDataCompletionHandler
+import io.trtc.tuikit.atomicxcore.api.LiveListStore
+
+// 1. Define a background music model (using data class)
+data class MusicModel(
+    val musicId: String,
+    val musicName: String
+)
+
+// 2. Host side: Add a method to push background music in your Host business logic
+fun updateBackgroundMusic(music: MusicModel) {
+    val gson = Gson()
+    val jsonString = gson.toJson(music) ?: ""
+
+    // The metaData to be updated
+    val metaData = hashMapOf("music_info" to jsonString)
+
+    // Update metaData
+    LiveListStore.shared()
+        .updateLiveMetaData(
+            metaData,
+            object : CompletionHandler {
+                override fun onSuccess() {
+                    print("Background music ${music.musicName} pushed successfully")
+                }
+
+                override fun onFailure(code: Int, desc: String) {
+                    print("Failed to push background music: $desc")
+                }
+            }
+        )
+}
+
+// 3. Audience side: Add a method to listen for background music changes in your Audience business logic
+private fun subscribeToDataUpdates() {
+    CoroutineScope(Dispatchers.Main).launch {
+        LiveListStore.shared()
+            .liveState
+            .currentLive
+            .map { it.metaData }
+            .collect {
+                val musicInfo = it["music_info"]
+                // Refresh business state, e.g., play new background music
+            }
+    }
+}
+```
+
+## Enriching the Live Streaming Scene
+
+Once the basic live streaming functionality is in place, refer to the following guides to add interactive features to your live stream:
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >**Feature**</td>
+
+<td rowspan="1" colSpan="1" >**Description**</td>
+
+<td rowspan="1" colSpan="1" >**Store**</td>
+
+<td rowspan="1" colSpan="1" >**Implementation Guide**</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Enable Audience Audio/Video Co-hosting**</td>
+
+<td rowspan="1" colSpan="1" >Audience can apply to join the host on stage for real-time video interaction.</td>
+
+<td rowspan="1" colSpan="1" >[CoGuestStore](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-co-guest-store/index.html)</td>
+
+<td rowspan="1" colSpan="1" >[Implementation Guide](https://write.woa.com/document/194571606970114048)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Enable Host Cross-room PK**</td>
+
+<td rowspan="1" colSpan="1" >Hosts from different rooms can connect for interaction or PK.</td>
+
+<td rowspan="1" colSpan="1" >[CoHostStore](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-co-host-store/index.html)<br>[BattleStore](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-battle-store/index.html)</td>
+
+<td rowspan="1" colSpan="1" >[Implementation Guide](https://write.woa.com/document/194571607349698560)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Add Bullet Chat Feature**</td>
+
+<td rowspan="1" colSpan="1" >Audience can send and receive real-time text messages in the live room.</td>
+
+<td rowspan="1" colSpan="1" >[BarrageStore](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>
+
+<td rowspan="1" colSpan="1" >[Implementation Guide](https://write.woa.com/document/194571607715651584)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >**Build a Gift Giving System**</td>
+
+<td rowspan="1" colSpan="1" >Audience can send virtual gifts to the host, increasing engagement and fun.</td>
+
+<td rowspan="1" colSpan="1" >[GiftStore](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.gift/-gift-store/index.html)</td>
+
+<td rowspan="1" colSpan="1" >[Implementation Guide](https://write.woa.com/document/194571602045140992)</td>
+</tr>
+</table>
+
+
+## API Documentation
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >**Store/Component**</td>
+
+<td rowspan="1" colSpan="1" >**Description**</td>
+
+<td rowspan="1" colSpan="1" >**API Reference**</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >LiveCoreView</td>
+
+<td rowspan="1" colSpan="1" >Core view component for displaying and interacting with live video streams. Handles video rendering and view widgets, supports host streaming, audience co-hosting, host connections, and more.</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" >Manages the full lifecycle of live rooms: create/join/leave/destroy rooms, query room list, modify live info (name, announcement, etc.), and listen to live status events (e.g., kicked out, 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>
+
+<tr>
+<td rowspan="1" colSpan="1" >DeviceStore</td>
+
+<td rowspan="1" colSpan="1" >Controls audio/video devices: microphone (on/off, volume), camera (on/off, switch, quality), screen sharing, and real-time device status monitoring.</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.device/-device-store/index.html)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >CoGuestStore</td>
+
+<td rowspan="1" colSpan="1" >Manages audience co-hosting: apply/invite/accept/reject co-host requests, member permission control (microphone/camera), and status synchronization.</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/-co-guest-store/index.html)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >CoHostStore</td>
+
+<td rowspan="1" colSpan="1" >Handles host cross-room connections: supports multiple layout templates (dynamic grid, etc.), initiates/accepts/rejects connections, and manages co-host interactions.</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/-co-host-store/index.html)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >BattleStore</td>
+
+<td rowspan="1" colSpan="1" >Manages host PK battles: initiate PK (set duration/opponent), manage PK status (start/end), synchronize scores, and listen for battle results.</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/-battle-store/index.html)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >GiftStore</td>
+
+<td rowspan="1" colSpan="1" >Handles gift interactions: get gift list, send/receive gifts, and listen for gift events (including sender and gift details).</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.gift/-gift-store/index.html)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >BarrageStore</td>
+
+<td rowspan="1" colSpan="1" >Supports live chat: send text/custom danmaku, maintain danmaku list, and monitor danmaku 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>
+
+<tr>
+<td rowspan="1" colSpan="1" >LikeStore</td>
+
+<td rowspan="1" colSpan="1" >Handles like interactions: send likes, listen for like events, and synchronize total like count.</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/-like-store/index.html)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >LiveAudienceStore</td>
+
+<td rowspan="1" colSpan="1" >Manages audience: get real-time audience list (ID/name/avatar), count audience, and listen for 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.live/-live-audience-store/index.html)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >AudioEffectStore</td>
+
+<td rowspan="1" colSpan="1" >Audio effects: voice change (child/male), reverb (KTV, etc.), ear return adjustment, and real-time effect switching.</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.device/-audio-effect-store/index.html)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >BaseBeautyStore</td>
+
+<td rowspan="1" colSpan="1" >Basic beauty filters: adjust smoothing/whitening/rosiness (0-9), reset beauty status, and synchronize effect parameters.</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.device/-base-beauty-store/index.html)</td>
+</tr>
+</table>
+
+
+## FAQs
+
+### Why is the screen black with no video after the host calls createLive or the audience calls joinLive?
+- **Check setLiveID**: Ensure you have set the correct liveID for the LiveCoreView instance before calling start or join methods.
+
+- **Check device permissions**: Ensure the app has system permissions for camera and microphone usage.
+
+- **Check the host side**: Has the host called `DeviceStore.shared().openLocalCamera(true)`to enable the camera?
+
+- **Check the network**: Ensure the device has a stable network connection.
+
+
+### After the host enables the camera, why is there a local video preview after starting the stream, but a black screen before starting?
+- **Check the host side**: Make sure the host streaming view (LiveCoreView) has its `viewType` set to `PUSH_VIEW`.
+
+- **Check the audience side**: Make sure the audience playback view (LiveCoreView) has its `viewType` set to `PLAY_VIEW`.
+
+
+### What restrictions and rules apply to `updateLiveMetaData`?
+
+To maintain system stability and efficiency, metaData usage follows these rules:
+- **Permissions**: Only hosts and administrators can call `updateLiveMetaData`. Regular audience members cannot.
+
+- **Quantity and Size Limits:**
+
+  - Each room supports up to **10** keys.
+
+  - Each key can be up to **50 bytes**; each value up to **2KB**.
+
+  - The total size of all values in a room cannot exceed **16KB**.
+
+- **Conflict Resolution**: The update mechanism is "last write wins". If multiple administrators modify the same key in quick succession, the last change takes effect. Avoid concurrent modifications to the same key in your business logic.