@tencentcloud/sdk-mcp 1.4.6 → 1.6.0-beta.1

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

@@ -1,12 +1,11 @@
 ## 简介
 
-**AudioEffectStore** 提供了一套完整的音效管理 API，包括变声效果、混响效果和耳返功能。
-通过该类，主播可以在直播过程中实时调整自己的声音效果，提升直播体验。
+`AudioEffectStore` 提供了一套完整的音效管理 API，包括变声效果、混响效果和耳返功能。 通过该类，主播可以在直播过程中实时调整自己的声音效果，提升直播体验。
 
 > **重要：**
 >
 
-> 使用 **shared** 单例获取 **AudioEffectStore** 实例。设置的音效在退出房间后会自动失效，下次进房需要重新设置。
+> 使用 **shared** 单例获取 `AudioEffectStore` 实例。设置的音效在退出房间后会自动失效，下次进房需要重新设置。
 >
 
 > **说明：**
@@ -24,7 +23,7 @@
 ## 功能特性
 - **变声效果**：支持多种变声特效，如熊孩子、小女孩、大叔等。
 
-- **混响效果**：支持多种混响特效，如KTV、小房间、大会堂等。
+- **混响效果**：支持多种混响特效，如 KTV、小房间、大会堂等。
 
 - **耳返功能**：主播可在耳机中听到自己的声音，适用于唱歌场景。
 
@@ -33,22 +32,24 @@
 ## 可订阅数据
 
 **AudioEffectState** 的字段描述如下：
-| **属性名** | **类型** | **描述** |
-| --- | --- | --- |
-| audioChangerType | ValueListenable<AudioChangerType> | 变声状态。 |
-| audioReverbType | ValueListenable<AudioReverbType> | 混响状态。 |
-| isEarMonitorOpened | ValueListenable<bool> | 耳返开启。 |
-| earMonitorVolume | ValueListenable<int> | 耳返音量，取值范围 0 - 100。<br>如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。 |
+
+|**属性名**|**类型**|**描述**|
+|---------|---------|---------|
+|audioChangerType|ValueListenable<AudioChangerType>|变声状态。|
+|audioReverbType|ValueListenable<AudioReverbType>|混响状态。|
+|isEarMonitorOpened|ValueListenable<bool>|耳返开启。|
+|earMonitorVolume|ValueListenable<int>|耳返音量，取值范围0到100。<br>如果将 volume 设置成100之后感觉音量还是太小，可以将 volume 最大设置成150，但超过100的 volume 会有爆音的风险，请谨慎操作。|
 
 ## API 列表
-| **函数名** | **描述** |
-| --- | --- |
-| shared | 获取单例实例。 |
-| setAudioChangerType | 设置变声效果。 |
-| setAudioReverbType | 设置混响效果。 |
-| setVoiceEarMonitorEnable | 开启/关闭耳返。 |
-| setVoiceEarMonitorVolume | 设置耳返音量。 |
-| reset | 重置为默认状态。 |
+
+|**函数名**|**描述**|
+|---------|---------|
+|shared|获取单例实例。|
+|setAudioChangerType|设置变声效果。|
+|setAudioReverbType|设置混响效果。|
+|setVoiceEarMonitorEnable|开启/关闭耳返。|
+|setVoiceEarMonitorVolume|设置耳返音量。|
+|reset|重置为默认状态。|
 
 ### 获取实例
 
@@ -60,7 +61,7 @@
 
 #### setAudioChangerType
 
-设置变声效果
+设置变声效果。
 ``` dart
 void setAudioChangerType(AudioChangerType type);
 ```
@@ -71,7 +72,7 @@ void setAudioChangerType(AudioChangerType type);
 
 **版本信息**
 
-从 3.5 版本开始支持。
+从3.5版本开始支持。
 
 **调用时机**
 
@@ -86,15 +87,16 @@ void setAudioChangerType(AudioChangerType type);
 >
 
 **参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| type | AudioChangerType | 必填 | 变声效果类型。 |
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|type|AudioChangerType|变声效果类型。|
 
 ### 混响设置
 
 #### setAudioReverbType
 
-设置混响效果
+设置混响效果。
 ``` dart
 void setAudioReverbType(AudioReverbType type);
 ```
@@ -105,7 +107,7 @@ void setAudioReverbType(AudioReverbType type);
 
 **版本信息**
 
-从 3.5 版本开始支持。
+从3.5版本开始支持。
 
 **调用时机**
 
@@ -120,15 +122,16 @@ void setAudioReverbType(AudioReverbType type);
 >
 
 **参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| type | AudioReverbType | 必填 | 混响效果类型。 |
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|type|AudioReverbType|混响效果类型。|
 
 ### 耳返设置
 
 #### setVoiceEarMonitorEnable
 
-开启/关闭耳返
+开启/关闭耳返。
 ``` dart
 void setVoiceEarMonitorEnable(bool enable);
 ```
@@ -137,7 +140,7 @@ void setVoiceEarMonitorEnable(bool enable);
 
 **版本信息**
 
-从 3.5 版本开始支持。
+从3.5版本开始支持。
 
 **适用场景**
 
@@ -156,13 +159,14 @@ void setVoiceEarMonitorEnable(bool enable);
 >
 
 **参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| enable | bool | 必填 | 是否开启耳返。 |
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|enable|bool|是否开启耳返。|
 
 #### setVoiceEarMonitorVolume
 
-设置耳返音量
+设置耳返音量。
 ``` dart
 void setVoiceEarMonitorVolume(int volume);
 ```
@@ -171,7 +175,7 @@ void setVoiceEarMonitorVolume(int volume);
 
 **版本信息**
 
-从 3.5 版本开始支持。
+从3.5版本开始支持。
 
 **调用时机**
 
@@ -182,19 +186,20 @@ void setVoiceEarMonitorVolume(int volume);
 > **说明：**
 >
 
-> 如果将 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
 
-重置为默认状态
+重置为默认状态。
 ``` dart
 void reset();
 ```
@@ -203,7 +208,7 @@ void reset();
 
 **版本信息**
 
-从 3.5 版本开始支持。
+从3.5版本开始支持。
 
 **调用时机**
 
@@ -214,65 +219,63 @@ void reset();
 ### 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 | 空灵。 |
+
+|**枚举值**|**值**|**说明**|
+|---------|---------|---------|
+|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 | 磁性。 |
+
+|**枚举值**|**值**|**说明**|
+|---------|---------|---------|
+|none|0|关闭特效。|
+|ktv|1|KTV。|
+|smallRoom|2|小房间。|
+|auditorium|3|大会堂。|
+|deep|4|低沉。|
+|loud|5|洪亮。|
+|metallic|6|金属声。|
+|magnetic|7|磁性。|
 
 ### AudioEffectState
 
 AudioEffectStore 对外提供的音效相关状态数据。
-| **属性** | **类型** | **说明** |
-| --- | --- | --- |
-| audioChangerType | ValueListenable<AudioChangerType> | 变声状态。 |
-| audioReverbType | ValueListenable<AudioReverbType> | 混响状态。 |
-| isEarMonitorOpened | ValueListenable<bool> | 耳返开启。 |
-| earMonitorVolume | ValueListenable<int> | 耳返音量，取值范围 0 - 100。<br>如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。 |
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|audioChangerType|ValueListenable<AudioChangerType>|变声状态。|
+|audioReverbType|ValueListenable<AudioReverbType>|混响状态。|
+|isEarMonitorOpened|ValueListenable<bool>|耳返开启。|
+|earMonitorVolume|ValueListenable<int>|耳返音量，取值范围0到100。<br>如果将 volume 设置成100之后感觉音量还是太小，可以将 volume 最大设置成150，但超过100的 volume 会有爆音的风险，请谨慎操作。|
 
 ## 使用示例
 ``` dart
 // 获取单例实例
 final store = AudioEffectStore.shared;
-
 // 订阅状态变化
 store.audioEffectState.audioChangerType.addListener(() {
     print("当前变声效果: ${store.audioEffectState.audioChangerType.value}");
 });
-
 store.audioEffectState.audioReverbType.addListener(() {
     print("当前混响效果: ${store.audioEffectState.audioReverbType.value}");
 });
-
 // 设置变声效果
 store.setAudioChangerType(AudioChangerType.littleGirl);
-
 // 设置混响效果
 store.setAudioReverbType(AudioReverbType.ktv);
-
 // 开启耳返
 store.setVoiceEarMonitorEnable(true);
 store.setVoiceEarMonitorVolume(80);

package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md

@@ -0,0 +1,212 @@
+## 简介
+
+`BarrageStore` 提供了一套完整的弹幕管理 API，包括发送文本弹幕、发送自定义消息和添加本地提示消息。 通过该类，可以在直播间内实现弹幕互动功能。
+
+> **重要：**
+>
+
+> 使用 **create** 工厂方法创建 `BarrageStore` 实例，需要传入有效的直播间 ID。
+>
+
+> **说明：**
+>
+
+> 弹幕状态更新通过 **barrageState** 发布者传递。订阅它以接收房间内弹幕数据的实时更新。
+>
+
+## 功能特性
+- **文本弹幕**：支持发送纯文本弹幕消息。
+
+- **自定义消息**：支持发送自定义格式的弹幕消息（可用于房间公告，服务侧弹幕消息通知等）。
+
+- **本地提示**：支持添加仅本地可见的提示消息。
+
+## 可订阅数据
+
+**BarrageState** 的字段描述如下：
+
+|**属性名**|**类型**|**描述**|
+|---------|---------|---------|
+|messageList|ValueListenable<List<Barrage>>|当前房间的弹幕消息列表，支持实时更新并可被订阅监听。|
+
+## API 列表
+
+|**函数名**|**描述**|
+|---------|---------|
+|create|创建弹幕管理实例。|
+|addBarrageListener|添加弹幕事件监听器以接收自定义消息。|
+|removeBarrageListener|移除弹幕事件监听器。|
+|sendTextMessage|发送文本弹幕。|
+|sendCustomMessage|发送自定义消息。|
+|appendLocalTip|添加本地提示消息。|
+
+### 创建实例
+
+#### create
+
+弹幕管理核心类，用于处理直播间/语音聊天房内的弹幕相关业务逻辑。
+``` dart
+static BarrageStore create(String liveID) {
+  return StoreFactory.shared.getStore<BarrageStore>(roomID: liveID);
+}
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|liveID|String|直播间 ID。|
+
+### 观察事件
+
+#### addBarrageListener
+
+添加弹幕事件监听器。
+``` dart
+void addBarrageListener(BarrageListener listener);
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|listener|BarrageListener|弹幕事件监听器实例。|
+
+#### removeBarrageListener
+
+移除弹幕事件监听器。
+``` dart
+void removeBarrageListener(BarrageListener listener);
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|listener|BarrageListener|要移除的弹幕事件监听器实例。|
+
+### 发送弹幕
+
+#### sendTextMessage
+
+发送文本类型弹幕，当发送成功之后，接收端可通过提前订阅 BarrageState 中的 messageList 来获取弹幕消息。
+``` dart
+Future<CompletionHandler> sendTextMessage({
+  required String text,
+  Map<String, String>? extensionInfo,
+});
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|text|String|文本弹幕内容。|
+|extensionInfo|Map<String,String>?|扩展信息，可包含自定义字段（如指定弹幕颜色、字体大小等）。|
+
+#### sendCustomMessage
+
+发送自定义类型弹幕消息，当发送成功之后，接收端可通过订阅 BarrageStore 提供的 addBarrageListener 来订阅自定义消息。
+``` dart
+Future<CompletionHandler> sendCustomMessage({
+  required String businessID,
+  required String data,
+});
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|businessID|String|业务标识 ID，用于区分不同业务场景的自定义消息。|
+|data|String|自定义数据内容，通常为 JSON 格式字符串，用于传递业务自定义的数据。|
+
+### 本地消息
+
+#### appendLocalTip
+
+添加本地提示消息（在本地添加提示或操作反馈消息，仅当前客户端可见）。
+``` dart
+void appendLocalTip(Barrage message);
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**注意事项**
+
+> **说明：**
+>
+
+> 该消息仅在本地显示，不会通过网络发送给其他用户。
+>
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|message|Barrage|本地弹幕消息（如系统提示、操作反馈等，仅当前用户可见）。|
+
+## 数据结构
+
+### BarrageType
+
+弹幕类型枚举，用于区分不同的弹幕消息种类。
+
+|**枚举值**|**值**|**说明**|
+|---------|---------|---------|
+|text|0|文本类型弹幕，包含纯文字内容。|
+|custom|1|自定义类型弹幕，支持业务自定义数据格式（如带特效的弹幕、互动消息等）。|
+
+### Barrage
+
+弹幕数据模型，包含单条弹幕的完整属性信息。
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|liveID|String|弹幕所属直播间/语音聊天房的唯一标识 ID。|
+|sender|LiveUserInfo|弹幕发送者的用户信息（如用户 ID、昵称、头像等）。|
+|sequence|int|弹幕消息的唯一序列 ID，用于消息排序和去重。|
+|timestampInSecond|int|弹幕发送时间戳（单位：秒），用于展示发送时间顺序。|
+|messageType|BarrageType|弹幕消息类型（文本或自定义）。|
+|textContent|String|文本类型弹幕的消息内容，即弹幕的文本内容。|
+|extensionInfo|Map<String,String>|弹幕扩展信息，可自定义字段（如显示样式、优先级等）。当 messageType 为 TEXT 时有效。|
+|businessID|String|自定义类型弹幕的业务标识 ID，用于区分不同业务场景的自定义消息。|
+|data|String|自定义类型弹幕的具体数据内容（通常为 JSON 格式字符串），当 messageType 为 CUSTOM 时有效。|
+
+### BarrageState
+
+弹幕状态，管理当前房间的弹幕数据状态。
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|messageList|ValueListenable<List<Barrage>>|当前房间的弹幕消息列表，支持实时更新并可被订阅监听。|
+
+### BarrageListener
+
+弹幕事件监听器。
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|onCustomMessageReceived|voidFunction(Barrage)?|收到自定义弹幕消息时触发的回调。自定义消息不会添加到 **BarrageState.messageList**，而是通过此回调进行分发。|