@tencentcloud/sdk-mcp 1.3.9 → 1.4.0

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 (510) hide show
  1. package/index.js +1 -1
  2. package/index.js.map +1 -1
  3. package/package.json +2 -2
  4. package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/android-faq.md} +75 -308
  5. package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +2 -2
  6. package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/flutter-faq.md} +83 -315
  7. package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/ios-faq.md} +76 -313
  8. package/resource/doc/{tuicallkit/vue/faq.md → callkit/faq/web-faq.md} +78 -311
  9. package/resource/doc/callkit/preset/android/api.md +330 -0
  10. package/resource/doc/{tuicallkit → callkit/preset}/android/integration.md +63 -420
  11. package/resource/doc/callkit/preset/flutter/api.md +401 -0
  12. package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +53 -273
  13. package/resource/doc/callkit/preset/ios/api.md +282 -0
  14. package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +39 -120
  15. package/resource/doc/callkit/preset/react/api.md +600 -0
  16. package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +6 -6
  17. package/resource/doc/callkit/preset/vue/api.md +600 -0
  18. package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +5 -5
  19. package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -37
  20. package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
  21. package/resource/doc/{chatuikit → chatkit}/android/integration.md +30 -126
  22. package/resource/doc/chatkit/faq/android_sdk/client-api.md +280 -0
  23. package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +4 -17
  24. package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -2
  25. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +183 -0
  26. package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
  27. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +279 -0
  28. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +1 -1
  29. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +4 -4
  30. package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
  31. package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +20 -95
  32. package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -37
  33. package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
  34. package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +78 -280
  35. package/resource/doc/{chatuikit/vue → chatkit/react}/components/avatar.md +0 -1
  36. package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +7 -12
  37. package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +10 -17
  38. package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +1 -1
  39. package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -1
  40. package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +122 -703
  41. package/resource/doc/chatkit/react/components/conversation-actions.md +174 -0
  42. package/resource/doc/chatkit/react/components/conversation-list.md +333 -0
  43. package/resource/doc/chatkit/react/components/conversation-preview.md +116 -0
  44. package/resource/doc/chatkit/react/components/conversation-search.md +57 -0
  45. package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -186
  46. package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +21 -113
  47. package/resource/doc/chatkit/react/components/search.md +282 -0
  48. package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +5 -26
  49. package/resource/doc/{chatuikit → chatkit}/react/integration.md +37 -104
  50. package/resource/doc/{chatuikit/react → chatkit/vue}/components/avatar.md +0 -1
  51. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -13
  52. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +13 -18
  53. package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +1 -2
  54. package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -1
  55. package/resource/doc/chatkit/vue/components/contact-list.md +271 -0
  56. package/resource/doc/chatkit/vue/components/conversation-actions.md +228 -0
  57. package/resource/doc/{chatuikit → chatkit}/vue/components/conversation-list.md +42 -316
  58. package/resource/doc/chatkit/vue/components/conversation-preview.md +213 -0
  59. package/resource/doc/chatkit/vue/components/conversation-search.md +50 -0
  60. package/resource/doc/{chatuikit → chatkit}/vue/components/message-input.md +1 -23
  61. package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -134
  62. package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
  63. package/resource/doc/chatkit/vue/components/tuikit.md +45 -0
  64. package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +4 -4
  65. package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
  66. package/resource/doc/{chatuikit → chatkit}/vue/integration.md +53 -121
  67. package/resource/doc/livekit/core-sdk/live/android/api-reference/AudioEffectStore.md +283 -0
  68. package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +148 -0
  69. package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +316 -0
  70. package/resource/doc/livekit/core-sdk/live/android/api-reference/CameraView.md +57 -0
  71. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +419 -0
  72. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +325 -0
  73. package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +436 -0
  74. package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +165 -0
  75. package/resource/doc/livekit/core-sdk/live/android/api-reference/LikeStore.md +49 -0
  76. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +239 -0
  77. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +74 -0
  78. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +417 -0
  79. package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +207 -0
  80. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +17 -88
  81. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audio-effect.md +34 -192
  82. package/resource/doc/livekit/{live → core-sdk/live}/android/live-barrage.md +26 -139
  83. package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +16 -99
  84. package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +54 -161
  85. package/resource/doc/livekit/{live → core-sdk/live}/android/live-gift.md +75 -455
  86. package/resource/doc/livekit/{live → core-sdk/live}/android/live-host-interaction.md +91 -338
  87. package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +108 -492
  88. package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +27 -165
  89. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/AudioEffectStore.md +279 -0
  90. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +158 -0
  91. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BaseBeautyStore.md +155 -0
  92. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +304 -0
  93. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +394 -0
  94. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +303 -0
  95. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +410 -0
  96. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +160 -0
  97. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LikeStore.md +51 -0
  98. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +231 -0
  99. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveCoreView.md +143 -0
  100. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +375 -0
  101. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +170 -0
  102. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +13 -91
  103. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -177
  104. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +18 -102
  105. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -164
  106. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -161
  107. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +66 -460
  108. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
  109. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-integration.md +160 -543
  110. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +22 -161
  111. package/resource/doc/livekit/core-sdk/live/ios/api-reference/AudioEffectStore.md +287 -0
  112. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +165 -0
  113. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +143 -0
  114. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +298 -0
  115. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +349 -0
  116. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +297 -0
  117. package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +471 -0
  118. package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +179 -0
  119. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LikeStore.md +49 -0
  120. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +238 -0
  121. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +74 -0
  122. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +412 -0
  123. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +173 -0
  124. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +23 -96
  125. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +33 -195
  126. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +35 -150
  127. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +20 -105
  128. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +35 -140
  129. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +77 -457
  130. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +70 -317
  131. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +90 -473
  132. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +28 -163
  133. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audience-list.md +17 -88
  134. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audio-effect.md +34 -192
  135. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-barrage.md +26 -139
  136. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-co-guest-interaction.md +53 -262
  137. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-gift.md +75 -455
  138. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-host-interaction.md +60 -272
  139. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-integration.md +63 -440
  140. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-room-list.md +23 -151
  141. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-audience-list.md +13 -91
  142. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-audio-effect.md +34 -177
  143. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-barrage.md +18 -102
  144. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-co-guest-interaction.md +44 -201
  145. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-gift.md +66 -460
  146. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-integration.md +57 -419
  147. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-room-list.md +24 -157
  148. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audience-list.md +23 -96
  149. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audio-effect.md +33 -195
  150. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-barrage.md +35 -150
  151. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-co-guest-interaction.md +45 -254
  152. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-gift.md +77 -457
  153. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-host-interaction.md +52 -261
  154. package/resource/doc/livekit/core-sdk/voice/ios/voice-integration.md +478 -0
  155. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-room-list.md +36 -167
  156. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-audience-list.md +15 -45
  157. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-audio-effect.md +23 -137
  158. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-barrage.md +25 -131
  159. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-co-guest-interaction.md +70 -366
  160. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-gift.md +70 -424
  161. package/resource/doc/livekit/core-sdk/voice/uni-app/voice-integration.md +323 -0
  162. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-room-list.md +24 -116
  163. package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -3
  164. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +780 -0
  165. package/resource/doc/livekit/preset/live/vue/components/barrage.md +291 -0
  166. package/resource/doc/livekit/{live → preset/live}/vue/components/co-guest-panel.md +9 -48
  167. package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +27 -145
  168. package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +13 -76
  169. package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +33 -224
  170. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +211 -0
  171. package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
  172. package/resource/doc/livekit/preset/live/vue/live-list-integration.md +244 -0
  173. package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +301 -0
  174. package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +307 -0
  175. package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +754 -0
  176. package/resource/doc/roomkit/android/features/call-user-to-room.md +234 -0
  177. package/resource/doc/roomkit/android/features/room-participant-state.md +850 -0
  178. package/resource/doc/roomkit/android/features/room-state.md +358 -0
  179. package/resource/doc/roomkit/android/features/schedule-room.md +336 -0
  180. package/resource/doc/roomkit/android/integration.md +433 -0
  181. package/resource/doc/roomkit/{common/error_code.md → faq/common/error-code.md} +1 -1
  182. package/resource/doc/roomkit/flutter/features/call-user-to-room.md +228 -0
  183. package/resource/doc/roomkit/flutter/features/room-participant-state.md +796 -0
  184. package/resource/doc/roomkit/flutter/features/room-state.md +324 -0
  185. package/resource/doc/roomkit/flutter/features/schedule-room.md +324 -0
  186. package/resource/doc/roomkit/flutter/integration.md +405 -0
  187. package/resource/doc/roomkit/ios/features/call-user-to-room.md +226 -0
  188. package/resource/doc/roomkit/ios/features/room-participant-state.md +821 -0
  189. package/resource/doc/roomkit/ios/features/room-state.md +320 -0
  190. package/resource/doc/roomkit/ios/features/schedule-room.md +318 -0
  191. package/resource/doc/roomkit/ios/integration.md +384 -0
  192. package/resource/doc/roomkit/vue/faq.md +1 -0
  193. package/resource/doc/roomkit/vue/features/call-user-to-room.md +17 -53
  194. package/resource/doc/roomkit/vue/features/device-detection.md +30 -48
  195. package/resource/doc/roomkit/vue/features/device-state.md +24 -44
  196. package/resource/doc/roomkit/vue/features/free-beauty-panel.md +13 -36
  197. package/resource/doc/roomkit/vue/features/room-chat.md +31 -89
  198. package/resource/doc/roomkit/vue/features/room-participant-state.md +28 -50
  199. package/resource/doc/roomkit/vue/features/room-state.md +25 -36
  200. package/resource/doc/roomkit/vue/features/room-view.md +30 -127
  201. package/resource/doc/roomkit/vue/features/schedule-room.md +9 -40
  202. package/resource/doc/roomkit/vue/features/screen-share.md +22 -90
  203. package/resource/doc/roomkit/vue/features/virtual-background.md +13 -34
  204. package/resource/doc/roomkit/vue/integration.md +21 -80
  205. package/resource/doc/rtcengine/faq/common/userSig.md +17 -141
  206. package/resource/doc/rtcengine/faq/web/web.md +15 -22
  207. package/resource/doc/rtcengine/web/api.md +17 -21
  208. package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +4 -10
  209. package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +4 -8
  210. package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +3 -3
  211. package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -3
  212. package/resource/doc/rtcengine/web/plugin/22-advanced-audio-mixer.md +6 -6
  213. package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +2 -2
  214. package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +2 -4
  215. package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +1 -2
  216. package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +2 -6
  217. package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +13 -14
  218. package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +10 -90
  219. package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -8
  220. package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +31 -35
  221. package/resource/doc/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -2
  222. package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +7 -49
  223. package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -1
  224. package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -3
  225. package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +20 -20
  226. package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +1 -1
  227. package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +4 -4
  228. package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
  229. package/resource/doc/trtc/C++/ITRTCCloud.md +718 -2847
  230. package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
  231. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +207 -1041
  232. package/resource/doc/trtc/C++/ITXDeviceManager.md +127 -768
  233. package/resource/doc/trtc/C++/TRTCCloudCallback.md +634 -2259
  234. package/resource/doc/trtc/C++/TRTCTypeDef.md +726 -3465
  235. package/resource/doc/trtc/C++/TXLiteAVCode.md +117 -916
  236. package/resource/doc/trtc/android/TRTCCloud.md +638 -2612
  237. package/resource/doc/trtc/android/TRTCCloudDef.md +769 -3697
  238. package/resource/doc/trtc/android/TRTCCloudListener.md +609 -2070
  239. package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
  240. package/resource/doc/trtc/android/TXAudioEffectManager.md +207 -1049
  241. package/resource/doc/trtc/android/TXBeautyManager.md +127 -704
  242. package/resource/doc/trtc/android/TXDeviceManager.md +51 -318
  243. package/resource/doc/trtc/android/TXLiteAVCode.md +115 -900
  244. package/resource/doc/trtc/iOS/TRTCCloud.md +726 -2930
  245. package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +580 -2099
  246. package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
  247. package/resource/doc/trtc/iOS/TXAudioEffectManager.md +179 -896
  248. package/resource/doc/trtc/iOS/TXBeautyManager.md +128 -710
  249. package/resource/doc/trtc/iOS/TXDeviceManager.md +129 -772
  250. package/resource/doc/trtc/iOS/TXLiteAVCode.md +117 -915
  251. package/resource/doc/trtc/iOS/TXLiveSDKTypeDef.md +747 -3559
  252. package/server.js +1 -5
  253. package/server.js.map +1 -1
  254. package/tools/call/get_callkit_api.js +32 -0
  255. package/tools/call/get_callkit_api.js.map +1 -0
  256. package/tools/call/get_native_call_uikit_integration.js +34 -0
  257. package/tools/call/get_native_call_uikit_integration.js.map +1 -0
  258. package/tools/call/{get-web-call-integration.js → get_web_call_uikit_integration.js} +13 -8
  259. package/tools/call/get_web_call_uikit_integration.js.map +1 -0
  260. package/tools/chat/get_native_chat_uikit_feature_detail.js +34 -0
  261. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +1 -0
  262. package/tools/chat/get_native_chat_uikit_integration.js +45 -0
  263. package/tools/chat/get_native_chat_uikit_integration.js.map +1 -0
  264. package/tools/chat/get_web_chat_uikit_component_detail.js +34 -0
  265. package/tools/chat/get_web_chat_uikit_component_detail.js.map +1 -0
  266. package/tools/chat/get_web_chat_uikit_integration.js +45 -0
  267. package/tools/chat/get_web_chat_uikit_integration.js.map +1 -0
  268. package/tools/common/get_faq.js +265 -0
  269. package/tools/common/get_faq.js.map +1 -0
  270. package/tools/common/{get-usersig.js → get_usersig.js} +6 -3
  271. package/tools/common/get_usersig.js.map +1 -0
  272. package/tools/common/present_framework_choice.js +63 -0
  273. package/tools/common/present_framework_choice.js.map +1 -0
  274. package/tools/definitions/get_callkit_api_def.js +28 -0
  275. package/tools/definitions/get_callkit_api_def.js.map +1 -0
  276. package/tools/definitions/get_faq_def.js +18 -19
  277. package/tools/definitions/get_faq_def.js.map +1 -1
  278. package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
  279. package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
  280. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
  281. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
  282. package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -41
  283. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
  284. package/tools/definitions/get_native_livekit_core_features_def.js +33 -0
  285. package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
  286. package/tools/definitions/get_native_livekit_core_integration_def.js +33 -0
  287. package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
  288. package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
  289. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
  290. package/tools/definitions/get_usersig_def.js +17 -24
  291. package/tools/definitions/get_usersig_def.js.map +1 -1
  292. package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
  293. package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
  294. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
  295. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
  296. package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
  297. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
  298. package/tools/definitions/get_web_live_uikit_integration_def.js +13 -18
  299. package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
  300. package/tools/definitions/get_web_livekit_api_def.js +27 -0
  301. package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
  302. package/tools/definitions/get_web_livekit_component_detail_def.js +29 -0
  303. package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
  304. package/tools/definitions/get_web_room_uikit_integration_def.js +13 -46
  305. package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
  306. package/tools/definitions/get_web_roomkit_feature_detail_def.js +30 -0
  307. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
  308. package/tools/definitions/get_web_trtc_sdk_api_def.js +25 -0
  309. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
  310. package/tools/definitions/get_web_trtc_sdk_integration_def.js +25 -0
  311. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
  312. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +25 -0
  313. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
  314. package/tools/definitions/present_framework_choice_def.js +23 -12
  315. package/tools/definitions/present_framework_choice_def.js.map +1 -1
  316. package/tools/index.js +47 -61
  317. package/tools/index.js.map +1 -1
  318. package/tools/live/get_native_livekit_core_features.js +65 -0
  319. package/tools/live/get_native_livekit_core_features.js.map +1 -0
  320. package/tools/live/get_native_livekit_core_integration.js +59 -0
  321. package/tools/live/get_native_livekit_core_integration.js.map +1 -0
  322. package/tools/live/get_web_live_uikit_integration.js +48 -0
  323. package/tools/live/get_web_live_uikit_integration.js.map +1 -0
  324. package/tools/live/get_web_livekit_api.js +32 -0
  325. package/tools/live/get_web_livekit_api.js.map +1 -0
  326. package/tools/live/get_web_livekit_component_detail.js +34 -0
  327. package/tools/live/get_web_livekit_component_detail.js.map +1 -0
  328. package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
  329. package/tools/room/get_web_room_uikit_integration.js.map +1 -0
  330. package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
  331. package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
  332. package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
  333. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
  334. package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
  335. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
  336. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
  337. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
  338. package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
  339. package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
  340. package/utils/generate-structured-result.js +61 -17
  341. package/utils/generate-structured-result.js.map +1 -1
  342. package/utils/report-cls-client.js +12 -1
  343. package/utils/report-cls-client.js.map +1 -1
  344. package/utils/report-es-client.js +1 -1
  345. package/resource/doc/chatuikit/android/workflow.md +0 -713
  346. package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1376
  347. package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -860
  348. package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1371
  349. package/resource/doc/chatuikit/flutter/workflow.md +0 -816
  350. package/resource/doc/chatuikit/iOS/workflow.md +0 -0
  351. package/resource/doc/chatuikit/react/components/conversation-list.md +0 -765
  352. package/resource/doc/chatuikit/react/components/search.md +0 -885
  353. package/resource/doc/chatuikit/react/create-group.md +0 -22
  354. package/resource/doc/chatuikit/react/init.md +0 -25
  355. package/resource/doc/chatuikit/react/workflow.md +0 -254
  356. package/resource/doc/chatuikit/uniapp-app/faq.md +0 -0
  357. package/resource/doc/chatuikit/uniapp-app/integration.md +0 -619
  358. package/resource/doc/chatuikit/uniapp-app/workflow.md +0 -576
  359. package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
  360. package/resource/doc/chatuikit/vue/components/tuikit.md +0 -110
  361. package/resource/doc/chatuikit/vue/create-group.md +0 -26
  362. package/resource/doc/chatuikit/vue/init.md +0 -35
  363. package/resource/doc/chatuikit/vue/workflow.md +0 -395
  364. package/resource/doc/livekit/live/android/workflow.md +0 -322
  365. package/resource/doc/livekit/live/flutter/workflow.md +0 -353
  366. package/resource/doc/livekit/live/ios/workflow.md +0 -352
  367. package/resource/doc/livekit/live/vue/components/barrage.md +0 -615
  368. package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -442
  369. package/resource/doc/livekit/live/vue/faq.md +0 -0
  370. package/resource/doc/livekit/live/vue/live-list-integration.md +0 -195
  371. package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -293
  372. package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -381
  373. package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -598
  374. package/resource/doc/livekit/live/vue/states/live-state.md +0 -2656
  375. package/resource/doc/livekit/live/vue/workflow.md +0 -219
  376. package/resource/doc/livekit/voice/android/workflow.md +0 -333
  377. package/resource/doc/livekit/voice/flutter/workflow.md +0 -359
  378. package/resource/doc/livekit/voice/ios/voice-integration.md +0 -853
  379. package/resource/doc/livekit/voice/ios/workflow.md +0 -358
  380. package/resource/doc/livekit/voice/uni-app/voice-integration.md +0 -613
  381. package/resource/doc/livekit/voice/uni-app/workflow.md +0 -369
  382. package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -334
  383. package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -434
  384. package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -685
  385. package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -712
  386. package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -284
  387. package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
  388. package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
  389. package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
  390. package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
  391. package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -879
  392. package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -668
  393. package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -456
  394. package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -332
  395. package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
  396. package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -328
  397. package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -505
  398. package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
  399. package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -676
  400. package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
  401. package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -820
  402. package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1065
  403. package/resource/doc/roomkit/vue/features/workflow.md +0 -553
  404. package/resource/doc/roomkit/vue/workflow.md +0 -733
  405. package/resource/doc/tuicallkit/android/workflow.md +0 -432
  406. package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -786
  407. package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -663
  408. package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -932
  409. package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -926
  410. package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -452
  411. package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -779
  412. package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -635
  413. package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
  414. package/resource/doc/tuicallkit/react/api.md +0 -1512
  415. package/resource/doc/tuicallkit/react/faq.md +0 -986
  416. package/resource/doc/tuicallkit/vue/api.md +0 -1512
  417. package/tools/call/get-native-call-integration.js +0 -43
  418. package/tools/call/get-native-call-integration.js.map +0 -1
  419. package/tools/call/get-web-call-api.js +0 -27
  420. package/tools/call/get-web-call-api.js.map +0 -1
  421. package/tools/call/get-web-call-integration.js.map +0 -1
  422. package/tools/chat/get-native-chat-feature-detail.js +0 -30
  423. package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
  424. package/tools/chat/get-native-chat-integration.js +0 -45
  425. package/tools/chat/get-native-chat-integration.js.map +0 -1
  426. package/tools/chat/get-web-chat-component-detail.js +0 -31
  427. package/tools/chat/get-web-chat-component-detail.js.map +0 -1
  428. package/tools/chat/get-web-chat-integration.js +0 -45
  429. package/tools/chat/get-web-chat-integration.js.map +0 -1
  430. package/tools/chat/get-web-chat-uikit-init.js +0 -28
  431. package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
  432. package/tools/chat/get-web-create-group-doc.js +0 -28
  433. package/tools/chat/get-web-create-group-doc.js.map +0 -1
  434. package/tools/common/get-faq.js +0 -91
  435. package/tools/common/get-faq.js.map +0 -1
  436. package/tools/common/get-usersig.js.map +0 -1
  437. package/tools/common/present-framework-choice.js +0 -16
  438. package/tools/common/present-framework-choice.js.map +0 -1
  439. package/tools/common/present-scenario-choice.js +0 -16
  440. package/tools/common/present-scenario-choice.js.map +0 -1
  441. package/tools/common/record-prompt.js +0 -55
  442. package/tools/common/record-prompt.js.map +0 -1
  443. package/tools/common/record-result.js +0 -60
  444. package/tools/common/record-result.js.map +0 -1
  445. package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
  446. package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
  447. package/tools/definitions/get_native_live_api_def.js +0 -22
  448. package/tools/definitions/get_native_live_api_def.js.map +0 -1
  449. package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -109
  450. package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
  451. package/tools/definitions/get_native_live_uikit_integration_def.js +0 -75
  452. package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
  453. package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
  454. package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
  455. package/tools/definitions/get_trtc_native_api_def.js +0 -17
  456. package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
  457. package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
  458. package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
  459. package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
  460. package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
  461. package/tools/definitions/get_web_create_group_doc_def.js +0 -18
  462. package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
  463. package/tools/definitions/get_web_live_state_detail_def.js +0 -19
  464. package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
  465. package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
  466. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
  467. package/tools/definitions/get_web_room_feature_detail_def.js +0 -92
  468. package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
  469. package/tools/definitions/present_scenario_choice_def.js +0 -53
  470. package/tools/definitions/present_scenario_choice_def.js.map +0 -1
  471. package/tools/definitions/record_prompt_def.js +0 -58
  472. package/tools/definitions/record_prompt_def.js.map +0 -1
  473. package/tools/definitions/record_result_def.js +0 -46
  474. package/tools/definitions/record_result_def.js.map +0 -1
  475. package/tools/live/get-native-live-uikit-integration.js +0 -177
  476. package/tools/live/get-native-live-uikit-integration.js.map +0 -1
  477. package/tools/live/get-web-live-component-detail.js +0 -31
  478. package/tools/live/get-web-live-component-detail.js.map +0 -1
  479. package/tools/live/get-web-live-state-detail.js +0 -31
  480. package/tools/live/get-web-live-state-detail.js.map +0 -1
  481. package/tools/live/get-web-live-uikit-integration.js +0 -52
  482. package/tools/live/get-web-live-uikit-integration.js.map +0 -1
  483. package/tools/live/get_native_live_uikit_extra_features.js +0 -105
  484. package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
  485. package/tools/live/get_native_live_uikit_interaction.js +0 -194
  486. package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
  487. package/tools/native_live/get-native-live-api.js +0 -31
  488. package/tools/native_live/get-native-live-api.js.map +0 -1
  489. package/tools/room/get-web-room-feature-detail.js.map +0 -1
  490. package/tools/room/get-web-room-integration.js.map +0 -1
  491. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
  492. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
  493. package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
  494. package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
  495. package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
  496. package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
  497. package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
  498. package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
  499. package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
  500. package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
  501. package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
  502. package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
  503. package/tools/trtc/get-trtc-native-api.js +0 -31
  504. package/tools/trtc/get-trtc-native-api.js.map +0 -1
  505. package/utils/handle-component-name.js +0 -33
  506. package/utils/handle-component-name.js.map +0 -1
  507. /package/resource/doc/{rtcengine/web → callkit/core-sdk}/.gitkeep +0 -0
  508. /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
  509. /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
  510. /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
@@ -1,733 +0,0 @@
1
- # Vue TUIRoomKit (Atomicx 版本) 代码生成工作流指令
2
-
3
- ## 📋 指令目的
4
-
5
- 为 Agent 提供实现 Vue TUIRoomKit (Atomicx 版本) **核心功能的代码生成蓝图**,并指导 Agent **优先使用工具实时获取的最新文档内容**,支持 PC 端和 H5 移动端 Vue3 音视频会议应用场景。
6
-
7
- ---
8
-
9
- ## 🛑 Agent 执行硬性限制 (Guardrails)
10
-
11
- Agent 在生成代码时必须严格遵守以下指令:
12
-
13
- ### 1. 文档驱动集成
14
- - 必须严格按照工具返回结果中的 `llm_code_generation_instructions_md` 步骤执行
15
- - **必须严格按照集成文档中的示例代码生成代码**,不得擅自修改代码结构和实现方式
16
- - 代码生成时应完全遵循集成文档提供的最佳实践和示例,确保代码的正确性和可运行性
17
-
18
- ### 2. npm 包接入方式(推荐)
19
- - TUIRoomKit (Atomicx 版本) 采用 **npm 包直接安装方式**,无需克隆 GitHub 仓库
20
- - 通过 npm/pnpm/yarn 安装依赖包即可快速集成
21
- - 如需深度定制 UI,可使用源码导出功能
22
-
23
- ### 3. 静默执行集成
24
- - 所有代码编写完成后,在最后一步自动安装依赖并启动项目
25
- - 启动成功后提示用户在浏览器中访问本地开发服务器地址
26
-
27
- ### 4. 零外部配置(测试阶段)
28
- - 禁止自动创建任何 `.env` 文件用于生产环境配置
29
- - SDKAppID 和 UserSig 等关键凭证必须从 MCP 工具获取或让用户手动配置
30
-
31
- ### 5. 鉴权凭据配置
32
- - 使用 `get_usersig` MCP 工具获取 `SDKAppID`、`userId` 和 `userSig`
33
- - **⚠️ 重要安全提示**:必须告知用户,客户端生成 UserSig 仅适合本地测试,正式生产环境必须在服务端生成 UserSig
34
-
35
- ### 6. Vue 3 组合式 API
36
- - 优先使用 `<script setup lang="ts">` 语法(注意启用 TypeScript)
37
- - 使用 Vue 3 Composition API(ref、reactive、computed、onMounted 等)
38
- - 正确引入和使用 TUIRoomKit 组件
39
-
40
- ### 7. 平台适配
41
- - 使用 `getPlatform()` 检测当前平台,PC 端使用 `ConferenceMainView`,H5 移动端使用 `ConferenceMainViewH5`
42
- - 两套组件已分别针对 PC 和 H5 进行 UI 适配,开箱即用
43
-
44
- ### 8. 会议组件加载前置要求(⚠️ 关键约束)
45
- - **调用 `conference.start()` 或 `conference.join()` 的页面,必须确保会议主视图组件已在模板中加载**
46
- - 在调用发起/加入会议 API 前,页面模板中必须包含以下组件结构:
47
-
48
- ```vue
49
- <template>
50
- <ConferenceMainView v-if="isPC"></ConferenceMainView>
51
- <ConferenceMainViewH5 v-else></ConferenceMainViewH5>
52
- </template>
53
- ```
54
-
55
- - 如果缺少会议主视图组件,`conference.start()` 和 `conference.join()` 将无法正常渲染会议界面
56
- - Agent 生成会议室页面代码时,必须先引入并渲染上述组件,再执行发起/加入会议的逻辑
57
-
58
- ---
59
-
60
- ## 📦 TUIRoomKit 版本与依赖自动化
61
-
62
- Agent 生成代码后,必须自动执行以下依赖链:
63
-
64
- ### 1. 核心依赖版本推荐
65
-
66
- ```json
67
- {
68
- "@tencentcloud/roomkit-web-vue3": "latest", // TUIRoomKit 主组件包(包含 ConferenceMainView、ConferenceMainViewH5、conference 等)
69
- "tuikit-atomicx-vue3": "latest", // TUIRoomKit 原子化组件库(包含所有 Hooks 和原子化 UI 组件)
70
- "@tencentcloud/uikit-base-component-vue3": "latest", // 基础 UI 组件库(UIKitProvider 等)
71
- "@tencentcloud/universal-api": "latest" // 跨平台 API 工具库(getPlatform 等)
72
- }
73
- ```
74
-
75
- **依赖说明**:
76
-
77
- | 依赖包 | 作用 | 是否必需 | 说明 |
78
- |-------|------|---------|------|
79
- | **@tencentcloud/roomkit-web-vue3** | TUIRoomKit 主组件包 | ✅ 必须 | 提供 `ConferenceMainView`(PC 端)、`ConferenceMainViewH5`(H5 端)和 `conference` 对象(发起/加入会议) |
80
- | **tuikit-atomicx-vue3** | 原子化组件库 | ✅ 必须 | 提供 `useLoginState`、`useRoomState` 等 Hooks,以及 `RoomLayoutTemplate` 等枚举类型 |
81
- | **@tencentcloud/uikit-base-component-vue3** | 基础 UI 组件库 | ✅ 必须 | 提供 `UIKitProvider` 组件,用于配置全局主题和语言 |
82
- | **@tencentcloud/universal-api** | 跨平台 API 工具库 | ✅ 必须 | 提供 `getPlatform()` 方法,用于检测当前运行平台(pc/mobile) |
83
-
84
- **安装命令**:
85
-
86
- ```bash
87
- # npm
88
- npm install @tencentcloud/roomkit-web-vue3@latest tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/universal-api
89
-
90
- # pnpm
91
- pnpm install @tencentcloud/roomkit-web-vue3@latest tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/universal-api
92
-
93
- # yarn
94
- yarn add @tencentcloud/roomkit-web-vue3@latest tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/universal-api
95
- ```
96
-
97
- ### 2. 开发环境依赖(TypeScript 和 SCSS)
98
-
99
- 如果用户项目尚未支持 TypeScript 和 SCSS,Agent 必须自动安装:
100
-
101
- ```json
102
- {
103
- "typescript": "latest", // TypeScript 编译器
104
- "sass": "latest" // SCSS 预处理器
105
- }
106
- ```
107
-
108
- ### 3. 构建环境补丁 (Vite/esbuild)
109
-
110
- 若检测到 Vite 项目,Agent 必须在 `package.json` 自动增加补丁配置以兼容 esbuild-wasm:
111
-
112
- ```json
113
- {
114
- "overrides": {
115
- "esbuild": "npm:esbuild-wasm@latest"
116
- },
117
- "resolutions": {
118
- "esbuild": "npm:esbuild-wasm@latest"
119
- }
120
- }
121
- ```
122
-
123
- ---
124
-
125
- ## 🎯 TUIRoomKit (Atomicx 版本) 核心组件说明
126
-
127
- ### 主要组件
128
-
129
- | 组件名称 | 说明 | 使用场景 |
130
- |---------|------|---------|
131
- | `ConferenceMainView` | PC 端会议主界面组件 | 桌面端多人会议 |
132
- | `ConferenceMainViewH5` | H5 移动端会议主界面组件 | 移动端多人会议 |
133
- | `conference` | 会议控制对象 | 发起会议(start)和加入会议(join) |
134
- | `UIKitProvider` | 全局 UI 配置组件 | 配置主题和语言 |
135
-
136
- ### 核心 Hooks
137
-
138
- | Hook 名称 | 来源 | 说明 |
139
- |---------|------|------|
140
- | `useLoginState` | `tuikit-atomicx-vue3/room` | 提供 `login`、`setSelfInfo` 等登录方法 |
141
- | `useRoomState` | `tuikit-atomicx-vue3/room` | 提供房间状态管理 |
142
- | `useDeviceState` | `tuikit-atomicx-vue3/room` | 提供设备状态管理 |
143
- | `useRoomEngine` | `tuikit-atomicx-vue3/room` | 获取 roomEngine 实例 |
144
-
145
- ### 平台检测
146
-
147
- ```typescript
148
- import { getPlatform } from '@tencentcloud/universal-api';
149
-
150
- const isPC = getPlatform() === 'pc';
151
- // isPC === true → 使用 ConferenceMainView
152
- // isPC === false → 使用 ConferenceMainViewH5
153
- ```
154
-
155
- ---
156
-
157
- ## 👥 默认测试用户说明
158
-
159
- 为方便开发调试,Agent 生成的代码**默认提供 3 个测试用户**:
160
-
161
- | 用户 ID | 用户名称 | 说明 |
162
- |---------|---------|------|
163
- | `user001` | 用户 001 | 测试用户 1(可作为主持人) |
164
- | `user002` | 用户 002 | 测试用户 2(可作为参会者) |
165
- | `user003` | 用户 003 | 测试用户 3(可作为参会者) |
166
-
167
- ### 应用登录流程
168
-
169
- Agent 生成的完整应用包含以下页面和流程:
170
-
171
- ```mermaid
172
- graph LR
173
- A[首页 - 用户选择登录] --> B{选择用户}
174
- B --> C[user001 登录]
175
- B --> D[user002 登录]
176
- B --> E[user003 登录]
177
- C --> F[会议入口页面]
178
- D --> F
179
- E --> F
180
- F --> G[创建会议]
181
- F --> H[加入会议]
182
- G --> I[进入会议室]
183
- H --> I
184
- ```
185
-
186
- ### 首页功能要求
187
-
188
- Agent 生成的首页(Home 页面)必须包含以下功能:
189
-
190
- 1. **用户选择界面**:
191
- - 提供下拉框或按钮组,让用户选择要登录的测试用户(user001/user002/user003)
192
- - 显示当前选中用户的 ID 和名称
193
-
194
- 2. **登录按钮**:
195
- - 点击登录按钮后,调用 `login()` 和 `setSelfInfo()` 完成用户登录
196
- - 登录过程中显示加载状态
197
-
198
- 3. **登录成功后跳转**:
199
- - 登录成功后自动跳转到会议入口页面
200
- - 会议入口页面提供「创建会议」和「加入会议」两个入口
201
-
202
- ### 会议入口页面功能要求
203
-
204
- 登录成功后的会议入口页面必须包含:
205
-
206
- 1. **显示当前登录用户信息**:展示已登录的用户 ID 和名称
207
- 2. **创建会议功能**:
208
- - 输入会议 ID(可选,不输入则自动生成)
209
- - 输入会议名称(可选)
210
- - 点击「创建会议」按钮调用 `conference.start()`
211
- 3. **加入会议功能**:
212
- - 输入要加入的会议 ID(必填)
213
- - 点击「加入会议」按钮调用 `conference.join()`
214
-
215
- ### 代码实现示例
216
-
217
- #### 测试用户配置
218
-
219
- Agent 在生成代码时,需要为每个测试用户调用 `get_usersig` MCP 工具获取对应的 userSig,并**预先填入**代码中:
220
-
221
- ```typescript
222
- // ⚠️ Agent 生成代码时,需要调用 get_usersig 工具 3 次,分别为 user001、user002、user003 获取 userSig
223
- // 然后将获取到的 SDKAppID 和每个用户的 userSig 填入下方配置
224
-
225
- const SDKAppID = 0; // Agent 填入从 get_usersig 获取的 SDKAppID
226
-
227
- // 测试用户列表(包含预生成的 userSig)
228
- const TEST_USERS = [
229
- { userId: 'user001', userName: '用户 001', userSig: '' }, // Agent 填入 user001 的 userSig
230
- { userId: 'user002', userName: '用户 002', userSig: '' }, // Agent 填入 user002 的 userSig
231
- { userId: 'user003', userName: '用户 003', userSig: '' }, // Agent 填入 user003 的 userSig
232
- ];
233
- ```
234
-
235
- #### 首页用户选择组件示例
236
-
237
- ```vue
238
- <template>
239
- <div class="login-container">
240
- <h1>TUIRoomKit 音视频会议</h1>
241
- <div class="user-select">
242
- <label>选择测试用户:</label>
243
- <select v-model="selectedUserId">
244
- <option v-for="user in TEST_USERS" :key="user.userId" :value="user.userId">
245
- {{ user.userName }} ({{ user.userId }})
246
- </option>
247
- </select>
248
- </div>
249
- <button @click="handleLogin" :disabled="isLogging">
250
- {{ isLogging ? '登录中...' : '登录' }}
251
- </button>
252
- </div>
253
- </template>
254
-
255
- <script setup lang="ts">
256
- import { ref } from 'vue';
257
- import { useRouter } from 'vue-router';
258
- import { useLoginState } from 'tuikit-atomicx-vue3/room';
259
-
260
- // ⚠️ 以下凭证由 Agent 在代码生成时调用 get_usersig 工具获取并填入
261
- const SDKAppID = 0; // Agent 填入实际的 SDKAppID
262
-
263
- const TEST_USERS = [
264
- { userId: 'user001', userName: '用户 001', userSig: '' }, // Agent 填入 user001 的 userSig
265
- { userId: 'user002', userName: '用户 002', userSig: '' }, // Agent 填入 user002 的 userSig
266
- { userId: 'user003', userName: '用户 003', userSig: '' }, // Agent 填入 user003 的 userSig
267
- ];
268
-
269
- const router = useRouter();
270
- const { login, setSelfInfo } = useLoginState();
271
-
272
- const selectedUserId = ref('user001');
273
- const isLogging = ref(false);
274
-
275
- const handleLogin = async () => {
276
- const user = TEST_USERS.find(u => u.userId === selectedUserId.value);
277
- if (!user) return;
278
-
279
- isLogging.value = true;
280
- try {
281
- await login({
282
- userId: user.userId,
283
- userSig: user.userSig, // 使用预填入的 userSig
284
- sdkAppId: SDKAppID,
285
- });
286
- await setSelfInfo({
287
- userName: user.userName,
288
- avatarUrl: '',
289
- });
290
- // 登录成功,跳转到会议入口页面
291
- router.push('/conference-entry');
292
- } catch (error) {
293
- console.error('登录失败:', error);
294
- } finally {
295
- isLogging.value = false;
296
- }
297
- };
298
- </script>
299
- ```
300
-
301
- ---
302
-
303
- ## 🛠️ 集成步骤详解
304
-
305
- ### 步骤 1:安装项目依赖
306
-
307
- ```bash
308
- # npm
309
- npm install @tencentcloud/roomkit-web-vue3@latest tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/universal-api
310
-
311
- # pnpm
312
- pnpm install @tencentcloud/roomkit-web-vue3@latest tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/universal-api
313
-
314
- # yarn
315
- yarn add @tencentcloud/roomkit-web-vue3@latest tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/universal-api
316
- ```
317
-
318
- ---
319
-
320
- ### 步骤 2:创建会议页面组件(⚠️ 关键步骤)
321
-
322
- 创建会议页面组件,**必须在模板中先加载会议主视图组件**,然后再调用 `conference.start()` 或 `conference.join()`:
323
-
324
- ```vue
325
- <template>
326
- <!-- ⚠️ 关键:必须先在模板中加载会议主视图组件 -->
327
- <ConferenceMainView v-if="isPC"></ConferenceMainView>
328
- <ConferenceMainViewH5 v-else></ConferenceMainViewH5>
329
- </template>
330
-
331
- <script setup lang="ts">
332
- import { ref, onMounted } from 'vue';
333
- import { useRoute } from 'vue-router';
334
- import { ConferenceMainView, ConferenceMainViewH5, conference } from '@tencentcloud/roomkit-web-vue3';
335
- import { getPlatform } from '@tencentcloud/universal-api';
336
-
337
- const route = useRoute();
338
- const isPC = ref(getPlatform() === 'pc');
339
-
340
- // 从路由参数获取会议信息
341
- const roomId = route.query.roomId as string;
342
- const roomName = route.query.roomName as string;
343
- const action = route.query.action as 'start' | 'join'; // 'start' 或 'join'
344
-
345
- onMounted(async () => {
346
- // ⚠️ 确保组件已挂载(模板已渲染)后再调用 conference API
347
- if (action === 'start') {
348
- // 发起新会议
349
- await conference.start({
350
- roomId: roomId,
351
- options: {
352
- roomName: roomName || '我的会议',
353
- },
354
- });
355
- } else if (action === 'join') {
356
- // 加入已有会议
357
- await conference.join({
358
- roomId: roomId,
359
- });
360
- }
361
- });
362
- </script>
363
- ```
364
-
365
- **⚠️ 强制约束说明**:
366
- - `conference.start()` 和 `conference.join()` **必须在会议主视图组件加载后调用**
367
- - 模板中必须包含 `<ConferenceMainView>` 和 `<ConferenceMainViewH5>` 组件
368
- - 建议在 `onMounted` 生命周期中调用,确保组件已挂载完成
369
- - 如果模板中缺少会议主视图组件,调用 API 后会议界面将无法正常渲染
370
-
371
- ---
372
-
373
- ### 步骤 3:配置 App.vue 文件
374
-
375
- 将以下内容合并到项目的 `App.vue` 文件中:
376
-
377
- **关键配置要点**:
378
- - 配置全局 `UIKitProvider` 组件(设置主题和语言)
379
- - 配置全局样式,确保会议界面全屏显示
380
- - **注意**:用户登录逻辑在首页组件中实现(见「默认测试用户说明」章节)
381
-
382
- ```vue
383
- <template>
384
- <!-- Step 1: 配置全局 UIKitProvider -->
385
- <UIKitProvider theme="light" language="zh-CN">
386
- <!-- 您的业务组件(首页 → 会议入口 → 会议室) -->
387
- <router-view />
388
- </UIKitProvider>
389
- </template>
390
-
391
- <script setup lang="ts">
392
- import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
393
- </script>
394
-
395
- <!-- Step 2: 配置全局样式 -->
396
- <style>
397
- html, body {
398
- padding: 0 !important;
399
- margin: 0 !important;
400
- }
401
-
402
- #app {
403
- width: 100% !important;
404
- height: 100% !important;
405
- padding: 0 !important;
406
- margin: 0 !important;
407
- max-width: 100% !important;
408
- max-height: 100% !important;
409
- text-align: left !important;
410
- overflow: hidden;
411
- }
412
- </style>
413
- ```
414
-
415
- **Agent 执行要求**:
416
- - ⚠️ 用户登录逻辑在首页组件中实现,而非 App.vue
417
- - 必须调用 `get_usersig` MCP 工具为每个测试用户获取 SDKAppID、userId、userSig
418
-
419
- ---
420
-
421
- ### 步骤 4:发起新会议(完整示例)
422
-
423
- 从会议入口页面跳转到会议室页面并发起会议:
424
-
425
- ```typescript
426
- // 会议入口页面中的发起会议逻辑
427
- import { useRouter } from 'vue-router';
428
-
429
- const router = useRouter();
430
-
431
- const startConference = () => {
432
- // 跳转到会议室页面,传递会议参数
433
- router.push({
434
- path: '/room',
435
- query: {
436
- action: 'start',
437
- roomId: '123456', // 会议 ID
438
- roomName: '我的临时会议', // 会议名称
439
- },
440
- });
441
- };
442
- ```
443
-
444
- **⚠️ 注意**:实际的 `conference.start()` 调用在会议室页面组件(步骤 2)的 `onMounted` 中执行,确保会议主视图组件已加载。
445
-
446
- ---
447
-
448
- ### 步骤 5:加入已有会议(完整示例)
449
-
450
- 从会议入口页面跳转到会议室页面并加入会议:
451
-
452
- ```typescript
453
- // 会议入口页面中的加入会议逻辑
454
- import { useRouter } from 'vue-router';
455
-
456
- const router = useRouter();
457
-
458
- const joinConference = () => {
459
- // 跳转到会议室页面,传递会议参数
460
- router.push({
461
- path: '/room',
462
- query: {
463
- action: 'join',
464
- roomId: '123456', // 要加入的会议 ID
465
- },
466
- });
467
- };
468
- ```
469
-
470
- **⚠️ 注意**:实际的 `conference.join()` 调用在会议室页面组件(步骤 2)的 `onMounted` 中执行,确保会议主视图组件已加载。
471
-
472
- ---
473
-
474
- ## 🎨 UI 自定义功能
475
-
476
- ### 1. 主题及语言配置
477
-
478
- 通过配置 `UIKitProvider` 的入参修改主题及语言:
479
-
480
- | UIKitProvider 参数 | 可选值 | 默认值 |
481
- |-------------------|--------|--------|
482
- | theme | "light" \| "dark" | "light" |
483
- | language | "zh-CN" \| "en-US" | "en-US" |
484
-
485
- ```typescript
486
- <UIKitProvider theme="dark" language="en-US">
487
- <router-view />
488
- </UIKitProvider>
489
- ```
490
-
491
- ---
492
-
493
- ### 2. 源码导出(深度定制)
494
-
495
- 如需深度定制 TUIRoomKit 界面,可使用源码导出功能:
496
-
497
- ```bash
498
- # 执行源码导出脚本,默认拷贝路径为 ./src/components/RoomKit
499
- node ./node_modules/@tencentcloud/roomkit-web-vue3/scripts/eject.js
500
- ```
501
-
502
- 导出后修改组件引用路径:
503
-
504
- ```typescript
505
- // 修改前:从 npm 包引入
506
- - import { ConferenceMainView, conference } from '@tencentcloud/roomkit-web-vue3';
507
-
508
- // 修改后:从本地源码引入
509
- + import { ConferenceMainView, ConferenceMainViewH5, conference } from './components/RoomKit/index.ts';
510
- ```
511
-
512
- ---
513
-
514
- ### 3. 自定义房间流布局
515
-
516
- TUIRoomKit 支持三种流布局:
517
-
518
- | 布局类型 | 枚举值 | 说明 |
519
- |---------|--------|------|
520
- | 九宫格布局 | `RoomLayoutTemplate.GridLayout` | 默认布局 |
521
- | 侧边栏布局 | `RoomLayoutTemplate.SidebarLayout` | 侧边栏布局 |
522
- | 顶部栏布局 | `RoomLayoutTemplate.CinemaLayout` | 顶部栏布局 |
523
-
524
- 导出源码后,在 `RoomKit/views/ConferenceMainView/index.vue` 中修改:
525
-
526
- ```typescript
527
- import { RoomLayoutTemplate } from 'tuikit-atomicx-vue3/room';
528
-
529
- // 修改默认布局为侧边栏布局
530
- const participantViewLayout = ref(RoomLayoutTemplate.SidebarLayout);
531
-
532
- function handleLayoutUpdate(layout: RoomLayoutTemplate) {
533
- participantViewLayout.value = layout;
534
- }
535
- ```
536
-
537
- ---
538
-
539
- ### 4. 自定义视频流挂件
540
-
541
- 导出源码后,修改以下组件自定义视频流挂件:
542
-
543
- ```
544
- src/components/RoomKit/components/RoomLayoutView/ParticipantViewUI/ParticipantViewUI.vue
545
- ```
546
-
547
- ---
548
-
549
- ### 5. 配置用户联系人列表
550
-
551
- TUIRoomKit 预定会议和会中呼叫的用户选择列表默认展示用户关系链。批量导入步骤:
552
-
553
- 1. 使用 [账号管理 > 导入多个账号](https://cloud.tencent.com/document/product/269/4919) REST API 批量导入用户账号
554
- 2. 使用 [好友管理 > 导入好友](https://cloud.tencent.com/document/product/269/8301) REST API 批量导入用户关系链
555
-
556
- ---
557
-
558
- ## 🔄 完整自动化流程总结
559
-
560
- ```mermaid
561
- graph TD
562
- A[接收用户需求] --> B[安装 npm 依赖包]
563
- B --> C{检测 TypeScript 和 SCSS 支持}
564
- C -->|未安装| D[安装 typescript 和 sass]
565
- C -->|已安装| E[跳过]
566
- D --> F[创建首页 - 用户选择登录界面]
567
- E --> F
568
- F --> G[配置 3 个测试用户: user001/user002/user003]
569
- G --> H[调用 get_usersig 为每个用户获取凭证]
570
- H --> I[创建会议入口页面 - 创建/加入会议]
571
- I --> J[创建会议室页面组件]
572
- J --> K[配置 App.vue: UIKitProvider + 全局样式]
573
- K --> L{用户需要深度定制 UI?}
574
- L -->|是| M[执行源码导出脚本]
575
- L -->|否| N[使用默认配置]
576
- M --> O[提供 UI 自定义方案: 主题/布局/挂件]
577
- N --> P[record_result 记录集成结果]
578
- O --> P
579
- P --> Q[自动启动开发服务器: npm run dev]
580
- Q --> R[提示用户在浏览器中访问并选择用户登录]
581
- ```
582
-
583
- ---
584
-
585
- ## ✍️ Agent 代码生成示例指令 (Prompts)
586
-
587
- **基础集成**:
588
- > "按照 TUIRoomKit (Atomicx 版本) npm 包接入方式,为我生成一个 Vue 3 音视频会议应用。首页提供 3 个测试用户(user001/user002/user003)选择界面,用户选择后点击登录,登录成功后跳转到会议入口页面,提供创建会议和加入会议功能。使用 get_usersig 工具获取每个测试用户的鉴权凭证。启动后提示我在浏览器中访问调试地址。**请务必告知我:当前生成的代码仅适用于本地测试,正式生产环境必须在服务端生成 UserSig。**"
589
-
590
- **H5 移动端会议**:
591
- > "按照 TUIRoomKit (Atomicx 版本) 集成,生成一个同时支持 PC 端和 H5 移动端的 Vue 3 会议应用。首页提供测试用户选择和登录功能,使用 getPlatform() 检测平台,PC 端使用 ConferenceMainView,H5 端使用 ConferenceMainViewH5。"
592
-
593
- **深度定制 UI**:
594
- > "按照 TUIRoomKit (Atomicx 版本) 集成,生成一个 Vue 3 会议应用。包含用户选择登录流程,需要执行源码导出,自定义视频流布局为侧边栏布局,并自定义视频流挂件样式。"
595
-
596
- ---
597
-
598
- ## 📝 关键要点总结
599
-
600
- | 类别 | 要求 |
601
- |------|------|
602
- | **框架版本** | Vue 3.4.21 及以上版本 |
603
- | **平台支持** | PC 端 + H5 移动端(响应式适配,开箱即用) |
604
- | **接入方式** | npm 包直接安装(推荐);如需深度定制可使用源码导出 |
605
- | **文档优先** | 严格遵循工具返回的最新文档指令 |
606
- | **静默集成** | 代码编写完成后自动安装依赖并启动开发服务器 |
607
- | **凭证获取** | 调用 `get_usersig` MCP 工具获取 SDKAppID、userId、userSig |
608
- | **安全提示** | ⚠️ 必须告知用户:客户端生成 UserSig 仅适合测试,生产环境必须在服务端生成 |
609
- | **多语言** | 支持中文(zh-CN)和英文(en-US) |
610
- | **UI 自定义** | 支持主题、布局、视频流挂件等自定义(需源码导出) |
611
-
612
- ---
613
-
614
- ## 🎯 Agent 执行检查清单
615
-
616
- ### 项目初始化
617
- - [ ] 已安装核心依赖:`@tencentcloud/roomkit-web-vue3`、`tuikit-atomicx-vue3`、`@tencentcloud/uikit-base-component-vue3`、`@tencentcloud/universal-api`
618
- - [ ] 已检测并安装 TypeScript 和 SCSS 开发依赖(如果用户项目未安装)
619
-
620
- ### 代码生成
621
- - [ ] 已创建会议页面组件,使用 `getPlatform()` 检测平台
622
- - [ ] 已配置 `App.vue`:UIKitProvider + 全局样式
623
- - [ ] 组件使用了 `<script setup lang="ts">` 语法
624
-
625
- ### 测试用户与登录流程
626
- - [ ] 🔴 已配置 3 个默认测试用户:user001、user002、user003
627
- - [ ] 已创建首页用户选择界面(下拉框或按钮组选择测试用户)
628
- - [ ] 已实现登录按钮和登录加载状态
629
- - [ ] 登录成功后跳转到会议入口页面
630
-
631
- ### 会议入口页面
632
- - [ ] 已显示当前登录用户信息
633
- - [ ] 已实现「创建会议」功能(调用 `conference.start()`)
634
- - [ ] 已实现「加入会议」功能(调用 `conference.join()`)
635
-
636
- ### 凭证与登录
637
- - [ ] 🔴 已调用 `get_usersig` MCP 工具为每个测试用户获取 SDKAppID、userId、userSig
638
- - [ ] 已在首页实现 `login()` 和 `setSelfInfo()` 登录逻辑
639
- - [ ] ⚠️ **已告知用户**:当前生成的代码仅适用于本地测试,正式生产环境必须在服务端生成 UserSig
640
-
641
- ### UI 配置
642
- - [ ] 已根据用户需求配置主题(light/dark)和语言(zh-CN/en-US)
643
- - [ ] 如果用户需要深度定制,已执行源码导出脚本
644
-
645
- ### 最终检查
646
- - [ ] 已调用 `record_result` 记录集成结果
647
- - [ ] 已自动安装依赖(npm install)
648
- - [ ] 已自动启动开发服务器(npm run dev)
649
- - [ ] 已提示用户在浏览器中访问本地开发服务器地址
650
- - [ ] 项目可以正常运行,无报错
651
-
652
- ---
653
-
654
- ## 🔗 相关工具参考
655
-
656
- ### 必须使用的工具
657
-
658
- #### `get_usersig` - 获取鉴权凭证
659
- **用途**:从 MCP 环境变量获取腾讯云应用凭证
660
- - `SDKAppID`: 应用标识
661
- - `userId`: 用户 ID
662
- - `userSig`: 用户签名
663
-
664
- **使用约束**:
665
- - ✅ 必须调用此工具获取凭证
666
- - ⚠️ 必须告知用户:客户端生成 UserSig 仅适合测试,生产环境必须在服务端生成
667
-
668
- #### `record_result` - 记录集成结果
669
- **用途**:记录集成过程和结果,用于统计和分析
670
-
671
- **调用时机**:在完成所有集成步骤并成功启动项目后调用
672
-
673
- ---
674
-
675
- ## 📚 相关资源链接
676
-
677
- - **TUIRoomKit GitHub 仓库**:https://github.com/Tencent-RTC/TUIRoomKit
678
- - **腾讯云 TRTC 控制台**:https://console.cloud.tencent.com/trtc
679
- - **正式运行阶段如何计算 UserSig**:https://cloud.tencent.com/document/product/647/17275#formal
680
- - **URL 域名及协议限制说明**:https://cloud.tencent.com/document/product/647/17249
681
- - **应对防火墙受限(内网代理)**:https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-34-advanced-proxy.html
682
-
683
- ---
684
-
685
- ## ❓ 常见问题
686
-
687
- ### TUIRoomKit 在本地开发时正常,但部署到线上后无法采集摄像头/麦克风?
688
-
689
- **原因分析**:浏览器出于安全和隐私保护考虑,对音视频设备采集有严格限制。只有在安全环境(https://、localhost、file://)下才允许采集。
690
-
691
- **解决方案**:必须使用 HTTPS 协议部署网页,并确保具备有效的安全证书。
692
-
693
- ### TUIRoomKit 是否支持使用 iframe 集成?
694
-
695
- 支持。使用 iframe 集成时,需要配置 allow 属性授予必要权限:
696
-
697
- ```html
698
- <iframe allow="microphone; camera; display-capture; display; fullscreen;">
699
- ```
700
-
701
- ### TUIRoomKit 是否支持设置内网代理?
702
-
703
- 支持。请在进房前设置内网代理参数:
704
-
705
- ```typescript
706
- import TUIRoomEngine from '@tencentcloud/tuiroom-engine-js';
707
- import { useRoomEngine } from 'tuikit-atomicx-vue3/room';
708
-
709
- const { roomEngine } = useRoomEngine();
710
-
711
- TUIRoomEngine.once('ready', () => {
712
- const trtcCloud = roomEngine.instance?.getTRTCCloud();
713
- trtcCloud.callExperimentalAPI(JSON.stringify({
714
- api: 'setNetworkProxy',
715
- params: {
716
- websocketProxy: "wss://proxy.example.com/ws/",
717
- turnServer: [{
718
- url: '14.3.3.3:3478',
719
- username: 'turn',
720
- credential: 'turn',
721
- }],
722
- iceTransportPolicy: 'relay',
723
- },
724
- }));
725
- });
726
- ```
727
-
728
- ---
729
-
730
- **适用框架**: Vue 3.4.21+
731
- **平台支持**: PC 端 + H5 移动端
732
- **TUIRoomKit 版本**: @tencentcloud/roomkit-web-vue3 (Atomicx 版本)
733
- **构建工具**: Vite (推荐)