npm - @tencentcloud/sdk-mcp - Versions diffs - 1.3.9 → 1.4.1 - Mend

@tencentcloud/sdk-mcp 1.3.9 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (514) hide show

package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md RENAMED Viewed

@@ -11,42 +11,19 @@
 - **状态监听**：实时获取当前生效的美颜参数。
 ## 核心概念
 在开始集成之前，我们先通过下表了解一下 BaseBeautyStore 相关的核心概念：
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >**核心概念**</td>
-<td rowspan="1" colSpan="1" >**类型**</td>
-<td rowspan="1" colSpan="1" >**核心职责与描述**</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`BaseBeautyState`</td>
-<td rowspan="1" colSpan="1" >`struct`</td>
-<td rowspan="1" colSpan="1" >代表基础美颜模块的当前状态。包含了当前生效的磨皮 (`smoothLevel`)、美白 (`whitenessLevel`) 和红润 (`ruddyLevel`) 的强度值。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`BaseBeautyStore`</td>
-<td rowspan="1" colSpan="1" >`class`</td>
-<td rowspan="1" colSpan="1" >这是与基础美颜功能交互的核心管理类。它是一个全局单例 (`shared`)，负责所有基础美颜参数的设置、重置和状态同步。</td>
-</tr>
-</table>
+| **核心概念** | **类型** | **核心职责与描述** |
+| --- | --- | --- |
+| `BaseBeautyState` | `struct` | 代表基础美颜模块的当前状态。包含了当前生效的磨皮 (`smoothLevel`)、美白 (`whitenessLevel`) 和红润 (`ruddyLevel`) 的强度值。 |
+| `BaseBeautyStore` | `class` | 这是与基础美颜功能交互的核心管理类。它是一个全局单例 (`shared`)，负责所有基础美颜参数的设置、重置和状态同步。 |
 ## 实现步骤
 ### 步骤1：组件集成
-请参考 [开始直播](https://write.woa.com/document/191126382767431680) 集成 **AtomicXCore**，并完成 **LiveCoreView** 的接入。
+请参考 开始直播 集成 **AtomicXCore**，并完成 **LiveCoreView** 的接入。
 ### 步骤2：获取实例并监听状态
@@ -57,18 +34,17 @@
 2. **订阅状态**：订阅 `baseBeautyStore.state` 以实时获取 `BaseBeautyState` 的更新。
 #### 代码示例
 ``` swift
 import Foundation
-import AtomicXCore
-import Combine
+import AtomicXCore
+import Combine
 class BeautyManager {
     // 1. 获取单例
     private let baseBeautyStore = BaseBeautyStore.shared //
     private var cancellables = Set<AnyCancellable>()
     // 对外暴露美颜状态
     let beautyStatePublisher = CurrentValueSubject<BaseBeautyState, Never>(BaseBeautyState())
@@ -76,7 +52,7 @@ class BeautyManager {
         // 2. 订阅状态
         subscribeToBeautyState()
     }
     private func subscribeToBeautyState() {
         baseBeautyStore.state //
             .subscribe()
@@ -84,7 +60,7 @@ class BeautyManager {
             .assign(to: \.value, on: beautyStatePublisher)
             .store(in: &cancellables)
     }
     // ... 后续方法
 }
 ```
@@ -98,7 +74,6 @@ class BeautyManager {
 2. **调用接口**：分别调用 `setSmoothLevel(smoothLevel:)`、`setWhitenessLevel(whitenessLevel:)`、`setRuddyLevel(ruddyLevel:) `来设置磨皮、美白、红润的强度。
 #### 代码示例
 ``` swift
 extension BeautyManager {
@@ -146,48 +121,12 @@ extension BeautyManager {
 ### 基础美颜与高级美颜对比
 AtomicXCore 也提供了高级美颜支持，以满足不同场景的需求
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >**对比项**</td>
-<td rowspan="1" colSpan="1" >**基础美颜 (BaseBeautyStore)**</td>
-<td rowspan="1" colSpan="1" >**高级美颜 (TEBeautyKit 需额外集成)**</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >核心功能</td>
-<td rowspan="1" colSpan="1" >磨皮、美白、红润</td>
-<td rowspan="1" colSpan="1" >包含基础美颜，并增加 V 脸、眼距、瘦鼻、3D 贴纸、滤镜、美妆等丰富效果</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >计费</td>
-<td rowspan="1" colSpan="1" >免费 (包含在 AtomicXCore 授权内)</td>
-<td rowspan="1" colSpan="1" >付费（需要额外购买腾讯特效 SDK License） </td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >集成方式</td>
-<td rowspan="1" colSpan="1" >默认内置，直接使用 `BaseBeautyStore.shared`</td>
-<td rowspan="1" colSpan="1" >需要额外集成 `TEBeautyKit` 组件并进行鉴权</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >推荐场景</td>
-<td rowspan="1" colSpan="1" >对美颜要求不高，需要快速实现基础美颜功能的场景</td>
-<td rowspan="1" colSpan="1" >对美颜效果有较高要求，需要丰富的美型、贴纸、滤镜等高级功能的场景</td>
-</tr>
-</table>
+| **对比项** | **基础美颜 (BaseBeautyStore)** | **高级美颜 (TEBeautyKit 需额外集成)** |
+| --- | --- | --- |
+| 核心功能 | 磨皮、美白、红润 | 包含基础美颜，并增加 V 脸、眼距、瘦鼻、3D 贴纸、滤镜、美妆等丰富效果 |
+| 计费 | 免费 (包含在 AtomicXCore 授权内) | 付费（需要额外购买腾讯特效 SDK License） |
+| 集成方式 | 默认内置，直接使用 `BaseBeautyStore.shared` | 需要额外集成 `TEBeautyKit` 组件并进行鉴权 |
+| 推荐场景 | 对美颜要求不高，需要快速实现基础美颜功能的场景 | 对美颜效果有较高要求，需要丰富的美型、贴纸、滤镜等高级功能的场景 |
 ### 集成高级美颜
@@ -196,32 +135,10 @@ AtomicXCore 也提供了高级美颜支持，以满足不同场景的需求
 ## API 文档
 关于 [BaseBeautyStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/basebeautystore) 及其相关类的所有公开接口、属性和方法的详细信息，请参阅随 [AtomicXCore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore) 框架的官方 API 文档。本指南使用到的相关 Store 如下：
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >Store/Component</td>
-<td rowspan="1" colSpan="1" >功能描述</td>
-<td rowspan="1" colSpan="1" >API 文档</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >BaseBeautyStore</td>
-<td rowspan="1" colSpan="1" >基础美颜：调节磨皮 / 美白 / 红润（0-9 级），重置美颜状态，同步效果参数。</td>
-<td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/basebeautystore)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >DeviceStore</td>
-<td rowspan="1" colSpan="1" >音视频设备控制：麦克风（开关 / 音量）、摄像头（开关 / 切换 / 画质）、屏幕共享，设备状态实时监听。</td>
-<td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/devicestore)</td>
-</tr>
-</table>
+| Store/Component | 功能描述 | API 文档 |
+| --- | --- | --- |
+| BaseBeautyStore | 基础美颜：调节磨皮 / 美白 / 红润（0-9 级），重置美颜状态，同步效果参数。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/basebeautystore) |
+| DeviceStore | 音视频设备控制：麦克风（开关 / 音量）、摄像头（开关 / 切换 / 画质）、屏幕共享，设备状态实时监听。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/devicestore) |
 ## 常见问题
@@ -233,5 +150,3 @@ AtomicXCore 也提供了高级美颜支持，以满足不同场景的需求
 2. **是否使用了高级美颜**：如果您集成了 `TEBeautyKit` (高级美颜)，请确保您使用的是 `TEBeautyKit` 提供的接口来调节美颜。
 3. **参数范围**：如果您使用的基础美颜，请确认您传入的强度值在有效的范围内 (`0` 到 `9` 之间的 Float 值)。

package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md RENAMED Viewed

@@ -7,12 +7,11 @@
 - **主播邀请上麦**：主播可以主动向直播间内的任意一位观众发起连麦邀请。
 ## 实现步骤
 ### 步骤1：组件集成
-请参考 [开始直播](https://write.woa.com/document/191126382767431680) 集成 **AtomicXCore**，并完成 **LiveCoreView** 的接入。
+请参考 开始直播 集成 **AtomicXCore**，并完成 **LiveCoreView** 的接入。
 ### 步骤2：实现观众申请上麦
@@ -21,15 +20,14 @@
 作为观众，您的核心任务是**发起申请、接收结果**和**主动下麦**。
 1. **发起连麦申请**
    当用户点击界面上的“申请连麦”按钮时，调用 `applyForSeat` 方法。
    ``` swift
    import AtomicXCore
    let liveId = "房间ID"
    let guestStore = CoGuestStore.create(liveID: liveId)
    // 用户点击“申请连麦”
    func requestToConnect() {
        // timeout: 请求超时时间，例如 30 秒
@@ -45,7 +43,6 @@
    ```
 2. **监听主播的响应**
    通过订阅 `guestEventPublisher`，您可以接收到主播的处理结果。
    ``` swift
@@ -56,7 +53,7 @@
              if case let .onGuestApplicationResponded(isAccept, hostUser) = event {
                  if isAccept {
                      print("主播 \(hostUser.userName) 同意了你的申请，准备上麦")
-                     // 1. 打开摄像头、麦克风
+                     // 1. 打开摄像头、麦克风
                      DeviceStore.shared.openLocalCamera(isFront: true, completion: nil)
                      DeviceStore.shared.openLocalMicrophone(completion: nil)
                      // 2. 在此更新 UI，例如关闭申请按钮，显示连麦中的状态
@@ -71,7 +68,6 @@
    ```
 3. **主动下麦**
    当连麦观众想结束互动时，调用 `disConnect` 方法即可返回普通观众状态。
    ``` swift
@@ -89,7 +85,6 @@
    ```
 4. **(可选) 取消申请**
    如果观众在主播处理前想撤回申请，可以调用 `cancelApplication`。
    ``` swift
@@ -111,15 +106,14 @@
 作为主播，您的核心任务是**接收申请、展示申请列表**和**处理申请**。
 1. **监听新的连麦申请**
    通过订阅 `hostEventPublisher`，您可以在有新观众申请时立即收到通知，并给出提示。
    ``` swift
    import AtomicXCore
    let liveId = "房间ID"
    let guestStore = CoGuestStore.create(liveID: liveId)
    // 订阅主播事件
    guestStore.hostEventPublisher
        .sink { [weak self] event in
@@ -132,7 +126,6 @@
    ```
 2. **展示申请列表**
    `CoGuestStore` 的 state 会实时维护当前的申请者列表，您可以订阅它来刷新您的 UI。
    ``` swift
@@ -149,7 +142,6 @@
    ```
 3. **处理连麦申请**
    当您在列表中选择一位观众并点击“同意”或“拒绝”时，调用相应的方法。
    ``` perl
@@ -161,7 +153,7 @@
            }
        }
    }
    // 主播点击“拒绝”按钮
    func reject(userId: String) {
        guestStore.rejectApplication(userID: userId) { result in
@@ -177,7 +169,6 @@
 #### 主播端实现
 1. **向观众发起邀请**
    当主播在观众列表中选择某人并点击“邀请连麦”时，调用 `inviteToSeat` 方法。
    ``` swift
@@ -193,7 +184,6 @@
    ```
 2. **监听观众的回应**
    通过 `hostEventPublisher` 监听 `onHostInvitationResponded` 事件。
    ``` swift
@@ -210,7 +200,6 @@
 #### 观众端实现
 1. **接收主播的邀请**
    通过 `guestEventPublisher` 监听 `onHostInvitationReceived` 事件。
    ``` swift
@@ -223,23 +212,22 @@
    ```
 2. **响应邀请**
    当用户在弹出的对话框中做出选择后，调用相应的方法。
    ``` swift
    let inviterId = "发起邀请的主播ID" // 从 onHostInvitationReceived 事件中获取
    // 用户点击“接受”
    func accept() {
        guestStore.acceptInvitation(inviterID: inviterId) { result in
            if case .success = result {
-               // 2. 打开摄像头、麦克风
+               // 2. 打开摄像头、麦克风
                DeviceStore.shared.openLocalCamera(isFront: true, completion: nil)
                DeviceStore.shared.openLocalMicrophone(completion: nil)
            }
        }
    }
    // 用户点击“拒绝”
    func reject() {
        guestStore.rejectInvitation(inviterID: inviterId) { result in
@@ -250,10 +238,7 @@
 ### 运行效果
-当您集成以上功能实现后，请分别使用两个观众与主播进行连麦操作，观众 A 同时打开摄像头和麦克风，观众 B 只打开麦克风，运行效果如下，您可以参考下一章节 [完善 UI 细节](https://write.woa.com/#736c00b3-02dc-494b-838d-226439fd3e15) 来定制您想要的 UI 逻辑。
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/05225796a5da11f0a90152540099c741.png)
+当您集成以上功能实现后，请分别使用两个观众与主播进行连麦操作，观众 A 同时打开摄像头和麦克风，观众 B 只打开麦克风，运行效果如下，您可以参考下一章节 完善 UI 细节 来定制您想要的 UI 逻辑。
 ## 完善 UI 细节
@@ -263,22 +248,19 @@
 #### **实现效果**
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/515ea747a5d111f0872c525400bf7822.png)
 #### **实现方式**
 > **提示：**
->
+>
 > 您也可以参考 TUILiveKit 开源项目中的 [AnchorCoGuestView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Features/AnchorBoardcast/View/LivingView/Video/AnchorCoGuestView.swift) 和 [AnchorEmptySeatView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Features/AnchorBoardcast/View/LivingView/Video/AnchorEmptySeatView.swift) 文件来了解完整的实现逻辑。
->
+>
 - **步骤 1**：创建前景视图 (**CustomSeatView**)，该视图用于在视频流上方显示用户信息。
    ``` swift
    import UIKit
    // 自定义的用户信息悬浮视图（前景）
    class CustomSeatView: UIView {
       lazy var nameLabel: UILabel = {
@@ -287,7 +269,7 @@
            label.font = .systemFont(ofSize: 14)
            return label
        }()
        override init(frame: CGRect) {
            super.init(frame: frame)
            backgroundColor = UIColor.black.withAlphaComponent(0.5)
@@ -303,7 +285,7 @@
    ``` swift
    import UIKit
    // 自定义的头像占位视图（背景）
    class CustomAvatarView: UIView {
        lazy var avatarImageView: UIImageView = {
@@ -311,7 +293,7 @@
            imageView.tintColor = .gray
            return imageView
        }()
        override init(frame: CGRect) {
            super.init(frame: frame)
            backgroundColor = .clear
@@ -323,18 +305,18 @@
            }
        }
    }
    ```
 - **步骤 3**：实现 `VideoViewDelegate.createCoGuestView` 协议，根据 `viewLayer` 的值返回对应的视图。
    ``` swift
    import AtomicXCore
    // 1. 在您的视图控制器中，遵守 VideoViewDelegate 协议
    class YourViewController: UIViewController, VideoViewDelegate {
        // ... 其他代码 ...
        // 2. 完整实现协议方法，处理两种 viewLayer
        func createCoGuestView(seatInfo: TUISeatFullInfo, viewLayer: ViewLayer) -> UIView? {
            guard let userId = seatInfo.userID,!userId.isEmpty else {
@@ -356,110 +338,24 @@
    ```
 #### **参数说明**：
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >**参数**</td>
-<td rowspan="1" colSpan="1" >**类型**</td>
-<td rowspan="1" colSpan="1" >**说明**</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`seatInfo`</td>
-<td rowspan="1" colSpan="1" >`TUISeatFullInfo`</td>
-<td rowspan="1" colSpan="1" >麦位信息对象，包含麦上用户的详细信息。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`seatInfo.userID`</td>
-<td rowspan="1" colSpan="1" >`String?`</td>
-<td rowspan="1" colSpan="1" >麦上用户的 ID。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`seatInfo.userName`</td>
-<td rowspan="1" colSpan="1" >`String? `</td>
-<td rowspan="1" colSpan="1" >麦上用户的昵称。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`seatInfo.userAvatar`</td>
-<td rowspan="1" colSpan="1" >`String?`</td>
-<td rowspan="1" colSpan="1" >麦上用户的头像 URL。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`seatInfo.userMicrophoneStatus`</td>
-<td rowspan="1" colSpan="1" >`TUIDeviceStatus`</td>
-<td rowspan="1" colSpan="1" >麦上用户的麦克风状态。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`seatInfo.userCameraStatus `</td>
-<td rowspan="1" colSpan="1" >`TUIDeviceStatus`</td>
-<td rowspan="1" colSpan="1" >麦上用户的摄像头状态。</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >`viewLayer`</td>
-<td rowspan="1" colSpan="1" >`ViewLayer`</td>
-<td rowspan="1" colSpan="1" >视图层级枚举。<br>`.foreground` 表示前景挂件视图，始终显示在视频画面的最上层。<br>`.background` 表示背景挂件视图，位于前景视图下层，仅在对应用户没有视频流（例如未开摄像头）的情况下显示，通常用于展示用户的默认头像或占位图。</td>
-</tr>
-</table>
+| **参数** | **类型** | **说明** |
+| --- | --- | --- |
+| `seatInfo` | `TUISeatFullInfo` | 麦位信息对象，包含麦上用户的详细信息。 |
+| `seatInfo.userID` | `String?` | 麦上用户的 ID。 |
+| `seatInfo.userName` | `String? ` | 麦上用户的昵称。 |
+| `seatInfo.userAvatar` | `String?` | 麦上用户的头像 URL。 |
+| `seatInfo.userMicrophoneStatus` | `TUIDeviceStatus` | 麦上用户的麦克风状态。 |
+| `seatInfo.userCameraStatus ` | `TUIDeviceStatus` | 麦上用户的摄像头状态。 |
+| `viewLayer` | `ViewLayer` | 视图层级枚举。<br>`.foreground` 表示前景挂件视图，始终显示在视频画面的最上层。<br>`.background` 表示背景挂件视图，位于前景视图下层，仅在对应用户没有视频流（例如未开摄像头）的情况下显示，通常用于展示用户的默认头像或占位图。 |
 ## API 文档
 关于 [CoGuestStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore) 及其相关类的所有公开接口、属性和方法的详细信息，请参阅 [AtomicXCore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore) 框架的官方 API 文档。本指南使用到的相关 Store 如下：
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >Store/Component</td>
-<td rowspan="1" colSpan="1" >功能描述</td>
-<td rowspan="1" colSpan="1" >API 文档</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >LiveCoreView</td>
-<td rowspan="1" colSpan="1" >直播视频流展示与交互的核心视图组件：负责视频流渲染和视图挂件处理，支持主播直播、观众连麦、主播连线等场景。</td>
-<td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/livecoreview)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >DeviceStore</td>
-<td rowspan="1" colSpan="1" >音视频设备控制：麦克风（开关 / 音量）、摄像头（开关 / 切换 / 画质）、屏幕共享，设备状态实时监听。</td>
-<td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/devicestore)</td>
-</tr>
-<tr>
-<td rowspan="1" colSpan="1" >CoGuestStore</td>
-<td rowspan="1" colSpan="1" >观众连麦管理：连麦申请 / 邀请 / 同意 / 拒绝，连麦成员权限控制（麦克风 / 摄像头），状态同步。</td>
-<td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore)</td>
-</tr>
-</table>
+| Store/Component | 功能描述 | API 文档 |
+| --- | --- | --- |
+| LiveCoreView | 直播视频流展示与交互的核心视图组件：负责视频流渲染和视图挂件处理，支持主播直播、观众连麦、主播连线等场景。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/livecoreview) |
+| DeviceStore | 音视频设备控制：麦克风（开关 / 音量）、摄像头（开关 / 切换 / 画质）、屏幕共享，设备状态实时监听。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/devicestore) |
+| CoGuestStore | 观众连麦管理：连麦申请 / 邀请 / 同意 / 拒绝，连麦成员权限控制（麦克风 / 摄像头），状态同步。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore) |
 ## 常见问题
@@ -474,7 +370,6 @@
 - `.background`：背景层，仅在对应用户没有视频流（例如未开摄像头）的情况下显示，通常用于展示用户的默认头像或占位图。
 ### 我的自定义视图为什么没有显示？
 - **检查代理设置**：请确认已调用 `coreView.videoViewDelegate = self` 并成功设置了代理。