@tencentcloud/sdk-mcp 1.3.9 → 1.4.1

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

@@ -1,8 +1,5 @@
 **AtomicXCore** 提供了 [CoGuestStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore) 和 [LiveSeatStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveseatstore) 模块，用于管理观众连麦的完整业务流程。您无需关心复杂的状态同步和信令交互，只需调用几个简单的方法，即可为您的直播添加强大的观众与主播音视频互动功能。本文档将指导您如何使用 `CoGuestStore `和 `LiveSeatStore`在 iOS 应用中快速实现语音连麦功能。
 
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032603567/02ca5724b64111f0a5e052540099c741.png)
-
-
 ## 核心场景
 
 `CoGuestStore`和`LiveSeatStore`支持以下几个主流的场景：
@@ -12,12 +9,11 @@
 
 - **主播管理麦位**：主播可以对麦位上的用户进行踢人、闭麦、锁麦等操作。
 
-
 ## 实现步骤
 
 ### 步骤1：组件集成
 
-请参考 [快速接入](https://write.woa.com/document/192834898445422592) 集成 **AtomicXCore**。
+请参考 快速接入 集成 **AtomicXCore**。
 
 ### 步骤2：实现观众申请上麦
 
@@ -26,17 +22,16 @@
 作为观众，您的核心任务是**发起申请、接收结果**和**主动下麦**。
 1. **发起连麦申请**
 
-
    当用户点击界面上的“申请连麦”按钮时，调用 `applyForSeat` 方法。
 
    ``` swift
    import AtomicXCore
-   
+
    let liveId = "房间ID"
    var guestStore: CoGuestStore {
        CoGuestStore.create(liveID: liveID)
    }
-   
+
    // 用户点击“申请连麦”
    func requestToConnect() {
        // timeout: 请求超时时间，例如 30 秒
@@ -52,7 +47,6 @@
    ```
 2. **监听主播的处理结果**
 
-
    通过订阅 `guestEventPublisher`，您可以接收到主播的处理结果。
 
    ``` swift
@@ -63,7 +57,7 @@
              if case let .onGuestApplicationResponded(isAccept, hostUser) = event {
                  if isAccept {
                      print("主播 \(hostUser.userName) 同意了你的申请，准备上麦")
-                     // 1. 打开麦克风 
+                     // 1. 打开麦克风
                      DeviceStore.shared.openLocalMicrophone(completion: nil)
                      // 2. 在此更新 UI，例如关闭申请按钮，显示连麦中的状态
                  } else {
@@ -77,7 +71,6 @@
    ```
 3. **主动下麦**
 
-
    当连麦观众想结束互动时，调用 `disConnect` 方法即可返回普通观众状态。
 
    ``` swift
@@ -95,7 +88,6 @@
    ```
 4. **(可选) 取消申请**
 
-
    如果观众在主播处理前想撤回申请，可以调用 `cancelApplication`。
 
    ``` swift
@@ -117,17 +109,16 @@
 作为主播，您的核心任务是**接收申请、展示申请列表**和**处理申请**。
 1. **监听新的连麦申请**
 
-
    通过订阅 `hostEventPublisher`，您可以在有新观众申请时立即收到通知，并给出提示。
 
    ``` swift
    import AtomicXCore
-   
+
    let liveId = "房间ID"
    var guestStore: CoGuestStore {
        CoGuestStore.create(liveID: liveID)
    }
-   
+
    // 订阅主播事件
    guestStore.hostEventPublisher
        .sink { [weak self] event in
@@ -140,7 +131,6 @@
    ```
 2. **展示申请列表**
 
-
    `CoGuestStore` 的 state 会实时维护当前的申请者列表，您可以订阅它来刷新您的 UI。
 
    ``` swift
@@ -157,7 +147,6 @@
    ```
 3. **处理连麦申请**
 
-
    当您在列表中选择一位观众并点击“同意”或“拒绝”时，调用相应的方法。
 
    ``` perl
@@ -169,7 +158,7 @@
            }
        }
    }
-   
+
    // 主播点击“拒绝”按钮
    func reject(userId: String) {
        guestStore.rejectApplication(userID: userId) { result in
@@ -185,7 +174,6 @@
 #### 主播端实现
 1. **向观众发起邀请**
 
-
    当主播在观众列表中选择某人并点击“邀请连麦”时，调用 `inviteToSeat` 方法。
 
    ``` swift
@@ -201,7 +189,6 @@
    ```
 2. **监听观众的回应**
 
-
    通过 `hostEventPublisher` 监听 `onHostInvitationResponded` 事件。
 
    ``` swift
@@ -218,7 +205,6 @@
 #### 观众端实现
 1. **接收主播的邀请**
 
-
    通过 `guestEventPublisher` 监听 `onHostInvitationReceived` 事件。
 
    ``` swift
@@ -231,12 +217,11 @@
    ```
 2. **响应邀请**
 
-
    当用户在弹出的对话框中做出选择后，调用相应的方法。
 
    ``` swift
    let inviterId = "发起邀请的主播ID" // 从 onHostInvitationReceived 事件中获取
-   
+
    // 用户点击“接受”
    func accept() {
        guestStore.acceptInvitation(inviterID: inviterId) { result in
@@ -246,7 +231,7 @@
            }
        }
    }
-   
+
    // 用户点击“拒绝”
    func reject() {
        guestStore.rejectInvitation(inviterID: inviterId) { result in
@@ -268,7 +253,6 @@
 
 2. **解除静音**：调用 `unmuteMicrophone(completion:)` 方法。
 
-
 #### 示例代码：
 ``` swift
 let seatStore = LiveSeatStore.create(liveID: liveId)
@@ -279,24 +263,9 @@ seatStore.unmuteMicrophone(completion: nil) //解除静音
 ```
 
 #### unmuteMicrophone 接口参数：
-<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" >`completion`</td>
-
-<td rowspan="1" colSpan="1" >`CompletionClosure?`</td>
-
-<td rowspan="1" colSpan="1" >操作完成后的回调。</td>
-</tr>
-</table>
-
+| **参数** | **类型** | **描述** |
+| --- | --- | --- |
+| `completion` | `CompletionClosure?` | 操作完成后的回调。 |
 
 ### 主播远程控制麦上用户开麦或关麦
 
@@ -309,7 +278,6 @@ seatStore.unmuteMicrophone(completion: nil) //解除静音
 
 3. **用户自行开麦**：用户在收到“解除锁定”的通知后，必须主动调用 `LiveSeatStore` 的 `unmuteMicrophone()`方法解除静音，才能让房间内其他人听到自己的声音。
 
-
 #### 示例代码：
 
 ##### 主播端：
@@ -352,60 +320,16 @@ seatStore.liveSeatEventPublisher
 ```
 
 #### closeRemoteMicrophone 接口参数：
-<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" >`userID`</td>
-
-<td rowspan="1" colSpan="1" >`String`</td>
-
-<td rowspan="1" colSpan="1" >被操作的用户`userID`。</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`completion`</td>
-
-<td rowspan="1" colSpan="1" >`CompletionClosure?`</td>
-
-<td rowspan="1" colSpan="1" >请求完成后的回调。</td>
-</tr>
-</table>
-
+| **参数** | **类型** | **描述** |
+| --- | --- | --- |
+| `userID` | `String` | 被操作的用户`userID`。 |
+| `completion` | `CompletionClosure?` | 请求完成后的回调。 |
 
 #### openRemoteMicrophone 接口参数：
-<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" >`userID`</td>
-
-<td rowspan="1" colSpan="1" >`String`</td>
-
-<td rowspan="1" colSpan="1" >被操作的用户`userID`。</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`completion`</td>
-
-<td rowspan="1" colSpan="1" >`CompletionClosure?`</td>
-
-<td rowspan="1" colSpan="1" >请求完成后的回调。</td>
-</tr>
-</table>
-
+| **参数** | **类型** | **描述** |
+| --- | --- | --- |
+| `userID` | `String` | 被操作的用户`userID`。 |
+| `completion` | `CompletionClosure?` | 请求完成后的回调。 |
 
 ### 主播将麦上用户踢下麦位
 
@@ -414,7 +338,6 @@ seatStore.liveSeatEventPublisher
 
 2. **监听事件通知**：被踢下麦的用户会收到 `CoGuestStore.guestEventPublisher `中的 `onKickedOffSeat` 事件通知。
 
-
 #### 示例代码：
 ``` swift
 // 假设要踢走 "userB"
@@ -446,32 +369,10 @@ guestStore
 ```
 
 #### kickUserOutOfSeat 接口参数：
-<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" >`userID`</td>
-
-<td rowspan="1" colSpan="1" >`String`</td>
-
-<td rowspan="1" colSpan="1" >被踢下麦的用户`userID`。</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`completion`</td>
-
-<td rowspan="1" colSpan="1" >`CompletionClosure?`</td>
-
-<td rowspan="1" colSpan="1" >请求完成后的回调。</td>
-</tr>
-</table>
-
+| **参数** | **类型** | **描述** |
+| --- | --- | --- |
+| `userID` | `String` | 被踢下麦的用户`userID`。 |
+| `completion` | `CompletionClosure?` | 请求完成后的回调。 |
 
 ### 主播锁定和解锁麦位
 
@@ -482,7 +383,6 @@ guestStore
 
 2. **解锁麦位**：调用 `unlockSeat` 可以解锁麦位，解锁后该麦位可以再次被占用。
 
-
 #### 示例代码：
 ``` swift
 // 锁定2号麦位
@@ -501,75 +401,30 @@ seatStore.unlockSeat(seatIndex: 2) { result in
 ```
 
 #### lockSeat 接口参数：
-<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" >`seatIndex`</td>
-
-<td rowspan="1" colSpan="1" >`Int`</td>
-
-<td rowspan="1" colSpan="1" >需要锁定的麦位索引。</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`completion`</td>
-
-<td rowspan="1" colSpan="1" >`CompletionClosure?`</td>
-
-<td rowspan="1" colSpan="1" >请求完成后的回调。</td>
-</tr>
-</table>
-
+| **参数** | **类型** | **描述** |
+| --- | --- | --- |
+| `seatIndex` | `Int` | 需要锁定的麦位索引。 |
+| `completion` | `CompletionClosure?` | 请求完成后的回调。 |
 
 #### unlockSeat 接口参数：
-<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" >`seatIndex`</td>
-
-<td rowspan="1" colSpan="1" >`Int`</td>
-
-<td rowspan="1" colSpan="1" >需要解锁的麦位索引。</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`completion`</td>
-
-<td rowspan="1" colSpan="1" >`CompletionClosure?`</td>
-
-<td rowspan="1" colSpan="1" >请求完成后的回调。</td>
-</tr>
-</table>
-
+| **参数** | **类型** | **描述** |
+| --- | --- | --- |
+| `seatIndex` | `Int` | 需要解锁的麦位索引。 |
+| `completion` | `CompletionClosure?` | 请求完成后的回调。 |
 
 ### 移动麦位
 
 主播和普通上麦用户可以调用`moveUserToSeat(userID:targetIndex:policy:completion:)`移动麦位。
 
 #### 实现方式：
-1. **主播移动麦位**：主播可以调用此接口将任意用户移动到指定麦位。此时 `userID` 传入目标用户的 ID，`targetIndex`是目标麦位索引，`policy` 参数来指定如果目标麦位有人时的移动策略，详细参见 [接口参数](https://write.woa.com/#227e92a5-7552-41ae-b57c-2dab5b7de234) 说明。
+1. **主播移动麦位**：主播可以调用此接口将任意用户移动到指定麦位。此时 `userID` 传入目标用户的 ID，`targetIndex`是目标麦位索引，`policy` 参数来指定如果目标麦位有人时的移动策略，详细参见 接口参数 说明。
 
 2. **普通上麦用户移动自己麦位**：普通上麦用户也可以调用此接口来移动自己。此时 `userID` 必须传入用户自己的 ID，`targetIndex` 传入想去的新麦位索引，此时`policy` 参数无效，如果目标麦位有人时会报错并停止移动。
 
-
 #### 示例代码：
 ``` swift
-seatStore.moveUserToSeat(userID: "userC", 
-                         targetIndex: newSeatIndex, 
+seatStore.moveUserToSeat(userID: "userC",
+                         targetIndex: newSeatIndex,
                          policy: .abortWhenOccupied) { result in
     if case .success = result {
         print("已成功移动到 \(newSeatIndex) 号麦位")
@@ -580,78 +435,20 @@ seatStore.moveUserToSeat(userID: "userC",
 ```
 
 #### moveUserToSeat 接口参数：
-<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" >`userID`</td>
-
-<td rowspan="1" colSpan="1" >`String`</td>
-
-<td rowspan="1" colSpan="1" >需要移麦的用户`userID`。</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`targetIndex`</td>
-
-<td rowspan="1" colSpan="1" >`Int`</td>
-
-<td rowspan="1" colSpan="1" >目标麦位索引。</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`policy`</td>
-
-<td rowspan="1" colSpan="1" >`MoveSeatPolicy?`</td>
-
-<td rowspan="1" colSpan="1" >目标麦位有人时的移动策略枚举：<br>- `abortWhenOccupied`：目标麦位有人时放弃移动（默认策略）​​<br>- `forceReplace`：强制替换目标麦位上的用户​​，被替换的用户将会被踢下麦<br>- `swapPosition`：与目标麦位用户交换位置​​。</td>
-</tr>
-
-<tr>
-<td rowspan="1" colSpan="1" >`completion`</td>
-
-<td rowspan="1" colSpan="1" >`CompletionClosure?`</td>
-
-<td rowspan="1" colSpan="1" >请求完成后的回调。</td>
-</tr>
-</table>
-
+| **参数** | **类型** | **描述** |
+| --- | --- | --- |
+| `userID` | `String` | 需要移麦的用户`userID`。 |
+| `targetIndex` | `Int` | 目标麦位索引。 |
+| `policy` | `MoveSeatPolicy?` | 目标麦位有人时的移动策略枚举：<br>- `abortWhenOccupied`：目标麦位有人时放弃移动（默认策略）​​<br>- `forceReplace`：强制替换目标麦位上的用户​​，被替换的用户将会被踢下麦<br>- `swapPosition`：与目标麦位用户交换位置​​。 |
+| `completion` | `CompletionClosure?` | 请求完成后的回调。 |
 
 ## API 文档
 
 关于 [CoGuestStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore) 和 [LiveSeatStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveseatstore) 及其相关类的所有公开接口、属性和方法的详细信息，请参阅 [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" >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>
-
-<tr>
-<td rowspan="1" colSpan="1" >LiveSeatStore</td>
-
-<td rowspan="1" colSpan="1" >麦位管理：静音/解除静音，锁定/解锁麦位，踢人下麦、远程控制麦上用户麦克风，麦列表状态监听</td>
-
-<td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveseatstore)</td>
-</tr>
-</table>
-
+| **Store/Component** | **功能描述** | **API 文档** |
+| --- | --- | --- |
+| CoGuestStore | 观众连麦管理：连麦申请 / 邀请 / 同意 / 拒绝，连麦成员权限控制（麦克风 / 摄像头），状态同步。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore) |
+| LiveSeatStore | 麦位管理：静音/解除静音，锁定/解锁麦位，踢人下麦、远程控制麦上用户麦克风，麦列表状态监听 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveseatstore) |
 
 ## 常见问题
 
@@ -662,7 +459,6 @@ seatStore.moveUserToSeat(userID: "userC",
 
 - 语音房（语聊房）：核心是麦位网格。您不会使用 `LiveCoreView`，而是会基于 `LiveSeatStore` 的 `state`（特别是 `seatList`）来构建一个网格 UI（例如 `UICollectionView`）。UI 的重点是实时显示每个麦位 `SeatInfo` 的状态：是否有人、是否静音、是否被锁定 ，以及是否正在说话。您只需要打开麦克风。
 
-
 ### 如何在 UI 上实时刷新麦位信息（如是否有人、是否静音）？
 
 您应该订阅 `LiveSeatState` 中的 `seatList` 属性，它是一个`[SeatInfo]` 数组类型的响应式数据，每当数组变化时都会通知您重新渲染麦位列表。遍历此数组，您可以：
@@ -672,7 +468,6 @@ seatStore.moveUserToSeat(userID: "userC",
 
 - 通过 `seatInfo.userInfo.microphoneStatus` 判断麦上用户的麦克风状态。
 
-
 ### LiveSeatStore 和 DeviceStore 都有麦克风接口，它们有何区别？
 
 这是一个非常重要的问题。`DeviceStore` 管理的是物理设备，而 `LiveSeatStore` 管理的是麦位业务（即音频流）。
@@ -682,14 +477,12 @@ seatStore.moveUserToSeat(userID: "userC",
 
 - `closeLocalMicrophone`：停止音频采集并释放麦克风设备。
 
-
    `LiveSeatStore`：
 
 - `muteMicrophone`：静音。停止向远端发送本地的音频流，但麦克风设备本身仍在运行。
 
 - `unmuteMicrophone`：解除静音。恢复向远端发送音频流。
 
-
    推荐的工作流程：您应该遵循“设备只开一次，麦上只用静音切换”的原则
 
 1. **上麦时**：当观众成功上麦，调用一次 `openLocalMicrophone`来启动设备。
@@ -697,5 +490,3 @@ seatStore.moveUserToSeat(userID: "userC",
 2. **在麦上时**：用户在麦位上所有的“开麦”和“闭麦”操作，都应该调用 `unmuteMicrophone`和 `muteMicrophone`来控制上行音频流的通断。
 
 3. **下麦时**：当用户下麦（例如调用 `disconnect`），调用`closeLocalMicrophone`来释放设备。
-
-