@tencentcloud/sdk-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 (514) hide show
  1. package/index.js +1 -1
  2. package/index.js.map +1 -1
  3. package/package.json +2 -2
  4. package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/android-faq.md} +75 -308
  5. package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +2 -2
  6. package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/flutter-faq.md} +83 -315
  7. package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/ios-faq.md} +76 -313
  8. package/resource/doc/{tuicallkit/vue/faq.md → callkit/faq/web-faq.md} +78 -311
  9. package/resource/doc/callkit/preset/android/api.md +330 -0
  10. package/resource/doc/{tuicallkit → callkit/preset}/android/integration.md +63 -420
  11. package/resource/doc/callkit/preset/flutter/api.md +401 -0
  12. package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +53 -273
  13. package/resource/doc/callkit/preset/ios/api.md +282 -0
  14. package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +39 -120
  15. package/resource/doc/callkit/preset/react/api.md +600 -0
  16. package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +6 -6
  17. package/resource/doc/callkit/preset/vue/api.md +600 -0
  18. package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +5 -5
  19. package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -37
  20. package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
  21. package/resource/doc/{chatuikit → chatkit}/android/integration.md +30 -126
  22. package/resource/doc/chatkit/faq/android_sdk/client-api.md +280 -0
  23. package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +4 -17
  24. package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -2
  25. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +183 -0
  26. package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
  27. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +279 -0
  28. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +1 -1
  29. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +4 -4
  30. package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
  31. package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +20 -95
  32. package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -37
  33. package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
  34. package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +78 -280
  35. package/resource/doc/{chatuikit/vue → chatkit/react}/components/avatar.md +0 -1
  36. package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +7 -12
  37. package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +10 -17
  38. package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +1 -1
  39. package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -1
  40. package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +122 -703
  41. package/resource/doc/chatkit/react/components/conversation-actions.md +174 -0
  42. package/resource/doc/chatkit/react/components/conversation-list.md +333 -0
  43. package/resource/doc/chatkit/react/components/conversation-preview.md +116 -0
  44. package/resource/doc/chatkit/react/components/conversation-search.md +57 -0
  45. package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -186
  46. package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +21 -113
  47. package/resource/doc/chatkit/react/components/search.md +282 -0
  48. package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +5 -26
  49. package/resource/doc/{chatuikit → chatkit}/react/integration.md +37 -104
  50. package/resource/doc/{chatuikit/react → chatkit/vue}/components/avatar.md +0 -1
  51. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -13
  52. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +13 -18
  53. package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +1 -2
  54. package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -1
  55. package/resource/doc/chatkit/vue/components/contact-list.md +271 -0
  56. package/resource/doc/chatkit/vue/components/conversation-actions.md +228 -0
  57. package/resource/doc/{chatuikit → chatkit}/vue/components/conversation-list.md +42 -316
  58. package/resource/doc/chatkit/vue/components/conversation-preview.md +213 -0
  59. package/resource/doc/chatkit/vue/components/conversation-search.md +50 -0
  60. package/resource/doc/{chatuikit → chatkit}/vue/components/message-input.md +1 -23
  61. package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -134
  62. package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
  63. package/resource/doc/chatkit/vue/components/tuikit.md +45 -0
  64. package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +4 -4
  65. package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
  66. package/resource/doc/{chatuikit → chatkit}/vue/integration.md +53 -121
  67. package/resource/doc/livekit/core-sdk/live/android/api-reference/AudioEffectStore.md +283 -0
  68. package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +148 -0
  69. package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +316 -0
  70. package/resource/doc/livekit/core-sdk/live/android/api-reference/CameraView.md +57 -0
  71. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +419 -0
  72. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +325 -0
  73. package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +436 -0
  74. package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +165 -0
  75. package/resource/doc/livekit/core-sdk/live/android/api-reference/LikeStore.md +49 -0
  76. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +239 -0
  77. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +74 -0
  78. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +417 -0
  79. package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +207 -0
  80. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +17 -88
  81. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audio-effect.md +34 -192
  82. package/resource/doc/livekit/{live → core-sdk/live}/android/live-barrage.md +26 -139
  83. package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +16 -99
  84. package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +54 -161
  85. package/resource/doc/livekit/{live → core-sdk/live}/android/live-gift.md +75 -455
  86. package/resource/doc/livekit/{live → core-sdk/live}/android/live-host-interaction.md +91 -338
  87. package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +108 -492
  88. package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +27 -165
  89. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/AudioEffectStore.md +279 -0
  90. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +158 -0
  91. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BaseBeautyStore.md +155 -0
  92. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +304 -0
  93. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +394 -0
  94. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +303 -0
  95. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +410 -0
  96. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +160 -0
  97. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LikeStore.md +51 -0
  98. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +231 -0
  99. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveCoreView.md +143 -0
  100. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +375 -0
  101. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +170 -0
  102. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +13 -91
  103. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -177
  104. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +18 -102
  105. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -164
  106. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -161
  107. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +66 -460
  108. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
  109. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-integration.md +160 -543
  110. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +22 -161
  111. package/resource/doc/livekit/core-sdk/live/ios/api-reference/AudioEffectStore.md +287 -0
  112. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +165 -0
  113. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +143 -0
  114. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +298 -0
  115. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +349 -0
  116. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +297 -0
  117. package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +471 -0
  118. package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +179 -0
  119. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LikeStore.md +49 -0
  120. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +238 -0
  121. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +74 -0
  122. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +412 -0
  123. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +173 -0
  124. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +23 -96
  125. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +33 -195
  126. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +35 -150
  127. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +20 -105
  128. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +35 -140
  129. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +77 -457
  130. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +70 -317
  131. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +90 -473
  132. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +28 -163
  133. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audience-list.md +17 -88
  134. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audio-effect.md +34 -192
  135. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-barrage.md +26 -139
  136. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-co-guest-interaction.md +53 -262
  137. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-gift.md +75 -455
  138. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-host-interaction.md +60 -272
  139. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-integration.md +63 -440
  140. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-room-list.md +23 -151
  141. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-audience-list.md +13 -91
  142. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-audio-effect.md +34 -177
  143. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-barrage.md +18 -102
  144. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-co-guest-interaction.md +44 -201
  145. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-gift.md +66 -460
  146. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-integration.md +57 -419
  147. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-room-list.md +24 -157
  148. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audience-list.md +23 -96
  149. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audio-effect.md +33 -195
  150. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-barrage.md +35 -150
  151. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-co-guest-interaction.md +45 -254
  152. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-gift.md +77 -457
  153. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-host-interaction.md +52 -261
  154. package/resource/doc/livekit/core-sdk/voice/ios/voice-integration.md +478 -0
  155. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-room-list.md +36 -167
  156. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-audience-list.md +15 -45
  157. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-audio-effect.md +23 -137
  158. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-barrage.md +25 -131
  159. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-co-guest-interaction.md +70 -366
  160. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-gift.md +70 -424
  161. package/resource/doc/livekit/core-sdk/voice/uni-app/voice-integration.md +323 -0
  162. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-room-list.md +24 -116
  163. package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -3
  164. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +780 -0
  165. package/resource/doc/livekit/preset/live/vue/components/barrage.md +291 -0
  166. package/resource/doc/livekit/{live → preset/live}/vue/components/co-guest-panel.md +9 -48
  167. package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +27 -145
  168. package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +13 -76
  169. package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +33 -224
  170. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +211 -0
  171. package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
  172. package/resource/doc/livekit/preset/live/vue/live-list-integration.md +244 -0
  173. package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +301 -0
  174. package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +307 -0
  175. package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +754 -0
  176. package/resource/doc/roomkit/android/features/call-user-to-room.md +234 -0
  177. package/resource/doc/roomkit/android/features/room-participant-state.md +850 -0
  178. package/resource/doc/roomkit/android/features/room-state.md +358 -0
  179. package/resource/doc/roomkit/android/features/schedule-room.md +336 -0
  180. package/resource/doc/roomkit/android/integration.md +433 -0
  181. package/resource/doc/roomkit/{common/error_code.md → faq/common/error-code.md} +1 -1
  182. package/resource/doc/roomkit/flutter/features/call-user-to-room.md +228 -0
  183. package/resource/doc/roomkit/flutter/features/room-participant-state.md +796 -0
  184. package/resource/doc/roomkit/flutter/features/room-state.md +324 -0
  185. package/resource/doc/roomkit/flutter/features/schedule-room.md +324 -0
  186. package/resource/doc/roomkit/flutter/integration.md +405 -0
  187. package/resource/doc/roomkit/ios/features/call-user-to-room.md +226 -0
  188. package/resource/doc/roomkit/ios/features/room-participant-state.md +821 -0
  189. package/resource/doc/roomkit/ios/features/room-state.md +320 -0
  190. package/resource/doc/roomkit/ios/features/schedule-room.md +318 -0
  191. package/resource/doc/roomkit/ios/integration.md +384 -0
  192. package/resource/doc/roomkit/vue/faq.md +1 -0
  193. package/resource/doc/roomkit/vue/features/call-user-to-room.md +17 -53
  194. package/resource/doc/roomkit/vue/features/device-detection.md +30 -48
  195. package/resource/doc/roomkit/vue/features/device-state.md +24 -44
  196. package/resource/doc/roomkit/vue/features/free-beauty-panel.md +13 -36
  197. package/resource/doc/roomkit/vue/features/room-chat.md +31 -89
  198. package/resource/doc/roomkit/vue/features/room-participant-state.md +28 -50
  199. package/resource/doc/roomkit/vue/features/room-state.md +25 -36
  200. package/resource/doc/roomkit/vue/features/room-view.md +30 -127
  201. package/resource/doc/roomkit/vue/features/schedule-room.md +9 -40
  202. package/resource/doc/roomkit/vue/features/screen-share.md +22 -90
  203. package/resource/doc/roomkit/vue/features/virtual-background.md +13 -34
  204. package/resource/doc/roomkit/vue/integration.md +21 -80
  205. package/resource/doc/rtcengine/faq/common/userSig.md +17 -141
  206. package/resource/doc/rtcengine/faq/web/web.md +15 -22
  207. package/resource/doc/rtcengine/web/api.md +17 -21
  208. package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +4 -10
  209. package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +4 -8
  210. package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +3 -3
  211. package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -3
  212. package/resource/doc/rtcengine/web/plugin/22-advanced-audio-mixer.md +6 -6
  213. package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +2 -2
  214. package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +2 -4
  215. package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +1 -2
  216. package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +2 -6
  217. package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +13 -14
  218. package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +10 -90
  219. package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -8
  220. package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +31 -35
  221. package/resource/doc/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -2
  222. package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +7 -49
  223. package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -1
  224. package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -3
  225. package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +20 -20
  226. package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +1 -1
  227. package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +4 -4
  228. package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
  229. package/resource/doc/trtc/C++/ITRTCCloud.md +718 -2847
  230. package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
  231. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +207 -1041
  232. package/resource/doc/trtc/C++/ITXDeviceManager.md +127 -768
  233. package/resource/doc/trtc/C++/TRTCCloudCallback.md +634 -2259
  234. package/resource/doc/trtc/C++/TRTCTypeDef.md +726 -3465
  235. package/resource/doc/trtc/C++/TXLiteAVCode.md +117 -916
  236. package/resource/doc/trtc/android/TRTCCloud.md +638 -2612
  237. package/resource/doc/trtc/android/TRTCCloudDef.md +769 -3697
  238. package/resource/doc/trtc/android/TRTCCloudListener.md +609 -2070
  239. package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
  240. package/resource/doc/trtc/android/TXAudioEffectManager.md +207 -1049
  241. package/resource/doc/trtc/android/TXBeautyManager.md +127 -704
  242. package/resource/doc/trtc/android/TXDeviceManager.md +51 -318
  243. package/resource/doc/trtc/android/TXLiteAVCode.md +115 -900
  244. package/resource/doc/trtc/iOS/TRTCCloud.md +726 -2930
  245. package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +580 -2099
  246. package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
  247. package/resource/doc/trtc/iOS/TXAudioEffectManager.md +179 -896
  248. package/resource/doc/trtc/iOS/TXBeautyManager.md +128 -710
  249. package/resource/doc/trtc/iOS/TXDeviceManager.md +129 -772
  250. package/resource/doc/trtc/iOS/TXLiteAVCode.md +117 -915
  251. package/resource/doc/trtc/iOS/TXLiveSDKTypeDef.md +747 -3559
  252. package/server.js +1 -5
  253. package/server.js.map +1 -1
  254. package/tools/call/get_callkit_api.js +32 -0
  255. package/tools/call/get_callkit_api.js.map +1 -0
  256. package/tools/call/get_native_call_uikit_integration.js +34 -0
  257. package/tools/call/get_native_call_uikit_integration.js.map +1 -0
  258. package/tools/call/{get-web-call-integration.js → get_web_call_uikit_integration.js} +13 -8
  259. package/tools/call/get_web_call_uikit_integration.js.map +1 -0
  260. package/tools/chat/get_native_chat_uikit_feature_detail.js +34 -0
  261. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +1 -0
  262. package/tools/chat/get_native_chat_uikit_integration.js +45 -0
  263. package/tools/chat/get_native_chat_uikit_integration.js.map +1 -0
  264. package/tools/chat/get_web_chat_uikit_component_detail.js +34 -0
  265. package/tools/chat/get_web_chat_uikit_component_detail.js.map +1 -0
  266. package/tools/chat/get_web_chat_uikit_integration.js +45 -0
  267. package/tools/chat/get_web_chat_uikit_integration.js.map +1 -0
  268. package/tools/common/get_faq.js +265 -0
  269. package/tools/common/get_faq.js.map +1 -0
  270. package/tools/common/{get-usersig.js → get_usersig.js} +6 -3
  271. package/tools/common/get_usersig.js.map +1 -0
  272. package/tools/common/present_framework_choice.js +63 -0
  273. package/tools/common/present_framework_choice.js.map +1 -0
  274. package/tools/common/record_skill_session.js +58 -0
  275. package/tools/common/record_skill_session.js.map +1 -0
  276. package/tools/definitions/get_callkit_api_def.js +28 -0
  277. package/tools/definitions/get_callkit_api_def.js.map +1 -0
  278. package/tools/definitions/get_faq_def.js +18 -19
  279. package/tools/definitions/get_faq_def.js.map +1 -1
  280. package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
  281. package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
  282. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
  283. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
  284. package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -41
  285. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
  286. package/tools/definitions/get_native_livekit_core_features_def.js +33 -0
  287. package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
  288. package/tools/definitions/get_native_livekit_core_integration_def.js +33 -0
  289. package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
  290. package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
  291. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
  292. package/tools/definitions/get_usersig_def.js +17 -24
  293. package/tools/definitions/get_usersig_def.js.map +1 -1
  294. package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
  295. package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
  296. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
  297. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
  298. package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
  299. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
  300. package/tools/definitions/get_web_live_uikit_integration_def.js +13 -18
  301. package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
  302. package/tools/definitions/get_web_livekit_api_def.js +27 -0
  303. package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
  304. package/tools/definitions/get_web_livekit_component_detail_def.js +29 -0
  305. package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
  306. package/tools/definitions/get_web_room_uikit_integration_def.js +13 -46
  307. package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
  308. package/tools/definitions/get_web_roomkit_feature_detail_def.js +30 -0
  309. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
  310. package/tools/definitions/get_web_trtc_sdk_api_def.js +25 -0
  311. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
  312. package/tools/definitions/get_web_trtc_sdk_integration_def.js +25 -0
  313. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
  314. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +25 -0
  315. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
  316. package/tools/definitions/present_framework_choice_def.js +23 -12
  317. package/tools/definitions/present_framework_choice_def.js.map +1 -1
  318. package/tools/definitions/record_skill_session_def.js +31 -0
  319. package/tools/definitions/record_skill_session_def.js.map +1 -0
  320. package/tools/index.js +49 -61
  321. package/tools/index.js.map +1 -1
  322. package/tools/live/get_native_livekit_core_features.js +65 -0
  323. package/tools/live/get_native_livekit_core_features.js.map +1 -0
  324. package/tools/live/get_native_livekit_core_integration.js +59 -0
  325. package/tools/live/get_native_livekit_core_integration.js.map +1 -0
  326. package/tools/live/get_web_live_uikit_integration.js +48 -0
  327. package/tools/live/get_web_live_uikit_integration.js.map +1 -0
  328. package/tools/live/get_web_livekit_api.js +32 -0
  329. package/tools/live/get_web_livekit_api.js.map +1 -0
  330. package/tools/live/get_web_livekit_component_detail.js +34 -0
  331. package/tools/live/get_web_livekit_component_detail.js.map +1 -0
  332. package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
  333. package/tools/room/get_web_room_uikit_integration.js.map +1 -0
  334. package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
  335. package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
  336. package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
  337. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
  338. package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
  339. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
  340. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
  341. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
  342. package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
  343. package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
  344. package/utils/generate-structured-result.js +61 -17
  345. package/utils/generate-structured-result.js.map +1 -1
  346. package/utils/report-cls-client.js +21 -1
  347. package/utils/report-cls-client.js.map +1 -1
  348. package/utils/report-es-client.js +1 -1
  349. package/resource/doc/chatuikit/android/workflow.md +0 -713
  350. package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1376
  351. package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -860
  352. package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1371
  353. package/resource/doc/chatuikit/flutter/workflow.md +0 -816
  354. package/resource/doc/chatuikit/iOS/workflow.md +0 -0
  355. package/resource/doc/chatuikit/react/components/conversation-list.md +0 -765
  356. package/resource/doc/chatuikit/react/components/search.md +0 -885
  357. package/resource/doc/chatuikit/react/create-group.md +0 -22
  358. package/resource/doc/chatuikit/react/init.md +0 -25
  359. package/resource/doc/chatuikit/react/workflow.md +0 -254
  360. package/resource/doc/chatuikit/uniapp-app/faq.md +0 -0
  361. package/resource/doc/chatuikit/uniapp-app/integration.md +0 -619
  362. package/resource/doc/chatuikit/uniapp-app/workflow.md +0 -576
  363. package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
  364. package/resource/doc/chatuikit/vue/components/tuikit.md +0 -110
  365. package/resource/doc/chatuikit/vue/create-group.md +0 -26
  366. package/resource/doc/chatuikit/vue/init.md +0 -35
  367. package/resource/doc/chatuikit/vue/workflow.md +0 -395
  368. package/resource/doc/livekit/live/android/workflow.md +0 -322
  369. package/resource/doc/livekit/live/flutter/workflow.md +0 -353
  370. package/resource/doc/livekit/live/ios/workflow.md +0 -352
  371. package/resource/doc/livekit/live/vue/components/barrage.md +0 -615
  372. package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -442
  373. package/resource/doc/livekit/live/vue/faq.md +0 -0
  374. package/resource/doc/livekit/live/vue/live-list-integration.md +0 -195
  375. package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -293
  376. package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -381
  377. package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -598
  378. package/resource/doc/livekit/live/vue/states/live-state.md +0 -2656
  379. package/resource/doc/livekit/live/vue/workflow.md +0 -219
  380. package/resource/doc/livekit/voice/android/workflow.md +0 -333
  381. package/resource/doc/livekit/voice/flutter/workflow.md +0 -359
  382. package/resource/doc/livekit/voice/ios/voice-integration.md +0 -853
  383. package/resource/doc/livekit/voice/ios/workflow.md +0 -358
  384. package/resource/doc/livekit/voice/uni-app/voice-integration.md +0 -613
  385. package/resource/doc/livekit/voice/uni-app/workflow.md +0 -369
  386. package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -334
  387. package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -434
  388. package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -685
  389. package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -712
  390. package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -284
  391. package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
  392. package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
  393. package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
  394. package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
  395. package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -879
  396. package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -668
  397. package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -456
  398. package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -332
  399. package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
  400. package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -328
  401. package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -505
  402. package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
  403. package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -676
  404. package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
  405. package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -820
  406. package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1065
  407. package/resource/doc/roomkit/vue/features/workflow.md +0 -553
  408. package/resource/doc/roomkit/vue/workflow.md +0 -733
  409. package/resource/doc/tuicallkit/android/workflow.md +0 -432
  410. package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -786
  411. package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -663
  412. package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -932
  413. package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -926
  414. package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -452
  415. package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -779
  416. package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -635
  417. package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
  418. package/resource/doc/tuicallkit/react/api.md +0 -1512
  419. package/resource/doc/tuicallkit/react/faq.md +0 -986
  420. package/resource/doc/tuicallkit/vue/api.md +0 -1512
  421. package/tools/call/get-native-call-integration.js +0 -43
  422. package/tools/call/get-native-call-integration.js.map +0 -1
  423. package/tools/call/get-web-call-api.js +0 -27
  424. package/tools/call/get-web-call-api.js.map +0 -1
  425. package/tools/call/get-web-call-integration.js.map +0 -1
  426. package/tools/chat/get-native-chat-feature-detail.js +0 -30
  427. package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
  428. package/tools/chat/get-native-chat-integration.js +0 -45
  429. package/tools/chat/get-native-chat-integration.js.map +0 -1
  430. package/tools/chat/get-web-chat-component-detail.js +0 -31
  431. package/tools/chat/get-web-chat-component-detail.js.map +0 -1
  432. package/tools/chat/get-web-chat-integration.js +0 -45
  433. package/tools/chat/get-web-chat-integration.js.map +0 -1
  434. package/tools/chat/get-web-chat-uikit-init.js +0 -28
  435. package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
  436. package/tools/chat/get-web-create-group-doc.js +0 -28
  437. package/tools/chat/get-web-create-group-doc.js.map +0 -1
  438. package/tools/common/get-faq.js +0 -91
  439. package/tools/common/get-faq.js.map +0 -1
  440. package/tools/common/get-usersig.js.map +0 -1
  441. package/tools/common/present-framework-choice.js +0 -16
  442. package/tools/common/present-framework-choice.js.map +0 -1
  443. package/tools/common/present-scenario-choice.js +0 -16
  444. package/tools/common/present-scenario-choice.js.map +0 -1
  445. package/tools/common/record-prompt.js +0 -55
  446. package/tools/common/record-prompt.js.map +0 -1
  447. package/tools/common/record-result.js +0 -60
  448. package/tools/common/record-result.js.map +0 -1
  449. package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
  450. package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
  451. package/tools/definitions/get_native_live_api_def.js +0 -22
  452. package/tools/definitions/get_native_live_api_def.js.map +0 -1
  453. package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -109
  454. package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
  455. package/tools/definitions/get_native_live_uikit_integration_def.js +0 -75
  456. package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
  457. package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
  458. package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
  459. package/tools/definitions/get_trtc_native_api_def.js +0 -17
  460. package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
  461. package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
  462. package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
  463. package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
  464. package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
  465. package/tools/definitions/get_web_create_group_doc_def.js +0 -18
  466. package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
  467. package/tools/definitions/get_web_live_state_detail_def.js +0 -19
  468. package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
  469. package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
  470. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
  471. package/tools/definitions/get_web_room_feature_detail_def.js +0 -92
  472. package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
  473. package/tools/definitions/present_scenario_choice_def.js +0 -53
  474. package/tools/definitions/present_scenario_choice_def.js.map +0 -1
  475. package/tools/definitions/record_prompt_def.js +0 -58
  476. package/tools/definitions/record_prompt_def.js.map +0 -1
  477. package/tools/definitions/record_result_def.js +0 -46
  478. package/tools/definitions/record_result_def.js.map +0 -1
  479. package/tools/live/get-native-live-uikit-integration.js +0 -177
  480. package/tools/live/get-native-live-uikit-integration.js.map +0 -1
  481. package/tools/live/get-web-live-component-detail.js +0 -31
  482. package/tools/live/get-web-live-component-detail.js.map +0 -1
  483. package/tools/live/get-web-live-state-detail.js +0 -31
  484. package/tools/live/get-web-live-state-detail.js.map +0 -1
  485. package/tools/live/get-web-live-uikit-integration.js +0 -52
  486. package/tools/live/get-web-live-uikit-integration.js.map +0 -1
  487. package/tools/live/get_native_live_uikit_extra_features.js +0 -105
  488. package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
  489. package/tools/live/get_native_live_uikit_interaction.js +0 -194
  490. package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
  491. package/tools/native_live/get-native-live-api.js +0 -31
  492. package/tools/native_live/get-native-live-api.js.map +0 -1
  493. package/tools/room/get-web-room-feature-detail.js.map +0 -1
  494. package/tools/room/get-web-room-integration.js.map +0 -1
  495. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
  496. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
  497. package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
  498. package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
  499. package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
  500. package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
  501. package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
  502. package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
  503. package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
  504. package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
  505. package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
  506. package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
  507. package/tools/trtc/get-trtc-native-api.js +0 -31
  508. package/tools/trtc/get-trtc-native-api.js.map +0 -1
  509. package/utils/handle-component-name.js +0 -33
  510. package/utils/handle-component-name.js.map +0 -1
  511. /package/resource/doc/{rtcengine/web → callkit/core-sdk}/.gitkeep +0 -0
  512. /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
  513. /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
  514. /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
@@ -1,22 +1,7 @@
1
1
  `GiftStore` 是 `AtomicXCore` 中专门负责管理直播间礼物功能的模块。通过它,您可以为您的直播应用构建一套完整的礼物系统,实现丰富的营收和互动场景。
2
- <table>
3
- <tr>
4
- <td rowspan="1" colSpan="1" >礼物面板</td>
5
-
6
- <td rowspan="1" colSpan="1" >弹幕礼物</td>
7
-
8
- <td rowspan="1" colSpan="1" >全屏礼物</td>
9
- </tr>
10
-
11
- <tr>
12
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/b480dc47ae6f11f096c2525400454e06.jpeg)</td>
13
-
14
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/1363112bae7011f096c2525400454e06.png)</td>
15
-
16
- <td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/b5caaab8ae6f11f0b08552540044a08e.gif)</td>
17
- </tr>
18
- </table>
19
-
2
+ | 礼物面板 | 弹幕礼物 | 全屏礼物 |
3
+ | --- | --- | --- |
4
+ | | | |
20
5
 
21
6
  ## 核心功能
22
7
  - **礼物列表获取**:从服务端拉取礼物面板所需的数据,包括礼物分类和礼物详情。
@@ -25,75 +10,30 @@
25
10
 
26
11
  - **礼物事件广播**:实时接收房间内发生的礼物赠送事件,用于展示礼物动画和弹幕通知。
27
12
 
28
-
29
13
  ## 核心概念
30
14
 
31
15
  在开始集成之前,我们先通过下表了解一下 `GiftStore` 相关的几个核心概念:
32
- <table>
33
- <tr>
34
- <td rowspan="1" colSpan="1" >**核心概念**</td>
35
-
36
- <td rowspan="1" colSpan="1" >**类型**</td>
37
-
38
- <td rowspan="1" colSpan="1" >**核心职责与描述**</td>
39
- </tr>
40
-
41
- <tr>
42
- <td rowspan="1" colSpan="1" >`Gift`</td>
43
-
44
- <td rowspan="1" colSpan="1" >`struct`</td>
45
-
46
- <td rowspan="1" colSpan="1" >代表一个具体的礼物数据模型。包含了礼物的 ID、名称、图标地址、动画资源地址 (resourceURL) 和价格 (coins) 等。</td>
47
- </tr>
48
-
49
- <tr>
50
- <td rowspan="1" colSpan="1" >`GiftCategory`</td>
51
-
52
- <td rowspan="1" colSpan="1" >`struct`</td>
53
-
54
- <td rowspan="1" colSpan="1" >代表一个礼物分类,例如“热门”、“豪华”等。它包含了分类的名称以及该分类下的 **Gift **列表。</td>
55
- </tr>
56
-
57
- <tr>
58
- <td rowspan="1" colSpan="1" >`GiftState`</td>
59
-
60
- <td rowspan="1" colSpan="1" >`struct`</td>
61
-
62
- <td rowspan="1" colSpan="1" >代表礼物模块的当前状态。其核心属性 usableGifts 是一个 [GiftCategory] 数组,存储了从服务端拉取到的完整礼物列表。</td>
63
- </tr>
64
-
65
- <tr>
66
- <td rowspan="1" colSpan="1" >`GiftEvent`</td>
67
-
68
- <td rowspan="1" colSpan="1" >`enum`</td>
69
-
70
- <td rowspan="1" colSpan="1" >代表直播间内发生的礼物事件。目前只有 .onReceiveGift,当有任何人(包括自己)发送礼物时,房间内所有人都会收到此事件。</td>
71
- </tr>
72
-
73
- <tr>
74
- <td rowspan="1" colSpan="1" >`GiftStore`</td>
75
-
76
- <td rowspan="1" colSpan="1" >`class`</td>
77
-
78
- <td rowspan="1" colSpan="1" >这是与礼物功能交互的核心管理类。通过它,您可以拉取礼物列表、发送礼物,并通过订阅其 giftEventPublisher 来接收礼物事件。</td>
79
- </tr>
80
- </table>
81
-
16
+ | **核心概念** | **类型** | **核心职责与描述** |
17
+ | --- | --- | --- |
18
+ | `Gift` | `struct` | 代表一个具体的礼物数据模型。包含了礼物的 ID、名称、图标地址、动画资源地址 (resourceURL) 和价格 (coins) 等。 |
19
+ | `GiftCategory` | `struct` | 代表一个礼物分类,例如“热门”、“豪华”等。它包含了分类的名称以及该分类下的 **Gift **列表。 |
20
+ | `GiftState` | `struct` | 代表礼物模块的当前状态。其核心属性 usableGifts 是一个 [GiftCategory] 数组,存储了从服务端拉取到的完整礼物列表。 |
21
+ | `GiftEvent` | `enum` | 代表直播间内发生的礼物事件。目前只有 .onReceiveGift,当有任何人(包括自己)发送礼物时,房间内所有人都会收到此事件。 |
22
+ | `GiftStore` | `class` | 这是与礼物功能交互的核心管理类。通过它,您可以拉取礼物列表、发送礼物,并通过订阅其 giftEventPublisher 来接收礼物事件。 |
82
23
 
83
24
  ## 实现步骤
84
25
 
85
26
  ### 步骤1:组件集成
86
27
 
87
28
  > **说明:**
88
- >
89
-
90
- > 使用**礼物系统**要求开通TUILiveKit **多人连麦版**、**大规模直播版**,不同套餐中可配置的礼物数量有所不同,详细参见 [功能与计费说明](https://write.woa.com/document/141302177829593088) 中的**礼物系统**说明。
91
- >
29
+ >
92
30
 
93
- - **视频直播**:请参考 [快速接入](https://write.woa.com/document/191126382767431680) 集成 **AtomicXCore**,完成接入。
31
+ > 使用**礼物系统**要求开通TUILiveKit **多人连麦版**、**大规模直播版**,不同套餐中可配置的礼物数量有所不同,详细参见 功能与计费说明 中的**礼物系统**说明。
32
+ >
94
33
 
95
- - **语聊房**:请参考 [快速接入](https://write.woa.com/document/192834898445422592) 集成 **AtomicXCore**,完成接入。
34
+ - **视频直播**:请参考 快速接入 集成 **AtomicXCore**,完成接入。
96
35
 
36
+ - **语聊房**:请参考 快速接入 集成 **AtomicXCore**,完成接入。
97
37
 
98
38
  ### 步骤2:初始化并监听礼物事件
99
39
 
@@ -106,18 +46,17 @@
106
46
 
107
47
  3. **订阅状态**:订阅 `giftStore.state` 以获取 `usableGifts `礼物列表。
108
48
 
109
-
110
49
  #### 代码示例:
111
50
  ``` swift
112
51
  import Foundation
113
- import AtomicXCore
114
- import Combine
52
+ import AtomicXCore
53
+ import Combine
115
54
 
116
55
  class GiftManager {
117
56
  private let liveId: String
118
57
  private let giftStore: GiftStore
119
58
  private var cancellables = Set<AnyCancellable>()
120
-
59
+
121
60
  // 对外暴露礼物事件,方便UI层订阅以播放动画
122
61
  let giftEventPublisher = PassthroughSubject<GiftEvent, Never>()
123
62
  // 对外暴露礼物列表
@@ -127,7 +66,7 @@ class GiftManager {
127
66
  self.liveId = liveId
128
67
  // 1. 通过 liveId 获取 GiftStore 的实例
129
68
  self.giftStore = GiftStore.create(liveID: liveId)
130
-
69
+
131
70
  subscribeToGiftState()
132
71
  subscribeToGiftEvents()
133
72
  }
@@ -142,7 +81,7 @@ class GiftManager {
142
81
  }
143
82
  .store(in: &cancellables)
144
83
  }
145
-
84
+
146
85
  /// 3. 订阅礼物列表状态
147
86
  private func subscribeToGiftState() {
148
87
  giftStore.state
@@ -157,132 +96,26 @@ class GiftManager {
157
96
  #### 礼物列表结构体参数
158
97
  - `GiftCategory`**参数说明**
159
98
 
160
- <table>
161
- <tr>
162
- <td rowspan="1" colSpan="1" >**参数**</td>
163
-
164
- <td rowspan="1" colSpan="1" >**类型**</td>
165
-
166
- <td rowspan="1" colSpan="1" >**描述**</td>
167
- </tr>
168
-
169
- <tr>
170
- <td rowspan="1" colSpan="1" >`categoryID`</td>
171
-
172
- <td rowspan="1" colSpan="1" >`String`</td>
173
-
174
- <td rowspan="1" colSpan="1" >礼物分类的唯一 ID。</td>
175
- </tr>
176
-
177
- <tr>
178
- <td rowspan="1" colSpan="1" >`name`</td>
179
-
180
- <td rowspan="1" colSpan="1" >`String`</td>
181
-
182
- <td rowspan="1" colSpan="1" >礼物分类的显示名称。</td>
183
- </tr>
184
-
185
- <tr>
186
- <td rowspan="1" colSpan="1" >`desc`</td>
187
-
188
- <td rowspan="1" colSpan="1" >`String`</td>
189
-
190
- <td rowspan="1" colSpan="1" >礼物分类的描述信息。</td>
191
- </tr>
192
-
193
- <tr>
194
- <td rowspan="1" colSpan="1" >`extensionInfo`</td>
195
-
196
- <td rowspan="1" colSpan="1" >`[String: String]`</td>
197
-
198
- <td rowspan="1" colSpan="1" >扩展信息字段。</td>
199
- </tr>
200
-
201
- <tr>
202
- <td rowspan="1" colSpan="1" >`giftList`</td>
203
-
204
- <td rowspan="1" colSpan="1" >`[`[`Gift`](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/gift)`]`</td>
205
-
206
- <td rowspan="1" colSpan="1" >该分类下包含的 Gift 礼物对象数组。</td>
207
- </tr>
208
- </table>
99
+ | **参数** | **类型** | **描述** |
100
+ | --- | --- | --- |
101
+ | `categoryID` | `String` | 礼物分类的唯一 ID。 |
102
+ | `name` | `String` | 礼物分类的显示名称。 |
103
+ | `desc` | `String` | 礼物分类的描述信息。 |
104
+ | `extensionInfo` | `[String: String]` | 扩展信息字段。 |
105
+ | `giftList` | `[`[`Gift`](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/gift)`]` | 该分类下包含的 Gift 礼物对象数组。 |
209
106
 
210
107
  - `Gift`** 参数说明**
211
108
 
212
- <table>
213
- <tr>
214
- <td rowspan="1" colSpan="1" >**参数**</td>
215
-
216
- <td rowspan="1" colSpan="1" >**类型**</td>
217
-
218
- <td rowspan="1" colSpan="1" >**描述**</td>
219
- </tr>
220
-
221
- <tr>
222
- <td rowspan="1" colSpan="1" >`giftID`</td>
223
-
224
- <td rowspan="1" colSpan="1" >`String`</td>
225
-
226
- <td rowspan="1" colSpan="1" > 礼物的唯一 ID。</td>
227
- </tr>
228
-
229
- <tr>
230
- <td rowspan="1" colSpan="1" >`name`</td>
231
-
232
- <td rowspan="1" colSpan="1" >`String`</td>
233
-
234
- <td rowspan="1" colSpan="1" > 礼物的显示名称。</td>
235
- </tr>
236
-
237
- <tr>
238
- <td rowspan="1" colSpan="1" >`desc`</td>
239
-
240
- <td rowspan="1" colSpan="1" >`String`</td>
241
-
242
- <td rowspan="1" colSpan="1" > 礼物的描述信息。</td>
243
- </tr>
244
-
245
- <tr>
246
- <td rowspan="1" colSpan="1" >`iconURL`</td>
247
-
248
- <td rowspan="1" colSpan="1" >`String`</td>
249
-
250
- <td rowspan="1" colSpan="1" > 礼物图标 URL。</td>
251
- </tr>
252
-
253
- <tr>
254
- <td rowspan="1" colSpan="1" >`resourceURL`</td>
255
-
256
- <td rowspan="1" colSpan="1" >`String`</td>
257
-
258
- <td rowspan="1" colSpan="1" > 礼物动画资源 URL。</td>
259
- </tr>
260
-
261
- <tr>
262
- <td rowspan="1" colSpan="1" >`level`</td>
263
-
264
- <td rowspan="1" colSpan="1" >`UInt`</td>
265
-
266
- <td rowspan="1" colSpan="1" > 礼物等级。</td>
267
- </tr>
268
-
269
- <tr>
270
- <td rowspan="1" colSpan="1" >`coins`</td>
271
-
272
- <td rowspan="1" colSpan="1" >`UInt`</td>
273
-
274
- <td rowspan="1" colSpan="1" > 礼物价格。</td>
275
- </tr>
276
-
277
- <tr>
278
- <td rowspan="1" colSpan="1" >`extensionInfo`</td>
279
-
280
- <td rowspan="1" colSpan="1" >`[String: String]`</td>
281
-
282
- <td rowspan="1" colSpan="1" > 扩展信息字段。</td>
283
- </tr>
284
- </table>
285
-
109
+ | **参数** | **类型** | **描述** |
110
+ | --- | --- | --- |
111
+ | `giftID` | `String` | 礼物的唯一 ID。 |
112
+ | `name` | `String` | 礼物的显示名称。 |
113
+ | `desc` | `String` | 礼物的描述信息。 |
114
+ | `iconURL` | `String` | 礼物图标 URL。 |
115
+ | `resourceURL` | `String` | 礼物动画资源 URL。 |
116
+ | `level` | `UInt` | 礼物等级。 |
117
+ | `coins` | `UInt` | 礼物价格。 |
118
+ | `extensionInfo` | `[String: String]` | 扩展信息字段。 |
286
119
 
287
120
  ### 步骤3:获取礼物列表
288
121
 
@@ -295,7 +128,6 @@ class GiftManager {
295
128
 
296
129
  3. **接收数据**:拉取成功后,通过步骤2中对 giftStore.state 的订阅,自动接收到更新后的 usableGifts 列表。
297
130
 
298
-
299
131
  #### 代码示例:
300
132
  ``` swift
301
133
  extension GiftManager {
@@ -325,7 +157,6 @@ extension GiftManager {
325
157
 
326
158
  3. **处理回调**:在 `completion` 回调中处理发送失败的情况(例如余额不足提示);发送成功后的 UI 更新(动画、弹幕)应由 `.onReceiveGift` 事件驱动。
327
159
 
328
-
329
160
  #### 代码示例:
330
161
  ``` swift
331
162
  extension GiftManager {
@@ -346,40 +177,11 @@ extension GiftManager {
346
177
  ```
347
178
 
348
179
  #### `sendGift`接口参数
349
- <table>
350
- <tr>
351
- <td rowspan="1" colSpan="1" >**参数名**</td>
352
-
353
- <td rowspan="1" colSpan="1" >**类型**</td>
354
-
355
- <td rowspan="1" colSpan="1" >**描述**</td>
356
- </tr>
357
-
358
- <tr>
359
- <td rowspan="1" colSpan="1" >`giftID`</td>
360
-
361
- <td rowspan="1" colSpan="1" >`String`</td>
362
-
363
- <td rowspan="1" colSpan="1" >要发送的礼物的唯一 ID。</td>
364
- </tr>
365
-
366
- <tr>
367
- <td rowspan="1" colSpan="1" >`count`</td>
368
-
369
- <td rowspan="1" colSpan="1" >`UInt`</td>
370
-
371
- <td rowspan="1" colSpan="1" >发送的数量。</td>
372
- </tr>
373
-
374
- <tr>
375
- <td rowspan="1" colSpan="1" >`completion`</td>
376
-
377
- <td rowspan="1" colSpan="1" >`CompletionClosure?`</td>
378
-
379
- <td rowspan="1" colSpan="1" >发送完成后的回调。</td>
380
- </tr>
381
- </table>
382
-
180
+ | **参数名** | **类型** | **描述** |
181
+ | --- | --- | --- |
182
+ | `giftID` | `String` | 要发送的礼物的唯一 ID。 |
183
+ | `count` | `UInt` | 发送的数量。 |
184
+ | `completion` | `CompletionClosure?` | 发送完成后的回调。 |
383
185
 
384
186
  ## 功能进阶
385
187
 
@@ -396,128 +198,33 @@ extension GiftManager {
396
198
 
397
199
  3. **UI 展示**:使用拉取到的 `[GiftCategory]` 数据填充礼物面板。
398
200
 
399
-
400
201
  #### **配置时序图**
401
202
 
402
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/1a7376a1ae6e11f09b75525400bf7822.png)
403
-
404
-
405
203
  #### **涉及 REST API 接口一览**
406
- <table>
407
- <tr>
408
- <td rowspan="1" colSpan="1" >接口分类</td>
409
-
410
- <td rowspan="1" colSpan="1" >接口</td>
411
-
412
- <td rowspan="1" colSpan="1" >请求示例</td>
413
- </tr>
414
-
415
- <tr>
416
- <td rowspan="3" colSpan="1" >​礼物管理​</td>
417
-
418
- <td rowspan="1" colSpan="1" >添加礼物信息</td>
419
-
420
- <td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341527570997248)</td>
421
- </tr>
422
-
423
- <tr>
424
- <td rowspan="1" colSpan="1" >删除礼物信息</td>
425
-
426
- <td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341544133693440)</td>
427
- </tr>
428
-
429
- <tr>
430
- <td rowspan="1" colSpan="1" >查询礼物信息</td>
431
-
432
- <td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341539054186496)</td>
433
- </tr>
434
-
435
- <tr>
436
- <td rowspan="3" colSpan="1" >礼物​分类管理​</td>
437
-
438
- <td rowspan="1" colSpan="1" >添加礼物分类信息</td>
439
-
440
- <td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180807825764642816)</td>
441
- </tr>
442
-
443
- <tr>
444
- <td rowspan="1" colSpan="1" >删除指定礼物分类信息</td>
445
-
446
- <td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180807830209925120)</td>
447
- </tr>
448
-
449
- <tr>
450
- <td rowspan="1" colSpan="1" >获取指定礼物分类信息</td>
451
-
452
- <td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180807827909746688)</td>
453
- </tr>
454
-
455
- <tr>
456
- <td rowspan="3" colSpan="1" >​礼物关系管理​</td>
457
-
458
- <td rowspan="1" colSpan="1" >添加指定礼物分类和礼物间的关系</td>
459
-
460
- <td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341551420928000)</td>
461
- </tr>
462
-
463
- <tr>
464
- <td rowspan="1" colSpan="1" >删除指定礼物分类和礼物间的关系</td>
465
-
466
- <td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341562381627392)</td>
467
- </tr>
468
-
469
- <tr>
470
- <td rowspan="1" colSpan="1" >获取指定礼物分类下的礼物关系</td>
471
-
472
- <td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341571868094464)</td>
473
- </tr>
474
-
475
- <tr>
476
- <td rowspan="6" colSpan="1" >​礼物多语言​管理</td>
477
-
478
- <td rowspan="1" colSpan="1" >添加礼物多语言信息</td>
479
-
480
- <td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341579611611136)</td>
481
- </tr>
482
-
483
- <tr>
484
- <td rowspan="1" colSpan="1" >删除指定礼物多语言信息</td>
485
-
486
- <td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341598501920768)</td>
487
- </tr>
488
-
489
- <tr>
490
- <td rowspan="1" colSpan="1" >获取礼物多语言信息</td>
491
-
492
- <td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341588810166272)</td>
493
- </tr>
494
-
495
- <tr>
496
- <td rowspan="1" colSpan="1" >添加礼物分类多语言信息</td>
497
-
498
- <td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341603609534464)</td>
499
- </tr>
500
-
501
- <tr>
502
- <td rowspan="1" colSpan="1" >删除指定礼物分类多语言信息</td>
503
-
504
- <td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341624911425536)</td>
505
- </tr>
506
-
507
- <tr>
508
- <td rowspan="1" colSpan="1" >获取礼物分类多语言信息</td>
509
-
510
- <td rowspan="1" colSpan="1" >[请求示例](https://write.woa.com/document/180341612525645824)</td>
511
- </tr>
512
- </table>
513
-
204
+ | 接口分类 | 接口 | 请求示例 |
205
+ | --- | --- | --- |
206
+ | ​礼物管理​ | 添加礼物信息 | 请求示例 |
207
+ | 删除礼物信息 | 请求示例 | |
208
+ | 查询礼物信息 | 请求示例 | |
209
+ | 礼物​分类管理​ | 添加礼物分类信息 | 请求示例 |
210
+ | 删除指定礼物分类信息 | 请求示例 | |
211
+ | 获取指定礼物分类信息 | 请求示例 | |
212
+ | ​礼物关系管理​ | 添加指定礼物分类和礼物间的关系 | 请求示例 |
213
+ | 删除指定礼物分类和礼物间的关系 | 请求示例 | |
214
+ | 获取指定礼物分类下的礼物关系 | 请求示例 | |
215
+ | ​礼物多语言​管理 | 添加礼物多语言信息 | 请求示例 |
216
+ | 删除指定礼物多语言信息 | 请求示例 | |
217
+ | 获取礼物多语言信息 | 请求示例 | |
218
+ | 添加礼物分类多语言信息 | 请求示例 | |
219
+ | 删除指定礼物分类多语言信息 | 请求示例 | |
220
+ | 获取礼物分类多语言信息 | 请求示例 | |
514
221
 
515
222
  ### 计费与送礼扣费流程
516
223
 
517
224
  当观众赠送礼物时,需要确保其账户余额充足,并完成实际的扣费操作,然后才能触发礼物特效的播放和广播。
518
225
 
519
226
  #### 实现方式
520
- 1. **后台配置回调**:在 LiveKit 后台配置您的自建计费系统的回调 URL。参考 [回调配置文档](https://write.woa.com/document/183772947196690432)。
227
+ 1. **后台配置回调**:在 LiveKit 后台配置您的自建计费系统的回调 URL。参考 回调配置文档。
521
228
 
522
229
  2. **客户端发送**:客户端调用 `sendGift`。
523
230
 
@@ -525,31 +232,12 @@ extension GiftManager {
525
232
 
526
233
  4. **结果同步**:扣费成功,AtomicXCore 广播 `.onReceiveGift` 事件。扣费失败,`sendGift` 的 `completion` 收到错误。
527
234
 
528
-
529
235
  #### 调用流程图
530
236
 
531
- ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182498/8266a8afae6e11f0a68e5254001c06ec.png)
532
-
533
-
534
237
  #### 涉及 REST API 接口一览
535
- <table>
536
- <tr>
537
- <td rowspan="1" colSpan="1" >接口</td>
538
-
539
- <td rowspan="1" colSpan="1" >说明</td>
540
-
541
- <td rowspan="1" colSpan="1" >请求示例</td>
542
- </tr>
543
-
544
- <tr>
545
- <td rowspan="1" colSpan="1" >回调配置 - 发送礼物之前回调</td>
546
-
547
- <td rowspan="1" colSpan="1" >客户后台可以通过该回调决定是否通过送礼前校验等场景</td>
548
-
549
- <td rowspan="1" colSpan="1" >[调用示例](https://write.woa.com/document/183772947196690432)</td>
550
- </tr>
551
- </table>
552
-
238
+ | 接口 | 说明 | 请求示例 |
239
+ | --- | --- | --- |
240
+ | 回调配置 - 发送礼物之前回调 | 客户后台可以通过该回调决定是否通过送礼前校验等场景 | 调用示例 |
553
241
 
554
242
  ### 实现全屏礼物动画播放
555
243
 
@@ -558,56 +246,13 @@ extension GiftManager {
558
246
  #### 实现方式
559
247
 
560
248
  `AtomicXCore` 本身不包含礼物动画播放器,您需要根据业务需求选择并集成第三方库。以下是两种方案的对比:
561
- <table>
562
- <tr>
563
- <td rowspan="1" colSpan="1" >**对比项**</td>
564
-
565
- <td rowspan="1" colSpan="1" >**基础方案 (SVGAPlayer-iOS)**</td>
566
-
567
- <td rowspan="1" colSpan="1" >**高级方案 (TCEffectPlayerKit)**</td>
568
- </tr>
569
-
570
- <tr>
571
- <td rowspan="1" colSpan="1" >计费</td>
572
-
573
- <td rowspan="1" colSpan="1" >免费 (开源库)</td>
574
-
575
- <td rowspan="1" colSpan="1" >付费 (需购买 License),请参见 [付费指引](https://cloud.tencent.com/document/product/616/116461)</td>
576
- </tr>
577
-
578
- <tr>
579
- <td rowspan="1" colSpan="1" >集成方式</td>
580
-
581
- <td rowspan="1" colSpan="1" >需手动集成 SVGAPlayer 库 (例如通过 CocoaPods)</td>
582
-
583
- <td rowspan="1" colSpan="1" >需额外集成 TCEffectPlayerKit 并进行鉴权</td>
584
- </tr>
585
-
586
- <tr>
587
- <td rowspan="1" colSpan="1" >动画格式支持</td>
588
-
589
- <td rowspan="1" colSpan="1" >仅支持 SVGA</td>
590
-
591
- <td rowspan="1" colSpan="1" >SVGA、PAG、WebP、Lottie、MP4 等多种格式</td>
592
- </tr>
593
-
594
- <tr>
595
- <td rowspan="1" colSpan="1" >性能</td>
596
-
597
- <td rowspan="1" colSpan="1" >建议 SVGA 文件 ≤ 10MB</td>
598
-
599
- <td rowspan="1" colSpan="1" >支持更大的动画文件,复杂特效/多动画并发/低端机表现更优</td>
600
- </tr>
601
-
602
- <tr>
603
- <td rowspan="1" colSpan="1" >推荐场景</td>
604
-
605
- <td rowspan="1" colSpan="1" >礼物动画格式统一为 SVGA,且文件大小可控</td>
606
-
607
- <td rowspan="1" colSpan="1" >需要支持多种动画格式,或对动画性能/设备兼容性有更高要求</td>
608
- </tr>
609
- </table>
610
-
249
+ | **对比项** | **基础方案 (SVGAPlayer-iOS)** | **高级方案 (TCEffectPlayerKit)** |
250
+ | --- | --- | --- |
251
+ | 计费 | 免费 (开源库) | 付费 (需购买 License),请参见 [付费指引](https://cloud.tencent.com/document/product/616/116461) |
252
+ | 集成方式 | 需手动集成 SVGAPlayer 库 (例如通过 CocoaPods) | 需额外集成 TCEffectPlayerKit 并进行鉴权 |
253
+ | 动画格式支持 | 仅支持 SVGA | SVGA、PAG、WebP、Lottie、MP4 等多种格式 |
254
+ | 性能 | 建议 SVGA 文件 ≤ 10MB | 支持更大的动画文件,复杂特效/多动画并发/低端机表现更优 |
255
+ | 推荐场景 | 礼物动画格式统一为 SVGA,且文件大小可控 | 需要支持多种动画格式,或对动画性能/设备兼容性有更高要求 |
611
256
 
612
257
  本章节主要演示基础方案的集成。如果您选择高级方案,请参考 [TCEffectPlayer 集成指引](https://cloud.tencent.com/document/product/616/116474)。
613
258
 
@@ -624,11 +269,10 @@ extension GiftManager {
624
269
 
625
270
  3. **解析并播放**:当收到 `.onReceiveGift `事件时,检查 `gift.resourceURL `是否有效且指向一个 SVGA 文件。如果是,则使用 `SVGAParser` 解析 URL,并将解析后的 `SVGAVideoEntity` 交给 `SVGAPlayer` 实例播放。
626
271
 
627
-
628
272
  #### 代码示例
629
273
  ``` swift
630
274
  import UIKit
631
- import AtomicXCore
275
+ import AtomicXCore
632
276
  import Combine
633
277
  import SVGAPlayer // 1. 导入
634
278
 
@@ -699,7 +343,6 @@ class LiveRoomViewController: UIViewController, SVGAPlayerDelegate {
699
343
 
700
344
  5. **本地插入**:调用 `barrageStore.appendLocalTip(message: giftTip) `将消息插入本地列表。
701
345
 
702
-
703
346
  #### 代码示例
704
347
  ``` swift
705
348
  // 在 LiveRoomManager 或类似的顶层管理器中
@@ -715,7 +358,7 @@ private func setupGiftToBarrageFlow() {
715
358
  // 4. 拼接消息
716
359
  let tipText = "\(sender.userName) 送出了 \(gift.name) x \(count)"
717
360
  var giftTip = Barrage()
718
- giftTip.messageType = .text
361
+ giftTip.messageType = .text
719
362
  giftTip.textContent = tipText
720
363
  // 可选:设置一个特殊的sender
721
364
 
@@ -729,32 +372,10 @@ private func setupGiftToBarrageFlow() {
729
372
  ## API 文档
730
373
 
731
374
  关于 [GiftStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore) 及其相关类的所有公开接口、属性和方法的详细信息,请参阅随 [AtomicXCore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore) 框架的官方 API 文档。本指南使用到的相关 Store 如下:
732
- <table>
733
- <tr>
734
- <td rowspan="1" colSpan="1" >Store/Component</td>
735
-
736
- <td rowspan="1" colSpan="1" >功能描述</td>
737
-
738
- <td rowspan="1" colSpan="1" >API 文档</td>
739
- </tr>
740
-
741
- <tr>
742
- <td rowspan="1" colSpan="1" >GiftStore</td>
743
-
744
- <td rowspan="1" colSpan="1" >礼物互动:获取礼物列表,发送 / 接收礼物,监听礼物事件(含发送者、礼物详情)。</td>
745
-
746
- <td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/giftstore)</td>
747
- </tr>
748
-
749
- <tr>
750
- <td rowspan="1" colSpan="1" >BarrageStore</td>
751
-
752
- <td rowspan="1" colSpan="1" >弹幕功能:发送文本 / 自定义弹幕,维护弹幕列表,实时监听弹幕状态。</td>
753
-
754
- <td rowspan="1" colSpan="1" >[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore)</td>
755
- </tr>
756
- </table>
757
-
375
+ | Store/Component | 功能描述 | API 文档 |
376
+ | --- | --- | --- |
377
+ | GiftStore | 礼物互动:获取礼物列表,发送 / 接收礼物,监听礼物事件(含发送者、礼物详情)。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/giftstore) |
378
+ | BarrageStore | 弹幕功能:发送文本 / 自定义弹幕,维护弹幕列表,实时监听弹幕状态。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore) |
758
379
 
759
380
  ## 常见问题
760
381
 
@@ -771,7 +392,6 @@ private func setupGiftToBarrageFlow() {
771
392
  `onReceiveGift` 事件是对房间内所有成员的广播(包括发送者自己)。如果您在 `sendGift` 的 `completion` 成功回调里执行了一次UI操作,同时又在 `onReceiveGift` 订阅中执行了相同的 UI 操作,就会造成重复。
772
393
  - **实践教程**:UI 的更新(例如播放动画、弹幕提示)只在 `onReceiveGift` 事件的订阅中处理。`sendGift` 的 `completion`回调仅用于处理发送失败的逻辑(例如提示用户“发送失败”或“余额不足”)。
773
394
 
774
-
775
395
  ### 礼物扣费逻辑在哪里实现?
776
396
 
777
397
  礼物扣费逻辑完全由您的自建计费系统负责。`AtomicXCore` 通过后台回调机制与您的计费系统对接。客户端调用 `sendGift` 触发回调,您的后台服务完成扣费后,将结果返回给 `AtomicXCore` 后台,从而决定礼物事件是否广播。
@@ -782,4 +402,4 @@ private func setupGiftToBarrageFlow() {
782
402
 
783
403
  ### 礼物动画播放卡顿怎么办?
784
404
 
785
- 请检查您的 SVGA 文件大小,基础播放器建议不要超过 10MB。如果文件过大或动画复杂,您可以考虑集成 TUILiveKit 提供的高级特效播放器,以获得更优的性能表现。
405
+ 请检查您的 SVGA 文件大小,基础播放器建议不要超过 10MB。如果文件过大或动画复杂,您可以考虑集成 TUILiveKit 提供的高级特效播放器,以获得更优的性能表现。