npm - @tencentcloud/sdk-mcp - Versions diffs - 1.4.7 → 1.6.0-beta.1 - Mend

@tencentcloud/sdk-mcp 1.4.7 → 1.6.0-beta.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 (556) hide show

package/resource/knowledge/chat/urls/sdk/ios.md ADDED Viewed

@@ -0,0 +1,84 @@
+# iOS — SDK 官方文档 URL 映射
+## A — SDK 集成和初始化（iOS）
+| 子问题 | 目标文档 |
+|--------|---------|
+| iOS SDK 集成 | `https://cloud.tencent.com/document/product/269/75284` |
+| iOS SDK 初始化 | `https://cloud.tencent.com/document/product/269/75291` |
+## B — 登录
+| 子问题 | 目标文档 |
+|--------|---------|
+| 登录（`login` API） | `https://cloud.tencent.com/document/product/269/75294` |
+| 登出（`logout` API） | `https://cloud.tencent.com/document/product/269/75294` |
+## C — SDK API 使用
+| 子问题 | 目标文档 |
+|--------|---------|
+| SDK 消息类型介绍 | `https://cloud.tencent.com/document/product/269/75313` |
+| 文本消息（sendC2CMessage/sendGroupTextMessage） | `https://cloud.tencent.com/document/product/269/75315` |
+| 群 @ 消息（createAtSignedGroupMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75349` |
+| 图片消息（createImageMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75315` |
+| 语音消息（createSoundMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75315` |
+| 视频消息（createVideoMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75315` |
+| 文件消息（createFileMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75315` |
+| 自定义消息（sendC2CCustomMessage/sendGroupCustomMessage） | `https://cloud.tencent.com/document/product/269/75315` |
+| 表情消息（createFaceMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75315` |
+| 地理位置消息（createLocationMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75315` |
+| 合并消息（createMergerMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75324` |
+| 逐条转发消息（createForwardMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75324` |
+| 发送消息参数配置（sendMessage 参数） | `https://cloud.tencent.com/document/product/269/75315` |
+| 接收消息（addSimpleMsgListener/addAdvancedMsgListener） | `https://cloud.tencent.com/document/product/269/75318` |
+| 获取历史消息（getC2CHistoryMessageList/getGroupHistoryMessageList/getHistoryMessageList） | `https://cloud.tencent.com/document/product/269/75321` |
+| 修改消息（modifyMessage） | `https://cloud.tencent.com/document/product/269/75327` |
+| 插入消息（insertC2CMessageToLocalStorage/insertGroupMessageToLocalStorage） | `https://cloud.tencent.com/document/product/269/75330` |
+| 删除消息（deleteMessageFromLocalStorage/deleteMessages） | `https://cloud.tencent.com/document/product/269/75332` |
+| 清空消息（clearC2CHistoryMessage/clearGroupHistoryMessage） | `https://cloud.tencent.com/document/product/269/75335` |
+| 撤回消息（revokeMessage） | `https://cloud.tencent.com/document/product/269/75337` |
+| 在线消息 | `https://cloud.tencent.com/document/product/269/75340` |
+| 已读回执（单聊/群聊） | `https://cloud.tencent.com/document/product/269/75343` |
+| 查询消息（findMessages） | `https://cloud.tencent.com/document/product/269/75346` |
+| 群定向消息 | `https://cloud.tencent.com/document/product/269/75351` |
+| 消息免打扰（setC2CReceiveMessageOpt/setGroupReceiveMessageOpt/setAllReceiveMessageOpt） | `https://cloud.tencent.com/document/product/269/75353` |
+| 消息扩展（投票/接龙场景） | `https://cloud.tencent.com/document/product/269/81038` |
+| 消息回应（表情回应） | `https://cloud.tencent.com/document/product/269/96241` |
+| 消息翻译（translateText） | `https://cloud.tencent.com/document/product/269/85380` |
+| 语音转文字（convertVoiceToText） | `https://cloud.tencent.com/document/product/269/96280` |
+| 消息置顶（pinGroupMessage） | `https://cloud.tencent.com/document/product/269/106050` |
+| 流式消息（V2TIM_ELEM_TYPE_STREAM） | `https://cloud.tencent.com/document/product/269/129557` |
+| 文字转语音 | `https://cloud.tencent.com/document/product/269/131939` |
+| 会话存储限制 | `https://cloud.tencent.com/document/product/269/75363` |
+| 会话列表（getConversationList） | `https://cloud.tencent.com/document/product/269/75366` |
+| 会话资料（getConversation） | `https://cloud.tencent.com/document/product/269/75369` |
+| 会话未读数（getTotalUnreadMessageCount） | `https://cloud.tencent.com/document/product/269/75372` |
+| 置顶会话（pinConversation） | `https://cloud.tencent.com/document/product/269/75375` |
+| 删除会话（deleteConversation） | `https://cloud.tencent.com/document/product/269/75378` |
+| 会话草稿（setConversationDraft） | `https://cloud.tencent.com/document/product/269/75381` |
+| 会话标记（markConversation） | `https://cloud.tencent.com/document/product/269/77389` |
+| 会话分组 | `https://cloud.tencent.com/document/product/269/77392` |
+| 群组类型和不同群类型能力介绍 | `https://cloud.tencent.com/document/product/269/75697` |
+| 普通群管理 | `https://cloud.tencent.com/document/product/269/75395` |
+| 群资料（getGroupsInfo / setGroupInfo） | `https://cloud.tencent.com/document/product/269/75397` |
+| 群成员管理 | `https://cloud.tencent.com/document/product/269/75400` |
+| 群成员资料 | `https://cloud.tencent.com/document/product/269/75403` |
+| 群自定义属性 | `https://cloud.tencent.com/document/product/269/75406` |
+| 群计数器（groupCounter） | `https://cloud.tencent.com/document/product/269/85676` |
+| 社群（Community / 话题） | `https://cloud.tencent.com/document/product/269/75409` |
+| 社群（权限组） | `https://cloud.tencent.com/document/product/269/104417` |
+| 用户资料（getUsersInfo / setSelfInfo） | `https://cloud.tencent.com/document/product/269/75416` |
+| 用户状态（getUserStatus / subscribeUserStatus） | `https://cloud.tencent.com/document/product/269/75511` |
+| 好友管理 | `https://cloud.tencent.com/document/product/269/75419` |
+| 好友分组 | `https://cloud.tencent.com/document/product/269/75422` |
+| 用户黑名单 | `https://cloud.tencent.com/document/product/269/75425` |
+| 关注和粉丝 | `https://cloud.tencent.com/document/product/269/105494` |
+| 云端搜索消息（searchCloudMessages） | `https://cloud.tencent.com/document/product/269/115824` |
+| 云端搜索用户（searchUsers） | `https://cloud.tencent.com/document/product/269/115825` |
+| 云端搜索群组（searchGroups） | `https://cloud.tencent.com/document/product/269/115826` |
+| 云端搜索群成员（searchGroupMembers） | `https://cloud.tencent.com/document/product/269/115827` |
+| 本地搜索消息（searchLocalMessages） | `https://cloud.tencent.com/document/product/269/75436` |
+| 本地搜索好友（searchFriends） | `https://cloud.tencent.com/document/product/269/75439` |
+| 本地搜索群组（searchGroups） | `https://cloud.tencent.com/document/product/269/75441` |
+| 本地搜索群成员（searchGroupMembers） | `https://cloud.tencent.com/document/product/269/75443` |

package/resource/knowledge/chat/urls/sdk/web.md ADDED Viewed

@@ -0,0 +1,88 @@
+# Web — SDK 官方文档 URL 映射
+## A — SDK 集成和初始化（Web & 小程序）
+| 子问题 | 目标文档 |
+|--------|---------|
+| Web 端集成和初始化（V4） | `https://cloud.tencent.com/document/product/269/75285` |
+| 小程序端集成和初始化（V4） | `https://cloud.tencent.com/document/product/269/117335` |
+## B — 登录
+| 子问题 | 目标文档 |
+|--------|---------|
+| 登录（`login` API） | `https://cloud.tencent.com/document/product/269/75295` |
+| 登出（`logout` API） | `https://cloud.tencent.com/document/product/269/75295` |
+## C — SDK API 使用
+| 子问题 | 目标文档 |
+|--------|---------|
+| SDK 消息类型介绍 | `https://cloud.tencent.com/document/product/269/75314` |
+| IM 消息 Payload 结构（Message payload） | `https://web.sdk.qcloud.com/im/doc/v3/zh-cn/Message.html` |
+| 文本消息（createTextMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75316` |
+| 群 @ 消息（createTextAtMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75316` |
+| 图片消息（createImageMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75316` |
+| 语音消息（createVoiceMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75316` |
+| 视频消息（createVideoMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75316` |
+| 文件消息（createFileMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75316` |
+| 自定义消息（createCustomMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75316` |
+| 表情消息（createFaceMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75316` |
+| 地理位置消息（createLocationMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75316` |
+| 合并消息（createMergerMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75316` |
+| 逐条转发消息（createForwardMessage → sendMessage） | `https://cloud.tencent.com/document/product/269/75316` |
+| 发送消息参数配置（sendMessage 参数） | `https://cloud.tencent.com/document/product/269/75316` |
+| 接收消息（EVENT.MESSAGE_RECEIVED） | `https://cloud.tencent.com/document/product/269/75319` |
+| 获取历史消息（getMessageList） | `https://cloud.tencent.com/document/product/269/75322` |
+| 修改消息（modifyMessage） | `https://cloud.tencent.com/document/product/269/75328` |
+| 删除消息（deleteMessage） | `https://cloud.tencent.com/document/product/269/75333` |
+| 清空消息（clearHistoryMessage） | `https://cloud.tencent.com/document/product/269/84438` |
+| 撤回消息（revokeMessage） | `https://cloud.tencent.com/document/product/269/75338` |
+| 在线消息 | `https://cloud.tencent.com/document/product/269/75341` |
+| 已读回执（单聊/群聊） | `https://cloud.tencent.com/document/product/269/75344` |
+| 查询消息（findMessage） | `https://cloud.tencent.com/document/product/269/75348` |
+| 群定向消息 | `https://cloud.tencent.com/document/product/269/82987` |
+| 消息免打扰（setMessageRemindType） | `https://cloud.tencent.com/document/product/269/75354` |
+| 消息扩展（投票/接龙场景） | `https://cloud.tencent.com/document/product/269/84439` |
+| 消息回应（表情回应） | `https://cloud.tencent.com/document/product/269/98758` |
+| 消息翻译（translateText） | `https://cloud.tencent.com/document/product/269/95414` |
+| 语音转文字（convertVoiceToText） | `https://cloud.tencent.com/document/product/269/106622` |
+| 流式消息（TYPES.MSG_STREAM） | `https://cloud.tencent.com/document/product/269/131979` |
+| 会话存储限制 | `https://cloud.tencent.com/document/product/269/75364` |
+| 会话列表（getConversationList） | `https://cloud.tencent.com/document/product/269/75367` |
+| 会话资料（getConversationProfile） | `https://cloud.tencent.com/document/product/269/75370` |
+| 会话未读数（getTotalUnreadMessageCount） | `https://cloud.tencent.com/document/product/269/75373` |
+| 置顶会话（pinConversation） | `https://cloud.tencent.com/document/product/269/75376` |
+| 删除会话（deleteConversation） | `https://cloud.tencent.com/document/product/269/75379` |
+| 会话草稿（setConversationDraft） | `https://cloud.tencent.com/document/product/269/95424` |
+| 会话标记（markConversation） | `https://cloud.tencent.com/document/product/269/79378` |
+| 会话分组 | `https://cloud.tencent.com/document/product/269/79379` |
+| 群组类型和不同群类型能力介绍 | `https://cloud.tencent.com/document/product/269/75697` |
+| 普通群管理 | `https://cloud.tencent.com/document/product/269/75395` |
+| 群资料（getGroupProfile / updateGroupProfile） | `https://cloud.tencent.com/document/product/269/75398` |
+| 群成员管理 | `https://cloud.tencent.com/document/product/269/75401` |
+| 群成员资料 | `https://cloud.tencent.com/document/product/269/75404` |
+| 群自定义属性 | `https://cloud.tencent.com/document/product/269/75407` |
+| 群计数器（groupCounter） | `https://cloud.tencent.com/document/product/269/86617` |
+| 社群（Community / 话题） | `https://cloud.tencent.com/document/product/269/75410` |
+| 用户资料（getMyProfile / getUserProfile / updateMyProfile） | `https://cloud.tencent.com/document/product/269/75417` |
+| 用户状态（getUserStatus / subscribeUserStatus） | `https://cloud.tencent.com/document/product/269/78125` |
+| 好友管理 | `https://cloud.tencent.com/document/product/269/75420` |
+| 好友分组 | `https://cloud.tencent.com/document/product/269/75423` |
+| 用户黑名单 | `https://cloud.tencent.com/document/product/269/75426` |
+| 关注和粉丝 | `https://cloud.tencent.com/document/product/269/105307` |
+| 云端搜索消息（searchCloudMessages） | `https://cloud.tencent.com/document/product/269/114754` |
+| 云端搜索用户（searchUsers） | `https://cloud.tencent.com/document/product/269/114757` |
+| 云端搜索群组（searchGroups） | `https://cloud.tencent.com/document/product/269/114760` |
+| 云端搜索群成员（searchGroupMembers） | `https://cloud.tencent.com/document/product/269/114763` |
+## D — 版本升级指南
+| 子问题 | 目标文档 |
+|--------|---------|
+| V4 版本日志 / Changelog | `https://cloud.tencent.com/document/product/269/38492` |
+| V3 → V4 版本迁移 | `https://web.sdk.qcloud.com/im/doc/v3/zh-cn/tutorial-04-comparison-v4.html` |
+| V3 → V4 破坏性变更 | `https://web.sdk.qcloud.com/im/doc/v3/zh-cn/tutorial-04-comparison-v4.html` |
+| V3 版本日志 / Changelog | `https://cloud.tencent.com/document/product/269/124855` |
+| V2 → V3 版本迁移 | `https://web.sdk.qcloud.com/im/doc/v3/zh-cn/tutorial-06-comparison.html` |
+| V2 → V3 破坏性变更 | `https://web.sdk.qcloud.com/im/doc/v3/zh-cn/tutorial-07-breakingchanges.html` |

package/resource/knowledge/chat/urls/webhook.md ADDED Viewed

@@ -0,0 +1,73 @@
+# 服务端回调（Webhook）— 官方文档 URL 映射
+## 回调概览
+| 子问题 | 目标文档 |
+|--------|---------|
+| 第三方回调概览 / 配置方法 / 规范 | `https://cloud.tencent.com/document/product/269/1522` |
+## 在线状态相关回调
+| 子问题 | 目标文档 |
+|--------|---------|
+| 用户状态变更回调 | `https://cloud.tencent.com/document/product/269/2570` |
+| 更新用户资料后回调 | `https://cloud.tencent.com/document/product/269/76489` |
+## 资料关系链相关回调
+| 子问题 | 目标文档 |
+|--------|---------|
+| 添加好友之前回调 | `https://cloud.tencent.com/document/product/269/61698` |
+| 添加好友回应之前回调 | `https://cloud.tencent.com/document/product/269/61699` |
+| 添加好友之后回调 | `https://cloud.tencent.com/document/product/269/1657` |
+| 删除好友之后回调 | `https://cloud.tencent.com/document/product/269/1659` |
+| 添加黑名单之后回调 | `https://cloud.tencent.com/document/product/269/1660` |
+| 删除黑名单之后回调 | `https://cloud.tencent.com/document/product/269/1661` |
+## 关注与粉丝相关回调
+| 子问题 | 目标文档 |
+|--------|---------|
+| 关注用户之后回调 | `https://cloud.tencent.com/document/product/269/118915` |
+| 取关用户之后回调 | `https://cloud.tencent.com/document/product/269/118916` |
+## 单聊消息相关回调
+| 子问题 | 目标文档 |
+|--------|---------|
+| 设置单聊消息扩展回调 | `https://cloud.tencent.com/document/product/269/126475` |
+| 发单聊消息之前回调 | `https://cloud.tencent.com/document/product/269/1632` |
+| 发单聊消息之后回调 | `https://cloud.tencent.com/document/product/269/2716` |
+| 单聊消息已读上报后回调 | `https://cloud.tencent.com/document/product/269/61696` |
+| 单聊消息撤回后回调 | `https://cloud.tencent.com/document/product/269/61697` |
+| 单聊单条消息已读回执之后回调 | `https://cloud.tencent.com/document/product/269/128223` |
+| 单聊消息编辑之后回调 | `https://cloud.tencent.com/document/product/269/128224` |
+## 群组系统相关回调
+| 子问题 | 目标文档 |
+|--------|---------|
+| 设置群消息扩展回调 | `https://cloud.tencent.com/document/product/269/126476` |
+| 创建群组之前回调 | `https://cloud.tencent.com/document/product/269/1662` |
+| 创建群组之后回调 | `https://cloud.tencent.com/document/product/269/1663` |
+| 申请入群之前回调 | `https://cloud.tencent.com/document/product/269/1665` |
+| 拉人入群之前回调 | `https://cloud.tencent.com/document/product/269/1666` |
+| 新成员入群之后回调 | `https://cloud.tencent.com/document/product/269/1667` |
+| 群成员离开之后回调 | `https://cloud.tencent.com/document/product/269/1668` |
+| 群内发言之前回调 | `https://cloud.tencent.com/document/product/269/1619` |
+| 群内发言之后回调 | `https://cloud.tencent.com/document/product/269/2661` |
+| 群组满员之后回调 | `https://cloud.tencent.com/document/product/269/1669` |
+| 群组解散之后回调 | `https://cloud.tencent.com/document/product/269/1670` |
+| 群组资料变动之后回调 | `https://cloud.tencent.com/document/product/269/2930` |
+| 撤回群消息之后回调 | `https://cloud.tencent.com/document/product/269/73141` |
+| 直播群成员在线状态回调 | `https://cloud.tencent.com/document/product/269/76156` |
+| 发送群聊消息异常回调 | `https://cloud.tencent.com/document/product/269/78619` |
+| 创建话题之前回调 | `https://cloud.tencent.com/document/product/269/78206` |
+| 创建话题之后回调 | `https://cloud.tencent.com/document/product/269/78207` |
+| 解散话题之后回调 | `https://cloud.tencent.com/document/product/269/78208` |
+| 话题资料修改之后回调 | `https://cloud.tencent.com/document/product/269/78209` |
+| 群成员资料变更后回调 | `https://cloud.tencent.com/document/product/269/105353` |
+| 群自定义属性变更后回调 | `https://cloud.tencent.com/document/product/269/105354` |
+| 已读回执后回调 | `https://cloud.tencent.com/document/product/269/105355` |
+| 转让群主后回调 | `https://cloud.tencent.com/document/product/269/105356` |
+| 群内消息编辑后回调 | `https://cloud.tencent.com/document/product/269/129193` |

package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/AudioEffectStore.md RENAMED Viewed

@@ -1,12 +1,11 @@
 ## 简介
-**AudioEffectStore** 提供了一套完整的音效管理 API，包括变声效果、混响效果和耳返功能。
-通过该类，主播可以在直播过程中实时调整自己的声音效果，提升直播体验。
+`AudioEffectStore` 提供了一套完整的音效管理 API，包括变声效果、混响效果和耳返功能。 通过该类，主播可以在直播过程中实时调整自己的声音效果，提升直播体验。
 > **重要：**
 >
-> 使用 **AudioEffectStore.shared** 单例获取 **AudioEffectStore** 实例。设置的音效在退出房间后会自动失效，下次进房需要重新设置。
+> 使用 **AudioEffectStore.shared** 单例获取 `AudioEffectStore` 实例。设置的音效在退出房间后会自动失效，下次进房需要重新设置。
 >
 > **说明：**
@@ -24,7 +23,7 @@
 ## 功能特性
 - **变声效果**：支持多种变声特效，如熊孩子、小女孩、大叔等。
-- **混响效果**：支持多种混响特效，如KTV、小房间、大会堂等。
+- **混响效果**：支持多种混响特效，如 KTV、小房间、大会堂等。
 - **耳返功能**：主播可在耳机中听到自己的声音，适用于唱歌场景。
@@ -33,22 +32,24 @@
 ## 可订阅数据
 **AudioEffectState** 的字段描述如下：
-| **属性名** | **类型** | **描述** |
-| --- | --- | --- |
-| audioChangerType | StateFlow<AudioChangerType> | 变声状态。 |
-| audioReverbType | StateFlow<AudioReverbType> | 混响状态。 |
-| isEarMonitorOpened | StateFlow<Boolean> | 耳返开启。 |
-| earMonitorVolume | StateFlow<Int> | 耳返音量，取值范围 0 - 100。<br>如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。 |
+|**属性名**|**类型**|**描述**|
+|---------|---------|---------|
+|audioChangerType|StateFlow<AudioChangerType>|变声状态。|
+|audioReverbType|StateFlow<AudioReverbType>|混响状态。|
+|isEarMonitorOpened|StateFlow<Boolean>|耳返开启。|
+|earMonitorVolume|StateFlow<Int>|耳返音量，取值范围0到100。<br>如果将 volume 设置成100之后感觉音量还是太小，可以将 volume 最大设置成150，但超过100的 volume 会有爆音的风险，请谨慎操作。|
 ## API 列表
-| **函数名** | **描述** |
-| --- | --- |
-| AudioEffectStore.shared | 获取单例实例。 |
-| setAudioChangerType | 设置变声效果。 |
-| setAudioReverbType | 设置混响效果。 |
-| setVoiceEarMonitorEnable | 开启/关闭耳返。 |
-| setVoiceEarMonitorVolume | 设置耳返音量。 |
-| reset | 重置为默认状态。 |
+|**函数名**|**描述**|
+|---------|---------|
+|AudioEffectStore.shared|获取单例实例。|
+|setAudioChangerType|设置变声效果。|
+|setAudioReverbType|设置混响效果。|
+|setVoiceEarMonitorEnable|开启/关闭耳返。|
+|setVoiceEarMonitorVolume|设置耳返音量。|
+|reset|重置为默认状态。|
 ### 获取实例
@@ -60,7 +61,7 @@
 #### setAudioChangerType
-设置变声效果
+设置变声效果。
 ``` kotlin
 abstract fun setAudioChangerType(type: AudioChangerType)
 ```
@@ -71,7 +72,7 @@ abstract fun setAudioChangerType(type: AudioChangerType)
 **版本信息**
-从 3.5 版本开始支持。
+从3.5版本开始支持。
 **调用时机**
@@ -86,15 +87,16 @@ abstract fun setAudioChangerType(type: AudioChangerType)
 >
 **参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| type | AudioChangerType | 必填 | 变声效果类型。 |
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|type|AudioChangerType|变声效果类型。|
 ### 混响设置
 #### setAudioReverbType
-设置混响效果
+设置混响效果。
 ``` kotlin
 abstract fun setAudioReverbType(type: AudioReverbType)
 ```
@@ -105,7 +107,7 @@ abstract fun setAudioReverbType(type: AudioReverbType)
 **版本信息**
-从 3.5 版本开始支持。
+从3.5版本开始支持。
 **调用时机**
@@ -120,15 +122,16 @@ abstract fun setAudioReverbType(type: AudioReverbType)
 >
 **参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| type | AudioReverbType | 必填 | 混响效果类型。 |
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|type|AudioReverbType|混响效果类型。|
 ### 耳返设置
 #### setVoiceEarMonitorEnable
-开启/关闭耳返
+开启/关闭耳返。
 ``` kotlin
 abstract fun setVoiceEarMonitorEnable(enable: Boolean)
 ```
@@ -137,7 +140,7 @@ abstract fun setVoiceEarMonitorEnable(enable: Boolean)
 **版本信息**
-从 3.5 版本开始支持。
+从3.5版本开始支持。
 **适用场景**
@@ -156,13 +159,14 @@ abstract fun setVoiceEarMonitorEnable(enable: Boolean)
 >
 **参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| enable | Boolean | 必填 | 是否开启耳返。 |
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|enable|Boolean|是否开启耳返。|
 #### setVoiceEarMonitorVolume
-设置耳返音量
+设置耳返音量。
 ``` kotlin
 abstract fun setVoiceEarMonitorVolume(volume: Int)
 ```
@@ -171,7 +175,7 @@ abstract fun setVoiceEarMonitorVolume(volume: Int)
 **版本信息**
-从 3.5 版本开始支持。
+从3.5版本开始支持。
 **调用时机**
@@ -182,19 +186,20 @@ abstract fun setVoiceEarMonitorVolume(volume: Int)
 > **说明：**
 >
-> 如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。
+> 如果将 volume 设置成100之后感觉音量还是太小，可以将 volume 最大设置成150，但超过100的 volume 会有爆音的风险，请谨慎操作。
 >
 **参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| volume | Int | 必填 | 耳返音量。（取值范围：0 - 100（超过 100 可能导致爆音））（默认值：100）。 |
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|volume|Int|耳返音量。（取值范围：取值范围0到100，超过100可能导致爆音）（默认值：100）。|
 ### 重置
 #### reset
-重置为默认状态
+重置为默认状态。
 ``` kotlin
 abstract fun reset()
 ```
@@ -203,7 +208,7 @@ abstract fun reset()
 **版本信息**
-从 3.5 版本开始支持。
+从3.5版本开始支持。
 **调用时机**
@@ -214,69 +219,67 @@ abstract fun reset()
 ### AudioChangerType
 变声效果类型。
-| **枚举值** | **值** | **说明** |
-| --- | --- | --- |
-| NONE | 0 | 关闭特效。 |
-| CHILD | 1 | 熊孩子。 |
-| LITTLE_GIRL | 2 | 小女孩。 |
-| MAN | 3 | 大叔。 |
-| HEAVY_METAL | 4 | 重金属。 |
-| COLD | 5 | 感冒。 |
-| FOREIGNER | 6 | 外语腔。 |
-| TRAPPED_BEAST | 7 | 困兽。 |
-| FATSO | 8 | 肥宅。 |
-| STRONG_CURRENT | 9 | 强电流。 |
-| HEAVY_MACHINERY | 10 | 重机械。 |
-| ETHEREAL | 11 | 空灵。 |
+|**枚举值**|**值**|**说明**|
+|---------|---------|---------|
+|NONE|0|关闭特效。|
+|CHILD|1|熊孩子。|
+|LITTLE_GIRL|2|小女孩。|
+|MAN|3|大叔。|
+|HEAVY_METAL|4|重金属。|
+|COLD|5|感冒。|
+|FOREIGNER|6|外语腔。|
+|TRAPPED_BEAST|7|困兽。|
+|FATSO|8|肥宅。|
+|STRONG_CURRENT|9|强电流。|
+|HEAVY_MACHINERY|10|重机械。|
+|ETHEREAL|11|空灵。|
 ### AudioReverbType
 混响效果类型。
-| **枚举值** | **值** | **说明** |
-| --- | --- | --- |
-| NONE | 0 | 关闭特效。 |
-| KTV | 1 | KTV。 |
-| SMALL_ROOM | 2 | 小房间。 |
-| AUDITORIUM | 3 | 大会堂。 |
-| DEEP | 4 | 低沉。 |
-| LOUD | 5 | 洪亮。 |
-| METALLIC | 6 | 金属声。 |
-| MAGNETIC | 7 | 磁性。 |
+|**枚举值**|**值**|**说明**|
+|---------|---------|---------|
+|NONE|0|关闭特效。|
+|KTV|1|KTV。|
+|SMALL_ROOM|2|小房间。|
+|AUDITORIUM|3|大会堂。|
+|DEEP|4|低沉。|
+|LOUD|5|洪亮。|
+|METALLIC|6|金属声。|
+|MAGNETIC|7|磁性。|
 ### AudioEffectState
 AudioEffectStore 对外提供的音效相关状态数据。
-| **属性** | **类型** | **说明** |
-| --- | --- | --- |
-| audioChangerType | StateFlow<AudioChangerType> | 变声状态。 |
-| audioReverbType | StateFlow<AudioReverbType> | 混响状态。 |
-| isEarMonitorOpened | StateFlow<Boolean> | 耳返开启。 |
-| earMonitorVolume | StateFlow<Int> | 耳返音量，取值范围 0 - 100。<br>如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。 |
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|audioChangerType|StateFlow<AudioChangerType>|变声状态。|
+|audioReverbType|StateFlow<AudioReverbType>|混响状态。|
+|isEarMonitorOpened|StateFlow<Boolean>|耳返开启。|
+|earMonitorVolume|StateFlow<Int>|耳返音量，取值范围0到100。<br>如果将 volume 设置成100之后感觉音量还是太小，可以将 volume 最大设置成150，但超过100的 volume 会有爆音的风险，请谨慎操作。|
 ## 使用示例
 ``` kotlin
 // 获取单例实例
 val store = AudioEffectStore.shared()
 // 订阅状态变化
 lifecycleScope.launch {
     store.audioEffectState.audioChangerType.collect { type ->
         println("当前变声效果: $type")
     }
 }
 lifecycleScope.launch {
     store.audioEffectState.audioReverbType.collect { type ->
         println("当前混响效果: $type")
     }
 }
 // 设置变声效果
 store.setAudioChangerType(AudioChangerType.LITTLE_GIRL)
 // 设置混响效果
 store.setAudioReverbType(AudioReverbType.KTV)
 // 开启耳返
 store.setVoiceEarMonitorEnable(true)
 store.setVoiceEarMonitorVolume(80)