@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
@@ -0,0 +1,79 @@
1
+ ## TUICallKit(含 UI 组件)
2
+
3
+ TUICallKit API 是音视频通话组件的**含 UI 接口**,使用 TUICallKit API,您可以通过简单接口快速实现一个类微信的音视频通话场景。
4
+
5
+ |<br>API|描述|
6
+ |---------|---------|
7
+ |[init](https://cloud.tencent.com/document/product/647/81015#init)|初始化 TUICallKit 组件实例。|
8
+ |[calls](https://cloud.tencent.com/document/product/647/81015#calls)|发起单人或多人通话。|
9
+ |[join](https://cloud.tencent.com/document/product/647/81015#join)|主动加入通话。|
10
+ |[setCallingBell](https://cloud.tencent.com/document/product/647/81015#setCallingBell)|设置自定义来电铃音。|
11
+ |[setSelfInfo](https://cloud.tencent.com/document/product/647/81015#setSelfInfo)|设置用户昵称和头像。|
12
+ |[enableMuteMode](https://cloud.tencent.com/document/product/647/81015#enableMuteMode)|开启/关闭来电铃声。|
13
+ |[enableFloatWindow](https://cloud.tencent.com/document/product/647/81015#enableFloatWindow)|开启/关闭悬浮窗功能。|
14
+ |[enableVirtualBackground](https://cloud.tencent.com/document/product/647/81015#enableVirtualBackground)|开启/关闭模糊背景的功能按钮。|
15
+ |[setLanguage](https://cloud.tencent.com/document/product/647/81015#setLanguage)|设置 TUICallKit 组件通话语言。|
16
+ |[hideFeatureButton](https://cloud.tencent.com/document/product/647/81015#hideFeatureButton)|隐藏按钮。|
17
+ |[setLocalViewBackgroundImage](https://cloud.tencent.com/document/product/647/81015#setLocalViewBackgroundImage)|设置本地用户通话界面背景图。|
18
+ |[setRemoteViewBackgroundImage](https://cloud.tencent.com/document/product/647/81015#setRemoteViewBackgroundImage)|设置远端用户通话界面背景图。|
19
+ |[setLayoutMode](https://cloud.tencent.com/document/product/647/81015#setLayoutMode)|设置通话界面布局模式。|
20
+ |[setCameraDefaultState](https://cloud.tencent.com/document/product/647/81015#setCameraDefaultState)|设置摄像头是否默认打开。|
21
+ |[destroyed](https://cloud.tencent.com/document/product/647/81015#destroyed)|销毁 TUICallKit 组件实例。|
22
+ |[getTUICallEngineInstance](https://cloud.tencent.com/document/product/647/81015#getTUICallEngineInstance)|获取 TUICallEngine 实例。|
23
+
24
+ ## TUICallEngine (无 UI 接口)
25
+
26
+ TUICallEngine API 是音视频通话组件的**无 UI 接口**,如果 CallKit 的交互并不满足您的需求,您可以使用这套 API 根据您的业务需求自定义封装。
27
+
28
+ |**API**|**描述**|
29
+ |---------|---------|
30
+ |[createInstance](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#createInstance)|创建 TUICallEngine 实例(单例模式)。|
31
+ |[destroyInstance](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#destroyInstance)|销毁 TUICallEngine 实例(单例模式)。|
32
+ |[on](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#on)|监听事件。|
33
+ |[off](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#off)|取消监听事件。|
34
+ |[login](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#login)|登录接口。|
35
+ |[logout](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#logout)|登出接口。|
36
+ |[setSelfInfo](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#setSelfInfo)|设置用户昵称和头像。|
37
+ |[calls](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#calls)|发起单人或多人通话。|
38
+ |[join](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#join)|主动加入通话。|
39
+ |[accept](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#accept)|接听通话。|
40
+ |[reject](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#reject)|拒绝通话。|
41
+ |[hangup](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#hangup)|结束通话。|
42
+ |[startRemoteView](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#startRemoteView)|启动远端画面渲染。|
43
+ |[stopRemoteView](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#stopRemoteView)|停止远端画面渲染。|
44
+ |[openCamera](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#openCamera)|开启摄像头。|
45
+ |[closeCamera](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#closeCamera)|关闭摄像头。|
46
+ |[switchCamera](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#switchCamera)|切换前后置摄像头,仅移动端支持。|
47
+ |[openMicrophone](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#openMicrophone)|打开麦克风。|
48
+ |[closeMicrophone](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#closeMicrophone)|关闭麦克风。|
49
+ |[setVideoQuality](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#setVideoQuality)|设置视频分辨率。|
50
+ |[getDeviceList](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#getDeviceList)|获取设备列表。|
51
+ |[switchDevice](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#switchDevice)|切换摄像头或麦克风设备。|
52
+ |[enableAIVoice](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#enableAIVoice)|开启/关闭 AI 降噪。|
53
+ |[enableMultiDeviceAbility](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#enableMultiDeviceAbility)|开启/关闭 TUICallEngine 的多设备登录模式。|
54
+ |[setBlurBackground](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#setBlurBackground)|开关/设置背景虚化。|
55
+ |[setVirtualBackground](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#setVirtualBackground)|开关/设置图片背景虚化。|
56
+
57
+ ## TUICallEvent
58
+
59
+ TUICallEvent 是 TUICallEngine 对应的事件类,您可以通过监听如下事件,来监听自己感兴趣的事件。
60
+
61
+ |EVENT|描述|
62
+ |---------|---------|
63
+ |[TUICallEvent.ERROR](https://cloud.tencent.com/document/product/647/78758#ERROR)|通话过程中错误事件。|
64
+ |[TUICallEvent.KICKED_OUT](https://cloud.tencent.com/document/product/647/78758#KICKED_OUT)|用户重复登录,被踢下线。|
65
+ |[TUICallEvent.USER_ACCEPT](https://cloud.tencent.com/document/product/647/78758#USER_ACCEPT)|xxxx 用户接通的事件,**v4.x.x 已废弃。**|
66
+ |[TUICallEvent.USER_ENTER](https://cloud.tencent.com/document/product/647/78758#USER_ENTER)|xxxx 用户加入通话的事件。|
67
+ |[TUICallEvent.USER_LEAVE](https://cloud.tencent.com/document/product/647/78758#USER_LEAVE)|xxxx 用户离开通话的事件。|
68
+ |[TUICallEvent.REJECT](https://cloud.tencent.com/document/product/647/78758#REJECT)|xxxx 用户拒绝通话的事件。|
69
+ |[TUICallEvent.NO_RESP](https://cloud.tencent.com/document/product/647/78758#NO_RESP)|xxxx 用户不响应的事件。|
70
+ |[TUICallEvent.LINE_BUSY](https://cloud.tencent.com/document/product/647/78758#LINE_BUSY)|xxxx 用户忙线的事件。|
71
+ |[TUICallEvent.USER_VIDEO_AVAILABLE](https://cloud.tencent.com/document/product/647/78758#USER_VIDEO_AVAILABLE)|xxxx 用户是否有视频流的事件。|
72
+ |[TUICallEvent.USER_AUDIO_AVAILABLE](https://cloud.tencent.com/document/product/647/78758#USER_AUDIO_AVAILABLE)|xxxx 用户是否有音频流的事件。|
73
+ |[TUICallEvent.USER_VOICE_VOLUME](https://cloud.tencent.com/document/product/647/78758#USER_VOICE_VOLUME)|所有用户音量大小的反馈事件。|
74
+ |[TUICallEvent.ON_CALL_RECEIVED](https://cloud.tencent.com/document/product/647/78758#ON_CALL_RECEIVED)|通话请求的事件。|
75
+ |TUICallEvent.ON_CALL_NOT_CONNECTED|通话未建立的事件。|
76
+ |[TUICallEvent.ON_CALL_BEGIN](https://cloud.tencent.com/document/product/647/78758#ON_CALL_BEGIN)|通话接通时抛出的事件。|
77
+ |TUICallEvent.ON_CALL_END|通话结束时抛出的事件。|
78
+ |[TUICallEvent.DEVICED_UPDATED](https://cloud.tencent.com/document/product/647/78758#DEVICED_UPDATED)|设备列表更新的事件。|
79
+ |[TUICallEvent.ON_USER_NETWORK_QUALITY_CHANGED](https://cloud.tencent.com/document/product/647/78758#ON_USER_NETWORK_QUALITY_CHANGED)|所有用户网络质量的事件。|
@@ -0,0 +1,72 @@
1
+ ## 组件概述
2
+
3
+ ChatSetting 是基于 Jetpack Compose 构建的聊天设置组件集合,主要包含单聊设置(C2CChatSetting)和群聊设置(GroupChatSetting)两个核心组件。这些组件为用户提供了完整的聊天会话管理功能,包括用户信息管理、权限设置、群组管理等核心能力。
4
+ | <strong>单聊设置界面</strong> | <strong>群聊设置界面</strong> |
5
+ | --- | --- |
6
+ | | |
7
+
8
+ ## 组件集成
9
+
10
+ ChatSetting 组件属于 TUIKit Compose 的一部分,集成 TUIKit Compose 即可获取并使用 ChatSetting 组件。集成方法请参考文档 TUIKit Compose 里的集成步骤。
11
+
12
+ ## 组件构成
13
+
14
+ ChatSetting 包含两个主要组件:C2CChatSetting(单聊设置)和 GroupChatSetting(群聊设置),每个组件都提供了丰富的配置选项。
15
+
16
+ ### 单聊设置(C2CChatSetting)
17
+
18
+ #### 对外方法
19
+ | 方法名 | 参数 | 描述 |
20
+ | --- | --- | --- |
21
+ | <code>C2CChatSetting</code> | <code>userID: String</code> | 聊天对象的用户 ID。 |
22
+ | <code>modifier: Modifier</code> | Jetpack Compose 中用来设置组件的样式、布局、行为和外观。 | |
23
+ | <code>onSendMessageClick: () -> Unit</code> | 发送消息按钮点击回调,可选参数。 | |
24
+ | <code>onContactDelete: () -> Unit</code> | 删除联系人按钮点击回调,可选参数。 | |
25
+ | <code>c2cChatSettingViewModelFactory: C2CChatSettingViewModelFactory</code> | 创建组件内部 C2CChatSettingViewModel 的工厂类。通常情况下,您无需手动创建,组件已提供默认实现。 | |
26
+
27
+ ### 群聊设置(GroupChatSetting)
28
+
29
+ #### 对外方法
30
+ | 方法名 | 参数 | 描述 |
31
+ | --- | --- | --- |
32
+ | <code>GroupChatSetting</code> | <code>groupID: String</code> | 群组 ID,用于标识群聊。 |
33
+ | <code>modifier: Modifier</code> | Jetpack Compose 中用来设置组件的样式、布局、行为和外观。 | |
34
+ | <code>onSendMessageClick: () -> Unit</code> | 发送消息按钮点击回调,可选参数。 | |
35
+ | <code>onGroupMemberClick: (GroupMember) -> Unit </code> | 群成员点击回调,可选参数。 | |
36
+ | <code>onGroupDelete: () -> Unit</code> | 解散/退出群组点击回调,可选参数。 | |
37
+ | <code>groupChatSettingViewModelFactory: GroupChatSettingViewModelFactory</code> | 创建组件内部 GroupChatSettingViewModel 的工厂类。通常情况下,您无需手动创建,组件已提供默认实现。 | |
38
+
39
+ ## 基础用法
40
+
41
+ 初始化 C2CChatSetting 即可直接展示单聊设置页面,示例代码如下:
42
+ ``` swift
43
+ Box {
44
+ C2CChatSetting(
45
+ userID = userID,
46
+ onSendMessageClick = {
47
+ // 处理发送消息点击事件
48
+ },
49
+ onContactDelete = {
50
+ // 处理联系人删除点击事件
51
+ },
52
+ )
53
+ }
54
+ ```
55
+
56
+ 初始化 GroupChatSetting 即可直接展示群聊设置页面,示例代码如下:
57
+ ``` swift
58
+ Box {
59
+ GroupChatSetting(
60
+ groupID = groupID,
61
+ onGroupMemberClick = { groupMember ->
62
+ // 处理点击群成员事件
63
+ },
64
+ onSendMessageClick = {
65
+ // 处理发送消息点击事件
66
+ },
67
+ onGroupDelete = {
68
+ // 处理解散退出群组事件
69
+ },
70
+ )
71
+ }
72
+ ```
@@ -0,0 +1,41 @@
1
+ ## 组件概述
2
+
3
+ ContactList 是基于 Jetpack Compose 构建的联系人列表组件,为用户提供完整的联系人管理功能。该组件支持好友列表展示、好友申请处理、群组列表管理、黑名单管理等功能,并提供了丰富的交互回调接口。
4
+ | <strong>联系人列表</strong> | <strong>群组列表</strong> | <strong>好友申请列表</strong> |
5
+ | --- | --- | --- |
6
+ | | | |
7
+
8
+ ## 组件集成
9
+
10
+ `ContactList` 组件属于 TUIKit Compose 的一部分,集成 TUIKit Compose 即可获取并使用 `ContactList` 组件。集成方法请参考文档 [TUIKit Compose](https://cloud.tencent.com/document/product/269/125127) 里的集成步骤。
11
+
12
+ ## 组件构成
13
+
14
+ `ContactList` 是联系人列表里的主组件,对应着整个联系人列表页框架:
15
+ | <strong>方法名</strong> | <strong>参数</strong> | <strong>描述</strong> |
16
+ | --- | --- | --- |
17
+ | <code>ContactList</code> | <code>modifier: Modifier</code> | Jetpack Compose 中用来设置组件的样式、布局、行为和外观。 |
18
+ | <code>onGroupClick: (ContactInfo) -> Unit</code> | 点击群组的回调,可选参数。 | |
19
+ | <code>onContactClick: (ContactInfo) -> Unit</code> | 点击联系人的回调,可选参数。 | |
20
+ | <code>contactListViewModelFactory: ContactListViewModelFactory</code> | 创建组件内部 ContactListViewModel 的工厂类。通常情况下,您无需手动创建,组件已提供默认实现。 | |
21
+
22
+ `ContactList` 上半部分预留了各个子视图的入口 cell,例如好友申请、群聊申请、群聊列表和黑名单列表。下半部分内嵌了联系人列表,如下图所示:
23
+
24
+ ## 基础用法
25
+
26
+ 在 `ContactList` 中点击好友申请、群聊申请、群聊列表和黑名单列表入口时,由组件自动完成路由,无需额外处理;点击群聊列表中的群组或联系人列表/黑名单中的个人时,会触发相应的回调接口 (`onGroupClick/onContactClick`),需监听回调并实现自定义跳转。路由跳转示例图如下所示:
27
+
28
+ 初始化 ContactList 即可直接展示联系人列表,示例代码如下:
29
+ ``` swift
30
+ Box(
31
+ modifier = Modifier
32
+ .fillMaxSize()
33
+ .systemBarsPadding()
34
+ ) {
35
+ ContactList(onGroupClick = {
36
+ // 处理群组点击事件
37
+ }, onContactClick = {
38
+ // 处理联系人点击事件
39
+ })
40
+ }
41
+ ```
@@ -0,0 +1,123 @@
1
+ ## 组件概述
2
+
3
+ ConversationList 是一个基于 Jetpack Compose 构建的会话列表组件,主要用于展示和管理用户的聊天会话。该组件提供了完整的会话列表功能,包括会话展示、交互操作等核心能力。
4
+ | <strong>会话列表</strong> | <strong>会话操作</strong> |
5
+ | --- | --- |
6
+ | | |
7
+
8
+ ## 组件集成
9
+
10
+ ConversationList 是属于 TUIKit Compose 的一个组件,集成 TUIKit Compose 即可获取并使用 ConversationList,集成方法请参考文档 TUIKit Compose 里的集成步骤。
11
+
12
+ ## 组件构成
13
+
14
+ ConversationList 组件对外仅暴露了会话列表的初始化方法,其他逻辑均封装在 ConversationList 中。
15
+
16
+ #### 对外方法
17
+ | 方法名 | 参数 | 描述 |
18
+ | --- | --- | --- |
19
+ | <code>ConversationList</code> | <code>modifier: Modifier</code> | Jetpack Compose 中用来设置组件的样式、布局、行为和外观。 |
20
+ | <code>conversationListViewModelFactory: ConversationListViewModelFactory</code> | 创建组件内部 ConversationListViewModel 的工厂类。通常情况下,您无需手动创建,组件已提供默认实现。 | |
21
+ | <code>config: ConversationActionConfigProtocol</code> | 初始化组件,设置会话操作菜单项,选填。 | |
22
+ | <code>customActions: List</code> | 初始化组件,设置自定义会话操作选项,选填。 | |
23
+ | <code>onConversationClick: (ConversationInfo) -> Unit</code> | 设置会话点击回调。 | |
24
+
25
+ ## 基础用法
26
+
27
+ ConversationList 组件可直接初始化使用,需要传入 onConversationClick 回调。
28
+
29
+ |参数名|类型|描述|
30
+ |---------|---------|---------|
31
+ |`onConversationClick`|`(ConversationInfo) -> Unit`|会话点击回调,当用户点击某个会话 cell 时触发。|
32
+
33
+ 示例代码如下:
34
+ ``` swift
35
+ Box(
36
+ modifier = Modifier
37
+ .fillMaxSize()
38
+ .systemBarsPadding()
39
+ ) {
40
+ ConversationList(onConversationClick = {
41
+ // 这里建议导航到聊天页面
42
+ })
43
+ }
44
+ ```
45
+
46
+ ## 自定义组件
47
+
48
+ 您可以自定义会话列表的操作项。方法如下。
49
+
50
+ #### 方式 1. 局部隐藏会话操作项
51
+
52
+ 初始化 ConversationList 时设置 `actions`,表示当前在会话列表 cell 上展示哪些操作项:
53
+ ``` swift
54
+ Box {
55
+ ConversationList(
56
+ // 不展示 ClearHistory
57
+ config = ChatConversationActionConfig(
58
+ isSupportDelete = true,
59
+ isSupportPin = true,
60
+ isSupportClearHistory = false
61
+ )
62
+ ) {
63
+ // 点击会话 cell 跳转
64
+ }
65
+ }
66
+ ```
67
+
68
+ **目前支持的菜单项开关操作**
69
+
70
+ |操作类型|描述|
71
+ |---------|---------|
72
+ |`isSupportDelete`|是否支持删除会话。|
73
+ |`isSupportPin`|是否支持置顶会话。|
74
+ |`isSupportClearHistory`|是否支持清空历史消息。|
75
+
76
+ #### 方式 2. 局部增加会话操作项
77
+
78
+ 初始化 ConversationList 时传入 `customActions`,ConversationList 内部会在默认的 action 底部添加您增加的自定义选项:
79
+
80
+ |参数名|类型|描述|
81
+ |---------|---------|---------|
82
+ |`customActions`|`List<ConversationCustomAction>`|自定义会话操作,当用户点击会话操作菜单时展示。|
83
+
84
+ 示例代码如下:
85
+ ``` swift
86
+ Box {
87
+ ConversationList(
88
+ customActions = listOf(ConversationCustomAction(title = "Share") {
89
+ println("Share conversation: ${it.title}")
90
+ })
91
+ ) {
92
+ // 处理点击事件
93
+ }
94
+ }
95
+ ```
96
+
97
+ #### 方式 3. 全局配置方式
98
+
99
+ 通过 `AppBuilderConfig` 进行全局配置:
100
+ ``` swift
101
+ // 在应用启动时配置,不包含则不支持
102
+ AppBuilderConfig.conversationActionList = listOf(
103
+ ConversationAction.DELETE, // 支持删除
104
+ ConversationAction.PIN, // 支持置顶
105
+ ConversationAction.CLEAR_HISTORY // 清空会话消息
106
+ )
107
+
108
+ // 接下来再初始化 ConversationList,所有的 ConversationList 都会遵守上面 conversationActionList 的配置
109
+ ConversationList() {
110
+ // 这里可以导航到聊天页面
111
+ }
112
+ ```
113
+
114
+ > **注意:**
115
+ >
116
+
117
+ > 局部配置的优先级大于全局配置。
118
+ >
119
+
120
+ 自定义效果如下图所示:
121
+ | 会话操作(默认选项) | 会话操作(隐藏<strong>删除</strong>选项) | 会话操作(新增<strong>隐藏会话</strong>选项) |
122
+ | --- | --- | --- |
123
+ | | | |
@@ -0,0 +1,142 @@
1
+ ## 功能描述
2
+
3
+ Android 端 `TUIKit` 默认自带 **简体中文、英语 **和** 阿拉伯语** 语言包,作为界面展示语言。
4
+
5
+ 根据此文档指引,您可以使用默认语言包,也可自定义语言翻译表述和增加其他语言包。
6
+
7
+ > **说明:**
8
+ >
9
+
10
+ > TUIKit 从 7.5.4852 版本开始,新增 RTL 语言(文字方向从右到左的语言,例如阿拉伯语、希伯来语等)支持,当应用内语言为 RTL 语言时,TUIKit 会自动切换到 RTL 样式;同时内置语言新增了阿拉伯语。
11
+ >
12
+
13
+ |简体中文|英文|阿拉伯语|
14
+ |---------|---------|---------|
15
+ ||||
16
+
17
+ ## 使用自带语言
18
+
19
+ 如果您的 App 需要的语言仅包括 **简体中文**、**英语 **和** 阿拉伯语**,请参考本部分。
20
+
21
+ ### 跟随系统语言
22
+
23
+ 直接使用 `TUIKit` 即可,无需额外步骤。组件内部语言会跟随系统语言。
24
+
25
+ ### 指定显示的语言
26
+
27
+ 如果您需要指定 TUIKit 界面的语言,需要在 Appliction 初始化时调用以下代码进行设置,例如设置为英文:
28
+ ``` java
29
+ public class MyApplication extends Application {
30
+ @Override
31
+ protected void onCreate() {
32
+ super.onCreate();
33
+ TUIThemeManager.getInstance().changeLanguage(this, TUIThemeManager.LANGUAGE_EN);
34
+ }
35
+
36
+ /**
37
+ * 语言可选枚举为:
38
+ * TUIThemeManager.LANGUAGE_EN ---- 英文
39
+ * TUIThemeManager.LANGUAGE_ZH_CN ---- 简体中文
40
+ * TUIThemeManager.LANGUAGE_AR ---- 阿拉伯语
41
+ */
42
+ }
43
+ ```
44
+
45
+ > **注意**
46
+ >
47
+
48
+ > 调用 `changeLanguage` 方法并不会自动刷新 UI,需要获取字符串之后重新设置到控件上才能生效。
49
+ >
50
+
51
+ ### 实时动态修改
52
+
53
+ 您可以参考 `TUIKitDemo` 的 [LanguageSelectActivity.java](https://github.com/TencentCloud/TIMSDK/blob/master/Android/Demo/app/src/main/java/com/tencent/qcloud/tim/demo/login/LanguageSelectActivity.java) 文件中的代码。也可以使用如下方法切换语言,例如切换为英文:
54
+ ``` java
55
+ TUIThemeManager.getInstance().changeLanguage(context, TUIThemeManager.LANGUAGE_EN);
56
+ System.exit(0);
57
+ Intent intent = context.getPackageManager().getLaunchIntentForPackage(context.getPackageName());
58
+ context.startActivity(intent);
59
+ ```
60
+
61
+ ### 使用 WebView 之后发现语言切换失败处理方法
62
+
63
+ 使用 WebView 之后导致语言切换失败是 Android 7 及以后版本的 bug,原因是 WebView 初始化时会修改 App 的语言为手机系统语言。需要在 [TUIThemeManager.java](https://github.com/TencentCloud/TIMSDK/blob/master/Android/TUIKit/TUICore/tuicore/src/main/java/com/tencent/qcloud/tuicore/TUIThemeManager.java) 的 `setThemeInternal` 方法中调用以下代码解决此问题:
64
+ ``` java
65
+ setWebViewLanguage(appContext);
66
+ ```
67
+
68
+ 添加之后:
69
+ ``` java
70
+ private void setThemeInternal(Context context) {
71
+ if (context == null) {
72
+ return;
73
+ }
74
+
75
+ Context appContext = context.getApplicationContext();
76
+ if (!isInit) {
77
+ isInit = true;
78
+ if (appContext instanceof Application) {
79
+ ((Application) appContext).registerActivityLifecycleCallbacks(new ThemeAndLanguageCallback());
80
+ }
81
+
82
+ /**
83
+ * 在此处添加代码 begin
84
+ */
85
+ setWebViewLanguage(appContext);
86
+ /**
87
+ * 在此处添加代码 end
88
+ */
89
+ Locale defaultLocale = getLocale(appContext);
90
+ SPUtils spUtils = SPUtils.getInstance(SP_THEME_AND_LANGUAGE_NAME);
91
+ currentLanguage = spUtils.getString(SP_KEY_LANGUAGE, defaultLocale.getLanguage());
92
+ currentThemeID = spUtils.getInt(SP_KEY_THEME, THEME_LIGHT);
93
+
94
+ // The language only needs to be initialized once
95
+ applyLanguage(appContext);
96
+ }
97
+ // The theme needs to be updated multiple times
98
+ applyTheme(appContext);
99
+ }
100
+ ```
101
+
102
+ ## 使用更多语言/自定义翻译表述
103
+
104
+ 如果您的 App 需要支持更多语言,或更改部分词条的翻译,请参考本部分。
105
+
106
+ 本章节以 `TUIGroup` 组件添加韩语语言包为例,讲解新增语言包和自定义翻译的流程。
107
+
108
+ ### 新增语言资源文件
109
+
110
+ 在 Android Studio 中的 `TUIGroup` 组件目录下,右键菜单中新增 Android Resource File:
111
+
112
+ 输入文件名 `strings`,由 `Locale` 维度创建资源目录:
113
+
114
+ 语言选择为韩语("ko: Korean"),地区选为"KR: South Korea" ,点击确定,这样就创建好了韩语资源文件 `values-ko-rKR/strings.xml`。
115
+
116
+ ### 个性化自定义翻译
117
+
118
+ 上一步已经创建好了韩语资源文件 `values-ko-rKR/strings.xml`,现在把 `values/strings.xml` 文件中的内容复制到 `values-ko-rKR/strings.xml`,用韩语替换对应的英文,如图所示:
119
+
120
+ 不同语言资源文件中语言的 `name` 是相同的,具体内容可以自定义翻译。
121
+
122
+ ### 跟随系统语言
123
+
124
+ 直接使用 `TUIKit` 即可,将手机默认语言设置为韩语后启动 App ,App 语言可以自动显示为韩语。
125
+
126
+ ### 指定显示的语言
127
+
128
+ 如果您需要指定 `TUIKit` 界面的语言为韩语,应该先在 `Appliction` 初始化时向语言管理器中添加韩语,然后再设置 `TUIKit` 界面的语言为韩语:
129
+ ``` java
130
+ public class MyApplication extends Application {
131
+ @Override
132
+ protected void onCreate() {
133
+ super.onCreate();
134
+ // 添加韩语
135
+ TUIThemeManager.addLanguage("ko-rKR", Locale.KOREA);
136
+ // 应用语言改为韩语
137
+ TUIThemeManager.getInstance().changeLanguage(this, "ko-rKR");
138
+ }
139
+ }
140
+ ```
141
+
142
+ 效果如图所示:
@@ -0,0 +1,57 @@
1
+ ## 组件概述
2
+
3
+ MessageInput 是基于 Jetpack Compose 构建的消息输入组件,为用户提供完整的消息编辑和发送功能。该组件支持多种消息类型的输入和发送,包括文本消息、图片、视频、文件、语音等,同时提供表情选择等增强功能,支持多种样式配置和自定义选项。
4
+ | <strong>消息输入界面</strong> | <strong>表情选择器</strong> |
5
+ | --- | --- |
6
+ | | |
7
+
8
+ ## 组件集成
9
+
10
+ MessageInput 组件属于 TUIKit Compose 的一部分,集成 TUIKit Compose 即可获取并使用 MessageInput 组件。集成方法请参考文档 TUIKit Compose 里的集成步骤。
11
+
12
+ ## 组件构成
13
+
14
+ MessageInput 组件包含消息输入核心组件和样式配置协议,提供了消息输入功能,并支持自定义。
15
+
16
+ #### 对外方法
17
+ | 方法名 | 参数 | 描述 |
18
+ | --- | --- | --- |
19
+ | <code> MessageInput</code> | <code>conversationID: String</code> | 会话 ID,用于标识当前聊天会话。如果是单聊,组成方式为 c2c_userID。如果是群聊,组成方式为 group_groupID。 |
20
+ | <code>modifier: Modifier</code> | Jetpack Compose 中用来设置组件的样式、布局、行为和外观。 | |
21
+ | <code>config: MessageInputConfigProtocol</code> | 输入样式配置,控制各功能按钮的显示。 | |
22
+ | <code>messageInputViewModelFactory: MessageInputViewModelFactory</code> | 创建组件内部 MessageInputViewModel 的工厂类。通常情况下,您无需手动创建,组件已提供默认实现。 | |
23
+
24
+ ## 基础用法
25
+
26
+ MessageInput 组件可直接初始化使用,需要提供会话 ID。
27
+ ``` swift
28
+ Box(
29
+ modifier = Modifier
30
+ .fillMaxWidth()
31
+ ) {
32
+ MessageInput(
33
+ conversationID = conversationID,
34
+ modifier = Modifier.navigationBarsPadding()
35
+ )
36
+ }
37
+ ```
38
+
39
+ ## 自定义组件
40
+
41
+ 您可以自定义决定是否显示输入栏上的功能入口:
42
+ ``` swift
43
+ // 自定义显示哪些功能按钮
44
+ MessageInput(
45
+ conversationID = conversationID,
46
+ config = ChatMessageInputConfig(
47
+ isShowAudioRecorder = false, // 隐藏语音录制
48
+ isShowPhotoTaker = true, // 显示拍照功能
49
+ isShowMore = true, // 显示更多功能
50
+ )
51
+ )
52
+ ```
53
+
54
+ 自定义效果如下图所示:
55
+ | 默认输入框 | 隐藏输入框上的语音录制功能 | 隐藏输入框上的全部功能 |
56
+ | --- | --- | --- |
57
+ | | | |
@@ -0,0 +1,142 @@
1
+ ## 组件概述
2
+
3
+ MessageList 是一个基于 Jetpack Compose 构建的消息列表组件,主要用于展示和管理聊天消息。该组件提供了完整的消息类型展示功能:
4
+ - 消息类型支持:文本、图片、视频、语音、文件、系统消息、表情消息等。
5
+
6
+ - 消息操作:支持长按菜单操作,例如复制、删除、撤回、以及自定义操作。
7
+
8
+ - 高度可定制:支持多种样式配置(例如气泡颜色、圆角、字体)和自定义操作项。
9
+
10
+ | <strong>聊天消息列表</strong> | <strong>消息长按菜单</strong> |
11
+ | --- | --- |
12
+ | | |
13
+
14
+ ## 组件集成
15
+
16
+ MessageList 是属于 TUIKit Compose 的一个组件,集成 TUIKit Compose 即可获取并使用 MessageList,集成方法请参考文档 TUIKit Compose 里的集成步骤。
17
+
18
+ ## 组件构成
19
+
20
+ MessageList 组件对外仅暴露了消息列表的初始化方法,其他逻辑均封装在 MessageList 中。
21
+
22
+ #### 对外方法
23
+ | 方法名 | 参数 | 描述 |
24
+ | --- | --- | --- |
25
+ | <code>MessageList</code> | <code>conversationID: String</code> | 初始化组件,设置会话 ID。如果是单聊,组成方式为 c2c_userID。如果是群聊,组成方式为 group_groupID。 |
26
+ | <code>modifier: Modifier </code> | Jetpack Compose 中用来设置组件的样式、布局、行为和外观。 | |
27
+ | <code>config: MessageListConfigProtocol</code> | 初始化组件,设置消息列表样式。 | |
28
+ | <code>customActions: List<MessageCustomAction></code> | 初始化组件,设置自定义消息菜单选项。 | |
29
+ | <code>locateMessage: MessageInfo?</code> | 初始化组件,设置定位消息。通常用于从消息搜索结果页跳转消息页同时定位到目标消息。 | |
30
+ | <code>messageListViewModelFactory: MessageListViewModelFactory</code> | 创建组件内部 MessageListViewModel 的工厂类。通常情况下,您无需手动创建,组件已提供默认实现。 | |
31
+ | <code>onUserClick: (String) -> Unit</code> | 初始化组件,设置点击用户头像跳转响应事件。 | |
32
+
33
+ ## 基础用法
34
+
35
+ MessageList 组件可直接初始化使用,需要提供会话 ID。除此之外,我们还建议您在初始化方法中实现 onUserClick。
36
+ ``` swift
37
+ Box(modifier = Modifier.systemBarsPadding()) {
38
+ MessageList(conversationID = conversationID) {
39
+ // 点击用户头像响应事件
40
+ }
41
+ }
42
+ ```
43
+
44
+ ## 自定义组件
45
+
46
+ 您可以自定义消息列表的样式和操作项。方法如下。
47
+
48
+ #### 自定义样式
49
+
50
+ 您可以实现 `MessageListConfigProtocol` 来创建完全自定义的样式:
51
+ ``` swift
52
+ class MyCustomConfig(
53
+ override val alignment: MessageAlignment = MessageAlignment.TWO_SIDED,
54
+ override val isShowTimeMessage: Boolean = true,
55
+ override val isShowLeftAvatar: Boolean = true,
56
+ override val isShowLeftNickname: Boolean = true,
57
+ override val isShowRightAvatar: Boolean = true,
58
+ override val isShowRightNickname: Boolean = true,
59
+ // ... 其他必须属性
60
+ ) : MessageListConfigProtocol
61
+
62
+ MessageList(conversationID = conversationID, config = MyCustomConfig()) {
63
+ // 点击用户头像响应事件
64
+ }
65
+ ```
66
+
67
+ `MessageListConfigProtocol` 属性说明:
68
+ | 属性名 | 类型 | 描述 | 备注 |
69
+ | --- | --- | --- | --- |
70
+ | <code>alignment</code> | <code>MessageAlignment</code> | 消息对齐方式 | - <code>MessageAlignment.LEFT</code>:左对齐。<br>- <code>MessageAlignment.RIGHT</code>:右对齐。<br>- <code>MessageAlignment.TWO_SIDED</code>:左右对齐。 |
71
+ | <code>isShowTimeMessage</code> | <code>Boolean</code> | 是否显示时间消息 | 控制是否显示消息时间戳。 |
72
+ | <code>isShowLeftAvatar</code> | <code>Boolean</code> | 是否显示左侧头像 | 控制接收消息时是否显示发送者头像。 |
73
+ | <code>isShowLeftNickname</code> | <code>Boolean</code> | 是否显示左侧昵称 | 控制接收消息时是否显示发送者昵称。 |
74
+ | <code>isShowRightAvatar</code> | <code>Boolean</code> | 是否显示右侧头像 | 控制发送消息时是否显示自己头像。 |
75
+ | <code>isShowRightNickname</code> | <code>Boolean</code> | 是否显示右侧昵称 | 控制发送消息时是否显示自己昵称。 |
76
+ | <code>isShowTimeInBubble</code> | <code>Boolean</code> | 是否在气泡内显示时间 | 控制时间戳是否显示在消息气泡内部。 |
77
+ | <code>cellSpacing</code> | <code>Dp</code> | 消息间距 | 控制相邻消息之间的间距。 |
78
+ | <code>isShowSystemMessage</code> | <code>Boolean</code> | 是否显示系统消息 | 控制是否显示系统通知类消息。 |
79
+ | <code>isShowUnsupportMessage</code> | <code>Boolean</code> | 是否显示不支持的消息 | 控制是否显示不支持类型的消息。 |
80
+ | <code>horizontalPadding</code> | <code>Dp</code> | 水平内边距 | 控制消息列表的左右内边距。 |
81
+ | <code>avatarSpacing</code> | <code>Dp</code> | 头像间距 | 控制头像与消息内容之间的间距。 |
82
+ | <code>isSupportCopy</code> | <code>Boolean</code> | 消息操作菜单是否支持复制 | - |
83
+ | <code>isSupportDelete</code> | <code>Boolean</code> | 消息操作菜单是否支持删除 | - |
84
+ | <code>isSupportRecall</code> | <code>Boolean</code> | 消息操作菜单是否支持撤回 | - |
85
+
86
+ ### **自定义操作项**
87
+
88
+ 您可以采用多种方式自定义长按消息菜单项。
89
+
90
+ #### 方式 1. 局部隐藏/显示操作项
91
+
92
+ 初始化 MessageList 时,通过设置 config 中的 `isSupportCopy`、`isSupportDelete`、`isSupportRecall`显示操作项:
93
+ ``` swift
94
+ MessageList(
95
+ conversationID = conversationID,
96
+ config = ChatMessageListConfig(isSupportCopy = false)
97
+ ) {
98
+ // 点击用户头像响应事件
99
+ }
100
+ ```
101
+
102
+ #### 方式 2. 局部增加操作项
103
+
104
+ 初始化 MessageList 时传入 `customActions`,MessageList 内部会在默认的 action 底部添加您增加的自定义选项:
105
+ ``` swift
106
+ MessageList(
107
+ conversationID = conversationID,
108
+ customActions = listOf(
109
+ MessageCustomAction(title = "Share", iconResID = R.drawable.message_list_menu_forward_icon) {
110
+ println("Share Message")
111
+ }
112
+ )
113
+ )
114
+ ```
115
+
116
+ #### **方式 3. 全局配置操作项**
117
+
118
+ 通过 `AppBuilderConfig` 进行全局配置:
119
+ ``` swift
120
+ // 在应用启动时配置
121
+ AppBuilderConfig.messageActionList = listOf(
122
+ MessageAction.COPY, // 支持复制
123
+ MessageAction.DELETE, // 支持删除
124
+ MessageAction.RECALL // 支持撤回
125
+ )
126
+
127
+ // 接下来再初始化 MessageList,所有的 MessageList 都会遵守上面的配置
128
+ MessageList(
129
+ conversationID = conversationID,
130
+ )
131
+ ```
132
+
133
+ > **注意:**
134
+ >
135
+
136
+ > 局部配置的优先级大于全局配置。
137
+ >
138
+
139
+ 自定义效果如下图所示:
140
+ | 消息列表操作(默认选项) | 消息列表操作(隐藏<strong>复制</strong>选项) | 消息列表操作(新增<strong>分享</strong>选项) |
141
+ | --- | --- | --- |
142
+ | | | |