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

package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md

@@ -1,336 +0,0 @@
-`LiveListStore` 是 `AtomicXCore` 中负责管理直播房间列表、创建、加入以及维护房间状态的核心模块。通过`LiveListStore`，您可以为您的应用构建完整的直播生命周期管理。
-
-## 核心功能
-- **直播列表拉取**：获取当前所有公开的直播间列表，支持分页加载。
-
-- **直播生命周期管理**：提供从创建、开播、加入、离开到结束直播的全套流程接口。
-
-- **直播信息更新**：主播可以随时更新直播间的公开信息，例如封面、公告等。
-
-- **实时事件监听**：监听直播结束、用户被踢出等关键事件。
-
-- **自定义业务数据**：强大的自定义元数据（`MetaData`）能力，允许您在房间内存储和同步任何业务相关的信息，例如直播状态、音乐信息、自定义角色等 。
-
-## 核心概念
-
-在开始集成之前，我们先通过下表了解一下 `LiveListStore` 相关的几个核心概念：
-| **核心概念** | **类型** | **核心职责与描述** |
-| --- | --- | --- |
-| `LiveInfo` | `struct` | 代表一个直播间的所有信息模型。包含了直播ID (`liveID`)、名称 (`liveName`)、房主信息 (`liveOwner`) 以及自定义元数据 (`metaData`) 等。 |
-| `LiveListState` | `struct` | 代表直播列表模块的当前状态。其核心属性 liveList 是一个 `[LiveInfo] `数组，存储了拉取到的直播列表；`currentLive` 则代表用户当前所在的直播间信息。 |
-| `LiveListEvent` | `enum` | 代表直播房间的全局事件。分为 `.onLiveEnded` (直播结束) 和 `.onKickedOutOfLive` (被踢出直播) 两种，用于处理关键的房间状态变更。 |
-| `LiveListStore` | `class` | 这是与直播列表和房间生命周期交互的核心管理类。它是一个全局单例 (shared)，负责所有直播房间的创建、加入、信息更新等操作。 |
-
-## 实现步骤
-
-### 步骤1：组件集成
-
-请参考 快速接入 集成 **AtomicXCore**，并完成 搭建基础语聊房的功能实现。
-
-### 步骤2：实现观众从直播列表进入直播间
-
-#### 实现方式：
-1. 创建一个展示直播列表的页面，该页面使用 `UICollectionView` 来布局直播间卡片。
-
-2. 当用户点击某个卡片时，获取该直播间的 `liveID`，并跳转到观众观看页面。
-
-   ``` swift
-   class LiveListViewController: UIViewController, UICollectionViewDataSource, UICollectionViewDelegate, UICollectionViewDelegateFlowLayout {
-
-       private let liveListStore = LiveListStore.shared
-       private var cancellables = Set<AnyCancellable>()
-       private var liveList: [LiveInfo] = []
-
-       private var collectionView: UICollectionView!
-
-       override func viewDidLoad() {
-           super.viewDidLoad()
-           setupUI()
-           bindStore()
-           fetchLiveList()
-       }
-
-       private func bindStore() {
-           // 订阅 state，自动接收列表更新
-           liveListStore.state
-               .subscribe(StatePublisherSelector(keyPath: \LiveListState.liveList))
-               .removeDuplicates()
-               .receive(on: DispatchQueue.main)
-               .sink { [weak self] fetchedList in
-                   self?.liveList = fetchedList
-                   self?.collectionView.reloadData()
-               }
-               .store(in: &cancellables)
-       }
-
-       private func fetchLiveList() {
-           liveListStore.fetchLiveList(cursor: "", count: 20) { result in
-               if case .failure(let error) = result {
-                   print("直播列表拉取失败: \(error.localizedDescription)")
-               }
-           }
-       }
-
-       // 当用户点击列表中的某个Cell时
-       func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath) {
-           let selectedLiveInfo = liveList[indexPath.item]
-
-           // 创建观众观看页面，并将 liveID 传入
-           let audienceVC = YourAudienceViewController(liveID: selectedLiveInfo.liveID)
-           audienceVC.modalPresentationStyle = .fullScreen
-           present(audienceVC, animated: true)
-       }
-
-       // --- UICollectionViewDataSource, Delegate, and UI setup methods ---
-       private func setupUI() {
-           let layout = UICollectionViewFlowLayout()
-           // ... (可以自定义您的布局)
-           collectionView = UICollectionView(frame: view.bounds, collectionViewLayout: layout)
-           collectionView.dataSource = self
-           collectionView.delegate = self
-           collectionView.register(UICollectionViewCell.self, forCellWithReuseIdentifier: "LiveCell")
-           view.addSubview(collectionView)
-       }
-
-       func collectionView(_ collectionView: UICollectionView, numberOfItemsInSection section: Int) -> Int {
-           return liveList.count
-       }
-
-       func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell {
-           let cell = collectionView.dequeueReusableCell(withReuseIdentifier: "LiveCell", for: indexPath)
-           cell.backgroundColor = .lightGray // 自定义您的Cell样式
-           // let liveInfo = liveList[indexPath.item]
-           // ... (例如: cell.titleLabel.text = liveInfo.liveName)
-           return cell
-       }
-
-       func collectionView(_ collectionView: UICollectionView, layout collectionViewLayout: UICollectionViewLayout, sizeForItemAt indexPath: IndexPath) -> CGSize {
-           // 单列、双列布局可通过自定义您的Cell大小来实现
-           let width = (view.bounds.width - 30) / 2
-           return CGSize(width: width, height: width * 1.2)
-       }
-   }
-   ```
-
-   **LiveInfo 参数说明**
-
-| **参数名** | **类型** | **描述** |
-| --- | --- | --- |
-| `liveID` | `String` | 直播间的唯一标识符 |
-| `liveName` | `String` | 直播间的标题 |
-| `coverURL` | `String` | 直播间的封面图片地址 |
-| `liveOwner` | [LiveUserInfo](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveuserinfo) | 房主的个人信息 |
-| `totalViewerCount` | `Int` | 直播间的总观看人数 |
-| `categoryList` | `[NSNumber]` | 直播间的分类标签列表 |
-| `notice` | `String` | 直播间的公告信息 |
-| `metaData` | `[String: String]` | 开发者自定义的元数据，用于实现复杂的业务场景 |
-
-## 功能进阶
-
-### 场景一：实现直播列表的分类展示
-
-在 App 的直播广场页，顶部设有“热门”、“音乐”、“游戏”等分类标签。用户点击不同的标签后，下方的直播列表会动态筛选，只展示对应分类的直播间，从而帮助用户快速发现感兴趣的内容。
-
-#### 实现方式：
-
-核心是利用 `LiveInfo` 模型中的 `categoryList` 属性。
-1. 当主播开播设置分类后，`fetchLiveList` 返回的 `LiveInfo` 对象中就会包含这些分类信息。
-
-2. 您的 App 在获取到完整的直播列表后，只需在客户端根据用户选择的分类，对这个列表进行一次简单的筛选，然后刷新 UI 即可。
-
-#### 代码示例：
-
-以下示例展示了如何在 `LiveListViewController` 中扩展一个 `LiveListManager` 来处理数据和筛选逻辑。
-``` swift
-import AtomicXCore
-import Combine
-
-// 1. 创建一个数据管理器来封装数据获取和筛选逻辑
-class LiveListManager {
-    private let liveListStore = LiveListStore.shared
-    private var cancellables = Set<AnyCancellable>()
-    private var fullLiveList: [LiveInfo] = []
-
-    // 对外暴露最终的直播列表
-    let filteredLiveListPublisher = CurrentValueSubject<[LiveInfo], Never>([])
-
-    init() {
-        liveListStore.state
-            .subscribe(StatePublisherSelector(keyPath: \LiveListState.liveList))
-            .receive(on: DispatchQueue.main)
-            .sink { [weak self] fetchedList in
-                self?.fullLiveList = fetchedList
-                // 默认将完整列表发布出去
-                self?.filteredLiveListPublisher.send(fetchedList)
-            }
-            .store(in: &cancellables)
-    }
-
-    func fetchFirstPage() {
-        liveListStore.fetchLiveList(cursor: "", count: 20) { _ in }
-    }
-
-    /// 根据分类筛选直播列表
-    func filterLiveList(by categoryId: NSNumber?) {
-        guard let categoryId = categoryId else {
-            // 如果 categoryId 为 nil，则显示完整列表
-            filteredLiveListPublisher.send(fullLiveList)
-            return
-        }
-
-        let filteredList = fullLiveList.filter { liveInfo in
-            liveInfo.categoryList.contains(categoryId)
-        }
-        filteredLiveListPublisher.send(filteredList)
-    }
-}
-```
-``` swift
-// 2. 在您的 LiveListViewController 中使用 Manager
-class LiveListViewController: UIViewController {
-    private let manager = LiveListManager()
-    private var cancellables = Set<AnyCancellable>()
-    private var liveList: [LiveInfo] = []
-    private var collectionView: UICollectionView!
-
-    override func viewDidLoad() {
-        super.viewDidLoad()
-        // ... setupUI ...
-
-        // 绑定数据
-        manager.filteredLiveListPublisher
-            .receive(on: DispatchQueue.main)
-            .sink { [weak self] filteredList in
-                self?.liveList = filteredList
-                self?.collectionView.reloadData()
-            }
-            .store(in: &cancellables)
-
-        // 首次拉取
-        manager.fetchFirstPage()
-    }
-
-    // 当用户点击顶部分类标签 (UISegmentedControl) 时
-    @objc func categorySegmentDidChange(_ sender: UISegmentedControl) {
-        let selectedCategoryId: NSNumber? = 1 // 假设 "音乐" 分类的ID是 1
-        manager.filterLiveList(by: selectedCategoryId)
-    }
-
-    // ... (UICollectionView 相关代码)
-}
-
-```
-
-### 场景二：实现语聊房内的自定义状态同步
-
-在语聊房中，主播可能需要向所有观众同步一些自定义信息，例如“当前房间话题”、“背景音乐信息”等。`LiveListStore` 的 `MetaData` 功能可以实现这一点。
-
-#### 实现方式：
-1. 主播端将自定义信息（建议使用 JSON 格式）通过 `updateLiveMetaData` 接口设置到一个或多个 key 中。`AtomicXCore` 会将这个变更实时同步给所有观众。
-
-2. 观众端只需订阅` LiveListState.currentLive`，监听 `metaData` 的变化，一旦发现关心的 key 更新，就解析其 value 并刷新业务状态。
-
-#### 示例代码：
-``` swift
-import AtomicXCore
-import Combine
-
-// 1. 定义一个背景音乐模型 (可选，建议使用 Codable)
-struct MusicModel: Codable {
-    let musicId: String
-    let musicName: String
-}
-
-// 2. 主播端：在您的主播业务逻辑中，添加推送背景音乐的方法
-func updateBackgroundMusic(music: MusicModel) {
-    guard let jsonData = try? JSONEncoder().encode(music),
-            let jsonString = String(data: jsonData, encoding: .utf8) else { return }
-
-    // 将要更新的元数据
-    let metaData = ["music_info": jsonString]
-
-    // 使用全局单例的 liveListStore 来更新 metaData
-    LiveListStore.shared.updateLiveMetaData(metaData) { result in
-        if case .success = result {
-            print("背景音乐 \(music.musicName) 推送成功")
-        } else if case .failure(let error) = result {
-            print("背景音乐推送失败: \(error.message)")
-        }
-    }
-}
-
-// 3. 观众端：在您的观众业务逻辑中，订阅并响应
-private func subscribeToDataUpdates() {
-        LiveListStore.shared.state
-            // 监听当前房间的 metaData
-            .subscribe(StatePublisherSelector(keyPath: \LiveListState.currentLive))
-            .map { $0.metaData["music_info"]}
-            .removeDuplicates()
-            .receive(on: DispatchQueue.main)
-            .sink { jsonString in
-                guard let jsonString = jsonString,
-                      let data = jsonString.data(using: .utf8),
-                      let music = try? JSONDecoder().decode(MusicModel.self, from: data) else {
-                    // 刷新业务状态，播放新的音乐
-                  // ... (例如: playMusic(music))
-                    return
-                }
-
-            }
-            .store(in: &cancellables)
-    }
-
-```
-
-关于 [LiveListStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveliststore) 及其相关类的所有公开接口、属性和方法的详细信息，请参阅随 [AtomicXCore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore) 框架的官方 API 文档。本文档使用到的相关 Store 如下：
-| **Store/Component** | **功能描述** | **API 文档** |
-| --- | --- | --- |
-| LiveListStore | 直播间全生命周期管理：创建 / 加入 / 离开 / 销毁房间，查询房间列表，修改直播信息（名称、公告等），监听直播状态（例如被踢出、结束）。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveliststore) |
-
-## 常见问题
-
-### 语聊房的列表和视频直播的列表数据是同一份吗？
-
-它们的数据是同一份，您不需要分开拉取。`LiveListStore` 是一个全局单例，它负责统一管理应用中所有“直播”房间的生命周期，无论是视频直播还是语聊房。
-
-### **直播列表中如何区分语聊房和视频直播**
-
-`LiveListStore` 本身不区分房间的业务类型。您需要在获取列表后，在客户端的应用层（业务逻辑或 UI 层）进行筛选和分类。
-
-我们推荐采用以下两种方式进行区分：
-
-**方式一（推荐）：使用 seatLayoutTemplateID 区分**。这是一个用于定义房间布局的模板 ID，关于目前已支持的模板 ID 和效果，请参阅文档开始直播-运行效果。您要在创建房间时指定 ID，然后在获取列表时根据 ID 范围来识别业务场景。
-- **步骤1：创建房间时指定 ID **调用 LiveListStore.shared.createLive 时，您需要根据业务场景为 LiveInfo 的 seatLayoutTemplateID 属性传入指定范围的 ID：
-
-  - 语聊房场景：传入 1 - 199 范围内的模板 ID。
-
-  - 视频直播场景：传入 200 - 999 范围内的模板 ID。
-
-- **步骤2：获取列表时筛选 **客户端在 `LiveListStore.state.liveList`中收到列表数据后，通过判断这个 ID 值所属的范围来区分，从而在进入直播间的时候区分两种业务场景。
-
-   > **重要提示：**
-   >
-
-   > 创建房间时，如果传入的 seatLayoutTemplateID 范围与您的业务场景（语聊房、视频直播）不匹配，可能会导致麦位布局出现功能异常。
-   >
-
-   **方式二**：**为 **`liveID`** 添加业务前缀。**这是一种可选的、纯粹的应用层约定，用于辅助您在客户端快速筛选。
-
-  - **步骤1：创建房间时添加前缀 **在您生成 liveID 并调用 createLive 时，为不同业务类型的 liveID 赋予不同的前缀。例如：视频直播的 ID 以 “Live_” 开头 (例如：Live_12345)，语聊房的 ID 以 “voice_” 开头 (例如：voice_67890)。
-
-  - **步骤2：获取列表时检查前缀 **客户端在拉取到列表后，通过检查 liveID 字符串的前缀来进行区分。
-
-### 使用 `updateLiveMetaData` 时有哪些需要注意的限制和规则？
-
-为了保证系统的稳定和高效，`metaData` 的使用遵循以下规则：
-- **权限**：只有房主和管理员可以调用 `updateLiveMetaData`。普通观众没有权限。
-
-- **数量与大小限制：**
-
-  - 单个房间最多支持 **10** 个 key。
-
-  - 每个 key 的长度不超过 **50 字节**，每个 value 的长度不超过 **2KB**。
-
-  - 单个房间所有 value 的总大小不超过 **16KB**。
-
-- **冲突解决**： `metaData` 的更新机制是“后来者覆盖”。如果多个管理员在短时间内修改同一个 key，最后一次的修改会生效。建议在业务设计上避免多人同时修改同一个关键信息。