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

package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md

@@ -1,170 +0,0 @@
-## 简介
-
-**LoginStore** 提供了一套完整的登录管理 API，包括用户登录、登出、设置个人信息等功能。
-通过该类，可以管理用户的登录状态和用户资料。
-
-> **重要：**
->
-
-> 使用 **shared** 单例对象访问 **LoginStore** 实例。
->
-
-> **说明：**
->
-
-> 登录状态更新通过 **loginState** 发布者传递。订阅它以接收登录状态的实时更新。
->
-
-## 功能特性
-- **用户登录**：支持使用 SDK 应用 ID、用户 ID 和用户签名进行登录。
-
-- **用户登出**：支持用户登出操作。
-
-- **个人信息设置**：支持设置用户昵称、头像、性别等个人资料。
-
-## 可订阅数据
-
-**LoginState** 的字段描述如下：
-| **属性名** | **类型** | **描述** |
-| --- | --- | --- |
-| loginStatus | LoginStatus | 登录状态。 |
-| loginUserInfo | UserProfile? | 登录用户信息。 |
-
-## API 列表
-| **函数名** | **描述** |
-| --- | --- |
-| shared | 单例对象。 |
-| loginEventPublisher | 登录事件发布者。 |
-| login | 登录。 |
-| logout | 登出。 |
-| setSelfInfo | 设置个人信息。 |
-
-### 获取实例
-
-#### shared
-
-单例对象
-``` dart
-static LoginStore get shared => LoginStoreImpl.instance;
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-### 观察事件
-
-#### loginEventPublisher
-
-登录事件发布者
-
-### 登录操作
-
-#### login
-
-登录
-``` dart
-Future<CompletionHandler> login({
-  required int sdkAppID,
-  required String userID,
-  required String userSig,
-});
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| sdkAppID | int | 必填 | SDK 应用 ID。 |
-| userID | String | 必填 | 用户 ID。 |
-| userSig | String | 必填 | 用户签名。 |
-
-#### logout
-
-登出
-``` dart
-Future<CompletionHandler> logout();
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-#### setSelfInfo
-
-设置个人信息
-``` dart
-Future<CompletionHandler> setSelfInfo({required UserProfile userInfo});
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| userProfile | UserProfile | 必填 | 用户资料。 |
-
-## 数据结构
-
-### LoginStatus
-
-登录状态。
-| **枚举值** | **说明** |
-| --- | --- |
-| unlogin | 未登录。 |
-| logined | 已登录。 |
-
-### AllowType
-
-好友验证方式。
-| **枚举值** | **值** | **说明** |
-| --- | --- | --- |
-| allowAny | 0 | 允许任何人。 |
-| needConfirm | 1 | 需要验证。 |
-| denyAny | 2 | 拒绝任何人。 |
-
-### Gender
-
-性别。
-| **枚举值** | **值** | **说明** |
-| --- | --- | --- |
-| unknown | 0 | 未知。 |
-| male | 1 | 男性。 |
-| female | 2 | 女性。 |
-
-### LoginEvent
-
-登录事件。
-| **枚举值** | **说明** |
-| --- | --- |
-| kickedOffline | 当前用户被踢下线。 |
-| loginExpired | 登录票据过期。 |
-
-### UserProfile
-
-用户资料。
-| **属性** | **类型** | **说明** |
-| --- | --- | --- |
-| userID | String | 用户 ID。 |
-| nickname | String? | 昵称。 |
-| avatarURL | String? | 头像URL。 |
-| selfSignature | String? | 个性签名。 |
-| gender | Gender? | 性别。 |
-| role | int? | 角色。 |
-| level | int? | 等级。 |
-| birthday | int? | 生日。 |
-| allowType | AllowType? | 好友验证方式。 |
-| customInfo | Map<String,String>? | 自定义信息。 |
-
-### LoginState
-
-登录状态。
-| **属性** | **类型** | **说明** |
-| --- | --- | --- |
-| loginStatus | LoginStatus | 登录状态。 |
-| loginUserInfo | UserProfile? | 登录用户信息。 |

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

@@ -1,165 +0,0 @@
-## 简介
-
-**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] | 当前房间的弹幕消息列表，支持实时更新并可被订阅监听。 |

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

@@ -1,143 +0,0 @@
-## 简介
-
-基础美颜功能通过简单易用的 API 实现实时美颜效果调节。**BaseBeautyStore** 提供了一套完整的接口来管理美颜效果的设置和状态订阅。
-
-> **说明：**
->
-
-> 美颜状态更新通过 **state** 发布者传递。订阅它以接收有关美颜效果级别的实时更新。
->
-
-## 功能特性
-- **磨皮效果**：支持 0-9 级别的磨皮效果调节。
-
-- **美白效果**：支持 0-9 级别的美白效果调节。
-
-- **红润效果**：支持 0-9 级别的红润效果调节。
-
-- **状态订阅**：实时订阅美颜状态变化，同步 UI 显示与实际效果。
-
-## 可订阅数据
-
-**BaseBeautyState** 的字段描述如下：
-| **属性名** | **类型** | **描述** |
-| --- | --- | --- |
-| smoothLevel | Float | 磨皮级别，取值范围 [0-9]；0 表示关闭，9 表示效果最明显。 |
-| whitenessLevel | Float | 美白级别，取值范围 [0-9]；0 表示关闭，9 表示效果最明显。 |
-| ruddyLevel | Float | 红润级别，取值范围 [0-9]；0 表示关闭，9 表示效果最明显。 |
-
-## API 列表
-| **函数名** | **描述** |
-| --- | --- |
-| shared | 获取单例实例。 |
-| setSmoothLevel | 设置磨皮级别。 |
-| setWhitenessLevel | 设置美白级别。 |
-| setRuddyLevel | 设置红润级别。 |
-| reset | 重置为默认状态。 |
-
-### 获取实例
-
-#### shared
-
-获取单例实例。
-
-### 美颜调节
-
-#### setSmoothLevel
-
-设置磨皮级别
-``` swift
-public func setSmoothLevel(smoothLevel: Float) {
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| smoothLevel | Float | 必填 | 磨皮级别，取值范围 [0, 9]；0 表示关闭，9 表示效果最明显。 |
-
-#### setWhitenessLevel
-
-设置美白级别
-``` swift
-public func setWhitenessLevel(whitenessLevel: Float) {
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| whitenessLevel | Float | 必填 | 美白级别，取值范围 [0, 9]；0 表示关闭，9 表示效果最明显。 |
-
-#### setRuddyLevel
-
-设置红润级别
-``` swift
-public func setRuddyLevel(ruddyLevel: Float) {
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| ruddyLevel | Float | 必填 | 红润级别，取值范围 [0, 9]；0 表示关闭，9 表示效果最明显。 |
-
-#### reset
-
-将所有美颜参数（磨皮、美白、红润）重置为默认关闭状态（值为0）。
-``` swift
-public func reset() {
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-## 数据结构
-
-### BaseBeautyState
-
-基础美颜状态，管理磨皮、美白、红润等美颜效果的级别数据。支持订阅以同步 UI 显示与实际效果。
-| **属性** | **类型** | **说明** |
-| --- | --- | --- |
-| smoothLevel | Float | 磨皮级别，取值范围 [0-9]；0 表示关闭，9 表示效果最明显。 |
-| whitenessLevel | Float | 美白级别，取值范围 [0-9]；0 表示关闭，9 表示效果最明显。 |
-| ruddyLevel | Float | 红润级别，取值范围 [0-9]；0 表示关闭，9 表示效果最明显。 |
-
-## 使用示例
-``` swift
-// 获取单例实例
-let store = BaseBeautyStore.shared
-
-// 订阅状态变化
-store.state.subscribe { state in
-    print("磨皮级别: \(state.smoothLevel)")
-    print("美白级别: \(state.whitenessLevel)")
-    print("红润级别: \(state.ruddyLevel)")
-}
-
-// 设置美颜效果
-store.setSmoothLevel(smoothLevel: 5)
-store.setWhitenessLevel(whitenessLevel: 3)
-store.setRuddyLevel(ruddyLevel: 2)
-
-// 重置所有美颜效果
-store.reset()
-```