npm - @tencentcloud/sdk-mcp - Versions diffs - 1.3.9 → 1.4.0 - Mend

@tencentcloud/sdk-mcp 1.3.9 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (510) hide show

package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-room-list.md RENAMED Viewed

@@ -1,8 +1,5 @@
 `LiveListStore` 是 `AtomicXCore` 中负责管理直播房间列表、创建、加入以及维护房间状态的核心模块。通过`LiveListStore`，开发者可以为应用构建完整的直播生命周期管理。
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032457995/1486fac1df3611f0a4f35254007c27c5.png)
 ## 核心功能
 - **直播列表拉取**：获取当前所有公开的直播间列表，支持分页加载。
@@ -14,58 +11,21 @@
 - **自定义业务数据**：强大的自定义元数据（`MetaData`）能力，允许您在房间内存储和同步任何业务相关的信息，例如直播状态、音乐信息、自定义角色等。
 ## 核心概念
 在开始集成之前，下表介绍了 `LiveListStore` 相关的核心概念：
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >**核心概念**</td>
-<td rowspan="1" colSpan="1" >**类型**</td>
-<td rowspan="1" colSpan="1" >**核心职责与描述**</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >[LiveInfo](https://tencent-rtc.github.io/TUIKit_Flutter/api_live_live_list_store/LiveInfo-class.html)</td>
-<td rowspan="1" colSpan="1" >`class`</td>
-<td rowspan="1" colSpan="1" >代表一个直播间的所有信息模型。包含了直播 ID (`liveID`)、名称 (`liveName`)、房主信息 (`liveOwner`) 以及自定义元数据 (`metaData`) 等。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >[LiveListState](https://tencent-rtc.github.io/TUIKit_Flutter/api_live_live_list_store/LiveListState-class.html)</td>
-<td rowspan="1" colSpan="1" >`class`</td>
-<td rowspan="1" colSpan="1" >代表直播列表模块的当前状态。其核心属性 `liveList` 是一个 `ValueListenable<List<LiveInfo>>` 类型，存储了拉取到的直播列表；`currentLive` 则代表用户当前所在的直播间信息。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >[LiveListListener](https://tencent-rtc.github.io/TUIKit_Flutter/api_live_live_list_store/LiveListListener-class.html)</td>
-<td rowspan="1" colSpan="1" >`class`</td>
-<td rowspan="1" colSpan="1" >代表直播房间的全局事件监听器。包含 `onLiveEnded` (直播结束) 和 `onKickedOutOfLive` (被踢出直播) 两种回调，用于处理关键的房间状态变更。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >[LiveListStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_live_live_list_store/LiveListStore-class.html)</td>
-<td rowspan="1" colSpan="1" >`class`</td>
-<td rowspan="1" colSpan="1" >这是与直播列表和房间生命周期交互的核心管理类。它是一个全局单例 (`shared`)，负责所有直播房间的创建、加入、信息更新等操作。</td>
-</tr>
-</table>
+| **核心概念** | **类型** | **核心职责与描述** |
+| --- | --- | --- |
+| [LiveInfo](https://tencent-rtc.github.io/TUIKit_Flutter/api_live_live_list_store/LiveInfo-class.html) | `class` | 代表一个直播间的所有信息模型。包含了直播 ID (`liveID`)、名称 (`liveName`)、房主信息 (`liveOwner`) 以及自定义元数据 (`metaData`) 等。 |
+| [LiveListState](https://tencent-rtc.github.io/TUIKit_Flutter/api_live_live_list_store/LiveListState-class.html) | `class` | 代表直播列表模块的当前状态。其核心属性 `liveList` 是一个 `ValueListenable<List<LiveInfo>>` 类型，存储了拉取到的直播列表；`currentLive` 则代表用户当前所在的直播间信息。 |
+| [LiveListListener](https://tencent-rtc.github.io/TUIKit_Flutter/api_live_live_list_store/LiveListListener-class.html) | `class` | 代表直播房间的全局事件监听器。包含 `onLiveEnded` (直播结束) 和 `onKickedOutOfLive` (被踢出直播) 两种回调，用于处理关键的房间状态变更。 |
+| [LiveListStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_live_live_list_store/LiveListStore-class.html) | `class` | 这是与直播列表和房间生命周期交互的核心管理类。它是一个全局单例 (`shared`)，负责所有直播房间的创建、加入、信息更新等操作。 |
 ## 实现步骤
 ### 步骤1：组件集成
-参考 [快速接入](https://write.woa.com/document/197478016886185984) 集成 **AtomicXCore**，并完成 [构建基础语聊房应用](https://write.woa.com/document/197478016886185984) 的功能实现。
+参考 快速接入 集成 **AtomicXCore**，并完成 构建基础语聊房应用 的功能实现。
 ### 步骤2：实现观众从直播列表进入直播间
@@ -74,7 +34,6 @@
 2. 当用户点击某个卡片时，获取该直播间的 `liveID`，并跳转到观众观看页面。
 #### 代码示例
 ``` java
 import 'package:flutter/material.dart';
@@ -332,80 +291,16 @@ class YourAudiencePage extends StatelessWidget {
 ```
 **LiveInfo 参数说明**
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >**参数名**</td>
-<td rowspan="1" colSpan="1" >**类型**</td>
-<td rowspan="1" colSpan="1" >**描述**</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`liveID`</td>
-<td rowspan="1" colSpan="1" >`String`</td>
-<td rowspan="1" colSpan="1" >直播间的唯一标识符</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`liveName`</td>
-<td rowspan="1" colSpan="1" >`String`</td>
-<td rowspan="1" colSpan="1" >直播间的标题</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`coverURL`</td>
-<td rowspan="1" colSpan="1" >`String`</td>
-<td rowspan="1" colSpan="1" >直播间的封面图片地址</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`liveOwner`</td>
-<td rowspan="1" colSpan="1" >`LiveUserInfo`</td>
-<td rowspan="1" colSpan="1" >房主的个人信息</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`totalViewerCount`</td>
-<td rowspan="1" colSpan="1" >`int`</td>
-<td rowspan="1" colSpan="1" >直播间的总观看人数</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`categoryList`</td>
-<td rowspan="1" colSpan="1" >`List<int>`</td>
-<td rowspan="1" colSpan="1" >直播间的分类标签列表</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`notice`</td>
-<td rowspan="1" colSpan="1" >`String`</td>
-<td rowspan="1" colSpan="1" >直播间的公告信息</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`metaData`</td>
-<td rowspan="1" colSpan="1" >`Map<String, String>`</td>
-<td rowspan="1" colSpan="1" >开发者自定义的元数据，用于实现复杂的业务场景</td>
-</tr>
-</table>
+| **参数名** | **类型** | **描述** |
+| --- | --- | --- |
+| `liveID` | `String` | 直播间的唯一标识符 |
+| `liveName` | `String` | 直播间的标题 |
+| `coverURL` | `String` | 直播间的封面图片地址 |
+| `liveOwner` | `LiveUserInfo` | 房主的个人信息 |
+| `totalViewerCount` | `int` | 直播间的总观看人数 |
+| `categoryList` | `List<int>` | 直播间的分类标签列表 |
+| `notice` | `String` | 直播间的公告信息 |
+| `metaData` | `Map<String, String>` | 开发者自定义的元数据，用于实现复杂的业务场景 |
 ## 功能进阶
@@ -413,9 +308,6 @@ class YourAudiencePage extends StatelessWidget {
 在 App 的直播广场页，顶部设有“热门”、“音乐”、“游戏”等分类标签。用户点击不同的标签后，下方的直播列表会动态筛选，只展示对应分类的直播间，从而帮助用户快速发现感兴趣的内容。
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032457995/48a37652df3611f08304525400454e06.png)
 #### 实现方式
 核心是利用 `LiveInfo` 模型中的 `categoryList` 属性。
@@ -423,7 +315,6 @@ class YourAudiencePage extends StatelessWidget {
 2. 您的 App 在获取到完整的直播列表后，只需在客户端根据用户选择的分类，对这个列表进行一次简单的筛选，然后刷新 UI 即可。
 #### 代码示例
 以下示例展示了如何创建一个 `LiveListManager` 来处理数据和筛选逻辑。
@@ -440,7 +331,7 @@ class LiveListManager extends ChangeNotifier {
   List<LiveInfo> get filteredLiveList => _filteredLiveList;
   int? get selectedCategoryId => _selectedCategoryId;
   late final VoidCallback _liveListListener = _onLiveListChanged;
   LiveListManager() {
@@ -619,7 +510,6 @@ class _CategoryLiveListPageState extends State<CategoryLiveListPage> {
 2. 观众端只需订阅 `LiveListState.currentLive`，监听 `metaData` 的变化，一旦发现关心的 key 更新，就解析其 value 并刷新业务状态。
 #### 代码示例
 ``` java
 import 'dart:convert';
@@ -754,24 +644,9 @@ class _AudienceMusicWidgetState extends State<AudienceMusicWidget> {
 ## API 文档
 关于 [LiveListStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_live_live_list_store/LiveListStore-class.html) 及其相关类的所有公开接口、属性和方法的详细信息，请参考 [AtomicXCore](https://tencent-rtc.github.io/TUIKit_Flutter) 框架的官方 API 文档。本文档使用到的相关 Store 如下：
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >**Store/Component**</td>
-<td rowspan="1" colSpan="1" >**功能描述**</td>
-<td rowspan="1" colSpan="1" >**API 文档**</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >LiveListStore</td>
-<td rowspan="1" colSpan="1" >直播间全生命周期管理：创建 / 加入 / 离开 / 销毁房间，查询房间列表，修改直播信息（名称、公告等），监听直播状态（例如被踢出、结束）。</td>
-<td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_Flutter/api_live_live_list_store/LiveListStore-class.html)</td>
-</tr>
-</table>
+| **Store/Component** | **功能描述** | **API 文档** |
+| --- | --- | --- |
+| LiveListStore | 直播间全生命周期管理：创建 / 加入 / 离开 / 销毁房间，查询房间列表，修改直播信息（名称、公告等），监听直播状态（例如被踢出、结束）。 | [API 文档](https://tencent-rtc.github.io/TUIKit_Flutter/api_live_live_list_store/LiveListStore-class.html) |
 ## 常见问题
@@ -787,10 +662,9 @@ class _AudienceMusicWidgetState extends State<AudienceMusicWidget> {
 **方式一（推荐）：使用 seatLayoutTemplateID 区分**
-这是一个用于定义房间布局的模板 ID，关于目前已支持的模板 ID 和效果，请参考文档 [开始直播-运行效果](https://write.woa.com/document/197478016886185984)。您要在创建房间时指定 ID，然后在获取列表时根据 ID 范围来识别业务场景。
+这是一个用于定义房间布局的模板 ID，关于目前已支持的模板 ID 和效果，请参考文档 开始直播-运行效果。您要在创建房间时指定 ID，然后在获取列表时根据 ID 范围来识别业务场景。
 - **步骤1：创建房间时指定 ID**
    调用 `LiveListStore.shared.createLive` 时，您需要根据业务场景为 `LiveInfo` 的 `seatLayoutTemplateID` 属性传入指定范围的 ID：
   - 语聊房场景：传入 1-199 范围内的模板 ID。
@@ -799,33 +673,26 @@ class _AudienceMusicWidgetState extends State<AudienceMusicWidget> {
 - **步骤2：获取列表时筛选**
    客户端在 `liveState.liveList` 中收到列表数据后，通过判断这个 ID 值所属的范围来区分，从而在进入直播间的时候区分两种业务场景。
    > **重要提示：**
-   >
+   >
    > 创建房间时，如果传入的 `seatLayoutTemplateID` 范围与您的业务场景（语聊房、视频直播）不匹配，可能会导致麦位布局出现功能异常。
-   >
+   >
    **方式二：为 **`liveID`** 添加业务前缀**
    这是一种可选的、纯粹的应用层约定，用于辅助您在客户端快速筛选。
 - **步骤1：创建房间时添加前缀**
    在您生成 `liveID` 并调用 `createLive` 时，为不同业务类型的 `liveID` 赋予不同的前缀。例如：视频直播的 ID 以 “Live_” 开头 (例如：Live_12345)，语聊房的 ID 以 “voice_” 开头 (例如：voice_67890)。
 - **步骤2：获取列表时检查前缀**
    客户端在拉取到列表后，通过检查 `liveID` 字符串的前缀来进行区分。
 ### 使用 `updateLiveMetaData` 注意事项
 为了保证系统的稳定和高效，`metaData` 的使用遵循以下规则：

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

@@ -1,8 +1,5 @@
 `LiveAudienceStore` 是 `AtomicXCore` 中专门负责管理直播间观众信息的模块。通过 `LiveAudienceStore`，您可以为您的直播应用构建一套完整的观众列表及管理系统。
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182232/5899241bb63f11f0a6c652540044a08e.png)
 ## 核心功能
 - **实时观众列表**：获取并展示当前在直播间内的所有观众信息。
@@ -14,72 +11,35 @@
 - **房间管理**：主播或管理员可以将任意普通观众请出（踢出）直播间。
 ## 核心概念
 在开始集成之前，我们先通过下表了解一下 LiveAudienceStore 相关的几个核心概念：
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >**核心概念**</td>
-<td rowspan="1" colSpan="1" >**类型**</td>
-<td rowspan="1" colSpan="1" >**核心职责与描述**</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`LiveUserInfo`</td>
-<td rowspan="1" colSpan="1" >struct</td>
-<td rowspan="1" colSpan="1" >代表一个观众（用户）的基础信息模型。它包含了用户的唯一标识 (`userID`)、昵称 (`userName`) 和头像地址 (`avatarURL`)。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`LiveAudienceState`</td>
-<td rowspan="1" colSpan="1" >struct</td>
-<td rowspan="1" colSpan="1" >代表观众模块的当前状态。其核心属性 `audienceList` 是一个 `[LiveUserInfo] `数组，存储了观众列表的快照；`audienceCount` 则代表当前观众总数。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`LiveAudienceEvent`</td>
-<td rowspan="1" colSpan="1" >enum</td>
-<td rowspan="1" colSpan="1" >代表观众动态的实时事件。分为 `.onAudienceJoined`（观众加入） 和 `.onAudienceLeft`（观众离开）两种，用于实现对观众列表的增量更新。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`LiveAudienceStore`</td>
-<td rowspan="1" colSpan="1" >class</td>
-<td rowspan="1" colSpan="1" >这是与观众列表功能交互的核心管理类。通过它，您可以获取观众列表快照、执行管理操作，并通过订阅其 `liveAudienceEventPublisher` 来接收实时动态。</td>
-</tr>
-</table>
+| **核心概念** | **类型** | **核心职责与描述** |
+| --- | --- | --- |
+| `LiveUserInfo` | struct | 代表一个观众（用户）的基础信息模型。它包含了用户的唯一标识 (`userID`)、昵称 (`userName`) 和头像地址 (`avatarURL`)。 |
+| `LiveAudienceState` | struct | 代表观众模块的当前状态。其核心属性 `audienceList` 是一个 `[LiveUserInfo] `数组，存储了观众列表的快照；`audienceCount` 则代表当前观众总数。 |
+| `LiveAudienceEvent` | enum | 代表观众动态的实时事件。分为 `.onAudienceJoined`（观众加入） 和 `.onAudienceLeft`（观众离开）两种，用于实现对观众列表的增量更新。 |
+| `LiveAudienceStore` | class | 这是与观众列表功能交互的核心管理类。通过它，您可以获取观众列表快照、执行管理操作，并通过订阅其 `liveAudienceEventPublisher` 来接收实时动态。 |
 ## 实现步骤
 ### 步骤1：组件集成
-请参考 [开始直播](https://write.woa.com/document/192834898445422592) 集成 **AtomicXCore**，完成接入。
+请参考 开始直播 集成 **AtomicXCore**，完成接入。
 ### 步骤2：初始化并获取观众列表
 获取一个与当前直播间 liveId 绑定的 `LiveAudienceStore` 实例，并主动拉取一次当前的观众列表，用于首次展示。
 ``` swift
 import Foundation
-import AtomicXCore
-import Combine
+import AtomicXCore
+import Combine
 class AudienceManager {
     private let liveId: String
     private let audienceStore: LiveAudienceStore
     private var cancellables = Set<AnyCancellable>()
     // 对外暴露【全量】观众列表的发布者，方便UI层订阅
     let audienceListPublisher = CurrentValueSubject<[LiveUserInfo], Never>([])
     // 对外暴露观众总数的发布者
@@ -89,11 +49,11 @@ class AudienceManager {
         self.liveId = liveId
         // 1. 通过 liveId 获取 LiveAudienceStore 的实例
         self.audienceStore = LiveAudienceStore.create(liveID: liveId)
         // 2. 订阅状态和事件
         subscribeToAudienceState()
         subscribeToAudienceEvents()
         // 3. 主动拉取首屏数据
         fetchInitialAudienceList()
     }
@@ -110,7 +70,7 @@ class AudienceManager {
             }
         }
     }
     // ... 后续代码
 }
 ```
@@ -140,9 +100,9 @@ extension AudienceManager {
             .receive(on: DispatchQueue.main)
             .sink { [weak self] event in
                 guard let self = self else { return }
                 var currentList = self.audienceListPublisher.value
                 switch event {
                 case .onAudienceJoined(let newAudience):
                     print("观众 \(newAudience.userName) 加入了直播间")
@@ -151,7 +111,7 @@ extension AudienceManager {
                         currentList.append(newAudience)
                         self.audienceListPublisher.send(currentList)
                     }
                 case .onAudienceLeft(let departedAudience):
                     print("观众 \(departedAudience.userName) 离开了直播间")
                     // 增量更新：从当前列表中移除离开的观众
@@ -223,7 +183,7 @@ extension AudienceManager {
 我们通过订阅 `LiveAudienceStore` 的观众加入事件（`LiveAudienceEvent.onAudienceJoined`）来获取新观众加入的实时通知。一旦事件触发，我们便提取出新观众的昵称信息，然后立即调用 `BarrageStore` 的本地插入接口 `appendLocalTip`。
 ``` swift
 import Foundation
-import AtomicXCore
+import AtomicXCore
 import Combine
 class LiveRoomManager {
@@ -260,7 +220,7 @@ class LiveRoomManager {
                 // 5. 创建一条本地提示消息
                 var welcomeTip = Barrage()
-                welcomeTip.messageType = .text
+                welcomeTip.messageType = .text
                 welcomeTip.textContent = "欢迎 \(newAudience.userName) 进入直播间！"
                 // 6. 调用 BarrageStore 的接口将其插入弹幕列表
@@ -274,40 +234,11 @@ class LiveRoomManager {
 ## API 文档
 关于 [LiveAudienceStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveaudiencestore) 及其相关类的所有公开接口、属性和方法的详细信息，请参阅随 [AtomicXCore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore) 框架的官方 API 文档。本文档使用到的相关 Store 如下：
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >Store/Component</td>
-<td rowspan="1" colSpan="1" >功能描述</td>
-<td rowspan="1" colSpan="1" >API 文档</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >LiveCoreView</td>
-<td rowspan="1" colSpan="1" >直播视频流展示与交互的核心视图组件：负责视频流渲染和视图挂件处理，支持主播直播、观众连麦、主播连线等场景。</td>
-<td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/livecoreview)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >LiveAudienceStore</td>
-<td rowspan="1" colSpan="1" >观众管理：获取实时观众列表（ID / 名称 / 头像），统计观众数量，监听观众进出事件。</td>
-<td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveaudiencestore)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >BarrageStore</td>
-<td rowspan="1" colSpan="1" >弹幕功能：发送文本 / 自定义弹幕，维护弹幕列表，实时监听弹幕状态。</td>
-<td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore)</td>
-</tr>
-</table>
+| Store/Component | 功能描述 | API 文档 |
+| --- | --- | --- |
+| LiveCoreView | 直播视频流展示与交互的核心视图组件：负责视频流渲染和视图挂件处理，支持主播直播、观众连麦、主播连线等场景。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/livecoreview) |
+| LiveAudienceStore | 观众管理：获取实时观众列表（ID / 名称 / 头像），统计观众数量，监听观众进出事件。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveaudiencestore) |
+| BarrageStore | 弹幕功能：发送文本 / 自定义弹幕，维护弹幕列表，实时监听弹幕状态。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore) |
 ## 常见问题
@@ -326,10 +257,6 @@ class LiveRoomManager {
   - **关键点：**在“弹幕风暴”或礼物刷屏等消息流量极高的场景下，如果房间内的消息速率超过了 40条/秒 的阈值，为了保证核心消息（如弹幕）的送达，**人数变更的消息可能会被频控策略丢弃**。
       **这对开发者意味着什么？**
       `audienceCount` 是一个非常接近实时的**高精度估算值**，但在极端高并发场景下，它可能存在短暂的延迟或数据丢失。因此，我们建议您将其用于 **UI 展示**，而不应作为计费、统计等需要绝对精准场景的唯一依据。