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

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

@@ -0,0 +1,397 @@
+## 简介
+
+`LiveSeatStore` 提供了一套完整的麦位管理 API，包括上麦、下麦、锁麦、解锁麦位、踢用户下麦、远程控制设备等功能。 通过该类，可以在直播间内实现麦位管理功能。
+
+> **重要：**
+>
+
+> 使用 **LiveSeatStore.create** 工厂方法创建 `LiveSeatStore` 实例，需要传入有效的直播间 ID。
+>
+
+> **说明：**
+>
+
+> 麦位状态更新通过 **liveSeatState** 发布者传递。订阅它以接收房间内麦位数据的实时更新。
+>
+
+## 功能特性
+- **麦位管理**：上麦、下麦、锁麦、解锁麦位等操作。
+
+- **用户管理**：踢用户下麦、移动用户到指定麦位。
+
+- **设备控制**：远程控制用户的摄像头和麦克风。
+
+- **事件监听**：监听麦位相关事件。
+
+## 可订阅数据
+
+**LiveSeatState** 的字段描述如下：
+
+|**属性名**|**类型**|**描述**|
+|---------|---------|---------|
+|seatList|ValueListenable<List<SeatInfo>>|麦位列表。|
+|canvas|ValueListenable<LiveCanvas>|画布信息。|
+|speakingUsers|ValueListenable<Map<String,int>>|正在说话的用户。|
+|avStatistics|ValueListenable<List<AVStatistics>>|音视频相关统计信息。|
+
+## API 列表
+
+|**函数名**|**描述**|
+|---------|---------|
+|LiveSeatStore.create|创建麦位管理实例。|
+|addLiveSeatEventListener|麦位事件回调。|
+|removeLiveSeatEventListener|麦位事件回调。|
+|takeSeat|上麦。|
+|leaveSeat|下麦。|
+|lockSeat|锁麦。|
+|unlockSeat|解锁麦位。|
+|kickUserOutOfSeat|踢用户下麦。|
+|moveUserToSeat|移动用户。|
+|openRemoteCamera|开启远程摄像头。|
+|closeRemoteCamera|关闭远程摄像头。|
+|openRemoteMicrophone|开启远程麦克风。|
+|closeRemoteMicrophone|关闭远程麦克风。|
+
+### 创建实例
+
+#### LiveSeatStore.create
+
+创建麦位管理实例。
+
+### 观察状态和事件
+
+#### addLiveSeatEventListener
+
+添加麦位事件监听器。
+``` dart
+void addLiveSeatEventListener(LiveSeatListener listener);
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|listener|LiveSeatListener|监听器。|
+
+#### removeLiveSeatEventListener
+
+移除麦位事件监听器。
+``` dart
+void removeLiveSeatEventListener(LiveSeatListener listener);
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|listener|LiveSeatListener|监听器。|
+
+### 麦位操作
+
+#### takeSeat
+
+上麦。
+``` dart
+Future<CompletionHandler> takeSeat(int seatIndex);
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|seatIndex|int|麦位索引。|
+
+#### leaveSeat
+
+下麦。
+``` dart
+Future<CompletionHandler> leaveSeat();
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+#### lockSeat
+
+锁定麦位。
+``` dart
+Future<CompletionHandler> lockSeat(int seatIndex);
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|seatIndex|int|麦位索引。|
+
+#### unlockSeat
+
+解锁麦位。
+``` dart
+Future<CompletionHandler> unlockSeat(int seatIndex);
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|seatIndex|int|麦位索引。|
+
+### 用户管理
+
+#### kickUserOutOfSeat
+
+踢用户下麦。
+``` dart
+Future<CompletionHandler> kickUserOutOfSeat(String userID);
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|userID|String|用户 ID。|
+
+#### moveUserToSeat
+
+移动用户到麦位。
+``` dart
+Future<CompletionHandler> moveUserToSeat({
+  required String userID,
+  required int targetIndex,
+  MoveSeatPolicy policy = MoveSeatPolicy.abortWhenOccupied,
+});
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|userID|String|用户 ID。|
+|targetIndex|int|目标麦位索引。|
+|policy|MoveSeatPolicy|移动策略。|
+
+### 远程设备控制
+
+#### openRemoteCamera
+
+开启远程摄像头。
+``` dart
+Future<CompletionHandler> openRemoteCamera({
+  required String userID,
+  required DeviceControlPolicy policy,
+});
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|userID|String|用户 ID。|
+|policy|DeviceControlPolicy|设备控制策略。|
+
+#### closeRemoteCamera
+
+关闭远程摄像头。
+``` dart
+Future<CompletionHandler> closeRemoteCamera(String userID);
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|userID|String|用户 ID。|
+
+#### openRemoteMicrophone
+
+开启远程麦克风。
+``` dart
+Future<CompletionHandler> openRemoteMicrophone({
+  required String userID,
+  required DeviceControlPolicy policy,
+});
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|userID|String|用户 ID。|
+|policy|DeviceControlPolicy|设备控制策略。|
+
+#### closeRemoteMicrophone
+
+关闭远程麦克风。
+``` dart
+Future<CompletionHandler> closeRemoteMicrophone(String userID);
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|userID|String|用户 ID。|
+
+## 数据结构
+
+### MoveSeatPolicy
+
+移动麦位策略。
+
+|**枚举值**|**说明**|
+|---------|---------|
+|abortWhenOccupied|被占用时中止。|
+|forceReplace|强制替换。|
+|swapPosition|交换位置。|
+
+### DeviceControlPolicy
+
+设备控制策略。
+
+|**枚举值**|**说明**|
+|---------|---------|
+|unlockOnly|仅解锁。|
+
+### SuspendStatus
+
+用户的挂起状态。
+
+|**枚举值**|**说明**|
+|---------|---------|
+|none|未挂起。|
+|inBackground|用户进入后台挂起。|
+|inCalling|用户正在接听电话。|
+
+### LiveSeatListener
+
+麦位相关的回调事件。
+
+**方法**
+
+|**方法名**|**说明**|
+|---------|---------|
+|onLocalCameraOpenedByAdmin|当本地摄像头被管理员开启时触发此回调。|
+|onLocalCameraClosedByAdmin|当本地摄像头被管理员关闭时触发此回调。|
+|onLocalMicrophoneOpenedByAdmin|当本地麦克风被管理员开启时触发此回调。|
+|onLocalMicrophoneClosedByAdmin|当本地麦克风被管理员关闭时触发此回调。|
+
+### SeatUserInfo
+
+麦位用户信息。
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|userID|String|用户 ID。|
+|userName|String|用户名。|
+|avatarURL|String|头像 URL。|
+|role|Role|用户角色。|
+|liveID|String|直播间 ID。|
+|microphoneStatus|DeviceStatus|麦克风状态。|
+|allowOpenMicrophone|bool|是否允许开启麦克风。|
+|cameraStatus|DeviceStatus|摄像头状态。|
+|allowOpenCamera|bool|是否允许开启摄像头。|
+|userSuspendStatus|SuspendStatus|用户挂起状态。|
+
+### RegionInfo
+
+麦位视图坐标信息。
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|x|int|X 坐标。|
+|y|int|Y 坐标。|
+|w|int|宽度。|
+|h|int|高度。|
+|zorder|int|层级顺序。|
+
+### AVStatistics
+
+音视频相关统计信息。
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|userID|String|用户 ID。|
+|videoBitrate|int|本地视频的码率。|
+|videoWidth|int|本地视频的宽度。|
+|videoHeight|int|本地视频的高度。|
+|frameRate|int|本地视频的帧率。|
+|audioSampleRate|int|音频的采样率。|
+|audioBitrate|int|音频码率。|
+
+### SeatInfo
+
+麦位信息。
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|index|int|麦位索引。|
+|isLocked|bool|是否锁定。|
+|userInfo|SeatUserInfo|用户信息。|
+|region|RegionInfo|区域信息。|
+
+### LiveCanvas
+
+直播画布。
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|w|int|宽度。|
+|h|int|高度。|
+|templateID|int|模板 ID。|
+
+### LiveSeatState
+
+LiveSeatStore 对外提供的麦位状态数据。
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|seatList|ValueListenable<List<SeatInfo>>|麦位列表。|
+|canvas|ValueListenable<LiveCanvas>|画布信息。|
+|speakingUsers|ValueListenable<Map<String,int>>|正在说话的用户。|
+|avStatistics|ValueListenable<List<AVStatistics>>|音视频相关统计信息。|

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

@@ -0,0 +1,183 @@
+## 简介
+
+`LoginStore` 提供了一套完整的登录管理 API，包括用户登录、登出、设置个人信息等功能。 通过该类，可以管理用户的登录状态和用户资料。
+
+> **重要：**
+>
+
+> 使用 **shared** 单例对象访问 `LoginStore` 实例。
+>
+
+> **说明：**
+>
+
+> 登录状态更新通过 **loginState** 发布者传递。订阅它以接收登录状态的实时更新。
+>
+
+## 功能特性
+- **用户登录**：支持使用 SDK 应用 ID、用户 ID 和用户签名进行登录。
+
+- **用户登出**：支持用户登出操作。
+
+- **个人信息设置**：支持设置用户昵称、头像、性别等个人资料。
+
+## 可订阅数据
+
+**LoginState** 的字段描述如下：
+
+|**属性名**|**类型**|**描述**|
+|---------|---------|---------|
+|loginStatus|LoginStatus|登录状态。|
+|loginUserInfo|UserProfile?|登录用户信息。|
+
+## API 列表
+
+|**函数名**|**描述**|
+|---------|---------|
+|shared|单例对象。|
+|loginEventStream|登录事件流。|
+|login|登录。|
+|logout|登出。|
+|setSelfInfo|设置个人信息。|
+
+### 获取实例
+
+#### shared
+
+单例对象。
+``` dart
+static LoginStore get shared => LoginStoreImpl.instance;
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+### 观察事件
+
+#### loginEventStream
+
+登录事件流。
+
+登录事件流。建议在调用 **login** 之前监听此事件流，以便能够及时接收登录相关事件。
+
+**数据结构：**LoginEvent
+
+### 登录操作
+
+#### login
+
+登录。
+``` dart
+Future<CompletionHandler> login({
+  required int sdkAppID,
+  required String userID,
+  required String userSig,
+});
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|sdkAppID|int|SDK 应用 ID。从 **控制台**(https://cloud.tencent.com/login?s_url=https%3A%2F%2Fconsole.cloud.tencent.com%2Ftrtc) 获取，通常是以 140 或 160 开头的 10 位整数。|
+|userID|String|用户 ID。建议限制长度为32字节，只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。|
+|userSig|String|用户签名。userSig 生成请参考 **用户鉴权**(https://cloud.tencent.com/document/product/647/17275)。|
+
+#### 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?|登录用户信息。|