@tencent-rtc/mcp 1.3.8 → 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 (429) 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/callkit/preset/android/integration.md +430 -0
  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/chatkit/android/integration.md +490 -0
  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 +19 -88
  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/core-sdk/voice/android/voice-audience-list.md +263 -0
  90. package/resource/doc/livekit/core-sdk/voice/android/voice-audio-effect.md +222 -0
  91. package/resource/doc/livekit/core-sdk/voice/android/voice-barrage.md +452 -0
  92. package/resource/doc/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +536 -0
  93. package/resource/doc/livekit/core-sdk/voice/android/voice-gift.md +442 -0
  94. package/resource/doc/livekit/core-sdk/voice/android/voice-host-interaction.md +489 -0
  95. package/resource/doc/livekit/core-sdk/voice/android/voice-integration.md +574 -0
  96. package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +435 -0
  97. package/resource/doc/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +516 -0
  98. package/resource/doc/livekit/core-sdk/voice/flutter/voice-integration.md +576 -0
  99. package/resource/doc/livekit/core-sdk/voice/ios/voice-audience-list.md +263 -0
  100. package/resource/doc/livekit/core-sdk/voice/ios/voice-audio-effect.md +212 -0
  101. package/resource/doc/livekit/core-sdk/voice/ios/voice-barrage.md +404 -0
  102. package/resource/doc/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +499 -0
  103. package/resource/doc/livekit/core-sdk/voice/ios/voice-gift.md +403 -0
  104. package/resource/doc/livekit/core-sdk/voice/ios/voice-host-interaction.md +552 -0
  105. package/resource/doc/livekit/core-sdk/voice/ios/voice-integration.md +514 -0
  106. package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +348 -0
  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 +173 -337
  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 -18
  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 -19
  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 -30
  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 -59
  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/integration.md +0 -287
  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/iOS/workflow.md +0 -0
  277. package/resource/doc/chatuikit/react/components/conversation-list.md +0 -1017
  278. package/resource/doc/chatuikit/react/components/search.md +0 -745
  279. package/resource/doc/chatuikit/react/create-group.md +0 -23
  280. package/resource/doc/chatuikit/react/init.md +0 -26
  281. package/resource/doc/chatuikit/react/workflow.md +0 -258
  282. package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
  283. package/resource/doc/chatuikit/vue/create-group.md +0 -25
  284. package/resource/doc/chatuikit/vue/init.md +0 -40
  285. package/resource/doc/chatuikit/vue/workflow.md +0 -395
  286. package/resource/doc/livekit/live/android/workflow.md +0 -320
  287. package/resource/doc/livekit/live/flutter/workflow.md +0 -353
  288. package/resource/doc/livekit/live/ios/workflow.md +0 -454
  289. package/resource/doc/livekit/live/vue/components/barrage.md +0 -616
  290. package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -446
  291. package/resource/doc/livekit/live/vue/faq.md +0 -0
  292. package/resource/doc/livekit/live/vue/live-list-integration.md +0 -200
  293. package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -269
  294. package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -269
  295. package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -595
  296. package/resource/doc/livekit/live/vue/states/live-state.md +0 -3591
  297. package/resource/doc/livekit/live/vue/workflow.md +0 -218
  298. package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -312
  299. package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -430
  300. package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -679
  301. package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -671
  302. package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -271
  303. package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
  304. package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
  305. package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
  306. package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
  307. package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -865
  308. package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -657
  309. package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -437
  310. package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -335
  311. package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
  312. package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -327
  313. package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -507
  314. package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
  315. package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -659
  316. package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
  317. package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -814
  318. package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1000
  319. package/resource/doc/roomkit/vue/features/workflow.md +0 -553
  320. package/resource/doc/roomkit/vue/workflow.md +0 -487
  321. package/resource/doc/tuicallkit/android/integration.md +0 -286
  322. package/resource/doc/tuicallkit/android/workflow.md +0 -0
  323. package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -784
  324. package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -610
  325. package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -938
  326. package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -897
  327. package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -469
  328. package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -781
  329. package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -398
  330. package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
  331. package/resource/doc/tuicallkit/react/api.md +0 -1404
  332. package/resource/doc/tuicallkit/vue/api.md +0 -1406
  333. package/resource/doc/tuicallkit/vue/faq.md +0 -36
  334. package/tools/call/get-native-call-integration.js +0 -43
  335. package/tools/call/get-native-call-integration.js.map +0 -1
  336. package/tools/call/get-web-call-api.js +0 -27
  337. package/tools/call/get-web-call-api.js.map +0 -1
  338. package/tools/call/get-web-call-integration.js.map +0 -1
  339. package/tools/chat/get-native-chat-feature-detail.js +0 -30
  340. package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
  341. package/tools/chat/get-native-chat-integration.js +0 -45
  342. package/tools/chat/get-native-chat-integration.js.map +0 -1
  343. package/tools/chat/get-web-chat-component-detail.js +0 -31
  344. package/tools/chat/get-web-chat-component-detail.js.map +0 -1
  345. package/tools/chat/get-web-chat-integration.js +0 -45
  346. package/tools/chat/get-web-chat-integration.js.map +0 -1
  347. package/tools/chat/get-web-chat-uikit-init.js +0 -28
  348. package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
  349. package/tools/chat/get-web-create-group-doc.js +0 -28
  350. package/tools/chat/get-web-create-group-doc.js.map +0 -1
  351. package/tools/common/get-faq.js +0 -91
  352. package/tools/common/get-faq.js.map +0 -1
  353. package/tools/common/get-usersig.js.map +0 -1
  354. package/tools/common/present-framework-choice.js +0 -16
  355. package/tools/common/present-framework-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 -49
  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 -74
  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 -95
  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/record_prompt_def.js +0 -53
  387. package/tools/definitions/record_prompt_def.js.map +0 -1
  388. package/tools/definitions/record_result_def.js +0 -30
  389. package/tools/definitions/record_result_def.js.map +0 -1
  390. package/tools/live/get-native-live-uikit-integration.js +0 -101
  391. package/tools/live/get-native-live-uikit-integration.js.map +0 -1
  392. package/tools/live/get-web-live-component-detail.js +0 -31
  393. package/tools/live/get-web-live-component-detail.js.map +0 -1
  394. package/tools/live/get-web-live-state-detail.js +0 -31
  395. package/tools/live/get-web-live-state-detail.js.map +0 -1
  396. package/tools/live/get-web-live-uikit-integration.js +0 -52
  397. package/tools/live/get-web-live-uikit-integration.js.map +0 -1
  398. package/tools/live/get_native_live_uikit_extra_features.js +0 -105
  399. package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
  400. package/tools/live/get_native_live_uikit_interaction.js +0 -101
  401. package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
  402. package/tools/native_live/get-native-live-api.js +0 -31
  403. package/tools/native_live/get-native-live-api.js.map +0 -1
  404. package/tools/room/get-web-room-feature-detail.js.map +0 -1
  405. package/tools/room/get-web-room-integration.js.map +0 -1
  406. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
  407. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
  408. package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
  409. package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
  410. package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
  411. package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
  412. package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
  413. package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
  414. package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
  415. package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
  416. package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
  417. package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
  418. package/tools/trtc/get-trtc-native-api.js +0 -31
  419. package/tools/trtc/get-trtc-native-api.js.map +0 -1
  420. package/utils/handle-component-name.js +0 -33
  421. package/utils/handle-component-name.js.map +0 -1
  422. /package/resource/doc/{chatuikit/android/workflow.md → callkit/core-sdk/.gitkeep} +0 -0
  423. /package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +0 -0
  424. /package/resource/doc/{tuicallkit/react/faq.md → callkit/faq/web-faq.md} +0 -0
  425. /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
  426. /package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +0 -0
  427. /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
  428. /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
  429. /package/resource/doc/roomkit/faq/common/{error_code.md → error-code.md} +0 -0
@@ -2,333 +2,89 @@
2
2
  ## Feature Overview
3
3
  `ITXBeautyManager.h` provides audio and video device management for the TRTC (Real-Time Communication) SDK on C++. Use this module to control hardware devices such as cameras, microphones, and speakers.
4
4
 
5
-
6
5
  ## ITXDeviceManager
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" >[isFrontCamera](https://write.woa.com/document/87030115247763456)</td>
16
-
17
- <td rowspan="1" colSpan="1" >Determine whether the current camera is front-facing (only for mobile terminal)</td>
18
- </tr>
19
-
20
- <tr>
21
- <td rowspan="1" colSpan="1" >[switchCamera](https://write.woa.com/document/87030115247763456)</td>
22
-
23
- <td rowspan="1" colSpan="1" >Switch between front and rear cameras (only for mobile terminal)</td>
24
- </tr>
25
-
26
- <tr>
27
- <td rowspan="1" colSpan="1" >[getCameraZoomMaxRatio](https://write.woa.com/document/87030115247763456)</td>
28
-
29
- <td rowspan="1" colSpan="1" >Get the maximum zoom level of the camera (only for mobile terminal)</td>
30
- </tr>
31
-
32
- <tr>
33
- <td rowspan="1" colSpan="1" >[setCameraZoomRatio](https://write.woa.com/document/87030115247763456)</td>
34
-
35
- <td rowspan="1" colSpan="1" >Set the zoom level of the camera (only for mobile terminal)</td>
36
- </tr>
37
-
38
- <tr>
39
- <td rowspan="1" colSpan="1" >[isAutoFocusEnabled](https://write.woa.com/document/87030115247763456)</td>
40
-
41
- <td rowspan="1" colSpan="1" >Check if automatic face position recognition is supported (only for mobile terminal)</td>
42
- </tr>
43
-
44
- <tr>
45
- <td rowspan="1" colSpan="1" >[enableCameraAutoFocus](https://write.woa.com/document/87030115247763456)</td>
46
-
47
- <td rowspan="1" colSpan="1" >Enable autofocus feature (only for mobile terminal)</td>
48
- </tr>
49
-
50
- <tr>
51
- <td rowspan="1" colSpan="1" >[setCameraFocusPosition](https://write.woa.com/document/87030115247763456)</td>
52
-
53
- <td rowspan="1" colSpan="1" >Set the focus position of the camera (only for mobile terminal)</td>
54
- </tr>
55
-
56
- <tr>
57
- <td rowspan="1" colSpan="1" >[enableCameraTorch](https://write.woa.com/document/87030115247763456)</td>
58
-
59
- <td rowspan="1" colSpan="1" >Turn the flash on/off, also known as flashlight mode (only for mobile terminal)</td>
60
- </tr>
61
-
62
- <tr>
63
- <td rowspan="1" colSpan="1" >[setAudioRoute](https://write.woa.com/document/87030115247763456)</td>
64
-
65
- <td rowspan="1" colSpan="1" >Set audio routing (only for mobile terminal)</td>
66
- </tr>
67
-
68
- <tr>
69
- <td rowspan="1" colSpan="1" >[getDevicesList](https://write.woa.com/document/87030115247763456)</td>
70
-
71
- <td rowspan="1" colSpan="1" >Get the device list (only for desktop terminal)</td>
72
- </tr>
73
-
74
- <tr>
75
- <td rowspan="1" colSpan="1" >[setCurrentDevice](https://write.woa.com/document/87030115247763456)</td>
76
-
77
- <td rowspan="1" colSpan="1" >Set the current device to use (only for desktop terminal)</td>
78
- </tr>
79
-
80
- <tr>
81
- <td rowspan="1" colSpan="1" >[getCurrentDevice](https://write.woa.com/document/87030115247763456)</td>
82
-
83
- <td rowspan="1" colSpan="1" >Get the current device in use (only for desktop terminal)</td>
84
- </tr>
85
-
86
- <tr>
87
- <td rowspan="1" colSpan="1" >[setCurrentDeviceVolume](https://write.woa.com/document/87030115247763456)</td>
88
-
89
- <td rowspan="1" colSpan="1" >Set the current device volume (only for desktop terminal)</td>
90
- </tr>
91
-
92
- <tr>
93
- <td rowspan="1" colSpan="1" >[getCurrentDeviceVolume](https://write.woa.com/document/87030115247763456)</td>
94
-
95
- <td rowspan="1" colSpan="1" >Get the current device volume (only for desktop terminal)</td>
96
- </tr>
97
-
98
- <tr>
99
- <td rowspan="1" colSpan="1" >[setCurrentDeviceMute](https://write.woa.com/document/87030115247763456)</td>
100
-
101
- <td rowspan="1" colSpan="1" >Set the mute status of the current device (only for desktop terminal)</td>
102
- </tr>
103
-
104
- <tr>
105
- <td rowspan="1" colSpan="1" >[getCurrentDeviceMute](https://write.woa.com/document/87030115247763456)</td>
106
-
107
- <td rowspan="1" colSpan="1" >Get the mute status of the current device (only for desktop terminal)</td>
108
- </tr>
109
-
110
- <tr>
111
- <td rowspan="1" colSpan="1" >[enableFollowingDefaultAudioDevice](https://write.woa.com/document/87030115247763456)</td>
112
-
113
- <td rowspan="1" colSpan="1" >Set SDK to use the audio device according to the default system device (only for desktop terminal)</td>
114
- </tr>
115
-
116
- <tr>
117
- <td rowspan="1" colSpan="1" >[startCameraDeviceTest](https://write.woa.com/document/87030115247763456)</td>
118
-
119
- <td rowspan="1" colSpan="1" >Start camera testing (only for desktop terminal)</td>
120
- </tr>
121
-
122
- <tr>
123
- <td rowspan="1" colSpan="1" >[stopCameraDeviceTest](https://write.woa.com/document/87030115247763456)</td>
124
-
125
- <td rowspan="1" colSpan="1" >End camera testing (only for desktop terminal)</td>
126
- </tr>
127
-
128
- <tr>
129
- <td rowspan="1" colSpan="1" >[startMicDeviceTest](https://write.woa.com/document/87030115247763456)</td>
130
-
131
- <td rowspan="1" colSpan="1" >Start mic testing (only for desktop terminal)</td>
132
- </tr>
133
-
134
- <tr>
135
- <td rowspan="1" colSpan="1" >[startMicDeviceTest](https://write.woa.com/document/87030115247763456)</td>
136
-
137
- <td rowspan="1" colSpan="1" >Start mic testing (only for desktop terminal)</td>
138
- </tr>
139
-
140
- <tr>
141
- <td rowspan="1" colSpan="1" >[stopMicDeviceTest](https://write.woa.com/document/87030115247763456)</td>
142
-
143
- <td rowspan="1" colSpan="1" >End mic testing (only for desktop terminal)</td>
144
- </tr>
145
-
146
- <tr>
147
- <td rowspan="1" colSpan="1" >[startSpeakerDeviceTest](https://write.woa.com/document/87030115247763456)</td>
148
-
149
- <td rowspan="1" colSpan="1" >Start speaker testing (only for desktop terminal)</td>
150
- </tr>
151
-
152
- <tr>
153
- <td rowspan="1" colSpan="1" >[stopSpeakerDeviceTest](https://write.woa.com/document/87030115247763456)</td>
154
-
155
- <td rowspan="1" colSpan="1" >End speaker testing (only for desktop terminal)</td>
156
- </tr>
157
-
158
- <tr>
159
- <td rowspan="1" colSpan="1" >[startCameraDeviceTest](https://write.woa.com/document/87030115247763456)</td>
160
-
161
- <td rowspan="1" colSpan="1" >Start camera testing (only for desktop terminal)</td>
162
- </tr>
163
-
164
- <tr>
165
- <td rowspan="1" colSpan="1" >[setApplicationPlayVolume](https://write.woa.com/document/87030115247763456)</td>
166
-
167
- <td rowspan="1" colSpan="1" >Set the volume of the current process in the Windows system volume synthesizer (only applicable for Windows system)</td>
168
- </tr>
169
-
170
- <tr>
171
- <td rowspan="1" colSpan="1" >[getApplicationPlayVolume](https://write.woa.com/document/87030115247763456)</td>
172
-
173
- <td rowspan="1" colSpan="1" >Get the volume of the current process in the Windows system volume synthesizer (only applicable for Windows system)</td>
174
- </tr>
175
-
176
- <tr>
177
- <td rowspan="1" colSpan="1" >[setApplicationMuteState](https://write.woa.com/document/87030115247763456)</td>
178
-
179
- <td rowspan="1" colSpan="1" >Set the mute status of the current process in the Windows system volume synthesizer (only applicable for Windows system)</td>
180
- </tr>
181
-
182
- <tr>
183
- <td rowspan="1" colSpan="1" >[getApplicationMuteState](https://write.woa.com/document/87030115247763456)</td>
184
-
185
- <td rowspan="1" colSpan="1" >Get the mute status of the current process in the Windows system volume synthesizer (only applicable for Windows system)</td>
186
- </tr>
187
-
188
- <tr>
189
- <td rowspan="1" colSpan="1" >[setCameraCapturerParam](https://write.woa.com/document/87030115247763456)</td>
190
-
191
- <td rowspan="1" colSpan="1" >Set camera capture preferences</td>
192
- </tr>
193
-
194
- <tr>
195
- <td rowspan="1" colSpan="1" >[setDeviceObserver](https://write.woa.com/document/87030115247763456)</td>
196
-
197
- <td rowspan="1" colSpan="1" >Set onDeviceChanged event callback</td>
198
- </tr>
199
-
200
- <tr>
201
- <td rowspan="1" colSpan="1" >[setSystemVolumeType](https://write.woa.com/document/87030115247763456)</td>
202
-
203
- <td rowspan="1" colSpan="1" >Set system volume type (only for mobile terminal)</td>
204
- </tr>
205
- </table>
206
-
6
+ | Function List | Description |
7
+ | --- | --- |
8
+ | isFrontCamera | Determine whether the current camera is front-facing (only for mobile terminal) |
9
+ | switchCamera | Switch between front and rear cameras (only for mobile terminal) |
10
+ | getCameraZoomMaxRatio | Get the maximum zoom level of the camera (only for mobile terminal) |
11
+ | setCameraZoomRatio | Set the zoom level of the camera (only for mobile terminal) |
12
+ | isAutoFocusEnabled | Check if automatic face position recognition is supported (only for mobile terminal) |
13
+ | enableCameraAutoFocus | Enable autofocus feature (only for mobile terminal) |
14
+ | setCameraFocusPosition | Set the focus position of the camera (only for mobile terminal) |
15
+ | enableCameraTorch | Turn the flash on/off, also known as flashlight mode (only for mobile terminal) |
16
+ | setAudioRoute | Set audio routing (only for mobile terminal) |
17
+ | getDevicesList | Get the device list (only for desktop terminal) |
18
+ | setCurrentDevice | Set the current device to use (only for desktop terminal) |
19
+ | getCurrentDevice | Get the current device in use (only for desktop terminal) |
20
+ | setCurrentDeviceVolume | Set the current device volume (only for desktop terminal) |
21
+ | getCurrentDeviceVolume | Get the current device volume (only for desktop terminal) |
22
+ | setCurrentDeviceMute | Set the mute status of the current device (only for desktop terminal) |
23
+ | getCurrentDeviceMute | Get the mute status of the current device (only for desktop terminal) |
24
+ | enableFollowingDefaultAudioDevice | Set SDK to use the audio device according to the default system device (only for desktop terminal) |
25
+ | startCameraDeviceTest | Start camera testing (only for desktop terminal) |
26
+ | stopCameraDeviceTest | End camera testing (only for desktop terminal) |
27
+ | startMicDeviceTest | Start mic testing (only for desktop terminal) |
28
+ | startMicDeviceTest | Start mic testing (only for desktop terminal) |
29
+ | stopMicDeviceTest | End mic testing (only for desktop terminal) |
30
+ | startSpeakerDeviceTest | Start speaker testing (only for desktop terminal) |
31
+ | stopSpeakerDeviceTest | End speaker testing (only for desktop terminal) |
32
+ | startCameraDeviceTest | Start camera testing (only for desktop terminal) |
33
+ | setApplicationPlayVolume | Set the volume of the current process in the Windows system volume synthesizer (only applicable for Windows system) |
34
+ | getApplicationPlayVolume | Get the volume of the current process in the Windows system volume synthesizer (only applicable for Windows system) |
35
+ | setApplicationMuteState | Set the mute status of the current process in the Windows system volume synthesizer (only applicable for Windows system) |
36
+ | getApplicationMuteState | Get the mute status of the current process in the Windows system volume synthesizer (only applicable for Windows system) |
37
+ | setCameraCapturerParam | Set camera capture preferences |
38
+ | setDeviceObserver | Set onDeviceChanged event callback |
39
+ | setSystemVolumeType | Set system volume type (only for mobile terminal) |
207
40
 
208
41
  ## Struct Type
209
- <table>
210
- <tr>
211
- <td rowspan="1" colSpan="1" >Function List</td>
212
-
213
- <td rowspan="1" colSpan="1" >Description</td>
214
- </tr>
215
-
216
- <tr>
217
- <td rowspan="1" colSpan="1" >[TXCameraCaptureParam](https://write.woa.com/document/87030115247763456)</td>
218
-
219
- <td rowspan="1" colSpan="1" >Camera collection parameters</td>
220
- </tr>
221
-
222
- <tr>
223
- <td rowspan="1" colSpan="1" >[ITXDeviceInfo](https://write.woa.com/document/87030115247763456)</td>
224
-
225
- <td rowspan="1" colSpan="1" >Information related to audio and video equipment (only for desktop platform)</td>
226
- </tr>
227
-
228
- <tr>
229
- <td rowspan="1" colSpan="1" >[ITXDeviceCollection](https://write.woa.com/document/87030115247763456)</td>
230
-
231
- <td rowspan="1" colSpan="1" >Device Information List (only for desktop platform)</td>
232
- </tr>
233
- </table>
234
-
42
+ | Function List | Description |
43
+ | --- | --- |
44
+ | TXCameraCaptureParam | Camera collection parameters |
45
+ | ITXDeviceInfo | Information related to audio and video equipment (only for desktop platform) |
46
+ | ITXDeviceCollection | Device Information List (only for desktop platform) |
235
47
 
236
48
  ## Enumeration Types
237
- <table>
238
- <tr>
239
- <td rowspan="1" colSpan="1" >Enumeration Types</td>
240
-
241
- <td rowspan="1" colSpan="1" >Description</td>
242
- </tr>
243
-
244
- <tr>
245
- <td rowspan="1" colSpan="1" >[TXSystemVolumeType](https://write.woa.com/document/87030115247763456)</td>
246
-
247
- <td rowspan="1" colSpan="1" >System Volume Type (Only applicable to mobile devices)</td>
248
- </tr>
249
-
250
- <tr>
251
- <td rowspan="1" colSpan="1" >[TXAudioRoute](https://write.woa.com/document/87030115247763456)</td>
252
-
253
- <td rowspan="1" colSpan="1" >Audio routing (i.e., the sound playback mode)</td>
254
- </tr>
255
-
256
- <tr>
257
- <td rowspan="1" colSpan="1" >[TXMediaDeviceType](https://write.woa.com/document/87030115247763456)</td>
258
-
259
- <td rowspan="1" colSpan="1" >Device type (only for desktop platform)</td>
260
- </tr>
261
-
262
- <tr>
263
- <td rowspan="1" colSpan="1" >[TXMediaDeviceState](https://write.woa.com/document/87030115247763456)</td>
264
-
265
- <td rowspan="1" colSpan="1" >Device operations</td>
266
- </tr>
267
-
268
- <tr>
269
- <td rowspan="1" colSpan="1" >[TXCameraCaptureMode](https://write.woa.com/document/87030115247763456)</td>
270
-
271
- <td rowspan="1" colSpan="1" >Camera capture preferences</td>
272
- </tr>
273
- </table>
274
-
49
+ | Enumeration Types | Description |
50
+ | --- | --- |
51
+ | TXSystemVolumeType | System Volume Type (Only applicable to mobile devices) |
52
+ | TXAudioRoute | Audio routing (i.e., the sound playback mode) |
53
+ | TXMediaDeviceType | Device type (only for desktop platform) |
54
+ | TXMediaDeviceState | Device operations |
55
+ | TXCameraCaptureMode | Camera capture preferences |
275
56
 
276
57
  ## isFrontCamera
277
58
 
278
-
279
-
280
59
  #### Determine whether the current camera is front-facing (only for mobile terminal)
281
60
 
282
61
  ## switchCamera
283
62
 
284
-
285
-
286
63
  #### Switch between front and rear cameras (only for mobile terminal)
287
64
 
288
65
  ## getCameraZoomMaxRatio
289
66
 
290
-
291
-
292
67
  #### Get the maximum zoom level of the camera (only for mobile terminal)
293
68
 
294
69
  ## setCameraZoomRatio
295
70
 
296
-
297
-
298
71
  #### Set the zoom level of the camera (only for mobile terminal)
299
- <table>
300
- <tr>
301
- <td rowspan="1" colSpan="1" >Parameters</td>
302
-
303
- <td rowspan="1" colSpan="1" >Description</td>
304
- </tr>
305
-
306
- <tr>
307
- <td rowspan="1" colSpan="1" >zoomRatio</td>
308
-
309
- <td rowspan="1" colSpan="1" >Value range 1 - 5, with 1 representing the farthest view (normal lens) and 5 representing the closest view (magnifier lens). The recommended maximum value is 5; exceeding 5 may cause video data to become blurry.</td>
310
- </tr>
311
- </table>
312
-
72
+ | Parameters | Description |
73
+ | --- | --- |
74
+ | zoomRatio | Value range 1 - 5, with 1 representing the farthest view (normal lens) and 5 representing the closest view (magnifier lens). The recommended maximum value is 5; exceeding 5 may cause video data to become blurry. |
313
75
 
314
76
  ## isAutoFocusEnabled
315
77
 
316
-
317
-
318
78
  #### Check if automatic face position recognition is supported (only for mobile terminal)
319
79
 
320
80
  ## enableCameraAutoFocus
321
81
 
322
-
323
-
324
82
  #### Enable autofocus feature (only for mobile terminal)
325
83
 
326
84
  Once enabled, the SDK will automatically detect the face position in the frame and keep the camera focus on the face position.
327
85
 
328
86
  ## setCameraFocusPosition
329
87
 
330
-
331
-
332
88
  #### Set the focus position of the camera (only for mobile terminal)
333
89
 
334
90
  You can achieve the following interactions with this interface:
@@ -338,27 +94,15 @@ You can achieve the following interactions with this interface:
338
94
  2. Display a rectangular box at the click position to indicate that the camera will focus on this point.
339
95
 
340
96
  3. Then, pass the coordinates of the user's click position through this interface to the SDK. The SDK will control the camera to focus on the user's desired location.
341
- <table>
342
- <tr>
343
- <td rowspan="1" colSpan="1" >Parameters</td>
344
-
345
- <td rowspan="1" colSpan="1" >Description</td>
346
- </tr>
347
-
348
- <tr>
349
- <td rowspan="1" colSpan="1" >position</td>
350
-
351
- <td rowspan="1" colSpan="1" >Focus position, please pass the coordinates of the desired focus point</td>
352
- </tr>
353
- </table>
354
-
97
+ | Parameters | Description |
98
+ | --- | --- |
99
+ | position | Focus position, please pass the coordinates of the desired focus point |
355
100
 
356
101
  > **Note**
357
- >
358
-
359
- > The prerequisite for using this interface is to disable the auto-focus feature through [enableCameraAutoFocus](https://write.woa.com/document/87030115247763456).
360
- >
102
+ >
361
103
 
104
+ > The prerequisite for using this interface is to disable the auto-focus feature through enableCameraAutoFocus.
105
+ >
362
106
 
363
107
  #### Return value description:
364
108
 
@@ -366,14 +110,10 @@ You can achieve the following interactions with this interface:
366
110
 
367
111
  ## enableCameraTorch
368
112
 
369
-
370
-
371
113
  #### Turn the flash on/off, also known as flashlight mode (only for mobile terminal)
372
114
 
373
115
  ## setAudioRoute
374
116
 
375
-
376
-
377
117
  #### Set audio routing (only for mobile terminal)
378
118
 
379
119
  A phone has two audio playback devices: one is the earpiece at the top of the phone, and the other is the stereo speaker at the bottom of the phone.
@@ -384,57 +124,25 @@ When the audio routing is set to the speaker, the sound is relatively loud. You
384
124
 
385
125
  ## getDevicesList
386
126
 
387
-
388
-
389
127
  #### Get the device list (only for desktop terminal)
390
- <table>
391
- <tr>
392
- <td rowspan="1" colSpan="1" >Parameters</td>
393
-
394
- <td rowspan="1" colSpan="1" >Description</td>
395
- </tr>
396
-
397
- <tr>
398
- <td rowspan="1" colSpan="1" >type</td>
399
-
400
- <td rowspan="1" colSpan="1" >Device type, specify which type of device list to retrieve. See TXMediaDeviceType Definition for details.</td>
401
- </tr>
402
- </table>
403
-
128
+ | Parameters | Description |
129
+ | --- | --- |
130
+ | type | Device type, specify which type of device list to retrieve. See TXMediaDeviceType Definition for details. |
404
131
 
405
132
  > **Note**
406
- >
133
+ >
407
134
  > - After use, please call the release method to release resources so that the SDK can maintain the lifecycle of the ITXDeviceCollection object.
408
135
  > - Do not use delete to release the returned Collection object. Deleting the ITXDeviceCollection* pointer will cause an abnormal crash.
409
136
  > - type only supports TXMediaDeviceTypeMic, TXMediaDeviceTypeSpeaker, TXMediaDeviceTypeCamera.
410
137
  > - This interface only supports Mac and Windows platforms.
411
138
 
412
-
413
139
  ## setCurrentDevice
414
140
 
415
-
416
-
417
141
  #### Set the current device to use (only for desktop terminal)
418
- <table>
419
- <tr>
420
- <td rowspan="1" colSpan="1" >Parameters</td>
421
-
422
- <td rowspan="1" colSpan="1" >Description</td>
423
- </tr>
424
-
425
- <tr>
426
- <td rowspan="1" colSpan="1" >deviceId</td>
427
-
428
- <td rowspan="1" colSpan="1" >Device ID, you can obtain the device ID through the [getDevicesList](https://write.woa.com/document/87030115247763456) interface.</td>
429
- </tr>
430
-
431
- <tr>
432
- <td rowspan="1" colSpan="1" >type</td>
433
-
434
- <td rowspan="1" colSpan="1" >Device type, see TXMediaDeviceType Definition for details.</td>
435
- </tr>
436
- </table>
437
-
142
+ | Parameters | Description |
143
+ | --- | --- |
144
+ | deviceId | Device ID, you can obtain the device ID through the getDevicesList interface. |
145
+ | type | Device type, see TXMediaDeviceType Definition for details. |
438
146
 
439
147
  #### Return value description:
440
148
 
@@ -442,308 +150,160 @@ When the audio routing is set to the speaker, the sound is relatively loud. You
442
150
 
443
151
  ## getCurrentDevice
444
152
 
445
-
446
-
447
153
  #### Get the current device in use (only for desktop terminal)
448
154
 
449
155
  ## setCurrentDeviceVolume
450
156
 
451
-
452
-
453
157
  #### Set the current device volume (only for desktop terminal)
454
158
 
455
159
  The volume here refers to the capture volume of the microphone or the playback volume of the speaker. The camera does not support setting the volume.
456
- <table>
457
- <tr>
458
- <td rowspan="1" colSpan="1" >Parameters</td>
459
-
460
- <td rowspan="1" colSpan="1" >Description</td>
461
- </tr>
462
-
463
- <tr>
464
- <td rowspan="1" colSpan="1" >volume</td>
465
-
466
- <td rowspan="1" colSpan="1" >Volume. Value range: 0-100. Default value: 100.</td>
467
- </tr>
468
- </table>
469
-
160
+ | Parameters | Description |
161
+ | --- | --- |
162
+ | volume | Volume. Value range: 0-100. Default value: 100. |
470
163
 
471
164
  ## getCurrentDeviceVolume
472
165
 
473
-
474
-
475
166
  #### Get the current device volume (only for desktop terminal)
476
167
 
477
168
  The volume here refers to the capture volume of the microphone or the playback volume of the speaker. The camera does not support retrieving the volume.
478
169
 
479
170
  ## setCurrentDeviceMute
480
171
 
481
-
482
-
483
172
  #### Set the mute status of the current device (only for desktop terminal)
484
173
 
485
174
  The volume here refers to the microphone and speaker, and the camera does not support silent operation.
486
175
 
487
176
  ## getCurrentDeviceMute
488
177
 
489
-
490
-
491
178
  #### Get the mute status of the current device (only for desktop terminal)
492
179
 
493
180
  The volume here refers to the microphone and speaker, and the camera does not support silent operation.
494
181
 
495
182
  ## enableFollowingDefaultAudioDevice
496
183
 
497
-
498
-
499
184
  #### Set SDK to use the audio device according to the default system device (only for desktop terminal)
500
185
 
501
186
  Only microphone and speaker types are supported. The camera does not yet support following the system default device
502
- <table>
503
- <tr>
504
- <td rowspan="1" colSpan="1" >Parameters</td>
505
-
506
- <td rowspan="1" colSpan="1" >Description</td>
507
- </tr>
508
-
509
- <tr>
510
- <td rowspan="1" colSpan="1" >enable</td>
511
-
512
- <td rowspan="1" colSpan="1" >Whether to follow the system default audio device.<br>- true: Follow. When the system default audio device changes or a new audio device is plugged in, the SDK will immediately switch the audio device.<br>- false: Do not follow. When the system default audio device changes or a new audio device is plugged in, the SDK will not switch the audio device.</td>
513
- </tr>
514
-
515
- <tr>
516
- <td rowspan="1" colSpan="1" >type</td>
517
-
518
- <td rowspan="1" colSpan="1" >Device type, see TXMediaDeviceType Definition for details.</td>
519
- </tr>
520
- </table>
521
-
187
+ | Parameters | Description |
188
+ | --- | --- |
189
+ | enable | Whether to follow the system default audio device.<br>- true: Follow. When the system default audio device changes or a new audio device is plugged in, the SDK will immediately switch the audio device.<br>- false: Do not follow. When the system default audio device changes or a new audio device is plugged in, the SDK will not switch the audio device. |
190
+ | type | Device type, see TXMediaDeviceType Definition for details. |
522
191
 
523
192
  ## startCameraDeviceTest
524
193
 
525
-
526
-
527
194
  #### Start camera testing (only for desktop terminal)
528
195
 
529
196
  > **Note**
530
- >
531
-
532
- > During testing, you can use the [setCurrentDevice](https://write.woa.com/document/87030115247763456) interface to switch cameras.
533
- >
197
+ >
534
198
 
199
+ > During testing, you can use the setCurrentDevice interface to switch cameras.
200
+ >
535
201
 
536
202
  ## stopCameraDeviceTest
537
203
 
538
-
539
-
540
204
  #### End camera testing (only for desktop terminal)
541
205
 
542
206
  ## startMicDeviceTest
543
207
 
544
-
545
-
546
208
  #### Start mic testing (only for desktop terminal)
547
209
 
548
210
  This interface can test whether the microphone is working properly. The volume of the microphone's audio stream will be notified to you via callback, with the volume range being 0 to 100.
549
- <table>
550
- <tr>
551
- <td rowspan="1" colSpan="1" >Parameters</td>
552
-
553
- <td rowspan="1" colSpan="1" >Description</td>
554
- </tr>
555
-
556
- <tr>
557
- <td rowspan="1" colSpan="1" >interval</td>
558
-
559
- <td rowspan="1" colSpan="1" >Microphone volume callback interval.</td>
560
- </tr>
561
- </table>
562
-
211
+ | Parameters | Description |
212
+ | --- | --- |
213
+ | interval | Microphone volume callback interval. |
563
214
 
564
215
  > **Note**
565
- >
216
+ >
566
217
 
567
218
  > After invoking this interface, the recorded microphone sound will be played back through the speaker by default.
568
- >
569
-
219
+ >
570
220
 
571
221
  ## startMicDeviceTest
572
222
 
573
-
574
-
575
223
  #### Start mic testing (only for desktop terminal)
576
224
 
577
225
  This interface can test whether the microphone is working properly. The volume of the microphone's audio stream will be notified to you via callback, with the volume range being 0 to 100.
578
- <table>
579
- <tr>
580
- <td rowspan="1" colSpan="1" >Parameters</td>
581
-
582
- <td rowspan="1" colSpan="1" >Description</td>
583
- </tr>
584
-
585
- <tr>
586
- <td rowspan="1" colSpan="1" >interval</td>
587
-
588
- <td rowspan="1" colSpan="1" >Microphone volume callback interval.</td>
589
- </tr>
590
-
591
- <tr>
592
- <td rowspan="1" colSpan="1" >playback</td>
593
-
594
- <td rowspan="1" colSpan="1" >Whether to enable microphone sound playback. When enabled, users will hear their own voice during microphone testing.</td>
595
- </tr>
596
- </table>
597
-
226
+ | Parameters | Description |
227
+ | --- | --- |
228
+ | interval | Microphone volume callback interval. |
229
+ | playback | Whether to enable microphone sound playback. When enabled, users will hear their own voice during microphone testing. |
598
230
 
599
231
  ## stopMicDeviceTest
600
232
 
601
-
602
-
603
233
  #### End mic testing (only for desktop terminal)
604
234
 
605
235
  ## startSpeakerDeviceTest
606
236
 
607
-
608
-
609
237
  #### Start speaker testing (only for desktop terminal)
610
238
 
611
239
  This interface tests the playback device by playing a specified audio file. If the user hears sound during the test, it means the playback device is working properly.
612
- <table>
613
- <tr>
614
- <td rowspan="1" colSpan="1" >Parameters</td>
615
-
616
- <td rowspan="1" colSpan="1" >Description</td>
617
- </tr>
618
-
619
- <tr>
620
- <td rowspan="1" colSpan="1" >filePath</td>
621
-
622
- <td rowspan="1" colSpan="1" >Path to the audio file</td>
623
- </tr>
624
- </table>
625
-
240
+ | Parameters | Description |
241
+ | --- | --- |
242
+ | filePath | Path to the audio file |
626
243
 
627
244
  ## stopSpeakerDeviceTest
628
245
 
629
-
630
-
631
246
  #### End speaker testing (only for desktop terminal)
632
247
 
633
248
  ## startCameraDeviceTest
634
249
 
635
-
636
-
637
250
  #### Start camera testing (only for desktop terminal)
638
251
 
639
252
  This interface supports custom rendering, which means you can take over the camera's rendered image by connecting to the ITRTCVideoRenderCallback Callback Interface.
640
253
 
641
254
  ## setApplicationPlayVolume
642
255
 
643
-
644
-
645
256
  #### Set the volume of the current process in the Windows system volume synthesizer (only applicable for Windows system)
646
257
 
647
258
  ## getApplicationPlayVolume
648
259
 
649
-
650
-
651
260
  #### Get the volume of the current process in the Windows system volume synthesizer (only applicable for Windows system)
652
261
 
653
262
  ## setApplicationMuteState
654
263
 
655
-
656
-
657
264
  #### Set the mute status of the current process in the Windows system volume synthesizer (only applicable for Windows system)
658
265
 
659
266
  ## getApplicationMuteState
660
267
 
661
-
662
-
663
268
  #### Get the mute status of the current process in the Windows system volume synthesizer (only applicable for Windows system)
664
269
 
665
270
  ## setCameraCapturerParam
666
271
 
667
-
668
-
669
272
  #### Set camera capture preferences
670
273
 
671
274
  ## setDeviceObserver
672
275
 
673
-
674
-
675
276
  #### Set onDeviceChanged event callback
676
277
 
677
278
  ## setSystemVolumeType
678
279
 
679
-
680
-
681
280
  #### Set system volume type (only for mobile terminal)
682
281
 
683
282
  @deprecated Not recommended starting from version 9.5. It is advised to use the startLocalAudio(quality) interface in ` TRTCCloud ` as a replacement, and decide the sound quality via the quality parameter.
684
283
 
685
284
  ## TXSystemVolumeType(Deprecated)
686
285
 
687
-
688
-
689
286
  #### System Volume Type (Only applicable to mobile devices)
690
287
 
691
288
  @deprecated Not recommended starting from version 9.5.
692
289
 
693
-
694
-
695
290
  Modern smartphones generally have two types of system volume: "Call Volume" and "Media Volume".
696
291
  - Call Volume: A volume type designed specifically for making and receiving phone calls, featuring built-in echo cancellation (AEC), and supporting microphone input via Bluetooth headphones. However, the sound quality is relatively average.
697
292
 
698
-
699
293
  If you press the volume button on the side of your phone to lower the volume and it cannot be set to zero (completely silent), it indicates that your phone is currently in Call Volume mode.
700
294
  - Media Volume: A volume type designed specifically for music scenarios, which cannot use the system's AEC feature, and does not support microphone input via Bluetooth headphones, but provides better music playback quality.
701
295
 
702
-
703
296
  If you press the volume button on the side of your phone to lower the volume and it can be set to completely silent, it indicates that your phone is currently in Media Volume mode.
704
297
 
705
-
706
-
707
298
  The SDK currently offers three control modes for system volume types: Automatic Switching Mode, Full Call Volume Mode, Full Media Volume Mode.
708
- <table>
709
- <tr>
710
- <td rowspan="1" colSpan="1" >Enumeration</td>
711
-
712
- <td rowspan="1" colSpan="1" >Value</td>
713
-
714
- <td rowspan="1" colSpan="1" >Description</td>
715
- </tr>
716
-
717
- <tr>
718
- <td rowspan="1" colSpan="1" >TXSystemVolumeTypeAuto</td>
719
-
720
- <td rowspan="1" colSpan="1" >0</td>
721
-
722
- <td rowspan="1" colSpan="1" >Automatic Switching Mode</td>
723
- </tr>
724
-
725
- <tr>
726
- <td rowspan="1" colSpan="1" >TXSystemVolumeTypeMedia</td>
727
-
728
- <td rowspan="1" colSpan="1" >1</td>
729
-
730
- <td rowspan="1" colSpan="1" >Full Media Volume</td>
731
- </tr>
732
-
733
- <tr>
734
- <td rowspan="1" colSpan="1" >TXSystemVolumeTypeVOIP</td>
735
-
736
- <td rowspan="1" colSpan="1" >2</td>
737
-
738
- <td rowspan="1" colSpan="1" >Full Call Volume</td>
739
- </tr>
740
- </table>
741
-
299
+ | Enumeration | Value | Description |
300
+ | --- | --- | --- |
301
+ | TXSystemVolumeTypeAuto | 0 | Automatic Switching Mode |
302
+ | TXSystemVolumeTypeMedia | 1 | Full Media Volume |
303
+ | TXSystemVolumeTypeVOIP | 2 | Full Call Volume |
742
304
 
743
305
  ## TXAudioRoute
744
306
 
745
-
746
-
747
307
  #### Audio routing (i.e., the sound playback mode)
748
308
 
749
309
  Audio routing, that is, whether the sound is played through the phone's speaker or earpiece. Therefore, this interface is only applicable to mobile devices.
@@ -753,276 +313,75 @@ A mobile phone has two speakers: one is the earpiece located at the top of the p
753
313
 
754
314
  - When the audio routing is set to the speaker, the sound is relatively loud. You can hear it clearly without holding the phone to your face, thus enabling the "hands-free" feature.
755
315
 
756
- <table>
757
- <tr>
758
- <td rowspan="1" colSpan="1" >Enumeration</td>
759
-
760
- <td rowspan="1" colSpan="1" >Value</td>
761
-
762
- <td rowspan="1" colSpan="1" >Description</td>
763
- </tr>
764
-
765
- <tr>
766
- <td rowspan="1" colSpan="1" >TXAudioRouteSpeakerphone</td>
767
-
768
- <td rowspan="1" colSpan="1" >0</td>
769
-
770
- <td rowspan="1" colSpan="1" >Speakerphone: Play sound through the speaker (i.e., "hands-free"), which is located at the bottom of the phone. The volume tends to be loud, suitable for playing music out loud.</td>
771
- </tr>
772
-
773
- <tr>
774
- <td rowspan="1" colSpan="1" >TXAudioRouteEarpiece</td>
775
-
776
- <td rowspan="1" colSpan="1" >1</td>
777
-
778
- <td rowspan="1" colSpan="1" >Earpiece: Plays through the earpiece, the earpiece is located at the top of the phone, the sound is small, suitable for privacy-protected call scenarios.</td>
779
- </tr>
780
- </table>
781
-
316
+ | Enumeration | Value | Description |
317
+ | --- | --- | --- |
318
+ | TXAudioRouteSpeakerphone | 0 | Speakerphone: Play sound through the speaker (i.e., "hands-free"), which is located at the bottom of the phone. The volume tends to be loud, suitable for playing music out loud. |
319
+ | TXAudioRouteEarpiece | 1 | Earpiece: Plays through the earpiece, the earpiece is located at the top of the phone, the sound is small, suitable for privacy-protected call scenarios. |
782
320
 
783
321
  ## TXMediaDeviceType
784
322
 
785
-
786
-
787
323
  #### Device type (only for desktop platform)
788
324
 
789
-
790
-
791
325
  This enumeration value is used for the three types of audio and video devices in Definition: camera, microphone, and speaker, allowing a single device management interface to control different types of devices.
792
- <table>
793
- <tr>
794
- <td rowspan="1" colSpan="1" >Enumeration</td>
795
-
796
- <td rowspan="1" colSpan="1" >Value</td>
797
-
798
- <td rowspan="1" colSpan="1" >Description</td>
799
- </tr>
800
-
801
- <tr>
802
- <td rowspan="1" colSpan="1" >TXMediaDeviceTypeUnknown</td>
803
-
804
- <td rowspan="1" colSpan="1" >-1</td>
805
-
806
- <td rowspan="1" colSpan="1" >Undefined device type</td>
807
- </tr>
808
-
809
- <tr>
810
- <td rowspan="1" colSpan="1" >TXMediaDeviceTypeMic</td>
811
-
812
- <td rowspan="1" colSpan="1" >0</td>
813
-
814
- <td rowspan="1" colSpan="1" >Microphone-type device</td>
815
- </tr>
816
-
817
- <tr>
818
- <td rowspan="1" colSpan="1" >TXMediaDeviceTypeSpeaker</td>
819
-
820
- <td rowspan="1" colSpan="1" >1</td>
821
-
822
- <td rowspan="1" colSpan="1" >Speaker-type device</td>
823
- </tr>
824
-
825
- <tr>
826
- <td rowspan="1" colSpan="1" >TXMediaDeviceTypeCamera</td>
827
-
828
- <td rowspan="1" colSpan="1" >2</td>
829
-
830
- <td rowspan="1" colSpan="1" >Camera-type device</td>
831
- </tr>
832
- </table>
833
-
326
+ | Enumeration | Value | Description |
327
+ | --- | --- | --- |
328
+ | TXMediaDeviceTypeUnknown | -1 | Undefined device type |
329
+ | TXMediaDeviceTypeMic | 0 | Microphone-type device |
330
+ | TXMediaDeviceTypeSpeaker | 1 | Speaker-type device |
331
+ | TXMediaDeviceTypeCamera | 2 | Camera-type device |
834
332
 
835
333
  ## TXMediaDeviceState
836
334
 
837
-
838
-
839
335
  #### Device operations
840
336
 
841
337
  This enumerated value is used for local equipment status change notification onDeviceChanged.
842
- <table>
843
- <tr>
844
- <td rowspan="1" colSpan="1" >Enumeration</td>
845
-
846
- <td rowspan="1" colSpan="1" >Value</td>
847
-
848
- <td rowspan="1" colSpan="1" >Description</td>
849
- </tr>
850
-
851
- <tr>
852
- <td rowspan="1" colSpan="1" >TXMediaDeviceStateAdd</td>
853
-
854
- <td rowspan="1" colSpan="1" >0</td>
855
-
856
- <td rowspan="1" colSpan="1" >Device inserted</td>
857
- </tr>
858
-
859
- <tr>
860
- <td rowspan="1" colSpan="1" >TXMediaDeviceStateRemove</td>
861
-
862
- <td rowspan="1" colSpan="1" >1</td>
863
-
864
- <td rowspan="1" colSpan="1" >Device removed</td>
865
- </tr>
866
-
867
- <tr>
868
- <td rowspan="1" colSpan="1" >TXMediaDeviceStateActive</td>
869
-
870
- <td rowspan="1" colSpan="1" >2</td>
871
-
872
- <td rowspan="1" colSpan="1" >Device enabled</td>
873
- </tr>
874
-
875
- <tr>
876
- <td rowspan="1" colSpan="1" >TXMediaDefaultDeviceChanged</td>
877
-
878
- <td rowspan="1" colSpan="1" >3</td>
879
-
880
- <td rowspan="1" colSpan="1" >System default device changed</td>
881
- </tr>
882
- </table>
883
-
338
+ | Enumeration | Value | Description |
339
+ | --- | --- | --- |
340
+ | TXMediaDeviceStateAdd | 0 | Device inserted |
341
+ | TXMediaDeviceStateRemove | 1 | Device removed |
342
+ | TXMediaDeviceStateActive | 2 | Device enabled |
343
+ | TXMediaDefaultDeviceChanged | 3 | System default device changed |
884
344
 
885
345
  ## TXCameraCaptureMode
886
346
 
887
-
888
-
889
347
  #### Camera capture preferences
890
348
 
891
349
  This enumeration type is used for camera collection parameter settings.
892
- <table>
893
- <tr>
894
- <td rowspan="1" colSpan="1" >Enumeration</td>
895
-
896
- <td rowspan="1" colSpan="1" >Value</td>
897
-
898
- <td rowspan="1" colSpan="1" >Description</td>
899
- </tr>
900
-
901
- <tr>
902
- <td rowspan="1" colSpan="1" >TXCameraResolutionStrategyAuto</td>
903
-
904
- <td rowspan="1" colSpan="1" >0</td>
905
-
906
- <td rowspan="1" colSpan="1" >Auto-adjust collection parameters.<br>The SDK selects appropriate camera output parameters based on the performance of the actual capture device and network conditions, maintaining a balance between device performance and video preview quality.</td>
907
- </tr>
908
-
909
- <tr>
910
- <td rowspan="1" colSpan="1" >TXCameraResolutionStrategyPerformance</td>
911
-
912
- <td rowspan="1" colSpan="1" >1</td>
913
-
914
- <td rowspan="1" colSpan="1" >Prioritize device performance.<br>The SDK selects the closest camera output parameters based on the encoder resolution and frame rate set by the user, thus ensuring device performance.</td>
915
- </tr>
916
-
917
- <tr>
918
- <td rowspan="1" colSpan="1" >TXCameraResolutionStrategyHighQuality</td>
919
-
920
- <td rowspan="1" colSpan="1" >2</td>
921
-
922
- <td rowspan="1" colSpan="1" >Priority is given to ensuring video preview quality.<br>The SDK selects higher camera output parameters to improve the quality of preview video. In this case, more CPU and memory will be consumed for video preprocessing.</td>
923
- </tr>
924
-
925
- <tr>
926
- <td rowspan="1" colSpan="1" >TXCameraCaptureManual</td>
927
-
928
- <td rowspan="1" colSpan="1" >3</td>
929
-
930
- <td rowspan="1" colSpan="1" >Users are allowed to set the video aspect ratio captured by the local camera.</td>
931
- </tr>
932
- </table>
933
-
350
+ | Enumeration | Value | Description |
351
+ | --- | --- | --- |
352
+ | TXCameraResolutionStrategyAuto | 0 | Auto-adjust collection parameters.<br>The SDK selects appropriate camera output parameters based on the performance of the actual capture device and network conditions, maintaining a balance between device performance and video preview quality. |
353
+ | TXCameraResolutionStrategyPerformance | 1 | Prioritize device performance.<br>The SDK selects the closest camera output parameters based on the encoder resolution and frame rate set by the user, thus ensuring device performance. |
354
+ | TXCameraResolutionStrategyHighQuality | 2 | Priority is given to ensuring video preview quality.<br>The SDK selects higher camera output parameters to improve the quality of preview video. In this case, more CPU and memory will be consumed for video preprocessing. |
355
+ | TXCameraCaptureManual | 3 | Users are allowed to set the video aspect ratio captured by the local camera. |
934
356
 
935
357
  ## TXCameraCaptureParam
936
358
 
937
-
938
-
939
359
  #### Camera collection parameters
940
360
 
941
361
  This setting determines the image quality of the local preview.
942
- <table>
943
- <tr>
944
- <td rowspan="1" colSpan="1" >Enumeration Types</td>
945
-
946
- <td rowspan="1" colSpan="1" >Description</td>
947
- </tr>
948
-
949
- <tr>
950
- <td rowspan="1" colSpan="1" >height</td>
951
-
952
- <td rowspan="1" colSpan="1" >**Field Definition:** Captured Image Width</td>
953
- </tr>
954
-
955
- <tr>
956
- <td rowspan="1" colSpan="1" >mode</td>
957
-
958
- <td rowspan="1" colSpan="1" >**Field Definition:** Camera Capture Preferences, refer to [TXCameraCaptureMode](https://write.woa.com/document/87030115247763456)</td>
959
- </tr>
960
-
961
- <tr>
962
- <td rowspan="1" colSpan="1" >width</td>
963
-
964
- <td rowspan="1" colSpan="1" >**Field Definition:** Captured Image Length</td>
965
- </tr>
966
- </table>
967
-
362
+ | Enumeration Types | Description |
363
+ | --- | --- |
364
+ | height | **Field Definition:** Captured Image Width |
365
+ | mode | **Field Definition:** Camera Capture Preferences, refer to TXCameraCaptureMode |
366
+ | width | **Field Definition:** Captured Image Length |
968
367
 
969
368
  ## TXMediaDeviceInfo
970
369
 
971
-
972
-
973
370
  #### Information related to audio and video equipment (only for desktop platform)
974
371
 
975
372
  This structure is used to describe key information of an audio and video device, such as Device ID, Device Name, etc., so that users can select their desired audio and video device in the user interface.
976
- <table>
977
- <tr>
978
- <td rowspan="1" colSpan="1" >Enumeration Types</td>
979
-
980
- <td rowspan="1" colSpan="1" >Description</td>
981
- </tr>
982
-
983
- <tr>
984
- <td rowspan="1" colSpan="1" >getDeviceName()</td>
985
-
986
- <td rowspan="1" colSpan="1" >Device Name (UTF-8)</td>
987
- </tr>
988
-
989
- <tr>
990
- <td rowspan="1" colSpan="1" >getDevicePID()</td>
991
-
992
- <td rowspan="1" colSpan="1" >Device ID (UTF-8)</td>
993
- </tr>
994
- </table>
995
-
373
+ | Enumeration Types | Description |
374
+ | --- | --- |
375
+ | getDeviceName() | Device Name (UTF-8) |
376
+ | getDevicePID() | Device ID (UTF-8) |
996
377
 
997
378
  ## ITXDeviceCollection
998
379
 
999
-
1000
-
1001
380
  #### Device Information List (only for desktop platform)
1002
381
 
1003
382
  This structure functions similarly to std::vector<ITXDeviceInfo>, used to solve binary compatibility issues with different versions of STL containers.
1004
- <table>
1005
- <tr>
1006
- <td rowspan="1" colSpan="1" >Enumeration Types</td>
1007
-
1008
- <td rowspan="1" colSpan="1" >Description</td>
1009
- </tr>
1010
-
1011
- <tr>
1012
- <td rowspan="1" colSpan="1" >getCount()</td>
1013
-
1014
- <td rowspan="1" colSpan="1" >Number of Devices</td>
1015
- </tr>
1016
-
1017
- <tr>
1018
- <td rowspan="1" colSpan="1" >index)</td>
1019
-
1020
- <td rowspan="1" colSpan="1" >Device Information (JSON Format)<br>**Note**<br>Example: {"SupportedResolution":[{"width":640,"height":480},{"width":320,"height":240}]}<br>param index Device Index, value is [0,getCount). Return JSON Format Device Information<br></td>
1021
- </tr>
1022
-
1023
- <tr>
1024
- <td rowspan="1" colSpan="1" >release()</td>
1025
-
1026
- <td rowspan="1" colSpan="1" >Release Device List, please do not use delete to release resources!!!</td>
1027
- </tr>
1028
- </table>
383
+ | Enumeration Types | Description |
384
+ | --- | --- |
385
+ | getCount() | Number of Devices |
386
+ | index) | Device Information (JSON Format)<br>**Note**<br>Example: {"SupportedResolution":[{"width":640,"height":480},{"width":320,"height":240}]}<br>param index Device Index, value is [0,getCount). Return JSON Format Device Information |
387
+ | release() | Release Device List, please do not use delete to release resources!!! |