@tencentcloud/sdk-mcp 1.6.7 → 1.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (331) hide show
  1. package/CHANGELOG.md +25 -0
  2. package/README.md +54 -35
  3. package/knowledge/build-index.js +32 -5
  4. package/knowledge/chunker.js +82 -14
  5. package/knowledge/chunking-policy.js +100 -0
  6. package/knowledge/content-loader.js +3 -1
  7. package/knowledge/frontmatter-meta.js +167 -0
  8. package/knowledge/path-meta.js +28 -6
  9. package/knowledge/search/exact-lookup.js +26 -123
  10. package/knowledge/search/filter-pool.js +17 -26
  11. package/knowledge/search/framework-fallback.js +22 -0
  12. package/knowledge/search/intent-router.js +13 -0
  13. package/knowledge/search/query-normalizer.js +129 -0
  14. package/knowledge/search/search-core.js +391 -0
  15. package/knowledge/search/search-knowledge.js +351 -323
  16. package/knowledge/search/search-message.js +87 -0
  17. package/knowledge/search/search-pass.js +428 -0
  18. package/knowledge/search/search-types.js +1 -0
  19. package/knowledge/search/url-row-scorer.js +258 -0
  20. package/package.json +1 -1
  21. package/resource/_schema/feature-aliases.yaml +1 -0
  22. package/resource/_schema/query-normalization.yaml +9 -0
  23. package/resource/index/manifest.json +1 -1
  24. package/resource/integration/callkit/preset/android/integration.md +0 -14
  25. package/resource/integration/callkit/preset/flutter/integration.md +0 -9
  26. package/resource/integration/callkit/preset/ios/integration.md +2 -14
  27. package/resource/integration/callkit/preset/react/integration.md +0 -21
  28. package/resource/integration/callkit/preset/vue/integration.md +0 -27
  29. package/resource/integration/chat/preset/android/integration.md +3 -10
  30. package/resource/integration/chat/preset/flutter/integration.md +12 -13
  31. package/resource/integration/chat/preset/ios/integration.md +9 -16
  32. package/resource/integration/chat/preset/react/integration.md +1 -9
  33. package/resource/integration/chat/preset/uni-app/integration.md +0 -9
  34. package/resource/integration/chat/preset/vue/integration.md +3 -13
  35. package/resource/integration/livekit/preset/live/android/live-host-integration.md +0 -4
  36. package/resource/integration/livekit/preset/live/android/prepare-integration.md +8 -21
  37. package/resource/integration/livekit/preset/live/ios/live-audience-integration.md +0 -1
  38. package/resource/integration/livekit/preset/live/ios/live-host-integration.md +0 -5
  39. package/resource/integration/livekit/preset/live/ios/live-list-integration.md +0 -4
  40. package/resource/integration/livekit/preset/live/ios/prepare-integration.md +0 -9
  41. package/resource/integration/livekit/preset/live/vue/live-list-integration.md +1 -5
  42. package/resource/integration/livekit/preset/live/vue/live-player-desk-integration.md +38 -147
  43. package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +1 -6
  44. package/resource/integration/livekit/preset/live/vue/live-pusher-integration.md +432 -286
  45. package/resource/integration/roomkit/preset/vue/integration.md +11 -24
  46. package/resource/knowledge/callkit/best-practice/callkit-miniprogram/uniapp-shrink.md +64 -0
  47. package/resource/knowledge/callkit/best-practice/common/call-autoplay-blocked.md +81 -0
  48. package/resource/knowledge/callkit/best-practice/common/call-message-in-chat.md +84 -0
  49. package/resource/knowledge/callkit/best-practice/common/call-vs-calls.md +114 -0
  50. package/resource/knowledge/callkit/best-practice/common/callengine-call-flow.md +128 -0
  51. package/resource/knowledge/callkit/best-practice/common/callengine-log-level.md +72 -0
  52. package/resource/knowledge/callkit/best-practice/common/callkit-get-engine-instance.md +87 -0
  53. package/resource/knowledge/callkit/best-practice/common/callkit-get-roomid.md +83 -0
  54. package/resource/knowledge/callkit/best-practice/common/callkit-limitations.md +37 -0
  55. package/resource/knowledge/callkit/best-practice/common/callkit-user-register-and-kicked.md +103 -0
  56. package/resource/knowledge/callkit/core-sdk/android/answer-call.md +1 -20
  57. package/resource/knowledge/callkit/core-sdk/android/make-call.md +0 -12
  58. package/resource/knowledge/callkit/core-sdk/android/offline-push.md +1 -12
  59. package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +0 -19
  60. package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +0 -13
  61. package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +1 -17
  62. package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +0 -13
  63. package/resource/knowledge/callkit/core-sdk/ios/make-call.md +0 -13
  64. package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +0 -12
  65. package/resource/knowledge/callkit/core-sdk/miniprogram/call-engine.md +0 -1
  66. package/resource/knowledge/callkit/core-sdk/miniprogram/call-event.md +0 -2
  67. package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +0 -15
  68. package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +0 -15
  69. package/resource/knowledge/callkit/core-sdk/web/call-engine.md +0 -1
  70. package/resource/knowledge/callkit/core-sdk/web/call-event.md +0 -1
  71. package/resource/knowledge/callkit/core-sdk/web/callengine-api-overview.md +0 -1
  72. package/resource/knowledge/callkit/faq/android.md +5 -15
  73. package/resource/knowledge/callkit/faq/common.md +0 -1
  74. package/resource/knowledge/callkit/faq/ios.md +1 -4
  75. package/resource/knowledge/callkit/faq/uniapp-app.md +0 -2
  76. package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +0 -5
  77. package/resource/knowledge/callkit/faq/web.md +1 -5
  78. package/resource/knowledge/callkit/preset/android/api.md +0 -6
  79. package/resource/knowledge/callkit/preset/ios/api.md +0 -4
  80. package/resource/knowledge/callkit/preset/miniprogram/api.md +0 -2
  81. package/resource/knowledge/callkit/preset/react/api.md +3 -154
  82. package/resource/knowledge/callkit/preset/vue/api.md +3 -42
  83. package/resource/knowledge/chat/best-practice/common/avchatroom-message-loss-diagnosis.md +71 -0
  84. package/resource/knowledge/chat/best-practice/common/group-conversation-cleanup-on-system-notice.md +67 -0
  85. package/resource/knowledge/chat/best-practice/common/image-message-url-lifecycle.md +63 -0
  86. package/resource/knowledge/chat/best-practice/common/login-repeat-2025-diagnosis.md +65 -0
  87. package/resource/knowledge/chat/best-practice/common/message-read-report-and-receipt.md +72 -0
  88. package/resource/knowledge/chat/best-practice/common/message-receive-event.md +70 -0
  89. package/resource/knowledge/chat/best-practice/common/message-risk-error-and-render.md +69 -0
  90. package/resource/knowledge/chat/best-practice/common/message-unread-count.md +71 -0
  91. package/resource/knowledge/chat/best-practice/miniprogram/audio-message-send.md +118 -0
  92. package/resource/knowledge/chat/best-practice/miniprogram/login-timeout-2801-diagnosis.md +67 -0
  93. package/resource/knowledge/chat/best-practice/miniprogram/media-upload-fail-diagnosis.md +68 -0
  94. package/resource/knowledge/chat/best-practice/web/audio-message-send.md +123 -0
  95. package/resource/knowledge/chat/preset/android/features/chat-setting.md +1 -4
  96. package/resource/knowledge/chat/preset/android/features/contact-list.md +0 -5
  97. package/resource/knowledge/chat/preset/android/features/conversation-list.md +1 -9
  98. package/resource/knowledge/chat/preset/android/features/language.md +1 -11
  99. package/resource/knowledge/chat/preset/android/features/message-input.md +1 -8
  100. package/resource/knowledge/chat/preset/android/features/message-list.md +1 -10
  101. package/resource/knowledge/chat/preset/android/features/search.md +0 -7
  102. package/resource/knowledge/chat/preset/android/features/theme.md +0 -6
  103. package/resource/knowledge/chat/preset/android-view/integration.md +3 -5
  104. package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +1 -4
  105. package/resource/knowledge/chat/preset/flutter/features/contact-list.md +1 -6
  106. package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +1 -9
  107. package/resource/knowledge/chat/preset/flutter/features/language.md +0 -3
  108. package/resource/knowledge/chat/preset/flutter/features/message-input.md +1 -8
  109. package/resource/knowledge/chat/preset/flutter/features/message-list.md +1 -10
  110. package/resource/knowledge/chat/preset/flutter/features/search.md +0 -7
  111. package/resource/knowledge/chat/preset/flutter/features/theme.md +0 -6
  112. package/resource/knowledge/chat/preset/ios/features/chat-setting.md +1 -4
  113. package/resource/knowledge/chat/preset/ios/features/contact-list.md +1 -8
  114. package/resource/knowledge/chat/preset/ios/features/conversation-list.md +1 -9
  115. package/resource/knowledge/chat/preset/ios/features/language.md +0 -11
  116. package/resource/knowledge/chat/preset/ios/features/message-input.md +1 -8
  117. package/resource/knowledge/chat/preset/ios/features/message-list.md +1 -10
  118. package/resource/knowledge/chat/preset/ios/features/search.md +0 -5
  119. package/resource/knowledge/chat/preset/ios/features/theme.md +0 -6
  120. package/resource/knowledge/chat/preset/ios-uikit/integration.md +5 -17
  121. package/resource/knowledge/chat/preset/react/features/chat-setting.md +0 -2
  122. package/resource/knowledge/chat/preset/react/features/contact-list.md +0 -23
  123. package/resource/knowledge/chat/preset/react/features/conversation-actions.md +2 -11
  124. package/resource/knowledge/chat/preset/react/features/conversation-list.md +2 -23
  125. package/resource/knowledge/chat/preset/react/features/conversation-preview.md +0 -5
  126. package/resource/knowledge/chat/preset/react/features/search.md +0 -1
  127. package/resource/knowledge/chat/preset/vue/features/chat-header.md +1 -3
  128. package/resource/knowledge/chat/preset/vue/features/chat-setting.md +3 -5
  129. package/resource/knowledge/chat/preset/vue/features/contact-list.md +3 -9
  130. package/resource/knowledge/chat/preset/vue/features/conversation-actions.md +0 -3
  131. package/resource/knowledge/chat/preset/vue/features/conversation-list.md +2 -13
  132. package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +2 -5
  133. package/resource/knowledge/chat/preset/vue/features/conversation-search.md +1 -0
  134. package/resource/knowledge/chat/preset/vue/features/message-input.md +2 -4
  135. package/resource/knowledge/chat/preset/vue/features/message-list.md +2 -4
  136. package/resource/knowledge/chat/preset/vue/features/search.md +4 -1
  137. package/resource/knowledge/chat/preset/vue/features/theme.md +4 -6
  138. package/resource/knowledge/chat/urls/sdk/web.md +1 -1
  139. package/resource/knowledge/livekit/best-practice/android/voice-room-anchor-start.md +124 -0
  140. package/resource/knowledge/livekit/best-practice/common/admin-take-seat.md +73 -0
  141. package/resource/knowledge/livekit/best-practice/common/audience-leave-live.md +81 -0
  142. package/resource/knowledge/livekit/best-practice/common/voice-room-no-audio-troubleshoot.md +100 -0
  143. package/resource/knowledge/livekit/best-practice/common/voice-room-seat-list-change.md +65 -0
  144. package/resource/knowledge/livekit/best-practice/flutter/voice-room-anchor-start.md +126 -0
  145. package/resource/knowledge/livekit/best-practice/ios/voice-room-anchor-start.md +130 -0
  146. package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +0 -7
  147. package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +0 -3
  148. package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +0 -3
  149. package/resource/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +0 -1
  150. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +0 -5
  151. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +0 -3
  152. package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +0 -2
  153. package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +0 -2
  154. package/resource/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +0 -2
  155. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +0 -2
  156. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +0 -1
  157. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +0 -2
  158. package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +1 -3
  159. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +0 -7
  160. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +0 -3
  161. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +0 -1
  162. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +0 -3
  163. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +0 -5
  164. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +0 -3
  165. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +0 -2
  166. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +0 -2
  167. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +0 -2
  168. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +0 -2
  169. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +0 -1
  170. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +0 -2
  171. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +1 -3
  172. package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +0 -7
  173. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +0 -3
  174. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +0 -1
  175. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +0 -3
  176. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +0 -5
  177. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +0 -3
  178. package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +0 -2
  179. package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +0 -2
  180. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +0 -2
  181. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +0 -2
  182. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +0 -1
  183. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +0 -2
  184. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +1 -3
  185. package/resource/knowledge/livekit/core-sdk/features/android/audience-list.md +2 -2
  186. package/resource/knowledge/livekit/core-sdk/features/android/audio-effect.md +1 -3
  187. package/resource/knowledge/livekit/core-sdk/features/android/barrage.md +2 -2
  188. package/resource/knowledge/livekit/core-sdk/features/android/base-beauty.md +0 -2
  189. package/resource/knowledge/livekit/core-sdk/features/android/gift.md +2 -7
  190. package/resource/knowledge/livekit/core-sdk/features/android/live-list.md +2 -2
  191. package/resource/knowledge/livekit/core-sdk/features/flutter/audience-list.md +2 -2
  192. package/resource/knowledge/livekit/core-sdk/features/flutter/audio-effect.md +0 -4
  193. package/resource/knowledge/livekit/core-sdk/features/flutter/barrage.md +2 -2
  194. package/resource/knowledge/livekit/core-sdk/features/flutter/base-beauty.md +0 -2
  195. package/resource/knowledge/livekit/core-sdk/features/flutter/gift.md +3 -7
  196. package/resource/knowledge/livekit/core-sdk/features/flutter/live-list.md +3 -2
  197. package/resource/knowledge/livekit/core-sdk/features/ios/audience-list.md +2 -2
  198. package/resource/knowledge/livekit/core-sdk/features/ios/audio-effect.md +1 -3
  199. package/resource/knowledge/livekit/core-sdk/features/ios/barrage.md +2 -2
  200. package/resource/knowledge/livekit/core-sdk/features/ios/base-beauty.md +0 -2
  201. package/resource/knowledge/livekit/core-sdk/features/ios/gift.md +2 -7
  202. package/resource/knowledge/livekit/core-sdk/features/ios/live-list.md +2 -2
  203. package/resource/knowledge/livekit/core-sdk/features/uni-app/audience-list.md +2 -2
  204. package/resource/knowledge/livekit/core-sdk/features/uni-app/audio-effect.md +1 -2
  205. package/resource/knowledge/livekit/core-sdk/features/uni-app/barrage.md +2 -2
  206. package/resource/knowledge/livekit/core-sdk/features/uni-app/base-beauty.md +0 -2
  207. package/resource/knowledge/livekit/core-sdk/features/uni-app/gift.md +4 -8
  208. package/resource/knowledge/livekit/core-sdk/features/uni-app/live-list.md +2 -2
  209. package/resource/knowledge/livekit/core-sdk/live/android/co-guest-interaction.md +0 -3
  210. package/resource/knowledge/livekit/core-sdk/live/android/host-interaction.md +0 -2
  211. package/resource/knowledge/livekit/core-sdk/live/android/integration.md +0 -7
  212. package/resource/knowledge/livekit/core-sdk/live/flutter/co-guest-interaction.md +0 -2
  213. package/resource/knowledge/livekit/core-sdk/live/flutter/host-interaction.md +0 -2
  214. package/resource/knowledge/livekit/core-sdk/live/flutter/integration.md +1 -7
  215. package/resource/knowledge/livekit/core-sdk/live/ios/co-guest-interaction.md +0 -3
  216. package/resource/knowledge/livekit/core-sdk/live/ios/host-interaction.md +0 -2
  217. package/resource/knowledge/livekit/core-sdk/live/ios/integration.md +0 -7
  218. package/resource/knowledge/livekit/core-sdk/live/uni-app/co-guest-interaction.md +0 -2
  219. package/resource/knowledge/livekit/core-sdk/live/uni-app/host-interaction.md +0 -2
  220. package/resource/knowledge/livekit/core-sdk/live/uni-app/integration.md +0 -5
  221. package/resource/knowledge/livekit/core-sdk/voice/android/co-guest-interaction.md +1 -3
  222. package/resource/knowledge/livekit/core-sdk/voice/android/host-interaction.md +4 -13
  223. package/resource/knowledge/livekit/core-sdk/voice/android/integration.md +5 -5
  224. package/resource/knowledge/livekit/core-sdk/voice/flutter/co-guest-interaction.md +0 -3
  225. package/resource/knowledge/livekit/core-sdk/voice/flutter/integration.md +18 -21
  226. package/resource/knowledge/livekit/core-sdk/voice/ios/co-guest-interaction.md +0 -2
  227. package/resource/knowledge/livekit/core-sdk/voice/ios/host-interaction.md +2 -11
  228. package/resource/knowledge/livekit/core-sdk/voice/ios/integration.md +8 -8
  229. package/resource/knowledge/livekit/core-sdk/voice/uni-app/co-guest-interaction.md +0 -2
  230. package/resource/knowledge/livekit/core-sdk/voice/uni-app/integration.md +1 -4
  231. package/resource/knowledge/livekit/faq/error-code.md +1 -1
  232. package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +0 -5
  233. package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +1 -1
  234. package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +0 -3
  235. package/resource/knowledge/push/api-reference/donut.md +1 -6
  236. package/resource/knowledge/push/api-reference/harmonyos.md +0 -2
  237. package/resource/knowledge/push/api-reference/react-native.md +0 -3
  238. package/resource/knowledge/push/api-reference/uni-app.md +3 -5
  239. package/resource/knowledge/push/api-reference/unity.md +0 -1
  240. package/resource/knowledge/push/api-reference/unreal-engine.md +0 -1
  241. package/resource/knowledge/push/config/android/fcm.md +0 -6
  242. package/resource/knowledge/push/config/android/honor.md +1 -7
  243. package/resource/knowledge/push/config/android/huawei.md +1 -9
  244. package/resource/knowledge/push/config/android/meizu.md +1 -7
  245. package/resource/knowledge/push/config/android/oppo.md +1 -3
  246. package/resource/knowledge/push/config/android/vivo.md +1 -12
  247. package/resource/knowledge/push/config/android/xiaomi.md +0 -5
  248. package/resource/knowledge/push/config/donut.md +0 -12
  249. package/resource/knowledge/push/config/harmonyos.md +18 -7
  250. package/resource/knowledge/push/config/ios.md +26 -33
  251. package/resource/knowledge/push/config/react-native.md +0 -30
  252. package/resource/knowledge/push/config/unity.md +0 -30
  253. package/resource/knowledge/push/config/unreal-engine.md +0 -30
  254. package/resource/knowledge/push/integration/android.md +148 -57
  255. package/resource/knowledge/push/integration/donut.md +5 -21
  256. package/resource/knowledge/push/integration/flutter.md +4 -6
  257. package/resource/knowledge/push/integration/harmonyos.md +17 -16
  258. package/resource/knowledge/push/integration/ios.md +30 -18
  259. package/resource/knowledge/push/integration/react-native.md +10 -60
  260. package/resource/knowledge/push/integration/uni-app.md +3 -25
  261. package/resource/knowledge/push/integration/unity.md +8 -77
  262. package/resource/knowledge/push/integration/unreal-engine.md +37 -96
  263. package/resource/knowledge/roomkit/best-practice/common/room-ghost-member.md +75 -0
  264. package/resource/knowledge/roomkit/best-practice/common/room-limit-and-multi.md +88 -0
  265. package/resource/knowledge/roomkit/best-practice/common/room-screen-share-preview.md +87 -0
  266. package/resource/knowledge/roomkit/best-practice/common/room-status-after-all-leave.md +73 -0
  267. package/resource/knowledge/roomkit/best-practice/vue/room-uikit-vs-atomicx.md +115 -0
  268. package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md +0 -2
  269. package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md +0 -2
  270. package/resource/knowledge/roomkit/core-sdk/android/room-state.md +3 -5
  271. package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md +4 -6
  272. package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +0 -2
  273. package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +0 -2
  274. package/resource/knowledge/roomkit/core-sdk/flutter/room-state.md +2 -4
  275. package/resource/knowledge/roomkit/core-sdk/flutter/schedule-room.md +4 -6
  276. package/resource/knowledge/roomkit/core-sdk/ios/call-user-to-room.md +0 -2
  277. package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md +0 -2
  278. package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +3 -5
  279. package/resource/knowledge/roomkit/core-sdk/ios/schedule-room.md +4 -6
  280. package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +0 -5
  281. package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +0 -3
  282. package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +0 -5
  283. package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +0 -3
  284. package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +1 -7
  285. package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +1 -2
  286. package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +0 -1
  287. package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +0 -3
  288. package/resource/knowledge/roomkit/preset/android/integration.md +202 -6
  289. package/resource/knowledge/roomkit/preset/flutter/integration.md +1 -16
  290. package/resource/knowledge/roomkit/preset/ios/integration.md +201 -7
  291. package/resource/knowledge/roomkit/preset/react/integration.md +205 -4
  292. package/resource/knowledge/rtcengine/web/api.md +0 -2
  293. package/resource/knowledge/rtcengine/web/plugin/22-advanced-audio-mixer.md +2 -2
  294. package/resource/knowledge/rtcengine/web/plugin/23-advanced-support-detection.md +3 -3
  295. package/resource/knowledge/rtcengine/web/plugin/28-advanced-beauty.md +1 -1
  296. package/resource/knowledge/rtcengine/web/plugin/30-advanced-cross-room-link.md +2 -0
  297. package/resource/knowledge/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -4
  298. package/resource/knowledge/rtcengine/web/plugin/39-advanced-video-decoder.md +2 -0
  299. package/resource/knowledge/share/userSig.md +2 -2
  300. package/resource/knowledge/trtc/android/TRTCCloud.md +16 -16
  301. package/resource/knowledge/trtc/android/TRTCCloudDef.md +5 -5
  302. package/resource/knowledge/trtc/android/TRTCCloudListener.md +3 -3
  303. package/resource/knowledge/trtc/android/TXAudioEffectManager.md +2 -2
  304. package/resource/knowledge/trtc/android/TXDeviceManager.md +1 -1
  305. package/resource/knowledge/trtc/c++/ITRTCCloud.md +14 -14
  306. package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +2 -2
  307. package/resource/knowledge/trtc/c++/ITXDeviceManager.md +4 -4
  308. package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +3 -3
  309. package/resource/knowledge/trtc/c++/TRTCTypeDef.md +5 -5
  310. package/resource/knowledge/trtc/ios/TRTCCloud.md +14 -14
  311. package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +3 -3
  312. package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +2 -2
  313. package/resource/knowledge/trtc/ios/TXDeviceManager.md +4 -4
  314. package/resource/knowledge/trtc/ios/TXLiveSDKTypeDef.md +5 -5
  315. package/server.js +8 -3
  316. package/tools/common/finalize_answer.js +9 -1
  317. package/tools/common/search_trtc_knowledge.js +3 -1
  318. package/tools/definitions/finalize_answer_def.js +2 -2
  319. package/tools/definitions/integration-boundary.js +2 -1
  320. package/tools/definitions/search_trtc_knowledge_def.js +2 -1
  321. package/utils/report-cls-client.js +3 -3
  322. package/utils/report-es-client.js +1 -1
  323. package/cursor-setting.png +0 -0
  324. package/mcp-server-prompt.png +0 -0
  325. package/resource/knowledge/callkit/best-practice/web/callengine-invitation.md +0 -80
  326. package/resource/knowledge/callkit/best-practice/web/callengine-log-control.md +0 -20
  327. package/resource/knowledge/callkit/best-practice/web/callkit-call-vs-calls.md +0 -116
  328. package/resource/knowledge/callkit/preset/react/uikit-api-reference.md +0 -475
  329. package/resource/knowledge/callkit/preset/vue/uikit-api-reference.md +0 -587
  330. package/resource/knowledge/callkit/preset/web/api.md +0 -79
  331. package/resource/knowledge/chat/best-practice/web/image-message-url-handling.md +0 -16
@@ -27,8 +27,6 @@
27
27
 
28
28
  ### 步骤1:组件集成
29
29
 
30
- 请参考 接入概览 集成 **AtomicXCore SDK**,并已完成 实现登录逻辑 部分接入。
31
-
32
30
  ### 步骤2:**创建并加入房间**
33
31
 
34
32
  #### *实现*方式:
@@ -81,7 +79,7 @@ fun createAndJoinRoom() {
81
79
  | --- | --- | --- | --- |
82
80
  | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
83
81
  | <code>roomType</code> | <code>RoomType</code> | 是 | 房间类型<br>- <code>STANDARD</code>:标准房间(默认值)。<br>- <code>WEBINAR</code>:大型研讨会房间。<br>多人会议场景这里填写 <code>STANDARD</code> 房间类型。 |
84
- | <code>options</code> | <code>CreateRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法请参考:CreateRoomOptions 结构体详细说明 |
82
+ | <code>options</code> | <code>CreateRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法
85
83
  | <code>completion</code> | <code>CompletionHandler</code> | 否 | 操作完成回调,用于返回创建和加入房间的结果。若创建失败则会返回错误码和错误信息。 |
86
84
 
87
85
  ##### CreateRoomOptions 结构体详细说明
@@ -227,8 +225,8 @@ fun updateRoomInfo() {
227
225
  | 参数名 | 类型 | 必填 | 说明 |
228
226
  | --- | --- | --- | --- |
229
227
  | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
230
- | <code>options</code> | <code>UpdateRoomOptions</code> | 是 | - 更新房间属性配置对象。<br>- 详细用法请参考:UpdateRoomOptions 结构体详细说明 |
231
- | <code>modifyFlagList</code> | <code>List<UpdateRoomOptions.ModifyFlag></code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>房间密码</strong>。<br>- 详细用法请参考:UpdateRoomOptions.ModifyFlag 详细说明。 |
228
+ | <code>options</code> | <code>UpdateRoomOptions</code> | 是 | - 更新房间属性配置对象。<br>- 详细用法
229
+ | <code>modifyFlagList</code> | <code>List<UpdateRoomOptions.ModifyFlag></code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>房间密码</strong>。<br>- 详细用法。 |
232
230
  | <code>completion</code> | <code>CompletionHandler</code> | 否 | 操作完成回调,用于返回更新房间信息的结果。若更新失败则会返回错误码和错误信息。 |
233
231
 
234
232
  **UpdateRoomOptions 结构体详细说明**
@@ -26,8 +26,6 @@
26
26
 
27
27
  ### 步骤1:组件集成
28
28
 
29
- 请参考 接入概览 集成 **AtomicXCore SDK**,并已完成 实现登录逻辑 部分接入。
30
-
31
29
  ### 步骤2:预定房间功能
32
30
 
33
31
  #### **1. 预定房间**
@@ -80,7 +78,7 @@ fun scheduleRoom() {
80
78
  | 参数名 | 类型 | 必填 | 说明 |
81
79
  | --- | --- | --- | --- |
82
80
  | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
83
- | <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法请参考:ScheduleRoomOptions 结构体详细说明。 |
81
+ | <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法。 |
84
82
  | <code>completion</code> | <code>CompletionHandler</code> | 否 | 操作完成回调,用于返回预定房间的结果。若预定失败则会返回错误码和错误信息。 |
85
83
 
86
84
  ##### ScheduleRoomOptions 结构体详细说明
@@ -91,7 +89,7 @@ fun scheduleRoom() {
91
89
  | <code>scheduleStartTime</code> | <code>Long</code> | 是 | - 预定的房间开始时间(Unix 时间戳,单位:秒)。<br>- 取值必须大于当前时间。<br>- 推荐设置为未来的整分时间。例如:1736164800(代表 2025-01-06 20:00:00)。 |
92
90
  | <code>scheduleEndTime</code> | <code>Long</code> | 是 | - 预定的房间结束时间(Unix 时间戳,单位:秒)。<br>- 取值必须大于 <code>scheduleStartTime</code>。<br>- 建议根据预期时长设置。例如:<code>scheduleStartTime</code> + 3600(预定 1 小时时长的房间)。 |
93
91
  | <code>reminderSecondsBeforeStart</code> | <code>Int</code> | 否 | - 房间开始前的提醒时间(单位:秒)。用于系统触发开始提醒。<br>- 推荐设置为 300(5分钟)或 900(15分钟),用于在 App 端触发本地通知。 |
94
- | <code>scheduleAttendees</code> | <code>List<String></code> | 否 | - 预定参与者的用户 ID 列表,在预定房间时设置,系统将向这些用户发送预定邀请。<br>- 获取方式请参考 获取指定预定房间的参与成员列表。 |
92
+ | <code>scheduleAttendees</code> | <code>List<String></code> | 否 | - 预定参与者的用户 ID 列表,在预定房间时设置,系统将向这些用户发送预定邀请。<br>- 获取方式。 |
95
93
  | <code>isAllMicrophoneDisabled</code> | <code>Boolean</code> | 否 | 是否全员禁止打开麦克风。开启后,除房主/管理员外,普通参与者默认禁止打开麦克风。<br>- true : 禁止。<br>- false :取消禁止 (默认值)。 |
96
94
  | <code>isAllCameraDisabled</code> | <code>Boolean</code> | 否 | 是否全员禁止打开摄像头。开启后,除房主/管理员外,普通参与者默认禁止打开摄像头。<br>- true : 禁止。<br>- false :取消禁止(默认值)。 |
97
95
  | <code>isAllScreenShareDisabled</code> | <code>Boolean</code> | 否 | 是否全员禁止发起屏幕共享。开启后,仅房主/管理员可进行屏幕共享。<br>- true : 禁止。<br>- false :取消禁止(默认值)。 |
@@ -161,8 +159,8 @@ fun updateScheduledRoom() {
161
159
  | 参数名 | 类型 | 必填 | 说明 |
162
160
  | --- | --- | --- | --- |
163
161
  | <code>roomID</code> | <code>String</code> | 是 | 字符串类型的房间唯一标识符。<br>限制长度为 0-48 字节。<br>建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
164
- | <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | 预定房间配置对象。<br>详细用法请参考:ScheduleRoomOptions 结构体详细说明。 |
165
- | <code>modifyFlagList</code> | <code>List<ScheduleRoomOptions.ModifyFlag></code> | 是 | 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>开始时间</strong>、<strong>结束时间。</strong><br>详细用法请参考:ScheduleRoomOptions.ModifyFlag 详细说明。 |
162
+ | <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | 预定房间配置对象。<br>详细用法。 |
163
+ | <code>modifyFlagList</code> | <code>List<ScheduleRoomOptions.ModifyFlag></code> | 是 | 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>开始时间</strong>、<strong>结束时间。</strong><br>详细用法。 |
166
164
  | <code>completion</code> | <code>CompletionHandler</code> | 否 | 操作完成回调,用于返回更新预定房间的结果。若更新失败则会返回错误码和错误信息。 |
167
165
 
168
166
  **ScheduleRoomOptions.ModifyFlag 详细说明**
@@ -21,8 +21,6 @@
21
21
 
22
22
  ### 步骤1:组件集成
23
23
 
24
- 请参考 接入概览 集成 **AtomicXCore SDK**,并已完成 实现登录逻辑 部分接入。
25
-
26
24
  ### 步骤2:呼叫方功能
27
25
 
28
26
  #### **1. 发起呼叫**
@@ -57,8 +57,6 @@
57
57
 
58
58
  ### 步骤1:组件集成
59
59
 
60
- 请参考 接入概览 集成 **AtomicXCore SDK**,并已完成 实现登录逻辑 部分接入。
61
-
62
60
  ### 步骤2:获取参与者列表
63
61
 
64
62
  在加入房间后,调用`RoomParticipantStore`的`getParticipantList`接口获取到房间内参与者列表。
@@ -27,8 +27,6 @@
27
27
 
28
28
  ### 步骤1:组件集成
29
29
 
30
- 请参考 接入概览 集成 **AtomicXCore SDK**,并已完成 实现登录逻辑 部分接入。
31
-
32
30
  ### 步骤2:**创建并加入房间**
33
31
 
34
32
  ##### 实现方式:
@@ -207,8 +205,8 @@ Future<void> updateRoomInfo() async {
207
205
  | 参数名 | 类型 | 必填 | 说明 |
208
206
  | --- | --- | --- | --- |
209
207
  | <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 详细说明。 |
208
+ | <code>options</code> | <code>UpdateRoomOptions</code> | 是 | - 更新房间属性配置对象。<br>- 详细用法
209
+ | <code>modifyFlag</code> | <code>UpdateRoomOptionsModifyFlag</code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>房间密码</strong>。<br>- 详细用法。 |
212
210
 
213
211
  **UpdateRoomOptions 结构体详细说明**
214
212
  | 参数名 | 类型 | 必填 | 说明 |
@@ -26,8 +26,6 @@
26
26
 
27
27
  ### 步骤1:组件集成
28
28
 
29
- 请参考 接入概览 集成 **AtomicXCore SDK**,并已完成 实现登录逻辑 部分接入。
30
-
31
29
  ### 步骤2:预定房间功能
32
30
 
33
31
  #### **一、预定房间**
@@ -79,7 +77,7 @@ Future<void> scheduleRoom() async {
79
77
  | 参数名 | 类型 | 必填 | 说明 |
80
78
  | --- | --- | --- | --- |
81
79
  | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
82
- | <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法请参考:ScheduleRoomOptions 结构体详细说明 |
80
+ | <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法
83
81
 
84
82
  ##### ScheduleRoomOptions 结构体详细说明
85
83
  | 参数名 | 类型 | 必填 | 说明 |
@@ -89,7 +87,7 @@ Future<void> scheduleRoom() async {
89
87
  | scheduleStartTime | int | 是 | - 预定的房间开始时间(Unix 时间戳,单位:秒)。<br>- 取值必须大于当前时间。<br>- 推荐设置为未来的整分时间。例如:1736164800(代表 2025-01-06 20:00:00)。 |
90
88
  | scheduleEndTime | int | 是 | - 预定的房间结束时间(Unix 时间戳,单位:秒)。<br>- 取值必须大于 scheduleStartTime。<br>- 建议根据预期时长设置。例如:scheduleStartTime + 3600(预定 1 小时时长的房间)。 |
91
89
  | reminderSecondsBeforeStart | int | 否 | - 房间开始前的提醒时间(单位:秒)。用于系统触发开始提醒。<br>- 推荐设置为 300(5分钟)或 900(15分钟),用于在 App 端触发本地通知。 |
92
- | scheduleAttendees | List<String> | 否 | - 预定参与者的用户 ID 列表,在预定房间时设置,系统将向这些用户发送预定邀请。<br>- 获取方式请参考 获取指定预定房间的参与成员列表。 |
90
+ | scheduleAttendees | List<String> | 否 | - 预定参与者的用户 ID 列表,在预定房间时设置,系统将向这些用户发送预定邀请。<br>- 获取方式。 |
93
91
  | isAllMicrophoneDisabled | bool | 否 | - 是否全员禁止打开麦克风。开启后,除房主/管理员外,普通参与者默认禁止打开麦克风。<br>- 参数含义:<br>- true : 禁止。<br>- false :取消禁止 (默认值)。 |
94
92
  | isAllCameraDisabled | bool | 否 | - 是否全员禁止打开摄像头。开启后,除房主/管理员外,普通参与者默认禁止打开摄像头。<br>- 参数含义:<br>- true : 禁止。<br>- false :取消禁止(默认值)。 |
95
93
  | isAllScreenShareDisabled | bool | 否 | - 是否全员禁止发起屏幕共享。开启后,仅房主/管理员可进行屏幕共享。<br>- 参数含义:<br>- true : 禁止。<br>- false :取消禁止(默认值)。 |
@@ -152,8 +150,8 @@ Future<void> scheduleRoom() async {
152
150
  | 参数名 | 类型 | 必填 | 说明 |
153
151
  | --- | --- | --- | --- |
154
152
  | roomID | String | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
155
- | options | ScheduleRoomOptions | 是 | - 预定房间配置对象。<br>- 详细用法请参考:ScheduleRoomOptions 结构体详细说明 |
156
- | modifyFlagList | List<ScheduleRoomOptionsModifyFlag> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>开始时间</strong>、<strong>结束时间。</strong><br>- 详细用法请参考:ScheduleRoomOptionsModifyFlag 详细说明。 |
153
+ | options | ScheduleRoomOptions | 是 | - 预定房间配置对象。<br>- 详细用法
154
+ | modifyFlagList | List<ScheduleRoomOptionsModifyFlag> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>开始时间</strong>、<strong>结束时间。</strong><br>- 详细用法。 |
157
155
 
158
156
  **ScheduleRoomOptionsModifyFlag 详细说明**
159
157
  | 参数名 | 说明 |
@@ -21,8 +21,6 @@
21
21
 
22
22
  ### 步骤1:组件集成
23
23
 
24
- 请参考 接入概览 集成 **AtomicXCore SDK**,并已完成 实现登录逻辑 部分接入。
25
-
26
24
  ### 步骤2:呼叫方功能
27
25
 
28
26
  #### **1. 发起呼叫**
@@ -27,8 +27,6 @@
27
27
 
28
28
  ### 步骤1:组件集成
29
29
 
30
- 请参考 接入概览 集成 **AtomicXCore SDK**,并已完成 实现登录逻辑 部分的接入。
31
-
32
30
  ### 步骤2:获取参与者列表
33
31
 
34
32
  在加入房间后,调用 `RoomParticipantStore` 的 `getParticipantList` 接口获取到房间内参与者列表。
@@ -27,8 +27,6 @@
27
27
 
28
28
  ### 步骤1:组件集成
29
29
 
30
- 请参考 接入概览 集成 **AtomicXCore SDK** ,并已完成 实现登录逻辑 部分接入。
31
-
32
30
  ### 步骤2:**创建并加入房间**
33
31
 
34
32
  ##### 实现方式:
@@ -74,7 +72,7 @@ func createAndJoinRoom() {
74
72
  | --- | --- | --- | --- |
75
73
  | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
76
74
  | <code>roomType</code> | <code>RoomType</code> | 是 | 房间类型:<br>- <code>standard</code>:标准房间,所有成员可自由音视频互动。<br>- <code>webinar</code>:大型研讨会房间,区分嘉宾和观众角色,观众默认无上麦权限。<br>多人会议场景这里填写 <code>standard</code> 房间类型。 |
77
- | <code>options</code> | <code>CreateRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法请参考:CreateRoomOptions 结构体详细说明。 |
75
+ | <code>options</code> | <code>CreateRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法。 |
78
76
  | <code>completion</code> | <code>CompletionClosure</code> | 否 | 操作完成回调,用于返回创建和加入房间的结果。若创建失败则会返回错误码和错误信息。 |
79
77
 
80
78
  ##### CreateRoomOptions 结构体详细说明
@@ -205,8 +203,8 @@ func updateRoomInfo() {
205
203
  | 参数名 | 类型 | 必填 | 说明 |
206
204
  | --- | --- | --- | --- |
207
205
  | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
208
- | <code>options</code> | <code>UpdateRoomOptions</code> | 是 | - 更新房间属性配置对象。<br>- 详细用法请参考:UpdateRoomOptions 结构体详细说明。 |
209
- | <code>modifyFlag</code> | <code>UpdateRoomOptions.ModifyFlag</code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>房间密码</strong>。<br>- 详细用法请参考:UpdateRoomOptions.ModifyFlag 详细说明。 |
206
+ | <code>options</code> | <code>UpdateRoomOptions</code> | 是 | - 更新房间属性配置对象。<br>- 详细用法。 |
207
+ | <code>modifyFlag</code> | <code>UpdateRoomOptions.ModifyFlag</code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>房间密码</strong>。<br>- 详细用法。 |
210
208
  | <code>completion</code> | <code>CompletionClosure</code> | 否 | 操作完成回调,用于返回更新房间信息的结果。若更新失败则会返回错误码和错误信息。 |
211
209
 
212
210
  **UpdateRoomOptions 结构体详细说明**
@@ -26,8 +26,6 @@
26
26
 
27
27
  ### 步骤1:组件集成
28
28
 
29
- 请参考 接入概览 集成 **AtomicXCore SDK**,并已完成 实现登录逻辑 部分接入。
30
-
31
29
  ### 步骤2:预定房间功能
32
30
 
33
31
  #### **一、预定房间**
@@ -78,7 +76,7 @@ func scheduleRoom() {
78
76
  | 参数名 | 类型 | 必填 | 说明 |
79
77
  | --- | --- | --- | --- |
80
78
  | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
81
- | <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法请参考:ScheduleRoomOptions 结构体详细说明 |
79
+ | <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法
82
80
  | <code>completion</code> | <code>CompletionClosure</code> | 否 | 操作完成回调,用于返回预定房间的结果。若预定失败则会返回错误码和错误信息。 |
83
81
 
84
82
  ##### ScheduleRoomOptions 结构体详细说明
@@ -89,7 +87,7 @@ func scheduleRoom() {
89
87
  | <code>scheduleStartTime</code> | <code>Int</code> | 是 | - 预定的房间开始时间(Unix 时间戳,单位:秒)。<br>- 取值必须大于当前时间。<br>- 推荐设置为未来的整分时间。例如:1736164800(代表 2025-01-06 20:00:00)。 |
90
88
  | <code>scheduleEndTime</code> | <code>Int</code> | 是 | - 预定的房间结束时间(Unix 时间戳,单位:秒)。<br>- 取值必须大于 <code>scheduleStartTime</code>。<br>- 建议根据预期时长设置。例如:<code>scheduleStartTime</code> + 3600(预定 1 小时时长的房间)。 |
91
89
  | <code>reminderSecondsBeforeStart</code> | <code>Int</code> | 否 | - 房间开始前的提醒时间(单位:秒)。用于系统触发开始提醒。<br>- 推荐设置为 300(5分钟)或 900(15分钟),用于在 App 端触发本地通知。 |
92
- | <code>scheduleAttendees</code> | <code>[String]</code> | 否 | - 预定参与者的用户 ID 列表,在预定房间时设置,系统将向这些用户发送预约邀请。<br>- 获取请参考获取指定预定房间的参与成员列表。 |
90
+ | <code>scheduleAttendees</code> | <code>[String]</code> | 否 | - 预定参与者的用户 ID 列表,在预定房间时设置,系统将向这些用户发送预约邀请。<br>- 获取。 |
93
91
  | <code>isAllMicrophoneDisabled</code> | <code>Bool</code> | 否 | 是否全员禁止打开麦克风。开启后,除房主/管理员外,普通参与者默认禁止打开麦克风。<br>- true : 禁止<br>- false :取消禁止 (默认值) |
94
92
  | <code>isAllCameraDisabled</code> | <code>Bool</code> | 否 | 是否全员禁止打开摄像头。开启后,除房主/管理员外,普通参与者默认禁止打开摄像头。<br>- true : 禁止<br>- false :取消禁止(默认值) |
95
93
  | <code>isAllScreenShareDisabled</code> | <code>Bool</code> | 否 | 是否全员禁止发起屏幕共享。开启后,仅房主/管理员可进行屏幕共享。<br>- true : 禁止<br>- false :取消禁止(默认值) |
@@ -152,8 +150,8 @@ func updateScheduledRoom() {
152
150
  | 参数名 | 类型 | 必填 | 说明 |
153
151
  | --- | --- | --- | --- |
154
152
  | <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
155
- | <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 预定房间配置对象。<br>- 详细用法请参考:ScheduleRoomOptions 结构体详细说明 |
156
- | <code>modifyFlag</code> | <code>ScheduleRoomOptions.ModifyFlag</code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>开始时间</strong>、<strong>结束时间。</strong><br>- 详细用法请参考:ScheduleRoomOptions.ModifyFlag 详细说明。 |
153
+ | <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 预定房间配置对象。<br>- 详细用法
154
+ | <code>modifyFlag</code> | <code>ScheduleRoomOptions.ModifyFlag</code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>开始时间</strong>、<strong>结束时间。</strong><br>- 详细用法。 |
157
155
  | <code>completion</code> | <code>CompletionClosure</code> | 否 | 操作完成回调,用于返回更新预定房间的结果。若更新失败则会返回错误码和错误信息。 |
158
156
 
159
157
  **ScheduleRoomOptions.ModifyFlag 详细说明**
@@ -38,7 +38,6 @@
38
38
  会前检测用于在用户入会前确认摄像头、麦克风和扬声器是否可用,常见于会议预览页、入会设置页和设备检测页。
39
39
 
40
40
  > **注意:**
41
- >
42
41
  > 会前设备检测用于确认设备是否可用,不代表用户已经在房间中发布音视频。用户入会后,仍需调用对应的设备控制接口,摄像头或麦克风才会被打开并在房间中发布音视频。
43
42
  >
44
43
 
@@ -380,7 +379,6 @@ function CameraControl() {
380
379
  会议中推荐使用“进房后预采集 + 默认静音”:先调用 `muteMicrophone`,再调用 `openLocalMicrophone` 打开采集,避免采集开启但尚未静音导致漏音。用户开麦时调用 `unmuteMicrophone`,闭麦时调用 `muteMicrophone`。
381
380
 
382
381
  > **说明:**
383
- >
384
382
  > 1. 麦克风控制推荐采用“进房后预采集 + 默认静音”的方式有两个好处:
385
383
  > - 用户点击打开麦克风时,不需要重新处理物理设备采集,响应速度更快。
386
384
  > - 业务层可以持续检测本地麦克风音量。当用户正在说话但音频未上行时,可以提示“您正在说话,是否打开麦克风?”。
@@ -626,7 +624,6 @@ function AudioSettings() {
626
624
  ```
627
625
 
628
626
  > **说明:**
629
- >
630
627
  > 扬声器设备切换依赖浏览器能力。部分浏览器可能无法获取扬声器列表或无法切换播放设备,建议在列表为空或切换失败时提示用户使用系统声音设置切换输出设备。
631
628
  >
632
629
 
@@ -1173,7 +1170,6 @@ function AdminDeviceRequestHandler() {
1173
1170
  管理员也可以邀请指定成员开启麦克风、摄像头或屏幕分享。邀请不是强制开启,成员接受后才会打开本地设备。
1174
1171
 
1175
1172
  > **说明:**
1176
- >
1177
1173
  > 邀请开启设备需要尊重用户授权。即使用户接受邀请,浏览器仍可能弹出系统权限确认;如果用户拒绝授权,设备仍无法打开。
1178
1174
  >
1179
1175
 
@@ -1319,7 +1315,6 @@ function DeviceInvitationHandler() {
1319
1315
  使用 `useDeviceState` 中的 [networkInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#networkInfo) 获取本地用户网络状态。
1320
1316
 
1321
1317
  > **说明:**
1322
- >
1323
1318
  > 仅当本地用户通过 `joinRoom` 或 `createAndJoinRoom` 加入房间,并且打开麦克风或摄像头后,`networkInfo` 中才可以拿到有效数据。未入会或未开启音视频采集时,建议展示“未知”或不展示网络状态。
1324
1319
  >
1325
1320
 
@@ -38,7 +38,6 @@ import { FreeBeautyPanel } from 'tuikit-atomicx-vue3/room';
38
38
  **以下示例展示了如何实现一个点击按钮弹出美颜设置的完整交互:**
39
39
 
40
40
  > **注意:**
41
- >
42
41
  > 所有 TUIKit 组件必须包裹在 UIKitProvider 内部,否则将无法获取上下文依赖,导致样式异常。
43
42
  >
44
43
 
@@ -117,7 +116,6 @@ const openBeautySettings = () => {
117
116
  在用户调节美颜参数(例如拖动滑块)时,使用 [setFreeBeauty](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setFreeBeauty) 进行实时预览。此时效果仅本地可见,不会传输给远端用户。
118
117
 
119
118
  > **注意:**
120
- >
121
119
  > 参数取值范围为 0-100。
122
120
  >
123
121
 
@@ -142,7 +140,6 @@ const updatePreview = async (beauty: number, white: number, ruddy: number) => {
142
140
  用户确认预览效果满意后,调用 [saveBeautySetting](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#saveBeautySetting) 将当前配置应用到视频流中。此时远端用户可以看到美颜效果。
143
141
 
144
142
  > **注意:**
145
- >
146
143
  > 虚拟背景功能依赖摄像头设备。可使用 [useDeviceState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-DeviceState) 检查设备状态。
147
144
  >
148
145
  > - [cameraList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cameraList):当前可用的摄像头设备列表,如果列表为空,说明未检测到摄像头或摄像头权限被禁止。
@@ -35,7 +35,6 @@
35
35
  在用户加入房间成功后,需要调用 [setActiveConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setActiveConversation) 接口初始化聊天数据。Vue 3 中建议使用 `watch` 监听 `currentRoom` 的变化;React 中使用 `useEffect`。
36
36
 
37
37
  > **说明:**
38
- >
39
38
  > - `GROUP` 为固定前缀,`setActiveConversation` 参数必须为 ``GROUP${roomId}``,否则无法正常收发消息。
40
39
  > - `GROUP` 为 IM SDK 群组会话的固定前缀(参考 [IM 会话类型](https://web.sdk.qcloud.com/im/doc/zh-cn/Conversation.html))。房间聊天基于 IM 群组实现,因此会话 ID 必须为 ``GROUP${roomId}`` 格式。
41
40
 
@@ -99,7 +98,6 @@ function useChatConversationSync() {
99
98
  在您的页面中,可以直接组合使用这两个组件。同时结合 [useRoomParticipantState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-RoomParticipantState) 获取当前用户的禁言状态,控制输入框的可用性。
100
99
 
101
100
  > **注意:**
102
- >
103
101
  > 所有 TUIKit 组件必须包裹在 UIKitProvider 内部,否则将无法获取上下文依赖,导致样式异常。
104
102
  >
105
103
 
@@ -273,7 +271,6 @@ function useChatUnreadCount(isChatPanelOpen: boolean) {
273
271
  与方案一步骤1相同,同样需要先调用 [setActiveConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setActiveConversation) 接口激活对应的 IM 群组会话。在退房时建议清空活跃会话,避免消息错发。
274
272
 
275
273
  > **说明:**
276
- >
277
274
  > - `GROUP` 为固定前缀,`setActiveConversation` 参数必须为 ``GROUP${roomId}``,否则无法正常收发消息。
278
275
  > - 在房间切换或退房时,建议重置或清空活跃会话,避免消息错发至错误会话。
279
276
 
@@ -430,7 +427,6 @@ function MessageListPanel({ roomId }: { roomId: string }) {
430
427
  使用对应框架的 Hook 管理输入框内容并发送消息。两者底层均调用相同的 `MessageInputStore.sendMessage(payload)`。
431
428
 
432
429
  > **注意:**
433
- >
434
430
  > `MessageInputStore` 是纯命令式 Store,不持有输入框内容状态。需由业务层自行管理输入内容,发送时将内容通过 `sendMessage({ type: 'textMessage', text })` 传入。
435
431
  >
436
432
 
@@ -504,7 +500,6 @@ function MessageInputPanel({ roomId }: { roomId: string }) {
504
500
  分页拉取历史消息,通常在滚动到列表顶部时触发。Vue 3 和 React 均使用 `loadOlderMessages()`(底层均对应 `MessageListStore.loadOlderMessages()`)。
505
501
 
506
502
  > **注意:**
507
- >
508
503
  > 在加载历史消息后,通常需要手动调整滚动条位置,以保持当前浏览视角不发生跳变。
509
504
  >
510
505
 
@@ -34,7 +34,6 @@
34
34
  | 申请开启媒体设备 | - | - | 支持 | |
35
35
 
36
36
  > **说明:**
37
- >
38
37
  > 房主和管理员权限应同时在 UI 层和接口调用层做校验。UI 层可隐藏当前成员不可见的管理入口;接口调用层仍需通过 `try/catch` 处理无权限错误。
39
38
  >
40
39
 
@@ -75,7 +74,6 @@ export default function ParticipantPanel() {
75
74
  ```
76
75
 
77
76
  > **说明:**
78
- >
79
77
  > - 如果使用内置成员列表组件 `RoomParticipantList`,需要在应用根节点配置 `UIKitProvider`,请参考 接入概览 > 配置全局 UIKitProvider。
80
78
  > - `RoomParticipantList` 会自动占满父容器的高度和宽度,请确保父容器具备明确尺寸。如果您需要完全自定义成员列表样式、操作按钮或业务信息展示,建议改用 `useRoomParticipantState` 自行渲染。
81
79
 
@@ -1013,7 +1011,6 @@ async function inviteUserToOpenCamera(userId: string) {
1013
1011
  |`RoomParticipantEvent.onDeviceInvitationDeclined`|成员拒绝邀请。|管理员侧展示拒绝结果。|
1014
1012
 
1015
1013
  > **说明:**
1016
- >
1017
1014
  > 设备申请和邀请的完整设备打开流程请参考设备管理文档。成员管理文档主要说明成员之间的权限协作关系。
1018
1015
  >
1019
1016
 
@@ -7,7 +7,6 @@
7
7
  用户已经通过 [useLoginState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-LoginState) 完成登录鉴权,请参考 接入概览。
8
8
 
9
9
  > **注意:**
10
- >
11
10
  > - **异步性:** `login` 方法为异步执行。在单页应用中,建议通过监听 `loginUserInfo.value?.userId` 的变化来确保登录就绪,严禁在未确认登录状态时抢跑调用房间管理方法。
12
11
  > - **单例约束:** `useRoomState` 采用单例设计,同一用户同一时刻仅支持存在于一个房间内。
13
12
 
@@ -48,7 +47,6 @@ const {
48
47
  请根据您的业务场景,选择适合的创建房间方式。
49
48
 
50
49
  > **注意:**
51
- >
52
50
  > 创建房间时指定的 `roomId` 建议由业务后台生成并下发,以确保同一场会议在您的业务系统中具备稳定且唯一的标识。
53
51
  >
54
52
 
@@ -119,7 +117,6 @@ await createAndJoinRoom({
119
117
  ```
120
118
 
121
119
  > **说明:**
122
- >
123
120
  > 创建者在调用 `createAndJoinRoom` 时会自动加入房间,无需额外输入密码。
124
121
  >
125
122
 
@@ -127,7 +124,7 @@ await createAndJoinRoom({
127
124
 
128
125
  **适用场景:**适用于需要在未来特定时间召开的会议(例如团队周会、线上培训等)。用户可在客户端提前设定会议标题、时间及受邀参会成员。
129
126
 
130
- **实现方式**:由客户端生成或向业务后台申请一个唯一的房间号,并配合会议时间等参数调用 `scheduleRoom` 接口提交预定。预定成功后,会议信息将同步至参与者的会议列表中。更多客户端预订会议能力请参考 无 UI 集成 > 预订房间。
127
+ **实现方式**:由客户端生成或向业务后台申请一个唯一的房间号,并配合会议时间等参数调用 `scheduleRoom` 接口提交预定。预定成功后,会议信息将同步至参与者的会议列表中。更多客户端预订会议能力。
131
128
 
132
129
  【Vue3】
133
130
  ``` typescript
@@ -285,7 +282,6 @@ await createAndJoinRoom({
285
282
  ```
286
283
 
287
284
  > **说明:**
288
- >
289
285
  > `createAndJoinRoom` 支持“房间不存在则创建,房间已存在则加入”的进房方式,适合无法预先判断房间状态的业务场景。
290
286
  >
291
287
 
@@ -324,7 +320,6 @@ await updateRoomInfo({
324
320
  ```
325
321
 
326
322
  > **说明:**
327
- >
328
323
  > 房主必须已经在房间内才能调用 `updateRoomInfo`。如果房主已经离开房间,需要先重新加入房间。
329
324
  >
330
325
 
@@ -397,7 +392,6 @@ await endRoom();
397
392
  ```
398
393
 
399
394
  > **说明:**
400
- >
401
395
  > - leaveRoom 适用于“当前用户退出”,不会销毁房间。
402
396
  > - endRoom 仅房主可调用,用于结束当前房间。
403
397
  > - 如果房主离开房间但未调用 endRoom,房间将继续存在,直到满足自动回收条件(连续 6 小时无用户)。
@@ -117,7 +117,7 @@ export default function ConferenceRoom() {
117
117
  #### 注意事项
118
118
  - `RoomView` 会占满父容器,请确保父容器设置了明确的 `width` 和 `height`。
119
119
 
120
- - `RoomView` 不负责创建或加入房间,也不负责打开本地摄像头或麦克风。设备打开逻辑请参考设备及网络。
120
+ - `RoomView` 不负责创建或加入房间,也不负责打开本地摄像头或麦克风。设备打开逻辑。
121
121
 
122
122
  ## 场景二:自定义视频区域挂件
123
123
 
@@ -475,7 +475,6 @@ export default function ConferenceRoom() {
475
475
  |移动端布局|优先展示屏幕共享;1-2 人场景突出远端或当前主要画面;多人场景通过分页展示。|
476
476
 
477
477
  > **说明:**
478
- >
479
478
  > 顶部栏和侧边栏布局中,用户双击某个画面后,该画面会成为主画面。若该成员离开房间,或被锁定的屏幕共享结束,主画面会自动回退到默认选择规则。
480
479
  >
481
480
 
@@ -95,7 +95,6 @@ const handleStartScreenShareWithAudio = async () => {
95
95
  |Safari|不支持|暂不支持系统音频分享|
96
96
 
97
97
  > **注意:**
98
- >
99
98
  > 系统音频分享需要浏览器支持,且用户在屏幕选择器中勾选**分享音频**选项。如果浏览器不支持系统音频分享,`screenAudio` 参数会被忽略,但屏幕画面分享功能不受影响,可以正常使用。
100
99
  >
101
100
 
@@ -50,7 +50,6 @@ import { VirtualBackgroundPanel } from 'tuikit-atomicx-vue3/room';
50
50
  **以下示例展示了如何实现一个点击按钮弹出虚拟背景设置的完整交互:**
51
51
 
52
52
  > **注意:**
53
- >
54
53
  > - 将 `node_modules/trtc-sdk-v5/assets` 目录发布至 CDN 或者静态资源服务器中,详情可见 [SDK 文档](https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-36-advanced-virtual-background.html)。
55
54
  > - 在使用 [VirtualBackgroundPanel](https://github.com/Tencent-RTC/TUIKit_Vue3/tree/main/packages/tuikit-atomicx-vue3/src/components/VirtualBackgroundPanel) 组件时,通过 props 传入 `assetsPath` 静态资源地址。
56
55
  > - 所有 TUIKit 组件必须包裹在 UIKitProvider 内部,否则将无法获取上下文依赖,导致样式异常。
@@ -122,7 +121,6 @@ const openSettings = () => {
122
121
  在调用虚拟背景功能前,必须先检查浏览器是否支持,并初始化资源路径。
123
122
 
124
123
  > **注意:**
125
- >
126
124
  > - 将 node_modules/trtc-sdk-v5/assets 目录发布至 CDN 或者静态资源服务器中,详情可见 [SDK 文档](https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-36-advanced-virtual-background.html)。
127
125
  > - 在使用 [initVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initVirtualBackground) 接口时,传入 assetsPath 静态资源地址。
128
126
  > - 虚拟背景功能依赖摄像头设备。可使用 [useDeviceState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-DeviceState) 检查设备状态。
@@ -156,7 +154,6 @@ onMounted(async () => {
156
154
  在用户确认应用背景前,通常需要先预览效果。使用 [setVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setVirtualBackground) 方法可以设置预览效果,此时不会应用到远端可见的视频流中。
157
155
 
158
156
  > **说明:**
159
- >
160
157
  > 调用 `setVirtualBackground` 仅在本地预览画面生效,远端用户不会看到虚拟背景效果,需调用 `saveVirtualBackground` 后才会同步到远端视频流。
161
158
  >
162
159