@tencent-rtc/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 (68) hide show
  1. package/package.json +2 -2
  2. package/resource/doc/chatuikit/faq/common/server.md +44 -0
  3. package/resource/doc/chatuikit/faq/web_sdk/faq.md +57 -0
  4. package/resource/doc/chatuikit/react/integration.md +430 -49
  5. package/resource/doc/chatuikit/react/workflow.md +258 -0
  6. package/resource/doc/chatuikit/vue/integration.md +355 -144
  7. package/resource/doc/chatuikit/vue/workflow.md +395 -0
  8. package/resource/doc/livekit/vue/components/co-guest-panel.md +3 -3
  9. package/resource/doc/livekit/vue/components/live-view.md +4 -4
  10. package/resource/doc/livekit/vue/{components/live-list.md → live-list-integration.md} +7 -7
  11. package/resource/doc/livekit/vue/{components/live-player.md → live-player-desk-integration.md} +8 -8
  12. package/resource/doc/livekit/vue/live-player-h5-integration.md +269 -0
  13. package/resource/doc/livekit/vue/workflow.md +218 -0
  14. package/resource/doc/trtc/C++/ITRTCCloud.md +4119 -0
  15. package/resource/doc/trtc/C++/ITRTCStatistics.md +325 -0
  16. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +1289 -0
  17. package/resource/doc/trtc/C++/ITXDeviceManager.md +1028 -0
  18. package/resource/doc/trtc/C++/TRTCCloudCallback.md +2650 -0
  19. package/resource/doc/trtc/C++/TRTCTypeDef.md +3600 -0
  20. package/resource/doc/trtc/C++/TXLiteAVCode.md +921 -0
  21. package/resource/doc/trtc/android/TRTCCloud.md +3782 -0
  22. package/resource/doc/trtc/android/TRTCCloudDef.md +3880 -0
  23. package/resource/doc/trtc/android/TRTCCloudListener.md +2431 -0
  24. package/resource/doc/trtc/android/TRTCStatistics.md +295 -0
  25. package/resource/doc/trtc/android/TXAudioEffectManager.md +1289 -0
  26. package/resource/doc/trtc/android/TXBeautyManager.md +979 -0
  27. package/resource/doc/trtc/android/TXDeviceManager.md +440 -0
  28. package/resource/doc/trtc/android/TXLiteAVCode.md +905 -0
  29. package/resource/doc/trtc/iOS/TRTCCloud.md +4238 -0
  30. package/resource/doc/trtc/iOS/TRTCCloudDef.md +3730 -0
  31. package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +2531 -0
  32. package/resource/doc/trtc/iOS/TRTCStatistics.md +295 -0
  33. package/resource/doc/trtc/iOS/TXAudioEffectManager.md +1100 -0
  34. package/resource/doc/trtc/iOS/TXBeautyManager.md +985 -0
  35. package/resource/doc/trtc/iOS/TXDeviceManager.md +1024 -0
  36. package/resource/doc/trtc/iOS/TXLiteAVCode.md +928 -0
  37. package/tools/chat/get-web-chat-integration.js +31 -14
  38. package/tools/chat/get-web-chat-integration.js.map +1 -1
  39. package/tools/definitions/get_faq_def.js +4 -0
  40. package/tools/definitions/get_faq_def.js.map +1 -1
  41. package/tools/definitions/get_native_live_api_def.js +1 -1
  42. package/tools/definitions/get_trtc_native_api_def.js +16 -0
  43. package/tools/definitions/get_trtc_native_api_def.js.map +1 -0
  44. package/tools/definitions/get_web_chat_uikit_integration_def.js +19 -12
  45. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
  46. package/tools/definitions/get_web_live_uikit_component_detail_def.js +13 -8
  47. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +1 -1
  48. package/tools/definitions/get_web_live_uikit_integration_def.js +32 -0
  49. package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -0
  50. package/tools/index.js +6 -4
  51. package/tools/index.js.map +1 -1
  52. package/tools/live/get-web-live-uikit-integration.js +52 -0
  53. package/tools/live/get-web-live-uikit-integration.js.map +1 -0
  54. package/tools/trtc/get-trtc-native-api.js +31 -0
  55. package/tools/trtc/get-trtc-native-api.js.map +1 -0
  56. package/utils/generate-structured-result.js +34 -0
  57. package/utils/generate-structured-result.js.map +1 -0
  58. package/utils/handle-component-name.js +0 -8
  59. package/utils/handle-component-name.js.map +1 -1
  60. package/utils/report-cls-client.js +1 -1
  61. package/utils/report-es-client.js +1 -1
  62. package/resource/doc/chatuikit/react/chat_window_integration.md +0 -94
  63. package/resource/doc/chatuikit/vue/chat_window_integration.md +0 -156
  64. package/tools/chat/get-web-chat-window-integration.js +0 -28
  65. package/tools/chat/get-web-chat-window-integration.js.map +0 -1
  66. package/tools/definitions/get_web_chat_window_integration_def.js +0 -26
  67. package/tools/definitions/get_web_chat_window_integration_def.js.map +0 -1
  68. /package/resource/doc/livekit/vue/{components/broadcast.md → live-pusher-integration.md} +0 -0
@@ -0,0 +1,395 @@
1
+ # Vue Chat TUIKit Code Generation Workflow Instructions
2
+
3
+ ## 📋 Instruction Purpose
4
+
5
+ Provide Agents with a **code generation blueprint for implementing Vue Chat TUIKit core features** and guide Agents to **prioritize using real-time documentation content obtained from tools**, specifically targeting Vue3 Web application scenarios.
6
+
7
+ ---
8
+
9
+ ## 🛑 Agent Execution Hard Constraints (Guardrails)
10
+
11
+ Agents must strictly follow these instructions when generating code:
12
+
13
+ ### 1. Documentation-Driven Integration
14
+ - Must strictly follow the steps in `llm_code_generation_instructions_md` from tool return results
15
+ - **Must strictly generate code according to example code in integration documentation**, do not modify code structure and implementation methods arbitrarily
16
+ - Code generation should completely follow best practices and examples provided by integration documentation to ensure code correctness and runnability
17
+
18
+ ### 2. CSS Style Mandatory Standards 🔴
19
+ - **Must strictly generate according to complete CSS style code in integration documentation**, including:
20
+ - Official CSS class names (such as `.chat-layout`, `.chat-content-panel`, etc.)
21
+ - Official CSS variable definitions (such as `--bg-color-operate`, `--stroke-color-primary`, etc.)
22
+ - Official layout structure and style properties
23
+ - Official `#app` style configuration
24
+ - **Prohibit creating any custom style class names or modifying official styles**
25
+ - All style code must be completely copied from integration documentation without modification
26
+
27
+ ### 3. Silent Integration Execution 🔥
28
+ **CRITICAL**: After all code writing is completed, dependencies must be automatically installed and the project started in the final step without waiting for user confirmation.
29
+
30
+ **Mandatory Execution Requirements**:
31
+ - **No Asking**: Do not ask users whether they need to start the project
32
+ - **No Waiting**: Do not wait for users to manually execute startup commands
33
+ - **Must Automate**: Must immediately execute integration steps after code completion
34
+ - **Batch Execution**: Dependency installation and startup commands must be completed in the same execute_command call
35
+
36
+ **Standard Execution Command**:
37
+ ```bash
38
+ cd [project_path] && npm install && npm run dev
39
+ ```
40
+
41
+ ### 4. Zero External Configuration
42
+ - Prohibit automatically creating any `config.js` or `.env` files
43
+ - Key credentials like SDKAppID, UserID, and UserSig must be directly injected into code variables
44
+
45
+ ### 5. Automatic Authentication Credential Acquisition
46
+ - Must call `get_usersig` tool to obtain test credentials, prohibit requiring users to manually input
47
+ - UserID generation should remain simple (prohibit concatenating dynamic timestamps to prevent logic errors)
48
+
49
+ ### 6. Default Active Conversation
50
+ - Integration logic must include `setActiveConversation` call
51
+ - Default to open `C2Cadministrator` conversation
52
+
53
+ ### 7. Vue3 Composition API
54
+ - Prioritize using `<script setup>` syntax
55
+ - Use Vue3 Composition API (ref, reactive, computed, etc.)
56
+ - Correctly import and use TUIKit components
57
+
58
+ ### 8. chat-only Mode Feature Restrictions (⚠️ Default Constraints + Exceptions When Users Actively Request)
59
+
60
+ **Default Behavior**:
61
+ When users choose chat-only mode, Agents **default exclude** the following extended features:
62
+ - **Default no Sidebar integration** (sidebar)
63
+ - **Default no ChatSetting integration** (chat settings)
64
+ - **Default no in-conversation search functionality integration**
65
+ - **Default no ConversationList integration** (conversation list)
66
+ - **Default only retain core chat components**: `Chat`, `MessageList`, `ChatHeader`, `MessageInput`
67
+
68
+ **Exception Handling**:
69
+ If users **explicitly request** adding certain extended features (such as "need ChatSetting", "want to integrate search", etc.), Agents **should allow and execute**:
70
+ - ✅ On the basis of core chat components, additionally integrate features explicitly requested by users
71
+ - ✅ Only add features explicitly requested by users, do not arbitrarily expand other features
72
+ - ✅ Correctly integrate required components according to integration documentation specifications
73
+
74
+ **Judgment Criteria**:
75
+ - User requirements contain explicit feature keywords (such as "ChatSetting", "search", "settings", "sidebar", etc.)
76
+ - Users explicitly state they need a certain extended feature
77
+
78
+ ---
79
+
80
+ ## 📦 TUIKit Version and Dependency Automation
81
+
82
+ After Agents generate code, they must automatically execute the following dependency chain:
83
+
84
+ ### 1. Core Dependency Version Recommendations
85
+
86
+ ```json
87
+ {
88
+ "@tencentcloud/chat-uikit-vue3": "latest",
89
+ "@tencentcloud/call-uikit-vue": "latest"
90
+ }
91
+ ```
92
+
93
+ ### 2. Build Environment Patches (Vite/esbuild)
94
+
95
+ If a Vite project is detected, Agents must automatically add patch configuration in `package.json` to be compatible with 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 Component Description
111
+
112
+ When generating code, Agents must understand and correctly use the following Vue3 components:
113
+
114
+ | Component Name | Description | Use Case |
115
+ |----------------|-------------|----------|
116
+ | `ConversationList` | Conversation list component | full-featured mode, display all conversations |
117
+ | `Chat` | Conversation container component | All modes, main chat container |
118
+ | `MessageList` | Conversation message list component | Display chat message history |
119
+ | `ChatHeader` | Conversation header information component | Display conversation title, member information, etc. |
120
+ | `MessageInput` | Input box component | Message input and sending |
121
+ | `ChatSetting` | Single chat and group chat management component | Conversation settings, group management, etc. |
122
+ | `Search` | Cloud search component | Search messages, contacts, etc. |
123
+ | `ContactList` | Contact component | full-featured mode, address book functionality |
124
+
125
+ **Important Notes**:
126
+ - Agents must strictly generate code according to component names and usage in integration documentation
127
+ - Do not create or modify component names arbitrarily
128
+ - Specific component usage methods are subject to integration documentation returned by tools
129
+
130
+ ---
131
+
132
+ ## 🛠️ Integration Mode Distribution (Goals)
133
+
134
+ According to user requirements, Agents must choose corresponding execution paths:
135
+
136
+ ### 1. Full-Featured Integration (full-featured)
137
+
138
+ **Objective**: Implement complete IM application similar to WeChat
139
+
140
+ **Core Components**:
141
+ - `ConversationList` (conversation list)
142
+ - `Chat` (chat container)
143
+ - `ContactList` (address book)
144
+ - `Search` (cloud search)
145
+
146
+ **Execution Reference**:
147
+ - Refer to real-time acquired `integration.md` instructions in tool return results
148
+
149
+ **Applicable Scenarios**:
150
+ - Build independent chat applications
151
+ - Need complete conversation management, address book, group management functionality
152
+ - As core functional module of Web applications
153
+
154
+ ---
155
+
156
+ ### 2. Chat Window Only Integration (chat-only)
157
+
158
+ **Objective**: Suitable for pure dialogue scenarios like customer service, consultation, detail page private chat
159
+
160
+ **Core Components**:
161
+ - `Chat` (chat container)
162
+ - `MessageList` (message list)
163
+ - `ChatHeader` (chat header)
164
+ - `MessageInput` (input box)
165
+
166
+ **Execution Reference**:
167
+ - Refer to real-time acquired `integration.md` instructions in tool return results
168
+
169
+ **Applicable Scenarios**:
170
+ - Customer service consultation scenarios (users click consultation button to enter chat page)
171
+ - Medical online consultation (patient-doctor one-on-one communication)
172
+ - Order detail page private chat (buyer-seller communication)
173
+ - Private messaging functionality in social applications
174
+
175
+ **🔴 Default Excluded Features (Agents Must Comply)**:
176
+
177
+ When generating chat-only mode code, Agents **default exclude** the following features and components:
178
+
179
+ 1. **Default no Sidebar integration (sidebar)**
180
+ - Default no generation of any sidebar-related code
181
+ - Default no import of conversation list, address book and other sidebar components
182
+ - Chat window should default to independent, sidebar-free pure chat interface
183
+
184
+ 2. **Default no ChatSetting integration (chat settings)**
185
+ - Default no generation of conversation settings, group management and other functionality
186
+ - Default no addition of settings button on the right side of ChatHeader
187
+ - Default no import of ChatSetting component
188
+
189
+ 3. **Default no in-conversation search functionality integration**
190
+ - Default no addition of message search functionality
191
+ - Default no addition of search entry in chat interface
192
+ - Default no import of Search component
193
+
194
+ 4. **Default no ConversationList integration (conversation list)**
195
+ - In chat-only mode, users specify conversation ID through external routing/parameters
196
+ - Default no need for conversation switching functionality
197
+
198
+ ---
199
+
200
+ **⚠️ Exception Handling When Users Actively Request**:
201
+
202
+ If users **explicitly request** adding certain extended features in chat-only mode, Agents **should allow and execute**:
203
+
204
+ **Trigger Conditions** (any one satisfied):
205
+ - Users explicitly state: "need ChatSetting", "want to integrate chat settings", "add conversation settings functionality"
206
+ - Users explicitly state: "need Search", "want to add search functionality", "integrate in-conversation search"
207
+ - Users explicitly state: "need Sidebar", "want to add sidebar"
208
+ - Users explicitly propose other extended feature requirements
209
+
210
+ **Agent Execution Process**:
211
+ 1. ✅ **Confirm User Requirements**: Recognize that users actively request adding extended features
212
+ 2. ✅ **Allow Integration**: On the basis of chat-only mode, additionally integrate components requested by users
213
+ 3. ✅ **Maintain Restraint**: Only add features explicitly requested by users, do not arbitrarily expand other features
214
+ 4. ✅ **Follow Documentation**: Correctly integrate required components according to integration documentation specifications
215
+
216
+ ---
217
+
218
+ ## 📞 Extended Features: Audio/Video Calling (TUICallKit)
219
+
220
+ If requirements contain "calling" or "video" functionality, Agents must execute:
221
+
222
+ ### Component Mounting
223
+ - Use `Teleport` to mount TUICallKit component to body
224
+
225
+ ### Interaction Injection
226
+
227
+ **Inject calling buttons in the right slot of ChatHeader component**:
228
+ - Icons: phone, camera, etc.
229
+ - Component usage methods refer to integration documentation
230
+
231
+ **Single Chat Logic**:
232
+ - Initiate calls through `TUICallKitServer.call`
233
+ - UserID automatically taken from currently active conversation
234
+
235
+ **Group Chat Logic**:
236
+ - Need to integrate member selection component
237
+ - Guide users to select group members before initiating calls
238
+
239
+ ---
240
+
241
+ ## ✍️ Agent Code Generation Example Instructions (Prompts)
242
+
243
+ When Agents start writing code, they should follow these semantic logics:
244
+
245
+ **Full-Featured Integration (full-featured)**:
246
+ > "According to `full-featured` mode, generate a Vue3 TUIKit integration page for me. Please automatically configure `C2Cadministrator` default active conversation and inject credentials obtained by `get_usersig` tool. Prohibit creating config files. **🔴 Important: Must strictly generate according to complete CSS style code in integration documentation, prohibit any customization or modification.**"
247
+
248
+ **Chat Window Only Integration (chat-only)**:
249
+ > "According to `chat-only` mode, generate a Vue3 TUIKit chat window for me. Please automatically configure `C2Cadministrator` default active conversation and inject credentials obtained by `get_usersig` tool. Prohibit creating config files. **Strictly exclude Sidebar, ChatSetting, in-conversation search and other features, only retain core chat components. 🔴 Important: Must strictly generate according to complete CSS style code in integration documentation, prohibit any custom styles.**"
250
+
251
+ ---
252
+
253
+ ## 📝 Key Points Summary
254
+
255
+ | Category | Requirement |
256
+ |----------|-------------|
257
+ | **Framework Version** | Specifically for Vue3 projects |
258
+ | **Documentation Priority** | Strictly follow latest documentation instructions returned by tools |
259
+ | **🔴 CSS Styles** | **Strictly follow integration documentation CSS, prohibit any customization or modification** |
260
+ | **Silent Integration** | Automatically install dependencies and start development server after code writing completion |
261
+ | **Credential Injection** | Automatically call `get_usersig`, directly inject into code |
262
+ | **Default Conversation** | Automatically activate `C2Cadministrator` conversation |
263
+ | **Dependency Management** | Automatically detect and install required dependency packages |
264
+ | **Build Tools** | Vite projects need to add esbuild-wasm patch configuration |
265
+ | **Integration Modes** | Support full-featured (complete) and chat-only (chat only) two modes |
266
+ | **chat-only Restrictions** | ⚠️ Default exclude Sidebar, ChatSetting, search functionality; allow integration when users actively request |
267
+
268
+ ---
269
+
270
+ ## 🎯 Agent Execution Checklist
271
+
272
+ After completing code generation, Agents must confirm all the following items:
273
+
274
+ ### Project Initialization
275
+ - [ ] Created Vue3 project or integrated into existing project
276
+ - [ ] Installed `@tencentcloud/chat-uikit-vue3` dependency
277
+ - [ ] If audio/video calling is needed, installed `@tencentcloud/call-uikit-vue`
278
+ - [ ] If Vite project, added esbuild-wasm patch configuration
279
+
280
+ ### Code Generation
281
+ - [ ] Correctly registered TUIKit components in main.js
282
+ - [ ] Created main chat container component (ChatContainer.vue or similar)
283
+ - [ ] Components use `<script setup>` syntax
284
+ - [ ] 🔴 **CSS Styles Strictly Compliant**:
285
+ - [ ] Completely obtained all CSS style code from integration documentation
286
+ - [ ] Used official class names from integration documentation
287
+ - [ ] Completely copied CSS variable definitions from integration documentation
288
+ - [ ] Used layout style configuration from integration documentation
289
+ - [ ] Prohibited creating any custom style class names
290
+ - [ ] Prohibited modifying any style properties from integration documentation
291
+ - [ ] Style code completely consistent with integration documentation
292
+
293
+ ### Credentials and Login
294
+ - [ ] 🔴 Called `get_usersig` tool to obtain test credentials
295
+ - [ ] Directly injected SDKAppID, UserID, UserSig into code
296
+ - [ ] Prohibited creating config.js or .env files
297
+ - [ ] Implemented TUILogin.login() login logic
298
+
299
+ ### Conversation Activation
300
+ - [ ] Added logic to default activate `C2Cadministrator` conversation
301
+ - [ ] Used correct API (setActiveConversation)
302
+
303
+ ### Integration Mode
304
+ - [ ] Selected correct integration mode according to user requirements (full-featured or chat-only)
305
+ - [ ] full-featured mode: Integrated ConversationList, Chat, Contact and other components
306
+ - [ ] chat-only mode: Integrated core components (Chat, MessageList, ChatHeader, MessageInput)
307
+ - [ ] chat-only mode: Judged whether extended features need integration according to user requirements
308
+ - [ ] If users did not actively request, confirmed not including Sidebar, ChatSetting, Search and other components
309
+ - [ ] If users actively requested (such as "need ChatSetting"), additionally integrated features explicitly requested by users
310
+
311
+ ### Audio/Video Calling (Optional)
312
+ - [ ] If calling functionality is needed, used Teleport to mount TUICallKit
313
+ - [ ] Added calling buttons in right slot of ChatHeader component
314
+ - [ ] Implemented single chat and group chat calling logic
315
+
316
+ ### Final Check
317
+ - [ ] Called `record_result` to record integration results
318
+ - [ ] Automatically installed dependencies (npm install)
319
+ - [ ] Automatically started development server (npm run dev)
320
+ - [ ] Project can run normally without errors
321
+
322
+ ---
323
+
324
+ ## 💡 Common Issue Handling
325
+
326
+ ### 1. Vite Build Errors
327
+
328
+ **Problem Symptoms**: Vite project reports esbuild-related errors when running
329
+
330
+ **Cause**: Some dependency packages are incompatible with esbuild
331
+
332
+ **Solution**:
333
+ Add patch configuration in `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 Mode Contains Unwanted Features
346
+
347
+ **Problem Symptoms**: chat-only mode generated code contains Sidebar, ChatSetting or in-conversation search functionality not requested by users
348
+
349
+ **Cause**: Agent did not correctly judge user requirements and arbitrarily added extended features
350
+
351
+ **Judgment Criteria**:
352
+ - ✅ **Should Add**: Users explicitly state "need ChatSetting", "want to integrate search", "add settings functionality", etc.
353
+ - ❌ **Should Not Add**: Users only say "build chat-only chat window" without mentioning extended features
354
+
355
+ **Solution**: Regenerate code, ensure default does not include extended features
356
+
357
+ ### 3. CSS Styles Do Not Conform to Integration Documentation
358
+
359
+ **Problem Symptoms**: Generated code uses custom style class names or modified official styles
360
+
361
+ **Cause**: Agent did not strictly generate code according to CSS styles in integration documentation
362
+
363
+ **Solution**:
364
+ 1. Re-call `get_web_chat_uikit_integration` to obtain latest integration documentation
365
+ 2. Completely copy all CSS style code from integration documentation
366
+ 3. Strictly use class names, variable names, style properties according to integration documentation
367
+ 4. Prohibit any form of modification or customization
368
+
369
+ ---
370
+
371
+ ## 🔗 Related Tool References
372
+
373
+ ### Must-Use Tools
374
+
375
+ #### `get_usersig` - Obtain Complete Test Credentials (Mandatory Call)
376
+ **Purpose**: Generate complete test account and authentication credentials, including:
377
+ - `SDKAppID`: Application identifier
378
+ - `userID`: Test user ID
379
+ - `userSig`: User signature (valid for 7 days)
380
+
381
+ **Call Timing**: Must call before generating login code
382
+
383
+ **Usage Constraints**:
384
+ - ✅ Must use complete credentials returned by tool
385
+ - ❌ Prohibit requiring users to manually fill in SDKAppID and secretKey
386
+ - ❌ Prohibit creating configuration files to store credentials
387
+
388
+ #### `record_result` - Record Integration Results
389
+ **Purpose**: Record integration process and results for statistics and analysis
390
+
391
+ ---
392
+
393
+ **Applicable Framework**: Vue3
394
+ **TUIKit Version**: @tencentcloud/chat-uikit-vue3 > 4.0.0
395
+ **Build Tools**: Vite (Recommended) / Webpack
@@ -44,19 +44,19 @@ Before performing quick integration, you need to refer to [preparations](https:/
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
  ### Step 3: Integrating the Link Management Panel
@@ -38,19 +38,19 @@ Before quick integration, you need to refer to [preparations](https://write.woa.
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
  ### Step 3: Joining the Live Room and Performing Voice Chat
@@ -395,4 +395,4 @@ const isAnchor = (userInfo: SeatUserInfo) => {
395
395
  </script>
396
396
 
397
397
  <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>
398
- ```
398
+ ```
@@ -9,7 +9,7 @@ This document provides a detailed introduction to the **Live Stream List Page**
9
9
 
10
10
  ### Step 1: Configuring the Environment and Activating the Service
11
11
 
12
- Before performing quick connection, you need to refer to [Preparations](https://write.woa.com/document/189228990450999296) to meet the required environment configuration and activate the corresponding service.
12
+ Before performing quick connection, you need to refer to [Preparations](https://write.woa.com/document/163673134112337920) to meet the required environment configuration and activate the corresponding service.
13
13
 
14
14
  ### Step 2: Dependency Installation
15
15
 
@@ -20,19 +20,19 @@ You can choose any method below to install dependencies:
20
20
 
21
21
  【npm】
22
22
  ``` bash
23
- npm install tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3 --save
23
+ npm install tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 --save
24
24
  ```
25
25
 
26
26
 
27
27
  【pnpm】
28
28
  ``` bash
29
- pnpm add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
29
+ pnpm add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
30
30
  ```
31
31
 
32
32
 
33
33
  【yarn】
34
34
  ``` bash
35
- yarn add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
35
+ yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
36
36
  ```
37
37
 
38
38
  ### Step 3: Live Stream List Page Integration
@@ -118,7 +118,7 @@ As shown in the above feature diagram, we also support you to customize the live
118
118
 
119
119
  ## Designate a Live Streaming Room
120
120
 
121
- To handle the redirect logic from the live list (or homepage) to the live streaming room, you need to configure Vue Router. In the `src` directory of your project, create a new `router` folder and create the `index.ts` file. Then, in your main file (such as **main.ts** or **index.ts**), import and use the router. See the [GitHub sample code](https://github.com/Tencent-RTC/TUILiveKit/blob/main/Web/web-vite-vue3/src/main.ts). If you need the live list, see the documentation for the [Live Stream List Page](https://write.woa.com/document/189228992611065856).
121
+ To handle the redirect logic from the live list (or homepage) to the live streaming room, you need to configure Vue Router. In the `src` directory of your project, create a new `router` folder and create the `index.ts` file. Then, in your main file (such as **main.ts** or **index.ts**), import and use the router. See the [GitHub sample code](https://github.com/Tencent-RTC/TUILiveKit/blob/main/Web/web-vite-vue3/src/main.ts). If you need the live list, see the documentation for the [Live Stream List Page](https://write.woa.com/#).
122
122
  ``` typescript
123
123
  // live-list.vue can be incrementally added to your code
124
124
  <template>
@@ -186,7 +186,7 @@ Congratulations! You have successfully integrated the live broadcast list page.
186
186
 
187
187
  <td rowspan="1" colSpan="1" >The live streamer's entire live streaming process is supported, including pre-streaming preparation and post-streaming interactions.</td>
188
188
 
189
- <td rowspan="1" colSpan="1" >[Host Streaming](https://write.woa.com/document/189497714561167360)</td>
189
+ <td rowspan="1" colSpan="1" >[Host Streaming](https://write.woa.com/document/194114399449153536)</td>
190
190
  </tr>
191
191
 
192
192
  <tr>
@@ -194,7 +194,7 @@ Congratulations! You have successfully integrated the live broadcast list page.
194
194
 
195
195
  <td rowspan="1" colSpan="1" >Viewers can enter the live streamer's room to watch the live stream, connect to the microphone, view live stream room information, view online viewers, and display comments.</td>
196
196
 
197
- <td rowspan="1" colSpan="1" >[Audience Viewing](https://write.woa.com/document/189571398058663936)</td>
197
+ <td rowspan="1" colSpan="1" >[Audience Viewing](https://write.woa.com/document/194114585866043392)</td>
198
198
  </tr>
199
199
  </table>
200
200
 
@@ -51,32 +51,32 @@ The watch page provides default behavior and style, but if the default behavior
51
51
 
52
52
  ### Step 1: Environment Configuration and Service Activation
53
53
 
54
- Before using Quick Access, you need to refer to [Preparations](https://write.woa.com/document/189231573727113216) configuration requirements and activate the corresponding services.
54
+ Before using Quick Access, you need to refer to [Preparations](https://write.woa.com/document/163673134112337920) configuration requirements and activate the corresponding services.
55
55
 
56
56
 
57
57
 
58
58
 
59
59
  【npm】
60
60
  ``` bash
61
- npm install tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3 --save
61
+ npm install tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 --save
62
62
  ```
63
63
 
64
64
 
65
65
  【pnpm】
66
66
  ``` bash
67
- pnpm add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
67
+ pnpm add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
68
68
  ```
69
69
 
70
70
 
71
71
  【yarn】
72
72
  ``` bash
73
- yarn add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
73
+ yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
74
74
  ```
75
75
 
76
76
  ### Step 2: Access the viewing page
77
77
 
78
78
  Create a live-player.vue file in your project and copy the following code to integrate the watch page into your project.
79
- ``` vue
79
+ ``` java
80
80
  <template>
81
81
  <UIKitProvider language="zh-CN">
82
82
  <div class="container">
@@ -190,7 +190,7 @@ As shown in the functional diagram above, we also support customizing the UI of
190
190
  #### Method 1: Playing by Specifying a LiveId
191
191
 
192
192
  If you need to specify a LiveId for playback, you need to add the following code based on the code in [step 3](https://write.woa.com/#c1b852bc-da02-4c9f-bb11-2a63582ce978) of the Quick Access section above. The reference method is as follows:
193
- ``` typescript
193
+ ``` java
194
194
  // live-player.vue
195
195
  import { onMounted } from 'vue';
196
196
  import { useLiveState } from 'tuikit-atomicx-vue3';
@@ -256,7 +256,7 @@ Congratulations! You've successfully integrated the watch page. Next, you can im
256
256
 
257
257
  <td rowspan="1" colSpan="1" >The complete workflow for a host to start a stream, including pre-stream setup and various in-stream interactions.</td>
258
258
 
259
- <td rowspan="1" colSpan="1" >[Host Streaming](https://write.woa.com/document/189497714561167360)</td>
259
+ <td rowspan="1" colSpan="1" >[Host Streaming](https://write.woa.com/document/194114399449153536)</td>
260
260
  </tr>
261
261
 
262
262
  <tr>
@@ -264,6 +264,6 @@ Congratulations! You've successfully integrated the watch page. Next, you can im
264
264
 
265
265
  <td rowspan="1" colSpan="1" >Display the live broadcast list interface and functions, including live broadcast list and room information display function</td>
266
266
 
267
- <td rowspan="1" colSpan="1" >[Live Stream List](https://write.woa.com/document/189592401543360512)</td>
267
+ <td rowspan="1" colSpan="1" >[Live Stream List](https://write.woa.com/document/194114814480777216)</td>
268
268
  </tr>
269
269
  </table>