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

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

@@ -0,0 +1,281 @@
+## 简介
+
+`LiveAudienceStore` 提供了一套完整的观众管理 API，包括获取观众列表、设置管理员、踢出用户、禁言等功能。 通过该类，可以在直播间内实现观众管理功能。
+
+> **重要：**
+>
+
+> 使用 **LiveAudienceStore.create** 工厂方法创建 `LiveAudienceStore` 实例，需要传入有效的直播间 ID。
+>
+
+> **说明：**
+>
+
+> 观众状态更新通过 **liveAudienceState** 发布者传递。订阅它以接收房间内观众数据的实时更新。
+>
+
+## 功能特性
+- **观众列表**：获取和管理当前房间的观众列表。
+
+- **权限管理**：设置和撤销管理员权限。
+
+- **用户管理**：踢出用户、禁言等操作。
+
+- **事件监听**：监听房主、管理员、观众加入/离开等事件。
+
+## 可订阅数据
+
+**LiveAudienceState** 的字段描述如下：
+
+|**属性名**|**类型**|**描述**|
+|---------|---------|---------|
+|audienceList|ValueListenable<List<LiveUserInfo>>|观众列表。|
+|audienceCount|ValueListenable<int>|观众数量。|
+|adminList|ValueListenable<List<LiveUserInfo>>|管理员列表。|
+|messageBannedUserList|ValueListenable<List<LiveUserInfo>>|消息被禁言的用户列表。|
+
+## API 列表
+
+|**函数名**|**描述**|
+|---------|---------|
+|LiveAudienceStore.create|创建观众管理实例。|
+|addLiveAudienceListener|观众事件回调。|
+|removeLiveAudienceListener|观众事件回调。|
+|fetchAudienceList|获取观众列表。|
+|setAdministrator|设置管理员。|
+|revokeAdministrator|撤销管理员。|
+|kickUserOutOfRoom|踢出用户。|
+|disableSendMessage|禁言/解禁用户。|
+
+### 创建实例
+
+#### LiveAudienceStore.create
+
+创建观众管理实例。
+
+### 观察状态和事件
+
+#### addLiveAudienceListener
+
+添加观众事件监听器。
+``` dart
+void addLiveAudienceListener(LiveAudienceListener listener);
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|listener|LiveAudienceListener|监听器。|
+
+#### removeLiveAudienceListener
+
+移除观众事件监听器。
+``` dart
+void removeLiveAudienceListener(LiveAudienceListener listener);
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|listener|LiveAudienceListener|监听器。|
+
+### 观众管理
+
+#### fetchAudienceList
+
+获取观众列表。
+``` dart
+Future<CompletionHandler> fetchAudienceList();
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+#### setAdministrator
+
+设置管理员。
+``` dart
+Future<CompletionHandler> setAdministrator(String userID);
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|userID|String|要设置为管理员的用户 ID。|
+
+#### revokeAdministrator
+
+撤销管理员。
+``` dart
+Future<CompletionHandler> revokeAdministrator(String userID);
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|userID|String|要撤销管理员权限的用户 ID。|
+
+#### kickUserOutOfRoom
+
+将用户踢出房间。
+``` dart
+Future<CompletionHandler> kickUserOutOfRoom(String userID);
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|userID|String|要踢出的用户 ID。|
+
+#### disableSendMessage
+
+禁用/解禁用户发送消息。
+``` dart
+Future<CompletionHandler> disableSendMessage({
+  required String userID,
+  required bool isDisable,
+});
+```
+
+**版本信息**
+
+从3.5版本开始支持。
+
+**参数说明**
+
+|**参数名**|**类型**|**描述**|
+|---------|---------|---------|
+|userID|String|目标用户 ID。|
+|isDisable|bool|true 表示禁用发送消息，false 表示解禁。|
+
+## 数据结构
+
+### Role
+
+用户角色。
+
+|**枚举值**|**说明**|
+|---------|---------|
+|owner|房主。|
+|admin|管理员。|
+|generalUser|普通用户。|
+
+### LiveUserInfo
+
+直播用户信息。
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|userID|String|用户唯一标识 ID。|
+|userName|String|用户名称。|
+|avatarURL|String|用户头像 URL。|
+
+### LiveAudienceState
+
+直播观众状态。
+
+|**属性**|**类型**|**说明**|
+|---------|---------|---------|
+|audienceList|ValueListenable<List<LiveUserInfo>>|观众列表。|
+|audienceCount|ValueListenable<int>|观众数量。|
+|adminList|ValueListenable<List<LiveUserInfo>>|管理员列表。|
+|messageBannedUserList|ValueListenable<List<LiveUserInfo>>|消息被禁言的用户列表。|
+
+### LiveAudienceListener
+
+直播观众事件。
+
+此监听器用于接收直播间内全角色（房主、管理员、观众）的动态事件。
+
+**方法**
+
+**onOwnerJoined**: 房主加入事件。
+``` dart
+void Function(LiveUserInfo owner)? onOwnerJoined;
+```
+
+|**参数名**|**类型**|**说明**|
+|---------|---------|---------|
+|owner|LiveUserInfo|加入的房主信息。|
+
+**onOwnerLeft**: 房主离开事件。
+``` dart
+void Function(LiveUserInfo owner)? onOwnerLeft;
+```
+
+|**参数名**|**类型**|**说明**|
+|---------|---------|---------|
+|owner|LiveUserInfo|离开的房主信息。|
+
+**onAdminJoined**: 管理员加入事件。
+``` dart
+void Function(LiveUserInfo admin)? onAdminJoined;
+```
+
+|**参数名**|**类型**|**说明**|
+|---------|---------|---------|
+|admin|LiveUserInfo|加入的管理员信息。|
+
+**onAdminLeft**: 管理员离开事件。
+``` dart
+void Function(LiveUserInfo admin)? onAdminLeft;
+```
+
+|**参数名**|**类型**|**说明**|
+|---------|---------|---------|
+|admin|LiveUserInfo|离开的管理员信息。|
+
+**onAudienceJoined**: 观众加入事件。
+``` dart
+void Function(LiveUserInfo audience)? onAudienceJoined;
+```
+
+|**参数名**|**类型**|**说明**|
+|---------|---------|---------|
+|audience|LiveUserInfo|加入的观众信息。|
+
+**onAudienceLeft**: 观众离开事件。
+``` dart
+void Function(LiveUserInfo audience)? onAudienceLeft;
+```
+
+|**参数名**|**类型**|**说明**|
+|---------|---------|---------|
+|audience|LiveUserInfo|离开的观众信息。|
+
+**onAudienceMessageDisabled**: 观众被禁止发言事件。
+``` dart
+void Function(LiveUserInfo audience, bool isDisable)? onAudienceMessageDisabled;
+LiveAudienceListener({this.onOwnerJoined, this.onOwnerLeft, this.onAdminJoined, this.onAdminLeft, this.onAudienceJoined, this.onAudienceLeft, this.onAudienceMessageDisabled});
+```
+
+|**参数名**|**类型**|**说明**|
+|---------|---------|---------|
+|audience|LiveUserInfo|观众信息。|
+|isDisable|bool|是否被禁止发言。|

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

@@ -1,7 +1,6 @@
 ## 简介
 
-**LiveCoreView** 提供了直播推流和播放的视图容器，支持多人连麦、PK 等功能。
-通过该组件，可以实现直播间的视频渲染和交互。
+`LiveCoreView` 提供了直播推流和播放的视图容器，支持多人连麦、PK 等功能。 通过该组件，可以实现直播间的视频渲染和交互。
 
 > **重要：**
 >
@@ -23,22 +22,24 @@
 ### CoreViewType
 
 核心视图类型。
-| **枚举值** | **说明** |
-| --- | --- |
-| playView | 播放视图。 |
-| pushView | 推流视图。 |
+
+|**枚举值**|**说明**|
+|---------|---------|
+|playView|播放视图。|
+|pushView|推流视图。|
 
 ### ViewLayer
 
 视图层级。
-| **枚举值** | **说明** |
-| --- | --- |
-| foreground | 前景层。 |
-| background | 背景层。 |
+
+|**枚举值**|**说明**|
+|---------|---------|
+|foreground|前景层。|
+|background|背景层。|
 
 ### LiveCoreController
 
-Live core widget controller protocol
+Live core widget controller protocol。
 
 **方法**
 
@@ -48,37 +49,41 @@ static LiveCoreController create(CoreViewType type) {
   return LiveCoreControllerImpl(type);
 }
 ```
-| **参数名** | **类型** | **说明** |
-| --- | --- | --- |
-| type | CoreViewType | 核心视图类型。 |
 
-**setLiveID**: 设置直播ID。应该在使用其他接口之前先设置直播ID。
+|**参数名**|**类型**|**说明**|
+|---------|---------|---------|
+|type|CoreViewType|核心视图类型。|
+
+**setLiveID**: 设置直播 ID。应该在使用其他接口之前先设置直播 ID。
 ``` dart
 void setLiveID(String liveID);
 ```
-| **参数名** | **类型** | **说明** |
-| --- | --- | --- |
-| liveID | String | 直播ID。 |
+
+|**参数名**|**类型**|**说明**|
+|---------|---------|---------|
+|liveID|String|直播 ID。|
 
 **startPreviewLiveStream**: 房间外预览。
 ``` dart
-void startPreviewLiveStream(String roomID, bool isMuteAudio, int viewID, TUIPlayCallback? playCallback);
+void startPreviewLiveStream(String roomID, bool isMuteAudio, TUIPlayCallback? playCallback);
 ```
-| **参数名** | **类型** | **说明** |
-| --- | --- | --- |
-| roomID | String | 直播ID。 |
-| isMuteAudio | bool | 是否静音。 |
-| playCallback | TUIPlayCallback? | 播放回调。 |
+
+|**参数名**|**类型**|**说明**|
+|---------|---------|---------|
+|roomID|String|直播 ID。|
+|isMuteAudio|bool|是否静音。|
+|playCallback|TUIPlayCallback?|播放回调。|
 
 **stopPreviewLiveStream**: 停止房间外预览。
 ``` dart
 void stopPreviewLiveStream(String roomID);
 ```
-| **参数名** | **类型** | **说明** |
-| --- | --- | --- |
-| roomID | String | 直播ID。 |
 
-**callExperimentalAPI**: 调用实验性API。
+|**参数名**|**类型**|**说明**|
+|---------|---------|---------|
+|roomID|String|直播 ID。|
+
+**callExperimentalAPI**: 调用实验性 API。
 ``` dart
 static void callExperimentalAPI(String jsonStr) {
   LiveCoreControllerImpl.callExperimentalAPI(jsonStr);
@@ -97,10 +102,11 @@ CoGuestWidgetBuilder coGuestWidgetBuilder = (BuildContext context, SeatInfo seat
   return Container();
 };
 ```
-| **参数名** | **类型** | **说明** |
-| --- | --- | --- |
-| seatInfo | SeatInfo | 连麦用户的麦位信息。 |
-| viewLayer | ViewLayer | 视图层级，前景层或背景层。 |
+
+|**参数名**|**类型**|**说明**|
+|---------|---------|---------|
+|seatInfo|SeatInfo|连麦用户的麦位信息。|
+|viewLayer|ViewLayer|视图层级，前景层或背景层。|
 
 **createCoHostView**: 创建跨房连麦视图。
 ``` dart
@@ -108,27 +114,28 @@ CoHostWidgetBuilder coHostWidgetBuilder = (BuildContext context, SeatInfo seatIn
   return Container();
 };
 ```
-| **参数名** | **类型** | **说明** |
-| --- | --- | --- |
-| seatInfo | SeatInfo | 跨房连麦用户的麦位信息。 |
-| viewLayer | ViewLayer | 视图层级，前景层或背景层。 |
 
-**createBattleView**: 创建PK视图。
+|**参数名**|**类型**|**说明**|
+|---------|---------|---------|
+|seatInfo|SeatInfo|跨房连麦用户的麦位信息。|
+|viewLayer|ViewLayer|视图层级，前景层或背景层。|
+
+**createBattleView**: 创建 PK 视图。
 ``` dart
 BattleWidgetBuilder battleWidgetBuilder = (BuildContext context, SeatInfo seatInfo) {
   return Container();
 };
 ```
-| **参数名** | **类型** | **说明** |
-| --- | --- | --- |
-| seatInfo | SeatInfo | PK用户的麦位信息。 |
 
-**createBattleContainerView**: 创建PK容器视图。
+|**参数名**|**类型**|**说明**|
+|---------|---------|---------|
+|seatInfo|SeatInfo|PK 用户的麦位信息。|
+
+**createBattleContainerView**: 创建 PK 容器视图。
 ``` dart
 BattleContainerWidgetBuilder battleContainerWidgetBuilder = (BuildContext context) {
   return Container();
 };
-
 VideoWidgetBuilder({
   CoGuestWidgetBuilder? coGuestWidgetBuilder,
   CoHostWidgetBuilder? coHostWidgetBuilder,