@tencentcloud/sdk-mcp 1.4.6 → 1.6.0-beta.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 (556) hide show
  1. package/index.js +0 -1
  2. package/knowledge/bm25-cache.js +73 -0
  3. package/knowledge/bm25.js +147 -0
  4. package/knowledge/build-index.js +65 -0
  5. package/knowledge/chunker.js +167 -0
  6. package/knowledge/content-loader.js +44 -0
  7. package/knowledge/extractors.js +25 -0
  8. package/knowledge/path-meta.js +175 -0
  9. package/knowledge/search/exact-lookup.js +330 -0
  10. package/knowledge/search/filter-pool.js +86 -0
  11. package/knowledge/search/requires-framework.js +72 -0
  12. package/knowledge/search/search-knowledge.js +226 -0
  13. package/package.json +9 -9
  14. package/resource/_schema/feature-aliases.yaml +10 -0
  15. package/resource/_schema/goal-tags.yaml +72 -0
  16. package/resource/_schema/products.yaml +16 -0
  17. package/resource/_schema/trtc-intents.yaml +27 -0
  18. package/resource/_schema/types.yaml +44 -0
  19. package/resource/index/component-slugs.json +1 -0
  20. package/resource/index/manifest.json +1 -0
  21. package/resource/{doc → integration}/callkit/preset/android/integration.md +32 -28
  22. package/resource/{doc → integration}/callkit/preset/flutter/integration.md +109 -54
  23. package/resource/integration/callkit/preset/ios/integration.md +411 -0
  24. package/resource/integration/callkit/preset/react/integration.md +499 -0
  25. package/resource/integration/callkit/preset/vue/integration.md +768 -0
  26. package/resource/{doc/chatkit → integration/chat/preset}/android/integration.md +11 -11
  27. package/resource/{doc/chatkit → integration/chat/preset}/flutter/integration.md +59 -37
  28. package/resource/integration/chat/preset/ios/integration.md +568 -0
  29. package/resource/{doc/chatkit → integration/chat/preset}/react/integration.md +127 -95
  30. package/resource/integration/chat/preset/uni-app/integration.md +494 -0
  31. package/resource/{doc/chatkit → integration/chat/preset}/vue/integration.md +163 -143
  32. package/resource/{doc → integration}/livekit/preset/live/vue/live-list-integration.md +15 -15
  33. package/resource/{doc → integration}/livekit/preset/live/vue/live-player-desk-integration.md +25 -13
  34. package/resource/{doc → integration}/livekit/preset/live/vue/live-player-h5-integration.md +15 -9
  35. package/resource/{doc → integration}/livekit/preset/live/vue/live-pusher-integration.md +31 -26
  36. package/resource/integration/roomkit/preset/vue/integration.md +571 -0
  37. package/resource/knowledge/callkit/core-sdk/android/answer-call.md +852 -0
  38. package/resource/knowledge/callkit/core-sdk/android/make-call.md +929 -0
  39. package/resource/knowledge/callkit/core-sdk/android/offline-push.md +364 -0
  40. package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +1150 -0
  41. package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +1216 -0
  42. package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +412 -0
  43. package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1191 -0
  44. package/resource/knowledge/callkit/core-sdk/ios/make-call.md +1292 -0
  45. package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +537 -0
  46. package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +953 -0
  47. package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +1061 -0
  48. package/resource/knowledge/callkit/faq/android.md +168 -0
  49. package/resource/knowledge/callkit/faq/common.md +180 -0
  50. package/resource/knowledge/callkit/faq/flutter.md +52 -0
  51. package/resource/knowledge/callkit/faq/ios.md +116 -0
  52. package/resource/knowledge/callkit/faq/uniapp-app.md +89 -0
  53. package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +217 -0
  54. package/resource/knowledge/callkit/faq/web.md +363 -0
  55. package/resource/knowledge/callkit/preset/android/api.md +413 -0
  56. package/resource/knowledge/callkit/preset/flutter/api.md +22 -0
  57. package/resource/knowledge/callkit/preset/ios/api.md +256 -0
  58. package/resource/knowledge/callkit/preset/web/api.md +79 -0
  59. package/resource/knowledge/chat/preset/android/features/chat-setting.md +72 -0
  60. package/resource/knowledge/chat/preset/android/features/contact-list.md +41 -0
  61. package/resource/knowledge/chat/preset/android/features/conversation-list.md +123 -0
  62. package/resource/knowledge/chat/preset/android/features/language.md +142 -0
  63. package/resource/knowledge/chat/preset/android/features/message-input.md +57 -0
  64. package/resource/knowledge/chat/preset/android/features/message-list.md +142 -0
  65. package/resource/knowledge/chat/preset/android/features/search.md +64 -0
  66. package/resource/{doc/chatkit → knowledge/chat/preset}/android/features/theme.md +21 -18
  67. package/resource/knowledge/chat/preset/android-view/integration.md +448 -0
  68. package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +62 -0
  69. package/resource/knowledge/chat/preset/flutter/features/contact-list.md +40 -0
  70. package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +129 -0
  71. package/resource/knowledge/chat/preset/flutter/features/language.md +104 -0
  72. package/resource/knowledge/chat/preset/flutter/features/message-input.md +54 -0
  73. package/resource/knowledge/chat/preset/flutter/features/message-list.md +163 -0
  74. package/resource/knowledge/chat/preset/flutter/features/search.md +59 -0
  75. package/resource/{doc/chatkit → knowledge/chat/preset}/flutter/features/theme.md +47 -19
  76. package/resource/knowledge/chat/preset/ios/features/chat-setting.md +92 -0
  77. package/resource/knowledge/chat/preset/ios/features/contact-list.md +119 -0
  78. package/resource/knowledge/chat/preset/ios/features/conversation-list.md +134 -0
  79. package/resource/knowledge/chat/preset/ios/features/language.md +105 -0
  80. package/resource/knowledge/chat/preset/ios/features/message-input.md +69 -0
  81. package/resource/knowledge/chat/preset/ios/features/message-list.md +164 -0
  82. package/resource/knowledge/chat/preset/ios/features/search.md +94 -0
  83. package/resource/{doc/chatkit → knowledge/chat/preset}/ios/features/theme.md +54 -51
  84. package/resource/{doc/chatkit/ios → knowledge/chat/preset/ios-uikit}/integration.md +157 -94
  85. package/resource/knowledge/chat/preset/react/features/chat-setting.md +123 -0
  86. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/contact-list.md +256 -104
  87. package/resource/knowledge/chat/preset/react/features/conversation-actions.md +217 -0
  88. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/conversation-list.md +86 -79
  89. package/resource/knowledge/chat/preset/react/features/conversation-preview.md +99 -0
  90. package/resource/knowledge/chat/preset/react/features/conversation-search.md +58 -0
  91. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-input.md +30 -83
  92. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-list.md +22 -25
  93. package/resource/knowledge/chat/preset/react/features/search.md +531 -0
  94. package/resource/knowledge/chat/preset/react/features/theme.md +16 -0
  95. package/resource/knowledge/chat/preset/vue/features/chat-header.md +331 -0
  96. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/chat-setting.md +0 -4
  97. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/contact-list.md +59 -53
  98. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-actions.md +49 -43
  99. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-list.md +61 -49
  100. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-preview.md +43 -40
  101. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-search.md +1 -1
  102. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-input.md +128 -105
  103. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-list.md +108 -195
  104. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/search.md +74 -68
  105. package/resource/knowledge/chat/preset/vue/features/theme.md +136 -0
  106. package/resource/knowledge/chat/urls/error-code.md +16 -0
  107. package/resource/knowledge/chat/urls/product.md +61 -0
  108. package/resource/knowledge/chat/urls/restapi.md +226 -0
  109. package/resource/knowledge/chat/urls/sdk/android.md +84 -0
  110. package/resource/knowledge/chat/urls/sdk/flutter.md +73 -0
  111. package/resource/knowledge/chat/urls/sdk/ios.md +84 -0
  112. package/resource/knowledge/chat/urls/sdk/web.md +88 -0
  113. package/resource/knowledge/chat/urls/webhook.md +73 -0
  114. package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/AudioEffectStore.md +79 -76
  115. package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +174 -0
  116. package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +329 -0
  117. package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/CameraView.md +7 -6
  118. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +434 -0
  119. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +362 -0
  120. package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +466 -0
  121. package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +173 -0
  122. package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/LikeStore.md +12 -10
  123. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +291 -0
  124. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +78 -0
  125. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +439 -0
  126. package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +221 -0
  127. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/AudioEffectStore.md +79 -76
  128. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +212 -0
  129. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/BaseBeautyStore.md +43 -45
  130. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +312 -0
  131. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +404 -0
  132. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +334 -0
  133. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +420 -0
  134. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +166 -0
  135. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LikeStore.md +12 -11
  136. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +281 -0
  137. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LiveCoreView.md +49 -42
  138. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +397 -0
  139. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +183 -0
  140. package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/AudioEffectStore.md +79 -75
  141. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +192 -0
  142. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +146 -0
  143. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +309 -0
  144. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +370 -0
  145. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +339 -0
  146. package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +503 -0
  147. package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +188 -0
  148. package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/LikeStore.md +12 -10
  149. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +289 -0
  150. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +78 -0
  151. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +434 -0
  152. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +187 -0
  153. package/resource/knowledge/livekit/core-sdk/api-reference/web/index.md +780 -0
  154. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audience-list.md +59 -51
  155. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audio-effect.md +37 -34
  156. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-barrage.md +68 -38
  157. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-base-beauty.md +18 -15
  158. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-co-guest-interaction.md +17 -17
  159. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-gift.md +86 -80
  160. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-host-interaction.md +53 -49
  161. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-integration.md +47 -45
  162. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-live-list.md +26 -22
  163. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audience-list.md +16 -13
  164. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audio-effect.md +28 -24
  165. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-barrage.md +33 -21
  166. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-base-beauty.md +29 -25
  167. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-co-guest-interaction.md +21 -20
  168. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-gift.md +78 -69
  169. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-host-interaction.md +47 -43
  170. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-integration.md +48 -45
  171. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-live-list.md +27 -23
  172. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audience-list.md +15 -12
  173. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audio-effect.md +39 -36
  174. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-barrage.md +42 -29
  175. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-base-beauty.md +19 -16
  176. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-co-guest-interaction.md +20 -19
  177. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-gift.md +55 -49
  178. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-host-interaction.md +50 -46
  179. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-integration.md +48 -46
  180. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-live-list.md +26 -22
  181. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audience-list.md +59 -51
  182. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audio-effect.md +41 -38
  183. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-barrage.md +67 -37
  184. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +53 -46
  185. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-gift.md +86 -80
  186. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-host-interaction.md +45 -40
  187. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-integration.md +43 -42
  188. package/resource/knowledge/livekit/core-sdk/voice/android/voice-room-list.md +523 -0
  189. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audience-list.md +16 -13
  190. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audio-effect.md +54 -50
  191. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-barrage.md +33 -21
  192. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +34 -28
  193. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-gift.md +73 -64
  194. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-integration.md +46 -43
  195. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-room-list.md +165 -148
  196. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audience-list.md +19 -16
  197. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audio-effect.md +40 -37
  198. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-barrage.md +41 -28
  199. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +54 -47
  200. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-gift.md +52 -46
  201. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-host-interaction.md +55 -50
  202. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-integration.md +47 -45
  203. package/resource/knowledge/livekit/core-sdk/voice/ios/voice-room-list.md +404 -0
  204. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audience-list.md +40 -57
  205. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audio-effect.md +38 -49
  206. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-barrage.md +53 -53
  207. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-co-guest-interaction.md +106 -116
  208. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-gift.md +49 -59
  209. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-integration.md +52 -45
  210. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-room-list.md +38 -46
  211. package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +915 -0
  212. package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +179 -0
  213. package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +419 -0
  214. package/resource/knowledge/push/config/android/fcm.md +133 -0
  215. package/resource/knowledge/push/config/android/honor.md +111 -0
  216. package/resource/knowledge/push/config/android/huawei.md +106 -0
  217. package/resource/knowledge/push/config/android/meizu.md +121 -0
  218. package/resource/knowledge/push/config/android/oppo.md +108 -0
  219. package/resource/knowledge/push/config/android/vivo.md +101 -0
  220. package/resource/knowledge/push/config/android/xiaomi.md +99 -0
  221. package/resource/knowledge/push/integration/android.md +1028 -0
  222. package/resource/knowledge/push/integration/donut.md +271 -0
  223. package/resource/knowledge/push/integration/flutter.md +363 -0
  224. package/resource/knowledge/push/integration/harmonyos.md +72 -0
  225. package/resource/knowledge/push/integration/ios.md +705 -0
  226. package/resource/knowledge/push/integration/react-native.md +337 -0
  227. package/resource/knowledge/push/integration/uni-app.md +461 -0
  228. package/resource/knowledge/push/integration/unity.md +357 -0
  229. package/resource/knowledge/push/integration/unreal-engine.md +353 -0
  230. package/resource/knowledge/push/overview/prepare.md +30 -0
  231. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/call-user-to-room.md +22 -20
  232. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-participant-state.md +22 -193
  233. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-state.md +33 -32
  234. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/schedule-room.md +30 -29
  235. package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +230 -0
  236. package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-participant-state.md +22 -21
  237. package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-state.md +29 -28
  238. package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/schedule-room.md +17 -16
  239. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/call-user-to-room.md +22 -20
  240. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-participant-state.md +49 -218
  241. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-state.md +37 -37
  242. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/schedule-room.md +28 -28
  243. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/call-user-to-room.md +122 -7
  244. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/device-detection.md +318 -3
  245. package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +1504 -0
  246. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/free-beauty-panel.md +4 -3
  247. package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +709 -0
  248. package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +1105 -0
  249. package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +635 -0
  250. package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +529 -0
  251. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/schedule-room.md +256 -13
  252. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/screen-share.md +218 -25
  253. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/virtual-background.md +4 -3
  254. package/resource/{doc/roomkit → knowledge/roomkit/preset}/android/integration.md +50 -64
  255. package/resource/{doc/roomkit → knowledge/roomkit/preset}/flutter/integration.md +34 -31
  256. package/resource/{doc/roomkit → knowledge/roomkit/preset}/ios/integration.md +45 -53
  257. package/resource/knowledge/roomkit/preset/react/integration.md +571 -0
  258. package/resource/{doc → knowledge}/rtcengine/web/how_to_run_web_sdk_demo.md +31 -15
  259. package/resource/{doc → knowledge}/rtcengine/web/plugin/21-advanced-auto-play-policy.md +9 -3
  260. package/resource/{doc → knowledge}/rtcengine/web/plugin/22-advanced-audio-mixer.md +1 -1
  261. package/resource/{doc → knowledge}/rtcengine/web/plugin/23-advanced-support-detection.md +1 -1
  262. package/resource/{doc → knowledge}/rtcengine/web/plugin/24-advanced-network-quality.md +6 -6
  263. package/resource/{doc → knowledge}/rtcengine/web/plugin/25-advanced-device-change.md +1 -1
  264. package/resource/{doc → knowledge}/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -4
  265. package/resource/{doc → knowledge}/rtcengine/web/plugin/27-advanced-small-stream.md +4 -4
  266. package/resource/{doc → knowledge}/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
  267. package/resource/{doc → knowledge}/trtc/android/TRTCCloud.md +547 -495
  268. package/resource/{doc → knowledge}/trtc/android/TRTCCloudDef.md +434 -403
  269. package/resource/{doc → knowledge}/trtc/android/TRTCCloudListener.md +394 -348
  270. package/resource/{doc → knowledge}/trtc/android/TRTCStatistics.md +17 -15
  271. package/resource/{doc → knowledge}/trtc/android/TXAudioEffectManager.md +227 -197
  272. package/resource/knowledge/trtc/android/TXBeautyManager.md +415 -0
  273. package/resource/{doc → knowledge}/trtc/android/TXDeviceManager.md +70 -63
  274. package/resource/{doc → knowledge}/trtc/android/TXLiteAVCode.md +19 -17
  275. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCCloud.md +599 -544
  276. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCStatistics.md +17 -15
  277. package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +502 -0
  278. package/resource/knowledge/trtc/c++/ITXDeviceManager.md +403 -0
  279. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCCloudCallback.md +439 -387
  280. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCTypeDef.md +417 -387
  281. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TXLiteAVCode.md +19 -17
  282. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloud.md +619 -559
  283. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloudDelegate.md +409 -360
  284. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCStatistics.md +17 -15
  285. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXAudioEffectManager.md +187 -164
  286. package/resource/knowledge/trtc/ios/TXBeautyManager.md +416 -0
  287. package/resource/knowledge/trtc/ios/TXDeviceManager.md +399 -0
  288. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiteAVCode.md +19 -17
  289. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiveSDKTypeDef.md +422 -396
  290. package/server-config.js +0 -1
  291. package/server.js +22 -11
  292. package/streamable-http.js +0 -1
  293. package/tools/call/get_native_call_uikit_integration.js +2 -4
  294. package/tools/call/get_native_callkit_core_integration.js +2 -6
  295. package/tools/call/get_web_call_uikit_integration.js +2 -4
  296. package/tools/chat/get_native_chat_uikit_integration.js +2 -4
  297. package/tools/chat/get_web_chat_uikit_integration.js +2 -4
  298. package/tools/common/get_usersig.js +0 -1
  299. package/tools/common/present_framework_choice.js +9 -4
  300. package/tools/common/record_answer.js +19 -26
  301. package/tools/common/record_feedback.js +17 -31
  302. package/tools/common/search_trtc_knowledge.js +44 -0
  303. package/tools/definitions/get_native_call_uikit_integration_def.js +2 -1
  304. package/tools/definitions/get_native_callkit_core_integration_def.js +2 -1
  305. package/tools/definitions/get_native_chat_uikit_integration_def.js +3 -2
  306. package/tools/definitions/get_native_livekit_core_integration_def.js +2 -1
  307. package/tools/definitions/get_usersig_def.js +0 -1
  308. package/tools/definitions/get_web_call_uikit_integration_def.js +2 -1
  309. package/tools/definitions/get_web_chat_uikit_integration_def.js +2 -1
  310. package/tools/definitions/get_web_live_uikit_integration_def.js +4 -3
  311. package/tools/definitions/get_web_room_core_integration_def.js +46 -0
  312. package/tools/definitions/get_web_room_uikit_integration_def.js +3 -1
  313. package/tools/definitions/integration-boundary.js +5 -0
  314. package/tools/definitions/present_framework_choice_def.js +11 -10
  315. package/tools/definitions/record_answer_def.js +9 -8
  316. package/tools/definitions/record_feedback_def.js +4 -3
  317. package/tools/definitions/search_trtc_knowledge_def.js +69 -0
  318. package/tools/index.js +5 -37
  319. package/tools/live/get_native_livekit_core_integration.js +1 -4
  320. package/tools/live/get_web_live_uikit_integration.js +2 -5
  321. package/tools/room/get_web_room_core_integration.js +47 -0
  322. package/tools/room/get_web_room_uikit_integration.js +2 -4
  323. package/utils/generate-structured-result.js +4 -11
  324. package/utils/generate-usersig.js +0 -1
  325. package/utils/get-device-identifier.js +0 -1
  326. package/utils/get-doc-content.js +14 -9
  327. package/utils/http-get.js +0 -1
  328. package/utils/http-post.js +0 -1
  329. package/utils/report-cls-client.js +22 -21
  330. package/utils/report-es-client.js +1 -2
  331. package/utils/report-runtime-error-cls-client.js +0 -1
  332. package/index.js.map +0 -1
  333. package/resource/doc/callkit/core-sdk/.gitkeep +0 -0
  334. package/resource/doc/callkit/core-sdk/android/answer-call.md +0 -942
  335. package/resource/doc/callkit/core-sdk/android/make-call.md +0 -876
  336. package/resource/doc/callkit/core-sdk/android/offline-push.md +0 -368
  337. package/resource/doc/callkit/core-sdk/flutter/answer-call.md +0 -1132
  338. package/resource/doc/callkit/core-sdk/flutter/make-call.md +0 -1206
  339. package/resource/doc/callkit/core-sdk/flutter/offline-push.md +0 -357
  340. package/resource/doc/callkit/core-sdk/ios/answer-call.md +0 -1009
  341. package/resource/doc/callkit/core-sdk/ios/make-call.md +0 -1154
  342. package/resource/doc/callkit/core-sdk/ios/offline-push.md +0 -470
  343. package/resource/doc/callkit/core-sdk/uni-app/answer-call.md +0 -1146
  344. package/resource/doc/callkit/core-sdk/uni-app/make-call.md +0 -1267
  345. package/resource/doc/callkit/faq/android-faq.md +0 -767
  346. package/resource/doc/callkit/faq/flutter-faq.md +0 -749
  347. package/resource/doc/callkit/faq/ios-faq.md +0 -759
  348. package/resource/doc/callkit/faq/web-faq.md +0 -753
  349. package/resource/doc/callkit/preset/android/api.md +0 -330
  350. package/resource/doc/callkit/preset/flutter/api.md +0 -401
  351. package/resource/doc/callkit/preset/ios/api.md +0 -282
  352. package/resource/doc/callkit/preset/ios/integration.md +0 -188
  353. package/resource/doc/callkit/preset/react/api.md +0 -600
  354. package/resource/doc/callkit/preset/react/integration.md +0 -86
  355. package/resource/doc/callkit/preset/vue/api.md +0 -600
  356. package/resource/doc/callkit/preset/vue/integration.md +0 -83
  357. package/resource/doc/chatkit/android/faq.md +0 -109
  358. package/resource/doc/chatkit/faq/android_sdk/client-api.md +0 -280
  359. package/resource/doc/chatkit/faq/common/product.md +0 -82
  360. package/resource/doc/chatkit/faq/common/server.md +0 -53
  361. package/resource/doc/chatkit/faq/common/server_error_code.md +0 -74
  362. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +0 -183
  363. package/resource/doc/chatkit/faq/flutter_sdk/faq.md +0 -54
  364. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +0 -279
  365. package/resource/doc/chatkit/faq/web_sdk/error_code.md +0 -47
  366. package/resource/doc/chatkit/faq/web_sdk/faq.md +0 -292
  367. package/resource/doc/chatkit/flutter/faq.md +0 -22
  368. package/resource/doc/chatkit/ios/faq.md +0 -109
  369. package/resource/doc/chatkit/react/components/avatar.md +0 -104
  370. package/resource/doc/chatkit/react/components/chat-header.md +0 -148
  371. package/resource/doc/chatkit/react/components/chat-setting.md +0 -117
  372. package/resource/doc/chatkit/react/components/chat.md +0 -38
  373. package/resource/doc/chatkit/react/components/component-list.md +0 -35
  374. package/resource/doc/chatkit/react/components/conversation-actions.md +0 -174
  375. package/resource/doc/chatkit/react/components/conversation-preview.md +0 -116
  376. package/resource/doc/chatkit/react/components/conversation-search.md +0 -57
  377. package/resource/doc/chatkit/react/components/search.md +0 -282
  378. package/resource/doc/chatkit/react/components/tuikit.md +0 -43
  379. package/resource/doc/chatkit/react/faq.md +0 -26
  380. package/resource/doc/chatkit/vue/components/avatar.md +0 -104
  381. package/resource/doc/chatkit/vue/components/chat-header.md +0 -149
  382. package/resource/doc/chatkit/vue/components/chat.md +0 -42
  383. package/resource/doc/chatkit/vue/components/component-list.md +0 -89
  384. package/resource/doc/chatkit/vue/components/tuikit.md +0 -45
  385. package/resource/doc/chatkit/vue/components/userpicker.md +0 -256
  386. package/resource/doc/chatkit/vue/faq.md +0 -35
  387. package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +0 -148
  388. package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +0 -316
  389. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +0 -419
  390. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +0 -325
  391. package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +0 -436
  392. package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +0 -165
  393. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +0 -239
  394. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +0 -74
  395. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +0 -417
  396. package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +0 -207
  397. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +0 -158
  398. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +0 -304
  399. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +0 -394
  400. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +0 -303
  401. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +0 -410
  402. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +0 -160
  403. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +0 -231
  404. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +0 -375
  405. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +0 -170
  406. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +0 -165
  407. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +0 -143
  408. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +0 -298
  409. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +0 -349
  410. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +0 -297
  411. package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +0 -471
  412. package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +0 -179
  413. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +0 -238
  414. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +0 -74
  415. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +0 -412
  416. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +0 -173
  417. package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +0 -365
  418. package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +0 -336
  419. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +0 -780
  420. package/resource/doc/livekit/preset/live/vue/components/barrage.md +0 -291
  421. package/resource/doc/livekit/preset/live/vue/components/co-guest-panel.md +0 -88
  422. package/resource/doc/livekit/preset/live/vue/components/live-audience-list.md +0 -164
  423. package/resource/doc/livekit/preset/live/vue/components/live-scene-panel.md +0 -130
  424. package/resource/doc/livekit/preset/live/vue/components/live-view.md +0 -203
  425. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +0 -211
  426. package/resource/doc/livekit/preset/live/vue/faq.md +0 -1
  427. package/resource/doc/roomkit/faq/common/error-code.md +0 -67
  428. package/resource/doc/roomkit/flutter/features/call-user-to-room.md +0 -228
  429. package/resource/doc/roomkit/vue/faq.md +0 -1
  430. package/resource/doc/roomkit/vue/features/device-state.md +0 -460
  431. package/resource/doc/roomkit/vue/features/room-chat.md +0 -369
  432. package/resource/doc/roomkit/vue/features/room-participant-state.md +0 -385
  433. package/resource/doc/roomkit/vue/features/room-state.md +0 -280
  434. package/resource/doc/roomkit/vue/features/room-view.md +0 -241
  435. package/resource/doc/roomkit/vue/integration.md +0 -315
  436. package/resource/doc/rtcengine/faq/web_sdk/.gitkeep +0 -0
  437. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +0 -472
  438. package/resource/doc/trtc/C++/ITXDeviceManager.md +0 -388
  439. package/resource/doc/trtc/android/TXBeautyManager.md +0 -403
  440. package/resource/doc/trtc/iOS/TXBeautyManager.md +0 -404
  441. package/resource/doc/trtc/iOS/TXDeviceManager.md +0 -382
  442. package/server-config.js.map +0 -1
  443. package/server.js.map +0 -1
  444. package/streamable-http.js.map +0 -1
  445. package/tools/call/get_callkit_api.js +0 -33
  446. package/tools/call/get_callkit_api.js.map +0 -1
  447. package/tools/call/get_native_call_uikit_integration.js.map +0 -1
  448. package/tools/call/get_native_callkit_core_integration.js.map +0 -1
  449. package/tools/call/get_web_call_uikit_integration.js.map +0 -1
  450. package/tools/chat/get_native_chat_uikit_feature_detail.js +0 -35
  451. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +0 -1
  452. package/tools/chat/get_native_chat_uikit_integration.js.map +0 -1
  453. package/tools/chat/get_web_chat_uikit_component_detail.js +0 -35
  454. package/tools/chat/get_web_chat_uikit_component_detail.js.map +0 -1
  455. package/tools/chat/get_web_chat_uikit_integration.js.map +0 -1
  456. package/tools/common/get_faq.js +0 -266
  457. package/tools/common/get_faq.js.map +0 -1
  458. package/tools/common/get_usersig.js.map +0 -1
  459. package/tools/common/present_framework_choice.js.map +0 -1
  460. package/tools/common/record_answer.js.map +0 -1
  461. package/tools/common/record_feedback.js.map +0 -1
  462. package/tools/common/record_skill_session.js +0 -69
  463. package/tools/common/record_skill_session.js.map +0 -1
  464. package/tools/definitions/get_callkit_api_def.js +0 -28
  465. package/tools/definitions/get_callkit_api_def.js.map +0 -1
  466. package/tools/definitions/get_faq_def.js +0 -41
  467. package/tools/definitions/get_faq_def.js.map +0 -1
  468. package/tools/definitions/get_native_call_uikit_integration_def.js.map +0 -1
  469. package/tools/definitions/get_native_callkit_core_integration_def.js.map +0 -1
  470. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +0 -31
  471. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +0 -1
  472. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +0 -1
  473. package/tools/definitions/get_native_livekit_core_features_def.js +0 -33
  474. package/tools/definitions/get_native_livekit_core_features_def.js.map +0 -1
  475. package/tools/definitions/get_native_livekit_core_integration_def.js.map +0 -1
  476. package/tools/definitions/get_native_trtc_sdk_docs_def.js +0 -32
  477. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +0 -1
  478. package/tools/definitions/get_usersig_def.js.map +0 -1
  479. package/tools/definitions/get_web_call_uikit_integration_def.js.map +0 -1
  480. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +0 -31
  481. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +0 -1
  482. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +0 -1
  483. package/tools/definitions/get_web_live_uikit_integration_def.js.map +0 -1
  484. package/tools/definitions/get_web_livekit_api_def.js +0 -27
  485. package/tools/definitions/get_web_livekit_api_def.js.map +0 -1
  486. package/tools/definitions/get_web_livekit_component_detail_def.js +0 -29
  487. package/tools/definitions/get_web_livekit_component_detail_def.js.map +0 -1
  488. package/tools/definitions/get_web_room_uikit_integration_def.js.map +0 -1
  489. package/tools/definitions/get_web_roomkit_feature_detail_def.js +0 -30
  490. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +0 -1
  491. package/tools/definitions/get_web_trtc_sdk_api_def.js +0 -25
  492. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +0 -1
  493. package/tools/definitions/get_web_trtc_sdk_integration_def.js +0 -25
  494. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +0 -1
  495. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +0 -25
  496. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +0 -1
  497. package/tools/definitions/present_framework_choice_def.js.map +0 -1
  498. package/tools/definitions/record_answer_def.js.map +0 -1
  499. package/tools/definitions/record_feedback_def.js.map +0 -1
  500. package/tools/definitions/record_skill_session_def.js +0 -31
  501. package/tools/definitions/record_skill_session_def.js.map +0 -1
  502. package/tools/index.js.map +0 -1
  503. package/tools/live/get_native_livekit_core_features.js +0 -68
  504. package/tools/live/get_native_livekit_core_features.js.map +0 -1
  505. package/tools/live/get_native_livekit_core_integration.js.map +0 -1
  506. package/tools/live/get_web_live_uikit_integration.js.map +0 -1
  507. package/tools/live/get_web_livekit_api.js +0 -33
  508. package/tools/live/get_web_livekit_api.js.map +0 -1
  509. package/tools/live/get_web_livekit_component_detail.js +0 -35
  510. package/tools/live/get_web_livekit_component_detail.js.map +0 -1
  511. package/tools/room/get_web_room_uikit_integration.js.map +0 -1
  512. package/tools/room/get_web_roomkit_feature_detail.js +0 -69
  513. package/tools/room/get_web_roomkit_feature_detail.js.map +0 -1
  514. package/tools/rtcengine/get_web_trtc_sdk_api.js +0 -32
  515. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +0 -1
  516. package/tools/rtcengine/get_web_trtc_sdk_integration.js +0 -32
  517. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +0 -1
  518. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +0 -32
  519. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +0 -1
  520. package/tools/trtc/get_native_trtc_sdk_docs.js +0 -74
  521. package/tools/trtc/get_native_trtc_sdk_docs.js.map +0 -1
  522. package/utils/build-session-directives.js +0 -122
  523. package/utils/build-session-directives.js.map +0 -1
  524. package/utils/generate-structured-result.js.map +0 -1
  525. package/utils/generate-usersig.js.map +0 -1
  526. package/utils/get-device-identifier.js.map +0 -1
  527. package/utils/get-doc-content.js.map +0 -1
  528. package/utils/handle-framework.js +0 -9
  529. package/utils/handle-framework.js.map +0 -1
  530. package/utils/handle-state-name.js +0 -29
  531. package/utils/handle-state-name.js.map +0 -1
  532. package/utils/http-get.js.map +0 -1
  533. package/utils/http-post.js.map +0 -1
  534. package/utils/report-cls-client.js.map +0 -1
  535. package/utils/report-es-client.js.map +0 -1
  536. package/utils/report-runtime-error-cls-client.js.map +0 -1
  537. /package/resource/{doc/callkit/faq/common → knowledge/callkit/faq}/error-code.md +0 -0
  538. /package/resource/{doc/livekit/faq/common → knowledge/livekit/faq}/error-code.md +0 -0
  539. /package/resource/{doc → knowledge}/rtcengine/web/api.md +0 -0
  540. /package/resource/{doc/rtcengine/faq/web/web.md → knowledge/rtcengine/web/faq.md} +0 -0
  541. /package/resource/{doc → knowledge}/rtcengine/web/how_to_integrated_web_sdk.md +0 -0
  542. /package/resource/{doc → knowledge}/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +0 -0
  543. /package/resource/{doc → knowledge}/rtcengine/web/plugin/28-advanced-beauty.md +0 -0
  544. /package/resource/{doc → knowledge}/rtcengine/web/plugin/29-advanced-water-mark.md +0 -0
  545. /package/resource/{doc → knowledge}/rtcengine/web/plugin/30-advanced-cross-room-link.md +0 -0
  546. /package/resource/{doc → knowledge}/rtcengine/web/plugin/34-advanced-proxy.md +0 -0
  547. /package/resource/{doc → knowledge}/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -0
  548. /package/resource/{doc → knowledge}/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -0
  549. /package/resource/{doc → knowledge}/rtcengine/web/plugin/37-advanced-voice-changer.md +0 -0
  550. /package/resource/{doc → knowledge}/rtcengine/web/plugin/38-advanced-basic-beauty.md +0 -0
  551. /package/resource/{doc → knowledge}/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -0
  552. /package/resource/{doc → knowledge}/rtcengine/web/plugin/40-advanced-video-mixer.md +0 -0
  553. /package/resource/{doc → knowledge}/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +0 -0
  554. /package/resource/{doc → knowledge}/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +0 -0
  555. /package/resource/{doc → knowledge}/rtcengine/web/plugin/43-advanced-face-detection.md +0 -0
  556. /package/resource/{doc/rtcengine/faq/common → knowledge/share}/userSig.md +0 -0
@@ -1,7 +1,8 @@
1
1
  `GiftStore` 是 `AtomicXCore` 中专门负责管理直播间礼物功能的模块。通过它,您可以为您的直播应用构建一套完整的礼物系统,实现丰富的营收和互动场景。
2
- | 礼物面板 | 弹幕礼物 | 全屏礼物 |
3
- | --- | --- | --- |
4
- | | | |
2
+
3
+ |礼物面板|弹幕礼物|全屏礼物|
4
+ |---------|---------|---------|
5
+ ||||
5
6
 
6
7
  ## 核心功能
7
8
  - **礼物列表获取**:从服务端拉取礼物面板所需的数据,包括礼物分类和礼物详情。
@@ -13,13 +14,14 @@
13
14
  ## 核心概念
14
15
 
15
16
  在开始集成之前,我们先通过下表了解一下 `GiftStore` 相关的几个核心概念:
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 来接收礼物事件。 |
17
+
18
+ |**核心概念**|**类型**|**核心职责与描述**|
19
+ |---------|---------|---------|
20
+ |`Gift`|`struct`|代表一个具体的礼物数据模型。包含了礼物的 ID、名称、图标地址、动画资源地址 (resourceURL) 和价格 (coins) 等。|
21
+ |`GiftCategory`|`struct`|代表一个礼物分类,例如“热门”、“豪华”等。它包含了分类的名称以及该分类下的 **Gift **列表。|
22
+ |`GiftState`|`struct`|代表礼物模块的当前状态。其核心属性 usableGifts 是一个 [GiftCategory] 数组,存储了从服务端拉取到的完整礼物列表。|
23
+ |`GiftEvent`|`enum`|代表直播间内发生的礼物事件。目前只有 .onReceiveGift,当有任何人(包括自己)调用发送礼物接口时,房间内所有人都会收到此事件。|
24
+ |`GiftStore`|`class`|这是与礼物功能交互的核心管理类。通过它,您可以拉取礼物列表、调用发送礼物接口,并通过订阅其 giftEventPublisher 来接收礼物事件。|
23
25
 
24
26
  ## 实现步骤
25
27
 
@@ -96,26 +98,26 @@ class GiftManager {
96
98
  #### 礼物列表结构体参数
97
99
  - `GiftCategory`**参数说明**
98
100
 
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 礼物对象数组。 |
101
+ |**参数**|**类型**|**描述**|
102
+ |---------|---------|---------|
103
+ |`categoryID`|`String`|礼物分类的唯一 ID。|
104
+ |`name`|`String`|礼物分类的显示名称。|
105
+ |`desc`|`String`|礼物分类的描述信息。|
106
+ |`extensionInfo`|`[String: String]`|扩展信息字段。|
107
+ |`giftList`|`[`[`Gift`](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/gift)`]`|该分类下包含的 Gift 礼物对象数组。|
106
108
 
107
109
  - `Gift`** 参数说明**
108
110
 
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]` | 扩展信息字段。 |
111
+ |**参数**|**类型**|**描述**|
112
+ |---------|---------|---------|
113
+ |`giftID`|`String`| 礼物的唯一 ID。|
114
+ |`name`|`String`| 礼物的显示名称。|
115
+ |`desc`|`String`| 礼物的描述信息。|
116
+ |`iconURL`|`String`| 礼物图标 URL。|
117
+ |`resourceURL`|`String`| 礼物动画资源 URL。|
118
+ |`level`|`UInt`| 礼物等级。|
119
+ |`coins`|`UInt`| 礼物价格。|
120
+ |`extensionInfo`|`[String: String]`| 扩展信息字段。|
119
121
 
120
122
  ### 步骤3:获取礼物列表
121
123
 
@@ -177,11 +179,12 @@ extension GiftManager {
177
179
  ```
178
180
 
179
181
  #### `sendGift`接口参数
180
- | **参数名** | **类型** | **描述** |
181
- | --- | --- | --- |
182
- | `giftID` | `String` | 要发送的礼物的唯一 ID。 |
183
- | `count` | `UInt` | 发送的数量。 |
184
- | `completion` | `CompletionClosure?` | 发送完成后的回调。 |
182
+
183
+ |**参数名**|**类型**|**描述**|
184
+ |---------|---------|---------|
185
+ |`giftID`|`String`|要发送的礼物的唯一 ID。|
186
+ |`count`|`UInt`|发送的数量。|
187
+ |`completion`|`CompletionClosure?`|发送完成后的回调。|
185
188
 
186
189
  ## 功能进阶
187
190
 
@@ -235,9 +238,10 @@ extension GiftManager {
235
238
  #### 调用流程图
236
239
 
237
240
  #### 涉及 REST API 接口一览
238
- | 接口 | 说明 | 请求示例 |
239
- | --- | --- | --- |
240
- | 回调配置 - 调用发送礼物接口之前回调 | 客户后台可以通过该回调决定是否通过送礼前校验等场景 | 调用示例 |
241
+
242
+ |接口|说明|请求示例|
243
+ |---------|---------|---------|
244
+ |回调配置 - 调用发送礼物接口之前回调|客户后台可以通过该回调决定是否通过送礼前校验等场景|调用示例|
241
245
 
242
246
  ### 实现全屏礼物动画播放
243
247
 
@@ -246,13 +250,14 @@ extension GiftManager {
246
250
  #### 实现方式
247
251
 
248
252
  `AtomicXCore` 本身不包含礼物动画播放器,您需要根据业务需求选择并集成第三方库。以下是两种方案的对比:
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,且文件大小可控 | 需要支持多种动画格式,或对动画性能/设备兼容性有更高要求 |
253
+
254
+ |**对比项**|**基础方案 (SVGAPlayer-iOS)**|**高级方案 (TCEffectPlayerKit)**|
255
+ |---------|---------|---------|
256
+ |计费|免费 (开源库)|付费 (需购买 License),请参见 [付费指引](https://cloud.tencent.com/document/product/616/116461)|
257
+ |集成方式|需手动集成 SVGAPlayer 库 (例如通过 CocoaPods)|需额外集成 TCEffectPlayerKit 并进行鉴权|
258
+ |动画格式支持|仅支持 SVGA|SVGA、PAG、WebP、Lottie、MP4 等多种格式|
259
+ |性能|建议 SVGA 文件 ≤ 10MB|支持更大的动画文件,复杂特效/多动画并发/低端机表现更优|
260
+ |推荐场景|礼物动画格式统一为 SVGA,且文件大小可控|需要支持多种动画格式,或对动画性能/设备兼容性有更高要求|
256
261
 
257
262
  本章节主要演示基础方案的集成。如果您选择高级方案,请参考 [TCEffectPlayer 集成指引](https://cloud.tencent.com/document/product/616/116474)。
258
263
 
@@ -372,10 +377,11 @@ private func setupGiftToBarrageFlow() {
372
377
  ## API 文档
373
378
 
374
379
  关于 [GiftStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore) 及其相关类的所有公开接口、属性和方法的详细信息,请参阅随 [AtomicXCore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore) 框架的官方 API 文档。本指南使用到的相关 Store 如下:
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) |
380
+
381
+ |Store/Component|功能描述|API 文档|
382
+ |---------|---------|---------|
383
+ |GiftStore|礼物互动:获取礼物列表,发送 / 接收礼物,监听礼物事件(含发送者、礼物详情)。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/giftstore)|
384
+ |BarrageStore|弹幕功能:发送文本 / 自定义弹幕,维护弹幕列表,实时监听弹幕状态。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore)|
379
385
 
380
386
  ## 常见问题
381
387
 
@@ -1,18 +1,19 @@
1
1
  `AtomicXCore` 提供了 `CoHostStore` 和 `BattleStore` 两个模块,分别用于处理**跨房连线**和 **PK 对战**。本文将指导您如何组合使用这两个工具,完成语聊房场景下的连线和 PK 功能的开发。
2
2
 
3
3
  ## 核心概念
4
- | **核心概念** | **类型** | **核心职责与描述** |
5
- | --- | --- | --- |
6
- | **CoHostStore** | class | 管理主播间的连线生命周期,提供连线功能 API(requestHostConnection、acceptHostConnection)。 |
7
- | **BattleStore** | class | 管理跨房 PK 对战的信令与数据,包括 PK 状态。 |
8
- | **LiveListStore** | class | 提供直播房间列表的拉取功能 (`fetchLiveList`),用于获取可连线的其他房间信息。 |
9
- | **LiveSeatStore** | class | 管理房间内所有麦位状态(包括连线状态下的跨房间麦位),用于监听用户上下麦、麦克风等状态。 |
10
- | **CoHostLayoutTemplate** | enum | 连线时,用于指定房间麦位布局模板,例如`.hostStaticVoice6v6`。 |
11
- | **BattleConfig** | struct | 配置 PK 的详细信息,例如 PK 时长 (`duration`) 和是否需要二次响应 (`needResponse`)。 |
4
+
5
+ |**核心概念**|**类型**|**核心职责与描述**|
6
+ |---------|---------|---------|
7
+ |**CoHostStore**|class|管理主播间的连线生命周期,提供连线功能 API(requestHostConnection、acceptHostConnection)。|
8
+ |**BattleStore**|class|管理跨房 PK 对战的信令与数据,包括 PK 状态。|
9
+ |**LiveListStore**|class|提供直播房间列表的拉取功能 (`fetchLiveList`),用于获取可连线的其他房间信息。|
10
+ |**LiveSeatStore**|class|管理房间内所有麦位状态(包括连线状态下的跨房间麦位),用于监听用户上下麦、麦克风等状态。|
11
+ |**CoHostLayoutTemplate**|enum|连线时,用于指定房间麦位布局模板,例如`.hostStaticVoice6v6`。|
12
+ |**BattleConfig**|struct|配置 PK 的详细信息,例如 PK 时长 (`duration`) 和是否需要二次响应 (`needResponse`)。|
12
13
 
13
14
  ## 前提条件
14
15
 
15
- 请参考 快速接入 集成 **AtomicXCore SDK**,并完成 **主播开播** 和 **观众观看** 的功能实现。
16
+ 请参考 开播与收听 集成 **AtomicXCore SDK**,并完成 **主播开播** 和 **观众观看** 的功能实现。
16
17
 
17
18
  ## 主播发起一场连线
18
19
 
@@ -25,8 +26,8 @@
25
26
  > **注意:**
26
27
  >
27
28
  > - 如果接口返回的列表中没有找到您想要的直播间,您需要检查开播时设置的 `TUILiveInfo` 的 `isPublicVisible` 字段是否为 `true`;
28
- > - 该接口支持分页继续拉取,您可以使用`result`为 `success` 时的`cursor`作为下一次续拉的游标,如果返回的 `cursor` 为空,则表示直播间列表已全部拉取完;
29
- > - 为了性能考虑,建议您将count设置为 20。
29
+ > - 该接口支持分页继续拉取,您可以使用 `result` 为 `success` 时的 `cursor` 作为下一次续拉的游标,如果返回的 `cursor` 为空,则表示直播间列表已全部拉取完;
30
+ > - 为了性能考虑,建议您将 count 设置为 20。
30
31
 
31
32
  ``` swift
32
33
  import AtomicXCore
@@ -57,8 +58,8 @@ func fetchLiveListForCoHost() {
57
58
  > **说明:**
58
59
  >
59
60
  > - AtomicXCore最大支持 **9** 个房间互相连线,每个房间支持 **50 **路用户。
60
- > - 该接口支持批量发起邀请,您可以按需使用;单个直播间是否邀请成功,您需要在 `completion` 回调中检查`Result`是否为`.success`。
61
- > - 该接口支持扩展字段,邀请发送成功后,该字段会随着 `CoHostEventPublisher ` 的 `onCoHostRequestReceived` 回调通知给对端主播,您可以在这个字段中携带 “**是否立即开始 PK 对战**” 等信息,来实现自己的特殊业务。
61
+ > - 该接口支持批量发起邀请,您可以按需使用;单个直播间是否邀请成功,您需要在 `completion` 回调中检查 `Result` 是否为`.success`。
62
+ > - 该接口支持扩展字段,邀请发送成功后,该字段会随着 `CoHostEventPublisher` 的 `onCoHostRequestReceived` 回调通知给对端主播,您可以在这个字段中携带 “**是否立即开始 PK 对战**” 等信息,来实现自己的特殊业务。
62
63
 
63
64
  ``` swift
64
65
  import AtomicXCore
@@ -197,7 +198,7 @@ liveSeatStore.state.subscribe(StatePublisherSelector(keyPath: \LiveSeatState.sea
197
198
 
198
199
  ### 步骤6:连线过程中继续邀请其他主播参与连线
199
200
 
200
- AtomicXCore 支持您在已经连线的过程中,还可以继续邀请其他主播参与连线,您可以继续调用`requestHostConnection`邀请新的主播参与连线。
201
+ AtomicXCore 支持您在已经连线的过程中,还可以继续邀请其他主播参与连线,您可以继续调用 `requestHostConnection` 邀请新的主播参与连线。
201
202
  ``` swift
202
203
  import AtomicXCore
203
204
 
@@ -246,10 +247,11 @@ func onExitButtonClicked() {
246
247
  ## 主播发起 PK
247
248
 
248
249
  主播发起 PK 支持两种主要业务流程,以满足不同直播互动需求。核心区别在于 PK 发起前房间的状态。
249
- | **PK 模式** | **房间状态(PK 前)** | **房间状态(PK 后)** |
250
- | --- | --- | --- |
251
- | **场景一:主播在连线后再发起 PK** | 双方**已连线** | 恢复连线状态 |
252
- | **场景二:主播发起带 PK 模式的连线** | 双方**未连线** | 恢复连线状态 |
250
+
251
+ |**PK 模式**|**房间状态(PK 前)**|**房间状态(PK 后)**|
252
+ |---------|---------|---------|
253
+ |**场景一:主播在连线后再发起 PK**|双方**已连线**|恢复连线状态|
254
+ |**场景二:主播发起带 PK 模式的连线**|双方**未连线**|恢复连线状态|
253
255
 
254
256
  ### 场景一:主播在连线后再发起 PK
255
257
 
@@ -258,7 +260,7 @@ AtomicXCore 支持您在这些主播中发起限时的对战 PK。交互如下
258
260
 
259
261
  2. 参与连线的主播,点击 PK 按钮发起一场限时的对战,可以通过主播收到的礼物数来判定对战的胜负。
260
262
 
261
- 3. 对端主播可以弹框提醒,并提示是否加入PK,当被邀请的主播同意后对战即刻开始。
263
+ 3. 对端主播可以弹框提醒,并提示是否加入 PK,当被邀请的主播同意后对战即刻开始。
262
264
 
263
265
  4. PK 开始后,UI 进入对战状态,显示 PK 进度条;该进度条可以是主播收到的礼物数,也可以是收到的点赞数等业务数据。
264
266
 
@@ -275,7 +277,7 @@ AtomicXCore 支持您在这些主播中发起限时的对战 PK。交互如下
275
277
  > - 当您不设置 `BattleConfig` 的 `duration` 字段时, PK 默认时长为 5 分钟。
276
278
  > - 当您不需要对端主播同意时,您可以设置 `BattleConfig` 的 `needResponse` 字段为 `false`,当邀请发出后 PK 会立即开始。
277
279
  > - 当 `BattleConfig` 的 `needResponse` 字段为 `false` 时,`requestBattle` 接口的 `timeout` 字段必须设置为 0。
278
- > - 当设置了超时时间后,如果对端主播在 timeout 时间内还未同意,当次的 PK 邀请会超时,主播和对端主播都会收到 `BattleEventPublisher ` 的 `onBattleRequestTimeout` 回调;参与连线的所有主播依然可以继续发起下一场 PK。
280
+ > - 当设置了超时时间后,如果对端主播在 timeout 时间内还未同意,当次的 PK 邀请会超时,主播和对端主播都会收到 `BattleEventPublisher` 的 `onBattleRequestTimeout` 回调;参与连线的所有主播依然可以继续发起下一场 PK。
279
281
 
280
282
  ``` swift
281
283
  var battleStore: BattleStore {
@@ -325,9 +327,9 @@ battleStore.battleEventPublisher
325
327
 
326
328
  - 当 `needResponse` 设置为 `true`,则当被邀请的所有对端主播都调用 `BattleStore` 的 `acceptBattle` 接口同意后进入 PK 状态。
327
329
 
328
- - 当 `needResponse` 设置为 `true`,若对端主播同意 PK,则已加入 PK 的主播会收到 `BattleEventPublisher ` 的 `onUserJoinBattle` 回调。
330
+ - 当 `needResponse` 设置为 `true`,若对端主播同意 PK,则已加入 PK 的主播会收到 `BattleEventPublisher` 的 `onUserJoinBattle` 回调。
329
331
 
330
- - 进入 PK 状态之后,参与 PK 的所有主播均会收到 `BattleEventPublisher ` 的 `onBattleStarted` 回调。
332
+ - 进入 PK 状态之后,参与 PK 的所有主播均会收到 `BattleEventPublisher` 的 `onBattleStarted` 回调。
331
333
 
332
334
  #### 步骤 4. 结束 PK 状态
333
335
 
@@ -339,7 +341,7 @@ battleStore.battleEventPublisher
339
341
 
340
342
  ##### 2. 主动调用 exitBattle 结束 PK
341
343
 
342
- 在 PK 过程中,参与 PK 的任一主播均可以调用 `BattleStore` 的 `exitBattle` 退出 PK,其他主播依然处于 PK 中不受影响,且会收到 `BattleEventPublisher` 的 `onUserExitBattle` 回调,您可以在这个回调中提醒 “有人退出 PK”;如果在 PK 的 `duration` 还未结束之前,其余人都主动调用 `BattleStore` 的 `exitBattle` 结束 PK 后,整个 PK 同样也会提前结束,最后一个 PK 主播也会收到 `BattleEventPublisher ` 的 `onUserExitBattle` 回调。
344
+ 在 PK 过程中,参与 PK 的任一主播均可以调用 `BattleStore` 的 `exitBattle` 退出 PK,其他主播依然处于 PK 中不受影响,且会收到 `BattleEventPublisher` 的 `onUserExitBattle` 回调,您可以在这个回调中提醒 “有人退出 PK”;如果在 PK 的 `duration` 还未结束之前,其余人都主动调用 `BattleStore` 的 `exitBattle` 结束 PK 后,整个 PK 同样也会提前结束,最后一个 PK 主播也会收到 `BattleEventPublisher` 的 `onUserExitBattle` 回调。
343
345
  ``` swift
344
346
  var battleStore: BattleStore {
345
347
  return BattleStore.create(liveID: liveID)
@@ -384,12 +386,12 @@ AtomicXCore 支持您在房间内直播时,直接发起 PK (中间不经历
384
386
 
385
387
  #### 步骤 1. 主播发起连线请求
386
388
 
387
- 此处的步骤与 《主播发起一场连线》中的步骤 1 和步骤 2 相似。唯一的区别在于:主播发起连线请求时,通过`CoHostStore` 的 `requestHostConnection` 接口设置`extraInfo`字段来标识当前的连线发起后需要同步发起 PK,用于对端主播 UI 提示信息的区分。
389
+ 此处的步骤与 《主播发起一场连线》中的步骤 1 和步骤 2 相似。唯一的区别在于:主播发起连线请求时,通过 `CoHostStore` 的 `requestHostConnection` 接口设置 `extraInfo` 字段来标识当前的连线发起后需要同步发起 PK,用于对端主播 UI 提示信息的区分。
388
390
 
389
391
  例如:
390
- - 当 `extraInfo`设置为 `{"withPK:true"}` 时,对端主播收到连线请求后 UI 提示 “主播向您发起 PK”。
392
+ - 当 `extraInfo` 设置为 `{"withPK:true"}` 时,对端主播收到连线请求后 UI 提示 “主播向您发起 PK”。
391
393
 
392
- - 当 `extraInfo`设置为 `{"withPK:false"}` 时,对端主播收到连线请求后 UI 提示 “主播邀请您参与跨房连线”。
394
+ - 当 `extraInfo` 设置为 `{"withPK:false"}` 时,对端主播收到连线请求后 UI 提示 “主播邀请您参与跨房连线”。
393
395
 
394
396
  ``` swift
395
397
  import AtomicXCore
@@ -527,12 +529,13 @@ coHostStore.coHostEventPublisher
527
529
 
528
530
  > LiveKit 后台的 PK 分数系统采用纯数值计算和累加机制,所以您需要根据自身的运营策略和业务需求,调用更新接口前完成 PK 分数的计算,您可以参考以下的 PK 分数计算示例:
529
531
  >
530
- | 礼物类型 | 分数计算规则 | 示例 |
531
- | --- | --- | --- |
532
- | ​基础礼物​ | 礼物价值 × 5 | 10元礼物 → 50分 |
533
- | ​中级礼物​ | 礼物价值 × 8 | 50元礼物 → 400分 |
534
- | ​高级礼物​ | 礼物价值 × 12 | 100元礼物 → 1200分 |
535
- | ​特效礼物​ | 固定高分数 | 520元礼物 → 1314分 |
532
+
533
+ |礼物类型|分数计算规则|示例|
534
+ |---------|---------|---------|
535
+ |​基础礼物​|礼物价值 × 5|10元礼物 → 50分|
536
+ |​中级礼物​|礼物价值 × 8|50元礼物 → 400分|
537
+ |​高级礼物​|礼物价值 × 12|100元礼物 → 1200分|
538
+ |​特效礼物​|固定高分数|520元礼物 → 1314分<br>|
536
539
 
537
540
  #### REST API 调用流程
538
541
 
@@ -543,19 +546,20 @@ coHostStore.coHostEventPublisher
543
546
 
544
547
  - 主动查询​:您的后台服务可主动调用 PK 状态查询 接口,随时查询当前 PK 状态。
545
548
 
546
- 2. **PK分数计算**​:您的后台服务根据业务规则(如上述示例),计算 PK 分数增量。
549
+ 2. **PK 分数计算**​:您的后台服务根据业务规则(如上述示例),计算 PK 分数增量。
547
550
 
548
- 3. **PK分数更新​**:您的后台服务调用 修改 PK 分数 接口,向 LiveKit 后台更新 PK 分数。
551
+ 3. **PK 分数更新​**:您的后台服务调用 修改 PK 分数 接口,向 LiveKit 后台更新 PK 分数。
549
552
 
550
- 4. **LiveKit后台 同步客户端**​:LiveKit 后台自动将更新后的 PK 分数同步到所有客户端。
553
+ 4. **LiveKit 后台 同步客户端**​:LiveKit 后台自动将更新后的 PK 分数同步到所有客户端。
551
554
 
552
555
  #### 涉及的 REST API 接口
553
- | 接口 | 功能描述 | 请求示例 |
554
- | --- | --- | --- |
555
- | 主动接口 - 查询 PK 状态 | 可根据此接口查询当前房间是否在 PK | 请求示例 |
556
- | 主动接口 - 修改 PK 分数 | 将计算后的 PK 数值通过此接口更新 | 请求示例 |
557
- | 回调配置 - PK 开始时回调 | 客户后台可以通过该回调及时知晓 PK 开启 | 回调示例 |
558
- | 回调配置 - PK 结束时回调 | 客户后台可以通过该回调及时知晓 PK 结束 | 回调示例 |
556
+
557
+ |接口|功能描述|请求示例|
558
+ |---------|---------|---------|
559
+ |主动接口 - 查询 PK 状态|可根据此接口查询当前房间是否在 PK。|请求示例|
560
+ |主动接口 - 修改 PK 分数|将计算后的 PK 数值通过此接口更新。|请求示例|
561
+ |回调配置 - PK 开始时回调|客户后台可以通过该回调及时知晓 PK 开启。|回调示例|
562
+ |回调配置 - PK 结束时回调|客户后台可以通过该回调及时知晓 PK 结束。|回调示例|
559
563
 
560
564
  ### 区分 PK 胜负
561
565
 
@@ -575,12 +579,13 @@ battleStore.state.subscribe(StatePublisherSelector(keyPath: \BattleState.battleS
575
579
  ## API 文档
576
580
 
577
581
  关于 `CoHostStore`、`BattleStore`、`LiveListStore` 和 `LiveSeatStore` 及其相关类的所有公开接口、属性和方法的详细信息,请参阅随 [**AtomicXCore**](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore) 框架的官方 API 文档。
578
- | **Store/Component** | **功能描述** | **API 文档** |
579
- | --- | --- | --- |
580
- | **CoHostStore** | 主播连线生命周期管理: 负责管理和协调主播间连线的生命周期,包括发起连线邀请、处理接受/拒绝、连线状态切换、连线中的视频流管理以及断开连线等任务。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore) |
581
- | **BattleStore** | 主播 PK 对战生命周期管理: 负责管理主播间的限时 PK 对战全生命周期,包括发起 PK 邀请、开始对战、实时更新 PK 分数、PK 结束结算胜负以及惩罚时间等流程。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/battlestore) |
582
- | **LiveListStore** | 直播间全生命周期管理:查询房间列表,修改直播信息等。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveliststore) |
583
- | **LiveSeatStore** | 麦位状态管理: 管理房间内所有麦位状态(包括连线状态下的跨房间麦位),用于监听用户上下麦、麦克风、麦位状态等信息。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveseatstore) |
582
+
583
+ |**Store/Component**|**功能描述**|**API 文档**|
584
+ |---------|---------|---------|
585
+ |**CoHostStore**|主播连线生命周期管理: 负责管理和协调主播间连线的生命周期,包括发起连线邀请、处理接受/拒绝、连线状态切换、连线中的视频流管理以及断开连线等任务。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore)|
586
+ |**BattleStore**|主播 PK 对战生命周期管理: 负责管理主播间的限时 PK 对战全生命周期,包括发起 PK 邀请、开始对战、实时更新 PK 分数、PK 结束结算胜负以及惩罚时间等流程。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/battlestore)|
587
+ |**LiveListStore**|直播间全生命周期管理:查询房间列表,修改直播信息等。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveliststore)|
588
+ |**LiveSeatStore**|麦位状态管理: 管理房间内所有麦位状态(包括连线状态下的跨房间麦位),用于监听用户上下麦、麦克风、麦位状态等信息。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveseatstore)|
584
589
 
585
590
  ## 常见问题
586
591
 
@@ -597,13 +602,13 @@ battleStore.state.subscribe(StatePublisherSelector(keyPath: \BattleState.battleS
597
602
 
598
603
  - 检查网络连接是否通畅,邀请信令有 30 秒默认超时时间。
599
604
 
600
- #### 连线或 PK 过程中,一方主播网络断开或App崩溃了怎么办?
605
+ #### 连线或 PK 过程中,一方主播网络断开或 App 崩溃了怎么办?
601
606
 
602
- **CoHostStore** 和 **BattleStore** 内部都有心跳和超时检测机制。如果一方异常退出,另一方会通过 **onCoHostUserLeft** 或 **onUserExitBattle** 等事件收到通知,您可以根据这些事件来处理UI,例如提示"对方已掉线"并结束互动。
607
+ **CoHostStore** 和 **BattleStore** 内部都有心跳和超时检测机制。如果一方异常退出,另一方会通过 **onCoHostUserLeft** 或 **onUserExitBattle** 等事件收到通知,您可以根据这些事件来处理 UI,例如提示"对方已掉线"并结束互动。
603
608
 
604
609
  #### 为什么 PK 分数只能通过 REST API 更新?
605
610
 
606
- 因为 REST API能同时满足 PK 分数的**安全性、实时性、扩展性**需求:
611
+ 因为 REST API 能同时满足 PK 分数的**安全性、实时性、扩展性**需求:
607
612
  - **防篡改保公平**:需鉴权 + 数据校验,每笔更新可追溯来源(例如礼物行为),杜绝手动改分、刷分,保障竞技公平。
608
613
 
609
614
  - **多端实时同步**:用标准化格式(例如 JSON)快速对接礼物、PK、展示系统,确保主播 / 观众 / 后台分数实时一致,无延迟。
@@ -3,12 +3,12 @@
3
3
  ## 核心概念
4
4
 
5
5
  在开始集成之前,我们先通过下表了解一下 `LiveSeatStore` 相关的几个核心概念:
6
- | **核心概念** | **类型** | **核心职责与描述** |
6
+ | <strong>核心概念</strong> | <strong>类型</strong> | <strong>核心职责与描述</strong> |
7
7
  | --- | --- | --- |
8
- | `LiveSeatStore` | `class` | 麦位管理核心,负责管理房间内的所有麦位信息和麦位相关操作。<br>通过 `liveSeatState.seatList` 暴露实时的麦位列表数据流。 |
9
- | `LiveSeatState` | `struct` | 代表麦位的当前状态。<br>- `seatList` :是一个`[seatInfo]`类型数组,存储了麦位列表的实时状态。<br>- `speakingUsers` :则代表当前正在说话的人和对应的音量。 |
10
- | `SeatInfo` | `struct` | 单个麦位的数据模型。` LiveSeatStore` 所推送的麦位列表(`seatList`)就是由多个 `SeatInfo` 对象组成的。<br>关键字段:<br>- `index`:麦位的索引(位置)。<br>- `isLocked `:麦位是否被锁定。<br>- `userInfo`: 麦位上的用户信息。如果麦位为空,此字段也为空对象。 |
11
- | `SeatUserInfo` | `struct` | 麦上用户的详细数据模型。 当一个用户成功上麦后,`SeatInfo` 中的 `userInfo` 字段就会被填充为此用户。<br>关键字段:<br>- `userID`: 用户的唯一 ID。<br>- `userName`: 用户的昵称。<br>- `avatarURL`: 用户的头像 URL。<br>- `microphoneStatus`: 麦克风状态(开/关)。<br>- `cameraStatus`: 摄像头状态(开/关)。 |
8
+ | <code>LiveSeatStore</code> | <code>class</code> | 麦位管理核心,负责管理房间内的所有麦位信息和麦位相关操作。<br>通过 <code>liveSeatState.seatList</code> 暴露实时的麦位列表数据流。 |
9
+ | <code>LiveSeatState</code> | <code>struct</code> | 代表麦位的当前状态。<br>- <code>seatList</code> :是一个<code>[seatInfo]</code>类型数组,存储了麦位列表的实时状态。<br>- <code>speakingUsers</code> :则代表当前正在说话的人和对应的音量。 |
10
+ | <code>SeatInfo</code> | <code>struct</code> | 单个麦位的数据模型。<code> LiveSeatStore</code> 所推送的麦位列表(<code>seatList</code>)就是由多个 <code>SeatInfo</code> 对象组成的。<br>关键字段:<br>- <code>index</code>:麦位的索引(位置)。<br>- <code>isLocked </code>:麦位是否被锁定。<br>- <code>userInfo</code>: 麦位上的用户信息。如果麦位为空,此字段也为空对象。 |
11
+ | <code>SeatUserInfo</code> | <code>struct</code> | 麦上用户的详细数据模型。 当一个用户成功上麦后,<code>SeatInfo</code> 中的 <code>userInfo</code> 字段就会被填充为此用户。<br>关键字段:<br>- <code>userID</code>: 用户的唯一 ID。<br>- <code>userName</code>: 用户的昵称。<br>- <code>avatarURL</code>: 用户的头像 URL。<br>- <code>microphoneStatus</code>: 麦克风状态(开/关)。<br>- <code>cameraStatus</code>: 摄像头状态(开/关)。 |
12
12
 
13
13
  ## 准备工作
14
14
 
@@ -17,7 +17,7 @@
17
17
  请参见 开通服务,获取体验版或付费版 `SDK`。
18
18
 
19
19
  ### 步骤2:在当前项目中导入 AtomicXCore
20
- 1. **安装组件**:请在您的 **Podfile** 文件中添加 `pod 'AtomicXCore'` 依赖,然后执行`pod install`。
20
+ 1. **安装组件**:请在您的 **Podfile** 文件中添加 `pod 'AtomicXCore'` 依赖,然后执行 `pod install`。
21
21
 
22
22
  ``` ruby
23
23
  # Podfile
@@ -62,11 +62,11 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau
62
62
  ```
63
63
 
64
64
  **登录接口参数说明:**
65
- | **参数** | **类型** | **说明** |
65
+ | <strong>参数</strong> | <strong>类型</strong> | <strong>说明</strong> |
66
66
  | --- | --- | --- |
67
- | sdkAppId | Int32 | 从 [控制台](https://console.cloud.tencent.com/trtc) 获取,通常是以 `140` 或 `160` 开头的 10 位整数。 |
68
- | userID | String | 当前用户的唯一 ID,仅包含英文字母、数字、连字符和下划线。为避免多端登录冲突,**请勿使用**`1`、`123`**等简单 ID**。 |
69
- | userSig | String | 用于腾讯云鉴权的票据。请注意:<br>- 开发环境:您可以采用本地 `GenerateTestUserSig.genTestSig` 函数生成 userSig 或者通过 [UserSig 辅助工具](https://console.cloud.tencent.com/im/tool-usersig) 生成临时的 UserSig。<br>- 生产环境:为了防止密钥泄露,请务必采用服务端生成 UserSig 的方式。详细信息请参考 [服务端生成 UserSig](https://cloud.tencent.com/document/product/647/17275)。<br>更多信息请参见 [如何计算及使用 UserSig](https://cloud.tencent.com/document/product/647/17275)。 |
67
+ | sdkAppId | Int32 | 从 <a href="https://console.cloud.tencent.com/trtc">控制台</a> 获取,通常是以 <code>140</code> 或 <code>160</code> 开头的 10 位整数。 |
68
+ | userID | String | 当前用户的唯一 ID,仅包含英文字母、数字、连字符和下划线。为避免多端登录冲突,<strong>请勿使用</strong><code>1</code>、<code>123</code><strong>等简单 ID</strong>。 |
69
+ | userSig | String | 用于腾讯云鉴权的票据。请注意:<br>- 开发环境:您可以采用本地 <code>GenerateTestUserSig.genTestSig</code> 函数生成 userSig 或者通过 <a href="https://console.cloud.tencent.com/im/tool-usersig">UserSig 辅助工具</a> 生成临时的 UserSig。<br>- 生产环境:为了防止密钥泄露,请务必采用服务端生成 UserSig 的方式。详细信息请参考 <a href="https://cloud.tencent.com/document/product/647/17275">服务端生成 UserSig</a>。<br>更多信息请参见 <a href="https://cloud.tencent.com/document/product/647/17275">如何计算及使用 UserSig</a>。 |
70
70
 
71
71
  ## 搭建基础语聊房
72
72
 
@@ -186,27 +186,27 @@ class YourAnchorViewController: UIViewController {
186
186
  ```
187
187
 
188
188
  `LiveInfo`**参数说明**
189
- | **参数名** | **类型** | **属性** | **描述** |
189
+ | <strong>参数名</strong> | <strong>类型</strong> | <strong>属性</strong> | <strong>描述</strong> |
190
190
  | --- | --- | --- | --- |
191
- | `liveID` | `String` | 必填 | 直播间的唯一标识符。 |
192
- | `liveName` | `String` | 选填 | 直播间的标题。 |
193
- | `notice` | `String` | 选填 | 直播间的公告信息。 |
194
- | `isMessageDisable` | `Bool` | 选填 | 是否禁言(`true`:是,`false`:否)。 |
195
- | `isPublicVisible` | `Bool` | 选填 | 是否公开可见(`true`:是,`false`:否)。 |
196
- | `seatMode` | `TakeSeatMode` | 选填 | 上麦模式(`.free`:自由上麦,`.apply`:申请上麦)。 |
197
- | `seatTemplate` | `SeatLayoutTemplate` | 必填 | 麦位布局模板。 |
198
- | `coverURL` | `String` | 选填 | 直播间的封面图片地址。 |
199
- | `backgroundURL` | `String` | 选填 | 直播间的背景图片地址。 |
200
- | `categoryList` | `[NSNumber]` | 选填 | 直播间的分类标签列表。 |
201
- | `activityStatus` | `Int` | 选填 | 直播活动状态。 |
202
- | `isGiftEnabled` | `Boolean` | 选填 | 是否启用礼物功能(`true`:是,`false`:否)。 |
191
+ | <code>liveID</code> | <code>String</code> | 必填 | 直播间的唯一标识符。 |
192
+ | <code>liveName</code> | <code>String</code> | 选填 | 直播间的标题。 |
193
+ | <code>notice</code> | <code>String</code> | 选填 | 直播间的公告信息。 |
194
+ | <code>isMessageDisable</code> | <code>Bool</code> | 选填 | 是否禁言(<code>true</code>:是,<code>false</code>:否)。 |
195
+ | <code>isPublicVisible</code> | <code>Bool</code> | 选填 | 是否公开可见(<code>true</code>:是,<code>false</code>:否)。 |
196
+ | <code>seatMode</code> | <code>TakeSeatMode</code> | 选填 | 上麦模式(<code>.free</code>:自由上麦,<code>.apply</code>:申请上麦)。 |
197
+ | <code>seatTemplate</code> | <code>SeatLayoutTemplate</code> | 必填 | 麦位布局模板。 |
198
+ | <code>coverURL</code> | <code>String</code> | 选填 | 直播间的封面图片地址。 |
199
+ | <code>backgroundURL</code> | <code>String</code> | 选填 | 直播间的背景图片地址。 |
200
+ | <code>categoryList</code> | <code>[NSNumber]</code> | 选填 | 直播间的分类标签列表。 |
201
+ | <code>activityStatus</code> | <code>Int</code> | 选填 | 直播活动状态。 |
202
+ | <code>isGiftEnabled</code> | <code>Boolean</code> | 选填 | 是否启用礼物功能(<code>true</code>:是,<code>false</code>:否)。 |
203
203
 
204
204
  #### **4. 构建麦位 UI 界面**
205
205
 
206
206
  > **提示:**
207
207
  >
208
208
 
209
- > 麦位 `UI` 效果的业务代码,您也可以参考 `TUILiveKit` 开源项目中的 [SeatGridView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/SeatGridview/SeatGridView.swift) 文件来了解完整的实现逻辑。
209
+ > 麦位 `UI` 效果的业务代码,您也可以参考 `TUILiveKit` 开源项目中的 [SeatGridView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Component/SeatGridview/SeatGridView.swift) 文件来了解完整的实现逻辑。
210
210
  >
211
211
 
212
212
  通过 `LiveSeatStore` 实例,监听 `state.seatList` 的变化,以实时获取麦位数据来渲染您的 UI。您可以在 `ViewController` 中(例如 `YourAnchorViewController` 或 `YourAudienceViewController`)通过以下方式监听数据:
@@ -398,7 +398,7 @@ class YourAudienceViewController: UIViewController {
398
398
  > **提示:**
399
399
  >
400
400
 
401
- > 麦上用户说话时展示波浪动画效果,您也可以参考 `TUILiveKit` 开源项目中的 [SeatGridView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/SeatGridview/SeatGridView.swift) 文件来了解完整的实现逻辑。
401
+ > 麦上用户说话时展示波浪动画效果,您也可以参考 `TUILiveKit` 开源项目中的 [SeatGridView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Component/SeatGridview/SeatGridView.swift) 文件来了解完整的实现逻辑。
402
402
  >
403
403
 
404
404
  在 `YourAnchorViewController` 或 `YourAudienceViewController` 中监听 `speakingUsers` 变化,并更新“正在说话”状态,代码示例如下:
@@ -438,28 +438,30 @@ class YourAnchorViewController: UIViewController {
438
438
  ## 丰富语聊房场景
439
439
 
440
440
  当您完成了基础的语聊房功能后,您可以参考以下功能指南来为语聊房添加丰富的互动玩法。
441
- | **功能** | **功能介绍** | **功能 Stores** | **实现指南** |
442
- | --- | --- | --- | --- |
443
- | **实现听众上麦** | 听众申请上麦,与房主进行实时语音互动。 | [CoGuestStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore) | 观众上麦 |
444
- | **实现房主跨房连线 PK** | 两个不同房间的主播进行连线,实现互动或 PK。 | [CoHostStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore)<br>[BattleStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/battlestore) | 主播连线和 PK |
445
- | **添加弹幕聊天功能** | 房间内成员可以发送和接收实时文字消息。 | [BarrageStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore) | 实现弹幕功能 |
446
- | **构建礼物赠送系统** | 观众可以向主播赠送虚拟礼物,增加互动和趣味性。 | [GiftStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/giftstore) | 实现礼物功能 |
441
+
442
+ |**功能**|**功能介绍**|**功能 Stores**|**实现指南**|
443
+ |---------|---------|---------|---------|
444
+ |**实现听众上麦**|听众申请上麦,与房主进行实时语音互动。|[CoGuestStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore)|观众上麦|
445
+ |**实现房主跨房连线 PK**|两个不同房间的主播进行连线,实现互动或 PK。|[CoHostStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore)<br>[BattleStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/battlestore)|主播连线和 PK|
446
+ |**添加弹幕聊天功能**|房间内成员可以发送和接收实时文字消息。|[BarrageStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore)|实现弹幕功能|
447
+ |**构建礼物赠送系统**|观众可以向主播赠送虚拟礼物,增加互动和趣味性。|[GiftStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/giftstore)|实现礼物功能|
447
448
 
448
449
  ## API 文档
449
- | **Store/Component** | **功能描述** | **API 文档** |
450
- | --- | --- | --- |
451
- | **LiveListStore** | 直播间全生命周期管理:创建 / 加入 / 离开 / 销毁房间,查询房间列表,修改直播信息(名称、公告等),监听直播状态(例如被踢出、结束)。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveliststore) |
452
- | **LiveSeatStore** | 麦位管理核心:管理麦位列表、麦上用户状态、麦位相关操作(上麦、下麦、踢人、锁麦、开关麦克风/摄像头等),监听麦位事件。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveseatstore) |
453
- | **DeviceStore** | 音视频设备控制:麦克风(开关 / 音量)、摄像头(开关 / 切换 / 画质)、屏幕共享,设备状态实时监听。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/devicestore/) |
454
- | **CoGuestStore** | 观众连麦管理:连麦申请 / 邀请 / 同意 / 拒绝,连麦成员权限控制(麦克风 / 摄像头),状态同步。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore/) |
455
- | **CoHostStore** | 主播跨房连线:支持多布局模板(动态网格等),发起 / 接受 / 拒绝连线,连麦主播互动管理。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore/) |
456
- | **BattleStore** | 主播 PK 对战:发起 PK(配置时长 / 对手),管理 PK 状态(开始 / 结束),同步分数,监听对战结果。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/battlestore) |
457
- | **GiftStore** | 礼物互动:获取礼物列表,发送 / 接收礼物,监听礼物事件(含发送者、礼物详情)。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/giftstore/) |
458
- | **BarrageStore** | 弹幕功能:发送文本 / 自定义弹幕,维护弹幕列表,实时监听弹幕状态。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore) |
459
- | **LikeStore** | 点赞互动:发送点赞,监听点赞事件,同步总点赞数。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/likestore) |
460
- | **LiveAudienceStore** | 观众管理:获取实时观众列表(ID / 名称 / 头像),统计观众数量,监听观众进出事件。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveaudiencestore) |
461
- | **AudioEffectStore** | 音频特效:变声(童声 / 男声)、混响(KTV 等)、耳返调节,实时切换特效。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/audioeffectstore) |
462
- | **BaseBeautyStore** | 基础美颜:调节磨皮 / 美白 / 红润(0-100 级),重置美颜状态,同步效果参数。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/basebeautystore) |
450
+
451
+ |**Store/Component**|**功能描述**|**API 文档**|
452
+ |---------|---------|---------|
453
+ |**LiveListStore**|直播间全生命周期管理:创建 / 加入 / 离开 / 销毁房间,查询房间列表,修改直播信息(名称、公告等),监听直播状态(例如被踢出、结束)。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveliststore)|
454
+ |**LiveSeatStore**|麦位管理核心:管理麦位列表、麦上用户状态、麦位相关操作(上麦、下麦、踢人、锁麦、开关麦克风/摄像头等),监听麦位事件。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveseatstore)|
455
+ |**DeviceStore**|音视频设备控制:麦克风(开关 / 音量)、摄像头(开关 / 切换 / 画质)、屏幕共享,设备状态实时监听。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/devicestore/)|
456
+ |**CoGuestStore**|观众连麦管理:连麦申请 / 邀请 / 同意 / 拒绝,连麦成员权限控制(麦克风 / 摄像头),状态同步。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore/)|
457
+ |**CoHostStore**|主播跨房连线:支持多布局模板(动态网格等),发起 / 接受 / 拒绝连线,连麦主播互动管理。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore/)|
458
+ |**BattleStore**|主播 PK 对战:发起 PK(配置时长 / 对手),管理 PK 状态(开始 / 结束),同步分数,监听对战结果。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/battlestore)|
459
+ |**GiftStore**|礼物互动:获取礼物列表,发送 / 接收礼物,监听礼物事件(含发送者、礼物详情)。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/giftstore/)|
460
+ |**BarrageStore**|弹幕功能:发送文本 / 自定义弹幕,维护弹幕列表,实时监听弹幕状态。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore)|
461
+ |**LikeStore**|点赞互动:发送点赞,监听点赞事件,同步总点赞数。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/likestore)|
462
+ |**LiveAudienceStore**|观众管理:获取实时观众列表(ID / 名称 / 头像),统计观众数量,监听观众进出事件。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveaudiencestore)|
463
+ |**AudioEffectStore**|音频特效:变声(童声 / 男声)、混响(KTV 等)、耳返调节,实时切换特效。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/audioeffectstore)|
464
+ |**BaseBeautyStore**|基础美颜:调节磨皮 / 美白 / 红润(0-100 级),重置美颜状态,同步效果参数。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/basebeautystore)|
463
465
 
464
466
  ## 常见问题
465
467