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

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

@@ -1,238 +0,0 @@
-## 简介
-
-**LiveAudienceStore** 提供了一套完整的观众管理 API，包括获取观众列表、设置管理员、踢出用户、禁言等功能。
-通过该类，可以在直播间内实现观众管理功能。
-
-> **重要：**
->
-
-> 使用 **create(liveID:)** 工厂方法创建 **LiveAudienceStore** 实例，需要传入有效的直播间 ID。
->
-
-> **说明：**
->
-
-> 观众状态更新通过 **state** 发布者传递。订阅它以接收房间内观众数据的实时更新。
->
-
-## 功能特性
-- **观众列表**：获取和管理当前房间的观众列表。
-
-- **权限管理**：设置和撤销管理员权限。
-
-- **用户管理**：踢出用户、禁言等操作。
-
-- **事件监听**：监听观众加入、离开等事件。
-
-## 可订阅数据
-
-**LiveAudienceState** 的字段描述如下：
-| **属性名** | **类型** | **描述** |
-| --- | --- | --- |
-| audienceList | [LiveUserInfo] | 观众列表。 |
-| audienceCount | UInt | 观众数量。 |
-| messageBannedUserList | [LiveUserInfo] | 消息被禁言的用户列表。 |
-
-## API 列表
-| **函数名** | **描述** |
-| --- | --- |
-| create | 创建观众管理实例。 |
-| liveAudienceEventPublisher | 观众事件发布者。 |
-| fetchAudienceList | 获取观众列表。 |
-| setAdministrator | 设置管理员。 |
-| revokeAdministrator | 撤销管理员。 |
-| kickUserOutOfRoom | 踢出用户。 |
-| disableSendMessage | 禁言/解禁用户。 |
-
-### 创建实例
-
-#### create
-
-创建观众管理实例
-``` swift
-public static func create(liveID: String) -> LiveAudienceStore {
-    let store: LiveAudienceStoreImpl = StoreFactory.shared.getStore(liveId: liveID)
-    return store
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| liveID | String | 必填 | 直播间ID。 |
-
-### 观察状态和事件
-
-#### liveAudienceEventPublisher
-
-观众事件发布者
-
-### 观众管理
-
-#### fetchAudienceList
-
-获取观众列表
-``` swift
-public func fetchAudienceList(
-    completion: CompletionClosure?
-) {
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| completion | CompletionClosure? | 必填 | 完成回调。 |
-
-#### setAdministrator
-
-设置管理员
-``` swift
-public func setAdministrator(userID: String,
-                             completion: CompletionClosure?) {
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| userID | String | 必填 | 要设置为管理员的用户ID。 |
-| completion | CompletionClosure? | 必填 | 完成回调。 |
-
-#### revokeAdministrator
-
-撤销管理员
-``` swift
-public func revokeAdministrator(userID: String,
-                                completion: CompletionClosure?) {
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| userID | String | 必填 | 要撤销管理员权限的用户ID。 |
-| completion | CompletionClosure? | 必填 | 完成回调。 |
-
-#### kickUserOutOfRoom
-
-将用户踢出房间
-``` swift
-public func kickUserOutOfRoom(userID: String,
-                              completion: CompletionClosure?) {
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| userID | String | 必填 | 要踢出的用户ID。 |
-| completion | CompletionClosure? | 必填 | 完成回调。 |
-
-#### disableSendMessage
-
-禁用/解禁用户发送消息
-``` swift
-public func disableSendMessage(userID: String,
-                               isDisable: Bool,
-                               completion: CompletionClosure?) {
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| userID | String | 必填 | 目标用户ID。 |
-| isDisable | Bool | 必填 | true 表示禁用发送消息，false 表示解禁。 |
-| completion | CompletionClosure? | 必填 | 完成回调。 |
-
-## 数据结构
-
-### Role
-
-用户角色。
-| **枚举值** | **说明** |
-| --- | --- |
-| owner | 房主。 |
-| admin | 管理员。 |
-| generalUser | 普通用户。 |
-
-### LiveUserInfo
-
-直播用户信息。
-| **属性** | **类型** | **说明** |
-| --- | --- | --- |
-| userID | String | 用户唯一标识ID。 |
-| userName | String | 用户名称。 |
-| avatarURL | String | 用户头像URL。 |
-
-### LiveAudienceState
-
-直播观众状态。
-| **属性** | **类型** | **说明** |
-| --- | --- | --- |
-| audienceList | [LiveUserInfo] | 观众列表。 |
-| audienceCount | UInt | 观众数量。 |
-| messageBannedUserList | [LiveUserInfo] | 消息被禁言的用户列表。 |
-
-### LiveAudienceListener
-
-直播观众事件。
-
-此监听器用于接收直播间内的观众动态事件。
-
-**方法**
-
-**onAudienceJoined**: 观众加入事件。
-``` swift
-case onAudienceJoined(audience: LiveUserInfo)
-```
-| **参数名** | **类型** | **说明** |
-| --- | --- | --- |
-| audience | LiveUserInfo | 加入的观众信息。 |
-
-**onAudienceLeft**: 观众离开事件。
-``` swift
-case onAudienceLeft(audience: LiveUserInfo)
-```
-| **参数名** | **类型** | **说明** |
-| --- | --- | --- |
-| audience | LiveUserInfo | 离开的观众信息。 |
-
-**onAudienceMessageDisabled**: 观众被禁止发言事件。
-``` swift
-case onAudienceMessageDisabled(audience: LiveUserInfo, isDisable: Bool)
-```
-| **参数名** | **类型** | **说明** |
-| --- | --- | --- |
-| audience | LiveUserInfo | 观众信息。 |
-| isDisable | Bool | 是否被禁止发言。 |

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

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

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

@@ -1,412 +0,0 @@
-## 简介
-
-**LiveSeatStore** 提供了一套完整的麦位管理 API，包括上麦、下麦、锁麦、解锁麦位、踢用户下麦、远程控制设备等功能。
-通过该类，可以在直播间内实现麦位管理功能。
-
-> **重要：**
->
-
-> 使用 **create(liveID:)** 工厂方法创建 **LiveSeatStore** 实例，需要传入有效的直播间 ID。
->
-
-> **说明：**
->
-
-> 麦位状态更新通过 **state** 发布者传递。订阅它以接收房间内麦位数据的实时更新。
->
-
-## 功能特性
-- **麦位管理**：上麦、下麦、锁麦、解锁麦位等操作。
-
-- **用户管理**：踢用户下麦、移动用户到指定麦位。
-
-- **设备控制**：远程控制用户的摄像头和麦克风。
-
-- **事件监听**：监听麦位相关事件。
-
-## 可订阅数据
-
-**LiveSeatState** 的字段描述如下：
-| **属性名** | **类型** | **描述** |
-| --- | --- | --- |
-| seatList | [SeatInfo] | 麦位列表。 |
-| canvas | LiveCanvas | 画布信息。 |
-| speakingUsers | [String:Int] | 正在说话的用户。 |
-| avStatistics | [AVStatistics] | 音视频相关统计信息。 |
-
-## API 列表
-| **函数名** | **描述** |
-| --- | --- |
-| create | 创建麦位管理实例。 |
-| liveSeatEventPublisher | 麦位事件发布者。 |
-| takeSeat | 上麦。 |
-| leaveSeat | 下麦。 |
-| lockSeat | 锁麦。 |
-| unlockSeat | 解锁麦位。 |
-| kickUserOutOfSeat | 踢用户下麦。 |
-| moveUserToSeat | 移动用户。 |
-| openRemoteCamera | 开启远程摄像头。 |
-| closeRemoteCamera | 关闭远程摄像头。 |
-| openRemoteMicrophone | 开启远程麦克风。 |
-| closeRemoteMicrophone | 关闭远程麦克风。 |
-
-### 创建实例
-
-#### create
-
-创建 LiveSeatStore 实例
-``` swift
-public static func create(liveID: String) -> LiveSeatStore {
-    let store: LiveSeatStoreImpl = StoreFactory.shared.getStore(liveId: liveID)
-    return store
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| liveID | String | 必填 | 直播间ID。 |
-
-### 观察状态和事件
-
-#### liveSeatEventPublisher
-
-麦位事件发布者
-
-### 麦位操作
-
-#### takeSeat
-
-上麦
-``` swift
-public func takeSeat(seatIndex: Int,
-                     completion: CompletionClosure?)
-{
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| seatIndex | Int | 必填 | 麦位索引。 |
-| completion | CompletionClosure? | 必填 | 完成回调。 |
-
-#### leaveSeat
-
-下麦
-``` swift
-public func leaveSeat(completion: CompletionClosure? = nil) {
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| completion | CompletionClosure? | 必填 | 完成回调。 |
-
-#### lockSeat
-
-锁定麦位
-``` swift
-public func lockSeat(
-    seatIndex: Int,
-    completion: CompletionClosure?
-) {
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| seatIndex | Int | 必填 | 麦位索引。 |
-| completion | CompletionClosure? | 必填 | 完成回调。 |
-
-#### unlockSeat
-
-解锁麦位
-``` swift
-public func unlockSeat(
-    seatIndex: Int,
-    completion: CompletionClosure?
-) {
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| seatIndex | Int | 必填 | 麦位索引。 |
-| completion | CompletionClosure? | 必填 | 完成回调。 |
-
-### 用户管理
-
-#### kickUserOutOfSeat
-
-踢用户下麦
-``` swift
-public func kickUserOutOfSeat(userID: String,
-                              completion: CompletionClosure?)
-{
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| userID | String | 必填 | 用户 ID。 |
-| completion | CompletionClosure? | 必填 | 完成回调。 |
-
-#### moveUserToSeat
-
-移动用户到麦位
-``` swift
-public func moveUserToSeat(
-    userID: String,
-    targetIndex: Int,
-    policy: MoveSeatPolicy?,
-    completion: CompletionClosure?
-) {
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| userID | String | 必填 | 用户 ID。 |
-| targetIndex | Int | 必填 | 目标麦位索引。 |
-| policy | MoveSeatPolicy? | 必填 | 移动策略。 |
-| completion | CompletionClosure? | 必填 | 完成回调。 |
-
-### 远程设备控制
-
-#### openRemoteCamera
-
-开启远程摄像头
-``` swift
-public func openRemoteCamera(
-    userID: String,
-    policy: DeviceControlPolicy,
-    completion: CompletionClosure?
-) {
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| userID | String | 必填 | 用户 ID。 |
-| policy | DeviceControlPolicy | 必填 | 设备控制策略。 |
-| completion | CompletionClosure? | 必填 | 完成回调。 |
-
-#### closeRemoteCamera
-
-关闭远程摄像头
-``` swift
-public func closeRemoteCamera(
-    userID: String,
-    completion: CompletionClosure?
-) {
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| userID | String | 必填 | 用户 ID。 |
-| completion | CompletionClosure? | 必填 | 完成回调。 |
-
-#### openRemoteMicrophone
-
-开启远程麦克风
-``` swift
-public func openRemoteMicrophone(
-    userID: String,
-    policy: DeviceControlPolicy,
-    completion: CompletionClosure?
-) {
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| userID | String | 必填 | 用户 ID。 |
-| policy | DeviceControlPolicy | 必填 | 设备控制策略。 |
-| completion | CompletionClosure? | 必填 | 完成回调。 |
-
-#### closeRemoteMicrophone
-
-关闭远程麦克风
-``` swift
-public func closeRemoteMicrophone(
-    userID: String,
-    completion: CompletionClosure?
-) {
-    fatalError("\(#function) must be overridden by subclass")
-}
-```
-
-**版本信息**
-
-从 3.5 版本开始支持。
-
-**参数说明**
-| **参数名** | **类型** | **是否必填** | **描述** |
-| --- | --- | --- | --- |
-| userID | String | 必填 | 用户 ID。 |
-| completion | CompletionClosure? | 必填 | 完成回调。 |
-
-## 数据结构
-
-### MoveSeatPolicy
-
-移动麦位策略。
-| **枚举值** | **说明** |
-| --- | --- |
-| abortWhenOccupied | 被占用时中止。 |
-| forceReplace | 强制替换。 |
-| swapPosition | 交换位置。 |
-
-### DeviceControlPolicy
-
-设备控制策略。
-| **枚举值** | **说明** |
-| --- | --- |
-| unlockOnly | 仅解锁。 |
-
-### SuspendStatus
-
-用户的挂起状态。
-| **枚举值** | **说明** |
-| --- | --- |
-| none | 未挂起。 |
-| inBackground | 用户进入后台挂起。 |
-| inCalling | 用户正在接听电话。 |
-
-### LiveSeatEvent
-
-麦位相关的回调事件。
-| **枚举值** | **说明** |
-| --- | --- |
-| 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 | CGFloat | X坐标。 |
-| y | CGFloat | Y坐标。 |
-| w | CGFloat | 宽度。 |
-| h | CGFloat | 高度。 |
-| zorder | Int | 层级顺序。 |
-
-### AVStatistics
-
-音视频相关统计信息。
-| **属性** | **类型** | **说明** |
-| --- | --- | --- |
-| userID | String | 用户 ID。 |
-| videoBitrate | UInt | 本地视频的码率。 |
-| videoWidth | CGFloat | 本地视频的宽度。 |
-| videoHeight | CGFloat | 本地视频的高度。 |
-| frameRate | UInt | 本地视频的帧率。 |
-| audioSampleRate | UInt | 音频的采样率。 |
-| audioBitrate | UInt | 音频码率。 |
-
-### SeatInfo
-
-麦位信息。
-| **属性** | **类型** | **说明** |
-| --- | --- | --- |
-| index | Int | 麦位索引。 |
-| isLocked | Bool | 是否锁定。 |
-| userInfo | SeatUserInfo | 用户信息。 |
-| region | RegionInfo | 区域信息。 |
-
-### LiveCanvas
-
-直播画布。
-| **属性** | **类型** | **说明** |
-| --- | --- | --- |
-| w | CGFloat | 宽度。 |
-| h | CGFloat | 高度。 |
-| templateID | UInt | 模板ID。 |
-
-### LiveSeatState
-
-LiveSeatStore 对外提供的麦位状态数据。
-| **属性** | **类型** | **说明** |
-| --- | --- | --- |
-| seatList | [SeatInfo] | 麦位列表。 |
-| canvas | LiveCanvas | 画布信息。 |
-| speakingUsers | [String:Int] | 正在说话的用户。 |
-| avStatistics | [AVStatistics] | 音视频相关统计信息。 |