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}/uni-app/voice-gift.md RENAMED Viewed

@@ -1,22 +1,7 @@
 `GiftState` 是 `AtomicXCore` 中专门负责管理直播间礼物功能的模块。通过它，您可以为您的直播应用构建一套完整的礼物系统，实现丰富的营收和互动场景。
-<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" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100028028022/92743423bbbc11f0b4c35254001c06ec.png)</td>
-<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100028028022/98aa70f4bbbc11f0b4c35254001c06ec.png)</td>
-<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100028028022/9c60d5edbbbc11f085a55254007c27c5.png)</td>
-</tr>
-</table>
+| 礼物面板 | 弹幕礼物 | 全屏礼物 |
+| --- | --- | --- |
+|  |  |  |
 ## 核心功能
 - **礼物列表获取**：从服务端拉取礼物面板所需的数据，包括礼物分类和礼物详情。
@@ -25,21 +10,19 @@
 - **礼物事件广播**：实时接收房间内发生的礼物赠送事件，用于展示礼物动画和弹幕通知。
 ## 实现步骤
 ### 步骤1：组件集成
 > **说明：**
->
-> 使用**礼物系统**要求开通TUILiveKit **多人连麦版**、**大规模直播版**，不同套餐中可配置的礼物数量有所不同，详细参见 [功能与计费说明](https://write.woa.com/document/141302177829593088) 中的**礼物系统**说明。
->
+>
-- **视频直播**：请参考 [快速接入](https://write.woa.com/document/191127271985012736) 集成 **AtomicXCore**，完成接入。
+> 使用**礼物系统**要求开通TUILiveKit **多人连麦版**、**大规模直播版**，不同套餐中可配置的礼物数量有所不同，详细参见 功能与计费说明 中的**礼物系统**说明。
+>
-- **语聊房**：请参考 [快速接入](https://write.woa.com/document/191656297444069376) 集成 **AtomicXCore**，完成接入。
+- **视频直播**：请参考 快速接入 集成 **AtomicXCore**，完成接入。
+- **语聊房**：请参考 快速接入 集成 **AtomicXCore**，完成接入。
 ### 步骤2：初始化并监听礼物事件
@@ -52,7 +35,6 @@
 3. **监听状态**：监听 响应式数据`usableGifts `礼物列表，来驱动 `UI` 更新。
 #### 代码示例:
 ``` typescript
 import { useGiftState } from "@/uni_modules/tuikit-atomic-x/state/GiftState";
@@ -83,132 +65,26 @@ watch(usableGifts, (newVal, oldVal) => {
 #### 礼物列表结构体参数
 - `GiftCategory`**参数说明**
-<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" >`categoryID`</td>
-<td rowspan="1" colSpan="1" >`string`</td>
-<td rowspan="1" colSpan="1" >礼物分类的唯一 ID。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`name`</td>
-<td rowspan="1" colSpan="1" >`string`</td>
-<td rowspan="1" colSpan="1" >礼物分类的显示名称。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`desc`</td>
-<td rowspan="1" colSpan="1" >`string`</td>
-<td rowspan="1" colSpan="1" >礼物分类的描述信息。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`extensionInfo`</td>
-<td rowspan="1" colSpan="1" >`[string: string]`</td>
-<td rowspan="1" colSpan="1" >扩展信息字段。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`giftList`</td>
-<td rowspan="1" colSpan="1" >`[string]`</td>
-<td rowspan="1" colSpan="1" >该分类下包含的 Gift 礼物对象数组。</td>
-</tr>
-</table>
+| **参数** | **类型** | **描述** |
+| --- | --- | --- |
+| `categoryID` | `string` | 礼物分类的唯一 ID。 |
+| `name` | `string` | 礼物分类的显示名称。 |
+| `desc` | `string` | 礼物分类的描述信息。 |
+| `extensionInfo` | `[string: string]` | 扩展信息字段。 |
+| `giftList` | `[string]` | 该分类下包含的 Gift 礼物对象数组。 |
 - `Gift`** 参数说明**
-<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" >`giftID`</td>
-<td rowspan="1" colSpan="1" >`string`</td>
-<td rowspan="1" colSpan="1" >  礼物的唯一 ID。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`name`</td>
-<td rowspan="1" colSpan="1" >`string`</td>
-<td rowspan="1" colSpan="1" >  礼物的显示名称。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`desc`</td>
-<td rowspan="1" colSpan="1" >`string`</td>
-<td rowspan="1" colSpan="1" >  礼物的描述信息。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`iconURL`</td>
-<td rowspan="1" colSpan="1" >`string`</td>
-<td rowspan="1" colSpan="1" >  礼物图标 URL。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`resourceURL`</td>
-<td rowspan="1" colSpan="1" >`string`</td>
-<td rowspan="1" colSpan="1" >  礼物动画资源 URL。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`level`</td>
-<td rowspan="1" colSpan="1" >`number`</td>
-<td rowspan="1" colSpan="1" >  礼物等级。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`coins`</td>
-<td rowspan="1" colSpan="1" >`number`</td>
-<td rowspan="1" colSpan="1" >  礼物价格。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`extensionInfo`</td>
-<td rowspan="1" colSpan="1" >`[string: string]`</td>
-<td rowspan="1" colSpan="1" >  扩展信息字段。</td>
-</tr>
-</table>
+| **参数** | **类型** | **描述** |
+| --- | --- | --- |
+| `giftID` | `string` | 礼物的唯一 ID。 |
+| `name` | `string` | 礼物的显示名称。 |
+| `desc` | `string` | 礼物的描述信息。 |
+| `iconURL` | `string` | 礼物图标 URL。 |
+| `resourceURL` | `string` | 礼物动画资源 URL。 |
+| `level` | `number` | 礼物等级。 |
+| `coins` | `number` | 礼物价格。 |
+| `extensionInfo` | `[string: string]` | 扩展信息字段。 |
 ### 步骤3：获取礼物列表
@@ -221,7 +97,6 @@ watch(usableGifts, (newVal, oldVal) => {
 3. **接收数据**：拉取成功后，通过步骤二中对 `usableGifts` 的监听，自动接收到更新后的 `usableGifts` 列表。
 #### 代码示例:
 ``` typescript
 import { useGiftState } from "@/uni_modules/tuikit-atomic-x/state/GiftState";
@@ -235,7 +110,7 @@ const { addGiftListener, usableGifts } = useGiftState(liveID);
 onMounted(() => {
     refreshUsableGifts({
-      liveID: 'xxx', // 当前直播间的 liveID
+      liveID: 'xxx', // 当前直播间的 liveID
       success: () => {
         console.log('礼物列表拉取成功')
         // 成功后，state 响应式数据会自动更新
@@ -258,7 +133,6 @@ onMounted(() => {
 3. **处理回调**：在 `fail` 回调中处理发送失败的情况（例如余额不足提示）；发送成功后的 UI 更新（动画、弹幕）应由 `'onReceiveGift'` 事件驱动。
 #### 代码示例:
 ``` typescript
@@ -277,9 +151,9 @@ const sendGift = () => {
       giftID: giftID,
       count: 1,
       success: () => {
-        console.log('礼物 ${giftID} 发送成功')
+        console.log('礼物 ${giftID} 发送成功')
       },
-      fail: (error) => {
+      fail: (error) => {
         console.log('礼物发送失败', error)
         // 可以在此提示用户，例如“余额不足”或“网络错误”
       },
@@ -288,56 +162,13 @@ const sendGift = () => {
 ```
 #### `sendGift`接口参数
-<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" >当前直播间的`liveID`。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`giftID`</td>
-<td rowspan="1" colSpan="1" >`string`</td>
-<td rowspan="1" colSpan="1" >要发送的礼物的唯一 ID。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`count`</td>
-<td rowspan="1" colSpan="1" >`number`</td>
-<td rowspan="1" colSpan="1" >发送的数量。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`success`</td>
-<td rowspan="1" colSpan="1" >`Function`</td>
-<td rowspan="1" colSpan="1" >发送成功的回调。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`fail`</td>
-<td rowspan="1" colSpan="1" >`Function`</td>
-<td rowspan="1" colSpan="1" >发送失败的回调。</td>
-</tr>
-</table>
+| **参数名** | **类型** | **描述** |
+| --- | --- | --- |
+| `liveID` | `string` | 当前直播间的`liveID`。 |
+| `giftID` | `string` | 要发送的礼物的唯一 ID。 |
+| `count` | `number` | 发送的数量。 |
+| `success` | `Function` | 发送成功的回调。 |
+| `fail` | `Function` | 发送失败的回调。 |
 ## 功能进阶
@@ -354,128 +185,33 @@ const sendGift = () => {
 3. **UI 展示**：使用拉取到的 `[GiftCategory]` 数据填充礼物面板。
 #### **配置时序图**
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100028028022/bd9fcf8dbbbc11f0a808525400bf7822.png)
 #### **涉及 REST API 接口一览**
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >接口分类</td>
-<td rowspan="1" colSpan="1" >接口</td>
-<td rowspan="1" colSpan="1" >请求示例</td>
-</tr>
-<tr>
-<td rowspan="3" colSpan="1" >礼物管理</td>
-<td rowspan="1" colSpan="1" >添加礼物信息</td>
-<td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341527570997248)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >删除礼物信息</td>
-<td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341544133693440)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >查询礼物信息</td>
-<td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341539054186496)</td>
-</tr>
-<tr>
-<td rowspan="3" colSpan="1" >礼物分类管理</td>
-<td rowspan="1" colSpan="1" >添加礼物分类信息</td>
-<td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180807825764642816)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >删除指定礼物分类信息</td>
-<td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180807830209925120)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >获取指定礼物分类信息</td>
-<td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180807827909746688)</td>
-</tr>
-<tr>
-<td rowspan="3" colSpan="1" >礼物关系管理</td>
-<td rowspan="1" colSpan="1" >添加指定礼物分类和礼物间的关系</td>
-<td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341551420928000)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >删除指定礼物分类和礼物间的关系</td>
-<td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341562381627392)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >获取指定礼物分类下的礼物关系</td>
-<td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341571868094464)</td>
-</tr>
-<tr>
-<td rowspan="6" colSpan="1" >礼物多语言管理</td>
-<td rowspan="1" colSpan="1" >添加礼物多语言信息</td>
-<td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341579611611136)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >删除指定礼物多语言信息</td>
-<td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341598501920768)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >获取礼物多语言信息</td>
-<td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341588810166272)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >添加礼物分类多语言信息</td>
-<td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341603609534464)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >删除指定礼物分类多语言信息</td>
-<td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341624911425536)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >获取礼物分类多语言信息</td>
-<td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341612525645824)</td>
-</tr>
-</table>
+| 接口分类 | 接口 | 请求示例 |
+| --- | --- | --- |
+| 礼物管理 | 添加礼物信息 | 请求示例 |
+| 删除礼物信息 | 请求示例 |  |
+| 查询礼物信息 | 请求示例 |  |
+| 礼物分类管理 | 添加礼物分类信息 | 请求示例 |
+| 删除指定礼物分类信息 | 请求示例 |  |
+| 获取指定礼物分类信息 | 请求示例 |  |
+| 礼物关系管理 | 添加指定礼物分类和礼物间的关系 | 请求示例 |
+| 删除指定礼物分类和礼物间的关系 | 请求示例 |  |
+| 获取指定礼物分类下的礼物关系 | 请求示例 |  |
+| 礼物多语言管理 | 添加礼物多语言信息 | 请求示例 |
+| 删除指定礼物多语言信息 | 请求示例 |  |
+| 获取礼物多语言信息 | 请求示例 |  |
+| 添加礼物分类多语言信息 | 请求示例 |  |
+| 删除指定礼物分类多语言信息 | 请求示例 |  |
+| 获取礼物分类多语言信息 | 请求示例 |  |
 ### 计费与送礼扣费流程
 当观众赠送礼物时，需要确保其账户余额充足，并完成实际的扣费操作，然后才能触发礼物特效的播放和广播。
 #### 实现方式
-1. **后台配置回调**：在 LiveKit 后台配置您的自建计费系统的回调 URL。参考 [回调配置文档](https://write.woa.com/document/183772947196690432)。
+1. **后台配置回调**：在 LiveKit 后台配置您的自建计费系统的回调 URL。参考 回调配置文档。
 2. **客户端发送**：客户端调用 `sendGift`。
@@ -483,31 +219,12 @@ const sendGift = () => {
 4. **结果同步**：扣费成功，AtomicXCore 广播 `'onReceiveGift'` 事件。扣费失败，`sendGift` 的 `fail` 收到错误。
 #### 调用流程图
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100028028022/cb539aa9bbbc11f0a808525400bf7822.png)
 #### 涉及 REST API 接口一览
-<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" >回调配置 - 发送礼物之前回调</td>
-<td rowspan="1" colSpan="1" >客户后台可以通过该回调决定是否通过送礼前校验等场景</td>
-<td rowspan="1" colSpan="1" >[调用示例](https://write.woa.com/document/183772947196690432)</td>
-</tr>
-</table>
+| 接口 | 说明 | 请求示例 |
+| --- | --- | --- |
+| 回调配置 - 发送礼物之前回调 | 客户后台可以通过该回调决定是否通过送礼前校验等场景 | 调用示例 |
 ### 实现全屏礼物动画播放
@@ -516,56 +233,13 @@ const sendGift = () => {
 #### 实现方式
 `AtomicXCore` 本身包含礼物动画播放器，您可以根据业务需求选择并集成第三方库。以下是两种方案的对比：
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >**对比项**</td>
-<td rowspan="1" colSpan="1" >**内置方案 (SVGAPlayer)**</td>
-<td rowspan="1" colSpan="1" >**高级方案 (TCEffectPlayerKit)**</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >计费</td>
-<td rowspan="1" colSpan="1" >免费 </td>
-<td rowspan="1" colSpan="1" >付费 (需购买 License)，请参见 [付费指引](https://cloud.tencent.com/document/product/616/116461)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >集成方式</td>
-<td rowspan="1" colSpan="1" >AtomicXCore 内置</td>
-<td rowspan="1" colSpan="1" >需额外集成 TCEffectPlayerKit 并进行鉴权</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >动画格式支持</td>
-<td rowspan="1" colSpan="1" >仅支持 SVGA</td>
-<td rowspan="1" colSpan="1" >SVGA、PAG、WebP、Lottie、MP4 等多种格式</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >性能</td>
-<td rowspan="1" colSpan="1" >建议 SVGA 文件 ≤ 10MB</td>
-<td rowspan="1" colSpan="1" >支持更大的动画文件，复杂特效/多动画并发/低端机表现更优</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >推荐场景</td>
-<td rowspan="1" colSpan="1" >礼物动画格式统一为 SVGA，且文件大小可控</td>
-<td rowspan="1" colSpan="1" >需要支持多种动画格式，或对动画性能/设备兼容性有更高要求</td>
-</tr>
-</table>
+| **对比项** | **内置方案 (SVGAPlayer)** | **高级方案 (TCEffectPlayerKit)** |
+| --- | --- | --- |
+| 计费 | 免费 | 付费 (需购买 License)，请参见 [付费指引](https://cloud.tencent.com/document/product/616/116461) |
+| 集成方式 | AtomicXCore 内置 | 需额外集成 TCEffectPlayerKit 并进行鉴权 |
+| 动画格式支持 | 仅支持 SVGA | SVGA、PAG、WebP、Lottie、MP4 等多种格式 |
+| 性能 | 建议 SVGA 文件 ≤ 10MB | 支持更大的动画文件，复杂特效/多动画并发/低端机表现更优 |
+| 推荐场景 | 礼物动画格式统一为 SVGA，且文件大小可控 | 需要支持多种动画格式，或对动画性能/设备兼容性有更高要求 |
 本章节主要演示基础方案的集成。如果您选择高级方案，请参考 [TCEffectPlayer 集成指引](https://cloud.tencent.com/document/product/616/116474)。
@@ -579,7 +253,6 @@ const sendGift = () => {
 3. **解析并播放**：当收到 `'onReceiveGift'`事件时，检查 `gift.resourceURL`是否有效且指向一个 SVGA 文件。如果是，则将`gift.resourceURL`传给`svga-player` 进行播放
 #### 代码示例
 ``` typescript
 <template>
@@ -599,7 +272,7 @@ onMounted(() => {
        callback: (event) => {
          const gift = JSON.parse(event)
          if( gift.resourceURL ) {
-           giftUrl.value = gift.resourceURL
+           giftUrl.value = gift.resourceURL
          }
        }
      })
@@ -621,7 +294,6 @@ onMounted(() => {
 4. **本地插入**：调用 `barrageState`的`appendLocalTip(message: giftTip) `将消息插入本地列表。
 #### 代码示例
 ``` typescript
 import { useGiftState } from "@/uni_modules/tuikit-atomic-x/state/GiftState";
@@ -646,7 +318,7 @@ onMounted(() => {
            message: giftTip
          })
          if( gift.resourceURL ) {
-           giftUrl.value = gift.resourceURL
+           giftUrl.value = gift.resourceURL
          }
        }
      })
@@ -656,33 +328,11 @@ onMounted(() => {
 ## API 文档
-关于 [GiftState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-GiftState) 及其相关类的所有公开接口、属性和方法的详细信息，请参阅随 [AtomicXCore](https://write.woa.com/document/192223419814899712) 框架的官方 API 文档。本指南使用到的相关 Store 如下：
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >**State**</td>
-<td rowspan="1" colSpan="1" >**功能描述**</td>
-<td rowspan="1" colSpan="1" >**API 文档**</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >GiftState</td>
-<td rowspan="1" colSpan="1" >礼物互动：获取礼物列表，发送 / 接收礼物，监听礼物事件（含发送者、礼物详情）。</td>
-<td rowspan="1" colSpan="1" >[API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-GiftState)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >BarrageState</td>
-<td rowspan="1" colSpan="1" >弹幕功能：发送文本 / 自定义弹幕，维护弹幕列表，实时监听弹幕状态。</td>
-<td rowspan="1" colSpan="1" >[API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-BarrageState)</td>
-</tr>
-</table>
+关于 [GiftState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-GiftState) 及其相关类的所有公开接口、属性和方法的详细信息，请参阅随 AtomicXCore 框架的官方 API 文档。本指南使用到的相关 Store 如下：
+| **State** | **功能描述** | **API 文档** |
+| --- | --- | --- |
+| GiftState | 礼物互动：获取礼物列表，发送 / 接收礼物，监听礼物事件（含发送者、礼物详情）。 | [API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-GiftState) |
+| BarrageState | 弹幕功能：发送文本 / 自定义弹幕，维护弹幕列表，实时监听弹幕状态。 | [API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-BarrageState) |
 ## 常见问题
@@ -699,7 +349,6 @@ onMounted(() => {
 `onReceiveGift` 事件是对房间内所有成员的广播（包括发送者自己）。如果您在 `sendGift` 的 `success` 成功回调里执行了一次UI操作，同时又在 `onReceiveGift` 订阅中执行了相同的 UI 操作，就会造成重复。
 - **实践教程**：UI 的更新（例如播放动画、弹幕提示）只在 `onReceiveGift` 事件的订阅中处理。`sendGift` 的 `success` 回调仅用于处理发送失败的逻辑（例如提示用户“发送失败”或“余额不足”）。
 ### 礼物扣费逻辑在哪里实现？
 礼物扣费逻辑完全由您的自建计费系统负责。`AtomicXCore` 通过后台回调机制与您的计费系统对接。客户端调用 `sendGift` 触发回调，您的后台服务完成扣费后，将结果返回给 `AtomicXCore` 后台，从而决定礼物事件是否广播。
@@ -711,6 +360,3 @@ onMounted(() => {
 ### 礼物动画播放卡顿怎么办？
 请检查您的 `SVGA` 文件大小，基础播放器建议不要超过 10MB。如果文件过大或动画复杂，您可以考虑集成 `TUILiveKit` 提供的高级特效播放器，以获得更优的性能表现。