@tencentcloud/sdk-mcp 1.3.9 → 1.4.1

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

@@ -1,8 +1,5 @@
 `LiveListStore` 是 `AtomicXCore` 中负责管理直播房间列表、创建、加入以及维护房间状态的核心模块。通过`LiveListStore`，您可以为您的应用构建完整的直播生命周期管理。
 
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032457995/430c21d1df2b11f0a4f35254007c27c5.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/191126413785100288) 集成 **AtomicXCore**，并完成 [主播开播](https://write.woa.com/document/191126413785100288) 和 [观众观看](https://write.woa.com/document/191126413785100288) 的功能实现。
+请参考 开始直播 集成 **AtomicXCore**，并完成 主播开播 和 观众观看 的功能实现。
 
 ### 步骤2：观众进入直播间实现
 
@@ -325,80 +285,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>` | 开发者自定义的元数据，用于实现复杂的业务场景 |
 
 ## 功能进阶
 
@@ -406,9 +302,6 @@ class YourAudiencePage extends StatelessWidget {
 
 在 App 的直播广场页，顶部设有"热门"、"音乐"、"游戏"等分类标签。用户点击不同的标签后，下方的直播列表会动态筛选，只展示对应分类的直播间，从而帮助用户快速发现感兴趣的内容。
 
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032457995/aecbc0cfdf2b11f0a38652540044a08e.png)
-
-
 #### 实现方式
 
 核心是利用 `LiveInfo` 模型中的 `categoryList` 属性。当主播开播设置分类后，`fetchLiveList` 返回的 `LiveInfo` 对象中就会包含这些分类信息。您的 App 在获取到完整的直播列表后，只需在客户端根据用户选择的分类，对这个列表进行一次简单的筛选，然后刷新 UI 即可。
@@ -602,9 +495,6 @@ class _CategoryLiveListPageState extends State<CategoryLiveListPage> {
 
 在电商直播中，主播正在讲解一款商品。此时，所有观众的直播画面下方都会弹出一张商品卡片，实时展示该商品的图片、名称和价格。当主播切换讲解下一件商品时，所有观众端的卡片都会自动、同步更新。
 
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032457995/7757e4eddf2c11f08a7a52540099c741.png)
-
-
 #### 实现方式
 
 主播端将当前商品的结构化信息（建议使用 **JSON** 格式）通过 `updateLiveMetaData` 接口设置到一个自定义的 key（例如 "`product_info`"）中。**AtomicXCore** 会将这个变更实时同步给所有观众。观众端只需订阅 `LiveListState.currentLive`，监听 `metaData` 的变化，一旦发现 `product_info` 的值更新，就解析其中的 JSON 数据并刷新商品卡片 UI。
@@ -808,40 +698,11 @@ class _ProductCardWidgetState extends State<ProductCardWidget> {
 ## 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/index.html) 框架的官方 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" >**LiveCoreWidget**</td>
-
-<td rowspan="1" colSpan="1" >直播视频流展示与交互的核心视图组件：负责视频流渲染和视图挂件处理，支持主播直播、观众连麦、主播连线等场景。</td>
-
-<td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_Flutter/api_view_live_live_core_widget/LiveCoreWidget-class.html)</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >**LiveCoreController**</td>
-
-<td rowspan="1" colSpan="1" >LiveCoreWidget 的控制器：用于设置直播 ID、控制预览等操作。</td>
-
-<td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_Flutter/api_view_live_live_core_widget/LiveCoreController-class.html)</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 文档** |
+| --- | --- | --- |
+| **LiveCoreWidget** | 直播视频流展示与交互的核心视图组件：负责视频流渲染和视图挂件处理，支持主播直播、观众连麦、主播连线等场景。 | [API 文档](https://tencent-rtc.github.io/TUIKit_Flutter/api_view_live_live_core_widget/LiveCoreWidget-class.html) |
+| **LiveCoreController** | LiveCoreWidget 的控制器：用于设置直播 ID、控制预览等操作。 | [API 文档](https://tencent-rtc.github.io/TUIKit_Flutter/api_view_live_live_core_widget/LiveCoreController-class.html) |
+| **LiveListStore** | 直播间全生命周期管理：创建 / 加入 / 离开 / 销毁房间，查询房间列表，修改直播信息（名称、公告等），监听直播状态（例如被踢出、结束）。 | [API 文档](https://tencent-rtc.github.io/TUIKit_Flutter/api_live_live_list_store/LiveListStore-class.html) |
 
 ## 常见问题
 

package/resource/doc/livekit/core-sdk/live/ios/api-reference/AudioEffectStore.md

@@ -0,0 +1,287 @@
+## 简介
+
+**AudioEffectStore** 提供了一套完整的音效管理 API，包括变声效果、混响效果和耳返功能。
+通过该类，主播可以在直播过程中实时调整自己的声音效果，提升直播体验。
+
+> **重要：**
+>
+
+> 使用 **shared** 单例获取 **AudioEffectStore** 实例。设置的音效在退出房间后会自动失效，下次进房需要重新设置。
+>
+
+> **说明：**
+>
+
+> 音效状态更新通过 **state** 发布者传递。订阅它以接收有关变声、混响和耳返状态的实时更新。
+>
+
+> **警告：**
+>
+
+> 由于蓝牙耳机的硬件延迟非常高，在主播佩戴蓝牙耳机时无法开启耳返功能。请在用户界面上提示主播佩戴有线耳机。
+>
+
+## 功能特性
+- **变声效果**：支持多种变声特效，如熊孩子、小女孩、大叔等。
+
+- **混响效果**：支持多种混响特效，如KTV、小房间、大会堂等。
+
+- **耳返功能**：主播可在耳机中听到自己的声音，适用于唱歌场景。
+
+- **音量控制**：支持耳返音量的精细调节。
+
+## 可订阅数据
+
+**AudioEffectState** 的字段描述如下：
+| **属性名** | **类型** | **描述** |
+| --- | --- | --- |
+| audioChangerType | AudioChangerType | 变声状态。 |
+| audioReverbType | AudioReverbType | 混响状态。 |
+| isEarMonitorOpened | Bool | 耳返开启。 |
+| earMonitorVolume | Int | 耳返音量，取值范围 0 - 100。<br>如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。 |
+
+## API 列表
+| **函数名** | **描述** |
+| --- | --- |
+| shared | 获取单例实例。 |
+| setAudioChangerType | 设置变声效果。 |
+| setAudioReverbType | 设置混响效果。 |
+| setVoiceEarMonitorEnable | 开启/关闭耳返。 |
+| setVoiceEarMonitorVolume | 设置耳返音量。 |
+| reset | 重置为默认状态。 |
+
+### 获取实例
+
+#### shared
+
+获取单例实例。
+
+### 变声设置
+
+#### setAudioChangerType
+
+设置变声效果
+``` swift
+public func setAudioChangerType(type: AudioChangerType) {
+    fatalError("\(#function) must be overridden by subclass")
+}
+```
+
+通过该接口您可以设置人声的变声特效。
+
+变声特效可以作用于人声之上，通过声学算法对人声进行二次处理，以获得与原始声音所不同的音色。
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**调用时机**
+
+进入房间后，且需要使用变声效果时调用。
+
+**注意事项**
+
+> **说明：**
+>
+
+> 设置的效果在退出房间后会自动失效，如果下次进房还需要对应特效，需要调用此接口再次进行设置。
+>
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| type | AudioChangerType | 必填 | 变声效果类型。 |
+
+### 混响设置
+
+#### setAudioReverbType
+
+设置混响效果
+``` swift
+public func setAudioReverbType(type: AudioReverbType) {
+    fatalError("\(#function) must be overridden by subclass")
+}
+```
+
+通过该接口您可以设置人声的混响效果。
+
+混响特效可以作用于人声之上，通过声学算法对声音进行叠加处理，模拟出各种不同环境下的临场感受。
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**调用时机**
+
+进入房间后，且需要使用混响效果时调用。
+
+**注意事项**
+
+> **说明：**
+>
+
+> 设置的效果在退出房间后会自动失效，如果下次进房还需要对应特效，需要调用此接口再次进行设置。
+>
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| type | AudioReverbType | 必填 | 混响效果类型。 |
+
+### 耳返设置
+
+#### setVoiceEarMonitorEnable
+
+开启/关闭耳返
+``` swift
+public func setVoiceEarMonitorEnable(enable: Bool) {
+    fatalError("\(#function) must be overridden by subclass")
+}
+```
+
+主播开启耳返后，可以在耳机里听到麦克风采集到的自己发出的声音，该特效适用于主播唱歌的应用场景中。
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**适用场景**
+
+适用于主播唱歌场景，让主播能够实时听到自己的声音以便调整演唱效果。
+
+**调用时机**
+
+进入房间后，且主播佩戴有线耳机时调用。
+
+**注意事项**
+
+> **警告：**
+>
+
+> 由于蓝牙耳机的硬件延迟非常高，所以在主播佩戴蓝牙耳机时无法开启此特效，请尽量在用户界面上提示主播佩戴有线耳机。
+>
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| enable | Bool | 必填 | 是否开启耳返。 |
+
+#### setVoiceEarMonitorVolume
+
+设置耳返音量
+``` swift
+public func setVoiceEarMonitorVolume(volume: Int) {
+    fatalError("\(#function) must be overridden by subclass")
+}
+```
+
+通过该接口您可以设置耳返特效中声音的音量大小。
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**调用时机**
+
+开启耳返功能后调用。
+
+**注意事项**
+
+> **说明：**
+>
+
+> 如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。
+>
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| volume | Int | 必填 | 耳返音量。（取值范围：0 - 100（超过 100 可能导致爆音））（默认值：100）。 |
+
+### 重置
+
+#### reset
+
+重置为默认状态
+``` swift
+public func reset() {
+    fatalError("\(#function) must be overridden by subclass")
+}
+```
+
+将所有音效设置重置为默认值，包括关闭变声效果、关闭混响效果、关闭耳返并重置耳返音量。
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**调用时机**
+
+需要恢复默认音效设置时调用，例如退出直播间前。
+
+## 数据结构
+
+### AudioChangerType
+
+变声效果类型。
+| **枚举值** | **值** | **说明** |
+| --- | --- | --- |
+| none | 0 | 关闭特效。 |
+| child | 1 | 熊孩子。 |
+| littleGirl | 2 | 小女孩。 |
+| man | 3 | 大叔。 |
+| heavyMetal | 4 | 重金属。 |
+| cold | 5 | 感冒。 |
+| foreigner | 6 | 外语腔。 |
+| trappedBeast | 7 | 困兽。 |
+| fatso | 8 | 肥宅。 |
+| strongCurrent | 9 | 强电流。 |
+| heavyMachinery | 10 | 重机械。 |
+| ethereal | 11 | 空灵。 |
+
+### AudioReverbType
+
+混响效果类型。
+| **枚举值** | **值** | **说明** |
+| --- | --- | --- |
+| none | 0 | 关闭特效。 |
+| ktv | 1 | KTV。 |
+| smallRoom | 2 | 小房间。 |
+| auditorium | 3 | 大会堂。 |
+| deep | 4 | 低沉。 |
+| loud | 5 | 洪亮。 |
+| metallic | 6 | 金属声。 |
+| magnetic | 7 | 磁性。 |
+
+### AudioEffectState
+
+AudioEffectStore 对外提供的音效相关状态数据。
+| **属性** | **类型** | **说明** |
+| --- | --- | --- |
+| audioChangerType | AudioChangerType | 变声状态。 |
+| audioReverbType | AudioReverbType | 混响状态。 |
+| isEarMonitorOpened | Bool | 耳返开启。 |
+| earMonitorVolume | Int | 耳返音量，取值范围 0 - 100。<br>如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。 |
+
+## 使用示例
+``` swift
+// 获取单例实例
+let store = AudioEffectStore.shared
+
+// 订阅状态变化
+store.state.subscribe { state in
+    print("当前变声效果: \(state.audioChangerType)")
+    print("当前混响效果: \(state.audioReverbType)")
+    print("耳返开启: \(state.isEarMonitorOpened)")
+}
+
+// 设置变声效果
+store.setAudioChangerType(type: .littleGirl)
+
+// 设置混响效果
+store.setAudioReverbType(type: .ktv)
+
+// 开启耳返
+store.setVoiceEarMonitorEnable(enable: true)
+store.setVoiceEarMonitorVolume(volume: 80)
+```

package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md

@@ -0,0 +1,165 @@
+## 简介
+
+**BarrageStore** 提供了一套完整的弹幕管理 API，包括发送文本弹幕、发送自定义弹幕和添加本地提示消息。
+通过该类，可以在直播间内实现弹幕互动功能。
+
+> **重要：**
+>
+
+> 使用 **create(liveID:)** 工厂方法创建 **BarrageStore** 实例，需要传入有效的直播间 ID。
+>
+
+> **说明：**
+>
+
+> 弹幕状态更新通过 **state** 发布者传递。订阅它以接收房间内弹幕数据的实时更新。
+>
+
+## 功能特性
+- **文本弹幕**：支持发送纯文本弹幕消息。
+
+- **自定义弹幕**：支持发送自定义格式的弹幕（如带特效的弹幕）。
+
+- **本地提示**：支持添加仅本地可见的提示消息。
+
+## 可订阅数据
+
+**BarrageState** 的字段描述如下：
+| **属性名** | **类型** | **描述** |
+| --- | --- | --- |
+| messageList | [Barrage] | 当前房间的弹幕消息列表，支持实时更新并可被订阅监听。 |
+
+## API 列表
+| **函数名** | **描述** |
+| --- | --- |
+| create | 创建弹幕管理实例。 |
+| sendTextMessage | 发送文本弹幕。 |
+| sendCustomMessage | 发送自定义弹幕。 |
+| appendLocalTip | 添加本地提示消息。 |
+
+### 创建实例
+
+#### create
+
+弹幕管理核心类，用于处理直播间/语音聊天房内的弹幕相关业务逻辑。
+``` swift
+public static func create(liveID: String) -> BarrageStore {
+    let store: BarrageStoreImpl = StoreFactory.shared.getStore(liveId: liveID)
+    return store
+}
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| liveID | String | 必填 | 直播间ID。 |
+
+### 发送弹幕
+
+#### sendTextMessage
+
+发送文本类型弹幕。
+``` swift
+public func sendTextMessage(text: String,
+                            extensionInfo: [String: String]?,
+                            completion: CompletionClosure?) {
+    fatalError("\(#function) must be overridden by subclass")
+}
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| text | String | 必填 | 文本弹幕内容。 |
+| extensionInfo | [String:String]? | 必填 | 扩展信息，可包含自定义字段（如指定弹幕颜色、字体大小等）。 |
+| completion | CompletionClosure? | 必填 | 完成回调（成功/失败状态）。 |
+
+#### sendCustomMessage
+
+发送自定义类型弹幕。
+``` swift
+public func sendCustomMessage(businessID: String,
+                              data: String,
+                              completion: CompletionClosure?) {
+    fatalError("\(#function) must be overridden by subclass")
+}
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| businessID | String | 必填 | 业务标识ID，用于区分不同业务场景的自定义弹幕。 |
+| data | String | 必填 | 自定义数据内容，通常为JSON格式字符串，用于传递业务自定义的数据。 |
+| completion | CompletionClosure? | 必填 | 完成回调（成功/失败状态）。 |
+
+### 本地消息
+
+#### appendLocalTip
+
+添加本地提示消息（在本地添加提示或操作反馈消息，仅当前客户端可见）。
+``` swift
+public func appendLocalTip(message: Barrage) {
+    fatalError("\(#function) must be overridden by subclass")
+}
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**注意事项**
+
+> **说明：**
+>
+
+> 该消息仅在本地显示，不会通过网络发送给其他用户。
+>
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| message | Barrage | 必填 | 本地弹幕消息（如系统提示、操作反馈等，仅当前用户可见）。 |
+
+## 数据结构
+
+### BarrageType
+
+弹幕类型枚举，用于区分不同的弹幕消息种类。
+| **枚举值** | **值** | **说明** |
+| --- | --- | --- |
+| text | 0 | 文本类型弹幕，包含纯文字内容。 |
+| custom | 1 | 自定义类型弹幕，支持业务自定义数据格式（如带特效的弹幕、互动消息等）。 |
+
+### Barrage
+
+弹幕数据模型，包含单条弹幕的完整属性信息。
+| **属性** | **类型** | **说明** |
+| --- | --- | --- |
+| liveID | String | 弹幕所属直播间/语音聊天房的唯一标识ID。 |
+| sender | LiveUserInfo | 弹幕发送者的用户信息（如用户ID、昵称、头像等）。 |
+| sequence | Int | 弹幕消息的唯一序列ID，用于消息排序和去重。 |
+| timestampInSecond | TimeInterval | 弹幕发送时间戳（单位：秒），用于展示发送时间顺序。 |
+| messageType | BarrageType | 弹幕消息类型（文本或自定义）。 |
+| textContent | String | 文本类型弹幕的消息内容，即弹幕的文本内容。 |
+| extensionInfo | [String:String]? | 弹幕扩展信息，可自定义字段（如显示样式、优先级等）。当 messageType 为 TEXT 时有效。 |
+| businessID | String | 自定义类型弹幕的业务标识ID，用于区分不同业务场景的自定义弹幕。 |
+| data | String | 自定义类型弹幕的具体数据内容（通常为JSON格式字符串），当 messageType 为 CUSTOM 时有效。 |
+
+### BarrageState
+
+弹幕状态，管理当前房间的弹幕数据状态。
+| **属性** | **类型** | **说明** |
+| --- | --- | --- |
+| messageList | [Barrage] | 当前房间的弹幕消息列表，支持实时更新并可被订阅监听。 |