@tencent-rtc/mcp 1.3.9 → 1.4.0

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 (431) hide show
  1. package/package.json +2 -2
  2. package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/android-faq.md} +10 -22
  3. package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/flutter-faq.md} +10 -22
  4. package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/ios-faq.md} +10 -22
  5. package/resource/doc/callkit/preset/android/api.md +296 -0
  6. package/resource/doc/{tuicallkit → callkit/preset}/android/integration.md +53 -365
  7. package/resource/doc/callkit/preset/flutter/api.md +410 -0
  8. package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +35 -97
  9. package/resource/doc/callkit/preset/ios/api.md +80 -0
  10. package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +37 -118
  11. package/resource/doc/callkit/preset/react/api.md +501 -0
  12. package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +5 -20
  13. package/resource/doc/callkit/preset/vue/api.md +501 -0
  14. package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +4 -19
  15. package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -38
  16. package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
  17. package/resource/doc/{chatuikit → chatkit}/android/integration.md +28 -121
  18. package/resource/doc/chatkit/faq/android_sdk/client-api.md +281 -0
  19. package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +0 -1
  20. package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -1
  21. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +199 -0
  22. package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
  23. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +235 -0
  24. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +3 -3
  25. package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
  26. package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +18 -87
  27. package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -38
  28. package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
  29. package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +47 -165
  30. package/resource/doc/{chatuikit → chatkit}/react/components/avatar.md +0 -33
  31. package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +8 -49
  32. package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +6 -35
  33. package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +0 -6
  34. package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -11
  35. package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +96 -502
  36. package/resource/doc/chatkit/react/components/conversation-actions.md +174 -0
  37. package/resource/doc/chatkit/react/components/conversation-list.md +333 -0
  38. package/resource/doc/chatkit/react/components/conversation-preview.md +118 -0
  39. package/resource/doc/chatkit/react/components/conversation-search.md +60 -0
  40. package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -337
  41. package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +20 -212
  42. package/resource/doc/chatkit/react/components/search.md +243 -0
  43. package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +1 -47
  44. package/resource/doc/{chatuikit → chatkit}/react/integration.md +21 -81
  45. package/resource/doc/{chatuikit → chatkit}/vue/components/avatar.md +0 -33
  46. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -48
  47. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +3 -5
  48. package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +0 -5
  49. package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -15
  50. package/resource/doc/chatkit/vue/components/contact-list.md +271 -0
  51. package/resource/doc/chatkit/vue/components/conversation-actions.md +228 -0
  52. package/resource/doc/{chatuikit → chatkit}/vue/components/conversation-list.md +42 -492
  53. package/resource/doc/chatkit/vue/components/conversation-preview.md +213 -0
  54. package/resource/doc/chatkit/vue/components/conversation-search.md +50 -0
  55. package/resource/doc/{chatuikit → chatkit}/vue/components/message-input.md +2 -223
  56. package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -252
  57. package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
  58. package/resource/doc/{chatuikit → chatkit}/vue/components/tuikit.md +7 -21
  59. package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +3 -62
  60. package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
  61. package/resource/doc/{chatuikit → chatkit}/vue/integration.md +22 -23
  62. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +18 -89
  63. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audio-effect.md +34 -192
  64. package/resource/doc/livekit/{live → core-sdk/live}/android/live-barrage.md +28 -141
  65. package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +20 -112
  66. package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +59 -193
  67. package/resource/doc/livekit/{live → core-sdk/live}/android/live-gift.md +75 -455
  68. package/resource/doc/livekit/{live → core-sdk/live}/android/live-host-interaction.md +94 -344
  69. package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +107 -515
  70. package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +33 -173
  71. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +14 -93
  72. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -179
  73. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +19 -107
  74. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -166
  75. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -163
  76. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +69 -443
  77. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
  78. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-integration.md +107 -492
  79. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +23 -165
  80. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +35 -111
  81. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +35 -193
  82. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +31 -144
  83. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +24 -116
  84. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +37 -171
  85. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +79 -459
  86. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +69 -320
  87. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +85 -502
  88. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +32 -169
  89. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audience-list.md +18 -89
  90. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audio-effect.md +34 -192
  91. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-barrage.md +28 -141
  92. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-co-guest-interaction.md +50 -259
  93. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-gift.md +75 -455
  94. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-host-interaction.md +51 -265
  95. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-integration.md +61 -427
  96. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-room-list.md +33 -173
  97. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-co-guest-interaction.md +44 -203
  98. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-integration.md +56 -416
  99. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audience-list.md +35 -111
  100. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audio-effect.md +35 -193
  101. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-barrage.md +31 -144
  102. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-co-guest-interaction.md +43 -252
  103. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-gift.md +79 -459
  104. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-host-interaction.md +46 -264
  105. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-integration.md +61 -445
  106. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-room-list.md +32 -169
  107. package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -2
  108. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +780 -0
  109. package/resource/doc/livekit/preset/live/vue/components/barrage.md +291 -0
  110. package/resource/doc/livekit/{live → preset/live}/vue/components/co-guest-panel.md +10 -49
  111. package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +26 -144
  112. package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +12 -75
  113. package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +36 -227
  114. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +215 -0
  115. package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
  116. package/resource/doc/livekit/preset/live/vue/live-list-integration.md +241 -0
  117. package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +299 -0
  118. package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +300 -0
  119. package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +743 -0
  120. package/resource/doc/roomkit/vue/faq.md +1 -0
  121. package/resource/doc/roomkit/vue/features/call-user-to-room.md +17 -53
  122. package/resource/doc/roomkit/vue/features/device-detection.md +30 -48
  123. package/resource/doc/roomkit/vue/features/device-state.md +24 -44
  124. package/resource/doc/roomkit/vue/features/free-beauty-panel.md +13 -36
  125. package/resource/doc/roomkit/vue/features/room-chat.md +31 -89
  126. package/resource/doc/roomkit/vue/features/room-participant-state.md +28 -50
  127. package/resource/doc/roomkit/vue/features/room-state.md +25 -34
  128. package/resource/doc/roomkit/vue/features/room-view.md +30 -125
  129. package/resource/doc/roomkit/vue/features/schedule-room.md +9 -40
  130. package/resource/doc/roomkit/vue/features/screen-share.md +22 -90
  131. package/resource/doc/roomkit/vue/features/virtual-background.md +13 -29
  132. package/resource/doc/roomkit/vue/integration.md +21 -76
  133. package/resource/doc/rtcengine/faq/common/error_code.md +1 -0
  134. package/resource/doc/rtcengine/faq/web/web.md +14 -24
  135. package/resource/doc/rtcengine/web/api.md +1 -3
  136. package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +3 -10
  137. package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +1 -5
  138. package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +1 -2
  139. package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -4
  140. package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +3 -5
  141. package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +1 -7
  142. package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +0 -2
  143. package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -8
  144. package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +11 -11
  145. package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +12 -88
  146. package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -5
  147. package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +30 -37
  148. package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +13 -90
  149. package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -2
  150. package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +1 -2
  151. package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +19 -19
  152. package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +1 -1
  153. package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +4 -5
  154. package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
  155. package/resource/doc/trtc/C++/ITRTCCloud.md +686 -2835
  156. package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
  157. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +202 -1022
  158. package/resource/doc/trtc/C++/ITXDeviceManager.md +126 -767
  159. package/resource/doc/trtc/C++/TRTCCloudCallback.md +579 -2147
  160. package/resource/doc/trtc/C++/TRTCTypeDef.md +703 -3378
  161. package/resource/doc/trtc/C++/TXLiteAVCode.md +116 -908
  162. package/resource/doc/trtc/android/TRTCCloud.md +606 -2573
  163. package/resource/doc/trtc/android/TRTCCloudDef.md +752 -3640
  164. package/resource/doc/trtc/android/TRTCCloudListener.md +581 -2008
  165. package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
  166. package/resource/doc/trtc/android/TXAudioEffectManager.md +202 -1022
  167. package/resource/doc/trtc/android/TXBeautyManager.md +127 -704
  168. package/resource/doc/trtc/android/TXDeviceManager.md +51 -318
  169. package/resource/doc/trtc/android/TXLiteAVCode.md +114 -892
  170. package/resource/doc/trtc/iOS/TRTCCloud.md +694 -2904
  171. package/resource/doc/trtc/iOS/TRTCCloudDef.md +726 -3498
  172. package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +543 -2028
  173. package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
  174. package/resource/doc/trtc/iOS/TXAudioEffectManager.md +174 -877
  175. package/resource/doc/trtc/iOS/TXBeautyManager.md +128 -710
  176. package/resource/doc/trtc/iOS/TXDeviceManager.md +129 -772
  177. package/resource/doc/trtc/iOS/TXLiteAVCode.md +117 -915
  178. package/server.js +1 -5
  179. package/server.js.map +1 -1
  180. package/tools/call/get_callkit_api.js +32 -0
  181. package/tools/call/get_callkit_api.js.map +1 -0
  182. package/tools/call/get_native_call_uikit_integration.js +34 -0
  183. package/tools/call/get_native_call_uikit_integration.js.map +1 -0
  184. package/tools/call/{get-web-call-integration.js → get_web_call_uikit_integration.js} +13 -8
  185. package/tools/call/get_web_call_uikit_integration.js.map +1 -0
  186. package/tools/chat/get_native_chat_uikit_feature_detail.js +34 -0
  187. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +1 -0
  188. package/tools/chat/get_native_chat_uikit_integration.js +45 -0
  189. package/tools/chat/get_native_chat_uikit_integration.js.map +1 -0
  190. package/tools/chat/get_web_chat_uikit_component_detail.js +34 -0
  191. package/tools/chat/get_web_chat_uikit_component_detail.js.map +1 -0
  192. package/tools/chat/get_web_chat_uikit_integration.js +45 -0
  193. package/tools/chat/get_web_chat_uikit_integration.js.map +1 -0
  194. package/tools/common/get_faq.js +265 -0
  195. package/tools/common/get_faq.js.map +1 -0
  196. package/tools/common/{get-usersig.js → get_usersig.js} +6 -3
  197. package/tools/common/get_usersig.js.map +1 -0
  198. package/tools/common/present_framework_choice.js +63 -0
  199. package/tools/common/present_framework_choice.js.map +1 -0
  200. package/tools/definitions/get_callkit_api_def.js +29 -0
  201. package/tools/definitions/get_callkit_api_def.js.map +1 -0
  202. package/tools/definitions/get_faq_def.js +17 -18
  203. package/tools/definitions/get_faq_def.js.map +1 -1
  204. package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
  205. package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
  206. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
  207. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
  208. package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -41
  209. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
  210. package/tools/definitions/get_native_livekit_core_features_def.js +34 -0
  211. package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
  212. package/tools/definitions/get_native_livekit_core_integration_def.js +34 -0
  213. package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
  214. package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
  215. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
  216. package/tools/definitions/get_usersig_def.js +17 -22
  217. package/tools/definitions/get_usersig_def.js.map +1 -1
  218. package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
  219. package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
  220. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
  221. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
  222. package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
  223. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
  224. package/tools/definitions/get_web_live_uikit_integration_def.js +15 -18
  225. package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
  226. package/tools/definitions/get_web_livekit_api_def.js +30 -0
  227. package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
  228. package/tools/definitions/get_web_livekit_component_detail_def.js +32 -0
  229. package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
  230. package/tools/definitions/get_web_room_uikit_integration_def.js +15 -46
  231. package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
  232. package/tools/definitions/get_web_roomkit_feature_detail_def.js +31 -0
  233. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
  234. package/tools/definitions/get_web_trtc_sdk_api_def.js +27 -0
  235. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
  236. package/tools/definitions/get_web_trtc_sdk_integration_def.js +27 -0
  237. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
  238. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +27 -0
  239. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
  240. package/tools/definitions/present_framework_choice_def.js +24 -12
  241. package/tools/definitions/present_framework_choice_def.js.map +1 -1
  242. package/tools/index.js +47 -61
  243. package/tools/index.js.map +1 -1
  244. package/tools/live/get_native_livekit_core_features.js +65 -0
  245. package/tools/live/get_native_livekit_core_features.js.map +1 -0
  246. package/tools/live/get_native_livekit_core_integration.js +59 -0
  247. package/tools/live/get_native_livekit_core_integration.js.map +1 -0
  248. package/tools/live/get_web_live_uikit_integration.js +48 -0
  249. package/tools/live/get_web_live_uikit_integration.js.map +1 -0
  250. package/tools/live/get_web_livekit_api.js +32 -0
  251. package/tools/live/get_web_livekit_api.js.map +1 -0
  252. package/tools/live/get_web_livekit_component_detail.js +34 -0
  253. package/tools/live/get_web_livekit_component_detail.js.map +1 -0
  254. package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
  255. package/tools/room/get_web_room_uikit_integration.js.map +1 -0
  256. package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
  257. package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
  258. package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
  259. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
  260. package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
  261. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
  262. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
  263. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
  264. package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
  265. package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
  266. package/utils/generate-structured-result.js +61 -17
  267. package/utils/generate-structured-result.js.map +1 -1
  268. package/utils/report-cls-client.js +12 -1
  269. package/utils/report-cls-client.js.map +1 -1
  270. package/utils/report-es-client.js +2 -2
  271. package/resource/doc/chatuikit/android/workflow.md +0 -713
  272. package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1371
  273. package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -932
  274. package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1119
  275. package/resource/doc/chatuikit/flutter/workflow.md +0 -941
  276. package/resource/doc/chatuikit/react/components/conversation-list.md +0 -1017
  277. package/resource/doc/chatuikit/react/components/search.md +0 -745
  278. package/resource/doc/chatuikit/react/create-group.md +0 -23
  279. package/resource/doc/chatuikit/react/init.md +0 -26
  280. package/resource/doc/chatuikit/react/workflow.md +0 -258
  281. package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
  282. package/resource/doc/chatuikit/vue/create-group.md +0 -25
  283. package/resource/doc/chatuikit/vue/init.md +0 -40
  284. package/resource/doc/chatuikit/vue/workflow.md +0 -395
  285. package/resource/doc/livekit/live/android/workflow.md +0 -320
  286. package/resource/doc/livekit/live/flutter/workflow.md +0 -353
  287. package/resource/doc/livekit/live/ios/workflow.md +0 -454
  288. package/resource/doc/livekit/live/vue/components/barrage.md +0 -616
  289. package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -446
  290. package/resource/doc/livekit/live/vue/faq.md +0 -0
  291. package/resource/doc/livekit/live/vue/live-list-integration.md +0 -200
  292. package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -269
  293. package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -269
  294. package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -595
  295. package/resource/doc/livekit/live/vue/states/live-state.md +0 -3591
  296. package/resource/doc/livekit/live/vue/workflow.md +0 -218
  297. package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -312
  298. package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -430
  299. package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -679
  300. package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -671
  301. package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -271
  302. package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
  303. package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
  304. package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
  305. package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
  306. package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -865
  307. package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -657
  308. package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -437
  309. package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -335
  310. package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
  311. package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -327
  312. package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -507
  313. package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
  314. package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -659
  315. package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
  316. package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -814
  317. package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1000
  318. package/resource/doc/roomkit/vue/features/workflow.md +0 -553
  319. package/resource/doc/roomkit/vue/workflow.md +0 -733
  320. package/resource/doc/tuicallkit/android/workflow.md +0 -441
  321. package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -784
  322. package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -610
  323. package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -938
  324. package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -897
  325. package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -469
  326. package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -781
  327. package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -398
  328. package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
  329. package/resource/doc/tuicallkit/react/api.md +0 -1404
  330. package/resource/doc/tuicallkit/vue/api.md +0 -1406
  331. package/resource/doc/tuicallkit/vue/faq.md +0 -36
  332. package/tools/call/get-native-call-integration.js +0 -43
  333. package/tools/call/get-native-call-integration.js.map +0 -1
  334. package/tools/call/get-web-call-api.js +0 -27
  335. package/tools/call/get-web-call-api.js.map +0 -1
  336. package/tools/call/get-web-call-integration.js.map +0 -1
  337. package/tools/chat/get-native-chat-feature-detail.js +0 -30
  338. package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
  339. package/tools/chat/get-native-chat-integration.js +0 -45
  340. package/tools/chat/get-native-chat-integration.js.map +0 -1
  341. package/tools/chat/get-web-chat-component-detail.js +0 -31
  342. package/tools/chat/get-web-chat-component-detail.js.map +0 -1
  343. package/tools/chat/get-web-chat-integration.js +0 -45
  344. package/tools/chat/get-web-chat-integration.js.map +0 -1
  345. package/tools/chat/get-web-chat-uikit-init.js +0 -28
  346. package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
  347. package/tools/chat/get-web-create-group-doc.js +0 -28
  348. package/tools/chat/get-web-create-group-doc.js.map +0 -1
  349. package/tools/common/get-faq.js +0 -91
  350. package/tools/common/get-faq.js.map +0 -1
  351. package/tools/common/get-usersig.js.map +0 -1
  352. package/tools/common/present-framework-choice.js +0 -16
  353. package/tools/common/present-framework-choice.js.map +0 -1
  354. package/tools/common/present-scenario-choice.js +0 -16
  355. package/tools/common/present-scenario-choice.js.map +0 -1
  356. package/tools/common/record-prompt.js +0 -55
  357. package/tools/common/record-prompt.js.map +0 -1
  358. package/tools/common/record-result.js +0 -60
  359. package/tools/common/record-result.js.map +0 -1
  360. package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
  361. package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
  362. package/tools/definitions/get_native_live_api_def.js +0 -23
  363. package/tools/definitions/get_native_live_api_def.js.map +0 -1
  364. package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -87
  365. package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
  366. package/tools/definitions/get_native_live_uikit_integration_def.js +0 -75
  367. package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
  368. package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
  369. package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
  370. package/tools/definitions/get_trtc_native_api_def.js +0 -16
  371. package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
  372. package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
  373. package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
  374. package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
  375. package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
  376. package/tools/definitions/get_web_create_group_doc_def.js +0 -18
  377. package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
  378. package/tools/definitions/get_web_live_state_detail_def.js +0 -19
  379. package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
  380. package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
  381. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
  382. package/tools/definitions/get_web_room_feature_detail_def.js +0 -92
  383. package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
  384. package/tools/definitions/get_web_room_state_detail_def.js +0 -19
  385. package/tools/definitions/get_web_room_state_detail_def.js.map +0 -1
  386. package/tools/definitions/present_scenario_choice_def.js +0 -53
  387. package/tools/definitions/present_scenario_choice_def.js.map +0 -1
  388. package/tools/definitions/record_prompt_def.js +0 -58
  389. package/tools/definitions/record_prompt_def.js.map +0 -1
  390. package/tools/definitions/record_result_def.js +0 -46
  391. package/tools/definitions/record_result_def.js.map +0 -1
  392. package/tools/live/get-native-live-uikit-integration.js +0 -177
  393. package/tools/live/get-native-live-uikit-integration.js.map +0 -1
  394. package/tools/live/get-web-live-component-detail.js +0 -31
  395. package/tools/live/get-web-live-component-detail.js.map +0 -1
  396. package/tools/live/get-web-live-state-detail.js +0 -31
  397. package/tools/live/get-web-live-state-detail.js.map +0 -1
  398. package/tools/live/get-web-live-uikit-integration.js +0 -52
  399. package/tools/live/get-web-live-uikit-integration.js.map +0 -1
  400. package/tools/live/get_native_live_uikit_extra_features.js +0 -105
  401. package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
  402. package/tools/live/get_native_live_uikit_interaction.js +0 -194
  403. package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
  404. package/tools/native_live/get-native-live-api.js +0 -31
  405. package/tools/native_live/get-native-live-api.js.map +0 -1
  406. package/tools/room/get-web-room-feature-detail.js.map +0 -1
  407. package/tools/room/get-web-room-integration.js.map +0 -1
  408. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
  409. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
  410. package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
  411. package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
  412. package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
  413. package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
  414. package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
  415. package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
  416. package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
  417. package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
  418. package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
  419. package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
  420. package/tools/trtc/get-trtc-native-api.js +0 -31
  421. package/tools/trtc/get-trtc-native-api.js.map +0 -1
  422. package/utils/handle-component-name.js +0 -33
  423. package/utils/handle-component-name.js.map +0 -1
  424. /package/resource/doc/{chatuikit/iOS/workflow.md → callkit/core-sdk/.gitkeep} +0 -0
  425. /package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +0 -0
  426. /package/resource/doc/{tuicallkit/react/faq.md → callkit/faq/web-faq.md} +0 -0
  427. /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
  428. /package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +0 -0
  429. /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
  430. /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
  431. /package/resource/doc/roomkit/faq/common/{error_code.md → error-code.md} +0 -0
@@ -1,22 +1,7 @@
1
1
  `GiftStore` is a dedicated module within **AtomicXCore** for managing live room gifting features. It enables you to build a complete gifting system for your live streaming application, supporting robust monetization and interactive experiences.
2
- <table>
3
- <tr>
4
- <td rowspan="1" colSpan="1" >**Gift Panel**</td>
5
-
6
- <td rowspan="1" colSpan="1" >**Barrage Gift**</td>
7
-
8
- <td rowspan="1" colSpan="1" >**Full-Screen Gift**</td>
9
- </tr>
10
-
11
- <tr>
12
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/33aa8083c6e111f0b011525400bf7822.png)</td>
13
-
14
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/33925a80c6e111f087ad52540099c741.png)</td>
15
-
16
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/33c98fa2c6e111f09e745254007c27c5.gif)</td>
17
- </tr>
18
- </table>
19
-
2
+ | **Gift Panel** | **Barrage Gift** | **Full-Screen Gift** |
3
+ | --- | --- | --- |
4
+ | | | |
20
5
 
21
6
  ## Core Features
22
7
  - **Gift List Retrieval**: Retrieve gift panel data from the server, including gift categories and details.
@@ -25,73 +10,28 @@
25
10
 
26
11
  - **Gift Event Broadcasting:** Real-time synchronization of gift events across all clients in the room to trigger animations and barrage notifications.
27
12
 
28
-
29
13
  ## Core Concepts
30
- <table>
31
- <tr>
32
- <td rowspan="1" colSpan="1" >**Core Concept**</td>
33
-
34
- <td rowspan="1" colSpan="1" >**Type**</td>
35
-
36
- <td rowspan="1" colSpan="1" >**Core Responsibilities & Description**</td>
37
- </tr>
38
-
39
- <tr>
40
- <td rowspan="1" colSpan="1" >`Gift`</td>
41
-
42
- <td rowspan="1" colSpan="1" >`struct`</td>
43
-
44
- <td rowspan="1" colSpan="1" >Represents a gift data model, including ID, name, icon URL, animation resource URL (resourceURL), price (coins), and more.</td>
45
- </tr>
46
-
47
- <tr>
48
- <td rowspan="1" colSpan="1" >`GiftCategory`</td>
49
-
50
- <td rowspan="1" colSpan="1" >`struct`</td>
51
-
52
- <td rowspan="1" colSpan="1" >- Represents a grouping of gifts (e.g., "Popular", "Luxury"). <br>- Contains a category name and an array of Gift objects.</td>
53
- </tr>
54
-
55
- <tr>
56
- <td rowspan="1" colSpan="1" >`GiftState`</td>
57
-
58
- <td rowspan="1" colSpan="1" >`struct`</td>
59
-
60
- <td rowspan="1" colSpan="1" >- Represents the current state of the gift module. <br>- The core property, usableGifts, is a StateFlow containing the full gift list from the server.</td>
61
- </tr>
62
-
63
- <tr>
64
- <td rowspan="1" colSpan="1" >`GiftEvent`</td>
65
-
66
- <td rowspan="1" colSpan="1" >`enum`</td>
67
-
68
- <td rowspan="1" colSpan="1" >Defines the event listener for gift events in the live room. Currently, only `onReceiveGift` is available. This event is broadcast to all users in the room (including the sender) whenever a gift is successfully sent.</td>
69
- </tr>
70
-
71
- <tr>
72
- <td rowspan="1" colSpan="1" >`GiftStore`</td>
73
-
74
- <td rowspan="1" colSpan="1" >`class`</td>
75
-
76
- <td rowspan="1" colSpan="1" >- The core management class for gift features. <br>- Used to fetch gift lists, execute send requests, and listen for global gift events.</td>
77
- </tr>
78
- </table>
79
-
14
+ | **Core Concept** | **Type** | **Core Responsibilities & Description** |
15
+ | --- | --- | --- |
16
+ | `Gift` | `struct` | Represents a gift data model, including ID, name, icon URL, animation resource URL (resourceURL), price (coins), and more. |
17
+ | `GiftCategory` | `struct` | - Represents a grouping of gifts (e.g., "Popular", "Luxury").<br>- Contains a category name and an array of Gift objects. |
18
+ | `GiftState` | `struct` | - Represents the current state of the gift module.<br>- The core property, usableGifts, is a StateFlow containing the full gift list from the server. |
19
+ | `GiftEvent` | `enum` | Defines the event listener for gift events in the live room. Currently, only `onReceiveGift` is available. This event is broadcast to all users in the room (including the sender) whenever a gift is successfully sent. |
20
+ | `GiftStore` | `class` | - The core management class for gift features.<br>- Used to fetch gift lists, execute send requests, and listen for global gift events. |
80
21
 
81
22
  ## Implementation
82
23
 
83
24
  ### Step 1: Component Integration
84
25
 
85
26
  > **Note:**
86
- >
87
-
88
- > To use the gifting system, activate either the **Free Trial,** or **Pro **edition. The number of configurable gifts depends on the selected package. For details, see the **Gift System** section in [Feature and Billing Description](https://write.woa.com/document/137771241658241024) and choose the package that fits your needs.
89
- >
27
+ >
90
28
 
91
- - **Video Live Streaming**: Please refer to [Quick Start](https://write.woa.com/document/194571606121816064) to integrate AtomicXCore.
29
+ > To use the gifting system, activate either the **Free Trial,** or **Pro **edition. The number of configurable gifts depends on the selected package. For details, see the **Gift System** section in Feature and Billing Description and choose the package that fits your needs.
30
+ >
92
31
 
93
- - **Voice Chat Room**: Please refer to [Quick Start](https://write.woa.com/document/194571595685527552) to integrate AtomicXCore.
32
+ - **Video Live Streaming**: Please refer to Quick Start to integrate AtomicXCore.
94
33
 
34
+ - **Voice Chat Room**: Please refer to Quick Start to integrate AtomicXCore.
95
35
 
96
36
  ### Step 2: Initialize and Listen for Gift Events
97
37
 
@@ -104,18 +44,17 @@ Obtain a `GiftStore` instance and set up subscribers to receive gift events and
104
44
 
105
45
  3. **Subscribe to State**: Subscribe to `giftStore.state` to obtain the `usableGifts` gift list.
106
46
 
107
-
108
47
  #### Code Example
109
48
  ``` swift
110
49
  import Foundation
111
- import AtomicXCore
112
- import Combine
50
+ import AtomicXCore
51
+ import Combine
113
52
 
114
53
  class GiftManager {
115
54
  private let liveId: String
116
55
  private let giftStore: GiftStore
117
56
  private var cancellables = Set<AnyCancellable>()
118
-
57
+
119
58
  // Expose gift events for the UI layer to subscribe and trigger animations
120
59
  let giftEventPublisher = PassthroughSubject<GiftEvent, Never>()
121
60
  // Expose gift list externally
@@ -125,7 +64,7 @@ class GiftManager {
125
64
  self.liveId = liveId
126
65
  // 1. Obtain GiftStore instance using liveId
127
66
  self.giftStore = GiftStore.create(liveID: liveId)
128
-
67
+
129
68
  subscribeToGiftState()
130
69
  subscribeToGiftEvents()
131
70
  }
@@ -140,7 +79,7 @@ class GiftManager {
140
79
  }
141
80
  .store(in: &cancellables)
142
81
  }
143
-
82
+
144
83
  /// 3. Subscribe to gift list state
145
84
  private func subscribeToGiftState() {
146
85
  giftStore.state
@@ -155,132 +94,26 @@ class GiftManager {
155
94
  #### Gift List Struct Parameters
156
95
  - **GiftCategory Parameter Description**
157
96
 
158
- <table>
159
- <tr>
160
- <td rowspan="1" colSpan="1" >**Parameter**</td>
161
-
162
- <td rowspan="1" colSpan="1" >**Type**</td>
163
-
164
- <td rowspan="1" colSpan="1" >**Description**</td>
165
- </tr>
166
-
167
- <tr>
168
- <td rowspan="1" colSpan="1" >`categoryID`</td>
169
-
170
- <td rowspan="1" colSpan="1" >`String`</td>
171
-
172
- <td rowspan="1" colSpan="1" >Unique ID of the gift category.</td>
173
- </tr>
174
-
175
- <tr>
176
- <td rowspan="1" colSpan="1" >`name`</td>
177
-
178
- <td rowspan="1" colSpan="1" >`String`</td>
179
-
180
- <td rowspan="1" colSpan="1" >Display name of the gift category.</td>
181
- </tr>
182
-
183
- <tr>
184
- <td rowspan="1" colSpan="1" >`desc`</td>
185
-
186
- <td rowspan="1" colSpan="1" >`String`</td>
187
-
188
- <td rowspan="1" colSpan="1" >Description of the gift category.</td>
189
- </tr>
190
-
191
- <tr>
192
- <td rowspan="1" colSpan="1" >`extensionInfo`</td>
193
-
194
- <td rowspan="1" colSpan="1" >`[String: String]`</td>
195
-
196
- <td rowspan="1" colSpan="1" >Extension information field.</td>
197
- </tr>
198
-
199
- <tr>
200
- <td rowspan="1" colSpan="1" >`giftList`</td>
201
-
202
- <td rowspan="1" colSpan="1" >`[`[Gift](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/gift)`]`</td>
203
-
204
- <td rowspan="1" colSpan="1" >Array of Gift objects contained in this category.</td>
205
- </tr>
206
- </table>
97
+ | **Parameter** | **Type** | **Description** |
98
+ | --- | --- | --- |
99
+ | `categoryID` | `String` | Unique ID of the gift category. |
100
+ | `name` | `String` | Display name of the gift category. |
101
+ | `desc` | `String` | Description of the gift category. |
102
+ | `extensionInfo` | `[String: String]` | Extension information field. |
103
+ | `giftList` | `[`[Gift](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/gift)`]` | Array of Gift objects contained in this category. |
207
104
 
208
105
  - **Gift Parameter Description**
209
106
 
210
- <table>
211
- <tr>
212
- <td rowspan="1" colSpan="1" >**Parameter**</td>
213
-
214
- <td rowspan="1" colSpan="1" >**Type**</td>
215
-
216
- <td rowspan="1" colSpan="1" >**Description**</td>
217
- </tr>
218
-
219
- <tr>
220
- <td rowspan="1" colSpan="1" >`giftID`</td>
221
-
222
- <td rowspan="1" colSpan="1" >`String`</td>
223
-
224
- <td rowspan="1" colSpan="1" >Unique ID of the gift.</td>
225
- </tr>
226
-
227
- <tr>
228
- <td rowspan="1" colSpan="1" >`name`</td>
229
-
230
- <td rowspan="1" colSpan="1" >`String`</td>
231
-
232
- <td rowspan="1" colSpan="1" >Display name of the gift.</td>
233
- </tr>
234
-
235
- <tr>
236
- <td rowspan="1" colSpan="1" >`desc`</td>
237
-
238
- <td rowspan="1" colSpan="1" >`String`</td>
239
-
240
- <td rowspan="1" colSpan="1" >Description of the gift.</td>
241
- </tr>
242
-
243
- <tr>
244
- <td rowspan="1" colSpan="1" >`iconURL`</td>
245
-
246
- <td rowspan="1" colSpan="1" >`String`</td>
247
-
248
- <td rowspan="1" colSpan="1" >Gift icon URL.</td>
249
- </tr>
250
-
251
- <tr>
252
- <td rowspan="1" colSpan="1" >`resourceURL`</td>
253
-
254
- <td rowspan="1" colSpan="1" >`String`</td>
255
-
256
- <td rowspan="1" colSpan="1" >Gift animation resource URL.</td>
257
- </tr>
258
-
259
- <tr>
260
- <td rowspan="1" colSpan="1" >`level`</td>
261
-
262
- <td rowspan="1" colSpan="1" >`UInt`</td>
263
-
264
- <td rowspan="1" colSpan="1" >Gift level.</td>
265
- </tr>
266
-
267
- <tr>
268
- <td rowspan="1" colSpan="1" >`coins`</td>
269
-
270
- <td rowspan="1" colSpan="1" >`UInt`</td>
271
-
272
- <td rowspan="1" colSpan="1" >Gift price.</td>
273
- </tr>
274
-
275
- <tr>
276
- <td rowspan="1" colSpan="1" >`extensionInfo`</td>
277
-
278
- <td rowspan="1" colSpan="1" >`[String: String]`</td>
279
-
280
- <td rowspan="1" colSpan="1" >Extension information field.</td>
281
- </tr>
282
- </table>
283
-
107
+ | **Parameter** | **Type** | **Description** |
108
+ | --- | --- | --- |
109
+ | `giftID` | `String` | Unique ID of the gift. |
110
+ | `name` | `String` | Display name of the gift. |
111
+ | `desc` | `String` | Description of the gift. |
112
+ | `iconURL` | `String` | Gift icon URL. |
113
+ | `resourceURL` | `String` | Gift animation resource URL. |
114
+ | `level` | `UInt` | Gift level. |
115
+ | `coins` | `UInt` | Gift price. |
116
+ | `extensionInfo` | `[String: String]` | Extension information field. |
284
117
 
285
118
  ### Step 3: Retrieve Gift List
286
119
 
@@ -291,8 +124,7 @@ Call the `refreshUsableGifts` method to fetch gift data from the server.
291
124
 
292
125
  2. **Handle Callback**: Handle the completion block for error checking.
293
126
 
294
- 3. **Receive Data**: Upon success, the data flows automatically through the giftListPublisher set up in [Step 2](https://write.woa.com/#634828fc-7b2c-4a61-9140-60efc5246431).
295
-
127
+ 3. **Receive Data**: Upon success, the data flows automatically through the giftListPublisher set up in Step 2.
296
128
 
297
129
  #### Code Example
298
130
  ``` swift
@@ -323,7 +155,6 @@ Trigger the sending logic when a user interacts with the gift panel.
323
155
 
324
156
  3. **Handle Result**: Use the completion block only to handle failures (e.g., balance errors). Successful sends are handled via the global `.onReceiveGift` event listener to ensure consistency.
325
157
 
326
-
327
158
  #### Code Example
328
159
  ``` swift
329
160
  extension GiftManager {
@@ -344,40 +175,11 @@ extension GiftManager {
344
175
  ```
345
176
 
346
177
  #### sendGift API Parameters
347
- <table>
348
- <tr>
349
- <td rowspan="1" colSpan="1" >**Parameter Name**</td>
350
-
351
- <td rowspan="1" colSpan="1" >**Type**</td>
352
-
353
- <td rowspan="1" colSpan="1" >**Description**</td>
354
- </tr>
355
-
356
- <tr>
357
- <td rowspan="1" colSpan="1" >`giftID`</td>
358
-
359
- <td rowspan="1" colSpan="1" >`String`</td>
360
-
361
- <td rowspan="1" colSpan="1" >The unique ID of the gift to send.</td>
362
- </tr>
363
-
364
- <tr>
365
- <td rowspan="1" colSpan="1" >`count`</td>
366
-
367
- <td rowspan="1" colSpan="1" >`UInt`</td>
368
-
369
- <td rowspan="1" colSpan="1" >The number of gifts to send.</td>
370
- </tr>
371
-
372
- <tr>
373
- <td rowspan="1" colSpan="1" >`completion`</td>
374
-
375
- <td rowspan="1" colSpan="1" >`CompletionClosure?`</td>
376
-
377
- <td rowspan="1" colSpan="1" >Callback after sending is complete.</td>
378
- </tr>
379
- </table>
380
-
178
+ | **Parameter Name** | **Type** | **Description** |
179
+ | --- | --- | --- |
180
+ | `giftID` | `String` | The unique ID of the gift to send. |
181
+ | `count` | `UInt` | The number of gifts to send. |
182
+ | `completion` | `CompletionClosure?` | Callback after sending is complete. |
381
183
 
382
184
  ## Advanced Features
383
185
 
@@ -388,134 +190,39 @@ The `GiftStore` module is designed to work seamlessly with your backend infrastr
388
190
  You can fully customize your gift inventory (names, icons, prices, animations) to match your branding.
389
191
 
390
192
  #### Implementation
391
- 1. **Server-Side Configuration**: Use the LiveKit server REST API to manage gift information, categories, and multi-language support. See the [Gift Configuration Guide](https://write.woa.com/document/185130564680273920).
193
+ 1. **Server-Side Configuration**: Use the LiveKit server REST API to manage gift information, categories, and multi-language support. See the Gift Configuration Guide.
392
194
 
393
195
  2. **Client Fetch**: On the client, call `refreshUsableGifts` to retrieve configuration data.
394
196
 
395
197
  3. **UI Display**: Use the retrieved `List<GiftCategory>` to render the gift panel.
396
198
 
397
-
398
199
  #### Configuration Sequence Diagram
399
200
 
400
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/3c2e9ac9c6e111f0a7775254005ef0f7.png)
401
-
402
-
403
201
  #### Related REST API Interfaces Overview
404
- <table>
405
- <tr>
406
- <td rowspan="1" colSpan="1" >**Interface Category**</td>
407
-
408
- <td rowspan="1" colSpan="1" >**Interface**</td>
409
-
410
- <td rowspan="1" colSpan="1" >**Request Example**</td>
411
- </tr>
412
-
413
- <tr>
414
- <td rowspan="3" colSpan="1" >**​Gift Management**</td>
415
-
416
- <td rowspan="1" colSpan="1" >Add Gift Information</td>
417
-
418
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185130814885187584)</td>
419
- </tr>
420
-
421
- <tr>
422
- <td rowspan="1" colSpan="1" >Delete Gift Information</td>
423
-
424
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131021432451072)</td>
425
- </tr>
426
-
427
- <tr>
428
- <td rowspan="1" colSpan="1" >Query Gift Information</td>
429
-
430
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185130925608591360)</td>
431
- </tr>
432
-
433
- <tr>
434
- <td rowspan="3" colSpan="1" >**Gift Category Management**</td>
435
-
436
- <td rowspan="1" colSpan="1" >Add Gift Category Information</td>
437
-
438
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131054187974656)</td>
439
- </tr>
440
-
441
- <tr>
442
- <td rowspan="1" colSpan="1" >Delete Specific Gift Category Information</td>
443
-
444
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131288984932352)</td>
445
- </tr>
446
-
447
- <tr>
448
- <td rowspan="1" colSpan="1" >Get Specific Gift Category Information</td>
449
-
450
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131164168736768)</td>
451
- </tr>
452
-
453
- <tr>
454
- <td rowspan="3" colSpan="1" >**Gift Relationship Management**</td>
455
-
456
- <td rowspan="1" colSpan="1" >Add Relationship between a Specific Gift Category and Gift</td>
457
-
458
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131388068356096)</td>
459
- </tr>
460
-
461
- <tr>
462
- <td rowspan="1" colSpan="1" >Delete Relationship between a Specific Gift Category and Gift</td>
463
-
464
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131491225227264)</td>
465
- </tr>
466
-
467
- <tr>
468
- <td rowspan="1" colSpan="1" >Get Gift Relationships under a Specific Gift Category</td>
469
-
470
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131634710056960)</td>
471
- </tr>
472
-
473
- <tr>
474
- <td rowspan="6" colSpan="1" >**Gift Multi-language Management**</td>
475
-
476
- <td rowspan="1" colSpan="1" >Add Gift Multi-language Information</td>
477
-
478
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131766094020608)</td>
479
- </tr>
480
-
481
- <tr>
482
- <td rowspan="1" colSpan="1" >Delete Specific Gift Multi-language Information</td>
483
-
484
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185132041665441792)</td>
485
- </tr>
486
-
487
- <tr>
488
- <td rowspan="1" colSpan="1" >Get Gift Multi-language Information</td>
489
-
490
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131910582956032)</td>
491
- </tr>
492
-
493
- <tr>
494
- <td rowspan="1" colSpan="1" >Add Gift Category Multi-language Information</td>
495
-
496
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185132145524985856)</td>
497
- </tr>
498
-
499
- <tr>
500
- <td rowspan="1" colSpan="1" >Delete Specific Gift Category Multi-language Information</td>
501
-
502
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185132396568891392)</td>
503
- </tr>
504
-
505
- <tr>
506
- <td rowspan="1" colSpan="1" >Get Gift Category Multi-language Information</td>
507
-
508
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185132283123777536)</td>
509
- </tr>
510
- </table>
511
-
202
+ | **Interface Category** | **Interface** | **Request Example** |
203
+ | --- | --- | --- |
204
+ | **​Gift Management** | Add Gift Information | Example |
205
+ | Delete Gift Information | Example | |
206
+ | Query Gift Information | Example | |
207
+ | **Gift Category Management** | Add Gift Category Information | Example |
208
+ | Delete Specific Gift Category Information | Example | |
209
+ | Get Specific Gift Category Information | Example | |
210
+ | **Gift Relationship Management** | Add Relationship between a Specific Gift Category and Gift | Example |
211
+ | Delete Relationship between a Specific Gift Category and Gift | Example | |
212
+ | Get Gift Relationships under a Specific Gift Category | Example | |
213
+ | **Gift Multi-language Management** | Add Gift Multi-language Information | Example |
214
+ | Delete Specific Gift Multi-language Information | Example | |
215
+ | Get Gift Multi-language Information | Example | |
216
+ | Add Gift Category Multi-language Information | Example | |
217
+ | Delete Specific Gift Category Multi-language Information | Example | |
218
+ | Get Gift Category Multi-language Information | Example | |
512
219
 
513
220
  ### Billing and Gift Deduction Process
514
221
 
515
222
  AtomicXCore delegates the billing logic to your backend to ensure security and flexibility.
516
223
 
517
224
  #### Workflow
518
- 1. **Backend Callback Configuration**: Configure your billing system's callback URL in the LiveKit backend. See [Callback Configuration Documentation](https://write.woa.com/document/155612057789870080).
225
+ 1. **Backend Callback Configuration**: Configure your billing system's callback URL in the LiveKit backend. See Callback Configuration Documentation.
519
226
 
520
227
  2. **Client Request**: The client calls `sendGift`.
521
228
 
@@ -523,31 +230,12 @@ AtomicXCore delegates the billing logic to your backend to ensure security and f
523
230
 
524
231
  4. **Result Synchronization**: If succeeds, **AtomicXCore** broadcasts the `onReceiveGift` event; if fails, the completion callback of `sendGift` receives an error.
525
232
 
526
-
527
233
  #### Call Flow
528
234
 
529
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/416552bdc6e111f09e745254007c27c5.png)
530
-
531
-
532
235
  #### Related REST API Interfaces Overview
533
- <table>
534
- <tr>
535
- <td rowspan="1" colSpan="1" >**Interface**</td>
536
-
537
- <td rowspan="1" colSpan="1" >**Description**</td>
538
-
539
- <td rowspan="1" colSpan="1" >**Request Example**</td>
540
- </tr>
541
-
542
- <tr>
543
- <td rowspan="1" colSpan="1" >**Callback Configuration - Callback before sending a gift**</td>
544
-
545
- <td rowspan="1" colSpan="1" >Pre-gifting validation hook. <br>Allows your backend to intercept gift requests to perform necessary checks (e.g., sufficient balance, risk control) before the gift is processed.</td>
546
-
547
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/183772991768039424)</td>
548
- </tr>
549
- </table>
550
-
236
+ | **Interface** | **Description** | **Request Example** |
237
+ | --- | --- | --- |
238
+ | **Callback Configuration - Callback before sending a gift** | Pre-gifting validation hook.<br>Allows your backend to intercept gift requests to perform necessary checks (e.g., sufficient balance, risk control) before the gift is processed. | Example |
551
239
 
552
240
  ### Full-Screen Animation (SVGA Integration)
553
241
 
@@ -556,56 +244,13 @@ When a user sends a luxury gift (e.g., "Rocket", "Carnival"), play a full-screen
556
244
  #### Implementation
557
245
 
558
246
  **AtomicXCore** does not include a built-in gift animation player. Integrate a third-party library based on your requirements. Below is a comparison of two options:
559
- <table>
560
- <tr>
561
- <td rowspan="1" colSpan="1" >**Comparison Item**</td>
562
-
563
- <td rowspan="1" colSpan="1" >**Basic Solution (SVGAPlayer)**</td>
564
-
565
- <td rowspan="1" colSpan="1" >**Gift AR (TCEffectPlayerKit)**</td>
566
- </tr>
567
-
568
- <tr>
569
- <td rowspan="1" colSpan="1" >Billing</td>
570
-
571
- <td rowspan="1" colSpan="1" >Free (open source)</td>
572
-
573
- <td rowspan="1" colSpan="1" >Paid (License Required). See [Billing Guide](https://trtc.io/document/69949?product=beautyar&menulabel=core%20sdk&platform=android#X-Series-Capabilities)</td>
574
- </tr>
575
-
576
- <tr>
577
- <td rowspan="1" colSpan="1" >Integration Method</td>
578
-
579
- <td rowspan="1" colSpan="1" >Manual integration via Gradle</td>
580
-
581
- <td rowspan="1" colSpan="1" >Requires additional integration and authentication</td>
582
- </tr>
583
-
584
- <tr>
585
- <td rowspan="1" colSpan="1" > Formats</td>
586
-
587
- <td rowspan="1" colSpan="1" >SVGA only</td>
588
-
589
- <td rowspan="1" colSpan="1" >SVGA, PAG, WebP, Lottie, MP4, and more</td>
590
- </tr>
591
-
592
- <tr>
593
- <td rowspan="1" colSpan="1" >Performance</td>
594
-
595
- <td rowspan="1" colSpan="1" >Good for files < 10MB</td>
596
-
597
- <td rowspan="1" colSpan="1" >Optimized for large assets & complex layering</td>
598
- </tr>
599
-
600
- <tr>
601
- <td rowspan="1" colSpan="1" >Recommended Scenario</td>
602
-
603
- <td rowspan="1" colSpan="1" >Uniform SVGA format, controllable file size</td>
604
-
605
- <td rowspan="1" colSpan="1" >Multiple formats or higher performance/device compatibility needs</td>
606
- </tr>
607
- </table>
608
-
247
+ | **Comparison Item** | **Basic Solution (SVGAPlayer)** | **Gift AR (TCEffectPlayerKit)** |
248
+ | --- | --- | --- |
249
+ | Billing | Free (open source) | Paid (License Required). See [Billing Guide](https://trtc.io/document/69949?product=beautyar&menulabel=core%20sdk&platform=android#X-Series-Capabilities) |
250
+ | Integration Method | Manual integration via Gradle | Requires additional integration and authentication |
251
+ | Formats | SVGA only | SVGA, PAG, WebP, Lottie, MP4, and more |
252
+ | Performance | Good for files < 10MB | Optimized for large assets & complex layering |
253
+ | Recommended Scenario | Uniform SVGA format, controllable file size | Multiple formats or higher performance/device compatibility needs |
609
254
 
610
255
  This section demonstrates the basic solution. For the **Gift AR**, see the [TCEffectPlayer Integration Guide](https://trtc.io/document/70537?product=beautyar&menulabel=core%20sdk&platform=ios).
611
256
 
@@ -622,11 +267,10 @@ This section demonstrates the basic solution. For the **Gift AR**, see the [TCEf
622
267
 
623
268
  3. **Parse and Play**: When receiving an `.onReceiveGift` event, check if `gift.resourceURL` is valid and points to an SVGA file. If so, use `SVGAParser` to parse the URL and pass the parsed `SVGAVideoEntity` to the `SVGAPlayer` instance for playback.
624
269
 
625
-
626
270
  #### Code Example
627
271
  ``` swift
628
272
  import UIKit
629
- import AtomicXCore
273
+ import AtomicXCore
630
274
  import Combine
631
275
  import SVGAPlayer // 1. Import
632
276
 
@@ -697,7 +341,6 @@ Enhance social interaction by displaying a system notification in the public bar
697
341
 
698
342
  5. **Insert Locally**: Call `barrageStore.appendLocalTip(message: giftTip)` to insert the message into the local list.
699
343
 
700
-
701
344
  #### Code Example
702
345
  ``` swift
703
346
  // In LiveRoomManager or a similar top-level manager
@@ -713,7 +356,7 @@ private func setupGiftToBarrageFlow() {
713
356
  // 4. Compose message
714
357
  let tipText = "\(sender.userName) sent \(gift.name) x \(count)"
715
358
  var giftTip = Barrage()
716
- giftTip.messageType = .text
359
+ giftTip.messageType = .text
717
360
  giftTip.textContent = tipText
718
361
  // Optional: set a special sender
719
362
 
@@ -727,32 +370,10 @@ private func setupGiftToBarrageFlow() {
727
370
  ## API Documentation
728
371
 
729
372
  For complete details on all public interfaces, properties, and methods of [GiftStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/giftstore) and related classes, see the official API documentation for [AtomicXCore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore). Key stores referenced in this guide include:
730
- <table>
731
- <tr>
732
- <td rowspan="1" colSpan="1" >**Store/Component**</td>
733
-
734
- <td rowspan="1" colSpan="1" >**Feature Description**</td>
735
-
736
- <td rowspan="1" colSpan="1" >**API Documentation**</td>
737
- </tr>
738
-
739
- <tr>
740
- <td rowspan="1" colSpan="1" >GiftStore</td>
741
-
742
- <td rowspan="1" colSpan="1" >Fetch gift list, send/receive gifts, listen for gift events (including sender and gift details).</td>
743
-
744
- <td rowspan="1" colSpan="1" >[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/giftstore)</td>
745
- </tr>
746
-
747
- <tr>
748
- <td rowspan="1" colSpan="1" >BarrageStore</td>
749
-
750
- <td rowspan="1" colSpan="1" >Send text/custom barrage, maintain barrage list, listen to barrage status in real time.</td>
751
-
752
- <td rowspan="1" colSpan="1" >[API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore)</td>
753
- </tr>
754
- </table>
755
-
373
+ | **Store/Component** | **Feature Description** | **API Documentation** |
374
+ | --- | --- | --- |
375
+ | GiftStore | Fetch gift list, send/receive gifts, listen for gift events (including sender and gift details). | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/giftstore) |
376
+ | BarrageStore | Send text/custom barrage, maintain barrage list, listen to barrage status in real time. | [API Documentation](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore) |
756
377
 
757
378
  ## FAQs
758
379
 
@@ -769,7 +390,6 @@ Use the `GiftStore.setLanguage(language: String)` API before calling `refreshUsa
769
390
  The `onReceiveGift` event is broadcast to all room members, including the sender. If you update the UI both in the sendGift completion callback and in the `onReceiveGift` event, the animation will play twice.
770
391
  - **Best Practice**: Only update the UI (e.g., play animations, show barrage) in the `onReceiveGift` event handler. Use the `sendGift` completion callback only for handling failures (such as "Send failed" or "Insufficient balance").
771
392
 
772
-
773
393
  ### Where is the gift deduction logic implemented?
774
394
 
775
395
  Gift deduction is handled entirely by your billing system. AtomicXCore integrates with your billing system via a backend callback. When the client calls `sendGift`, your backend performs the deduction. After returning the result to the AtomicXCore backend, it determines whether to broadcast the gift event.
@@ -780,4 +400,4 @@ No. Gift notifications (`onReceiveGift` events) are not affected by mute or freq
780
400
 
781
401
  ### What should I do if gift animation playback stutters?
782
402
 
783
- Check your SVGA file size; the basic player recommends files no larger than 10MB. For large or complex animations, consider integrating the **Gift AR** provided by TUILiveKit for improved performance.
403
+ Check your SVGA file size; the basic player recommends files no larger than 10MB. For large or complex animations, consider integrating the **Gift AR** provided by TUILiveKit for improved performance.