@tencentcloud/sdk-mcp 1.2.9 → 1.3.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 (73) hide show
  1. package/package.json +2 -2
  2. package/resource/doc/chatuikit/faq/common/server.md +54 -0
  3. package/resource/doc/chatuikit/faq/web_sdk/faq.md +60 -0
  4. package/resource/doc/chatuikit/react/integration.md +516 -48
  5. package/resource/doc/chatuikit/react/workflow.md +254 -0
  6. package/resource/doc/chatuikit/uniapp-app/faq.md +0 -0
  7. package/resource/doc/chatuikit/uniapp-app/integration.md +619 -0
  8. package/resource/doc/chatuikit/uniapp-app/workflow.md +576 -0
  9. package/resource/doc/chatuikit/vue/integration.md +511 -129
  10. package/resource/doc/chatuikit/vue/workflow.md +395 -0
  11. package/resource/doc/livekit/vue/components/co-guest-panel.md +5 -5
  12. package/resource/doc/livekit/vue/components/live-view.md +16 -49
  13. package/resource/doc/livekit/vue/{components/live-list.md → live-list-integration.md} +13 -44
  14. package/resource/doc/livekit/vue/live-player-desk-integration.md +293 -0
  15. package/resource/doc/livekit/vue/{components/live-player.md → live-player-h5-integration.md} +118 -110
  16. package/resource/doc/livekit/vue/{components/broadcast.md → live-pusher-integration.md} +77 -82
  17. package/resource/doc/livekit/vue/workflow.md +219 -0
  18. package/resource/doc/trtc/C++/ITRTCCloud.md +4131 -0
  19. package/resource/doc/trtc/C++/ITRTCStatistics.md +326 -0
  20. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +1306 -0
  21. package/resource/doc/trtc/C++/ITXDeviceManager.md +1029 -0
  22. package/resource/doc/trtc/C++/TRTCCloudCallback.md +2743 -0
  23. package/resource/doc/trtc/C++/TRTCTypeDef.md +3703 -0
  24. package/resource/doc/trtc/C++/TXLiteAVCode.md +930 -0
  25. package/resource/doc/trtc/android/TRTCCloud.md +3832 -0
  26. package/resource/doc/trtc/android/TRTCCloudDef.md +3945 -0
  27. package/resource/doc/trtc/android/TRTCCloudListener.md +2480 -0
  28. package/resource/doc/trtc/android/TRTCStatistics.md +296 -0
  29. package/resource/doc/trtc/android/TXAudioEffectManager.md +1344 -0
  30. package/resource/doc/trtc/android/TXBeautyManager.md +980 -0
  31. package/resource/doc/trtc/android/TXDeviceManager.md +441 -0
  32. package/resource/doc/trtc/android/TXLiteAVCode.md +914 -0
  33. package/resource/doc/trtc/iOS/TRTCCloud.md +4256 -0
  34. package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +2580 -0
  35. package/resource/doc/trtc/iOS/TRTCStatistics.md +296 -0
  36. package/resource/doc/trtc/iOS/TXAudioEffectManager.md +1117 -0
  37. package/resource/doc/trtc/iOS/TXBeautyManager.md +986 -0
  38. package/resource/doc/trtc/iOS/TXDeviceManager.md +1025 -0
  39. package/resource/doc/trtc/iOS/TXLiteAVCode.md +929 -0
  40. package/resource/doc/trtc/iOS/TXLiveSDKTypeDef.md +3798 -0
  41. package/tools/chat/get-web-chat-integration.js +31 -14
  42. package/tools/chat/get-web-chat-integration.js.map +1 -1
  43. package/tools/definitions/get_faq_def.js +4 -0
  44. package/tools/definitions/get_faq_def.js.map +1 -1
  45. package/tools/definitions/get_trtc_native_api_def.js +17 -0
  46. package/tools/definitions/get_trtc_native_api_def.js.map +1 -0
  47. package/tools/definitions/get_web_chat_uikit_integration_def.js +18 -11
  48. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
  49. package/tools/definitions/get_web_live_uikit_component_detail_def.js +9 -3
  50. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +1 -1
  51. package/tools/definitions/get_web_live_uikit_integration_def.js +32 -0
  52. package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -0
  53. package/tools/definitions/present_framework_choice_def.js +1 -1
  54. package/tools/definitions/record_result_def.js +1 -1
  55. package/tools/definitions/record_result_def.js.map +1 -1
  56. package/tools/index.js +6 -4
  57. package/tools/index.js.map +1 -1
  58. package/tools/live/get-web-live-uikit-integration.js +52 -0
  59. package/tools/live/get-web-live-uikit-integration.js.map +1 -0
  60. package/tools/trtc/get-trtc-native-api.js +31 -0
  61. package/tools/trtc/get-trtc-native-api.js.map +1 -0
  62. package/utils/generate-structured-result.js +34 -0
  63. package/utils/generate-structured-result.js.map +1 -0
  64. package/utils/handle-component-name.js +0 -8
  65. package/utils/handle-component-name.js.map +1 -1
  66. package/utils/report-cls-client.js +1 -1
  67. package/utils/report-es-client.js +1 -1
  68. package/resource/doc/chatuikit/react/chat_window_integration.md +0 -83
  69. package/resource/doc/chatuikit/vue/chat_window_integration.md +0 -131
  70. package/tools/chat/get-web-chat-window-integration.js +0 -28
  71. package/tools/chat/get-web-chat-window-integration.js.map +0 -1
  72. package/tools/definitions/get_web_chat_window_integration_def.js +0 -26
  73. package/tools/definitions/get_web_chat_window_integration_def.js.map +0 -1
@@ -0,0 +1,395 @@
1
+ # Vue Chat TUIKit 代码生成工作流指令
2
+
3
+ ## 📋 指令目的
4
+
5
+ 为 Agent 提供实现 Vue Chat TUIKit **核心功能的代码生成蓝图**,并指导 Agent **优先使用工具实时获取的最新文档内容**,专门针对 Vue3 Web 应用场景。
6
+
7
+ ---
8
+
9
+ ## 🛑 Agent 执行硬性限制 (Guardrails)
10
+
11
+ Agent 在生成代码时必须严格遵守以下指令:
12
+
13
+ ### 1. 文档驱动集成
14
+ - 必须严格按照工具返回结果中的 `llm_code_generation_instructions_md` 步骤执行
15
+ - **必须严格按照集成文档中的示例代码生成代码**,不得擅自修改代码结构和实现方式
16
+ - 代码生成时应完全遵循集成文档提供的最佳实践和示例,确保代码的正确性和可运行性
17
+
18
+ ### 2. CSS 样式强制规范 🔴
19
+ - **必须严格按照集成文档中的完整 CSS 样式代码生成**,包括:
20
+ - 官方 CSS 类名(如 `.chat-layout`、`.chat-content-panel` 等)
21
+ - 官方 CSS 变量定义(如 `--bg-color-operate`、`--stroke-color-primary` 等)
22
+ - 官方布局结构和样式属性
23
+ - 官方 `#app` 样式配置
24
+ - **禁止创建任何自定义样式类名或修改官方样式**
25
+ - 所有样式代码必须从集成文档中完整复制,不得修改
26
+
27
+ ### 3. 静默执行集成 🔥
28
+ **CRITICAL**: 所有代码编写完成后,必须在最后一步自动安装依赖并启动项目,无需等待用户确认。
29
+
30
+ **强制执行要求**:
31
+ - **禁止询问**: 不得询问用户是否需要启动项目
32
+ - **禁止等待**: 不得等待用户手动执行启动命令
33
+ - **必须自动**: 代码完成后必须立即执行集成步骤
34
+ - **批量执行**: 安装依赖和启动命令必须在同一个 execute_command 调用中完成
35
+
36
+ **标准执行命令**:
37
+ ```bash
38
+ cd [项目路径] && npm install && npm run dev
39
+ ```
40
+
41
+ ### 4. 零外部配置
42
+ - 禁止自动创建任何 `config.js` 或 `.env` 文件
43
+ - SDKAppID、UserID 和 UserSig 等关键凭证必须直接注入到代码变量中
44
+
45
+ ### 5. 自动获取鉴权凭据
46
+ - 必须调用 `get_usersig` 工具获取测试凭证,禁止要求用户手动输入
47
+ - UserID 生成应保持简洁(禁止拼接动态时间戳以防逻辑出错)
48
+
49
+ ### 6. 默认激活会话
50
+ - 集成逻辑必须包含 `setActiveConversation` 调用
51
+ - 默认打开 `C2Cadministrator` 会话
52
+
53
+ ### 7. Vue3 组合式 API
54
+ - 优先使用 `<script setup>` 语法
55
+ - 使用 Vue3 Composition API(ref、reactive、computed 等)
56
+ - 正确引入和使用 TUIKit 组件
57
+
58
+ ### 8. chat-only 模式功能限制(⚠️ 默认约束 + 用户主动要求时的例外)
59
+
60
+ **默认行为**:
61
+ 当用户选择 chat-only 模式时,Agent **默认排除**以下扩展功能:
62
+ - **默认不集成 Sidebar**(侧边栏)
63
+ - **默认不集成 ChatSetting**(聊天设置)
64
+ - **默认不集成会话内搜索功能**
65
+ - **默认不集成 ConversationList**(会话列表)
66
+ - **默认仅保留核心聊天组件**:`Chat`、`MessageList`、`ChatHeader`、`MessageInput`
67
+
68
+ **例外处理**:
69
+ 如果用户**明确要求**添加某些扩展功能(如"需要 ChatSetting"、"要集成搜索"等),Agent **应该允许并执行**:
70
+ - ✅ 在核心聊天组件基础上,额外集成用户明确要求的功能
71
+ - ✅ 只添加用户明确要求的功能,不擅自扩展其他功能
72
+ - ✅ 按照集成文档的规范正确集成所需组件
73
+
74
+ **判断标准**:
75
+ - 用户需求中包含明确的功能关键词(如"ChatSetting"、"搜索"、"设置"、"侧边栏"等)
76
+ - 用户明确说明需要某个扩展功能
77
+
78
+ ---
79
+
80
+ ## 📦 TUIKit 版本与依赖自动化
81
+
82
+ Agent 生成代码后,必须自动执行以下依赖链:
83
+
84
+ ### 1. 核心依赖版本推荐
85
+
86
+ ```json
87
+ {
88
+ "@tencentcloud/chat-uikit-vue3": "latest",
89
+ "@tencentcloud/call-uikit-vue": "latest"
90
+ }
91
+ ```
92
+
93
+ ### 2. 构建环境补丁 (Vite/esbuild)
94
+
95
+ 若检测到 Vite 项目,Agent 必须在 `package.json` 自动增加补丁配置以兼容 esbuild-wasm:
96
+
97
+ ```json
98
+ {
99
+ "overrides": {
100
+ "esbuild": "npm:esbuild-wasm@latest"
101
+ },
102
+ "resolutions": {
103
+ "esbuild": "npm:esbuild-wasm@latest"
104
+ }
105
+ }
106
+ ```
107
+
108
+ ---
109
+
110
+ ## 📦 Vue3 TUIKit 组件说明
111
+
112
+ Agent 在生成代码时,必须了解并正确使用以下 Vue3 组件:
113
+
114
+ | 组件名称 | 说明 | 使用场景 |
115
+ |---------|------|---------|
116
+ | `ConversationList` | 会话列表组件 | full-featured 模式,显示所有会话 |
117
+ | `Chat` | 会话的容器组件 | 所有模式,聊天主容器 |
118
+ | `MessageList` | 会话的消息列表组件 | 显示聊天消息记录 |
119
+ | `ChatHeader` | 会话的头部信息组件 | 显示会话标题、成员信息等 |
120
+ | `MessageInput` | 输入框组件 | 消息输入和发送 |
121
+ | `ChatSetting` | 单聊和群聊的管理组件 | 会话设置、群管理等 |
122
+ | `Search` | 云端搜索组件 | 搜索消息、联系人等 |
123
+ | `ContactList` | 联系人组件 | full-featured 模式,通讯录功能 |
124
+
125
+ **重要提示**:
126
+ - Agent 必须严格按照集成文档中的组件名称和用法生成代码
127
+ - 不要自行创造或修改组件名称
128
+ - 组件的具体使用方式以工具返回的集成文档为准
129
+
130
+ ---
131
+
132
+ ## 🛠️ 集成模式分发 (Goals)
133
+
134
+ 根据用户的需求,Agent 必须选择对应的执行路径:
135
+
136
+ ### 1. 全量功能集成 (full-featured)
137
+
138
+ **目标**: 实现类似微信的完整 IM 应用
139
+
140
+ **核心组件**:
141
+ - `ConversationList` (会话列表)
142
+ - `Chat` (聊天容器)
143
+ - `ContactList` (通讯录)
144
+ - `Search` (云端搜索)
145
+
146
+ **执行参考**:
147
+ - 参考工具返回结果中实时获取的 `integration.md` 指令
148
+
149
+ **适用场景**:
150
+ - 构建独立的聊天应用
151
+ - 需要完整的会话管理、通讯录、群组管理功能
152
+ - 作为 Web 应用的核心功能模块
153
+
154
+ ---
155
+
156
+ ### 2. 仅集成聊天窗口 (chat-only)
157
+
158
+ **目标**: 适用于客服、问诊、详情页私聊等纯对话场景
159
+
160
+ **核心组件**:
161
+ - `Chat` (聊天容器)
162
+ - `MessageList` (消息列表)
163
+ - `ChatHeader` (聊天头部)
164
+ - `MessageInput` (输入框)
165
+
166
+ **执行参考**:
167
+ - 参考工具返回结果中实时获取的 `integration.md` 指令
168
+
169
+ **适用场景**:
170
+ - 客服咨询场景(用户点击咨询按钮进入聊天页面)
171
+ - 医疗在线问诊(患者与医生一对一沟通)
172
+ - 订单详情页私聊(买家与卖家沟通)
173
+ - 社交应用中的私信功能
174
+
175
+ **🔴 默认排除功能(Agent 必须遵守)**:
176
+
177
+ Agent 在生成 chat-only 模式代码时,**默认排除**以下功能和组件:
178
+
179
+ 1. **默认不集成 Sidebar(侧边栏)**
180
+ - 默认不生成任何侧边栏相关代码
181
+ - 默认不引入会话列表、通讯录等侧边栏组件
182
+ - 聊天窗口默认应该是独立的、无侧边栏的纯聊天界面
183
+
184
+ 2. **默认不集成 ChatSetting(聊天设置)**
185
+ - 默认不生成会话设置、群管理等功能
186
+ - 默认不在 ChatHeader 右侧添加设置按钮
187
+ - 默认不引入 ChatSetting 组件
188
+
189
+ 3. **默认不集成会话内搜索功能**
190
+ - 默认不添加消息搜索功能
191
+ - 默认不在聊天界面添加搜索入口
192
+ - 默认不引入 Search 组件
193
+
194
+ 4. **默认不集成会话列表(ConversationList)**
195
+ - chat-only 模式下,用户通过外部路由/参数指定会话 ID
196
+ - 默认不需要会话切换功能
197
+
198
+ ---
199
+
200
+ **⚠️ 用户主动要求时的例外处理**:
201
+
202
+ 如果用户在 chat-only 模式下**明确要求**添加某些扩展功能,Agent **应该允许并执行**:
203
+
204
+ **触发条件**(满足任一即可):
205
+ - 用户明确说明:"需要 ChatSetting"、"要集成聊天设置"、"添加会话设置功能"
206
+ - 用户明确说明:"需要 Search"、"要添加搜索功能"、"集成会话内搜索"
207
+ - 用户明确说明:"需要 Sidebar"、"要添加侧边栏"
208
+ - 用户明确提出其他扩展功能需求
209
+
210
+ **Agent 执行流程**:
211
+ 1. ✅ **确认用户需求**:识别到用户主动要求添加扩展功能
212
+ 2. ✅ **允许集成**:在 chat-only 模式基础上,额外集成用户要求的组件
213
+ 3. ✅ **保持克制**:只添加用户明确要求的功能,不擅自扩展其他功能
214
+ 4. ✅ **遵循文档**:按照集成文档的规范正确集成所需组件
215
+
216
+ ---
217
+
218
+ ## 📞 扩展功能:音视频通话 (TUICallKit)
219
+
220
+ 若需求中包含"通话"或"视频"功能,Agent 必须执行:
221
+
222
+ ### 组件挂载
223
+ - 使用 `Teleport` 将 TUICallKit 组件挂载到 body
224
+
225
+ ### 交互注入
226
+
227
+ **在 ChatHeader 组件的右侧插槽注入通话按钮**:
228
+ - 图标: 电话、摄像机等
229
+ - 组件使用方式参考集成文档
230
+
231
+ **单聊逻辑**:
232
+ - 通过 `TUICallKitServer.call` 发起通话
233
+ - UserID 自动取自当前激活会话
234
+
235
+ **群聊逻辑**:
236
+ - 需集成成员选择组件
237
+ - 引导用户选择群成员后再发起通话
238
+
239
+ ---
240
+
241
+ ## ✍️ Agent 代码生成示例指令 (Prompts)
242
+
243
+ 当 Agent 开始编写代码时,应遵循以下语义逻辑:
244
+
245
+ **全量功能集成 (full-featured)**:
246
+ > "按照 `full-featured` 模式,为我生成一个 Vue3 TUIKit 集成页面。请自动配置 `C2Cadministrator` 默认激活会话,并注入由 `get_usersig` 工具获取的凭据。禁止创建 config 文件。**🔴 重要:必须严格按照集成文档中的完整 CSS 样式代码生成,禁止任何自定义或修改。**"
247
+
248
+ **仅聊天窗口集成 (chat-only)**:
249
+ > "按照 `chat-only` 模式,为我生成一个 Vue3 TUIKit 聊天窗口。请自动配置 `C2Cadministrator` 默认激活会话,并注入由 `get_usersig` 工具获取的凭据。禁止创建 config 文件。**严格排除 Sidebar、ChatSetting、会话内搜索等功能,仅保留核心聊天组件。🔴 重要:必须严格按照集成文档中的完整 CSS 样式代码生成,禁止任何自定义样式。**"
250
+
251
+ ---
252
+
253
+ ## 📝 关键要点总结
254
+
255
+ | 类别 | 要求 |
256
+ |------|------|
257
+ | **框架版本** | 专门针对 Vue3 项目 |
258
+ | **文档优先** | 严格遵循工具返回的最新文档指令 |
259
+ | **🔴 CSS 样式** | **严格按照集成文档 CSS,禁止任何自定义或修改** |
260
+ | **静默集成** | 代码编写完成后自动安装依赖并启动开发服务器 |
261
+ | **凭证注入** | 自动调用 `get_usersig`,直接注入代码 |
262
+ | **默认会话** | 自动激活 `C2Cadministrator` 会话 |
263
+ | **依赖管理** | 自动检测并安装所需依赖包 |
264
+ | **构建工具** | Vite 项目需添加 esbuild-wasm 补丁配置 |
265
+ | **集成模式** | 支持 full-featured(全量)和 chat-only(仅聊天)两种模式 |
266
+ | **chat-only 限制** | ⚠️ 默认排除 Sidebar、ChatSetting、搜索功能;用户主动要求时允许集成 |
267
+
268
+ ---
269
+
270
+ ## 🎯 Agent 执行检查清单
271
+
272
+ 在完成代码生成后,Agent 必须确认以下所有项目:
273
+
274
+ ### 项目初始化
275
+ - [ ] 已创建 Vue3 项目或在现有项目中集成
276
+ - [ ] 已安装 `@tencentcloud/chat-uikit-vue3` 依赖
277
+ - [ ] 如果需要音视频通话,已安装 `@tencentcloud/call-uikit-vue`
278
+ - [ ] 如果是 Vite 项目,已添加 esbuild-wasm 补丁配置
279
+
280
+ ### 代码生成
281
+ - [ ] 已在 main.js 中正确注册 TUIKit 组件
282
+ - [ ] 已创建主聊天容器组件(ChatContainer.vue 或类似)
283
+ - [ ] 组件使用了 `<script setup>` 语法
284
+ - [ ] 🔴 **CSS 样式严格合规**:
285
+ - [ ] 已从集成文档中完整获取所有 CSS 样式代码
286
+ - [ ] 已使用集成文档中的官方类名
287
+ - [ ] 已完整复制集成文档中的 CSS 变量定义
288
+ - [ ] 已使用集成文档中的布局样式配置
289
+ - [ ] 禁止创建任何自定义样式类名
290
+ - [ ] 禁止修改集成文档中的任何样式属性
291
+ - [ ] 样式代码与集成文档完全一致
292
+
293
+ ### 凭证与登录
294
+ - [ ] 🔴 已调用 `get_usersig` 工具获取测试凭证
295
+ - [ ] 已将 SDKAppID、UserID、UserSig 直接注入到代码中
296
+ - [ ] 禁止创建 config.js 或 .env 文件
297
+ - [ ] 已实现 TUILogin.login() 登录逻辑
298
+
299
+ ### 会话激活
300
+ - [ ] 已添加默认激活 `C2Cadministrator` 会话的逻辑
301
+ - [ ] 使用了正确的 API(setActiveConversation)
302
+
303
+ ### 集成模式
304
+ - [ ] 已根据用户需求选择正确的集成模式(full-featured 或 chat-only)
305
+ - [ ] full-featured 模式:已集成 ConversationList、Chat、Contact 等组件
306
+ - [ ] chat-only 模式:已集成核心组件(Chat、MessageList、ChatHeader、MessageInput)
307
+ - [ ] chat-only 模式:已根据用户需求判断是否需要集成扩展功能
308
+ - [ ] 如果用户未主动要求,已确认不包含 Sidebar、ChatSetting、Search 等组件
309
+ - [ ] 如果用户主动要求(如"需要 ChatSetting"),已额外集成用户明确要求的功能
310
+
311
+ ### 音视频通话(可选)
312
+ - [ ] 如果需要通话功能,已使用 Teleport 挂载 TUICallKit
313
+ - [ ] 已在 ChatHeader 组件右侧插槽添加通话按钮
314
+ - [ ] 已实现单聊和群聊的通话逻辑
315
+
316
+ ### 最终检查
317
+ - [ ] 已调用 `record_result` 记录集成结果
318
+ - [ ] 已自动安装依赖(npm install)
319
+ - [ ] 已自动启动开发服务器(npm run dev)
320
+ - [ ] 项目可以正常运行,无报错
321
+
322
+ ---
323
+
324
+ ## 💡 常见问题处理
325
+
326
+ ### 1. Vite 构建错误
327
+
328
+ **问题现象**:Vite 项目运行时报 esbuild 相关错误
329
+
330
+ **原因**:某些依赖包与 esbuild 不兼容
331
+
332
+ **解决方案**:
333
+ 在 `package.json` 中添加补丁配置:
334
+ ```json
335
+ {
336
+ "overrides": {
337
+ "esbuild": "npm:esbuild-wasm@latest"
338
+ },
339
+ "resolutions": {
340
+ "esbuild": "npm:esbuild-wasm@latest"
341
+ }
342
+ }
343
+ ```
344
+
345
+ ### 2. chat-only 模式包含了不该有的功能
346
+
347
+ **问题现象**:chat-only 模式生成的代码包含了用户未要求的 Sidebar、ChatSetting 或会话内搜索功能
348
+
349
+ **原因**:Agent 未正确判断用户需求,擅自添加了扩展功能
350
+
351
+ **判断标准**:
352
+ - ✅ **应该添加**:用户明确说明"需要 ChatSetting"、"要集成搜索"、"添加设置功能"等
353
+ - ❌ **不应添加**:用户只说"搭建 chat-only 聊天窗口",未提及扩展功能
354
+
355
+ **解决方案**:重新生成代码,确保默认不包含扩展功能
356
+
357
+ ### 3. CSS 样式不符合集成文档
358
+
359
+ **问题现象**:生成的代码使用了自定义样式类名,或修改了官方样式
360
+
361
+ **原因**:Agent 未严格按照集成文档中的 CSS 样式生成代码
362
+
363
+ **解决方案**:
364
+ 1. 重新调用 `get_web_chat_uikit_integration` 获取最新集成文档
365
+ 2. 从集成文档中完整复制所有 CSS 样式代码
366
+ 3. 严格按照集成文档中的类名、变量名、样式属性使用
367
+ 4. 禁止任何形式的修改或自定义
368
+
369
+ ---
370
+
371
+ ## 🔗 相关工具参考
372
+
373
+ ### 必须使用的工具
374
+
375
+ #### `get_usersig` - 获取完整测试凭证(强制调用)
376
+ **用途**:生成完整的测试账号和鉴权凭证,包括:
377
+ - `SDKAppID`: 应用标识
378
+ - `userID`: 测试用户 ID
379
+ - `userSig`: 用户签名(有效期 7 天)
380
+
381
+ **调用时机**:在生成登录代码之前必须调用
382
+
383
+ **使用约束**:
384
+ - ✅ 必须使用工具返回的完整凭证
385
+ - ❌ 禁止让用户手动填写 SDKAppID 和 secretKey
386
+ - ❌ 禁止创建配置文件存储凭证
387
+
388
+ #### `record_result` - 记录集成结果
389
+ **用途**:记录集成过程和结果,用于统计和分析
390
+
391
+ ---
392
+
393
+ **适用框架**: Vue3
394
+ **TUIKit 版本**: @tencentcloud/chat-uikit-vue3 > 4.0.0
395
+ **构建工具**: Vite (推荐) / Webpack
@@ -1,4 +1,4 @@
1
- 本文对 TUILiveKit 组件中的**连麦管理面板(CoGuestPanel)**进行了详细的介绍,您可以在已有项目中直接参考本文示例集成我们开发好的组件,也可以根据您的需求按照文档中的组件定制化部分对样式和布局进行深度的定制。
1
+ 本文对**连麦管理面板(CoGuestPanel)**进行了详细的介绍,您可以在已有项目中直接参考本文示例集成我们开发好的组件,也可以根据您的需求按照文档中的组件定制化部分对样式和布局进行深度的定制。
2
2
 
3
3
  ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/af6ace34975411f093df52540099c741.png)
4
4
 
@@ -35,7 +35,7 @@
35
35
 
36
36
  ### 步骤1:环境配置及开通服务
37
37
 
38
- 在进行快速接入之前,您需要参考[准备工作](https://write.woa.com/document/185222107981008896),满足相关环境配置及开通对应服务。
38
+ 在进行快速接入之前,您需要参考 [准备工作](https://write.woa.com/document/188228825253294080),满足相关环境配置及开通对应服务。
39
39
 
40
40
  ### 步骤2:安装依赖
41
41
 
@@ -44,19 +44,19 @@
44
44
 
45
45
  【npm】
46
46
  ``` bash
47
- npm install tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3 --save
47
+ npm install tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 --save
48
48
  ```
49
49
 
50
50
 
51
51
  【pnpm】
52
52
  ``` bash
53
- pnpm add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
53
+ pnpm add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
54
54
  ```
55
55
 
56
56
 
57
57
  【yarn】
58
58
  ``` bash
59
- yarn add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
59
+ yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
60
60
  ```
61
61
 
62
62
  ### 步骤3:集成连麦管理面板
@@ -1,4 +1,4 @@
1
- 本文对 TUILiveKit 组件中的 **直播视频组件(LiveView)** 进行了详细的介绍,您可以在已有项目中直接参考本文示例集成我们开发好的组件,也可以根据您的需求按照文档中的组件定制化部分对样式,布局进行深度的定制。
1
+ 本文对**直播视频组件(LiveView)**进行了详细的介绍,您可以在已有项目中直接参考本文示例集成我们开发好的组件,也可以根据您的需求按照文档中的组件定制化部分对样式,布局进行深度的定制。
2
2
 
3
3
  ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/1b766277b00211f09e195254007c27c5.png)
4
4
 
@@ -38,19 +38,19 @@
38
38
 
39
39
  【npm】
40
40
  ``` bash
41
- npm install tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3 --save
41
+ npm install tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 --save
42
42
  ```
43
43
 
44
44
 
45
45
  【pnpm】
46
46
  ``` bash
47
- pnpm add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
47
+ pnpm add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
48
48
  ```
49
49
 
50
50
 
51
51
  【yarn】
52
52
  ``` bash
53
- yarn add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
53
+ yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
54
54
  ```
55
55
 
56
56
  ### 步骤3:加入直播间并进行连麦
@@ -113,21 +113,21 @@ LiveView 提供了灵活的组件自定义插槽,该插槽支持您根据自
113
113
  </tr>
114
114
 
115
115
  <tr>
116
- <td rowspan="1" colSpan="1" >seatViewUI</td>
116
+ <td rowspan="1" colSpan="1" >streamViewUI</td>
117
117
 
118
- <td rowspan="1" colSpan="1" >seatInfo: SeatInfo</td>
118
+ <td rowspan="1" colSpan="1" >userInfo</td>
119
119
 
120
120
  <td rowspan="1" colSpan="1" >自定义麦位的显示 UI</td>
121
121
  </tr>
122
122
  </table>
123
123
 
124
- ``` typescript
125
- // seatViewUI 插槽使用示例
124
+ ``` java
125
+ // streamViewUI 插槽使用示例
126
126
  <LiveView>
127
127
  <CustomStreamViewUI #streamViewUI></CustomStreamViewUI>
128
128
  </LiveView>
129
129
  ```
130
- 1. `SeatInfo` 定义了直播房间中每个麦位的基本信息和状态:
130
+ 1. `userInfo` 定义了直播房间中每个麦位的基本信息和状态:
131
131
 
132
132
  <table>
133
133
  <tr>
@@ -140,56 +140,23 @@ LiveView 提供了灵活的组件自定义插槽,该插槽支持您根据自
140
140
  <td rowspan="1" colSpan="1" >说明</td>
141
141
  </tr>
142
142
 
143
- <tr>
144
- <td rowspan="1" colSpan="1" >index</td>
145
-
146
- <td rowspan="1" colSpan="1" >number</td>
147
-
148
- <td rowspan="1" colSpan="1" >必填</td>
149
-
150
- <td rowspan="1" colSpan="1" >麦位的索引号,从0开始递增,用于标识麦位在房间中的位置。</td>
151
- </tr>
152
-
153
- <tr>
154
- <td rowspan="1" colSpan="1" >isLocked</td>
155
-
156
- <td rowspan="1" colSpan="1" >boolean</td>
157
-
158
- <td rowspan="1" colSpan="1" >必填</td>
159
-
160
- <td rowspan="1" colSpan="1" >麦位锁定状态,true 表示麦位被锁定,其他用户无法进入;false 表示麦位开放。</td>
161
- </tr>
162
-
163
143
  <tr>
164
144
  <td rowspan="1" colSpan="1" >userInfo</td>
165
145
 
166
- <td rowspan="1" colSpan="1" >SeatUserInfo</td>
146
+ <td rowspan="1" colSpan="1" >userInfo</td>
167
147
 
168
148
  <td rowspan="1" colSpan="1" >非必填</td>
169
149
 
170
150
  <td rowspan="1" colSpan="1" >当前坐在该麦位上的用户信息,如果麦位为空则为 `undefined`。</td>
171
151
  </tr>
172
-
173
- <tr>
174
- <td rowspan="1" colSpan="1" >region</td>
175
-
176
- <td rowspan="1" colSpan="1" >RegionInfo</td>
177
-
178
- <td rowspan="1" colSpan="1" >非必填</td>
179
-
180
- <td rowspan="1" colSpan="1" >麦位在视频画布中的显示区域信息,用于多路视频布局。</td>
181
- </tr>
182
152
  </table>
183
153
 
184
154
  ``` typescript
185
- interface SeatInfo {
186
- index: number; // 麦位索引
187
- isLocked: boolean; // 麦位是否被锁定
188
- userInfo?: SeatUserInfo; // 麦位上的用户信息(可选)
189
- region?: RegionInfo; // 麦位在画布中的区域信息(可选)
155
+ interface userInfo {
156
+ userInfo: userInfo; // 麦位上的用户信息
190
157
  }
191
158
  ```
192
- 2. `SeatUserInfo` 定义了直播房间中每个麦位上的用户详细信息:
159
+ 2. `userInfo` 定义了直播房间中每个麦位上的用户详细信息:
193
160
 
194
161
  <table>
195
162
  <tr>
@@ -382,11 +349,11 @@ LiveView 提供了灵活的组件自定义插槽,该插槽支持您根据自
382
349
 
383
350
  #### 自定义插槽示例
384
351
 
385
- 为了更好地让您体验及理解 LiveView 组件的 seatViewUI 插槽定制化能力,我们提供了**直播连麦场景**示例供您参考,您可以参考上述**步骤3**将如下代码增量复制至您的项目中实现类似场景的效果。
352
+ 为了更好地让您体验及理解 LiveView 组件的 streamViewUI 插槽定制化能力,我们提供了**直播连麦场景**示例供您参考,您可以参考上述**步骤3**将如下代码增量复制至您的项目中实现类似场景的效果。
386
353
  ``` typescript
387
354
  <template>
388
355
  <LiveView>
389
- <template #seatViewUI="{ userInfo }">
356
+ <template #streamViewUI="{ userInfo }">
390
357
  <div
391
358
  class="live-stream-view"
392
359
  :class="{ 'is-anchor': isAnchor(userInfo), 'is-guest': !isAnchor(userInfo) }"
@@ -424,4 +391,4 @@ const isAnchor = (userInfo: SeatUserInfo) => {
424
391
  </script>
425
392
 
426
393
  <style scoped>.live-stream-view{position:relative;width:100%;height:100%;border-radius:8px;overflow:hidden}.live-stream-view.is-anchor{border:3px solid #ff6b35;box-shadow:0 0 20px rgba(255,107,53,.3)}.live-stream-view.is-guest{border:1px solid #ddd}.video-area{width:100%;height:100%;background:#000}.user-overlay{position:absolute;bottom:0;left:0;right:0;background:linear-gradient(transparent,rgba(0,0,0,.8));padding:10px;color:#fff}.user-badge{display:inline-block;padding:2px 8px;border-radius:10px;font-size:12px;margin-bottom:5px;background:#666}.anchor-badge{background:#ff6b35;color:#fff}.user-name{font-weight:700;margin-bottom:5px}.device-status span{margin-right:5px;opacity:.8}.device-status .camera.Off,.device-status .mic.Off{opacity:.3}</style>
427
- ```
394
+ ```
@@ -1,16 +1,21 @@
1
1
  ## 概述
2
- 本文对 TUILiveKit 组件中的**直播列表页面**进行了详细的介绍,您可以在已有项目中直接参考本文档集成我们开发好的直播列表页面,也可以根据您的需求按照文档中的内容对页面的样式,布局以及功能项进行深度的定制。
2
+
3
+ 本文对 TUILiveKit Demo 中的**直播列表页面**进行了详细的介绍,您可以在已有项目中直接参考本文档集成我们开发好的直播列表页面,也可以根据您的需求按照文档中的内容对页面的样式,布局以及功能项进行深度的定制。
3
4
 
4
5
  ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027862798/f73d96db8c8611f0ae9d5254001c06ec.png)
5
6
 
6
7
 
8
+ ## 快速体验
9
+
10
+ 您可以在 [在线体验](https://write.woa.com/document/193874503063744512) 中使用 [在线开播网站](https://web.sdk.qcloud.com/trtc/livekit/pusher/index.html) 快速开启一场直播,同时您也可以使用 [在线观看网站](https://web.sdk.qcloud.com/trtc/livekit/player/index.html) 来查看账户下直播列表。
11
+
7
12
  ## 快速接入
8
13
 
9
14
  ### 步骤1:环境配置及开通服务
10
15
 
11
16
  在进行快速接入之前,您需要参见 [准备工作](https://write.woa.com/document/188228825253294080),满足相关环境配置及开通对应服务。
12
17
 
13
- ### 步骤2: 安装依赖
18
+ ### 步骤2:安装依赖
14
19
 
15
20
  您可以选择以下任一方式安装依赖:
16
21
 
@@ -19,25 +24,25 @@
19
24
 
20
25
  【npm】
21
26
  ``` bash
22
- npm install tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3 --save
27
+ npm install tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 --save
23
28
  ```
24
29
 
25
30
 
26
31
  【pnpm】
27
32
  ``` bash
28
- pnpm add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
33
+ pnpm add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
29
34
  ```
30
35
 
31
36
 
32
37
  【yarn】
33
38
  ``` bash
34
- yarn add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
39
+ yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
35
40
  ```
36
41
 
37
42
  ### 步骤3: 直播列表页面接入
38
43
 
39
44
  在您的项目下创建 **live-list.vue **文件,可直接复制如下代码至您的项目中集成**直播列表页面**。
40
- ``` vue
45
+ ``` javascript
41
46
  <template>
42
47
  <UIKitProvider language="zh-CN">
43
48
  <div class="container">
@@ -81,7 +86,7 @@ onMounted(async () => {
81
86
  > **注意:**
82
87
  >
83
88
 
84
- > 若您需要实现直播列表到进入直播间的跳转逻辑,可参考本文中[指定直播间](https://write.woa.com/#61f1bbc9-1f23-4b69-aceb-7ab3f35a0ec2)部分内容。
89
+ > 若您需要实现直播列表到进入直播间的跳转逻辑,可参考本文中 [指定直播间](https://write.woa.com/#61f1bbc9-1f23-4b69-aceb-7ab3f35a0ec2) 部分内容。
85
90
  >
86
91
 
87
92
 
@@ -94,7 +99,7 @@ npm run dev
94
99
 
95
100
  ## 自由定制
96
101
 
97
- 根据上述功能展示图,我们也支持您根据项目需求对直播列表页面进行 UI 定制能力。主要可供定制的能力如下表所示。
102
+ 根据上述功能展示图,我们也支持您根据项目需求对直播列表页面进行 UI 定制。主要可供定制的能力如下表所示。
98
103
  <table>
99
104
  <tr>
100
105
  <td rowspan="1" colSpan="1" >**类别**</td>
@@ -188,39 +193,3 @@ app.mount('#app');
188
193
  ### 更多资源
189
194
 
190
195
  [腾讯云实时音视频控制台](https://console.cloud.tencent.com/trtc)
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
-
213
-
214
-
215
-
216
-
217
-
218
- ####
219
-
220
- ####
221
-
222
- ####
223
-
224
- ####
225
-
226
- ####