@tencent-rtc/mcp 1.3.9 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (435) 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/common/record_skill_session.js +58 -0
  201. package/tools/common/record_skill_session.js.map +1 -0
  202. package/tools/definitions/get_callkit_api_def.js +29 -0
  203. package/tools/definitions/get_callkit_api_def.js.map +1 -0
  204. package/tools/definitions/get_faq_def.js +17 -18
  205. package/tools/definitions/get_faq_def.js.map +1 -1
  206. package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
  207. package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
  208. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
  209. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
  210. package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -41
  211. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
  212. package/tools/definitions/get_native_livekit_core_features_def.js +34 -0
  213. package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
  214. package/tools/definitions/get_native_livekit_core_integration_def.js +34 -0
  215. package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
  216. package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
  217. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
  218. package/tools/definitions/get_usersig_def.js +17 -22
  219. package/tools/definitions/get_usersig_def.js.map +1 -1
  220. package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
  221. package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
  222. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
  223. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
  224. package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
  225. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
  226. package/tools/definitions/get_web_live_uikit_integration_def.js +15 -18
  227. package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
  228. package/tools/definitions/get_web_livekit_api_def.js +30 -0
  229. package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
  230. package/tools/definitions/get_web_livekit_component_detail_def.js +32 -0
  231. package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
  232. package/tools/definitions/get_web_room_uikit_integration_def.js +15 -46
  233. package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
  234. package/tools/definitions/get_web_roomkit_feature_detail_def.js +31 -0
  235. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
  236. package/tools/definitions/get_web_trtc_sdk_api_def.js +27 -0
  237. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
  238. package/tools/definitions/get_web_trtc_sdk_integration_def.js +27 -0
  239. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
  240. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +27 -0
  241. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
  242. package/tools/definitions/present_framework_choice_def.js +24 -12
  243. package/tools/definitions/present_framework_choice_def.js.map +1 -1
  244. package/tools/definitions/record_skill_session_def.js +31 -0
  245. package/tools/definitions/record_skill_session_def.js.map +1 -0
  246. package/tools/index.js +49 -61
  247. package/tools/index.js.map +1 -1
  248. package/tools/live/get_native_livekit_core_features.js +65 -0
  249. package/tools/live/get_native_livekit_core_features.js.map +1 -0
  250. package/tools/live/get_native_livekit_core_integration.js +59 -0
  251. package/tools/live/get_native_livekit_core_integration.js.map +1 -0
  252. package/tools/live/get_web_live_uikit_integration.js +48 -0
  253. package/tools/live/get_web_live_uikit_integration.js.map +1 -0
  254. package/tools/live/get_web_livekit_api.js +32 -0
  255. package/tools/live/get_web_livekit_api.js.map +1 -0
  256. package/tools/live/get_web_livekit_component_detail.js +34 -0
  257. package/tools/live/get_web_livekit_component_detail.js.map +1 -0
  258. package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
  259. package/tools/room/get_web_room_uikit_integration.js.map +1 -0
  260. package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
  261. package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
  262. package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
  263. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
  264. package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
  265. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
  266. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
  267. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
  268. package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
  269. package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
  270. package/utils/generate-structured-result.js +61 -17
  271. package/utils/generate-structured-result.js.map +1 -1
  272. package/utils/report-cls-client.js +21 -1
  273. package/utils/report-cls-client.js.map +1 -1
  274. package/utils/report-es-client.js +2 -2
  275. package/resource/doc/chatuikit/android/workflow.md +0 -713
  276. package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1371
  277. package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -932
  278. package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1119
  279. package/resource/doc/chatuikit/flutter/workflow.md +0 -941
  280. package/resource/doc/chatuikit/react/components/conversation-list.md +0 -1017
  281. package/resource/doc/chatuikit/react/components/search.md +0 -745
  282. package/resource/doc/chatuikit/react/create-group.md +0 -23
  283. package/resource/doc/chatuikit/react/init.md +0 -26
  284. package/resource/doc/chatuikit/react/workflow.md +0 -258
  285. package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
  286. package/resource/doc/chatuikit/vue/create-group.md +0 -25
  287. package/resource/doc/chatuikit/vue/init.md +0 -40
  288. package/resource/doc/chatuikit/vue/workflow.md +0 -395
  289. package/resource/doc/livekit/live/android/workflow.md +0 -320
  290. package/resource/doc/livekit/live/flutter/workflow.md +0 -353
  291. package/resource/doc/livekit/live/ios/workflow.md +0 -454
  292. package/resource/doc/livekit/live/vue/components/barrage.md +0 -616
  293. package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -446
  294. package/resource/doc/livekit/live/vue/faq.md +0 -0
  295. package/resource/doc/livekit/live/vue/live-list-integration.md +0 -200
  296. package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -269
  297. package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -269
  298. package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -595
  299. package/resource/doc/livekit/live/vue/states/live-state.md +0 -3591
  300. package/resource/doc/livekit/live/vue/workflow.md +0 -218
  301. package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -312
  302. package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -430
  303. package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -679
  304. package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -671
  305. package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -271
  306. package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
  307. package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
  308. package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
  309. package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
  310. package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -865
  311. package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -657
  312. package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -437
  313. package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -335
  314. package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
  315. package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -327
  316. package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -507
  317. package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
  318. package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -659
  319. package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
  320. package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -814
  321. package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1000
  322. package/resource/doc/roomkit/vue/features/workflow.md +0 -553
  323. package/resource/doc/roomkit/vue/workflow.md +0 -733
  324. package/resource/doc/tuicallkit/android/workflow.md +0 -441
  325. package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -784
  326. package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -610
  327. package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -938
  328. package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -897
  329. package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -469
  330. package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -781
  331. package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -398
  332. package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
  333. package/resource/doc/tuicallkit/react/api.md +0 -1404
  334. package/resource/doc/tuicallkit/vue/api.md +0 -1406
  335. package/resource/doc/tuicallkit/vue/faq.md +0 -36
  336. package/tools/call/get-native-call-integration.js +0 -43
  337. package/tools/call/get-native-call-integration.js.map +0 -1
  338. package/tools/call/get-web-call-api.js +0 -27
  339. package/tools/call/get-web-call-api.js.map +0 -1
  340. package/tools/call/get-web-call-integration.js.map +0 -1
  341. package/tools/chat/get-native-chat-feature-detail.js +0 -30
  342. package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
  343. package/tools/chat/get-native-chat-integration.js +0 -45
  344. package/tools/chat/get-native-chat-integration.js.map +0 -1
  345. package/tools/chat/get-web-chat-component-detail.js +0 -31
  346. package/tools/chat/get-web-chat-component-detail.js.map +0 -1
  347. package/tools/chat/get-web-chat-integration.js +0 -45
  348. package/tools/chat/get-web-chat-integration.js.map +0 -1
  349. package/tools/chat/get-web-chat-uikit-init.js +0 -28
  350. package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
  351. package/tools/chat/get-web-create-group-doc.js +0 -28
  352. package/tools/chat/get-web-create-group-doc.js.map +0 -1
  353. package/tools/common/get-faq.js +0 -91
  354. package/tools/common/get-faq.js.map +0 -1
  355. package/tools/common/get-usersig.js.map +0 -1
  356. package/tools/common/present-framework-choice.js +0 -16
  357. package/tools/common/present-framework-choice.js.map +0 -1
  358. package/tools/common/present-scenario-choice.js +0 -16
  359. package/tools/common/present-scenario-choice.js.map +0 -1
  360. package/tools/common/record-prompt.js +0 -55
  361. package/tools/common/record-prompt.js.map +0 -1
  362. package/tools/common/record-result.js +0 -60
  363. package/tools/common/record-result.js.map +0 -1
  364. package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
  365. package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
  366. package/tools/definitions/get_native_live_api_def.js +0 -23
  367. package/tools/definitions/get_native_live_api_def.js.map +0 -1
  368. package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -87
  369. package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
  370. package/tools/definitions/get_native_live_uikit_integration_def.js +0 -75
  371. package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
  372. package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
  373. package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
  374. package/tools/definitions/get_trtc_native_api_def.js +0 -16
  375. package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
  376. package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
  377. package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
  378. package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
  379. package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
  380. package/tools/definitions/get_web_create_group_doc_def.js +0 -18
  381. package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
  382. package/tools/definitions/get_web_live_state_detail_def.js +0 -19
  383. package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
  384. package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
  385. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
  386. package/tools/definitions/get_web_room_feature_detail_def.js +0 -92
  387. package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
  388. package/tools/definitions/get_web_room_state_detail_def.js +0 -19
  389. package/tools/definitions/get_web_room_state_detail_def.js.map +0 -1
  390. package/tools/definitions/present_scenario_choice_def.js +0 -53
  391. package/tools/definitions/present_scenario_choice_def.js.map +0 -1
  392. package/tools/definitions/record_prompt_def.js +0 -58
  393. package/tools/definitions/record_prompt_def.js.map +0 -1
  394. package/tools/definitions/record_result_def.js +0 -46
  395. package/tools/definitions/record_result_def.js.map +0 -1
  396. package/tools/live/get-native-live-uikit-integration.js +0 -177
  397. package/tools/live/get-native-live-uikit-integration.js.map +0 -1
  398. package/tools/live/get-web-live-component-detail.js +0 -31
  399. package/tools/live/get-web-live-component-detail.js.map +0 -1
  400. package/tools/live/get-web-live-state-detail.js +0 -31
  401. package/tools/live/get-web-live-state-detail.js.map +0 -1
  402. package/tools/live/get-web-live-uikit-integration.js +0 -52
  403. package/tools/live/get-web-live-uikit-integration.js.map +0 -1
  404. package/tools/live/get_native_live_uikit_extra_features.js +0 -105
  405. package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
  406. package/tools/live/get_native_live_uikit_interaction.js +0 -194
  407. package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
  408. package/tools/native_live/get-native-live-api.js +0 -31
  409. package/tools/native_live/get-native-live-api.js.map +0 -1
  410. package/tools/room/get-web-room-feature-detail.js.map +0 -1
  411. package/tools/room/get-web-room-integration.js.map +0 -1
  412. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
  413. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
  414. package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
  415. package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
  416. package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
  417. package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
  418. package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
  419. package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
  420. package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
  421. package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
  422. package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
  423. package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
  424. package/tools/trtc/get-trtc-native-api.js +0 -31
  425. package/tools/trtc/get-trtc-native-api.js.map +0 -1
  426. package/utils/handle-component-name.js +0 -33
  427. package/utils/handle-component-name.js.map +0 -1
  428. /package/resource/doc/{chatuikit/iOS/workflow.md → callkit/core-sdk/.gitkeep} +0 -0
  429. /package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +0 -0
  430. /package/resource/doc/{tuicallkit/react/faq.md → callkit/faq/web-faq.md} +0 -0
  431. /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
  432. /package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +0 -0
  433. /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
  434. /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
  435. /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/7b61daa5c6bc11f0b011525400bf7822.png)</td>
13
-
14
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/7afa1bb7c6bc11f0a93d52540044a08e.png)</td>
15
-
16
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/7b633146c6bc11f09e745254007c27c5.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 Broadcast:** Receive real-time gift events in the room for displaying gift 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" >`data class`</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" >`data class`</td>
51
-
52
- <td rowspan="1" colSpan="1" >Represents a gift category (e.g., "Popular", "Luxury"). Contains the category name and a list of Gift objects.</td>
53
- </tr>
54
-
55
- <tr>
56
- <td rowspan="1" colSpan="1" >`GiftState`</td>
57
-
58
- <td rowspan="1" colSpan="1" >`data class`</td>
59
-
60
- <td rowspan="1" colSpan="1" >Represents the current state of the gift module. 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" >`abstract class`</td>
67
-
68
- <td rowspan="1" colSpan="1" >Defines the event listener for gift events in the live room. Currently, only onReceiveGift is available; all users in the room receive this event when any user sends a gift.</td>
69
- </tr>
70
-
71
- <tr>
72
- <td rowspan="1" colSpan="1" >`GiftStore`</td>
73
-
74
- <td rowspan="1" colSpan="1" >`abstract class`</td>
75
-
76
- <td rowspan="1" colSpan="1" >The core management class for gift features. Use it to fetch the gift list, send gifts, and receive gift events via listeners.</td>
77
- </tr>
78
- </table>
79
-
14
+ | **Core Concept** | **Type** | **Core Responsibilities & Description** |
15
+ | --- | --- | --- |
16
+ | `Gift` | `data class` | Represents a gift data model, including ID, name, icon URL, animation resource URL (resourceURL), price (coins), and more. |
17
+ | `GiftCategory` | `data class` | Represents a gift category (e.g., "Popular", "Luxury"). Contains the category name and a list of Gift objects. |
18
+ | `GiftState` | `data class` | Represents the current state of the gift module. The core property, usableGifts, is a StateFlow containing the full gift list from the server. |
19
+ | `GiftEvent` | `abstract class` | Defines the event listener for gift events in the live room. Currently, only onReceiveGift is available; all users in the room receive this event when any user sends a gift. |
20
+ | `GiftStore` | `abstract class` | The core management class for gift features. Use it to fetch the gift list, send gifts, and receive gift events via listeners. |
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/194571606056804352) 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/194571595678187521) 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,7 +44,6 @@ Obtain a `GiftStore` instance and set up listeners to receive gift events and up
104
44
 
105
45
  3. **Subscribe to State**: Subscribe to `giftStore.giftState.usableGifts`to receive gift list updates.
106
46
 
107
-
108
47
  #### Code Example
109
48
  ``` kotlin
110
49
  import io.trtc.tuikit.atomicxcore.api.gift.Gift
@@ -156,132 +95,26 @@ class GiftManager(
156
95
  #### Gift List Structure Parameters
157
96
  - **GiftCategory Parameter Description**
158
97
 
159
- <table>
160
- <tr>
161
- <td rowspan="1" colSpan="1" >**Parameter**</td>
162
-
163
- <td rowspan="1" colSpan="1" >**Type**</td>
164
-
165
- <td rowspan="1" colSpan="1" >**Description**</td>
166
- </tr>
167
-
168
- <tr>
169
- <td rowspan="1" colSpan="1" >`categoryID`</td>
170
-
171
- <td rowspan="1" colSpan="1" >`String`</td>
172
-
173
- <td rowspan="1" colSpan="1" >Unique ID of the gift category.</td>
174
- </tr>
175
-
176
- <tr>
177
- <td rowspan="1" colSpan="1" >`name`</td>
178
-
179
- <td rowspan="1" colSpan="1" >`String`</td>
180
-
181
- <td rowspan="1" colSpan="1" >Display name of the gift category.</td>
182
- </tr>
183
-
184
- <tr>
185
- <td rowspan="1" colSpan="1" >`desc`</td>
186
-
187
- <td rowspan="1" colSpan="1" >`String`</td>
188
-
189
- <td rowspan="1" colSpan="1" >Description of the gift category.</td>
190
- </tr>
191
-
192
- <tr>
193
- <td rowspan="1" colSpan="1" >`extensionInfo`</td>
194
-
195
- <td rowspan="1" colSpan="1" >`Map<String, String>`</td>
196
-
197
- <td rowspan="1" colSpan="1" >Extension information field.</td>
198
- </tr>
199
-
200
- <tr>
201
- <td rowspan="1" colSpan="1" >`giftList`</td>
202
-
203
- <td rowspan="1" colSpan="1" >`List`</td>
204
-
205
- <td rowspan="1" colSpan="1" >Array of Gift objects in this category.</td>
206
- </tr>
207
- </table>
98
+ | **Parameter** | **Type** | **Description** |
99
+ | --- | --- | --- |
100
+ | `categoryID` | `String` | Unique ID of the gift category. |
101
+ | `name` | `String` | Display name of the gift category. |
102
+ | `desc` | `String` | Description of the gift category. |
103
+ | `extensionInfo` | `Map<String, String>` | Extension information field. |
104
+ | `giftList` | `List` | Array of Gift objects in this category. |
208
105
 
209
106
  - **Gift Parameter Description**
210
107
 
211
- <table>
212
- <tr>
213
- <td rowspan="1" colSpan="1" >**Parameter**</td>
214
-
215
- <td rowspan="1" colSpan="1" >**Type**</td>
216
-
217
- <td rowspan="1" colSpan="1" >**Description**</td>
218
- </tr>
219
-
220
- <tr>
221
- <td rowspan="1" colSpan="1" >`giftID`</td>
222
-
223
- <td rowspan="1" colSpan="1" >`String`</td>
224
-
225
- <td rowspan="1" colSpan="1" >Unique ID of the gift.</td>
226
- </tr>
227
-
228
- <tr>
229
- <td rowspan="1" colSpan="1" >`name`</td>
230
-
231
- <td rowspan="1" colSpan="1" >`String`</td>
232
-
233
- <td rowspan="1" colSpan="1" >Display name of the gift.</td>
234
- </tr>
235
-
236
- <tr>
237
- <td rowspan="1" colSpan="1" >`desc`</td>
238
-
239
- <td rowspan="1" colSpan="1" >`String`</td>
240
-
241
- <td rowspan="1" colSpan="1" >Description of the gift.</td>
242
- </tr>
243
-
244
- <tr>
245
- <td rowspan="1" colSpan="1" >`iconURL`</td>
246
-
247
- <td rowspan="1" colSpan="1" >`String`</td>
248
-
249
- <td rowspan="1" colSpan="1" >Gift icon URL.</td>
250
- </tr>
251
-
252
- <tr>
253
- <td rowspan="1" colSpan="1" >`resourceURL`</td>
254
-
255
- <td rowspan="1" colSpan="1" >`String`</td>
256
-
257
- <td rowspan="1" colSpan="1" >Gift animation resource URL.</td>
258
- </tr>
259
-
260
- <tr>
261
- <td rowspan="1" colSpan="1" >`level`</td>
262
-
263
- <td rowspan="1" colSpan="1" >`Long`</td>
264
-
265
- <td rowspan="1" colSpan="1" >Gift level.</td>
266
- </tr>
267
-
268
- <tr>
269
- <td rowspan="1" colSpan="1" >`coins`</td>
270
-
271
- <td rowspan="1" colSpan="1" >`Long`</td>
272
-
273
- <td rowspan="1" colSpan="1" >Gift price.</td>
274
- </tr>
275
-
276
- <tr>
277
- <td rowspan="1" colSpan="1" >`extensionInfo`</td>
278
-
279
- <td rowspan="1" colSpan="1" >`Map<String, String>`</td>
280
-
281
- <td rowspan="1" colSpan="1" >Extension information field.</td>
282
- </tr>
283
- </table>
284
-
108
+ | **Parameter** | **Type** | **Description** |
109
+ | --- | --- | --- |
110
+ | `giftID` | `String` | Unique ID of the gift. |
111
+ | `name` | `String` | Display name of the gift. |
112
+ | `desc` | `String` | Description of the gift. |
113
+ | `iconURL` | `String` | Gift icon URL. |
114
+ | `resourceURL` | `String` | Gift animation resource URL. |
115
+ | `level` | `Long` | Gift level. |
116
+ | `coins` | `Long` | Gift price. |
117
+ | `extensionInfo` | `Map<String, String>` | Extension information field. |
285
118
 
286
119
  ### Step 3: Retrieve Gift List
287
120
 
@@ -294,7 +127,6 @@ Call the `refreshUsableGifts` method to fetch gift data from the server.
294
127
 
295
128
  3. **Receive Data**: After a successful fetch, the updated usableGifts list is delivered automatically via your subscription to `giftStore.giftState.usableGifts`.
296
129
 
297
-
298
130
  #### Code Example
299
131
  ``` kotlin
300
132
  class GiftManager(
@@ -329,7 +161,6 @@ When a user selects a gift and clicks send, call the `sendGift` API.
329
161
 
330
162
  3. **Handle Callback**: Use the completion `callback` to handle failures (e.g., insufficient balance). UI updates (animations, barrage) after a successful send should be triggered by the `onReceiveGift` event.
331
163
 
332
-
333
164
  #### Code Example
334
165
  ``` kotlin
335
166
  class GiftManager(
@@ -355,40 +186,11 @@ class GiftManager(
355
186
  ```
356
187
 
357
188
  #### **sendGift API Parameters**
358
- <table>
359
- <tr>
360
- <td rowspan="1" colSpan="1" >**Parameter Name**</td>
361
-
362
- <td rowspan="1" colSpan="1" >**Type**</td>
363
-
364
- <td rowspan="1" colSpan="1" >**Description**</td>
365
- </tr>
366
-
367
- <tr>
368
- <td rowspan="1" colSpan="1" >`giftID`</td>
369
-
370
- <td rowspan="1" colSpan="1" >`String`</td>
371
-
372
- <td rowspan="1" colSpan="1" >Unique ID of the gift to send.</td>
373
- </tr>
374
-
375
- <tr>
376
- <td rowspan="1" colSpan="1" >`count`</td>
377
-
378
- <td rowspan="1" colSpan="1" >`Int`</td>
379
-
380
- <td rowspan="1" colSpan="1" >Number of gifts to send.</td>
381
- </tr>
382
-
383
- <tr>
384
- <td rowspan="1" colSpan="1" >`completion`</td>
385
-
386
- <td rowspan="1" colSpan="1" >`CompletionHandler?`</td>
387
-
388
- <td rowspan="1" colSpan="1" >Callback invoked after sending completes.</td>
389
- </tr>
390
- </table>
391
-
189
+ | **Parameter Name** | **Type** | **Description** |
190
+ | --- | --- | --- |
191
+ | `giftID` | `String` | Unique ID of the gift to send. |
192
+ | `count` | `Int` | Number of gifts to send. |
193
+ | `completion` | `CompletionHandler?` | Callback invoked after sending completes. |
392
194
 
393
195
  ## Advanced Features
394
196
 
@@ -399,134 +201,39 @@ The capabilities of `GiftStore` are closely tied to your backend services. This
399
201
  Customize available gift types, categories, names, icons, prices, and animation effects to meet your operational and branding requirements.
400
202
 
401
203
  #### Implementation
402
- 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).
204
+ 1. **Server-Side Configuration**: Use the `LiveKit` server REST API to manage gift information, categories, and multi-language support. See the Gift Configuration Guide.
403
205
 
404
206
  2. **Client Fetch**: On the client, call `refreshUsableGifts` to retrieve configuration data.
405
207
 
406
208
  3. **UI Display**: Use the retrieved `List<GiftCategory>` to populate the gift panel.
407
209
 
408
-
409
210
  #### Configuration Sequence Diagram
410
211
 
411
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/8c76ea1ec6bc11f0aedb525400454e06.png)
412
-
413
-
414
212
  #### Related REST API Interfaces Overview
415
- <table>
416
- <tr>
417
- <td rowspan="1" colSpan="1" >**Interface Category**</td>
418
-
419
- <td rowspan="1" colSpan="1" >**Interface**</td>
420
-
421
- <td rowspan="1" colSpan="1" >**Request Example**</td>
422
- </tr>
423
-
424
- <tr>
425
- <td rowspan="3" colSpan="1" >**​Gift Management**</td>
426
-
427
- <td rowspan="1" colSpan="1" >Add Gift Information</td>
428
-
429
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185130814885187584)</td>
430
- </tr>
431
-
432
- <tr>
433
- <td rowspan="1" colSpan="1" >Delete Gift Information</td>
434
-
435
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131021432451072)</td>
436
- </tr>
437
-
438
- <tr>
439
- <td rowspan="1" colSpan="1" >Query Gift Information</td>
440
-
441
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185130925608591360)</td>
442
- </tr>
443
-
444
- <tr>
445
- <td rowspan="3" colSpan="1" >**Gift Category Management**</td>
446
-
447
- <td rowspan="1" colSpan="1" >Add Gift Category Information</td>
448
-
449
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131054187974656)</td>
450
- </tr>
451
-
452
- <tr>
453
- <td rowspan="1" colSpan="1" >Delete Specific Gift Category Information</td>
454
-
455
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131288984932352)</td>
456
- </tr>
457
-
458
- <tr>
459
- <td rowspan="1" colSpan="1" >Get Specific Gift Category Information</td>
460
-
461
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131164168736768)</td>
462
- </tr>
463
-
464
- <tr>
465
- <td rowspan="3" colSpan="1" >**Gift Relationship Management**</td>
466
-
467
- <td rowspan="1" colSpan="1" >Add Relationship between a Specific Gift Category and Gift</td>
468
-
469
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131388068356096)</td>
470
- </tr>
471
-
472
- <tr>
473
- <td rowspan="1" colSpan="1" >Delete Relationship between a Specific Gift Category and Gift</td>
474
-
475
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131491225227264)</td>
476
- </tr>
477
-
478
- <tr>
479
- <td rowspan="1" colSpan="1" >Get Gift Relationships under a Specific Gift Category</td>
480
-
481
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131634710056960)</td>
482
- </tr>
483
-
484
- <tr>
485
- <td rowspan="6" colSpan="1" >**Gift Multi-language Management**</td>
486
-
487
- <td rowspan="1" colSpan="1" >Add Gift Multi-language Information</td>
488
-
489
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131766094020608)</td>
490
- </tr>
491
-
492
- <tr>
493
- <td rowspan="1" colSpan="1" >Delete Specific Gift Multi-language Information</td>
494
-
495
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185132041665441792)</td>
496
- </tr>
497
-
498
- <tr>
499
- <td rowspan="1" colSpan="1" >Get Gift Multi-language Information</td>
500
-
501
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185131910582956032)</td>
502
- </tr>
503
-
504
- <tr>
505
- <td rowspan="1" colSpan="1" >Add Gift Category Multi-language Information</td>
506
-
507
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185132145524985856)</td>
508
- </tr>
509
-
510
- <tr>
511
- <td rowspan="1" colSpan="1" >Delete Specific Gift Category Multi-language Information</td>
512
-
513
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185132396568891392)</td>
514
- </tr>
515
-
516
- <tr>
517
- <td rowspan="1" colSpan="1" >Get Gift Category Multi-language Information</td>
518
-
519
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/185132283123777536)</td>
520
- </tr>
521
- </table>
522
-
213
+ | **Interface Category** | **Interface** | **Request Example** |
214
+ | --- | --- | --- |
215
+ | **​Gift Management** | Add Gift Information | Example |
216
+ | Delete Gift Information | Example | |
217
+ | Query Gift Information | Example | |
218
+ | **Gift Category Management** | Add Gift Category Information | Example |
219
+ | Delete Specific Gift Category Information | Example | |
220
+ | Get Specific Gift Category Information | Example | |
221
+ | **Gift Relationship Management** | Add Relationship between a Specific Gift Category and Gift | Example |
222
+ | Delete Relationship between a Specific Gift Category and Gift | Example | |
223
+ | Get Gift Relationships under a Specific Gift Category | Example | |
224
+ | **Gift Multi-language Management** | Add Gift Multi-language Information | Example |
225
+ | Delete Specific Gift Multi-language Information | Example | |
226
+ | Get Gift Multi-language Information | Example | |
227
+ | Add Gift Category Multi-language Information | Example | |
228
+ | Delete Specific Gift Category Multi-language Information | Example | |
229
+ | Get Gift Category Multi-language Information | Example | |
523
230
 
524
231
  ### Billing and Gift Deduction Process
525
232
 
526
233
  When a viewer sends a gift, ensure their account balance is sufficient and complete the deduction before triggering the gift effect playback and broadcast.
527
234
 
528
235
  #### Implementation
529
- 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).
236
+ 1. **Backend Callback Configuration**: Configure your billing system's callback URL in the LiveKit backend. See Callback Configuration Documentation.
530
237
 
531
238
  2. **Client Send**: The client calls `sendGift`.
532
239
 
@@ -534,31 +241,12 @@ When a viewer sends a gift, ensure their account balance is sufficient and compl
534
241
 
535
242
  4. **Result Synchronization**: If successful, **AtomicXCore** broadcasts the `onReceiveGift` event; if failed, the completion callback of sendGift receives an error.
536
243
 
537
-
538
244
  #### Call Flow
539
245
 
540
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/997f5343c6bc11f0a93d52540044a08e.png)
541
-
542
-
543
246
  #### Related REST API Interfaces Overview
544
- <table>
545
- <tr>
546
- <td rowspan="1" colSpan="1" >**Interface**</td>
547
-
548
- <td rowspan="1" colSpan="1" >**Description**</td>
549
-
550
- <td rowspan="1" colSpan="1" >**Request Example**</td>
551
- </tr>
552
-
553
- <tr>
554
- <td rowspan="1" colSpan="1" >**Callback Configuration - Callback before sending a gift**</td>
555
-
556
- <td rowspan="1" colSpan="1" >The customer's backend can use this callback to decide whether to pass pre-gifting checks, etc.</td>
557
-
558
- <td rowspan="1" colSpan="1" >[Example](https://write.woa.com/document/183772991768039424)</td>
559
- </tr>
560
- </table>
561
-
247
+ | **Interface** | **Description** | **Request Example** |
248
+ | --- | --- | --- |
249
+ | **Callback Configuration - Callback before sending a gift** | The customer's backend can use this callback to decide whether to pass pre-gifting checks, etc. | Example |
562
250
 
563
251
  ### Implement Full-Screen Gift Animation Playback
564
252
 
@@ -567,56 +255,13 @@ When a user sends a luxury gift (e.g., "Rocket", "Carnival"), play a full-screen
567
255
  #### Implementation
568
256
 
569
257
  **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:
570
- <table>
571
- <tr>
572
- <td rowspan="1" colSpan="1" >**Comparison Item**</td>
573
-
574
- <td rowspan="1" colSpan="1" >**Basic Solution (SVGAPlayer)**</td>
575
-
576
- <td rowspan="1" colSpan="1" >**Gift AR (TCEffectPlayerKit)**</td>
577
- </tr>
578
-
579
- <tr>
580
- <td rowspan="1" colSpan="1" >Billing</td>
581
-
582
- <td rowspan="1" colSpan="1" >Free (open source)</td>
583
-
584
- <td rowspan="1" colSpan="1" >Paid (requires license). See [Billing Guide](https://trtc.io/document/69949?product=beautyar&menulabel=core%20sdk&platform=android#X-Series-Capabilities)</td>
585
- </tr>
586
-
587
- <tr>
588
- <td rowspan="1" colSpan="1" >Integration Method</td>
589
-
590
- <td rowspan="1" colSpan="1" >Manual integration via Gradle</td>
591
-
592
- <td rowspan="1" colSpan="1" >Requires additional integration and authentication</td>
593
- </tr>
594
-
595
- <tr>
596
- <td rowspan="1" colSpan="1" >Supported Animation Formats</td>
597
-
598
- <td rowspan="1" colSpan="1" >SVGA only</td>
599
-
600
- <td rowspan="1" colSpan="1" >SVGA, PAG, WebP, Lottie, MP4, and more</td>
601
- </tr>
602
-
603
- <tr>
604
- <td rowspan="1" colSpan="1" >Performance</td>
605
-
606
- <td rowspan="1" colSpan="1" >Recommended SVGA file size ≤ 10MB</td>
607
-
608
- <td rowspan="1" colSpan="1" >Supports larger files, better performance for complex/multiple/low-end scenarios</td>
609
- </tr>
610
-
611
- <tr>
612
- <td rowspan="1" colSpan="1" >Recommended Scenario</td>
613
-
614
- <td rowspan="1" colSpan="1" >Uniform SVGA format, controllable file size</td>
615
-
616
- <td rowspan="1" colSpan="1" >Multiple formats or higher performance/device compatibility needs</td>
617
- </tr>
618
- </table>
619
-
258
+ | **Comparison Item** | **Basic Solution (SVGAPlayer)** | **Gift AR (TCEffectPlayerKit)** |
259
+ | --- | --- | --- |
260
+ | Billing | Free (open source) | Paid (requires license). See [Billing Guide](https://trtc.io/document/69949?product=beautyar&menulabel=core%20sdk&platform=android#X-Series-Capabilities) |
261
+ | Integration Method | Manual integration via Gradle | Requires additional integration and authentication |
262
+ | Supported Animation Formats | SVGA only | SVGA, PAG, WebP, Lottie, MP4, and more |
263
+ | Performance | Recommended SVGA file size ≤ 10MB | Supports larger files, better performance for complex/multiple/low-end scenarios |
264
+ | Recommended Scenario | Uniform SVGA format, controllable file size | Multiple formats or higher performance/device compatibility needs |
620
265
 
621
266
  This section demonstrates the basic solution. For the **Gift AR** see the [TCEffectPlayer Integration Guide](https://trtc.io/document/70531?product=beautyar&menulabel=core%20sdk&platform=android).
622
267
 
@@ -633,7 +278,6 @@ This section demonstrates the basic solution. For the **Gift AR** see the [TCEff
633
278
 
634
279
  3. **Parse and Play**: On `onReceiveGift`, check if `gift.resourceURL` is a valid SVGA file. Use `SVGAParser` to parse and play the animation.
635
280
 
636
-
637
281
  #### Code Example
638
282
  ``` kotlin
639
283
  import android.os.Bundle
@@ -657,9 +301,9 @@ class LiveRoomActivity : AppCompatActivity() {
657
301
  super.onCreate(savedInstanceState)
658
302
  setContentView(R.layout.activity_live_room)
659
303
  setupSVGAPlayer()
660
-
304
+
661
305
  svgaImageView.loops = 1
662
-
306
+
663
307
  svgaImageView.callback = object : SVGACallback {
664
308
  override fun onFinished() {
665
309
  svgaImageView.visibility = android.view.View.GONE
@@ -694,7 +338,7 @@ class LiveRoomActivity : AppCompatActivity() {
694
338
  }
695
339
  })
696
340
  }
697
-
341
+
698
342
  private fun playAnimation(url: URL) {
699
343
  svgaParser.decodeFromURL(url, object : SVGAParser.ParseCompletion {
700
344
  override fun onComplete(videoItem: SVGAVideoEntity) {
@@ -704,7 +348,7 @@ class LiveRoomActivity : AppCompatActivity() {
704
348
  svgaImageView.startAnimation()
705
349
  }
706
350
  }
707
-
351
+
708
352
  override fun onError() {
709
353
  println("SVGA animation parsing failed")
710
354
  // Optionally add retry or error reporting
@@ -729,7 +373,6 @@ When a user sends a gift, display a system message in the public barrage area (e
729
373
 
730
374
  5. **Insert Locally**: Call `barrageStore.appendLocalTip(message: giftTip)` to add the message to the local barrage list.
731
375
 
732
-
733
376
  #### Code Example
734
377
  ``` kotlin
735
378
  import io.trtc.tuikit.atomicxcore.api.barrage.Barrage
@@ -766,32 +409,10 @@ class LiveRoomManager(
766
409
  ## API Documentation
767
410
 
768
411
  For complete details on all public interfaces, properties, and methods of [GiftStore](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.gift/-gift-store/index.html) and related classes, see the official API documentation for [AtomicXCore](https://tencent-rtc.github.io/TUIKit_Android/index.html). Key stores referenced in this guide include:
769
- <table>
770
- <tr>
771
- <td rowspan="1" colSpan="1" >**Store/Component**</td>
772
-
773
- <td rowspan="1" colSpan="1" >**Feature Description**</td>
774
-
775
- <td rowspan="1" colSpan="1" >**API Documentation**</td>
776
- </tr>
777
-
778
- <tr>
779
- <td rowspan="1" colSpan="1" >GiftStore</td>
780
-
781
- <td rowspan="1" colSpan="1" >Gift interactions: fetch gift list, send/receive gifts, listen for gift events (including sender and gift details).</td>
782
-
783
- <td rowspan="1" colSpan="1" >[API Documentation](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.gift/-gift-store/index.html)</td>
784
- </tr>
785
-
786
- <tr>
787
- <td rowspan="1" colSpan="1" >BarrageStore</td>
788
-
789
- <td rowspan="1" colSpan="1" >Barrage features: send text/custom barrage, maintain barrage list, listen to barrage status in real time.</td>
790
-
791
- <td rowspan="1" colSpan="1" >[API Documentation](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.barrage/-barrage-store/index.html)</td>
792
- </tr>
793
- </table>
794
-
412
+ | **Store/Component** | **Feature Description** | **API Documentation** |
413
+ | --- | --- | --- |
414
+ | GiftStore | Gift interactions: fetch gift list, send/receive gifts, listen for gift events (including sender and gift details). | [API Documentation](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.gift/-gift-store/index.html) |
415
+ | BarrageStore | Barrage features: send text/custom barrage, maintain barrage list, listen to barrage status in real time. | [API Documentation](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.barrage/-barrage-store/index.html) |
795
416
 
796
417
  ## FAQs
797
418
 
@@ -808,7 +429,6 @@ Use the `GiftStore.setLanguage(language: String)` API before calling `refreshUsa
808
429
  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.
809
430
  - **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").
810
431
 
811
-
812
432
  ### Where is the gift deduction logic implemented?
813
433
 
814
434
  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.
@@ -819,4 +439,4 @@ No. Gift notifications (`onReceiveGift` events) are not affected by mute or freq
819
439
 
820
440
  ### What should I do if gift animation playback stutters?
821
441
 
822
- 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.
442
+ 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.