@tencentcloud/sdk-mcp 1.4.7 → 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 -12
  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 +6 -5
  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 -40
  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
@@ -0,0 +1,230 @@
1
+ `RoomStore` 是 `AtomicXCore` 中专职房间事务管理的模块,深度集成了会中呼叫能力。本章节旨在指导如何利用 `RoomStore` 高效完成会中呼叫相关功能的开发与接入。
2
+
3
+ ## 核心功能
4
+ - **会中呼叫**:房间内任意参与者均可呼叫房间外任意成员加入房间。
5
+
6
+ - **获取会中呼叫用户列表**:可以获取指定房间的会中呼叫的用户列表。
7
+
8
+ ## 核心概念
9
+
10
+ 在开始集成之前,需要通过下表了解一下 `RoomStore` 中与会中呼叫相关的几个核心概念:
11
+ | <strong>核心概念</strong> | <strong>核心职责与描述</strong> |
12
+ | --- | --- |
13
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomCallStatus.html">RoomCallStatus</a> | 代表会中呼叫的状态,包含:<br>- <code>none</code>(默认态)。<br>- <code>calling</code>(呼叫中)。<br>- <code>timeout</code>(呼叫超时)。<br>- <code>rejected</code>(呼叫被拒绝)。 |
14
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomCallResult.html">RoomCallResult</a> | 代表会中呼叫的结果,包含:<br>- <code>success</code>(呼叫成功)。<br>- <code>alreadyInCalling</code>(已在呼叫中)。<br>- <code>alreadyInRoom</code>(已在房间中)。 |
15
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/CallRejectionReason.html">CallRejectionReason</a> | 代表呼叫被拒绝的原因,目前仅支持:<br>- <code>rejected</code>(主动拒绝)。<br>- <code>inOtherRoom</code>(在其他房间中)。 |
16
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomCall-class.html">RoomCall</a> | 代表会中呼叫业务的核心数据结构。负责存储呼叫者信息、被呼叫者信息、以及当前呼叫状态。 |
17
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener-class.html">RoomListener</a> | 代表房间动态的实时事件。其中包含会中呼叫相关的事件。 |
18
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStore-class.html">RoomStore</a> | 这是与房间全生命周期相关的核心类。功能包含:发起会中呼叫,响应会中呼叫,获取房间的会中呼叫列表,并通过订阅其 <code>RoomListener</code> 来接收与会中呼叫相关的实时动态事件。 |
19
+
20
+ ## 实现步骤
21
+
22
+ ### 步骤1:组件集成
23
+
24
+ 请参考 接入概览 集成 **AtomicXCore SDK**,并已完成 实现登录逻辑 部分接入。
25
+
26
+ ### 步骤2:呼叫方功能
27
+
28
+ #### **1. 发起呼叫**
29
+
30
+ 作为呼叫方调用 `RoomStore` 的 `callUserToRoom` 接口,可以批量呼叫用户进房。
31
+ ``` java
32
+ import 'package:atomic_x_core/atomicxcore.dart';
33
+
34
+ Future<void> callUserToRoom({
35
+ required List<String> userIDList,
36
+ int timeout = 30,
37
+ String? extensionInfo,
38
+ }) async {
39
+ final result = await RoomStore.shared.callUserToRoom(
40
+ roomID: "roomID",
41
+ userIDList: userIDList,
42
+ timeout: timeout,
43
+ extensionInfo: extensionInfo,
44
+ );
45
+
46
+ if (result.isSuccess) {
47
+ print("呼叫用户请求发送成功");
48
+ } else {
49
+ print("呼叫用户失败: [错误码: ${result.errorCode}]: ${result.errorMessage}");
50
+ }
51
+ }
52
+ ```
53
+
54
+ #### **2. 取消呼叫**
55
+
56
+ 作为呼叫方调用 `RoomStore` 的 `cancelCall` 接口,可以批量取消正在呼叫的申请。
57
+ ``` java
58
+ import 'package:atomic_x_core/atomicxcore.dart';
59
+
60
+ Future<void> cancelCall(List<String> userIDList) async {
61
+ final result = await RoomStore.shared.cancelCall(
62
+ roomID: "roomID",
63
+ userIDList: userIDList,
64
+ );
65
+
66
+ if (result.isSuccess) {
67
+ print("取消呼叫成功");
68
+ } else {
69
+ print("取消呼叫失败: [错误码: ${result.errorCode}]: ${result.errorMessage}");
70
+ }
71
+ }
72
+ ```
73
+
74
+ #### **3. 获取呼叫列表信息**
75
+
76
+ 进入房间后,调用 `RoomStore` 的 `getPendingCalls` 接口,可以分页查询当前房间正在呼叫的用户列表信息。
77
+ ``` java
78
+ import 'package:atomic_x_core/atomicxcore.dart';
79
+
80
+ Future<void> getPendingCalls(String roomID, String? cursor) async {
81
+ // cursor 为分页游标,首次调用时传入 null,获取第一页数据,后续调用时传入上次返回的 cursor 值。
82
+ final result = await RoomStore.shared.getPendingCalls(
83
+ roomID: roomID,
84
+ cursor: cursor,
85
+ );
86
+
87
+ if (result.isSuccess) {
88
+ print("获取呼叫列表成功,列表信息: ${result.data}, 分页游标: ${result.cursor}");
89
+ } else {
90
+ print("获取呼叫列表失败: [错误码: ${result.errorCode}]: ${result.errorMessage}");
91
+ }
92
+ }
93
+ ```
94
+
95
+ #### **4. 订阅会中呼叫事件**
96
+
97
+ 作为呼叫方订阅 `RoomStore` 的 `RoomListener` 能够实时获取呼叫的生命周期事件。通过监听以下回调,可以精准捕捉呼叫的最终结果并据此更新 UI 状态或执行后续业务逻辑。
98
+ ``` java
99
+ import 'package:atomic_x_core/atomicxcore.dart';
100
+
101
+ late RoomListener _listener;
102
+
103
+ /// 订阅会中呼叫相关事件
104
+ void addRoomCallListener() {
105
+ _listener = RoomListener(
106
+ onCallTimeout: (roomInfo, call) {
107
+ print("呼叫超时 房间信息: ${roomInfo.roomID}, 呼叫者: ${call.caller.userID}");
108
+ },
109
+ onCallAccepted: (roomInfo, call) {
110
+ print("呼叫已被接受 房间信息: ${roomInfo.roomID}, 被呼叫者: ${call.callee.userID}");
111
+ },
112
+ onCallRejected: (roomInfo, call, reason) {
113
+ print("呼叫被拒绝 房间信息: ${roomInfo.roomID}, 被呼叫者: ${call.callee.userID}, 拒绝原因: $reason");
114
+ },
115
+ );
116
+
117
+ RoomStore.shared.addRoomListener(_listener);
118
+ }
119
+
120
+ void removeRoomCallListener() {
121
+ RoomStore.shared.removeRoomListener(_listener);
122
+ }
123
+ ```
124
+
125
+ **呼叫事件函数详细说明**
126
+
127
+ |事件函数|触发时机与说明|
128
+ |---------|---------|
129
+ |[onCallTimeout](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener/onCallTimeout.html)|呼叫超时。当呼叫请求在预设的时间内(由调用 callUserToRoom 时指定)未得到被呼叫方的响应时触发。此时,呼叫自动结束,呼叫方通常需要提示“对方无人接听”。|
130
+ |[onCallAccepted](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener/onCallAccepted.html)|呼叫被接受。被呼叫方主动点击了“接听”或“接受”按钮。收到此回调后,表示被呼叫者即将进入房间,呼叫方应更新 UI 状态,例如将该用户从“呼叫中”列表移除,并等待后续的成员进房通知来刷新成员列表。|
131
+ |[onCallRejected](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener/onCallRejected.html)|呼叫被拒绝。被呼叫方主动拒绝了通话请求,或者因为被呼叫方当前正处于其他房间中而自动拒绝。回调中通常包含拒绝原因(如主动拒绝或在其他房间中)。|
132
+
133
+ ### 步骤3:被呼叫方功能
134
+
135
+ #### **1. 订阅会中呼叫事件**
136
+
137
+ 作为被呼叫方订阅 `RoomStore` 的 `RoomListener` 可以实时监听并响应来自呼叫方的呼叫行为。以下是构建呼叫提醒界面以及维护呼叫链路状态的关键事件。
138
+ ``` java
139
+ import 'package:atomic_x_core/atomicxcore.dart';
140
+
141
+ late RoomListener _listener;
142
+
143
+ /// 订阅会中呼叫相关事件
144
+ void addRoomCallListener() {
145
+ _listener = RoomListener(
146
+ onCallReceived: (roomInfo, call, extensionInfo) {
147
+ print("收到房间呼叫 房间信息: ${roomInfo.roomID}, 呼叫者: ${call.caller.userID}, 扩展信息: $extensionInfo");
148
+ },
149
+ onCallCancelled: (roomInfo, call) {
150
+ print("呼叫被取消 房间信息: ${roomInfo.roomID}, 呼叫者: ${call.caller.userID}");
151
+ },
152
+ onCallRevokedByAdmin: (roomInfo, call, operatorUser) {
153
+ print("呼叫被管理员移除 房间信息: ${roomInfo.roomID}, 呼叫者: ${call.caller.userID}, 移除操作者: ${operatorUser.userID}");
154
+ },
155
+ onCallHandledByOtherDevice: (roomInfo, isAccepted) {
156
+ print("呼叫已被其他设备处理 房间信息: ${roomInfo.roomID}, 处理结果: $isAccepted");
157
+ },
158
+ );
159
+
160
+ RoomStore.shared.addRoomListener(_listener);
161
+ }
162
+
163
+ void removeRoomCallListener() {
164
+ RoomStore.shared.removeRoomListener(_listener);
165
+ }
166
+ ```
167
+
168
+ **事件函数详细说明**
169
+
170
+ |事件函数|触发时机与说明|
171
+ |---------|---------|
172
+ |[onCallReceived](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener/onCallReceived.html)|收到呼叫邀请。当有其他用户向您发起入会邀请时触发。收到此回调后,被呼叫方通常应立即弹出“呼叫提醒”界面,展示呼叫者信息、房间信息,并提供“接听”和“拒绝”按钮。|
173
+ |[onCallCancelled](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener/onCallCancelled.html)|呼叫被发起方取消。呼叫方在您未做出响应前,主动撤回了呼叫请求。收到此回调后,被呼叫方应立即关闭当前的来电界面,并提示“对方已取消呼叫”,以恢复应用正常操作流程。|
174
+ |[onCallRevokedByAdmin](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener/onCallRevokedByAdmin.html)|呼叫被管理员撤销。房间管理员或后台系统因权限变更、房间解散等原因强行终止了该笔呼叫邀请。收到此通知后,被呼叫方需立即停止呼叫流程并隐藏相关 UI,处理逻辑通常类似于呼叫被取消。|
175
+ |[onCallHandledByOtherDevice](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener/onCallHandledByOtherDevice.html)|呼叫已在其他设备处理。当用户在多个设备(例如手机和 iPad)同时登录时,如果呼叫已在其中一台设备上被处理(接受或拒绝),当前设备会收到此通知,用于同步 UI 状态并自动消除呼叫界面。|
176
+
177
+ #### **2. 接受呼叫、拒绝呼叫**
178
+
179
+ 作为被呼叫方调用 `RoomStore` 的 `acceptCall` 或者 `rejectCall` 接口,处理接受或者拒绝呼叫邀请。
180
+ ``` java
181
+ import 'package:atomic_x_core/atomicxcore.dart';
182
+
183
+ late RoomListener _listener;
184
+
185
+ /// 订阅会中呼叫相关事件
186
+ void addRoomCallListener() {
187
+ _listener = RoomListener(
188
+ onCallReceived: (roomInfo, call, extensionInfo) {
189
+ print("收到房间呼叫 房间信息: ${roomInfo.roomID}, 呼叫者: ${call.caller.userID}, 扩展信息: $extensionInfo");
190
+ // 接受、拒绝呼叫邀请操作
191
+ },
192
+ );
193
+
194
+ RoomStore.shared.addRoomListener(_listener);
195
+ }
196
+
197
+ void removeRoomCallListener() {
198
+ RoomStore.shared.removeRoomListener(_listener);
199
+ }
200
+
201
+ // 接受呼叫邀请
202
+ Future<void> acceptCall(String roomID) async {
203
+ final result = await RoomStore.shared.acceptCall(roomID);
204
+
205
+ if (result.isSuccess) {
206
+ print("接受呼叫成功,房间ID: $roomID");
207
+ } else {
208
+ print("接受呼叫失败: [错误码: ${result.errorCode}] ${result.errorMessage}");
209
+ }
210
+ }
211
+
212
+ // 拒绝呼叫邀请
213
+ Future<void> rejectCall(String roomID, {CallRejectionReason reason = CallRejectionReason.rejected}) async {
214
+ final result = await RoomStore.shared.rejectCall(
215
+ roomID: roomID,
216
+ reason: reason,
217
+ );
218
+
219
+ if (result.isSuccess) {
220
+ print("拒绝呼叫成功,房间ID: $roomID");
221
+ } else {
222
+ print("拒绝呼叫失败: [错误码: ${result.errorCode}] ${result.errorMessage}");
223
+ }
224
+ }
225
+ ```
226
+
227
+ ## API 文档
228
+ | <strong>Store/Component</strong> | <strong>功能描述</strong> | <strong>API 文档</strong> |
229
+ | --- | --- | --- |
230
+ | <strong>RoomStore</strong> | 房间全生命周期管理:创建并加入 / 加入 / 离开 / 结束房间 / 更新、获取房间信息 / 预定房间 / 呼叫房间外成员 / 监听房间内被动事件(例如房间解散,房间信息更新等)。 | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStore-class.html">API 文档</a> |
@@ -3,9 +3,9 @@
3
3
  ## 房间模式说明
4
4
 
5
5
  在开始使用成员管理功能之前,需要了解 `AtomicXCore` 中房间模块支持的两种房间模式,不同模式下的成员管理功能有所区别:
6
- | **标准房间模式(Standard Room)** | **网络研讨会房间模式(Webinar Room)** |
6
+ | <strong>标准房间模式(Standard Room)</strong> | <strong>网络研讨会房间模式(Webinar Room)</strong> |
7
7
  | --- | --- |
8
- | - **适用场景:**小型会议、团队协作、朋友聊天等。<br>- **成员特点:**所有成员都是参与者,可以自由开启/关闭音视频设备。<br>- **管理特点:**扁平化管理,房主可设置管理员进行协助管理。 | - **适用场景**:网络研讨会、在线培训等。<br>- **成员特点**:<br>- **嘉宾(Participants)**:可以开启音视频设备,参与互动。<br>- **观众(Audience)**:只能观看,无法开启音视频设备。<br>- **管理特点**:分层管理,支持观众与嘉宾身份转换。 |
8
+ | - <strong>适用场景:</strong>小型会议、团队协作、朋友聊天等。<br>- <strong>成员特点:</strong>所有成员都是参与者,可以自由开启/关闭音视频设备。<br>- <strong>管理特点:</strong>扁平化管理,房主可设置管理员进行协助管理。 | - <strong>适用场景</strong>:网络研讨会、在线培训等。<br>- <strong>成员特点</strong>:<br>- <strong>嘉宾(Participants)</strong>:可以开启音视频设备,参与互动。<br>- <strong>观众(Audience)</strong>:只能观看,无法开启音视频设备。<br>- <strong>管理特点</strong>:分层管理,支持观众与嘉宾身份转换。 |
9
9
 
10
10
  ## 核心功能
11
11
  - **获取参与者列表**:获取并展示当前房间内所有参与者信息。
@@ -29,28 +29,29 @@
29
29
  - **音视频设备管理**:支持申请/邀请打开摄像头、麦克风,关闭远端摄像头、麦克风,以及房主和管理员设置全体静音,全体禁用摄像头功能。
30
30
 
31
31
  ## 功能对比
32
- | **功能** | **标准房间模式** | **网络研讨会房间模式** |
33
- | --- | --- | --- |
34
- | 获取参与者列表 | 获取所有房间成员 | 获取嘉宾列表 |
35
- | 获取观众列表 | 不适用 | 获取观众列表 |
36
- | 搜索房间内成员 | 支持 | 支持 |
37
- | 将观众提升为嘉宾 | 不适用 | 支持 |
38
- | 将嘉宾降级为观众 | 不适用 | 支持 |
39
- | 转移房主身份 | 支持 | 支持 |
40
- | 设置/撤销管理员 | 支持 | 支持 |
41
- | 移出房间 | 支持 | 支持 |
42
- | 更新参与者信息 | 支持 | 支持 |
43
- | 音视频设备管理 | 支持 | 支持 |
32
+
33
+ |**功能**|**标准房间模式**|**网络研讨会房间模式**|
34
+ |---------|---------|---------|
35
+ |获取参与者列表|获取所有房间成员|获取嘉宾列表|
36
+ |获取观众列表|不适用|获取观众列表|
37
+ |搜索房间内成员|支持|支持|
38
+ |将观众提升为嘉宾|不适用|支持|
39
+ |将嘉宾降级为观众|不适用|支持|
40
+ |转移房主身份|支持|支持|
41
+ |设置/撤销管理员|支持|支持|
42
+ |移出房间|支持|支持|
43
+ |更新参与者信息|支持|支持|
44
+ |音视频设备管理|支持|支持|
44
45
 
45
46
  ## 核心概念
46
47
 
47
48
  在开始集成之前,需要通过下表了解 `RoomParticipantStore` 相关的核心概念:
48
- | **核心概念** | **核心职责与描述** |
49
+ | <strong>核心概念</strong> | <strong>核心职责与描述</strong> |
49
50
  | --- | --- |
50
- | [RoomParticipant](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_participant_store/RoomParticipant-class.html) | 代表参与者的核心数据模型,封装了参与者的完整信息和状态管理能力。<br>核心功能包括:<br>- 参与者基本信息管理(用户 ID、用户名称、用户头像、房间内角色身份)。<br>- 参与者设备状态管理(麦克风状态,摄像头状态,屏幕分享状态,消息状态)。 |
51
- | [RoomParticipantState](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_participant_store/RoomParticipantState-class.html) | 代表参与者状态管理的核心数据结构,负责维护房间内与参与者相关状态信息。<br>核心属性:<br>- `participantList` 存储了当前所在房间的所有参与者信息集合。<br>- `participantListCursor` 代表房间内参与者列表的分页快照。<br>- `localParticipant`代表自身所在房间内的参与者信息。 |
52
- | [RoomParticipantListener](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_participant_store/RoomParticipantListener-class.html) | 代表房间内和参与者相关的实时事件。主要事件分为三大类:参与者进退房事件、 参与者身份改变事件,参与者设备控制事件。 |
53
- | [RoomParticipantStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_participant_store/RoomParticipantStore-class.html) | 这是参与者控制相关的核心类。功能包含:控制房间内参与者音视频状态、执行参与者管理操作,并通过 `addRoomParticipantListener` 方法来接收实时事件。 |
51
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_participant_store/RoomParticipant-class.html">RoomParticipant</a> | 代表参与者的核心数据模型,封装了参与者的完整信息和状态管理能力。<br>核心功能包括:<br>- 参与者基本信息管理(用户 ID、用户名称、用户头像、房间内角色身份)。<br>- 参与者设备状态管理(麦克风状态,摄像头状态,屏幕分享状态,消息状态)。 |
52
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_participant_store/RoomParticipantState-class.html">RoomParticipantState</a> | 代表参与者状态管理的核心数据结构,负责维护房间内与参与者相关状态信息。<br>核心属性:<br>- <code>participantList</code> 存储了当前所在房间的所有参与者信息集合。<br>- <code>participantListCursor</code> 代表房间内参与者列表的分页快照。<br>- <code>localParticipant</code>代表自身所在房间内的参与者信息。 |
53
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_participant_store/RoomParticipantListener-class.html">RoomParticipantListener</a> | 代表房间内和参与者相关的实时事件。主要事件分为三大类:参与者进退房事件、 参与者身份改变事件,参与者设备控制事件。 |
54
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_participant_store/RoomParticipantStore-class.html">RoomParticipantStore</a> | 这是参与者控制相关的核心类。功能包含:控制房间内参与者音视频状态、执行参与者管理操作,并通过 <code>addRoomParticipantListener</code> 方法来接收实时事件。 |
54
55
 
55
56
  ## 实现步骤
56
57
 
@@ -791,6 +792,6 @@ Widget buildSpeakingUsersWidget() {
791
792
  ```
792
793
 
793
794
  ## API 文档
794
- | **Store** | **功能描述** | **API文档** |
795
+ | <strong>Store</strong> | <strong>功能描述</strong> | <strong>API文档</strong> |
795
796
  | --- | --- | --- |
796
- | **RoomParticipantStore** | 房间内参与者管理:设置管理员 / 转移房主 / 获取参与者列表 / 移出房间 / 参与者设备控制(例如关闭、邀请打开摄像头、麦克风等)/ 申请打开设备(例如申请打开摄像头、麦克风等)。 | [API 文档](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_participant_store/RoomParticipantStore-class.html) |
797
+ | <strong>RoomParticipantStore</strong> | 房间内参与者管理:设置管理员 / 转移房主 / 获取参与者列表 / 移出房间 / 参与者设备控制(例如关闭、邀请打开摄像头、麦克风等)/ 申请打开设备(例如申请打开摄像头、麦克风等)。 | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_participant_store/RoomParticipantStore-class.html">API 文档</a> |
@@ -16,12 +16,12 @@
16
16
  ## 核心概念
17
17
 
18
18
  在开始集成之前,需要通过下表了解一下`RoomStore`相关的几个核心概念:
19
- | **核心概念** | **核心职责与描述** |
19
+ | <strong>核心概念</strong> | <strong>核心职责与描述</strong> |
20
20
  | --- | --- |
21
- | [RoomInfo](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomInfo-class.html) | 代表房间信息的核心数据模型,封装了房间的完整信息和状态管理能力。<br>核心功能包括:<br>- 房间基本信息管理(房间 ID、名称、创建者)。<br>- 实时状态跟踪(参与者数量、房间状态、创建时间)。<br>- 房间调度功能(预约时间、参会者列表、提醒设置)。<br>- 全面的权限控制(密码保护、设备管控、消息管理)。 |
22
- | [RoomState](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomState-class.html) | 代表房间状态管理的核心数据结构,负责维护用户的房间相关状态信息。<br>核心属性:<br>- `scheduledRoomList` 存储了当前账号下所有预约的房间列表信息。<br>- `scheduledRoomListCursor` 则代表预约房间列表的分页快照。<br>- `currentRoom` 则代表当前所在房间的状态信息。 |
23
- | [RoomListener](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener-class.html) | 代表房间动态的实时事件。主要事件分为两大类:预约房间事件和房间结束事件。 |
24
- | [RoomStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStore-class.html) | 这是与房间全生命周期相关的核心类。功能包含:获取预约房间列表快照、执行房间管理操作,并通过 `addRoomListener` 方法来接收实时动态事件。 |
21
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomInfo-class.html">RoomInfo</a> | 代表房间信息的核心数据模型,封装了房间的完整信息和状态管理能力。<br>核心功能包括:<br>- 房间基本信息管理(房间 ID、名称、创建者)。<br>- 实时状态跟踪(参与者数量、房间状态、创建时间)。<br>- 房间调度功能(预约时间、参会者列表、提醒设置)。<br>- 全面的权限控制(密码保护、设备管控、消息管理)。 |
22
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomState-class.html">RoomState</a> | 代表房间状态管理的核心数据结构,负责维护用户的房间相关状态信息。<br>核心属性:<br>- <code>scheduledRoomList</code> 存储了当前账号下所有预约的房间列表信息。<br>- <code>scheduledRoomListCursor</code> 则代表预约房间列表的分页快照。<br>- <code>currentRoom</code> 则代表当前所在房间的状态信息。 |
23
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener-class.html">RoomListener</a> | 代表房间动态的实时事件。主要事件分为两大类:预约房间事件和房间结束事件。 |
24
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStore-class.html">RoomStore</a> | 这是与房间全生命周期相关的核心类。功能包含:获取预约房间列表快照、执行房间管理操作,并通过 <code>addRoomListener</code> 方法来接收实时动态事件。 |
25
25
 
26
26
  ## 实现步骤
27
27
 
@@ -74,19 +74,20 @@ void createAndJoinRoom() async {
74
74
  ##### createAndJoinRoom 接口参数详细说明
75
75
  | 参数名 | 类型 | 必填 | 说明 |
76
76
  | --- | --- | --- | --- |
77
- | `roomID` | `String` | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
78
- | `roomType` | `String` | 是 | 房间类型<br>- standard:标准房间,所有成员可自由音视频互动。<br>- webinar:大型研讨会房间,区分嘉宾和观众角色,观众默认无上麦权限。 |
79
- | `options` | [CreateRoomOptions](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/CreateRoomOptions-class.html) | 是 | 房间创建选项配置对象。 |
77
+ | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
78
+ | <code>roomType</code> | <code>String</code> | 是 | 房间类型<br>- standard:标准房间,所有成员可自由音视频互动。<br>- webinar:大型研讨会房间,区分嘉宾和观众角色,观众默认无上麦权限。 |
79
+ | <code>options</code> | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/CreateRoomOptions-class.html">CreateRoomOptions</a> | 是 | 房间创建选项配置对象。 |
80
80
 
81
81
  ##### CreateRoomOptions 结构体详细说明
82
- | 参数名 | 类型 | 必填 | 默认值 | 说明 |
83
- | --- | --- | --- | --- | --- |
84
- | roomName | String | 否 | "" | 房间名称。若不设置,系统可能会使用默认名称。 |
85
- | password | String | 否 | "" | 房间密码。设置后,其他用户加入房间时需输入密码。 |
86
- | isAllMicrophoneDisabled | bool | 否 | false | 是否全员禁止开启麦克风。开启后,除房主/管理员外,普通参与者默认禁止打开麦克风。 |
87
- | isAllCameraDisabled | bool | 否 | false | 是否全员禁止开启摄像头。开启后,除房主/管理员外,普通参与者默认禁止打开摄像头。 |
88
- | isAllScreenShareDisabled | bool | 否 | false | 是否全员禁止发起屏幕共享。开启后,仅房主/管理员可进行屏幕共享。 |
89
- | isAllMessageDisabled | bool | 否 | false | 是否全员禁止发送聊天消息(禁言)。开启后,普通参与者无法在房间内发送文字消息。 |
82
+
83
+ |参数名|类型|必填|默认值|说明|
84
+ |---------|---------|---------|---------|---------|
85
+ |roomName|String|否|""|房间名称。若不设置,系统可能会使用默认名称。|
86
+ |password|String|否|""|房间密码。设置后,其他用户加入房间时需输入密码。|
87
+ |isAllMicrophoneDisabled|bool|否|false|是否全员禁止开启麦克风。开启后,除房主/管理员外,普通参与者默认禁止打开麦克风。|
88
+ |isAllCameraDisabled|bool|否|false|是否全员禁止开启摄像头。开启后,除房主/管理员外,普通参与者默认禁止打开摄像头。|
89
+ |isAllScreenShareDisabled|bool|否|false|是否全员禁止发起屏幕共享。开启后,仅房主/管理员可进行屏幕共享。|
90
+ |isAllMessageDisabled|bool|否|false|是否全员禁止发送聊天消息(禁言)。开启后,普通参与者无法在房间内发送文字消息。|
90
91
 
91
92
  ### 步骤3:加入房间
92
93
 
@@ -114,9 +115,9 @@ Future<void> joinRoom() async {
114
115
  ##### joinRoom 接口参数详细说明
115
116
  | 参数名 | 类型 | 必填 | 说明 |
116
117
  | --- | --- | --- | --- |
117
- | `roomID` | `String` | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
118
- | `roomType` | `RoomType` | 是 | 房间类型<br>- standard:标准房间,所有成员可自由音视频互动。<br>- webinar:大型研讨会房间,区分嘉宾和观众角色,观众默认无上麦权限。 |
119
- | `password` | `String` | 否 | - 房间密码,空字符串 "" 通常表示该房间不设密码。<br>- 限制长度为 0-32 字节。<br>- 推荐使用 4-8 位纯数字,方便移动端输入。设置后,其他用户加入房间时需输入密码。建议不要存储明文敏感信息。 |
118
+ | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
119
+ | <code>roomType</code> | <code>RoomType</code> | 是 | 房间类型<br>- standard:标准房间,所有成员可自由音视频互动。<br>- webinar:大型研讨会房间,区分嘉宾和观众角色,观众默认无上麦权限。 |
120
+ | <code>password</code> | <code>String</code> | 否 | - 房间密码,空字符串 "" 通常表示该房间不设密码。<br>- 限制长度为 0-32 字节。<br>- 推荐使用 4-8 位纯数字,方便移动端输入。设置后,其他用户加入房间时需输入密码。建议不要存储明文敏感信息。 |
120
121
 
121
122
  ### 步骤4:离开房间
122
123
 
@@ -205,21 +206,21 @@ Future<void> updateRoomInfo() async {
205
206
  ##### updateRoomInfo 接口参数详细说明
206
207
  | 参数名 | 类型 | 必填 | 说明 |
207
208
  | --- | --- | --- | --- |
208
- | `roomID` | `String` | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
209
- | `options` | `UpdateRoomOptions` | 是 | - 更新房间属性配置对象。<br>- 详细用法请参考:UpdateRoomOptions 结构体详细说明 |
210
- | `modifyFlag` | `UpdateRoomOptionsModifyFlag` | 是 | - 更新房间属性修改标志位。目前支持更新**房间名称**、**房间密码**。<br>- 详细用法请参考:UpdateRoomOptionsModifyFlag 详细说明。 |
209
+ | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
210
+ | <code>options</code> | <code>UpdateRoomOptions</code> | 是 | - 更新房间属性配置对象。<br>- 详细用法请参考:UpdateRoomOptions 结构体详细说明 |
211
+ | <code>modifyFlag</code> | <code>UpdateRoomOptionsModifyFlag</code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>房间密码</strong>。<br>- 详细用法请参考:UpdateRoomOptionsModifyFlag 详细说明。 |
211
212
 
212
213
  **UpdateRoomOptions 结构体详细说明**
213
214
  | 参数名 | 类型 | 必填 | 说明 |
214
215
  | --- | --- | --- | --- |
215
- | `roomName` | `String` | 否 | - 房间名称,可以不设置,默认为空字符串。<br>- 限制长度为 0-60 字节。<br>- 支持中英文、数字、特殊字符。 |
216
- | `password` | `String` | 否 | - 房间密码,空字符串 "" 通常表示该房间不设密码。<br>- 限制长度为 0-32 字节。<br>- 推荐使用 4-8 位纯数字,方便移动端输入。设置后,其他用户加入房间时需输入密码。建议不要存储明文敏感信息。 |
216
+ | <code>roomName</code> | <code>String</code> | 否 | - 房间名称,可以不设置,默认为空字符串。<br>- 限制长度为 0-60 字节。<br>- 支持中英文、数字、特殊字符。 |
217
+ | <code>password</code> | <code>String</code> | 否 | - 房间密码,空字符串 "" 通常表示该房间不设密码。<br>- 限制长度为 0-32 字节。<br>- 推荐使用 4-8 位纯数字,方便移动端输入。设置后,其他用户加入房间时需输入密码。建议不要存储明文敏感信息。 |
217
218
 
218
219
  **UpdateRoomOptionsModifyFlag 详细说明**
219
220
  | 参数名 | 类型 | 必填 | 说明 |
220
221
  | --- | --- | --- | --- |
221
- | `roomName` | `int` | 否 | - 修改房间名称时的标识位。<br>- 当修改`UpdateRoomOptions`中的`roomName`后,需要同步向`modifyFlagList`中加入`roomName`标识位。 |
222
- | `password` | `int` | 否 | - 修改房间密码时的标识位。<br>- 当修改`UpdateRoomOptions`中的`password`后,需要同步向`modifyFlagList`中加入`password`标识位。 |
222
+ | <code>roomName</code> | <code>int</code> | 否 | - 修改房间名称时的标识位。<br>- 当修改<code>UpdateRoomOptions</code>中的<code>roomName</code>后,需要同步向<code>modifyFlagList</code>中加入<code>roomName</code>标识位。 |
223
+ | <code>password</code> | <code>int</code> | 否 | - 修改房间密码时的标识位。<br>- 当修改<code>UpdateRoomOptions</code>中的<code>password</code>后,需要同步向<code>modifyFlagList</code>中加入<code>password</code>标识位。 |
223
224
 
224
225
  ### 步骤7:获取房间信息
225
226
 
@@ -298,9 +299,9 @@ ValueListenableBuilder(
298
299
  ```
299
300
 
300
301
  ## API 文档
301
- | **Store** | **功能描述** | **API文档** |
302
+ | <strong>Store</strong> | <strong>功能描述</strong> | <strong>API文档</strong> |
302
303
  | --- | --- | --- |
303
- | **RoomStore** | 房间全生命周期管理:创建并加入 / 加入 / 离开 / 结束房间 / 更新、获取房间信息 / 房间预约 / 呼叫房间外成员 / 监听房间内被动事件(如房间解散,房间信息更新等)。 | [API 文档](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStore-class.html) |
304
+ | <strong>RoomStore</strong> | 房间全生命周期管理:创建并加入 / 加入 / 离开 / 结束房间 / 更新、获取房间信息 / 房间预约 / 呼叫房间外成员 / 监听房间内被动事件(如房间解散,房间信息更新等)。 | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStore-class.html">API 文档</a> |
304
305
 
305
306
  ## 常见问题
306
307
 
@@ -14,13 +14,13 @@
14
14
  ## 核心概念
15
15
 
16
16
  在开始集成之前,您可能需要通过下表了解一下`RoomStore`中与预定房间相关的几个核心概念:
17
- | **核心概念** | **核心职责与描述** |
17
+ | <strong>核心概念</strong> | <strong>核心职责与描述</strong> |
18
18
  | --- | --- |
19
- | [RoomStatus](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStatus.html) | 代表当前房间的状态,包含:`scheduled`(预定状态),`running`(进行中)。 |
20
- | [ScheduleRoomOptions](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/ScheduleRoomOptions-class.html) | 代表预定房间的核心数据结构,包含:开始时间,结束时间,预定成员列表等。 |
21
- | [RoomState](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomState-class.html) | 代表房间状态管理的核心数据结构,负责维护用户的房间相关状态信息。<br>核心属性:<br>- `scheduledRoomList` 存储了当前账号下所有预定的房间列表信息。<br>- `scheduledRoomListCursor` 则代表预定房间列表的分页游标。 |
22
- | [RoomListener](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener-class.html) | 代表房间动态的实时事件。其中包含预定房间相关的事件。 |
23
- | [RoomStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStore-class.html) | 这是与房间全生命周期相关的核心类。通过它,您可以主动发起预定房间,获取预定房间列表等功能,并通过 `addRoomListener` 方法来接收与预定房间相关的实时动态事件。 |
19
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStatus.html">RoomStatus</a> | 代表当前房间的状态,包含:<code>scheduled</code>(预定状态),<code>running</code>(进行中)。 |
20
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/ScheduleRoomOptions-class.html">ScheduleRoomOptions</a> | 代表预定房间的核心数据结构,包含:开始时间,结束时间,预定成员列表等。 |
21
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomState-class.html">RoomState</a> | 代表房间状态管理的核心数据结构,负责维护用户的房间相关状态信息。<br>核心属性:<br>- <code>scheduledRoomList</code> 存储了当前账号下所有预定的房间列表信息。<br>- <code>scheduledRoomListCursor</code> 则代表预定房间列表的分页游标。 |
22
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomListener-class.html">RoomListener</a> | 代表房间动态的实时事件。其中包含预定房间相关的事件。 |
23
+ | <a href="https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStore-class.html">RoomStore</a> | 这是与房间全生命周期相关的核心类。通过它,您可以主动发起预定房间,获取预定房间列表等功能,并通过 <code>addRoomListener</code> 方法来接收与预定房间相关的实时动态事件。 |
24
24
 
25
25
  ## 实现步骤
26
26
 
@@ -78,14 +78,14 @@ Future<void> scheduleRoom() async {
78
78
  ##### scheduleRoom 接口参数详细说明
79
79
  | 参数名 | 类型 | 必填 | 说明 |
80
80
  | --- | --- | --- | --- |
81
- | `roomID` | `String` | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
82
- | `options` | `ScheduleRoomOptions` | 是 | - 创建房间配置对象。<br>- 详细用法请参考:ScheduleRoomOptions 结构体详细说明 |
81
+ | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
82
+ | <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法请参考:ScheduleRoomOptions 结构体详细说明 |
83
83
 
84
84
  ##### ScheduleRoomOptions 结构体详细说明
85
85
  | 参数名 | 类型 | 必填 | 说明 |
86
86
  | --- | --- | --- | --- |
87
87
  | roomName | String | 否 | - 房间名称,可以不设置,默认为空字符串。<br>- 限制长度为 0-60 字节。<br>- 支持中英文、数字、特殊字符。 |
88
- | password | String | 否 | - 房间密码,空字符串 `""` 通常表示该房间不设密码。<br>- 限制长度为 0-32 字节。<br>- 推荐使用 4-8 位纯数字,方便移动端输入。设置后,其他用户加入房间时需输入密码。建议不要存储明文敏感信息。 |
88
+ | password | String | 否 | - 房间密码,空字符串 <code>""</code> 通常表示该房间不设密码。<br>- 限制长度为 0-32 字节。<br>- 推荐使用 4-8 位纯数字,方便移动端输入。设置后,其他用户加入房间时需输入密码。建议不要存储明文敏感信息。 |
89
89
  | scheduleStartTime | int | 是 | - 预定的房间开始时间(Unix 时间戳,单位:秒)。<br>- 取值必须大于当前时间。<br>- 推荐设置为未来的整分时间。例如:1736164800(代表 2025-01-06 20:00:00)。 |
90
90
  | scheduleEndTime | int | 是 | - 预定的房间结束时间(Unix 时间戳,单位:秒)。<br>- 取值必须大于 scheduleStartTime。<br>- 建议根据预期时长设置。例如:scheduleStartTime + 3600(预定 1 小时时长的房间)。 |
91
91
  | reminderSecondsBeforeStart | int | 否 | - 房间开始前的提醒时间(单位:秒)。用于系统触发开始提醒。<br>- 推荐设置为 300(5分钟)或 900(15分钟),用于在 App 端触发本地通知。 |
@@ -153,14 +153,14 @@ Future<void> scheduleRoom() async {
153
153
  | --- | --- | --- | --- |
154
154
  | roomID | String | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
155
155
  | options | ScheduleRoomOptions | 是 | - 预定房间配置对象。<br>- 详细用法请参考:ScheduleRoomOptions 结构体详细说明 |
156
- | modifyFlagList | List<ScheduleRoomOptionsModifyFlag> | 是 | - 更新房间属性修改标志位。目前支持更新**房间名称**、**开始时间**、**结束时间。**<br>- 详细用法请参考:ScheduleRoomOptionsModifyFlag 详细说明。 |
156
+ | modifyFlagList | List<ScheduleRoomOptionsModifyFlag> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>开始时间</strong>、<strong>结束时间。</strong><br>- 详细用法请参考:ScheduleRoomOptionsModifyFlag 详细说明。 |
157
157
 
158
158
  **ScheduleRoomOptionsModifyFlag 详细说明**
159
159
  | 参数名 | 说明 |
160
160
  | --- | --- |
161
- | `roomName` | - 修改预定房间名称时的标识位。<br>- 当修改`ScheduleRoomOptions`中的`roomName`后,需要同步向`modifyFlagList`中添加`roomName`标识位。 |
162
- | `scheduleStartTime` | - 修改预定房间开始时间时的标识位。<br>- 当修改`ScheduleRoomOptions`中的`scheduleStartTime`后,需要同步向`modifyFlagList`中添加`scheduleStartTime`标识位。 |
163
- | `scheduleEndTime` | - 修改预定房间结束时间时的标识位。<br>- 当修改`ScheduleRoomOptions`中的`scheduleEndTime`后,需要同步向`modifyFlagList`中添加`scheduleEndTime`标识位。 |
161
+ | <code>roomName</code> | - 修改预定房间名称时的标识位。<br>- 当修改<code>ScheduleRoomOptions</code>中的<code>roomName</code>后,需要同步向<code>modifyFlagList</code>中添加<code>roomName</code>标识位。 |
162
+ | <code>scheduleStartTime</code> | - 修改预定房间开始时间时的标识位。<br>- 当修改<code>ScheduleRoomOptions</code>中的<code>scheduleStartTime</code>后,需要同步向<code>modifyFlagList</code>中添加<code>scheduleStartTime</code>标识位。 |
163
+ | <code>scheduleEndTime</code> | - 修改预定房间结束时间时的标识位。<br>- 当修改<code>ScheduleRoomOptions</code>中的<code>scheduleEndTime</code>后,需要同步向<code>modifyFlagList</code>中添加<code>scheduleEndTime</code>标识位。 |
164
164
 
165
165
  #### **四、添加、删除参与成员**
166
166
  - **预定房间者:**调用 `RoomStore` 的 `addScheduledAttendees` 或者 `removeScheduledAttendees` 接口,可以为已预定的房间内批量添加或移除预定参与者。
@@ -298,9 +298,10 @@ Future<void> scheduleRoom() async {
298
298
  ```
299
299
 
300
300
  ## API 文档
301
- | **Store/Component** | **功能描述** | **API文档** |
302
- | --- | --- | --- |
303
- | **RoomStore** | 房间全生命周期管理:创建并加入 / 加入 / 离开 / 结束房间 / 更新、获取房间信息 / 房间预定 / 呼叫房间外成员 / 监听房间内被动事件(例如房间解散,房间信息更新等)。 | [API 文档](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStore-class.html) |
301
+
302
+ |**Store/Component**|**功能描述**|**API文档**|
303
+ |---------|---------|---------|
304
+ |**RoomStore**|房间全生命周期管理:创建并加入 / 加入 / 离开 / 结束房间 / 更新、获取房间信息 / 房间预定 / 呼叫房间外成员 / 监听房间内被动事件(例如房间解散,房间信息更新等)。|[API 文档](https://tencent-rtc.github.io/TUIKit_Flutter/api_room_room_store/RoomStore-class.html)|
304
305
 
305
306
  ## 常见问题
306
307
 
@@ -8,14 +8,14 @@
8
8
  ## 核心概念
9
9
 
10
10
  在开始集成之前,需要通过下表了解一下`RoomStore`中与会中呼叫相关的几个核心概念:
11
- | **核心概念** | **类型** | **核心职责与描述** |
11
+ | <strong>核心概念</strong> | <strong>类型</strong> | <strong>核心职责与描述</strong> |
12
12
  | --- | --- | --- |
13
- | [RoomCallStatus](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomcallstatus) | `enum` | 代表会中呼叫的状态,包含:<br>- `none`(默认态)。<br>- `calling`(呼叫中)。<br>- `timeout`(呼叫超时)。<br>- `rejected`(呼叫被拒绝)。 |
14
- | [RoomCallResult](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomcallresult) | `enum` | 代表会中呼叫的结果,包含:<br>- `success`(呼叫成功)。<br>- `alreadyInCalling`(已在呼叫中)。<br>- `alreadyInRoom`(已在房间中)。 |
15
- | [CallRejectionReason](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/callrejectionreason) | `enum` | 代表呼叫被拒绝的原因,目前仅支持:<br>- `rejected`(主动拒绝)。<br>- `inOtherRoom`(在其他房间中)。 |
16
- | [RoomCall](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomcall) | `struct` | 代表会中呼叫业务的核心数据结构。负责存储呼叫者信息、被呼叫者信息、以及当前呼叫状态。 |
17
- | [RoomEvent](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent) | `enum` | 代表房间动态的实时事件。其中包含会中呼叫相关的事件。 |
18
- | [RoomStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomstore) | `class` | 这是与房间全生命周期相关的核心类。功能包含:发起会中呼叫,响应会中呼叫,获取房间的会中呼叫列表,并通过订阅其 `roomEventPublisher` 来接收与会中呼叫相关的实时动态事件。 |
13
+ | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomcallstatus">RoomCallStatus</a> | <code>enum</code> | 代表会中呼叫的状态,包含:<br>- <code>none</code>(默认态)。<br>- <code>calling</code>(呼叫中)。<br>- <code>timeout</code>(呼叫超时)。<br>- <code>rejected</code>(呼叫被拒绝)。 |
14
+ | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomcallresult">RoomCallResult</a> | <code>enum</code> | 代表会中呼叫的结果,包含:<br>- <code>success</code>(呼叫成功)。<br>- <code>alreadyInCalling</code>(已在呼叫中)。<br>- <code>alreadyInRoom</code>(已在房间中)。 |
15
+ | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/callrejectionreason">CallRejectionReason</a> | <code>enum</code> | 代表呼叫被拒绝的原因,目前仅支持:<br>- <code>rejected</code>(主动拒绝)。<br>- <code>inOtherRoom</code>(在其他房间中)。 |
16
+ | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomcall">RoomCall</a> | <code>struct</code> | 代表会中呼叫业务的核心数据结构。负责存储呼叫者信息、被呼叫者信息、以及当前呼叫状态。 |
17
+ | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent">RoomEvent</a> | <code>enum</code> | 代表房间动态的实时事件。其中包含会中呼叫相关的事件。 |
18
+ | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomstore">RoomStore</a> | <code>class</code> | 这是与房间全生命周期相关的核心类。功能包含:发起会中呼叫,响应会中呼叫,获取房间的会中呼叫列表,并通过订阅其 <code>roomEventPublisher</code> 来接收与会中呼叫相关的实时动态事件。 |
19
19
 
20
20
  ## 实现步骤
21
21
 
@@ -120,12 +120,13 @@ private func subscribeRoomCallEvents() {
120
120
  ```
121
121
 
122
122
  **呼叫事件函数详细说明**
123
- | 事件函数 | 触发时机与说明 |
124
- | --- | --- |
125
- | [onCallTimeout](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncalltimeout(roominfo:call:)) | 呼叫超时。当呼叫请求在预设的时间内(由调用 callUserToRoom 时指定)未得到被呼叫方的响应时触发。此时,呼叫自动结束,呼叫方通常需要提示“对方无人接听”。 |
126
- | [onCallAccepted](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallaccepted(roominfo:call:)) | 呼叫被接受。被呼叫方主动点击了“接听”或“接受”按钮。收到此回调后,表示双方已达成呼叫意图,呼叫方通常应立即执行进入房间或开始推流的操作。 |
127
- | [onCallRejected](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallrejected(roominfo:call:reason:)) | 呼叫被拒绝。被呼叫方主动拒绝了通话请求,或者因为被呼叫方当前正处于其他房间中而自动拒绝。回调中通常包含拒绝原因(如主动拒绝或在其他房间中)。 |
128
- | [onCallHandledByOtherDevice](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallhandledbyotherdevice(roominfo:isaccepted:)) | 呼叫已在其他设备处理。当用户在多个设备(例如手机和 iPad)同时登录时,如果呼叫已在其中一台设备上被处理(接受或拒绝),当前设备会收到此通知,用于同步 UI 状态并自动消除呼叫界面。 |
123
+
124
+ |事件函数|触发时机与说明|
125
+ |---------|---------|
126
+ |[onCallTimeout](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncalltimeout(roominfo:call:))|呼叫超时。当呼叫请求在预设的时间内(由调用 callUserToRoom 时指定)未得到被呼叫方的响应时触发。此时,呼叫自动结束,呼叫方通常需要提示“对方无人接听”。|
127
+ |[onCallAccepted](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallaccepted(roominfo:call:))|呼叫被接受。被呼叫方主动点击了“接听”或“接受”按钮。收到此回调后,表示双方已达成呼叫意图,呼叫方通常应立即执行进入房间或开始推流的操作。|
128
+ |[onCallRejected](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallrejected(roominfo:call:reason:))|呼叫被拒绝。被呼叫方主动拒绝了通话请求,或者因为被呼叫方当前正处于其他房间中而自动拒绝。回调中通常包含拒绝原因(如主动拒绝或在其他房间中)。|
129
+ |[onCallHandledByOtherDevice](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallhandledbyotherdevice(roominfo:isaccepted:))|呼叫已在其他设备处理。当用户在多个设备(例如手机和 iPad)同时登录时,如果呼叫已在其中一台设备上被处理(接受或拒绝),当前设备会收到此通知,用于同步 UI 状态并自动消除呼叫界面。|
129
130
 
130
131
  ### 步骤3:被呼叫方功能
131
132
 
@@ -162,11 +163,12 @@ private func subscribeRoomCallEvents() {
162
163
  ```
163
164
 
164
165
  **事件函数详细说明**
165
- | 事件函数 | 触发时机与说明 |
166
- | --- | --- |
167
- | [onCallReceived](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallreceived(roominfo:call:extensioninfo:)) | 收到呼叫邀请。当有其他用户向您发起入会邀请时触发。收到此回调后,被呼叫方通常应立即弹出“呼叫提醒”界面,展示呼叫者信息、房间信息,并提供“接听”和“拒绝”按钮。 |
168
- | [onCallCancelled](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallcancelled(roominfo:call:)) | 呼叫被发起方取消。呼叫方在您未做出响应前,主动撤回了呼叫请求。收到此回调后,被呼叫方应立即关闭当前的来电界面,并提示“对方已取消呼叫”,以恢复应用正常操作流程。 |
169
- | [onCallRevokedByAdmin](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallrevokedbyadmin(roominfo:call:operator:)) | 呼叫被管理员撤销。房间管理员或后台系统因权限变更、房间解散等原因强行终止了该笔呼叫邀请。收到此通知后,被呼叫方需立即停止呼叫流程并隐藏相关 UI,处理逻辑通常类似于呼叫被取消。 |
166
+
167
+ |事件函数|触发时机与说明|
168
+ |---------|---------|
169
+ |[onCallReceived](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallreceived(roominfo:call:extensioninfo:))|收到呼叫邀请。当有其他用户向您发起入会邀请时触发。收到此回调后,被呼叫方通常应立即弹出“呼叫提醒”界面,展示呼叫者信息、房间信息,并提供“接听”和“拒绝”按钮。|
170
+ |[onCallCancelled](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallcancelled(roominfo:call:))|呼叫被发起方取消。呼叫方在您未做出响应前,主动撤回了呼叫请求。收到此回调后,被呼叫方应立即关闭当前的来电界面,并提示“对方已取消呼叫”,以恢复应用正常操作流程。|
171
+ |[onCallRevokedByAdmin](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallrevokedbyadmin(roominfo:call:operator:))|呼叫被管理员撤销。房间管理员或后台系统因权限变更、房间解散等原因强行终止了该笔呼叫邀请。收到此通知后,被呼叫方需立即停止呼叫流程并隐藏相关 UI,处理逻辑通常类似于呼叫被取消。|
170
172
 
171
173
  #### **2. 接受呼叫、拒绝呼叫**
172
174
 
@@ -221,6 +223,6 @@ func rejectCall(roomID: String, reason: CallRejectionReason = .rejected) {
221
223
  ```
222
224
 
223
225
  ## API 文档
224
- | **Store/Component** | **功能描述** | **API文档** |
226
+ | <strong>Store/Component</strong> | <strong>功能描述</strong> | <strong>API文档</strong> |
225
227
  | --- | --- | --- |
226
- | **RoomStore** | 房间全生命周期管理:创建并加入 / 加入 / 离开 / 结束房间 / 更新、获取房间信息 / 预定房间 / 呼叫房间外成员 / 监听房间内被动事件(例如房间解散,房间信息更新等)。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomstore) |
228
+ | <strong>RoomStore</strong> | 房间全生命周期管理:创建并加入 / 加入 / 离开 / 结束房间 / 更新、获取房间信息 / 预定房间 / 呼叫房间外成员 / 监听房间内被动事件(例如房间解散,房间信息更新等)。 | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomstore">API 文档</a> |