@tencentcloud/sdk-mcp 1.4.7 → 1.6.0-beta.2

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 +36 -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,22 +1,38 @@
1
- 本文将介绍如何集成 `TUIKit` 组件。
1
+ TUIKit 是基于 IM SDK 的一款 UI 组件库,可通过 UI 组件快速实现聊天、会话、搜索、关系链、群组等功能。本文介绍如何快速集成 TUIKit 并实现核心功能。
2
2
 
3
- > **说明:**
4
- >
5
- > 1. 从 5.7.1435 版本开始,TUIKit 支持模块化集成,支持了经典版 UI,您可以根据自己的需求集成所需模块。
6
- > 2. 从 6.9.3557 版本开始,TUIKit 新增了全新的简约版 UI。
7
- > 3. 为了尊重版权,IM Demo/TUIKit 工程中默认不包含大表情元素切图。正式上线商用前请您替换为自己设计或拥有版权的其他表情包。下图所示默认的**小黄脸表情包版权归腾讯云所有**,可有偿授权使用,如需获得授权可您可以通过升级至 [IM 企业版套餐](https://buy.cloud.tencent.com/avc) 免费使用该表情包。
3
+ > **架构说明**:本文档对应 **iOS TUIKit(UIKit 架构)**,适用于基于 UIKit 的项目。如需 SwiftUI 架构,请参考 iOS TUIKit SwiftUI 集成文档。
8
4
 
9
- >
10
- >
5
+ ## 关键概念
6
+ - **经典版 UI**:从 5.7.1435 版本开始,TUIKit 支持模块化集成,支持了经典版 UI(类微信 UI)。
7
+
8
+ - **简约版 UI**:从 6.9.3557 版本开始,TUIKit 新增了全新的简约版 UI(类 WhatsApp UI)。
9
+
10
+ 您可以根据需求自由选择经典版或简约版 UI 组件。如果您还不了解各个界面库的功能,可以查阅文档 [TUIKit 界面库介绍](https://cloud.tencent.com/document/product/269/37190)。
11
+
12
+ ## 前提条件
13
+ - Xcode 15 及以上
11
14
 
12
- 您可以根据需求自由选择经典版或简约版 UI 组件。如果您还不了解各个界面库的功能,可以查阅文档 [TUIKit 界面库介绍](https://cloud.tencent.com/document/product/269/37190)。
15
+ - iOS 14.0 及以上
13
16
 
14
- ## 开发环境要求
15
- - Xcode 10 及以上
17
+ - 一个有效的腾讯云账号及 Chat 应用。可参考 开通服务 从控制台获取以下信息:
16
18
 
17
- - iOS 9.0 及以上
19
+ - SDKAppID:App 在控制台获取的 Chat 应用的 ID,为应用的唯一标识。
20
+
21
+ - SDKSecretKey:应用的密钥。
18
22
 
19
23
  ## CocoaPods 集成
24
+
25
+ > **消息引用与回复功能的版本兼容性:**
26
+ >
27
+
28
+ > 自 9.0.7652 版本起:
29
+ >
30
+ > - **消息引用(Quote)**改用 IMSDK 原生引用能力实现,与旧版本引用消息格式不兼容。新旧版本互发的引用消息无法正确解析引用内容,请将收发双方统一升级至 9.0.7652 及以上版本。
31
+ > - **消息回复(Reply)**功能已下线,相关接口与 UI 入口不再提供,如业务有相关需求,可参考旧版本 TUIKit 自行实现。
32
+
33
+ > **两者区别:引用是发送新消息时附带一条历史消息的摘要卡片,点击可跳转原消息(一问一答);回复是在某条消息下追加评论并聚合成回复列表(评论区式)。**
34
+ >
35
+
20
36
  1. 安装 CocoaPods。
21
37
  在终端窗口中输入如下命令(需要提前在 Mac 中安装 Ruby 环境):
22
38
 
@@ -35,12 +51,12 @@
35
51
 
36
52
  - DevelopmentPods 本地集成。
37
53
 
38
- 以上两种集成方式的优缺点如下表所示:
54
+ 上面两种集成方式的优缺点如下表所示:
39
55
 
40
- | 集成方式 | 适合场景 | 优点 | 缺点 |
41
- | --- | --- | --- | --- |
42
- | 远程 CocoaPods 集成 | 适合无源码修改时的集成。 | 当 TUIKit 有版本更新时,您只需再次` Pod update `即可完成更新。 | 当您有源码修改,使用 `Pod update` 更新时,新版本的 TUIKit 会覆盖您的修改。 |
43
- | 本地 DevelopmentPods 集成 | 适合有涉及源码自定义修改的客户。 | 当您有自己的 git 仓库时,可以跟踪修改。修改源码后,使用 `Pod update` 更新其他远程 Pod 库时,不会覆盖您的修改。 | 您需要手动将 TUIKit 源码覆盖您本地 TUIKit 文件夹进行更新。 |
56
+ |集成方式|适合场景|优点|缺点|
57
+ |---------|---------|---------|---------|
58
+ |远程 CocoaPods 集成|适合无源码修改时的集成。|当 TUIKit 有版本更新时,您只需再次` Pod update `即可完成更新。|当您有源码修改,使用 `Pod update` 更新时,新版本的 TUIKit 会覆盖您的修改。|
59
+ |本地 DevelopmentPods 集成|适合有涉及源码自定义修改的客户。|当您有自己的 git 仓库时,可以跟踪修改。修改源码后,使用 `Pod update` 更新其他远程 Pod 库时,不会覆盖您的修改。|您需要手动将 TUIKit 源码覆盖您本地 TUIKit 文件夹进行更新。|
44
60
 
45
61
  ### 远程 CocoaPods 集成
46
62
 
@@ -58,7 +74,7 @@
58
74
  ``` bash
59
75
  # Uncomment the next line to define a global platform for your project
60
76
  source 'https://github.com/CocoaPods/Specs.git'
61
- platform :ios, '13.0'
77
+ platform :ios, '14.0'
62
78
  # 防止 TUIKit 组件里的 *.xcassets 与您项目里面冲突。
63
79
  install! 'cocoapods', :disable_input_output_paths => true
64
80
 
@@ -100,7 +116,7 @@ post_install do |installer|
100
116
  config.build_settings['CODE_SIGNING_REQUIRED'] = "NO"
101
117
  config.build_settings['CODE_SIGNING_ALLOWED'] = "NO"
102
118
  config.build_settings['ENABLE_BITCODE'] = "NO"
103
- config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = "13.0"
119
+ config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = "14.0"
104
120
  #Fix Xcode15 other links flag -ld64
105
121
  xcode_version = `xcrun xcodebuild -version | grep Xcode | cut -d' ' -f2`.to_f
106
122
  if xcode_version >= 15
@@ -120,14 +136,14 @@ post_install do |installer|
120
136
  end
121
137
  end
122
138
  end
123
-
139
+ end
124
140
  ```
125
141
 
126
142
  【Objective-C 组件】
127
143
  ``` bash
128
144
  # Uncomment the next line to define a global platform for your project
129
145
  source 'https://github.com/CocoaPods/Specs.git'
130
- platform :ios, '13.0'
146
+ platform :ios, '14.0'
131
147
  # 防止 TUIKit 组件里的 *.xcassets 与您项目里面冲突。
132
148
  install! 'cocoapods', :disable_input_output_paths => true
133
149
 
@@ -136,7 +152,7 @@ target 'your_project_name' do
136
152
  # 从 7.1 版本开始,新增了 TUIKit 插件(TUIXXXPlugin),TUIKit 插件是动态库依赖,需要开启此设置。
137
153
  # 如果您不依赖 TUIKit 插件,该设置可以保持关闭。
138
154
  use_frameworks!
139
- # 请按需开启 modular headers,开启后 Pod 模块才能使用 @import 导入,简化 Swift 引用 OC 的方式。
155
+ # 请按需开启 use_modular_headers!。开启后,Pod 会被生成为 Clang Module,OC 可用 @import 模块名;、Swift 可直接 import 模块名 引用,无需 Bridging Header。
140
156
  # use_modular_headers!
141
157
 
142
158
  # 集成聊天功能
@@ -176,7 +192,7 @@ post_install do |installer|
176
192
  config.build_settings['CODE_SIGNING_REQUIRED'] = "NO"
177
193
  config.build_settings['CODE_SIGNING_ALLOWED'] = "NO"
178
194
  config.build_settings['ENABLE_BITCODE'] = "NO"
179
- config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = "13.0"
195
+ config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = "14.0"
180
196
  #Fix Xcode15 other links flag -ld64
181
197
  xcode_version = `xcrun xcodebuild -version | grep Xcode | cut -d' ' -f2`.to_f
182
198
  if xcode_version >= 15
@@ -196,7 +212,7 @@ post_install do |installer|
196
212
  end
197
213
  end
198
214
  end
199
-
215
+ end
200
216
  ```
201
217
 
202
218
  【简约版】
@@ -205,7 +221,7 @@ post_install do |installer|
205
221
  ``` bash
206
222
  # Uncomment the next line to define a global platform for your project
207
223
  source 'https://github.com/CocoaPods/Specs.git'
208
- platform :ios, '13.0'
224
+ platform :ios, '14.0'
209
225
  # 防止 TUIKit 组件里的 *.xcassets 与您项目里面冲突。
210
226
  install! 'cocoapods', :disable_input_output_paths => true
211
227
 
@@ -240,7 +256,7 @@ post_install do |installer|
240
256
  config.build_settings['CODE_SIGNING_REQUIRED'] = "NO"
241
257
  config.build_settings['CODE_SIGNING_ALLOWED'] = "NO"
242
258
  config.build_settings['ENABLE_BITCODE'] = "NO"
243
- config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = "13.0"
259
+ config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = "14.0"
244
260
  #Fix Xcode15 other links flag -ld64
245
261
  xcode_version = `xcrun xcodebuild -version | grep Xcode | cut -d' ' -f2`.to_f
246
262
  if xcode_version >= 15
@@ -260,13 +276,14 @@ post_install do |installer|
260
276
  end
261
277
  end
262
278
  end
279
+ end
263
280
  ```
264
281
 
265
282
  【Objective-C 组件】
266
283
  ``` bash
267
284
  # Uncomment the next line to define a global platform for your project
268
285
  source 'https://github.com/CocoaPods/Specs.git'
269
- platform :ios, '13.0'
286
+ platform :ios, '14.0'
270
287
  # 防止 TUIKit 组件里的 *.xcassets 与您项目里面冲突。
271
288
  install! 'cocoapods', :disable_input_output_paths => true
272
289
 
@@ -275,7 +292,7 @@ target 'your_project_name' do
275
292
  # 从 7.1 版本开始,新增了 TUIKit 插件(TUIXXXPlugin),TUIKit 插件是动态库依赖,需要开启此设置。
276
293
  # 如果您不依赖 TUIKit 插件,该设置可以保持关闭。
277
294
  use_frameworks!
278
- # 请按需开启 modular headers,开启后 Pod 模块才能使用 @import 导入,简化 Swift 引用 OC 的方式。
295
+ # 请按需开启 use_modular_headers!。开启后,Pod 会被生成为 Clang Module,OC 可用 @import 模块名;、Swift 可直接 import 模块名 引用,无需 Bridging Header。
279
296
  # use_modular_headers!
280
297
 
281
298
  # 集成聊天功能
@@ -306,7 +323,7 @@ post_install do |installer|
306
323
  config.build_settings['CODE_SIGNING_REQUIRED'] = "NO"
307
324
  config.build_settings['CODE_SIGNING_ALLOWED'] = "NO"
308
325
  config.build_settings['ENABLE_BITCODE'] = "NO"
309
- config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = "13.0"
326
+ config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = "14.0"
310
327
  #Fix Xcode15 other links flag -ld64
311
328
  xcode_version = `xcrun xcodebuild -version | grep Xcode | cut -d' ' -f2`.to_f
312
329
  if xcode_version >= 15
@@ -326,13 +343,13 @@ post_install do |installer|
326
343
  end
327
344
  end
328
345
  end
346
+ end
329
347
  ```
330
348
 
331
349
  > **说明:**
332
350
  >
333
351
  > 1. 如果您直接 `pod 'TUIChat'`,不指定经典版或简约版,默认会集成两套版本 UI 组件。
334
352
  > 2. 经典版和简约版 UI 不能混用,集成多个组件时,您必须同时全部选择经典版 UI 或简约版 UI。例如,经典版 `TUIChat` 组件必须与经典版 `TUIConversation`、`TUIContact` 组件搭配使用。同理,简约版 `TUIChat` 组件必须与简约版 `TUIConversation`、`TUIContact` 组件搭配使用。
335
- > 3. 如果您使用的是 Swift,请开启 `use_modular_headers!` ,并将头文件引用改成 @import 模块名形式引用。
336
353
 
337
354
  Podfile 修改完毕后,执行以下命令,安装 TUIKit 组件。
338
355
  ``` bash
@@ -344,25 +361,31 @@ pod install
344
361
  pod repo update
345
362
  ```
346
363
 
347
- 之后执行以下命令,更新组件库的Pod版本。
364
+ 之后执行以下命令,更新组件库的 Pod 版本。
348
365
  ``` bash
349
366
  pod update
350
367
  ```
351
368
 
352
369
  集成全部的 TUIKit 组件后的项目结构:
353
370
 
354
- > **注意:**
371
+ ### 本地 DevelopmentPods 源码集成
372
+
373
+ > **消息引用与回复功能的版本兼容性:**
355
374
  >
356
375
 
357
- > 若您操作遇到错误,可查阅文末的常见问题。
376
+ > 自 9.0.7652 版本起:
377
+ >
378
+ > - 消息引用(Quote) 改用 IMSDK 原生引用能力实现,与旧版本引用消息格式不兼容。新旧版本互发的引用消息无法正确解析引用内容,请将收发双方统一升级至 9.0.7652 及以上版本。
379
+ > - 消息回复(Reply) 功能已下线,相关接口与 UI 入口不再提供,如业务有相关需求,可参考旧版本 TUIKit 自行实现。
380
+
381
+ > *两者区别:引用是发送新消息时附带一条历史消息的摘要卡片,点击可跳转原消息(一问一答);回复是在某条消息下追加评论并聚合成回复列表(评论区式)。*
358
382
  >
359
383
 
360
- ### 本地 DevelopmentPods 源码集成
361
384
  1. 从 GitHub 下载 TUIKit 源码,将 TUIKit 目录直接拖入您的工程目录下:
362
385
 
363
- - [Swift TUIKit 源码 Github 地址](https://github.com/Tencent-RTC/Chat_UIKit/tree/main/Swift/TUIKit):
386
+ - [Swift TUIKit 源码 GitHub 地址](https://github.com/Tencent-RTC/Chat_UIKit/tree/main/Swift/TUIKit):
364
387
 
365
- - [Objective-C TUIKit 源码 Github 地址](https://github.com/TencentCloud/TIMSDK/tree/master/iOS/TUIKit):
388
+ - [Objective-C TUIKit 源码 GitHub 地址](https://github.com/TencentCloud/TIMSDK/tree/master/iOS/TUIKit):
366
389
 
367
390
  2. 修改您 Podfile 中每个组件的本地路径。path 是 TUIKit 文件夹相对于您工程 Podfile 文件的位置,常见的有:
368
391
 
@@ -374,13 +397,13 @@ pod update
374
397
 
375
398
  以 TUIKit 文件夹位于您工程 Podfile 文件父目录为例:
376
399
 
377
- 【DevelopmentPodfile】
400
+ 【Development Podfile】
378
401
 
379
402
  【Swift 组件】
380
403
  ``` bash
381
404
  # Uncomment the next line to define a global platform for your project
382
405
  source 'https://github.com/CocoaPods/Specs.git'
383
- platform :ios, '13.0'
406
+ platform :ios, '14.0'
384
407
  install! 'cocoapods', :disable_input_output_paths => true
385
408
 
386
409
  # 请使用您的真实项目名称替换 your_project_name
@@ -424,7 +447,7 @@ post_install do |installer|
424
447
  config.build_settings['CODE_SIGNING_REQUIRED'] = "NO"
425
448
  config.build_settings['CODE_SIGNING_ALLOWED'] = "NO"
426
449
  config.build_settings['ENABLE_BITCODE'] = "NO"
427
- config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = "13.0"
450
+ config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = "14.0"
428
451
  #Fix Xcode15 other links flag -ld64
429
452
  xcode_version = `xcrun xcodebuild -version | grep Xcode | cut -d' ' -f2`.to_f
430
453
  if xcode_version >= 15
@@ -444,14 +467,14 @@ post_install do |installer|
444
467
  end
445
468
  end
446
469
  end
447
- en
470
+ end
448
471
  ```
449
472
 
450
473
  【Objective-C 组件】
451
474
  ``` bash
452
475
  # Uncomment the next line to define a global platform for your project
453
476
  source 'https://github.com/CocoaPods/Specs.git'
454
- platform :ios, '13.0'
477
+ platform :ios, '14.0'
455
478
  install! 'cocoapods', :disable_input_output_paths => true
456
479
 
457
480
  # 请使用您的真实项目名称替换 your_project_name
@@ -497,7 +520,7 @@ post_install do |installer|
497
520
  config.build_settings['CODE_SIGNING_REQUIRED'] = "NO"
498
521
  config.build_settings['CODE_SIGNING_ALLOWED'] = "NO"
499
522
  config.build_settings['ENABLE_BITCODE'] = "NO"
500
- config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = "13.0"
523
+ config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = "14.0"
501
524
  #Fix Xcode15 other links flag -ld64
502
525
  xcode_version = `xcrun xcodebuild -version | grep Xcode | cut -d' ' -f2`.to_f
503
526
  if xcode_version >= 15
@@ -517,7 +540,7 @@ post_install do |installer|
517
540
  end
518
541
  end
519
542
  end
520
- en
543
+ end
521
544
  ```
522
545
 
523
546
  3. Podfile 修改完毕后,执行以下命令,安装本地 TUIKit 组件。示例:
@@ -528,7 +551,7 @@ en
528
551
 
529
552
  > **注意:**
530
553
  >
531
- > 1. 使用本地集成方案时,如需升级时需要从 Github 获取最新的组件代码,覆盖您本地项目的 TUIKit 目录。
554
+ > 1. 使用本地集成方案时,如需升级时需要从 GitHub 获取最新的组件代码,覆盖您本地项目的 TUIKit 目录。
532
555
  > 2. 当私有化修改和远端有冲突时,需要手动合并,处理冲突。
533
556
  > 3. TUIKit 插件需要依赖 TUICore 的版本,请确保插件版本和 "../TUIKit/TUICore/TUICore.spec" 中的 spec.version 一致。
534
557
 
@@ -558,27 +581,23 @@ TUIKit 依赖的第三方库的最低版本如下,如果您的版本较低,
558
581
  - SSZipArchive (2.4.3)
559
582
  ```
560
583
 
561
- ## 快速搭建
584
+ ## 接入步骤
562
585
 
563
- 常用的聊天软件都是由会话列表、聊天窗口、好友列表、音视频通话等几个基本的界面组成,参考下面步骤,您仅需几行代码即可在项目中快速搭建这些 UI 界面。
586
+ 常用的聊天软件都是由会话列表、聊天窗口、好友列表、音视频通话等几个基本的界面组成,参考下面步骤,您仅需几行代码即可在项目中快速搭建这些 UI 界面。 实操教学(Objective-C 组件版本)视频请参见:[极速集成 TUIKit(iOS)](https://cloud.tencent.com/edu/learning/quick-play/3130-82618)。
564
587
 
565
- > **说明:**
566
- >
588
+ ### 步骤1:配置用户鉴权
567
589
 
568
- > 关于 TUIKit 组件模块功能:
569
- >
570
- > - 实操教学(Objective-C 组件版本)视频请参见:[极速集成 TUIKit(iOS)](https://cloud.tencent.com/edu/learning/course-3130-56699)。
571
- > - 如果想了解更多,您还可以 [下载并运行 TUIKitDemo 源码](https://cloud.tencent.com/document/product/269/68228),内含常见功能示例。
590
+ SDKAppID 需要在 [即时通信 IM 控制台](https://console.cloud.tencent.com/im) 创建并获取,userSig 需要按规则计算,详细步骤请参考文档 [跑通 Demo](https://cloud.tencent.com/document/product/269/68228)。
572
591
 
573
- ### 步骤1:组件登录
592
+ ### 步骤2:用户登录
574
593
 
575
594
  登录组件后才能正常使用组件的功能。用户在 App 上点击登录时,您可以登录 TUIKit 组件。
576
- SDKAppID 需要在 [即时通信 IM 控制台](https://console.cloud.tencent.com/im) 创建并获取,userSig 需要按规则计算,详细步骤请参考文档 [快速入门](https://cloud.tencent.com/document/product/269/68228#.E6.93.8D.E4.BD.9C.E6.AD.A5.E9.AA.A4)。
577
595
 
578
596
  示例代码如下所示:
579
597
 
580
598
  【Swift】
581
599
  ``` swift
600
+ import TUICore
582
601
  @objc func loginSDK(_ userID: String, userSig: String, succ: TSucc?, fail: TFail?) {
583
602
  TUILogin.login(Int32(SDKAPPID), userID: userID, userSig: userSig, config: loginConfig, succ: {
584
603
  // update UI
@@ -603,7 +622,7 @@ SDKAppID 需要在 [即时通信 IM 控制台](https://console.cloud.tencent.com
603
622
  }
604
623
  ```
605
624
 
606
- ### 步骤2:构建会话列表
625
+ ### 步骤3:构建会话列表界面
607
626
 
608
627
  会话列表只需要创建 `TUIConversationListController` 对象即可。会话列表会从数据库中读取最近联系人,当用户点击联系人时,`TUIConversationListController` 将事件 `didSelectConversation` 回调给上层。
609
628
 
@@ -613,17 +632,22 @@ SDKAppID 需要在 [即时通信 IM 控制台](https://console.cloud.tencent.com
613
632
 
614
633
  【Swift】
615
634
  ``` swift
635
+ import UIKit
636
+ import TUICore
637
+ import ImSDK_Plus
638
+ import TIMCommon
639
+ import TUIConversation
616
640
  // ConversationController 为您自己的 ViewController
617
641
  public class ConversationController: UIViewController, V2TIMSDKListener, TUIPopViewDelegate {
618
- override public func viewDidLoad() {
619
- super.viewDidLoad()
620
- setupNavigation()
621
-
622
- conv = TUIConversationListController()
623
- if let conv = conv {
624
- addChild(conv)
625
- view.addSubview(conv.view)
626
- }
642
+ private var conv: TUIConversationListController?
643
+ override public func viewDidLoad() {
644
+ super.viewDidLoad()
645
+ setupNavigation()
646
+ conv = TUIConversationListController()
647
+ if let conv = conv {
648
+ addChild(conv)
649
+ view.addSubview(conv.view)
650
+ }
627
651
  }
628
652
  }
629
653
  // 会话列表点击事件,可自定义,通常是打开聊天界面
@@ -702,7 +726,7 @@ public protocol TUIConversationListControllerListener: AnyObject {
702
726
  @end
703
727
  ```
704
728
 
705
- ### 步骤3:构建聊天窗口
729
+ ### 步骤4:构建聊天界面
706
730
 
707
731
  初始化聊天界面时,需要上层传入当前聊天界面对应的会话信息。
708
732
 
@@ -712,6 +736,11 @@ public protocol TUIConversationListControllerListener: AnyObject {
712
736
 
713
737
  【Swift】
714
738
  ``` swift
739
+ import UIKit
740
+ import TUICore
741
+ import TIMCommon
742
+ import TUIChat
743
+
715
744
  let conversationData = TUIChatConversationModel()
716
745
  conversationData.userID = userID ?? ""
717
746
  conversationData.groupID = groupID ?? ""
@@ -806,16 +835,21 @@ private func getChatViewController(_ model: TUIChatConversationModel) -> TUIBase
806
835
  > `TUIC2CChatViewController_Minimalist` 会自动拉取该用户的历史消息并展示出来。
807
836
  >
808
837
 
809
- ### 步骤4:构建通讯录界面
838
+ ### 步骤5:构建联系人界面
810
839
 
811
- 通讯录界面不需要其它依赖,只需创建对象并显示出来即可。
840
+ 联系人列表界面不需要其它依赖,只需创建对象并显示出来即可。
812
841
 
813
842
  【经典版】
814
843
 
815
844
  【Swift】
816
845
  ``` swift
846
+ import UIKit
847
+ import TUICore
848
+ import TIMCommon
849
+ import TUIContact
817
850
  // ContactController 为您自己的 ViewController
818
851
  public class ContactsController: UIViewController, TUIPopViewDelegate {
852
+ var contactVC: TUIContactController?
819
853
  override public func viewDidLoad() {
820
854
  super.viewDidLoad()
821
855
 
@@ -848,6 +882,7 @@ public class ContactsController: UIViewController, TUIPopViewDelegate {
848
882
 
849
883
  【Swift】
850
884
  ``` swift
885
+ import TUIContact
851
886
  protocol TUIContactControllerListener: NSObjectProtocol {
852
887
  func onSelectFriend(_ cell: TUICommonContactCell) -> Bool
853
888
  func onAddNewFriend(_ cell: TUICommonTableViewCell) -> Bool
@@ -858,6 +893,7 @@ protocol TUIContactControllerListener: NSObjectProtocol {
858
893
 
859
894
  【Objective-C】
860
895
  ``` objectivec
896
+ #import “TUIContactController.h”
861
897
  @protocol TUIContactControllerListener <NSObject>
862
898
  @optional
863
899
  - (void)onSelectFriend:(TUICommonContactCell *)cell;
@@ -921,12 +957,15 @@ protocol TUIContactControllerListener_Minimalist: AnyObject {
921
957
  @end
922
958
  ```
923
959
 
924
- 例如,单击好友后,您可以将好友信息页展示出来:
960
+ 例如单击好友后,您可以将好友信息页展示出来:
925
961
 
926
962
  【经典版】
927
963
 
928
964
  【Swift】
929
965
  ``` swift
966
+ import TIMCommon
967
+ import TUICore
968
+ import UIKit
930
969
  @objc private func onSelectFriend(_ cell: TUICommonContactCell) {
931
970
  if let delegate = delegate {
932
971
  if delegate.onSelectFriend(cell) { return }
@@ -983,7 +1022,7 @@ protocol TUIContactControllerListener_Minimalist: AnyObject {
983
1022
  }
984
1023
  ```
985
1024
 
986
- ### 步骤5:构建音视频通话功能
1025
+ ### 步骤6:构建音视频通话功能
987
1026
 
988
1027
  TUI 组件支持在聊天界面对用户发起音视频通话,仅需要简单几步就可以快速集成:
989
1028
  | 视频通话 | 语音通话 |
@@ -1005,7 +1044,17 @@ TUI 组件支持在聊天界面对用户发起音视频通话,仅需要简单
1005
1044
  // 集成音视频通话组件
1006
1045
  pod 'TUICallKit_Swift'
1007
1046
  ```
1008
- 6. 发起和接收视频或语音通话。
1047
+ 6. 使用音视频功能,需要授权摄像头和麦克风的使用权限,请根据实际项目需要,设置项目所需权限。
1048
+
1049
+ 在 **Xcode** 中,选择** TARGETS > Info > Custom iOS Target Properties** 菜单。
1050
+
1051
+  单击 **+**,添加摄像头和麦克风权限:
1052
+
1053
+ - Privacy - Camera Usage Description
1054
+
1055
+ - Privacy - Microphone Usage Description
1056
+
1057
+ 7. 发起和接收视频或语音通话。
1009
1058
 
1010
1059
  | 消息页发起通话 | 联系人页发起通话 |
1011
1060
  | --- | --- |
@@ -1015,12 +1064,12 @@ TUI 组件支持在聊天界面对用户发起音视频通话,仅需要简单
1015
1064
 
1016
1065
  - 当用户在线收到通话邀请时,TUIKit 会自动展示通话接收 UI,用户可以选择同意或者拒绝通话。
1017
1066
 
1018
- - 当用户离线收到通话邀请时,如需唤起 App 通话,就要使用到离线推送能力,离线推送的实现请参见 [添加离线推送](https://cloud.tencent.com/document/product/269/109894)。
1067
+ - 当用户离线收到通话邀请时,如果需要唤起 App 通话,就要使用到离线推送能力,离线推送的实现请参见 [添加离线推送](https://cloud.tencent.com/document/product/269/109894)。
1019
1068
 
1020
- 7. 添加离线推送。
1069
+ 8. 添加离线推送。
1021
1070
  在使用离线推送之前,您需要开通 [IM 离线推送](https://cloud.tencent.com/document/product/269/75429) 服务。
1022
1071
 
1023
- 8. 关于 App 的配置,您可以参见文档:[集成 TUIOfflinePush 跑通离线推送功能](https://cloud.tencent.com/document/product/269/109894)。
1072
+ 9. 关于 App 的配置,您可以参见文档:[集成推送服务(Push)跑通离线推送功能](https://cloud.tencent.com/document/product/269/109894)。
1024
1073
 
1025
1074
  > **说明:**
1026
1075
  >
@@ -1028,9 +1077,11 @@ TUI 组件支持在聊天界面对用户发起音视频通话,仅需要简单
1028
1077
  > 配置完成后,当单击接收到的**音视频通话离线推送通知**时, TUICallKit 会自动拉起**音视频通话邀请界面**。
1029
1078
  >
1030
1079
 
1031
- 9. 附加增值能力
1032
- 集成 TUIChat 和 TUICallkit 的组件后,在聊天界面发送语音消息时,即可**录制带 AI 降噪和自动增益的语音消息**。该功能需要购买 [音视频通话能力](https://cloud.tencent.com/document/product/1640/79968) 进阶版及以上套餐,仅 IMSDK 7.0 及以上版本支持。当套餐过期后,录制语音消息会切换到系统 API 进行录音。
1033
- 下面是使用两台华为 P10同时录制的语音消息对比:
1080
+ 10. 附加增值能力
1081
+
1082
+ 集成 TUIChat 和 TUICallKit 的组件后,在聊天界面发送语音消息时,即可**录制带 AI 降噪和自动增益的语音消息**。该功能需要购买 [音视频通话能力](https://cloud.tencent.com/document/product/1640/79968) 进阶版及以上套餐,仅 IMSDK 7.0 及以上版本支持。当套餐过期后,录制语音消息会切换到系统 API 进行录音。
1083
+
1084
+ 下面是使用两台华为 P10 同时录制的语音消息对比:
1034
1085
 
1035
1086
  <link rel="stylesheet" href="//cloudcache.tencentcs.com/open_proj/proj_qcloud_v2/gateway/portal/css/global-20209142343.css?max_age=31536000&amp;t=20191128" />
1036
1087
  <link rel="stylesheet" href="//cloudcache.tencentcs.com/open_proj/proj_qcloud_v2/gateway/portal/css/global-components.css?max_age=31536000&amp;t=20180817" />
@@ -1057,7 +1108,7 @@ TUI 组件支持在聊天界面对用户发起音视频通话,仅需要简单
1057
1108
 
1058
1109
  </div>
1059
1110
 
1060
- ### 步骤6:构建多人音视频功能
1111
+ ### 步骤7. 构建多人音视频功能
1061
1112
 
1062
1113
  TUI 组件支持在聊天界面对用户发起多人音视频,仅需要简单几步就可以快速集成:
1063
1114
 
@@ -1067,7 +1118,7 @@ TUI 组件支持在聊天界面对用户发起多人音视频,仅需要简单
1067
1118
 
1068
1119
  3. 找到含 UI 低代码场景方案功能区,单击卡片下方的多人音视频(TUIRoomKit) > 免费体验。
1069
1120
 
1070
- 4. 在弹窗中单击免费试用7天,即可成功开通多人音视频免费体验版。开通完成后即可参见 [集成指引](https://cloud.tencent.com/document/product/269/84296) 进行集成。
1121
+ 4. 在弹窗中单击免费试用 7 天,即可成功开通多人音视频免费体验版。开通完成后即可参见 [集成指引](https://cloud.tencent.com/document/product/269/84296) 进行集成。
1071
1122
 
1072
1123
  5. 集成 TUIRoomKit 组件。在 podfile 文件中添加以下内容。
1073
1124
 
@@ -1081,7 +1132,9 @@ TUI 组件支持在聊天界面对用户发起多人音视频,仅需要简单
1081
1132
 
1082
1133
  ## 常见问题
1083
1134
 
1084
- #### 1. TUICallKit 和自己集成的音视频库冲突了?
1135
+ #### 音视频常见问题
1136
+
1137
+ ##### 1. TUICallKit 和自己集成的音视频库冲突了?
1085
1138
 
1086
1139
  腾讯云的音视频库不能同时集成,可能存在符号冲突,可以按照下面的场景处理。
1087
1140
  1. 如果您使用了 `TXLiteAVSDK_TRTC` 库,不会发生符号冲突。可直接在 Podfile 文件中添加依赖,
@@ -1096,18 +1149,20 @@ TUI 组件支持在聊天界面对用户发起多人音视频,仅需要简单
1096
1149
  ```
1097
1150
  3. 如果您使用了 `TXLiteAVSDK_Enterprise` 库,会产生符号冲突。建议升级到 `TXLiteAVSDK_Professional` 后使用 TUICallKit_Swift/Professional。
1098
1151
 
1099
- #### 2. 通话邀请的超时时间默认是多久?
1152
+ ##### 2. 通话邀请的超时时间默认是多久?
1100
1153
 
1101
1154
  通话邀请的默认超时时间是 30 秒。
1102
1155
 
1103
- #### 3. 在邀请超时时间内,被邀请者如果离线再上线,能否立即收到邀请?
1156
+ ##### 3. 在邀请超时时间内,被邀请者如果离线再上线,能否立即收到邀请?
1104
1157
  - 如果是单聊通话邀请,被邀请者离线再上线可以收到通话邀请,TUIKit 内部会自动唤起通话邀请界面。
1105
1158
 
1106
1159
  - 如果是群聊通话邀请,被邀请者离线再上线后会自动拉取最近 30 秒内的邀请,TUIKit 会自动唤起群通话界面。
1107
1160
 
1108
- #### 4. 上架 Appstore 时打包失败,提示 Unsupported Architectures。
1161
+ #### 上架常见问题
1109
1162
 
1110
- 问题现象如下图,打包时提示 ImSDK_Plus.framework 中包含了 Appstore 不支持的 x86_64 模拟器版本。该问题是由于 IMSDK 为了方便开发者调试,发布时会默认带上模拟器版本。
1163
+ ##### 1. 上架 App Store 时打包失败,提示 Unsupported Architectures。
1164
+
1165
+ 问题现象如下图,打包时提示 ImSDK_Plus.framework 中包含了 App Store 不支持的 x86_64 模拟器版本。该问题是由于 IMSDK 为了方便开发者调试,发布时会默认带上模拟器版本。
1111
1166
 
1112
1167
  您可以按照下面的步骤,在打包时去掉模拟器版本:
1113
1168
  1. 选中您工程的 Target,并点击 Build Phases 选项,在当前面板中添加 Run Script;
@@ -1151,11 +1206,11 @@ TUI 组件支持在聊天界面对用户发起多人音视频,仅需要简单
1151
1206
  done
1152
1207
  ```
1153
1208
 
1154
- ## Xcode 集成常见问题
1209
+ ### Xcode 集成常见问题
1155
1210
 
1156
1211
  #### 1. [Xcodeproj] Unknown object version (60). (RuntimeError)
1157
1212
 
1158
- 使用 Xcode15 创建新工程来集成 TUIKit 时,输入**pod install** 后,可能会遇到此问题,原因是使用了较旧版本的 CocoaPods ,此时有两种解决办法:
1213
+ 使用 Xcode15 创建新工程来集成 TUIKit 时,输入 **pod install** 后,可能会遇到此问题,原因是使用了较旧版本的 CocoaPods ,此时有两种解决办法:
1159
1214
 
1160
1215
  解决方式一: 修改 Xcode 工程的 **Project Format **版本。
1161
1216
 
@@ -1167,15 +1222,15 @@ TUI 组件支持在聊天界面对用户发起多人音视频,仅需要简单
1167
1222
 
1168
1223
  Assertion failed: (false && "compact unwind compressed function offset doesn't fit in 24 bits"), function operator(), file Layout.cpp,
1169
1224
 
1170
- 或是使用 XCode15 集成 TUIRoom 时,因最新链接器导致 TUIRoomEngine 的符号冲突,都属于该问题。
1225
+ 或是使用 Xcode 15 集成 TUIRoom 时,因最新链接器导致 TUIRoomEngine 的符号冲突,都属于该问题。
1171
1226
 
1172
1227
  解决方式是:修改链接器配置
1173
1228
 
1174
- 在 **Build Settings** 中的**Other Linker Flags** 种添加"**-ld64**",即可解决。 参考资料: [https://developer.apple.com/forums/thread/735426](https://links.jianshu.com/go?to=https%3A%2F%2Fdeveloper.apple.com%2Fforums%2Fthread%2F735426)。
1229
+ 在 **Build Settings** 中的 **Other Linker Flags** 中添加"**-ld64**",即可解决。 参考资料: [https://developer.apple.com/forums/thread/735426](https://links.jianshu.com/go)。
1175
1230
 
1176
1231
  #### 3. Rosetta 模拟器问题
1177
1232
 
1178
- 使用苹果芯片(m1\m2等系列芯片)时会遇到, 原因是包括 SDWebImage 在内的三方库,并未支持 xcframework,不过苹果依旧给出了适配办法,就是在模拟器上开启 Rosetta 设置, 一般情况下编译时会自动弹出 Rosetta 选项。
1233
+ 使用苹果芯片(M1\M2等系列芯片)时会遇到, 原因是包括 SDWebImage 在内的三方库,并未支持 xcframework,不过苹果依旧给出了适配办法,就是在模拟器上开启 Rosetta 设置, 一般情况下编译时会自动弹出 Rosetta 选项。
1179
1234
 
1180
1235
  #### 4. Xcode 15 开发者沙盒选项问题
1181
1236
 
@@ -1183,10 +1238,12 @@ Sandbox: bash(xxx) deny(1) file-write-create
1183
1238
 
1184
1239
  当您使用 Xcode 15 创建一个新工程时, 可能会因为此选项导致编译运行失败,建议您关闭此选项。
1185
1240
 
1186
- ### 5. Xcode 16 不支持 Framework 开启 bitcode 问题
1241
+ #### 5. Xcode 16 不支持 Framework 开启 bitcode 问题
1187
1242
 
1188
1243
  **解决方案1:升级 SDK**
1189
- 如果您使用的是包含 Bitcode 的旧版本 SDK(如 TXIMSDK_iOS),建议您按照本文档的指引,将 SDK 升级至 TXIMSDK_Plus_iOS_XCFramework。
1244
+
1245
+ 如果您使用的是包含 Bitcode 的旧版本 SDK(例如 TXIMSDK_iOS),建议您按照本文档的指引,将 SDK 升级至 TXIMSDK_Plus_iOS_XCFramework。
1246
+
1190
1247
  **解决方式2: 修改 Podfile 配置**
1191
1248
 
1192
1249
  在您的 Podfile 末尾新增如下配置,重新 Pod install。
@@ -1208,18 +1265,24 @@ post_install do |installer|
1208
1265
  end
1209
1266
  ```
1210
1267
 
1211
- ## CocoaPods 集成常见问题
1268
+ ### CocoaPods 集成常见问题
1212
1269
 
1213
- #### 1. 使用远端集成时,Pod依赖版本不匹配问题
1270
+ #### 1. 使用远端集成时,Pod 依赖版本不匹配问题
1214
1271
 
1215
1272
  若您使用远端 Pods 集成时,出现 **Podfile.lock** 和 插件依赖的 TUICore 版本不一致时,
1216
1273
 
1217
1274
  此时请删除 **Podfile.lock** 文件, 并使用 **pod repo update **更新本地代码仓库, 之后使用 **pod update** 重新更新即可。
1218
1275
 
1219
- #### 2. 使用本地集成时,Pod依赖版本不匹配问题
1276
+ #### 2. 使用本地集成时,Pod 依赖版本不匹配问题
1220
1277
 
1221
- 若您使用DevelopPods集成时 出现 插件依赖的 **TUICore **版本较新,但本地 Pod 依赖的版本号是 **1.0.0** ,
1278
+ 若您使用 DevelopPods 集成时 出现 插件依赖的 **TUICore **版本较新,但本地 Pod 依赖的版本号是 **1.0.0** ,
1222
1279
 
1223
1280
  此时请您参见 [Podfile_local](https://github.com/TencentCloud/TIMSDK/blob/master/iOS/Demo/Podfile_local) 和 [TUICore.spec](https://github.com/TencentCloud/TIMSDK/blob/master/iOS/TUIKit/TUICore/TUICore.podspec) , 插件需要跟随版本,需要和 TUICore.spec 中一致,正常情况下我们会帮您修改为一致。
1224
1281
 
1225
1282
  第一次使用本地集成时,建议您下载我们的示例 Demo 工程,将 Podfile 文件内容替换为 Podfile_local 的内容,执行 **Pod update **后相互参照。
1283
+
1284
+ ### 其他常见问题
1285
+
1286
+ ##### 表情包的使用
1287
+
1288
+ 为了尊重版权,IM Demo/TUIKit 工程中默认不包含大表情元素切图。正式上线商用前请您替换为自己设计或拥有版权的其他表情包。下图所示默认的**小黄脸表情包版权归腾讯云所有**,可有偿授权使用,如需获得授权,您可以通过升级至 [IM 企业版套餐](https://buy.cloud.tencent.com/avc) 免费使用该表情包。