@tencentcloud/sdk-mcp 1.3.9 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (514) hide show
  1. package/index.js +1 -1
  2. package/index.js.map +1 -1
  3. package/package.json +2 -2
  4. package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/android-faq.md} +75 -308
  5. package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +2 -2
  6. package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/flutter-faq.md} +83 -315
  7. package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/ios-faq.md} +76 -313
  8. package/resource/doc/{tuicallkit/vue/faq.md → callkit/faq/web-faq.md} +78 -311
  9. package/resource/doc/callkit/preset/android/api.md +330 -0
  10. package/resource/doc/{tuicallkit → callkit/preset}/android/integration.md +63 -420
  11. package/resource/doc/callkit/preset/flutter/api.md +401 -0
  12. package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +53 -273
  13. package/resource/doc/callkit/preset/ios/api.md +282 -0
  14. package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +39 -120
  15. package/resource/doc/callkit/preset/react/api.md +600 -0
  16. package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +6 -6
  17. package/resource/doc/callkit/preset/vue/api.md +600 -0
  18. package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +5 -5
  19. package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -37
  20. package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
  21. package/resource/doc/{chatuikit → chatkit}/android/integration.md +30 -126
  22. package/resource/doc/chatkit/faq/android_sdk/client-api.md +280 -0
  23. package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +4 -17
  24. package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -2
  25. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +183 -0
  26. package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
  27. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +279 -0
  28. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +1 -1
  29. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +4 -4
  30. package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
  31. package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +20 -95
  32. package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -37
  33. package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
  34. package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +78 -280
  35. package/resource/doc/{chatuikit/vue → chatkit/react}/components/avatar.md +0 -1
  36. package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +7 -12
  37. package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +10 -17
  38. package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +1 -1
  39. package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -1
  40. package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +122 -703
  41. package/resource/doc/chatkit/react/components/conversation-actions.md +174 -0
  42. package/resource/doc/chatkit/react/components/conversation-list.md +333 -0
  43. package/resource/doc/chatkit/react/components/conversation-preview.md +116 -0
  44. package/resource/doc/chatkit/react/components/conversation-search.md +57 -0
  45. package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -186
  46. package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +21 -113
  47. package/resource/doc/chatkit/react/components/search.md +282 -0
  48. package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +5 -26
  49. package/resource/doc/{chatuikit → chatkit}/react/integration.md +37 -104
  50. package/resource/doc/{chatuikit/react → chatkit/vue}/components/avatar.md +0 -1
  51. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -13
  52. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +13 -18
  53. package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +1 -2
  54. package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -1
  55. package/resource/doc/chatkit/vue/components/contact-list.md +271 -0
  56. package/resource/doc/chatkit/vue/components/conversation-actions.md +228 -0
  57. package/resource/doc/{chatuikit → chatkit}/vue/components/conversation-list.md +42 -316
  58. package/resource/doc/chatkit/vue/components/conversation-preview.md +213 -0
  59. package/resource/doc/chatkit/vue/components/conversation-search.md +50 -0
  60. package/resource/doc/{chatuikit → chatkit}/vue/components/message-input.md +1 -23
  61. package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -134
  62. package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
  63. package/resource/doc/chatkit/vue/components/tuikit.md +45 -0
  64. package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +4 -4
  65. package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
  66. package/resource/doc/{chatuikit → chatkit}/vue/integration.md +53 -121
  67. package/resource/doc/livekit/core-sdk/live/android/api-reference/AudioEffectStore.md +283 -0
  68. package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +148 -0
  69. package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +316 -0
  70. package/resource/doc/livekit/core-sdk/live/android/api-reference/CameraView.md +57 -0
  71. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +419 -0
  72. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +325 -0
  73. package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +436 -0
  74. package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +165 -0
  75. package/resource/doc/livekit/core-sdk/live/android/api-reference/LikeStore.md +49 -0
  76. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +239 -0
  77. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +74 -0
  78. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +417 -0
  79. package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +207 -0
  80. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +17 -88
  81. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audio-effect.md +34 -192
  82. package/resource/doc/livekit/{live → core-sdk/live}/android/live-barrage.md +26 -139
  83. package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +16 -99
  84. package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +54 -161
  85. package/resource/doc/livekit/{live → core-sdk/live}/android/live-gift.md +75 -455
  86. package/resource/doc/livekit/{live → core-sdk/live}/android/live-host-interaction.md +91 -338
  87. package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +108 -492
  88. package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +27 -165
  89. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/AudioEffectStore.md +279 -0
  90. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +158 -0
  91. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BaseBeautyStore.md +155 -0
  92. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +304 -0
  93. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +394 -0
  94. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +303 -0
  95. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +410 -0
  96. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +160 -0
  97. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LikeStore.md +51 -0
  98. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +231 -0
  99. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveCoreView.md +143 -0
  100. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +375 -0
  101. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +170 -0
  102. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +13 -91
  103. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -177
  104. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +18 -102
  105. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -164
  106. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -161
  107. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +66 -460
  108. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
  109. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-integration.md +160 -543
  110. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +22 -161
  111. package/resource/doc/livekit/core-sdk/live/ios/api-reference/AudioEffectStore.md +287 -0
  112. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +165 -0
  113. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +143 -0
  114. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +298 -0
  115. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +349 -0
  116. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +297 -0
  117. package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +471 -0
  118. package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +179 -0
  119. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LikeStore.md +49 -0
  120. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +238 -0
  121. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +74 -0
  122. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +412 -0
  123. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +173 -0
  124. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +23 -96
  125. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +33 -195
  126. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +35 -150
  127. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +20 -105
  128. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +35 -140
  129. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +77 -457
  130. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +70 -317
  131. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +90 -473
  132. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +28 -163
  133. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audience-list.md +17 -88
  134. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audio-effect.md +34 -192
  135. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-barrage.md +26 -139
  136. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-co-guest-interaction.md +53 -262
  137. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-gift.md +75 -455
  138. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-host-interaction.md +60 -272
  139. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-integration.md +63 -440
  140. package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-room-list.md +23 -151
  141. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-audience-list.md +13 -91
  142. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-audio-effect.md +34 -177
  143. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-barrage.md +18 -102
  144. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-co-guest-interaction.md +44 -201
  145. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-gift.md +66 -460
  146. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-integration.md +57 -419
  147. package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-room-list.md +24 -157
  148. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audience-list.md +23 -96
  149. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audio-effect.md +33 -195
  150. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-barrage.md +35 -150
  151. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-co-guest-interaction.md +45 -254
  152. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-gift.md +77 -457
  153. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-host-interaction.md +52 -261
  154. package/resource/doc/livekit/core-sdk/voice/ios/voice-integration.md +478 -0
  155. package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-room-list.md +36 -167
  156. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-audience-list.md +15 -45
  157. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-audio-effect.md +23 -137
  158. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-barrage.md +25 -131
  159. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-co-guest-interaction.md +70 -366
  160. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-gift.md +70 -424
  161. package/resource/doc/livekit/core-sdk/voice/uni-app/voice-integration.md +323 -0
  162. package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-room-list.md +24 -116
  163. package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -3
  164. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +780 -0
  165. package/resource/doc/livekit/preset/live/vue/components/barrage.md +291 -0
  166. package/resource/doc/livekit/{live → preset/live}/vue/components/co-guest-panel.md +9 -48
  167. package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +27 -145
  168. package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +13 -76
  169. package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +33 -224
  170. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +211 -0
  171. package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
  172. package/resource/doc/livekit/preset/live/vue/live-list-integration.md +244 -0
  173. package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +301 -0
  174. package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +307 -0
  175. package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +754 -0
  176. package/resource/doc/roomkit/android/features/call-user-to-room.md +234 -0
  177. package/resource/doc/roomkit/android/features/room-participant-state.md +850 -0
  178. package/resource/doc/roomkit/android/features/room-state.md +358 -0
  179. package/resource/doc/roomkit/android/features/schedule-room.md +336 -0
  180. package/resource/doc/roomkit/android/integration.md +433 -0
  181. package/resource/doc/roomkit/{common/error_code.md → faq/common/error-code.md} +1 -1
  182. package/resource/doc/roomkit/flutter/features/call-user-to-room.md +228 -0
  183. package/resource/doc/roomkit/flutter/features/room-participant-state.md +796 -0
  184. package/resource/doc/roomkit/flutter/features/room-state.md +324 -0
  185. package/resource/doc/roomkit/flutter/features/schedule-room.md +324 -0
  186. package/resource/doc/roomkit/flutter/integration.md +405 -0
  187. package/resource/doc/roomkit/ios/features/call-user-to-room.md +226 -0
  188. package/resource/doc/roomkit/ios/features/room-participant-state.md +821 -0
  189. package/resource/doc/roomkit/ios/features/room-state.md +320 -0
  190. package/resource/doc/roomkit/ios/features/schedule-room.md +318 -0
  191. package/resource/doc/roomkit/ios/integration.md +384 -0
  192. package/resource/doc/roomkit/vue/faq.md +1 -0
  193. package/resource/doc/roomkit/vue/features/call-user-to-room.md +17 -53
  194. package/resource/doc/roomkit/vue/features/device-detection.md +30 -48
  195. package/resource/doc/roomkit/vue/features/device-state.md +24 -44
  196. package/resource/doc/roomkit/vue/features/free-beauty-panel.md +13 -36
  197. package/resource/doc/roomkit/vue/features/room-chat.md +31 -89
  198. package/resource/doc/roomkit/vue/features/room-participant-state.md +28 -50
  199. package/resource/doc/roomkit/vue/features/room-state.md +25 -36
  200. package/resource/doc/roomkit/vue/features/room-view.md +30 -127
  201. package/resource/doc/roomkit/vue/features/schedule-room.md +9 -40
  202. package/resource/doc/roomkit/vue/features/screen-share.md +22 -90
  203. package/resource/doc/roomkit/vue/features/virtual-background.md +13 -34
  204. package/resource/doc/roomkit/vue/integration.md +21 -80
  205. package/resource/doc/rtcengine/faq/common/userSig.md +17 -141
  206. package/resource/doc/rtcengine/faq/web/web.md +15 -22
  207. package/resource/doc/rtcengine/web/api.md +17 -21
  208. package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +4 -10
  209. package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +4 -8
  210. package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +3 -3
  211. package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -3
  212. package/resource/doc/rtcengine/web/plugin/22-advanced-audio-mixer.md +6 -6
  213. package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +2 -2
  214. package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +2 -4
  215. package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +1 -2
  216. package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +2 -6
  217. package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +13 -14
  218. package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +10 -90
  219. package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -8
  220. package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +31 -35
  221. package/resource/doc/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -2
  222. package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +7 -49
  223. package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -1
  224. package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -3
  225. package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +20 -20
  226. package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +1 -1
  227. package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +4 -4
  228. package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
  229. package/resource/doc/trtc/C++/ITRTCCloud.md +718 -2847
  230. package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
  231. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +207 -1041
  232. package/resource/doc/trtc/C++/ITXDeviceManager.md +127 -768
  233. package/resource/doc/trtc/C++/TRTCCloudCallback.md +634 -2259
  234. package/resource/doc/trtc/C++/TRTCTypeDef.md +726 -3465
  235. package/resource/doc/trtc/C++/TXLiteAVCode.md +117 -916
  236. package/resource/doc/trtc/android/TRTCCloud.md +638 -2612
  237. package/resource/doc/trtc/android/TRTCCloudDef.md +769 -3697
  238. package/resource/doc/trtc/android/TRTCCloudListener.md +609 -2070
  239. package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
  240. package/resource/doc/trtc/android/TXAudioEffectManager.md +207 -1049
  241. package/resource/doc/trtc/android/TXBeautyManager.md +127 -704
  242. package/resource/doc/trtc/android/TXDeviceManager.md +51 -318
  243. package/resource/doc/trtc/android/TXLiteAVCode.md +115 -900
  244. package/resource/doc/trtc/iOS/TRTCCloud.md +726 -2930
  245. package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +580 -2099
  246. package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
  247. package/resource/doc/trtc/iOS/TXAudioEffectManager.md +179 -896
  248. package/resource/doc/trtc/iOS/TXBeautyManager.md +128 -710
  249. package/resource/doc/trtc/iOS/TXDeviceManager.md +129 -772
  250. package/resource/doc/trtc/iOS/TXLiteAVCode.md +117 -915
  251. package/resource/doc/trtc/iOS/TXLiveSDKTypeDef.md +747 -3559
  252. package/server.js +1 -5
  253. package/server.js.map +1 -1
  254. package/tools/call/get_callkit_api.js +32 -0
  255. package/tools/call/get_callkit_api.js.map +1 -0
  256. package/tools/call/get_native_call_uikit_integration.js +34 -0
  257. package/tools/call/get_native_call_uikit_integration.js.map +1 -0
  258. package/tools/call/{get-web-call-integration.js → get_web_call_uikit_integration.js} +13 -8
  259. package/tools/call/get_web_call_uikit_integration.js.map +1 -0
  260. package/tools/chat/get_native_chat_uikit_feature_detail.js +34 -0
  261. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +1 -0
  262. package/tools/chat/get_native_chat_uikit_integration.js +45 -0
  263. package/tools/chat/get_native_chat_uikit_integration.js.map +1 -0
  264. package/tools/chat/get_web_chat_uikit_component_detail.js +34 -0
  265. package/tools/chat/get_web_chat_uikit_component_detail.js.map +1 -0
  266. package/tools/chat/get_web_chat_uikit_integration.js +45 -0
  267. package/tools/chat/get_web_chat_uikit_integration.js.map +1 -0
  268. package/tools/common/get_faq.js +265 -0
  269. package/tools/common/get_faq.js.map +1 -0
  270. package/tools/common/{get-usersig.js → get_usersig.js} +6 -3
  271. package/tools/common/get_usersig.js.map +1 -0
  272. package/tools/common/present_framework_choice.js +63 -0
  273. package/tools/common/present_framework_choice.js.map +1 -0
  274. package/tools/common/record_skill_session.js +58 -0
  275. package/tools/common/record_skill_session.js.map +1 -0
  276. package/tools/definitions/get_callkit_api_def.js +28 -0
  277. package/tools/definitions/get_callkit_api_def.js.map +1 -0
  278. package/tools/definitions/get_faq_def.js +18 -19
  279. package/tools/definitions/get_faq_def.js.map +1 -1
  280. package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
  281. package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
  282. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
  283. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
  284. package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -41
  285. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
  286. package/tools/definitions/get_native_livekit_core_features_def.js +33 -0
  287. package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
  288. package/tools/definitions/get_native_livekit_core_integration_def.js +33 -0
  289. package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
  290. package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
  291. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
  292. package/tools/definitions/get_usersig_def.js +17 -24
  293. package/tools/definitions/get_usersig_def.js.map +1 -1
  294. package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
  295. package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
  296. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
  297. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
  298. package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
  299. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
  300. package/tools/definitions/get_web_live_uikit_integration_def.js +13 -18
  301. package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
  302. package/tools/definitions/get_web_livekit_api_def.js +27 -0
  303. package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
  304. package/tools/definitions/get_web_livekit_component_detail_def.js +29 -0
  305. package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
  306. package/tools/definitions/get_web_room_uikit_integration_def.js +13 -46
  307. package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
  308. package/tools/definitions/get_web_roomkit_feature_detail_def.js +30 -0
  309. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
  310. package/tools/definitions/get_web_trtc_sdk_api_def.js +25 -0
  311. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
  312. package/tools/definitions/get_web_trtc_sdk_integration_def.js +25 -0
  313. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
  314. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +25 -0
  315. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
  316. package/tools/definitions/present_framework_choice_def.js +23 -12
  317. package/tools/definitions/present_framework_choice_def.js.map +1 -1
  318. package/tools/definitions/record_skill_session_def.js +31 -0
  319. package/tools/definitions/record_skill_session_def.js.map +1 -0
  320. package/tools/index.js +49 -61
  321. package/tools/index.js.map +1 -1
  322. package/tools/live/get_native_livekit_core_features.js +65 -0
  323. package/tools/live/get_native_livekit_core_features.js.map +1 -0
  324. package/tools/live/get_native_livekit_core_integration.js +59 -0
  325. package/tools/live/get_native_livekit_core_integration.js.map +1 -0
  326. package/tools/live/get_web_live_uikit_integration.js +48 -0
  327. package/tools/live/get_web_live_uikit_integration.js.map +1 -0
  328. package/tools/live/get_web_livekit_api.js +32 -0
  329. package/tools/live/get_web_livekit_api.js.map +1 -0
  330. package/tools/live/get_web_livekit_component_detail.js +34 -0
  331. package/tools/live/get_web_livekit_component_detail.js.map +1 -0
  332. package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
  333. package/tools/room/get_web_room_uikit_integration.js.map +1 -0
  334. package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
  335. package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
  336. package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
  337. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
  338. package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
  339. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
  340. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
  341. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
  342. package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
  343. package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
  344. package/utils/generate-structured-result.js +61 -17
  345. package/utils/generate-structured-result.js.map +1 -1
  346. package/utils/report-cls-client.js +21 -1
  347. package/utils/report-cls-client.js.map +1 -1
  348. package/utils/report-es-client.js +1 -1
  349. package/resource/doc/chatuikit/android/workflow.md +0 -713
  350. package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1376
  351. package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -860
  352. package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1371
  353. package/resource/doc/chatuikit/flutter/workflow.md +0 -816
  354. package/resource/doc/chatuikit/iOS/workflow.md +0 -0
  355. package/resource/doc/chatuikit/react/components/conversation-list.md +0 -765
  356. package/resource/doc/chatuikit/react/components/search.md +0 -885
  357. package/resource/doc/chatuikit/react/create-group.md +0 -22
  358. package/resource/doc/chatuikit/react/init.md +0 -25
  359. package/resource/doc/chatuikit/react/workflow.md +0 -254
  360. package/resource/doc/chatuikit/uniapp-app/faq.md +0 -0
  361. package/resource/doc/chatuikit/uniapp-app/integration.md +0 -619
  362. package/resource/doc/chatuikit/uniapp-app/workflow.md +0 -576
  363. package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
  364. package/resource/doc/chatuikit/vue/components/tuikit.md +0 -110
  365. package/resource/doc/chatuikit/vue/create-group.md +0 -26
  366. package/resource/doc/chatuikit/vue/init.md +0 -35
  367. package/resource/doc/chatuikit/vue/workflow.md +0 -395
  368. package/resource/doc/livekit/live/android/workflow.md +0 -322
  369. package/resource/doc/livekit/live/flutter/workflow.md +0 -353
  370. package/resource/doc/livekit/live/ios/workflow.md +0 -352
  371. package/resource/doc/livekit/live/vue/components/barrage.md +0 -615
  372. package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -442
  373. package/resource/doc/livekit/live/vue/faq.md +0 -0
  374. package/resource/doc/livekit/live/vue/live-list-integration.md +0 -195
  375. package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -293
  376. package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -381
  377. package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -598
  378. package/resource/doc/livekit/live/vue/states/live-state.md +0 -2656
  379. package/resource/doc/livekit/live/vue/workflow.md +0 -219
  380. package/resource/doc/livekit/voice/android/workflow.md +0 -333
  381. package/resource/doc/livekit/voice/flutter/workflow.md +0 -359
  382. package/resource/doc/livekit/voice/ios/voice-integration.md +0 -853
  383. package/resource/doc/livekit/voice/ios/workflow.md +0 -358
  384. package/resource/doc/livekit/voice/uni-app/voice-integration.md +0 -613
  385. package/resource/doc/livekit/voice/uni-app/workflow.md +0 -369
  386. package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -334
  387. package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -434
  388. package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -685
  389. package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -712
  390. package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -284
  391. package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
  392. package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
  393. package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
  394. package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
  395. package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -879
  396. package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -668
  397. package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -456
  398. package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -332
  399. package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
  400. package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -328
  401. package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -505
  402. package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
  403. package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -676
  404. package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
  405. package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -820
  406. package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1065
  407. package/resource/doc/roomkit/vue/features/workflow.md +0 -553
  408. package/resource/doc/roomkit/vue/workflow.md +0 -733
  409. package/resource/doc/tuicallkit/android/workflow.md +0 -432
  410. package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -786
  411. package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -663
  412. package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -932
  413. package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -926
  414. package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -452
  415. package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -779
  416. package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -635
  417. package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
  418. package/resource/doc/tuicallkit/react/api.md +0 -1512
  419. package/resource/doc/tuicallkit/react/faq.md +0 -986
  420. package/resource/doc/tuicallkit/vue/api.md +0 -1512
  421. package/tools/call/get-native-call-integration.js +0 -43
  422. package/tools/call/get-native-call-integration.js.map +0 -1
  423. package/tools/call/get-web-call-api.js +0 -27
  424. package/tools/call/get-web-call-api.js.map +0 -1
  425. package/tools/call/get-web-call-integration.js.map +0 -1
  426. package/tools/chat/get-native-chat-feature-detail.js +0 -30
  427. package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
  428. package/tools/chat/get-native-chat-integration.js +0 -45
  429. package/tools/chat/get-native-chat-integration.js.map +0 -1
  430. package/tools/chat/get-web-chat-component-detail.js +0 -31
  431. package/tools/chat/get-web-chat-component-detail.js.map +0 -1
  432. package/tools/chat/get-web-chat-integration.js +0 -45
  433. package/tools/chat/get-web-chat-integration.js.map +0 -1
  434. package/tools/chat/get-web-chat-uikit-init.js +0 -28
  435. package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
  436. package/tools/chat/get-web-create-group-doc.js +0 -28
  437. package/tools/chat/get-web-create-group-doc.js.map +0 -1
  438. package/tools/common/get-faq.js +0 -91
  439. package/tools/common/get-faq.js.map +0 -1
  440. package/tools/common/get-usersig.js.map +0 -1
  441. package/tools/common/present-framework-choice.js +0 -16
  442. package/tools/common/present-framework-choice.js.map +0 -1
  443. package/tools/common/present-scenario-choice.js +0 -16
  444. package/tools/common/present-scenario-choice.js.map +0 -1
  445. package/tools/common/record-prompt.js +0 -55
  446. package/tools/common/record-prompt.js.map +0 -1
  447. package/tools/common/record-result.js +0 -60
  448. package/tools/common/record-result.js.map +0 -1
  449. package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
  450. package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
  451. package/tools/definitions/get_native_live_api_def.js +0 -22
  452. package/tools/definitions/get_native_live_api_def.js.map +0 -1
  453. package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -109
  454. package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
  455. package/tools/definitions/get_native_live_uikit_integration_def.js +0 -75
  456. package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
  457. package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
  458. package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
  459. package/tools/definitions/get_trtc_native_api_def.js +0 -17
  460. package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
  461. package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
  462. package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
  463. package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
  464. package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
  465. package/tools/definitions/get_web_create_group_doc_def.js +0 -18
  466. package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
  467. package/tools/definitions/get_web_live_state_detail_def.js +0 -19
  468. package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
  469. package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
  470. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
  471. package/tools/definitions/get_web_room_feature_detail_def.js +0 -92
  472. package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
  473. package/tools/definitions/present_scenario_choice_def.js +0 -53
  474. package/tools/definitions/present_scenario_choice_def.js.map +0 -1
  475. package/tools/definitions/record_prompt_def.js +0 -58
  476. package/tools/definitions/record_prompt_def.js.map +0 -1
  477. package/tools/definitions/record_result_def.js +0 -46
  478. package/tools/definitions/record_result_def.js.map +0 -1
  479. package/tools/live/get-native-live-uikit-integration.js +0 -177
  480. package/tools/live/get-native-live-uikit-integration.js.map +0 -1
  481. package/tools/live/get-web-live-component-detail.js +0 -31
  482. package/tools/live/get-web-live-component-detail.js.map +0 -1
  483. package/tools/live/get-web-live-state-detail.js +0 -31
  484. package/tools/live/get-web-live-state-detail.js.map +0 -1
  485. package/tools/live/get-web-live-uikit-integration.js +0 -52
  486. package/tools/live/get-web-live-uikit-integration.js.map +0 -1
  487. package/tools/live/get_native_live_uikit_extra_features.js +0 -105
  488. package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
  489. package/tools/live/get_native_live_uikit_interaction.js +0 -194
  490. package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
  491. package/tools/native_live/get-native-live-api.js +0 -31
  492. package/tools/native_live/get-native-live-api.js.map +0 -1
  493. package/tools/room/get-web-room-feature-detail.js.map +0 -1
  494. package/tools/room/get-web-room-integration.js.map +0 -1
  495. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
  496. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
  497. package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
  498. package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
  499. package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
  500. package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
  501. package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
  502. package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
  503. package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
  504. package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
  505. package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
  506. package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
  507. package/tools/trtc/get-trtc-native-api.js +0 -31
  508. package/tools/trtc/get-trtc-native-api.js.map +0 -1
  509. package/utils/handle-component-name.js +0 -33
  510. package/utils/handle-component-name.js.map +0 -1
  511. /package/resource/doc/{rtcengine/web → callkit/core-sdk}/.gitkeep +0 -0
  512. /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
  513. /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
  514. /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
@@ -3,333 +3,89 @@
3
3
  ## 概述
4
4
  `ITXDeviceManager.h` 是腾讯云实时音视频(TRTC SDK ) C++ 的音视频设备管理模块文档,用于管理摄像头、麦克风和扬声器等音视频相关的硬件设备。
5
5
 
6
-
7
6
  ## ITXDeviceManager
8
- <table>
9
- <tr>
10
- <td rowspan="1" colSpan="1" >函数列表</td>
11
-
12
- <td rowspan="1" colSpan="1" >描述</td>
13
- </tr>
14
-
15
- <tr>
16
- <td rowspan="1" colSpan="1" >[isFrontCamera](https://write.woa.com/document/87030115247763456)</td>
17
-
18
- <td rowspan="1" colSpan="1" >判断当前是否为前置摄像头(仅适用于移动端)。</td>
19
- </tr>
20
-
21
- <tr>
22
- <td rowspan="1" colSpan="1" >[switchCamera](https://write.woa.com/document/87030115247763456)</td>
23
-
24
- <td rowspan="1" colSpan="1" >切换前置或后置摄像头(仅适用于移动端)。</td>
25
- </tr>
26
-
27
- <tr>
28
- <td rowspan="1" colSpan="1" >[getCameraZoomMaxRatio](https://write.woa.com/document/87030115247763456)</td>
29
-
30
- <td rowspan="1" colSpan="1" >获取摄像头的最大缩放倍数(仅适用于移动端)。</td>
31
- </tr>
32
-
33
- <tr>
34
- <td rowspan="1" colSpan="1" >[setCameraZoomRatio](https://write.woa.com/document/87030115247763456)</td>
35
-
36
- <td rowspan="1" colSpan="1" >设置摄像头的缩放倍数(仅适用于移动端)。</td>
37
- </tr>
38
-
39
- <tr>
40
- <td rowspan="1" colSpan="1" >[isAutoFocusEnabled](https://write.woa.com/document/87030115247763456)</td>
41
-
42
- <td rowspan="1" colSpan="1" >查询是否支持自动识别人脸位置(仅适用于移动端)。</td>
43
- </tr>
44
-
45
- <tr>
46
- <td rowspan="1" colSpan="1" >[enableCameraAutoFocus](https://write.woa.com/document/87030115247763456)</td>
47
-
48
- <td rowspan="1" colSpan="1" >开启自动对焦功能(仅适用于移动端)。</td>
49
- </tr>
50
-
51
- <tr>
52
- <td rowspan="1" colSpan="1" >[setCameraFocusPosition](https://write.woa.com/document/87030115247763456)</td>
53
-
54
- <td rowspan="1" colSpan="1" >设置摄像头的对焦位置(仅适用于移动端)。</td>
55
- </tr>
56
-
57
- <tr>
58
- <td rowspan="1" colSpan="1" >[enableCameraTorch](https://write.woa.com/document/87030115247763456)</td>
59
-
60
- <td rowspan="1" colSpan="1" >开启/关闭闪光灯,也就是手电筒模式(仅适用于移动端)。</td>
61
- </tr>
62
-
63
- <tr>
64
- <td rowspan="1" colSpan="1" >[setAudioRoute](https://write.woa.com/document/87030115247763456)</td>
65
-
66
- <td rowspan="1" colSpan="1" >设置音频路由(仅适用于移动端)。</td>
67
- </tr>
68
-
69
- <tr>
70
- <td rowspan="1" colSpan="1" >[getDevicesList](https://write.woa.com/document/87030115247763456)</td>
71
-
72
- <td rowspan="1" colSpan="1" >获取设备列表(仅适用于桌面端)。</td>
73
- </tr>
74
-
75
- <tr>
76
- <td rowspan="1" colSpan="1" >[setCurrentDevice](https://write.woa.com/document/87030115247763456)</td>
77
-
78
- <td rowspan="1" colSpan="1" >设置当前要使用的设备(仅适用于桌面端)。</td>
79
- </tr>
80
-
81
- <tr>
82
- <td rowspan="1" colSpan="1" >[getCurrentDevice](https://write.woa.com/document/87030115247763456)</td>
83
-
84
- <td rowspan="1" colSpan="1" >获取当前正在使用的设备(仅适用于桌面端)。</td>
85
- </tr>
86
-
87
- <tr>
88
- <td rowspan="1" colSpan="1" >[setCurrentDeviceVolume](https://write.woa.com/document/87030115247763456)</td>
89
-
90
- <td rowspan="1" colSpan="1" >设置当前设备的音量(仅适用于桌面端)。</td>
91
- </tr>
92
-
93
- <tr>
94
- <td rowspan="1" colSpan="1" >[getCurrentDeviceVolume](https://write.woa.com/document/87030115247763456)</td>
95
-
96
- <td rowspan="1" colSpan="1" >获取当前设备的音量(仅适用于桌面端)。</td>
97
- </tr>
98
-
99
- <tr>
100
- <td rowspan="1" colSpan="1" >[setCurrentDeviceMute](https://write.woa.com/document/87030115247763456)</td>
101
-
102
- <td rowspan="1" colSpan="1" >设置当前设备的静音状态(仅适用于桌面端)。</td>
103
- </tr>
104
-
105
- <tr>
106
- <td rowspan="1" colSpan="1" >[getCurrentDeviceMute](https://write.woa.com/document/87030115247763456)</td>
107
-
108
- <td rowspan="1" colSpan="1" >获取当前设备的静音状态(仅适用于桌面端)。</td>
109
- </tr>
110
-
111
- <tr>
112
- <td rowspan="1" colSpan="1" >[enableFollowingDefaultAudioDevice](https://write.woa.com/document/87030115247763456)</td>
113
-
114
- <td rowspan="1" colSpan="1" >设置 SDK 使用的音频设备根据跟随系统默认设备(仅适用于桌面端)。</td>
115
- </tr>
116
-
117
- <tr>
118
- <td rowspan="1" colSpan="1" >[startCameraDeviceTest](https://write.woa.com/document/87030115247763456)</td>
119
-
120
- <td rowspan="1" colSpan="1" >开始摄像头测试(仅适用于桌面端)。</td>
121
- </tr>
122
-
123
- <tr>
124
- <td rowspan="1" colSpan="1" >[stopCameraDeviceTest](https://write.woa.com/document/87030115247763456)</td>
125
-
126
- <td rowspan="1" colSpan="1" >结束摄像头测试(仅适用于桌面端)。</td>
127
- </tr>
128
-
129
- <tr>
130
- <td rowspan="1" colSpan="1" >[startMicDeviceTest](https://write.woa.com/document/87030115247763456)</td>
131
-
132
- <td rowspan="1" colSpan="1" >开始麦克风测试(仅适用于桌面端)。</td>
133
- </tr>
134
-
135
- <tr>
136
- <td rowspan="1" colSpan="1" >[startMicDeviceTest](https://write.woa.com/document/87030115247763456)</td>
137
-
138
- <td rowspan="1" colSpan="1" >开始麦克风测试(仅适用于桌面端)。</td>
139
- </tr>
140
-
141
- <tr>
142
- <td rowspan="1" colSpan="1" >[stopMicDeviceTest](https://write.woa.com/document/87030115247763456)</td>
143
-
144
- <td rowspan="1" colSpan="1" >结束麦克风测试(仅适用于桌面端)。</td>
145
- </tr>
146
-
147
- <tr>
148
- <td rowspan="1" colSpan="1" >[startSpeakerDeviceTest](https://write.woa.com/document/87030115247763456)</td>
149
-
150
- <td rowspan="1" colSpan="1" >开始扬声器测试(仅适用于桌面端)。</td>
151
- </tr>
152
-
153
- <tr>
154
- <td rowspan="1" colSpan="1" >[stopSpeakerDeviceTest](https://write.woa.com/document/87030115247763456)</td>
155
-
156
- <td rowspan="1" colSpan="1" >结束扬声器测试(仅适用于桌面端)。</td>
157
- </tr>
158
-
159
- <tr>
160
- <td rowspan="1" colSpan="1" >[startCameraDeviceTest](https://write.woa.com/document/87030115247763456)</td>
161
-
162
- <td rowspan="1" colSpan="1" >开始摄像头测试(仅适用于桌面端)。</td>
163
- </tr>
164
-
165
- <tr>
166
- <td rowspan="1" colSpan="1" >[setApplicationPlayVolume](https://write.woa.com/document/87030115247763456)</td>
167
-
168
- <td rowspan="1" colSpan="1" >设置 Windows 系统音量合成器中当前进程的音量(仅适用于 Windows 系统)。</td>
169
- </tr>
170
-
171
- <tr>
172
- <td rowspan="1" colSpan="1" >[getApplicationPlayVolume](https://write.woa.com/document/87030115247763456)</td>
173
-
174
- <td rowspan="1" colSpan="1" >获取 Windows 系统音量合成器中当前进程的音量(仅适用于 Windows 系统)。</td>
175
- </tr>
176
-
177
- <tr>
178
- <td rowspan="1" colSpan="1" >[setApplicationMuteState](https://write.woa.com/document/87030115247763456)</td>
179
-
180
- <td rowspan="1" colSpan="1" >设置 Windows 系统音量合成器中当前进程的静音状态(仅适用于 Windows 系统)。</td>
181
- </tr>
182
-
183
- <tr>
184
- <td rowspan="1" colSpan="1" >[getApplicationMuteState](https://write.woa.com/document/87030115247763456)</td>
185
-
186
- <td rowspan="1" colSpan="1" >获取 Windows 系统音量合成器中当前进程的静音状态(仅适用于 Windows 系统)。</td>
187
- </tr>
188
-
189
- <tr>
190
- <td rowspan="1" colSpan="1" >[setCameraCapturerParam](https://write.woa.com/document/87030115247763456)</td>
191
-
192
- <td rowspan="1" colSpan="1" >设置摄像头采集偏好。</td>
193
- </tr>
194
-
195
- <tr>
196
- <td rowspan="1" colSpan="1" >[setDeviceObserver](https://write.woa.com/document/87030115247763456)</td>
197
-
198
- <td rowspan="1" colSpan="1" >设置 onDeviceChanged 事件回调。</td>
199
- </tr>
200
-
201
- <tr>
202
- <td rowspan="1" colSpan="1" >[setSystemVolumeType](https://write.woa.com/document/87030115247763456)</td>
203
-
204
- <td rowspan="1" colSpan="1" >设置系统音量类型(仅适用于移动端)。</td>
205
- </tr>
206
- </table>
207
-
7
+ | 函数列表 | 描述 |
8
+ | --- | --- |
9
+ | isFrontCamera | 判断当前是否为前置摄像头(仅适用于移动端)。 |
10
+ | switchCamera | 切换前置或后置摄像头(仅适用于移动端)。 |
11
+ | getCameraZoomMaxRatio | 获取摄像头的最大缩放倍数(仅适用于移动端)。 |
12
+ | setCameraZoomRatio | 设置摄像头的缩放倍数(仅适用于移动端)。 |
13
+ | isAutoFocusEnabled | 查询是否支持自动识别人脸位置(仅适用于移动端)。 |
14
+ | enableCameraAutoFocus | 开启自动对焦功能(仅适用于移动端)。 |
15
+ | setCameraFocusPosition | 设置摄像头的对焦位置(仅适用于移动端)。 |
16
+ | enableCameraTorch | 开启/关闭闪光灯,也就是手电筒模式(仅适用于移动端)。 |
17
+ | setAudioRoute | 设置音频路由(仅适用于移动端)。 |
18
+ | getDevicesList | 获取设备列表(仅适用于桌面端)。 |
19
+ | setCurrentDevice | 设置当前要使用的设备(仅适用于桌面端)。 |
20
+ | getCurrentDevice | 获取当前正在使用的设备(仅适用于桌面端)。 |
21
+ | setCurrentDeviceVolume | 设置当前设备的音量(仅适用于桌面端)。 |
22
+ | getCurrentDeviceVolume | 获取当前设备的音量(仅适用于桌面端)。 |
23
+ | setCurrentDeviceMute | 设置当前设备的静音状态(仅适用于桌面端)。 |
24
+ | getCurrentDeviceMute | 获取当前设备的静音状态(仅适用于桌面端)。 |
25
+ | enableFollowingDefaultAudioDevice | 设置 SDK 使用的音频设备根据跟随系统默认设备(仅适用于桌面端)。 |
26
+ | startCameraDeviceTest | 开始摄像头测试(仅适用于桌面端)。 |
27
+ | stopCameraDeviceTest | 结束摄像头测试(仅适用于桌面端)。 |
28
+ | startMicDeviceTest | 开始麦克风测试(仅适用于桌面端)。 |
29
+ | startMicDeviceTest | 开始麦克风测试(仅适用于桌面端)。 |
30
+ | stopMicDeviceTest | 结束麦克风测试(仅适用于桌面端)。 |
31
+ | startSpeakerDeviceTest | 开始扬声器测试(仅适用于桌面端)。 |
32
+ | stopSpeakerDeviceTest | 结束扬声器测试(仅适用于桌面端)。 |
33
+ | startCameraDeviceTest | 开始摄像头测试(仅适用于桌面端)。 |
34
+ | setApplicationPlayVolume | 设置 Windows 系统音量合成器中当前进程的音量(仅适用于 Windows 系统)。 |
35
+ | getApplicationPlayVolume | 获取 Windows 系统音量合成器中当前进程的音量(仅适用于 Windows 系统)。 |
36
+ | setApplicationMuteState | 设置 Windows 系统音量合成器中当前进程的静音状态(仅适用于 Windows 系统)。 |
37
+ | getApplicationMuteState | 获取 Windows 系统音量合成器中当前进程的静音状态(仅适用于 Windows 系统)。 |
38
+ | setCameraCapturerParam | 设置摄像头采集偏好。 |
39
+ | setDeviceObserver | 设置 onDeviceChanged 事件回调。 |
40
+ | setSystemVolumeType | 设置系统音量类型(仅适用于移动端)。 |
208
41
 
209
42
  ## 结构体类型
210
- <table>
211
- <tr>
212
- <td rowspan="1" colSpan="1" >函数列表</td>
213
-
214
- <td rowspan="1" colSpan="1" >描述</td>
215
- </tr>
216
-
217
- <tr>
218
- <td rowspan="1" colSpan="1" >[TXCameraCaptureParam](https://write.woa.com/document/87030115247763456)</td>
219
-
220
- <td rowspan="1" colSpan="1" >摄像头采集参数。</td>
221
- </tr>
222
-
223
- <tr>
224
- <td rowspan="1" colSpan="1" >[ITXDeviceInfo](https://write.woa.com/document/87030115247763456)</td>
225
-
226
- <td rowspan="1" colSpan="1" >音视频设备的相关信息(仅适用于桌面平台)。</td>
227
- </tr>
228
-
229
- <tr>
230
- <td rowspan="1" colSpan="1" >[ITXDeviceCollection](https://write.woa.com/document/87030115247763456)</td>
231
-
232
- <td rowspan="1" colSpan="1" >设备信息列表(仅适用于桌面平台)。</td>
233
- </tr>
234
- </table>
235
-
43
+ | 函数列表 | 描述 |
44
+ | --- | --- |
45
+ | TXCameraCaptureParam | 摄像头采集参数。 |
46
+ | ITXDeviceInfo | 音视频设备的相关信息(仅适用于桌面平台)。 |
47
+ | ITXDeviceCollection | 设备信息列表(仅适用于桌面平台)。 |
236
48
 
237
49
  ## 枚举类型
238
- <table>
239
- <tr>
240
- <td rowspan="1" colSpan="1" >枚举类型</td>
241
-
242
- <td rowspan="1" colSpan="1" >描述</td>
243
- </tr>
244
-
245
- <tr>
246
- <td rowspan="1" colSpan="1" >[TXSystemVolumeType](https://write.woa.com/document/87030115247763456)</td>
247
-
248
- <td rowspan="1" colSpan="1" >系统音量类型(仅适用于移动设备)。</td>
249
- </tr>
250
-
251
- <tr>
252
- <td rowspan="1" colSpan="1" >[TXAudioRoute](https://write.woa.com/document/87030115247763456)</td>
253
-
254
- <td rowspan="1" colSpan="1" >音频路由(即声音的播放模式)。</td>
255
- </tr>
256
-
257
- <tr>
258
- <td rowspan="1" colSpan="1" >[TXMediaDeviceType](https://write.woa.com/document/87030115247763456)</td>
259
-
260
- <td rowspan="1" colSpan="1" >设备类型(仅适用于桌面平台)。</td>
261
- </tr>
262
-
263
- <tr>
264
- <td rowspan="1" colSpan="1" >[TXMediaDeviceState](https://write.woa.com/document/87030115247763456)</td>
265
-
266
- <td rowspan="1" colSpan="1" >设备操作。</td>
267
- </tr>
268
-
269
- <tr>
270
- <td rowspan="1" colSpan="1" >[TXCameraCaptureMode](https://write.woa.com/document/87030115247763456)</td>
271
-
272
- <td rowspan="1" colSpan="1" >摄像头采集偏好。</td>
273
- </tr>
274
- </table>
275
-
50
+ | 枚举类型 | 描述 |
51
+ | --- | --- |
52
+ | TXSystemVolumeType | 系统音量类型(仅适用于移动设备)。 |
53
+ | TXAudioRoute | 音频路由(即声音的播放模式)。 |
54
+ | TXMediaDeviceType | 设备类型(仅适用于桌面平台)。 |
55
+ | TXMediaDeviceState | 设备操作。 |
56
+ | TXCameraCaptureMode | 摄像头采集偏好。 |
276
57
 
277
58
  ## isFrontCamera
278
59
 
279
-
280
-
281
60
  #### 判断当前是否为前置摄像头(仅适用于移动端)。
282
61
 
283
62
  ## switchCamera
284
63
 
285
-
286
-
287
64
  #### 切换前置或后置摄像头(仅适用于移动端)。
288
65
 
289
66
  ## getCameraZoomMaxRatio
290
67
 
291
-
292
-
293
68
  #### 获取摄像头的最大缩放倍数(仅适用于移动端)。
294
69
 
295
70
  ## setCameraZoomRatio
296
71
 
297
-
298
-
299
72
  #### 设置摄像头的缩放倍数(仅适用于移动端)。
300
- <table>
301
- <tr>
302
- <td rowspan="1" colSpan="1" >参数</td>
303
-
304
- <td rowspan="1" colSpan="1" >描述</td>
305
- </tr>
306
-
307
- <tr>
308
- <td rowspan="1" colSpan="1" >zoomRatio</td>
309
-
310
- <td rowspan="1" colSpan="1" >取值范围 [1, 5],取值为1表示最远视角(正常镜头),取值为5表示最近视角(放大镜头)。最大值推荐为5,若超过5,视频数据会变得模糊不清。</td>
311
- </tr>
312
- </table>
313
-
73
+ | 参数 | 描述 |
74
+ | --- | --- |
75
+ | zoomRatio | 取值范围 [1, 5],取值为1表示最远视角(正常镜头),取值为5表示最近视角(放大镜头)。最大值推荐为5,若超过5,视频数据会变得模糊不清。 |
314
76
 
315
77
  ## isAutoFocusEnabled
316
78
 
317
-
318
-
319
79
  #### 查询是否支持自动识别人脸位置(仅适用于移动端)。
320
80
 
321
81
  ## enableCameraAutoFocus
322
82
 
323
-
324
-
325
83
  #### 开启自动对焦功能(仅适用于移动端)。
326
84
 
327
85
  开启后,SDK 会自动检测画面中的人脸位置,并将摄像头的焦点始终对焦在人脸位置上。
328
86
 
329
87
  ## setCameraFocusPosition
330
88
 
331
-
332
-
333
89
  #### 设置摄像头的对焦位置(仅适用于移动端)。
334
90
 
335
91
  您可以通过该接口实现如下交互:
@@ -339,27 +95,15 @@
339
95
  2. 在用户的单击位置显示一个矩形方框,以示摄像头会在此处对焦。
340
96
 
341
97
  3. 随后将用户点击位置的坐标通过本接口传递给 SDK,之后 SDK 会操控摄像头按照用户期望的位置进行对焦。
342
- <table>
343
- <tr>
344
- <td rowspan="1" colSpan="1" >参数</td>
345
-
346
- <td rowspan="1" colSpan="1" >描述</td>
347
- </tr>
348
-
349
- <tr>
350
- <td rowspan="1" colSpan="1" >position</td>
351
-
352
- <td rowspan="1" colSpan="1" >对焦位置,请传入期望对焦点的坐标值</td>
353
- </tr>
354
- </table>
355
-
98
+ | 参数 | 描述 |
99
+ | --- | --- |
100
+ | position | 对焦位置,请传入期望对焦点的坐标值 |
356
101
 
357
102
  > **注意**
358
- >
359
-
360
- > 使用该接口的前提是先通过 [enableCameraAutoFocus](https://write.woa.com/document/87030115247763456) 关闭自动对焦功能。
361
- >
103
+ >
362
104
 
105
+ > 使用该接口的前提是先通过 enableCameraAutoFocus 关闭自动对焦功能。
106
+ >
363
107
 
364
108
  #### 返回值说明:
365
109
 
@@ -367,14 +111,10 @@
367
111
 
368
112
  ## enableCameraTorch
369
113
 
370
-
371
-
372
114
  #### 开启/关闭闪光灯,也就是手电筒模式(仅适用于移动端)。
373
115
 
374
116
  ## setAudioRoute
375
117
 
376
-
377
-
378
118
  #### 设置音频路由(仅适用于移动端)。
379
119
 
380
120
  手机有两个音频播放设备:一个是位于手机顶部的听筒,一个是位于手机底部的立体声扬声器。
@@ -385,57 +125,25 @@
385
125
 
386
126
  ## getDevicesList
387
127
 
388
-
389
-
390
128
  #### 获取设备列表(仅适用于桌面端)。
391
- <table>
392
- <tr>
393
- <td rowspan="1" colSpan="1" >参数</td>
394
-
395
- <td rowspan="1" colSpan="1" >描述</td>
396
- </tr>
397
-
398
- <tr>
399
- <td rowspan="1" colSpan="1" >type</td>
400
-
401
- <td rowspan="1" colSpan="1" >设备类型,指定需要获取哪种设备的列表。详见 [TXMediaDeviceType](https://write.woa.com/document/87030115247763456) 定义。</td>
402
- </tr>
403
- </table>
404
-
129
+ | 参数 | 描述 |
130
+ | --- | --- |
131
+ | type | 设备类型,指定需要获取哪种设备的列表。详见 TXMediaDeviceType 定义。 |
405
132
 
406
133
  > **注意**
407
- >
134
+ >
408
135
  > - 使用完毕后请调用 release 方法释放资源,这样可以让 SDK 维护 ITXDeviceCollection 对象的生命周期。
409
136
  > - 不要使用 delete 释放返回的 Collection 对象,` delete ITXDeviceCollection* ` 指针会导致异常崩溃。
410
137
  > - type 只支持 ` TXMediaDeviceTypeMic `、` TXMediaDeviceTypeSpeaker `、` TXMediaDeviceTypeCamera `。
411
138
  > - 此接口只支持 Mac 和 Windows 平台。
412
139
 
413
-
414
140
  ## setCurrentDevice
415
141
 
416
-
417
-
418
142
  #### 设置当前要使用的设备(仅适用于桌面端)。
419
- <table>
420
- <tr>
421
- <td rowspan="1" colSpan="1" >参数</td>
422
-
423
- <td rowspan="1" colSpan="1" >描述</td>
424
- </tr>
425
-
426
- <tr>
427
- <td rowspan="1" colSpan="1" >deviceId</td>
428
-
429
- <td rowspan="1" colSpan="1" >设备ID,您可以通过接口 [getDevicesList](https://write.woa.com/document/87030115247763456) 获得设备 ID。</td>
430
- </tr>
431
-
432
- <tr>
433
- <td rowspan="1" colSpan="1" >type</td>
434
-
435
- <td rowspan="1" colSpan="1" >设备类型,详见 TXMediaDeviceType 定义。</td>
436
- </tr>
437
- </table>
438
-
143
+ | 参数 | 描述 |
144
+ | --- | --- |
145
+ | deviceId | 设备ID,您可以通过接口 getDevicesList 获得设备 ID。 |
146
+ | type | 设备类型,详见 TXMediaDeviceType 定义。 |
439
147
 
440
148
  #### 返回值说明:
441
149
 
@@ -443,308 +151,160 @@
443
151
 
444
152
  ## getCurrentDevice
445
153
 
446
-
447
-
448
154
  #### 获取当前正在使用的设备(仅适用于桌面端)。
449
155
 
450
156
  ## setCurrentDeviceVolume
451
157
 
452
-
453
-
454
158
  #### 设置当前设备的音量(仅适用于桌面端)。
455
159
 
456
160
  这里的音量指的是麦克风的采集音量或者扬声器的播放音量,摄像头是不支持设置音量的。
457
- <table>
458
- <tr>
459
- <td rowspan="1" colSpan="1" >参数</td>
460
-
461
- <td rowspan="1" colSpan="1" >描述</td>
462
- </tr>
463
-
464
- <tr>
465
- <td rowspan="1" colSpan="1" >volume</td>
466
-
467
- <td rowspan="1" colSpan="1" >音量大小,取值范围为 [0, 100],默认值:100。</td>
468
- </tr>
469
- </table>
470
-
161
+ | 参数 | 描述 |
162
+ | --- | --- |
163
+ | volume | 音量大小,取值范围为 [0, 100],默认值:100。 |
471
164
 
472
165
  ## getCurrentDeviceVolume
473
166
 
474
-
475
-
476
167
  #### 获取当前设备的音量(仅适用于桌面端)。
477
168
 
478
169
  这里的音量指的是麦克风的采集音量或者扬声器的播放音量,摄像头是不支持获取音量的。
479
170
 
480
171
  ## setCurrentDeviceMute
481
172
 
482
-
483
-
484
173
  #### 设置当前设备的静音状态(仅适用于桌面端)。
485
174
 
486
175
  这里的音量指的是麦克风和扬声器,摄像头是不支持静音操作的。
487
176
 
488
177
  ## getCurrentDeviceMute
489
178
 
490
-
491
-
492
179
  #### 获取当前设备的静音状态(仅适用于桌面端)。
493
180
 
494
181
  这里的音量指的是麦克风和扬声器,摄像头是不支持静音操作的。
495
182
 
496
183
  ## enableFollowingDefaultAudioDevice
497
184
 
498
-
499
-
500
185
  #### 设置 SDK 使用的音频设备根据跟随系统默认设备(仅适用于桌面端)。
501
186
 
502
187
  仅支持设置麦克风和扬声器类型,摄像头暂不支持跟随系统默认设备
503
- <table>
504
- <tr>
505
- <td rowspan="1" colSpan="1" >参数</td>
506
-
507
- <td rowspan="1" colSpan="1" >描述</td>
508
- </tr>
509
-
510
- <tr>
511
- <td rowspan="1" colSpan="1" >enable</td>
512
-
513
- <td rowspan="1" colSpan="1" >是否跟随系统默认的音频设备。<br>- true:跟随。当系统默认音频设备发生改变或者有新音频设备插入时,SDK 立即切换音频设备。<br>- false:不跟随。当系统默认音频设备发生改变或者有新音频设备插入时,SDK 不会切换音频设备。</td>
514
- </tr>
515
-
516
- <tr>
517
- <td rowspan="1" colSpan="1" >type</td>
518
-
519
- <td rowspan="1" colSpan="1" >设备类型,详见 [TXMediaDeviceType](https://write.woa.com/document/87030115247763456) 定义。</td>
520
- </tr>
521
- </table>
522
-
188
+ | 参数 | 描述 |
189
+ | --- | --- |
190
+ | enable | 是否跟随系统默认的音频设备。<br>- true:跟随。当系统默认音频设备发生改变或者有新音频设备插入时,SDK 立即切换音频设备。<br>- false:不跟随。当系统默认音频设备发生改变或者有新音频设备插入时,SDK 不会切换音频设备。 |
191
+ | type | 设备类型,详见 TXMediaDeviceType 定义。 |
523
192
 
524
193
  ## startCameraDeviceTest
525
194
 
526
-
527
-
528
195
  #### 开始摄像头测试(仅适用于桌面端)。
529
196
 
530
197
  > **注意**
531
- >
532
-
533
- > 在测试过程中可以使用 [setCurrentDevice](https://write.woa.com/document/87030115247763456) 接口切换摄像头。
534
- >
198
+ >
535
199
 
200
+ > 在测试过程中可以使用 setCurrentDevice 接口切换摄像头。
201
+ >
536
202
 
537
203
  ## stopCameraDeviceTest
538
204
 
539
-
540
-
541
205
  #### 结束摄像头测试(仅适用于桌面端)。
542
206
 
543
207
  ## startMicDeviceTest
544
208
 
545
-
546
-
547
209
  #### 开始麦克风测试(仅适用于桌面端)。
548
210
 
549
211
  该接口可以测试麦克风是否能正常工作,测试到的麦克风采集音量的大小,会以回调的形式通知给您,其中 volume 的取值范围为 [0, 100]。
550
- <table>
551
- <tr>
552
- <td rowspan="1" colSpan="1" >参数</td>
553
-
554
- <td rowspan="1" colSpan="1" >描述</td>
555
- </tr>
556
-
557
- <tr>
558
- <td rowspan="1" colSpan="1" >interval</td>
559
-
560
- <td rowspan="1" colSpan="1" >麦克风音量的回调间隔。</td>
561
- </tr>
562
- </table>
563
-
212
+ | 参数 | 描述 |
213
+ | --- | --- |
214
+ | interval | 麦克风音量的回调间隔。 |
564
215
 
565
216
  > **注意**
566
- >
217
+ >
567
218
 
568
219
  > 该接口调用后默认会回播麦克风录制到的声音到扬声器中。
569
- >
570
-
220
+ >
571
221
 
572
222
  ## startMicDeviceTest
573
223
 
574
-
575
-
576
224
  #### 开始麦克风测试(仅适用于桌面端)。
577
225
 
578
226
  该接口可以测试麦克风是否能正常工作,测试到的麦克风采集音量的大小,会以回调的形式通知给您,其中 volume 的取值范围为 [0, 100]。
579
- <table>
580
- <tr>
581
- <td rowspan="1" colSpan="1" >参数</td>
582
-
583
- <td rowspan="1" colSpan="1" >描述</td>
584
- </tr>
585
-
586
- <tr>
587
- <td rowspan="1" colSpan="1" >interval</td>
588
-
589
- <td rowspan="1" colSpan="1" >麦克风音量的回调间隔。</td>
590
- </tr>
591
-
592
- <tr>
593
- <td rowspan="1" colSpan="1" >playback</td>
594
-
595
- <td rowspan="1" colSpan="1" >是否开启回播麦克风声音,开启后用户测试麦克风时会听到自己的声音。</td>
596
- </tr>
597
- </table>
598
-
227
+ | 参数 | 描述 |
228
+ | --- | --- |
229
+ | interval | 麦克风音量的回调间隔。 |
230
+ | playback | 是否开启回播麦克风声音,开启后用户测试麦克风时会听到自己的声音。 |
599
231
 
600
232
  ## stopMicDeviceTest
601
233
 
602
-
603
-
604
234
  #### 结束麦克风测试(仅适用于桌面端)。
605
235
 
606
236
  ## startSpeakerDeviceTest
607
237
 
608
-
609
-
610
238
  #### 开始扬声器测试(仅适用于桌面端)。
611
239
 
612
240
  该接口通过播放指定的音频文件,用于测试播放设备是否能正常工作。如果用户在测试时能听到声音,说明播放设备能正常工作。
613
- <table>
614
- <tr>
615
- <td rowspan="1" colSpan="1" >参数</td>
616
-
617
- <td rowspan="1" colSpan="1" >描述</td>
618
- </tr>
619
-
620
- <tr>
621
- <td rowspan="1" colSpan="1" >filePath</td>
622
-
623
- <td rowspan="1" colSpan="1" >声音文件的路径</td>
624
- </tr>
625
- </table>
626
-
241
+ | 参数 | 描述 |
242
+ | --- | --- |
243
+ | filePath | 声音文件的路径 |
627
244
 
628
245
  ## stopSpeakerDeviceTest
629
246
 
630
-
631
-
632
247
  #### 结束扬声器测试(仅适用于桌面端)。
633
248
 
634
249
  ## startCameraDeviceTest
635
250
 
636
-
637
-
638
251
  #### 开始摄像头测试(仅适用于桌面端)。
639
252
 
640
- 该接口支持自定义渲染,即您可以通过接 [ITRTCVideoRenderCallback](https://write.woa.com/document/87030021158866944) 回调接口接管摄像头的渲染画面。
253
+ 该接口支持自定义渲染,即您可以通过接 ITRTCVideoRenderCallback 回调接口接管摄像头的渲染画面。
641
254
 
642
255
  ## setApplicationPlayVolume
643
256
 
644
-
645
-
646
257
  #### 设置 Windows 系统音量合成器中当前进程的音量(仅适用于 Windows 系统)。
647
258
 
648
259
  ## getApplicationPlayVolume
649
260
 
650
-
651
-
652
261
  #### 获取 Windows 系统音量合成器中当前进程的音量(仅适用于 Windows 系统)。
653
262
 
654
263
  ## setApplicationMuteState
655
264
 
656
-
657
-
658
265
  #### 设置 Windows 系统音量合成器中当前进程的静音状态(仅适用于 Windows 系统)。
659
266
 
660
267
  ## getApplicationMuteState
661
268
 
662
-
663
-
664
269
  #### 获取 Windows 系统音量合成器中当前进程的静音状态(仅适用于 Windows 系统)。
665
270
 
666
271
  ## setCameraCapturerParam
667
272
 
668
-
669
-
670
273
  #### 设置摄像头采集偏好。
671
274
 
672
275
  ## setDeviceObserver
673
276
 
674
-
675
-
676
277
  #### 设置 onDeviceChanged 事件回调。
677
278
 
678
279
  ## setSystemVolumeType
679
280
 
680
-
681
-
682
281
  #### 设置系统音量类型(仅适用于移动端)。
683
282
 
684
283
  @deprecated v9.5 版本开始不推荐使用,建议使用 ` TRTCCloud ` 中的 ` startLocalAudio(quality) ` 接口替代之,通过 quality 参数来决策音质。
685
284
 
686
285
  ## TXSystemVolumeType(Deprecated)
687
286
 
688
-
689
-
690
287
  #### 系统音量类型(仅适用于移动设备)。
691
288
 
692
289
  @deprecated v9.5 版本开始不推荐使用。
693
290
 
694
-
695
-
696
291
  现代智能手机中一般都具备两套系统音量类型,即“通话音量”和“媒体音量”。
697
292
  - 通话音量:手机专门为接打电话所设计的音量类型,自带回声抵消(AEC)功能,并且支持通过蓝牙耳机上的麦克风进行拾音,缺点是音质比较一般。
698
293
 
699
-
700
294
  当您通过手机侧面的音量按键下调手机音量时,如果无法将其调至零(也就是无法彻底静音),说明您的手机当前处于通话音量。
701
295
  - 媒体音量:手机专门为音乐场景所设计的音量类型,无法使用系统的 AEC 功能,并且不支持通过蓝牙耳机的麦克风进行拾音,但具备更好的音乐播放效果。
702
296
 
703
-
704
297
  当您通过手机侧面的音量按键下调手机音量时,如果能够将手机音量调至彻底静音,说明您的手机当前处于媒体音量。
705
298
 
706
-
707
-
708
299
  SDK 目前提供了三种系统音量类型的控制模式:自动切换模式、全程通话音量模式、全程媒体音量模式。
709
- <table>
710
- <tr>
711
- <td rowspan="1" colSpan="1" >枚举</td>
712
-
713
- <td rowspan="1" colSpan="1" >取值</td>
714
-
715
- <td rowspan="1" colSpan="1" >描述</td>
716
- </tr>
717
-
718
- <tr>
719
- <td rowspan="1" colSpan="1" >TXSystemVolumeTypeAuto</td>
720
-
721
- <td rowspan="1" colSpan="1" >0</td>
722
-
723
- <td rowspan="1" colSpan="1" >自动切换模式</td>
724
- </tr>
725
-
726
- <tr>
727
- <td rowspan="1" colSpan="1" >TXSystemVolumeTypeMedia</td>
728
-
729
- <td rowspan="1" colSpan="1" >1</td>
730
-
731
- <td rowspan="1" colSpan="1" >全程媒体音量</td>
732
- </tr>
733
-
734
- <tr>
735
- <td rowspan="1" colSpan="1" >TXSystemVolumeTypeVOIP</td>
736
-
737
- <td rowspan="1" colSpan="1" >2</td>
738
-
739
- <td rowspan="1" colSpan="1" >全程通话音量</td>
740
- </tr>
741
- </table>
742
-
300
+ | 枚举 | 取值 | 描述 |
301
+ | --- | --- | --- |
302
+ | TXSystemVolumeTypeAuto | 0 | 自动切换模式 |
303
+ | TXSystemVolumeTypeMedia | 1 | 全程媒体音量 |
304
+ | TXSystemVolumeTypeVOIP | 2 | 全程通话音量 |
743
305
 
744
306
  ## TXAudioRoute
745
307
 
746
-
747
-
748
308
  #### 音频路由(即声音的播放模式)。
749
309
 
750
310
  音频路由,即声音是从手机的扬声器还是从听筒中播放出来,因此该接口仅适用于手机等移动端设备。
@@ -754,276 +314,75 @@ SDK 目前提供了三种系统音量类型的控制模式:自动切换模式
754
314
 
755
315
  - 设置音频路由为扬声器时,声音比较大,不用将手机贴脸也能听清,因此可以实现“免提”的功能。
756
316
 
757
- <table>
758
- <tr>
759
- <td rowspan="1" colSpan="1" >枚举</td>
760
-
761
- <td rowspan="1" colSpan="1" >取值</td>
762
-
763
- <td rowspan="1" colSpan="1" >描述</td>
764
- </tr>
765
-
766
- <tr>
767
- <td rowspan="1" colSpan="1" >TXAudioRouteSpeakerphone</td>
768
-
769
- <td rowspan="1" colSpan="1" >0</td>
770
-
771
- <td rowspan="1" colSpan="1" >Speakerphone:使用扬声器播放(即“免提”),扬声器位于手机底部,声音偏大,适合外放音乐。</td>
772
- </tr>
773
-
774
- <tr>
775
- <td rowspan="1" colSpan="1" >TXAudioRouteEarpiece</td>
776
-
777
- <td rowspan="1" colSpan="1" >1</td>
778
-
779
- <td rowspan="1" colSpan="1" >Earpiece:使用听筒播放,听筒位于手机顶部,声音偏小,适合需要保护隐私的通话场景。</td>
780
- </tr>
781
- </table>
782
-
317
+ | 枚举 | 取值 | 描述 |
318
+ | --- | --- | --- |
319
+ | TXAudioRouteSpeakerphone | 0 | Speakerphone:使用扬声器播放(即“免提”),扬声器位于手机底部,声音偏大,适合外放音乐。 |
320
+ | TXAudioRouteEarpiece | 1 | Earpiece:使用听筒播放,听筒位于手机顶部,声音偏小,适合需要保护隐私的通话场景。 |
783
321
 
784
322
  ## TXMediaDeviceType
785
323
 
786
-
787
-
788
324
  #### 设备类型(仅适用于桌面平台)。
789
325
 
790
-
791
-
792
326
  该枚举值用于定义三种类型的音视频设备,即摄像头、麦克风和扬声器,以便让一套设备管理接口可以操控三种不同类型的设备。
793
- <table>
794
- <tr>
795
- <td rowspan="1" colSpan="1" >枚举</td>
796
-
797
- <td rowspan="1" colSpan="1" >取值</td>
798
-
799
- <td rowspan="1" colSpan="1" >描述</td>
800
- </tr>
801
-
802
- <tr>
803
- <td rowspan="1" colSpan="1" >TXMediaDeviceTypeUnknown</td>
804
-
805
- <td rowspan="1" colSpan="1" >-1</td>
806
-
807
- <td rowspan="1" colSpan="1" >未定义的设备类型</td>
808
- </tr>
809
-
810
- <tr>
811
- <td rowspan="1" colSpan="1" >TXMediaDeviceTypeMic</td>
812
-
813
- <td rowspan="1" colSpan="1" >0</td>
814
-
815
- <td rowspan="1" colSpan="1" >麦克风类型设备</td>
816
- </tr>
817
-
818
- <tr>
819
- <td rowspan="1" colSpan="1" >TXMediaDeviceTypeSpeaker</td>
820
-
821
- <td rowspan="1" colSpan="1" >1</td>
822
-
823
- <td rowspan="1" colSpan="1" >扬声器类型设备</td>
824
- </tr>
825
-
826
- <tr>
827
- <td rowspan="1" colSpan="1" >TXMediaDeviceTypeCamera</td>
828
-
829
- <td rowspan="1" colSpan="1" >2</td>
830
-
831
- <td rowspan="1" colSpan="1" >摄像头类型设备</td>
832
- </tr>
833
- </table>
834
-
327
+ | 枚举 | 取值 | 描述 |
328
+ | --- | --- | --- |
329
+ | TXMediaDeviceTypeUnknown | -1 | 未定义的设备类型 |
330
+ | TXMediaDeviceTypeMic | 0 | 麦克风类型设备 |
331
+ | TXMediaDeviceTypeSpeaker | 1 | 扬声器类型设备 |
332
+ | TXMediaDeviceTypeCamera | 2 | 摄像头类型设备 |
835
333
 
836
334
  ## TXMediaDeviceState
837
335
 
838
-
839
-
840
336
  #### 设备操作。
841
337
 
842
338
  该枚举值用于本地设备的状态变化通知 onDeviceChanged。
843
- <table>
844
- <tr>
845
- <td rowspan="1" colSpan="1" >枚举</td>
846
-
847
- <td rowspan="1" colSpan="1" >取值</td>
848
-
849
- <td rowspan="1" colSpan="1" >描述</td>
850
- </tr>
851
-
852
- <tr>
853
- <td rowspan="1" colSpan="1" >TXMediaDeviceStateAdd</td>
854
-
855
- <td rowspan="1" colSpan="1" >0</td>
856
-
857
- <td rowspan="1" colSpan="1" >设备已被插入</td>
858
- </tr>
859
-
860
- <tr>
861
- <td rowspan="1" colSpan="1" >TXMediaDeviceStateRemove</td>
862
-
863
- <td rowspan="1" colSpan="1" >1</td>
864
-
865
- <td rowspan="1" colSpan="1" >设备已被移除</td>
866
- </tr>
867
-
868
- <tr>
869
- <td rowspan="1" colSpan="1" >TXMediaDeviceStateActive</td>
870
-
871
- <td rowspan="1" colSpan="1" >2</td>
872
-
873
- <td rowspan="1" colSpan="1" >设备已启用</td>
874
- </tr>
875
-
876
- <tr>
877
- <td rowspan="1" colSpan="1" >TXMediaDefaultDeviceChanged</td>
878
-
879
- <td rowspan="1" colSpan="1" >3</td>
880
-
881
- <td rowspan="1" colSpan="1" >系统默认设备变更</td>
882
- </tr>
883
- </table>
884
-
339
+ | 枚举 | 取值 | 描述 |
340
+ | --- | --- | --- |
341
+ | TXMediaDeviceStateAdd | 0 | 设备已被插入 |
342
+ | TXMediaDeviceStateRemove | 1 | 设备已被移除 |
343
+ | TXMediaDeviceStateActive | 2 | 设备已启用 |
344
+ | TXMediaDefaultDeviceChanged | 3 | 系统默认设备变更 |
885
345
 
886
346
  ## TXCameraCaptureMode
887
347
 
888
-
889
-
890
348
  #### 摄像头采集偏好。
891
349
 
892
350
  该枚举类型用于摄像头采集参数设置。
893
- <table>
894
- <tr>
895
- <td rowspan="1" colSpan="1" >枚举</td>
896
-
897
- <td rowspan="1" colSpan="1" >取值</td>
898
-
899
- <td rowspan="1" colSpan="1" >描述</td>
900
- </tr>
901
-
902
- <tr>
903
- <td rowspan="1" colSpan="1" >TXCameraResolutionStrategyAuto</td>
904
-
905
- <td rowspan="1" colSpan="1" >0</td>
906
-
907
- <td rowspan="1" colSpan="1" >自动调整采集参数。<br>SDK 根据实际的采集设备性能及网络情况,选择合适的摄像头输出参数,在设备性能及视频预览质量之间,维持平衡。</td>
908
- </tr>
909
-
910
- <tr>
911
- <td rowspan="1" colSpan="1" >TXCameraResolutionStrategyPerformance</td>
912
-
913
- <td rowspan="1" colSpan="1" >1</td>
914
-
915
- <td rowspan="1" colSpan="1" >优先保证设备性能。<br>SDK 根据用户设置编码器的分辨率和帧率,选择最接近的摄像头输出参数,从而保证设备性能。</td>
916
- </tr>
917
-
918
- <tr>
919
- <td rowspan="1" colSpan="1" >TXCameraResolutionStrategyHighQuality</td>
920
-
921
- <td rowspan="1" colSpan="1" >2</td>
922
-
923
- <td rowspan="1" colSpan="1" >优先保证视频预览质量。<br>SDK选择较高的摄像头输出参数,从而提高预览视频的质量。在这种情况下,会消耗更多的 CPU 及内存做视频前处理。</td>
924
- </tr>
925
-
926
- <tr>
927
- <td rowspan="1" colSpan="1" >TXCameraCaptureManual</td>
928
-
929
- <td rowspan="1" colSpan="1" >3</td>
930
-
931
- <td rowspan="1" colSpan="1" >允许用户设置本地摄像头采集的视频宽高。</td>
932
- </tr>
933
- </table>
934
-
351
+ | 枚举 | 取值 | 描述 |
352
+ | --- | --- | --- |
353
+ | TXCameraResolutionStrategyAuto | 0 | 自动调整采集参数。<br>SDK 根据实际的采集设备性能及网络情况,选择合适的摄像头输出参数,在设备性能及视频预览质量之间,维持平衡。 |
354
+ | TXCameraResolutionStrategyPerformance | 1 | 优先保证设备性能。<br>SDK 根据用户设置编码器的分辨率和帧率,选择最接近的摄像头输出参数,从而保证设备性能。 |
355
+ | TXCameraResolutionStrategyHighQuality | 2 | 优先保证视频预览质量。<br>SDK选择较高的摄像头输出参数,从而提高预览视频的质量。在这种情况下,会消耗更多的 CPU 及内存做视频前处理。 |
356
+ | TXCameraCaptureManual | 3 | 允许用户设置本地摄像头采集的视频宽高。 |
935
357
 
936
358
  ## TXCameraCaptureParam
937
359
 
938
-
939
-
940
360
  #### 摄像头采集参数。
941
361
 
942
362
  该设置能决定本地预览图像画质。
943
- <table>
944
- <tr>
945
- <td rowspan="1" colSpan="1" >枚举类型</td>
946
-
947
- <td rowspan="1" colSpan="1" >描述</td>
948
- </tr>
949
-
950
- <tr>
951
- <td rowspan="1" colSpan="1" >height</td>
952
-
953
- <td rowspan="1" colSpan="1" >**字段含义:** 采集图像宽度</td>
954
- </tr>
955
-
956
- <tr>
957
- <td rowspan="1" colSpan="1" >mode</td>
958
-
959
- <td rowspan="1" colSpan="1" >**字段含义:** 摄像头采集偏好,请参见 [TXCameraCaptureMode](https://write.woa.com/document/87030115247763456)</td>
960
- </tr>
961
-
962
- <tr>
963
- <td rowspan="1" colSpan="1" >width</td>
964
-
965
- <td rowspan="1" colSpan="1" >**字段含义:** 采集图像长度</td>
966
- </tr>
967
- </table>
968
-
363
+ | 枚举类型 | 描述 |
364
+ | --- | --- |
365
+ | height | **字段含义:** 采集图像宽度 |
366
+ | mode | **字段含义:** 摄像头采集偏好,请参见 TXCameraCaptureMode |
367
+ | width | **字段含义:** 采集图像长度 |
969
368
 
970
369
  ## TXMediaDeviceInfo
971
370
 
972
-
973
-
974
371
  #### 音视频设备的相关信息(仅适用于桌面平台)。
975
372
 
976
373
  该结构体用于描述一个音视频设备的关键信息,例如设备 ID、设备名称等等,以便用户能够在用户界面上选择自己期望使用的音视频设备。
977
- <table>
978
- <tr>
979
- <td rowspan="1" colSpan="1" >枚举类型</td>
980
-
981
- <td rowspan="1" colSpan="1" >描述</td>
982
- </tr>
983
-
984
- <tr>
985
- <td rowspan="1" colSpan="1" >getDeviceName()</td>
986
-
987
- <td rowspan="1" colSpan="1" >设备名称 (UTF-8)</td>
988
- </tr>
989
-
990
- <tr>
991
- <td rowspan="1" colSpan="1" >getDevicePID()</td>
992
-
993
- <td rowspan="1" colSpan="1" >设备 ID (UTF-8)</td>
994
- </tr>
995
- </table>
996
-
374
+ | 枚举类型 | 描述 |
375
+ | --- | --- |
376
+ | getDeviceName() | 设备名称 (UTF-8) |
377
+ | getDevicePID() | 设备 ID (UTF-8) |
997
378
 
998
379
  ## ITXDeviceCollection
999
380
 
1000
-
1001
-
1002
381
  #### 设备信息列表(仅适用于桌面平台)。
1003
382
 
1004
383
  此结构体的作用相当于 std::vector<ITXDeviceInfo>,用于解决不同版本的 STL 容器的二进制兼容问题。
1005
- <table>
1006
- <tr>
1007
- <td rowspan="1" colSpan="1" >枚举类型</td>
1008
-
1009
- <td rowspan="1" colSpan="1" >描述</td>
1010
- </tr>
1011
-
1012
- <tr>
1013
- <td rowspan="1" colSpan="1" >getCount()</td>
1014
-
1015
- <td rowspan="1" colSpan="1" >设备数量</td>
1016
- </tr>
1017
-
1018
- <tr>
1019
- <td rowspan="1" colSpan="1" >index)</td>
1020
-
1021
- <td rowspan="1" colSpan="1" >设备信息(JSON 格式)<br>**注意**<br>示例:{"SupportedResolution":[{"width":640,"height":480},{"width":320,"height":240}]}<br>param index 设备索引,值为 [0,getCount),return 返回 JSON 格式的设备信息<br></td>
1022
- </tr>
1023
-
1024
- <tr>
1025
- <td rowspan="1" colSpan="1" >release()</td>
1026
-
1027
- <td rowspan="1" colSpan="1" >释放设备列表,请不要使用 delete 释放资源 !!!</td>
1028
- </tr>
1029
- </table>
384
+ | 枚举类型 | 描述 |
385
+ | --- | --- |
386
+ | getCount() | 设备数量 |
387
+ | index) | 设备信息(JSON 格式)<br>**注意**<br>示例:{"SupportedResolution":[{"width":640,"height":480},{"width":320,"height":240}]}<br>param index 设备索引,值为 [0,getCount),return 返回 JSON 格式的设备信息 |
388
+ | release() | 释放设备列表,请不要使用 delete 释放资源 !!! |