@tencentcloud/sdk-mcp 1.4.7 → 1.6.0-beta.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 (556) hide show
  1. package/index.js +0 -1
  2. package/knowledge/bm25-cache.js +73 -0
  3. package/knowledge/bm25.js +147 -0
  4. package/knowledge/build-index.js +65 -0
  5. package/knowledge/chunker.js +167 -0
  6. package/knowledge/content-loader.js +44 -0
  7. package/knowledge/extractors.js +25 -0
  8. package/knowledge/path-meta.js +175 -0
  9. package/knowledge/search/exact-lookup.js +330 -0
  10. package/knowledge/search/filter-pool.js +86 -0
  11. package/knowledge/search/requires-framework.js +72 -0
  12. package/knowledge/search/search-knowledge.js +226 -0
  13. package/package.json +9 -9
  14. package/resource/_schema/feature-aliases.yaml +10 -0
  15. package/resource/_schema/goal-tags.yaml +72 -0
  16. package/resource/_schema/products.yaml +16 -0
  17. package/resource/_schema/trtc-intents.yaml +27 -0
  18. package/resource/_schema/types.yaml +44 -0
  19. package/resource/index/component-slugs.json +1 -0
  20. package/resource/index/manifest.json +1 -0
  21. package/resource/{doc → integration}/callkit/preset/android/integration.md +32 -28
  22. package/resource/{doc → integration}/callkit/preset/flutter/integration.md +109 -54
  23. package/resource/integration/callkit/preset/ios/integration.md +411 -0
  24. package/resource/integration/callkit/preset/react/integration.md +499 -0
  25. package/resource/integration/callkit/preset/vue/integration.md +768 -0
  26. package/resource/{doc/chatkit → integration/chat/preset}/android/integration.md +11 -11
  27. package/resource/{doc/chatkit → integration/chat/preset}/flutter/integration.md +59 -37
  28. package/resource/integration/chat/preset/ios/integration.md +568 -0
  29. package/resource/{doc/chatkit → integration/chat/preset}/react/integration.md +127 -95
  30. package/resource/integration/chat/preset/uni-app/integration.md +494 -0
  31. package/resource/{doc/chatkit → integration/chat/preset}/vue/integration.md +163 -143
  32. package/resource/{doc → integration}/livekit/preset/live/vue/live-list-integration.md +15 -15
  33. package/resource/{doc → integration}/livekit/preset/live/vue/live-player-desk-integration.md +25 -13
  34. package/resource/{doc → integration}/livekit/preset/live/vue/live-player-h5-integration.md +15 -9
  35. package/resource/{doc → integration}/livekit/preset/live/vue/live-pusher-integration.md +31 -26
  36. package/resource/integration/roomkit/preset/vue/integration.md +571 -0
  37. package/resource/knowledge/callkit/core-sdk/android/answer-call.md +852 -0
  38. package/resource/knowledge/callkit/core-sdk/android/make-call.md +929 -0
  39. package/resource/knowledge/callkit/core-sdk/android/offline-push.md +364 -0
  40. package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +1150 -0
  41. package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +1216 -0
  42. package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +412 -0
  43. package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1191 -0
  44. package/resource/knowledge/callkit/core-sdk/ios/make-call.md +1292 -0
  45. package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +537 -0
  46. package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +953 -0
  47. package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +1061 -0
  48. package/resource/knowledge/callkit/faq/android.md +168 -0
  49. package/resource/knowledge/callkit/faq/common.md +180 -0
  50. package/resource/knowledge/callkit/faq/flutter.md +52 -0
  51. package/resource/knowledge/callkit/faq/ios.md +116 -0
  52. package/resource/knowledge/callkit/faq/uniapp-app.md +89 -0
  53. package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +217 -0
  54. package/resource/knowledge/callkit/faq/web.md +363 -0
  55. package/resource/knowledge/callkit/preset/android/api.md +413 -0
  56. package/resource/knowledge/callkit/preset/flutter/api.md +22 -0
  57. package/resource/knowledge/callkit/preset/ios/api.md +256 -0
  58. package/resource/knowledge/callkit/preset/web/api.md +79 -0
  59. package/resource/knowledge/chat/preset/android/features/chat-setting.md +72 -0
  60. package/resource/knowledge/chat/preset/android/features/contact-list.md +41 -0
  61. package/resource/knowledge/chat/preset/android/features/conversation-list.md +123 -0
  62. package/resource/knowledge/chat/preset/android/features/language.md +142 -0
  63. package/resource/knowledge/chat/preset/android/features/message-input.md +57 -0
  64. package/resource/knowledge/chat/preset/android/features/message-list.md +142 -0
  65. package/resource/knowledge/chat/preset/android/features/search.md +64 -0
  66. package/resource/{doc/chatkit → knowledge/chat/preset}/android/features/theme.md +21 -18
  67. package/resource/knowledge/chat/preset/android-view/integration.md +448 -0
  68. package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +62 -0
  69. package/resource/knowledge/chat/preset/flutter/features/contact-list.md +40 -0
  70. package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +129 -0
  71. package/resource/knowledge/chat/preset/flutter/features/language.md +104 -0
  72. package/resource/knowledge/chat/preset/flutter/features/message-input.md +54 -0
  73. package/resource/knowledge/chat/preset/flutter/features/message-list.md +163 -0
  74. package/resource/knowledge/chat/preset/flutter/features/search.md +59 -0
  75. package/resource/{doc/chatkit → knowledge/chat/preset}/flutter/features/theme.md +47 -19
  76. package/resource/knowledge/chat/preset/ios/features/chat-setting.md +92 -0
  77. package/resource/knowledge/chat/preset/ios/features/contact-list.md +119 -0
  78. package/resource/knowledge/chat/preset/ios/features/conversation-list.md +134 -0
  79. package/resource/knowledge/chat/preset/ios/features/language.md +105 -0
  80. package/resource/knowledge/chat/preset/ios/features/message-input.md +69 -0
  81. package/resource/knowledge/chat/preset/ios/features/message-list.md +164 -0
  82. package/resource/knowledge/chat/preset/ios/features/search.md +94 -0
  83. package/resource/{doc/chatkit → knowledge/chat/preset}/ios/features/theme.md +54 -51
  84. package/resource/{doc/chatkit/ios → knowledge/chat/preset/ios-uikit}/integration.md +157 -94
  85. package/resource/knowledge/chat/preset/react/features/chat-setting.md +123 -0
  86. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/contact-list.md +256 -104
  87. package/resource/knowledge/chat/preset/react/features/conversation-actions.md +217 -0
  88. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/conversation-list.md +86 -79
  89. package/resource/knowledge/chat/preset/react/features/conversation-preview.md +99 -0
  90. package/resource/knowledge/chat/preset/react/features/conversation-search.md +58 -0
  91. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-input.md +30 -83
  92. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-list.md +22 -25
  93. package/resource/knowledge/chat/preset/react/features/search.md +531 -0
  94. package/resource/knowledge/chat/preset/react/features/theme.md +16 -0
  95. package/resource/knowledge/chat/preset/vue/features/chat-header.md +331 -0
  96. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/chat-setting.md +0 -4
  97. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/contact-list.md +59 -53
  98. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-actions.md +49 -43
  99. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-list.md +61 -49
  100. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-preview.md +43 -40
  101. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-search.md +1 -1
  102. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-input.md +128 -105
  103. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-list.md +108 -195
  104. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/search.md +74 -68
  105. package/resource/knowledge/chat/preset/vue/features/theme.md +136 -0
  106. package/resource/knowledge/chat/urls/error-code.md +16 -0
  107. package/resource/knowledge/chat/urls/product.md +61 -0
  108. package/resource/knowledge/chat/urls/restapi.md +226 -0
  109. package/resource/knowledge/chat/urls/sdk/android.md +84 -0
  110. package/resource/knowledge/chat/urls/sdk/flutter.md +73 -0
  111. package/resource/knowledge/chat/urls/sdk/ios.md +84 -0
  112. package/resource/knowledge/chat/urls/sdk/web.md +88 -0
  113. package/resource/knowledge/chat/urls/webhook.md +73 -0
  114. package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/AudioEffectStore.md +79 -76
  115. package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +174 -0
  116. package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +329 -0
  117. package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/CameraView.md +7 -6
  118. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +434 -0
  119. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +362 -0
  120. package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +466 -0
  121. package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +173 -0
  122. package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/LikeStore.md +12 -10
  123. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +291 -0
  124. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +78 -0
  125. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +439 -0
  126. package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +221 -0
  127. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/AudioEffectStore.md +79 -76
  128. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +212 -0
  129. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/BaseBeautyStore.md +43 -45
  130. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +312 -0
  131. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +404 -0
  132. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +334 -0
  133. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +420 -0
  134. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +166 -0
  135. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LikeStore.md +12 -11
  136. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +281 -0
  137. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LiveCoreView.md +49 -42
  138. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +397 -0
  139. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +183 -0
  140. package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/AudioEffectStore.md +79 -75
  141. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +192 -0
  142. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +146 -0
  143. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +309 -0
  144. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +370 -0
  145. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +339 -0
  146. package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +503 -0
  147. package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +188 -0
  148. package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/LikeStore.md +12 -10
  149. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +289 -0
  150. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +78 -0
  151. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +434 -0
  152. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +187 -0
  153. package/resource/knowledge/livekit/core-sdk/api-reference/web/index.md +780 -0
  154. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audience-list.md +59 -51
  155. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audio-effect.md +37 -34
  156. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-barrage.md +68 -38
  157. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-base-beauty.md +18 -15
  158. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-co-guest-interaction.md +17 -17
  159. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-gift.md +86 -80
  160. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-host-interaction.md +53 -49
  161. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-integration.md +47 -45
  162. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-live-list.md +26 -22
  163. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audience-list.md +16 -13
  164. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audio-effect.md +28 -24
  165. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-barrage.md +33 -21
  166. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-base-beauty.md +29 -25
  167. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-co-guest-interaction.md +21 -20
  168. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-gift.md +78 -69
  169. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-host-interaction.md +47 -43
  170. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-integration.md +48 -45
  171. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-live-list.md +27 -23
  172. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audience-list.md +15 -12
  173. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audio-effect.md +39 -36
  174. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-barrage.md +42 -29
  175. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-base-beauty.md +19 -16
  176. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-co-guest-interaction.md +20 -19
  177. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-gift.md +55 -49
  178. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-host-interaction.md +50 -46
  179. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-integration.md +48 -46
  180. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-live-list.md +26 -22
  181. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audience-list.md +59 -51
  182. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audio-effect.md +41 -38
  183. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-barrage.md +67 -37
  184. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +53 -46
  185. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-gift.md +86 -80
  186. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-host-interaction.md +45 -40
  187. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-integration.md +43 -42
  188. package/resource/knowledge/livekit/core-sdk/voice/android/voice-room-list.md +523 -0
  189. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audience-list.md +16 -13
  190. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audio-effect.md +54 -50
  191. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-barrage.md +33 -21
  192. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +34 -28
  193. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-gift.md +73 -64
  194. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-integration.md +46 -43
  195. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-room-list.md +165 -148
  196. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audience-list.md +19 -16
  197. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audio-effect.md +40 -37
  198. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-barrage.md +41 -28
  199. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +54 -47
  200. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-gift.md +52 -46
  201. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-host-interaction.md +55 -50
  202. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-integration.md +47 -45
  203. package/resource/knowledge/livekit/core-sdk/voice/ios/voice-room-list.md +404 -0
  204. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audience-list.md +40 -57
  205. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audio-effect.md +38 -49
  206. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-barrage.md +53 -53
  207. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-co-guest-interaction.md +106 -116
  208. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-gift.md +49 -59
  209. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-integration.md +52 -45
  210. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-room-list.md +38 -46
  211. package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +915 -0
  212. package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +179 -0
  213. package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +419 -0
  214. package/resource/knowledge/push/config/android/fcm.md +133 -0
  215. package/resource/knowledge/push/config/android/honor.md +111 -0
  216. package/resource/knowledge/push/config/android/huawei.md +106 -0
  217. package/resource/knowledge/push/config/android/meizu.md +121 -0
  218. package/resource/knowledge/push/config/android/oppo.md +108 -0
  219. package/resource/knowledge/push/config/android/vivo.md +101 -0
  220. package/resource/knowledge/push/config/android/xiaomi.md +99 -0
  221. package/resource/knowledge/push/integration/android.md +1028 -0
  222. package/resource/knowledge/push/integration/donut.md +271 -0
  223. package/resource/knowledge/push/integration/flutter.md +363 -0
  224. package/resource/knowledge/push/integration/harmonyos.md +72 -0
  225. package/resource/knowledge/push/integration/ios.md +705 -0
  226. package/resource/knowledge/push/integration/react-native.md +337 -0
  227. package/resource/knowledge/push/integration/uni-app.md +461 -0
  228. package/resource/knowledge/push/integration/unity.md +357 -0
  229. package/resource/knowledge/push/integration/unreal-engine.md +353 -0
  230. package/resource/knowledge/push/overview/prepare.md +30 -0
  231. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/call-user-to-room.md +22 -20
  232. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-participant-state.md +22 -193
  233. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-state.md +33 -32
  234. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/schedule-room.md +30 -29
  235. package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +230 -0
  236. package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-participant-state.md +22 -21
  237. package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-state.md +29 -28
  238. package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/schedule-room.md +17 -16
  239. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/call-user-to-room.md +22 -20
  240. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-participant-state.md +49 -218
  241. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-state.md +37 -37
  242. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/schedule-room.md +28 -28
  243. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/call-user-to-room.md +122 -7
  244. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/device-detection.md +318 -3
  245. package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +1504 -0
  246. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/free-beauty-panel.md +4 -3
  247. package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +709 -0
  248. package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +1105 -0
  249. package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +635 -0
  250. package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +529 -0
  251. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/schedule-room.md +256 -13
  252. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/screen-share.md +218 -25
  253. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/virtual-background.md +4 -3
  254. package/resource/{doc/roomkit → knowledge/roomkit/preset}/android/integration.md +50 -64
  255. package/resource/{doc/roomkit → knowledge/roomkit/preset}/flutter/integration.md +34 -31
  256. package/resource/{doc/roomkit → knowledge/roomkit/preset}/ios/integration.md +45 -53
  257. package/resource/knowledge/roomkit/preset/react/integration.md +571 -0
  258. package/resource/{doc → knowledge}/rtcengine/web/how_to_run_web_sdk_demo.md +31 -15
  259. package/resource/{doc → knowledge}/rtcengine/web/plugin/21-advanced-auto-play-policy.md +9 -3
  260. package/resource/{doc → knowledge}/rtcengine/web/plugin/22-advanced-audio-mixer.md +1 -1
  261. package/resource/{doc → knowledge}/rtcengine/web/plugin/23-advanced-support-detection.md +1 -1
  262. package/resource/{doc → knowledge}/rtcengine/web/plugin/24-advanced-network-quality.md +6 -6
  263. package/resource/{doc → knowledge}/rtcengine/web/plugin/25-advanced-device-change.md +1 -1
  264. package/resource/{doc → knowledge}/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -4
  265. package/resource/{doc → knowledge}/rtcengine/web/plugin/27-advanced-small-stream.md +4 -4
  266. package/resource/{doc → knowledge}/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
  267. package/resource/{doc → knowledge}/trtc/android/TRTCCloud.md +547 -495
  268. package/resource/{doc → knowledge}/trtc/android/TRTCCloudDef.md +434 -403
  269. package/resource/{doc → knowledge}/trtc/android/TRTCCloudListener.md +394 -348
  270. package/resource/{doc → knowledge}/trtc/android/TRTCStatistics.md +17 -15
  271. package/resource/{doc → knowledge}/trtc/android/TXAudioEffectManager.md +227 -197
  272. package/resource/knowledge/trtc/android/TXBeautyManager.md +415 -0
  273. package/resource/{doc → knowledge}/trtc/android/TXDeviceManager.md +70 -63
  274. package/resource/{doc → knowledge}/trtc/android/TXLiteAVCode.md +19 -17
  275. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCCloud.md +599 -544
  276. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCStatistics.md +17 -15
  277. package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +502 -0
  278. package/resource/knowledge/trtc/c++/ITXDeviceManager.md +403 -0
  279. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCCloudCallback.md +439 -387
  280. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCTypeDef.md +417 -387
  281. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TXLiteAVCode.md +19 -17
  282. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloud.md +619 -559
  283. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloudDelegate.md +409 -360
  284. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCStatistics.md +17 -15
  285. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXAudioEffectManager.md +187 -164
  286. package/resource/knowledge/trtc/ios/TXBeautyManager.md +416 -0
  287. package/resource/knowledge/trtc/ios/TXDeviceManager.md +399 -0
  288. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiteAVCode.md +19 -17
  289. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiveSDKTypeDef.md +422 -396
  290. package/server-config.js +0 -1
  291. package/server.js +22 -12
  292. package/streamable-http.js +0 -1
  293. package/tools/call/get_native_call_uikit_integration.js +2 -4
  294. package/tools/call/get_native_callkit_core_integration.js +2 -6
  295. package/tools/call/get_web_call_uikit_integration.js +2 -4
  296. package/tools/chat/get_native_chat_uikit_integration.js +2 -4
  297. package/tools/chat/get_web_chat_uikit_integration.js +2 -4
  298. package/tools/common/get_usersig.js +0 -1
  299. package/tools/common/present_framework_choice.js +9 -4
  300. package/tools/common/record_answer.js +19 -26
  301. package/tools/common/record_feedback.js +17 -31
  302. package/tools/common/search_trtc_knowledge.js +44 -0
  303. package/tools/definitions/get_native_call_uikit_integration_def.js +2 -1
  304. package/tools/definitions/get_native_callkit_core_integration_def.js +2 -1
  305. package/tools/definitions/get_native_chat_uikit_integration_def.js +3 -2
  306. package/tools/definitions/get_native_livekit_core_integration_def.js +2 -1
  307. package/tools/definitions/get_usersig_def.js +0 -1
  308. package/tools/definitions/get_web_call_uikit_integration_def.js +2 -1
  309. package/tools/definitions/get_web_chat_uikit_integration_def.js +2 -1
  310. package/tools/definitions/get_web_live_uikit_integration_def.js +4 -3
  311. package/tools/definitions/get_web_room_core_integration_def.js +46 -0
  312. package/tools/definitions/get_web_room_uikit_integration_def.js +3 -1
  313. package/tools/definitions/integration-boundary.js +5 -0
  314. package/tools/definitions/present_framework_choice_def.js +11 -10
  315. package/tools/definitions/record_answer_def.js +6 -5
  316. package/tools/definitions/record_feedback_def.js +4 -3
  317. package/tools/definitions/search_trtc_knowledge_def.js +69 -0
  318. package/tools/index.js +5 -37
  319. package/tools/live/get_native_livekit_core_integration.js +1 -4
  320. package/tools/live/get_web_live_uikit_integration.js +2 -5
  321. package/tools/room/get_web_room_core_integration.js +47 -0
  322. package/tools/room/get_web_room_uikit_integration.js +2 -4
  323. package/utils/generate-structured-result.js +4 -11
  324. package/utils/generate-usersig.js +0 -1
  325. package/utils/get-device-identifier.js +0 -1
  326. package/utils/get-doc-content.js +14 -9
  327. package/utils/http-get.js +0 -1
  328. package/utils/http-post.js +0 -1
  329. package/utils/report-cls-client.js +22 -21
  330. package/utils/report-es-client.js +1 -2
  331. package/utils/report-runtime-error-cls-client.js +0 -1
  332. package/index.js.map +0 -1
  333. package/resource/doc/callkit/core-sdk/.gitkeep +0 -0
  334. package/resource/doc/callkit/core-sdk/android/answer-call.md +0 -942
  335. package/resource/doc/callkit/core-sdk/android/make-call.md +0 -876
  336. package/resource/doc/callkit/core-sdk/android/offline-push.md +0 -368
  337. package/resource/doc/callkit/core-sdk/flutter/answer-call.md +0 -1132
  338. package/resource/doc/callkit/core-sdk/flutter/make-call.md +0 -1206
  339. package/resource/doc/callkit/core-sdk/flutter/offline-push.md +0 -357
  340. package/resource/doc/callkit/core-sdk/ios/answer-call.md +0 -1009
  341. package/resource/doc/callkit/core-sdk/ios/make-call.md +0 -1154
  342. package/resource/doc/callkit/core-sdk/ios/offline-push.md +0 -470
  343. package/resource/doc/callkit/core-sdk/uni-app/answer-call.md +0 -1146
  344. package/resource/doc/callkit/core-sdk/uni-app/make-call.md +0 -1267
  345. package/resource/doc/callkit/faq/android-faq.md +0 -767
  346. package/resource/doc/callkit/faq/flutter-faq.md +0 -749
  347. package/resource/doc/callkit/faq/ios-faq.md +0 -759
  348. package/resource/doc/callkit/faq/web-faq.md +0 -753
  349. package/resource/doc/callkit/preset/android/api.md +0 -330
  350. package/resource/doc/callkit/preset/flutter/api.md +0 -401
  351. package/resource/doc/callkit/preset/ios/api.md +0 -282
  352. package/resource/doc/callkit/preset/ios/integration.md +0 -188
  353. package/resource/doc/callkit/preset/react/api.md +0 -600
  354. package/resource/doc/callkit/preset/react/integration.md +0 -86
  355. package/resource/doc/callkit/preset/vue/api.md +0 -600
  356. package/resource/doc/callkit/preset/vue/integration.md +0 -83
  357. package/resource/doc/chatkit/android/faq.md +0 -109
  358. package/resource/doc/chatkit/faq/android_sdk/client-api.md +0 -280
  359. package/resource/doc/chatkit/faq/common/product.md +0 -82
  360. package/resource/doc/chatkit/faq/common/server.md +0 -53
  361. package/resource/doc/chatkit/faq/common/server_error_code.md +0 -74
  362. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +0 -183
  363. package/resource/doc/chatkit/faq/flutter_sdk/faq.md +0 -54
  364. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +0 -279
  365. package/resource/doc/chatkit/faq/web_sdk/error_code.md +0 -47
  366. package/resource/doc/chatkit/faq/web_sdk/faq.md +0 -292
  367. package/resource/doc/chatkit/flutter/faq.md +0 -22
  368. package/resource/doc/chatkit/ios/faq.md +0 -109
  369. package/resource/doc/chatkit/react/components/avatar.md +0 -104
  370. package/resource/doc/chatkit/react/components/chat-header.md +0 -148
  371. package/resource/doc/chatkit/react/components/chat-setting.md +0 -117
  372. package/resource/doc/chatkit/react/components/chat.md +0 -38
  373. package/resource/doc/chatkit/react/components/component-list.md +0 -35
  374. package/resource/doc/chatkit/react/components/conversation-actions.md +0 -174
  375. package/resource/doc/chatkit/react/components/conversation-preview.md +0 -116
  376. package/resource/doc/chatkit/react/components/conversation-search.md +0 -57
  377. package/resource/doc/chatkit/react/components/search.md +0 -282
  378. package/resource/doc/chatkit/react/components/tuikit.md +0 -43
  379. package/resource/doc/chatkit/react/faq.md +0 -26
  380. package/resource/doc/chatkit/vue/components/avatar.md +0 -104
  381. package/resource/doc/chatkit/vue/components/chat-header.md +0 -149
  382. package/resource/doc/chatkit/vue/components/chat.md +0 -42
  383. package/resource/doc/chatkit/vue/components/component-list.md +0 -89
  384. package/resource/doc/chatkit/vue/components/tuikit.md +0 -45
  385. package/resource/doc/chatkit/vue/components/userpicker.md +0 -256
  386. package/resource/doc/chatkit/vue/faq.md +0 -35
  387. package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +0 -148
  388. package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +0 -316
  389. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +0 -419
  390. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +0 -325
  391. package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +0 -436
  392. package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +0 -165
  393. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +0 -239
  394. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +0 -74
  395. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +0 -417
  396. package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +0 -207
  397. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +0 -158
  398. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +0 -304
  399. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +0 -394
  400. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +0 -303
  401. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +0 -410
  402. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +0 -160
  403. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +0 -231
  404. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +0 -375
  405. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +0 -170
  406. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +0 -165
  407. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +0 -143
  408. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +0 -298
  409. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +0 -349
  410. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +0 -297
  411. package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +0 -471
  412. package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +0 -179
  413. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +0 -238
  414. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +0 -74
  415. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +0 -412
  416. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +0 -173
  417. package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +0 -365
  418. package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +0 -336
  419. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +0 -780
  420. package/resource/doc/livekit/preset/live/vue/components/barrage.md +0 -291
  421. package/resource/doc/livekit/preset/live/vue/components/co-guest-panel.md +0 -88
  422. package/resource/doc/livekit/preset/live/vue/components/live-audience-list.md +0 -164
  423. package/resource/doc/livekit/preset/live/vue/components/live-scene-panel.md +0 -130
  424. package/resource/doc/livekit/preset/live/vue/components/live-view.md +0 -203
  425. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +0 -211
  426. package/resource/doc/livekit/preset/live/vue/faq.md +0 -1
  427. package/resource/doc/roomkit/faq/common/error-code.md +0 -67
  428. package/resource/doc/roomkit/flutter/features/call-user-to-room.md +0 -228
  429. package/resource/doc/roomkit/vue/faq.md +0 -1
  430. package/resource/doc/roomkit/vue/features/device-state.md +0 -460
  431. package/resource/doc/roomkit/vue/features/room-chat.md +0 -369
  432. package/resource/doc/roomkit/vue/features/room-participant-state.md +0 -385
  433. package/resource/doc/roomkit/vue/features/room-state.md +0 -280
  434. package/resource/doc/roomkit/vue/features/room-view.md +0 -241
  435. package/resource/doc/roomkit/vue/integration.md +0 -315
  436. package/resource/doc/rtcengine/faq/web_sdk/.gitkeep +0 -0
  437. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +0 -472
  438. package/resource/doc/trtc/C++/ITXDeviceManager.md +0 -388
  439. package/resource/doc/trtc/android/TXBeautyManager.md +0 -403
  440. package/resource/doc/trtc/iOS/TXBeautyManager.md +0 -404
  441. package/resource/doc/trtc/iOS/TXDeviceManager.md +0 -382
  442. package/server-config.js.map +0 -1
  443. package/server.js.map +0 -1
  444. package/streamable-http.js.map +0 -1
  445. package/tools/call/get_callkit_api.js +0 -33
  446. package/tools/call/get_callkit_api.js.map +0 -1
  447. package/tools/call/get_native_call_uikit_integration.js.map +0 -1
  448. package/tools/call/get_native_callkit_core_integration.js.map +0 -1
  449. package/tools/call/get_web_call_uikit_integration.js.map +0 -1
  450. package/tools/chat/get_native_chat_uikit_feature_detail.js +0 -35
  451. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +0 -1
  452. package/tools/chat/get_native_chat_uikit_integration.js.map +0 -1
  453. package/tools/chat/get_web_chat_uikit_component_detail.js +0 -35
  454. package/tools/chat/get_web_chat_uikit_component_detail.js.map +0 -1
  455. package/tools/chat/get_web_chat_uikit_integration.js.map +0 -1
  456. package/tools/common/get_faq.js +0 -266
  457. package/tools/common/get_faq.js.map +0 -1
  458. package/tools/common/get_usersig.js.map +0 -1
  459. package/tools/common/present_framework_choice.js.map +0 -1
  460. package/tools/common/record_answer.js.map +0 -1
  461. package/tools/common/record_feedback.js.map +0 -1
  462. package/tools/common/record_skill_session.js +0 -69
  463. package/tools/common/record_skill_session.js.map +0 -1
  464. package/tools/definitions/get_callkit_api_def.js +0 -28
  465. package/tools/definitions/get_callkit_api_def.js.map +0 -1
  466. package/tools/definitions/get_faq_def.js +0 -40
  467. package/tools/definitions/get_faq_def.js.map +0 -1
  468. package/tools/definitions/get_native_call_uikit_integration_def.js.map +0 -1
  469. package/tools/definitions/get_native_callkit_core_integration_def.js.map +0 -1
  470. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +0 -31
  471. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +0 -1
  472. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +0 -1
  473. package/tools/definitions/get_native_livekit_core_features_def.js +0 -33
  474. package/tools/definitions/get_native_livekit_core_features_def.js.map +0 -1
  475. package/tools/definitions/get_native_livekit_core_integration_def.js.map +0 -1
  476. package/tools/definitions/get_native_trtc_sdk_docs_def.js +0 -32
  477. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +0 -1
  478. package/tools/definitions/get_usersig_def.js.map +0 -1
  479. package/tools/definitions/get_web_call_uikit_integration_def.js.map +0 -1
  480. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +0 -31
  481. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +0 -1
  482. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +0 -1
  483. package/tools/definitions/get_web_live_uikit_integration_def.js.map +0 -1
  484. package/tools/definitions/get_web_livekit_api_def.js +0 -27
  485. package/tools/definitions/get_web_livekit_api_def.js.map +0 -1
  486. package/tools/definitions/get_web_livekit_component_detail_def.js +0 -29
  487. package/tools/definitions/get_web_livekit_component_detail_def.js.map +0 -1
  488. package/tools/definitions/get_web_room_uikit_integration_def.js.map +0 -1
  489. package/tools/definitions/get_web_roomkit_feature_detail_def.js +0 -30
  490. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +0 -1
  491. package/tools/definitions/get_web_trtc_sdk_api_def.js +0 -25
  492. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +0 -1
  493. package/tools/definitions/get_web_trtc_sdk_integration_def.js +0 -25
  494. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +0 -1
  495. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +0 -25
  496. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +0 -1
  497. package/tools/definitions/present_framework_choice_def.js.map +0 -1
  498. package/tools/definitions/record_answer_def.js.map +0 -1
  499. package/tools/definitions/record_feedback_def.js.map +0 -1
  500. package/tools/definitions/record_skill_session_def.js +0 -31
  501. package/tools/definitions/record_skill_session_def.js.map +0 -1
  502. package/tools/index.js.map +0 -1
  503. package/tools/live/get_native_livekit_core_features.js +0 -68
  504. package/tools/live/get_native_livekit_core_features.js.map +0 -1
  505. package/tools/live/get_native_livekit_core_integration.js.map +0 -1
  506. package/tools/live/get_web_live_uikit_integration.js.map +0 -1
  507. package/tools/live/get_web_livekit_api.js +0 -33
  508. package/tools/live/get_web_livekit_api.js.map +0 -1
  509. package/tools/live/get_web_livekit_component_detail.js +0 -35
  510. package/tools/live/get_web_livekit_component_detail.js.map +0 -1
  511. package/tools/room/get_web_room_uikit_integration.js.map +0 -1
  512. package/tools/room/get_web_roomkit_feature_detail.js +0 -69
  513. package/tools/room/get_web_roomkit_feature_detail.js.map +0 -1
  514. package/tools/rtcengine/get_web_trtc_sdk_api.js +0 -32
  515. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +0 -1
  516. package/tools/rtcengine/get_web_trtc_sdk_integration.js +0 -32
  517. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +0 -1
  518. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +0 -32
  519. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +0 -1
  520. package/tools/trtc/get_native_trtc_sdk_docs.js +0 -74
  521. package/tools/trtc/get_native_trtc_sdk_docs.js.map +0 -1
  522. package/utils/build-session-directives.js +0 -122
  523. package/utils/build-session-directives.js.map +0 -1
  524. package/utils/generate-structured-result.js.map +0 -1
  525. package/utils/generate-usersig.js.map +0 -1
  526. package/utils/get-device-identifier.js.map +0 -1
  527. package/utils/get-doc-content.js.map +0 -1
  528. package/utils/handle-framework.js +0 -9
  529. package/utils/handle-framework.js.map +0 -1
  530. package/utils/handle-state-name.js +0 -29
  531. package/utils/handle-state-name.js.map +0 -1
  532. package/utils/http-get.js.map +0 -1
  533. package/utils/http-post.js.map +0 -1
  534. package/utils/report-cls-client.js.map +0 -1
  535. package/utils/report-es-client.js.map +0 -1
  536. package/utils/report-runtime-error-cls-client.js.map +0 -1
  537. /package/resource/{doc/callkit/faq/common → knowledge/callkit/faq}/error-code.md +0 -0
  538. /package/resource/{doc/livekit/faq/common → knowledge/livekit/faq}/error-code.md +0 -0
  539. /package/resource/{doc → knowledge}/rtcengine/web/api.md +0 -0
  540. /package/resource/{doc/rtcengine/faq/web/web.md → knowledge/rtcengine/web/faq.md} +0 -0
  541. /package/resource/{doc → knowledge}/rtcengine/web/how_to_integrated_web_sdk.md +0 -0
  542. /package/resource/{doc → knowledge}/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +0 -0
  543. /package/resource/{doc → knowledge}/rtcengine/web/plugin/28-advanced-beauty.md +0 -0
  544. /package/resource/{doc → knowledge}/rtcengine/web/plugin/29-advanced-water-mark.md +0 -0
  545. /package/resource/{doc → knowledge}/rtcengine/web/plugin/30-advanced-cross-room-link.md +0 -0
  546. /package/resource/{doc → knowledge}/rtcengine/web/plugin/34-advanced-proxy.md +0 -0
  547. /package/resource/{doc → knowledge}/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -0
  548. /package/resource/{doc → knowledge}/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -0
  549. /package/resource/{doc → knowledge}/rtcengine/web/plugin/37-advanced-voice-changer.md +0 -0
  550. /package/resource/{doc → knowledge}/rtcengine/web/plugin/38-advanced-basic-beauty.md +0 -0
  551. /package/resource/{doc → knowledge}/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -0
  552. /package/resource/{doc → knowledge}/rtcengine/web/plugin/40-advanced-video-mixer.md +0 -0
  553. /package/resource/{doc → knowledge}/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +0 -0
  554. /package/resource/{doc → knowledge}/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +0 -0
  555. /package/resource/{doc → knowledge}/rtcengine/web/plugin/43-advanced-face-detection.md +0 -0
  556. /package/resource/{doc/rtcengine/faq/common → knowledge/share}/userSig.md +0 -0
@@ -2,40 +2,35 @@ TUIKit 是基于腾讯云 Chat SDK 的一款 Vue 3 UI 组件库,它提供了
2
2
 
3
3
  > **说明:**
4
4
  >
5
+ > - **AI 助手使用说明**
5
6
 
6
- > 您好!我们正在开发一款即时通讯产品 UIKit,它基于腾讯云 Chat SDK,是一款 Vue3 UI 组件库,能帮助您快速集成并实现核心功能。
7
+ > Skill 提供了** IM 知识咨询**和 **Vue3 State API 无 UI 集成**能力,您可以用 Skill 在 IDE 中直接查询 SDK、UIKit、服务端 API、产品计费等内容,也可以用 Skill 在 Vue3 项目中集成 IM 能力, [点击这里,立即体验 AI 集成和咨询助手](https://cloud.tencent.com/document/product/269/125822)。
7
8
  >
8
9
 
9
- > 您的反馈我们会**高度重视**,本问卷填写**仅需要 30 秒**!诚邀您的参与。
10
- >
11
-
12
- > **推荐使用更高效的 AI 集成助手**
13
- >
14
-
15
- > 我们为您提供了全新的 AI 集成方式,只需要简单描述您的需求,即可**自动生成集成代码**,大幅提升开发效率。
10
+ > 您好!我们正在开发一款即时通信产品 UIKit,它基于腾讯云 Chat SDK,是一款 Vue3 UI 组件库,能帮助您快速集成并实现核心功能。
16
11
  >
17
12
 
18
- > [点击这里,立即体验 AI 集成](https://cloud.tencent.com/document/product/269/124481)
13
+ > 您的反馈我们会**高度重视**,本问卷填写**仅需要 30 秒**!诚邀您的参与。
19
14
  >
20
15
 
21
16
  ## 关键概念
22
17
 
23
18
  chat-uikit-vue3 主要分为 ConversationList、Chat、MessageList、ChatHeader、MessageInput、ChatSetting、Search、Contact 等核心 UI 组件,每个 UI 组件负责展示不同的内容。
24
- 1. ConversationList 提供会话列表组件。
19
+ - ConversationList 提供会话列表组件。
25
20
 
26
- 2. Chat 提供会话的容器组件。
21
+ - Chat 提供会话的容器组件。
27
22
 
28
- 3. MessageList 提供会话的消息列表组件。
23
+ - MessageList 提供会话的消息列表组件。
29
24
 
30
- 4. ChatHeader 提供会话的头部信息组件。
25
+ - ChatHeader 提供会话的头部信息组件。
31
26
 
32
- 5. MessageInput 提供输入框组件。
27
+ - MessageInput 提供输入框组件。
33
28
 
34
- 6. ChatSetting 提供单聊和群聊的管理组件。
29
+ - ChatSetting 提供单聊和群聊的管理组件。
35
30
 
36
- 7. Search 提供云端搜索组件。
31
+ - Search 提供云端搜索组件。
37
32
 
38
- 8. Contact 提供联系人组件。
33
+ - Contact 提供联系人组件。
39
34
 
40
35
  ## 前提条件
41
36
  - Vue.js@^3.0.0
@@ -46,7 +41,7 @@ chat-uikit-vue3 主要分为 ConversationList、Chat、MessageList、ChatHeader
46
41
 
47
42
  ## 创建项目
48
43
 
49
- 使用 Vite 创建一个新的名称为 **chat-example** 的 Vue3 项目。
44
+ 使用 Vite 创建一个新的名称为 **chat-integration-vue3** 的 Vue3 项目。
50
45
 
51
46
  > **说明:**
52
47
  >
@@ -59,181 +54,202 @@ chat-uikit-vue3 主要分为 ConversationList、Chat、MessageList、ChatHeader
59
54
  npm create vite@latest
60
55
  ```
61
56
 
57
+ 脚手架选项可参考以下选择:
58
+ ``` java
59
+ ◇ Project name:
60
+ │ chat-integration-vue3
61
+ │
62
+ ◇ Select a framework:
63
+ │ Vue
64
+ │
65
+ ◇ Select a variant:
66
+ │ TypeScript
67
+ │
68
+ ◆ Install with npm and start now?
69
+ │ ● Yes / ○ No
70
+ └
71
+ ```
72
+
62
73
  ## 下载并导入组件
63
74
 
64
75
  创建项目完成后,切换到项目所在目录。
65
76
 
66
77
  【shell】
67
78
  ``` bash
68
- cd chat-example
69
- npm install
79
+ cd chat-integration-vue3
70
80
  ```
71
81
 
72
82
  ### 步骤1:安装依赖
73
83
 
84
+ > **说明:**
85
+ >
86
+
87
+ > 建议使用 npm 进行安装,npm 会主动下载所需的 peerDependencies 依赖。
88
+ >
89
+
74
90
  【shell】
75
91
  ``` bash
76
- npm i @tencentcloud/chat-uikit-vue3
92
+ npm i @tencentcloud/chat-uikit-vue3@6 tuikit-atomicx-vue3@6
77
93
  ```
78
94
 
79
95
  ### 步骤2:引入组件
80
96
 
81
97
  > **注意:**
82
98
  >
83
- > - 以下代码中未填入 `SDKAppID`、`userID` 和 `userSig`,需在 步骤3 中获取相关信息后进行替换。
84
- > - 为了尊重版权,下图所示的**默认小黄脸表情包版权属于腾讯云**,您可以通过升级至 [IM 企业版套餐](https://buy.cloud.tencent.com/avc) 免费使用该表情包。
85
99
 
86
- >
100
+ > 以下代码中未填入 `SDKAppID`、`userID` 和 `userSig`,需在 步骤3 中获取相关信息后进行替换。
87
101
  >
88
102
 
89
- #### 2.1 搭建主界面
103
+ #### 2.1 搭建入口页面
90
104
 
91
- 例如:在 `src/App.vue` 页面中写入以下代码:
105
+ 例如:在 `src/App.vue` 页面中写入以下代码,保证登录成功后进入聊天页面,避免在登录前调用 api。
92
106
  ``` typescript
93
107
  <template>
94
108
  <UIKitProvider language="zh-CN" theme="light">
95
- <div class="chat-layout">
96
- <!-- 左侧导航 -->
97
- <SideTab :active-tab="activeTab" @tab-change="handleTabChange" />
98
-
99
- <!-- 中间列表 -->
100
- <div class="conversation-list-panel">
101
- <ConversationList v-show="activeTab === 'conversations'" />
102
- <ContactList v-show="activeTab === 'contacts'" />
103
- </div>
109
+ <ChatLayout v-if="isLoggedIn" />
110
+ </UIKitProvider>
111
+ </template>
104
112
 
105
- <!-- 右侧聊天 -->
106
- <Chat
107
- v-show="activeTab === 'conversations'"
108
- class="chat-content-panel"
109
- :PlaceholderEmpty="EmptyChatTpl"
110
- >
113
+ <script setup lang="ts">
114
+ import { ref } from 'vue';
115
+ import { UIKitProvider, useLoginState } from '@tencentcloud/chat-uikit-vue3';
116
+ import ChatLayout from './components/ChatLayout.vue';
117
+
118
+ const { login } = useLoginState();
119
+ const isLoggedIn = ref(false);
120
+
121
+ login({
122
+ sdkAppId: 0, // SDKAppID, number 类型
123
+ userId: '', // UserID, string 类型
124
+ userSig: '', // userSig, string 类型
125
+ }).then(() => {
126
+ isLoggedIn.value = true;
127
+ });
128
+ </script>
129
+
130
+ <style>
131
+ body { margin: 0; padding: 0; font-family: Inter, Avenir, Helvetica, Arial, sans-serif; }
132
+ #app { width: 100vw; height: 100vh; }
133
+ #app > div { display: flex; align-items: center; justify-content: center; }
134
+ </style>
135
+ ```
136
+
137
+ #### 2.2 搭建聊天页面
138
+
139
+ 在 `src/components` 文件夹中新建一个 `ChatLayout.vue` 的文件,并写入以下内容:
140
+ ``` typescript
141
+ <template>
142
+ <div class="chat-layout">
143
+ <SideTab :active-tab="activeTab" @tab-change="(tab) => activeTab = tab" />
144
+
145
+ <div class="list-panel">
146
+ <ConversationList v-show="activeTab === 'conversations'" />
147
+ <ContactList v-show="activeTab === 'contacts'" />
148
+ </div>
149
+
150
+ <div v-show="activeTab === 'conversations'" class="chat-panel">
151
+ <Chat :PlaceholderEmpty="EmptyChatTpl">
111
152
  <ChatHeader>
112
153
  <template #ChatHeaderRight>
113
- <button class="icon-button" @click="isChatSettingShow = !isChatSettingShow">
154
+ <button class="icon-btn" @click="settingOpen = !settingOpen">
114
155
  <IconMenu size="20" />
115
156
  </button>
116
157
  </template>
117
158
  </ChatHeader>
118
159
  <MessageList />
119
- <MessageInput class="message-input-container">
160
+ <MessageInput>
120
161
  <template #headerToolbar>
121
- <div class="message-toolbar">
122
- <div class="message-toolbar-actions">
123
- <EmojiPicker />
124
- <FilePicker />
125
- <VideoPicker />
126
- <ImagePicker />
127
- <!-- 参考文档开通音视频通话服务 -->
128
- <!-- <AudioCallPicker />
129
- <VideoCallPicker /> -->
162
+ <div class="toolbar">
163
+ <div class="toolbar-left">
164
+ <EmojiPicker /><FilePicker /><VideoPicker /><ImagePicker />
130
165
  </div>
131
- <button class="icon-button" @click="isSearchInChatShow = !isSearchInChatShow">
166
+ <button class="icon-btn" @click="searchOpen = !searchOpen">
132
167
  <IconSearch size="20" />
133
168
  </button>
134
169
  </div>
135
170
  </template>
136
171
  </MessageInput>
137
-
138
- <!-- 聊天设置侧边栏 -->
139
- <div v-show="isChatSettingShow" class="chat-sidebar" :class="{ dark: theme === 'dark' }">
140
- <div class="chat-sidebar-header">
141
- <span class="chat-sidebar-title">设置</span>
142
- <button class="icon-button" @click="isChatSettingShow = false">✕</button>
143
- </div>
144
- <ChatSetting />
145
- </div>
146
-
147
- <!-- 会话内搜索侧边栏 -->
148
- <div v-show="isSearchInChatShow" class="chat-sidebar" :class="{ dark: theme === 'dark' }">
149
- <div class="chat-sidebar-header">
150
- <span class="chat-sidebar-title">群搜索</span>
151
- <button class="icon-button" @click="isSearchInChatShow = false">✕</button>
152
- </div>
153
- <Search :variant="VariantType.EMBEDDED" />
172
+ <div v-if="settingOpen" class="float-sidebar">
173
+ <ChatSetting @close="settingOpen = false" />
154
174
  </div>
155
175
  </Chat>
176
+ </div>
156
177
 
157
- <!-- 联系人详情 -->
158
- <ContactInfo
159
- v-show="activeTab === 'contacts'"
160
- class="contact-detail-panel"
161
- @send-message="handleSendMessage"
162
- />
178
+ <div v-if="searchOpen && activeTab === 'conversations'" class="search-sidebar">
179
+ <div class="search-sidebar-header">
180
+ <span class="search-sidebar-title">搜索</span>
181
+ <button class="icon-btn" @click="searchOpen = false">✕</button>
182
+ </div>
183
+ <Search :variant="VariantType.EMBEDDED" />
163
184
  </div>
164
- </UIKitProvider>
185
+
186
+ <div v-show="activeTab === 'contacts'" class="detail-panel">
187
+ <ContactInfo @send-message="activeTab = 'conversations'" />
188
+ </div>
189
+ </div>
165
190
  </template>
166
191
 
167
192
  <script setup lang="ts">
168
- import { ref, h, watch } from 'vue';
193
+ import { ref, watch } from 'vue';
169
194
  import {
170
- Chat, Search, ChatHeader, MessageList, MessageInput, ContactList, ContactInfo, ChatSetting, UIKitProvider, ConversationList, useUIKit, useLoginState, useConversationListState, EmojiPicker, FilePicker, VideoPicker, ImagePicker, VariantType, AudioCallPicker, VideoCallPicker,
195
+ Chat, Search, ChatHeader, MessageList, MessageInput,
196
+ ConversationList, ContactList, ContactInfo, ChatSetting,
197
+ EmojiPicker, FilePicker, VideoPicker, ImagePicker,
198
+ VariantType, useChatContext,
171
199
  } from '@tencentcloud/chat-uikit-vue3';
172
- import { IconMenu, IconSearch, TUIToast } from '@tencentcloud/uikit-base-component-vue3';
173
- import SideTab from './components/SideTab.vue';
200
+ import { IconMenu, IconSearch } from '@tencentcloud/uikit-base-component-vue3';
201
+ import SideTab from './SideTab.vue';
174
202
 
175
- const { theme } = useUIKit();
176
- const { login } = useLoginState();
177
- const { setActiveConversation, activeConversation } = useConversationListState();
203
+ const { activeConversation } = useChatContext();
178
204
 
179
205
  const activeTab = ref<'conversations' | 'contacts'>('conversations');
180
- const isChatSettingShow = ref(false);
181
- const isSearchInChatShow = ref(false);
182
-
183
- // 切换会话时关闭会话内侧边栏
184
- watch(() => activeConversation.value?.conversationID, (newVal, oldVal) => {
185
- if (newVal !== oldVal) {
186
- isChatSettingShow.value = false;
187
- isSearchInChatShow.value = false;
188
- }
189
- });
206
+ const settingOpen = ref(false);
207
+ const searchOpen = ref(false);
190
208
 
191
- // 登录
192
- login({
193
- sdkAppId: 0, // SDKAppID, number 类型
194
- userId: '', // UserID, string 类型
195
- userSig: '', // userSig, string 类型
196
- })
197
- .then(() => {
198
- const userID = 'administrator';
199
- const conversationID = `C2C${userID}`;
200
- setActiveConversation(conversationID);
201
- })
202
- .catch((err) => {
203
- TUIToast.error({
204
- message: err.message,
205
- duration: 5000,
206
- });
209
+ watch(() => activeConversation.value?.conversationID, () => {
210
+ settingOpen.value = false;
211
+ searchOpen.value = false;
207
212
  });
208
213
 
209
- const handleTabChange = (tab: 'conversations' | 'contacts') => {
210
- activeTab.value = tab;
211
- };
212
-
213
- const handleSendMessage = () => {
214
- activeTab.value = 'conversations';
215
- };
214
+ watch(activeTab, () => {
215
+ settingOpen.value = false;
216
+ searchOpen.value = false;
217
+ });
216
218
 
217
- // 空会话占位组件
218
- const EmptyChatTpl = h('div', { class: 'empty-placeholder' }, [
219
- h('div', { class: 'empty-icon' }, '💬'),
220
- h('div', { class: 'empty-title' }, '暂无会话'),
221
- h('div', { class: 'empty-subtitle' }, '选择一个会话开始聊天'),
222
- ]);
219
+ const EmptyChatTpl = { template: `
220
+ <div class="empty-chat">
221
+ <div style="font-size:48px;opacity:.3">💬</div>
222
+ <div style="font-size:15px;font-weight:600;color:#6c757d">暂无会话</div>
223
+ <div style="font-size:13px;color:#868e96">选择一个会话开始聊天</div>
224
+ </div>
225
+ `};
223
226
  </script>
224
227
 
225
228
  <style scoped>
226
- .chat-layout{width:calc(100vw - 64px);height:calc(100vh - 64px);max-width:1600px;max-height:900px;display:flex;border-radius:16px;box-shadow:0 20px 60px rgba(0,0,0,0.3),0 0 0 1px rgba(255,255,255,0.1);overflow:hidden;backdrop-filter:blur(10px);}.conversation-list-panel{width:300px;display:flex;flex-direction:column;border-right:1px solid var(--stroke-color-primary);overflow:hidden;}.chat-content-panel{flex:1;}.contact-detail-panel{flex:1;}.icon-button{padding:4px 6px;display:flex;align-items:center;justify-content:center;border:none;background:transparent;border-radius:4px;font-size:20px;color:var(--text-color-primary);cursor:pointer;transition:background-color 0.2s;outline:none;}.icon-button:focus{outline:none;}.icon-button:hover{background-color:var(--button-color-secondary-hover);}.icon-button:active{background-color:var(--button-color-secondary-active);}.message-toolbar{display:flex;justify-content:space-between;align-items:center;}.message-toolbar-actions{display:flex;align-items:center;gap:4px;}.chat-sidebar{position:absolute;right:0;top:0;bottom:0;min-width:300px;max-width:400px;display:flex;flex-direction:column;background-color:var(--bg-color-operate);box-shadow:var(--shadow-color) 0 0 10px;overflow:auto;z-index:1000;}.chat-sidebar.dark{box-shadow:-4px 0 16px rgba(0,0,0,0.4),-1px 0 0 rgba(255,255,255,0.1);}.chat-sidebar-header{position:sticky;top:0;display:flex;align-items:center;justify-content:space-between;padding:12px 16px;background-color:var(--bg-color-operate);border-bottom:1px solid var(--stroke-color-primary);z-index:10;}.chat-sidebar-title{font-size:16px;font-weight:500;color:var(--text-color-primary);}.empty-placeholder{flex:1;display:flex;flex-direction:column;align-items:center;justify-content:center;gap:12px;background-color:var(--bg-color-operate);border-left:1px solid rgba(0,0,0,0.08);color:#adb5bd;}.empty-icon{font-size:64px;opacity:0.3;}.empty-title{font-size:16px;font-weight:600;color:#6c757d;}.empty-subtitle{font-size:14px;color:#868e96;}img[alt="empty"]{display:none;}.message-input-container{border-top:1px solid var(--stroke-color-primary);}.call-kit{position:fixed;top:50%;left:50%;z-index:999;transform:translate(-50%,-50%);max-width:800px;max-height:600px;}
229
+ .chat-layout { height: 60vh; aspect-ratio: 16/9; display: flex; border-radius: 16px; box-shadow: 0 20px 60px rgba(0,0,0,.3), 0 0 0 1px rgba(255,255,255,.1); overflow: hidden; }
230
+ @media (max-width: 1920px) { .chat-layout { height: 80vh; } }
231
+ .list-panel { width: 300px; display: flex; flex-direction: column; border-right: 1px solid var(--stroke-color-primary); overflow: hidden; }
232
+ .detail-panel { flex: 1; }
233
+ .icon-btn { padding: 4px 6px; display: flex; align-items: center; justify-content: center; border: none; background: transparent; border-radius: 4px; font-size: 20px; color: var(--text-color-primary); cursor: pointer; outline: none; }
234
+ .icon-btn:hover { background-color: var(--button-color-secondary-hover); }
235
+ .toolbar { display: flex; justify-content: space-between; align-items: center; }
236
+ .toolbar-left { display: flex; align-items: center; gap: 4px; }
237
+ .search-sidebar { border-left: 1px solid var(--stroke-color-primary); display: flex; flex-direction: column; flex: 0 0 300px; }
238
+ .search-sidebar-header { display: flex; align-items: center; justify-content: space-between; padding: 12px 16px; border-bottom: 1px solid var(--stroke-color-primary); }
239
+ .search-sidebar-title { font-size: 16px; font-weight: 500; color: var(--text-color-primary); }
240
+ .chat-panel { flex: 1; position: relative; display: flex; }
241
+ .float-sidebar { position: absolute; right: 0; top: 0; bottom: 0; min-width: 300px; max-width: 400px; display: flex; flex-direction: column; background-color: var(--bg-color-operate); box-shadow: -2px 0 8px rgba(0,0,0,.04), -4px 0 16px rgba(0,0,0,.06); overflow: auto; z-index: 1000; }
242
+ .empty-chat { flex: 1; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 8px; background-color: var(--bg-color-operate); border-left: 1px solid rgba(0,0,0,.08); }
227
243
  </style>
228
244
 
229
245
  <style>
230
- #app{background:linear-gradient(135deg,#667eea 0%,#764ba2 100%) !important;width:100vw !important;height:100vh !important;text-align:start !important;max-width:none !important;display:flex !important;align-items:center !important;justify-content:center !important}
246
+ #app { text-align: start; }
231
247
  </style>
232
248
  ```
233
249
 
234
- #### 2.2 引入侧边导航
250
+ #### 2.3 引入侧边导航
235
251
 
236
- 在 `src/component` 文件夹中新建一个 `SideTab.vue` 的文件,并写入以下内容:
252
+ 在 `src/components` 文件夹中新建一个 `SideTab.vue` 的文件,并写入以下内容:
237
253
  ``` typescript
238
254
  <template>
239
255
  <div class="side-tab" :class="{ dark: isDark }">
@@ -301,20 +317,20 @@ const handleTabChange = (tab: 'conversations' | 'contacts') => {
301
317
 
302
318
  ### 步骤3:获取 SDKAppID、userID 和 userSig
303
319
 
304
- 在上一步的 `src/App.vue`文件中的 login 函数,填入登录信息 SDKAppID、userID 和 userSig。
320
+ 在上一步的 `src/App.vue` 文件中的 login 函数,填入登录信息 SDKAppID、userID 和 userSig。
305
321
  ``` java
306
322
  // 登录
307
323
  login({
308
- sdkAppId : , // SDKAppID, number 类型
309
- userId: '', // UserID, string 类型
310
- userSig: '', // userSig, string 类型
324
+ sdkAppId: 0, // number 类型
325
+ userId: '', // string 类型
326
+ userSig: '', // string 类型
311
327
  });
312
328
  ```
313
329
  | 参数 | 类型 | 说明 |
314
330
  | --- | --- | --- |
315
- | SDKAppID | Number | SDKAppID 是腾讯云 IM 客户应用的唯一标识。您可以在 [即时通信 IM 控制台](https://console.cloud.tencent.com/im) 创建新应用,获取 SDKAppID 。<br>**说明:**<br>SDKAppID 是腾讯云 IM 客户应用的唯一标识。我们建议每一个独立的 App 都申请一个新的 SDKAppID。不同 SDKAppID 之间的消息是天然隔离的,不能互通。 |
331
+ | SDKAppID | Number | SDKAppID 是腾讯云 IM 客户应用的唯一标识。您可以在 <a href="https://console.cloud.tencent.com/im">即时通信 IM 控制台</a> 创建新应用,获取 SDKAppID 。<br><strong>说明:</strong><br>SDKAppID 是腾讯云 IM 客户应用的唯一标识。我们建议每一个独立的 App 都申请一个新的 SDKAppID。不同 SDKAppID 之间的消息是天然隔离的,不能互通。 |
316
332
  | userID | String | 用户的唯一标识符,由您定义,只能包含大小写字母(a-z,A-Z)、数字(0-9)、下划线和连字符。 |
317
- | userSig | String | 用户登录即时通信 IM 的密码,其本质是对 UserID 等信息加密后得到的密文。<br>**说明:**<br>开发环境:快速跑通 Demo,可以通过 [即时通信 IM 控制台](https://console.cloud.tencent.com/im) 获取 UserSig。<br>生产环境:将 UserSig 的计算代码集成到您的服务端,并提供面向项目的接口, 正确的 UserSig 签发方式请参见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。 |
333
+ | userSig | String | 用户登录即时通信 IM 的密码,其本质是对 UserID 等信息加密后得到的密文。<br><strong>说明:</strong><br>开发环境:快速跑通 Demo,可以通过 <a href="https://console.cloud.tencent.com/im">即时通信 IM 控制台</a> 获取 UserSig。<br>生产环境:将 UserSig 的计算代码集成到您的服务端,并提供面向项目的接口, 正确的 UserSig 签发方式请参见 <a href="https://cloud.tencent.com/document/product/269/32688">服务端生成 UserSig</a>。 |
318
334
 
319
335
  > **注意:**
320
336
  >
@@ -326,7 +342,7 @@ login({
326
342
 
327
343
  - userID:单击 [即时通信 IM 控制台 > 消息服务 Chat > 账号管理](https://console.cloud.tencent.com/im/account-management),切换至目标应用所在账号,您可以创建 2~3 个账号用于体验单聊、群聊的功能。
328
344
 
329
- - userSig:单击 [即时通信 IM 控制台 > 开发工具 > UserSig生成校验](https://console.cloud.tencent.com/im/tool-usersig),切换至目标应用所在账号,填写创建的 UserID,即可生成 UserSig。
345
+ - userSig:单击 [即时通信 IM 控制台 > 开发工具 > UserSig 生成校验](https://console.cloud.tencent.com/im/tool-usersig),切换至目标应用所在账号,填写创建的 UserID,即可生成 UserSig。
330
346
 
331
347
  ## 运行和测试
332
348
 
@@ -339,9 +355,9 @@ login({
339
355
 
340
356
  > **注意:**
341
357
  >
342
- > 1. 请确保 步骤3 代码中 SDKAppID、userID 和 userSig 均已成功替换,如未替换将会导致项目表现异常。
343
- > 2. userID 和 userSig 为一一对应关系。
344
- > 3. 如遇到项目启动失败,请检查 开发环境要求 是否满足。
358
+ > - 请确保 步骤3 代码中 SDKAppID、userID 和 userSig 均已成功替换,如未替换将会导致项目表现异常。
359
+ > - userID 和 userSig 为一一对应关系。
360
+ > - 如遇到项目启动失败,请检查 开发环境要求 是否满足。
345
361
 
346
362
  ## 集成更多高级特性
347
363
 
@@ -356,12 +372,12 @@ login({
356
372
  > 更多详细信息可参考:音视频通话-开通服务。
357
373
  >
358
374
 
359
- 1. 安装 `@tencentcloud/call-uikit-vue` 依赖。
375
+ 1. 安装 `@trtc/calls-uikit-vue` 依赖。
360
376
 
361
377
  ``` bash
362
- npm install @tencentcloud/call-uikit-vue
378
+ npm install @trtc/calls-uikit-vue
363
379
  ```
364
- 2. 从 `@tencentcloud/call-uikit-vue` 导出 `TUICallKit`,并挂载到 DOM 节点上。
380
+ 2. 从 `@trtc/calls-uikit-vue` 导出 `TUICallKit`,并挂载到 DOM 节点上。
365
381
 
366
382
  在 `src/App.vue` 文件中继续补充下面的代码:
367
383
 
@@ -377,7 +393,7 @@ login({
377
393
 
378
394
  <script setup lang="ts">
379
395
  // 导入音视频通话核心组件
380
- import { TUICallKit } from '@tencentcloud/call-uikit-vue';
396
+ import { TUICallKit } from '@trtc/calls-uikit-vue';
381
397
  </script>
382
398
  ```
383
399
  3. 打开 `<MessageInput />` 组件中 `#headerToolbar` 插槽内的注释。
@@ -421,14 +437,14 @@ login({
421
437
  >
422
438
 
423
439
  云端搜索在“步骤 2”中已经默认集成,如果需要关闭云端搜索功能,请参考以下代码:
424
- 1. 设置 `ConversationList` 的 `enableSearch` 属性为 `false`
440
+ 1. 设置 `ConversationList` 的 `enableSearch` 属性为 `false`:
425
441
 
426
442
  ``` typescript
427
443
  <template>
428
444
  <ConversationList v-show="activeTab === 'conversations'" :enable-search="false" />
429
445
  </template>
430
446
  ```
431
- 2. 注释会话内搜索侧边栏相关的代码
447
+ 2. 注释会话内搜索侧边栏相关的代码:
432
448
 
433
449
  ``` typescript
434
450
  <template>
@@ -470,6 +486,10 @@ const isChatSettingShow = ref(false);
470
486
  </el-drawer>
471
487
  ```
472
488
 
489
+ ### 表情包使用
490
+
491
+ 为了尊重版权,下图所示的**默认小黄脸表情包版权属于腾讯云**,您可以通过升级至 [IM 企业版套餐](https://buy.cloud.tencent.com/avc) 免费使用该表情包。
492
+
473
493
  ## 参考信息
474
494
 
475
495
  ### 官网文档
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## 快速体验
6
6
 
7
- 您可以在 在线体验 中使用 [在线开播网站](https://web.sdk.qcloud.com/trtc/livekit/pusher/index.html#/?fromMark=123016) 快速开启一场直播,同时您也可以使用 [在线观看网站](https://web.sdk.qcloud.com/trtc/livekit/player/index.html#/?fromMark=123016) 来查看账户下直播列表。
7
+ 您可以在 在线体验 中使用 [在线开播网站](https://web.sdk.qcloud.com/trtc/livekit/pusher/index.html#/) 快速开启一场直播,同时您也可以使用 [在线观看网站](https://web.sdk.qcloud.com/trtc/livekit/player/index.html#/) 来查看账户下直播列表。
8
8
 
9
9
  ## 快速接入
10
10
 
@@ -110,7 +110,7 @@ onMounted(async () => {
110
110
 
111
111
  #### 步骤1:配置页面路由
112
112
 
113
- 请配置您的 Vue Router,将`live-list.vue` 映射到直播列表页面。
113
+ 请配置您的 Vue Router,将 `live-list.vue` 映射到直播列表页面。
114
114
 
115
115
  > **注意:**
116
116
  >
@@ -186,10 +186,10 @@ function handleLiveRoomClick(liveInfo: LiveInfo) {
186
186
  ## 自由定制
187
187
 
188
188
  根据上述功能展示图,我们也支持您根据项目需求对直播列表页面进行 UI 定制。主要可供定制的能力如下表所示。
189
- | **类别** | **功能** | **描述** |
189
+ | <strong>类别</strong> | <strong>功能</strong> | <strong>描述</strong> |
190
190
  | --- | --- | --- |
191
- | **直播间列表** | 自定义直播间列表区域展示 | **支持:**<br>- **直播间信息文字 展示/隐藏、UI 进行定制。**<br>- **直播间一行/一列展示固定数量定制。** |
192
- | **个人信息** | 自定义个人信息展示 | **支持:**<br>- **展示/隐藏个人信息。**<br>- **个人信息字体、颜色 UI 自定义设置。** |
191
+ | <strong>直播间列表</strong> | 自定义直播间列表区域展示 | <strong>支持:</strong><br>- <strong>直播间信息文字 展示/隐藏、UI 进行定制。</strong><br>- <strong>直播间一行/一列展示固定数量定制。</strong> |
192
+ | <strong>个人信息</strong> | 自定义个人信息展示 | <strong>支持:</strong><br>- <strong>展示/隐藏个人信息。</strong><br>- <strong>个人信息字体、颜色 UI 自定义设置。</strong> |
193
193
 
194
194
  ### 颜色主题及语言
195
195
 
@@ -211,12 +211,12 @@ import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
211
211
  ### 按钮 Button 和 图标 Icon
212
212
 
213
213
  您可以对按钮、图标等控件进行自定义。以` live-list.vue` 为例,对` Button`、`Icon` 控件执行增删改等操作都可以满足您的自定义需求。除布局调整外,我们还支持对颜色、字体、圆角以及输入框、弹框等内容进行全面修改,充分满足您的 UI 定制需求。
214
- | **类别** | **功能** | **描述** |
214
+ | <strong>类别</strong> | <strong>功能</strong> | <strong>描述</strong> |
215
215
  | --- | --- | --- |
216
- | **素材管理** | 自定义素材管理区域展示 | 支持调整 Icon 的大小、颜色或对 Icon 进行替换。 |
217
- | **直播工具** | 自定义直播工具信息展示 | 支持调整 Icon 的大小、颜色或对 Icon 进行替换。 |
218
- | **在线观众** | 自定义观众信息展示 | 支持:<br>- 展示/隐藏观众等级。<br>- 观众信息字体、颜色 UI 自定义设置。<br>- 替换为您需要的 Icon 风格。 |
219
- | **消息列表** | 自定义消息弹幕区域展示 | 支持:<br>- 展示/隐藏聊天输入区域。<br>- 支持 UI 定制聊天气泡风格、定制观众等级等内容。 |
216
+ | <strong>素材管理</strong> | 自定义素材管理区域展示 | 支持调整 Icon 的大小、颜色或对 Icon 进行替换。 |
217
+ | <strong>直播工具</strong> | 自定义直播工具信息展示 | 支持调整 Icon 的大小、颜色或对 Icon 进行替换。 |
218
+ | <strong>在线观众</strong> | 自定义观众信息展示 | 支持:<br>- 展示/隐藏观众等级。<br>- 观众信息字体、颜色 UI 自定义设置。<br>- 替换为您需要的 Icon 风格。 |
219
+ | <strong>消息列表</strong> | 自定义消息弹幕区域展示 | 支持:<br>- 展示/隐藏聊天输入区域。<br>- 支持 UI 定制聊天气泡风格、定制观众等级等内容。 |
220
220
 
221
221
  ### 设置昵称及头像
222
222
 
@@ -236,9 +236,9 @@ await setSelfInfo({
236
236
  ## 下一步
237
237
 
238
238
  恭喜您,现在您已经成功集成了**直播列表页面**。接下来,您可以实现**主播开播页**、**观众观看页**和 **UI 自定义**等内容,可参考下表:
239
- | **功能** | **描述** | **集成指引** |
239
+ | <strong>功能</strong> | <strong>描述</strong> | <strong>集成指引</strong> |
240
240
  | --- | --- | --- |
241
- | **观众观看** | 实现观众进入主播的直播间后观看直播,实现观众连麦 、直播间信息、在线观众、弹幕显示等功能。 | 观众观看(Web Vue3) |
242
- | **主播开播** | 主播在当前页面开始直播及相关设置。 | 主播开播(Web Vue3) |
243
- | **UI 自定义** | 更详细的 UI 组件自定义指引。 | UI 自定义 |
244
- | **Web 监播** | 运营平台,支持直播间管控。 | 监播页面(Web Vue3) |
241
+ | <strong>观众观看</strong> | 实现观众进入主播的直播间后观看直播,实现观众连麦 、直播间信息、在线观众、弹幕显示等功能。 | 观众观看(Web Vue3) |
242
+ | <strong>主播开播</strong> | 主播在当前页面开始直播及相关设置。 | 主播开播(Web Vue3) |
243
+ | <strong>UI 自定义</strong> | 更详细的 UI 组件自定义指引。 | UI 自定义 |
244
+ | <strong>直播管理系统</strong> | 运营平台,支持直播间管控。 | 直播管理系统(Vue3) |
@@ -1,5 +1,11 @@
1
1
  本文对 TUILiveKit Demo 中的**观看页面**进行了详细的介绍,您可以在已有项目中直接参考本文档集成我们开发好的观看页面,也可以根据您的需求按照文档中的内容对页面的样式,布局以及功能项进行深度的定制。
2
2
 
3
+ > **集成提示****:**
4
+ >
5
+
6
+ > 本文档介绍基于 **UI 组件** 的观众观看方式(含完整交互 UI)。若您需通过 **Core SDK** 自行搭建观众端界面,请参考 观众观看 (Core SDK)。
7
+ >
8
+
3
9
  ## 功能展示
4
10
 
5
11
  观看页面提供默认行为和风格,但如果默认行为和样式不能完全满足您的需求,您也可以对 UI 进行自定义。图中显示的数字与特定功能列表中的类别相对应。其中主要包含直播**信息展示、视频直播区域、在线观众、音视频操作、直播时长、画面分辨率切换、全屏功能、聊天互动、消息列表等。**
@@ -13,6 +19,12 @@
13
19
 
14
20
  - **H5 移动平台支持**:跨平台兼容。
15
21
 
22
+ > **说明:**
23
+ >
24
+
25
+ > 本文档主要介绍观众端的核心功能逻辑。如果您需要修改观众端的界面样式(如修改某些默认控件、修改图标和颜色、调整弹窗风格),请直接前往 调整界面风格 指南进行配置。
26
+ >
27
+
16
28
  ## 快速接入
17
29
 
18
30
  ### 步骤1:环境配置及开通服务
@@ -40,7 +52,7 @@ yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
40
52
 
41
53
  ### 步骤3:观看页面接入
42
54
 
43
- 在您的项目下创建`live-player.vue`文件,可直接复制如下代码至您的项目中集成**观看页面**。
55
+ 在您的项目下创建 `live-player.vue`文件,可直接复制如下代码至您的项目中集成**观看页面**。
44
56
 
45
57
  > **注意:**
46
58
  >
@@ -150,7 +162,7 @@ npm run dev
150
162
  ### 步骤1:开启一场直播
151
163
  - **方式一(推荐):**
152
164
 
153
- 使用我们提供的 [在线开播网站](https://web.sdk.qcloud.com/trtc/livekit/pusher/index.html#/?fromMark=123004) ,开启一场直播来观看,开启后获取直播间 ID
165
+ 使用我们提供的 [在线开播网站](https://web.sdk.qcloud.com/trtc/livekit/pusher/index.html#/) ,开启一场直播来观看,开启后获取直播间 ID
154
166
 
155
167
  - **方式二:**
156
168
 
@@ -229,21 +241,21 @@ import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
229
241
 
230
242
  ### 按钮 Button 和图标 Icon
231
243
 
232
- 若您需要对按钮 Button 或图标 Icon 等其他控件进行新增或替换等 UI 定制,您可以通过如下方式实现,以`live-player.vue `文件中的按钮和图标为例,您可以参考下图找到对应按钮或图标的指定位置源码,对当前部分的控件进行**增加、删除、替换**等 UI 定制操作。
244
+ 若您需要对按钮 Button 或图标 Icon 等其他控件进行新增或替换等 UI 定制,您可以通过如下方式实现,以 `live-player.vue `文件中的按钮和图标为例,您可以参考下图找到对应按钮或图标的指定位置源码,对当前部分的控件进行**增加、删除、替换**等 UI 定制操作。
233
245
 
234
246
  根据上述示例,我们同样支持您根据项目需求对**观众观看页面**进行 UI 定制的能力。除了页面 UI 布局调整,我们也支持您对**颜色主题、字体、圆角、按钮、图标、输入框、弹框等**内容进行**增加、删除、修改**等操作,满足您的 UI 定制需要。
235
- | **类别** | **功能** | **描述** |
247
+ | <strong>类别</strong> | <strong>功能</strong> | <strong>描述</strong> |
236
248
  | --- | --- | --- |
237
- | **素材管理** | 自定义素材管理区域展示 | 支持调整 Icon 的大小、颜色或对 Icon 进行替换。 |
238
- | **直播工具** | 自定义直播工具信息展示 | 支持调整 Icon 的大小、颜色或对 Icon 进行替换。 |
239
- | **在线观众** | 自定义观众信息展示 | **支持:**<br>- 展示/隐藏观众等级。<br>- 观众信息字体、颜色 UI 自定义设置。<br>- 替换为您需要的 Icon 风格。 |
240
- | **消息列表** | 自定义消息弹幕区域展示 | **支持:**<br>- 展示/隐藏聊天输入区域。<br>- 支持 UI 定制聊天气泡风格、定制观众等级等内容。 |
249
+ | <strong>素材管理</strong> | 自定义素材管理区域展示 | 支持调整 Icon 的大小、颜色或对 Icon 进行替换。 |
250
+ | <strong>直播工具</strong> | 自定义直播工具信息展示 | 支持调整 Icon 的大小、颜色或对 Icon 进行替换。 |
251
+ | <strong>在线观众</strong> | 自定义观众信息展示 | <strong>支持:</strong><br>- 展示/隐藏观众等级。<br>- 观众信息字体、颜色 UI 自定义设置。<br>- 替换为您需要的 Icon 风格。 |
252
+ | <strong>消息列表</strong> | 自定义消息弹幕区域展示 | <strong>支持:</strong><br>- 展示/隐藏聊天输入区域。<br>- 支持 UI 定制聊天气泡风格、定制观众等级等内容。 |
241
253
 
242
254
  ## 常见问题
243
255
 
244
256
  ### 浏览器自动播放限制
245
257
 
246
- 出于用户体验考虑,现代浏览器对网页自动播放 (Autoplay) 功能实施了限制性策略:所有带声音的媒体内容必须经过用户主动交互(如点击或触摸)后才能播放。这项限制主要是为了防止网站在用户未明确同意的情况下突然播放音频,避免对用户造成干扰。大多数浏览器都不限制无声视频的自动播放,但是在低电量模式下的 iOS Safari 浏览器中以及开启了自定义自动播放限制的 iOS WKWebView 中(如 iOS 微信浏览器),无声视频的自动播放也会受到限制。
258
+ 出于用户体验考虑,现代浏览器对网页自动播放 (Autoplay) 功能实施了限制性策略:所有带声音的媒体内容必须经过用户主动交互(如点击或触摸)后才能播放。这项限制主要是为了防止网站在用户未明确同意的情况下突然播放音频,避免对用户造成干扰。大多数浏览器都不限制无声视频的自动播放,但是在低电量模式下的 iOS Safari 浏览器中以及开启了自定义自动播放限制的 iOS WKWebView 中(例如 iOS 微信浏览器),无声视频的自动播放也会受到限制。
247
259
 
248
260
  #### 自动播放失败表现
249
261
 
@@ -294,8 +306,8 @@ export { useCustomizedAutoPlayDialog };
294
306
  ## 下一步
295
307
 
296
308
  恭喜您,现在您已经成功集成了观众观看功能。接下来,您可以继续接入**直播列表、UI 自定义**和**监播**等功能:
297
- | **功能** | **描述** | **集成指引** |
309
+ | <strong>功能</strong> | <strong>描述</strong> | <strong>集成指引</strong> |
298
310
  | --- | --- | --- |
299
- | **直播列表** | 展示直播列表界面和功能,包含直播列表和房间信息展示功能。 | 直播列表(Web Vue3) |
300
- | **UI 自定义** | 更详细的 UI 组件自定义指引。 | 概述 |
301
- | **Web 监播** | 运营平台,支持直播间管控。 | Web 监播页(Web Vue3) |
311
+ | <strong>直播列表</strong> | 展示直播列表界面和功能,包含直播列表和房间信息展示功能。 | 直播列表(Web Vue3) |
312
+ | <strong>UI 自定义</strong> | 更详细的 UI 组件自定义指引。 | 概述 |
313
+ | <strong>直播管理系统</strong> | 运营平台,支持直播间管控。 | 直播管理系统(Vue3) |