@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
@@ -1,780 +0,0 @@
1
- atomicx-core SDK 是腾讯云最新推出的面向即时通信、音视频通话、视频直播、语聊房等场景的全新一代基于响应式的 API,您可以非常快速的基于这组 API 构建自己的 UI 页面,它支持房间管理、屏幕分享、成员管理、麦位控制、基础美颜等丰富功能,同时基于 TRTC SDK,能够提供超低延时、高品质的音视频体验,本页面包含 atomicx-core SDK 的所有 API 接口,按功能模块分类展示。
2
-
3
- ## LoginState
4
-
5
- 用户身份认证与登录管理模块
6
- - 核心功能:提供用户登录、登出、个人信息管理等基础身份认证功能,是整个系统的用户身份基础。
7
-
8
- - 技术特点:支持多种登录方式、用户信息缓存、登录状态持久化等功能,确保用户身份的安全性和可靠性。
9
-
10
- - 业务价值:为所有业务模块提供统一的用户身份认证服务,是系统安全和用户体验的基础保障。
11
-
12
- - 应用场景:用户登录、身份验证、个人信息管理、权限控制等核心身份认证场景。
13
-
14
- **响应式数据**
15
-
16
- | **数据列表** | **描述** |
17
- | --- | --- |
18
- | [loginUserInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#loginUserInfo) | 当前登录用户信息。 |
19
-
20
- **接口函数**
21
-
22
- | **函数列表** | **描述** |
23
- | --- | --- |
24
- | [login](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#login) | 用户登录。 |
25
- | [setSelfInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setSelfInfo) | 设置用户个人信息。 |
26
- | [logout](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#logout) | 用户登出函数。 |
27
-
28
- ## DeviceState
29
-
30
- 设备状态管理模块
31
- - 核心功能:管理摄像头、麦克风等音视频设备的控制,提供设备状态监控、权限检查等基础设备服务。
32
-
33
- - 技术特点:支持多设备管理、设备状态实时监控、权限动态检查、设备故障自动恢复等高级功能。
34
-
35
- - 业务价值:为直播系统提供稳定的设备基础,确保音视频采集的可靠性和用户体验。
36
-
37
- - 应用场景:设备管理、权限控制、音视频采集、设备故障处理等基础技术场景。
38
-
39
- **响应式数据**
40
-
41
- | **数据列表** | **描述** |
42
- | --- | --- |
43
- | [microphoneStatus](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#microphoneStatus) | 麦克风状态。 |
44
- | [microphoneList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#microphoneList) | 麦克风设备列表。 |
45
- | [currentMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentMicrophone) | 当前选中的麦克风设备。 |
46
- | [microphoneLastError](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#microphoneLastError) | 麦克风最后一次错误信息。 |
47
- | [captureVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#captureVolume) | 麦克风采集音量。 |
48
- | [currentMicVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentMicVolume) | 当前麦克风音量。 |
49
- | [isMicrophoneTesting](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isMicrophoneTesting) | 麦克风测试状态。 |
50
- | [testingMicVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#testingMicVolume) | 测试时的麦克风音量。 |
51
- | [cameraStatus](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cameraStatus) | 摄像头状态。 |
52
- | [cameraList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cameraList) | 摄像头设备列表。 |
53
- | [currentCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentCamera) | 当前选中的摄像头设备。 |
54
- | [cameraLastError](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cameraLastError) | 摄像头最后一次错误信息。 |
55
- | [isCameraTesting](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isCameraTesting) | 摄像头测试状态。 |
56
- | [isCameraTestLoading](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isCameraTestLoading) | 摄像头测试加载状态。 |
57
- | [isFrontCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isFrontCamera) | 是否为前置摄像头。 |
58
- | [localMirrorType](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#localMirrorType) | 本地视频镜像类型。 |
59
- | [localVideoQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#localVideoQuality) | 本地视频质量。 |
60
- | [speakerList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#speakerList) | 扬声器设备列表。 |
61
- | [currentSpeaker](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentSpeaker) | 当前选中的扬声器设备。 |
62
- | [outputVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#outputVolume) | 扬声器输出音量。 |
63
- | [currentAudioRoute](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentAudioRoute) | 当前音频路由。 |
64
- | [isSpeakerTesting](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isSpeakerTesting) | 扬声器测试状态。 |
65
- | [screenStatus](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#screenStatus) | 屏幕分享状态。 |
66
- | [networkInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#networkInfo) | 网络信息。 |
67
-
68
- **接口函数**
69
-
70
- | **函数列表** | **描述** |
71
- | --- | --- |
72
- | [openLocalMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#openLocalMicrophone) | 开启本地麦克风。 |
73
- | [closeLocalMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#closeLocalMicrophone) | 关闭本地麦克风。 |
74
- | [muteLocalAudio](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#muteLocalAudio) | 静音本地音频。 |
75
- | [unmuteLocalAudio](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#unmuteLocalAudio) | 取消静音本地音频。 |
76
- | [getMicrophoneList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getMicrophoneList) | 获取麦克风设备列表。 |
77
- | [setCurrentMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setCurrentMicrophone) | 设置当前麦克风设备。 |
78
- | [startMicrophoneTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startMicrophoneTest) | 开始麦克风测试。 |
79
- | [setCaptureVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setCaptureVolume) | 设置音频采集音量。 |
80
- | [setOutputVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setOutputVolume) | 设置音频播放音量。 |
81
- | [stopMicrophoneTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopMicrophoneTest) | 停止麦克风测试。 |
82
- | [getSpeakerList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getSpeakerList) | 获取扬声器设备列表。 |
83
- | [setCurrentSpeaker](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setCurrentSpeaker) | 设置当前扬声器设备。 |
84
- | [setAudioRoute](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setAudioRoute) | 设置音频路由。 |
85
- | [startSpeakerTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startSpeakerTest) | 开始扬声器测试。 |
86
- | [stopSpeakerTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopSpeakerTest) | 停止扬声器测试。 |
87
- | [openLocalCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#openLocalCamera) | 开启本地摄像头。 |
88
- | [closeLocalCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#closeLocalCamera) | 关闭本地摄像头。 |
89
- | [getCameraList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getCameraList) | 获取摄像头设备列表。 |
90
- | [setCurrentCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setCurrentCamera) | 设置当前摄像头设备。 |
91
- | [switchCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#switchCamera) | 切换前后摄像头。 |
92
- | [switchMirror](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#switchMirror) | 切换视频镜像模式。 |
93
- | [updateVideoQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateVideoQuality) | 更新视频质量。 |
94
- | [startCameraDeviceTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startCameraDeviceTest) | 开始摄像头设备测试。 |
95
- | [startScreenShare](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startScreenShare) | 开始屏幕分享。 |
96
- | [stopScreenShare](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopScreenShare) | 停止屏幕分享。 |
97
- | [stopCameraDeviceTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopCameraDeviceTest) | 停止摄像头设备测试。 |
98
- | [screenCaptureStopped](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#screenCaptureStopped) | 屏幕分享停止回调。 |
99
-
100
- ## LiveListState
101
-
102
- 直播列表管理模块
103
- - 核心功能:管理直播间的完整生命周期,包括创建、加入、离开、结束等核心业务流程,支持直播列表的分页获取和实时更新。
104
-
105
- - 技术特点:支持分页加载、实时状态同步、直播信息动态更新,采用响应式数据管理,确保 UI 与数据状态实时同步。新增 liveList 和 liveListCursor 响应式数据,提供 fetchLiveList 接口函数。
106
-
107
- - 业务价值:为直播平台提供核心的直播间管理能力,支持大规模并发直播场景,是直播业务的基础设施。
108
-
109
- - 应用场景:直播列表展示、直播间创建、直播状态管理、直播数据统计等核心业务场景。
110
-
111
- **响应式数据**
112
-
113
- | **数据列表** | **描述** |
114
- | --- | --- |
115
- | [currentLive](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentLive) | 转换TUILiveInfo为LiveInfo格式。 |
116
- | [liveList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#liveList) | 直播列表数据,包含所有直播间的信息。 |
117
- | [liveListCursor](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#liveListCursor) | 直播列表分页游标,用于获取下一页数据。 |
118
-
119
- **接口函数**
120
-
121
- | **函数列表** | **描述** |
122
- | --- | --- |
123
- | [createLive](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#createLive) | 创建直播间。 |
124
- | [joinLive](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#joinLive) | 加入直播间。 |
125
- | [leaveLive](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#leaveLive) | 离开直播间。 |
126
- | [endLive](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#endLive) | 结束直播。 |
127
- | [updateLiveInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateLiveInfo) | 更新直播间信息。 |
128
- | [queryMetaData](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#queryMetaData) | 查询元数据。 |
129
- | [updateLiveMetaData](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateLiveMetaData) | 更新直播间元数据。 |
130
- | [fetchLiveList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#fetchLiveList) | 获取直播列表。 |
131
-
132
- ## LiveSeatState
133
-
134
- 直播间座位管理模块
135
- - 核心功能:实现多人连麦场景下的座位控制,支持复杂的座位状态管理和音视频设备控制,包括上麦、下麦、座位锁定等完整功能。
136
-
137
- - 技术特点:基于 WebRTC 技术,支持多路音视频流管理,提供座位锁定、设备控制、权限管理等高级功能。新增 seatList、canvas、speakingUsers、networkQualities 响应式数据,以及完整的座位操作接口。
138
-
139
- - 业务价值:为多人互动直播提供核心技术支撑,支持 PK、连麦、多人游戏等丰富的互动场景。
140
-
141
- - 应用场景:多人连麦、主播 PK、互动游戏、在线教育、会议直播等需要多人音视频互动的场景。
142
-
143
- **响应式数据**
144
-
145
- | **数据列表** | **描述** |
146
- | --- | --- |
147
- | [seatList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#seatList) | 麦位列表,包含所有麦位的状态和用户信息。 |
148
- | [canvas](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#canvas) | 画布配置,用于视频渲染和布局管理。 |
149
- | [speakingUsers](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#speakingUsers) | 正在发言的用户列表。 |
150
- | [networkQualities](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#networkQualities) | 网络质量信息,包含各用户的网络状态。 |
151
-
152
- **接口函数**
153
-
154
- | **函数列表** | **描述** |
155
- | --- | --- |
156
- | [takeSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#takeSeat) | 用户上麦。 |
157
- | [leaveSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#leaveSeat) | 用户下麦。 |
158
- | [lockSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#lockSeat) | 锁定麦位。 |
159
- | [unLockSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#unLockSeat) | 解锁麦位。 |
160
- | [kickUserOutOfSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#kickUserOutOfSeat) | 踢用户下麦。 |
161
- | [moveUserToSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#moveUserToSeat) | 移动用户到指定麦位。 |
162
- | [openRemoteCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#openRemoteCamera) | 开启远端摄像头。 |
163
- | [closeRemoteCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#closeRemoteCamera) | 关闭远端摄像头。 |
164
- | [openRemoteMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#openRemoteMicrophone) | 开启远端麦克风。 |
165
- | [closeRemoteMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#closeRemoteMicrophone) | 关闭远端麦克风。 |
166
- | [muteMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#muteMicrophone) | 静音麦克风。 |
167
- | [unmuteMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#unmuteMicrophone) | 取消静音麦克风。 |
168
- | [startPlayStream](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startPlayStream) | 开始播放流。 |
169
- | [stopPlayStream](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopPlayStream) | 停止播放流。 |
170
-
171
- ## LiveAudienceState
172
-
173
- 直播间观众管理模块
174
- - 核心功能:管理直播间观众列表,提供观众权限控制、管理员设置等直播间秩序维护功能,支持实时观众统计。
175
-
176
- - 技术特点:支持实时观众列表更新、权限分级管理、批量操作等高级功能,确保直播间秩序和用户体验。新增 audienceList 和 audienceCount 响应式数据。
177
-
178
- - 业务价值:为直播平台提供完整的观众管理解决方案,支持大规模观众场景下的秩序维护。
179
-
180
- - 应用场景:观众管理、权限控制、直播间秩序维护、观众互动管理等核心业务场景。
181
-
182
- **响应式数据**
183
-
184
- | **数据列表** | **描述** |
185
- | --- | --- |
186
- | [audienceList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#audienceList) | 观众列表,包含直播间所有观众的信息。 |
187
- | [audienceCount](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#audienceCount) | 观众总数统计。 |
188
-
189
- **接口函数**
190
-
191
- | **函数列表** | **描述** |
192
- | --- | --- |
193
- | [fetchAudienceList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#fetchAudienceList) | 获取观众列表。 |
194
- | [setAdministrator](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setAdministrator) | 设置管理员。 |
195
- | [revokeAdministrator](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#revokeAdministrator) | 撤销管理员。 |
196
- | [kickUserOutOfRoom](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#kickUserOutOfRoom) | 踢出房间。 |
197
- | [disableSendMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#disableSendMessage) | 禁言用户。 |
198
-
199
- ## LiveMonitorState
200
-
201
- 直播监控管理模块
202
- - 核心功能:提供直播间实时监控功能,包括直播状态监控、数据统计、异常检测等核心监控能力,支持多直播间监控。
203
-
204
- - 技术特点:支持实时数据采集、多维度监控指标、智能告警机制,确保直播服务的稳定性和可靠性。新增 monitorLiveInfoList 响应式数据,优化监控接口。
205
-
206
- - 业务价值:为直播平台提供全方位的监控保障,及时发现和处理异常情况,提升服务质量。
207
-
208
- - 应用场景:直播质量监控、性能分析、异常告警、数据统计等运营管理场景。
209
-
210
- **响应式数据**
211
-
212
- | **数据列表** | **描述** |
213
- | --- | --- |
214
- | [monitorLiveInfoList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#monitorLiveInfoList) | 监控的直播间信息列表。 |
215
-
216
- **接口函数**
217
-
218
- | **函数列表** | **描述** |
219
- | --- | --- |
220
- | [init](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#init) | 初始化监控。 |
221
- | [getLiveList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getLiveList) | 获取直播列表。 |
222
- | [closeRoom](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#closeRoom) | 关闭房间。 |
223
- | [sendMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#sendMessage) | 发送消息。 |
224
- | [startPlay](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startPlay) | 开始播放。 |
225
- | [stopPlay](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopPlay) | 停止播放。 |
226
- | [muteLiveAudio](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#muteLiveAudio) | 静音直播音频。 |
227
-
228
- ## CoGuestState
229
-
230
- 连麦嘉宾管理模块
231
- - 核心功能:处理观众与主播之间的连麦互动,管理连麦申请、邀请、接受、拒绝等完整的连麦流程,支持连麦状态管理。
232
-
233
- - 技术特点:基于实时音视频技术,支持连麦状态实时同步、音视频质量自适应、网络状况监控等高级功能。新增 connected、invitees、applicants、candidates 响应式数据和 applyForSeat 接口。
234
-
235
- - 业务价值:为直播平台提供观众参与互动的核心能力,增强用户粘性和直播趣味性。
236
-
237
- - 应用场景:观众连麦、互动问答、在线K歌、游戏直播等需要观众参与的互动场景。
238
-
239
- **响应式数据**
240
-
241
- | **数据列表** | **描述** |
242
- | --- | --- |
243
- | [candidates](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#candidates) | 取消订阅连麦事件。 |
244
- | [connected](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#connected) | 连麦连接状态。 |
245
- | [invitees](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#invitees) | 被邀请的用户列表。 |
246
- | [applicants](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#applicants) | 申请连麦的用户列表。 |
247
-
248
- **接口函数**
249
-
250
- | **函数列表** | **描述** |
251
- | --- | --- |
252
- | [cancelApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cancelApplication) | 取消申请。 |
253
- | [acceptApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptApplication) | 接受申请。 |
254
- | [rejectApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#rejectApplication) | 拒绝申请。 |
255
- | [cancelInvitation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cancelInvitation) | 取消邀请。 |
256
- | [acceptInvitation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptInvitation) | 接受邀请。 |
257
- | [rejectInvitation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#rejectInvitation) | 拒绝邀请。 |
258
- | [disConnect](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#disConnect) | 断开连接。 |
259
- | [applyForSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#applyForSeat) | 申请上麦。 |
260
-
261
- ## CoHostState
262
-
263
- 连麦主播管理模块
264
- - 核心功能:实现主播间的连麦功能,支持主播邀请、连麦申请、连麦状态管理等主播间互动功能,提供完整的主播连麦流程。
265
-
266
- - 技术特点:支持多主播音视频同步、画中画显示、音视频质量优化等高级技术,确保连麦体验的流畅性。新增 coHostStatus、connected、applicant、invitees、candidates 响应式数据和完整的连麦控制接口。
267
-
268
- - 业务价值:为直播平台提供主播间协作的核心能力,支持 PK、合作直播等高级业务场景。
269
-
270
- - 应用场景:主播 PK、合作直播、跨平台连麦、主播互动等高级直播场景。
271
-
272
- **响应式数据**
273
-
274
- | **数据列表** | **描述** |
275
- | --- | --- |
276
- | [coHostStatus](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#coHostStatus) | 连麦主播状态。 |
277
- | [connected](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#connected) | 连麦连接状态。 |
278
- | [applicant](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#applicant) | 申请连麦的主播信息。 |
279
- | [invitees](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#invitees) | 被邀请的用户列表。 |
280
- | [candidates](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#candidates) | 候选用户列表。 |
281
-
282
- **接口函数**
283
-
284
- | **函数列表** | **描述** |
285
- | --- | --- |
286
- | [requestHostConnection](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#requestHostConnection) | 请求主播连麦。 |
287
- | [cancelHostConnection](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cancelHostConnection) | 取消主播连麦。 |
288
- | [acceptHostConnection](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptHostConnection) | 接受主播连麦。 |
289
- | [rejectHostConnection](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#rejectHostConnection) | 拒绝主播连麦。 |
290
- | [exitHostConnection](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#exitHostConnection) | 退出主播连麦。 |
291
-
292
- ## BattleState
293
-
294
- PK 对战管理模块
295
- - 核心功能:管理主播间的 PK 对战功能,包括对战邀请、接受、拒绝、结束等完整的 PK 流程,支持实时比分统计。
296
-
297
- - 技术特点:支持实时对战状态同步、比分计算、对战结果统计等功能。新增 battleScore 响应式数据,提供完整的 PK 对战体验。
298
-
299
- - 业务价值:为直播平台提供竞技互动功能,增强直播趣味性和用户参与度。
300
-
301
- - 应用场景:主播 PK、才艺比拼、游戏对战、互动竞技等娱乐场景。
302
-
303
- **响应式数据**
304
-
305
- | **数据列表** | **描述** |
306
- | --- | --- |
307
- | [currentBattleInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentBattleInfo) | 当前PK信息。 |
308
- | [battleUsers](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#battleUsers) | PK参与用户列表。 |
309
- | [battleScore](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#battleScore) | PK对战的实时比分。 |
310
-
311
- **接口函数**
312
-
313
- | **函数列表** | **描述** |
314
- | --- | --- |
315
- | [requestBattle](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#requestBattle) | 请求 PK。 |
316
- | [cancelBattleRequest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cancelBattleRequest) | 取消 PK 请求。 |
317
- | [acceptBattle](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptBattle) | 接受 PK。 |
318
- | [rejectBattle](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#rejectBattle) | 拒绝 PK。 |
319
- | [exitBattle](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#exitBattle) | 退出 PK。 |
320
-
321
- ## BarrageState
322
-
323
- 弹幕消息管理模块
324
- - 核心功能:处理直播间内的文本消息、自定义消息等弹幕功能,支持弹幕发送、消息状态同步等完整弹幕系统,提供本地提示功能。
325
-
326
- - 技术特点:支持高并发消息处理、实时消息同步、消息过滤、表情包支持等高级功能。新增 sendTextMessage、sendCustomMessage、appendLocalTip 接口函数。
327
-
328
- - 业务价值:为直播平台提供核心的互动能力,增强用户参与度和直播氛围。
329
-
330
- - 应用场景:弹幕互动、消息管理、表情包、聊天室等社交互动场景。
331
-
332
- **响应式数据**
333
-
334
- | **数据列表** | **描述** |
335
- | --- | --- |
336
- | [messageList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#messageList) | 弹幕消息列表。 |
337
-
338
- **接口函数**
339
-
340
- | **函数列表** | **描述** |
341
- | --- | --- |
342
- | [sendTextMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#sendTextMessage) | 发送文本消息。 |
343
- | [sendCustomMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#sendCustomMessage) | 发送自定义消息。 |
344
- | [appendLocalTip](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#appendLocalTip) | 添加本地提示。 |
345
-
346
- ## MessageListState
347
-
348
- 消息列表管理模块
349
- - 核心功能:管理聊天消息列表,支持消息加载、滚动控制、已读回执、消息高亮等完整的消息展示功能。
350
-
351
- - 技术特点:支持虚拟滚动、消息优化、实时更新等高性能消息处理。新增 activeConversationID、messageList、hasMoreOlderMessage 等响应式数据。
352
-
353
- - 业务价值:为即时通信提供核心的消息展示能力,确保良好的聊天体验。
354
-
355
- - 应用场景:即时通信、群聊、私聊、消息管理等通信场景。
356
-
357
- **响应式数据**
358
-
359
- | **数据列表** | **描述** |
360
- | --- | --- |
361
- | [activeConversationID](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#activeConversationID) | 当前活跃的会话 ID。 |
362
- | [messageList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#messageList) | 消息列表数据。 |
363
- | [hasMoreOlderMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#hasMoreOlderMessage) | 是否有更多旧消息。 |
364
- | [hasMoreNewerMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#hasMoreNewerMessage) | 是否有更多新消息。 |
365
- | [enableReadReceipt](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#enableReadReceipt) | 是否启用已读回执。 |
366
- | [isDisableScroll](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isDisableScroll) | 是否禁用滚动。 |
367
- | [recalledMessageIDSet](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#recalledMessageIDSet) | 已撤回消息的 ID 集合。 |
368
- | [highlightMessageIDSet](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#highlightMessageIDSet) | 高亮消息的 ID 集合。 |
369
-
370
- **接口函数**
371
-
372
- | **函数列表** | **描述** |
373
- | --- | --- |
374
- | [setEnableReadReceipt](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setEnableReadReceipt) | 设置已读回执。 |
375
- | [setIsDisableScroll](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setIsDisableScroll) | 设置滚动禁用。 |
376
- | [highlightMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#highlightMessage) | 高亮消息。 |
377
-
378
- ## MessageInputState
379
-
380
- 消息输入管理模块
381
- - 核心功能:管理消息输入框的状态和行为,支持文本输入、表情包、@功能、输入状态提示等完整的输入体验。
382
-
383
- - 技术特点:支持富文本编辑、输入状态同步、草稿保存等功能。新增 inputRawValue、isPeerTyping 响应式数据。
384
-
385
- - 业务价值:为用户提供便捷的消息输入体验,提升沟通效率。
386
-
387
- - 应用场景:消息编辑、表情输入、文件发送、语音输入等输入场景。
388
-
389
- **响应式数据**
390
-
391
- | **数据列表** | **描述** |
392
- | --- | --- |
393
- | [inputRawValue](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#inputRawValue) | 输入框的原始文本内容。 |
394
- | [isPeerTyping](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isPeerTyping) | 对方是否正在输入。 |
395
-
396
- **接口函数**
397
-
398
- | **函数列表** | **描述** |
399
- | --- | --- |
400
- | [updateRawValue](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateRawValue) | 更新原始值。 |
401
- | [setEditorInstance](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setEditorInstance) | 设置编辑器实例。 |
402
- | [setContent](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setContent) | 设置内容。 |
403
- | [insertContent](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#insertContent) | 插入内容。 |
404
- | [focusEditor](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#focusEditor) | 聚焦编辑器。 |
405
- | [blurEditor](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#blurEditor) | 失焦编辑器。 |
406
- | [sendMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#sendMessage) | 发送消息。 |
407
-
408
- ## MessageActionState
409
-
410
- 消息操作管理模块
411
- - 核心功能:管理消息的各种操作,包括转发、引用、复制、删除、撤回等完整的消息操作功能。
412
-
413
- - 技术特点:支持批量操作、操作状态管理、权限控制等功能。新增 forwardMessageIDList、isForwardMessageSelectionDone 等响应式数据。
414
-
415
- - 业务价值:为用户提供丰富的消息操作能力,提升使用体验。
416
-
417
- - 应用场景:消息转发、消息引用、消息管理、批量操作等场景。
418
-
419
- **响应式数据**
420
-
421
- | **数据列表** | **描述** |
422
- | --- | --- |
423
- | [forwardMessageIDList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#forwardMessageIDList) | 要转发的消息 ID 列表。 |
424
- | [isForwardMessageSelectionDone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isForwardMessageSelectionDone) | 消息转发选择是否完成。 |
425
- | [forwardConversationIDList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#forwardConversationIDList) | 转发目标会话 ID 列表。 |
426
- | [quotedMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#quotedMessage) | 被引用的消息信息。 |
427
-
428
- **接口函数**
429
-
430
- | **函数列表** | **描述** |
431
- | --- | --- |
432
- | [forwardMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#forwardMessage) | 转发消息。 |
433
- | [setForwardMessageIDList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setForwardMessageIDList) | 设置转发消息列表。 |
434
- | [setIsForwardMessageSelectionDone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setIsForwardMessageSelectionDone) | 设置转发选择完成。 |
435
- | [setForwardConversationIDList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setForwardConversationIDList) | 设置转发会话列表。 |
436
- | [quoteMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#quoteMessage) | 引用消息。 |
437
- | [clearQuotedMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#clearQuotedMessage) | 清除引用消息。 |
438
- | [copyTextMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#copyTextMessage) | 复制文本消息。 |
439
- | [deleteMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#deleteMessage) | 删除消息。 |
440
- | [recallMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#recallMessage) | 撤回消息。 |
441
- | [resetMessageActionState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#resetMessageActionState) | 重置消息操作状态。 |
442
-
443
- ## ConversationListState
444
-
445
- 会话列表管理模块
446
- - 核心功能:管理用户的会话列表,支持会话排序、未读统计、会话操作等完整的会话管理功能。
447
-
448
- - 技术特点:支持实时会话更新、智能排序、网络状态监控等功能。新增 conversationList、activeConversation、totalUnRead、netStatus 响应式数据。
449
-
450
- - 业务价值:为用户提供清晰的会话管理界面,提升沟通效率。
451
-
452
- - 应用场景:会话管理、联系人列表、群组管理、消息中心等场景。
453
-
454
- **响应式数据**
455
-
456
- | **数据列表** | **描述** |
457
- | --- | --- |
458
- | [conversationList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#conversationList) | 会话列表数据。 |
459
- | [activeConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#activeConversation) | 当前活跃的会话。 |
460
- | [totalUnRead](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#totalUnRead) | 未读消息总数。 |
461
- | [netStatus](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#netStatus) | 网络连接状态。 |
462
-
463
- **接口函数**
464
-
465
- | **函数列表** | **描述** |
466
- | --- | --- |
467
- | [markConversationUnread](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#markConversationUnread) | 标记会话未读。 |
468
- | [setActiveConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setActiveConversation) | 设置活跃会话。 |
469
- | [pinConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#pinConversation) | 置顶会话。 |
470
- | [deleteConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#deleteConversation) | 删除会话。 |
471
- | [muteConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#muteConversation) | 静音会话。 |
472
- | [setConversationDraft](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setConversationDraft) | 设置会话草稿。 |
473
- | [createC2CConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#createC2CConversation) | 创建单聊会话。 |
474
- | [createGroupConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#createGroupConversation) | 创建群聊会话。 |
475
-
476
- ## ContactListState
477
-
478
- 联系人管理模块
479
- - 核心功能:管理用户的联系人列表,包括好友管理、群组管理、黑名单管理等完整的联系人功能。
480
-
481
- - 技术特点:支持联系人分组、好友申请处理、群组申请管理等功能。新增 friendList、groupList、blackList 等响应式数据和完整的联系人操作接口。
482
-
483
- - 业务价值:为用户提供完整的社交关系管理能力,构建社交网络。
484
-
485
- - 应用场景:好友管理、群组管理、联系人搜索、社交网络等场景。
486
-
487
- **响应式数据**
488
-
489
- | **数据列表** | **描述** |
490
- | --- | --- |
491
- | [friendList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#friendList) | 好友列表。 |
492
- | [groupList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupList) | 群组列表。 |
493
- | [blackList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#blackList) | 黑名单列表。 |
494
- | [friendApplicationUnreadCount](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#friendApplicationUnreadCount) | 好友申请未读数。 |
495
- | [friendGroupList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#friendGroupList) | 好友分组列表。 |
496
- | [friendApplicationList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#friendApplicationList) | 好友申请列表。 |
497
- | [groupApplicationList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupApplicationList) | 群申请列表。 |
498
-
499
- **接口函数**
500
-
501
- | **函数列表** | **描述** |
502
- | --- | --- |
503
- | [setGroupApplicationList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setGroupApplicationList) | 设置群组申请列表。 |
504
- | [setFriendList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setFriendList) | 设置好友列表。 |
505
- | [setGroupList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setGroupList) | 设置群组列表。 |
506
- | [setBlackList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setBlackList) | 设置黑名单列表。 |
507
- | [setFriendApplicationUnreadCount](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setFriendApplicationUnreadCount) | 设置好友申请未读数。 |
508
- | [setFriendGroupList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setFriendGroupList) | 设置好友分组列表。 |
509
- | [setFriendApplicationList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setFriendApplicationList) | 设置好友申请列表。 |
510
- | [initContactListWatcher](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initContactListWatcher) | 初始化联系人监听器。 |
511
- | [addFriend](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#addFriend) | 添加好友。 |
512
- | [markFriendApplicationAsRead](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#markFriendApplicationAsRead) | 标记好友申请为已读。 |
513
- | [acceptFriendApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptFriendApplication) | 接受好友申请。 |
514
- | [refuseFriendApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#refuseFriendApplication) | 拒绝好友申请。 |
515
- | [addToBlacklist](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#addToBlacklist) | 添加到黑名单。 |
516
- | [removeFromBlacklist](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#removeFromBlacklist) | 从黑名单移除。 |
517
- | [deleteFriend](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#deleteFriend) | 删除好友。 |
518
- | [setFriendRemark](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setFriendRemark) | 设置好友备注。 |
519
- | [createFriendGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#createFriendGroup) | 创建好友分组。 |
520
- | [deleteFriendGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#deleteFriendGroup) | 删除好友分组。 |
521
- | [addToFriendGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#addToFriendGroup) | 添加到好友分组。 |
522
- | [removeFromFriendGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#removeFromFriendGroup) | 从好友分组移除。 |
523
- | [renameFriendGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#renameFriendGroup) | 重命名好友分组。 |
524
- | [joinGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#joinGroup) | 加入群组。 |
525
- | [acceptGroupApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptGroupApplication) | 接受群组申请。 |
526
- | [refuseGroupApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#refuseGroupApplication) | 拒绝群组申请。 |
527
-
528
- ## C2CSettingState
529
-
530
- 单聊设置管理模块
531
- - 核心功能:管理单聊会话的各种设置,包括用户信息、聊天设置、权限控制等功能。
532
-
533
- - 技术特点:支持实时设置同步、权限管理、个性化配置等功能。更新响应式数据为 userID、avatar、signature 等标准化字段。
534
-
535
- - 业务价值:为用户提供个性化的单聊体验,提升沟通质量。
536
-
537
- - 应用场景:单聊设置、用户信息管理、聊天权限控制等场景。
538
-
539
- **响应式数据**
540
-
541
- | **数据列表** | **描述** |
542
- | --- | --- |
543
- | [currentConversationRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentConversationRef) | 当前会话引用。 |
544
- | [userIDRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#userIDRef) | 用户 ID。 |
545
- | [nickRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#nickRef) | 用户昵称。 |
546
- | [avatarRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#avatarRef) | 用户头像。 |
547
- | [signatureRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#signatureRef) | 用户个性签名。 |
548
- | [remarkRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#remarkRef) | 好友备注名。 |
549
- | [isMutedRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isMutedRef) | 会话静音状态。 |
550
- | [isPinnedRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isPinnedRef) | 会话置顶状态。 |
551
- | [isContactRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isContactRef) | 好友关系状态。 |
552
- | [userID](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#userID) | 用户 ID。 |
553
- | [avatar](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#avatar) | 用户头像 URL。 |
554
- | [signature](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#signature) | 用户个性签名。 |
555
- | [remark](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#remark) | 用户备注名。 |
556
- | [isMuted](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isMuted) | 是否已静音。 |
557
- | [isPinned](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isPinned) | 是否已置顶。 |
558
- | [isContact](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isContact) | 是否为联系人。 |
559
-
560
- **接口函数**
561
-
562
- | **函数列表** | **描述** |
563
- | --- | --- |
564
- | [setChatPinned](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setChatPinned) | 设置聊天置顶。 |
565
- | [setChatMuted](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setChatMuted) | 设置聊天免打扰。 |
566
- | [setUserRemark](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setUserRemark) | 设置用户备注。 |
567
-
568
- ## GroupSettingState
569
-
570
- 群聊设置管理模块
571
- - 核心功能:管理群聊的各种设置和操作,包括群信息管理、成员管理、权限控制等完整的群管理功能。
572
-
573
- - 技术特点:支持群权限管理、成员操作、群设置同步等功能。新增 groupID、groupType、groupName 等完整的群信息响应式数据和管理接口。
574
-
575
- - 业务价值:为群主和管理员提供完整的群管理能力,维护群秩序。
576
-
577
- - 应用场景:群管理、成员管理、权限控制、群设置等场景。
578
-
579
- **响应式数据**
580
-
581
- | **数据列表** | **描述** |
582
- | --- | --- |
583
- | [groupID](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupID) | 群组 ID。 |
584
- | [groupType](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupType) | 群组类型。 |
585
- | [groupName](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupName) | 群组名称。 |
586
- | [avatar](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#avatar) | 用户头像 URL。 |
587
- | [introduction](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#introduction) | 群组介绍。 |
588
- | [notification](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#notification) | 群组公告。 |
589
- | [isMuted](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isMuted) | 是否已静音。 |
590
- | [isPinned](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isPinned) | 是否已置顶。 |
591
- | [groupOwner](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupOwner) | 群主信息。 |
592
- | [adminMembers](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#adminMembers) | 管理员列表。 |
593
- | [allMembers](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#allMembers) | 所有成员列表。 |
594
- | [memberCount](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#memberCount) | 成员总数。 |
595
- | [maxMemberCount](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#maxMemberCount) | 最大成员数。 |
596
- | [currentUserID](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentUserID) | 当前用户 ID。 |
597
- | [currentUserRole](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentUserRole) | 当前用户角色。 |
598
- | [nameCard](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#nameCard) | 用户名片。 |
599
- | [isMuteAllMembers](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isMuteAllMembers) | 是否禁言所有成员。 |
600
- | [isInGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isInGroup) | 是否在群组中。 |
601
- | [inviteOption](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#inviteOption) | 邀请选项。 |
602
-
603
- **接口函数**
604
-
605
- | **函数列表** | **描述** |
606
- | --- | --- |
607
- | [getGroupMemberList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getGroupMemberList) | 获取群成员列表。 |
608
- | [updateGroupProfile](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateGroupProfile) | 更新群资料。 |
609
- | [addGroupMember](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#addGroupMember) | 添加群成员。 |
610
- | [deleteGroupMember](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#deleteGroupMember) | 删除群成员。 |
611
- | [changeGroupOwner](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#changeGroupOwner) | 转让群主。 |
612
- | [setGroupMemberRole](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setGroupMemberRole) | 设置群成员角色。 |
613
- | [setGroupMemberNameCard](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setGroupMemberNameCard) | 设置群成员名片。 |
614
- | [setChatPinned](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setChatPinned) | 设置聊天置顶。 |
615
- | [setChatMuted](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setChatMuted) | 设置聊天免打扰。 |
616
- | [setGroupMemberMuteTime](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setGroupMemberMuteTime) | 设置群成员禁言。 |
617
- | [setMuteAllMember](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setMuteAllMember) | 设置全员禁言。 |
618
- | [dismissGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#dismissGroup) | 解散群组。 |
619
- | [quitGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#quitGroup) | 退出群组。 |
620
- | [hasPermission](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#hasPermission) | 检查权限。 |
621
- | [canOperateOnMember](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#canOperateOnMember) | 检查成员操作权限。 |
622
- | [getAvailablePermissions](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getAvailablePermissions) | 获取可用权限。 |
623
- | [initWatcher](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initWatcher) | 初始化监听器。 |
624
-
625
- ## VideoMixerState
626
-
627
- 视频混流管理模块
628
- - 核心功能:管理视频混流功能,支持多路视频合成、布局管理、媒体源控制等高级视频处理功能。
629
-
630
- - 技术特点:支持实时视频混流、动态布局调整、媒体源管理等功能。新增 isVideoMixerEnabled、mediaSourceList、activeMediaSource 响应式数据和完整的混流控制接口。
631
-
632
- - 业务价值:为直播平台提供专业的视频制作能力,提升直播质量。
633
-
634
- - 应用场景:多人直播、画中画、视频合成、专业制作等场景。
635
-
636
- **响应式数据**
637
-
638
- | **数据列表** | **描述** |
639
- | --- | --- |
640
- | [publishVideoQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#publishVideoQuality) | 根据分辨率获取尺寸。 |
641
- | [isVideoMixerEnabled](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isVideoMixerEnabled) | 视频混流是否启用。 |
642
- | [mediaSourceList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#mediaSourceList) | 媒体源列表。 |
643
- | [activeMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#activeMediaSource) | 当前活跃的媒体源。 |
644
-
645
- **接口函数**
646
-
647
- | **函数列表** | **描述** |
648
- | --- | --- |
649
- | [getVideoDataByQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getVideoDataByQuality) | 根据质量获取视频数据。 |
650
- | [getSizeByQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getSizeByQuality) | 根据质量获取尺寸。 |
651
- | [getSizeByResolution](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getSizeByResolution) | 根据分辨率获取尺寸。 |
652
- | [transformTUIVideoQualityToTRTCVideoResolution](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#transformTUIVideoQualityToTRTCVideoResolution) | 转换视频质量到 TRTC 分辨率。 |
653
- | [transformTRTCVideoResolutionToTUIVideoQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#transformTRTCVideoResolutionToTUIVideoQuality) | 转换 TRTC 分辨率到视频质量。 |
654
- | [transformTRTCVideoResModeToTUIVideoResMode](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#transformTRTCVideoResModeToTUIVideoResMode) | 转换 TRTC 分辨率模式。 |
655
- | [changeActiveMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#changeActiveMediaSource) | 切换活跃媒体源。 |
656
- | [updateVideoQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateVideoQuality) | 更新视频质量。 |
657
- | [getDefaultLayoutByMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getDefaultLayoutByMediaSource) | 根据媒体源获取默认布局。 |
658
- | [addMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#addMediaSource) | 添加媒体源。 |
659
- | [updateMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateMediaSource) | 更新媒体源。 |
660
- | [removeMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#removeMediaSource) | 移除媒体源。 |
661
- | [enableLocalVideoMixer](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#enableLocalVideoMixer) | 启用本地视频混流。 |
662
- | [clearMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#clearMediaSource) | 清空所有媒体源。 |
663
- | [initMediaSourceManager](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initMediaSourceManager) | 初始化媒体源管理器。 |
664
- | [initVideoMixerState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initVideoMixerState) | 初始化视频混流状态。 |
665
-
666
- ## VirtualBackgroundState
667
-
668
- 虚拟背景管理模块
669
- - 核心功能:管理虚拟背景功能,支持背景替换、背景模糊、自定义背景等视频美化功能。
670
-
671
- - 技术特点:基于 AI 技术实现实时背景分割和替换。新增 virtualBackgroundConfig 响应式数据和 isSupported、setVirtualBackground 接口函数。
672
-
673
- - 业务价值:为用户提供隐私保护和视频美化功能,提升视频通话体验。
674
-
675
- - 应用场景:视频通话、在线会议、直播美化、隐私保护等场景。
676
-
677
- **响应式数据**
678
-
679
- | **数据列表** | **描述** |
680
- | --- | --- |
681
- | [virtualBackgroundConfig](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#virtualBackgroundConfig) | 虚拟背景配置。 |
682
-
683
- **接口函数**
684
-
685
- | **函数列表** | **描述** |
686
- | --- | --- |
687
- | [initVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initVirtualBackground) | 初始化虚拟背景。 |
688
- | [saveVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#saveVirtualBackground) | 保存虚拟背景。 |
689
- | [isSupported](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isSupported) | 检查是否支持。 |
690
- | [setVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setVirtualBackground) | 设置虚拟背景。 |
691
-
692
- ## ASRState
693
-
694
- 语音识别管理模块
695
- - 核心功能:管理语音识别功能,支持实时语音转文字、转录历史管理、转录导出等功能。
696
-
697
- - 技术特点:基于先进的 ASR 技术,支持多语言识别、实时转录、历史记录等功能。新增 recentTranscripts、transcriptHistory 响应式数据和 exportTranscripts 接口。
698
-
699
- - 业务价值:为用户提供语音转文字服务,提升沟通效率和可访问性。
700
-
701
- - 应用场景:会议记录、语音转录、无障碍通信、内容记录等场景。
702
-
703
- **响应式数据**
704
-
705
- | **数据列表** | **描述** |
706
- | --- | --- |
707
- | [recentTranscripts](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#recentTranscripts) | 最近的语音转录记录。 |
708
- | [transcriptHistory](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#transcriptHistory) | 语音转录历史记录。 |
709
-
710
- **接口函数**
711
-
712
- | **函数列表** | **描述** |
713
- | --- | --- |
714
- | [setRecentTranscriptsDuration](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setRecentTranscriptsDuration) | 设置最近转录时长。 |
715
- | [clearHistory](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#clearHistory) | 清空转录历史记录。 |
716
- | [exportTranscripts](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#exportTranscripts) | 导出转录内容。 |
717
-
718
- ## SearchState
719
-
720
- 搜索功能管理模块
721
- - 核心功能:管理全局搜索功能,支持消息搜索、用户搜索、群组搜索等多维度搜索能力。
722
-
723
- - 技术特点:支持高级搜索、搜索历史、搜索建议等功能。重构响应式数据为 keyword、results、isLoading 等标准化字段,提供完整的搜索接口。
724
-
725
- - 业务价值:为用户提供快速查找信息的能力,提升使用效率。
726
-
727
- - 应用场景:消息搜索、联系人搜索、内容查找、历史记录等场景。
728
-
729
- **响应式数据**
730
-
731
- | **数据列表** | **描述** |
732
- | --- | --- |
733
- | [keyword](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#keyword) | 搜索关键词。 |
734
- | [results](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#results) | 搜索结果。 |
735
- | [isLoading](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isLoading) | 是否正在加载。 |
736
- | [error](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#error) | 错误信息。 |
737
- | [searchAdvancedParams](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#searchAdvancedParams) | 高级搜索参数。 |
738
- | [selectedSearchType](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#selectedSearchType) | 选中的搜索类型。 |
739
-
740
- **接口函数**
741
-
742
- | **函数列表** | **描述** |
743
- | --- | --- |
744
- | [search](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#search) | 搜索。 |
745
- | [setKeyword](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setKeyword) | 设置关键词。 |
746
- | [setSelectedType](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setSelectedType) | 设置选中类型。 |
747
- | [setSearchMessageAdvancedParams](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setSearchMessageAdvancedParams) | 设置消息搜索高级参数。 |
748
- | [setSearchUserAdvancedParams](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setSearchUserAdvancedParams) | 设置用户搜索高级参数。 |
749
- | [setSearchGroupAdvancedParams](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setSearchGroupAdvancedParams) | 设置群组搜索高级参数。 |
750
- | [loadMore](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#loadMore) | 加载更多。 |
751
-
752
- ## SeatStore
753
-
754
- 座位存储管理模块
755
- - 核心功能:提供座位状态的底层存储和管理,支持座位信息缓存、用户信息映射、设备请求处理等核心功能。
756
-
757
- - 技术特点:采用响应式存储设计,支持实时状态同步、事件驱动更新等功能。新增 liveOwnerUserId、localUserId、seatList 等响应式数据和 getUserInfo、convertUserInfoToAudienceInfo 接口。
758
-
759
- - 业务价值:为座位管理提供可靠的数据基础,确保座位状态的一致性。
760
-
761
- - 应用场景:座位状态管理、用户信息存储、设备状态跟踪等底层场景。
762
-
763
- **响应式数据**
764
-
765
- | **数据列表** | **描述** |
766
- | --- | --- |
767
- | [liveOwnerUserId](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#liveOwnerUserId) | 直播间主播用户 ID。 |
768
- | [localUserId](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#localUserId) | 本地用户 ID。 |
769
- | [seatList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#seatList) | 麦位列表,包含所有麦位的状态和用户信息。 |
770
- | [coHostUserList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#coHostUserList) | 连麦主播列表。 |
771
- | [sentDeviceRequestMap](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#sentDeviceRequestMap) | 已发送的设备请求映射。 |
772
- | [receivedDeviceRequestMap](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#receivedDeviceRequestMap) | 已接收的设备请求映射。 |
773
- | [userInfoMap](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#userInfoMap) | 用户信息映射表。 |
774
-
775
- **接口函数**
776
-
777
- | 函数列表 | 描述 |
778
- | --- | --- |
779
- | [getUserInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getUserInfo) | 获取用户信息。 |
780
- | [convertUserInfoToAudienceInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#convertUserInfoToAudienceInfo) | 转换用户信息为观众信息。 |