@tencent-rtc/mcp 1.4.7 → 1.6.0

package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-host-interaction.md

@@ -1,14 +1,15 @@
 `AtomicXCore` provides two core modules: `CoHostStore` for **cross-room connections** and `BattleStore` for **PK battles**. This guide explains how to integrate these modules to enable connection and PK features in a voice chat room application.
 
 ## Core Concepts
-| **Key Concept** | **Type** | **Core Responsibilities & Description** |
-| --- | --- | --- |
-| **CoHostStore** | `class` | Manages the lifecycle of co-hosting between streamers, providing APIs for co-hosting (requestHostConnection, acceptHostConnection). |
-| **BattleStore** | `class` | Handles signaling and state management for cross-room PK battles, including PK status. |
-| **LiveListStore** | `class` | Fetches the list of live rooms (`fetchLiveList`), enabling discovery of other rooms available for co-hosting. |
-| **LiveSeatStore** | `class` | Manages the status of all seats in a room (including cross-room seats during co-hosting), tracks users joining/leaving seats and microphone status. |
-| **CoHostLayoutTemplate** | `enum` | Defines seat layout templates for co-hosting, such as `.hostStaticVoice6v6`. |
-| **BattleConfig** | `struct` | Configures PK details, including PK duration (`duration`) and whether a response (`needResponse`) is required. |
+
+|**Key Concept**|**Type**|**Core Responsibilities & Description**|
+|---------|---------|---------|
+|**CoHostStore**|`class`|Manages the lifecycle of co-hosting between streamers, providing APIs for co-hosting (requestHostConnection, acceptHostConnection).|
+|**BattleStore**|`class`|Handles signaling and state management for cross-room PK battles, including PK status.|
+|**LiveListStore**|`class`|Fetches the list of live rooms (`fetchLiveList`), enabling discovery of other rooms available for co-hosting.|
+|**LiveSeatStore**|`class`|Manages the status of all seats in a room (including cross-room seats during co-hosting), tracks users joining/leaving seats and microphone status.|
+|**CoHostLayoutTemplate**|`enum`|Defines seat layout templates for co-hosting, such as `.hostStaticVoice6v6`.|
+|**BattleConfig**|`struct`|Configures PK details, including PK duration (`duration`) and whether a response (`needResponse`) is required.|
 
 ## Prerequisites
 
@@ -224,10 +225,11 @@ func onExitButtonClicked() {
 ```
 
 PK Streamer Initiates a PK BattleStreamers can start PK battles using two main flows, depending on the room state before PK begins:
-| **PK Mode** | **Room State (Before PK)** | **Room State (After PK)** |
-| --- | --- | --- |
-| **Scenario 1: PK after co-hosting** | Both sides **already co-hosting** | Return to co-hosting state |
-| **Scenario 2: Co-hosting with PK mode** | Both sides **not co-hosting** | Return to co-hosting state |
+
+|**PK Mode**|**Room State (Before PK)**|**Room State (After PK)**|
+|---------|---------|---------|
+|**Scenario 1: PK after co-hosting**|Both sides **already co-hosting**|Return to co-hosting state|
+|**Scenario 2: Co-hosting with PK mode**|Both sides **not co-hosting**|Return to co-hosting state|
 
 ### Scenario 1: PK After Co-hosting
 
@@ -468,12 +470,13 @@ In typical** live host PK scenarios,** the value of gifts received by the host i
 
 > The PK score system in the LiveKit backend uses pure numeric calculation and accumulation. You must calculate the PK score according to your own business logic before calling the update API. See the following PK score calculation examples:
 >
-| Gift Type | Score Calculation Rule | Example |
-| --- | --- | --- |
-| Basic Gift | Gift value × 5 | 10 RMB gift → 50 points |
-| Intermediate Gift | Gift value × 8 | 50 RMB gift → 400 points |
-| Advanced Gift | Gift value × 12 | 100 RMB gift → 1200 points |
-| Special Effect Gift | Fixed high score | 520 RMB gift → 1314 points |
+
+|Gift Type|Score Calculation Rule|Example|
+|---------|---------|---------|
+|Basic Gift|Gift value × 5|10 RMB gift → 50 points|
+|Intermediate Gift|Gift value × 8|50 RMB gift → 400 points|
+|Advanced Gift|Gift value × 12|100 RMB gift → 1200 points|
+|Special Effect Gift|Fixed high score|520 RMB gift → 1314 points|
 
 #### REST API Call Flow
 
@@ -491,12 +494,13 @@ In typical** live host PK scenarios,** the value of gifts received by the host i
 4. **LiveKit Backend Syncs to Client**: The backend automatically synchronizes the updated PK score to all clients.
 
 #### Involved REST API Endpoints
-| **API** | **Function Description** | **Request Example** |
-| --- | --- | --- |
-| Active API - Query PK Status | Check whether the current room is in PK | Example |
-| Active API - Update PK Score | Update the calculated PK score | Example |
-| Callback Configuration - PK Start Callback | Receive real-time notification when PK starts | Example |
-| Callback Configuration - PK End Callback | Receive real-time notification when PK ends | Example |
+
+|**API**|**Function Description**|**Request Example**|
+|---------|---------|---------|
+|Active API - Query PK Status|Check whether the current room is in PK|Example|
+|Active API - Update PK Score|Update the calculated PK score|Example|
+|Callback Configuration - PK Start Callback|Receive real-time notification when PK starts|Example|
+|Callback Configuration - PK End Callback|Receive real-time notification when PK ends|Example|
 
 ### Winner Determination
 
@@ -516,12 +520,13 @@ battleStore.state.subscribe(StatePublisherSelector(keyPath: \BattleState.battleS
 ## API Documentation
 
 For complete API details, refer to the [AtomicXCore API documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore):
-| **Store/Component** | **Function Description** | **API Documentation** |
-| --- | --- | --- |
-| **CoHostStore** | Core component for live stream display and interaction: handles video rendering, widget management, streamer live, audience mic-link, streamer co-hosting, and more. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore) |
-| **BattleStore** | Manages the full lifecycle of live rooms: create, join, leave, destroy, query room list, modify live info, listen for live status changes. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/battlestore) |
-| **LiveListStore** | Manages live room lifecycle: query room list, modify live info, etc. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveliststore) |
-| **LiveSeatStore** | Manages seat status: tracks all seats in the room (including cross-room seats during co-hosting), check user join/leave, microphone, seat status, etc. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveseatstore) |
+
+|**Store/Component**|**Function Description**|**API Documentation**|
+|---------|---------|---------|
+|**CoHostStore**|Core component for live stream display and interaction: handles video rendering, widget management, streamer live, audience mic-link, streamer co-hosting, and more.|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore)|
+|**BattleStore**|Manages the full lifecycle of live rooms: create, join, leave, destroy, query room list, modify live info, listen for live status changes.|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/battlestore)|
+|**LiveListStore**|Manages live room lifecycle: query room list, modify live info, etc.|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveliststore)|
+|**LiveSeatStore**|Manages seat status: tracks all seats in the room (including cross-room seats during co-hosting), check user join/leave, microphone, seat status, etc.|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveseatstore)|
 
 ## FAQs
 

package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-integration.md

@@ -1,14 +1,14 @@
 This document guides you through building a voice chat room application with host broadcasting and audience participation features using the **AtomicXCore** SDK's `LiveListStore` and `LiveSeatStore`.
 
 ## Core Concepts
-| **Core Concept** | **Type** | **Core Responsibilities & Description** |
+| <strong>Core Concept</strong> | <strong>Type</strong> | <strong>Core Responsibilities & Description</strong> |
 | --- | --- | --- |
-| `LiveListStore` | `class` | - `createLive()`: Start live stream as host.<br>- `endLive()`: End live stream as host.<br>- `joinLive()`: Audience joins live room.<br>- `leaveLive()`: Leave live room. |
-| `LiveInfo` | `struct` | - `liveID`: Unique room identifier.<br>- `seatLayoutTemplateID`: Layout template ID (e.g., 600 for dynamic grid). |
-| `LiveSeatStore` | `class` | - Core seat management class. Manages all seat information and seat-related operations in the room.<br>- Provides a real-time seat list data stream via liveSeatState.seatList. |
-| `LiveSeatState` | `struct` | Represents the current state of all seats.<br>- `seatList`: a StateFlow containing the real-time seat list.<br>- `speakingUsers`: users currently speaking and their volume. |
-| `SeatInfo` | `class` | Data model for a single seat. The seat list (seatList) emitted by LiveSeatStore is a list of SeatInfo objects.<br>Key fields:<br>- `index`: seat position.<br>- `isLocked`: whether the seat is locked.<br>- `userInfo`: user information for the seat. If the seat is empty, this field is empty. |
-| `SeatUserInfo` | `class` | Detailed data model for the user occupying a seat. When a user successfully takes a seat, the userInfo field in SeatInfo is populated.<br>Key fields:<br>- `userID`: unique user ID.<br>- `userName`: user nickname.<br>- `avatarURL`: user avatar URL.<br>- `microphoneStatus`: microphone status (on/off).<br>- `cameraStatus`: camera status (on/off). |
+| <code>LiveListStore</code> | <code>class</code> | - <code>createLive()</code>: Start live stream as host.<br>- <code>endLive()</code>: End live stream as host.<br>- <code>joinLive()</code>: Audience joins live room.<br>- <code>leaveLive()</code>: Leave live room. |
+| <code>LiveInfo</code> | <code>struct</code> | - <code>liveID</code>: Unique room identifier.<br>- <code>seatLayoutTemplateID</code>: Layout template ID (e.g., 600 for dynamic grid). |
+| <code>LiveSeatStore</code> | <code>class</code> | - Core seat management class. Manages all seat information and seat-related operations in the room.<br>- Provides a real-time seat list data stream via liveSeatState.seatList. |
+| <code>LiveSeatState</code> | <code>struct</code> | Represents the current state of all seats.<br>- <code>seatList</code>: a StateFlow containing the real-time seat list.<br>- <code>speakingUsers</code>: users currently speaking and their volume. |
+| <code>SeatInfo</code> | <code>class</code> | Data model for a single seat. The seat list (seatList) emitted by LiveSeatStore is a list of SeatInfo objects.<br>Key fields:<br>- <code>index</code>: seat position.<br>- <code>isLocked</code>: whether the seat is locked.<br>- <code>userInfo</code>: user information for the seat. If the seat is empty, this field is empty. |
+| <code>SeatUserInfo</code> | <code>class</code> | Detailed data model for the user occupying a seat. When a user successfully takes a seat, the userInfo field in SeatInfo is populated.<br>Key fields:<br>- <code>userID</code>: unique user ID.<br>- <code>userName</code>: user nickname.<br>- <code>avatarURL</code>: user avatar URL.<br>- <code>microphoneStatus</code>: microphone status (on/off).<br>- <code>cameraStatus</code>: camera status (on/off). |
 
 ## Prerequisites
 
@@ -66,9 +66,9 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau
 **Login API Parameter Description**
 | Parameter | Type | Description |
 | --- | --- | --- |
-| `sdkAppID` | `Int` | Get this from [TRTC console > Application management](https://console.trtc.io/app). |
-| `userID` | `String` | The unique ID for the current user. Must contain only English letters, numbers, hyphens, and underscores. |
-| `userSig` | `String` | 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.<br>- For more information, see How to Calculate and Use UserSig. |
+| <code>sdkAppID</code> | <code>Int</code> | Get this from <a href="https://console.trtc.io/app">TRTC console > Application management</a>. |
+| <code>userID</code> | <code>String</code> | The unique ID for the current user. Must contain only English letters, numbers, hyphens, and underscores. |
+| <code>userSig</code> | <code>String</code> | A ticket for Tencent Cloud authentication. Please note:<br>- <strong>Development Environment</strong>: You can use the local <code>GenerateTestUserSig.genTestSig</code> function to generate a UserSig or generate a temporary UserSig via the <a href="https://console.trtc.io/usersig">UserSig Generation Tool</a>.<br>- <strong>Production Environment</strong>: To prevent key leakage, you must use a server-side method to generate UserSig. For details, see Generating UserSig on the Server.<br>- For more information, see How to Calculate and Use UserSig. |
 
 ## Building a Basic Voice Chat Room
 
@@ -180,27 +180,28 @@ class YourAnchorViewController: UIViewController {
 ```
 
 **LiveInfo Parameter Reference:**
-| **Parameter Name** | **Type** | **Required** | **Description** |
-| --- | --- | --- | --- |
-| `liveID` | `String` | Required | Unique identifier for the live room |
-| `liveName` | `String` | Optional | Room title |
-| `notice` | `String` | Optional | Room announcement |
-| `isMessageDisable` | `Bool` | Optional | Mute chat (`true`: muted, `false`: not muted) |
-| `isPublicVisible` | `Bool` | Optional | Public visibility (`true`: visible, `false`: not visible) |
-| `seatMode` | `TakeSeatMode` | Optional | Seat mode (`.free`: free seat, `.apply`: apply for seat) |
-| `seatTemplate` | `SeatLayoutTemplate` | Required | Seat layout template ID |
-| `coverURL` | `String` | Optional | Room cover image URL |
-| `backgroundURL` | `String` | Optional | Room background image URL |
-| `categoryList` | `[NSNumber]` | Optional | Room category tags |
-| `activityStatus` | `Int` | Optional | Live activity status |
-| `isGiftEnabled` | `Bool` | Optional | Enable gift feature (`true`: enabled, `false`: disabled) |
+
+|**Parameter Name**|**Type**|**Required**|**Description**|
+|---------|---------|---------|---------|
+|`liveID`|`String`|Required|Unique identifier for the live room|
+|`liveName`|`String`|Optional|Room title|
+|`notice`|`String`|Optional|Room announcement|
+|`isMessageDisable`|`Bool`|Optional|Mute chat (`true`: muted, `false`: not muted)|
+|`isPublicVisible`|`Bool`|Optional|Public visibility (`true`: visible, `false`: not visible)|
+|`seatMode`|`TakeSeatMode`|Optional|Seat mode (`.free`: free seat, `.apply`: apply for seat)|
+|`seatTemplate`|`SeatLayoutTemplate`|Required|Seat layout template ID|
+|`coverURL`|`String`|Optional|Room cover image URL|
+|`backgroundURL`|`String`|Optional|Room background image URL|
+|`categoryList`|`[NSNumber]`|Optional|Room category tags|
+|`activityStatus`|`Int`|Optional|Live activity status|
+|`isGiftEnabled`|`Bool`|Optional|Enable gift feature (`true`: enabled, `false`: disabled)|
 
 #### **4. Build the Mic Seat UI**
 
 > **Note：**
 >
 
-> For seat UI logic and effects, refer to the open-source [SeatGridView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/SeatGridview/SeatGridView.swift) in TUILiveKit.
+> For seat UI logic and effects, refer to the open-source [SeatGridView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Component/SeatGridview/SeatGridView.swift) in TUILiveKit.
 >
 
 Use your `LiveSeatStore` instance to subscribe to `state.seatList` and update the UI in real time:
@@ -380,7 +381,7 @@ In voice chat rooms, it's common to show a wave animation over the avatar of use
 > **Note：**
 >
 
-> For a complete implementation of the speaking wave animation, refer to [SeatGridView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/SeatGridview/SeatGridView.swift) in TUILiveKit.
+> For a complete implementation of the speaking wave animation, refer to [SeatGridView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Component/SeatGridview/SeatGridView.swift) in TUILiveKit.
 >
 
 In your `YourAnchorViewController` or `YourAudienceViewController`, subscribe to `speakingUsers` and update the UI accordingly:
@@ -474,28 +475,30 @@ private func subscribeToDataUpdates() {
 ## Enriching Voice Chat Room Scenarios
 
 After implementing the basic voice chat room, enhance your application with the following features:
-| **Feature** | **Description** | **Store** | **Implementation Guide** |
-| --- | --- | --- | --- |
-| **Audience Take Seat** | Audience members can apply to take a seat and interact with the host in real time. | [CoGuestStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore) | Implementation |
-| **Host Cross-Room PK** | Hosts from different rooms can connect for interaction or PK. | [CoHostStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore)<br>[BattleStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/battlestore) | Implementation |
-| **Add Barrage Chat** | Room members can send and receive real-time text messages. | [BarrageStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore) | Implementation |
-| **Gift System** | Audience can send virtual gifts to hosts to increase interaction and engagement. | [GiftStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/giftstore) | Implementation |
+
+|**Feature**|**Description**|**Store**|**Implementation Guide**|
+|---------|---------|---------|---------|
+|**Audience Take Seat**|Audience members can apply to take a seat and interact with the host in real time.|[CoGuestStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore)|Implementation|
+|**Host Cross-Room PK**|Hosts from different rooms can connect for interaction or PK.|[CoHostStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore)<br>[BattleStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/battlestore)|Implementation|
+|**Add Barrage Chat**|Room members can send and receive real-time text messages.|[BarrageStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore)|Implementation|
+|**Gift System**|Audience can send virtual gifts to hosts to increase interaction and engagement.|[GiftStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/giftstore)|Implementation|
 
 ## API Documentation
-| **Store/Component** | **Description** | **API Docs** |
-| --- | --- | --- |
-| `LiveListStore` | Manages the full live room lifecycle: create, join, leave, destroy room; query room list; modify room info; listen for room status changes. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveliststore) |
-| `LiveSeatStore` | Seat management: handle seat list, user status, seat operations (take seat, leave seat, kick, lock, toggle mic/camera), and seat events. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveseatstore) |
-| `DeviceStore` | Audio/video device control: microphone, camera, screen sharing, device status monitoring. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/devicestore/) |
-| `CoGuestStore` | Audience co-host management: application, invitation, acceptance, rejection, member permissions, status sync. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore/) |
-| `CoHostStore` | Host cross-room connection: supports multiple layouts, initiate/accept/reject connection, manage co-host interaction. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore/) |
-| `BattleStore` | Host PK battle: initiate PK, manage PK status, synchronize scores, listen for battle results. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/battlestore) |
-| `GiftStore` | Gift interaction: fetch gift list, send/receive gifts, listen for gift events. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/giftstore/) |
-| `BarrageStore` | Barrage (chat overlay): send text/custom barrage, maintain barrage list, monitor barrage status. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore) |
-| `LikeStore` | Like interaction: send likes, listen for like events, synchronize like count. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/likestore) |
-| `LiveAudienceStore` | Audience management: get real-time audience list, count, entry/exit events. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveaudiencestore) |
-| `AudioEffectStore` | Audio effects: voice change, reverb, in-ear monitoring, effect switching. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/audioeffectstore) |
-| `BaseBeautyStore` | Basic beauty: adjust smoothing/whitening/redness (0-100), reset beauty status, synchronize effect parameters. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/basebeautystore) |
+
+|**Store/Component**|**Description**|**API Docs**|
+|---------|---------|---------|
+|`LiveListStore`|Manages the full live room lifecycle: create, join, leave, destroy room; query room list; modify room info; listen for room status changes.|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveliststore)|
+|`LiveSeatStore`|Seat management: handle seat list, user status, seat operations (take seat, leave seat, kick, lock, toggle mic/camera), and seat events.|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveseatstore)|
+|`DeviceStore`|Audio/video device control: microphone, camera, screen sharing, device status monitoring.|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/devicestore/)|
+|`CoGuestStore`|Audience co-host management: application, invitation, acceptance, rejection, member permissions, status sync.|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore/)|
+|`CoHostStore`|Host cross-room connection: supports multiple layouts, initiate/accept/reject connection, manage co-host interaction.|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore/)|
+|`BattleStore`|Host PK battle: initiate PK, manage PK status, synchronize scores, listen for battle results.|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/battlestore)|
+|`GiftStore`|Gift interaction: fetch gift list, send/receive gifts, listen for gift events.|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/giftstore/)|
+|`BarrageStore`|Barrage (chat overlay): send text/custom barrage, maintain barrage list, monitor barrage status.|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore)|
+|`LikeStore`|Like interaction: send likes, listen for like events, synchronize like count.|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/likestore)|
+|`LiveAudienceStore`|Audience management: get real-time audience list, count, entry/exit events.|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveaudiencestore)|
+|`AudioEffectStore`|Audio effects: voice change, reverb, in-ear monitoring, effect switching.|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/audioeffectstore)|
+|`BaseBeautyStore`|Basic beauty: adjust smoothing/whitening/redness (0-100), reset beauty status, synchronize effect parameters.|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/basebeautystore)|
 
 ## FAQs
 

package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-room-list.md

@@ -8,12 +8,12 @@
 - **Real-Time Event Listening**: Listen for key events such as live session end or users being removed from a room.
 
 ## Core Concepts
-| **Core Concept** | **Type** | **Core Responsibility & Description** |
+| <strong>Core Concept</strong> | <strong>Type</strong> | <strong>Core Responsibility & Description</strong> |
 | --- | --- | --- |
-| `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. |
+| <code>LiveInfo</code> | <code>struct</code> | - Represents the complete information model of a live room.<br>- Includes the live room ID (<code>liveID</code>), name (<code>liveName</code>), owner information (<code>liveOwner</code>), and custom metadata (<code>metaData</code>), among other properties. |
+| <code>LiveListState</code> | <code>struct</code> | - Represents the current state of the live list module.<br>- The core property <code>liveList</code> is a StateFlow containing the fetched live room list;<br>- <code>currentLive</code> represents the information of the live room the user is currently in. |
+| <code>LiveListEvent</code> | <code>enum</code> | Handles global live room events, including <code>.onLiveEnded</code> (live ended) and <code>.onKickedOutOfLive</code> (user removed from live), for responding to key room state changes. |
+| <code>LiveListStore</code> | <code>class</code> | - 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
 
@@ -106,16 +106,17 @@ class LiveListViewController: UIViewController, UICollectionViewDataSource, UICo
 ```
 
 #### LiveInfo Parameter Reference
-| **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 |
+
+|**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
 
@@ -297,10 +298,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:
-| **Store/Component** | **Feature Description** | **API Documentation** |
+| <strong>Store/Component</strong> | <strong>Feature Description</strong> | <strong>API Documentation</strong> |
 | --- | --- | --- |
-| 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) |
+| 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. | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/livecoreview">API Documentation</a> |
+| 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). | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveliststore">API Documentation</a> |
 
 ## FAQs
 

package/resource/knowledge/livekit/faq/error-code.md

@@ -0,0 +1,193 @@
+## General Error Code
+
+|Error Code|Description|
+|---------|---------|
+|0|Operation Successful.|
+|-1|Temporarily Unclassified General Error.|
+|-2|`Request Rate` limited, please try again later.|
+|-3|Repeat Operation.|
+|-1000|Not Found `SDKAppID`, Please Confirm Application Info in [TRTC Console](https://console.tencentcloud.com/trtc/allapp).|
+|-1001|Passing illegal parameters when calling API, check if the parameters are legal.|
+|-1002|Not logged in, please call `Login` API.|
+|-1003|Failed to obtain permission, unauthorized audio/video permission, please check if `Device Permission` is enabled.|
+|-1004|This feature requires an additional package. Please activate the corresponding package as needed in the [TRTC Console](https://console.tencentcloud.com/trtc/allapp).|
+|-3301|Network access is restricted. Please [contact us](https://trtc.io/contact) for support.|
+
+### Local User Rendering, Video Management, Audio Management API Callback Error Definition
+
+|Error Code|Description|
+|---------|---------|
+|-1100|System issue, failed to open camera. Check if camera device functions well.|
+|-1101|Camera has no system authorization, please check system authorization.|
+|-1102|Camera is occupied. Check if other process is using camera.|
+|-1103|No camera device currently, please insert camera device to solve the problem.|
+|-1104|System issue, failed to open mic. Check if mic device functions well.|
+|-1105|Mic has no system authorization, check system authorization.|
+|-1106|Mic is occupied.|
+|-1107|No mic device currently.|
+|-1108|Failed to obtain screen sharing object, check screen recording permission.|
+|-1109|Failed to enable screen sharing, check if someone is already screen sharing in the room.|
+
+### Room Management Related API Callback Error Definition
+
+|Error Code|Description|
+|---------|---------|
+|-2101|This feature can only be used after entering the room.|
+|-2102|Room owner does not support leaving the room, conference room type: transfer room ownership first, then leave the room. Living room type: room owner can only close the room.|
+|-2103|This operation is not supported in the current room type.|
+|-2105|Illegal Custom Room ID, must be `Printable ASCII Characters (0x20-0x7e)`, Up to **48 Bytes** Long.|
+|-2107|Illegal Room Name, maximum **30 Bytes**. Must Be `UTF-8 Encoding` if contains Chinese characters.|
+|-2108|User is already in another room, single roomengine instance only supports user entering one room, to enter different room, please leave the room or use new roomengine instance|
+
+### Room User Information API Callback Error Definition
+
+|Error Code|Description|
+|---------|---------|
+|-2200|User Not Found.|
+
+### Room User Speech Management API Callback Error Definition & Room Mic Seat Management API Callback Error Definition
+
+|Error Code|Description|
+|---------|---------|
+|-2300|Room owner permission required for operation.|
+|-2301|Room owner or administrator permission required for operation.|
+|-2310|No permission for signaling request, e.g. canceling an invite not initiated by yourself.|
+|-2311|Signaling request id is invalid or has been processed.|
+|-2312|Signal request repetition.|
+|-2340|Maximum mic seat exceeds package quantity limit.|
+|-2344|Mic seat serial number does not exist.|
+|-2360|Current mic seat audio is locked.|
+|-2361|Need to apply to room owner or administrator to open mic.|
+|-2370|Current mic seat video is locked, need room owner to unlock mic seat before opening camera.|
+|-2371|Need to apply to room owner or administrator to open camera.|
+|-2372|The current microphone position video is locked and needs to be unlocked by the room owner before screen sharing can be enabled.|
+|-2373|Screen sharing needs to be enabled after applying to the room owner or administrator.|
+|-2380|All members muted in the current room.|
+|-2381|You have been muted in the current room.|
+
+## Definition Of Room Preload API Callback Error
+
+|Error code|Description|
+|---------|---------|
+|-4001|The current room does not support preloading.|
+
+## Common Error Codes for RESTful APIs
+
+|Error code|Description|
+|---------|---------|
+|60002|`HTTP` parsing error, please check the `HTTP` request `URL` format.|
+|60003|HTTP request `JSON` parsing error, please check the `JSON` format.|
+|60004|Request `URL` or `JSON` payload contains an incorrect account or signature.|
+|60005|Request `URL` or `JSON` payload contains an incorrect account or signature.|
+|60006|`SDKAppID` invalid, please verify the validity of `SDKAppID`.|
+|60007|`RESTful API` invocation frequency exceeds its limit, please reduce the request frequency.|
+|60008|Service request timed out or `HTTP` request format is incorrect, please check and retry.|
+|60009|Request Resource Error, please check the request `URL`.|
+|60010|The request requires App administrator privileges.|
+|60011|`SDKAppID` request frequency exceeds the limit, please reduce the request frequency.|
+|60012|`RESTful API` requires `SDKAppID`, please check the `SDKAppID` in the request `URL`.|
+|60013|`HTTP` response package `JSON` parsing error.|
+|60014|Account Replacement timed out.|
+|60015|The request body has the wrong account type. Please ensure the account is in string format.|
+|60016|`SDKAppID` is disabled.|
+|60017|The request is disabled.|
+|60018|The request is too frequent, please try again later.|
+|60019|The request is too frequent, please try again later.|
+|60020|Your Professional Edition package has expired and been deactivated. Please  log in to [Chat  purchase page](https://buy.cloud.tencent.com/avc) to repurchase the package. Once purchased, it will take effect 5 minutes later.|
+|60021|Calling `Source IP` for `RestAPI` is illegal.|
+
+## Error codes
+
+Common error codes (60000 to 79999) see [Error Code](https://intl.cloud.tencent.com/document/product/1047/34348) documentation.
+The private error codes for this API are as follows:
+
+|Error Code|Explanation|
+|---------|---------|
+|100001|Server internal error, please retry.|
+|100002|The parameter is illegal. Check whether the request is correct according to the error description.|
+|100003|The room ID already exists. Please select another room ID.|
+|100004|The room does not exist, or it once existed but has now been dissolved.|
+|100005|Not a room member.|
+|100006|Insufficient operation permissions.|
+|100007|No payment information; you need to purchase a package in the console.|
+|100008|The room is full.|
+|100009|Tag quantity exceeds upper limit.|
+|100010|The room ID has been used, and the operator is the room owner; it can be used directly.|
+|100011|The room ID has been occupied by Chat. You can use a different room ID or dissolve the group first.|
+|100012|Creating rooms exceeds the frequency limit; the same room ID can only be created once within 1 second.|
+|100013|Exceeds the upper limit, for example, the number of microphone seats, the number of PK match rooms, etc., exceeds the payment limit.|
+|100015|Invalid room type.|
+|100016|This member has been banned.|
+|100017|This member has been muted.|
+|100018|The current room requires a password for entry.|
+|100019|Room Entry Password Error.|
+|100020|The admin quantity exceeds the upper limit.|
+|100023|This operation has exceeded the allowed quantity limit.|
+|100024|The package has not been activated or has expired. Please check in the console.|
+|100025|The number of members in the room has reached the upper limit.|
+|100026|Room name or other information contains sensitive content.|
+|100100|A device application already exists. Please avoid submitting duplicate requests.|
+|100101|The device application request has timed out. Please try again.|
+|100102|Signal request conflict.|
+|100200|The requested mic seat is locked. Please try a different seat.|
+|100201|The requested mic seat is already occupied.|
+|100202|The user is already in the mic seat request queue.|
+|100203|The user is already on the mic seat.|
+|100204|The user is not in the mic seat request queue.|
+|100205|All mic seats are currently occupied.|
+|100206|The user is not currently on any mic seat.|
+|100207|The mic seat is not locked.|
+|100208|The user is already in the mic seat invitation list.|
+|100209|The user is not in the mic seat invitation list.|
+|100210|The user is already on the mic seat.|
+|100211|The room does not support mic seat functionality.|
+|100230|The current room type does not support this mic seat operation.|
+|100251|The seat list is empty.|
+|100252|Invalid mic seat index.|
+|100253|Featured host seats are full.|
+|100300|The callback URL already exists. Please avoid submitting duplicate configurations.|
+|100301|The callback URL does not exist.|
+|100302|The callback authentication token does not exist.|
+|100400|The current connection does not exist or has ended.|
+|100401|The room is already in connection.|
+|100402|There is a pending connection request for this room.|
+|100403|The current room is connecting with other rooms.|
+|100404|The number of rooms has exceeded the limit for connection or PK session.|
+|100405|Connection requests are being made too frequently. Please wait a moment and try again.|
+|100406|The connection request has already been processed.|
+|100407|The specified room is not part of this connection session.|
+|100411|The battle does not exist or has ended.|
+|100412|None of the rooms in the PK session are valid.|
+|100413|PK sessions are being created too frequently. Please wait a moment and try again.|
+|100414|The room is not currently in a PK session.|
+|100415|The room is already participating in another PK session.|
+|100416|There is a pending battle request for this room.|
+|100417|The room is currently in a PK. Please try again later.|
+|100418|The room has exited the current PK.|
+|100419|Canceling a PK session is not allowed while the room is actively in a PK.|
+|100420|The PK session has not started yet.|
+|100421|The PK session has already ended.|
+|100500|The number of keys in the room's `Metadata` exceeds the limit.|
+|100501|The size of value in the room's `Metadata` exceeds the maximum byte limit.|
+|100502|The total size of all value in the room's `Metadata` exceeds the maximum byte limit.|
+|100503|No valid keys were provided for the `Metadata` deletion request.|
+|100504|The size of key in the room's `Metadata` exceeds the maximum byte limit.|
+|100601|The user has been muted and cannot send messages.|
+|100700|The number of bots has reached the maximum limit.|
+|102001|The gift feature is not enabled. Please activate it in the console.|
+|102002|The specified gift does not exist.|
+|102003|Gift sending verification failed. Please check your request and try again.|
+|102004|The gift sending request was rejected by the server-side validation callback.|
+|102005|The gift configuration does not exist.|
+|102006|The number of gifts has reached the upper limit.|
+|102007|The number of gift categories has reached the upper limit.|
+|102008|The gift feature is not enabled for the current room.|
+|102009|The like feature is not enabled for the current room.|
+|102010|The gift configuration already exists. Do not create it again.|
+|104001|The song playlist does not exist.|
+|104002|The song playlist has reached its maximum capacity. Please remove existing songs before adding new ones.|
+|104003|The song playlist is empty.|
+|104004|The specified song does not exist.|
+|105001|The maximum number of speech recognitions for this room has been reached.|
+|105002|Unsupported language type.|
+|105003|The number of target translation languages has reached the maximum limit.|