@tencent-rtc/mcp 1.3.9 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (431) hide show
  1. package/package.json +2 -2
  2. package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/android-faq.md} +10 -22
  3. package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/flutter-faq.md} +10 -22
  4. package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/ios-faq.md} +10 -22
  5. package/resource/doc/callkit/preset/android/api.md +296 -0
  6. package/resource/doc/{tuicallkit → callkit/preset}/android/integration.md +53 -365
  7. package/resource/doc/callkit/preset/flutter/api.md +410 -0
  8. package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +35 -97
  9. package/resource/doc/callkit/preset/ios/api.md +80 -0
  10. package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +37 -118
  11. package/resource/doc/callkit/preset/react/api.md +501 -0
  12. package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +5 -20
  13. package/resource/doc/callkit/preset/vue/api.md +501 -0
  14. package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +4 -19
  15. package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -38
  16. package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
  17. package/resource/doc/{chatuikit → chatkit}/android/integration.md +28 -121
  18. package/resource/doc/chatkit/faq/android_sdk/client-api.md +281 -0
  19. package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +0 -1
  20. package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -1
  21. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +199 -0
  22. package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
  23. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +235 -0
  24. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +3 -3
  25. package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
  26. package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +18 -87
  27. package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -38
  28. package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
  29. package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +47 -165
  30. package/resource/doc/{chatuikit → chatkit}/react/components/avatar.md +0 -33
  31. package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +8 -49
  32. package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +6 -35
  33. package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +0 -6
  34. package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -11
  35. package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +96 -502
  36. package/resource/doc/chatkit/react/components/conversation-actions.md +174 -0
  37. package/resource/doc/chatkit/react/components/conversation-list.md +333 -0
  38. package/resource/doc/chatkit/react/components/conversation-preview.md +118 -0
  39. package/resource/doc/chatkit/react/components/conversation-search.md +60 -0
  40. package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -337
  41. package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +20 -212
  42. package/resource/doc/chatkit/react/components/search.md +243 -0
  43. package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +1 -47
  44. package/resource/doc/{chatuikit → chatkit}/react/integration.md +21 -81
  45. package/resource/doc/{chatuikit → chatkit}/vue/components/avatar.md +0 -33
  46. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -48
  47. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +3 -5
  48. package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +0 -5
  49. package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -15
  50. package/resource/doc/chatkit/vue/components/contact-list.md +271 -0
  51. package/resource/doc/chatkit/vue/components/conversation-actions.md +228 -0
  52. package/resource/doc/{chatuikit → chatkit}/vue/components/conversation-list.md +42 -492
  53. package/resource/doc/chatkit/vue/components/conversation-preview.md +213 -0
  54. package/resource/doc/chatkit/vue/components/conversation-search.md +50 -0
  55. package/resource/doc/{chatuikit → chatkit}/vue/components/message-input.md +2 -223
  56. package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -252
  57. package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
  58. package/resource/doc/{chatuikit → chatkit}/vue/components/tuikit.md +7 -21
  59. package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +3 -62
  60. package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
  61. package/resource/doc/{chatuikit → chatkit}/vue/integration.md +22 -23
  62. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +18 -89
  63. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audio-effect.md +34 -192
  64. package/resource/doc/livekit/{live → core-sdk/live}/android/live-barrage.md +28 -141
  65. package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +20 -112
  66. package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +59 -193
  67. package/resource/doc/livekit/{live → core-sdk/live}/android/live-gift.md +75 -455
  68. package/resource/doc/livekit/{live → core-sdk/live}/android/live-host-interaction.md +94 -344
  69. package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +107 -515
  70. package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +33 -173
  71. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +14 -93
  72. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -179
  73. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +19 -107
  74. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -166
  75. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -163
  76. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +69 -443
  77. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
  78. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-integration.md +107 -492
  79. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +23 -165
  80. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +35 -111
  81. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +35 -193
  82. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +31 -144
  83. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +24 -116
  84. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +37 -171
  85. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +79 -459
  86. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +69 -320
  87. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +85 -502
  88. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +32 -169
  89. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audience-list.md +18 -89
  90. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audio-effect.md +34 -192
  91. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-barrage.md +28 -141
  92. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-co-guest-interaction.md +50 -259
  93. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-gift.md +75 -455
  94. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-host-interaction.md +51 -265
  95. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-integration.md +61 -427
  96. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-room-list.md +33 -173
  97. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-co-guest-interaction.md +44 -203
  98. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-integration.md +56 -416
  99. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audience-list.md +35 -111
  100. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audio-effect.md +35 -193
  101. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-barrage.md +31 -144
  102. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-co-guest-interaction.md +43 -252
  103. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-gift.md +79 -459
  104. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-host-interaction.md +46 -264
  105. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-integration.md +61 -445
  106. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-room-list.md +32 -169
  107. package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -2
  108. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +780 -0
  109. package/resource/doc/livekit/preset/live/vue/components/barrage.md +291 -0
  110. package/resource/doc/livekit/{live → preset/live}/vue/components/co-guest-panel.md +10 -49
  111. package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +26 -144
  112. package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +12 -75
  113. package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +36 -227
  114. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +215 -0
  115. package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
  116. package/resource/doc/livekit/preset/live/vue/live-list-integration.md +241 -0
  117. package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +299 -0
  118. package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +300 -0
  119. package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +743 -0
  120. package/resource/doc/roomkit/vue/faq.md +1 -0
  121. package/resource/doc/roomkit/vue/features/call-user-to-room.md +17 -53
  122. package/resource/doc/roomkit/vue/features/device-detection.md +30 -48
  123. package/resource/doc/roomkit/vue/features/device-state.md +24 -44
  124. package/resource/doc/roomkit/vue/features/free-beauty-panel.md +13 -36
  125. package/resource/doc/roomkit/vue/features/room-chat.md +31 -89
  126. package/resource/doc/roomkit/vue/features/room-participant-state.md +28 -50
  127. package/resource/doc/roomkit/vue/features/room-state.md +25 -34
  128. package/resource/doc/roomkit/vue/features/room-view.md +30 -125
  129. package/resource/doc/roomkit/vue/features/schedule-room.md +9 -40
  130. package/resource/doc/roomkit/vue/features/screen-share.md +22 -90
  131. package/resource/doc/roomkit/vue/features/virtual-background.md +13 -29
  132. package/resource/doc/roomkit/vue/integration.md +21 -76
  133. package/resource/doc/rtcengine/faq/common/error_code.md +1 -0
  134. package/resource/doc/rtcengine/faq/web/web.md +14 -24
  135. package/resource/doc/rtcengine/web/api.md +1 -3
  136. package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +3 -10
  137. package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +1 -5
  138. package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +1 -2
  139. package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -4
  140. package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +3 -5
  141. package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +1 -7
  142. package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +0 -2
  143. package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -8
  144. package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +11 -11
  145. package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +12 -88
  146. package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -5
  147. package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +30 -37
  148. package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +13 -90
  149. package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -2
  150. package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +1 -2
  151. package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +19 -19
  152. package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +1 -1
  153. package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +4 -5
  154. package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
  155. package/resource/doc/trtc/C++/ITRTCCloud.md +686 -2835
  156. package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
  157. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +202 -1022
  158. package/resource/doc/trtc/C++/ITXDeviceManager.md +126 -767
  159. package/resource/doc/trtc/C++/TRTCCloudCallback.md +579 -2147
  160. package/resource/doc/trtc/C++/TRTCTypeDef.md +703 -3378
  161. package/resource/doc/trtc/C++/TXLiteAVCode.md +116 -908
  162. package/resource/doc/trtc/android/TRTCCloud.md +606 -2573
  163. package/resource/doc/trtc/android/TRTCCloudDef.md +752 -3640
  164. package/resource/doc/trtc/android/TRTCCloudListener.md +581 -2008
  165. package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
  166. package/resource/doc/trtc/android/TXAudioEffectManager.md +202 -1022
  167. package/resource/doc/trtc/android/TXBeautyManager.md +127 -704
  168. package/resource/doc/trtc/android/TXDeviceManager.md +51 -318
  169. package/resource/doc/trtc/android/TXLiteAVCode.md +114 -892
  170. package/resource/doc/trtc/iOS/TRTCCloud.md +694 -2904
  171. package/resource/doc/trtc/iOS/TRTCCloudDef.md +726 -3498
  172. package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +543 -2028
  173. package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
  174. package/resource/doc/trtc/iOS/TXAudioEffectManager.md +174 -877
  175. package/resource/doc/trtc/iOS/TXBeautyManager.md +128 -710
  176. package/resource/doc/trtc/iOS/TXDeviceManager.md +129 -772
  177. package/resource/doc/trtc/iOS/TXLiteAVCode.md +117 -915
  178. package/server.js +1 -5
  179. package/server.js.map +1 -1
  180. package/tools/call/get_callkit_api.js +32 -0
  181. package/tools/call/get_callkit_api.js.map +1 -0
  182. package/tools/call/get_native_call_uikit_integration.js +34 -0
  183. package/tools/call/get_native_call_uikit_integration.js.map +1 -0
  184. package/tools/call/{get-web-call-integration.js → get_web_call_uikit_integration.js} +13 -8
  185. package/tools/call/get_web_call_uikit_integration.js.map +1 -0
  186. package/tools/chat/get_native_chat_uikit_feature_detail.js +34 -0
  187. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +1 -0
  188. package/tools/chat/get_native_chat_uikit_integration.js +45 -0
  189. package/tools/chat/get_native_chat_uikit_integration.js.map +1 -0
  190. package/tools/chat/get_web_chat_uikit_component_detail.js +34 -0
  191. package/tools/chat/get_web_chat_uikit_component_detail.js.map +1 -0
  192. package/tools/chat/get_web_chat_uikit_integration.js +45 -0
  193. package/tools/chat/get_web_chat_uikit_integration.js.map +1 -0
  194. package/tools/common/get_faq.js +265 -0
  195. package/tools/common/get_faq.js.map +1 -0
  196. package/tools/common/{get-usersig.js → get_usersig.js} +6 -3
  197. package/tools/common/get_usersig.js.map +1 -0
  198. package/tools/common/present_framework_choice.js +63 -0
  199. package/tools/common/present_framework_choice.js.map +1 -0
  200. package/tools/definitions/get_callkit_api_def.js +29 -0
  201. package/tools/definitions/get_callkit_api_def.js.map +1 -0
  202. package/tools/definitions/get_faq_def.js +17 -18
  203. package/tools/definitions/get_faq_def.js.map +1 -1
  204. package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
  205. package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
  206. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
  207. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
  208. package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -41
  209. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
  210. package/tools/definitions/get_native_livekit_core_features_def.js +34 -0
  211. package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
  212. package/tools/definitions/get_native_livekit_core_integration_def.js +34 -0
  213. package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
  214. package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
  215. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
  216. package/tools/definitions/get_usersig_def.js +17 -22
  217. package/tools/definitions/get_usersig_def.js.map +1 -1
  218. package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
  219. package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
  220. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
  221. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
  222. package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
  223. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
  224. package/tools/definitions/get_web_live_uikit_integration_def.js +15 -18
  225. package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
  226. package/tools/definitions/get_web_livekit_api_def.js +30 -0
  227. package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
  228. package/tools/definitions/get_web_livekit_component_detail_def.js +32 -0
  229. package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
  230. package/tools/definitions/get_web_room_uikit_integration_def.js +15 -46
  231. package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
  232. package/tools/definitions/get_web_roomkit_feature_detail_def.js +31 -0
  233. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
  234. package/tools/definitions/get_web_trtc_sdk_api_def.js +27 -0
  235. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
  236. package/tools/definitions/get_web_trtc_sdk_integration_def.js +27 -0
  237. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
  238. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +27 -0
  239. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
  240. package/tools/definitions/present_framework_choice_def.js +24 -12
  241. package/tools/definitions/present_framework_choice_def.js.map +1 -1
  242. package/tools/index.js +47 -61
  243. package/tools/index.js.map +1 -1
  244. package/tools/live/get_native_livekit_core_features.js +65 -0
  245. package/tools/live/get_native_livekit_core_features.js.map +1 -0
  246. package/tools/live/get_native_livekit_core_integration.js +59 -0
  247. package/tools/live/get_native_livekit_core_integration.js.map +1 -0
  248. package/tools/live/get_web_live_uikit_integration.js +48 -0
  249. package/tools/live/get_web_live_uikit_integration.js.map +1 -0
  250. package/tools/live/get_web_livekit_api.js +32 -0
  251. package/tools/live/get_web_livekit_api.js.map +1 -0
  252. package/tools/live/get_web_livekit_component_detail.js +34 -0
  253. package/tools/live/get_web_livekit_component_detail.js.map +1 -0
  254. package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
  255. package/tools/room/get_web_room_uikit_integration.js.map +1 -0
  256. package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
  257. package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
  258. package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
  259. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
  260. package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
  261. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
  262. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
  263. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
  264. package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
  265. package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
  266. package/utils/generate-structured-result.js +61 -17
  267. package/utils/generate-structured-result.js.map +1 -1
  268. package/utils/report-cls-client.js +12 -1
  269. package/utils/report-cls-client.js.map +1 -1
  270. package/utils/report-es-client.js +2 -2
  271. package/resource/doc/chatuikit/android/workflow.md +0 -713
  272. package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1371
  273. package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -932
  274. package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1119
  275. package/resource/doc/chatuikit/flutter/workflow.md +0 -941
  276. package/resource/doc/chatuikit/react/components/conversation-list.md +0 -1017
  277. package/resource/doc/chatuikit/react/components/search.md +0 -745
  278. package/resource/doc/chatuikit/react/create-group.md +0 -23
  279. package/resource/doc/chatuikit/react/init.md +0 -26
  280. package/resource/doc/chatuikit/react/workflow.md +0 -258
  281. package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
  282. package/resource/doc/chatuikit/vue/create-group.md +0 -25
  283. package/resource/doc/chatuikit/vue/init.md +0 -40
  284. package/resource/doc/chatuikit/vue/workflow.md +0 -395
  285. package/resource/doc/livekit/live/android/workflow.md +0 -320
  286. package/resource/doc/livekit/live/flutter/workflow.md +0 -353
  287. package/resource/doc/livekit/live/ios/workflow.md +0 -454
  288. package/resource/doc/livekit/live/vue/components/barrage.md +0 -616
  289. package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -446
  290. package/resource/doc/livekit/live/vue/faq.md +0 -0
  291. package/resource/doc/livekit/live/vue/live-list-integration.md +0 -200
  292. package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -269
  293. package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -269
  294. package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -595
  295. package/resource/doc/livekit/live/vue/states/live-state.md +0 -3591
  296. package/resource/doc/livekit/live/vue/workflow.md +0 -218
  297. package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -312
  298. package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -430
  299. package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -679
  300. package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -671
  301. package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -271
  302. package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
  303. package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
  304. package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
  305. package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
  306. package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -865
  307. package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -657
  308. package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -437
  309. package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -335
  310. package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
  311. package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -327
  312. package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -507
  313. package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
  314. package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -659
  315. package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
  316. package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -814
  317. package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1000
  318. package/resource/doc/roomkit/vue/features/workflow.md +0 -553
  319. package/resource/doc/roomkit/vue/workflow.md +0 -733
  320. package/resource/doc/tuicallkit/android/workflow.md +0 -441
  321. package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -784
  322. package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -610
  323. package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -938
  324. package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -897
  325. package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -469
  326. package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -781
  327. package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -398
  328. package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
  329. package/resource/doc/tuicallkit/react/api.md +0 -1404
  330. package/resource/doc/tuicallkit/vue/api.md +0 -1406
  331. package/resource/doc/tuicallkit/vue/faq.md +0 -36
  332. package/tools/call/get-native-call-integration.js +0 -43
  333. package/tools/call/get-native-call-integration.js.map +0 -1
  334. package/tools/call/get-web-call-api.js +0 -27
  335. package/tools/call/get-web-call-api.js.map +0 -1
  336. package/tools/call/get-web-call-integration.js.map +0 -1
  337. package/tools/chat/get-native-chat-feature-detail.js +0 -30
  338. package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
  339. package/tools/chat/get-native-chat-integration.js +0 -45
  340. package/tools/chat/get-native-chat-integration.js.map +0 -1
  341. package/tools/chat/get-web-chat-component-detail.js +0 -31
  342. package/tools/chat/get-web-chat-component-detail.js.map +0 -1
  343. package/tools/chat/get-web-chat-integration.js +0 -45
  344. package/tools/chat/get-web-chat-integration.js.map +0 -1
  345. package/tools/chat/get-web-chat-uikit-init.js +0 -28
  346. package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
  347. package/tools/chat/get-web-create-group-doc.js +0 -28
  348. package/tools/chat/get-web-create-group-doc.js.map +0 -1
  349. package/tools/common/get-faq.js +0 -91
  350. package/tools/common/get-faq.js.map +0 -1
  351. package/tools/common/get-usersig.js.map +0 -1
  352. package/tools/common/present-framework-choice.js +0 -16
  353. package/tools/common/present-framework-choice.js.map +0 -1
  354. package/tools/common/present-scenario-choice.js +0 -16
  355. package/tools/common/present-scenario-choice.js.map +0 -1
  356. package/tools/common/record-prompt.js +0 -55
  357. package/tools/common/record-prompt.js.map +0 -1
  358. package/tools/common/record-result.js +0 -60
  359. package/tools/common/record-result.js.map +0 -1
  360. package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
  361. package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
  362. package/tools/definitions/get_native_live_api_def.js +0 -23
  363. package/tools/definitions/get_native_live_api_def.js.map +0 -1
  364. package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -87
  365. package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
  366. package/tools/definitions/get_native_live_uikit_integration_def.js +0 -75
  367. package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
  368. package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
  369. package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
  370. package/tools/definitions/get_trtc_native_api_def.js +0 -16
  371. package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
  372. package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
  373. package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
  374. package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
  375. package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
  376. package/tools/definitions/get_web_create_group_doc_def.js +0 -18
  377. package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
  378. package/tools/definitions/get_web_live_state_detail_def.js +0 -19
  379. package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
  380. package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
  381. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
  382. package/tools/definitions/get_web_room_feature_detail_def.js +0 -92
  383. package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
  384. package/tools/definitions/get_web_room_state_detail_def.js +0 -19
  385. package/tools/definitions/get_web_room_state_detail_def.js.map +0 -1
  386. package/tools/definitions/present_scenario_choice_def.js +0 -53
  387. package/tools/definitions/present_scenario_choice_def.js.map +0 -1
  388. package/tools/definitions/record_prompt_def.js +0 -58
  389. package/tools/definitions/record_prompt_def.js.map +0 -1
  390. package/tools/definitions/record_result_def.js +0 -46
  391. package/tools/definitions/record_result_def.js.map +0 -1
  392. package/tools/live/get-native-live-uikit-integration.js +0 -177
  393. package/tools/live/get-native-live-uikit-integration.js.map +0 -1
  394. package/tools/live/get-web-live-component-detail.js +0 -31
  395. package/tools/live/get-web-live-component-detail.js.map +0 -1
  396. package/tools/live/get-web-live-state-detail.js +0 -31
  397. package/tools/live/get-web-live-state-detail.js.map +0 -1
  398. package/tools/live/get-web-live-uikit-integration.js +0 -52
  399. package/tools/live/get-web-live-uikit-integration.js.map +0 -1
  400. package/tools/live/get_native_live_uikit_extra_features.js +0 -105
  401. package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
  402. package/tools/live/get_native_live_uikit_interaction.js +0 -194
  403. package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
  404. package/tools/native_live/get-native-live-api.js +0 -31
  405. package/tools/native_live/get-native-live-api.js.map +0 -1
  406. package/tools/room/get-web-room-feature-detail.js.map +0 -1
  407. package/tools/room/get-web-room-integration.js.map +0 -1
  408. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
  409. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
  410. package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
  411. package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
  412. package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
  413. package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
  414. package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
  415. package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
  416. package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
  417. package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
  418. package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
  419. package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
  420. package/tools/trtc/get-trtc-native-api.js +0 -31
  421. package/tools/trtc/get-trtc-native-api.js.map +0 -1
  422. package/utils/handle-component-name.js +0 -33
  423. package/utils/handle-component-name.js.map +0 -1
  424. /package/resource/doc/{chatuikit/iOS/workflow.md → callkit/core-sdk/.gitkeep} +0 -0
  425. /package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +0 -0
  426. /package/resource/doc/{tuicallkit/react/faq.md → callkit/faq/web-faq.md} +0 -0
  427. /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
  428. /package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +0 -0
  429. /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
  430. /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
  431. /package/resource/doc/roomkit/faq/common/{error_code.md → error-code.md} +0 -0
package/resource/doc/livekit/live/vue/states/live-state.md DELETED
@@ -1,3591 +0,0 @@
1
- The atomicx-core SDK is a brand-new first-generation responsive API launched by Tencent Cloud for Chat, Audio/Video Calls, live streaming, voice chat room and other scenarios. You can quickly build your own UI page based on this set of APIs. It supports room management, screen sharing, member management, microphone position control, basic beauty filter and other rich features. Based on the TRTC SDK, it can provide ultra-low latency and high-quality audio/video experience. This page contains ALL API interfaces of the atomicx-core SDK, displayed by feature module.
2
-
3
-
4
- ## LoginState
5
-
6
-
7
- User Identity Authentication and Logon Management Module
8
- -Core features: Provide basic identity authentication including user login, logout, and personal information management, forming the user identity basis of the entire system.
9
-
10
-
11
- - Technical features: Support various log-in methods, user information cache, login status persistence and other features to underwrite user identity security and reliability.
12
-
13
-
14
- - Business value: Provides unified user identity authentication service for all business modules, forming the foundation of system security and user experience assurance.
15
-
16
-
17
- - Application scenarios: Core identity authentication scenarios such as user login, identity verification, personal information management, and permission control.
18
-
19
-
20
-
21
-
22
- responsive data
23
-
24
-
25
- <table>
26
- <tr>
27
- <td rowspan="1" colSpan="1" >**Data List**</td>
28
-
29
-
30
- <td rowspan="1" colSpan="1" >**Description**</td>
31
- </tr>
32
-
33
-
34
- <tr>
35
- <td rowspan="1" colSpan="1" >[loginUserInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#loginUserInfo)</td>
36
-
37
-
38
- <td rowspan="1" colSpan="1" >Current login user information.</td>
39
- </tr>
40
- </table>
41
-
42
-
43
-
44
-
45
- API Function
46
-
47
-
48
- <table>
49
- <tr>
50
- <td rowspan="1" colSpan="1" >**Function list**</td>
51
-
52
-
53
- <td rowspan="1" colSpan="1" >**Description**</td>
54
- </tr>
55
-
56
-
57
- <tr>
58
- <td rowspan="1" colSpan="1" >[login](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#login)</td>
59
-
60
-
61
- <td rowspan="1" colSpan="1" >User login.</td>
62
- </tr>
63
-
64
-
65
- <tr>
66
- <td rowspan="1" colSpan="1" >[setSelfInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setSelfInfo)</td>
67
-
68
-
69
- <td rowspan="1" colSpan="1" >Set user personal information.</td>
70
- </tr>
71
-
72
-
73
- <tr>
74
- <td rowspan="1" colSpan="1" >[logout](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#logout)</td>
75
-
76
-
77
- <td rowspan="1" colSpan="1" >User logout function.</td>
78
- </tr>
79
- </table>
80
-
81
-
82
-
83
-
84
- ## DeviceState
85
-
86
-
87
- Device Status Management Module
88
- -Core feature: Manage control of cameras, microphones and other audio/video devices, providing device status monitoring, permission check and other basic equipment services.
89
-
90
-
91
- - Technical feature: Supports advanced functions such as multi-device management, real-time status monitoring, dynamic permission check, and automatic failure recovery.
92
-
93
-
94
- - Business value: Provide stability to the live streaming system, underwriting the reliability of audio and video capture and user experience.
95
-
96
-
97
- - Use cases: Basic technical scenarios such as device management, permission control, audio and video capture, and fault handling.
98
-
99
-
100
-
101
-
102
- responsive data
103
-
104
-
105
- <table>
106
- <tr>
107
- <td rowspan="1" colSpan="1" >**Data List**</td>
108
-
109
-
110
- <td rowspan="1" colSpan="1" >**Description**</td>
111
- </tr>
112
-
113
-
114
- <tr>
115
- <td rowspan="1" colSpan="1" >[microphoneStatus](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#microphoneStatus)</td>
116
-
117
-
118
- <td rowspan="1" colSpan="1" >Microphone Status.</td>
119
- </tr>
120
-
121
-
122
- <tr>
123
- <td rowspan="1" colSpan="1" >[microphoneList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#microphoneList)</td>
124
-
125
-
126
- <td rowspan="1" colSpan="1" >Microphone Device List.</td>
127
- </tr>
128
-
129
-
130
- <tr>
131
- <td rowspan="1" colSpan="1" >[currentMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentMicrophone)</td>
132
-
133
-
134
- <td rowspan="1" colSpan="1" >Selected microphone device.</td>
135
- </tr>
136
-
137
-
138
- <tr>
139
- <td rowspan="1" colSpan="1" >[microphoneLastError](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#microphoneLastError)</td>
140
-
141
-
142
- <td rowspan="1" colSpan="1" >Last microphone error information.</td>
143
- </tr>
144
-
145
-
146
- <tr>
147
- <td rowspan="1" colSpan="1" >[captureVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#captureVolume)</td>
148
-
149
-
150
- <td rowspan="1" colSpan="1" >Mic capture volume.</td>
151
- </tr>
152
-
153
-
154
- <tr>
155
- <td rowspan="1" colSpan="1" >[currentMicVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentMicVolume)</td>
156
-
157
-
158
- <td rowspan="1" colSpan="1" >Current microphone volume.</td>
159
- </tr>
160
-
161
-
162
- <tr>
163
- <td rowspan="1" colSpan="1" >[isMicrophoneTesting](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isMicrophoneTesting)</td>
164
-
165
-
166
- <td rowspan="1" colSpan="1" >Mic testing status.</td>
167
- </tr>
168
-
169
-
170
- <tr>
171
- <td rowspan="1" colSpan="1" >[testingMicVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#testingMicVolume)</td>
172
-
173
-
174
- <td rowspan="1" colSpan="1" >Microphone volume during testing.</td>
175
- </tr>
176
-
177
-
178
- <tr>
179
- <td rowspan="1" colSpan="1" >[cameraStatus](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cameraStatus)</td>
180
-
181
-
182
- <td rowspan="1" colSpan="1" >Camera status.</td>
183
- </tr>
184
-
185
-
186
- <tr>
187
- <td rowspan="1" colSpan="1" >[cameraList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cameraList)</td>
188
-
189
-
190
- <td rowspan="1" colSpan="1" >Camera list.</td>
191
- </tr>
192
-
193
-
194
- <tr>
195
- <td rowspan="1" colSpan="1" >[currentCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentCamera)</td>
196
-
197
-
198
- <td rowspan="1" colSpan="1" >Selected camera.</td>
199
- </tr>
200
-
201
-
202
- <tr>
203
- <td rowspan="1" colSpan="1" >[cameraLastError](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cameraLastError)</td>
204
-
205
-
206
- <td rowspan="1" colSpan="1" >Last camera error information.</td>
207
- </tr>
208
-
209
-
210
- <tr>
211
- <td rowspan="1" colSpan="1" >[isCameraTesting](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isCameraTesting)</td>
212
-
213
-
214
- <td rowspan="1" colSpan="1" >Camera test status.</td>
215
- </tr>
216
-
217
-
218
- <tr>
219
- <td rowspan="1" colSpan="1" >[isCameraTestLoading](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isCameraTestLoading)</td>
220
-
221
-
222
- <td rowspan="1" colSpan="1" >Camera test loading status.</td>
223
- </tr>
224
-
225
-
226
- <tr>
227
- <td rowspan="1" colSpan="1" >[isFrontCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isFrontCamera)</td>
228
-
229
-
230
- <td rowspan="1" colSpan="1" >Whether the camera is front-facing.</td>
231
- </tr>
232
-
233
-
234
- <tr>
235
- <td rowspan="1" colSpan="1" >[localMirrorType](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#localMirrorType)</td>
236
-
237
-
238
- <td rowspan="1" colSpan="1" >Local video image type.</td>
239
- </tr>
240
-
241
-
242
- <tr>
243
- <td rowspan="1" colSpan="1" >[localVideoQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#localVideoQuality)</td>
244
-
245
-
246
- <td rowspan="1" colSpan="1" >Local video quality.</td>
247
- </tr>
248
-
249
-
250
- <tr>
251
- <td rowspan="1" colSpan="1" >[speakerList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#speakerList)</td>
252
-
253
-
254
- <td rowspan="1" colSpan="1" >Speaker Device List.</td>
255
- </tr>
256
-
257
-
258
- <tr>
259
- <td rowspan="1" colSpan="1" >[currentSpeaker](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentSpeaker)</td>
260
-
261
-
262
- <td rowspan="1" colSpan="1" >Selected speaker device.</td>
263
- </tr>
264
-
265
-
266
- <tr>
267
- <td rowspan="1" colSpan="1" >[outputVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#outputVolume)</td>
268
-
269
-
270
- <td rowspan="1" colSpan="1" >Speaker output volume.</td>
271
- </tr>
272
-
273
-
274
- <tr>
275
- <td rowspan="1" colSpan="1" >[currentAudioRoute](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentAudioRoute)</td>
276
-
277
-
278
- <td rowspan="1" colSpan="1" >Current audio routing.</td>
279
- </tr>
280
-
281
-
282
- <tr>
283
- <td rowspan="1" colSpan="1" >[isSpeakerTesting](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isSpeakerTesting)</td>
284
-
285
-
286
- <td rowspan="1" colSpan="1" >Speaker testing status.</td>
287
- </tr>
288
-
289
-
290
- <tr>
291
- <td rowspan="1" colSpan="1" >[screenStatus](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#screenStatus)</td>
292
-
293
-
294
- <td rowspan="1" colSpan="1" >Screen sharing status.</td>
295
- </tr>
296
-
297
-
298
- <tr>
299
- <td rowspan="1" colSpan="1" >[networkInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#networkInfo)</td>
300
-
301
-
302
- <td rowspan="1" colSpan="1" >Network information.</td>
303
- </tr>
304
- </table>
305
-
306
-
307
-
308
-
309
- API Function
310
-
311
-
312
- <table>
313
- <tr>
314
- <td rowspan="1" colSpan="1" >**Function list**</td>
315
-
316
-
317
- <td rowspan="1" colSpan="1" >**Description**</td>
318
- </tr>
319
-
320
-
321
- <tr>
322
- <td rowspan="1" colSpan="1" >[openLocalMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#openLocalMicrophone)</td>
323
-
324
-
325
- <td rowspan="1" colSpan="1" >Open local microphone.</td>
326
- </tr>
327
-
328
-
329
- <tr>
330
- <td rowspan="1" colSpan="1" >[closeLocalMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#closeLocalMicrophone)</td>
331
-
332
-
333
- <td rowspan="1" colSpan="1" >Close local microphone.</td>
334
- </tr>
335
-
336
-
337
- <tr>
338
- <td rowspan="1" colSpan="1" >[muteLocalAudio](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#muteLocalAudio)</td>
339
-
340
-
341
- <td rowspan="1" colSpan="1" >Mute local audio.</td>
342
- </tr>
343
-
344
-
345
- <tr>
346
- <td rowspan="1" colSpan="1" >[unmuteLocalAudio](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#unmuteLocalAudio)</td>
347
-
348
-
349
- <td rowspan="1" colSpan="1" >Unmute local audio.</td>
350
- </tr>
351
-
352
-
353
- <tr>
354
- <td rowspan="1" colSpan="1" >[getMicrophoneList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getMicrophoneList)</td>
355
-
356
-
357
- <td rowspan="1" colSpan="1" >Get microphone device list.</td>
358
- </tr>
359
-
360
-
361
- <tr>
362
- <td rowspan="1" colSpan="1" >[setCurrentMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setCurrentMicrophone)</td>
363
-
364
-
365
- <td rowspan="1" colSpan="1" >Set current microphone device.</td>
366
- </tr>
367
-
368
-
369
- <tr>
370
- <td rowspan="1" colSpan="1" >[startMicrophoneTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startMicrophoneTest)</td>
371
-
372
-
373
- <td rowspan="1" colSpan="1" >Start mic testing.</td>
374
- </tr>
375
-
376
-
377
- <tr>
378
- <td rowspan="1" colSpan="1" >[setCaptureVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setCaptureVolume)</td>
379
-
380
-
381
- <td rowspan="1" colSpan="1" >Set audio capture volume.</td>
382
- </tr>
383
-
384
-
385
- <tr>
386
- <td rowspan="1" colSpan="1" >[setOutputVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setOutputVolume)</td>
387
-
388
-
389
- <td rowspan="1" colSpan="1" >Set audio playback volume.</td>
390
- </tr>
391
-
392
-
393
- <tr>
394
- <td rowspan="1" colSpan="1" >[stopMicrophoneTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopMicrophoneTest)</td>
395
-
396
-
397
- <td rowspan="1" colSpan="1" >Stop mic testing.</td>
398
- </tr>
399
-
400
-
401
- <tr>
402
- <td rowspan="1" colSpan="1" >[getSpeakerList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getSpeakerList)</td>
403
-
404
-
405
- <td rowspan="1" colSpan="1" >Search speaker device list.</td>
406
- </tr>
407
-
408
-
409
- <tr>
410
- <td rowspan="1" colSpan="1" >[setCurrentSpeaker](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setCurrentSpeaker)</td>
411
-
412
-
413
- <td rowspan="1" colSpan="1" >Set current speaker device.</td>
414
- </tr>
415
-
416
-
417
- <tr>
418
- <td rowspan="1" colSpan="1" >[setAudioRoute](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setAudioRoute)</td>
419
-
420
-
421
- <td rowspan="1" colSpan="1" >Set audio routing.</td>
422
- </tr>
423
-
424
-
425
- <tr>
426
- <td rowspan="1" colSpan="1" >[startSpeakerTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startSpeakerTest)</td>
427
-
428
-
429
- <td rowspan="1" colSpan="1" >Start speaker testing.</td>
430
- </tr>
431
-
432
-
433
- <tr>
434
- <td rowspan="1" colSpan="1" >[stopSpeakerTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopSpeakerTest)</td>
435
-
436
-
437
- <td rowspan="1" colSpan="1" >Stop speaker test.</td>
438
- </tr>
439
-
440
-
441
- <tr>
442
- <td rowspan="1" colSpan="1" >[openLocalCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#openLocalCamera)</td>
443
-
444
-
445
- <td rowspan="1" colSpan="1" >Turn on local camera.</td>
446
- </tr>
447
-
448
-
449
- <tr>
450
- <td rowspan="1" colSpan="1" >[closeLocalCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#closeLocalCamera)</td>
451
-
452
-
453
- <td rowspan="1" colSpan="1" >Turn off local camera.</td>
454
- </tr>
455
-
456
-
457
- <tr>
458
- <td rowspan="1" colSpan="1" >[getCameraList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getCameraList)</td>
459
-
460
-
461
- <td rowspan="1" colSpan="1" >Get camera list.</td>
462
- </tr>
463
-
464
-
465
- <tr>
466
- <td rowspan="1" colSpan="1" >[setCurrentCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setCurrentCamera)</td>
467
-
468
-
469
- <td rowspan="1" colSpan="1" >Set current camera.</td>
470
- </tr>
471
-
472
-
473
- <tr>
474
- <td rowspan="1" colSpan="1" >[switchCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#switchCamera)</td>
475
-
476
-
477
- <td rowspan="1" colSpan="1" >Switch between front and rear cameras.</td>
478
- </tr>
479
-
480
-
481
- <tr>
482
- <td rowspan="1" colSpan="1" >[switchMirror](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#switchMirror)</td>
483
-
484
-
485
- <td rowspan="1" colSpan="1" >Toggle video mirroring mode.</td>
486
- </tr>
487
-
488
-
489
- <tr>
490
- <td rowspan="1" colSpan="1" >[updateVideoQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateVideoQuality)</td>
491
-
492
-
493
- <td rowspan="1" colSpan="1" >Refresh video quality.</td>
494
- </tr>
495
-
496
-
497
- <tr>
498
- <td rowspan="1" colSpan="1" >[startCameraDeviceTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startCameraDeviceTest)</td>
499
-
500
-
501
- <td rowspan="1" colSpan="1" >Start camera test.</td>
502
- </tr>
503
-
504
-
505
- <tr>
506
- <td rowspan="1" colSpan="1" >[startScreenShare](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startScreenShare)</td>
507
-
508
-
509
- <td rowspan="1" colSpan="1" >Start screen sharing.</td>
510
- </tr>
511
-
512
-
513
- <tr>
514
- <td rowspan="1" colSpan="1" >[stopScreenShare](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopScreenShare)</td>
515
-
516
-
517
- <td rowspan="1" colSpan="1" >Stop screen sharing.</td>
518
- </tr>
519
-
520
-
521
- <tr>
522
- <td rowspan="1" colSpan="1" >[stopCameraDeviceTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopCameraDeviceTest)</td>
523
-
524
-
525
- <td rowspan="1" colSpan="1" >Stop camera test.</td>
526
- </tr>
527
-
528
-
529
- <tr>
530
- <td rowspan="1" colSpan="1" >[screenCaptureStopped](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#screenCaptureStopped)</td>
531
-
532
-
533
- <td rowspan="1" colSpan="1" >Screen sharing stop callback.</td>
534
- </tr>
535
- </table>
536
-
537
-
538
-
539
-
540
- ## LiveListState
541
-
542
-
543
- Live List Management Module
544
- -Core features: Manage the complete lifecycle of live streaming rooms, including creation, join, leave, and end core business processes, support pagination fetch and real-time update of live lists.
545
-
546
-
547
- - Technical features: Support load by page, real-time state synchronization, dynamic data updates of live information, implement responsive data management to ensure real-time synchronization between UI and data status. Newly-added liveList and liveListCursor responsive data, provide fetchLiveList API function.
548
-
549
-
550
- - Business value: Provide core live room management capabilities for the live streaming platform, support large-scale concurrency in live-streaming scenarios, and serve as the infrastructure for the live streaming business.
551
-
552
-
553
- - Application scenario: Core business scenarios such as live list display, live room creation, live stream status management, and live broadcast data statistics.
554
-
555
-
556
-
557
-
558
- responsive data
559
-
560
-
561
- <table>
562
- <tr>
563
- <td rowspan="1" colSpan="1" >**Data List**</td>
564
-
565
-
566
- <td rowspan="1" colSpan="1" >**Description**</td>
567
- </tr>
568
-
569
-
570
- <tr>
571
- <td rowspan="1" colSpan="1" >[currentLive](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentLive)</td>
572
-
573
-
574
- <td rowspan="1" colSpan="1" >Switch TUILiveInfo to LiveInfo format.</td>
575
- </tr>
576
-
577
-
578
- <tr>
579
- <td rowspan="1" colSpan="1" >[liveList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#liveList)</td>
580
-
581
-
582
- <td rowspan="1" colSpan="1" >Live list data, including info of all live streaming rooms.</td>
583
- </tr>
584
-
585
-
586
- <tr>
587
- <td rowspan="1" colSpan="1" >[liveListCursor](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#liveListCursor)</td>
588
-
589
-
590
- <td rowspan="1" colSpan="1" >Live list pagination cursor, used to obtain next page data.</td>
591
- </tr>
592
- </table>
593
-
594
-
595
-
596
-
597
- API Function
598
-
599
-
600
- <table>
601
- <tr>
602
- <td rowspan="1" colSpan="1" >**Function list**</td>
603
-
604
-
605
- <td rowspan="1" colSpan="1" >**Description**</td>
606
- </tr>
607
-
608
-
609
- <tr>
610
- <td rowspan="1" colSpan="1" >[createLive](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#createLive)</td>
611
-
612
-
613
- <td rowspan="1" colSpan="1" >Create a live streaming room.</td>
614
- </tr>
615
-
616
-
617
- <tr>
618
- <td rowspan="1" colSpan="1" >[joinLive](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#joinLive)</td>
619
-
620
-
621
- <td rowspan="1" colSpan="1" >Join live room.</td>
622
- </tr>
623
-
624
-
625
- <tr>
626
- <td rowspan="1" colSpan="1" >[leaveLive](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#leaveLive)</td>
627
-
628
-
629
- <td rowspan="1" colSpan="1" >Leave the live streaming room.</td>
630
- </tr>
631
-
632
-
633
- <tr>
634
- <td rowspan="1" colSpan="1" >[endLive](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#endLive)</td>
635
-
636
-
637
- <td rowspan="1" colSpan="1" >End live stream.</td>
638
- </tr>
639
-
640
-
641
- <tr>
642
- <td rowspan="1" colSpan="1" >[updateLiveInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateLiveInfo)</td>
643
-
644
-
645
- <td rowspan="1" colSpan="1" >Refresh live room information.</td>
646
- </tr>
647
-
648
-
649
- <tr>
650
- <td rowspan="1" colSpan="1" >[queryMetaData](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#queryMetaData)</td>
651
-
652
-
653
- <td rowspan="1" colSpan="1" >Query metadata.</td>
654
- </tr>
655
-
656
-
657
- <tr>
658
- <td rowspan="1" colSpan="1" >[updateLiveMetaData](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateLiveMetaData)</td>
659
-
660
-
661
- <td rowspan="1" colSpan="1" >Update live room metadata.</td>
662
- </tr>
663
-
664
-
665
- <tr>
666
- <td rowspan="1" colSpan="1" >[fetchLiveList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#fetchLiveList)</td>
667
-
668
-
669
- <td rowspan="1" colSpan="1" >Get live list.</td>
670
- </tr>
671
- </table>
672
-
673
-
674
-
675
-
676
- ## LiveSeatState
677
-
678
-
679
- Live Room Seat Management Module
680
- -Core features: Implement seat control in microphone-connected scenarios, support complex seat status management and audio/video device control, including joining, leaving, seat lock and all features.
681
-
682
-
683
- -Technical features: Based on WebRTC technology, it supports multiple media stream management and offers advanced functions like seat locking, device control, and permission management. Newly-added responsive data includes seatList, canvas, speakingUsers, and networkQualities, as well as a complete operation API for seats.
684
-
685
-
686
- - Business value: Provide core technology support for multi-person interactive live streaming, supporting various interactive scenarios like PK, microphone connection, and multiplayer games.
687
-
688
-
689
- - Application scenarios: Scenarios requiring multi-person audio and video interaction, such as co-anchoring, PK battles, interactive games, online education, and live conference streaming.
690
-
691
-
692
-
693
-
694
- responsive data
695
-
696
-
697
- <table>
698
- <tr>
699
- <td rowspan="1" colSpan="1" >**Data List**</td>
700
-
701
-
702
- <td rowspan="1" colSpan="1" >**Description**</td>
703
- </tr>
704
-
705
-
706
- <tr>
707
- <td rowspan="1" colSpan="1" >[seatList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#seatList)</td>
708
-
709
-
710
- <td rowspan="1" colSpan="1" >Microphone position list, including ALL seat states and user information.</td>
711
- </tr>
712
-
713
-
714
- <tr>
715
- <td rowspan="1" colSpan="1" >[canvas](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#canvas)</td>
716
-
717
-
718
- <td rowspan="1" colSpan="1" >Canvas configuration for video rendering and layout management.</td>
719
- </tr>
720
-
721
-
722
- <tr>
723
- <td rowspan="1" colSpan="1" >[speakingUsers](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#speakingUsers)</td>
724
-
725
-
726
- <td rowspan="1" colSpan="1" >List of users speaking.</td>
727
- </tr>
728
-
729
-
730
- <tr>
731
- <td rowspan="1" colSpan="1" >[networkQualities](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#networkQualities)</td>
732
-
733
-
734
- <td rowspan="1" colSpan="1" >Network quality information, including user's network status.</td>
735
- </tr>
736
- </table>
737
-
738
-
739
-
740
-
741
- API Function
742
-
743
-
744
- <table>
745
- <tr>
746
- <td rowspan="1" colSpan="1" >**Function list**</td>
747
-
748
-
749
- <td rowspan="1" colSpan="1" >**Description**</td>
750
- </tr>
751
-
752
-
753
- <tr>
754
- <td rowspan="1" colSpan="1" >[takeSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#takeSeat)</td>
755
-
756
-
757
- <td rowspan="1" colSpan="1" >User joins the stage.</td>
758
- </tr>
759
-
760
-
761
- <tr>
762
- <td rowspan="1" colSpan="1" >[leaveSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#leaveSeat)</td>
763
-
764
-
765
- <td rowspan="1" colSpan="1" >User Microphone Dequeuing.</td>
766
- </tr>
767
-
768
-
769
- <tr>
770
- <td rowspan="1" colSpan="1" >[lockSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#lockSeat)</td>
771
-
772
-
773
- <td rowspan="1" colSpan="1" >Seat locking.</td>
774
- </tr>
775
-
776
-
777
- <tr>
778
- <td rowspan="1" colSpan="1" >[unLockSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#unLockSeat)</td>
779
-
780
-
781
- <td rowspan="1" colSpan="1" >Unlock microphone position.</td>
782
- </tr>
783
-
784
-
785
- <tr>
786
- <td rowspan="1" colSpan="1" >[kickUserOutOfSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#kickUserOutOfSeat)</td>
787
-
788
-
789
- <td rowspan="1" colSpan="1" >Remove users from speaking.</td>
790
- </tr>
791
-
792
-
793
- <tr>
794
- <td rowspan="1" colSpan="1" >[moveUserToSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#moveUserToSeat)</td>
795
-
796
-
797
- <td rowspan="1" colSpan="1" >Move user to designated seat.</td>
798
- </tr>
799
-
800
-
801
- <tr>
802
- <td rowspan="1" colSpan="1" >[openRemoteCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#openRemoteCamera)</td>
803
-
804
-
805
- <td rowspan="1" colSpan="1" >Enable remote camera.</td>
806
- </tr>
807
-
808
-
809
- <tr>
810
- <td rowspan="1" colSpan="1" >[closeRemoteCamera](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#closeRemoteCamera)</td>
811
-
812
-
813
- <td rowspan="1" colSpan="1" >Turn off remote camera.</td>
814
- </tr>
815
-
816
-
817
- <tr>
818
- <td rowspan="1" colSpan="1" >[openRemoteMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#openRemoteMicrophone)</td>
819
-
820
-
821
- <td rowspan="1" colSpan="1" >Enable remote microphone.</td>
822
- </tr>
823
-
824
-
825
- <tr>
826
- <td rowspan="1" colSpan="1" >[closeRemoteMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#closeRemoteMicrophone)</td>
827
-
828
-
829
- <td rowspan="1" colSpan="1" >Turn off remote microphone.</td>
830
- </tr>
831
-
832
-
833
- <tr>
834
- <td rowspan="1" colSpan="1" >[muteMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#muteMicrophone)</td>
835
-
836
-
837
- <td rowspan="1" colSpan="1" >Mute microphone.</td>
838
- </tr>
839
-
840
-
841
- <tr>
842
- <td rowspan="1" colSpan="1" >[unmuteMicrophone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#unmuteMicrophone)</td>
843
-
844
-
845
- <td rowspan="1" colSpan="1" >Unmute microphone.</td>
846
- </tr>
847
-
848
-
849
- <tr>
850
- <td rowspan="1" colSpan="1" >[startPlayStream](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startPlayStream)</td>
851
-
852
-
853
- <td rowspan="1" colSpan="1" >Start playback.</td>
854
- </tr>
855
-
856
-
857
- <tr>
858
- <td rowspan="1" colSpan="1" >[stopPlayStream](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopPlayStream)</td>
859
-
860
-
861
- <td rowspan="1" colSpan="1" >Stop playback.</td>
862
- </tr>
863
- </table>
864
-
865
-
866
-
867
-
868
- ## LiveAudienceState
869
-
870
-
871
- Live Room Audience Management Module
872
- - Core features: Manage the audience list of live streaming rooms, provide permission control, admin settings and other maintenance features for live room order, support real-time audience statistics.
873
-
874
-
875
- - Technical features: Support advanced functions such as real-time audience list update, permission hierarchy management, and batch operation to underwrite live room order and user experience. Newly-added responsive data: audienceList and audienceCount.
876
-
877
-
878
- - Business value: Offer a complete audience management solution for the live streaming platform, supporting order maintenance in large-scale audience scenarios.
879
-
880
-
881
- - Application scenario: Core business scenarios such as audience management, permission control, live streaming room order maintenance, and audience interaction management.
882
-
883
-
884
-
885
-
886
- responsive data
887
-
888
-
889
- <table>
890
- <tr>
891
- <td rowspan="1" colSpan="1" >**Data List**</td>
892
-
893
-
894
- <td rowspan="1" colSpan="1" >**Description**</td>
895
- </tr>
896
-
897
-
898
- <tr>
899
- <td rowspan="1" colSpan="1" >[audienceList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#audienceList)</td>
900
-
901
-
902
- <td rowspan="1" colSpan="1" >Audience list, including info of all audience in the live streaming room.</td>
903
- </tr>
904
-
905
-
906
- <tr>
907
- <td rowspan="1" colSpan="1" >[audienceCount](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#audienceCount)</td>
908
-
909
-
910
- <td rowspan="1" colSpan="1" >Total number statistics of audience.</td>
911
- </tr>
912
- </table>
913
-
914
-
915
-
916
-
917
- API Function
918
-
919
-
920
- <table>
921
- <tr>
922
- <td rowspan="1" colSpan="1" >**Function list**</td>
923
-
924
-
925
- <td rowspan="1" colSpan="1" >**Description**</td>
926
- </tr>
927
-
928
-
929
- <tr>
930
- <td rowspan="1" colSpan="1" >[fetchAudienceList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#fetchAudienceList)</td>
931
-
932
-
933
- <td rowspan="1" colSpan="1" >Retrieve audience list.</td>
934
- </tr>
935
-
936
-
937
- <tr>
938
- <td rowspan="1" colSpan="1" >[setAdministrator](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setAdministrator)</td>
939
-
940
-
941
- <td rowspan="1" colSpan="1" >Set administrator.</td>
942
- </tr>
943
-
944
-
945
- <tr>
946
- <td rowspan="1" colSpan="1" >[revokeAdministrator](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#revokeAdministrator)</td>
947
-
948
-
949
- <td rowspan="1" colSpan="1" >Revoke admin.</td>
950
- </tr>
951
-
952
-
953
- <tr>
954
- <td rowspan="1" colSpan="1" >[kickUserOutOfRoom](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#kickUserOutOfRoom)</td>
955
-
956
-
957
- <td rowspan="1" colSpan="1" >Kick out of room.</td>
958
- </tr>
959
-
960
-
961
- <tr>
962
- <td rowspan="1" colSpan="1" >[disableSendMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#disableSendMessage)</td>
963
-
964
-
965
- <td rowspan="1" colSpan="1" >Mute users.</td>
966
- </tr>
967
- </table>
968
-
969
-
970
-
971
-
972
- ## LiveMonitorState
973
-
974
-
975
- Live Stream Monitoring Management Module
976
- - Core features: Provide real-time monitoring for live streaming rooms, including live status monitoring, data statistics, anomaly detection and other core monitoring capabilities, support multi-room monitoring.
977
-
978
-
979
- - Technical features: Support real-time data collection, multidimensional monitoring metrics, intelligent alarm mechanism to underwrite service stability and reliability. Newly-added monitorLiveInfoList responsive data, optimized monitoring interface.
980
-
981
-
982
- - Business value: Offer comprehensive monitoring assurance for the live streaming platform, enabling timely detection and handling of anomalies to improve service quality.
983
-
984
-
985
- - Application scenario: Operation management scenarios such as live stream quality monitoring, performance analysis, abnormal alarm, and data statistics.
986
-
987
-
988
-
989
-
990
- responsive data
991
-
992
-
993
- <table>
994
- <tr>
995
- <td rowspan="1" colSpan="1" >**Data List**</td>
996
-
997
-
998
- <td rowspan="1" colSpan="1" >**Description**</td>
999
- </tr>
1000
-
1001
-
1002
- <tr>
1003
- <td rowspan="1" colSpan="1" >[monitorLiveInfoList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#monitorLiveInfoList)</td>
1004
-
1005
-
1006
- <td rowspan="1" colSpan="1" >Live room monitoring list.</td>
1007
- </tr>
1008
- </table>
1009
-
1010
-
1011
-
1012
-
1013
- API Function
1014
-
1015
-
1016
- <table>
1017
- <tr>
1018
- <td rowspan="1" colSpan="1" >**Function list**</td>
1019
-
1020
-
1021
- <td rowspan="1" colSpan="1" >**Description**</td>
1022
- </tr>
1023
-
1024
-
1025
- <tr>
1026
- <td rowspan="1" colSpan="1" >[init](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#init)</td>
1027
-
1028
-
1029
- <td rowspan="1" colSpan="1" >Initialize monitoring.</td>
1030
- </tr>
1031
-
1032
-
1033
- <tr>
1034
- <td rowspan="1" colSpan="1" >[getLiveList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getLiveList)</td>
1035
-
1036
-
1037
- <td rowspan="1" colSpan="1" >Get live list.</td>
1038
- </tr>
1039
-
1040
-
1041
- <tr>
1042
- <td rowspan="1" colSpan="1" >[closeRoom](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#closeRoom)</td>
1043
-
1044
-
1045
- <td rowspan="1" colSpan="1" >Close the room.</td>
1046
- </tr>
1047
-
1048
-
1049
- <tr>
1050
- <td rowspan="1" colSpan="1" >[sendMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#sendMessage)</td>
1051
-
1052
-
1053
- <td rowspan="1" colSpan="1" >Send message.</td>
1054
- </tr>
1055
-
1056
-
1057
- <tr>
1058
- <td rowspan="1" colSpan="1" >[startPlay](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startPlay)</td>
1059
-
1060
-
1061
- <td rowspan="1" colSpan="1" >Start playback.</td>
1062
- </tr>
1063
-
1064
-
1065
- <tr>
1066
- <td rowspan="1" colSpan="1" >[stopPlay](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopPlay)</td>
1067
-
1068
-
1069
- <td rowspan="1" colSpan="1" >Stop playback.</td>
1070
- </tr>
1071
-
1072
-
1073
- <tr>
1074
- <td rowspan="1" colSpan="1" >[muteLiveAudio](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#muteLiveAudio)</td>
1075
-
1076
-
1077
- <td rowspan="1" colSpan="1" >Mute live audio.</td>
1078
- </tr>
1079
- </table>
1080
-
1081
-
1082
-
1083
-
1084
- ## CoGuestState
1085
-
1086
-
1087
- Guest management module
1088
- - Core features: Handle mic-connect interaction between audience and host, manage join microphone application, invitation, acceptance, rejection and other complete process, support status management.
1089
-
1090
-
1091
- - Technical features: Based on real-time audio and video technology, support advanced functions like real-time synchronization of mic-connect status, adaptive adjustment of audio/video quality, and network condition monitoring. Newly-added connected, invitees, applicants, candidates responsive data and applyForSeat API.
1092
-
1093
-
1094
- - Business value: Provide core audience interaction capabilities for the live streaming platform, enhance user stickiness and live stream fun.
1095
-
1096
-
1097
- - Application scenarios: Interactive scenarios requiring audience participation, such as audience mic connection, interactive Q&A, online karaoke, and game live streaming.
1098
-
1099
-
1100
-
1101
-
1102
- responsive data
1103
-
1104
-
1105
- <table>
1106
- <tr>
1107
- <td rowspan="1" colSpan="1" >**Data List**</td>
1108
-
1109
-
1110
- <td rowspan="1" colSpan="1" >**Description**</td>
1111
- </tr>
1112
-
1113
-
1114
- <tr>
1115
- <td rowspan="1" colSpan="1" >[candidates](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#candidates)</td>
1116
-
1117
-
1118
- <td rowspan="1" colSpan="1" >Unsubscription of co-streaming event.</td>
1119
- </tr>
1120
-
1121
-
1122
- <tr>
1123
- <td rowspan="1" colSpan="1" >[connected](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#connected)</td>
1124
-
1125
-
1126
- <td rowspan="1" colSpan="1" >Co-streaming Connection Status.</td>
1127
- </tr>
1128
-
1129
-
1130
- <tr>
1131
- <td rowspan="1" colSpan="1" >[invitees](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#invitees)</td>
1132
-
1133
-
1134
- <td rowspan="1" colSpan="1" >List of invited users.</td>
1135
- </tr>
1136
-
1137
-
1138
- <tr>
1139
- <td rowspan="1" colSpan="1" >[applicants](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#applicants)</td>
1140
-
1141
-
1142
- <td rowspan="1" colSpan="1" >List of users applying for mic connection.</td>
1143
- </tr>
1144
- </table>
1145
-
1146
-
1147
-
1148
-
1149
- API Function
1150
-
1151
-
1152
- <table>
1153
- <tr>
1154
- <td rowspan="1" colSpan="1" >**Function list**</td>
1155
-
1156
-
1157
- <td rowspan="1" colSpan="1" >**Description**</td>
1158
- </tr>
1159
-
1160
-
1161
- <tr>
1162
- <td rowspan="1" colSpan="1" >[cancelApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cancelApplication)</td>
1163
-
1164
-
1165
- <td rowspan="1" colSpan="1" >Cancel application.</td>
1166
- </tr>
1167
-
1168
-
1169
- <tr>
1170
- <td rowspan="1" colSpan="1" >[acceptApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptApplication)</td>
1171
-
1172
-
1173
- <td rowspan="1" colSpan="1" >Accept application.</td>
1174
- </tr>
1175
-
1176
-
1177
- <tr>
1178
- <td rowspan="1" colSpan="1" >[rejectApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#rejectApplication)</td>
1179
-
1180
-
1181
- <td rowspan="1" colSpan="1" >Reject application.</td>
1182
- </tr>
1183
-
1184
-
1185
- <tr>
1186
- <td rowspan="1" colSpan="1" >[cancelInvitation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cancelInvitation)</td>
1187
-
1188
-
1189
- <td rowspan="1" colSpan="1" >Cancel invitation.</td>
1190
- </tr>
1191
-
1192
-
1193
- <tr>
1194
- <td rowspan="1" colSpan="1" >[acceptInvitation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptInvitation)</td>
1195
-
1196
-
1197
- <td rowspan="1" colSpan="1" >Accept invitation.</td>
1198
- </tr>
1199
-
1200
-
1201
- <tr>
1202
- <td rowspan="1" colSpan="1" >[rejectInvitation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#rejectInvitation)</td>
1203
-
1204
-
1205
- <td rowspan="1" colSpan="1" >Reject invitation.</td>
1206
- </tr>
1207
-
1208
-
1209
- <tr>
1210
- <td rowspan="1" colSpan="1" >[disConnect](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#disConnect)</td>
1211
-
1212
-
1213
- <td rowspan="1" colSpan="1" >Disconnect.</td>
1214
- </tr>
1215
-
1216
-
1217
- <tr>
1218
- <td rowspan="1" colSpan="1" >[applyForSeat](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#applyForSeat)</td>
1219
-
1220
-
1221
- <td rowspan="1" colSpan="1" >Request to speak.</td>
1222
- </tr>
1223
- </table>
1224
-
1225
-
1226
-
1227
-
1228
- ## CoHostState
1229
-
1230
-
1231
- Anchor management module
1232
- - Core features: Implement the co-anchoring function between hosts, support host invitations, join microphone applications, status management, and other interaction features, providing a complete co-anchoring process.
1233
-
1234
-
1235
- - Technical features: Support advanced technologies like multi-anchor audio-video synchronization, Picture-in-Picture display, and audio/video quality optimization to ensure smooth co-anchoring experience. Newly-added coHostStatus, connected, applicant, invitees, candidates responsive data and a complete co-anchoring control API.
1236
-
1237
-
1238
- - Business value: Provide core collaboration capabilities for hosts on live streaming platforms, supporting advanced business scenarios like PK and co-streaming.
1239
-
1240
-
1241
- - Application scenarios: Advanced live-streaming scenarios such as host PK battles, co-streaming, cross-platform voice chats, and host interactions.
1242
-
1243
-
1244
-
1245
-
1246
- responsive data
1247
-
1248
-
1249
- <table>
1250
- <tr>
1251
- <td rowspan="1" colSpan="1" >**Data List**</td>
1252
-
1253
-
1254
- <td rowspan="1" colSpan="1" >**Description**</td>
1255
- </tr>
1256
-
1257
-
1258
- <tr>
1259
- <td rowspan="1" colSpan="1" >[coHostStatus](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#coHostStatus)</td>
1260
-
1261
-
1262
- <td rowspan="1" colSpan="1" >Co-streaming Host Status.</td>
1263
- </tr>
1264
-
1265
-
1266
- <tr>
1267
- <td rowspan="1" colSpan="1" >[connected](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#connected)</td>
1268
-
1269
-
1270
- <td rowspan="1" colSpan="1" >Co-streaming Connection Status.</td>
1271
- </tr>
1272
-
1273
-
1274
- <tr>
1275
- <td rowspan="1" colSpan="1" >[applicant](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#applicant)</td>
1276
-
1277
-
1278
- <td rowspan="1" colSpan="1" >Host information applying for mic connection.</td>
1279
- </tr>
1280
-
1281
-
1282
- <tr>
1283
- <td rowspan="1" colSpan="1" >[invitees](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#invitees)</td>
1284
-
1285
-
1286
- <td rowspan="1" colSpan="1" >List of invited users.</td>
1287
- </tr>
1288
-
1289
-
1290
- <tr>
1291
- <td rowspan="1" colSpan="1" >[candidates](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#candidates)</td>
1292
-
1293
-
1294
- <td rowspan="1" colSpan="1" >List of candidate users.</td>
1295
- </tr>
1296
- </table>
1297
-
1298
-
1299
-
1300
-
1301
- API Function
1302
-
1303
-
1304
- <table>
1305
- <tr>
1306
- <td rowspan="1" colSpan="1" >**Function list**</td>
1307
-
1308
-
1309
- <td rowspan="1" colSpan="1" >**Description**</td>
1310
- </tr>
1311
-
1312
-
1313
- <tr>
1314
- <td rowspan="1" colSpan="1" >[requestHostConnection](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#requestHostConnection)</td>
1315
-
1316
-
1317
- <td rowspan="1" colSpan="1" >Request host mic connection.</td>
1318
- </tr>
1319
-
1320
-
1321
- <tr>
1322
- <td rowspan="1" colSpan="1" >[cancelHostConnection](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cancelHostConnection)</td>
1323
-
1324
-
1325
- <td rowspan="1" colSpan="1" >Cancel host mic connection.</td>
1326
- </tr>
1327
-
1328
-
1329
- <tr>
1330
- <td rowspan="1" colSpan="1" >[acceptHostConnection](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptHostConnection)</td>
1331
-
1332
-
1333
- <td rowspan="1" colSpan="1" >Accept host mic connection.</td>
1334
- </tr>
1335
-
1336
-
1337
- <tr>
1338
- <td rowspan="1" colSpan="1" >[rejectHostConnection](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#rejectHostConnection)</td>
1339
-
1340
-
1341
- <td rowspan="1" colSpan="1" >Reject host mic connection.</td>
1342
- </tr>
1343
-
1344
-
1345
- <tr>
1346
- <td rowspan="1" colSpan="1" >[exitHostConnection](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#exitHostConnection)</td>
1347
-
1348
-
1349
- <td rowspan="1" colSpan="1" >Exit host mic connection.</td>
1350
- </tr>
1351
- </table>
1352
-
1353
-
1354
-
1355
-
1356
- ## BattleState
1357
-
1358
-
1359
- PK Battle Management Module
1360
- - Core features: Manage PK battles between hosts, including battle invitations, acceptance, rejection, and completion, supporting live score statistics.
1361
-
1362
-
1363
- - Technical features: Support real-time battle state synchronization, score calculation, results statistics and other features. Newly-added battleScore responsive data provides a complete PK battle experience.
1364
-
1365
-
1366
- - Business value: The platform offers competitive gaming interaction features to enhance live stream fun and user engagement.
1367
-
1368
-
1369
- - Application scenarios: Entertainment scenarios such as host PK battles, talent competitions, game battles, and interactive competitions.
1370
-
1371
-
1372
-
1373
-
1374
- responsive data
1375
-
1376
-
1377
- <table>
1378
- <tr>
1379
- <td rowspan="1" colSpan="1" >**Data List**</td>
1380
-
1381
-
1382
- <td rowspan="1" colSpan="1" >**Description**</td>
1383
- </tr>
1384
-
1385
-
1386
- <tr>
1387
- <td rowspan="1" colSpan="1" >[currentBattleInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentBattleInfo)</td>
1388
-
1389
-
1390
- <td rowspan="1" colSpan="1" >Current PK info.</td>
1391
- </tr>
1392
-
1393
-
1394
- <tr>
1395
- <td rowspan="1" colSpan="1" >[battleUsers](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#battleUsers)</td>
1396
-
1397
-
1398
- <td rowspan="1" colSpan="1" >List of PK participants.</td>
1399
- </tr>
1400
-
1401
-
1402
- <tr>
1403
- <td rowspan="1" colSpan="1" >[battleScore](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#battleScore)</td>
1404
-
1405
-
1406
- <td rowspan="1" colSpan="1" >Live score of PK battle.</td>
1407
- </tr>
1408
- </table>
1409
-
1410
-
1411
-
1412
-
1413
- API Function
1414
-
1415
-
1416
- <table>
1417
- <tr>
1418
- <td rowspan="1" colSpan="1" >**Function list**</td>
1419
-
1420
-
1421
- <td rowspan="1" colSpan="1" >**Description**</td>
1422
- </tr>
1423
-
1424
-
1425
- <tr>
1426
- <td rowspan="1" colSpan="1" >[requestBattle](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#requestBattle)</td>
1427
-
1428
-
1429
- <td rowspan="1" colSpan="1" >Request PK.</td>
1430
- </tr>
1431
-
1432
-
1433
- <tr>
1434
- <td rowspan="1" colSpan="1" >[cancelBattleRequest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cancelBattleRequest)</td>
1435
-
1436
-
1437
- <td rowspan="1" colSpan="1" >Cancel battle request.</td>
1438
- </tr>
1439
-
1440
-
1441
- <tr>
1442
- <td rowspan="1" colSpan="1" >[acceptBattle](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptBattle)</td>
1443
-
1444
-
1445
- <td rowspan="1" colSpan="1" >Accept PK.</td>
1446
- </tr>
1447
-
1448
-
1449
- <tr>
1450
- <td rowspan="1" colSpan="1" >[rejectBattle](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#rejectBattle)</td>
1451
-
1452
-
1453
- <td rowspan="1" colSpan="1" >Reject PK.</td>
1454
- </tr>
1455
-
1456
-
1457
- <tr>
1458
- <td rowspan="1" colSpan="1" >[exitBattle](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#exitBattle)</td>
1459
-
1460
-
1461
- <td rowspan="1" colSpan="1" >Exit PK.</td>
1462
- </tr>
1463
- </table>
1464
-
1465
-
1466
-
1467
-
1468
- ## BarrageState
1469
-
1470
-
1471
- Bullet screen message management module
1472
- - Core features: Process text messages and custom messages in the live streaming room, support barrage sending, message status synchronization and complete danmaku system, provide local notification.
1473
-
1474
-
1475
- - Technical features: Support advanced functions like high-concurrency message processing, real-time message synchronization, message filtering, and emoji pack support. Newly-added API functions: sendTextMessage, sendCustomMessage, appendLocalTip.
1476
-
1477
-
1478
- - Business value: Provide core interactive capabilities for the live streaming platform, enhance user engagement and communication environment.
1479
-
1480
-
1481
- - Application scenarios: bullet screen interaction, message management, emoji pack, chat room, and other social interactive scenarios.
1482
-
1483
-
1484
-
1485
-
1486
- responsive data
1487
-
1488
-
1489
- <table>
1490
- <tr>
1491
- <td rowspan="1" colSpan="1" >**Data List**</td>
1492
-
1493
-
1494
- <td rowspan="1" colSpan="1" >**Description**</td>
1495
- </tr>
1496
-
1497
-
1498
- <tr>
1499
- <td rowspan="1" colSpan="1" >[messageList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#messageList)</td>
1500
-
1501
-
1502
- <td rowspan="1" colSpan="1" >Barrage message list.</td>
1503
- </tr>
1504
- </table>
1505
-
1506
-
1507
-
1508
-
1509
- API Function
1510
-
1511
-
1512
- <table>
1513
- <tr>
1514
- <td rowspan="1" colSpan="1" >**Function list**</td>
1515
-
1516
-
1517
- <td rowspan="1" colSpan="1" >**Description**</td>
1518
- </tr>
1519
-
1520
-
1521
- <tr>
1522
- <td rowspan="1" colSpan="1" >[sendTextMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#sendTextMessage)</td>
1523
-
1524
-
1525
- <td rowspan="1" colSpan="1" >Send text message.</td>
1526
- </tr>
1527
-
1528
-
1529
- <tr>
1530
- <td rowspan="1" colSpan="1" >[sendCustomMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#sendCustomMessage)</td>
1531
-
1532
-
1533
- <td rowspan="1" colSpan="1" >Send custom messages.</td>
1534
- </tr>
1535
-
1536
-
1537
- <tr>
1538
- <td rowspan="1" colSpan="1" >[appendLocalTip](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#appendLocalTip)</td>
1539
-
1540
-
1541
- <td rowspan="1" colSpan="1" >Add local prompt.</td>
1542
- </tr>
1543
- </table>
1544
-
1545
-
1546
-
1547
-
1548
- ## MessageListState
1549
-
1550
-
1551
- Message List Management Module
1552
- - Core features: Manage chat message list, support message loading, scroll control, read receipt, and highlight for complete display functionality.
1553
-
1554
-
1555
- - Technical features: Support high-performance message processing like virtual scrolling, message optimization, and real-time update. Newly-added responsive data: activeConversationID, messageList, hasMoreOlderMessage.
1556
-
1557
-
1558
- - Business value: Provide core message display capacity for Chat to underwrite a good chat experience.
1559
-
1560
-
1561
- - Application scenarios: Chat, group chat, private chat, and message management in communication scenarios.
1562
-
1563
-
1564
-
1565
-
1566
- responsive data
1567
-
1568
-
1569
- <table>
1570
- <tr>
1571
- <td rowspan="1" colSpan="1" >**Data List**</td>
1572
-
1573
-
1574
- <td rowspan="1" colSpan="1" >**Description**</td>
1575
- </tr>
1576
-
1577
-
1578
- <tr>
1579
- <td rowspan="1" colSpan="1" >[activeConversationID](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#activeConversationID)</td>
1580
-
1581
-
1582
- <td rowspan="1" colSpan="1" >Current active session ID.</td>
1583
- </tr>
1584
-
1585
-
1586
- <tr>
1587
- <td rowspan="1" colSpan="1" >[messageList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#messageList)</td>
1588
-
1589
-
1590
- <td rowspan="1" colSpan="1" >Message list data.</td>
1591
- </tr>
1592
-
1593
-
1594
- <tr>
1595
- <td rowspan="1" colSpan="1" >[hasMoreOlderMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#hasMoreOlderMessage)</td>
1596
-
1597
-
1598
- <td rowspan="1" colSpan="1" >Whether there are more old messages.</td>
1599
- </tr>
1600
-
1601
-
1602
- <tr>
1603
- <td rowspan="1" colSpan="1" >[hasMoreNewerMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#hasMoreNewerMessage)</td>
1604
-
1605
-
1606
- <td rowspan="1" colSpan="1" >Whether there are more new messages.</td>
1607
- </tr>
1608
-
1609
-
1610
- <tr>
1611
- <td rowspan="1" colSpan="1" >[enableReadReceipt](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#enableReadReceipt)</td>
1612
-
1613
-
1614
- <td rowspan="1" colSpan="1" >Whether to enable read receipt.</td>
1615
- </tr>
1616
-
1617
-
1618
- <tr>
1619
- <td rowspan="1" colSpan="1" >[isDisableScroll](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isDisableScroll)</td>
1620
-
1621
-
1622
- <td rowspan="1" colSpan="1" >Whether to disable scrolling.</td>
1623
- </tr>
1624
-
1625
-
1626
- <tr>
1627
- <td rowspan="1" colSpan="1" >[recalledMessageIDSet](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#recalledMessageIDSet)</td>
1628
-
1629
-
1630
- <td rowspan="1" colSpan="1" >ID set of recalled messages.</td>
1631
- </tr>
1632
-
1633
-
1634
- <tr>
1635
- <td rowspan="1" colSpan="1" >[highlightMessageIDSet](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#highlightMessageIDSet)</td>
1636
-
1637
-
1638
- <td rowspan="1" colSpan="1" >ID set of highlight messages.</td>
1639
- </tr>
1640
- </table>
1641
-
1642
-
1643
-
1644
-
1645
- API Function
1646
-
1647
-
1648
- <table>
1649
- <tr>
1650
- <td rowspan="1" colSpan="1" >**Function list**</td>
1651
-
1652
-
1653
- <td rowspan="1" colSpan="1" >**Description**</td>
1654
- </tr>
1655
-
1656
-
1657
- <tr>
1658
- <td rowspan="1" colSpan="1" >[setEnableReadReceipt](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setEnableReadReceipt)</td>
1659
-
1660
-
1661
- <td rowspan="1" colSpan="1" >Set read receipt.</td>
1662
- </tr>
1663
-
1664
-
1665
- <tr>
1666
- <td rowspan="1" colSpan="1" >[setIsDisableScroll](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setIsDisableScroll)</td>
1667
-
1668
-
1669
- <td rowspan="1" colSpan="1" >Disable scrolling.</td>
1670
- </tr>
1671
-
1672
-
1673
- <tr>
1674
- <td rowspan="1" colSpan="1" >[highlightMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#highlightMessage)</td>
1675
-
1676
-
1677
- <td rowspan="1" colSpan="1" >Highlight message.</td>
1678
- </tr>
1679
- </table>
1680
-
1681
-
1682
-
1683
-
1684
- ## MessageInputState
1685
-
1686
-
1687
- Message Input Management Module
1688
- - Core features: Manage the state and behavior of the message input box, support text input, emoji pack, @feature, input state notification, and complete input experience.
1689
-
1690
-
1691
- - Technical features: Support rich text editing, input state synchronization, draft saving, and other features. Newly-added responsive data: inputRawValue, isPeerTyping.
1692
-
1693
-
1694
- - Business value: Provide users with a convenient message input experience to enhance communication efficiency.
1695
-
1696
-
1697
- - Application scenarios: Message editing, emoji input, file sending, and voice input in input scenarios.
1698
-
1699
-
1700
-
1701
-
1702
- responsive data
1703
-
1704
-
1705
- <table>
1706
- <tr>
1707
- <td rowspan="1" colSpan="1" >**Data List**</td>
1708
-
1709
-
1710
- <td rowspan="1" colSpan="1" >**Description**</td>
1711
- </tr>
1712
-
1713
-
1714
- <tr>
1715
- <td rowspan="1" colSpan="1" >[inputRawValue](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#inputRawValue)</td>
1716
-
1717
-
1718
- <td rowspan="1" colSpan="1" >Original text content of the input box.</td>
1719
- </tr>
1720
-
1721
-
1722
- <tr>
1723
- <td rowspan="1" colSpan="1" >[isPeerTyping](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isPeerTyping)</td>
1724
-
1725
-
1726
- <td rowspan="1" colSpan="1" >Whether the other party is typing.</td>
1727
- </tr>
1728
- </table>
1729
-
1730
-
1731
-
1732
-
1733
- API Function
1734
-
1735
-
1736
- <table>
1737
- <tr>
1738
- <td rowspan="1" colSpan="1" >**Function list**</td>
1739
-
1740
-
1741
- <td rowspan="1" colSpan="1" >**Description**</td>
1742
- </tr>
1743
-
1744
-
1745
- <tr>
1746
- <td rowspan="1" colSpan="1" >[updateRawValue](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateRawValue)</td>
1747
-
1748
-
1749
- <td rowspan="1" colSpan="1" >Refresh original value.</td>
1750
- </tr>
1751
-
1752
-
1753
- <tr>
1754
- <td rowspan="1" colSpan="1" >[setEditorInstance](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setEditorInstance)</td>
1755
-
1756
-
1757
- <td rowspan="1" colSpan="1" >Set the editor instance.</td>
1758
- </tr>
1759
-
1760
-
1761
- <tr>
1762
- <td rowspan="1" colSpan="1" >[setContent](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setContent)</td>
1763
-
1764
-
1765
- <td rowspan="1" colSpan="1" >Set Content.</td>
1766
- </tr>
1767
-
1768
-
1769
- <tr>
1770
- <td rowspan="1" colSpan="1" >[insertContent](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#insertContent)</td>
1771
-
1772
-
1773
- <td rowspan="1" colSpan="1" >Insert content.</td>
1774
- </tr>
1775
-
1776
-
1777
- <tr>
1778
- <td rowspan="1" colSpan="1" >[focusEditor](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#focusEditor)</td>
1779
-
1780
-
1781
- <td rowspan="1" colSpan="1" >Focus editor.</td>
1782
- </tr>
1783
-
1784
-
1785
- <tr>
1786
- <td rowspan="1" colSpan="1" >[blurEditor](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#blurEditor)</td>
1787
-
1788
-
1789
- <td rowspan="1" colSpan="1" >Blur editor.</td>
1790
- </tr>
1791
-
1792
-
1793
- <tr>
1794
- <td rowspan="1" colSpan="1" >[sendMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#sendMessage)</td>
1795
-
1796
-
1797
- <td rowspan="1" colSpan="1" >Send message.</td>
1798
- </tr>
1799
- </table>
1800
-
1801
-
1802
-
1803
-
1804
- ## MessageActionState
1805
-
1806
-
1807
- Message Operation Management Module
1808
- - Core features: Manage various operations of messages, including forward, refer, copy, delete, and revoke for complete message operation functionality.
1809
-
1810
-
1811
- - Technical features: Support batch operations, status management, permission control, and other features. Newly-added responsive data: forwardMessageIDList, isForwardMessageSelectionDone.
1812
-
1813
-
1814
- - Business value: Provide users with various message operation capabilities to enhance user experience.
1815
-
1816
-
1817
- - Application scenarios: Message forwarding, message quotation, message management, batch operation, and other scenarios.
1818
-
1819
-
1820
-
1821
-
1822
- responsive data
1823
-
1824
-
1825
- <table>
1826
- <tr>
1827
- <td rowspan="1" colSpan="1" >**Data List**</td>
1828
-
1829
-
1830
- <td rowspan="1" colSpan="1" >**Description**</td>
1831
- </tr>
1832
-
1833
-
1834
- <tr>
1835
- <td rowspan="1" colSpan="1" >[forwardMessageIDList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#forwardMessageIDList)</td>
1836
-
1837
-
1838
- <td rowspan="1" colSpan="1" >ID list of messages to forward.</td>
1839
- </tr>
1840
-
1841
-
1842
- <tr>
1843
- <td rowspan="1" colSpan="1" >[isForwardMessageSelectionDone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isForwardMessageSelectionDone)</td>
1844
-
1845
-
1846
- <td rowspan="1" colSpan="1" >Whether message forwarding is completed.</td>
1847
- </tr>
1848
-
1849
-
1850
- <tr>
1851
- <td rowspan="1" colSpan="1" >[forwardConversationIDList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#forwardConversationIDList)</td>
1852
-
1853
-
1854
- <td rowspan="1" colSpan="1" >ID list of forwarding target sessions.</td>
1855
- </tr>
1856
-
1857
-
1858
- <tr>
1859
- <td rowspan="1" colSpan="1" >[quotedMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#quotedMessage)</td>
1860
-
1861
-
1862
- <td rowspan="1" colSpan="1" >Referenced message info.</td>
1863
- </tr>
1864
- </table>
1865
-
1866
-
1867
-
1868
-
1869
- API Function
1870
-
1871
-
1872
- <table>
1873
- <tr>
1874
- <td rowspan="1" colSpan="1" >**Function list**</td>
1875
-
1876
-
1877
- <td rowspan="1" colSpan="1" >**Description**</td>
1878
- </tr>
1879
-
1880
-
1881
- <tr>
1882
- <td rowspan="1" colSpan="1" >[forwardMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#forwardMessage)</td>
1883
-
1884
-
1885
- <td rowspan="1" colSpan="1" >Forward message.</td>
1886
- </tr>
1887
-
1888
-
1889
- <tr>
1890
- <td rowspan="1" colSpan="1" >[setForwardMessageIDList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setForwardMessageIDList)</td>
1891
-
1892
-
1893
- <td rowspan="1" colSpan="1" >Set forwarding message list.</td>
1894
- </tr>
1895
-
1896
-
1897
- <tr>
1898
- <td rowspan="1" colSpan="1" >[setIsForwardMessageSelectionDone](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setIsForwardMessageSelectionDone)</td>
1899
-
1900
-
1901
- <td rowspan="1" colSpan="1" >Forward selection is completed.</td>
1902
- </tr>
1903
-
1904
-
1905
- <tr>
1906
- <td rowspan="1" colSpan="1" >[setForwardConversationIDList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setForwardConversationIDList)</td>
1907
-
1908
-
1909
- <td rowspan="1" colSpan="1" >Set forwarding session list.</td>
1910
- </tr>
1911
-
1912
-
1913
- <tr>
1914
- <td rowspan="1" colSpan="1" >[quoteMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#quoteMessage)</td>
1915
-
1916
-
1917
- <td rowspan="1" colSpan="1" >Quoted message.</td>
1918
- </tr>
1919
-
1920
-
1921
- <tr>
1922
- <td rowspan="1" colSpan="1" >[clearQuotedMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#clearQuotedMessage)</td>
1923
-
1924
-
1925
- <td rowspan="1" colSpan="1" >Clear quoted message.</td>
1926
- </tr>
1927
-
1928
-
1929
- <tr>
1930
- <td rowspan="1" colSpan="1" >[copyTextMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#copyTextMessage)</td>
1931
-
1932
-
1933
- <td rowspan="1" colSpan="1" >Copy text message.</td>
1934
- </tr>
1935
-
1936
-
1937
- <tr>
1938
- <td rowspan="1" colSpan="1" >[deleteMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#deleteMessage)</td>
1939
-
1940
-
1941
- <td rowspan="1" colSpan="1" >Delete message.</td>
1942
- </tr>
1943
-
1944
-
1945
- <tr>
1946
- <td rowspan="1" colSpan="1" >[recallMessage](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#recallMessage)</td>
1947
-
1948
-
1949
- <td rowspan="1" colSpan="1" >Recall message.</td>
1950
- </tr>
1951
-
1952
-
1953
- <tr>
1954
- <td rowspan="1" colSpan="1" >[resetMessageActionState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#resetMessageActionState)</td>
1955
-
1956
-
1957
- <td rowspan="1" colSpan="1" >Reset message operation status.</td>
1958
- </tr>
1959
- </table>
1960
-
1961
-
1962
-
1963
-
1964
- ## ConversationListState
1965
-
1966
-
1967
- Session List Management Module
1968
- - Core features: Manage user session list, support session sorting, unread statistics, and conversation action for complete session management functionality.
1969
-
1970
-
1971
- - Technical features: Support real-time session update, intelligent sorting, network status monitoring and other features. Newly-added responsive data: conversationList, activeConversation, totalUnRead, netStatus.
1972
-
1973
-
1974
- - Business value: Provide users with a clear session management interface to enhance communication efficiency.
1975
-
1976
-
1977
- - Application scenarios: Session management, contact list, group management, message center, and other scenarios.
1978
-
1979
-
1980
-
1981
-
1982
- responsive data
1983
-
1984
-
1985
- <table>
1986
- <tr>
1987
- <td rowspan="1" colSpan="1" >**Data List**</td>
1988
-
1989
-
1990
- <td rowspan="1" colSpan="1" >**Description**</td>
1991
- </tr>
1992
-
1993
-
1994
- <tr>
1995
- <td rowspan="1" colSpan="1" >[conversationList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#conversationList)</td>
1996
-
1997
-
1998
- <td rowspan="1" colSpan="1" >Conversation list data.</td>
1999
- </tr>
2000
-
2001
-
2002
- <tr>
2003
- <td rowspan="1" colSpan="1" >[activeConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#activeConversation)</td>
2004
-
2005
-
2006
- <td rowspan="1" colSpan="1" >Current active session.</td>
2007
- </tr>
2008
-
2009
-
2010
- <tr>
2011
- <td rowspan="1" colSpan="1" >[totalUnRead](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#totalUnRead)</td>
2012
-
2013
-
2014
- <td rowspan="1" colSpan="1" >Total unread count.</td>
2015
- </tr>
2016
-
2017
-
2018
- <tr>
2019
- <td rowspan="1" colSpan="1" >[netStatus](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#netStatus)</td>
2020
-
2021
-
2022
- <td rowspan="1" colSpan="1" >Network connection status.</td>
2023
- </tr>
2024
- </table>
2025
-
2026
-
2027
-
2028
-
2029
- API Function
2030
-
2031
-
2032
- <table>
2033
- <tr>
2034
- <td rowspan="1" colSpan="1" >**Function list**</td>
2035
-
2036
-
2037
- <td rowspan="1" colSpan="1" >**Description**</td>
2038
- </tr>
2039
-
2040
-
2041
- <tr>
2042
- <td rowspan="1" colSpan="1" >[markConversationUnread](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#markConversationUnread)</td>
2043
-
2044
-
2045
- <td rowspan="1" colSpan="1" >Mark conversation as unread.</td>
2046
- </tr>
2047
-
2048
-
2049
- <tr>
2050
- <td rowspan="1" colSpan="1" >[setActiveConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setActiveConversation)</td>
2051
-
2052
-
2053
- <td rowspan="1" colSpan="1" >Set active session.</td>
2054
- </tr>
2055
-
2056
-
2057
- <tr>
2058
- <td rowspan="1" colSpan="1" >[pinConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#pinConversation)</td>
2059
-
2060
-
2061
- <td rowspan="1" colSpan="1" >Pin conversation to top.</td>
2062
- </tr>
2063
-
2064
-
2065
- <tr>
2066
- <td rowspan="1" colSpan="1" >[deleteConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#deleteConversation)</td>
2067
-
2068
-
2069
- <td rowspan="1" colSpan="1" >Delete conversation.</td>
2070
- </tr>
2071
-
2072
-
2073
- <tr>
2074
- <td rowspan="1" colSpan="1" >[muteConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#muteConversation)</td>
2075
-
2076
-
2077
- <td rowspan="1" colSpan="1" >Mute session.</td>
2078
- </tr>
2079
-
2080
-
2081
- <tr>
2082
- <td rowspan="1" colSpan="1" >[setConversationDraft](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setConversationDraft)</td>
2083
-
2084
-
2085
- <td rowspan="1" colSpan="1" >Set session draft.</td>
2086
- </tr>
2087
-
2088
-
2089
- <tr>
2090
- <td rowspan="1" colSpan="1" >[createC2CConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#createC2CConversation)</td>
2091
-
2092
-
2093
- <td rowspan="1" colSpan="1" >Create one-on-one chat session.</td>
2094
- </tr>
2095
-
2096
-
2097
- <tr>
2098
- <td rowspan="1" colSpan="1" >[createGroupConversation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#createGroupConversation)</td>
2099
-
2100
-
2101
- <td rowspan="1" colSpan="1" >Create group chat session.</td>
2102
- </tr>
2103
- </table>
2104
-
2105
-
2106
-
2107
-
2108
- ## ContactListState
2109
-
2110
-
2111
- Contact Management Module
2112
- - Core features: Manage user contact list, including friend management, chat group management, and blocklist management for complete contact feature.
2113
-
2114
-
2115
- - Technical features: Support contact group, Friend request processing, group application management and other features. Newly-added responsive data: friendList, groupList, blackList, and complete contact operation API.
2116
-
2117
-
2118
- - Business value: Provides users with complete social relationship management capability to build a social network.
2119
-
2120
-
2121
- - Application scenarios: Friend management, group management, contact search, social network, and other scenarios.
2122
-
2123
-
2124
-
2125
-
2126
- responsive data
2127
-
2128
-
2129
- <table>
2130
- <tr>
2131
- <td rowspan="1" colSpan="1" >**Data List**</td>
2132
-
2133
-
2134
- <td rowspan="1" colSpan="1" >**Description**</td>
2135
- </tr>
2136
-
2137
-
2138
- <tr>
2139
- <td rowspan="1" colSpan="1" >[friendList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#friendList)</td>
2140
-
2141
-
2142
- <td rowspan="1" colSpan="1" >Friend list.</td>
2143
- </tr>
2144
-
2145
-
2146
- <tr>
2147
- <td rowspan="1" colSpan="1" >[groupList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupList)</td>
2148
-
2149
-
2150
- <td rowspan="1" colSpan="1" >Group list.</td>
2151
- </tr>
2152
-
2153
-
2154
- <tr>
2155
- <td rowspan="1" colSpan="1" >[blackList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#blackList)</td>
2156
-
2157
-
2158
- <td rowspan="1" colSpan="1" >Blocklist.</td>
2159
- </tr>
2160
-
2161
-
2162
- <tr>
2163
- <td rowspan="1" colSpan="1" >[friendApplicationUnreadCount](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#friendApplicationUnreadCount)</td>
2164
-
2165
-
2166
- <td rowspan="1" colSpan="1" >Friend request unread.</td>
2167
- </tr>
2168
-
2169
-
2170
- <tr>
2171
- <td rowspan="1" colSpan="1" >[friendGroupList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#friendGroupList)</td>
2172
-
2173
-
2174
- <td rowspan="1" colSpan="1" >Friend group list.</td>
2175
- </tr>
2176
-
2177
-
2178
- <tr>
2179
- <td rowspan="1" colSpan="1" >[friendApplicationList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#friendApplicationList)</td>
2180
-
2181
-
2182
- <td rowspan="1" colSpan="1" >Friend request list.</td>
2183
- </tr>
2184
-
2185
-
2186
- <tr>
2187
- <td rowspan="1" colSpan="1" >[groupApplicationList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupApplicationList)</td>
2188
-
2189
-
2190
- <td rowspan="1" colSpan="1" >Group join request list.</td>
2191
- </tr>
2192
- </table>
2193
-
2194
-
2195
-
2196
-
2197
- API Function
2198
-
2199
-
2200
- <table>
2201
- <tr>
2202
- <td rowspan="1" colSpan="1" >**Function list**</td>
2203
-
2204
-
2205
- <td rowspan="1" colSpan="1" >**Description**</td>
2206
- </tr>
2207
-
2208
-
2209
- <tr>
2210
- <td rowspan="1" colSpan="1" >[setGroupApplicationList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setGroupApplicationList)</td>
2211
-
2212
-
2213
- <td rowspan="1" colSpan="1" >Set group join request list.</td>
2214
- </tr>
2215
-
2216
-
2217
- <tr>
2218
- <td rowspan="1" colSpan="1" >[setFriendList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setFriendList)</td>
2219
-
2220
-
2221
- <td rowspan="1" colSpan="1" >Set friend list.</td>
2222
- </tr>
2223
-
2224
-
2225
- <tr>
2226
- <td rowspan="1" colSpan="1" >[setGroupList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setGroupList)</td>
2227
-
2228
-
2229
- <td rowspan="1" colSpan="1" >Set group list.</td>
2230
- </tr>
2231
-
2232
-
2233
- <tr>
2234
- <td rowspan="1" colSpan="1" >[setBlackList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setBlackList)</td>
2235
-
2236
-
2237
- <td rowspan="1" colSpan="1" >Set blocklist.</td>
2238
- </tr>
2239
-
2240
-
2241
- <tr>
2242
- <td rowspan="1" colSpan="1" >[setFriendApplicationUnreadCount](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setFriendApplicationUnreadCount)</td>
2243
-
2244
-
2245
- <td rowspan="1" colSpan="1" >Set friend request unread.</td>
2246
- </tr>
2247
-
2248
-
2249
- <tr>
2250
- <td rowspan="1" colSpan="1" >[setFriendGroupList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setFriendGroupList)</td>
2251
-
2252
-
2253
- <td rowspan="1" colSpan="1" >Set friend group list.</td>
2254
- </tr>
2255
-
2256
-
2257
- <tr>
2258
- <td rowspan="1" colSpan="1" >[setFriendApplicationList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setFriendApplicationList)</td>
2259
-
2260
-
2261
- <td rowspan="1" colSpan="1" >Set friend request list.</td>
2262
- </tr>
2263
-
2264
-
2265
- <tr>
2266
- <td rowspan="1" colSpan="1" >[initContactListWatcher](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initContactListWatcher)</td>
2267
-
2268
-
2269
- <td rowspan="1" colSpan="1" >Initialize contact person listener.</td>
2270
- </tr>
2271
-
2272
-
2273
- <tr>
2274
- <td rowspan="1" colSpan="1" >[addFriend](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#addFriend)</td>
2275
-
2276
-
2277
- <td rowspan="1" colSpan="1" >Add friend.</td>
2278
- </tr>
2279
-
2280
-
2281
- <tr>
2282
- <td rowspan="1" colSpan="1" >[markFriendApplicationAsRead](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#markFriendApplicationAsRead)</td>
2283
-
2284
-
2285
- <td rowspan="1" colSpan="1" >Tag friend request as read.</td>
2286
- </tr>
2287
-
2288
-
2289
- <tr>
2290
- <td rowspan="1" colSpan="1" >[acceptFriendApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptFriendApplication)</td>
2291
-
2292
-
2293
- <td rowspan="1" colSpan="1" >Accept friend request.</td>
2294
- </tr>
2295
-
2296
-
2297
- <tr>
2298
- <td rowspan="1" colSpan="1" >[refuseFriendApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#refuseFriendApplication)</td>
2299
-
2300
-
2301
- <td rowspan="1" colSpan="1" >Refuse friend application.</td>
2302
- </tr>
2303
-
2304
-
2305
- <tr>
2306
- <td rowspan="1" colSpan="1" >[addToBlacklist](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#addToBlacklist)</td>
2307
-
2308
-
2309
- <td rowspan="1" colSpan="1" >Add to blocklist.</td>
2310
- </tr>
2311
-
2312
-
2313
- <tr>
2314
- <td rowspan="1" colSpan="1" >[removeFromBlacklist](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#removeFromBlacklist)</td>
2315
-
2316
-
2317
- <td rowspan="1" colSpan="1" >Remove from blocklist.</td>
2318
- </tr>
2319
-
2320
-
2321
- <tr>
2322
- <td rowspan="1" colSpan="1" >[deleteFriend](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#deleteFriend)</td>
2323
-
2324
-
2325
- <td rowspan="1" colSpan="1" >Delete friend.</td>
2326
- </tr>
2327
-
2328
-
2329
- <tr>
2330
- <td rowspan="1" colSpan="1" >[setFriendRemark](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setFriendRemark)</td>
2331
-
2332
-
2333
- <td rowspan="1" colSpan="1" >Set friend remark.</td>
2334
- </tr>
2335
-
2336
-
2337
- <tr>
2338
- <td rowspan="1" colSpan="1" >[createFriendGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#createFriendGroup)</td>
2339
-
2340
-
2341
- <td rowspan="1" colSpan="1" >Create friend group.</td>
2342
- </tr>
2343
-
2344
-
2345
- <tr>
2346
- <td rowspan="1" colSpan="1" >[deleteFriendGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#deleteFriendGroup)</td>
2347
-
2348
-
2349
- <td rowspan="1" colSpan="1" >Delete friend group.</td>
2350
- </tr>
2351
-
2352
-
2353
- <tr>
2354
- <td rowspan="1" colSpan="1" >[addToFriendGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#addToFriendGroup)</td>
2355
-
2356
-
2357
- <td rowspan="1" colSpan="1" >Add to friend group.</td>
2358
- </tr>
2359
-
2360
-
2361
- <tr>
2362
- <td rowspan="1" colSpan="1" >[removeFromFriendGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#removeFromFriendGroup)</td>
2363
-
2364
-
2365
- <td rowspan="1" colSpan="1" >Remove from friend group.</td>
2366
- </tr>
2367
-
2368
-
2369
- <tr>
2370
- <td rowspan="1" colSpan="1" >[renameFriendGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#renameFriendGroup)</td>
2371
-
2372
-
2373
- <td rowspan="1" colSpan="1" >Rename friend group.</td>
2374
- </tr>
2375
-
2376
-
2377
- <tr>
2378
- <td rowspan="1" colSpan="1" >[joinGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#joinGroup)</td>
2379
-
2380
-
2381
- <td rowspan="1" colSpan="1" >Join group.</td>
2382
- </tr>
2383
-
2384
-
2385
- <tr>
2386
- <td rowspan="1" colSpan="1" >[acceptGroupApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#acceptGroupApplication)</td>
2387
-
2388
-
2389
- <td rowspan="1" colSpan="1" >Accept group request.</td>
2390
- </tr>
2391
-
2392
-
2393
- <tr>
2394
- <td rowspan="1" colSpan="1" >[refuseGroupApplication](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#refuseGroupApplication)</td>
2395
-
2396
-
2397
- <td rowspan="1" colSpan="1" >Reject group request.</td>
2398
- </tr>
2399
- </table>
2400
-
2401
-
2402
-
2403
-
2404
- ## C2CSettingState
2405
-
2406
-
2407
- C2C Chat Settings Management Module
2408
- - Core features: Manage various settings for C2C Chat, including user information, chat settings, and permission control.
2409
-
2410
-
2411
- - Technical features: Support real-time set synchronization, permission management, personalized configuration, and other features. Update responsive data to standardized fields such as userID, avatar, and signature.
2412
-
2413
-
2414
- - Business value: Provide users with a personalized C2C Chat experience to enhance communication quality.
2415
-
2416
-
2417
- - Application scenarios: C2C chat settings, user information management, and permission control in chat scenarios.
2418
-
2419
-
2420
-
2421
-
2422
- responsive data
2423
-
2424
-
2425
- <table>
2426
- <tr>
2427
- <td rowspan="1" colSpan="1" >**Data List**</td>
2428
-
2429
-
2430
- <td rowspan="1" colSpan="1" >**Description**</td>
2431
- </tr>
2432
-
2433
-
2434
- <tr>
2435
- <td rowspan="1" colSpan="1" >[currentConversationRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentConversationRef)</td>
2436
-
2437
-
2438
- <td rowspan="1" colSpan="1" >Current session reference.</td>
2439
- </tr>
2440
-
2441
-
2442
- <tr>
2443
- <td rowspan="1" colSpan="1" >[userIDRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#userIDRef)</td>
2444
-
2445
-
2446
- <td rowspan="1" colSpan="1" >User ID.</td>
2447
- </tr>
2448
-
2449
-
2450
- <tr>
2451
- <td rowspan="1" colSpan="1" >[nickRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#nickRef)</td>
2452
-
2453
-
2454
- <td rowspan="1" colSpan="1" >User nickname.</td>
2455
- </tr>
2456
-
2457
-
2458
- <tr>
2459
- <td rowspan="1" colSpan="1" >[avatarRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#avatarRef)</td>
2460
-
2461
-
2462
- <td rowspan="1" colSpan="1" >User profile photo.</td>
2463
- </tr>
2464
-
2465
-
2466
- <tr>
2467
- <td rowspan="1" colSpan="1" >[signatureRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#signatureRef)</td>
2468
-
2469
-
2470
- <td rowspan="1" colSpan="1" >User personal signature.</td>
2471
- </tr>
2472
-
2473
-
2474
- <tr>
2475
- <td rowspan="1" colSpan="1" >[remarkRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#remarkRef)</td>
2476
-
2477
-
2478
- <td rowspan="1" colSpan="1" >Friend remark name.</td>
2479
- </tr>
2480
-
2481
-
2482
- <tr>
2483
- <td rowspan="1" colSpan="1" >[isMutedRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isMutedRef)</td>
2484
-
2485
-
2486
- <td rowspan="1" colSpan="1" >Session mute status.</td>
2487
- </tr>
2488
-
2489
-
2490
- <tr>
2491
- <td rowspan="1" colSpan="1" >[isPinnedRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isPinnedRef)</td>
2492
-
2493
-
2494
- <td rowspan="1" colSpan="1" >Session pinning status.</td>
2495
- </tr>
2496
-
2497
-
2498
- <tr>
2499
- <td rowspan="1" colSpan="1" >[isContactRef](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isContactRef)</td>
2500
-
2501
-
2502
- <td rowspan="1" colSpan="1" >Friend relationship status.</td>
2503
- </tr>
2504
-
2505
-
2506
- <tr>
2507
- <td rowspan="1" colSpan="1" >[userID](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#userID)</td>
2508
-
2509
-
2510
- <td rowspan="1" colSpan="1" >User ID.</td>
2511
- </tr>
2512
-
2513
-
2514
- <tr>
2515
- <td rowspan="1" colSpan="1" >[avatar](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#avatar)</td>
2516
-
2517
-
2518
- <td rowspan="1" colSpan="1" >User avatar URL.</td>
2519
- </tr>
2520
-
2521
-
2522
- <tr>
2523
- <td rowspan="1" colSpan="1" >[signature](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#signature)</td>
2524
-
2525
-
2526
- <td rowspan="1" colSpan="1" >User personal signature.</td>
2527
- </tr>
2528
-
2529
-
2530
- <tr>
2531
- <td rowspan="1" colSpan="1" >[remark](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#remark)</td>
2532
-
2533
-
2534
- <td rowspan="1" colSpan="1" >User remark name.</td>
2535
- </tr>
2536
-
2537
-
2538
- <tr>
2539
- <td rowspan="1" colSpan="1" >[isMuted](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isMuted)</td>
2540
-
2541
-
2542
- <td rowspan="1" colSpan="1" >Whether muted.</td>
2543
- </tr>
2544
-
2545
-
2546
- <tr>
2547
- <td rowspan="1" colSpan="1" >[isPinned](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isPinned)</td>
2548
-
2549
-
2550
- <td rowspan="1" colSpan="1" >Whether pinned to top.</td>
2551
- </tr>
2552
-
2553
-
2554
- <tr>
2555
- <td rowspan="1" colSpan="1" >[isContact](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isContact)</td>
2556
-
2557
-
2558
- <td rowspan="1" colSpan="1" >Whether it is the contact person.</td>
2559
- </tr>
2560
- </table>
2561
-
2562
-
2563
-
2564
-
2565
- API Function
2566
-
2567
-
2568
- <table>
2569
- <tr>
2570
- <td rowspan="1" colSpan="1" >**Function list**</td>
2571
-
2572
-
2573
- <td rowspan="1" colSpan="1" >**Description**</td>
2574
- </tr>
2575
-
2576
-
2577
- <tr>
2578
- <td rowspan="1" colSpan="1" >[setChatPinned](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setChatPinned)</td>
2579
-
2580
-
2581
- <td rowspan="1" colSpan="1" >Pin chat to top.</td>
2582
- </tr>
2583
-
2584
-
2585
- <tr>
2586
- <td rowspan="1" colSpan="1" >[setChatMuted](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setChatMuted)</td>
2587
-
2588
-
2589
- <td rowspan="1" colSpan="1" >Enable Do Not Disturb for chat.</td>
2590
- </tr>
2591
-
2592
-
2593
- <tr>
2594
- <td rowspan="1" colSpan="1" >[setUserRemark](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setUserRemark)</td>
2595
-
2596
-
2597
- <td rowspan="1" colSpan="1" >Set user remark.</td>
2598
- </tr>
2599
- </table>
2600
-
2601
-
2602
-
2603
-
2604
- ## GroupSettingState
2605
-
2606
-
2607
- Group chat settings management module
2608
- -Core features: Manage various group chat settings and operations, including information management, member management, permission control, and complete group management capabilities.
2609
-
2610
-
2611
- - Technical features: Support group permission management, member operations, group set sync and other features. Newly-added responsive data: groupID, groupType, groupName, and complete group information response and management API.
2612
-
2613
-
2614
- - Business value: Provides group owners and admins with complete group management capability to maintain order.
2615
-
2616
-
2617
- - Application scenarios: Group management, member management, permission control, group settings, and other scenarios.
2618
-
2619
-
2620
-
2621
-
2622
- responsive data
2623
-
2624
-
2625
- <table>
2626
- <tr>
2627
- <td rowspan="1" colSpan="1" >**Data List**</td>
2628
-
2629
-
2630
- <td rowspan="1" colSpan="1" >**Description**</td>
2631
- </tr>
2632
-
2633
-
2634
- <tr>
2635
- <td rowspan="1" colSpan="1" >[groupID](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupID)</td>
2636
-
2637
-
2638
- <td rowspan="1" colSpan="1" >Group ID.</td>
2639
- </tr>
2640
-
2641
-
2642
- <tr>
2643
- <td rowspan="1" colSpan="1" >[groupType](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupType)</td>
2644
-
2645
-
2646
- <td rowspan="1" colSpan="1" >Group type.</td>
2647
- </tr>
2648
-
2649
-
2650
- <tr>
2651
- <td rowspan="1" colSpan="1" >[groupName](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupName)</td>
2652
-
2653
-
2654
- <td rowspan="1" colSpan="1" >Group name.</td>
2655
- </tr>
2656
-
2657
-
2658
- <tr>
2659
- <td rowspan="1" colSpan="1" >[avatar](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#avatar)</td>
2660
-
2661
-
2662
- <td rowspan="1" colSpan="1" >User avatar URL.</td>
2663
- </tr>
2664
-
2665
-
2666
- <tr>
2667
- <td rowspan="1" colSpan="1" >[introduction](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#introduction)</td>
2668
-
2669
-
2670
- <td rowspan="1" colSpan="1" >Group introduction.</td>
2671
- </tr>
2672
-
2673
-
2674
- <tr>
2675
- <td rowspan="1" colSpan="1" >[notification](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#notification)</td>
2676
-
2677
-
2678
- <td rowspan="1" colSpan="1" >Group notice.</td>
2679
- </tr>
2680
-
2681
-
2682
- <tr>
2683
- <td rowspan="1" colSpan="1" >[isMuted](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isMuted)</td>
2684
-
2685
-
2686
- <td rowspan="1" colSpan="1" >Whether muted.</td>
2687
- </tr>
2688
-
2689
-
2690
- <tr>
2691
- <td rowspan="1" colSpan="1" >[isPinned](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isPinned)</td>
2692
-
2693
-
2694
- <td rowspan="1" colSpan="1" >Whether pinned to top.</td>
2695
- </tr>
2696
-
2697
-
2698
- <tr>
2699
- <td rowspan="1" colSpan="1" >[groupOwner](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#groupOwner)</td>
2700
-
2701
-
2702
- <td rowspan="1" colSpan="1" >Group owner info.</td>
2703
- </tr>
2704
-
2705
-
2706
- <tr>
2707
- <td rowspan="1" colSpan="1" >[adminMembers](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#adminMembers)</td>
2708
-
2709
-
2710
- <td rowspan="1" colSpan="1" >Administrator list.</td>
2711
- </tr>
2712
-
2713
-
2714
- <tr>
2715
- <td rowspan="1" colSpan="1" >[allMembers](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#allMembers)</td>
2716
-
2717
-
2718
- <td rowspan="1" colSpan="1" >All member list.</td>
2719
- </tr>
2720
-
2721
-
2722
- <tr>
2723
- <td rowspan="1" colSpan="1" >[memberCount](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#memberCount)</td>
2724
-
2725
-
2726
- <td rowspan="1" colSpan="1" >Total number of members.</td>
2727
- </tr>
2728
-
2729
-
2730
- <tr>
2731
- <td rowspan="1" colSpan="1" >[maxMemberCount](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#maxMemberCount)</td>
2732
-
2733
-
2734
- <td rowspan="1" colSpan="1" >Maximum number of members.</td>
2735
- </tr>
2736
-
2737
-
2738
- <tr>
2739
- <td rowspan="1" colSpan="1" >[currentUserID](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentUserID)</td>
2740
-
2741
-
2742
- <td rowspan="1" colSpan="1" >Current user ID.</td>
2743
- </tr>
2744
-
2745
-
2746
- <tr>
2747
- <td rowspan="1" colSpan="1" >[currentUserRole](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentUserRole)</td>
2748
-
2749
-
2750
- <td rowspan="1" colSpan="1" >Current user role.</td>
2751
- </tr>
2752
-
2753
-
2754
- <tr>
2755
- <td rowspan="1" colSpan="1" >[nameCard](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#nameCard)</td>
2756
-
2757
-
2758
- <td rowspan="1" colSpan="1" >Name card.</td>
2759
- </tr>
2760
-
2761
-
2762
- <tr>
2763
- <td rowspan="1" colSpan="1" >[isMuteAllMembers](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isMuteAllMembers)</td>
2764
-
2765
-
2766
- <td rowspan="1" colSpan="1" >Whether to mute all members.</td>
2767
- </tr>
2768
-
2769
-
2770
- <tr>
2771
- <td rowspan="1" colSpan="1" >[isInGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isInGroup)</td>
2772
-
2773
-
2774
- <td rowspan="1" colSpan="1" >Whether in the group.</td>
2775
- </tr>
2776
-
2777
-
2778
- <tr>
2779
- <td rowspan="1" colSpan="1" >[inviteOption](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#inviteOption)</td>
2780
-
2781
-
2782
- <td rowspan="1" colSpan="1" >InviteOption.</td>
2783
- </tr>
2784
- </table>
2785
-
2786
-
2787
-
2788
-
2789
- API Function
2790
-
2791
-
2792
- <table>
2793
- <tr>
2794
- <td rowspan="1" colSpan="1" >**Function list**</td>
2795
-
2796
-
2797
- <td rowspan="1" colSpan="1" >**Description**</td>
2798
- </tr>
2799
-
2800
-
2801
- <tr>
2802
- <td rowspan="1" colSpan="1" >[getGroupMemberList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getGroupMemberList)</td>
2803
-
2804
-
2805
- <td rowspan="1" colSpan="1" >Get Group Member list.</td>
2806
- </tr>
2807
-
2808
-
2809
- <tr>
2810
- <td rowspan="1" colSpan="1" >[updateGroupProfile](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateGroupProfile)</td>
2811
-
2812
-
2813
- <td rowspan="1" colSpan="1" >Refresh group information.</td>
2814
- </tr>
2815
-
2816
-
2817
- <tr>
2818
- <td rowspan="1" colSpan="1" >[addGroupMember](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#addGroupMember)</td>
2819
-
2820
-
2821
- <td rowspan="1" colSpan="1" >Add Group Member.</td>
2822
- </tr>
2823
-
2824
-
2825
- <tr>
2826
- <td rowspan="1" colSpan="1" >[deleteGroupMember](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#deleteGroupMember)</td>
2827
-
2828
-
2829
- <td rowspan="1" colSpan="1" >Delete group member.</td>
2830
- </tr>
2831
-
2832
-
2833
- <tr>
2834
- <td rowspan="1" colSpan="1" >[changeGroupOwner](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#changeGroupOwner)</td>
2835
-
2836
-
2837
- <td rowspan="1" colSpan="1" >Transfer Group Ownership.</td>
2838
- </tr>
2839
-
2840
-
2841
- <tr>
2842
- <td rowspan="1" colSpan="1" >[setGroupMemberRole](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setGroupMemberRole)</td>
2843
-
2844
-
2845
- <td rowspan="1" colSpan="1" >Set group member role.</td>
2846
- </tr>
2847
-
2848
-
2849
- <tr>
2850
- <td rowspan="1" colSpan="1" >[setGroupMemberNameCard](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setGroupMemberNameCard)</td>
2851
-
2852
-
2853
- <td rowspan="1" colSpan="1" >Set group member name card.</td>
2854
- </tr>
2855
-
2856
-
2857
- <tr>
2858
- <td rowspan="1" colSpan="1" >[setChatPinned](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setChatPinned)</td>
2859
-
2860
-
2861
- <td rowspan="1" colSpan="1" >Pin chat to top.</td>
2862
- </tr>
2863
-
2864
-
2865
- <tr>
2866
- <td rowspan="1" colSpan="1" >[setChatMuted](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setChatMuted)</td>
2867
-
2868
-
2869
- <td rowspan="1" colSpan="1" >Enable Do Not Disturb for chat.</td>
2870
- </tr>
2871
-
2872
-
2873
- <tr>
2874
- <td rowspan="1" colSpan="1" >[setGroupMemberMuteTime](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setGroupMemberMuteTime)</td>
2875
-
2876
-
2877
- <td rowspan="1" colSpan="1" >Mute group member.</td>
2878
- </tr>
2879
-
2880
-
2881
- <tr>
2882
- <td rowspan="1" colSpan="1" >[setMuteAllMember](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setMuteAllMember)</td>
2883
-
2884
-
2885
- <td rowspan="1" colSpan="1" >Enable room-wide mute.</td>
2886
- </tr>
2887
-
2888
-
2889
- <tr>
2890
- <td rowspan="1" colSpan="1" >[dismissGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#dismissGroup)</td>
2891
-
2892
-
2893
- <td rowspan="1" colSpan="1" >Disband group.</td>
2894
- </tr>
2895
-
2896
-
2897
- <tr>
2898
- <td rowspan="1" colSpan="1" >[quitGroup](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#quitGroup)</td>
2899
-
2900
-
2901
- <td rowspan="1" colSpan="1" >Leave Group.</td>
2902
- </tr>
2903
-
2904
-
2905
- <tr>
2906
- <td rowspan="1" colSpan="1" >[hasPermission](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#hasPermission)</td>
2907
-
2908
-
2909
- <td rowspan="1" colSpan="1" >Check permission.</td>
2910
- </tr>
2911
-
2912
-
2913
- <tr>
2914
- <td rowspan="1" colSpan="1" >[canOperateOnMember](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#canOperateOnMember)</td>
2915
-
2916
-
2917
- <td rowspan="1" colSpan="1" >Check member operation permissions.</td>
2918
- </tr>
2919
-
2920
-
2921
- <tr>
2922
- <td rowspan="1" colSpan="1" >[getAvailablePermissions](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getAvailablePermissions)</td>
2923
-
2924
-
2925
- <td rowspan="1" colSpan="1" >Get available permissions.</td>
2926
- </tr>
2927
-
2928
-
2929
- <tr>
2930
- <td rowspan="1" colSpan="1" >[initWatcher](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initWatcher)</td>
2931
-
2932
-
2933
- <td rowspan="1" colSpan="1" >Initialize listener.</td>
2934
- </tr>
2935
- </table>
2936
-
2937
-
2938
-
2939
-
2940
- ## VideoMixerState
2941
-
2942
-
2943
- Video stream mixing management module
2944
- -Core feature: Manage video stream mixing functionality, support advanced video processing such as multiple streams video compositing, layout management, and media source control.
2945
-
2946
-
2947
- - Technical features: Support real-time video stream mixing, dynamic layout adjustment, media source management and other features. Newly-added isVideoMixerEnabled, mediaSourceList, activeMediaSource responsive data and complete control interface.
2948
-
2949
-
2950
- - Business value: The platform offers professional video production capabilities to enhance live streaming quality.
2951
-
2952
-
2953
- - Application scenarios: Scenarios such as multi-person live streaming, Picture-in-Picture, video compositing, and professional production.
2954
-
2955
-
2956
-
2957
-
2958
- responsive data
2959
-
2960
-
2961
- <table>
2962
- <tr>
2963
- <td rowspan="1" colSpan="1" >**Data List**</td>
2964
-
2965
-
2966
- <td rowspan="1" colSpan="1" >**Description**</td>
2967
- </tr>
2968
-
2969
-
2970
- <tr>
2971
- <td rowspan="1" colSpan="1" >[publishVideoQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#publishVideoQuality)</td>
2972
-
2973
-
2974
- <td rowspan="1" colSpan="1" >Get size based on resolution.</td>
2975
- </tr>
2976
-
2977
-
2978
- <tr>
2979
- <td rowspan="1" colSpan="1" >[isVideoMixerEnabled](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isVideoMixerEnabled)</td>
2980
-
2981
-
2982
- <td rowspan="1" colSpan="1" >Whether video stream mixing is enabled.</td>
2983
- </tr>
2984
-
2985
-
2986
- <tr>
2987
- <td rowspan="1" colSpan="1" >[mediaSourceList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#mediaSourceList)</td>
2988
-
2989
-
2990
- <td rowspan="1" colSpan="1" >Media source list.</td>
2991
- </tr>
2992
-
2993
-
2994
- <tr>
2995
- <td rowspan="1" colSpan="1" >[activeMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#activeMediaSource)</td>
2996
-
2997
-
2998
- <td rowspan="1" colSpan="1" >Currently active media source.</td>
2999
- </tr>
3000
- </table>
3001
-
3002
-
3003
-
3004
-
3005
- API Function
3006
-
3007
-
3008
- <table>
3009
- <tr>
3010
- <td rowspan="1" colSpan="1" >**Function list**</td>
3011
-
3012
-
3013
- <td rowspan="1" colSpan="1" >**Description**</td>
3014
- </tr>
3015
-
3016
-
3017
- <tr>
3018
- <td rowspan="1" colSpan="1" >[getVideoDataByQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getVideoDataByQuality)</td>
3019
-
3020
-
3021
- <td rowspan="1" colSpan="1" >Get video data based on quality.</td>
3022
- </tr>
3023
-
3024
-
3025
- <tr>
3026
- <td rowspan="1" colSpan="1" >[getSizeByQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getSizeByQuality)</td>
3027
-
3028
-
3029
- <td rowspan="1" colSpan="1" >Get size based on quality.</td>
3030
- </tr>
3031
-
3032
-
3033
- <tr>
3034
- <td rowspan="1" colSpan="1" >[getSizeByResolution](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getSizeByResolution)</td>
3035
-
3036
-
3037
- <td rowspan="1" colSpan="1" >Get size based on resolution.</td>
3038
- </tr>
3039
-
3040
-
3041
- <tr>
3042
- <td rowspan="1" colSpan="1" >[transformTUIVideoQualityToTRTCVideoResolution](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#transformTUIVideoQualityToTRTCVideoResolution)</td>
3043
-
3044
-
3045
- <td rowspan="1" colSpan="1" >Switch video quality to TRTC resolution.</td>
3046
- </tr>
3047
-
3048
-
3049
- <tr>
3050
- <td rowspan="1" colSpan="1" >[transformTRTCVideoResolutionToTUIVideoQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#transformTRTCVideoResolutionToTUIVideoQuality)</td>
3051
-
3052
-
3053
- <td rowspan="1" colSpan="1" >Switch TRTC resolution to video quality.</td>
3054
- </tr>
3055
-
3056
-
3057
- <tr>
3058
- <td rowspan="1" colSpan="1" >[transformTRTCVideoResModeToTUIVideoResMode](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#transformTRTCVideoResModeToTUIVideoResMode)</td>
3059
-
3060
-
3061
- <td rowspan="1" colSpan="1" >Switch TRTC resolution mode.</td>
3062
- </tr>
3063
-
3064
-
3065
- <tr>
3066
- <td rowspan="1" colSpan="1" >[changeActiveMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#changeActiveMediaSource)</td>
3067
-
3068
-
3069
- <td rowspan="1" colSpan="1" >Switch active media source.</td>
3070
- </tr>
3071
-
3072
-
3073
- <tr>
3074
- <td rowspan="1" colSpan="1" >[updateVideoQuality](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateVideoQuality)</td>
3075
-
3076
-
3077
- <td rowspan="1" colSpan="1" >Refresh video quality.</td>
3078
- </tr>
3079
-
3080
-
3081
- <tr>
3082
- <td rowspan="1" colSpan="1" >[getDefaultLayoutByMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getDefaultLayoutByMediaSource)</td>
3083
-
3084
-
3085
- <td rowspan="1" colSpan="1" >Get default layout based on media source.</td>
3086
- </tr>
3087
-
3088
-
3089
- <tr>
3090
- <td rowspan="1" colSpan="1" >[addMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#addMediaSource)</td>
3091
-
3092
-
3093
- <td rowspan="1" colSpan="1" >Add media source.</td>
3094
- </tr>
3095
-
3096
-
3097
- <tr>
3098
- <td rowspan="1" colSpan="1" >[updateMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#updateMediaSource)</td>
3099
-
3100
-
3101
- <td rowspan="1" colSpan="1" >Refresh media source.</td>
3102
- </tr>
3103
-
3104
-
3105
- <tr>
3106
- <td rowspan="1" colSpan="1" >[removeMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#removeMediaSource)</td>
3107
-
3108
-
3109
- <td rowspan="1" colSpan="1" >Remove media source.</td>
3110
- </tr>
3111
-
3112
-
3113
- <tr>
3114
- <td rowspan="1" colSpan="1" >[enableLocalVideoMixer](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#enableLocalVideoMixer)</td>
3115
-
3116
-
3117
- <td rowspan="1" colSpan="1" >Enable local video stream mixing.</td>
3118
- </tr>
3119
-
3120
-
3121
- <tr>
3122
- <td rowspan="1" colSpan="1" >[clearMediaSource](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#clearMediaSource)</td>
3123
-
3124
-
3125
- <td rowspan="1" colSpan="1" >Clear ALL media sources.</td>
3126
- </tr>
3127
-
3128
-
3129
- <tr>
3130
- <td rowspan="1" colSpan="1" >[initMediaSourceManager](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initMediaSourceManager)</td>
3131
-
3132
-
3133
- <td rowspan="1" colSpan="1" >Initialize media source manager.</td>
3134
- </tr>
3135
-
3136
-
3137
- <tr>
3138
- <td rowspan="1" colSpan="1" >[initVideoMixerState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initVideoMixerState)</td>
3139
-
3140
-
3141
- <td rowspan="1" colSpan="1" >Initialize video mixing status.</td>
3142
- </tr>
3143
- </table>
3144
-
3145
-
3146
-
3147
-
3148
- ## VirtualBackgroundState
3149
-
3150
-
3151
- Virtual Background Management Module
3152
- -Core features: Manage the virtual background feature, supporting background replacement, background blurring, and custom background for video beautification.
3153
-
3154
-
3155
- - Technical features: Real-time background segmentation and replacement based on AI technology. Newly-added virtualBackgroundConfig responsive data and isSupported, setVirtualBackground API functions.
3156
-
3157
-
3158
- - Business value: Provides users with privacy protection and video beautification features to enhance the video call experience.
3159
-
3160
-
3161
- - Application scenarios: Video call, online meeting, live stream beautification, privacy protection, and other scenarios.
3162
-
3163
-
3164
-
3165
-
3166
- responsive data
3167
-
3168
-
3169
- <table>
3170
- <tr>
3171
- <td rowspan="1" colSpan="1" >**Data List**</td>
3172
-
3173
-
3174
- <td rowspan="1" colSpan="1" >**Description**</td>
3175
- </tr>
3176
-
3177
-
3178
- <tr>
3179
- <td rowspan="1" colSpan="1" >[virtualBackgroundConfig](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#virtualBackgroundConfig)</td>
3180
-
3181
-
3182
- <td rowspan="1" colSpan="1" >Virtual background configuration.</td>
3183
- </tr>
3184
- </table>
3185
-
3186
-
3187
-
3188
-
3189
- API Function
3190
-
3191
-
3192
- <table>
3193
- <tr>
3194
- <td rowspan="1" colSpan="1" >**Function list**</td>
3195
-
3196
-
3197
- <td rowspan="1" colSpan="1" >**Description**</td>
3198
- </tr>
3199
-
3200
-
3201
- <tr>
3202
- <td rowspan="1" colSpan="1" >[initVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initVirtualBackground)</td>
3203
-
3204
-
3205
- <td rowspan="1" colSpan="1" >Initialize virtual background.</td>
3206
- </tr>
3207
-
3208
-
3209
- <tr>
3210
- <td rowspan="1" colSpan="1" >[saveVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#saveVirtualBackground)</td>
3211
-
3212
-
3213
- <td rowspan="1" colSpan="1" >Save virtual background.</td>
3214
- </tr>
3215
-
3216
-
3217
- <tr>
3218
- <td rowspan="1" colSpan="1" >[isSupported](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isSupported)</td>
3219
-
3220
-
3221
- <td rowspan="1" colSpan="1" >Check whether it is supported.</td>
3222
- </tr>
3223
-
3224
-
3225
- <tr>
3226
- <td rowspan="1" colSpan="1" >[setVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setVirtualBackground)</td>
3227
-
3228
-
3229
- <td rowspan="1" colSpan="1" >Set virtual background.</td>
3230
- </tr>
3231
- </table>
3232
-
3233
-
3234
-
3235
-
3236
- ## ASRState
3237
-
3238
-
3239
- Automatic Speech Recognition (ASR) management module
3240
- - Core features: Manage Automatic Speech Recognition (ASR), support real-time voice-to-text, history management, export and other features.
3241
-
3242
-
3243
- - Technical features: Based on advanced ASR technology, support language recognition, real-time transcription, history and other features. Newly-added responsive data: recentTranscripts, transcriptHistory and API: exportTranscripts.
3244
-
3245
-
3246
- - Business value: Provide users with speech-to-text service to enhance communication efficiency and accessibility.
3247
-
3248
-
3249
- - Application scenarios: Meeting minutes, speech transcription, barrier-free communication, content recording, and other scenarios.
3250
-
3251
-
3252
-
3253
-
3254
- responsive data
3255
-
3256
-
3257
- <table>
3258
- <tr>
3259
- <td rowspan="1" colSpan="1" >**Data List**</td>
3260
-
3261
-
3262
- <td rowspan="1" colSpan="1" >**Description**</td>
3263
- </tr>
3264
-
3265
-
3266
- <tr>
3267
- <td rowspan="1" colSpan="1" >[recentTranscripts](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#recentTranscripts)</td>
3268
-
3269
-
3270
- <td rowspan="1" colSpan="1" >Latest speech transcription records.</td>
3271
- </tr>
3272
-
3273
-
3274
- <tr>
3275
- <td rowspan="1" colSpan="1" >[transcriptHistory](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#transcriptHistory)</td>
3276
-
3277
-
3278
- <td rowspan="1" colSpan="1" >Speech transcription history.</td>
3279
- </tr>
3280
- </table>
3281
-
3282
-
3283
-
3284
-
3285
- API Function
3286
-
3287
-
3288
- <table>
3289
- <tr>
3290
- <td rowspan="1" colSpan="1" >**Function list**</td>
3291
-
3292
-
3293
- <td rowspan="1" colSpan="1" >**Description**</td>
3294
- </tr>
3295
-
3296
-
3297
- <tr>
3298
- <td rowspan="1" colSpan="1" >[setRecentTranscriptsDuration](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setRecentTranscriptsDuration)</td>
3299
-
3300
-
3301
- <td rowspan="1" colSpan="1" >Set the most recent transcription duration.</td>
3302
- </tr>
3303
-
3304
-
3305
- <tr>
3306
- <td rowspan="1" colSpan="1" >[clearHistory](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#clearHistory)</td>
3307
-
3308
-
3309
- <td rowspan="1" colSpan="1" >Clear transcription history.</td>
3310
- </tr>
3311
-
3312
-
3313
- <tr>
3314
- <td rowspan="1" colSpan="1" >[exportTranscripts](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#exportTranscripts)</td>
3315
-
3316
-
3317
- <td rowspan="1" colSpan="1" >Export transcribed content.</td>
3318
- </tr>
3319
- </table>
3320
-
3321
-
3322
-
3323
-
3324
- ## SearchState
3325
-
3326
-
3327
- Search functionality management module
3328
- -Core feature: Manage global search functionality, supporting message search, user search, group search, and other multidimensional search capabilities.
3329
-
3330
-
3331
- - Technical feature: Support advanced search, search history, search suggestions, and other features. Reconstruct responsive data into standardized fields like keyword, results, isLoading, and provide a complete search interface.
3332
-
3333
-
3334
- - Business value: Provide users with quick search ability to enhance usage efficiency.
3335
-
3336
-
3337
- - Application scenarios: Message search, contact search, content search, history records, and other scenarios.
3338
-
3339
-
3340
-
3341
-
3342
- responsive data
3343
-
3344
-
3345
- <table>
3346
- <tr>
3347
- <td rowspan="1" colSpan="1" >**Data List**</td>
3348
-
3349
-
3350
- <td rowspan="1" colSpan="1" >**Description**</td>
3351
- </tr>
3352
-
3353
-
3354
- <tr>
3355
- <td rowspan="1" colSpan="1" >[keyword](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#keyword)</td>
3356
-
3357
-
3358
- <td rowspan="1" colSpan="1" >Search keywords.</td>
3359
- </tr>
3360
-
3361
-
3362
- <tr>
3363
- <td rowspan="1" colSpan="1" >[results](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#results)</td>
3364
-
3365
-
3366
- <td rowspan="1" colSpan="1" >Search result.</td>
3367
- </tr>
3368
-
3369
-
3370
- <tr>
3371
- <td rowspan="1" colSpan="1" >[isLoading](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#isLoading)</td>
3372
-
3373
-
3374
- <td rowspan="1" colSpan="1" >Whether loading.</td>
3375
- </tr>
3376
-
3377
-
3378
- <tr>
3379
- <td rowspan="1" colSpan="1" >[error](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#error)</td>
3380
-
3381
-
3382
- <td rowspan="1" colSpan="1" >Error Message.</td>
3383
- </tr>
3384
-
3385
-
3386
- <tr>
3387
- <td rowspan="1" colSpan="1" >[searchAdvancedParams](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#searchAdvancedParams)</td>
3388
-
3389
-
3390
- <td rowspan="1" colSpan="1" >Advanced search parameter.</td>
3391
- </tr>
3392
-
3393
-
3394
- <tr>
3395
- <td rowspan="1" colSpan="1" >[selectedSearchType](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#selectedSearchType)</td>
3396
-
3397
-
3398
- <td rowspan="1" colSpan="1" >Selected search type.</td>
3399
- </tr>
3400
- </table>
3401
-
3402
-
3403
-
3404
-
3405
- API Function
3406
-
3407
-
3408
- <table>
3409
- <tr>
3410
- <td rowspan="1" colSpan="1" >**Function list**</td>
3411
-
3412
-
3413
- <td rowspan="1" colSpan="1" >**Description**</td>
3414
- </tr>
3415
-
3416
-
3417
- <tr>
3418
- <td rowspan="1" colSpan="1" >[search](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#search)</td>
3419
-
3420
-
3421
- <td rowspan="1" colSpan="1" >Search.</td>
3422
- </tr>
3423
-
3424
-
3425
- <tr>
3426
- <td rowspan="1" colSpan="1" >[setKeyword](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setKeyword)</td>
3427
-
3428
-
3429
- <td rowspan="1" colSpan="1" >Set keyword.</td>
3430
- </tr>
3431
-
3432
-
3433
- <tr>
3434
- <td rowspan="1" colSpan="1" >[setSelectedType](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setSelectedType)</td>
3435
-
3436
-
3437
- <td rowspan="1" colSpan="1" >Set selected type.</td>
3438
- </tr>
3439
-
3440
-
3441
- <tr>
3442
- <td rowspan="1" colSpan="1" >[setSearchMessageAdvancedParams](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setSearchMessageAdvancedParams)</td>
3443
-
3444
-
3445
- <td rowspan="1" colSpan="1" >Set advanced message search parameters.</td>
3446
- </tr>
3447
-
3448
-
3449
- <tr>
3450
- <td rowspan="1" colSpan="1" >[setSearchUserAdvancedParams](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setSearchUserAdvancedParams)</td>
3451
-
3452
-
3453
- <td rowspan="1" colSpan="1" >Set advanced user search parameters.</td>
3454
- </tr>
3455
-
3456
-
3457
- <tr>
3458
- <td rowspan="1" colSpan="1" >[setSearchGroupAdvancedParams](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setSearchGroupAdvancedParams)</td>
3459
-
3460
-
3461
- <td rowspan="1" colSpan="1" >Set advanced group search parameters.</td>
3462
- </tr>
3463
-
3464
-
3465
- <tr>
3466
- <td rowspan="1" colSpan="1" >[loadMore](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#loadMore)</td>
3467
-
3468
-
3469
- <td rowspan="1" colSpan="1" >Load more.</td>
3470
- </tr>
3471
- </table>
3472
-
3473
-
3474
-
3475
-
3476
- ## SeatStore
3477
-
3478
-
3479
- Seat Storage Management Module
3480
- -Core features: Provide underlying storage and management for seat status, support core features such as seat information cache, user information map, and device request handling.
3481
-
3482
-
3483
- - Technical features: Use responsive storage design, support real-time status synchronization, event-driven updates, and other features. Add newly-added responsive data such as liveOwnerUserId, localUserId, seatList, and APIs like getUserInfo and convertUserInfoToAudienceInfo.
3484
-
3485
-
3486
- - Business value: Provide a reliable data foundation for seat management and ensure seat status consistency.
3487
-
3488
-
3489
- - Application scenarios: Seat status management, user information storage, device status tracking, and other underlying scenarios.
3490
-
3491
-
3492
-
3493
-
3494
- responsive data
3495
-
3496
-
3497
- <table>
3498
- <tr>
3499
- <td rowspan="1" colSpan="1" >**Data List**</td>
3500
-
3501
-
3502
- <td rowspan="1" colSpan="1" >**Description**</td>
3503
- </tr>
3504
-
3505
-
3506
- <tr>
3507
- <td rowspan="1" colSpan="1" >[liveOwnerUserId](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#liveOwnerUserId)</td>
3508
-
3509
-
3510
- <td rowspan="1" colSpan="1" >Anchor user ID in the live streaming room.</td>
3511
- </tr>
3512
-
3513
-
3514
- <tr>
3515
- <td rowspan="1" colSpan="1" >[localUserId](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#localUserId)</td>
3516
-
3517
-
3518
- <td rowspan="1" colSpan="1" >Local User ID.</td>
3519
- </tr>
3520
-
3521
-
3522
- <tr>
3523
- <td rowspan="1" colSpan="1" >[seatList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#seatList)</td>
3524
-
3525
-
3526
- <td rowspan="1" colSpan="1" >Microphone position list, including ALL seat states and user information.</td>
3527
- </tr>
3528
-
3529
-
3530
- <tr>
3531
- <td rowspan="1" colSpan="1" >[coHostUserList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#coHostUserList)</td>
3532
-
3533
-
3534
- <td rowspan="1" colSpan="1" >Anchor list for mic connection.</td>
3535
- </tr>
3536
-
3537
-
3538
- <tr>
3539
- <td rowspan="1" colSpan="1" >[sentDeviceRequestMap](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#sentDeviceRequestMap)</td>
3540
-
3541
-
3542
- <td rowspan="1" colSpan="1" >Request mapping sent to the device.</td>
3543
- </tr>
3544
-
3545
-
3546
- <tr>
3547
- <td rowspan="1" colSpan="1" >[receivedDeviceRequestMap](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#receivedDeviceRequestMap)</td>
3548
-
3549
-
3550
- <td rowspan="1" colSpan="1" >Request mapping received from the device.</td>
3551
- </tr>
3552
-
3553
-
3554
- <tr>
3555
- <td rowspan="1" colSpan="1" >[userInfoMap](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#userInfoMap)</td>
3556
-
3557
-
3558
- <td rowspan="1" colSpan="1" >User information mapping table.</td>
3559
- </tr>
3560
- </table>
3561
-
3562
-
3563
-
3564
-
3565
- API Function
3566
-
3567
-
3568
- <table>
3569
- <tr>
3570
- <td rowspan="1" colSpan="1" >Function list</td>
3571
-
3572
-
3573
- <td rowspan="1" colSpan="1" >Description</td>
3574
- </tr>
3575
-
3576
-
3577
- <tr>
3578
- <td rowspan="1" colSpan="1" >[getUserInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#getUserInfo)</td>
3579
-
3580
-
3581
- <td rowspan="1" colSpan="1" >Retrieve user information.</td>
3582
- </tr>
3583
-
3584
-
3585
- <tr>
3586
- <td rowspan="1" colSpan="1" >[convertUserInfoToAudienceInfo](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#convertUserInfoToAudienceInfo)</td>
3587
-
3588
-
3589
- <td rowspan="1" colSpan="1" >Switch user information to audience information.</td>
3590
- </tr>
3591
- </table>