@tencentcloud/sdk-mcp 1.3.9 → 1.4.0

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

@@ -0,0 +1,394 @@
+## 简介
+
+连麦功能通过基于麦位的系统实现主播和观众成员之间的实时互动。**CoGuestStore** 提供了一套全面的 API 来管理整个连麦生命周期。
+
+> **重要：**
+>
+
+> 请始终使用工厂方法 **CoGuestStore.create** 并提供有效的直播间 ID 来创建 **CoGuestStore** 实例。不要尝试直接初始化。
+>
+
+> **说明：**
+>
+
+> 连麦状态更新通过 **coGuestState** 发布者传递。订阅它以接收有关已连接用户、邀请和申请的实时更新。
+>
+
+> **警告：**
+>
+
+> 如果连麦请求在指定的超时时间内未收到响应，将触发带有 **NoResponseReason.timeout** 的事件。请始终在 UI 中处理超时场景。
+>
+
+## 功能特性
+- **双向邀请**：主播可以邀请观众成员，观众成员也可以申请加入。
+
+- **状态管理**：实时跟踪已连接用户、邀请和申请。
+
+- **事件驱动架构**：为主播和观众角色提供独立的事件流。
+
+- **超时处理**：为邀请和申请提供内置超时机制。
+
+## 可订阅数据
+
+**CoGuestState** 的字段描述如下：
+| **属性名** | **类型** | **描述** |
+| --- | --- | --- |
+| connected | ValueListenable<List<SeatUserInfo>> | 已经在麦位上的用户列表。 |
+| invitees | ValueListenable<List<LiveUserInfo>> | 主播发出邀请的用户列表。 |
+| applicants | ValueListenable<List<LiveUserInfo>> | 主播收到申请连麦的用户列表。 |
+| candidates | ValueListenable<List<LiveUserInfo>> | 候选连麦的用户列表。 |
+
+## API 列表
+| **函数名** | **描述** |
+| --- | --- |
+| CoGuestStore.create | 创建对象实例。 |
+| addHostListener | 主播端事件回调。 |
+| removeHostListener | 主播端事件回调。 |
+| addGuestListener | 观众端事件回调。 |
+| removeGuestListener | 观众端事件回调。 |
+| applyForSeat | 观众申请连麦。 |
+| cancelApplication | 观众取消申请。 |
+| acceptApplication | 主播接受申请。 |
+| rejectApplication | 主播拒绝申请。 |
+| inviteToSeat | 主播邀请观众连麦。 |
+| cancelInvitation | 主播取消邀请。 |
+| acceptInvitation | 观众接受邀请。 |
+| rejectInvitation | 观众拒绝邀请。 |
+| disconnect | 结束连麦会话。 |
+
+### 创建实例
+
+#### CoGuestStore.create
+
+创建对象实例。
+
+### 观察状态和事件
+
+#### addHostListener
+
+添加主播侧事件回调监听器
+``` dart
+void addHostListener(HostListener listener);
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| listener | HostListener | 必填 | 监听器。 |
+
+#### removeHostListener
+
+移除主播侧事件回调监听器
+``` dart
+void removeHostListener(HostListener listener);
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| listener | HostListener | 必填 | 监听器。 |
+
+#### addGuestListener
+
+添加观众侧事件回调监听器
+``` dart
+void addGuestListener(GuestListener listener);
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| listener | GuestListener | 必填 | 监听器。 |
+
+#### removeGuestListener
+
+移除观众侧事件回调监听器
+``` dart
+void removeGuestListener(GuestListener listener);
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| listener | GuestListener | 必填 | 监听器。 |
+
+### 观众操作
+
+#### applyForSeat
+
+申请上麦
+``` dart
+Future<CompletionHandler> applyForSeat({
+    required int seatIndex,
+    required int timeout,
+    String? extraInfo,
+});
+```
+
+以观众身份请求加入连麦会话。
+
+调用此方法后，会向直播间内的所有主播发送连麦请求。请求将保持活动状态，直到：
+• 主播通过 **acceptApplication** 接受
+• 主播通过 **rejectApplication** 拒绝
+• 超时时间到期
+• 您通过 **cancelApplication** 取消
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**注意事项**
+
+> **说明：**
+>
+
+> 如果在超时时间内没有主播响应，将触发带有 **NoResponseReason.timeout** 的 {ref2} 事件。
+>
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| seatIndex | int | 必填 | 麦位索引，-1 表示自动分配麦位。 |
+| timeout | int | 必填 | 超时时间（单位：秒）。 |
+| extraInfo | String? | 必填 | 额外信息。 |
+
+#### cancelApplication
+
+取消上麦申请
+``` dart
+Future<CompletionHandler> cancelApplication();
+```
+
+取消之前发送的连麦申请。调用此方法后，所有主播将收到申请取消的通知。
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**注意事项**
+
+> **说明：**
+>
+
+> 如果申请已被主播处理，取消操作可能无效。
+>
+
+#### acceptApplication
+
+接受上麦申请
+``` dart
+Future<CompletionHandler> acceptApplication(String userID);
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| userID | String | 必填 | 用户 ID。 |
+
+#### rejectApplication
+
+拒绝上麦申请
+``` dart
+Future<CompletionHandler> rejectApplication(String userID);
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| userID | String | 必填 | 用户 ID。 |
+
+### 主播操作
+
+#### inviteToSeat
+
+邀请观众上麦
+``` dart
+Future<CompletionHandler> inviteToSeat({
+    required String inviteeID,
+    required int seatIndex,
+    required int timeout,
+    String? extraInfo,
+});
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| inviteeID | String | 必填 | 被邀请用户 ID。 |
+| seatIndex | int | 必填 | 麦位索引，-1 表示自动分配麦位。 |
+| timeout | int | 必填 | 超时时间（单位：秒）。 |
+| extraInfo | String? | 必填 | 额外信息。 |
+
+#### cancelInvitation
+
+取消上麦邀请
+``` dart
+Future<CompletionHandler> cancelInvitation(String inviteeID);
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| inviteeID | String | 必填 | 被邀请用户 ID。 |
+
+#### acceptInvitation
+
+接受上麦邀请
+``` dart
+Future<CompletionHandler> acceptInvitation(String inviterID);
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| inviterID | String | 必填 | 邀请者用户 ID。 |
+
+#### rejectInvitation
+
+拒绝上麦邀请
+``` dart
+Future<CompletionHandler> rejectInvitation(String inviterID);
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| inviterID | String | 必填 | 邀请者用户 ID。 |
+
+### 连接控制
+
+#### disconnect
+
+结束连麦会话。
+
+## 数据结构
+
+### NoResponseReason
+
+主播发出的连麦邀请或者观众发起连麦请求的无响应原因。
+| **枚举值** | **值** | **说明** |
+| --- | --- | --- |
+| timeout | 0 | 请求超时。 |
+| alreadySeated | 1 | 用户已在麦位上。 |
+
+### HostListener
+
+主播侧收到的回调事件。
+
+**方法**
+| **方法名** | **说明** |
+| --- | --- |
+| onGuestApplicationReceived | 当观众申请连麦时触发此回调。 |
+| onGuestApplicationCancelled | 当观众取消连麦申请时触发此回调。 |
+| onGuestApplicationProcessedByOtherHost | 当观众的连麦申请被其他主播处理时触发此回调。 |
+| onHostInvitationResponded | 当主播发出的连麦邀请收到观众响应时触发此回调。 |
+| onHostInvitationNoResponse | 当主播发出的连麦邀请无响应时触发此回调。 |
+
+### GuestListener
+
+观众侧收到的回调事件。
+
+**方法**
+| **方法名** | **说明** |
+| --- | --- |
+| onHostInvitationReceived | 当收到主播的连麦邀请时触发此回调。 |
+| onHostInvitationCancelled | 当主播取消连麦邀请时触发此回调。 |
+| onGuestApplicationResponded | 当观众的连麦申请收到主播响应时触发此回调。 |
+| onGuestApplicationNoResponse | 当观众的连麦申请无响应时触发此回调。 |
+| onKickedOffSeat | 当观众被主播踢下麦位时触发此回调。 |
+
+### CoGuestState
+
+CoGuestStore 对外提供的连麦相关状态数据。
+| **属性** | **类型** | **说明** |
+| --- | --- | --- |
+| connected | ValueListenable<List<SeatUserInfo>> | 已经在麦位上的用户列表。 |
+| invitees | ValueListenable<List<LiveUserInfo>> | 主播发出邀请的用户列表。 |
+| applicants | ValueListenable<List<LiveUserInfo>> | 主播收到申请连麦的用户列表。 |
+| candidates | ValueListenable<List<LiveUserInfo>> | 候选连麦的用户列表。 |
+
+## 使用示例
+``` dart
+// 创建 store 实例
+final store = CoGuestStore.create('live_room_123');
+
+// 定义监听器
+late final VoidCallback connectedListener = _onConnectedChanged;
+late final VoidCallback applicantsListener = _onApplicantsChanged;
+
+void _onConnectedChanged() {
+    print('已连接用户: ${store.coGuestState.connected.value.length}');
+}
+
+void _onApplicantsChanged() {
+    print('待处理申请: ${store.coGuestState.applicants.value.length}');
+}
+
+// 订阅状态变化
+store.coGuestState.connected.addListener(connectedListener);
+store.coGuestState.applicants.addListener(applicantsListener);
+
+// 添加主播事件监听器（主播使用）
+final hostListener = HostListener(
+    onGuestApplicationReceived: (guestUser) {
+        print('收到来自 ${guestUser.userName} 的申请');
+        // 显示接受/拒绝的 UI
+    },
+    onHostInvitationResponded: (isAccept, guestUser) {
+        print('观众 ${guestUser.userName} ${isAccept ? "接受了" : "拒绝了"}');
+    },
+);
+store.addHostListener(hostListener);
+
+// 主播：接受申请
+final result = await store.acceptApplication('user_456');
+if (result.code == 0) {
+    print('申请接受成功');
+}
+
+// 完成后取消订阅
+store.coGuestState.connected.removeListener(connectedListener);
+store.coGuestState.applicants.removeListener(applicantsListener);
+store.removeHostListener(hostListener);
+```

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

@@ -0,0 +1,303 @@
+## 简介
+
+跨房连线功能允许不同直播间的主播进行实时互动。**CoHostStore** 提供了一套全面的 API 来管理整个跨房连线生命周期。
+
+> **重要：**
+>
+
+> 请始终使用工厂方法 **CoHostStore.create** 并提供有效的直播间 ID 来创建 **CoHostStore** 实例。不要尝试直接初始化。
+>
+
+> **说明：**
+>
+
+> 连线状态更新通过 **coHostState** 发布者传递。订阅它以接收有关连线状态、已连接主播、邀请和申请的实时更新。
+>
+
+> **警告：**
+>
+
+> 如果连线请求在指定的超时时间内未收到响应，将触发超时事件。请始终在 UI 中处理超时场景。
+>
+
+## 功能特性
+- **双向连线**：主播可以向其他主播发起连线请求，也可以接收其他主播的连线请求。
+
+- **状态管理**：实时跟踪连线状态、已连接主播、邀请列表和申请者。
+
+- **事件驱动架构**：提供连线事件流用于监听各种连线状态变化。
+
+- **布局模板**：支持多种连线布局模板，如动态网格布局和1对6布局。
+
+## 可订阅数据
+
+**CoHostState** 的字段描述如下：
+| **属性名** | **类型** | **描述** |
+| --- | --- | --- |
+| coHostStatus | ValueListenable<CoHostStatus> | 跨房连线的实时状态。 |
+| connected | ValueListenable<List<SeatUserInfo>> | 正在和当前直播间连线的主播列表。 |
+| invitees | ValueListenable<List<SeatUserInfo>> | 向其他直播间发出请求的主播列表。 |
+| applicant | ValueListenable<SeatUserInfo?> | 向当前直播间发起连线请求的主播。 |
+| candidatesCursor | ValueListenable<String> | 推荐用户列表游标。 |
+| candidates | ValueListenable<List<SeatUserInfo>> | 推荐用户列表。 |
+
+## API 列表
+| **函数名** | **描述** |
+| --- | --- |
+| CoHostStore.create | 创建对象实例。 |
+| addCoHostListener | 连线事件回调。 |
+| removeCoHostListener | 连线事件回调。 |
+| requestHostConnection | 发起连线请求。 |
+| cancelHostConnection | 取消连线请求。 |
+| acceptHostConnection | 接受连线请求。 |
+| rejectHostConnection | 拒绝连线请求。 |
+| exitHostConnection | 退出连线。 |
+| getCoHostCandidates | 获取推荐主播列表。 |
+
+### 创建实例
+
+#### CoHostStore.create
+
+创建对象实例。
+
+### 观察状态和事件
+
+#### addCoHostListener
+
+添加连线回调监听器
+``` dart
+void addCoHostListener(CoHostListener listener);
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| listener | CoHostListener | 必填 | 监听器。 |
+
+#### removeCoHostListener
+
+移除连线回调监听器
+``` dart
+void removeCoHostListener(CoHostListener listener);
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| listener | CoHostListener | 必填 | 监听器。 |
+
+### 连线操作
+
+#### requestHostConnection
+
+发起主播连线请求
+``` dart
+Future<CompletionHandler> requestHostConnection({
+    required String targetHostLiveID,
+    required CoHostLayoutTemplate layoutTemplate,
+    required int timeout,
+    String extraInfo = '',
+});
+```
+
+向目标主播发起跨房连线请求。
+
+调用此方法后，会向目标主播发送连线请求。请求将保持活动状态，直到：
+• 目标主播通过 **acceptHostConnection(fromHostLiveID:completion:)** 接受
+• 目标主播通过 **rejectHostConnection(fromHostLiveID:completion:)** 拒绝
+• 超时时间到期
+• 您通过 **cancelHostConnection(toHostLiveID:completion:)** 取消
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| targetHostLiveID | String | 必填 | 目标主播的直播间ID。 |
+| layoutTemplate | CoHostLayoutTemplate | 必填 | 连线布局模板。 |
+| timeout | int | 必填 | 请求超时时间（单位：秒）。 |
+| extraInfo | String? | 必填 | 扩展信息。 |
+
+#### cancelHostConnection
+
+取消主播连线请求
+``` dart
+Future<CompletionHandler> cancelHostConnection(String toHostLiveID);
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| toHostLiveID | String | 必填 | 目标主播的直播间ID。 |
+
+#### acceptHostConnection
+
+接受主播连线请求
+``` dart
+Future<CompletionHandler> acceptHostConnection(String fromHostLiveID);
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| fromHostLiveID | String | 必填 | 发起连线请求的主播直播间ID。 |
+
+#### rejectHostConnection
+
+拒绝主播连线请求
+``` dart
+Future<CompletionHandler> rejectHostConnection(String fromHostLiveID);
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| fromHostLiveID | String | 必填 | 发起连线请求的主播直播间ID。 |
+
+#### exitHostConnection
+
+退出主播连线
+``` dart
+Future<CompletionHandler> exitHostConnection();
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+#### getCoHostCandidates
+
+获取可以与当前主播连线的推荐主播列表
+``` dart
+Future<CompletionHandler> getCoHostCandidates(String cursor);
+```
+
+**版本信息**
+
+从 3.5 版本开始支持。
+
+**参数说明**
+| **参数名** | **类型** | **是否必填** | **描述** |
+| --- | --- | --- | --- |
+| cursor | String | 必填 | 游标。 |
+
+## 数据结构
+
+### CoHostStatus
+
+当前用户的跨房连线状态。
+| **枚举值** | **值** | **说明** |
+| --- | --- | --- |
+| connected | 0 | 和其他主播正在连线中。 |
+| disconnected | 1 | 没有和其他主播连线。 |
+
+### CoHostLayoutTemplate
+
+连线布局模板。
+| **枚举值** | **值** | **说明** |
+| --- | --- | --- |
+| hostVoiceConnection | 2 | 语聊房连线布局。 |
+| hostDynamicGrid | 600 | 主播动态网格布局。 |
+| hostDynamic1v6 | 601 | 主播动态1对6布局。 |
+
+### CoHostListener
+
+连线请求的回调事件。
+
+**方法**
+| **方法名** | **说明** |
+| --- | --- |
+| onCoHostRequestReceived | 当收到连线请求时触发此回调。 |
+| onCoHostRequestCancelled | 当连线请求被取消时触发此回调。 |
+| onCoHostRequestAccepted | 当连线请求被接受时触发此回调。 |
+| onCoHostRequestRejected | 当连线请求被拒绝时触发此回调。 |
+| onCoHostRequestTimeout | 当连线请求超时时触发此回调。 |
+| onCoHostUserJoined | 当用户加入连线时触发此回调。 |
+| onCoHostUserLeft | 当用户离开连线时触发此回调。 |
+
+### CoHostState
+
+CoHostStore 对外提供的跨房连线相关状态数据。
+| **属性** | **类型** | **说明** |
+| --- | --- | --- |
+| coHostStatus | ValueListenable<CoHostStatus> | 跨房连线的实时状态。 |
+| connected | ValueListenable<List<SeatUserInfo>> | 正在和当前直播间连线的主播列表。 |
+| invitees | ValueListenable<List<SeatUserInfo>> | 向其他直播间发出请求的主播列表。 |
+| applicant | ValueListenable<SeatUserInfo?> | 向当前直播间发起连线请求的主播。 |
+| candidatesCursor | ValueListenable<String> | 推荐用户列表游标。 |
+| candidates | ValueListenable<List<SeatUserInfo>> | 推荐用户列表。 |
+
+## 使用示例
+``` dart
+// 创建 store 实例
+final store = CoHostStore.create('live_room_123');
+
+// 定义监听器
+late final VoidCallback statusListener = _onStatusChanged;
+late final VoidCallback connectedListener = _onConnectedChanged;
+
+void _onStatusChanged() {
+    print('连线状态: ${store.coHostState.coHostStatus.value}');
+}
+
+void _onConnectedChanged() {
+    print('已连接主播: ${store.coHostState.connected.value.length}');
+}
+
+// 订阅状态变化
+store.coHostState.coHostStatus.addListener(statusListener);
+store.coHostState.connected.addListener(connectedListener);
+
+// 添加连线事件监听器
+final coHostListener = CoHostListener(
+    onCoHostRequestReceived: (inviter, extensionInfo) {
+        print('收到来自 ${inviter.userName} 的连线请求');
+        // 显示接受/拒绝的 UI
+    },
+    onCoHostRequestAccepted: (invitee) {
+        print('连线请求被 ${invitee.userName} 接受');
+    },
+    onCoHostUserJoined: (userInfo) {
+        print('主播 ${userInfo.userName} 加入连线');
+    },
+);
+store.addCoHostListener(coHostListener);
+
+// 发起连线请求
+final result = await store.requestHostConnection(
+    targetHostLiveID: 'target_live_id',
+    layoutTemplate: CoHostLayoutTemplate.hostDynamicGrid,
+    timeout: 30,
+    extraInfo: '',
+);
+if (result.code == 0) {
+    print('连线请求发送成功');
+}
+
+// 完成后取消订阅
+store.coHostState.coHostStatus.removeListener(statusListener);
+store.coHostState.connected.removeListener(connectedListener);
+store.removeCoHostListener(coHostListener);
+```