@tencent-rtc/mcp 1.6.7 → 1.6.8

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 (248) hide show
  1. package/knowledge/build-index.js +3 -0
  2. package/knowledge/content-loader.js +3 -1
  3. package/knowledge/search/filter-pool.js +12 -4
  4. package/knowledge/search/query-normalizer.js +76 -0
  5. package/knowledge/search/search-knowledge.js +104 -5
  6. package/package.json +1 -1
  7. package/resource/_schema/feature-aliases.yaml +1 -0
  8. package/resource/_schema/query-normalization.yaml +9 -0
  9. package/resource/index/manifest.json +1 -1
  10. package/resource/integration/callkit/preset/android/integration.md +3 -14
  11. package/resource/integration/callkit/preset/flutter/integration.md +1 -12
  12. package/resource/integration/callkit/preset/ios/integration.md +2 -12
  13. package/resource/integration/callkit/preset/react/integration.md +1 -14
  14. package/resource/integration/callkit/preset/vue/integration.md +1 -14
  15. package/resource/integration/chat/preset/android/integration.md +6 -13
  16. package/resource/integration/chat/preset/flutter/integration.md +1 -8
  17. package/resource/integration/chat/preset/ios/integration.md +4 -12
  18. package/resource/integration/chat/preset/react/integration.md +6 -16
  19. package/resource/integration/chat/preset/vue/integration.md +0 -9
  20. package/resource/integration/livekit/preset/live/android/live-audience-integration.md +2 -6
  21. package/resource/integration/livekit/preset/live/android/live-host-integration.md +1 -11
  22. package/resource/integration/livekit/preset/live/android/live-list-integration.md +2 -6
  23. package/resource/integration/livekit/preset/live/android/prepare-integration.md +2 -7
  24. package/resource/integration/livekit/preset/live/ios/live-audience-integration.md +2 -7
  25. package/resource/integration/livekit/preset/live/ios/live-host-integration.md +1 -13
  26. package/resource/integration/livekit/preset/live/ios/live-list-integration.md +2 -10
  27. package/resource/integration/livekit/preset/live/ios/prepare-integration.md +3 -8
  28. package/resource/integration/livekit/preset/live/vue/live-list-integration.md +0 -4
  29. package/resource/integration/livekit/preset/live/vue/live-player-desk-integration.md +1 -5
  30. package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +2 -7
  31. package/resource/integration/livekit/preset/live/vue/live-pusher-integration.md +2 -8
  32. package/resource/integration/roomkit/preset/vue/integration.md +0 -11
  33. package/resource/knowledge/callkit/core-sdk/android/answer-call.md +0 -7
  34. package/resource/knowledge/callkit/core-sdk/android/make-call.md +0 -8
  35. package/resource/knowledge/callkit/core-sdk/android/offline-push.md +1 -9
  36. package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +2 -8
  37. package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +2 -8
  38. package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +1 -16
  39. package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +0 -8
  40. package/resource/knowledge/callkit/core-sdk/ios/make-call.md +0 -8
  41. package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +0 -11
  42. package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +178 -200
  43. package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +195 -217
  44. package/resource/knowledge/callkit/faq/android.md +4 -14
  45. package/resource/knowledge/callkit/faq/common.md +0 -2
  46. package/resource/knowledge/callkit/faq/error-code.md +2 -4
  47. package/resource/knowledge/callkit/faq/ios.md +1 -4
  48. package/resource/knowledge/callkit/preset/android/api.md +0 -6
  49. package/resource/knowledge/callkit/preset/ios/api.md +0 -4
  50. package/resource/knowledge/callkit/preset/react/api.md +3 -4
  51. package/resource/knowledge/callkit/preset/react/uikit-api-reference.md +3 -4
  52. package/resource/knowledge/callkit/preset/vue/api.md +3 -4
  53. package/resource/knowledge/callkit/preset/vue/uikit-api-reference.md +3 -4
  54. package/resource/knowledge/chat/preset/android/features/chat-setting.md +0 -5
  55. package/resource/knowledge/chat/preset/android/features/contact-list.md +0 -7
  56. package/resource/knowledge/chat/preset/android/features/conversation-list.md +0 -6
  57. package/resource/knowledge/chat/preset/android/features/language.md +0 -8
  58. package/resource/knowledge/chat/preset/android/features/message-input.md +0 -6
  59. package/resource/knowledge/chat/preset/android/features/message-list.md +0 -8
  60. package/resource/knowledge/chat/preset/android/features/search.md +0 -7
  61. package/resource/knowledge/chat/preset/android/features/theme.md +0 -4
  62. package/resource/knowledge/chat/preset/android-view/integration.md +0 -6
  63. package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +0 -4
  64. package/resource/knowledge/chat/preset/flutter/features/contact-list.md +0 -9
  65. package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +0 -7
  66. package/resource/knowledge/chat/preset/flutter/features/language.md +0 -5
  67. package/resource/knowledge/chat/preset/flutter/features/message-input.md +0 -6
  68. package/resource/knowledge/chat/preset/flutter/features/message-list.md +0 -8
  69. package/resource/knowledge/chat/preset/flutter/features/search.md +0 -5
  70. package/resource/knowledge/chat/preset/flutter/features/theme.md +0 -4
  71. package/resource/knowledge/chat/preset/ios/features/chat-setting.md +0 -5
  72. package/resource/knowledge/chat/preset/ios/features/contact-list.md +0 -5
  73. package/resource/knowledge/chat/preset/ios/features/conversation-list.md +0 -7
  74. package/resource/knowledge/chat/preset/ios/features/language.md +1 -8
  75. package/resource/knowledge/chat/preset/ios/features/message-input.md +0 -6
  76. package/resource/knowledge/chat/preset/ios/features/message-list.md +0 -8
  77. package/resource/knowledge/chat/preset/ios/features/search.md +0 -5
  78. package/resource/knowledge/chat/preset/ios/features/theme.md +0 -4
  79. package/resource/knowledge/chat/preset/ios-uikit/integration.md +0 -6
  80. package/resource/knowledge/chat/preset/react/features/contact-list.md +0 -23
  81. package/resource/knowledge/chat/preset/react/features/conversation-actions.md +2 -11
  82. package/resource/knowledge/chat/preset/react/features/conversation-list.md +4 -26
  83. package/resource/knowledge/chat/preset/react/features/conversation-preview.md +0 -6
  84. package/resource/knowledge/chat/preset/react/features/search.md +0 -1
  85. package/resource/knowledge/chat/preset/react/features/theme.md +0 -1
  86. package/resource/knowledge/chat/preset/vue/features/contact-list.md +3 -9
  87. package/resource/knowledge/chat/preset/vue/features/conversation-actions.md +0 -3
  88. package/resource/knowledge/chat/preset/vue/features/conversation-list.md +2 -13
  89. package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +2 -3
  90. package/resource/knowledge/chat/preset/vue/features/conversation-search.md +1 -0
  91. package/resource/knowledge/chat/preset/vue/features/search.md +4 -3
  92. package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +0 -7
  93. package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +0 -3
  94. package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +0 -3
  95. package/resource/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +0 -1
  96. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +0 -5
  97. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +0 -3
  98. package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +0 -2
  99. package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +0 -2
  100. package/resource/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +0 -2
  101. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +0 -2
  102. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +0 -1
  103. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +0 -2
  104. package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +0 -2
  105. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +0 -7
  106. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +0 -3
  107. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +0 -1
  108. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +0 -3
  109. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +0 -5
  110. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +0 -3
  111. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +0 -2
  112. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +0 -2
  113. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +0 -2
  114. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +0 -2
  115. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +0 -1
  116. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +0 -2
  117. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +1 -3
  118. package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +0 -7
  119. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +0 -3
  120. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +0 -1
  121. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +0 -3
  122. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +0 -5
  123. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +0 -3
  124. package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +0 -2
  125. package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +0 -2
  126. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +0 -2
  127. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +0 -2
  128. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +0 -1
  129. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +0 -2
  130. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +0 -2
  131. package/resource/knowledge/livekit/core-sdk/features/android/audience-list.md +2 -2
  132. package/resource/knowledge/livekit/core-sdk/features/android/audio-effect.md +2 -3
  133. package/resource/knowledge/livekit/core-sdk/features/android/barrage.md +2 -2
  134. package/resource/knowledge/livekit/core-sdk/features/android/base-beauty.md +2 -2
  135. package/resource/knowledge/livekit/core-sdk/features/android/gift.md +2 -7
  136. package/resource/knowledge/livekit/core-sdk/features/android/live-list.md +3 -4
  137. package/resource/knowledge/livekit/core-sdk/features/flutter/audience-list.md +2 -2
  138. package/resource/knowledge/livekit/core-sdk/features/flutter/audio-effect.md +2 -4
  139. package/resource/knowledge/livekit/core-sdk/features/flutter/barrage.md +2 -2
  140. package/resource/knowledge/livekit/core-sdk/features/flutter/base-beauty.md +0 -2
  141. package/resource/knowledge/livekit/core-sdk/features/flutter/gift.md +2 -7
  142. package/resource/knowledge/livekit/core-sdk/features/flutter/live-list.md +3 -2
  143. package/resource/knowledge/livekit/core-sdk/features/ios/audience-list.md +2 -2
  144. package/resource/knowledge/livekit/core-sdk/features/ios/audio-effect.md +2 -4
  145. package/resource/knowledge/livekit/core-sdk/features/ios/barrage.md +2 -2
  146. package/resource/knowledge/livekit/core-sdk/features/ios/base-beauty.md +2 -2
  147. package/resource/knowledge/livekit/core-sdk/features/ios/gift.md +2 -7
  148. package/resource/knowledge/livekit/core-sdk/features/ios/live-list.md +3 -4
  149. package/resource/knowledge/livekit/core-sdk/live/android/co-guest-interaction.md +0 -3
  150. package/resource/knowledge/livekit/core-sdk/live/android/host-interaction.md +0 -4
  151. package/resource/knowledge/livekit/core-sdk/live/android/integration.md +1 -4
  152. package/resource/knowledge/livekit/core-sdk/live/flutter/co-guest-interaction.md +1 -3
  153. package/resource/knowledge/livekit/core-sdk/live/flutter/host-interaction.md +0 -1
  154. package/resource/knowledge/livekit/core-sdk/live/flutter/integration.md +1 -4
  155. package/resource/knowledge/livekit/core-sdk/live/ios/co-guest-interaction.md +0 -3
  156. package/resource/knowledge/livekit/core-sdk/live/ios/host-interaction.md +0 -3
  157. package/resource/knowledge/livekit/core-sdk/live/ios/integration.md +1 -4
  158. package/resource/knowledge/livekit/core-sdk/voice/android/co-guest-interaction.md +0 -2
  159. package/resource/knowledge/livekit/core-sdk/voice/android/host-interaction.md +0 -5
  160. package/resource/knowledge/livekit/core-sdk/voice/android/integration.md +1 -4
  161. package/resource/knowledge/livekit/core-sdk/voice/flutter/co-guest-interaction.md +1 -4
  162. package/resource/knowledge/livekit/core-sdk/voice/flutter/integration.md +3 -6
  163. package/resource/knowledge/livekit/core-sdk/voice/ios/co-guest-interaction.md +0 -2
  164. package/resource/knowledge/livekit/core-sdk/voice/ios/host-interaction.md +0 -4
  165. package/resource/knowledge/livekit/core-sdk/voice/ios/integration.md +1 -4
  166. package/resource/knowledge/livekit/faq/error-code.md +0 -1
  167. package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +2 -3
  168. package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +3 -3
  169. package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +3 -3
  170. package/resource/knowledge/push/api-reference/android.md +0 -1
  171. package/resource/knowledge/push/api-reference/harmonyos.md +0 -2
  172. package/resource/knowledge/push/api-reference/react-native.md +3 -5
  173. package/resource/knowledge/push/api-reference/uni-app.md +3 -5
  174. package/resource/knowledge/push/api-reference/unity.md +0 -1
  175. package/resource/knowledge/push/api-reference/unreal-engine.md +0 -1
  176. package/resource/knowledge/push/config/android.md +0 -24
  177. package/resource/knowledge/push/config/harmonyos.md +0 -1
  178. package/resource/knowledge/push/config/ios.md +0 -3
  179. package/resource/knowledge/push/config/react-native.md +0 -29
  180. package/resource/knowledge/push/config/unity.md +1 -24
  181. package/resource/knowledge/push/config/unreal-engine.md +1 -24
  182. package/resource/knowledge/push/integration/android.md +0 -14
  183. package/resource/knowledge/push/integration/flutter.md +0 -19
  184. package/resource/knowledge/push/integration/harmonyos.md +0 -2
  185. package/resource/knowledge/push/integration/ios.md +0 -3
  186. package/resource/knowledge/push/integration/react-native.md +0 -24
  187. package/resource/knowledge/push/integration/uni-app.md +1 -11
  188. package/resource/knowledge/push/integration/unity.md +0 -9
  189. package/resource/knowledge/push/integration/unreal-engine.md +1 -17
  190. package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md +0 -4
  191. package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md +0 -4
  192. package/resource/knowledge/roomkit/core-sdk/android/room-state.md +0 -4
  193. package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md +1 -5
  194. package/resource/knowledge/roomkit/core-sdk/ios/call-user-to-room.md +0 -4
  195. package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md +0 -4
  196. package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +0 -4
  197. package/resource/knowledge/roomkit/core-sdk/ios/schedule-room.md +1 -5
  198. package/resource/knowledge/roomkit/core-sdk/vue/call-user-to-room.md +1 -1
  199. package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +0 -6
  200. package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +0 -9
  201. package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +0 -11
  202. package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +1 -5
  203. package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +1 -8
  204. package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +0 -3
  205. package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +0 -3
  206. package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +0 -5
  207. package/resource/knowledge/roomkit/preset/android/integration.md +0 -4
  208. package/resource/knowledge/roomkit/preset/flutter/integration.md +1 -13
  209. package/resource/knowledge/roomkit/preset/ios/integration.md +0 -6
  210. package/resource/knowledge/roomkit/preset/react/integration.md +0 -16
  211. package/resource/knowledge/rtcengine/web/api.md +1 -8
  212. package/resource/knowledge/rtcengine/web/faq.md +3 -5
  213. package/resource/knowledge/rtcengine/web/how_to_integrated_web_sdk.md +0 -6
  214. package/resource/knowledge/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +1 -1
  215. package/resource/knowledge/rtcengine/web/plugin/21-advanced-auto-play-policy.md +1 -1
  216. package/resource/knowledge/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +1 -1
  217. package/resource/knowledge/rtcengine/web/plugin/27-advanced-small-stream.md +1 -1
  218. package/resource/knowledge/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -3
  219. package/resource/knowledge/rtcengine/web/plugin/34-advanced-proxy.md +2 -4
  220. package/resource/knowledge/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -4
  221. package/resource/knowledge/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -2
  222. package/resource/knowledge/trtc/android/TRTCCloud.md +8 -56
  223. package/resource/knowledge/trtc/android/TRTCCloudDef.md +6 -7
  224. package/resource/knowledge/trtc/android/TRTCCloudListener.md +1 -18
  225. package/resource/knowledge/trtc/android/TXAudioEffectManager.md +0 -14
  226. package/resource/knowledge/trtc/android/TXDeviceManager.md +0 -1
  227. package/resource/knowledge/trtc/android/TXLiteAVCode.md +1 -1
  228. package/resource/knowledge/trtc/c++/ITRTCCloud.md +7 -59
  229. package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +0 -14
  230. package/resource/knowledge/trtc/c++/ITXDeviceManager.md +0 -4
  231. package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +1 -19
  232. package/resource/knowledge/trtc/c++/TRTCTypeDef.md +6 -7
  233. package/resource/knowledge/trtc/c++/TXLiteAVCode.md +1 -1
  234. package/resource/knowledge/trtc/ios/TRTCCloud.md +9 -60
  235. package/resource/knowledge/trtc/ios/TRTCCloudDef.md +6 -7
  236. package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +1 -19
  237. package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +0 -13
  238. package/resource/knowledge/trtc/ios/TXDeviceManager.md +0 -4
  239. package/resource/knowledge/trtc/ios/TXLiteAVCode.md +1 -1
  240. package/server.js +1 -1
  241. package/tools/common/search_trtc_knowledge.js +2 -0
  242. package/tools/definitions/search_trtc_knowledge_def.js +1 -0
  243. package/utils/report-cls-client.js +3 -3
  244. package/utils/report-es-client.js +1 -1
  245. package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +0 -230
  246. package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +0 -797
  247. package/resource/knowledge/roomkit/core-sdk/flutter/room-state.md +0 -325
  248. package/resource/knowledge/roomkit/core-sdk/flutter/schedule-room.md +0 -325
@@ -3,9 +3,6 @@
3
3
  ### Step 1: TIMPush Integration
4
4
 
5
5
  Download [TIMPush](https://github.com/TencentCloud/TIMSDK/tree/master/UE5/Push/pushdemo/Plugins/TIMPush) and copy to the `Plugins` directory under the project. In the Build.cs file of the main module, introduce TIMPush.
6
- | copy directory | Introduce plug-in |
7
- | --- | --- |
8
- | | |
9
6
 
10
7
  ### Step 2: Push Parameter Configuration
11
8
 
@@ -13,8 +10,6 @@ Download [TIMPush](https://github.com/TencentCloud/TIMSDK/tree/master/UE5/Push/p
13
10
 
14
11
  Upload the obtained iOS APNs Push Certificate to the IM console during the manufacturer configuration process.
15
12
 
16
- The IM console will allocate a certificate ID for you, as shown below:
17
-
18
13
  Set businessID:
19
14
 
20
15
  Open "Project Settings" in UE4 Editor, search for `Additional Plist Data`, modify the following text and copy it into the textbox. `YourBusinessID` is required, while `YourGroupID` needs to be modified when you need to count push reach and click data.
@@ -39,9 +34,6 @@ bEnableRemoteNotificationsSupport=True
39
34
  【Android】
40
35
 
41
36
  After completing the console manufacturer push information, download and add the configuration file to the project. Place the downloaded `timpush-configs.json` file under the `Source/ThirdParty/TIMPushLibrary/Android/TIMPush/Assets` directory.
42
- | download configuration file | copy path |
43
- | --- | --- |
44
- | | |
45
37
 
46
38
  ### Step 3: Client Vendor Configuration
47
39
 
@@ -99,7 +91,6 @@ According to the vivo and Honor vendor access guide, you need to add APPID and A
99
91
  Integrate the corresponding plugin and json configuration file using the vendor method.
100
92
 
101
93
  > **Note:**
102
- >
103
94
  > Note: The following Honor adaptation requires configuration for version 7.7.5283 and above.
104
95
  >
105
96
 
@@ -163,7 +154,6 @@ Integrate the corresponding plugin and json configuration file using the vendor
163
154
  If you need custom parsing for received remote push, you can implement it by the following method.
164
155
 
165
156
  > **Note:**
166
- >
167
157
  > 1. Register callback timing is recommended to be placed in the program entry function.
168
158
  > 2. Configure the console and click subsequent actions with the following configuration. Select **open specified in-app page**. Do not modify and use default values.
169
159
  >
@@ -290,7 +280,6 @@ Indonesia: https://apiidn.im.qcloud.com/v3/offline_push_report/huawei
290
280
  China: https://api.im.qcloud.com/v3/offline_push_report/huawei
291
281
 
292
282
  > **Note:**
293
- >
294
283
  > Note: Huawei Push certificate ID <= 11344 uses Huawei Push v2 API. Reach and Receipt Click are unsupported. Please regenerate and update the certificate ID.
295
284
  >
296
285
 
@@ -316,9 +305,6 @@ China: https://api.im.qcloud.com/v3/offline_push_report/honor
316
305
  | Receipt Address:<br>Singapore :https://apisgp.im.qcloud.com/v3/offline_push_report/vivo<br>Korea:<br>https://apikr.im.qcloud.com/v3/offline_push_report/vivo<br>USA: https://apiusa.im.qcloud.com/v3/offline_push_report/vivo<br>Germany: https://apiger.im.qcloud.com/v3/offline_push_report/vivo<br>Indonesia: https://apiidn.im.qcloud.com/v3/offline_push_report/vivo<br>China:<br>https://api.im.qcloud.com/v3/offline_push_report/vivo | |
317
306
 
318
307
  【Meizu】
319
- | Enable Receipt Switch | Configure Receipt Address |
320
- | --- | --- |
321
- | | |
322
308
 
323
309
  Receipt Address:
324
310
 
@@ -335,14 +321,13 @@ Indonesia: https://apiidn.im.qcloud.com/v3/offline_push_report/meizu
335
321
  China: https://api.im.qcloud.com/v3/offline_push_report/meizu
336
322
 
337
323
  > **Note:**
338
- >
339
324
  > Note: After enabling the receipt switch, please ensure the receipt address is configured correctly. Without configuring or with an incorrect address, it will impact the push notification feature.
340
325
  >
341
326
 
342
327
  【iOS】
343
328
  1. If you need to track push notification reach and click data, you need to change "YourGroupID" to your own App Group ID in the "project setting" (see manufacturer configuration - generate App GroupID).
344
329
 
345
- 2. After configuring the App Group ID, you need to use Xcode to open the xcworkspace file generated by UE in the project directory, and refer to the method in Manufacturer Configuration - Generate App Group ID - Step 4 to configure your App Group ID. Then, enable the Notification Service Extension Target in `Editor - Add Target` in the Xcode project.
330
+ 2. After configuring the App Group ID, you need to use Xcode to open the xcworkspace file generated by UE in the project directory, and . Then, enable the Notification Service Extension Target in `Editor - Add Target` in the Xcode project.
346
331
 
347
332
  3. You also need to unzip the two framework compressed packages in the `Plugins-TIMPush-Source-ThirdParty-TIMPushLibrary-iOS` path of the project root directory, and add the internal .framework folder to your pushservice target in the Xcode project.
348
333
 
@@ -379,7 +364,6 @@ Other manufacturers support it with no need to configure. FCM does not currently
379
364
  Congratulations on completing the access of the push plugin. Remind you: the push plugin **will automatically stop providing push service (including regular message offline push, all users/tag push, etc.) after trial or purchase expiry**. To avoid affecting normal business operation, please advise in advance to [purchase](https://buy.cloud.tencent.com/avc)/[renew](https://console.cloud.tencent.com/account/renewal).
380
365
 
381
366
  > **Note:**
382
- >
383
367
  > 1. Manufacturer offline channels have a [message categorization mechanism](https://cloud.tencent.com/document/product/269/100649), and different types will also have different push strategies.
384
368
  > - If the push demand belongs to IM type push and requires timely delivery, set your own app to the corresponding push type according to the vendor's rules. It will be categorized as a high-priority system message type or important message type.
385
369
  > - Conversely, offline push has quantity and frequency limits and may not reach devices in time.
@@ -235,7 +235,3 @@ fun rejectCall(roomID: String, reason: CallRejectionReason = CallRejectionReason
235
235
  |Store/Component|Description|API Documentation|
236
236
  |---------|---------|---------|
237
237
  |**RoomStore**|Manages the full room lifecycle: create and join, join, leave, end room, update/retrieve room information, schedule rooms, invite external members, listen for passive room events (such as room dissolution, room info updates, etc).|[API Documentation](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.room/-room-store/index.html)|
238
-
239
- ## Contact Us
240
-
241
- If you have any questions or suggestions during integration or usage, contact info_rtc@tencent.com.
@@ -582,7 +582,3 @@ private fun subscribeParticipantState() {
582
582
  |Store/Component|Description|API Documentation|
583
583
  |---------|---------|---------|
584
584
  |**RoomParticipantStore**|Manages room participants: assign admin, transfer ownership, retrieve participant list, remove participant, control participant devices (close, invite to enable camera/microphone, etc.), request device enablement.|[API Documentation](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.room/-room-participant-store/index.html)|
585
-
586
- ## Contact Us
587
-
588
- If you have any questions or suggestions during integration or use, please contact info_rtc@tencent.com.
@@ -358,7 +358,3 @@ private fun subscribeCurrentRoomState() {
358
358
  **What does this mean for developers?**
359
359
 
360
360
  `participantCount` is a highly accurate, near real-time estimate. In rare cases with extremely high concurrency, brief delays or data loss may occur. We recommend using it for UI display only—not for billing, statistics, or scenarios requiring absolute precision.
361
-
362
- ## Contact Us
363
-
364
- If you have questions or feedback during integration or usage, please email info_rtc@tencent.com.
@@ -94,7 +94,7 @@ Follow the Integration Overview to integrate the AtomicXCore SDK. Make sure you
94
94
  | <code>scheduleStartTime</code> | <code>Long</code> | Yes | - Scheduled start time (Unix timestamp in seconds).<br>- Must be greater than the current time.<br>- We recommend aligning to a future minute. Example: 1736164800 (2025-01-06 20:00:00). |
95
95
  | <code>scheduleEndTime</code> | <code>Long</code> | Yes | Scheduled end time (Unix timestamp in seconds).<br>- Must be greater than <code>scheduleStartTime</code>.<br>- Set based on expected duration, e.g., <code>scheduleStartTime</code> + 3600 for one hour. |
96
96
  | <code>reminderSecondsBeforeStart</code> | <code>Int</code> | No | - Reminder time before the scheduled start (seconds). Used for system-triggered notifications.<br>- Recommended: 300 (5 min) or 900 (15 min) for local app notifications. |
97
- | <code>scheduleAttendees</code> | <code>List</code> | No | - List of participant user IDs. The system will send invitations to these users.<br>- For details, see retrieving the participant list for scheduled rooms. |
97
+ | <code>scheduleAttendees</code> | <code>List</code> | No | - List of participant user IDs. The system will send invitations to these users.<br>- . |
98
98
  | <code>isAllMicrophoneDisabled</code> | <code>Boolean</code> | No | Whether to mute all participants by default.<br>- true: Disabled.<br>- false: Not disabled (default). |
99
99
  | <code>isAllCameraDisabled</code> | <code>Boolean</code> | No | Whether to disable all participant cameras by default.<br>- true: Disabled.<br>- false: Not disabled (default). |
100
100
  | <code>isAllScreenShareDisabled</code> | <code>Boolean</code> | No | Whether to disable screen sharing for all participants.<br>- true: Disabled.<br>- false: Not disabled (default). |
@@ -334,7 +334,3 @@ If you are not receiving the upcoming event notification after scheduling a room
334
334
  - **Edge Case:** If the room is scheduled to start very soon (e.g., in 5 minutes) but the reminder is set for 10 minutes before start, the system cannot send the notification, and the event will be missed.
335
335
 
336
336
  - **Solution:** Ensure the scheduled start time is sufficiently further in the future than the reminder interval you've set.
337
-
338
- ## Contact Us
339
-
340
- For questions or feedback during integration or usage, contact info_rtc@tencent.com.
@@ -227,7 +227,3 @@ func rejectCall(roomID: String, reason: CallRejectionReason = .rejected) {
227
227
  |**Store/Component**|**Description**|**API Documentation**|
228
228
  |---------|---------|---------|
229
229
  |**RoomStore**|Room lifecycle management: create and join, join, leave, end room, update and retrieve room info, reserve room, call users outside the room, listen to passive room events (such as room dissolution, updates, etc.).|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomstore)|
230
-
231
- ## Contact Us
232
-
233
- If you have any questions or suggestions during integration or usage, contact info_rtc@tencent.com.
@@ -563,7 +563,3 @@ private func subscribeParticipantState() {
563
563
  |**Store/Component**|**Description**|**API Documentation**|
564
564
  |---------|---------|---------|
565
565
  |**RoomParticipantStore**|Manage participants in the room: assign admin roles, transfer ownership, retrieve participant list, remove participants, control participant devices (e.g., close, invite to enable camera/microphone), request device enable (e.g., request to enable camera/microphone).|[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomparticipantstore)|
566
-
567
- ## Contact Us
568
-
569
- If you have any questions or suggestions during integration or use, please contact info_rtc@tencent.com.
@@ -319,7 +319,3 @@ private func subscribeRoomState() {
319
319
  **What does this mean for developers?**
320
320
 
321
321
  `participantCount` provides a highly accurate, near real-time estimate. However, during periods of extremely high concurrency, updates may be briefly delayed or lost. We recommend using it for **UI display** purposes only, not for billing, analytics, or other scenarios requiring absolute precision.
322
-
323
- ## Contact Us
324
-
325
- If you have questions or feedback during integration or usage, please email info_rtc@tencent.com.
@@ -89,7 +89,7 @@ func scheduleRoom() {
89
89
  | <code>scheduleStartTime</code> | <code>Int</code> | Yes | - Scheduled start time (Unix timestamp in seconds).<br>- Must be greater than the current time.<br>- We recommend aligning to a future minute. Example: 1736164800 (2025-01-06 20:00:00). |
90
90
  | <code>scheduleEndTime</code> | <code>Int</code> | Yes | - Scheduled end time (Unix timestamp in seconds).<br>- Must be greater than <code>scheduleStartTime</code>.<br>- Set based on expected duration, e.g., <code>scheduleStartTime</code> + 3600 for one hour. |
91
91
  | <code>reminderSecondsBeforeStart</code> | <code>Int</code> | No | - Reminder time before the scheduled start (seconds). Used for system-triggered notifications.<br>- Recommended: 300 (5 min) or 900 (15 min) for local app notifications. |
92
- | <code>scheduleAttendees</code> | <code>[String]</code> | No | - List of participant user IDs. The system will send invitations to these users.<br>- For details, see retrieving the participant list for scheduled rooms. |
92
+ | <code>scheduleAttendees</code> | <code>[String]</code> | No | - List of participant user IDs. The system will send invitations to these users.<br>- . |
93
93
  | <code>isAllMicrophoneDisabled</code> | <code>Bool</code> | No | Whether to mute all participants by default.<br>- true: Disabled.<br>- false: Not disabled (default). |
94
94
  | <code>isAllCameraDisabled</code> | <code>Bool</code> | No | Whether to disable all participant cameras by default.<br>- true: Disabled.<br>- false: Not disabled (default). |
95
95
  | <code>isAllScreenShareDisabled</code> | <code>Bool</code> | No | Whether to disable screen sharing for all participants.<br>- true: Disabled.<br>- false: Not disabled (default). |
@@ -316,7 +316,3 @@ If you are not receiving a "room starting soon" notification after scheduling, c
316
316
  - If the room's start time is too close (e.g., 5 minutes away) and the reminder is set too far in advance (e.g., 10 minutes before), the event will not trigger.
317
317
 
318
318
  - Make sure the scheduled start time is at least as far in the future as the reminder value you set.
319
-
320
- ## Contact Us
321
-
322
- For questions or feedback during integration or usage, contact info_rtc@tencent.com.
@@ -138,7 +138,7 @@ onUnmounted(() => {
138
138
 
139
139
  ## Practical Tutorial: Improving the Call Answer Rate
140
140
 
141
- To achieve a higher call answer rate in your business, beyond implementing the basic functionality, it is recommended to refer to the following strategies to optimize the user experience:
141
+ To achieve a higher call answer rate in your business, beyond implementing the basic functionality, it is recommended to
142
142
 
143
143
  ### 1. Enhance Call Awareness (Avoid Users Missing Calls)
144
144
 
@@ -74,9 +74,6 @@ watch(currentCamera, (camera) => {
74
74
  });
75
75
  ```
76
76
 
77
- > **Note:**
78
- >
79
-
80
77
  > When you call [setCurrentCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#setCurrentCamera) to switch the device, if the camera is already on, Atomicx will automatically stop capturing from the current device and restart capturing with the new device, so the video stream switches seamlessly. If switching fails, the original device will continue to be used.
81
78
  >
82
79
 
@@ -331,9 +328,6 @@ watch(outputVolume, (volume) => {
331
328
 
332
329
  Using the [networkInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#networkInfo) data from [useDeviceState](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#module-DeviceState), you can monitor the local user's network quality in real time.
333
330
 
334
- > **Note:**
335
- >
336
-
337
331
  > Valid data can only be obtained from [networkInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#networkInfo) when the local user has joined a room via [joinRoom](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#joinRoom) and turned on the microphone or camera.
338
332
  >
339
333
 
@@ -37,9 +37,6 @@ It is generally recommended to place `FreeBeautyPanel` inside a Dialog or Modal,
37
37
 
38
38
  **The following example shows how to implement a complete interaction where clicking a button opens the beauty settings:**
39
39
 
40
- > **Note:**
41
- >
42
-
43
40
  > All TUIKit components must be wrapped inside UIKitProvider; otherwise, they will not be able to obtain their context dependencies, resulting in abnormal styling.
44
41
  >
45
42
 
@@ -117,9 +114,6 @@ This section mainly describes how to implement basic beauty via the atomicx-core
117
114
 
118
115
  When the user adjusts the beauty parameters (for example, by dragging a slider), use [setFreeBeauty](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#setFreeBeauty) for real-time preview. At this point, the effect is only visible locally and will not be transmitted to remote users.
119
116
 
120
- > **Note:**
121
- >
122
-
123
117
  > The value range of the parameters is 0-100.
124
118
  >
125
119
 
@@ -143,9 +137,6 @@ const updatePreview = async (beauty: number, white: number, ruddy: number) => {
143
137
 
144
138
  After the user confirms that they are satisfied with the preview, call [saveBeautySetting](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#saveBeautySetting) to apply the current configuration to the video stream. At this point, remote users can see the beauty effect.
145
139
 
146
- > **Note:**
147
- >
148
-
149
140
  > The beauty feature depends on a camera device. You can use [useDeviceState](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#module-DeviceState) to check the device status.
150
141
  >
151
142
  > - [cameraList](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#cameraList): The list of currently available camera devices. If the list is empty, it means no camera was detected or camera permission is denied.
@@ -35,7 +35,6 @@ This feature offers two integration approaches, and you can choose the one that
35
35
  After the user successfully joins the room, you need to call the [setActiveConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#setActiveConversation) API to initialize the chat data. We recommend listening for changes to [currentRoom](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#currentRoom) to handle this automatically.
36
36
 
37
37
  > **Note:**
38
- >
39
38
  > - `GROUP` is a fixed prefix. The `setActiveConversation` argument must be ``GROUP${roomId}``; otherwise, messages cannot be sent or received properly.
40
39
  > - `GROUP` is the fixed prefix for IM SDK group conversations (see [IM conversation types](https://web.sdk.qcloud.com/im/doc/zh-cn/Conversation.html)). Room chat is built on IM groups, so the conversation ID must be in the ``GROUP${roomId}`` format.
41
40
 
@@ -60,9 +59,6 @@ watch(() => currentRoom.value?.roomId, (roomId) => {
60
59
 
61
60
  In your page, you can directly combine these two components. At the same time, use [useRoomParticipantState](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#module-RoomParticipantState) to obtain the current user's mute status and control the availability of the input box.
62
61
 
63
- > **Caution:**
64
- >
65
-
66
62
  > All TUIKit components must be wrapped inside UIKitProvider; otherwise, they cannot obtain their context dependencies, resulting in abnormal styles.
67
63
  >
68
64
 
@@ -144,9 +140,6 @@ const openChatWindow = () => {
144
140
 
145
141
  This section mainly explains how to implement a custom chat interface using the atomicx-core SDK APIs [useMessageListState](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#module-MessageListState) and [useMessageInputState](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#module-MessageInputState).
146
142
 
147
- > **Caution:**
148
- >
149
-
150
143
  > `MessageInputState` supports integration with the `@tiptap/vue-3` editor by default. If you only need a simple text input (such as `<input>` or `<textarea>`), please **ignore** the editor-instance-bound APIs such as `setEditorInstance` and `setContent`, and simply use `updateRawValue` and `sendMessage`.
151
144
  >
152
145
 
@@ -155,7 +148,6 @@ This section mainly explains how to implement a custom chat interface using the
155
148
  After the user successfully joins the room, you need to call the [setActiveConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#setActiveConversation) API to initialize the chat data. We recommend listening for changes to [currentRoom](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#currentRoom) to handle this automatically.
156
149
 
157
150
  > **Note:**
158
- >
159
151
  > - `GROUP` is a fixed prefix. The `setActiveConversation` argument must be ``GROUP${roomId}``; otherwise, messages cannot be sent or received properly.
160
152
  > - When switching rooms or leaving a room, we recommend resetting or clearing the active conversation to avoid sending messages to the wrong conversation.
161
153
 
@@ -241,9 +233,6 @@ const handleSend = async () => {
241
233
 
242
234
  Use the [loadMoreOlderMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#module-MessageListState) method to fetch historical messages page by page. This is usually triggered when scrolling to the top of the list.
243
235
 
244
- > **Caution:**
245
- >
246
-
247
236
  > After loading historical messages, you usually need to manually adjust the scrollbar position to keep the current viewport from jumping.
248
237
  >
249
238
 
@@ -81,7 +81,6 @@ const { participantList } = useRoomParticipantState();
81
81
  ```
82
82
 
83
83
  > **Note:**
84
- >
85
84
  > - `RoomParticipantList` automatically fills the height and width of its parent container, so make sure its parent container has explicit dimensions.
86
85
  > - When using the `RoomParticipantList` component, make sure to configure the global `UIKitProvider` in `App.vue`. For details, refer to [Configuring App.vue](https://cloud.tencent.com/document/product/647/81962#ce98ee15-b0cb-43af-81da-70f51231430e).
87
86
 
@@ -111,9 +110,6 @@ const handleLoadMore = async () => {
111
110
  };
112
111
  ```
113
112
 
114
- > **Note:**
115
- >
116
-
117
113
  > The data successfully fetched by the `getParticipantList` interface is automatically maintained in `participantList`. The UI only needs to render the data in `participantList`.
118
114
  >
119
115
 
@@ -355,7 +351,7 @@ await kickParticipant({ userId });
355
351
 
356
352
  ### Step 9: Invite others to join the room
357
353
 
358
- In actual business scenarios, you may need to send a call invitation to users who have not yet entered the room. Atomicx provides full support for a calling system. For details, refer to In-Meeting Calling.
354
+ In actual business scenarios, you may need to send a call invitation to users who have not yet entered the room. Atomicx provides full support for a calling system. .
359
355
 
360
356
  ## API Documentation
361
357
 
@@ -32,9 +32,6 @@ const {
32
32
 
33
33
  Create a room (room owner): Use [createAndJoinRoom](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#createAndJoinRoom). After a successful call, the user automatically gains room owner permissions.
34
34
 
35
- > **Note:**
36
- >
37
-
38
35
  > It is recommended that the roomId specified when creating a room be generated and delivered by the business backend, to ensure the uniqueness and stability of the room ID across the entire application globally.
39
36
  >
40
37
 
@@ -148,9 +145,6 @@ await updateRoomInfo({
148
145
  })
149
146
  ```
150
147
 
151
- > **Note:**
152
- >
153
-
154
148
  > The room owner must be inside the room to call [updateRoomInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#updateRoomInfo). If the room owner has already left the room, they need to rejoin before they can update the room information.
155
149
  >
156
150
 
@@ -175,7 +169,6 @@ await endRoom();
175
169
  ```
176
170
 
177
171
  > **Note:**
178
- >
179
172
  > - If the room owner leaves the room but does not call [endRoom](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#endRoom), the room will continue to exist until the automatic reclamation condition is met (no users for 6 consecutive hours).
180
173
  > - The room owner can transfer the room owner identity to another user via the [transferOwner](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#transferOwner) interface.
181
174
 
@@ -261,7 +254,7 @@ Atomicx provides complete scheduled room capabilities, including:
261
254
 
262
255
  - **Join reminders:** Support automatic reminder logic before the start.
263
256
 
264
- If you need to implement the more complex business logic for managing multi-person audio/video rooms described above, please refer to: Schedule Room.
257
+ If you need to implement the more complex business logic for managing multi-person audio/video rooms described above, please .
265
258
 
266
259
  ## FAQ
267
260
 
@@ -52,9 +52,6 @@ import { RoomView } from 'tuikit-atomicx-vue3/room';
52
52
  </style>
53
53
  ```
54
54
 
55
- > **Note:**
56
- >
57
-
58
55
  > `RoomView` automatically fills the height and width of its parent container, so make sure its parent container has explicit dimensions.
59
56
  >
60
57
 
@@ -60,9 +60,6 @@ const handleStartScreenShareWithAudio = async () => {
60
60
  |Firefox|Not supported|System audio sharing is not yet supported|
61
61
  |Safari|Not supported|System audio sharing is not yet supported|
62
62
 
63
- > **Note:**
64
- >
65
-
66
63
  > System audio sharing requires browser support, and the user must check the **Share audio** option in the screen picker. If the browser does not support system audio sharing, the `screenAudio` parameter is ignored, but the screen sharing feature is not affected and works normally.
67
64
  >
68
65
 
@@ -50,7 +50,6 @@ It is generally recommended to place the [VirtualBackgroundPanel](https://github
50
50
  **The following example shows how to implement a complete interaction where clicking a button opens the virtual background settings:**
51
51
 
52
52
  > **Note:**
53
- >
54
53
  > - Publish the `node_modules/trtc-sdk-v5/assets` directory to a CDN or static resource server. For details, see the [SDK documentation](https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-36-advanced-virtual-background.html).
55
54
  > - When using the [VirtualBackgroundPanel](https://github.com/Tencent-RTC/TUIKit_Vue3/tree/main/packages/tuikit-atomicx-vue3/src/components/VirtualBackgroundPanel) component, pass the `assetsPath` static resource address via props.
56
55
  > - All TUIKit components must be wrapped inside UIKitProvider; otherwise, they will not be able to obtain their context dependencies, resulting in abnormal styling.
@@ -122,7 +121,6 @@ This section mainly describes how to implement the virtual background via the at
122
121
  Before invoking the virtual background feature, you must first check whether the browser supports it and initialize the resource path.
123
122
 
124
123
  > **Note:**
125
- >
126
124
  > - Publish the node_modules/trtc-sdk-v5/assets directory to a CDN or static resource server. For details, see the [SDK documentation](https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-36-advanced-virtual-background.html).
127
125
  > - When using the [initVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#initVirtualBackground) interface, pass the assetsPath static resource address.
128
126
  > - The virtual background feature depends on a camera device. You can use [useDeviceState](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#module-DeviceState) to check the device status.
@@ -155,9 +153,6 @@ onMounted(async () => {
155
153
 
156
154
  Before the user confirms applying the background, you usually need to preview the effect first. Use the [setVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/en/index.html#setVirtualBackground) method to set the preview effect. At this point, it is not applied to the video stream visible to remote users.
157
155
 
158
- > **Note:**
159
- >
160
-
161
156
  > Calling `setVirtualBackground` only takes effect in the local preview. Remote users will not see the virtual background effect; it is synchronized to the remote video stream only after `saveVirtualBackground` is called.
162
157
  >
163
158
 
@@ -1,9 +1,6 @@
1
1
  TUIRoomKit is a comprehensive multi-party audio and video conferencing solution built on TRTC. It provides a complete set of UI components along with all the core functionality you need to get up and running quickly.
2
2
 
3
3
  This documentation walks you through integrating TUIRoomKit into your project to enable reliable multi-party audio/video conferencing. You'll also find step-by-step guides for customizing image assets, localizing UI text, and configuring other options—everything you need to build audio/video experiences that align with your brand.
4
- | Room Preparation Page | Room Main Page | Member Management |
5
- | --- | --- | --- |
6
- | | | |
7
4
 
8
5
  ## Prerequisites
9
6
 
@@ -95,7 +92,6 @@ After completing the above steps, Android Studio will usually prompt you to **Sy
95
92
  After integrating the code, complete the login process. This step is **required to use TUIRoomKit features**—you must log in successfully before accessing any functionality. Verify that all parameters are set correctly:
96
93
 
97
94
  > **Note:**
98
- >
99
95
  > The sample code calls the login API directly. In production scenarios, always call AtomicXCore's login service **after** completing your own user authentication and login workflow. This ensures correct business logic flow, prevents data inconsistencies, and integrates seamlessly with your user management and permission systems.
100
96
  >
101
97
 
@@ -1,7 +1,4 @@
1
1
  TUIRoomKit is a comprehensive multi-party audio and video conferencing solution powered by TRTC. It provides a full suite of UI components and essential features out of the box. This guide walks developers through integrating TUIRoomKit into their projects to enable robust multi-party audio and video conferencing. It also covers how to quickly customize image assets, localize UI text, and configure other settings, empowering you to build branded audio and video applications.
2
- | Room Preparation Page | Standard Room Home | Large Webinar Room Home | Member Management |
3
- | --- | --- | --- | --- |
4
- | | | | |
5
2
 
6
3
  ## Prerequisites
7
4
 
@@ -111,7 +108,6 @@ To enable proper page navigation and multilingual UI, update your Flutter app as
111
108
  After integration, complete the login process—a **critical step for using TUIRoomKit**. You must log in successfully before accessing TUIRoomKit features. Ensure all parameters are configured correctly:
112
109
 
113
110
  > **Note:**
114
- >
115
111
  > The sample code calls the login interface directly. In production, always call TUIRoomKit's login service **after your own user authentication and login logic**. This prevents business logic confusion and data inconsistencies, and ensures seamless integration with your user management and permission system.
116
112
  >
117
113
 
@@ -233,7 +229,7 @@ class YourMainPage extends StatelessWidget {
233
229
  | Parameter | Type | Description |
234
230
  | --- | --- | --- |
235
231
  | <code>roomID</code> | <code>String</code> | - Unique Room Identifier.<br>- Length: 0-48 bytes.<br>- Use only numbers, English letters (case-sensitive), underscores (_), and hyphens (-). Avoid spaces and Chinese characters. |
236
- | <code>behavior</code> | <code>RoomBehavior</code> | - Main Room Page initialization source.<br>- Parameter options:<br>- create: Host creates the room (requires Room Creation Options). For detailed usage of CreateRoomOptions, please refer to: CreateRoomOptions Structure Specifications.<br>- enter: Participant joins the room. |
232
+ | <code>behavior</code> | <code>RoomBehavior</code> | - Main Room Page initialization source.<br>- Parameter options:<br>- create: Host creates the room (requires Room Creation Options). For detailed usage of CreateRoomOptions, please .<br>- enter: Participant joins the room. |
237
233
  | <code>config</code> | <code>ConnectConfig</code> | Controls audio/video device behavior after entering the room. |
238
234
 
239
235
  **ConnectConfig Parameter Descriptions:**
@@ -313,21 +309,16 @@ class YourMainPage extends StatelessWidget {
313
309
  **For detailed parameter descriptions, see:** RoomMainWidget Constructor Parameter Descriptions and ConnectConfig Parameter Descriptions.
314
310
 
315
311
  > **Note:**
316
- >
317
312
  > When joining a large webinar room using TUIRoomKit, ensure the room ID created on the web starts with `webinar_`.
318
313
  >
319
314
 
320
315
  ## Core Features
321
316
 
322
317
  Once `RoomMainWidget` is integrated, you get a full-featured multi-party audio and video conferencing interface, including member management, device control, room information display, and more. This is the core of the TUIRoomKit component.
323
- | Standard Room | Large Webinar Room |
324
- | --- | --- |
325
- | | |
326
318
 
327
319
  ## UI Customization
328
320
 
329
321
  > **Note:**
330
- >
331
322
  > UI customization, icon customization, and text customization require modifying TUIRoomKit source code. When integrated via the pub Dependency Manager, TUIRoomKit is treated as an immutable dependency. Each time you run flutter pub get, Flutter:
332
323
  >
333
324
  > 1. Checks the version in pubspec.lock.
@@ -349,9 +340,6 @@ Once `RoomMainWidget` is integrated, you get a full-featured multi-party audio a
349
340
  > ` path: room`
350
341
 
351
342
  The `RoomMainWidget` main room page is highly customizable and feature-rich. Developers can adapt the UI to fit their business requirements. Below are the main view components in `RoomMainWidget` for quick modification.
352
- | Standard Room | Large Webinar Room |
353
- | --- | --- |
354
- | | |
355
343
 
356
344
  **RoomMainWidget Component Details**
357
345
 
@@ -1,9 +1,6 @@
1
1
  TUIRoomKit is a comprehensive multi-party audio and video conferencing solution built on TRTC. It provides a complete set of UI components along with all the core functionality you need to get up and running quickly.
2
2
 
3
3
  This documentation walks you through integrating TUIRoomKit into your project to enable reliable multi-party audio/video conferencing. You'll also find step-by-step guides for customizing image assets, localizing UI text, and configuring other options—everything you need to build audio/video experiences that align with your brand.
4
- | Room Preparation Page | Room Main Page | Member Management |
5
- | --- | --- | --- |
6
- | | | |
7
4
 
8
5
  ## Prerequisites
9
6
 
@@ -88,7 +85,6 @@ To enable audio/video features, your app must request microphone and camera perm
88
85
  After integrating the code, complete the login process. **This step is required to use TUIRoomKit.** You must log in successfully before accessing any features. Verify that all parameters are correctly configured:
89
86
 
90
87
  > **Note:**
91
- >
92
88
  > In the sample code, login is handled in the `didFinishLaunchingWithOptions` method. In real-world projects, **call the AtomicXCore login service only after your own user authentication and login procedures have completed**. This prevents business logic conflicts and ensures seamless integration with your user management and permission systems.
93
89
  >
94
90
 
@@ -279,7 +275,6 @@ Once you've integrated `RoomMainView`, your application will offer a full-featur
279
275
  ## Customize UI
280
276
 
281
277
  > **Note:**
282
- >
283
278
  > Customizing UI elements, icons, or text requires modifying the TUIRoomKit source code. When you integrate TUIRoomKit via CocoaPods, it acts as an immutable dependency. Each time you run `pod install`, CocoaPods will:
284
279
  >
285
280
  > - Check the version listed in Podfile.lock.
@@ -329,7 +324,6 @@ TUIRoomKit manages UI image resources in `TUIRoomKit.xcassets`. Use Xcode's grap
329
324
  TUIRoomKit uses the [Apple Strings Catalog](https://developer.apple.com/documentation/xcode/localizing-and-varying-text-with-a-string-catalog) tool to manage UI text. You can easily adjust text using Xcode's visual tools.
330
325
 
331
326
  > **Note:**
332
- >
333
327
  > The Apple Strings Catalog (.xcstrings) format, introduced in Xcode 15, streamlines localization management. It supports structured formats for plurals, device-specific variants, and more, and is now the recommended localization approach for iOS and macOS apps.
334
328
  >
335
329
 
@@ -60,7 +60,6 @@ export default function App() {
60
60
  Authentication is required to access all TUIRoomKit features. Call **conference.login** immediately after your business system completes authentication (when the user logs in to your web page). After calling `conference.login`, call `conference.setSelfInfo` to set the user's display name and avatar, which appear in the participant video area and member list.
61
61
 
62
62
  > **Note:**
63
- >
64
63
  > Make sure to use the generated UserSig in your configuration. In production, generate UserSig on your server and have the client request a dynamic UserSig from your business server as needed. See [How to Calculate UserSig in Production](https://trtc.io/document/35166).
65
64
  >
66
65
 
@@ -305,7 +304,6 @@ const enterDualMeeting = async (bizOrderId: string) => {
305
304
  ```
306
305
 
307
306
  > **Tip:**
308
- >
309
307
  > The `conference.createAndJoinRoom` API automatically handles "create if not exists (become Host), join if exists (become Participant)", resolving state conflicts under high concurrency.
310
308
  >
311
309
 
@@ -325,7 +323,6 @@ await conference.leaveRoom();
325
323
  ```
326
324
 
327
325
  > **Note:**
328
- >
329
326
  > When the Host leaves or closes the webpage, the room is not automatically ended. Other Participants can continue using TUIRoomKit. The system will reclaim room resources 6 hours after the scheduled end time if there are zero Participants.
330
327
  >
331
328
 
@@ -339,7 +336,6 @@ await conference.endRoom();
339
336
  ```
340
337
 
341
338
  > **Note:**
342
- >
343
339
  > Only the Host can call `endRoom()` after successfully entering the room. Calling as a non-host or before entering will result in an error.
344
340
  >
345
341
 
@@ -404,8 +400,6 @@ pnpm run dev
404
400
  yarn run dev
405
401
  ```
406
402
 
407
- After the project starts, open your browser to the debug address (usually http://localhost:5173) to access the app. You should see the meeting interface as shown below:
408
-
409
403
  ## Next Steps
410
404
 
411
405
  After completing the basic integration, you can further customize the UI to fit your business requirements.
@@ -498,17 +492,13 @@ No. TUIRoomKit does not allow the same userId to join the same room on multiple
498
492
 
499
493
  ### Is iframe integration supported?
500
494
 
501
- Yes. When integrating TUIRoomKit via iframe, set the allow attribute to grant necessary browser permissions (microphone, camera, screen sharing, fullscreen, etc.) as shown below:
502
495
  ``` typescript
503
496
  // Enable microphone, camera, screen sharing, fullscreen permissions
504
497
  <iframe src="https://your-domain.com/index.html" allow="microphone; camera; display-capture; display; fullscreen;">
505
498
  ```
506
499
 
507
- For more information, see Embedded Pages (iframe).
508
-
509
500
  ### Is intranet proxy supported?
510
501
 
511
- Yes. Set intranet proxy parameters as shown below. For more details, see [Dealing with Firewall Restrictions](https://trtc.io/document/59667).
512
502
  ``` typescript
513
503
  // Set intranet proxy parameters before entering the room
514
504
  import TUIRoomEngine from '@tencentcloud/tuiroom-engine-js';
@@ -540,8 +530,6 @@ TUIRoomKit offers rich customization out of the box—custom themes and language
540
530
  We strongly discourage exporting the source code. Doing so removes your project from TUIRoomKit's standard npm upgrade path, increases maintenance costs, and prevents you from benefiting from new features and performance improvements in the underlying audio/video engine.
541
531
  - Recommended: Explore standard customization options in the UI customization documentation.
542
532
 
543
- - Feedback: If the available APIs do not meet your needs, contact us via [Contact Us](https://trtc.io/contact) to submit your requirements. We will evaluate and strive to provide stable, standardized API support.
544
-
545
533
  If you have fully considered the maintenance risks and require deep customization, you may export the source code as follows:
546
534
 
547
535
  【React】
@@ -566,7 +554,3 @@ import { ConferenceMainView, conference } from './components/RoomKit/index.ts';
566
554
  // Replace with the actual TUIRoomKit source path
567
555
  src/components/RoomKit
568
556
  ```
569
-
570
- ## Contact Us
571
-
572
- If you have any questions or suggestions during integration or usage, you are welcome to join our [Telegram technical group](https://t.me/+EPk6TMZEZMM5OGY1) or [contact us](https://trtc.io/contact) for support.