@tencent-rtc/mcp 1.3.9 → 1.4.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 (435) hide show
  1. package/package.json +2 -2
  2. package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/android-faq.md} +10 -22
  3. package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/flutter-faq.md} +10 -22
  4. package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/ios-faq.md} +10 -22
  5. package/resource/doc/callkit/preset/android/api.md +296 -0
  6. package/resource/doc/{tuicallkit → callkit/preset}/android/integration.md +53 -365
  7. package/resource/doc/callkit/preset/flutter/api.md +410 -0
  8. package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +35 -97
  9. package/resource/doc/callkit/preset/ios/api.md +80 -0
  10. package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +37 -118
  11. package/resource/doc/callkit/preset/react/api.md +501 -0
  12. package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +5 -20
  13. package/resource/doc/callkit/preset/vue/api.md +501 -0
  14. package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +4 -19
  15. package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -38
  16. package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
  17. package/resource/doc/{chatuikit → chatkit}/android/integration.md +28 -121
  18. package/resource/doc/chatkit/faq/android_sdk/client-api.md +281 -0
  19. package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +0 -1
  20. package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -1
  21. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +199 -0
  22. package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
  23. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +235 -0
  24. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +3 -3
  25. package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
  26. package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +18 -87
  27. package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -38
  28. package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
  29. package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +47 -165
  30. package/resource/doc/{chatuikit → chatkit}/react/components/avatar.md +0 -33
  31. package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +8 -49
  32. package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +6 -35
  33. package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +0 -6
  34. package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -11
  35. package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +96 -502
  36. package/resource/doc/chatkit/react/components/conversation-actions.md +174 -0
  37. package/resource/doc/chatkit/react/components/conversation-list.md +333 -0
  38. package/resource/doc/chatkit/react/components/conversation-preview.md +118 -0
  39. package/resource/doc/chatkit/react/components/conversation-search.md +60 -0
  40. package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -337
  41. package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +20 -212
  42. package/resource/doc/chatkit/react/components/search.md +243 -0
  43. package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +1 -47
  44. package/resource/doc/{chatuikit → chatkit}/react/integration.md +21 -81
  45. package/resource/doc/{chatuikit → chatkit}/vue/components/avatar.md +0 -33
  46. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -48
  47. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +3 -5
  48. package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +0 -5
  49. package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -15
  50. package/resource/doc/chatkit/vue/components/contact-list.md +271 -0
  51. package/resource/doc/chatkit/vue/components/conversation-actions.md +228 -0
  52. package/resource/doc/{chatuikit → chatkit}/vue/components/conversation-list.md +42 -492
  53. package/resource/doc/chatkit/vue/components/conversation-preview.md +213 -0
  54. package/resource/doc/chatkit/vue/components/conversation-search.md +50 -0
  55. package/resource/doc/{chatuikit → chatkit}/vue/components/message-input.md +2 -223
  56. package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -252
  57. package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
  58. package/resource/doc/{chatuikit → chatkit}/vue/components/tuikit.md +7 -21
  59. package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +3 -62
  60. package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
  61. package/resource/doc/{chatuikit → chatkit}/vue/integration.md +22 -23
  62. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +18 -89
  63. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audio-effect.md +34 -192
  64. package/resource/doc/livekit/{live → core-sdk/live}/android/live-barrage.md +28 -141
  65. package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +20 -112
  66. package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +59 -193
  67. package/resource/doc/livekit/{live → core-sdk/live}/android/live-gift.md +75 -455
  68. package/resource/doc/livekit/{live → core-sdk/live}/android/live-host-interaction.md +94 -344
  69. package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +107 -515
  70. package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +33 -173
  71. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +14 -93
  72. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -179
  73. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +19 -107
  74. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -166
  75. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -163
  76. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +69 -443
  77. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
  78. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-integration.md +107 -492
  79. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +23 -165
  80. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +35 -111
  81. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +35 -193
  82. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +31 -144
  83. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +24 -116
  84. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +37 -171
  85. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +79 -459
  86. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +69 -320
  87. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +85 -502
  88. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +32 -169
  89. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audience-list.md +18 -89
  90. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audio-effect.md +34 -192
  91. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-barrage.md +28 -141
  92. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-co-guest-interaction.md +50 -259
  93. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-gift.md +75 -455
  94. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-host-interaction.md +51 -265
  95. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-integration.md +61 -427
  96. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-room-list.md +33 -173
  97. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-co-guest-interaction.md +44 -203
  98. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-integration.md +56 -416
  99. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audience-list.md +35 -111
  100. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audio-effect.md +35 -193
  101. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-barrage.md +31 -144
  102. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-co-guest-interaction.md +43 -252
  103. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-gift.md +79 -459
  104. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-host-interaction.md +46 -264
  105. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-integration.md +61 -445
  106. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-room-list.md +32 -169
  107. package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -2
  108. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +780 -0
  109. package/resource/doc/livekit/preset/live/vue/components/barrage.md +291 -0
  110. package/resource/doc/livekit/{live → preset/live}/vue/components/co-guest-panel.md +10 -49
  111. package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +26 -144
  112. package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +12 -75
  113. package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +36 -227
  114. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +215 -0
  115. package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
  116. package/resource/doc/livekit/preset/live/vue/live-list-integration.md +241 -0
  117. package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +299 -0
  118. package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +300 -0
  119. package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +743 -0
  120. package/resource/doc/roomkit/vue/faq.md +1 -0
  121. package/resource/doc/roomkit/vue/features/call-user-to-room.md +17 -53
  122. package/resource/doc/roomkit/vue/features/device-detection.md +30 -48
  123. package/resource/doc/roomkit/vue/features/device-state.md +24 -44
  124. package/resource/doc/roomkit/vue/features/free-beauty-panel.md +13 -36
  125. package/resource/doc/roomkit/vue/features/room-chat.md +31 -89
  126. package/resource/doc/roomkit/vue/features/room-participant-state.md +28 -50
  127. package/resource/doc/roomkit/vue/features/room-state.md +25 -34
  128. package/resource/doc/roomkit/vue/features/room-view.md +30 -125
  129. package/resource/doc/roomkit/vue/features/schedule-room.md +9 -40
  130. package/resource/doc/roomkit/vue/features/screen-share.md +22 -90
  131. package/resource/doc/roomkit/vue/features/virtual-background.md +13 -29
  132. package/resource/doc/roomkit/vue/integration.md +21 -76
  133. package/resource/doc/rtcengine/faq/common/error_code.md +1 -0
  134. package/resource/doc/rtcengine/faq/web/web.md +14 -24
  135. package/resource/doc/rtcengine/web/api.md +1 -3
  136. package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +3 -10
  137. package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +1 -5
  138. package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +1 -2
  139. package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -4
  140. package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +3 -5
  141. package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +1 -7
  142. package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +0 -2
  143. package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -8
  144. package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +11 -11
  145. package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +12 -88
  146. package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -5
  147. package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +30 -37
  148. package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +13 -90
  149. package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -2
  150. package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +1 -2
  151. package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +19 -19
  152. package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +1 -1
  153. package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +4 -5
  154. package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
  155. package/resource/doc/trtc/C++/ITRTCCloud.md +686 -2835
  156. package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
  157. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +202 -1022
  158. package/resource/doc/trtc/C++/ITXDeviceManager.md +126 -767
  159. package/resource/doc/trtc/C++/TRTCCloudCallback.md +579 -2147
  160. package/resource/doc/trtc/C++/TRTCTypeDef.md +703 -3378
  161. package/resource/doc/trtc/C++/TXLiteAVCode.md +116 -908
  162. package/resource/doc/trtc/android/TRTCCloud.md +606 -2573
  163. package/resource/doc/trtc/android/TRTCCloudDef.md +752 -3640
  164. package/resource/doc/trtc/android/TRTCCloudListener.md +581 -2008
  165. package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
  166. package/resource/doc/trtc/android/TXAudioEffectManager.md +202 -1022
  167. package/resource/doc/trtc/android/TXBeautyManager.md +127 -704
  168. package/resource/doc/trtc/android/TXDeviceManager.md +51 -318
  169. package/resource/doc/trtc/android/TXLiteAVCode.md +114 -892
  170. package/resource/doc/trtc/iOS/TRTCCloud.md +694 -2904
  171. package/resource/doc/trtc/iOS/TRTCCloudDef.md +726 -3498
  172. package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +543 -2028
  173. package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
  174. package/resource/doc/trtc/iOS/TXAudioEffectManager.md +174 -877
  175. package/resource/doc/trtc/iOS/TXBeautyManager.md +128 -710
  176. package/resource/doc/trtc/iOS/TXDeviceManager.md +129 -772
  177. package/resource/doc/trtc/iOS/TXLiteAVCode.md +117 -915
  178. package/server.js +1 -5
  179. package/server.js.map +1 -1
  180. package/tools/call/get_callkit_api.js +32 -0
  181. package/tools/call/get_callkit_api.js.map +1 -0
  182. package/tools/call/get_native_call_uikit_integration.js +34 -0
  183. package/tools/call/get_native_call_uikit_integration.js.map +1 -0
  184. package/tools/call/{get-web-call-integration.js → get_web_call_uikit_integration.js} +13 -8
  185. package/tools/call/get_web_call_uikit_integration.js.map +1 -0
  186. package/tools/chat/get_native_chat_uikit_feature_detail.js +34 -0
  187. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +1 -0
  188. package/tools/chat/get_native_chat_uikit_integration.js +45 -0
  189. package/tools/chat/get_native_chat_uikit_integration.js.map +1 -0
  190. package/tools/chat/get_web_chat_uikit_component_detail.js +34 -0
  191. package/tools/chat/get_web_chat_uikit_component_detail.js.map +1 -0
  192. package/tools/chat/get_web_chat_uikit_integration.js +45 -0
  193. package/tools/chat/get_web_chat_uikit_integration.js.map +1 -0
  194. package/tools/common/get_faq.js +265 -0
  195. package/tools/common/get_faq.js.map +1 -0
  196. package/tools/common/{get-usersig.js → get_usersig.js} +6 -3
  197. package/tools/common/get_usersig.js.map +1 -0
  198. package/tools/common/present_framework_choice.js +63 -0
  199. package/tools/common/present_framework_choice.js.map +1 -0
  200. package/tools/common/record_skill_session.js +58 -0
  201. package/tools/common/record_skill_session.js.map +1 -0
  202. package/tools/definitions/get_callkit_api_def.js +29 -0
  203. package/tools/definitions/get_callkit_api_def.js.map +1 -0
  204. package/tools/definitions/get_faq_def.js +17 -18
  205. package/tools/definitions/get_faq_def.js.map +1 -1
  206. package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
  207. package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
  208. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
  209. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
  210. package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -41
  211. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
  212. package/tools/definitions/get_native_livekit_core_features_def.js +34 -0
  213. package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
  214. package/tools/definitions/get_native_livekit_core_integration_def.js +34 -0
  215. package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
  216. package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
  217. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
  218. package/tools/definitions/get_usersig_def.js +17 -22
  219. package/tools/definitions/get_usersig_def.js.map +1 -1
  220. package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
  221. package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
  222. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
  223. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
  224. package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
  225. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
  226. package/tools/definitions/get_web_live_uikit_integration_def.js +15 -18
  227. package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
  228. package/tools/definitions/get_web_livekit_api_def.js +30 -0
  229. package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
  230. package/tools/definitions/get_web_livekit_component_detail_def.js +32 -0
  231. package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
  232. package/tools/definitions/get_web_room_uikit_integration_def.js +15 -46
  233. package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
  234. package/tools/definitions/get_web_roomkit_feature_detail_def.js +31 -0
  235. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
  236. package/tools/definitions/get_web_trtc_sdk_api_def.js +27 -0
  237. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
  238. package/tools/definitions/get_web_trtc_sdk_integration_def.js +27 -0
  239. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
  240. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +27 -0
  241. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
  242. package/tools/definitions/present_framework_choice_def.js +24 -12
  243. package/tools/definitions/present_framework_choice_def.js.map +1 -1
  244. package/tools/definitions/record_skill_session_def.js +31 -0
  245. package/tools/definitions/record_skill_session_def.js.map +1 -0
  246. package/tools/index.js +49 -61
  247. package/tools/index.js.map +1 -1
  248. package/tools/live/get_native_livekit_core_features.js +65 -0
  249. package/tools/live/get_native_livekit_core_features.js.map +1 -0
  250. package/tools/live/get_native_livekit_core_integration.js +59 -0
  251. package/tools/live/get_native_livekit_core_integration.js.map +1 -0
  252. package/tools/live/get_web_live_uikit_integration.js +48 -0
  253. package/tools/live/get_web_live_uikit_integration.js.map +1 -0
  254. package/tools/live/get_web_livekit_api.js +32 -0
  255. package/tools/live/get_web_livekit_api.js.map +1 -0
  256. package/tools/live/get_web_livekit_component_detail.js +34 -0
  257. package/tools/live/get_web_livekit_component_detail.js.map +1 -0
  258. package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
  259. package/tools/room/get_web_room_uikit_integration.js.map +1 -0
  260. package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
  261. package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
  262. package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
  263. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
  264. package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
  265. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
  266. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
  267. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
  268. package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
  269. package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
  270. package/utils/generate-structured-result.js +61 -17
  271. package/utils/generate-structured-result.js.map +1 -1
  272. package/utils/report-cls-client.js +21 -1
  273. package/utils/report-cls-client.js.map +1 -1
  274. package/utils/report-es-client.js +2 -2
  275. package/resource/doc/chatuikit/android/workflow.md +0 -713
  276. package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1371
  277. package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -932
  278. package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1119
  279. package/resource/doc/chatuikit/flutter/workflow.md +0 -941
  280. package/resource/doc/chatuikit/react/components/conversation-list.md +0 -1017
  281. package/resource/doc/chatuikit/react/components/search.md +0 -745
  282. package/resource/doc/chatuikit/react/create-group.md +0 -23
  283. package/resource/doc/chatuikit/react/init.md +0 -26
  284. package/resource/doc/chatuikit/react/workflow.md +0 -258
  285. package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
  286. package/resource/doc/chatuikit/vue/create-group.md +0 -25
  287. package/resource/doc/chatuikit/vue/init.md +0 -40
  288. package/resource/doc/chatuikit/vue/workflow.md +0 -395
  289. package/resource/doc/livekit/live/android/workflow.md +0 -320
  290. package/resource/doc/livekit/live/flutter/workflow.md +0 -353
  291. package/resource/doc/livekit/live/ios/workflow.md +0 -454
  292. package/resource/doc/livekit/live/vue/components/barrage.md +0 -616
  293. package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -446
  294. package/resource/doc/livekit/live/vue/faq.md +0 -0
  295. package/resource/doc/livekit/live/vue/live-list-integration.md +0 -200
  296. package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -269
  297. package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -269
  298. package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -595
  299. package/resource/doc/livekit/live/vue/states/live-state.md +0 -3591
  300. package/resource/doc/livekit/live/vue/workflow.md +0 -218
  301. package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -312
  302. package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -430
  303. package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -679
  304. package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -671
  305. package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -271
  306. package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
  307. package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
  308. package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
  309. package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
  310. package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -865
  311. package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -657
  312. package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -437
  313. package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -335
  314. package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
  315. package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -327
  316. package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -507
  317. package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
  318. package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -659
  319. package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
  320. package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -814
  321. package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1000
  322. package/resource/doc/roomkit/vue/features/workflow.md +0 -553
  323. package/resource/doc/roomkit/vue/workflow.md +0 -733
  324. package/resource/doc/tuicallkit/android/workflow.md +0 -441
  325. package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -784
  326. package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -610
  327. package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -938
  328. package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -897
  329. package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -469
  330. package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -781
  331. package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -398
  332. package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
  333. package/resource/doc/tuicallkit/react/api.md +0 -1404
  334. package/resource/doc/tuicallkit/vue/api.md +0 -1406
  335. package/resource/doc/tuicallkit/vue/faq.md +0 -36
  336. package/tools/call/get-native-call-integration.js +0 -43
  337. package/tools/call/get-native-call-integration.js.map +0 -1
  338. package/tools/call/get-web-call-api.js +0 -27
  339. package/tools/call/get-web-call-api.js.map +0 -1
  340. package/tools/call/get-web-call-integration.js.map +0 -1
  341. package/tools/chat/get-native-chat-feature-detail.js +0 -30
  342. package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
  343. package/tools/chat/get-native-chat-integration.js +0 -45
  344. package/tools/chat/get-native-chat-integration.js.map +0 -1
  345. package/tools/chat/get-web-chat-component-detail.js +0 -31
  346. package/tools/chat/get-web-chat-component-detail.js.map +0 -1
  347. package/tools/chat/get-web-chat-integration.js +0 -45
  348. package/tools/chat/get-web-chat-integration.js.map +0 -1
  349. package/tools/chat/get-web-chat-uikit-init.js +0 -28
  350. package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
  351. package/tools/chat/get-web-create-group-doc.js +0 -28
  352. package/tools/chat/get-web-create-group-doc.js.map +0 -1
  353. package/tools/common/get-faq.js +0 -91
  354. package/tools/common/get-faq.js.map +0 -1
  355. package/tools/common/get-usersig.js.map +0 -1
  356. package/tools/common/present-framework-choice.js +0 -16
  357. package/tools/common/present-framework-choice.js.map +0 -1
  358. package/tools/common/present-scenario-choice.js +0 -16
  359. package/tools/common/present-scenario-choice.js.map +0 -1
  360. package/tools/common/record-prompt.js +0 -55
  361. package/tools/common/record-prompt.js.map +0 -1
  362. package/tools/common/record-result.js +0 -60
  363. package/tools/common/record-result.js.map +0 -1
  364. package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
  365. package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
  366. package/tools/definitions/get_native_live_api_def.js +0 -23
  367. package/tools/definitions/get_native_live_api_def.js.map +0 -1
  368. package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -87
  369. package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
  370. package/tools/definitions/get_native_live_uikit_integration_def.js +0 -75
  371. package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
  372. package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
  373. package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
  374. package/tools/definitions/get_trtc_native_api_def.js +0 -16
  375. package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
  376. package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
  377. package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
  378. package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
  379. package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
  380. package/tools/definitions/get_web_create_group_doc_def.js +0 -18
  381. package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
  382. package/tools/definitions/get_web_live_state_detail_def.js +0 -19
  383. package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
  384. package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
  385. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
  386. package/tools/definitions/get_web_room_feature_detail_def.js +0 -92
  387. package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
  388. package/tools/definitions/get_web_room_state_detail_def.js +0 -19
  389. package/tools/definitions/get_web_room_state_detail_def.js.map +0 -1
  390. package/tools/definitions/present_scenario_choice_def.js +0 -53
  391. package/tools/definitions/present_scenario_choice_def.js.map +0 -1
  392. package/tools/definitions/record_prompt_def.js +0 -58
  393. package/tools/definitions/record_prompt_def.js.map +0 -1
  394. package/tools/definitions/record_result_def.js +0 -46
  395. package/tools/definitions/record_result_def.js.map +0 -1
  396. package/tools/live/get-native-live-uikit-integration.js +0 -177
  397. package/tools/live/get-native-live-uikit-integration.js.map +0 -1
  398. package/tools/live/get-web-live-component-detail.js +0 -31
  399. package/tools/live/get-web-live-component-detail.js.map +0 -1
  400. package/tools/live/get-web-live-state-detail.js +0 -31
  401. package/tools/live/get-web-live-state-detail.js.map +0 -1
  402. package/tools/live/get-web-live-uikit-integration.js +0 -52
  403. package/tools/live/get-web-live-uikit-integration.js.map +0 -1
  404. package/tools/live/get_native_live_uikit_extra_features.js +0 -105
  405. package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
  406. package/tools/live/get_native_live_uikit_interaction.js +0 -194
  407. package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
  408. package/tools/native_live/get-native-live-api.js +0 -31
  409. package/tools/native_live/get-native-live-api.js.map +0 -1
  410. package/tools/room/get-web-room-feature-detail.js.map +0 -1
  411. package/tools/room/get-web-room-integration.js.map +0 -1
  412. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
  413. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
  414. package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
  415. package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
  416. package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
  417. package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
  418. package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
  419. package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
  420. package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
  421. package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
  422. package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
  423. package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
  424. package/tools/trtc/get-trtc-native-api.js +0 -31
  425. package/tools/trtc/get-trtc-native-api.js.map +0 -1
  426. package/utils/handle-component-name.js +0 -33
  427. package/utils/handle-component-name.js.map +0 -1
  428. /package/resource/doc/{chatuikit/iOS/workflow.md → callkit/core-sdk/.gitkeep} +0 -0
  429. /package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +0 -0
  430. /package/resource/doc/{tuicallkit/react/faq.md → callkit/faq/web-faq.md} +0 -0
  431. /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
  432. /package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +0 -0
  433. /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
  434. /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
  435. /package/resource/doc/roomkit/faq/common/{error_code.md → error-code.md} +0 -0
@@ -1,733 +0,0 @@
1
- # Vue TUIRoomKit (Atomicx Version) Code Generation Workflow Instructions
2
-
3
- ## 📋 Instruction Purpose
4
-
5
- Provide Agent with a **code generation blueprint for implementing Vue TUIRoomKit (Atomicx version) core functionality**, and guide Agent to **prioritize using real-time latest documentation content obtained from tools**, supporting PC and H5 mobile Vue3 audio/video conference application scenarios.
6
-
7
- ---
8
-
9
- ## 🛑 Agent Execution Hard Constraints (Guardrails)
10
-
11
- Agent 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 in integration documentation to ensure code correctness and runnability
17
-
18
- ### 2. npm Package Integration Method (Recommended)
19
- - TUIRoomKit (Atomicx version) uses **direct npm package installation method**, no need to clone GitHub repository
20
- - Quick integration through npm/pnpm/yarn dependency installation
21
- - Source code export functionality available for deep UI customization
22
-
23
- ### 3. Silent Integration Execution
24
- - Automatically install dependencies and start project after all code writing is completed
25
- - Prompt user to access local development server address in browser after successful startup
26
-
27
- ### 4. Zero External Configuration (Testing Phase)
28
- - Prohibit automatic creation of any `.env` files for production environment configuration
29
- - Key credentials like SDKAppID and UserSig must be obtained from MCP tools or manually configured by users
30
-
31
- ### 5. Authentication Credential Configuration
32
- - Use `get_usersig` MCP tool to obtain `SDKAppID`, `userId` and `userSig`
33
- - **⚠️ Important Security Notice**: Must inform users that client-side UserSig generation is only suitable for local testing, production environment must generate UserSig on server side
34
-
35
- ### 6. Vue 3 Composition API
36
- - Prioritize using `<script setup lang="ts">` syntax (note TypeScript enabled)
37
- - Use Vue 3 Composition API (ref, reactive, computed, onMounted, etc.)
38
- - Correctly import and use TUIRoomKit components
39
-
40
- ### 7. Platform Adaptation
41
- - Use `getPlatform()` to detect current platform, PC uses `ConferenceMainView`, H5 mobile uses `ConferenceMainViewH5`
42
- - Both component sets are already UI-adapted for PC and H5 respectively, ready to use out of the box
43
-
44
- ### 8. Conference Component Loading Prerequisites (⚠️ Critical Constraint)
45
- - **Pages calling `conference.start()` or `conference.join()` must ensure conference main view components are already loaded in template**
46
- - Before calling start/join conference APIs, page template must include the following component structure:
47
-
48
- ```vue
49
- <template>
50
- <ConferenceMainView v-if="isPC"></ConferenceMainView>
51
- <ConferenceMainViewH5 v-else></ConferenceMainViewH5>
52
- </template>
53
- ```
54
-
55
- - If conference main view components are missing, `conference.start()` and `conference.join()` will not be able to render conference interface properly
56
- - When Agent generates conference room page code, must first import and render above components, then execute start/join conference logic
57
-
58
- ---
59
-
60
- ## 📦 TUIRoomKit Version & Dependency Automation
61
-
62
- After Agent generates code, must automatically execute the following dependency chain:
63
-
64
- ### 1. Core Dependency Version Recommendations
65
-
66
- ```json
67
- {
68
- "@tencentcloud/roomkit-web-vue3": "latest", // TUIRoomKit main component package (includes ConferenceMainView, ConferenceMainViewH5, conference, etc.)
69
- "tuikit-atomicx-vue3": "latest", // TUIRoomKit atomic component library (includes all Hooks and atomic UI components)
70
- "@tencentcloud/uikit-base-component-vue3": "latest", // Base UI component library (UIKitProvider, etc.)
71
- "@tencentcloud/universal-api": "latest" // Cross-platform API utility library (getPlatform, etc.)
72
- }
73
- ```
74
-
75
- **Dependency Description**:
76
-
77
- | Dependency Package | Purpose | Required | Description |
78
- |-------|------|---------|------|
79
- | **@tencentcloud/roomkit-web-vue3** | TUIRoomKit main component package | ✅ Required | Provides `ConferenceMainView` (PC), `ConferenceMainViewH5` (H5) and `conference` object (start/join meetings) |
80
- | **tuikit-atomicx-vue3** | Atomic component library | ✅ Required | Provides `useLoginState`, `useRoomState` and other Hooks, as well as `RoomLayoutTemplate` and other enum types |
81
- | **@tencentcloud/uikit-base-component-vue3** | Base UI component library | ✅ Required | Provides `UIKitProvider` component for configuring global theme and language |
82
- | **@tencentcloud/universal-api** | Cross-platform API utility library | ✅ Required | Provides `getPlatform()` method for detecting current running platform (pc/mobile) |
83
-
84
- **Installation Commands**:
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. Development Environment Dependencies (TypeScript and SCSS)
98
-
99
- If user project does not yet support TypeScript and SCSS, Agent must automatically install:
100
-
101
- ```json
102
- {
103
- "typescript": "latest", // TypeScript compiler
104
- "sass": "latest" // SCSS preprocessor
105
- }
106
- ```
107
-
108
- ### 3. Build Environment Patch (Vite/esbuild)
109
-
110
- If Vite project is detected, Agent must automatically add patch configuration in `package.json` to be compatible with 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 Version) Core Component Description
126
-
127
- ### Main Components
128
-
129
- | Component Name | Description | Use Case |
130
- |---------|------|---------|
131
- | `ConferenceMainView` | PC conference main interface component | Desktop multi-person meetings |
132
- | `ConferenceMainViewH5` | H5 mobile conference main interface component | Mobile multi-person meetings |
133
- | `conference` | Conference control object | Start meeting (start) and join meeting (join) |
134
- | `UIKitProvider` | Global UI configuration component | Configure theme and language |
135
-
136
- ### Core Hooks
137
-
138
- | Hook Name | Source | Description |
139
- |---------|------|------|
140
- | `useLoginState` | `tuikit-atomicx-vue3/room` | Provides `login`, `setSelfInfo` and other login methods |
141
- | `useRoomState` | `tuikit-atomicx-vue3/room` | Provides room state management |
142
- | `useDeviceState` | `tuikit-atomicx-vue3/room` | Provides device state management |
143
- | `useRoomEngine` | `tuikit-atomicx-vue3/room` | Get roomEngine instance |
144
-
145
- ### Platform Detection
146
-
147
- ```typescript
148
- import { getPlatform } from '@tencentcloud/universal-api';
149
-
150
- const isPC = getPlatform() === 'pc';
151
- // isPC === true → Use ConferenceMainView
152
- // isPC === false → Use ConferenceMainViewH5
153
- ```
154
-
155
- ---
156
-
157
- ## 👥 Default Test User Description
158
-
159
- For convenient development and debugging, Agent generated code **provides 3 test users by default**:
160
-
161
- | User ID | User Name | Description |
162
- |---------|---------|------|
163
- | `user001` | User 001 | Test user 1 (can be host) |
164
- | `user002` | User 002 | Test user 2 (can be participant) |
165
- | `user003` | User 003 | Test user 3 (can be participant) |
166
-
167
- ### Application Login Flow
168
-
169
- Agent generated complete application includes the following pages and flow:
170
-
171
- ```mermaid
172
- graph LR
173
- A[Home - User Selection Login] --> B{Select User}
174
- B --> C[user001 Login]
175
- B --> D[user002 Login]
176
- B --> E[user003 Login]
177
- C --> F[Conference Entry Page]
178
- D --> F
179
- E --> F
180
- F --> G[Create Meeting]
181
- F --> H[Join Meeting]
182
- G --> I[Enter Conference Room]
183
- H --> I
184
- ```
185
-
186
- ### Home Page Feature Requirements
187
-
188
- Agent generated home page (Home page) must include the following features:
189
-
190
- 1. **User Selection Interface**:
191
- - Provide dropdown or button group for users to select test user to login (user001/user002/user003)
192
- - Display currently selected user's ID and name
193
-
194
- 2. **Login Button**:
195
- - After clicking login button, call `login()` and `setSelfInfo()` to complete user login
196
- - Show loading state during login process
197
-
198
- 3. **Redirect After Successful Login**:
199
- - Automatically redirect to conference entry page after successful login
200
- - Conference entry page provides "Create Meeting" and "Join Meeting" two entrances
201
-
202
- ### Conference Entry Page Feature Requirements
203
-
204
- Conference entry page after successful login must include:
205
-
206
- 1. **Display Current Login User Info**: Show logged-in user ID and name
207
- 2. **Create Meeting Feature**:
208
- - Input meeting ID (optional, auto-generate if not provided)
209
- - Input meeting name (optional)
210
- - Click "Create Meeting" button to call `conference.start()`
211
- 3. **Join Meeting Feature**:
212
- - Input meeting ID to join (required)
213
- - Click "Join Meeting" button to call `conference.join()`
214
-
215
- ### Code Implementation Example
216
-
217
- #### Test User Configuration
218
-
219
- When Agent generates code, need to call `get_usersig` MCP tool for each test user to get corresponding userSig, and **pre-fill** into code:
220
-
221
- ```typescript
222
- // ⚠️ When Agent generates code, need to call get_usersig tool 3 times, to get userSig for user001, user002, user003 respectively
223
- // Then fill the obtained SDKAppID and each user's userSig into the configuration below
224
-
225
- const SDKAppID = 0; // Agent fills in SDKAppID obtained from get_usersig
226
-
227
- // Test user list (including pre-generated userSig)
228
- const TEST_USERS = [
229
- { userId: 'user001', userName: 'User 001', userSig: '' }, // Agent fills in user001's userSig
230
- { userId: 'user002', userName: 'User 002', userSig: '' }, // Agent fills in user002's userSig
231
- { userId: 'user003', userName: 'User 003', userSig: '' }, // Agent fills in user003's userSig
232
- ];
233
- ```
234
-
235
- #### Home Page User Selection Component Example
236
-
237
- ```vue
238
- <template>
239
- <div class="login-container">
240
- <h1>TUIRoomKit Audio/Video Conference</h1>
241
- <div class="user-select">
242
- <label>Select Test User:</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 ? 'Logging in...' : 'Login' }}
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
- // ⚠️ Following credentials are obtained and filled by Agent when generating code by calling get_usersig tool
261
- const SDKAppID = 0; // Agent fills in actual SDKAppID
262
-
263
- const TEST_USERS = [
264
- { userId: 'user001', userName: 'User 001', userSig: '' }, // Agent fills in user001's userSig
265
- { userId: 'user002', userName: 'User 002', userSig: '' }, // Agent fills in user002's userSig
266
- { userId: 'user003', userName: 'User 003', userSig: '' }, // Agent fills in user003's 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, // Use pre-filled userSig
284
- sdkAppId: SDKAppID,
285
- });
286
- await setSelfInfo({
287
- userName: user.userName,
288
- avatarUrl: '',
289
- });
290
- // Login successful, redirect to conference entry page
291
- router.push('/conference-entry');
292
- } catch (error) {
293
- console.error('Login failed:', error);
294
- } finally {
295
- isLogging.value = false;
296
- }
297
- };
298
- </script>
299
- ```
300
-
301
- ---
302
-
303
- ## 🛠️ Integration Steps Detailed
304
-
305
- ### Step 1: Install Project Dependencies
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
- ### Step 2: Create Conference Page Component (⚠️ Critical Step)
321
-
322
- Create conference page component, **must load conference main view components in template first**, then call `conference.start()` or `conference.join()`:
323
-
324
- ```vue
325
- <template>
326
- <!-- ⚠️ Critical: Must load conference main view components in template first -->
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
- // Get meeting info from route parameters
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' or 'join'
344
-
345
- onMounted(async () => {
346
- // ⚠️ Ensure component is mounted (template rendered) before calling conference API
347
- if (action === 'start') {
348
- // Start new meeting
349
- await conference.start({
350
- roomId: roomId,
351
- options: {
352
- roomName: roomName || 'My Meeting',
353
- },
354
- });
355
- } else if (action === 'join') {
356
- // Join existing meeting
357
- await conference.join({
358
- roomId: roomId,
359
- });
360
- }
361
- });
362
- </script>
363
- ```
364
-
365
- **⚠️ Mandatory Constraint Description**:
366
- - `conference.start()` and `conference.join()` **must be called after conference main view components are loaded**
367
- - Template must include `<ConferenceMainView>` and `<ConferenceMainViewH5>` components
368
- - Recommend calling in `onMounted` lifecycle to ensure components are mounted
369
- - If conference main view components are missing from template, calling API will not render conference interface properly
370
-
371
- ---
372
-
373
- ### Step 3: Configure App.vue File
374
-
375
- Merge the following content into project's `App.vue` file:
376
-
377
- **Key Configuration Points**:
378
- - Configure global `UIKitProvider` component (set theme and language)
379
- - Configure global styles to ensure conference interface displays fullscreen
380
- - **Note**: User login logic is implemented in home page component (see "Default Test User Description" section)
381
-
382
- ```vue
383
- <template>
384
- <!-- Step 1: Configure global UIKitProvider -->
385
- <UIKitProvider theme="light" language="en-US">
386
- <!-- Your business components (Home → Conference Entry → Conference Room) -->
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: Configure global styles -->
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 Execution Requirements**:
416
- - ⚠️ User login logic is implemented in home page component, not in App.vue
417
- - Must call `get_usersig` MCP tool to get SDKAppID, userId, userSig for each test user
418
-
419
- ---
420
-
421
- ### Step 4: Start New Meeting (Complete Example)
422
-
423
- Navigate from conference entry page to conference room page and start meeting:
424
-
425
- ```typescript
426
- // Start meeting logic in conference entry page
427
- import { useRouter } from 'vue-router';
428
-
429
- const router = useRouter();
430
-
431
- const startConference = () => {
432
- // Navigate to conference room page, pass meeting parameters
433
- router.push({
434
- path: '/room',
435
- query: {
436
- action: 'start',
437
- roomId: '123456', // Meeting ID
438
- roomName: 'My Temporary Meeting', // Meeting name
439
- },
440
- });
441
- };
442
- ```
443
-
444
- **⚠️ Note**: Actual `conference.start()` call is executed in conference room page component (Step 2) `onMounted`, ensuring conference main view components are loaded.
445
-
446
- ---
447
-
448
- ### Step 5: Join Existing Meeting (Complete Example)
449
-
450
- Navigate from conference entry page to conference room page and join meeting:
451
-
452
- ```typescript
453
- // Join meeting logic in conference entry page
454
- import { useRouter } from 'vue-router';
455
-
456
- const router = useRouter();
457
-
458
- const joinConference = () => {
459
- // Navigate to conference room page, pass meeting parameters
460
- router.push({
461
- path: '/room',
462
- query: {
463
- action: 'join',
464
- roomId: '123456', // Meeting ID to join
465
- },
466
- });
467
- };
468
- ```
469
-
470
- **⚠️ Note**: Actual `conference.join()` call is executed in conference room page component (Step 2) `onMounted`, ensuring conference main view components are loaded.
471
-
472
- ---
473
-
474
- ## 🎨 UI Customization Features
475
-
476
- ### 1. Theme and Language Configuration
477
-
478
- Modify theme and language by configuring `UIKitProvider` parameters:
479
-
480
- | UIKitProvider Parameter | Available Values | Default Value |
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. Source Code Export (Deep Customization)
494
-
495
- For deep customization of TUIRoomKit interface, use source code export feature:
496
-
497
- ```bash
498
- # Execute source code export script, default copy path is ./src/components/RoomKit
499
- node ./node_modules/@tencentcloud/roomkit-web-vue3/scripts/eject.js
500
- ```
501
-
502
- After export, modify component import paths:
503
-
504
- ```typescript
505
- // Before: Import from npm package
506
- - import { ConferenceMainView, conference } from '@tencentcloud/roomkit-web-vue3';
507
-
508
- // After: Import from local source code
509
- + import { ConferenceMainView, ConferenceMainViewH5, conference } from './components/RoomKit/index.ts';
510
- ```
511
-
512
- ---
513
-
514
- ### 3. Custom Room Stream Layout
515
-
516
- TUIRoomKit supports three stream layouts:
517
-
518
- | Layout Type | Enum Value | Description |
519
- |---------|--------|------|
520
- | Grid Layout | `RoomLayoutTemplate.GridLayout` | Default layout |
521
- | Sidebar Layout | `RoomLayoutTemplate.SidebarLayout` | Sidebar layout |
522
- | Top Bar Layout | `RoomLayoutTemplate.CinemaLayout` | Top bar layout |
523
-
524
- After exporting source code, modify in `RoomKit/views/ConferenceMainView/index.vue`:
525
-
526
- ```typescript
527
- import { RoomLayoutTemplate } from 'tuikit-atomicx-vue3/room';
528
-
529
- // Change default layout to sidebar layout
530
- const participantViewLayout = ref(RoomLayoutTemplate.SidebarLayout);
531
-
532
- function handleLayoutUpdate(layout: RoomLayoutTemplate) {
533
- participantViewLayout.value = layout;
534
- }
535
- ```
536
-
537
- ---
538
-
539
- ### 4. Custom Video Stream Widgets
540
-
541
- After exporting source code, modify the following component to customize video stream widgets:
542
-
543
- ```
544
- src/components/RoomKit/components/RoomLayoutView/ParticipantViewUI/ParticipantViewUI.vue
545
- ```
546
-
547
- ---
548
-
549
- ### 5. Configure User Contact List
550
-
551
- TUIRoomKit scheduled meetings and in-meeting calls user selection list displays user relationship chain by default. Batch import steps:
552
-
553
- 1. Use [Account Management > Import Multiple Accounts](https://cloud.tencent.com/document/product/269/4919) REST API to batch import user accounts
554
- 2. Use [Friend Management > Import Friends](https://cloud.tencent.com/document/product/269/8301) REST API to batch import user relationship chain
555
-
556
- ---
557
-
558
- ## 🔄 Complete Automation Process Summary
559
-
560
- ```mermaid
561
- graph TD
562
- A[Receive User Requirements] --> B[Install npm Dependencies]
563
- B --> C{Detect TypeScript and SCSS Support}
564
- C -->|Not Installed| D[Install typescript and sass]
565
- C -->|Already Installed| E[Skip]
566
- D --> F[Create Home Page - User Selection Login Interface]
567
- E --> F
568
- F --> G[Configure 3 Test Users: user001/user002/user003]
569
- G --> H[Call get_usersig to Get Credentials for Each User]
570
- H --> I[Create Conference Entry Page - Create/Join Meeting]
571
- I --> J[Create Conference Room Page Component]
572
- J --> K[Configure App.vue: UIKitProvider + Global Styles]
573
- K --> L{User Needs Deep UI Customization?}
574
- L -->|Yes| M[Execute Source Code Export Script]
575
- L -->|No| N[Use Default Configuration]
576
- M --> O[Provide UI Customization Solutions: Theme/Layout/Widgets]
577
- N --> P[record_result Record Integration Results]
578
- O --> P
579
- P --> Q[Auto Start Development Server: npm run dev]
580
- Q --> R[Prompt User to Access in Browser and Select User Login]
581
- ```
582
-
583
- ---
584
-
585
- ## ✍️ Agent Code Generation Example Instructions (Prompts)
586
-
587
- **Basic Integration**:
588
- > "Following TUIRoomKit (Atomicx version) npm package integration method, generate a Vue 3 audio/video conference application for me. Home page provides 3 test user (user001/user002/user003) selection interface, after user selection click login, redirect to conference entry page after successful login, provide create meeting and join meeting functions. Use get_usersig tool to get authentication credentials for each test user. After startup, prompt me to access debug address in browser. **Please be sure to inform me: The currently generated code is only suitable for local testing, production environment must generate UserSig on server side.**"
589
-
590
- **H5 Mobile Conference**:
591
- > "Following TUIRoomKit (Atomicx version) integration, generate a Vue 3 conference application that supports both PC and H5 mobile. Home page provides test user selection and login functionality, use getPlatform() to detect platform, PC uses ConferenceMainView, H5 uses ConferenceMainViewH5."
592
-
593
- **Deep UI Customization**:
594
- > "Following TUIRoomKit (Atomicx version) integration, generate a Vue 3 conference application. Include user selection login process, need to execute source code export, customize video stream layout to sidebar layout, and customize video stream widget styles."
595
-
596
- ---
597
-
598
- ## 📝 Key Points Summary
599
-
600
- | Category | Requirements |
601
- |------|------|
602
- | **Framework Version** | Vue 3.4.21 and above |
603
- | **Platform Support** | PC + H5 mobile (responsive adaptation, ready to use) |
604
- | **Integration Method** | Direct npm package installation (recommended); source code export available for deep customization |
605
- | **Documentation First** | Strictly follow latest documentation instructions returned by tools |
606
- | **Silent Integration** | Auto install dependencies and start development server after code writing completion |
607
- | **Credential Acquisition** | Call `get_usersig` MCP tool to get SDKAppID, userId, userSig |
608
- | **Security Notice** | ⚠️ Must inform users: Client-side UserSig generation only suitable for testing, production environment must generate on server side |
609
- | **Multi-language** | Supports Chinese (zh-CN) and English (en-US) |
610
- | **UI Customization** | Supports theme, layout, video stream widget customization (requires source code export) |
611
-
612
- ---
613
-
614
- ## 🎯 Agent Execution Checklist
615
-
616
- ### Project Initialization
617
- - [ ] Installed core dependencies: `@tencentcloud/roomkit-web-vue3`, `tuikit-atomicx-vue3`, `@tencentcloud/uikit-base-component-vue3`, `@tencentcloud/universal-api`
618
- - [ ] Detected and installed TypeScript and SCSS development dependencies (if user project not installed)
619
-
620
- ### Code Generation
621
- - [ ] Created conference page component, using `getPlatform()` to detect platform
622
- - [ ] Configured `App.vue`: UIKitProvider + global styles
623
- - [ ] Components use `<script setup lang="ts">` syntax
624
-
625
- ### Test Users and Login Flow
626
- - [ ] 🔴 Configured 3 default test users: user001, user002, user003
627
- - [ ] Created home page user selection interface (dropdown or button group to select test users)
628
- - [ ] Implemented login button and login loading state
629
- - [ ] Redirect to conference entry page after successful login
630
-
631
- ### Conference Entry Page
632
- - [ ] Display current login user information
633
- - [ ] Implemented "Create Meeting" functionality (call `conference.start()`)
634
- - [ ] Implemented "Join Meeting" functionality (call `conference.join()`)
635
-
636
- ### Credentials and Login
637
- - [ ] 🔴 Called `get_usersig` MCP tool to get SDKAppID, userId, userSig for each test user
638
- - [ ] Implemented `login()` and `setSelfInfo()` login logic in home page
639
- - [ ] ⚠️ **Informed user**: Currently generated code only suitable for local testing, production environment must generate UserSig on server side
640
-
641
- ### UI Configuration
642
- - [ ] Configured theme (light/dark) and language (zh-CN/en-US) according to user requirements
643
- - [ ] If user needs deep customization, executed source code export script
644
-
645
- ### Final Check
646
- - [ ] Called `record_result` to record integration results
647
- - [ ] Auto installed dependencies (npm install)
648
- - [ ] Auto started development server (npm run dev)
649
- - [ ] Prompted user to access local development server address in browser
650
- - [ ] Project runs normally without errors
651
-
652
- ---
653
-
654
- ## 🔗 Related Tool References
655
-
656
- ### Must-Use Tools
657
-
658
- #### `get_usersig` - Get Authentication Credentials
659
- **Purpose**: Get Tencent Cloud application credentials from MCP environment variables
660
- - `SDKAppID`: Application identifier
661
- - `userId`: User ID
662
- - `userSig`: User signature
663
-
664
- **Usage Constraints**:
665
- - ✅ Must call this tool to get credentials
666
- - ⚠️ Must inform users: Client-side UserSig generation only suitable for testing, production environment must generate on server side
667
-
668
- #### `record_result` - Record Integration Results
669
- **Purpose**: Record integration process and results for statistics and analysis
670
-
671
- **Call Timing**: Call after completing all integration steps and successfully starting project
672
-
673
- ---
674
-
675
- ## 📚 Related Resource Links
676
-
677
- - **TUIRoomKit GitHub Repository**: https://github.com/Tencent-RTC/TUIRoomKit
678
- - **Tencent Cloud TRTC Console**: https://console.cloud.tencent.com/trtc
679
- - **How to Calculate UserSig in Production**: https://cloud.tencent.com/document/product/647/17275#formal
680
- - **URL Domain and Protocol Restrictions**: https://cloud.tencent.com/document/product/647/17249
681
- - **Dealing with Firewall Restrictions (Internal Proxy)**: https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-34-advanced-proxy.html
682
-
683
- ---
684
-
685
- ## ❓ Frequently Asked Questions
686
-
687
- ### TUIRoomKit works normally in local development, but cannot capture camera/microphone after deploying online?
688
-
689
- **Root Cause**: Browsers have strict restrictions on audio/video device capture for security and privacy protection. Capture is only allowed in secure environments (https://, localhost, file://).
690
-
691
- **Solution**: Must deploy web pages using HTTPS protocol and ensure valid security certificates.
692
-
693
- ### Does TUIRoomKit support iframe integration?
694
-
695
- Yes. When using iframe integration, need to configure allow attribute to grant necessary permissions:
696
-
697
- ```html
698
- <iframe allow="microphone; camera; display-capture; display; fullscreen;">
699
- ```
700
-
701
- ### Does TUIRoomKit support setting internal network proxy?
702
-
703
- Yes. Please set internal network proxy parameters before entering room:
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
- **Supported Framework**: Vue 3.4.21+
731
- **Platform Support**: PC + H5 Mobile
732
- **TUIRoomKit Version**: @tencentcloud/roomkit-web-vue3 (Atomicx Version)
733
- **Build Tool**: Vite (Recommended)