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

@tencentcloud/sdk-mcp 1.3.9 → 1.4.1

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 (514) hide show

package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-audio-effect.md RENAMED Viewed

@@ -1,8 +1,5 @@
 本篇文档旨在指导您如何使用 `AtomicXCore` 框架中的  `AudioEffectState` 和 `DeviceState` 模块，为您的直播应用快速集成音效控制功能，包括麦克风音量、耳返监听，并添加多种趣味变声效果和混响效果。
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100028028022/46976106baed11f0b0cf525400e889b2.png)
 ## 核心功能
 通过组合 `AudioEffectState` 和 `DeviceState`，您将能实现以下核心功能：
@@ -14,12 +11,11 @@
 - **混响效果**：模拟不同环境的声场效果，例如 KTV、金属声、低沉、洪亮等。
 ## 实现步骤
 ### 步骤1：组件集成
-请参考 [快速接入](https://write.woa.com/document/191656297444069376) 集成 **AtomicXCore。**
+请参考 快速接入 集成 **AtomicXCore。**
 ### 步骤2：获取 State 实例
@@ -41,11 +37,10 @@ useDeviceState(liveID)
 耳返功能允许用户实时监听自己的麦克风声音，可以通过调用本节介绍的接口管理耳返功能。
 > **注意：**
->
+>
 > 耳返功能通常需要连接耳机才能正常工作。
->
+>
 #### 实现方式:
 1. **开关耳返**：您可以在 `UI` 上自行实现开关耳返功能。
@@ -54,7 +49,6 @@ useDeviceState(liveID)
 3. **监听状态更新 UI**：您可以订阅实时的耳返状态值更新 UI。
 #### 代码示例:
 ``` typescript
 import { watch } from 'vue'
@@ -63,7 +57,6 @@ import { useAudioEffectState } from '@/uni_modules/tuikit-atomic-x/state/AudioEf
 // liveID 是语聊房的唯一标识
 const liveID = 'your_live_id'; // 替换为实际的语聊房 liveID
 // 通过 liveID 获取对应实例
 const { setVoiceEarMonitorEnable, setVoiceEarMonitorVolume, earMonitorVolume } = useAudioEffectState(liveID)
@@ -88,44 +81,14 @@ watch(earMonitorVolume, (newVolume) => {
 ```
 #### setVoiceEarMonitorEnable 接口参数
-<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" >`enable`</td>
-<td rowspan="1" colSpan="1" >`boolean`</td>
-<td rowspan="1" colSpan="1" >是否开启耳返。<br>- true：开启<br>- false：关闭</td>
-</tr>
-</table>
+| **参数名** | **类型** | **描述** |
+| --- | --- | --- |
+| `enable` | `boolean` | 是否开启耳返。<br>- true：开启<br>- false：关闭 |
 #### setVoiceEarMonitorVolume 接口参数
-<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" >`volume`</td>
-<td rowspan="1" colSpan="1" >`number`</td>
-<td rowspan="1" colSpan="1" >耳返音量大小。<br>- 取值范围： [0, 150]<br>- 默认值：100</td>
-</tr>
-</table>
+| **参数名** | **类型** | **描述** |
+| --- | --- | --- |
+| `volume` | `number` | 耳返音量大小。<br>- 取值范围： [0, 150]<br>- 默认值：100 |
 ### 步骤4：实现人声音量调节
@@ -136,7 +99,6 @@ watch(earMonitorVolume, (newVolume) => {
 2. **监听状态更新 UI**：您可以订阅实时的音量状态值更新 UI。
 #### 示例代码：
 ``` typescript
 import { watch } from 'vue'
@@ -162,24 +124,9 @@ watch(captureVolume, (newVolume) => {
 ```
 #### setCaptureVolume 接口参数
-<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" >`volume`</td>
-<td rowspan="1" colSpan="1" >`number`</td>
-<td rowspan="1" colSpan="1" >采集音量大小。<br>- 取值范围： [0, 150]<br>- 默认值：100</td>
-</tr>
-</table>
+| **参数名** | **类型** | **描述** |
+| --- | --- | --- |
+| `volume` | `number` | 采集音量大小。<br>- 取值范围： [0, 150]<br>- 默认值：100 |
 ### 步骤5：实现变声效果
@@ -203,24 +150,9 @@ const applyVoiceChanger = () => {
 ```
 #### setAudioChangerType 接口参数
-<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" >`changerType`</td>
-<td rowspan="1" colSpan="1" >`string`</td>
-<td rowspan="1" colSpan="1" >[变声效果枚举](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/interface.html#AudioReverbTypeParam)。</td>
-</tr>
-</table>
+| **参数名** | **类型** | **描述** |
+| --- | --- | --- |
+| `changerType` | `string` | [变声效果枚举](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/interface.html#AudioReverbTypeParam)。 |
 ### 步骤6：实现混响效果
@@ -243,54 +175,17 @@ const applyReverbEffect = () => {
 ```
 #### setAudioReverbType 接口参数
-<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" >`reverbType`</td>
-<td rowspan="1" colSpan="1" >`string`</td>
-<td rowspan="1" colSpan="1" >[混响效果枚举](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/interface.html#AudioReverbTypeParam)。</td>
-</tr>
-</table>
+| **参数名** | **类型** | **描述** |
+| --- | --- | --- |
+| `reverbType` | `string` | [混响效果枚举](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/interface.html#AudioReverbTypeParam)。 |
 ## API 文档
-关于 [AudioEffectState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-AudioEffectState) 和 [DeviceState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-DeviceState) 及其相关类的所有公开接口、属性的详细信息，请参阅随 [AtomicXCore](https://write.woa.com/document/192223419814899712) 框架的官方 API 文档。
-<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" >AudioEffectState</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-AudioEffectState)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >DeviceState</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-DeviceState)</td>
-</tr>
-</table>
+关于 [AudioEffectState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-AudioEffectState) 和 [DeviceState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-DeviceState) 及其相关类的所有公开接口、属性的详细信息，请参阅随 AtomicXCore 框架的官方 API 文档。
+| **State** | **功能描述** | **API 文档** |
+| --- | --- | --- |
+| AudioEffectState | 音效管理：进行音效设置，并获取实时音效状态。 | [API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-AudioEffectState) |
+| DeviceState | 设备管理：进行摄像头、麦克风操作，并获取实时设备状态。 | [API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-DeviceState) |
 ## 常见问题
@@ -305,7 +200,6 @@ const applyReverbEffect = () => {
 - **耳返音量 (EarMonitorVolume)：**通过 `setVoiceEarMonitorVolume()`** 设置。它只**决定了**您自己**在耳机里听到的监听声音大小，**不会**影响观众。
 ### **新创建的直播间为什么直接就有音效、或者出现音量很大、很小等问题？**
 `AudioEffectState`和`DeviceState`是单例，这意味着音效和设备设置是全局生效的，出现这种情况很可能是因为您之前设置过音效但是没有重置，需要在合适的地方将数据重置。
@@ -319,14 +213,6 @@ const applyReverbEffect = () => {
 3. **麦克风是否开启**：确认 `DeviceState` 中的麦克风是开启状态（即已调用 `openLocalMicrophone`）。
 ### **变声效果 和混响效果 可以同时生效吗？**
 可以。`AudioChangerType` 和 `AudioReverbType` 是可以叠加生效的。例如，您可以同时设置 `'LITTLEGIRL'` 变声和 `'KTV'`混响。

package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-barrage.md RENAMED Viewed

@@ -1,8 +1,5 @@
 本篇文档旨在指导 uniapp 开发者如何使用 `AtomicXCore` 框架中的 `BarrageState` 模块，为您的直播应用快速集成功能丰富、性能卓越的弹幕系统。
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100028028022/51f80cd8bbbc11f0b4c35254001c06ec.png)
 ## 核心功能
 `BarrageState` 为您的直播应用提供了一套完整的弹幕解决方案，核心功能包括：
@@ -14,12 +11,11 @@
 - 在本地消息列表中插入系统提示（例如，“欢迎 XX 进入直播间”）。
 ## 实现步骤
 ### 步骤1：组件集成
-请参考 [开始直播](https://write.woa.com/document/191127271985012736) 集成 **AtomicXCore**，完成接入。
+请参考 开始直播 集成 **AtomicXCore**，完成接入。
 ### 步骤2：初始化并监听弹幕
@@ -55,60 +51,24 @@ const { sendTextMessage } = useBarrageState(liveID);
 const sendMessage = () => {
     sendTextMessage({
       liveID: 'xxx', // 当前直播间的 liveID
-      text: 'xxx', // 您想要发送的弹幕
+      text: 'xxx', // 您想要发送的弹幕
       success: () => {
         console.log("弹幕发送成功")
       },
       fail: (error) => {
         console.log("弹幕发送失败", error)
-      }
+      }
     })
 }
 ```
 #### **接口参数**
-<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" >`text`</td>
-<td rowspan="1" colSpan="1" >`string`</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`。 |
+| `text` | `string` | 要发送的文本内容。 |
+| `success` | `Function` | 发送成功的回调。 |
+| `fail` | `Function` | 发送失败的回调。 |
 ### 步骤4：发送自定义弹幕
@@ -124,7 +84,7 @@ const { sendCustomMessage } = useBarrageState(liveID);
 /// 发送一条自定义弹幕，例如用于发送礼物
 const sendGiftMessage = ( giftID: string, giftCount: number ) => {
-    // 1. 定义一个能识别业务的ID
+    // 1. 定义一个能识别业务的ID
     const businessID = "live_gift"
     // 2. 将业务数据编码为 JSON 字符串
     const giftData = { "gift_id": giftId, "gift_count": giftCount }
@@ -132,7 +92,7 @@ const sendGiftMessage = ( giftID: string, giftCount: number ) => {
     sendCustomMessage({
       liveID: 'xxx', // 当前直播间的 liveID
       businessID,
-      data: JSON.stringify(giftData),
+      data: JSON.stringify(giftData),
       success: () => {
         console.log("礼物消息发送成功")
       },
@@ -144,56 +104,13 @@ const sendGiftMessage = ( giftID: string, giftCount: number ) => {
 ```
 #### **接口参数**
-<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" >`businessId`</td>
-<td rowspan="1" colSpan="1" >`string`</td>
-<td rowspan="1" colSpan="1" >业务唯一标识符，例如 "live_gift"，用于接收端区分不同的自定义消息。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`data`</td>
-<td rowspan="1" colSpan="1" >`string`</td>
-<td rowspan="1" colSpan="1" >业务数据，通常为 JSON 格式的字符串。</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`。 |
+| `businessId` | `string` | 业务唯一标识符，例如 "live_gift"，用于接收端区分不同的自定义消息。 |
+| `data` | `string` | 业务数据，通常为 JSON 格式的字符串。 |
+| `success` | `Function` | 发送成功的回调。 |
+| `fail` | `Function` | 发送失败的回调。 |
 ### 步骤5：在本地插入提示消息
@@ -221,24 +138,9 @@ const showWelcomeMessage = (user: LiveUserInfo) => {
 ```
 #### **接口参数**
-<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" >`message`</td>
-<td rowspan="1" colSpan="1" >`string`</td>
-<td rowspan="1" colSpan="1" >要在本地插入的消息对象。SDK 会将此消息对象追加到 `BarrageState` 的 `messageList` 中。</td>
-</tr>
-</table>
+| **参数** | **类型** | **描述** |
+| --- | --- | --- |
+| `message` | `string` | 要在本地插入的消息对象。SDK 会将此消息对象追加到 `BarrageState` 的 `messageList` 中。 |
 ### 步骤6：管理用户发言（禁言与解禁）
@@ -389,7 +291,7 @@ SDK 会以极高频率返回完整的弹幕列表。如果每次都更新完整
 SDK 返回的全量 `messageList` 会在长时间直播中无限增长，即使 `UI` 层做了节流，数据层持有的这个巨大数组也会持续侵占内存，最终导致应用闪退。
-#### 优化方案：固定容量的循环数组 (Circular Buffer)
+#### 优化方案：固定容量的循环数组 (Circular Buffer)
 **只让您自己的数据源（DataSource）持有有限数量的消息**。无论 `SDK` 返回的全量列表有多大，您的应用只截取其中最新的部分用于显示。
@@ -423,7 +325,7 @@ SDK 返回的全量 `messageList` 会在长时间直播中无限增长，即使
 ## API 文档
-关于 [BarrageState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-BarrageState) 及其相关类的所有公开接口、属性和方法的详细信息，请参阅随 [AtomicXCore](https://write.woa.com/document/192223419814899712) 框架的官方 API 文档。
+关于 [BarrageState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-BarrageState) 及其相关类的所有公开接口、属性和方法的详细信息，请参阅随 AtomicXCore 框架的官方 API 文档。
 ## 常见问题
@@ -441,7 +343,6 @@ SDK 返回的全量 `messageList` 会在长时间直播中无限增长，即使
 3. **接收端**: 在接收到弹幕消息后，检查其 `messageType` 是否为 `'CUSTOM'` 以及 `businessID` 是否匹配。如果匹配，则解析 `data` 字符串（通常是解析JSON），根据解析出的数据（例如 `color、text`）来渲染您的自定义UI样式。
 ### 为什么我调用了 sendTextMessage，但是在消息列表中看不到我发送的消息？
 **请按以下步骤排查：**
@@ -453,7 +354,6 @@ SDK 返回的全量 `messageList` 会在长时间直播中无限增长，即使
 4. **网络问题**：检查设备当前的网络连接是否正常。消息发送依赖于网络。
 ### 新观众进入直播间时，如何让他们看到加入前的历史弹幕消息？
 `AtomicXCore` 支持拉取历史弹幕消息，但这需要您在**服务端控制台**进行一项简单的配置。配置完成后，SDK 会自动处理后续的一切，您无需编写额外的代码。
@@ -463,20 +363,14 @@ SDK 返回的全量 `messageList` 会在长时间直播中无限增长，即使
 2. 在左侧导航栏按照路径：**消息服务 Chat** >** 功能配置 **>** 群组配置 **> **群功能配置** >** 直播群新成员查看入群前消息量配置**进行导航。
-   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100028028022/67592599bbbc11f0a808525400bf7822.png)
 3. 修改“新成员可查看最近消息数”，最大支持 **50** 条。
    **步骤2：客户端无感获取 **
-   完成上述配置后，您的客户端代码**无需做任何改动**。
+   完成上述配置后，您的客户端代码**无需做任何改动**。
    当新用户加入直播间时，`AtomicXCore` 的底层 会自动拉取您配置的历史消息数量。这些历史消息会和实时消息一样，通过您已实现的 `BarrageState` 订阅通道推送给您的 UI 层。您的应用会像接收实时弹幕一样，自然地接收并展示这些历史弹幕。
 ### 为什么我的弹幕区域没有消息时，遮盖住了其底层区域的点击事件。
-在 `nvue` 下，如果您给组件提供默认的宽高，即使该组件没有渲染，它还是会挂载在 `UI` 上。这里建议不要给组件提供默认的宽高，而是根据有没有内容渲染来进行宽高的动态计算。
+在 `nvue` 下，如果您给组件提供默认的宽高，即使该组件没有渲染，它还是会挂载在 `UI` 上。这里建议不要给组件提供默认的宽高，而是根据有没有内容渲染来进行宽高的动态计算。