@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
@@ -2,324 +2,69 @@
2
2
  ## Overview
3
3
  `ITRTCStatistics.h` provides read-only statistics for TRTC Real-Time Communication (TRTC SDK) on C++. The TRTC SDK reports real-time audio and video metrics—including frame rate, bitrate, and stutter status—every two seconds.
4
4
 
5
-
6
5
  ## Struct Type
7
- <table>
8
- <tr>
9
- <td rowspan="1" colSpan="1" >Function List</td>
10
-
11
- <td rowspan="1" colSpan="1" >Description</td>
12
- </tr>
13
-
14
- <tr>
15
- <td rowspan="1" colSpan="1" >[TRTCLocalStatistics](https://write.woa.com/document/87030057818304512)</td>
16
-
17
- <td rowspan="1" colSpan="1" >Local Audio and Video Statistics</td>
18
- </tr>
19
-
20
- <tr>
21
- <td rowspan="1" colSpan="1" >[TRTCRemoteStatistics](https://write.woa.com/document/87030057818304512)</td>
22
-
23
- <td rowspan="1" colSpan="1" >Remote Audio and Video Statistics</td>
24
- </tr>
25
-
26
- <tr>
27
- <td rowspan="1" colSpan="1" >[TRTCStatistics](https://write.woa.com/document/87030057818304512)</td>
28
-
29
- <td rowspan="1" colSpan="1" >Summary Statistics of Network and Performance</td>
30
- </tr>
31
- </table>
32
-
6
+ | Function List | Description |
7
+ | --- | --- |
8
+ | TRTCLocalStatistics | Local Audio and Video Statistics |
9
+ | TRTCRemoteStatistics | Remote Audio and Video Statistics |
10
+ | TRTCStatistics | Summary Statistics of Network and Performance |
33
11
 
34
12
  ## TRTCLocalStatistics
35
13
 
36
-
37
-
38
14
  #### Local Audio and Video Statistics
39
- <table>
40
- <tr>
41
- <td rowspan="1" colSpan="1" >Enumeration Types</td>
42
-
43
- <td rowspan="1" colSpan="1" >Description</td>
44
- </tr>
45
-
46
- <tr>
47
- <td rowspan="1" colSpan="1" >audioBitrate</td>
48
-
49
- <td rowspan="1" colSpan="1" >[Field Meaning] Local audio bitrate, that is, how much new audio data is generated per second, in Kbps.</td>
50
- </tr>
51
-
52
- <tr>
53
- <td rowspan="1" colSpan="1" >audioCaptureState</td>
54
-
55
- <td rowspan="1" colSpan="1" >[Field Meaning] Audio device collection status (used to detect the health of audio peripherals).<br>0: Collection Device Status Normal; 1: Long Period of Silence Detected; 2: Crackling Sound Detected; 3: Abnormal Sound Intermittence Detected.</td>
56
- </tr>
57
-
58
- <tr>
59
- <td rowspan="1" colSpan="1" >audioSampleRate</td>
60
-
61
- <td rowspan="1" colSpan="1" >[Field Meaning] Local audio sampling rate, in Hz.</td>
62
- </tr>
63
-
64
- <tr>
65
- <td rowspan="1" colSpan="1" >frameRate</td>
66
-
67
- <td rowspan="1" colSpan="1" >[Field Meaning] Local video frame rate, that is, how many video frames per second, unit: FPS.</td>
68
- </tr>
69
-
70
- <tr>
71
- <td rowspan="1" colSpan="1" >height</td>
72
-
73
- <td rowspan="1" colSpan="1" >[Field Meaning] Local video height, in px.</td>
74
- </tr>
75
-
76
- <tr>
77
- <td rowspan="1" colSpan="1" >streamType</td>
78
-
79
- <td rowspan="1" colSpan="1" >[Field Meaning] Video stream type (HD large screen \| Low-definition Small Picture \| Auxiliary Stream Picture).</td>
80
- </tr>
81
-
82
- <tr>
83
- <td rowspan="1" colSpan="1" >videoBitrate</td>
84
-
85
- <td rowspan="1" colSpan="1" >[Field Meaning] Local video bitrate, that is, how much new video data is generated per second, in Kbps.</td>
86
- </tr>
87
-
88
- <tr>
89
- <td rowspan="1" colSpan="1" >width</td>
90
-
91
- <td rowspan="1" colSpan="1" >[Field Meaning] Local video width, in pixels (px).</td>
92
- </tr>
93
- </table>
94
-
15
+ | Enumeration Types | Description |
16
+ | --- | --- |
17
+ | audioBitrate | [Field Meaning] Local audio bitrate, that is, how much new audio data is generated per second, in Kbps. |
18
+ | audioCaptureState | [Field Meaning] Audio device collection status (used to detect the health of audio peripherals).<br>0: Collection Device Status Normal; 1: Long Period of Silence Detected; 2: Crackling Sound Detected; 3: Abnormal Sound Intermittence Detected. |
19
+ | audioSampleRate | [Field Meaning] Local audio sampling rate, in Hz. |
20
+ | frameRate | [Field Meaning] Local video frame rate, that is, how many video frames per second, unit: FPS. |
21
+ | height | [Field Meaning] Local video height, in px. |
22
+ | streamType | [Field Meaning] Video stream type (HD large screen \\| Low-definition Small Picture \\| Auxiliary Stream Picture). |
23
+ | videoBitrate | [Field Meaning] Local video bitrate, that is, how much new video data is generated per second, in Kbps. |
24
+ | width | [Field Meaning] Local video width, in pixels (px). |
95
25
 
96
26
  ## TRTCRemoteStatistics
97
27
 
98
-
99
-
100
28
  #### Remote Audio and Video Statistics
101
- <table>
102
- <tr>
103
- <td rowspan="1" colSpan="1" >Enumeration Types</td>
104
-
105
- <td rowspan="1" colSpan="1" >Description</td>
106
- </tr>
107
-
108
- <tr>
109
- <td rowspan="1" colSpan="1" >audioBitrate</td>
110
-
111
- <td rowspan="1" colSpan="1" >[Field Meaning] Local audio bitrate, in Kbps</td>
112
- </tr>
113
-
114
- <tr>
115
- <td rowspan="1" colSpan="1" >audioBlockRate</td>
116
-
117
- <td rowspan="1" colSpan="1" >[Field Meaning] Audio playback stuttering rate, in percentage (%)<br>Audio playback stuttering rate (audioBlockRate) = cumulative stuttering duration during audio playback (audioTotalBlockTime) / total duration of audio playback</td>
118
- </tr>
119
-
120
- <tr>
121
- <td rowspan="1" colSpan="1" >audioPacketLoss</td>
122
-
123
- <td rowspan="1" colSpan="1" >[Field Meaning] Total audio stream packet loss rate (%).<br>audioPacketLoss represents the packet loss rate at the audience end after an audio stream completes the transmission chain from ` Broadcaster > Cloud > Audience `.<br>The smaller the audioPacketLoss, the better. A packet loss rate of 0 means all audio stream data has been completely received by the audience.<br>If downLoss == 0 but audioPacketLoss != 0 occurs, it indicates that the audio stream has no packet loss on the "cloud=>audience" segment, but there is irrecoverable packet loss on the ` host>cloud ` segment.</td>
124
- </tr>
125
-
126
- <tr>
127
- <td rowspan="1" colSpan="1" >audioSampleRate</td>
128
-
129
- <td rowspan="1" colSpan="1" >[Field Meaning] Local audio sampling rate, in Hz.</td>
130
- </tr>
131
-
132
- <tr>
133
- <td rowspan="1" colSpan="1" >audioTotalBlockTime</td>
134
-
135
- <td rowspan="1" colSpan="1" >[Field Meaning] Cumulative stuttering duration during audio playback, in milliseconds (ms)</td>
136
- </tr>
137
-
138
- <tr>
139
- <td rowspan="1" colSpan="1" >finalLoss</td>
140
-
141
- <td rowspan="1" colSpan="1" >[Field Meaning] Overall packet loss rate of the audio and video stream (%). Deprecated; it is recommended to use audioPacketLoss and videoPacketLoss instead.</td>
142
- </tr>
143
-
144
- <tr>
145
- <td rowspan="1" colSpan="1" >frameRate</td>
146
-
147
- <td rowspan="1" colSpan="1" >[Field Meaning] Remote video frame rate, in FPS.</td>
148
- </tr>
149
-
150
- <tr>
151
- <td rowspan="1" colSpan="1" >height</td>
152
-
153
- <td rowspan="1" colSpan="1" >[Field Meaning] Remote video height, in pixels (px).</td>
154
- </tr>
155
-
156
- <tr>
157
- <td rowspan="1" colSpan="1" >jitterBufferDelay</td>
158
-
159
- <td rowspan="1" colSpan="1" >[Field Meaning] Playback latency, in milliseconds (ms)<br>To avoid audio and screen freezing caused by network jitter and packet disorder, TRTC manages a playback buffer at the playback end to organize received network packets. The size of this buffer is adaptively adjusted based on current network quality. This buffer size is translated into a time length in milliseconds, referred to as jitterBufferDelay.</td>
160
- </tr>
161
-
162
- <tr>
163
- <td rowspan="1" colSpan="1" >point2PointDelay</td>
164
-
165
- <td rowspan="1" colSpan="1" >[Field Meaning] End-to-end latency, in milliseconds (ms)<br>point2PointDelay represents the delay from "Anchors => Cloud => Audience". More precisely, it represents the full-link latency of "Collection => Encoding => Network Transmission => Receive => Buffering => Decoding => Play".<br>point2PointDelay requires both local and remote SDKs to be version 8.5 or above to be effective. If the remote user is on a version before 8.5, this value will always be 0, meaning it is not applicable.</td>
166
- </tr>
167
-
168
- <tr>
169
- <td rowspan="1" colSpan="1" >remoteNetworkRTT</td>
170
-
171
- <td rowspan="1" colSpan="1" >[Field Meaning] The round-trip time from the SDK to the cloud, in milliseconds (ms)<br>This value represents the total time it takes for a network packet to travel from the SDK to the cloud and back, summing up the "SDK => Cloud => SDK" time.<br>The smaller this value, the better: if remoteNetworkRTT < 50ms, it indicates low audio and video call latency; if remoteNetworkRTT > 200ms, it suggests high audio and video call latency.<br>It is important to note that remoteNetworkRTT represents the total time for "SDK => Cloud => SDK", so there is no need to differentiate between remoteNetworkUpRTT and remoteNetworkDownRTT</td>
172
- </tr>
173
-
174
- <tr>
175
- <td rowspan="1" colSpan="1" >remoteNetworkUplinkLoss</td>
176
-
177
- <td rowspan="1" colSpan="1" >[Field Meaning] The uplink packet loss rate from the SDK to the cloud, in percentage (%)<br>The smaller the value, the better. If remoteNetworkUplinkLoss is 0%, it means the uplink network quality is good, with almost no data packet loss when uploading to the cloud.<br>If remoteNetworkUplinkLoss is 30%, it means that 30% of the audio and video data packets sent by the SDK to the cloud are lost in the transmission link.</td>
178
- </tr>
179
-
180
- <tr>
181
- <td rowspan="1" colSpan="1" >streamType</td>
182
-
183
- <td rowspan="1" colSpan="1" >[Field Meaning] Video stream type (HD large screen \| Low-definition Small Picture \| Auxiliary Stream Picture).</td>
184
- </tr>
185
-
186
- <tr>
187
- <td rowspan="1" colSpan="1" >userId</td>
188
-
189
- <td rowspan="1" colSpan="1" >[Field Meaning] User ID</td>
190
- </tr>
191
-
192
- <tr>
193
- <td rowspan="1" colSpan="1" >videoBitrate</td>
194
-
195
- <td rowspan="1" colSpan="1" >[Field Meaning] Remote video bitrate, in Kbps.</td>
196
- </tr>
197
-
198
- <tr>
199
- <td rowspan="1" colSpan="1" >videoBlockRate</td>
200
-
201
- <td rowspan="1" colSpan="1" >[Field Meaning] Video playback stutter rate, in percentage (%). Video playback stutter rate (videoBlockRate) = cumulative stutter duration during video playback (videoTotalBlockTime) / total duration of video playback.</td>
202
- </tr>
203
-
204
- <tr>
205
- <td rowspan="1" colSpan="1" >videoPacketLoss</td>
206
-
207
- <td rowspan="1" colSpan="1" >[Field Meaning] Total packet loss rate of the video stream (%).<br>videoPacketLoss represents the packet loss rate at the audience end after the video stream completes the transmission chain from ` Anchors > Cloud > Audience `.<br>The smaller the videoPacketLoss, the better. A packet loss rate of 0 means all video stream data has been completely received by the audience.<br>If downLoss == 0 but videoPacketLoss != 0 occurs, it indicates that the video stream has no packet loss on the ` Cloud > Audience ` segment, but there is irrecoverable packet loss on the ` Anchors > Cloud ` segment.</td>
208
- </tr>
209
-
210
- <tr>
211
- <td rowspan="1" colSpan="1" >videoTotalBlockTime</td>
212
-
213
- <td rowspan="1" colSpan="1" >[Field Meaning] Cumulative stutter duration during video playback, in milliseconds (ms)</td>
214
- </tr>
215
-
216
- <tr>
217
- <td rowspan="1" colSpan="1" >width</td>
218
-
219
- <td rowspan="1" colSpan="1" >[Field Meaning] Remote video width, in pixels (px).</td>
220
- </tr>
221
- </table>
222
-
29
+ | Enumeration Types | Description |
30
+ | --- | --- |
31
+ | audioBitrate | [Field Meaning] Local audio bitrate, in Kbps |
32
+ | audioBlockRate | [Field Meaning] Audio playback stuttering rate, in percentage (%)<br>Audio playback stuttering rate (audioBlockRate) = cumulative stuttering duration during audio playback (audioTotalBlockTime) / total duration of audio playback |
33
+ | audioPacketLoss | [Field Meaning] Total audio stream packet loss rate (%).<br>audioPacketLoss represents the packet loss rate at the audience end after an audio stream completes the transmission chain from ` Broadcaster > Cloud > Audience `.<br>The smaller the audioPacketLoss, the better. A packet loss rate of 0 means all audio stream data has been completely received by the audience.<br>If downLoss == 0 but audioPacketLoss != 0 occurs, it indicates that the audio stream has no packet loss on the "cloud=>audience" segment, but there is irrecoverable packet loss on the ` host>cloud ` segment. |
34
+ | audioSampleRate | [Field Meaning] Local audio sampling rate, in Hz. |
35
+ | audioTotalBlockTime | [Field Meaning] Cumulative stuttering duration during audio playback, in milliseconds (ms) |
36
+ | finalLoss | [Field Meaning] Overall packet loss rate of the audio and video stream (%). Deprecated; it is recommended to use audioPacketLoss and videoPacketLoss instead. |
37
+ | frameRate | [Field Meaning] Remote video frame rate, in FPS. |
38
+ | height | [Field Meaning] Remote video height, in pixels (px). |
39
+ | jitterBufferDelay | [Field Meaning] Playback latency, in milliseconds (ms)<br>To avoid audio and screen freezing caused by network jitter and packet disorder, TRTC manages a playback buffer at the playback end to organize received network packets. The size of this buffer is adaptively adjusted based on current network quality. This buffer size is translated into a time length in milliseconds, referred to as jitterBufferDelay. |
40
+ | point2PointDelay | [Field Meaning] End-to-end latency, in milliseconds (ms)<br>point2PointDelay represents the delay from "Anchors => Cloud => Audience". More precisely, it represents the full-link latency of "Collection => Encoding => Network Transmission => Receive => Buffering => Decoding => Play".<br>point2PointDelay requires both local and remote SDKs to be version 8.5 or above to be effective. If the remote user is on a version before 8.5, this value will always be 0, meaning it is not applicable. |
41
+ | remoteNetworkRTT | [Field Meaning] The round-trip time from the SDK to the cloud, in milliseconds (ms)<br>This value represents the total time it takes for a network packet to travel from the SDK to the cloud and back, summing up the "SDK => Cloud => SDK" time.<br>The smaller this value, the better: if remoteNetworkRTT < 50ms, it indicates low audio and video call latency; if remoteNetworkRTT > 200ms, it suggests high audio and video call latency.<br>It is important to note that remoteNetworkRTT represents the total time for "SDK => Cloud => SDK", so there is no need to differentiate between remoteNetworkUpRTT and remoteNetworkDownRTT |
42
+ | remoteNetworkUplinkLoss | [Field Meaning] The uplink packet loss rate from the SDK to the cloud, in percentage (%)<br>The smaller the value, the better. If remoteNetworkUplinkLoss is 0%, it means the uplink network quality is good, with almost no data packet loss when uploading to the cloud.<br>If remoteNetworkUplinkLoss is 30%, it means that 30% of the audio and video data packets sent by the SDK to the cloud are lost in the transmission link. |
43
+ | streamType | [Field Meaning] Video stream type (HD large screen \\| Low-definition Small Picture \\| Auxiliary Stream Picture). |
44
+ | userId | [Field Meaning] User ID |
45
+ | videoBitrate | [Field Meaning] Remote video bitrate, in Kbps. |
46
+ | videoBlockRate | [Field Meaning] Video playback stutter rate, in percentage (%). Video playback stutter rate (videoBlockRate) = cumulative stutter duration during video playback (videoTotalBlockTime) / total duration of video playback. |
47
+ | videoPacketLoss | [Field Meaning] Total packet loss rate of the video stream (%).<br>videoPacketLoss represents the packet loss rate at the audience end after the video stream completes the transmission chain from ` Anchors > Cloud > Audience `.<br>The smaller the videoPacketLoss, the better. A packet loss rate of 0 means all video stream data has been completely received by the audience.<br>If downLoss == 0 but videoPacketLoss != 0 occurs, it indicates that the video stream has no packet loss on the ` Cloud > Audience ` segment, but there is irrecoverable packet loss on the ` Anchors > Cloud ` segment. |
48
+ | videoTotalBlockTime | [Field Meaning] Cumulative stutter duration during video playback, in milliseconds (ms) |
49
+ | width | [Field Meaning] Remote video width, in pixels (px). |
223
50
 
224
51
  ## TRTCStatistics
225
52
 
226
-
227
-
228
53
  #### Summary Statistics of Network and Performance
229
- <table>
230
- <tr>
231
- <td rowspan="1" colSpan="1" >Enumeration Types</td>
232
-
233
- <td rowspan="1" colSpan="1" >Description</td>
234
- </tr>
235
-
236
- <tr>
237
- <td rowspan="1" colSpan="1" >appCpu</td>
238
-
239
- <td rowspan="1" colSpan="1" >[Field Meaning] Current application CPU utilization, in percentage (%); not supported on Android 8.0 and above.</td>
240
- </tr>
241
-
242
- <tr>
243
- <td rowspan="1" colSpan="1" >appMemoryUsageInMB</td>
244
-
245
- <td rowspan="1" colSpan="1" >[Field Meaning] Current application memory usage, in MB.</td>
246
- </tr>
247
-
248
- <tr>
249
- <td rowspan="1" colSpan="1" >downLoss</td>
250
-
251
- <td rowspan="1" colSpan="1" >[Field Meaning] Downlink packet loss rate from the cloud to SDK, in percentage (%)<br>The smaller the value, the better. If downLoss is 0%, it means the downlink network quality is good, with almost no data packet loss from the cloud.<br>If downLoss is 30%, it means that 30% of the audio and video data packets transmitted from the cloud to the SDK are lost in the transmission link.</td>
252
- </tr>
253
-
254
- <tr>
255
- <td rowspan="1" colSpan="1" >gatewayRtt</td>
256
-
257
- <td rowspan="1" colSpan="1" >[Field Meaning] Round-trip latency from the SDK to the local router, in milliseconds (ms). This value represents the total time it takes for a network packet to travel from the SDK to the local router gateway and back, summing up the [SDK -> Gateway -> SDK] time.<br>The smaller the value, the better. If gatewayRtt < 50ms, it means lower audio and video call latency. If gatewayRtt > 200ms, it means higher audio and video call latency.<br>This value is invalid when the network type is cellular.</td>
258
- </tr>
259
-
260
- <tr>
261
- <td rowspan="1" colSpan="1" >localStatisticsArray</td>
262
-
263
- <td rowspan="1" colSpan="1" >[Field Meaning] Local audio and video statistical information<br>Since there may be three local audio and video streams (i.e., high-definition main screen, low-definition small screen, and auxiliary screen), the local audio and video statistical information is an array.</td>
264
- </tr>
265
-
266
- <tr>
267
- <td rowspan="1" colSpan="1" >localStatisticsArraySize</td>
268
-
269
- <td rowspan="1" colSpan="1" >[Field Meaning] Size of the array localStatisticsArray</td>
270
- </tr>
271
-
272
- <tr>
273
- <td rowspan="1" colSpan="1" >receivedBytes</td>
274
-
275
- <td rowspan="1" colSpan="1" >[Field Meaning] Total received bytes (including signaling data and audio and video data), in bytes.</td>
276
- </tr>
277
-
278
- <tr>
279
- <td rowspan="1" colSpan="1" >remoteStatisticsArray</td>
280
-
281
- <td rowspan="1" colSpan="1" >[Field Meaning] Remote audio and video statistical information<br>Since there may be multiple remote users at the same time, and each remote user may simultaneously have multiple audio and video streams (i.e., high-definition main screen, low-definition small screen, and auxiliary screen), the remote audio and video statistical information is an array.</td>
282
- </tr>
283
-
284
- <tr>
285
- <td rowspan="1" colSpan="1" >remoteStatisticsArraySize</td>
286
-
287
- <td rowspan="1" colSpan="1" >[Field Meaning] Size of the array remoteStatisticsArray.</td>
288
- </tr>
289
-
290
- <tr>
291
- <td rowspan="1" colSpan="1" >rtt</td>
292
-
293
- <td rowspan="1" colSpan="1" >[Field Meaning] Round-trip latency from the SDK to the cloud, in milliseconds (ms)<br>This value represents the total time it takes for a network packet to travel from the SDK to the cloud and back, summing up the "SDK => Cloud => SDK" time.<br>The smaller the value, the better: if RTT < 50ms, it means lower audio and video call latency; if RTT > 200ms, it means higher audio and video call latency.<br>It needs to be specifically explained that RTT represents the total time for "SDK => Cloud => SDK," so there is no need to distinguish between upRtt and downRtt.</td>
294
- </tr>
295
-
296
- <tr>
297
- <td rowspan="1" colSpan="1" >sentBytes</td>
298
-
299
- <td rowspan="1" colSpan="1" >[Field Meaning] Total bytes sent (including signaling data and audio and video data), in bytes (Bytes).</td>
300
- </tr>
301
-
302
- <tr>
303
- <td rowspan="1" colSpan="1" >systemCpu</td>
304
-
305
- <td rowspan="1" colSpan="1" >[Field Meaning] Current system CPU utilization, in percentage (%); not supported on Android 8.0 and above.</td>
306
- </tr>
307
-
308
- <tr>
309
- <td rowspan="1" colSpan="1" >systemMemoryInMB</td>
310
-
311
- <td rowspan="1" colSpan="1" >[Field Meaning] Current system memory, in MB.</td>
312
- </tr>
313
-
314
- <tr>
315
- <td rowspan="1" colSpan="1" >systemMemoryUsageInMB</td>
316
-
317
- <td rowspan="1" colSpan="1" >[Field Meaning] Current system memory usage, in MB, not supported on iOS/MAC.</td>
318
- </tr>
319
-
320
- <tr>
321
- <td rowspan="1" colSpan="1" >upLoss</td>
322
-
323
- <td rowspan="1" colSpan="1" >[Field Meaning] Uplink packet loss rate from the SDK to the cloud, in percentage (%)<br>The smaller the value, the better. If upLoss is 0%, it means the uplink network quality is good, with almost no data packet loss when uploading to the cloud.<br>If upLoss is 30%, it means that 30% of the audio and video data packets sent by the SDK to the cloud are lost in the transmission link.</td>
324
- </tr>
325
- </table>
54
+ | Enumeration Types | Description |
55
+ | --- | --- |
56
+ | appCpu | [Field Meaning] Current application CPU utilization, in percentage (%); not supported on Android 8.0 and above. |
57
+ | appMemoryUsageInMB | [Field Meaning] Current application memory usage, in MB. |
58
+ | downLoss | [Field Meaning] Downlink packet loss rate from the cloud to SDK, in percentage (%)<br>The smaller the value, the better. If downLoss is 0%, it means the downlink network quality is good, with almost no data packet loss from the cloud.<br>If downLoss is 30%, it means that 30% of the audio and video data packets transmitted from the cloud to the SDK are lost in the transmission link. |
59
+ | gatewayRtt | [Field Meaning] Round-trip latency from the SDK to the local router, in milliseconds (ms). This value represents the total time it takes for a network packet to travel from the SDK to the local router gateway and back, summing up the [SDK -> Gateway -> SDK] time.<br>The smaller the value, the better. If gatewayRtt < 50ms, it means lower audio and video call latency. If gatewayRtt > 200ms, it means higher audio and video call latency.<br>This value is invalid when the network type is cellular. |
60
+ | localStatisticsArray | [Field Meaning] Local audio and video statistical information<br>Since there may be three local audio and video streams (i.e., high-definition main screen, low-definition small screen, and auxiliary screen), the local audio and video statistical information is an array. |
61
+ | localStatisticsArraySize | [Field Meaning] Size of the array localStatisticsArray |
62
+ | receivedBytes | [Field Meaning] Total received bytes (including signaling data and audio and video data), in bytes. |
63
+ | remoteStatisticsArray | [Field Meaning] Remote audio and video statistical information<br>Since there may be multiple remote users at the same time, and each remote user may simultaneously have multiple audio and video streams (i.e., high-definition main screen, low-definition small screen, and auxiliary screen), the remote audio and video statistical information is an array. |
64
+ | remoteStatisticsArraySize | [Field Meaning] Size of the array remoteStatisticsArray. |
65
+ | rtt | [Field Meaning] Round-trip latency from the SDK to the cloud, in milliseconds (ms)<br>This value represents the total time it takes for a network packet to travel from the SDK to the cloud and back, summing up the "SDK => Cloud => SDK" time.<br>The smaller the value, the better: if RTT < 50ms, it means lower audio and video call latency; if RTT > 200ms, it means higher audio and video call latency.<br>It needs to be specifically explained that RTT represents the total time for "SDK => Cloud => SDK," so there is no need to distinguish between upRtt and downRtt. |
66
+ | sentBytes | [Field Meaning] Total bytes sent (including signaling data and audio and video data), in bytes (Bytes). |
67
+ | systemCpu | [Field Meaning] Current system CPU utilization, in percentage (%); not supported on Android 8.0 and above. |
68
+ | systemMemoryInMB | [Field Meaning] Current system memory, in MB. |
69
+ | systemMemoryUsageInMB | [Field Meaning] Current system memory usage, in MB, not supported on iOS/MAC. |
70
+ | upLoss | [Field Meaning] Uplink packet loss rate from the SDK to the cloud, in percentage (%)<br>The smaller the value, the better. If upLoss is 0%, it means the uplink network quality is good, with almost no data packet loss when uploading to the cloud.<br>If upLoss is 30%, it means that 30% of the audio and video data packets sent by the SDK to the cloud are lost in the transmission link. |