@tencentcloud/sdk-mcp 1.3.8 → 1.3.9

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 (70) hide show
  1. package/package.json +1 -1
  2. package/resource/doc/chatuikit/android/integration.md +466 -484
  3. package/resource/doc/chatuikit/android/workflow.md +713 -0
  4. package/resource/doc/livekit/live/flutter/live-integration.md +208 -167
  5. package/resource/doc/livekit/voice/android/voice-audience-list.md +335 -0
  6. package/resource/doc/livekit/voice/android/voice-audio-effect.md +384 -0
  7. package/resource/doc/livekit/voice/android/voice-barrage.md +569 -0
  8. package/resource/doc/livekit/voice/android/voice-co-guest-interaction.md +748 -0
  9. package/resource/doc/livekit/voice/android/voice-gift.md +833 -0
  10. package/resource/doc/livekit/voice/android/voice-host-interaction.md +728 -0
  11. package/resource/doc/livekit/voice/android/voice-integration.md +886 -0
  12. package/resource/doc/livekit/voice/android/voice-room-list.md +493 -0
  13. package/resource/doc/livekit/voice/android/workflow.md +333 -0
  14. package/resource/doc/livekit/voice/flutter/voice-audience-list.md +337 -0
  15. package/resource/doc/livekit/voice/flutter/voice-audio-effect.md +739 -0
  16. package/resource/doc/livekit/voice/flutter/voice-barrage.md +578 -0
  17. package/resource/doc/livekit/voice/flutter/voice-co-guest-interaction.md +673 -0
  18. package/resource/doc/livekit/voice/flutter/voice-gift.md +812 -0
  19. package/resource/doc/livekit/voice/flutter/voice-integration.md +925 -0
  20. package/resource/doc/livekit/voice/flutter/voice-room-list.md +842 -0
  21. package/resource/doc/livekit/voice/flutter/workflow.md +359 -0
  22. package/resource/doc/livekit/voice/ios/voice-audience-list.md +335 -0
  23. package/resource/doc/livekit/voice/ios/voice-audio-effect.md +373 -0
  24. package/resource/doc/livekit/voice/ios/voice-barrage.md +529 -0
  25. package/resource/doc/livekit/voice/ios/voice-co-guest-interaction.md +701 -0
  26. package/resource/doc/livekit/voice/ios/voice-gift.md +785 -0
  27. package/resource/doc/livekit/voice/ios/voice-host-interaction.md +820 -0
  28. package/resource/doc/livekit/voice/ios/voice-integration.md +853 -0
  29. package/resource/doc/livekit/voice/ios/voice-room-list.md +467 -0
  30. package/resource/doc/livekit/voice/ios/workflow.md +358 -0
  31. package/resource/doc/livekit/voice/uni-app/voice-audience-list.md +264 -0
  32. package/resource/doc/livekit/voice/uni-app/voice-audio-effect.md +332 -0
  33. package/resource/doc/livekit/voice/uni-app/voice-barrage.md +482 -0
  34. package/resource/doc/livekit/voice/uni-app/voice-co-guest-interaction.md +944 -0
  35. package/resource/doc/livekit/voice/uni-app/voice-gift.md +716 -0
  36. package/resource/doc/livekit/voice/uni-app/voice-integration.md +613 -0
  37. package/resource/doc/livekit/voice/uni-app/voice-room-list.md +562 -0
  38. package/resource/doc/livekit/voice/uni-app/workflow.md +369 -0
  39. package/resource/doc/roomkit/vue/integration.md +119 -224
  40. package/resource/doc/roomkit/vue/workflow.md +472 -226
  41. package/resource/doc/tuicallkit/android/integration.md +675 -90
  42. package/resource/doc/tuicallkit/android/workflow.md +432 -0
  43. package/tools/common/present-scenario-choice.js +16 -0
  44. package/tools/common/present-scenario-choice.js.map +1 -0
  45. package/tools/definitions/get_native_call_uikit_integration_def.js +18 -2
  46. package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
  47. package/tools/definitions/get_native_chat_uikit_integration_def.js +29 -7
  48. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
  49. package/tools/definitions/get_native_live_uikit_integration_def.js +65 -40
  50. package/tools/definitions/get_native_live_uikit_integration_def.js.map +1 -1
  51. package/tools/definitions/get_native_live_uikit_interaction_def.js +42 -94
  52. package/tools/definitions/get_native_live_uikit_interaction_def.js.map +1 -1
  53. package/tools/definitions/get_web_room_feature_detail_def.js +29 -32
  54. package/tools/definitions/get_web_room_feature_detail_def.js.map +1 -1
  55. package/tools/definitions/get_web_room_uikit_integration_def.js +25 -9
  56. package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
  57. package/tools/definitions/present_scenario_choice_def.js +53 -0
  58. package/tools/definitions/present_scenario_choice_def.js.map +1 -0
  59. package/tools/definitions/record_prompt_def.js +6 -1
  60. package/tools/definitions/record_prompt_def.js.map +1 -1
  61. package/tools/definitions/record_result_def.js +20 -4
  62. package/tools/definitions/record_result_def.js.map +1 -1
  63. package/tools/index.js +2 -0
  64. package/tools/index.js.map +1 -1
  65. package/tools/live/get-native-live-uikit-integration.js +110 -34
  66. package/tools/live/get-native-live-uikit-integration.js.map +1 -1
  67. package/tools/live/get_native_live_uikit_interaction.js +128 -35
  68. package/tools/live/get_native_live_uikit_interaction.js.map +1 -1
  69. package/utils/report-cls-client.js +1 -1
  70. package/utils/report-es-client.js +1 -1
@@ -0,0 +1,359 @@
1
+ # Native 语聊房 AtomicXCore 代码生成工作流指令 (Flutter)
2
+
3
+ ## 🚨 核心原则(最高优先级)
4
+
5
+ **Agent 必须确保生成的代码可以成功编译运行,严禁将无法构建的代码交付给用户!**
6
+
7
+ ### ⚠️ 强制编译验证
8
+
9
+ **每次生成/修改代码后,必须执行完整构建验证**:
10
+
11
+ ```bash
12
+ flutter build apk --debug
13
+ # 或者在 iOS 环境下
14
+ flutter build ios --debug --no-codesign
15
+ ```
16
+
17
+ **禁止行为**:
18
+
19
+ * ❌ 禁止只用 `flutter analyze` 检查就认为代码正确(无法检测原生依赖问题)
20
+ * ❌ 禁止忽略 `pubspec.yaml` 版本冲突
21
+
22
+ **编译错误分类与处理**:
23
+ | 错误类型 | 示例 | 处理方式 |
24
+ |---------|------|---------|
25
+ | 依赖解析失败 | `Because xxx depends on yyy...` | 检查 `pubspec.yaml` 版本兼容性,执行 `flutter pub get` |
26
+ | 依赖缺失 | `Target of URI doesn't exist` | 添加缺失库到 `dependencies` |
27
+ | Import 缺失 | `Undefined class 'xxx'` | 添加 import 语句 |
28
+ | 资源缺失 | `Unable to load asset` | 在 `pubspec.yaml` 的 `assets` 节点注册资源 |
29
+ | 权限缺失 | Crash on access Mic | 检查 `AndroidManifest.xml` 和 `Info.plist` |
30
+
31
+ **验证流程**:
32
+
33
+ 1. 执行 `flutter build apk --debug`。
34
+ 2. 如果失败 → 分析完整错误堆栈 → 修复 → 重新构建。
35
+ 3. 循环直到 `BUILD SUCCESSFUL`。
36
+
37
+ **处理流程**:
38
+
39
+ 1. **构建成功** → 交付代码。
40
+ 2. **构建失败** → 分析错误 → **自动修复** → 重新构建。
41
+ * ✅ **可自动修复**:依赖缺失、Import 缺失、权限配置缺失。
42
+ * ❌ **不可修复**:SDK 内部错误、Flutter 环境配置问题(需提示用户)。
43
+
44
+ ---
45
+
46
+ ## 📋 指令目的与架构
47
+
48
+ 为 Agent 提供实现 Native (Flutter) 语聊房 AtomicXCore 核心功能的**代码生成蓝图**。
49
+
50
+ **核心架构**:
51
+
52
+ * **麦位管理**:`LiveSeatStore` (麦位数据驱动)
53
+ * **状态**:`LiveSeatState` / `SeatInfo` / `SeatUserInfo`
54
+ * **事件**:`Listener` (回调处理)
55
+
56
+ **语聊房 vs 视频直播的核心差异**:
57
+ | 特性 | 视频直播 | 语聊房 |
58
+ |------|---------|-------|
59
+ | 核心组件 | `LiveCoreWidget` | `LiveSeatStore` |
60
+ | 媒体类型 | 音视频流 | 纯音频(麦位) |
61
+ | 画面 | 视频画面 | 麦位头像 + 音浪动画 |
62
+ | 核心概念 | 推流/拉流 | 麦位(seatList) |
63
+
64
+ **功能依赖逻辑(重要)**:
65
+
66
+ 1. **基础先行**:必须先使用本工具(`get_flutter_voice_uikit_integration`)完成基础语聊房(房主开播/观众进房/房间列表)。
67
+ 2. **互动叠加**:如果用户需求包含"上麦"、"连线"、"观众列表",必须**在基础功能完成后**,再调用互动工具(`get_flutter_voice_uikit_interaction`)。
68
+ 3. **空项目处理**:若用户在空项目中直接请求互动功能,Agent **必须先实现基础功能**,再添加互动能力。
69
+
70
+ ---
71
+
72
+ ## ⚙️ 自动化工作流步骤
73
+
74
+ ### 步骤 0: 前置准备(自动化)
75
+
76
+ 1. **生成凭证**:调用 `get_usersig` 工具生成测试凭证。
77
+ * 房主: `host001`, `host002`, `host003`
78
+ * 观众: `user001`, `user002`, `user003`
79
+
80
+ 2. **环境检查**:检查 `pubspec.yaml`,若缺失以下依赖则自动添加:
81
+ ```yaml
82
+ dependencies:
83
+ flutter:
84
+ sdk: flutter
85
+ atomic_x_core: ^3.6.0 # 核心库
86
+ permission_handler: ^11.0.0 # 权限处理
87
+ svgaplayer_flutter: ^2.0.0 # 礼物动画(如需)
88
+ ```
89
+
90
+ 3. **权限注入**(语聊房不需要摄像头权限):
91
+ * **Android**: 在 `android/app/src/main/AndroidManifest.xml` 添加 Record Audio 权限。
92
+ * **iOS**: 在 `ios/Runner/Info.plist` 添加 `NSMicrophoneUsageDescription`。
93
+
94
+ ### 步骤 1: 获取与生成
95
+
96
+ **必须优先且唯一**使用本工具返回的**实时文档内容**生成代码。
97
+
98
+ * **仅房主**:生成 `HostPage`
99
+ * **仅观众**:生成 `AudiencePage`
100
+ * **房主+观众**:生成 `MainPage` (入口选择) + `HostPage` + `AudiencePage`
101
+
102
+ ### 步骤 2: 验证与交付
103
+
104
+ 执行 `flutter build apk --debug`,确保无误后交付。
105
+
106
+ ---
107
+
108
+ ## 🚫 代码生成约束(严格遵守)
109
+
110
+ ### 1. 通用代码约束
111
+
112
+ * **严禁修改 Import**:统一使用 `import 'package:atomic_x_core/atomicxcore.dart';`。
113
+ * **严禁臆造 API**:必须严格遵循文档中的 Store 和 Model 定义。
114
+ * **必须查阅 API 文档**:涉及数据模型字段(如 `SeatInfo`、`SeatUserInfo`),必须查看文档确认字段名(例如确认是 `userInfo.userName` 而不是 `name`)。
115
+
116
+ ### 2. 🧩 Store 与 Listener 管理约束(生命周期安全)
117
+
118
+ **核心原因**:Dart 的 Stream 和闭包监听如果不正确释放,会导致严重的内存泄漏或空指针异常。
119
+
120
+ * **唯一实例原则**:所有 Listener(如 `GuestListener`, `SeatListener`, `BarrageListener`)**必须声明为 State 的成员变量**。
121
+ * **严禁匿名内部类**:禁止直接在 `addListener(Listener(...))` 中写匿名对象,必须先实例化。
122
+ * **成对原则**:在 `initState` 调用 `addListener`,则**必须**在 `dispose` 调用 `removeListener`,防止内存泄漏和监听失效。
123
+
124
+ ### 3. ⏱️ 超时时间限制(关键技术点)
125
+
126
+ **必须严格遵守以下参数限制,优先使用文档示例中的值:**
127
+
128
+ #### A. 观众上麦 (`CoGuestStore`)
129
+
130
+ * **规则**:
131
+ * 可选参数,不填则不检查超时。
132
+ * 若填写,范围必须在 **5 - 1800 秒**之间。
133
+
134
+ * **正确示例**:
135
+ ```dart
136
+ // ✅ 推荐:跟随文档示例(如 30秒)
137
+ guestStore.applyForSeat(seatIndex: -1, timeout: 30, extraInfo: null);
138
+ ```
139
+
140
+ #### B. 房主连线 (`CoHostStore`)
141
+
142
+ * **规则**:
143
+ * **最大值 30 秒**(后台硬限制)。
144
+
145
+ * **正确示例**:
146
+ ```dart
147
+ // ✅ 推荐:使用最大值
148
+ coHostStore.requestHostConnection(..., timeout: 30);
149
+ ```
150
+
151
+ ### 4. 🎨 扩展功能约束(音效/弹幕/礼物/UI)
152
+
153
+ #### A. 音效 (Audio Effect)
154
+
155
+ * **变声枚举 (`AudioChangerType`)**:
156
+ * ✅ **允许**:`AudioChangerType.child`, `AudioChangerType.man` 等标准枚举。
157
+ * ❌ **禁止**:使用整型索引(如 `1`, `2`)。
158
+
159
+ #### B. 麦位 UI 布局
160
+
161
+ * **布局要求**:麦位使用 `GridView` 展示,通常 4x2 或 3x3 布局。
162
+ * **麦位状态**:
163
+ * 空麦位:显示占位图标(如 `+` 号)
164
+ * 有人麦位:显示用户头像 + 昵称
165
+ * 正在说话:头像边框高亮或显示音浪动画
166
+ * 麦位锁定:显示锁定图标
167
+ * **音浪动画**:订阅 `LiveSeatState.speakingUsers` 获取正在说话的用户和音量。
168
+
169
+ #### C. 弹幕与礼物布局 (Barrage & Gift)
170
+
171
+ * **层级要求**:使用 `Stack` 组件。
172
+ * 底层:麦位区域 (全屏)。
173
+ * 顶层:弹幕、礼物、功能按钮 (使用 `Positioned` 定位)。
174
+
175
+ * **键盘适配**:
176
+ * `Scaffold` 属性 `resizeToAvoidBottomInset: false`,防止键盘顶起麦位区域。
177
+ * 输入框位于 `Stack` 顶层,使用 `MediaQuery` 监听键盘高度或使用 `Positioned(bottom: 0)` 配合 `SafeArea`。
178
+
179
+ ##### 弹幕输入框 (Barrage Input)
180
+
181
+ * **位置**:固定在屏幕底部左侧,与功能按钮(礼物、申请上麦等)同行。
182
+ * **样式**:半透明圆角背景 + 占位文字「说点什么...」。
183
+ * **键盘适配**:
184
+ * 键盘弹起时,输入框**保持原位置不变**,禁止随键盘上移。
185
+ * **必须**在 `Scaffold` 设置 `resizeToAvoidBottomInset: false`。
186
+
187
+ ##### 弹幕显示流 (Barrage Display Flow)
188
+
189
+ * **数据源**:使用 `ValueListenableBuilder` 监听 `BarrageStore.create(liveId).barrageState.messageList`。
190
+ * **本地回显**:发送成功后**立即**调用 `appendLocalTip` 插入本地弹幕列表,无需等待服务器回调。
191
+ * **滚动行为**:新消息到达时自动滚动到底部。
192
+
193
+ ##### 全屏礼物动画 (Full-screen Gift Animation)
194
+
195
+ **⚠️ 必须实现**:礼物功能集成时,全屏礼物动画是**强制要求**,不可省略。
196
+
197
+ * **依赖**:必须引入 `svgaplayer_flutter`。
198
+ * **层级**:全屏礼物动画视图必须覆盖在麦位区域**之上**。
199
+ * **双端同步**:收到 `GiftStore.onReceiveGift` 回调后,**房主端和观众端**都必须播放全屏动画。严禁只在观众端播放。
200
+
201
+ ### 🎨 默认 UI/UX 设计与交互规范 (仅在用户未指定时生效)
202
+
203
+ **⚠️ 注意:以下规范仅在用户未提供具体 UI 设计图或需求时作为默认标准执行。**
204
+
205
+ ### 1. 全局视觉风格 (Global Aesthetics)
206
+
207
+ * **沉浸式暗黑**:`Scaffold` 背景必须为 `Colors.black` 或深色渐变。
208
+ * **安全区域**:所有悬浮 UI 必须包裹在 `SafeArea` 中。
209
+ * **文字可读性**:深色背景上的白色文字(如弹幕、ID)必须添加**黑色阴影** (`Shadow`)。
210
+ * **错误提示**:统一使用 `SnackBar` 或 `FlutterToast`,禁止使用模态 Dialog 打断用户。
211
+
212
+ ### 2. 通用组件规范 (Component Standards)
213
+
214
+ * **顶部胶囊 (Glass Capsule)**:
215
+ * **样式**:**半透明黑色背景** + **全圆角**。
216
+ * **应用**:仅用于顶部左侧展示"房主头像+ID+在线人数"。
217
+
218
+ * **通用按钮 (Flat Buttons)**:
219
+ * **样式**:**"文字 + 圆角矩形背景"**。视觉风格扁平简约,背景色为半透明黑或主题色。
220
+ * **关闭按钮**:特例,使用圆形半透明背景图标。
221
+
222
+ ### 3. 语聊房布局蓝图 (Voice Room Layout)
223
+
224
+ **⚠️ 动态布局原则:仅渲染用户实际集成的功能按钮。若用户未请求某功能(如礼物/音效),严禁添加对应的空按钮**
225
+
226
+ #### A. 顶部栏 (Top Bar)
227
+
228
+ * **左侧 [房间信息]**:使用 **半透明胶囊** 包裹 [房主头像 | 房主昵称 | 在线人数]。
229
+ * **右侧 [控制区]**:横向排列 [关闭图标(X)]。
230
+
231
+ #### B. 麦位区域 (Seat Area) - 核心展示区
232
+
233
+ * **布局方式**:使用 `GridView.builder`
234
+ * **典型布局**:
235
+ * 8 麦位:4x2 或 2x4
236
+ * 9 麦位:3x3(房主占中心或首位)
237
+ * **麦位状态展示**:
238
+ * 空麦位:圆形占位 + `+` 号图标
239
+ * 有人麦位:用户头像 + 昵称 + 麦克风状态图标
240
+ * 说话中:头像边框高亮(主题色)+ 音浪动画
241
+ * 锁定麦位:锁定图标覆盖
242
+
243
+ #### C. 底部栏 (Bottom Bar) - 根据角色动态切换
244
+
245
+ * **房主模式 (Host)**:
246
+ * **左侧**:[弹幕列表(背景透明)] + [聊天输入框]。
247
+ * **右侧**:功能阵列 [音效] [更多(管理麦位)]。
248
+
249
+ * **观众模式 (Audience)**:
250
+ * **左侧**:[弹幕列表] + [聊天输入框]。
251
+ * **右侧**:[礼物] [申请上麦]。
252
+
253
+ * **麦上用户模式 (On-Seat Audience)**:
254
+ * **左侧**:[弹幕列表] + [聊天输入框]。
255
+ * **右侧**:[礼物] [音效] [下麦]。
256
+
257
+ ### 4. 首页布局与交互 (Home Interaction)
258
+
259
+ #### A. 首页参考布局
260
+
261
+ ```
262
+ ┌─────────────────────────────┐
263
+ │ AtomicXCore 语聊房 │
264
+ │ │
265
+ │ 房间 ID │
266
+ │ ┌─────────────────────────┐│
267
+ │ │ voice_room_001 ││ ← 输入框 (带左侧 Padding, 半透明背景)
268
+ │ └─────────────────────────┘│
269
+ │ │
270
+ │ 房主开播 │
271
+ │ (点击即以 host001 登录) │
272
+ │ │
273
+ │ 观众进房 │
274
+ │ (点击即以 user001 登录) │
275
+ │ │
276
+ │ [ 📋 房间列表 ] │
277
+ └─────────────────────────────┘
278
+ ```
279
+
280
+ #### B. 隐式登录流程
281
+
282
+ **首页不需要单独的登录按钮**,登录在点击功能按钮时自动完成:
283
+
284
+ * 点击「房主开播」→ 使用 `host001` 登录 → 跳转房主页。
285
+ * 点击「观众进房」→ 使用 `user001` 登录 → 跳转观众页。
286
+ * 点击「房间列表」→ 使用 `user001` 登录 → 跳转列表页。
287
+
288
+ ---
289
+
290
+ ## 🎯 功能实现细节
291
+
292
+ ### 1. 房主开播 (`HostPage`)
293
+
294
+ * **核心**:`LiveListStore` + `LiveSeatStore`
295
+ * **流程**:
296
+ 1. 创建房间:`LiveListStore.createLive()`
297
+ 2. 初始化麦位:`LiveSeatStore.create(liveId)`
298
+ 3. 房主自动上 0 号麦位
299
+ * **销毁**:`dispose` 中必须调用 `endLive()`。
300
+
301
+ ### 2. 观众进房 (`AudiencePage`)
302
+
303
+ * **核心**:`LiveListStore` + `LiveSeatStore`
304
+ * **流程**:
305
+ 1. 加入房间:`LiveListStore.joinLive()`
306
+ 2. 订阅麦位:`LiveSeatStore.create(liveId).liveSeatState.seatList` (ValueListenable)
307
+ * **销毁**:`dispose` 中必须调用 `leaveLive()`。
308
+
309
+ ### 3. 房间列表 (`RoomListPage`)
310
+
311
+ * **核心**:`LiveListStore.fetchLiveList()` + `GridView`/`ListView`
312
+ * **数据**:订阅 `liveState.liveList` (ValueListenable)。
313
+ * **跳转**:点击列表项跳转观众页,传递 `liveID`。
314
+
315
+ ### 4. 上麦与麦位管理交互规范 (`co_guest`)
316
+
317
+ #### A. 观众申请上麦(房主被动接收)
318
+
319
+ * **房主端 UI**:❌ **严禁**在底部工具栏或任何位置显示「上麦申请」列表按钮。
320
+ * **交互逻辑**:当收到观众上麦申请回调(`onApplicationReceived`)时,直接在屏幕中心弹出对话框(`showDialog`):
321
+ * **标题**:上麦申请
322
+ * **内容**:收到观众 [昵称] 的上麦申请,是否接受?
323
+ * **操作**:[拒绝] [接受]
324
+
325
+ #### B. 麦位管理面板(房主点击麦位弹出)
326
+
327
+ * **展现形式**:使用底部浮层面板(`showModalBottomSheet`),禁止使用 Dialog。
328
+ * **功能列表**:
329
+ * 邀请上麦(空麦位)
330
+ * 踢下麦位(有人麦位)
331
+ * 禁言/解禁(有人麦位)
332
+ * 锁定/解锁麦位
333
+
334
+ ---
335
+
336
+ ## 📋 Agent 最终检查清单
337
+
338
+ * [ ] **编译验证**:已执行 `flutter build apk --debug` 且结果为 SUCCESS。
339
+ * [ ] **API 准确性**:未修改 Import,未臆造 API,已核对 `SeatInfo`/`SeatUserInfo` 字段名。
340
+ * [ ] **超时合规**:上麦超时 5-1800s,连线超时 ≤30s。
341
+ * [ ] **扩展合规**:音效枚举正确,弹幕布局覆盖且键盘适配。
342
+ * [ ] **礼物合规**:房主和观众端均实现了全屏礼物动画显示。
343
+ * [ ] **麦位合规**:正确订阅 `seatList` 和 `speakingUsers`,实现音浪动画。
344
+ * [ ] **凭证注入**:已自动注入测试 UserSig。
345
+ * [ ] **依赖完整**:已检查并修复 `pubspec.yaml` 和平台权限配置。
346
+
347
+ ---
348
+
349
+ ## 🚨 安全提醒(代码注释模板)
350
+
351
+ ```dart
352
+ /**
353
+ * ⚠️ 测试凭证说明
354
+ * - 当前 userSig 由开发工具自动生成,有效期 7 天
355
+ * - ❌ 生产环境严禁在客户端生成 userSig
356
+ * - ✅ 正式上线前必须在后端服务生成
357
+ * - 参考: https://cloud.tencent.com/document/product/647/17275
358
+ */
359
+ ```
@@ -0,0 +1,335 @@
1
+ `LiveAudienceStore` 是 `AtomicXCore` 中专门负责管理直播间观众信息的模块。通过 `LiveAudienceStore`,您可以为您的直播应用构建一套完整的观众列表及管理系统。
2
+
3
+ ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182232/5899241bb63f11f0a6c652540044a08e.png)
4
+
5
+
6
+ ## 核心功能
7
+ - **实时观众列表**:获取并展示当前在直播间内的所有观众信息。
8
+
9
+ - **观众人数统计**:实时获取当前直播间的准确观众总数。
10
+
11
+ - **观众动态监听**:通过事件订阅,实时感知观众的加入和离开。
12
+
13
+ - **管理员权限**:主播可以将普通观众设为管理员,或撤销其管理员身份。
14
+
15
+ - **房间管理**:主播或管理员可以将任意普通观众请出(踢出)直播间。
16
+
17
+
18
+ ## 核心概念
19
+
20
+ 在开始集成之前,我们先通过下表了解一下 LiveAudienceStore 相关的几个核心概念:
21
+ <table>
22
+ <tr>
23
+ <td rowspan="1" colSpan="1" >**核心概念**</td>
24
+
25
+ <td rowspan="1" colSpan="1" >**类型**</td>
26
+
27
+ <td rowspan="1" colSpan="1" >**核心职责与描述**</td>
28
+ </tr>
29
+
30
+ <tr>
31
+ <td rowspan="1" colSpan="1" >`LiveUserInfo`</td>
32
+
33
+ <td rowspan="1" colSpan="1" >struct</td>
34
+
35
+ <td rowspan="1" colSpan="1" >代表一个观众(用户)的基础信息模型。它包含了用户的唯一标识 (`userID`)、昵称 (`userName`) 和头像地址 (`avatarURL`)。</td>
36
+ </tr>
37
+
38
+ <tr>
39
+ <td rowspan="1" colSpan="1" >`LiveAudienceState`</td>
40
+
41
+ <td rowspan="1" colSpan="1" >struct</td>
42
+
43
+ <td rowspan="1" colSpan="1" >代表观众模块的当前状态。其核心属性 `audienceList` 是一个 `[LiveUserInfo] `数组,存储了观众列表的快照;`audienceCount` 则代表当前观众总数。</td>
44
+ </tr>
45
+
46
+ <tr>
47
+ <td rowspan="1" colSpan="1" >`LiveAudienceEvent`</td>
48
+
49
+ <td rowspan="1" colSpan="1" >enum</td>
50
+
51
+ <td rowspan="1" colSpan="1" >代表观众动态的实时事件。分为 `.onAudienceJoined`(观众加入) 和 `.onAudienceLeft`(观众离开)两种,用于实现对观众列表的增量更新。</td>
52
+ </tr>
53
+
54
+ <tr>
55
+ <td rowspan="1" colSpan="1" >`LiveAudienceStore`</td>
56
+
57
+ <td rowspan="1" colSpan="1" >class</td>
58
+
59
+ <td rowspan="1" colSpan="1" >这是与观众列表功能交互的核心管理类。通过它,您可以获取观众列表快照、执行管理操作,并通过订阅其 `liveAudienceEventPublisher` 来接收实时动态。</td>
60
+ </tr>
61
+ </table>
62
+
63
+
64
+ ## 实现步骤
65
+
66
+ ### 步骤1:组件集成
67
+
68
+ 请参考 [开始直播](https://write.woa.com/document/192834898445422592) 集成 **AtomicXCore**,完成接入。
69
+
70
+ ### 步骤2:初始化并获取观众列表
71
+
72
+ 获取一个与当前直播间 liveId 绑定的 `LiveAudienceStore` 实例,并主动拉取一次当前的观众列表,用于首次展示。
73
+ ``` swift
74
+ import Foundation
75
+ import AtomicXCore
76
+ import Combine
77
+
78
+ class AudienceManager {
79
+ private let liveId: String
80
+ private let audienceStore: LiveAudienceStore
81
+ private var cancellables = Set<AnyCancellable>()
82
+
83
+ // 对外暴露【全量】观众列表的发布者,方便UI层订阅
84
+ let audienceListPublisher = CurrentValueSubject<[LiveUserInfo], Never>([])
85
+ // 对外暴露观众总数的发布者
86
+ let audienceCountPublisher = PassthroughSubject<UInt, Never>()
87
+
88
+ init(liveId: String) {
89
+ self.liveId = liveId
90
+ // 1. 通过 liveId 获取 LiveAudienceStore 的实例
91
+ self.audienceStore = LiveAudienceStore.create(liveID: liveId)
92
+
93
+ // 2. 订阅状态和事件
94
+ subscribeToAudienceState()
95
+ subscribeToAudienceEvents()
96
+
97
+ // 3. 主动拉取首屏数据
98
+ fetchInitialAudienceList()
99
+ }
100
+
101
+ /// 主动获取一次观众列表快照
102
+ func fetchInitialAudienceList() {
103
+ audienceStore.fetchAudienceList { [weak self] result in
104
+ switch result {
105
+ case .success:
106
+ print("首次拉取观众列表成功")
107
+ // 成功后,数据会通过下面的 state 订阅通道自动更新
108
+ case .failure(let error):
109
+ print("首次拉取观众列表失败: \(error.localizedDescription)")
110
+ }
111
+ }
112
+ }
113
+
114
+ // ... 后续代码
115
+ }
116
+ ```
117
+
118
+ ### 步骤3:监听观众列表状态与实时动态
119
+
120
+ 订阅 `audienceStore` 的 `state` 和 `event`,以接收全量列表快照和实时的观众进出事件,从而驱动 UI 更新。
121
+ ``` swift
122
+ extension AudienceManager {
123
+ /// 订阅 state,用于获取观众总数和列表快照
124
+ private func subscribeToAudienceState() {
125
+ audienceStore.state
126
+ .subscribe()
127
+ .receive(on: DispatchQueue.main)
128
+ .sink { [weak self] state in
129
+ // state.audienceList 是一个全量快照
130
+ self?.audienceListPublisher.send(state.audienceList)
131
+ // state.audienceCount 是实时总数
132
+ self?.audienceCountPublisher.send(state.audienceCount)
133
+ }
134
+ .store(in: &cancellables)
135
+ }
136
+
137
+ /// 订阅 event,用于处理观众的实时进出
138
+ private func subscribeToAudienceEvents() {
139
+ audienceStore.liveAudienceEventPublisher
140
+ .receive(on: DispatchQueue.main)
141
+ .sink { [weak self] event in
142
+ guard let self = self else { return }
143
+
144
+ var currentList = self.audienceListPublisher.value
145
+
146
+ switch event {
147
+ case .onAudienceJoined(let newAudience):
148
+ print("观众 \(newAudience.userName) 加入了直播间")
149
+ // 增量更新:在当前列表末尾添加新观众
150
+ if !currentList.contains(where: { $0.userID == newAudience.userID }) {
151
+ currentList.append(newAudience)
152
+ self.audienceListPublisher.send(currentList)
153
+ }
154
+
155
+ case .onAudienceLeft(let departedAudience):
156
+ print("观众 \(departedAudience.userName) 离开了直播间")
157
+ // 增量更新:从当前列表中移除离开的观众
158
+ currentList.removeAll { $0.userID == departedAudience.userID }
159
+ self.audienceListPublisher.send(currentList)
160
+ }
161
+ }
162
+ .store(in: &cancellables)
163
+ }
164
+ }
165
+ ```
166
+
167
+ ### 步骤4:管理观众(踢人与设置管理员)
168
+
169
+ 作为主播或管理员,对直播间内的观众进行管理操作。
170
+
171
+ #### 4.1 将观众踢出直播间
172
+
173
+ 调用 `kickUserOutOfRoom` 接口可以将指定用户请出直播间。
174
+ ``` swift
175
+ extension AudienceManager {
176
+ func kick(userId: String) {
177
+ audienceStore.kickUserOutOfRoom(userId: userId) { result in
178
+ switch result {
179
+ case .success:
180
+ print("成功将用户 \(userId) 踢出房间")
181
+ // 踢出成功后,您会收到 onAudienceLeft 事件
182
+ case .failure(let error):
183
+ print("踢出用户 \(userId) 失败: \(error.localizedDescription)")
184
+ }
185
+ }
186
+ }
187
+ }
188
+ ```
189
+
190
+ #### 4.2 设置/撤销管理员
191
+
192
+ 通过 `setAdministrator` 和 `revokeAdministrator` 接口可以管理用户的管理员身份。
193
+ ``` swift
194
+ extension AudienceManager {
195
+ /// 将用户设为管理员
196
+ func promoteToAdmin(userId: String) {
197
+ audienceStore.setAdministrator(userId: userId) { result in
198
+ if case .success = result {
199
+ print("成功将用户 \(userId) 设为管理员")
200
+ }
201
+ }
202
+ }
203
+
204
+ /// 撤销用户的管理员身份
205
+ func revokeAdmin(userId: String) {
206
+ audienceStore.revokeAdministrator(userId: userId) { result in
207
+ if case .success = result {
208
+ print("成功撤销用户 \(userId) 的管理员身份")
209
+ }
210
+ }
211
+ }
212
+ }
213
+ ```
214
+
215
+ ## 功能进阶
216
+
217
+ ### 在弹幕区展示观众入场欢迎语
218
+
219
+ 当有新观众进入直播间时,弹幕/聊天区域会在本地自动显示一条欢迎消息,例如:“欢迎 [用户昵称] 进入直播间”。
220
+
221
+ #### 实现方式
222
+
223
+ 我们通过订阅 `LiveAudienceStore` 的观众加入事件(`LiveAudienceEvent.onAudienceJoined`)来获取新观众加入的实时通知。一旦事件触发,我们便提取出新观众的昵称信息,然后立即调用 `BarrageStore` 的本地插入接口 `appendLocalTip`。
224
+ ``` swift
225
+ import Foundation
226
+ import AtomicXCore
227
+ import Combine
228
+
229
+ class LiveRoomManager {
230
+ private let liveId: String
231
+ private let audienceManager: AudienceManager
232
+ private let barrageManager: BarrageManager // 假设您已实现了弹幕文档中的BarrageManager
233
+ private var cancellables = Set<AnyCancellable>()
234
+
235
+ init(liveId: String) {
236
+ self.liveId = liveId
237
+ // 初始化两个核心管理器
238
+ self.audienceManager = AudienceManager(liveId: liveId)
239
+ self.barrageManager = BarrageManager(liveId: liveId)
240
+
241
+ // 设置联动
242
+ setupWelcomeMessageFlow()
243
+ }
244
+
245
+ private func setupWelcomeMessageFlow() {
246
+ // 1. 获取 LiveAudienceStore 的实例
247
+ let audienceStore = LiveAudienceStore.create(liveID: self.liveId)
248
+
249
+ // 2. 获取 BarrageStore 的实例 (得益于内部机制,这会是同一个实例)
250
+ let barrageStore = BarrageStore.create(liveID: self.liveId)
251
+
252
+ // 3. 订阅观众事件
253
+ audienceStore.liveAudienceEventPublisher
254
+ .receive(on: DispatchQueue.main)
255
+ .sink { event in
256
+ // 4. 只处理观众加入事件
257
+ guard case .onAudienceJoined(let newAudience) = event else {
258
+ return
259
+ }
260
+
261
+ // 5. 创建一条本地提示消息
262
+ var welcomeTip = Barrage()
263
+ welcomeTip.messageType = .text
264
+ welcomeTip.textContent = "欢迎 \(newAudience.userName) 进入直播间!"
265
+
266
+ // 6. 调用 BarrageStore 的接口将其插入弹幕列表
267
+ barrageStore.appendLocalTip(message: welcomeTip)
268
+ }
269
+ .store(in: &cancellables)
270
+ }
271
+ }
272
+ ```
273
+
274
+ ## API 文档
275
+
276
+ 关于 [LiveAudienceStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveaudiencestore) 及其相关类的所有公开接口、属性和方法的详细信息,请参阅随 [AtomicXCore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore) 框架的官方 API 文档。本文档使用到的相关 Store 如下:
277
+ <table>
278
+ <tr>
279
+ <td rowspan="1" colSpan="1" >Store/Component</td>
280
+
281
+ <td rowspan="1" colSpan="1" >功能描述</td>
282
+
283
+ <td rowspan="1" colSpan="1" >API 文档</td>
284
+ </tr>
285
+
286
+ <tr>
287
+ <td rowspan="1" colSpan="1" >LiveCoreView</td>
288
+
289
+ <td rowspan="1" colSpan="1" >直播视频流展示与交互的核心视图组件:负责视频流渲染和视图挂件处理,支持主播直播、观众连麦、主播连线等场景。</td>
290
+
291
+ <td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/livecoreview)</td>
292
+ </tr>
293
+
294
+ <tr>
295
+ <td rowspan="1" colSpan="1" >LiveAudienceStore</td>
296
+
297
+ <td rowspan="1" colSpan="1" >观众管理:获取实时观众列表(ID / 名称 / 头像),统计观众数量,监听观众进出事件。</td>
298
+
299
+ <td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveaudiencestore)</td>
300
+ </tr>
301
+
302
+ <tr>
303
+ <td rowspan="1" colSpan="1" >BarrageStore</td>
304
+
305
+ <td rowspan="1" colSpan="1" >弹幕功能:发送文本 / 自定义弹幕,维护弹幕列表,实时监听弹幕状态。</td>
306
+
307
+ <td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore)</td>
308
+ </tr>
309
+ </table>
310
+
311
+
312
+ ## 常见问题
313
+
314
+ ### `LiveAudienceState` 中的在线人数(`audienceCount`)是如何更新的?时机和频率是怎样的?
315
+
316
+ `audienceCount` 的更新并非总是实时的,其机制如下:
317
+ - **主动进出房间**:当用户主动加入或正常退出直播间时,在线人数的变更通知会即时触发。您会很快在 `LiveAudienceState` 中观察到 `audienceCount` 的变化。
318
+
319
+ - **异常掉线**:当用户因网络问题、应用崩溃等原因异常掉线时,系统需要通过心跳机制来判断其真实状态。只有当该用户连续 90 秒没有心跳后,系统才会判定其为离线,并触发人数变更通知。
320
+
321
+ - **更新机制与频率控制:**
322
+
323
+ - 无论是即时触发还是延迟触发,所有的人数变更通知都是以消息的形式在房间内广播的。
324
+
325
+ - 房间内每秒的消息总量有上限,单房间消息频控是**每秒 40 条消息**。
326
+
327
+ - **关键点:**在“弹幕风暴”或礼物刷屏等消息流量极高的场景下,如果房间内的消息速率超过了 40条/秒 的阈值,为了保证核心消息(如弹幕)的送达,**人数变更的消息可能会被频控策略丢弃**。
328
+
329
+
330
+ **这对开发者意味着什么?**
331
+
332
+
333
+ `audienceCount` 是一个非常接近实时的**高精度估算值**,但在极端高并发场景下,它可能存在短暂的延迟或数据丢失。因此,我们建议您将其用于 **UI 展示**,而不应作为计费、统计等需要绝对精准场景的唯一依据。
334
+
335
+