@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
@@ -1,291 +0,0 @@
1
- 本文对**弹幕组件**进行了详细的介绍,其中包含**弹幕消息组件(BarrageList)**和**消息发送组件(BarrageInput)。**您可以在已有项目中直接参考本文示例集成我们开发好的整体组件,也可以根据您的需求按照文档中的组件自定义部分对样式,布局进行深度的定制。
2
-
3
- ## 组件构成
4
- | **组件名称** | **具体内容** |
5
- | --- | --- |
6
- | **弹幕消息组件(BarrageList)** | 负责实时展示和管理弹幕消息流的组件,提供**消息列表渲染、时间聚合、用户交互和响应式适配**等完整的消息展示解决方案。 |
7
- | **消息发送组件(BarrageInput)** | 提供富文本编辑和消息发送功能的输入组件,集成**表情选择器、字符限制、状态管理和跨平台适配**,为用户提供流畅的消息输入体验。 |
8
-
9
- ## 组件接入
10
-
11
- ### 步骤1:环境配置及开通服务
12
-
13
- 在进行快速接入之前,您需要参考准备工作,满足相关环境配置及开通对应服务。
14
-
15
- ### 步骤2:安装依赖
16
-
17
- 【npm】
18
- ``` bash
19
- npm install tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3 --save
20
- ```
21
-
22
- 【pnpm】
23
- ``` bash
24
- pnpm add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
25
- ```
26
-
27
- 【yarn】
28
- ``` bash
29
- yarn add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
30
- ```
31
-
32
- ### 步骤3:集成弹幕组件
33
-
34
- 在您的项目中引入并使用弹幕组件,可直接复制如下示例至您的项目中展示**完整的直播间弹幕消息组件以及消息发送组件**。
35
- ``` typescript
36
- <template>
37
- <UIKitProvider theme="dark" language="zh-CN">
38
- <div class="app">
39
- <div class="chat-container">
40
- <div class="chat-content">
41
- <BarrageList class="barrage-list" />
42
- </div>
43
- <div class="chat-input">
44
- <BarrageInput class="barrage-input" />
45
- </div>
46
- </div>
47
- </div>
48
- </UIKitProvider>
49
- </template>
50
-
51
- <script setup lang="ts">
52
- import { onMounted, ref } from 'vue';
53
- import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
54
- import { BarrageList, BarrageInput, useLoginState, useLiveState } from 'tuikit-atomicx-vue3';
55
-
56
- const { login, loginUserInfo } = useLoginState();
57
- const { joinLive } = useLiveState();
58
-
59
- async function initLogin() {
60
- try {
61
- await login({
62
- sdkAppId: 0, // SDKAppID, 可以参考步骤 1 获取
63
- userId: '', // UserID, 可以参考步骤 1 获取
64
- userSig: '', // userSig, 可以参考步骤 1 获取
65
- });
66
- } catch (error) {
67
- console.error('登录失败:', error);
68
- }
69
- }
70
-
71
- onMounted(async () => {
72
- await initLogin();
73
- await joinLive({
74
- liveId: '输入对应直播间 LiveId', // 输入对应 liveId 进入直播间
75
- });
76
- });
77
- </script>
78
-
79
- <style scoped>.app{width:100vw;height:100vh;display:flex;justify-content:center;align-items:center;padding:20px;box-sizing:border-box}.chat-container{width:100%;max-width:500px;height:600px;border-radius:16px;display:flex;flex-direction:column;overflow:hidden}.chat-content{flex:1;overflow:hidden}.barrage-list{width:100%;height:100%}.chat-input{background-color:var(--bg-color-dialog);padding:16px}.barrage-input{width:100%}</style>
80
- ```
81
-
82
- ## 自定义组件
83
-
84
- **弹幕消息组件**分别为用户自定义需求提供了丰富且多维度的`Props` 接口,允许用户自定义功能或自定义 UI 等,具体参数内容如下表所示。
85
-
86
- > **说明:**
87
- >
88
-
89
- > 若您需要直接了解弹幕消息组件(BarrageList)的自定义的详细内容可快速跳转如下链接:弹幕消息组件自定义;
90
- >
91
-
92
- > 若您需要直接了解消息发送组件(BarrageInput)的自定义的详细内容可快速跳转如下链接:消息发送组件自定义;
93
- >
94
-
95
- ### 弹幕消息组件(BarrageList)自定义
96
-
97
- #### **Props**
98
- | **参数名** | **参数类型** | **默认值** | **说明** |
99
- | --- | --- | --- | --- |
100
- | messageAggregationTime | Number | 300 | 消息分组的最大时间间隔(秒)。 |
101
- | filter | (message: IMessageModel) => boolean | - | 用于筛选消息的函数。 |
102
- | Message | Component | Message | 自定义消息组件。 |
103
- | MessageTimeDivider | Component | MessageTimeDivider | 自定义消息时间分割线组件。 |
104
- | LocalNoticeMessage | Component | LocalNoticeMessage | 自定义本地通知消息组件。 |
105
- | containerStyle | CSSProperties | - | 自定义消息列表容器样式。 |
106
- | itemStyle | CSSProperties | - | 自定义单条消息项样式。 |
107
- | height | String | - | 组件高度,支持CSS单位。 |
108
- | style | CSSProperties | - | 指定根元素样式的自定义样式。 |
109
-
110
- 如上表所示,弹幕消息组件的 Props 自定义部分由三块内容组成,分别为**组件属性、可替换子组件、自定义样式,**具体内容如下表所示。
111
- | **内容** | **参数** |
112
- | --- | --- |
113
- | **组件属性** | `filter`、`messageAggregationTime` |
114
- | **可替换子组件** | `Message`、`MessageTimeDivider`、`LocalNoticeMessage` |
115
- | **自定义样式** | `ContainerStyle`、`ItemStyle`、`height`、`style` |
116
-
117
- #### 消息筛选
118
-
119
- 通过设置 `filter` 参数,您可以灵活地控制弹幕消息组件中显示的消息内容。
120
- ``` typescript
121
- <BarrageList :filter="(message) => message.type === 'TIMTextElem'" />
122
- ```
123
-
124
- #### 消息聚合时间
125
-
126
- 通过设置 `messageAggregationTime` 参数,您可以控制消息分组的时间间隔。
127
- ``` typescript
128
- <BarrageList :messageAggregationTime="300" />
129
- ```
130
-
131
- #### 自定义样式
132
-
133
- 弹幕消息组件提供了 `containerStyle`、`itemStyle`、`自定义子组件` 等内容,用于自定义组件样式。
134
- 1. 要自定义消息列表容器样式,您可以给 `containerStyle` 属性传递一个样式对象。
135
-
136
- **示例:自定义容器内边距**
137
-
138
- ``` typescript
139
- <BarrageList :containerStyle="{ padding: '0px' }" />
140
- ```
141
- 2. 要自定义单条消息样式,您可以给 `itemStyle` 属性传递一个样式对象。
142
-
143
- **示例:自定义消息项间距和边框及消息气泡颜色**
144
-
145
- ``` typescript
146
- <BarrageList :itemStyle="{ borderRadius: '10px', background: '#1C66e5', padding: '10px', boxSizing: 'border-box'}" />
147
- ```
148
- 3. 弹幕消息组件支持自定义消息展示组件,您可以完全控制消息的渲染方式。
149
-
150
- **示例:自定义消息组件**
151
-
152
- ``` typescript
153
- // MyCustomMessage.vue
154
- <template>
155
- <div class="custom-message">
156
- <div class="message-header">
157
- <span class="user-name">{{ getUserName(message) }}</span>
158
- <span class="message-time">{{ formatTime(message.time) }}</span>
159
- </div>
160
- <div class="message-content">
161
- {{ getMessageText(message) }}
162
- </div>
163
- </div>
164
- </template>
165
-
166
- <script setup lang="ts">
167
- interface SimpleMessage {
168
- id: string;
169
- from: string;
170
- nick?: string;
171
- nameCard?: string;
172
- time: number;
173
- type: string;
174
- content: string;
175
- avatar?: string;
176
- }
177
-
178
- interface Props {
179
- message: SimpleMessage;
180
- isLastInChunk?: boolean;
181
- }
182
-
183
- const props = defineProps<Props>();
184
-
185
- const formatTime = (timestamp: number) => {
186
- return new Date(timestamp * 1000).toLocaleTimeString('zh-CN', {
187
- hour: '2-digit',
188
- minute: '2-digit'
189
- });
190
- };
191
-
192
- const getUserName = (message: SimpleMessage) => {
193
- return message.nameCard || message.nick || message.from || '匿名用户';
194
- };
195
-
196
- const getMessageText = (message: SimpleMessage) => {
197
- if (message.type === 'text') {
198
- return message.content || '';
199
- } else if (message.type === 'image') {
200
- return '[图片消息]';
201
- } else if (message.type === 'emoji') {
202
- return '[表情消息]';
203
- }
204
- return '[其他类型消息]';
205
- };
206
- </script>
207
-
208
- <style scoped>.custom-message{background:linear-gradient(135deg,#667eea 0%,#764ba2 100%);color:white;padding:12px;border-radius:12px;margin:4px 0;box-shadow:0 2px 8px rgba(0,0,0,0.1);transition:transform 0.2s ease}.custom-message:hover{transform:translateY(-2px)}.message-header{display:flex;justify-content:space-between;align-items:center;margin-bottom:8px;font-size:12px;opacity:0.9}.user-name{font-weight:500;max-width:120px;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.message-time{font-size:11px;opacity:0.7}.message-content{font-size:14px;line-height:1.4;word-break:break-word}</style>
209
-
210
- // 在 弹幕消息组件 中使用
211
- <template>
212
- <BarrageList :Message="MyCustomMessage" />
213
- </template>
214
-
215
- <script setup lang="ts">
216
- import MyCustomMessage from "./MyCustomMessage.vue";
217
- </script>
218
- ```
219
- | **修改前** | **修改后** | | |
220
- | --- | --- | --- | --- |
221
- | **自定义容器内边距** | **自定义消息项间距和边框** | **自定义消息组件** | |
222
- | | | | |
223
-
224
- ### 消息发送组件(BarrageInput)自定义
225
-
226
- #### **Props**
227
- | **参数名** | **类型** | **默认值** | **说明** |
228
- | --- | --- | --- | --- |
229
- | containerClass | String | '' | 自定义容器的 CSS 类名。 |
230
- | containerStyle | Record | {} | 自定义容器的内联样式。 |
231
- | width | String | - | 组件宽度,支持CSS单位。 |
232
- | height | String | - | 组件高度,支持CSS单位。 |
233
- | minHeight | String | '40px' | 组件最小高度,支持CSS单位。 |
234
- | maxHeight | String | '140px' | 组件最大高度,支持CSS单位。 |
235
- | placeholder | String | - | 输入框占位符文本。 |
236
- | disabled | Boolean | false | 是否禁用输入框。 |
237
- | autoFocus | Boolean | true | 是否自动聚焦到输入框。 |
238
- | maxLength | Number | 80 | 输入内容的最大字符数限制。 |
239
-
240
- #### **Events**
241
- | **事件名** | **参数** | **说明** |
242
- | --- | --- | --- |
243
- | focus | - | 输入框获得焦点时触发。 |
244
- | blur | - | 输入框失去焦点时触发。 |
245
-
246
- 如上表所示,消息发送组件的 Props 自定义部分由三块内容组成,分别为**尺寸控制、输入限制、自定义样式,**具体内容如下表所示。
247
- | **内容** | **参数** |
248
- | --- | --- |
249
- | **尺寸控制** | `width`、`height`、`minHeight`、`minWidth` |
250
- | **输入限制** | `maxLength` |
251
- | **自定义样式** | `ContainerStyle`、`ContainerClass` |
252
-
253
- #### 尺寸控制
254
-
255
- 通过设置 `width`、`height`、`minHeight`、`maxHeight` 参数,您可以灵活地控制 **BarrageInput** 的尺寸。
256
- ``` typescript
257
- <BarrageInput width="400px" height="60px" minHeight="40px" maxHeight="120px" />
258
- ```
259
-
260
- #### 输入限制
261
-
262
- 通过设置 `maxLength` 参数,您可以控制输入内容的最大字符数。
263
- ``` typescript
264
- <BarrageInput :maxLength="100" />
265
- ```
266
-
267
- #### 自定义样式
268
-
269
- 消息发送组件提供了 `containerStyle`、`containerClass` 属性,用于自定义组件样式。
270
- 1. 若需要自定义输入框容器样式,您可以给 `containerStyle` 属性传递一个样式对象。
271
-
272
- **示例:自定义容器背景和边框圆角**
273
-
274
- ``` typescript
275
- <BarrageInput :containerStyle="{ backgroundColor: '#a8abb2', borderRadius: '0 0', boxShadow: '0 2px 8px rgba(0,0,0,0.1)'}" />
276
- ```
277
- 2. 若需要自定义输入框容器类名,您可以给 `containerClass` 属性传递一个类名字符串。
278
-
279
- **示例:自定义容器类名**
280
-
281
- ``` typescript
282
- <template>
283
- <BarrageInput containerClass="my-custom-input-container" />
284
- </template>
285
-
286
- <style>.my-custom-input-container {background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);border: none;border-radius: 20px;padding: 8px 20px;}.my-custom-input-container:focus-within {box-shadow: 0 0 0 3px rgba(102, 126, 234, 0.3);}</style>
287
- ```
288
- | **修改前** | **修改后** | |
289
- | --- | --- | --- |
290
- | **自定义容器背景和边框圆角** | **自定义消息项间距和边框** | |
291
- | | | |
@@ -1,88 +0,0 @@
1
- 本文对**连麦管理面板(CoGuestPanel)**进行了详细的介绍,您可以在已有项目中直接参考本文示例集成我们开发好的组件,也可以根据您的需求按照文档中的组件定制化部分对样式和布局进行深度的定制。
2
-
3
- ## 核心功能
4
- | **功能名称** | **具体内容** |
5
- | --- | --- |
6
- | **Tab 切换** | 提供双 Tab 界面设计,用户可在连麦申请和连麦管理两个功能模块间快速切换,支持状态记忆和消息提示。 |
7
- | **申请列表** | 实时展示所有待审核的连麦申请,显示用户头像、昵称等信息,支持按时间排序和状态筛选功能。 |
8
- | **主播操作** | 提供丰富的一键式操作按钮,支持接受申请、拒绝申请、断开连麦等功能,实时反馈操作结果。 |
9
-
10
- ## 组件接入
11
-
12
- ### 步骤1:环境配置及开通服务
13
-
14
- 在进行快速接入之前,您需要参考 准备工作,满足相关环境配置及开通对应服务。
15
-
16
- ### 步骤2:安装依赖
17
-
18
- 【npm】
19
- ``` bash
20
- npm install tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 --save
21
- ```
22
-
23
- 【pnpm】
24
- ``` bash
25
- pnpm add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
26
- ```
27
-
28
- 【yarn】
29
- ``` bash
30
- yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
31
- ```
32
-
33
- ### 步骤3:集成连麦管理面板
34
-
35
- 在您的项目中引入并使用**连麦管理面板**,可直接复制如下代码示例至您的项目中展示连麦管理面板。
36
- ``` typescript
37
- <template>
38
- <UIKitProvider theme="light" language="zh-CN">
39
- <div class="app">
40
- <CoGuestPanel class="co-guest-panel" />
41
- </div>
42
- </UIKitProvider>
43
- </template>
44
-
45
- <script setup lang="ts">
46
- import { onMounted, ref } from 'vue';
47
- import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
48
- import { CoGuestPanel, useLoginState, useLiveState } from 'tuikit-atomicx-vue3';
49
-
50
- const { login, loginUserInfo } = useLoginState();
51
- const { joinLive } = useLiveState();
52
-
53
- async function initLogin() {
54
- try {
55
- await login({
56
- sdkAppId: 0, // SDKAppID, 可以参考步骤 1 获取
57
- userId: '', // UserID, 可以参考步骤 1 获取
58
- userSig: '', // userSig, 可以参考步骤 1 获取
59
- });
60
- } catch (error) {
61
- console.error('登录失败:', error);
62
- }
63
- }
64
-
65
- onMounted(async () => {
66
- await initLogin();
67
- await joinLive({
68
- liveId: '输入对应直播间 LiveId', // 输入对应 liveId 进入直播间
69
- });
70
- });
71
- </script>
72
-
73
- <style scoped>.app{width:100vw;height:100vh;display:flex;justify-content:center;align-items:center;padding:20px;box-sizing:border-box}.co-guest-panel{width:100%;max-width:500px;padding: 24px;height:600px;background:rgba(255,255,255,0.9);border-radius:12px;box-shadow:0 8px 32px rgba(0,0,0,0.1);overflow:hidden}</style>
74
- ```
75
-
76
- ## 自定义样式定制
77
-
78
- 连麦管理面板支持通过 CSS 变量进行样式定制,您可以覆盖以下变量来调整组件外观,在已完成**步骤3**的前提下,您可以参考如下示例的方式来调整连麦管理面板的 UI,也可以直接将下列示例增量复制进您的组件中生成下列效果示例。
79
- ``` typescript
80
- <template>
81
- <CoGuestPanel class="co-guest-panel" />
82
- </template>
83
-
84
- <style>.co-guest-panel{--text-color-primary:#2d3748;--text-color-secondary:#93a3bb;--text-color-link:#20c9e7;--bg-color-primary:#ffffff;--bg-color-hover:#d6e7f3;--stroke-color-primary:#8bb6ef;--stroke-color-secondary:#90c0f4;--shadow-light:0 2px 8px rgba(69,67,67,0.08);--shadow-medium:0 4px 16px rgba(93,87,87,0.12);--transition:all 0.3s ease;}.co-guest-panel .panel-content{background:var(--bg-color-primary);border-radius:16px;border:1px solid var(--stroke-color-primary);box-shadow:var(--shadow-medium);transition:var(--transition);overflow:hidden;}.co-guest-panel .panel-content:hover{box-shadow:0 8px 24px rgba(0,0,0,0.15);transform:translateY(-2px);border-color:var(--stroke-color-secondary);}.co-guest-panel .user-item{padding:16px;margin:8px 0;background:var(--bg-color-primary);border:1px solid var(--stroke-color-primary);border-radius:12px;transition:var(--transition);cursor:pointer;}.co-guest-panel .user-item:hover{background:var(--bg-color-hover);border-color:var(--text-color-link);box-shadow:var(--shadow-light);transform:translateY(-1px);}.co-guest-panel .user-item:active{transform:translateY(0);transition:all 0.15s ease;}.co-guest-panel .user-item.selected{background:rgba(102,126,234,0.08);border-color:var(--text-color-link);box-shadow:var(--shadow-light);}</style></style>
85
- ```
86
- | **修改前** | **修改后** |
87
- | --- | --- |
88
- | | |
@@ -1,164 +0,0 @@
1
- 本文对 TUILiveKit 组件中的**观众列表组件(LiveAudienceList)**进行了详细的介绍,您可以在已有项目中直接参考本文示例集成我们开发好的组件,也可以根据您的需求按照文档中的组件定制化部分对样式,布局进行深度的定制。
2
-
3
- ## 核心功能
4
- | **功能分类** | **具体能力** |
5
- | --- | --- |
6
- | **实时观众展示** | 实时显示直播间在线观众列表,支持头像、昵称展示,提供清晰的观众信息视图,让主播能够直观了解观众构成 |
7
- | **响应式设计** | 组件支持桌面端和移动端两套UI方案,自动适配不同设备屏幕尺寸,提供一致的用户体验,满足多平台直播需求 |
8
- | **可定制化 UI** | 提供灵活的插槽机制,支持自定义观众标记、头像样式等元素,让您能够根据业务需求定制观众列表的展示效果,打造独特的视觉体验 |
9
-
10
- ## 组件接入
11
-
12
- ### 步骤1:环境配置及开通服务
13
-
14
- 在进行快速接入之前,您需要参见 准备工作,满足相关环境配置及开通对应服务。
15
-
16
- ### 步骤2: 安装依赖
17
-
18
- 【npm】
19
- ``` bash
20
- npm install tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3 --save
21
- ```
22
-
23
- 【pnpm】
24
- ``` bash
25
- pnpm add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
26
- ```
27
-
28
- 【yarn】
29
- ``` bash
30
- yarn add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
31
- ```
32
-
33
- ### 步骤3:集成观众列表组件
34
-
35
- 在您的项目中引入并使用**观众列表组件**,可直接复制如下代码示例至您的项目中展示直播间观众列表。
36
- ``` typescript
37
- <template>
38
- <UIKitProvider theme="dark" language="zh-CN">
39
- <div class="app">
40
- <div class="live-audience-container">
41
- <LiveAudienceList class="live-audience-list"/>
42
- </div>
43
- </div>
44
- </UIKitProvider>
45
- </template>
46
-
47
- <script setup lang="ts">
48
- import { onMounted } from 'vue';
49
- import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
50
- import { LiveAudienceList, useLoginState, useLiveState } from 'tuikit-atomicx-vue3';
51
-
52
- const { login } = useLoginState();
53
- const { joinLive } = useLiveState();
54
-
55
- async function initLogin() {
56
- try {
57
- await login({
58
- sdkAppId: 0, // SDKAppID, 可以参考步骤 1 获取
59
- userId: '', // UserID, 可以参考步骤 1 获取
60
- userSig: '', // userSig, 可以参考步骤 1 获取
61
- });
62
- } catch (error) {
63
- console.error('登录失败:', error);
64
- }
65
- }
66
-
67
- onMounted(async () => {
68
- await initLogin();
69
- await joinLive({
70
- liveId: '输入对应直播间 LiveId', // 进入直播间
71
- });
72
- });
73
- </script>
74
-
75
- <style>.live-audience-container{display:flex;height:100%;width:300px;padding:20px}.live-audience-list{width:100%;height:100%}</style>
76
- ```
77
-
78
- ## 组件定制化
79
-
80
- **观众列表组件**提供了灵活的组件自定义插槽,该插槽支持您根据自己需求调整观众标记、特殊身份标识等元素的样式与布局。下列分别给出插槽使用示例
81
-
82
- ### 组件插槽
83
- | **名称** | **参数** | **说明** |
84
- | --- | --- | --- |
85
- | customAudienceInfo | audience: AudienceInfo | 自定义观众信息的显示 UI |
86
-
87
- ``` typescript
88
- // customAudienceInfo 插槽使用示例
89
- <LiveAudienceList>
90
- <CustomAudienceInfo #customAudienceInfo />
91
- </LiveAudienceList>
92
- ```
93
-
94
- `AudienceInfo` 定义了直播房间中每个观众的基本信息和状态:
95
- | **参数** | **类型** | **说明** |
96
- | --- | --- | --- |
97
- | userId | string | 观众的唯一标识符,在整个系统中保持唯一性。 |
98
- | userName | string | 观众在直播中显示的名称,支持中文、英文等字符,为空时显示 userId。 |
99
- | avatarUrl | string | 观众头像的完整 URL 地址,支持 HTTPS 协议。 |
100
- | isMessageDisabled | boolean | 观众是否被禁言,true 表示已被禁言,false 表示可以正常发言。 |
101
- | joinTime | number | 观众进入直播间的时间戳,用于排序和统计。 |
102
-
103
- ``` typescript
104
- interface AudienceInfo {
105
- userId: string; // 观众唯一标识
106
- userName?: string; // 观众显示名称(可选)
107
- avatarUrl?: string; // 观众头像URL(可选)
108
- isMessageDisabled?: boolean; // 是否被禁言(可选)
109
- joinTime?: number; // 进入时间戳(可选)
110
- }
111
- ```
112
-
113
- ### 组件属性
114
- | **属性名** | **类型** | **默认值** | **说明** |
115
- | --- | --- | --- | --- |
116
- | height | string | '500px' | 组件高度,支持 CSS 单位(px、%、vh等)。 |
117
- | style | CSSProperties | {} | 自定义样式对象,用于覆盖组件默认样式。 |
118
-
119
- #### 自定义插槽示例
120
-
121
- 为了更好地让您体验及理解**观众列表组件** 组件的 **customAudienceInfo **插槽定制化能力,我们提供了**自定义个人信息**示例场景供您参考,您可以参考上述**步骤3**将如下代码增量复制至您的项目中实现类似场景的效果。
122
- ``` typescript
123
- <template>
124
- <LiveAudienceList>
125
- <template #customAudienceInfo="{ audience }">
126
- <div class="custom-audience-info">
127
- <!-- 头像 -->
128
-
129
- <!-- 观众信息 -->
130
- <div class="audience-details">
131
- <span class="audience-name">{{ audience.userName || audience.userId }}</span>
132
- <span class="join-time">{{ formatJoinTime(audience.joinTime) }}</span>
133
- </div>
134
-
135
- <!-- 状态指示器 -->
136
- <div v-if="audience.isMessageDisabled" class="muted-indicator">🔇</div>
137
- </div>
138
- </template>
139
- </LiveAudienceList>
140
- </template>
141
-
142
- <script setup lang="ts">
143
- import { LiveAudienceList } from 'tuikit-atomicx-vue3';
144
-
145
- const defaultAvatar = 'xxx'; // 输入默认头像 Url
146
-
147
- const formatJoinTime = (timestamp?: number) => { // 格式化加入时间
148
- if (!timestamp) return '刚刚加入';
149
-
150
- const now = Date.now();
151
- const diff = now - timestamp;
152
- const minutes = Math.floor(diff / (1000 * 60));
153
- const hours = Math.floor(diff / (1000 * 60 * 60));
154
- const days = Math.floor(diff / (1000 * 60 * 60 * 24));
155
-
156
- if (days > 0) return `${days}天前加入`;
157
- if (hours > 0) return `${hours}小时前加入`;
158
- if (minutes > 0) return `${minutes}分钟前加入`;
159
- return '刚刚加入';
160
- };
161
- </script>
162
-
163
- <style scoped>.custom-audience-info{display:flex;align-items:center;gap:12px;padding:8px;border-radius:8px;transition:background-color .2s ease}.custom-audience-info:hover{background-color:var(--uikit-color-gray-1)}.audience-avatar{width:40px;height:40px;border-radius:50%;object-fit:cover;border:2px solid var(--uikit-color-gray-3)}.audience-details{flex:1;display:flex;flex-direction:column;gap:4px}.audience-name{font-size:14px;font-weight:500;color:var(--text-color-primary);white-space:nowrap;overflow:hidden;text-overflow:ellipsis}.join-time{font-size:12px;color:var(--text-color-secondary)}.muted-indicator{font-size:16px;opacity:.6}</style>
164
- ```
@@ -1,130 +0,0 @@
1
- 本文对 TUILiveKit 组件中的**媒体源配置面板(LiveScenePanel)**进行了详细的介绍,您可以在已有项目中直接参考本文示例集成我们开发好的组件,也可以根据您的需求按照文档中的组件定制化部分对样式和布局进行深度的定制。
2
-
3
- ## 核心功能
4
- | **功能分类** | **具体能力** |
5
- | --- | --- |
6
- | **多素材类型支持** | 摄像头、屏幕共享、图片、视频、文本等多种素材类型,支持设备选择和参数配置。 |
7
- | **智能显示模式** | 无素材时显示完整面板,有素材时自动切换为紧凑按钮模式,响应式布局适配。 |
8
- | **素材管理操作** | 添加、编辑、重命名、删除、排序等完整的素材管理功能,支持批量操作。 |
9
- | **实时预览配置** | 摄像头配置弹窗提供实时预览,支持参数调整和设备测试。 |
10
- | **权限与错误处理** | 自动权限检查,友好的错误提示和重试机制,保障用户体验。 |
11
-
12
- ## 组件接入
13
-
14
- ### 步骤1:环境配置及开通服务
15
-
16
- 在进行快速接入之前,您需要参考准备工作,满足相关环境配置及开通对应服务。
17
-
18
- ### 步骤2:安装依赖
19
-
20
- 【npm】
21
- ``` bash
22
- npm install tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3 --save
23
- ```
24
-
25
- 【pnpm】
26
- ``` bash
27
- pnpm add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
28
- ```
29
-
30
- 【yarn】
31
- ``` bash
32
- yarn add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
33
- ```
34
-
35
- ### 步骤3:集成**媒体源配置面板**
36
-
37
- 在您的项目中引入并使用**媒体源配置面板**,可直接复制如下代码示例至您的项目中展示媒体源配置面板。
38
- ``` typescript
39
- <template>
40
- <UIKitProvider theme="dark" language="zh-CN">
41
- <div class="app-container">
42
- <LiveScenePanel class="live-scene-panel" />
43
- </div>
44
- </UIKitProvider>
45
- </template>
46
-
47
- <script setup lang="ts">
48
- import { onMounted } from 'vue';
49
- import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
50
- import { LiveScenePanel, useLoginState } from 'tuikit-atomicx-vue3';
51
-
52
- const { login } = useLoginState();
53
-
54
- async function initLogin() {
55
- try {
56
- await login({
57
- sdkAppId: 0, // SDKAppID, 可以参考步骤 1 获取
58
- userId: '', // UserID, 可以参考步骤 1 获取
59
- userSig: '', // userSig, 可以参考步骤 1 获取
60
- });
61
- } catch (error) {
62
- console.error('登录失败:', error);
63
- }
64
- }
65
-
66
- onMounted(async () => {
67
- await initLogin();
68
- });
69
- </script>
70
-
71
- <style scoped>.app-container{width:100vw;height:100vh;display:flex;justify-content:center;align-items:center;padding:20px;box-sizing:border-box}.live-scene-panel{width:20%;height:80vh;background:rgba(0,0,0,0.8);border-radius:16px}</style>
72
- ```
73
-
74
- ## 自定义组件
75
-
76
- 媒体源配置面板为用户自定义提供了丰富且多维度的功能接口,允许用户自定义素材类型、操作行为、样式主题等。在已完成上述**步骤3**的前提下,您可以参考如下示例的方式来调整媒体源配置面板的 UI,也可以直接将下列示例增量复制组件中生成下列效果示例。
77
-
78
- ### 样式自定义
79
-
80
- 通过 CSS 类名和变量自定义组件外观,支持主题色彩、布局样式、动画效果等全方位定制。
81
- ``` typescript
82
- <template>
83
- <LiveScenePanel class="custom-live-scene-panel" />
84
- </template>
85
-
86
- <style>.app-container{width:100vw;height:100vh;display:flex;justify-content:center;align-items:center;padding:20px;box-sizing:border-box}.custom-live-scene-panel{width:100%;max-width:300px;height:80vh;background:linear-gradient(135deg,#667eea 0%,#764ba2 100%);border:2px solid #4c63d2;border-radius:16px;padding:24px;box-shadow:0 8px 32px rgba(0,0,0,0.1);color:white}.custom-live-scene-panel .add-material-item{background-color:#147fcb!important;color:white;border:none;border-radius:0!important;padding:12px 24px;font-weight:600;transition:all 0.3s ease}.custom-live-scene-panel .materials-list{margin-top:20px;gap:16px;display:grid;grid-template-columns:repeat(auto-fill,minmax(200px,1fr))}.custom-live-scene-panel .material-item{background:rgba(255,255,255,0.1);border:1px solid rgba(255,255,255,0.2);border-radius:12px;padding:16px;backdrop-filter:blur(10px);transition:all 0.3s ease}.custom-live-scene-panel .material-item:hover{background:rgba(255,255,255,0.2);transform:scale(1.02)}</style>
87
- ```
88
- | **修改前** | **修改后** | | |
89
- | --- | --- | --- | --- |
90
- | **添加媒体源界面** | **媒体源设置界面** | **添加媒体源界面** | **媒体源设置界面** |
91
- | | | | |
92
-
93
- ### 状态监听与扩展
94
-
95
- 通过状态管理 Hooks,您可以监听媒体源配置面板的内部状态变化,实现外部业务逻辑的响应式处理。这种方式允许您在不修改组件内部代码的情况下,对素材的添加、删除、更新等操作进行监听和响应,从而实现数据同步、业务统计、用户提示等扩展功能。
96
- ``` typescript
97
- <template>
98
- <!-- 状态显示 -->
99
- <div class="status-info">
100
- <span>素材数量: {{ materialCount }}</span>
101
- <span>最后操作: {{ lastOperation }}</span>
102
- </div>
103
- <!-- LiveScenePanel 组件 -->
104
- <LiveScenePanel />
105
- <StreamMixer />
106
- </template>
107
-
108
- <script setup lang="ts">
109
- import { ref, computed, watch } from 'vue';
110
- import { LiveScenePanel, useVideoMixerState, StreamMixer } from 'tuikit-atomicx-vue3';
111
-
112
- // 使用状态管理 hooks
113
- const { mediaSourceList } = useVideoMixerState();
114
- const lastOperation = ref('无');
115
- const materialCount = computed(() => mediaSourceList.value.length);
116
-
117
- // 监听素材列表变化
118
- watch(mediaSourceList, (newList, oldList) => {
119
- if (newList.length > oldList.length) {
120
- lastOperation.value = '添加素材';
121
- console.log('素材已添加');
122
- } else if (newList.length < oldList.length) {
123
- lastOperation.value = '删除素材';
124
- console.log('素材已删除');
125
- }
126
- }, { deep: true });
127
- </script>
128
-
129
- <style>.status-info {display: flex; gap: 20px; padding: 12px; background: #f8f9fa;border-radius: 6px; margin-bottom: 16px;font-size: 14px;}</style>
130
- ```