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

package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md

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

package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md

@@ -1,74 +0,0 @@
-## 简介
-
-**LiveCoreView** 提供了直播推流和播放的视图容器，支持多人连麦、PK 等功能。
-通过该组件，可以实现直播间的视频渲染和交互。
-
-> **重要：**
->
-
-> 使用前需要先调用 **setLiveID** 设置直播间 ID。
->
-
-## 功能特性
-- **视频渲染**：提供直播推流和播放的视图容器。
-
-- **连麦支持**：支持多人连麦功能。
-
-- **PK 支持**：支持主播 PK 功能。
-
-- **房间外预览**：支持在进入房间前预览直播流。
-
-## 数据结构
-
-### CoreViewType
-
-核心视图类型。
-| **枚举值** | **说明** |
-| --- | --- |
-| PLAY_VIEW | 播放视图。 |
-| PUSH_VIEW | 推流视图。 |
-
-### ViewLayer
-
-视图层级。
-| **枚举值** | **说明** |
-| --- | --- |
-| FOREGROUND | 前景层。 |
-| BACKGROUND | 背景层。 |
-
-### VideoViewAdapter
-
-视频视图适配器协议。
-
-**方法**
-
-**createCoGuestView**: 创建连麦视图。
-``` kotlin
-fun createCoGuestView(seatInfo: SeatInfo?, viewLayer: ViewLayer?): View?
-```
-| **参数名** | **类型** | **说明** |
-| --- | --- | --- |
-| seatInfo | SeatInfo? | 连麦用户的麦位信息。 |
-| viewLayer | ViewLayer? | 视图层级，前景层或背景层。 |
-
-**createCoHostView**: 创建跨房连麦视图。
-``` kotlin
-fun createCoHostView(seatInfo: SeatInfo?, viewLayer: ViewLayer?): View?
-```
-| **参数名** | **类型** | **说明** |
-| --- | --- | --- |
-| seatInfo | SeatInfo? | 跨房连麦用户的麦位信息。 |
-| viewLayer | ViewLayer? | 视图层级，前景层或背景层。 |
-
-**createBattleView**: 创建PK视图。
-``` kotlin
-fun createBattleView(seatInfo: SeatInfo?): View?
-```
-| **参数名** | **类型** | **说明** |
-| --- | --- | --- |
-| seatInfo | SeatInfo? | PK用户的麦位信息。 |
-
-**createBattleContainerView**: 创建PK容器视图。
-``` kotlin
-fun createBattleContainerView(): View?
-```

package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md

@@ -1,417 +0,0 @@
-## 简介
-
-**LiveSeatStore** 提供了一套完整的麦位管理 API，包括上麦、下麦、锁麦、解锁麦位、踢用户下麦、远程控制设备等功能。
-通过该类，可以在直播间内实现麦位管理功能。
-
-> **重要：**
->
-
-> 使用 **LiveSeatStore.create** 工厂方法创建 **LiveSeatStore** 实例，需要传入有效的直播间 ID。
->
-
-> **说明：**
->
-
-> 麦位状态更新通过 **liveSeatState** 发布者传递。订阅它以接收房间内麦位数据的实时更新。
->
-
-## 功能特性
-- **麦位管理**：上麦、下麦、锁麦、解锁麦位等操作。
-
-- **用户管理**：踢用户下麦、移动用户到指定麦位。
-
-- **设备控制**：远程控制用户的摄像头和麦克风。
-
-- **事件监听**：监听麦位相关事件。
-
-## 可订阅数据
-
-**LiveSeatState** 的字段描述如下：
-| **属性名** | **类型** | **描述** |
-| --- | --- | --- |
-| seatList | StateFlow<List<SeatInfo>> | 麦位列表。 |
-| canvas | StateFlow<LiveCanvas> | 画布信息。 |
-| speakingUsers | StateFlow<MutableMap<String,Int>> | 正在说话的用户。 |
-| avStatistics | StateFlow<List<AVStatistics>> | 音视频相关统计信息。 |
-
-## API 列表
-| **函数名** | **描述** |
-| --- | --- |
-| LiveSeatStore.create | 创建麦位管理实例。 |
-| addLiveSeatEventListener | 麦位事件回调。 |
-| removeLiveSeatEventListener | 麦位事件回调。 |
-| takeSeat | 上麦。 |
-| leaveSeat | 下麦。 |
-| lockSeat | 锁麦。 |
-| unlockSeat | 解锁麦位。 |
-| kickUserOutOfSeat | 踢用户下麦。 |
-| moveUserToSeat | 移动用户。 |
-| openRemoteCamera | 开启远程摄像头。 |
-| closeRemoteCamera | 关闭远程摄像头。 |
-| openRemoteMicrophone | 开启远程麦克风。 |
-| closeRemoteMicrophone | 关闭远程麦克风。 |
-
-### 创建实例
-
-#### LiveSeatStore.create
-
-创建麦位管理实例。
-
-### 观察状态和事件
-
-#### addLiveSeatEventListener
-
-添加麦位事件监听器
-``` kotlin
-abstract fun addLiveSeatEventListener(
-    listener: LiveSeatListener?
-)
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| listener | LiveSeatListener? | 必填 | 监听器。 |
-
-#### removeLiveSeatEventListener
-
-移除麦位事件监听器
-``` kotlin
-abstract fun removeLiveSeatEventListener(
-    listener: LiveSeatListener?
-)
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| listener | LiveSeatListener? | 必填 | 监听器。 |
-
-### 麦位操作
-
-#### takeSeat
-
-上麦
-``` kotlin
-abstract fun takeSeat(
-    seatIndex: Int,
-    completion: CompletionHandler?
-)
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| seatIndex | Int | 必填 | 麦位索引。 |
-| completion | CompletionHandler? | 必填 | 完成回调。 |
-
-#### leaveSeat
-
-下麦
-``` kotlin
-abstract fun leaveSeat(completion: CompletionHandler?)
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| completion | CompletionHandler? | 必填 | 完成回调。 |
-
-#### lockSeat
-
-锁定麦位
-``` kotlin
-abstract fun lockSeat(
-    seatIndex: Int,
-    completion: CompletionHandler?
-)
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| seatIndex | Int | 必填 | 麦位索引。 |
-| completion | CompletionHandler? | 必填 | 完成回调。 |
-
-#### unlockSeat
-
-解锁麦位
-``` kotlin
-abstract fun unlockSeat(
-    seatIndex: Int,
-    completion: CompletionHandler?
-)
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| seatIndex | Int | 必填 | 麦位索引。 |
-| completion | CompletionHandler? | 必填 | 完成回调。 |
-
-### 用户管理
-
-#### kickUserOutOfSeat
-
-踢用户下麦
-``` kotlin
-abstract fun kickUserOutOfSeat(
-    userID: String?,
-    completion: CompletionHandler?
-)
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| userID | String? | 必填 | 用户 ID。 |
-| completion | CompletionHandler? | 必填 | 完成回调。 |
-
-#### moveUserToSeat
-
-移动用户到麦位
-``` kotlin
-abstract fun moveUserToSeat(
-    userID: String?,
-    targetIndex: Int,
-    policy: MoveSeatPolicy? = MoveSeatPolicy.ABORT_WHEN_OCCUPIED,
-    completion: CompletionHandler?
-)
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| userID | String? | 必填 | 用户 ID。 |
-| targetIndex | Int | 必填 | 目标麦位索引。 |
-| policy | MoveSeatPolicy? | 必填 | 移动策略。 |
-| completion | CompletionHandler? | 必填 | 完成回调。 |
-
-### 远程设备控制
-
-#### openRemoteCamera
-
-开启远程摄像头
-``` kotlin
-abstract fun openRemoteCamera(
-    userID: String?,
-    policy: DeviceControlPolicy,
-    completion: CompletionHandler?
-)
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| userID | String? | 必填 | 用户 ID。 |
-| policy | DeviceControlPolicy | 必填 | 设备控制策略。 |
-| completion | CompletionHandler? | 必填 | 完成回调。 |
-
-#### closeRemoteCamera
-
-关闭远程摄像头
-``` kotlin
-abstract fun closeRemoteCamera(
-    userID: String?,
-    completion: CompletionHandler?
-)
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| userID | String? | 必填 | 用户 ID。 |
-| completion | CompletionHandler? | 必填 | 完成回调。 |
-
-#### openRemoteMicrophone
-
-开启远程麦克风
-``` kotlin
-abstract fun openRemoteMicrophone(
-    userID: String?,
-    policy: DeviceControlPolicy,
-    completion: CompletionHandler?
-)
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| userID | String? | 必填 | 用户 ID。 |
-| policy | DeviceControlPolicy | 必填 | 设备控制策略。 |
-| completion | CompletionHandler? | 必填 | 完成回调。 |
-
-#### closeRemoteMicrophone
-
-关闭远程麦克风
-``` kotlin
-abstract fun closeRemoteMicrophone(
-    userID: String?,
-    completion: CompletionHandler?
-)
-
-internal val hasAudioStreamUserList: MutableSet<String> = mutableSetOf()
-internal val hasVideoStreamUserList: MutableSet<String> = mutableSetOf()
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| userID | String? | 必填 | 用户 ID。 |
-| completion | CompletionHandler? | 必填 | 完成回调。 |
-
-## 数据结构
-
-### MoveSeatPolicy
-
-移动麦位策略。
-| **枚举值** | **说明** |
-| --- | --- |
-| ABORT_WHEN_OCCUPIED | 被占用时中止。 |
-| FORCE_REPLACE | 强制替换。 |
-| SWAP_POSITION | 交换位置。 |
-
-### DeviceControlPolicy
-
-设备控制策略。
-| **枚举值** | **说明** |
-| --- | --- |
-| UNLOCK_ONLY | 仅解锁。 |
-
-### SuspendStatus
-
-用户的挂起状态。
-| **枚举值** | **说明** |
-| --- | --- |
-| NONE | 未挂起。 |
-| IN_BACKGROUND | 用户进入后台挂起。 |
-| IN_CALLING | 用户正在接听电话。 |
-
-### LiveSeatListener
-
-麦位相关的回调事件。
-
-**方法**
-| **方法名** | **说明** |
-| --- | --- |
-| onLocalCameraOpenedByAdmin | 当本地摄像头被管理员开启时触发此回调。 |
-| onLocalCameraClosedByAdmin | 当本地摄像头被管理员关闭时触发此回调。 |
-| onLocalMicrophoneOpenedByAdmin | 当本地麦克风被管理员开启时触发此回调。 |
-| onLocalMicrophoneClosedByAdmin | 当本地麦克风被管理员关闭时触发此回调。 |
-
-### SeatUserInfo
-
-麦位用户信息。
-| **属性** | **类型** | **说明** |
-| --- | --- | --- |
-| userID | String | 用户 ID。 |
-| userName | String | 用户名。 |
-| avatarURL | String | 头像URL。 |
-| role | Role | 用户角色。 |
-| liveID | String | 直播间ID。 |
-| microphoneStatus | DeviceStatus | 麦克风状态。 |
-| allowOpenMicrophone | Boolean | 是否允许开启麦克风。 |
-| cameraStatus | DeviceStatus | 摄像头状态。 |
-| allowOpenCamera | Boolean | 是否允许开启摄像头。 |
-| 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 | Boolean | 是否锁定。 |
-| userInfo | SeatUserInfo | 用户信息。 |
-| region | RegionInfo | 区域信息。 |
-
-### LiveCanvas
-
-直播画布。
-| **属性** | **类型** | **说明** |
-| --- | --- | --- |
-| w | Int | 宽度。 |
-| h | Int | 高度。 |
-| templateID | Int | 模板ID。 |
-
-### LiveSeatState
-
-LiveSeatStore 对外提供的麦位状态数据。
-| **属性** | **类型** | **说明** |
-| --- | --- | --- |
-| seatList | StateFlow<List<SeatInfo>> | 麦位列表。 |
-| canvas | StateFlow<LiveCanvas> | 画布信息。 |
-| speakingUsers | StateFlow<MutableMap<String,Int>> | 正在说话的用户。 |
-| avStatistics | StateFlow<List<AVStatistics>> | 音视频相关统计信息。 |