@tencentcloud/sdk-mcp 1.3.9 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (510) 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/definitions/get_callkit_api_def.js +28 -0
  275. package/tools/definitions/get_callkit_api_def.js.map +1 -0
  276. package/tools/definitions/get_faq_def.js +18 -19
  277. package/tools/definitions/get_faq_def.js.map +1 -1
  278. package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
  279. package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
  280. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
  281. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
  282. package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -41
  283. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
  284. package/tools/definitions/get_native_livekit_core_features_def.js +33 -0
  285. package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
  286. package/tools/definitions/get_native_livekit_core_integration_def.js +33 -0
  287. package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
  288. package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
  289. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
  290. package/tools/definitions/get_usersig_def.js +17 -24
  291. package/tools/definitions/get_usersig_def.js.map +1 -1
  292. package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
  293. package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
  294. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
  295. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
  296. package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
  297. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
  298. package/tools/definitions/get_web_live_uikit_integration_def.js +13 -18
  299. package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
  300. package/tools/definitions/get_web_livekit_api_def.js +27 -0
  301. package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
  302. package/tools/definitions/get_web_livekit_component_detail_def.js +29 -0
  303. package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
  304. package/tools/definitions/get_web_room_uikit_integration_def.js +13 -46
  305. package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
  306. package/tools/definitions/get_web_roomkit_feature_detail_def.js +30 -0
  307. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
  308. package/tools/definitions/get_web_trtc_sdk_api_def.js +25 -0
  309. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
  310. package/tools/definitions/get_web_trtc_sdk_integration_def.js +25 -0
  311. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
  312. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +25 -0
  313. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
  314. package/tools/definitions/present_framework_choice_def.js +23 -12
  315. package/tools/definitions/present_framework_choice_def.js.map +1 -1
  316. package/tools/index.js +47 -61
  317. package/tools/index.js.map +1 -1
  318. package/tools/live/get_native_livekit_core_features.js +65 -0
  319. package/tools/live/get_native_livekit_core_features.js.map +1 -0
  320. package/tools/live/get_native_livekit_core_integration.js +59 -0
  321. package/tools/live/get_native_livekit_core_integration.js.map +1 -0
  322. package/tools/live/get_web_live_uikit_integration.js +48 -0
  323. package/tools/live/get_web_live_uikit_integration.js.map +1 -0
  324. package/tools/live/get_web_livekit_api.js +32 -0
  325. package/tools/live/get_web_livekit_api.js.map +1 -0
  326. package/tools/live/get_web_livekit_component_detail.js +34 -0
  327. package/tools/live/get_web_livekit_component_detail.js.map +1 -0
  328. package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
  329. package/tools/room/get_web_room_uikit_integration.js.map +1 -0
  330. package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
  331. package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
  332. package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
  333. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
  334. package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
  335. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
  336. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
  337. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
  338. package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
  339. package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
  340. package/utils/generate-structured-result.js +61 -17
  341. package/utils/generate-structured-result.js.map +1 -1
  342. package/utils/report-cls-client.js +12 -1
  343. package/utils/report-cls-client.js.map +1 -1
  344. package/utils/report-es-client.js +1 -1
  345. package/resource/doc/chatuikit/android/workflow.md +0 -713
  346. package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1376
  347. package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -860
  348. package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1371
  349. package/resource/doc/chatuikit/flutter/workflow.md +0 -816
  350. package/resource/doc/chatuikit/iOS/workflow.md +0 -0
  351. package/resource/doc/chatuikit/react/components/conversation-list.md +0 -765
  352. package/resource/doc/chatuikit/react/components/search.md +0 -885
  353. package/resource/doc/chatuikit/react/create-group.md +0 -22
  354. package/resource/doc/chatuikit/react/init.md +0 -25
  355. package/resource/doc/chatuikit/react/workflow.md +0 -254
  356. package/resource/doc/chatuikit/uniapp-app/faq.md +0 -0
  357. package/resource/doc/chatuikit/uniapp-app/integration.md +0 -619
  358. package/resource/doc/chatuikit/uniapp-app/workflow.md +0 -576
  359. package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
  360. package/resource/doc/chatuikit/vue/components/tuikit.md +0 -110
  361. package/resource/doc/chatuikit/vue/create-group.md +0 -26
  362. package/resource/doc/chatuikit/vue/init.md +0 -35
  363. package/resource/doc/chatuikit/vue/workflow.md +0 -395
  364. package/resource/doc/livekit/live/android/workflow.md +0 -322
  365. package/resource/doc/livekit/live/flutter/workflow.md +0 -353
  366. package/resource/doc/livekit/live/ios/workflow.md +0 -352
  367. package/resource/doc/livekit/live/vue/components/barrage.md +0 -615
  368. package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -442
  369. package/resource/doc/livekit/live/vue/faq.md +0 -0
  370. package/resource/doc/livekit/live/vue/live-list-integration.md +0 -195
  371. package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -293
  372. package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -381
  373. package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -598
  374. package/resource/doc/livekit/live/vue/states/live-state.md +0 -2656
  375. package/resource/doc/livekit/live/vue/workflow.md +0 -219
  376. package/resource/doc/livekit/voice/android/workflow.md +0 -333
  377. package/resource/doc/livekit/voice/flutter/workflow.md +0 -359
  378. package/resource/doc/livekit/voice/ios/voice-integration.md +0 -853
  379. package/resource/doc/livekit/voice/ios/workflow.md +0 -358
  380. package/resource/doc/livekit/voice/uni-app/voice-integration.md +0 -613
  381. package/resource/doc/livekit/voice/uni-app/workflow.md +0 -369
  382. package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -334
  383. package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -434
  384. package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -685
  385. package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -712
  386. package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -284
  387. package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
  388. package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
  389. package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
  390. package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
  391. package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -879
  392. package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -668
  393. package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -456
  394. package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -332
  395. package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
  396. package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -328
  397. package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -505
  398. package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
  399. package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -676
  400. package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
  401. package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -820
  402. package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1065
  403. package/resource/doc/roomkit/vue/features/workflow.md +0 -553
  404. package/resource/doc/roomkit/vue/workflow.md +0 -733
  405. package/resource/doc/tuicallkit/android/workflow.md +0 -432
  406. package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -786
  407. package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -663
  408. package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -932
  409. package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -926
  410. package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -452
  411. package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -779
  412. package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -635
  413. package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
  414. package/resource/doc/tuicallkit/react/api.md +0 -1512
  415. package/resource/doc/tuicallkit/react/faq.md +0 -986
  416. package/resource/doc/tuicallkit/vue/api.md +0 -1512
  417. package/tools/call/get-native-call-integration.js +0 -43
  418. package/tools/call/get-native-call-integration.js.map +0 -1
  419. package/tools/call/get-web-call-api.js +0 -27
  420. package/tools/call/get-web-call-api.js.map +0 -1
  421. package/tools/call/get-web-call-integration.js.map +0 -1
  422. package/tools/chat/get-native-chat-feature-detail.js +0 -30
  423. package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
  424. package/tools/chat/get-native-chat-integration.js +0 -45
  425. package/tools/chat/get-native-chat-integration.js.map +0 -1
  426. package/tools/chat/get-web-chat-component-detail.js +0 -31
  427. package/tools/chat/get-web-chat-component-detail.js.map +0 -1
  428. package/tools/chat/get-web-chat-integration.js +0 -45
  429. package/tools/chat/get-web-chat-integration.js.map +0 -1
  430. package/tools/chat/get-web-chat-uikit-init.js +0 -28
  431. package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
  432. package/tools/chat/get-web-create-group-doc.js +0 -28
  433. package/tools/chat/get-web-create-group-doc.js.map +0 -1
  434. package/tools/common/get-faq.js +0 -91
  435. package/tools/common/get-faq.js.map +0 -1
  436. package/tools/common/get-usersig.js.map +0 -1
  437. package/tools/common/present-framework-choice.js +0 -16
  438. package/tools/common/present-framework-choice.js.map +0 -1
  439. package/tools/common/present-scenario-choice.js +0 -16
  440. package/tools/common/present-scenario-choice.js.map +0 -1
  441. package/tools/common/record-prompt.js +0 -55
  442. package/tools/common/record-prompt.js.map +0 -1
  443. package/tools/common/record-result.js +0 -60
  444. package/tools/common/record-result.js.map +0 -1
  445. package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
  446. package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
  447. package/tools/definitions/get_native_live_api_def.js +0 -22
  448. package/tools/definitions/get_native_live_api_def.js.map +0 -1
  449. package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -109
  450. package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
  451. package/tools/definitions/get_native_live_uikit_integration_def.js +0 -75
  452. package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
  453. package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
  454. package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
  455. package/tools/definitions/get_trtc_native_api_def.js +0 -17
  456. package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
  457. package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
  458. package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
  459. package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
  460. package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
  461. package/tools/definitions/get_web_create_group_doc_def.js +0 -18
  462. package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
  463. package/tools/definitions/get_web_live_state_detail_def.js +0 -19
  464. package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
  465. package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
  466. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
  467. package/tools/definitions/get_web_room_feature_detail_def.js +0 -92
  468. package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
  469. package/tools/definitions/present_scenario_choice_def.js +0 -53
  470. package/tools/definitions/present_scenario_choice_def.js.map +0 -1
  471. package/tools/definitions/record_prompt_def.js +0 -58
  472. package/tools/definitions/record_prompt_def.js.map +0 -1
  473. package/tools/definitions/record_result_def.js +0 -46
  474. package/tools/definitions/record_result_def.js.map +0 -1
  475. package/tools/live/get-native-live-uikit-integration.js +0 -177
  476. package/tools/live/get-native-live-uikit-integration.js.map +0 -1
  477. package/tools/live/get-web-live-component-detail.js +0 -31
  478. package/tools/live/get-web-live-component-detail.js.map +0 -1
  479. package/tools/live/get-web-live-state-detail.js +0 -31
  480. package/tools/live/get-web-live-state-detail.js.map +0 -1
  481. package/tools/live/get-web-live-uikit-integration.js +0 -52
  482. package/tools/live/get-web-live-uikit-integration.js.map +0 -1
  483. package/tools/live/get_native_live_uikit_extra_features.js +0 -105
  484. package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
  485. package/tools/live/get_native_live_uikit_interaction.js +0 -194
  486. package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
  487. package/tools/native_live/get-native-live-api.js +0 -31
  488. package/tools/native_live/get-native-live-api.js.map +0 -1
  489. package/tools/room/get-web-room-feature-detail.js.map +0 -1
  490. package/tools/room/get-web-room-integration.js.map +0 -1
  491. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
  492. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
  493. package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
  494. package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
  495. package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
  496. package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
  497. package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
  498. package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
  499. package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
  500. package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
  501. package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
  502. package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
  503. package/tools/trtc/get-trtc-native-api.js +0 -31
  504. package/tools/trtc/get-trtc-native-api.js.map +0 -1
  505. package/utils/handle-component-name.js +0 -33
  506. package/utils/handle-component-name.js.map +0 -1
  507. /package/resource/doc/{rtcengine/web → callkit/core-sdk}/.gitkeep +0 -0
  508. /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
  509. /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
  510. /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
package/resource/doc/trtc/android/TRTCCloud.md CHANGED
@@ -3,874 +3,251 @@
3
3
  ## 概述
4
4
  `TRTCCloud.java` 是腾讯云实时音视频(TRTC SDK ) Android 平台的 API 文档，包含了推流、拉流、拉流、混流、录制等功能详细说明。
5
5
 
6
-
7
6
  ## TRTCCloud
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" >[sharedInstance](https://write.woa.com/document/87029900866228224)</td>
17
-
18
- <td rowspan="1" colSpan="1" >创建 TRTCCloud 实例（单例模式）。</td>
19
- </tr>
20
-
21
- <tr>
22
- <td rowspan="1" colSpan="1" >[destroySharedInstance](https://write.woa.com/document/87029900866228224)</td>
23
-
24
- <td rowspan="1" colSpan="1" >销毁 TRTCCloud 实例（单例模式）。</td>
25
- </tr>
26
-
27
- <tr>
28
- <td rowspan="1" colSpan="1" >[addListener](https://write.woa.com/document/87029900866228224)</td>
29
-
30
- <td rowspan="1" colSpan="1" >添加 TRTC 事件回调。</td>
31
- </tr>
32
-
33
- <tr>
34
- <td rowspan="1" colSpan="1" >[removeListener](https://write.woa.com/document/87029900866228224)</td>
35
-
36
- <td rowspan="1" colSpan="1" >移除 TRTC 事件回调。</td>
37
- </tr>
38
-
39
- <tr>
40
- <td rowspan="1" colSpan="1" >[setListenerHandler](https://write.woa.com/document/87029900866228224)</td>
41
-
42
- <td rowspan="1" colSpan="1" >设置驱动 TRTCCloudListener 事件回调的队列。</td>
43
- </tr>
44
-
45
- <tr>
46
- <td rowspan="1" colSpan="1" >[enterRoom](https://write.woa.com/document/87029900866228224)</td>
47
-
48
- <td rowspan="1" colSpan="1" >进入房间。</td>
49
- </tr>
50
-
51
- <tr>
52
- <td rowspan="1" colSpan="1" >[exitRoom](https://write.woa.com/document/87029900866228224)</td>
53
-
54
- <td rowspan="1" colSpan="1" >离开房间。</td>
55
- </tr>
56
-
57
- <tr>
58
- <td rowspan="1" colSpan="1" >[switchRole](https://write.woa.com/document/87029900866228224)</td>
59
-
60
- <td rowspan="1" colSpan="1" >切换角色。</td>
61
- </tr>
62
-
63
- <tr>
64
- <td rowspan="1" colSpan="1" >[switchRole](https://write.woa.com/document/87029900866228224)</td>
65
-
66
- <td rowspan="1" colSpan="1" >切换角色（支持设置权限位）。</td>
67
- </tr>
68
-
69
- <tr>
70
- <td rowspan="1" colSpan="1" >[switchRoom](https://write.woa.com/document/87029900866228224)</td>
71
-
72
- <td rowspan="1" colSpan="1" >切换房间。</td>
73
- </tr>
74
-
75
- <tr>
76
- <td rowspan="1" colSpan="1" >[ConnectOtherRoom](https://write.woa.com/document/87029900866228224)</td>
77
-
78
- <td rowspan="1" colSpan="1" >请求跨房通话。</td>
79
- </tr>
80
-
81
- <tr>
82
- <td rowspan="1" colSpan="1" >[DisconnectOtherRoom](https://write.woa.com/document/87029900866228224)</td>
83
-
84
- <td rowspan="1" colSpan="1" >退出跨房通话。</td>
85
- </tr>
86
-
87
- <tr>
88
- <td rowspan="1" colSpan="1" >[setDefaultStreamRecvMode](https://write.woa.com/document/87029900866228224)</td>
89
-
90
- <td rowspan="1" colSpan="1" >设置订阅模式（需要在进入房前设置才能生效）。</td>
91
- </tr>
92
-
93
- <tr>
94
- <td rowspan="1" colSpan="1" >[createSubCloud](https://write.woa.com/document/87029900866228224)</td>
95
-
96
- <td rowspan="1" colSpan="1" >创建子房间实例（用于多房间并发观看）。</td>
97
- </tr>
98
-
99
- <tr>
100
- <td rowspan="1" colSpan="1" >[destroySubCloud](https://write.woa.com/document/87029900866228224)</td>
101
-
102
- <td rowspan="1" colSpan="1" >销毁子房间实例。</td>
103
- </tr>
104
-
105
- <tr>
106
- <td rowspan="1" colSpan="1" >[updateOtherRoomForwardMode](https://write.woa.com/document/87029900866228224)</td>
107
-
108
- <td rowspan="1" colSpan="1" >更改跨房主播在本房间的上行能力。</td>
109
- </tr>
110
-
111
- <tr>
112
- <td rowspan="1" colSpan="1" >[startPublishMediaStream](https://write.woa.com/document/87029900866228224)</td>
113
-
114
- <td rowspan="1" colSpan="1" >开始发布媒体流。</td>
115
- </tr>
116
-
117
- <tr>
118
- <td rowspan="1" colSpan="1" >[updatePublishMediaStream](https://write.woa.com/document/87029900866228224)</td>
119
-
120
- <td rowspan="1" colSpan="1" >更新发布媒体流。</td>
121
- </tr>
122
-
123
- <tr>
124
- <td rowspan="1" colSpan="1" >[stopPublishMediaStream](https://write.woa.com/document/87029900866228224)</td>
125
-
126
- <td rowspan="1" colSpan="1" >停止发布媒体流。</td>
127
- </tr>
128
-
129
- <tr>
130
- <td rowspan="1" colSpan="1" >[startLocalPreview](https://write.woa.com/document/87029900866228224)</td>
131
-
132
- <td rowspan="1" colSpan="1" >开启本地摄像头的预览画面（移动端）。</td>
133
- </tr>
134
-
135
- <tr>
136
- <td rowspan="1" colSpan="1" >[updateLocalView](https://write.woa.com/document/87029900866228224)</td>
137
-
138
- <td rowspan="1" colSpan="1" >更新本地摄像头的预览画面。</td>
139
- </tr>
140
-
141
- <tr>
142
- <td rowspan="1" colSpan="1" >[stopLocalPreview](https://write.woa.com/document/87029900866228224)</td>
143
-
144
- <td rowspan="1" colSpan="1" >停止摄像头预览。</td>
145
- </tr>
146
-
147
- <tr>
148
- <td rowspan="1" colSpan="1" >[muteLocalVideo](https://write.woa.com/document/87029900866228224)</td>
149
-
150
- <td rowspan="1" colSpan="1" >暂停/恢复发布本地的视频流。</td>
151
- </tr>
152
-
153
- <tr>
154
- <td rowspan="1" colSpan="1" >[setVideoMuteImage](https://write.woa.com/document/87029900866228224)</td>
155
-
156
- <td rowspan="1" colSpan="1" >设置本地画面被暂停期间的替代图片。</td>
157
- </tr>
158
-
159
- <tr>
160
- <td rowspan="1" colSpan="1" >[startRemoteView](https://write.woa.com/document/87029900866228224)</td>
161
-
162
- <td rowspan="1" colSpan="1" >订阅远端用户的视频流，并绑定视频渲染控件。</td>
163
- </tr>
164
-
165
- <tr>
166
- <td rowspan="1" colSpan="1" >[updateRemoteView](https://write.woa.com/document/87029900866228224)</td>
167
-
168
- <td rowspan="1" colSpan="1" >更新远端用户的视频渲染控件。</td>
169
- </tr>
170
-
171
- <tr>
172
- <td rowspan="1" colSpan="1" >[stopRemoteView](https://write.woa.com/document/87029900866228224)</td>
173
-
174
- <td rowspan="1" colSpan="1" >停止订阅远端用户的视频流，并释放渲染控件。</td>
175
- </tr>
176
-
177
- <tr>
178
- <td rowspan="1" colSpan="1" >[stopAllRemoteView](https://write.woa.com/document/87029900866228224)</td>
179
-
180
- <td rowspan="1" colSpan="1" >停止订阅所有远端用户的视频流，并释放全部渲染资源。</td>
181
- </tr>
182
-
183
- <tr>
184
- <td rowspan="1" colSpan="1" >[muteRemoteVideoStream](https://write.woa.com/document/87029900866228224)</td>
185
-
186
- <td rowspan="1" colSpan="1" >暂停/恢复订阅远端用户的视频流。</td>
187
- </tr>
188
-
189
- <tr>
190
- <td rowspan="1" colSpan="1" >[muteAllRemoteVideoStreams](https://write.woa.com/document/87029900866228224)</td>
191
-
192
- <td rowspan="1" colSpan="1" >暂停/恢复订阅所有远端用户的视频流。</td>
193
- </tr>
194
-
195
- <tr>
196
- <td rowspan="1" colSpan="1" >[setVideoEncoderParam](https://write.woa.com/document/87029900866228224)</td>
197
-
198
- <td rowspan="1" colSpan="1" >设置视频编码器的编码参数。</td>
199
- </tr>
200
-
201
- <tr>
202
- <td rowspan="1" colSpan="1" >[setNetworkQosParam](https://write.woa.com/document/87029900866228224)</td>
203
-
204
- <td rowspan="1" colSpan="1" >设置网络质量控制的相关参数。</td>
205
- </tr>
206
-
207
- <tr>
208
- <td rowspan="1" colSpan="1" >[setLocalRenderParams](https://write.woa.com/document/87029900866228224)</td>
209
-
210
- <td rowspan="1" colSpan="1" >设置本地画面的渲染参数。</td>
211
- </tr>
212
-
213
- <tr>
214
- <td rowspan="1" colSpan="1" >[setRemoteRenderParams](https://write.woa.com/document/87029900866228224)</td>
215
-
216
- <td rowspan="1" colSpan="1" >设置远端画面的渲染模式。</td>
217
- </tr>
218
-
219
- <tr>
220
- <td rowspan="1" colSpan="1" >[enableEncSmallVideoStream](https://write.woa.com/document/87029900866228224)</td>
221
-
222
- <td rowspan="1" colSpan="1" >开启大小画面双路编码模式。</td>
223
- </tr>
224
-
225
- <tr>
226
- <td rowspan="1" colSpan="1" >[setRemoteVideoStreamType](https://write.woa.com/document/87029900866228224)</td>
227
-
228
- <td rowspan="1" colSpan="1" >切换指定远端用户的大小画面。</td>
229
- </tr>
230
-
231
- <tr>
232
- <td rowspan="1" colSpan="1" >[snapshotVideo](https://write.woa.com/document/87029900866228224)</td>
233
-
234
- <td rowspan="1" colSpan="1" >视频画面截图。</td>
235
- </tr>
236
-
237
- <tr>
238
- <td rowspan="1" colSpan="1" >[setPerspectiveCorrectionPoints](https://write.woa.com/document/87029900866228224)</td>
239
-
240
- <td rowspan="1" colSpan="1" >视频画面透视校正坐标设置。</td>
241
- </tr>
242
-
243
- <tr>
244
- <td rowspan="1" colSpan="1" >[setGravitySensorAdaptiveMode](https://write.woa.com/document/87029900866228224)</td>
245
-
246
- <td rowspan="1" colSpan="1" >设置重力感应的适配模式（11.7 及以上版本）。</td>
247
- </tr>
248
-
249
- <tr>
250
- <td rowspan="1" colSpan="1" >[startLocalAudio](https://write.woa.com/document/87029900866228224)</td>
251
-
252
- <td rowspan="1" colSpan="1" >开启本地音频的采集和发布。</td>
253
- </tr>
254
-
255
- <tr>
256
- <td rowspan="1" colSpan="1" >[stopLocalAudio](https://write.woa.com/document/87029900866228224)</td>
257
-
258
- <td rowspan="1" colSpan="1" >停止本地音频的采集和发布。</td>
259
- </tr>
260
-
261
- <tr>
262
- <td rowspan="1" colSpan="1" >[muteLocalAudio](https://write.woa.com/document/87029900866228224)</td>
263
-
264
- <td rowspan="1" colSpan="1" >暂停/恢复发布本地的音频流。</td>
265
- </tr>
266
-
267
- <tr>
268
- <td rowspan="1" colSpan="1" >[muteRemoteAudio](https://write.woa.com/document/87029900866228224)</td>
269
-
270
- <td rowspan="1" colSpan="1" >暂停/恢复播放远端的音频流。</td>
271
- </tr>
272
-
273
- <tr>
274
- <td rowspan="1" colSpan="1" >[muteAllRemoteAudio](https://write.woa.com/document/87029900866228224)</td>
275
-
276
- <td rowspan="1" colSpan="1" >暂停/恢复播放所有远端用户的音频流。</td>
277
- </tr>
278
-
279
- <tr>
280
- <td rowspan="1" colSpan="1" >[setAudioRoute](https://write.woa.com/document/87029900866228224)</td>
281
-
282
- <td rowspan="1" colSpan="1" >设置音频路由。</td>
283
- </tr>
284
-
285
- <tr>
286
- <td rowspan="1" colSpan="1" >[setRemoteAudioVolume](https://write.woa.com/document/87029900866228224)</td>
287
-
288
- <td rowspan="1" colSpan="1" >设定某一个远端用户的声音播放音量。</td>
289
- </tr>
290
-
291
- <tr>
292
- <td rowspan="1" colSpan="1" >[setAudioCaptureVolume](https://write.woa.com/document/87029900866228224)</td>
293
-
294
- <td rowspan="1" colSpan="1" >设定本地音频的采集音量。</td>
295
- </tr>
296
-
297
- <tr>
298
- <td rowspan="1" colSpan="1" >[getAudioCaptureVolume](https://write.woa.com/document/87029900866228224)</td>
299
-
300
- <td rowspan="1" colSpan="1" >获取本地音频的采集音量。</td>
301
- </tr>
302
-
303
- <tr>
304
- <td rowspan="1" colSpan="1" >[setAudioPlayoutVolume](https://write.woa.com/document/87029900866228224)</td>
305
-
306
- <td rowspan="1" colSpan="1" >设定远端音频的播放音量。</td>
307
- </tr>
308
-
309
- <tr>
310
- <td rowspan="1" colSpan="1" >[getAudioPlayoutVolume](https://write.woa.com/document/87029900866228224)</td>
311
-
312
- <td rowspan="1" colSpan="1" >获取远端音频的播放音量。</td>
313
- </tr>
314
-
315
- <tr>
316
- <td rowspan="1" colSpan="1" >[enableAudioVolumeEvaluation](https://write.woa.com/document/87029900866228224)</td>
317
-
318
- <td rowspan="1" colSpan="1" >启用音量大小提示。</td>
319
- </tr>
320
-
321
- <tr>
322
- <td rowspan="1" colSpan="1" >[startAudioRecording](https://write.woa.com/document/87029900866228224)</td>
323
-
324
- <td rowspan="1" colSpan="1" >开始录音。</td>
325
- </tr>
326
-
327
- <tr>
328
- <td rowspan="1" colSpan="1" >[stopAudioRecording](https://write.woa.com/document/87029900866228224)</td>
329
-
330
- <td rowspan="1" colSpan="1" >停止录音。</td>
331
- </tr>
332
-
333
- <tr>
334
- <td rowspan="1" colSpan="1" >[startLocalRecording](https://write.woa.com/document/87029900866228224)</td>
335
-
336
- <td rowspan="1" colSpan="1" >开启本地媒体录制。</td>
337
- </tr>
338
-
339
- <tr>
340
- <td rowspan="1" colSpan="1" >[stopLocalRecording](https://write.woa.com/document/87029900866228224)</td>
341
-
342
- <td rowspan="1" colSpan="1" >停止本地媒体录制。</td>
343
- </tr>
344
-
345
- <tr>
346
- <td rowspan="1" colSpan="1" >[setRemoteAudioParallelParams](https://write.woa.com/document/87029900866228224)</td>
347
-
348
- <td rowspan="1" colSpan="1" >设置远端音频流智能并发播放策略。</td>
349
- </tr>
350
-
351
- <tr>
352
- <td rowspan="1" colSpan="1" >[enable3DSpatialAudioEffect](https://write.woa.com/document/87029900866228224)</td>
353
-
354
- <td rowspan="1" colSpan="1" >启用 3D 音效。</td>
355
- </tr>
356
-
357
- <tr>
358
- <td rowspan="1" colSpan="1" >[updateSelf3DSpatialPosition](https://write.woa.com/document/87029900866228224)</td>
359
-
360
- <td rowspan="1" colSpan="1" >设置 3D 音效中自身坐标及朝向信息。</td>
361
- </tr>
362
-
363
- <tr>
364
- <td rowspan="1" colSpan="1" >[updateRemote3DSpatialPosition](https://write.woa.com/document/87029900866228224)</td>
365
-
366
- <td rowspan="1" colSpan="1" >设置 3D 音效中远端用户坐标信息。</td>
367
- </tr>
368
-
369
- <tr>
370
- <td rowspan="1" colSpan="1" >[set3DSpatialReceivingRange](https://write.woa.com/document/87029900866228224)</td>
371
-
372
- <td rowspan="1" colSpan="1" >设置指定用户所发出声音的可被接收范围。</td>
373
- </tr>
374
-
375
- <tr>
376
- <td rowspan="1" colSpan="1" >[getDeviceManager](https://write.woa.com/document/87029900866228224)</td>
377
-
378
- <td rowspan="1" colSpan="1" >获取设备管理类（TXDeviceManager）。</td>
379
- </tr>
380
-
381
- <tr>
382
- <td rowspan="1" colSpan="1" >[getBeautyManager](https://write.woa.com/document/87029900866228224)</td>
383
-
384
- <td rowspan="1" colSpan="1" >获取美颜管理类（TXBeautyManager）。</td>
385
- </tr>
386
-
387
- <tr>
388
- <td rowspan="1" colSpan="1" >[setWatermark](https://write.woa.com/document/87029900866228224)</td>
389
-
390
- <td rowspan="1" colSpan="1" >添加水印。</td>
391
- </tr>
392
-
393
- <tr>
394
- <td rowspan="1" colSpan="1" >[getAudioEffectManager](https://write.woa.com/document/87029900866228224)</td>
395
-
396
- <td rowspan="1" colSpan="1" >获取音效管理类（TXAudioEffectManager）。</td>
397
- </tr>
398
-
399
- <tr>
400
- <td rowspan="1" colSpan="1" >[startSystemAudioLoopback](https://write.woa.com/document/87029900866228224)</td>
401
-
402
- <td rowspan="1" colSpan="1" >开启系统声音采集。</td>
403
- </tr>
404
-
405
- <tr>
406
- <td rowspan="1" colSpan="1" >[stopSystemAudioLoopback](https://write.woa.com/document/87029900866228224)</td>
407
-
408
- <td rowspan="1" colSpan="1" >停止系统声音采集（iOS 端暂未支持）。</td>
409
- </tr>
410
-
411
- <tr>
412
- <td rowspan="1" colSpan="1" >[startScreenCapture](https://write.woa.com/document/87029900866228224)</td>
413
-
414
- <td rowspan="1" colSpan="1" >启动屏幕分享。</td>
415
- </tr>
416
-
417
- <tr>
418
- <td rowspan="1" colSpan="1" >[stopScreenCapture](https://write.woa.com/document/87029900866228224)</td>
419
-
420
- <td rowspan="1" colSpan="1" >停止屏幕分享。</td>
421
- </tr>
422
-
423
- <tr>
424
- <td rowspan="1" colSpan="1" >[pauseScreenCapture](https://write.woa.com/document/87029900866228224)</td>
425
-
426
- <td rowspan="1" colSpan="1" >暂停屏幕分享。</td>
427
- </tr>
428
-
429
- <tr>
430
- <td rowspan="1" colSpan="1" >[resumeScreenCapture](https://write.woa.com/document/87029900866228224)</td>
431
-
432
- <td rowspan="1" colSpan="1" >恢复屏幕分享。</td>
433
- </tr>
434
-
435
- <tr>
436
- <td rowspan="1" colSpan="1" >[setSubStreamEncoderParam](https://write.woa.com/document/87029900866228224)</td>
437
-
438
- <td rowspan="1" colSpan="1" >设置屏幕分享（即辅路）的视频编码参数（桌面系统和移动系统均已支持）。</td>
439
- </tr>
440
-
441
- <tr>
442
- <td rowspan="1" colSpan="1" >[enableCustomVideoCapture](https://write.woa.com/document/87029900866228224)</td>
443
-
444
- <td rowspan="1" colSpan="1" >启用/关闭视频自定义采集模式。</td>
445
- </tr>
446
-
447
- <tr>
448
- <td rowspan="1" colSpan="1" >[sendCustomVideoData](https://write.woa.com/document/87029900866228224)</td>
449
-
450
- <td rowspan="1" colSpan="1" >向 SDK 投送自己采集的视频帧。</td>
451
- </tr>
452
-
453
- <tr>
454
- <td rowspan="1" colSpan="1" >[enableCustomAudioCapture](https://write.woa.com/document/87029900866228224)</td>
455
-
456
- <td rowspan="1" colSpan="1" >启用音频自定义采集模式。</td>
457
- </tr>
458
-
459
- <tr>
460
- <td rowspan="1" colSpan="1" >[sendCustomAudioData](https://write.woa.com/document/87029900866228224)</td>
461
-
462
- <td rowspan="1" colSpan="1" >向 SDK 投送自己采集的音频数据。</td>
463
- </tr>
464
-
465
- <tr>
466
- <td rowspan="1" colSpan="1" >[enableMixExternalAudioFrame](https://write.woa.com/document/87029900866228224)</td>
467
-
468
- <td rowspan="1" colSpan="1" >启用/关闭自定义音轨。</td>
469
- </tr>
470
-
471
- <tr>
472
- <td rowspan="1" colSpan="1" >[mixExternalAudioFrame](https://write.woa.com/document/87029900866228224)</td>
473
-
474
- <td rowspan="1" colSpan="1" >向 SDK 混入自定义音轨。</td>
475
- </tr>
476
-
477
- <tr>
478
- <td rowspan="1" colSpan="1" >[setMixExternalAudioVolume](https://write.woa.com/document/87029900866228224)</td>
479
-
480
- <td rowspan="1" colSpan="1" >设置推流时混入外部音频的推流音量和播放音量。</td>
481
- </tr>
482
-
483
- <tr>
484
- <td rowspan="1" colSpan="1" >[generateCustomPTS](https://write.woa.com/document/87029900866228224)</td>
485
-
486
- <td rowspan="1" colSpan="1" >生成自定义采集时的时间戳。</td>
487
- </tr>
488
-
489
- <tr>
490
- <td rowspan="1" colSpan="1" >[setLocalVideoProcessListener](https://write.woa.com/document/87029900866228224)</td>
491
-
492
- <td rowspan="1" colSpan="1" >设置第三方美颜的视频数据回调。</td>
493
- </tr>
494
-
495
- <tr>
496
- <td rowspan="1" colSpan="1" >[setLocalVideoRenderListener](https://write.woa.com/document/87029900866228224)</td>
497
-
498
- <td rowspan="1" colSpan="1" >设置本地视频自定义渲染回调。</td>
499
- </tr>
500
-
501
- <tr>
502
- <td rowspan="1" colSpan="1" >[setRemoteVideoRenderListener](https://write.woa.com/document/87029900866228224)</td>
503
-
504
- <td rowspan="1" colSpan="1" >设置远端视频自定义渲染回调。</td>
505
- </tr>
506
-
507
- <tr>
508
- <td rowspan="1" colSpan="1" >[setAudioFrameListener](https://write.woa.com/document/87029900866228224)</td>
509
-
510
- <td rowspan="1" colSpan="1" >设置音频数据自定义回调。</td>
511
- </tr>
512
-
513
- <tr>
514
- <td rowspan="1" colSpan="1" >[setCapturedAudioFrameCallbackFormat](https://write.woa.com/document/87029900866228224)</td>
515
-
516
- <td rowspan="1" colSpan="1" >设置本地麦克风采集出的音频帧回调格式。</td>
517
- </tr>
518
-
519
- <tr>
520
- <td rowspan="1" colSpan="1" >[setLocalProcessedAudioFrameCallbackFormat](https://write.woa.com/document/87029900866228224)</td>
521
-
522
- <td rowspan="1" colSpan="1" >设置经过前处理后的本地音频帧回调格式。</td>
523
- </tr>
524
-
525
- <tr>
526
- <td rowspan="1" colSpan="1" >[setMixedPlayAudioFrameCallbackFormat](https://write.woa.com/document/87029900866228224)</td>
527
-
528
- <td rowspan="1" colSpan="1" >设置最终要由系统播放出的音频帧回调格式。</td>
529
- </tr>
530
-
531
- <tr>
532
- <td rowspan="1" colSpan="1" >[enableCustomAudioRendering](https://write.woa.com/document/87029900866228224)</td>
533
-
534
- <td rowspan="1" colSpan="1" >开启音频自定义播放。</td>
535
- </tr>
536
-
537
- <tr>
538
- <td rowspan="1" colSpan="1" >[getCustomAudioRenderingFrame](https://write.woa.com/document/87029900866228224)</td>
539
-
540
- <td rowspan="1" colSpan="1" >获取可播放的音频数据。</td>
541
- </tr>
542
-
543
- <tr>
544
- <td rowspan="1" colSpan="1" >[sendCustomCmdMsg](https://write.woa.com/document/87029900866228224)</td>
545
-
546
- <td rowspan="1" colSpan="1" >使用 UDP 通道发送自定义消息给房间内所有用户。</td>
547
- </tr>
548
-
549
- <tr>
550
- <td rowspan="1" colSpan="1" >[sendSEIMsg](https://write.woa.com/document/87029900866228224)</td>
551
-
552
- <td rowspan="1" colSpan="1" >使用 SEI 通道发送自定义消息给房间内所有用户。</td>
553
- </tr>
554
-
555
- <tr>
556
- <td rowspan="1" colSpan="1" >[startSpeedTest](https://write.woa.com/document/87029900866228224)</td>
557
-
558
- <td rowspan="1" colSpan="1" >开始进行网速测试（进入房间前使用）。</td>
559
- </tr>
560
-
561
- <tr>
562
- <td rowspan="1" colSpan="1" >[stopSpeedTest](https://write.woa.com/document/87029900866228224)</td>
563
-
564
- <td rowspan="1" colSpan="1" >停止网络测速。</td>
565
- </tr>
566
-
567
- <tr>
568
- <td rowspan="1" colSpan="1" >[getSDKVersion](https://write.woa.com/document/87029900866228224)</td>
569
-
570
- <td rowspan="1" colSpan="1" >获取 SDK 版本信息。</td>
571
- </tr>
572
-
573
- <tr>
574
- <td rowspan="1" colSpan="1" >[setLogLevel](https://write.woa.com/document/87029900866228224)</td>
575
-
576
- <td rowspan="1" colSpan="1" >设置 Log 输出级别。</td>
577
- </tr>
578
-
579
- <tr>
580
- <td rowspan="1" colSpan="1" >[setConsoleEnabled](https://write.woa.com/document/87029900866228224)</td>
581
-
582
- <td rowspan="1" colSpan="1" >启用/禁用控制台日志打印。</td>
583
- </tr>
584
-
585
- <tr>
586
- <td rowspan="1" colSpan="1" >[setLogCompressEnabled](https://write.woa.com/document/87029900866228224)</td>
587
-
588
- <td rowspan="1" colSpan="1" >启用/禁用日志的本地压缩。</td>
589
- </tr>
590
-
591
- <tr>
592
- <td rowspan="1" colSpan="1" >[setLogDirPath](https://write.woa.com/document/87029900866228224)</td>
593
-
594
- <td rowspan="1" colSpan="1" >设置本地日志的保存路径。</td>
595
- </tr>
596
-
597
- <tr>
598
- <td rowspan="1" colSpan="1" >[setLogListener](https://write.woa.com/document/87029900866228224)</td>
599
-
600
- <td rowspan="1" colSpan="1" >设置日志回调。</td>
601
- </tr>
602
-
603
- <tr>
604
- <td rowspan="1" colSpan="1" >[showDebugView](https://write.woa.com/document/87029900866228224)</td>
605
-
606
- <td rowspan="1" colSpan="1" >显示仪表盘。</td>
607
- </tr>
608
-
609
- <tr>
610
- <td rowspan="1" colSpan="1" >[TRTCViewMargin](https://write.woa.com/document/87029900866228224)</td>
611
-
612
- <td rowspan="1" colSpan="1" >设置仪表盘的边距。</td>
613
- </tr>
614
-
615
- <tr>
616
- <td rowspan="1" colSpan="1" >[callExperimentalAPI](https://write.woa.com/document/87029900866228224)</td>
617
-
618
- <td rowspan="1" colSpan="1" >调用实验性接口。</td>
619
- </tr>
620
-
621
- <tr>
622
- <td rowspan="1" colSpan="1" >[enablePayloadPrivateEncryption](https://write.woa.com/document/87029900866228224)</td>
623
-
624
- <td rowspan="1" colSpan="1" >开启或关闭媒体流私有加密。</td>
625
- </tr>
626
- </table>
627
-
7
+ | 函数列表 | 描述 |
8
+ | --- | --- |
9
+ | sharedInstance | 创建 TRTCCloud 实例（单例模式）。 |
10
+ | destroySharedInstance | 销毁 TRTCCloud 实例（单例模式）。 |
11
+ | addListener | 添加 TRTC 事件回调。 |
12
+ | removeListener | 移除 TRTC 事件回调。 |
13
+ | setListenerHandler | 设置驱动 TRTCCloudListener 事件回调的队列。 |
14
+ | enterRoom | 进入房间。 |
15
+ | exitRoom | 离开房间。 |
16
+ | switchRole | 切换角色。 |
17
+ | switchRole | 切换角色（支持设置权限位）。 |
18
+ | switchRoom | 切换房间。 |
19
+ | ConnectOtherRoom | 请求跨房通话。 |
20
+ | DisconnectOtherRoom | 退出跨房通话。 |
21
+ | setDefaultStreamRecvMode | 设置订阅模式（需要在进入房前设置才能生效）。 |
22
+ | createSubCloud | 创建子房间实例（用于多房间并发观看）。 |
23
+ | destroySubCloud | 销毁子房间实例。 |
24
+ | updateOtherRoomForwardMode | 更改跨房主播在本房间的上行能力。 |
25
+ | startPublishMediaStream | 开始发布媒体流。 |
26
+ | updatePublishMediaStream | 更新发布媒体流。 |
27
+ | stopPublishMediaStream | 停止发布媒体流。 |
28
+ | startLocalPreview | 开启本地摄像头的预览画面（移动端）。 |
29
+ | updateLocalView | 更新本地摄像头的预览画面。 |
30
+ | stopLocalPreview | 停止摄像头预览。 |
31
+ | muteLocalVideo | 暂停/恢复发布本地的视频流。 |
32
+ | setVideoMuteImage | 设置本地画面被暂停期间的替代图片。 |
33
+ | startRemoteView | 订阅远端用户的视频流，并绑定视频渲染控件。 |
34
+ | updateRemoteView | 更新远端用户的视频渲染控件。 |
35
+ | stopRemoteView | 停止订阅远端用户的视频流，并释放渲染控件。 |
36
+ | stopAllRemoteView | 停止订阅所有远端用户的视频流，并释放全部渲染资源。 |
37
+ | muteRemoteVideoStream | 暂停/恢复订阅远端用户的视频流。 |
38
+ | muteAllRemoteVideoStreams | 暂停/恢复订阅所有远端用户的视频流。 |
39
+ | setVideoEncoderParam | 设置视频编码器的编码参数。 |
40
+ | setNetworkQosParam | 设置网络质量控制的相关参数。 |
41
+ | setLocalRenderParams | 设置本地画面的渲染参数。 |
42
+ | setRemoteRenderParams | 设置远端画面的渲染模式。 |
43
+ | enableEncSmallVideoStream | 开启大小画面双路编码模式。 |
44
+ | setRemoteVideoStreamType | 切换指定远端用户的大小画面。 |
45
+ | snapshotVideo | 视频画面截图。 |
46
+ | setPerspectiveCorrectionPoints | 视频画面透视校正坐标设置。 |
47
+ | setGravitySensorAdaptiveMode | 设置重力感应的适配模式（11.7 及以上版本）。 |
48
+ | startLocalAudio | 开启本地音频的采集和发布。 |
49
+ | stopLocalAudio | 停止本地音频的采集和发布。 |
50
+ | muteLocalAudio | 暂停/恢复发布本地的音频流。 |
51
+ | muteRemoteAudio | 暂停/恢复播放远端的音频流。 |
52
+ | muteAllRemoteAudio | 暂停/恢复播放所有远端用户的音频流。 |
53
+ | setAudioRoute | 设置音频路由。 |
54
+ | setRemoteAudioVolume | 设定某一个远端用户的声音播放音量。 |
55
+ | setAudioCaptureVolume | 设定本地音频的采集音量。 |
56
+ | getAudioCaptureVolume | 获取本地音频的采集音量。 |
57
+ | setAudioPlayoutVolume | 设定远端音频的播放音量。 |
58
+ | getAudioPlayoutVolume | 获取远端音频的播放音量。 |
59
+ | enableAudioVolumeEvaluation | 启用音量大小提示。 |
60
+ | startAudioRecording | 开始录音。 |
61
+ | stopAudioRecording | 停止录音。 |
62
+ | startLocalRecording | 开启本地媒体录制。 |
63
+ | stopLocalRecording | 停止本地媒体录制。 |
64
+ | setRemoteAudioParallelParams | 设置远端音频流智能并发播放策略。 |
65
+ | enable3DSpatialAudioEffect | 启用 3D 音效。 |
66
+ | updateSelf3DSpatialPosition | 设置 3D 音效中自身坐标及朝向信息。 |
67
+ | updateRemote3DSpatialPosition | 设置 3D 音效中远端用户坐标信息。 |
68
+ | set3DSpatialReceivingRange | 设置指定用户所发出声音的可被接收范围。 |
69
+ | getDeviceManager | 获取设备管理类（TXDeviceManager）。 |
70
+ | getBeautyManager | 获取美颜管理类（TXBeautyManager）。 |
71
+ | setWatermark | 添加水印。 |
72
+ | getAudioEffectManager | 获取音效管理类（TXAudioEffectManager）。 |
73
+ | startSystemAudioLoopback | 开启系统声音采集。 |
74
+ | stopSystemAudioLoopback | 停止系统声音采集（iOS 端暂未支持）。 |
75
+ | startScreenCapture | 启动屏幕分享。 |
76
+ | stopScreenCapture | 停止屏幕分享。 |
77
+ | pauseScreenCapture | 暂停屏幕分享。 |
78
+ | resumeScreenCapture | 恢复屏幕分享。 |
79
+ | setSubStreamEncoderParam | 设置屏幕分享（即辅路）的视频编码参数（桌面系统和移动系统均已支持）。 |
80
+ | enableCustomVideoCapture | 启用/关闭视频自定义采集模式。 |
81
+ | sendCustomVideoData | 向 SDK 投送自己采集的视频帧。 |
82
+ | enableCustomAudioCapture | 启用音频自定义采集模式。 |
83
+ | sendCustomAudioData | 向 SDK 投送自己采集的音频数据。 |
84
+ | enableMixExternalAudioFrame | 启用/关闭自定义音轨。 |
85
+ | mixExternalAudioFrame | 向 SDK 混入自定义音轨。 |
86
+ | setMixExternalAudioVolume | 设置推流时混入外部音频的推流音量和播放音量。 |
87
+ | generateCustomPTS | 生成自定义采集时的时间戳。 |
88
+ | setLocalVideoProcessListener | 设置第三方美颜的视频数据回调。 |
89
+ | setLocalVideoRenderListener | 设置本地视频自定义渲染回调。 |
90
+ | setRemoteVideoRenderListener | 设置远端视频自定义渲染回调。 |
91
+ | setAudioFrameListener | 设置音频数据自定义回调。 |
92
+ | setCapturedAudioFrameCallbackFormat | 设置本地麦克风采集出的音频帧回调格式。 |
93
+ | setLocalProcessedAudioFrameCallbackFormat | 设置经过前处理后的本地音频帧回调格式。 |
94
+ | setMixedPlayAudioFrameCallbackFormat | 设置最终要由系统播放出的音频帧回调格式。 |
95
+ | enableCustomAudioRendering | 开启音频自定义播放。 |
96
+ | getCustomAudioRenderingFrame | 获取可播放的音频数据。 |
97
+ | sendCustomCmdMsg | 使用 UDP 通道发送自定义消息给房间内所有用户。 |
98
+ | sendSEIMsg | 使用 SEI 通道发送自定义消息给房间内所有用户。 |
99
+ | startSpeedTest | 开始进行网速测试（进入房间前使用）。 |
100
+ | stopSpeedTest | 停止网络测速。 |
101
+ | getSDKVersion | 获取 SDK 版本信息。 |
102
+ | setLogLevel | 设置 Log 输出级别。 |
103
+ | setConsoleEnabled | 启用/禁用控制台日志打印。 |
104
+ | setLogCompressEnabled | 启用/禁用日志的本地压缩。 |
105
+ | setLogDirPath | 设置本地日志的保存路径。 |
106
+ | setLogListener | 设置日志回调。 |
107
+ | showDebugView | 显示仪表盘。 |
108
+ | TRTCViewMargin | 设置仪表盘的边距。 |
109
+ | callExperimentalAPI | 调用实验性接口。 |
110
+ | enablePayloadPrivateEncryption | 开启或关闭媒体流私有加密。 |
628
111
 
629
112
  ## sharedInstance
630
113
 
631
-
632
-
633
114
  #### 创建 TRTCCloud 实例（单例模式）。
634
- <table>
635
- <tr>
636
- <td rowspan="1" colSpan="1" >参数</td>
637
-
638
- <td rowspan="1" colSpan="1" >描述</td>
639
- </tr>
640
-
641
- <tr>
642
- <td rowspan="1" colSpan="1" >context</td>
643
-
644
- <td rowspan="1" colSpan="1" >仅适用于 Android 平台，SDK 内部会将其转化为 Android 平台的 ApplicationContext 用于调用 Android System API。<br>如果传入的 ` context ` 参数为空，SDK 内部会自动获取当前进程的 ApplicationContext。</td>
645
- </tr>
646
- </table>
647
-
115
+ | 参数 | 描述 |
116
+ | --- | --- |
117
+ | context | 仅适用于 Android 平台，SDK 内部会将其转化为 Android 平台的 ApplicationContext 用于调用 Android System API。<br>如果传入的 ` context ` 参数为空，SDK 内部会自动获取当前进程的 ApplicationContext。 |
648
118
 
649
119
  > **注意**
650
- >
651
-
652
- > 1. 建议使用 [destroySharedInstance](https://write.woa.com/document/87029900866228224) 释放对象。
653
- >
120
+ >
654
121
 
122
+ > 1. 建议使用 destroySharedInstance 释放对象。
123
+ >
655
124
 
656
125
  ## destroySharedInstance
657
126
 
658
-
659
-
660
127
  #### 销毁 TRTCCloud 实例（单例模式）。
661
128
 
662
129
  ## addListener
663
130
 
664
-
665
-
666
131
  #### 添加 TRTC 事件回调。
667
132
 
668
- 您可以通过 [TRTCCloudListener](https://write.woa.com/document/87029920275542016) 获得来自 SDK 的各类事件通知（例如：错误码，警告码，音视频状态参数等）。
133
+ 您可以通过 TRTCCloudListener 获得来自 SDK 的各类事件通知（例如：错误码，警告码，音视频状态参数等）。
669
134
 
670
135
  ## removeListener
671
136
 
672
-
673
-
674
137
  #### 移除 TRTC 事件回调。
675
138
 
676
139
  ## setListenerHandler
677
140
 
678
-
679
-
680
141
  #### 设置驱动 TRTCCloudListener 事件回调的队列。
681
142
 
682
- 如果您不指定自己的 ` listenerHandler ` 默认会采用 MainQueue 作为驱动 [TRTCCloudListener](https://write.woa.com/document/87029920275542016) 事件回调的队列。
683
-
684
- 也就是当您不设置 ` listenerHandler ` 属性时，[TRTCCloudListener](https://write.woa.com/document/87029920275542016) 中的所有回调函数都是由 MainQueue 来驱动的。
685
- <table>
686
- <tr>
687
- <td rowspan="1" colSpan="1" >参数</td>
688
-
689
- <td rowspan="1" colSpan="1" >描述</td>
690
- </tr>
691
-
692
- <tr>
693
- <td rowspan="1" colSpan="1" >listenerHandler</td>
694
-
695
- <td rowspan="1" colSpan="1" >事件回调句柄</td>
696
- </tr>
697
- </table>
143
+ 如果您不指定自己的 ` listenerHandler ` 默认会采用 MainQueue 作为驱动 TRTCCloudListener 事件回调的队列。
698
144
 
145
+ 也就是当您不设置 ` listenerHandler ` 属性时，TRTCCloudListener 中的所有回调函数都是由 MainQueue 来驱动的。
146
+ | 参数 | 描述 |
147
+ | --- | --- |
148
+ | listenerHandler | 事件回调句柄 |
699
149
 
700
150
  > **注意**
701
- >
702
-
703
- > 如果您指定了自己的 ` listenerHandler `，请不要在 [TRTCCloudListener](https://write.woa.com/document/87029920275542016) 回调函数中操作 UI，否则会引发线程安全问题。
704
- >
151
+ >
705
152
 
153
+ > 如果您指定了自己的 ` listenerHandler `，请不要在 TRTCCloudListener 回调函数中操作 UI，否则会引发线程安全问题。
154
+ >
706
155
 
707
156
  ## enterRoom
708
157
 
709
-
710
-
711
158
  #### 进入房间。
712
159
 
713
160
  TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视频流，“发布”是指将自己的音频和视频推送到云端，“订阅”是指从云端拉取房间里其他用户的音视频流。
714
161
 
715
- 调用该接口时，您需要指定您的应用场景 [TRTCAppScene](https://write.woa.com/document/87029993616093184) 以获取最佳的音视频传输体验，这些场景可以分成两大类：
716
-
717
-
162
+ 调用该接口时，您需要指定您的应用场景 TRTCAppScene 以获取最佳的音视频传输体验，这些场景可以分成两大类：
718
163
 
719
164
  **实时通话：**
720
165
 
721
- 包括 [TRTC_APP_SCENE_VIDEOCALL](https://write.woa.com/document/87029993616093184) 和 [TRTC_APP_SCENE_AUDIOCALL](https://write.woa.com/document/87029993616093184) 两个可选项，分别是视频通话和语音通话，该模式适合 1对1 的音视频通话，或者参会人数在 300 人以内的在线会议。
722
-
723
-
166
+ 包括 TRTC_APP_SCENE_VIDEOCALL 和 TRTC_APP_SCENE_AUDIOCALL 两个可选项，分别是视频通话和语音通话，该模式适合 1对1 的音视频通话，或者参会人数在 300 人以内的在线会议。
724
167
 
725
168
  **在线直播：**
726
169
 
727
- 包括 [TRTC_APP_SCENE_LIVE](https://write.woa.com/document/87029993616093184) 和 [TRTC_APP_SCENE_VOICE_CHATROOM](https://write.woa.com/document/87029993616093184) 两个可选项，分别是视频直播和语音直播，该模式适合十万人以内的在线直播场景，但需要您在接下来介绍的 [TRTCParams](https://write.woa.com/document/87029993616093184) 参数中指定 **角色(role)** 这个字段，也就是将房间中的用户区分为 **主播** ([TRTCRoleAnchor](https://write.woa.com/document/87029993616093184)) 和 **观众** ([TRTCRoleAudience](https://write.woa.com/document/87029993616093184)) 两种不同的角色。
170
+ 包括 TRTC_APP_SCENE_LIVE 和 TRTC_APP_SCENE_VOICE_CHATROOM 两个可选项，分别是视频直播和语音直播，该模式适合十万人以内的在线直播场景，但需要您在接下来介绍的 TRTCParams 参数中指定 **角色(role)** 这个字段，也就是将房间中的用户区分为 **主播** (TRTCRoleAnchor) 和 **观众** (TRTCRoleAudience) 两种不同的角色。
728
171
 
729
-
730
-
731
- 调用该接口后，您会收到来自 [TRTCCloudListener](https://write.woa.com/document/87029920275542016) 中的 [onEnterRoom](https://write.woa.com/document/87029920275542016) 回调：
172
+ 调用该接口后，您会收到来自 TRTCCloudListener 中的 onEnterRoom 回调：
732
173
  - 如果进房成功，参数 ` result ` 会是一个正数（result > 0），表示从函数调用到进入房间所花费的时间，单位是毫秒（ms）。
733
174
 
734
175
  - 如果进房失败，参数 ` result ` 会是一个负数（result < 0），表示进房失败的[错误码](https://cloud.tencent.com/document/product/647/32257)。
735
176
 
736
- <table>
737
- <tr>
738
- <td rowspan="1" colSpan="1" >参数</td>
739
-
740
- <td rowspan="1" colSpan="1" >描述</td>
741
- </tr>
742
-
743
- <tr>
744
- <td rowspan="1" colSpan="1" >param</td>
745
-
746
- <td rowspan="1" colSpan="1" >进房参数，用于指定用户的身份、角色和安全票据等信息，详情请参见 [TRTCParams](https://write.woa.com/document/87029993616093184) 。</td>
747
- </tr>
748
-
749
- <tr>
750
- <td rowspan="1" colSpan="1" >scene</td>
751
-
752
- <td rowspan="1" colSpan="1" >应用场景，用于指定您的业务场景，同一个房间内的所有用户需要设定相同的 [TRTCAppScene](https://write.woa.com/document/87029993616093184)。</td>
753
- </tr>
754
- </table>
755
-
177
+ | 参数 | 描述 |
178
+ | --- | --- |
179
+ | param | 进房参数，用于指定用户的身份、角色和安全票据等信息，详情请参见 TRTCParams 。 |
180
+ | scene | 应用场景，用于指定您的业务场景，同一个房间内的所有用户需要设定相同的 TRTCAppScene。 |
756
181
 
757
182
  > **注意**
758
- >
183
+ >
759
184
 
760
185
  > 1. 同一个房间内的所有用户需要设定相同的 ` scene `。不同的 ` scene ` 会导致偶现的异常问题。
761
- >
762
-
763
- > 2. 当您指定参数 ` scene ` 为 [TRTC_APP_SCENE_LIVE](https://write.woa.com/document/87029993616093184) 或 [TRTC_APP_SCENE_VOICE_CHATROOM](https://write.woa.com/document/87029993616093184) 时，您必须通过 [TRTCParams](https://write.woa.com/document/87029993616093184) 中的 ` role `字段为当前用户设定他/她在房间中的角色。
764
- >
186
+ >
765
187
 
766
- > 3. 请您尽量保证 [enterRoom](https://write.woa.com/document/87029900866228224) 与 [exitRoom](https://write.woa.com/document/87029900866228224) 前后配对使用，即保证“先退出前一个房间再进入下一个房间”，否则会导致很多异常问题。
767
- >
188
+ > 2. 当您指定参数 ` scene ` 为 TRTC_APP_SCENE_LIVE 或 TRTC_APP_SCENE_VOICE_CHATROOM 时，您必须通过 TRTCParams 中的 ` role `字段为当前用户设定他/她在房间中的角色。
189
+ >
768
190
 
191
+ > 3. 请您尽量保证 enterRoom 与 exitRoom 前后配对使用，即保证“先退出前一个房间再进入下一个房间”，否则会导致很多异常问题。
192
+ >
769
193
 
770
194
  ## exitRoom
771
195
 
772
-
773
-
774
196
  #### 离开房间。
775
197
 
776
198
  调用该接口会让用户离开自己所在的音视频房间，并释放摄像头、麦克风、扬声器等设备资源。
777
199
 
778
- 等资源释放完毕之后，SDK 会通过 [TRTCCloudListener](https://write.woa.com/document/87029920275542016) 中的 [onExitRoom](https://write.woa.com/document/87029920275542016) 回调向您通知。
200
+ 等资源释放完毕之后，SDK 会通过 TRTCCloudListener 中的 onExitRoom 回调向您通知。
779
201
 
780
-
781
-
782
- 如果您要再次调用 [enterRoom](https://write.woa.com/document/87029900866228224) 或者切换到其他的供应商的 SDK，建议等待 [onExitRoom](https://write.woa.com/document/87029920275542016) 回调到来之后再执行之后的操作，以避免摄像头或麦克风被占用的问题。
202
+ 如果您要再次调用 enterRoom 或者切换到其他的供应商的 SDK，建议等待 onExitRoom 回调到来之后再执行之后的操作，以避免摄像头或麦克风被占用的问题。
783
203
 
784
204
  ## switchRole
785
205
 
786
-
787
-
788
206
  #### 切换角色。
789
207
 
790
208
  调用本接口可以实现用户在“主播”和“观众”两种角色之间来回切换。
791
209
 
792
-
793
-
794
210
  由于视频直播和语音聊天室需要支持多达10万名观众同时观看，所以设定了 **只有主播才能发布自己的音视频** 的规则。因此，当有些观众希望发布自己的音视频流（以便能跟主播互动）时，就需要先把自己的角色切换成 **主播**。
795
211
 
796
-
797
-
798
- 您可以在进入房间时通过 [TRTCParams](https://write.woa.com/document/87029993616093184) 中的 ` role ` 字段事先确定用户的角色，也可以在进入房间后通过该接口动态切换角色。
799
- <table>
800
- <tr>
801
- <td rowspan="1" colSpan="1" >参数</td>
802
-
803
- <td rowspan="1" colSpan="1" >描述</td>
804
- </tr>
805
-
806
- <tr>
807
- <td rowspan="1" colSpan="1" >role</td>
808
-
809
- <td rowspan="1" colSpan="1" >角色，默认为 **主播**。<br>- [TRTCRoleAnchor](https://write.woa.com/document/87029993616093184) ：主播，可以发布自己的音视频，同一个房间里最多支持50个主播同时发布音视频。<br>- [TRTCRoleAudience](https://write.woa.com/document/87029993616093184) ：观众，不能发布自己的音视频流，只能观看房间中其他主播的音视频。如果要发布自己的音视频，需要先通过 [switchRole](https://write.woa.com/document/87029900866228224) 切换成 **主播**，同一个房间内同时最多可以容纳 10 万名观众。</td>
810
- </tr>
811
- </table>
812
-
212
+ 您可以在进入房间时通过 TRTCParams 中的 ` role ` 字段事先确定用户的角色，也可以在进入房间后通过该接口动态切换角色。
213
+ | 参数 | 描述 |
214
+ | --- | --- |
215
+ | role | 角色，默认为 **主播**。<br>- TRTCRoleAnchor ：主播，可以发布自己的音视频，同一个房间里最多支持50个主播同时发布音视频。<br>- TRTCRoleAudience ：观众，不能发布自己的音视频流，只能观看房间中其他主播的音视频。如果要发布自己的音视频，需要先通过 switchRole 切换成 **主播**，同一个房间内同时最多可以容纳 10 万名观众。 |
813
216
 
814
217
  > **注意**
815
- >
816
-
817
- > 1. 该接口仅适用于视频直播（[TRTC_APP_SCENE_LIVE](https://write.woa.com/document/87029993616093184)）和语音聊天室（[TRTC_APP_SCENE_VOICE_CHATROOM](https://write.woa.com/document/87029993616093184)）这两个场景。
818
- >
218
+ >
819
219
 
820
- > 2. 如果您在调用 [enterRoom](https://write.woa.com/document/87029900866228224) 时指定的 ` scene ` 为 [TRTC_APP_SCENE_VIDEOCALL](https://write.woa.com/document/87029993616093184) 或 [TRTC_APP_SCENE_AUDIOCALL](https://write.woa.com/document/87029993616093184)，请不要调用这个接口。
821
- >
220
+ > 1. 该接口仅适用于视频直播（TRTC_APP_SCENE_LIVE）和语音聊天室（TRTC_APP_SCENE_VOICE_CHATROOM）这两个场景。
221
+ >
822
222
 
223
+ > 2. 如果您在调用 enterRoom 时指定的 ` scene ` 为 TRTC_APP_SCENE_VIDEOCALL 或 TRTC_APP_SCENE_AUDIOCALL，请不要调用这个接口。
224
+ >
823
225
 
824
226
  ## switchRole
825
227
 
826
-
827
-
828
228
  #### 切换角色（支持设置权限位）。
829
229
 
830
230
  调用本接口可以实现用户在“主播”和“观众”两种角色之间来回切换。
831
231
 
832
-
833
-
834
232
  由于视频直播和语音聊天室需要支持多达10万名观众同时观看，所以设定了 **只有主播才能发布自己的音视频** 的规则。因此，当有些观众希望发布自己的音视频流（以便能跟主播互动）时，就需要先把自己的角色切换成 **主播**。
835
233
 
836
-
837
-
838
- 您可以在进入房间时通过 [TRTCParams](https://write.woa.com/document/87029993616093184) 中的 ` role ` 字段事先确定用户的角色，也可以在进入房间后通过该接口动态切换角色。
839
- <table>
840
- <tr>
841
- <td rowspan="1" colSpan="1" >参数</td>
842
-
843
- <td rowspan="1" colSpan="1" >描述</td>
844
- </tr>
845
-
846
- <tr>
847
- <td rowspan="1" colSpan="1" >privateMapKey</td>
848
-
849
- <td rowspan="1" colSpan="1" >用于权限控制的权限票据，当您希望某个房间只能让特定的 userId 进入或者上行视频时，需要使用 ` privateMapKey ` 进行权限保护。<br>- 仅建议有高级别安全需求的客户使用，更多详情请参见 [开启高级权限控制](https://cloud.tencent.com/document/product/647/32240)。</td>
850
- </tr>
851
-
852
- <tr>
853
- <td rowspan="1" colSpan="1" >role</td>
854
-
855
- <td rowspan="1" colSpan="1" >角色，默认为 **主播**。<br>- [TRTCRoleAnchor](https://write.woa.com/document/87029993616093184) ：主播，可以发布自己的音视频，同一个房间里最多支持50个主播同时发布音视频。<br>- [TRTCRoleAudience](https://write.woa.com/document/87029993616093184) ：观众，不能发布自己的音视频流，只能观看房间中其他主播的音视频。如果要发布自己的音视频，需要先通过 [switchRole](https://write.woa.com/document/87029900866228224) 切换成 **主播**，同一个房间内同时最多可以容纳 10 万名观众。</td>
856
- </tr>
857
- </table>
858
-
234
+ 您可以在进入房间时通过 TRTCParams 中的 ` role ` 字段事先确定用户的角色，也可以在进入房间后通过该接口动态切换角色。
235
+ | 参数 | 描述 |
236
+ | --- | --- |
237
+ | privateMapKey | 用于权限控制的权限票据，当您希望某个房间只能让特定的 userId 进入或者上行视频时，需要使用 ` privateMapKey ` 进行权限保护。<br>- 仅建议有高级别安全需求的客户使用，更多详情请参见 [开启高级权限控制](https://cloud.tencent.com/document/product/647/32240)。 |
238
+ | role | 角色，默认为 **主播**。<br>- TRTCRoleAnchor ：主播，可以发布自己的音视频，同一个房间里最多支持50个主播同时发布音视频。<br>- TRTCRoleAudience ：观众，不能发布自己的音视频流，只能观看房间中其他主播的音视频。如果要发布自己的音视频，需要先通过 switchRole 切换成 **主播**，同一个房间内同时最多可以容纳 10 万名观众。 |
859
239
 
860
240
  > **注意**
861
- >
862
-
863
- > 1. 该接口仅适用于视频直播（[TRTC_APP_SCENE_LIVE](https://write.woa.com/document/87029993616093184)）和语音聊天室（[TRTC_APP_SCENE_VOICE_CHATROOM](https://write.woa.com/document/87029993616093184)）这两个场景。
864
- >
241
+ >
865
242
 
866
- > 2. 如果您在 [enterRoom](https://write.woa.com/document/87029900866228224) 时指定的 ` scene ` 为 [TRTC_APP_SCENE_VIDEOCALL](https://write.woa.com/document/87029993616093184) 或 [TRTC_APP_SCENE_AUDIOCALL](https://write.woa.com/document/87029993616093184)，请不要调用这个接口。
867
- >
243
+ > 1. 该接口仅适用于视频直播（TRTC_APP_SCENE_LIVE）和语音聊天室（TRTC_APP_SCENE_VOICE_CHATROOM）这两个场景。
244
+ >
868
245
 
246
+ > 2. 如果您在 enterRoom 时指定的 ` scene ` 为 TRTC_APP_SCENE_VIDEOCALL 或 TRTC_APP_SCENE_AUDIOCALL，请不要调用这个接口。
247
+ >
869
248
 
870
249
  ## switchRoom
871
250
 
872
-
873
-
874
251
  #### 切换房间。
875
252
 
876
253
  使用该接口可以让用户快速从一个房间切换到另一个房间。
@@ -878,74 +255,44 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
878
255
 
879
256
  - 如果用户的身份是“主播”，该接口在切换房间的同时还会保持自己的音视频发布状态，因此在房间切换过程中，摄像头的预览和声音的采集都不会中断。
880
257
 
881
-
882
-
883
-
884
258
  该接口适用于在线教育场景中，监课老师在多个房间中进行快速切换的场景。在该场景下使用 ` switchRoom ` 可以获得比 ` exitRoom + enterRoom ` 更好的流畅性和更少的代码量。
885
259
 
886
- 接口调用结果会通过 [TRTCCloudListener](https://write.woa.com/document/87029920275542016) 中的 [onSwitchRoom](https://write.woa.com/document/87029920275542016) 回调。
887
- <table>
888
- <tr>
889
- <td rowspan="1" colSpan="1" >参数</td>
890
-
891
- <td rowspan="1" colSpan="1" >描述</td>
892
- </tr>
893
-
894
- <tr>
895
- <td rowspan="1" colSpan="1" >config</td>
896
-
897
- <td rowspan="1" colSpan="1" >房间参数，详情请参见 [TRTCSwitchRoomConfig](https://write.woa.com/document/87029993616093184)。</td>
898
- </tr>
899
- </table>
900
-
260
+ 接口调用结果会通过 TRTCCloudListener 中的 onSwitchRoom 回调。
261
+ | 参数 | 描述 |
262
+ | --- | --- |
263
+ | config | 房间参数，详情请参见 TRTCSwitchRoomConfig。 |
901
264
 
902
265
  > **注意**
903
- >
266
+ >
904
267
 
905
268
  > 由于对老版本 SDK 兼容的需求，参数 ` config ` 中同时包含 ` roomId ` 与 ` strRoomId ` 两个参数，这两个参数的填写格外讲究，请注意如下事项：
906
- >
269
+ >
907
270
 
908
271
  > 1. 若您选用 ` strRoomId `，则 ` roomId ` 需要填写为0。若两者都填，将优先选用 ` roomId `。
909
- >
272
+ >
910
273
 
911
274
  > 2. 所有房间需要同时使用 ` strRoomId ` 或同时使用 ` roomId `，不可混用，否则将会出现很多预期之外的 bug。
912
- >
913
-
275
+ >
914
276
 
915
277
  ## ConnectOtherRoom
916
278
 
917
-
918
-
919
279
  #### 请求跨房通话。
920
280
 
921
281
  默认情况下，只有同一个房间中的用户之间可以进行音视频通话，不同的房间之间的音视频流是相互隔离的。
922
282
 
923
283
  但您可以通过调用该接口，将另一个房间中某个主播音视频流发布到自己所在的房间中，与此同时，该接口也会将自己的音视频流发布到目标主播的房间中。
924
284
 
925
-
926
-
927
285
  也就是说，您可以使用该接口让身处两个不同房间中的主播进行跨房间的音视频流分享，从而让每个房间中的观众都能观看到这两个主播的音视频。该功能可以用来实现主播之间的 PK 功能。
928
286
 
929
-
930
-
931
- 跨房通话的请求结果会通过 [TRTCCloudListener](https://write.woa.com/document/87029920275542016) 中的 [onConnectOtherRoom](https://write.woa.com/document/87029920275542016) 回调通知给您。
932
-
933
-
287
+ 跨房通话的请求结果会通过 TRTCCloudListener 中的 onConnectOtherRoom 回调通知给您。
934
288
 
935
289
  例如：当房间“101”中的主播 A 通过 ` connectOtherRoom() ` 跟房间“102”中的主播 B 建立跨房通话后，
936
290
  - 房间“101”中的用户都会收到主播 B 的 ` onRemoteUserEnterRoom(B) ` 和 ` onUserVideoAvailable(B,true) ` 这两个事件回调，即房间“101”中的用户都可以订阅主播 B 的音视频。
937
291
 
938
292
  - 房间“102”中的用户都会收到主播 A 的 ` onRemoteUserEnterRoom(A) ` 和 ` onUserVideoAvailable(A,true) ` 这两个事件回调，即房间“102”中的用户都可以订阅主播 A 的音视频。
939
293
 
940
-
941
-
942
-
943
- ![](https://qcloudimg.tencent-cloud.cn/raw/c5e6c72fc163ad5c0b6b7b00e1da55b5.png)
944
-
945
294
  跨房通话的参数考虑到后续扩展字段的兼容性问题，暂时采用了 JSON 格式的参数：
946
295
 
947
-
948
-
949
296
  **情况一：数字房间号**
950
297
 
951
298
  如果房间“101”中的主播 A 要跟房间“102”中的主播 B 连麦，那么主播 A 调用该接口时需要传入：` {"roomId": 102, "userId": "userB"} `
@@ -958,8 +305,6 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
958
305
  trtc.ConnectOtherRoom(jsonObj.toString());
959
306
  ```
960
307
 
961
-
962
-
963
308
  **情况二：字符串房间号**
964
309
 
965
310
  如果您使用的是字符串房间号，务必请将 json 中的 “roomId” 替换成 “strRoomId”: ` {"strRoomId": "102", "userId": "userB"} `
@@ -971,97 +316,54 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
971
316
  jsonObj.put("userId", "userB");
972
317
  trtc.ConnectOtherRoom(jsonObj.toString());
973
318
  ```
974
- <table>
975
- <tr>
976
- <td rowspan="1" colSpan="1" >参数</td>
977
-
978
- <td rowspan="1" colSpan="1" >描述</td>
979
- </tr>
980
-
981
- <tr>
982
- <td rowspan="1" colSpan="1" >param</td>
983
-
984
- <td rowspan="1" colSpan="1" >需要您传入 JSON 格式的字符串参数，` roomId ` 代表数字格式的房间号，` strRoomId ` 代表字符串格式的房间号，` userId ` 代表目标主播的用户 ID。</td>
985
- </tr>
986
- </table>
987
-
319
+ | 参数 | 描述 |
320
+ | --- | --- |
321
+ | param | 需要您传入 JSON 格式的字符串参数，` roomId ` 代表数字格式的房间号，` strRoomId ` 代表字符串格式的房间号，` userId ` 代表目标主播的用户 ID。 |
988
322
 
989
323
  ## DisconnectOtherRoom
990
324
 
991
-
992
-
993
325
  #### 退出跨房通话。
994
326
 
995
- 退出结果会通过 [TRTCCloudListener](https://write.woa.com/document/87029920275542016) 中的 onDisconnectOtherRoom 回调通知给您。
327
+ 退出结果会通过 TRTCCloudListener 中的 onDisconnectOtherRoom 回调通知给您。
996
328
 
997
329
  ## setDefaultStreamRecvMode
998
330
 
999
-
1000
-
1001
331
  #### 设置订阅模式（需要在进入房前设置才能生效）。
1002
332
 
1003
333
  您可以通过该接口在“自动订阅”和“手动订阅”两种模式下进行切换：
1004
- - 自动订阅：默认模式，用户在进入房间后会立刻接收到该房间中的音视频流，音频会自动播放，视频会自动开始解码（依然需要您通过 [startRemoteView](https://write.woa.com/document/87029900866228224) 接口绑定渲染控件）。
1005
-
1006
- - 手动订阅：在用户进入房间后，需要手动调用 [startRemoteView](https://write.woa.com/document/87029900866228224) 接口才能启动视频流的订阅和解码，需要手动调用 [muteRemoteAudio](https://write.woa.com/document/87029900866228224) (false) 接口才能启动声音的播放。
1007
-
1008
-
334
+ - 自动订阅：默认模式，用户在进入房间后会立刻接收到该房间中的音视频流，音频会自动播放，视频会自动开始解码（依然需要您通过 startRemoteView 接口绑定渲染控件）。
1009
335
 
336
+ - 手动订阅：在用户进入房间后，需要手动调用 startRemoteView 接口才能启动视频流的订阅和解码，需要手动调用 muteRemoteAudio (false) 接口才能启动声音的播放。
1010
337
 
1011
338
  在绝大多数场景下，用户进入房间后都会订阅房间中所有主播的音视频流，因此 TRTC 默认采用了自动订阅模式，以求得最佳的“秒开体验”。
1012
339
 
1013
340
  如果您的应用场景中每个房间同时会有很多路音视频流在发布，而每个用户只想选择性地订阅其中的 1-2 路，则推荐使用“手动订阅”模式以节省流量费用。
1014
- <table>
1015
- <tr>
1016
- <td rowspan="1" colSpan="1" >参数</td>
1017
-
1018
- <td rowspan="1" colSpan="1" >描述</td>
1019
- </tr>
1020
-
1021
- <tr>
1022
- <td rowspan="1" colSpan="1" >autoRecvAudio</td>
1023
-
1024
- <td rowspan="1" colSpan="1" >true：自动订阅音频；false：需手动调用 ` muteRemoteAudio(false) ` 订阅音频。默认值：true。</td>
1025
- </tr>
1026
-
1027
- <tr>
1028
- <td rowspan="1" colSpan="1" >autoRecvVideo</td>
1029
-
1030
- <td rowspan="1" colSpan="1" >true：自动订阅视频；false：需手动调用 ` startRemoteView ` 订阅视频。默认值：true。</td>
1031
- </tr>
1032
- </table>
1033
-
341
+ | 参数 | 描述 |
342
+ | --- | --- |
343
+ | autoRecvAudio | true：自动订阅音频；false：需手动调用 ` muteRemoteAudio(false) ` 订阅音频。默认值：true。 |
344
+ | autoRecvVideo | true：自动订阅视频；false：需手动调用 ` startRemoteView ` 订阅视频。默认值：true。 |
1034
345
 
1035
346
  > **注意**
1036
- >
347
+ >
1037
348
 
1038
349
  > 1. 需要在进入房间前调用该接口进行设置才能生效。
1039
- >
1040
-
1041
- > 2. 在自动订阅模式下，如果用户在进入房间后没有调用 [startRemoteView](https://write.woa.com/document/87029900866228224) 订阅视频流，SDK 会自动停止订阅视频流，以便达到节省流量的目的。
1042
- >
350
+ >
1043
351
 
352
+ > 2. 在自动订阅模式下，如果用户在进入房间后没有调用 startRemoteView 订阅视频流，SDK 会自动停止订阅视频流，以便达到节省流量的目的。
353
+ >
1044
354
 
1045
355
  ## createSubCloud
1046
356
 
1047
-
1048
-
1049
357
  #### 创建子房间实例（用于多房间并发观看）。
1050
358
 
1051
359
  TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的能力。
1052
360
 
1053
361
  通过调用该接口，您可以创建出多个 TRTCCloud 实例，以便同时进入多个不同的房间观看音视频流。
1054
362
 
1055
-
1056
-
1057
363
  但需要注意的是，您在多个 TRTCCloud 实例中发布音视频流的能力会受到一定限制。
1058
364
 
1059
-
1060
-
1061
365
  该功能主要用于在线教育场景中一种被称为“超级小班课”的业务场景中，用于解决“每个 TRTC 的房间中最多只能有 50 人同时发布自己音视频流”的限制。
1062
366
 
1063
-
1064
-
1065
367
  示例代码如下：
1066
368
  ``` java
1067
369
  //In the small room that needs interaction, enter the room as an anchor and push audio and video streams
@@ -1089,22 +391,21 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
1089
391
  ```
1090
392
 
1091
393
  > **注意**
1092
- >
394
+ >
1093
395
 
1094
396
  > 1. 同一个用户，可以使用同一个 userId 进入多个不同 roomId 的房间。
1095
- >
397
+ >
1096
398
 
1097
399
  > 2. 两台不同的终端设备不可以同时使用同一个 userId 进入同一个 roomId 的房间。
1098
- >
400
+ >
1099
401
 
1100
- > 3. 您可以分别为不同实例分别设置 [TRTCCloudListener](https://write.woa.com/document/87029920275542016) 获取各自的事件通知。
1101
- >
402
+ > 3. 您可以分别为不同实例分别设置 TRTCCloudListener 获取各自的事件通知。
403
+ >
1102
404
 
1103
405
  > 4. 同一个用户可以在多个 TRTCCloud 实例中推流，也可以调用子实例中与本地音视频相关的接口。但需要注意：
1104
- >
406
+ >
1105
407
  > - 多实例的音频需要同时为麦克风采集或自定义采集，而且与音频设备相关的接口调用会以最后一次为准；
1106
- > - 与摄像头相关的调用会以最后一次为准：[startLocalPreview](https://write.woa.com/document/87029900866228224)。
1107
-
408
+ > - 与摄像头相关的调用会以最后一次为准：startLocalPreview。
1108
409
 
1109
410
  #### 返回值说明：
1110
411
 
@@ -1112,62 +413,35 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
1112
413
 
1113
414
  ## destroySubCloud
1114
415
 
1115
-
1116
-
1117
416
  #### 销毁子房间实例。
1118
- <table>
1119
- <tr>
1120
- <td rowspan="1" colSpan="1" >参数</td>
1121
-
1122
- <td rowspan="1" colSpan="1" >描述</td>
1123
- </tr>
1124
-
1125
- <tr>
1126
- <td rowspan="1" colSpan="1" >subCloud</td>
1127
-
1128
- <td rowspan="1" colSpan="1" >子房间实例</td>
1129
- </tr>
1130
- </table>
1131
-
417
+ | 参数 | 描述 |
418
+ | --- | --- |
419
+ | subCloud | 子房间实例 |
1132
420
 
1133
421
  ## updateOtherRoomForwardMode
1134
422
 
1135
-
1136
-
1137
423
  #### 更改跨房主播在本房间的上行能力。
1138
424
 
1139
- 通常情况下，在调用 [connectOtherRoom](https://write.woa.com/document/87029900866228224) 接口与另一个房间的主播进行跨房通话后，本房间内的所有观众都将收到该主播发布的音视频流。
425
+ 通常情况下，在调用 connectOtherRoom 接口与另一个房间的主播进行跨房通话后，本房间内的所有观众都将收到该主播发布的音视频流。
1140
426
 
1141
427
  您可以通过调用该接口，限制跨房主播在本房间内的上行能力，禁止或允许跨房主播发布音频/主路视频/辅路视频，该行为会影响房间内的所有用户。
1142
428
 
1143
429
  在禁用跨房主播某种上行能力后，本房间内所有用户将无法收到对应音视频流，且无法再订阅对应的音视频。
1144
430
 
1145
-
1146
-
1147
431
  需要注意的是，该接口只能由进行跨房通话的主播调用，且通过该接口设置的限制会因为跨房通话的中断或对应主播退房重置。
1148
432
 
1149
-
1150
-
1151
- 该接口的调用结果会通过 [TRTCCloudListener](https://write.woa.com/document/87029920275542016) 中的 [onUpdateOtherRoomForwardMode](https://write.woa.com/document/87029920275542016) 回调通知给您。
1152
-
1153
-
433
+ 该接口的调用结果会通过 TRTCCloudListener 中的 onUpdateOtherRoomForwardMode 回调通知给您。
1154
434
 
1155
435
  例如：
1156
436
 
1157
- 房间“101”中有主播 A 与观众 B，房间“102”中有主播 C，主播 C 正常发布音视频流。主播 A 通过 [connectOtherRoom](https://write.woa.com/document/87029900866228224) 跟主播 C 建立跨房通话。
437
+ 房间“101”中有主播 A 与观众 B，房间“102”中有主播 C，主播 C 正常发布音视频流。主播 A 通过 connectOtherRoom 跟主播 C 建立跨房通话。
1158
438
  - 此时，主播 A 与观众 B 都会收到主播 C 的 ` onRemoteUserEnterRoom(C) `, ` onUserVideoAvailable(C,true) ` 和 ` onUserAudioAvailable(C,true) ` 这三个事件回调，可以订阅主播 C 的音视频。
1159
439
 
1160
-
1161
-
1162
-
1163
440
  之后，主播 A 调用该接口禁用主播 C 在本房间发布音频的能力。
1164
441
  - 此后，主播 C 的音频流将无法发布至房间“101”，主播 A 与观众 B 都将收到 ` onUserAudioAvailable(C,false) ` 事件回调，且无法再通过 ` muteRemoteAudio(C,false) ` 订阅主播 C 的音频。
1165
442
 
1166
443
  - 主播 C 的视频流将不受影响。房间“102”中的其他观众也不受影响，可以正常订阅主播 C 的音频。
1167
444
 
1168
-
1169
-
1170
-
1171
445
  该接口的参数考虑到后续扩展字段的兼容性问题，暂时采用了 JSON 格式的参数，示例如下：
1172
446
 
1173
447
  **情况一：数字房间号**
@@ -1181,8 +455,6 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
1181
455
  }
1182
456
  ```
1183
457
 
1184
-
1185
-
1186
458
  **情况二：字符串房间号**
1187
459
  ``` java
1188
460
  {
@@ -1193,628 +465,298 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
1193
465
  "muteSubStream":false
1194
466
  }
1195
467
  ```
1196
- <table>
1197
- <tr>
1198
- <td rowspan="1" colSpan="1" >参数</td>
1199
-
1200
- <td rowspan="1" colSpan="1" >描述</td>
1201
- </tr>
1202
-
1203
- <tr>
1204
- <td rowspan="1" colSpan="1" >param</td>
1205
-
1206
- <td rowspan="1" colSpan="1" >需要您传入 JSON 格式的字符串参数，` roomId ` 代表数字格式的房间号，` strRoomId ` 代表字符串格式的房间号，` userId ` 代表目标主播的用户 ID，` muteAudio `, ` muteVideo `,` muteSubStream ` 均为可选项，分表代表禁止或允许跨房主播发布音频/主路视频/辅路视频的能力。</td>
1207
- </tr>
1208
- </table>
1209
-
468
+ | 参数 | 描述 |
469
+ | --- | --- |
470
+ | param | 需要您传入 JSON 格式的字符串参数，` roomId ` 代表数字格式的房间号，` strRoomId ` 代表字符串格式的房间号，` userId ` 代表目标主播的用户 ID，` muteAudio `, ` muteVideo `,` muteSubStream ` 均为可选项，分表代表禁止或允许跨房主播发布音频/主路视频/辅路视频的能力。 |
1210
471
 
1211
472
  ## startPublishMediaStream
1212
473
 
1213
-
1214
-
1215
474
  #### 开始发布媒体流。
1216
475
 
1217
- 该接口会向 TRTC 服务器发送指令，要求其将当前用户的音视频流转推/转码到直播 CDN 或者回推到 TRTC 房间中您可以通过 [TRTCPublishTarget](https://write.woa.com/document/87029993616093184) 配置中的 [TRTCPublishMode](https://write.woa.com/document/87029993616093184) 指定具体的发布模式
1218
- <table>
1219
- <tr>
1220
- <td rowspan="1" colSpan="1" >参数</td>
1221
-
1222
- <td rowspan="1" colSpan="1" >描述</td>
1223
- </tr>
1224
-
1225
- <tr>
1226
- <td rowspan="1" colSpan="1" >config</td>
1227
-
1228
- <td rowspan="1" colSpan="1" >媒体流转码配置参数。具体配置参考 [TRTCStreamMixingConfig](https://write.woa.com/document/87029993616093184)。转码和回推到 TRTC 房间中时为必填项，您需要指定您预期的转码配置参数。转推模式下则无效。</td>
1229
- </tr>
1230
-
1231
- <tr>
1232
- <td rowspan="1" colSpan="1" >params</td>
1233
-
1234
- <td rowspan="1" colSpan="1" >媒体流编码输出参数，具体配置参考 [TRTCStreamEncoderParam](https://write.woa.com/document/87029993616093184)。转码和回推到 TRTC 房间中时为必填项，您需要指定您预期的转码输出参数。在转推时，为了更好的转推稳定性和 CDN 兼容性，也建议您进行配置。</td>
1235
- </tr>
1236
-
1237
- <tr>
1238
- <td rowspan="1" colSpan="1" >target</td>
1239
-
1240
- <td rowspan="1" colSpan="1" >媒体流发布的目标地址，具体配置参考 [TRTCPublishTarget](https://write.woa.com/document/87029993616093184)。支持转推/转码到腾讯或者第三方 CDN，也支持转码回推到 TRTC 房间中。</td>
1241
- </tr>
1242
- </table>
1243
-
476
+ 该接口会向 TRTC 服务器发送指令，要求其将当前用户的音视频流转推/转码到直播 CDN 或者回推到 TRTC 房间中您可以通过 TRTCPublishTarget 配置中的 TRTCPublishMode 指定具体的发布模式
477
+ | 参数 | 描述 |
478
+ | --- | --- |
479
+ | config | 媒体流转码配置参数。具体配置参考 TRTCStreamMixingConfig。转码和回推到 TRTC 房间中时为必填项，您需要指定您预期的转码配置参数。转推模式下则无效。 |
480
+ | params | 媒体流编码输出参数，具体配置参考 TRTCStreamEncoderParam。转码和回推到 TRTC 房间中时为必填项，您需要指定您预期的转码输出参数。在转推时，为了更好的转推稳定性和 CDN 兼容性，也建议您进行配置。 |
481
+ | target | 媒体流发布的目标地址，具体配置参考 TRTCPublishTarget。支持转推/转码到腾讯或者第三方 CDN，也支持转码回推到 TRTC 房间中。 |
1244
482
 
1245
483
  > **注意**
1246
- >
484
+ >
1247
485
 
1248
- > 1. SDK 会通过回调 [onStartPublishMediaStream](https://write.woa.com/document/87029920275542016) 带给您后台启动的任务标识（即 taskId）。
1249
- >
486
+ > 1. SDK 会通过回调 onStartPublishMediaStream 带给您后台启动的任务标识（即 taskId）。
487
+ >
1250
488
 
1251
- > 2. 同一个任务（[TRTCPublishMode](https://write.woa.com/document/87029993616093184) 与 [TRTCPublishCdnUrl](https://write.woa.com/document/87029993616093184) 均相同）仅支持启动一次。若您后续需要更新或者停止该项任务，需要记录并使用返回的 taskId，通过 [updatePublishMediaStream](https://write.woa.com/document/87029900866228224) 或者 [stopPublishMediaStream](https://write.woa.com/document/87029900866228224) 来操作。
1252
- >
489
+ > 2. 同一个任务（TRTCPublishMode 与 TRTCPublishCdnUrl 均相同）仅支持启动一次。若您后续需要更新或者停止该项任务，需要记录并使用返回的 taskId，通过 updatePublishMediaStream 或者 stopPublishMediaStream 来操作。
490
+ >
1253
491
 
1254
492
  > 3. ` target ` 支持同时配置多个 CDN URL（最多同时 10 个）。若您的同一个转推/转码任务需要发布至多路 CDN，则仅需要在 ` target ` 中配置多个 CDN URL 即可。同一个转码任务即使有多个转推地址，对应的转码计费仍只收取一份。
1255
- >
493
+ >
1256
494
 
1257
495
  > 4. 使用时需要注意不要多个任务同时往相同的 URL 地址推送，以免引起异常推流状态。一种推荐的方案是 URL 中使用 “sdkappid_roomid_userid_main” 作为区分标识，这种命名方式容易辨认且不会在您的多个应用中发生冲突。
1258
- >
1259
-
496
+ >
1260
497
 
1261
498
  ## updatePublishMediaStream
1262
499
 
1263
-
1264
-
1265
500
  #### 更新发布媒体流。
1266
501
 
1267
- 该接口会向 TRTC 服务器发送指令，更新通过 [startPublishMediaStream](https://write.woa.com/document/87029900866228224) 启动的媒体流
1268
- <table>
1269
- <tr>
1270
- <td rowspan="1" colSpan="1" >参数</td>
1271
-
1272
- <td rowspan="1" colSpan="1" >描述</td>
1273
- </tr>
1274
-
1275
- <tr>
1276
- <td rowspan="1" colSpan="1" >config</td>
1277
-
1278
- <td rowspan="1" colSpan="1" >媒体流转码配置参数。具体配置参考 [TRTCStreamMixingConfig](https://write.woa.com/document/87029993616093184)。转码和回推到 TRTC 房间中时为必填项，您需要指定您预期的转码配置参数。转推模式下则无效。</td>
1279
- </tr>
1280
-
1281
- <tr>
1282
- <td rowspan="1" colSpan="1" >params</td>
1283
-
1284
- <td rowspan="1" colSpan="1" >媒体流编码输出参数，具体配置参考 [TRTCStreamEncoderParam](https://write.woa.com/document/87029993616093184)。转码和回推到 TRTC 房间中时为必填项，您需要指定您预期的转码输出参数。在转推时，为了更好的转推稳定性和 CDN 兼容性，也建议您进行配置。</td>
1285
- </tr>
1286
-
1287
- <tr>
1288
- <td rowspan="1" colSpan="1" >target</td>
1289
-
1290
- <td rowspan="1" colSpan="1" >媒体流发布的目标地址，具体配置参考 [TRTCPublishTarget](https://write.woa.com/document/87029993616093184)。支持转推/转码到腾讯或者第三方 CDN，也支持转码回推到 TRTC 房间中。</td>
1291
- </tr>
1292
-
1293
- <tr>
1294
- <td rowspan="1" colSpan="1" >taskId</td>
1295
-
1296
- <td rowspan="1" colSpan="1" >通过回调 [onStartPublishMediaStream](https://write.woa.com/document/87029920275542016) 带给您后台启动的任务标识（即 taskId）</td>
1297
- </tr>
1298
- </table>
1299
-
502
+ 该接口会向 TRTC 服务器发送指令，更新通过 startPublishMediaStream 启动的媒体流
503
+ | 参数 | 描述 |
504
+ | --- | --- |
505
+ | config | 媒体流转码配置参数。具体配置参考 TRTCStreamMixingConfig。转码和回推到 TRTC 房间中时为必填项，您需要指定您预期的转码配置参数。转推模式下则无效。 |
506
+ | params | 媒体流编码输出参数，具体配置参考 TRTCStreamEncoderParam。转码和回推到 TRTC 房间中时为必填项，您需要指定您预期的转码输出参数。在转推时，为了更好的转推稳定性和 CDN 兼容性，也建议您进行配置。 |
507
+ | target | 媒体流发布的目标地址，具体配置参考 TRTCPublishTarget。支持转推/转码到腾讯或者第三方 CDN，也支持转码回推到 TRTC 房间中。 |
508
+ | taskId | 通过回调 onStartPublishMediaStream 带给您后台启动的任务标识（即 taskId） |
1300
509
 
1301
510
  > **注意**
1302
- >
511
+ >
1303
512
 
1304
513
  > 1. 您可以通过本接口来更新发布的 CDN URL（支持增删，最多同时 10 个），但您使用时需要注意不要多个任务同时往相同的 URL 地址推送，以免引起异常推流状态。
1305
- >
514
+ >
1306
515
 
1307
- > 2. 您可以通过 ` taskId ` 来更新调整转推/转码任务。例如在 pk 业务中，您可以先通过 [startPublishMediaStream](https://write.woa.com/document/87029900866228224) 发起转推，接着在主播发起 pk 时，通过 ` taskId ` 和本接口将转推更新为转码任务。此时，CDN 播放将连续并且不会发生断流（您需要保持媒体流编码输出参数 param 一致）。
1308
- >
516
+ > 2. 您可以通过 ` taskId ` 来更新调整转推/转码任务。例如在 pk 业务中，您可以先通过 startPublishMediaStream 发起转推，接着在主播发起 pk 时，通过 ` taskId ` 和本接口将转推更新为转码任务。此时，CDN 播放将连续并且不会发生断流（您需要保持媒体流编码输出参数 param 一致）。
517
+ >
1309
518
 
1310
519
  > 3. 同一个任务不支持纯音频、音视频、纯视频之间的切换。
1311
- >
1312
-
520
+ >
1313
521
 
1314
522
  ## stopPublishMediaStream
1315
523
 
1316
-
1317
-
1318
524
  #### 停止发布媒体流。
1319
525
 
1320
- 该接口会向 TRTC 服务器发送指令，停止通过 [startPublishMediaStream](https://write.woa.com/document/87029900866228224) 启动的媒体流
1321
- <table>
1322
- <tr>
1323
- <td rowspan="1" colSpan="1" >参数</td>
1324
-
1325
- <td rowspan="1" colSpan="1" >描述</td>
1326
- </tr>
1327
-
1328
- <tr>
1329
- <td rowspan="1" colSpan="1" >taskId</td>
1330
-
1331
- <td rowspan="1" colSpan="1" >通过回调 [onStartPublishMediaStream](https://write.woa.com/document/87029920275542016) 带给您后台启动的任务标识（即 taskId）</td>
1332
- </tr>
1333
- </table>
1334
-
526
+ 该接口会向 TRTC 服务器发送指令，停止通过 startPublishMediaStream 启动的媒体流
527
+ | 参数 | 描述 |
528
+ | --- | --- |
529
+ | taskId | 通过回调 onStartPublishMediaStream 带给您后台启动的任务标识（即 taskId） |
1335
530
 
1336
531
  > **注意**
1337
- >
532
+ >
1338
533
 
1339
- > 1. 若您的业务后台并没有保存该 ` taskId `，在您的主播异常退房重进后，如果您需要重新获取 ` taskId `，您可以再次调用 [startPublishMediaStream](https://write.woa.com/document/87029900866228224) 启动任务。此时 TRTC 后台会返回任务启动失败，同时带给您上一次启动的 ` taskId `。
1340
- >
1341
-
1342
- > 2. 若 ` taskId ` 填空字符串，将会停止该用户所有通过 [startPublishMediaStream](https://write.woa.com/document/87029900866228224) 启动的媒体流，如果您只启动了一个媒体流或者想停止所有通过您启动的媒体流，推荐使用这种方式。
1343
- >
534
+ > 1. 若您的业务后台并没有保存该 ` taskId `，在您的主播异常退房重进后，如果您需要重新获取 ` taskId `，您可以再次调用 startPublishMediaStream 启动任务。此时 TRTC 后台会返回任务启动失败，同时带给您上一次启动的 ` taskId `。
535
+ >
1344
536
 
537
+ > 2. 若 ` taskId ` 填空字符串，将会停止该用户所有通过 startPublishMediaStream 启动的媒体流，如果您只启动了一个媒体流或者想停止所有通过您启动的媒体流，推荐使用这种方式。
538
+ >
1345
539
 
1346
540
  ## startLocalPreview
1347
541
 
1348
-
1349
-
1350
542
  #### 开启本地摄像头的预览画面（移动端）。
1351
543
 
1352
- 在 [enterRoom](https://write.woa.com/document/87029900866228224) 之前调用此函数，SDK 只会开启摄像头，并一直等到您调用 [enterRoom](https://write.woa.com/document/87029900866228224) 之后才开始推流。
1353
-
1354
- 在 [enterRoom](https://write.woa.com/document/87029900866228224) 之后调用此函数，SDK 会开启摄像头并自动开始视频推流。
1355
-
1356
- 当开始渲染首帧摄像头画面时，您会收到 [TRTCCloudListener](https://write.woa.com/document/87029920275542016) 中的 [onCameraDidReady](https://write.woa.com/document/87029920275542016) 回调通知。
1357
- <table>
1358
- <tr>
1359
- <td rowspan="1" colSpan="1" >参数</td>
544
+ 在 enterRoom 之前调用此函数，SDK 只会开启摄像头，并一直等到您调用 enterRoom 之后才开始推流。
1360
545
 
1361
- <td rowspan="1" colSpan="1" >描述</td>
1362
- </tr>
1363
-
1364
- <tr>
1365
- <td rowspan="1" colSpan="1" >frontCamera</td>
1366
-
1367
- <td rowspan="1" colSpan="1" >true：前置摄像头；false：后置摄像头。</td>
1368
- </tr>
1369
-
1370
- <tr>
1371
- <td rowspan="1" colSpan="1" >view</td>
1372
-
1373
- <td rowspan="1" colSpan="1" >承载视频画面的控件。</td>
1374
- </tr>
1375
- </table>
546
+ 在 enterRoom 之后调用此函数，SDK 会开启摄像头并自动开始视频推流。
1376
547
 
548
+ 当开始渲染首帧摄像头画面时，您会收到 TRTCCloudListener 中的 onCameraDidReady 回调通知。
549
+ | 参数 | 描述 |
550
+ | --- | --- |
551
+ | frontCamera | true：前置摄像头；false：后置摄像头。 |
552
+ | view | 承载视频画面的控件。 |
1377
553
 
1378
554
  > **注意**
1379
- >
555
+ >
1380
556
 
1381
557
  > 如果希望开播前预览摄像头画面并通过 BeautyManager 调节美颜参数，您可以：
1382
- >
1383
- > - 方案一：在调用 [enterRoom](https://write.woa.com/document/87029900866228224) 之前调用 ` startLocalPreview `。
1384
- > - 方案二：在调用 [enterRoom](https://write.woa.com/document/87029900866228224) 之后调用 ` startLocalPreview + muteLocalVideo(true) `。
1385
-
558
+ >
559
+ > - 方案一：在调用 enterRoom 之前调用 ` startLocalPreview `。
560
+ > - 方案二：在调用 enterRoom 之后调用 ` startLocalPreview + muteLocalVideo(true) `。
1386
561
 
1387
562
  ## updateLocalView
1388
563
 
1389
-
1390
-
1391
564
  #### 更新本地摄像头的预览画面。
1392
565
 
1393
566
  ## stopLocalPreview
1394
567
 
1395
-
1396
-
1397
568
  #### 停止摄像头预览。
1398
569
 
1399
570
  ## muteLocalVideo
1400
571
 
1401
-
1402
-
1403
572
  #### 暂停/恢复发布本地的视频流。
1404
573
 
1405
574
  该接口可以暂停（或恢复）发布本地的视频画面，暂停之后，同一房间中的其他用户将无法继续看到自己画面。
1406
575
 
1407
- 该接口在指定 [TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184) 时等效于 ` startLocalPreview + stopLocalPreview ` 这两个接口，但具有更好的响应速度。
576
+ 该接口在指定 TRTC_VIDEO_STREAM_TYPE_BIG 时等效于 ` startLocalPreview + stopLocalPreview ` 这两个接口，但具有更好的响应速度。
1408
577
 
1409
578
  因为 ` startLocalPreview + stopLocalPreview ` 需要打开和关闭摄像头，而打开和关闭摄像头都是硬件设备相关的操作，非常耗时。
1410
579
 
1411
580
  相比之下，` muteLocalVideo ` 只需要在软件层面对数据流进行暂停或者放行即可，因此效率更高，也更适合需要频繁打开关闭的场景。
1412
581
 
582
+ 当暂停/恢复发布指定 TRTC_VIDEO_STREAM_TYPE_BIG 后，同一房间中的其他用户将会收到 onUserVideoAvailable 回调通知。
1413
583
 
1414
-
1415
- 当暂停/恢复发布指定 [TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184) 后，同一房间中的其他用户将会收到 [onUserVideoAvailable](https://write.woa.com/document/87029920275542016) 回调通知。
1416
-
1417
- 当暂停/恢复发布指定 [TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184) 后，同一房间中的其他用户将会收到 [onUserSubStreamAvailable](https://write.woa.com/document/87029920275542016) 回调通知。
1418
- <table>
1419
- <tr>
1420
- <td rowspan="1" colSpan="1" >参数</td>
1421
-
1422
- <td rowspan="1" colSpan="1" >描述</td>
1423
- </tr>
1424
-
1425
- <tr>
1426
- <td rowspan="1" colSpan="1" >mute</td>
1427
-
1428
- <td rowspan="1" colSpan="1" >true：暂停；false：恢复。</td>
1429
- </tr>
1430
-
1431
- <tr>
1432
- <td rowspan="1" colSpan="1" >streamType</td>
1433
-
1434
- <td rowspan="1" colSpan="1" >要暂停/恢复的视频流类型（仅支持 [TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184) 和 [TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184)）。</td>
1435
- </tr>
1436
- </table>
1437
-
584
+ 当暂停/恢复发布指定 TRTC_VIDEO_STREAM_TYPE_SUB 后，同一房间中的其他用户将会收到 onUserSubStreamAvailable 回调通知。
585
+ | 参数 | 描述 |
586
+ | --- | --- |
587
+ | mute | true：暂停；false：恢复。 |
588
+ | streamType | 要暂停/恢复的视频流类型（仅支持 TRTC_VIDEO_STREAM_TYPE_BIG 和 TRTC_VIDEO_STREAM_TYPE_SUB）。 |
1438
589
 
1439
590
  ## setVideoMuteImage
1440
591
 
1441
-
1442
-
1443
592
  #### 设置本地画面被暂停期间的替代图片。
1444
593
 
1445
594
  当您调用 ` muteLocalVideo(true) ` 暂停本地画面时，您可以通过调用本接口设置一张替代图片，设置后，房间中的其他用户会看到这张替代图片，而不是黑屏画面。
1446
- <table>
1447
- <tr>
1448
- <td rowspan="1" colSpan="1" >参数</td>
1449
-
1450
- <td rowspan="1" colSpan="1" >描述</td>
1451
- </tr>
1452
-
1453
- <tr>
1454
- <td rowspan="1" colSpan="1" >fps</td>
1455
-
1456
- <td rowspan="1" colSpan="1" >设置替代图片帧率，最小值为5，最大值为10，默认5。</td>
1457
- </tr>
1458
-
1459
- <tr>
1460
- <td rowspan="1" colSpan="1" >image</td>
1461
-
1462
- <td rowspan="1" colSpan="1" >设置替代图片，空值代表在 [muteLocalVideo](https://write.woa.com/document/87029900866228224) 之后不再发送视频流数据，默认值为空。</td>
1463
- </tr>
1464
- </table>
1465
-
595
+ | 参数 | 描述 |
596
+ | --- | --- |
597
+ | fps | 设置替代图片帧率，最小值为5，最大值为10，默认5。 |
598
+ | image | 设置替代图片，空值代表在 muteLocalVideo 之后不再发送视频流数据，默认值为空。 |
1466
599
 
1467
600
  ## startRemoteView
1468
601
 
1469
-
1470
-
1471
602
  #### 订阅远端用户的视频流，并绑定视频渲染控件。
1472
603
 
1473
- 调用该接口可以让 SDK 拉取指定 userId 的视频流，并渲染到参数 ` view ` 指定的渲染控件上。您可以通过 [setRemoteRenderParams](https://write.woa.com/document/87029900866228224) 设置画面的显示模式。
604
+ 调用该接口可以让 SDK 拉取指定 userId 的视频流，并渲染到参数 ` view ` 指定的渲染控件上。您可以通过 setRemoteRenderParams 设置画面的显示模式。
1474
605
  - 如果您已经知道房间中有视频流的用户的 userId，可以直接调用 ` startRemoteView ` 订阅该用户的画面。
1475
606
 
1476
- - 如果您不知道房间中有哪些用户在发布视频，您可以在 [enterRoom](https://write.woa.com/document/87029900866228224) 之后等待来自 [onUserVideoAvailable](https://write.woa.com/document/87029920275542016) 的通知。
1477
-
1478
-
1479
-
1480
-
1481
- 调用本接口只是启动视频流的拉取，此时画面还需要加载和缓冲，当缓冲完毕后您会收到来自 [onFirstVideoFrame](https://write.woa.com/document/87029920275542016) 的通知。
1482
- <table>
1483
- <tr>
1484
- <td rowspan="1" colSpan="1" >参数</td>
1485
-
1486
- <td rowspan="1" colSpan="1" >描述</td>
1487
- </tr>
1488
-
1489
- <tr>
1490
- <td rowspan="1" colSpan="1" >streamType</td>
1491
-
1492
- <td rowspan="1" colSpan="1" >指定要观看 userId 的视频流类型。<br>- 高清大画面：[TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184)。<br>- 低清小画面：[TRTC_VIDEO_STREAM_TYPE_SMALL](https://write.woa.com/document/87029993616093184)（需要远端用户通过 [enableEncSmallVideoStream](https://write.woa.com/document/87029900866228224) 开启双路编码后才有效果）。<br>- 辅流画面（常用于屏幕分享）：[TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184)。</td>
1493
- </tr>
1494
-
1495
- <tr>
1496
- <td rowspan="1" colSpan="1" >userId</td>
1497
-
1498
- <td rowspan="1" colSpan="1" >指定远端用户的 ID。</td>
1499
- </tr>
1500
-
1501
- <tr>
1502
- <td rowspan="1" colSpan="1" >view</td>
1503
-
1504
- <td rowspan="1" colSpan="1" >用于承载视频画面的渲染控件。</td>
1505
- </tr>
1506
- </table>
607
+ - 如果您不知道房间中有哪些用户在发布视频，您可以在 enterRoom 之后等待来自 onUserVideoAvailable 的通知。
1507
608
 
609
+ 调用本接口只是启动视频流的拉取，此时画面还需要加载和缓冲，当缓冲完毕后您会收到来自 onFirstVideoFrame 的通知。
610
+ | 参数 | 描述 |
611
+ | --- | --- |
612
+ | streamType | 指定要观看 userId 的视频流类型。<br>- 高清大画面：TRTC_VIDEO_STREAM_TYPE_BIG。<br>- 低清小画面：TRTC_VIDEO_STREAM_TYPE_SMALL（需要远端用户通过 enableEncSmallVideoStream 开启双路编码后才有效果）。<br>- 辅流画面（常用于屏幕分享）：TRTC_VIDEO_STREAM_TYPE_SUB。 |
613
+ | userId | 指定远端用户的 ID。 |
614
+ | view | 用于承载视频画面的渲染控件。 |
1508
615
 
1509
616
  > **注意**
1510
- >
617
+ >
1511
618
 
1512
619
  > 注意几点规则需要您关注：
1513
- >
620
+ >
1514
621
 
1515
622
  > 1. SDK 支持同时观看某 userId 的大画面和辅路画面，或者同时观看某 userId 的小画面和辅路画面，但不支持同时观看大画面和小画面。
1516
- >
623
+ >
1517
624
 
1518
- > 2. 只有当指定的 userId 通过 [enableEncSmallVideoStream](https://write.woa.com/document/87029900866228224) 开启双路编码后，才能观看该用户的小画面。
1519
- >
625
+ > 2. 只有当指定的 userId 通过 enableEncSmallVideoStream 开启双路编码后，才能观看该用户的小画面。
626
+ >
1520
627
 
1521
628
  > 3. 当指定的 userId 的小画面不存在时，SDK 默认切换到该用户的大画面。
1522
- >
1523
-
629
+ >
1524
630
 
1525
631
  ## updateRemoteView
1526
632
 
1527
-
1528
-
1529
633
  #### 更新远端用户的视频渲染控件。
1530
634
 
1531
635
  该接口可用于更新远端视频画面的渲染控件，常被用于切换显示区域的交互场景中。
1532
- <table>
1533
- <tr>
1534
- <td rowspan="1" colSpan="1" >参数</td>
1535
-
1536
- <td rowspan="1" colSpan="1" >描述</td>
1537
- </tr>
1538
-
1539
- <tr>
1540
- <td rowspan="1" colSpan="1" >streamType</td>
1541
-
1542
- <td rowspan="1" colSpan="1" >要设置预览窗口的流类型（仅支持 [TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184) 和 [TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184)）。</td>
1543
- </tr>
1544
-
1545
- <tr>
1546
- <td rowspan="1" colSpan="1" >userId</td>
1547
-
1548
- <td rowspan="1" colSpan="1" >指定远端用户的 ID。</td>
1549
- </tr>
1550
-
1551
- <tr>
1552
- <td rowspan="1" colSpan="1" >view</td>
1553
-
1554
- <td rowspan="1" colSpan="1" >承载视频画面的控件。</td>
1555
- </tr>
1556
- </table>
1557
-
636
+ | 参数 | 描述 |
637
+ | --- | --- |
638
+ | streamType | 要设置预览窗口的流类型（仅支持 TRTC_VIDEO_STREAM_TYPE_BIG 和 TRTC_VIDEO_STREAM_TYPE_SUB）。 |
639
+ | userId | 指定远端用户的 ID。 |
640
+ | view | 承载视频画面的控件。 |
1558
641
 
1559
642
  ## stopRemoteView
1560
643
 
1561
-
1562
-
1563
644
  #### 停止订阅远端用户的视频流，并释放渲染控件。
1564
645
 
1565
646
  调用此接口会让 SDK 停止接收该用户的视频流，并释放该路视频流的解码和渲染资源。
1566
- <table>
1567
- <tr>
1568
- <td rowspan="1" colSpan="1" >参数</td>
1569
-
1570
- <td rowspan="1" colSpan="1" >描述</td>
1571
- </tr>
1572
-
1573
- <tr>
1574
- <td rowspan="1" colSpan="1" >streamType</td>
1575
-
1576
- <td rowspan="1" colSpan="1" >指定要观看 userId 的视频流类型。<br>- 高清大画面：[TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184)。<br>- 低清小画面：[TRTC_VIDEO_STREAM_TYPE_SMALL](https://write.woa.com/document/87029993616093184)。<br>- 辅流画面（常用于屏幕分享）：[TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184)。</td>
1577
- </tr>
1578
-
1579
- <tr>
1580
- <td rowspan="1" colSpan="1" >userId</td>
1581
-
1582
- <td rowspan="1" colSpan="1" >指定远端用户的 ID。</td>
1583
- </tr>
1584
- </table>
1585
-
647
+ | 参数 | 描述 |
648
+ | --- | --- |
649
+ | streamType | 指定要观看 userId 的视频流类型。<br>- 高清大画面：TRTC_VIDEO_STREAM_TYPE_BIG。<br>- 低清小画面：TRTC_VIDEO_STREAM_TYPE_SMALL。<br>- 辅流画面（常用于屏幕分享）：TRTC_VIDEO_STREAM_TYPE_SUB。 |
650
+ | userId | 指定远端用户的 ID。 |
1586
651
 
1587
652
  ## stopAllRemoteView
1588
653
 
1589
-
1590
-
1591
654
  #### 停止订阅所有远端用户的视频流，并释放全部渲染资源。
1592
655
 
1593
656
  调用此接口会让 SDK 停止接收所有来自远端的视频流，并释放全部的解码和渲染资源。
1594
657
 
1595
658
  > **注意**
1596
- >
659
+ >
1597
660
 
1598
661
  > 如果当前有正在显示的辅路画面（屏幕分享）也会一并被停止。
1599
- >
1600
-
662
+ >
1601
663
 
1602
664
  ## muteRemoteVideoStream
1603
665
 
1604
-
1605
-
1606
666
  #### 暂停/恢复订阅远端用户的视频流。
1607
667
 
1608
668
  该接口仅暂停/恢复接收指定用户的视频流，但并不释放显示资源，视频画面会被冻屏在接口调用时的最后一帧。
1609
- <table>
1610
- <tr>
1611
- <td rowspan="1" colSpan="1" >参数</td>
1612
-
1613
- <td rowspan="1" colSpan="1" >描述</td>
1614
- </tr>
1615
-
1616
- <tr>
1617
- <td rowspan="1" colSpan="1" >mute</td>
1618
-
1619
- <td rowspan="1" colSpan="1" >是否暂停接收。</td>
1620
- </tr>
1621
-
1622
- <tr>
1623
- <td rowspan="1" colSpan="1" >streamType</td>
1624
-
1625
- <td rowspan="1" colSpan="1" >要暂停/恢复的视频流类型。<br>- 高清大画面：[TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184)。<br>- 低清小画面：[TRTC_VIDEO_STREAM_TYPE_SMALL](https://write.woa.com/document/87029993616093184)。<br>- 辅流画面（常用于屏幕分享）：[TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184)。</td>
1626
- </tr>
1627
-
1628
- <tr>
1629
- <td rowspan="1" colSpan="1" >userId</td>
1630
-
1631
- <td rowspan="1" colSpan="1" >指定远端用户的 ID。</td>
1632
- </tr>
1633
- </table>
1634
-
669
+ | 参数 | 描述 |
670
+ | --- | --- |
671
+ | mute | 是否暂停接收。 |
672
+ | streamType | 要暂停/恢复的视频流类型。<br>- 高清大画面：TRTC_VIDEO_STREAM_TYPE_BIG。<br>- 低清小画面：TRTC_VIDEO_STREAM_TYPE_SMALL。<br>- 辅流画面（常用于屏幕分享）：TRTC_VIDEO_STREAM_TYPE_SUB。 |
673
+ | userId | 指定远端用户的 ID。 |
1635
674
 
1636
675
  > **注意**
1637
- >
1638
-
1639
- > 该接口支持您在进入房间（[enterRoom](https://write.woa.com/document/87029900866228224)）前调用，暂停状态在退出房间（[exitRoom](https://write.woa.com/document/87029900866228224)）之后会被重置。调用该接口暂停接收指定用户的视频流后，只调用 [startRemoteView](https://write.woa.com/document/87029900866228224) 接口无法播放指定用户的视频，需要调用 [muteRemoteVideoStream](https://write.woa.com/document/87029900866228224)(false) 或 [muteAllRemoteVideoStreams](https://write.woa.com/document/87029900866228224)(false) 才能恢复。
1640
- >
676
+ >
1641
677
 
678
+ > 该接口支持您在进入房间（enterRoom）前调用，暂停状态在退出房间（exitRoom）之后会被重置。调用该接口暂停接收指定用户的视频流后，只调用 startRemoteView 接口无法播放指定用户的视频，需要调用 muteRemoteVideoStream(false) 或 muteAllRemoteVideoStreams(false) 才能恢复。
679
+ >
1642
680
 
1643
681
  ## muteAllRemoteVideoStreams
1644
682
 
1645
-
1646
-
1647
683
  #### 暂停/恢复订阅所有远端用户的视频流。
1648
684
 
1649
685
  该接口仅暂停/恢复接收所有用户的视频流，但并不释放显示资源，视频画面会被冻屏在接口调用时的最后一帧。
1650
- <table>
1651
- <tr>
1652
- <td rowspan="1" colSpan="1" >参数</td>
1653
-
1654
- <td rowspan="1" colSpan="1" >描述</td>
1655
- </tr>
1656
-
1657
- <tr>
1658
- <td rowspan="1" colSpan="1" >mute</td>
1659
-
1660
- <td rowspan="1" colSpan="1" >是否暂停接收。</td>
1661
- </tr>
1662
- </table>
1663
-
686
+ | 参数 | 描述 |
687
+ | --- | --- |
688
+ | mute | 是否暂停接收。 |
1664
689
 
1665
690
  > **注意**
1666
- >
1667
-
1668
- > 该接口支持您在进入房间（[enterRoom](https://write.woa.com/document/87029900866228224)）前调用，暂停状态在退出房间（[exitRoom](https://write.woa.com/document/87029900866228224)）之后会被重置。
1669
- >
691
+ >
1670
692
 
1671
- > 调用该接口暂停接收所有用户的视频流后，只调用 [startRemoteView](https://write.woa.com/document/87029900866228224) 接口无法播放指定用户的视频，需要调用 [muteRemoteVideoStream](https://write.woa.com/document/87029900866228224)(false) 或 [muteAllRemoteVideoStreams](https://write.woa.com/document/87029900866228224)(false) 才能恢复。
1672
- >
693
+ > 该接口支持您在进入房间（enterRoom）前调用，暂停状态在退出房间（exitRoom）之后会被重置。
694
+ >
1673
695
 
696
+ > 调用该接口暂停接收所有用户的视频流后，只调用 startRemoteView 接口无法播放指定用户的视频，需要调用 muteRemoteVideoStream(false) 或 muteAllRemoteVideoStreams(false) 才能恢复。
697
+ >
1674
698
 
1675
699
  ## setVideoEncoderParam
1676
700
 
1677
-
1678
-
1679
701
  #### 设置视频编码器的编码参数。
1680
702
 
1681
- 该设置能够决定远端用户看到的画面质量，同时也能决定云端录制出的视频文件的画面质量。
1682
- <table>
1683
- <tr>
1684
- <td rowspan="1" colSpan="1" >参数</td>
1685
-
1686
- <td rowspan="1" colSpan="1" >描述</td>
1687
- </tr>
1688
-
1689
- <tr>
1690
- <td rowspan="1" colSpan="1" >param</td>
1691
-
1692
- <td rowspan="1" colSpan="1" >用于设置视频编码器的相关参数，详情请参见 [TRTCVideoEncParam](https://write.woa.com/document/87029993616093184)。</td>
1693
- </tr>
1694
- </table>
1695
-
703
+ 该设置能够决定远端用户看到的画面质量，同时也能决定云端录制出的视频文件的画面质量。
704
+ | 参数 | 描述 |
705
+ | --- | --- |
706
+ | param | 用于设置视频编码器的相关参数，详情请参见 TRTCVideoEncParam。 |
1696
707
 
1697
708
  > **注意**
1698
- >
709
+ >
1699
710
 
1700
711
  > 从v11.5版本开始，编码输出分辨率会按照宽8高2字节对齐，并且是向下调整，eg:输入分辨率540x960，实际编码输出分辨率536x960。
1701
- >
1702
-
712
+ >
1703
713
 
1704
714
  ## setNetworkQosParam
1705
715
 
1706
-
1707
-
1708
716
  #### 设置网络质量控制的相关参数。
1709
717
 
1710
718
  该设置决定在差网络环境下的质量调控策略，如“画质优先”或“流畅优先”等策略。
1711
- <table>
1712
- <tr>
1713
- <td rowspan="1" colSpan="1" >参数</td>
1714
-
1715
- <td rowspan="1" colSpan="1" >描述</td>
1716
- </tr>
1717
-
1718
- <tr>
1719
- <td rowspan="1" colSpan="1" >param</td>
1720
-
1721
- <td rowspan="1" colSpan="1" >用于设置网络质量控制的相关参数，详情请参见 [TRTCNetworkQosParam](https://write.woa.com/document/87029993616093184)。</td>
1722
- </tr>
1723
- </table>
1724
-
719
+ | 参数 | 描述 |
720
+ | --- | --- |
721
+ | param | 用于设置网络质量控制的相关参数，详情请参见 TRTCNetworkQosParam。 |
1725
722
 
1726
723
  ## setLocalRenderParams
1727
724
 
1728
-
1729
-
1730
725
  #### 设置本地画面的渲染参数。
1731
726
 
1732
727
  可设置的参数包括有：画面的旋转角度、填充模式以及左右镜像等。
1733
- <table>
1734
- <tr>
1735
- <td rowspan="1" colSpan="1" >参数</td>
1736
-
1737
- <td rowspan="1" colSpan="1" >描述</td>
1738
- </tr>
1739
-
1740
- <tr>
1741
- <td rowspan="1" colSpan="1" >params</td>
1742
-
1743
- <td rowspan="1" colSpan="1" >画面渲染参数，详情请参见 [TRTCRenderParams](https://write.woa.com/document/87029993616093184)。</td>
1744
- </tr>
1745
- </table>
1746
-
728
+ | 参数 | 描述 |
729
+ | --- | --- |
730
+ | params | 画面渲染参数，详情请参见 TRTCRenderParams。 |
1747
731
 
1748
732
  ## setRemoteRenderParams
1749
733
 
1750
-
1751
-
1752
734
  #### 设置远端画面的渲染模式。
1753
735
 
1754
736
  可设置的参数包括有：画面的旋转角度、填充模式以及左右镜像等。
1755
- <table>
1756
- <tr>
1757
- <td rowspan="1" colSpan="1" >参数</td>
1758
-
1759
- <td rowspan="1" colSpan="1" >描述</td>
1760
- </tr>
1761
-
1762
- <tr>
1763
- <td rowspan="1" colSpan="1" >params</td>
1764
-
1765
- <td rowspan="1" colSpan="1" >画面渲染参数，详情请参见 [TRTCRenderParams](https://write.woa.com/document/87029993616093184)。</td>
1766
- </tr>
1767
-
1768
- <tr>
1769
- <td rowspan="1" colSpan="1" >streamType</td>
1770
-
1771
- <td rowspan="1" colSpan="1" >可以设置为主路画面（[TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184)）或辅路画面（[TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184)）。</td>
1772
- </tr>
1773
-
1774
- <tr>
1775
- <td rowspan="1" colSpan="1" >userId</td>
1776
-
1777
- <td rowspan="1" colSpan="1" >指定远端用户的 ID。</td>
1778
- </tr>
1779
- </table>
1780
-
737
+ | 参数 | 描述 |
738
+ | --- | --- |
739
+ | params | 画面渲染参数，详情请参见 TRTCRenderParams。 |
740
+ | streamType | 可以设置为主路画面（TRTC_VIDEO_STREAM_TYPE_BIG）或辅路画面（TRTC_VIDEO_STREAM_TYPE_SUB）。 |
741
+ | userId | 指定远端用户的 ID。 |
1781
742
 
1782
743
  ## enableEncSmallVideoStream
1783
744
 
1784
-
1785
-
1786
745
  #### 开启大小画面双路编码模式。
1787
746
 
1788
747
  开启双路编码模式后，当前用户的编码器会同时输出【高清大画面】和【低清小画面】两路视频流（但只有一路音频流）。
1789
748
 
1790
749
  如此以来，房间中的其他用户就可以根据自身的网络情况或屏幕大小选择订阅【高清大画面】或是【低清小画面】。
1791
- <table>
1792
- <tr>
1793
- <td rowspan="1" colSpan="1" >参数</td>
1794
-
1795
- <td rowspan="1" colSpan="1" >描述</td>
1796
- </tr>
1797
-
1798
- <tr>
1799
- <td rowspan="1" colSpan="1" >enable</td>
1800
-
1801
- <td rowspan="1" colSpan="1" >是否开启小画面编码，默认值：false。</td>
1802
- </tr>
1803
-
1804
- <tr>
1805
- <td rowspan="1" colSpan="1" >smallVideoEncParam</td>
1806
-
1807
- <td rowspan="1" colSpan="1" >小流的视频参数。</td>
1808
- </tr>
1809
- </table>
1810
-
750
+ | 参数 | 描述 |
751
+ | --- | --- |
752
+ | enable | 是否开启小画面编码，默认值：false。 |
753
+ | smallVideoEncParam | 小流的视频参数。 |
1811
754
 
1812
755
  > **注意**
1813
- >
756
+ >
1814
757
 
1815
758
  > 双路编码开启后，会消耗更多的 CPU 和 网络带宽，所以 Mac、Windows 或者高性能 Pad 可以考虑开启，不建议手机端开启。
1816
- >
1817
-
759
+ >
1818
760
 
1819
761
  #### 返回值说明：
1820
762
 
@@ -1822,120 +764,52 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
1822
764
 
1823
765
  ## setRemoteVideoStreamType
1824
766
 
1825
-
1826
-
1827
767
  #### 切换指定远端用户的大小画面。
1828
768
 
1829
- 当房间中某个主播开启了双路编码之后，房间中其他用户通过 [startRemoteView](https://write.woa.com/document/87029900866228224) 订阅到的画面默认会是【高清大画面】。
1830
-
1831
- 您可以通过此接口选定希望订阅的画面是大画面还是小画面，该接口在 [startRemoteView](https://write.woa.com/document/87029900866228224) 之前和之后调用均可生效。
1832
- <table>
1833
- <tr>
1834
- <td rowspan="1" colSpan="1" >参数</td>
1835
-
1836
- <td rowspan="1" colSpan="1" >描述</td>
1837
- </tr>
1838
-
1839
- <tr>
1840
- <td rowspan="1" colSpan="1" >streamType</td>
1841
-
1842
- <td rowspan="1" colSpan="1" >视频流类型，即选择看大画面还是小画面，默认为大画面。</td>
1843
- </tr>
1844
-
1845
- <tr>
1846
- <td rowspan="1" colSpan="1" >userId</td>
1847
-
1848
- <td rowspan="1" colSpan="1" >指定远端用户的 ID。</td>
1849
- </tr>
1850
- </table>
769
+ 当房间中某个主播开启了双路编码之后，房间中其他用户通过 startRemoteView 订阅到的画面默认会是【高清大画面】。
1851
770
 
771
+ 您可以通过此接口选定希望订阅的画面是大画面还是小画面，该接口在 startRemoteView 之前和之后调用均可生效。
772
+ | 参数 | 描述 |
773
+ | --- | --- |
774
+ | streamType | 视频流类型，即选择看大画面还是小画面，默认为大画面。 |
775
+ | userId | 指定远端用户的 ID。 |
1852
776
 
1853
777
  > **注意**
1854
- >
1855
-
1856
- > 此功能需要目标用户已经通过 [enableEncSmallVideoStream](https://write.woa.com/document/87029900866228224) 提前开启了双路编码模式，否则此调用无实际效果。
1857
- >
778
+ >
1858
779
 
780
+ > 此功能需要目标用户已经通过 enableEncSmallVideoStream 提前开启了双路编码模式，否则此调用无实际效果。
781
+ >
1859
782
 
1860
783
  ## snapshotVideo
1861
784
 
1862
-
1863
-
1864
785
  #### 视频画面截图。
1865
786
 
1866
787
  您可以通过本接口截取本地的视频画面，远端用户的主路画面以及远端用户的辅路（屏幕分享）画面。
1867
- <table>
1868
- <tr>
1869
- <td rowspan="1" colSpan="1" >参数</td>
1870
-
1871
- <td rowspan="1" colSpan="1" >描述</td>
1872
- </tr>
1873
-
1874
- <tr>
1875
- <td rowspan="1" colSpan="1" >sourceType</td>
1876
-
1877
- <td rowspan="1" colSpan="1" >画面来源，可选择截取视频流画面（[TRTC_SNAPSHOT_SOURCE_TYPE_STREAM](https://write.woa.com/document/87029993616093184)）、视频渲染画面（[TRTC_SNAPSHOT_SOURCE_TYPE_VIEW](https://write.woa.com/document/87029993616093184)）或 采集画面（[TRTC_SNAPSHOT_SOURCE_TYPE_CAPTURE](https://write.woa.com/document/87029993616093184)），采集画面截图更清晰。</td>
1878
- </tr>
1879
-
1880
- <tr>
1881
- <td rowspan="1" colSpan="1" >streamType</td>
1882
-
1883
- <td rowspan="1" colSpan="1" >视频流类型，可选择截取主路画面（[TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184)，常用于摄像头）或辅路画面（[TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184)，常用于屏幕分享）。</td>
1884
- </tr>
1885
-
1886
- <tr>
1887
- <td rowspan="1" colSpan="1" >userId</td>
1888
-
1889
- <td rowspan="1" colSpan="1" >用户 ID，如指定空置表示截取本地的视频画面。</td>
1890
- </tr>
1891
- </table>
1892
-
788
+ | 参数 | 描述 |
789
+ | --- | --- |
790
+ | sourceType | 画面来源，可选择截取视频流画面（TRTC_SNAPSHOT_SOURCE_TYPE_STREAM）、视频渲染画面（TRTC_SNAPSHOT_SOURCE_TYPE_VIEW）或 采集画面（TRTC_SNAPSHOT_SOURCE_TYPE_CAPTURE），采集画面截图更清晰。 |
791
+ | streamType | 视频流类型，可选择截取主路画面（TRTC_VIDEO_STREAM_TYPE_BIG，常用于摄像头）或辅路画面（TRTC_VIDEO_STREAM_TYPE_SUB，常用于屏幕分享）。 |
792
+ | userId | 用户 ID，如指定空置表示截取本地的视频画面。 |
1893
793
 
1894
794
  > **注意**
1895
- >
1896
-
1897
- > Windows 平台目前仅支持截取 [TRTC_SNAPSHOT_SOURCE_TYPE_STREAM](https://write.woa.com/document/87029993616093184) 来源的视频画面。
1898
- >
795
+ >
1899
796
 
797
+ > Windows 平台目前仅支持截取 TRTC_SNAPSHOT_SOURCE_TYPE_STREAM 来源的视频画面。
798
+ >
1900
799
 
1901
800
  ## setPerspectiveCorrectionPoints
1902
801
 
1903
-
1904
-
1905
802
  #### 视频画面透视校正坐标设置。
1906
803
 
1907
804
  您可以通过本接口指定渲染画面透视校正的坐标区域。
1908
- <table>
1909
- <tr>
1910
- <td rowspan="1" colSpan="1" >参数</td>
1911
-
1912
- <td rowspan="1" colSpan="1" >描述</td>
1913
- </tr>
1914
-
1915
- <tr>
1916
- <td rowspan="1" colSpan="1" >dstPoints</td>
1917
-
1918
- <td rowspan="1" colSpan="1" >期望校正到的目标坐标区域4个顶点坐标，需按照左上、左下、右上、右下的顺序传入，所有的坐标需要根据画面宽高做 [0,1] 区间的归一化；传 null 则停止透视校正。</td>
1919
- </tr>
1920
-
1921
- <tr>
1922
- <td rowspan="1" colSpan="1" >srcPoints</td>
1923
-
1924
- <td rowspan="1" colSpan="1" >原始画面坐标区域4个顶点坐标，需按照左上、左下、右上、右下的顺序传入，所有的坐标需要根据画面宽高做 [0,1] 区间的归一化; 传 null 则停止透视校正。</td>
1925
- </tr>
1926
-
1927
- <tr>
1928
- <td rowspan="1" colSpan="1" >userId</td>
1929
-
1930
- <td rowspan="1" colSpan="1" >用户 ID，如指定空值表示校正本地的视频画面。</td>
1931
- </tr>
1932
- </table>
1933
-
805
+ | 参数 | 描述 |
806
+ | --- | --- |
807
+ | dstPoints | 期望校正到的目标坐标区域4个顶点坐标，需按照左上、左下、右上、右下的顺序传入，所有的坐标需要根据画面宽高做 [0,1] 区间的归一化；传 null 则停止透视校正。 |
808
+ | srcPoints | 原始画面坐标区域4个顶点坐标，需按照左上、左下、右上、右下的顺序传入，所有的坐标需要根据画面宽高做 [0,1] 区间的归一化; 传 null 则停止透视校正。 |
809
+ | userId | 用户 ID，如指定空值表示校正本地的视频画面。 |
1934
810
 
1935
811
  ## setGravitySensorAdaptiveMode
1936
812
 
1937
-
1938
-
1939
813
  #### 设置重力感应的适配模式（11.7 及以上版本）。
1940
814
 
1941
815
  开启重力感应后，如果采集端的设备发生旋转，采集端和观众端的画面都会进行相应地渲染以确保视野中的画面始终朝上。
@@ -1945,252 +819,127 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
1945
819
  1. 该接口仅对采集端起作用，如果只是观看房间中的画面，开启此接口是无效的
1946
820
 
1947
821
  2. 当采集端设备发生 90 度或 270 度旋转时，采集端或者观众看到的画面可能会被裁剪以保持比例的协调
1948
- <table>
1949
- <tr>
1950
- <td rowspan="1" colSpan="1" >参数</td>
1951
-
1952
- <td rowspan="1" colSpan="1" >描述</td>
1953
- </tr>
1954
-
1955
- <tr>
1956
- <td rowspan="1" colSpan="1" >mode</td>
1957
-
1958
- <td rowspan="1" colSpan="1" >重力感应模式，详情请参见 [TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_DISABLE](https://write.woa.com/document/87029993616093184)、[TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_FILL_BY_CENTER_CROP](https://write.woa.com/document/87029993616093184) 和 [TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_FIT_WITH_BLACK_BORDER](https://write.woa.com/document/87029993616093184) 默认值：[TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_DISABLE](https://write.woa.com/document/87029993616093184)。</td>
1959
- </tr>
1960
- </table>
1961
-
822
+ | 参数 | 描述 |
823
+ | --- | --- |
824
+ | mode | 重力感应模式，详情请参见 TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_DISABLE、TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_FILL_BY_CENTER_CROP 和 TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_FIT_WITH_BLACK_BORDER 默认值：TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_DISABLE。 |
1962
825
 
1963
826
  ## startLocalAudio
1964
827
 
1965
-
1966
-
1967
828
  #### 开启本地音频的采集和发布。
1968
829
 
1969
830
  SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调用该接口开启麦克风采集，并将音频编码并发布到当前的房间中。
1970
831
 
1971
- 开启本地音频的采集和发布后，房间中的其他用户会收到 [onUserAudioAvailable](https://write.woa.com/document/87029920275542016)(userId, true) 的通知。
1972
- <table>
1973
- <tr>
1974
- <td rowspan="1" colSpan="1" >参数</td>
1975
-
1976
- <td rowspan="1" colSpan="1" >描述</td>
1977
- </tr>
1978
-
1979
- <tr>
1980
- <td rowspan="1" colSpan="1" >quality</td>
1981
-
1982
- <td rowspan="1" colSpan="1" >声音音质<br>- [TRTC_AUDIO_QUALITY_SPEECH](https://write.woa.com/document/87029993616093184)，流畅：单声道；音频裸码率：18kbps；适合语音通话为主的场景，例如在线会议，语音通话。<br>- [TRTC_AUDIO_QUALITY_DEFAULT](https://write.woa.com/document/87029993616093184)，默认：单声道；音频裸码率：50kbps；SDK 默认的音频质量，如无特殊需求推荐选择之。<br>- [TRTC_AUDIO_QUALITY_MUSIC](https://write.woa.com/document/87029993616093184)，高音质：双声道 + 全频带；音频裸码率：128kbps；适合需要高保真传输音乐的场景，例如在线K歌、音乐直播等。</td>
1983
- </tr>
1984
- </table>
1985
-
832
+ 开启本地音频的采集和发布后，房间中的其他用户会收到 onUserAudioAvailable(userId, true) 的通知。
833
+ | 参数 | 描述 |
834
+ | --- | --- |
835
+ | quality | 声音音质<br>- TRTC_AUDIO_QUALITY_SPEECH，流畅：单声道；音频裸码率：18kbps；适合语音通话为主的场景，例如在线会议，语音通话。<br>- TRTC_AUDIO_QUALITY_DEFAULT，默认：单声道；音频裸码率：50kbps；SDK 默认的音频质量，如无特殊需求推荐选择之。<br>- TRTC_AUDIO_QUALITY_MUSIC，高音质：双声道 + 全频带；音频裸码率：128kbps；适合需要高保真传输音乐的场景，例如在线K歌、音乐直播等。 |
1986
836
 
1987
837
  > **注意**
1988
- >
838
+ >
1989
839
 
1990
840
  > 该函数会检查麦克风的使用权限，如果当前 App 没有麦克风权限，SDK 会自动向用户申请麦克风使用权限。
1991
- >
1992
-
841
+ >
1993
842
 
1994
843
  ## stopLocalAudio
1995
844
 
1996
-
1997
-
1998
845
  #### 停止本地音频的采集和发布。
1999
846
 
2000
- 停止本地音频的采集和发布后，房间中的其他用户会收到 [onUserAudioAvailable](https://write.woa.com/document/87029920275542016)(userId, false) 的通知。
847
+ 停止本地音频的采集和发布后，房间中的其他用户会收到 onUserAudioAvailable(userId, false) 的通知。
2001
848
 
2002
849
  ## muteLocalAudio
2003
850
 
2004
-
2005
-
2006
851
  #### 暂停/恢复发布本地的音频流。
2007
852
 
2008
- 当您暂停发布本地音频流之后，房间中的其他用户会收到 [onUserAudioAvailable](https://write.woa.com/document/87029920275542016)(userId, false) 的通知。
853
+ 当您暂停发布本地音频流之后，房间中的其他用户会收到 onUserAudioAvailable(userId, false) 的通知。
2009
854
 
2010
- 当您恢复发布本地音频流之后，房间中的其他用户会收到 [onUserAudioAvailable](https://write.woa.com/document/87029920275542016)(userId, true) 的通知。
855
+ 当您恢复发布本地音频流之后，房间中的其他用户会收到 onUserAudioAvailable(userId, true) 的通知。
2011
856
 
857
+ 与 stopLocalAudio 的不同之处在于，` muteLocalAudio(true) ` 并不会释放麦克风权限，而是继续发送码率极低的静音包。
2012
858
 
859
+ 这对于需要云端录制的场景非常适用，因为 MP4 等格式的视频文件，对于音频数据的连续性要求很高，使用 stopLocalAudio 会导致录制出的 MP4 文件不易播放。
2013
860
 
2014
- 与 [stopLocalAudio](https://write.woa.com/document/87029900866228224) 的不同之处在于，` muteLocalAudio(true) ` 并不会释放麦克风权限，而是继续发送码率极低的静音包。
2015
-
2016
- 这对于需要云端录制的场景非常适用，因为 MP4 等格式的视频文件，对于音频数据的连续性要求很高，使用 [stopLocalAudio](https://write.woa.com/document/87029900866228224) 会导致录制出的 MP4 文件不易播放。
2017
-
2018
- 因此在对录制文件的质量要求较高的场景中，建议选择 ` muteLocalAudio ` 而不建议使用 [stopLocalAudio](https://write.woa.com/document/87029900866228224)。
2019
- <table>
2020
- <tr>
2021
- <td rowspan="1" colSpan="1" >参数</td>
2022
-
2023
- <td rowspan="1" colSpan="1" >描述</td>
2024
- </tr>
2025
-
2026
- <tr>
2027
- <td rowspan="1" colSpan="1" >mute</td>
2028
-
2029
- <td rowspan="1" colSpan="1" >true：静音；false：恢复。</td>
2030
- </tr>
2031
- </table>
2032
-
861
+ 因此在对录制文件的质量要求较高的场景中，建议选择 ` muteLocalAudio ` 而不建议使用 stopLocalAudio。
862
+ | 参数 | 描述 |
863
+ | --- | --- |
864
+ | mute | true：静音；false：恢复。 |
2033
865
 
2034
866
  ## muteRemoteAudio
2035
867
 
2036
-
2037
-
2038
868
  #### 暂停/恢复播放远端的音频流。
2039
869
 
2040
870
  当您静音某用户的远端音频时，SDK 会停止播放指定用户的声音，同时也会停止拉取该用户的音频数据。
2041
- <table>
2042
- <tr>
2043
- <td rowspan="1" colSpan="1" >参数</td>
2044
-
2045
- <td rowspan="1" colSpan="1" >描述</td>
2046
- </tr>
2047
-
2048
- <tr>
2049
- <td rowspan="1" colSpan="1" >mute</td>
2050
-
2051
- <td rowspan="1" colSpan="1" >true：静音；false：取消静音。</td>
2052
- </tr>
2053
-
2054
- <tr>
2055
- <td rowspan="1" colSpan="1" >userId</td>
2056
-
2057
- <td rowspan="1" colSpan="1" >用于指定远端用户的 ID。</td>
2058
- </tr>
2059
- </table>
2060
-
871
+ | 参数 | 描述 |
872
+ | --- | --- |
873
+ | mute | true：静音；false：取消静音。 |
874
+ | userId | 用于指定远端用户的 ID。 |
2061
875
 
2062
876
  > **注意**
2063
- >
2064
-
2065
- > 在进入房间（[enterRoom](https://write.woa.com/document/87029900866228224)）之前或之后调用本接口均生效，静音状态在退出房间（[exitRoom](https://write.woa.com/document/87029900866228224)）之后会被重置为 false。
2066
- >
877
+ >
2067
878
 
879
+ > 在进入房间（enterRoom）之前或之后调用本接口均生效，静音状态在退出房间（exitRoom）之后会被重置为 false。
880
+ >
2068
881
 
2069
882
  ## muteAllRemoteAudio
2070
883
 
2071
-
2072
-
2073
884
  #### 暂停/恢复播放所有远端用户的音频流。
2074
885
 
2075
886
  当您静音所有用户的远端音频时，SDK 会停止播放所有来自远端的音频流，同时也会停止拉取所有用户的音频数据。
2076
- <table>
2077
- <tr>
2078
- <td rowspan="1" colSpan="1" >参数</td>
2079
-
2080
- <td rowspan="1" colSpan="1" >描述</td>
2081
- </tr>
2082
-
2083
- <tr>
2084
- <td rowspan="1" colSpan="1" >mute</td>
2085
-
2086
- <td rowspan="1" colSpan="1" >true：静音；false：取消静音。</td>
2087
- </tr>
2088
- </table>
2089
-
887
+ | 参数 | 描述 |
888
+ | --- | --- |
889
+ | mute | true：静音；false：取消静音。 |
2090
890
 
2091
891
  > **注意**
2092
- >
2093
-
2094
- > 在进入房间（[enterRoom](https://write.woa.com/document/87029900866228224)）之前或之后调用本接口均生效，静音状态在退出房间（[exitRoom](https://write.woa.com/document/87029900866228224)）之后会被重置为 false。
2095
- >
892
+ >
2096
893
 
894
+ > 在进入房间（enterRoom）之前或之后调用本接口均生效，静音状态在退出房间（exitRoom）之后会被重置为 false。
895
+ >
2097
896
 
2098
897
  ## setAudioRoute
2099
898
 
2100
-
2101
-
2102
899
  #### 设置音频路由。
2103
900
 
2104
901
  设置“音频路由”，即设置声音是从手机的扬声器还是从听筒中播放出来，因此该接口仅适用于手机等移动端设备。
2105
902
 
2106
-
2107
-
2108
903
  手机有两个扬声器：一个是位于手机顶部的听筒，一个是位于手机底部的立体声扬声器。
2109
904
 
2110
905
  设置音频路由为听筒时，声音比较小，只有将耳朵凑近才能听清楚，隐私性较好，适合用于接听电话。
2111
906
 
2112
907
  设置音频路由为扬声器时，声音比较大，不用将手机贴脸也能听清，因此可以实现“免提”的功能。
2113
- <table>
2114
- <tr>
2115
- <td rowspan="1" colSpan="1" >参数</td>
2116
-
2117
- <td rowspan="1" colSpan="1" >描述</td>
2118
- </tr>
2119
-
2120
- <tr>
2121
- <td rowspan="1" colSpan="1" >route</td>
2122
-
2123
- <td rowspan="1" colSpan="1" >音频路由，即声音由哪里输出（扬声器、听筒），默认值：[TRTC_AUDIO_ROUTE_SPEAKER](https://write.woa.com/document/87029993616093184)。</td>
2124
- </tr>
2125
- </table>
2126
-
908
+ | 参数 | 描述 |
909
+ | --- | --- |
910
+ | route | 音频路由，即声音由哪里输出（扬声器、听筒），默认值：TRTC_AUDIO_ROUTE_SPEAKER。 |
2127
911
 
2128
912
  ## setRemoteAudioVolume
2129
913
 
2130
-
2131
-
2132
914
  #### 设定某一个远端用户的声音播放音量。
2133
915
 
2134
916
  您可以通过 ` setRemoteAudioVolume(userId, 0) ` 将某一个远端用户的声音静音。
2135
- <table>
2136
- <tr>
2137
- <td rowspan="1" colSpan="1" >参数</td>
2138
-
2139
- <td rowspan="1" colSpan="1" >描述</td>
2140
- </tr>
2141
-
2142
- <tr>
2143
- <td rowspan="1" colSpan="1" >userId</td>
2144
-
2145
- <td rowspan="1" colSpan="1" >用于指定远端用户的 ID。</td>
2146
- </tr>
2147
-
2148
- <tr>
2149
- <td rowspan="1" colSpan="1" >volume</td>
2150
-
2151
- <td rowspan="1" colSpan="1" >音量大小，取值范围为 [0, 150]，默认值：100。</td>
2152
- </tr>
2153
- </table>
2154
-
917
+ | 参数 | 描述 |
918
+ | --- | --- |
919
+ | userId | 用于指定远端用户的 ID。 |
920
+ | volume | 音量大小，取值范围为 [0, 150]，默认值：100。 |
2155
921
 
2156
922
  > **注意**
2157
- >
923
+ >
2158
924
 
2159
925
  > 如果将 ` volume ` 设置成 100 之后感觉音量还是太小，可以将 ` volume ` 最大设置成 150，但超过 100 的 ` volume ` 会有爆音的风险，请谨慎操作。
2160
- >
2161
-
926
+ >
2162
927
 
2163
928
  ## setAudioCaptureVolume
2164
929
 
2165
-
2166
-
2167
930
  #### 设定本地音频的采集音量。
2168
- <table>
2169
- <tr>
2170
- <td rowspan="1" colSpan="1" >参数</td>
2171
-
2172
- <td rowspan="1" colSpan="1" >描述</td>
2173
- </tr>
2174
-
2175
- <tr>
2176
- <td rowspan="1" colSpan="1" >volume</td>
2177
-
2178
- <td rowspan="1" colSpan="1" >音量大小，取值范围为 [0, 150]；默认值：100。</td>
2179
- </tr>
2180
- </table>
2181
-
931
+ | 参数 | 描述 |
932
+ | --- | --- |
933
+ | volume | 音量大小，取值范围为 [0, 150]；默认值：100。 |
2182
934
 
2183
935
  > **注意**
2184
- >
936
+ >
2185
937
 
2186
938
  > 如果将 ` volume ` 设置成 100 之后感觉音量还是太小，可以将 ` volume ` 最大设置成 150，但超过 100 的 ` volume ` 会有爆音的风险，请谨慎操作。
2187
- >
2188
-
939
+ >
2189
940
 
2190
941
  ## getAudioCaptureVolume
2191
942
 
2192
-
2193
-
2194
943
  #### 获取本地音频的采集音量。
2195
944
 
2196
945
  #### 返回值说明：
@@ -2199,106 +948,57 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
2199
948
 
2200
949
  ## setAudioPlayoutVolume
2201
950
 
2202
-
2203
-
2204
951
  #### 设定远端音频的播放音量。
2205
952
 
2206
953
  该接口会控制 SDK 最终交给系统播放的声音音量，调节效果会影响到本地音频录制文件的音量大小，但不会影响到耳返的音量大小。
2207
- <table>
2208
- <tr>
2209
- <td rowspan="1" colSpan="1" >参数</td>
2210
-
2211
- <td rowspan="1" colSpan="1" >描述</td>
2212
- </tr>
2213
-
2214
- <tr>
2215
- <td rowspan="1" colSpan="1" >volume</td>
2216
-
2217
- <td rowspan="1" colSpan="1" >音量大小，取值范围为 [0, 150]，默认值：100。</td>
2218
- </tr>
2219
- </table>
2220
-
954
+ | 参数 | 描述 |
955
+ | --- | --- |
956
+ | volume | 音量大小，取值范围为 [0, 150]，默认值：100。 |
2221
957
 
2222
958
  > **注意**
2223
- >
959
+ >
2224
960
 
2225
961
  > 如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。
2226
- >
2227
-
962
+ >
2228
963
 
2229
964
  ## getAudioPlayoutVolume
2230
965
 
2231
-
2232
-
2233
966
  #### 获取远端音频的播放音量。
2234
967
 
2235
968
  ## enableAudioVolumeEvaluation
2236
969
 
2237
-
2238
-
2239
970
  #### 启用音量大小提示。
2240
971
 
2241
- 开启此功能后，SDK 会在 [TRTCCloudListener](https://write.woa.com/document/87029920275542016) 中的 [onUserVoiceVolume](https://write.woa.com/document/87029920275542016) 回调中反馈本地和远端用户的音频音量评估信息，包括音量大小、人声检测、音频频谱等。
2242
- <table>
2243
- <tr>
2244
- <td rowspan="1" colSpan="1" >参数</td>
2245
-
2246
- <td rowspan="1" colSpan="1" >描述</td>
2247
- </tr>
2248
-
2249
- <tr>
2250
- <td rowspan="1" colSpan="1" >enable</td>
2251
-
2252
- <td rowspan="1" colSpan="1" >是否启用音量提示，默认为关闭状态。</td>
2253
- </tr>
2254
-
2255
- <tr>
2256
- <td rowspan="1" colSpan="1" >params</td>
2257
-
2258
- <td rowspan="1" colSpan="1" >音量评估等相关参数，请参见 [TRTCAudioVolumeEvaluateParams](https://write.woa.com/document/87029993616093184)。</td>
2259
- </tr>
2260
- </table>
2261
-
972
+ 开启此功能后，SDK 会在 TRTCCloudListener 中的 onUserVoiceVolume 回调中反馈本地和远端用户的音频音量评估信息，包括音量大小、人声检测、音频频谱等。
973
+ | 参数 | 描述 |
974
+ | --- | --- |
975
+ | enable | 是否启用音量提示，默认为关闭状态。 |
976
+ | params | 音量评估等相关参数，请参见 TRTCAudioVolumeEvaluateParams。 |
2262
977
 
2263
978
  > **注意**
2264
- >
2265
-
2266
- > 如需启用音量大小提示，请在调用 [startLocalAudio](https://write.woa.com/document/87029900866228224) 之前调用该接口.
2267
- >
979
+ >
2268
980
 
981
+ > 如需启用音量大小提示，请在调用 startLocalAudio 之前调用该接口.
982
+ >
2269
983
 
2270
984
  ## startAudioRecording
2271
985
 
2272
-
2273
-
2274
986
  #### 开始录音。
2275
987
 
2276
988
  当您调用该接口后， SDK 会将本地和远端的所有音频（包括本地音频，远端音频，背景音乐和音效等）混合并录制到一个本地文件中。
2277
989
 
2278
- 该接口在进入房间前后调用均可生效，如果录制任务在退出房间前尚未通过 [stopAudioRecording](https://write.woa.com/document/87029900866228224) 停止，则退出房间后录制任务会自动被停止。
2279
-
2280
- 本次录制的启动、完成状态会通过本地录制相关回调进行通知。参见 [TRTCCloudListener](https://write.woa.com/document/87029920275542016) 相关回调。
2281
- <table>
2282
- <tr>
2283
- <td rowspan="1" colSpan="1" >参数</td>
2284
-
2285
- <td rowspan="1" colSpan="1" >描述</td>
2286
- </tr>
2287
-
2288
- <tr>
2289
- <td rowspan="1" colSpan="1" >param</td>
2290
-
2291
- <td rowspan="1" colSpan="1" >录音参数，请参见 [TRTCAudioRecordingParams](https://write.woa.com/document/87029993616093184)。</td>
2292
- </tr>
2293
- </table>
990
+ 该接口在进入房间前后调用均可生效，如果录制任务在退出房间前尚未通过 stopAudioRecording 停止，则退出房间后录制任务会自动被停止。
2294
991
 
992
+ 本次录制的启动、完成状态会通过本地录制相关回调进行通知。参见 TRTCCloudListener 相关回调。
993
+ | 参数 | 描述 |
994
+ | --- | --- |
995
+ | param | 录音参数，请参见 TRTCAudioRecordingParams。 |
2295
996
 
2296
997
  > **注意**
2297
- >
2298
-
2299
- > 自 v11.5 版本，音频录制的状态结果由返回值统一调整为异步回调进行通知。参见 [TRTCCloudListener](https://write.woa.com/document/87029920275542016) 相关回调。
2300
- >
998
+ >
2301
999
 
1000
+ > 自 v11.5 版本，音频录制的状态结果由返回值统一调整为异步回调进行通知。参见 TRTCCloudListener 相关回调。
1001
+ >
2302
1002
 
2303
1003
  #### 返回值说明：
2304
1004
 
@@ -2306,218 +1006,105 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
2306
1006
 
2307
1007
  ## stopAudioRecording
2308
1008
 
2309
-
2310
-
2311
1009
  #### 停止录音。
2312
1010
 
2313
1011
  如果录制任务在退出房间前尚未通过本接口停止，则退出房间后录音任务会自动被停止。
2314
1012
 
2315
1013
  ## startLocalRecording
2316
1014
 
2317
-
2318
-
2319
1015
  #### 开启本地媒体录制。
2320
1016
 
2321
1017
  开启后把直播过程中的音视频内容录制到本地的一个文件中，该功能不会产生额外费用。
2322
- <table>
2323
- <tr>
2324
- <td rowspan="1" colSpan="1" >参数</td>
2325
-
2326
- <td rowspan="1" colSpan="1" >描述</td>
2327
- </tr>
2328
-
2329
- <tr>
2330
- <td rowspan="1" colSpan="1" >params</td>
2331
-
2332
- <td rowspan="1" colSpan="1" >录制参数，请参见 [TRTCLocalRecordingParams](https://write.woa.com/document/87029993616093184)。</td>
2333
- </tr>
2334
- </table>
2335
-
1018
+ | 参数 | 描述 |
1019
+ | --- | --- |
1020
+ | params | 录制参数，请参见 TRTCLocalRecordingParams。 |
2336
1021
 
2337
1022
  ## stopLocalRecording
2338
1023
 
2339
-
2340
-
2341
1024
  #### 停止本地媒体录制。
2342
1025
 
2343
1026
  如果录制任务在退出房间前尚未通过本接口停止，则退出房间后录音任务会自动被停止。
2344
1027
 
2345
1028
  ## setRemoteAudioParallelParams
2346
1029
 
2347
-
2348
-
2349
1030
  #### 设置远端音频流智能并发播放策略。
2350
1031
 
2351
1032
  设置远端音频流智能并发播放策略，适用于上麦人数比较多的场景。
2352
- <table>
2353
- <tr>
2354
- <td rowspan="1" colSpan="1" >参数</td>
2355
-
2356
- <td rowspan="1" colSpan="1" >描述</td>
2357
- </tr>
2358
-
2359
- <tr>
2360
- <td rowspan="1" colSpan="1" >params</td>
2361
-
2362
- <td rowspan="1" colSpan="1" >音频并发参数，请参见 [TRTCAudioParallelParams](https://write.woa.com/document/87029993616093184)。</td>
2363
- </tr>
2364
- </table>
2365
-
1033
+ | 参数 | 描述 |
1034
+ | --- | --- |
1035
+ | params | 音频并发参数，请参见 TRTCAudioParallelParams。 |
2366
1036
 
2367
1037
  ## enable3DSpatialAudioEffect
2368
1038
 
2369
-
2370
-
2371
1039
  #### 启用 3D 音效。
2372
1040
 
2373
- 启用 3D 音效。注意需使用流畅音质 [TRTC_AUDIO_QUALITY_SPEECH](https://write.woa.com/document/87029993616093184) 或默认音质 [TRTC_AUDIO_QUALITY_DEFAULT](https://write.woa.com/document/87029993616093184)。
2374
- <table>
2375
- <tr>
2376
- <td rowspan="1" colSpan="1" >参数</td>
2377
-
2378
- <td rowspan="1" colSpan="1" >描述</td>
2379
- </tr>
2380
-
2381
- <tr>
2382
- <td rowspan="1" colSpan="1" >enabled</td>
2383
-
2384
- <td rowspan="1" colSpan="1" >是否启用 3D 音效，默认为关闭状态。</td>
2385
- </tr>
2386
- </table>
2387
-
1041
+ 启用 3D 音效。注意需使用流畅音质 TRTC_AUDIO_QUALITY_SPEECH 或默认音质 TRTC_AUDIO_QUALITY_DEFAULT。
1042
+ | 参数 | 描述 |
1043
+ | --- | --- |
1044
+ | enabled | 是否启用 3D 音效，默认为关闭状态。 |
2388
1045
 
2389
1046
  ## updateSelf3DSpatialPosition
2390
1047
 
2391
-
2392
-
2393
1048
  #### 设置 3D 音效中自身坐标及朝向信息。
2394
1049
 
2395
1050
  更新自身在世界坐标系中的位置和朝向， SDK 会根据该方法参数计算自身和远端用户之间的相对位置，进而渲染出空间音效。
2396
- <table>
2397
- <tr>
2398
- <td rowspan="1" colSpan="1" >参数</td>
2399
-
2400
- <td rowspan="1" colSpan="1" >描述</td>
2401
- </tr>
2402
-
2403
- <tr>
2404
- <td rowspan="1" colSpan="1" >axisForward</td>
2405
-
2406
- <td rowspan="1" colSpan="1" >自身坐标系前轴在世界坐标系中的单位向量，三个值依次表示前、右、上坐标值。</td>
2407
- </tr>
2408
-
2409
- <tr>
2410
- <td rowspan="1" colSpan="1" >axisRight</td>
2411
-
2412
- <td rowspan="1" colSpan="1" >自身坐标系右轴在世界坐标系中的单位向量，三个值依次表示前、右、上坐标值。</td>
2413
- </tr>
2414
-
2415
- <tr>
2416
- <td rowspan="1" colSpan="1" >axisUp</td>
2417
-
2418
- <td rowspan="1" colSpan="1" >自身坐标系上轴在世界坐标系中的单位向量，三个值依次表示前、右、上坐标值。</td>
2419
- </tr>
2420
-
2421
- <tr>
2422
- <td rowspan="1" colSpan="1" >position</td>
2423
-
2424
- <td rowspan="1" colSpan="1" >自身在世界坐标系中的坐标，三个值依次表示前、右、上坐标值。</td>
2425
- </tr>
2426
- </table>
2427
-
1051
+ | 参数 | 描述 |
1052
+ | --- | --- |
1053
+ | axisForward | 自身坐标系前轴在世界坐标系中的单位向量，三个值依次表示前、右、上坐标值。 |
1054
+ | axisRight | 自身坐标系右轴在世界坐标系中的单位向量，三个值依次表示前、右、上坐标值。 |
1055
+ | axisUp | 自身坐标系上轴在世界坐标系中的单位向量，三个值依次表示前、右、上坐标值。 |
1056
+ | position | 自身在世界坐标系中的坐标，三个值依次表示前、右、上坐标值。 |
2428
1057
 
2429
1058
  > **注意**
2430
- >
1059
+ >
2431
1060
 
2432
1061
  > 1. 各参数应分别传入长度为 3 的数组。
2433
- >
1062
+ >
2434
1063
 
2435
1064
  > 2. 请适当限制调用频率，推荐两次坐标设置至少间隔 100ms。
2436
- >
2437
-
1065
+ >
2438
1066
 
2439
1067
  ## updateRemote3DSpatialPosition
2440
1068
 
2441
-
2442
-
2443
1069
  #### 设置 3D 音效中远端用户坐标信息。
2444
1070
 
2445
1071
  更新远端用户在世界坐标系中的位置，SDK 会根据自身和远端用户之间的相对位置，进而渲染出空间音效。
2446
- <table>
2447
- <tr>
2448
- <td rowspan="1" colSpan="1" >参数</td>
2449
-
2450
- <td rowspan="1" colSpan="1" >描述</td>
2451
- </tr>
2452
-
2453
- <tr>
2454
- <td rowspan="1" colSpan="1" >position</td>
2455
-
2456
- <td rowspan="1" colSpan="1" >该远端用户在世界坐标系中的坐标，三个值依次表示前、右、上坐标值。</td>
2457
- </tr>
2458
-
2459
- <tr>
2460
- <td rowspan="1" colSpan="1" >userId</td>
2461
-
2462
- <td rowspan="1" colSpan="1" >指定远端用户的 ID。</td>
2463
- </tr>
2464
- </table>
2465
-
1072
+ | 参数 | 描述 |
1073
+ | --- | --- |
1074
+ | position | 该远端用户在世界坐标系中的坐标，三个值依次表示前、右、上坐标值。 |
1075
+ | userId | 指定远端用户的 ID。 |
2466
1076
 
2467
1077
  > **注意**
2468
- >
1078
+ >
2469
1079
 
2470
1080
  > 1. 各参数应分别传入长度为 3 的数组。
2471
- >
1081
+ >
2472
1082
 
2473
1083
  > 2. 请适当限制调用频率，推荐同一远端用户两次坐标设置至少间隔 100ms。
2474
- >
2475
-
1084
+ >
2476
1085
 
2477
1086
  ## set3DSpatialReceivingRange
2478
1087
 
2479
-
2480
-
2481
1088
  #### 设置指定用户所发出声音的可被接收范围。
2482
1089
 
2483
1090
  设置该范围大小之后，该指定用户的声音将在该范围内可被听见，超出该范围将被衰减为 0。
2484
- <table>
2485
- <tr>
2486
- <td rowspan="1" colSpan="1" >参数</td>
2487
-
2488
- <td rowspan="1" colSpan="1" >描述</td>
2489
- </tr>
2490
-
2491
- <tr>
2492
- <td rowspan="1" colSpan="1" >range</td>
2493
-
2494
- <td rowspan="1" colSpan="1" >声音最大可被接收范围。</td>
2495
- </tr>
2496
-
2497
- <tr>
2498
- <td rowspan="1" colSpan="1" >userId</td>
2499
-
2500
- <td rowspan="1" colSpan="1" >指定远端用户的 ID。</td>
2501
- </tr>
2502
- </table>
2503
-
1091
+ | 参数 | 描述 |
1092
+ | --- | --- |
1093
+ | range | 声音最大可被接收范围。 |
1094
+ | userId | 指定远端用户的 ID。 |
2504
1095
 
2505
1096
  ## getDeviceManager
2506
1097
 
2507
-
2508
-
2509
1098
  #### 获取设备管理类（TXDeviceManager）。
2510
1099
 
2511
1100
  通过设备管理，您可以设置摄像头、麦克风和扬声器等音视频相关的硬件设备功能。
2512
1101
 
2513
1102
  #### 返回值说明：
2514
1103
 
2515
- 设备管理类 [TXDeviceManager](https://write.woa.com/document/87029980188905472)。
1104
+ 设备管理类 TXDeviceManager。
2516
1105
 
2517
1106
  ## getBeautyManager
2518
1107
 
2519
-
2520
-
2521
1108
  #### 获取美颜管理类（TXBeautyManager）。
2522
1109
 
2523
1110
  通过美颜管理，您可以使用以下功能：
@@ -2533,15 +1120,12 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
2533
1120
 
2534
1121
  - 设置动态贴纸和人脸挂件等动画特效。
2535
1122
 
2536
-
2537
1123
  #### 返回值说明：
2538
1124
 
2539
- 美颜管理类 [TXBeautyManager](https://write.woa.com/document/87029968748064768)。
1125
+ 美颜管理类 TXBeautyManager。
2540
1126
 
2541
1127
  ## setWatermark
2542
1128
 
2543
-
2544
-
2545
1129
  #### 添加水印。
2546
1130
 
2547
1131
  水印的位置是通过 rect 参数来指定的，rect 是一个四元组参数，其格式为 (x，y，width，height)
@@ -2553,52 +1137,25 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
2553
1137
 
2554
1138
  - height：是不用设置的，SDK 内部会根据水印图片的宽高比自动计算一个合适的高度。
2555
1139
 
2556
-
2557
-
2558
-
2559
1140
  参数设置举例：
2560
1141
 
2561
1142
  如果当前视频的编码分辨率是 540 × 960，且 rect 参数设置为（0.1，0.1，0.2，0.0），
2562
1143
 
2563
1144
  那么水印的左上坐标点就是（540 × 0.1，960 × 0.1）即（54，96），水印的宽度是 ` 540 × 0.2 = 108px `，水印的高度会根据水印图片的宽高比由 SDK 自动算出。
2564
- <table>
2565
- <tr>
2566
- <td rowspan="1" colSpan="1" >参数</td>
2567
-
2568
- <td rowspan="1" colSpan="1" >描述</td>
2569
- </tr>
2570
-
2571
- <tr>
2572
- <td rowspan="1" colSpan="1" >image</td>
2573
-
2574
- <td rowspan="1" colSpan="1" >水印图片，**必须使用透明底色的 png 格式**。</td>
2575
- </tr>
2576
-
2577
- <tr>
2578
- <td rowspan="1" colSpan="1" >rect</td>
2579
-
2580
- <td rowspan="1" colSpan="1" >水印相对于编码分辨率的归一化坐标，x，y，width，height 取值范围 [0, 1]。</td>
2581
- </tr>
2582
-
2583
- <tr>
2584
- <td rowspan="1" colSpan="1" >streamType</td>
2585
-
2586
- <td rowspan="1" colSpan="1" >指定给哪一路画面设置水印，详情请参见[TRTCVideoStreamType](https://write.woa.com/document/87029993616093184)。</td>
2587
- </tr>
2588
- </table>
2589
-
1145
+ | 参数 | 描述 |
1146
+ | --- | --- |
1147
+ | image | 水印图片，**必须使用透明底色的 png 格式**。 |
1148
+ | rect | 水印相对于编码分辨率的归一化坐标，x，y，width，height 取值范围 [0, 1]。 |
1149
+ | streamType | 指定给哪一路画面设置水印，详情请参见TRTCVideoStreamType。 |
2590
1150
 
2591
1151
  > **注意**
2592
- >
1152
+ >
2593
1153
 
2594
1154
  > 如果您要给主画面（一般为摄像头）和辅路画面（一般用作屏幕分享）同时设置水印，需要调用该接口两次，并设定不同的 ` streamType `。
2595
- >
2596
-
1155
+ >
2597
1156
 
2598
1157
  ## getAudioEffectManager
2599
1158
 
2600
-
2601
-
2602
1159
  #### 获取音效管理类（TXAudioEffectManager）。
2603
1160
 
2604
1161
  TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如下功能：
@@ -2612,15 +1169,12 @@ TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如
2612
1169
 
2613
1170
  - 短音效：鼓掌声、欢笑声等简短的音效文件（对于小于10秒的文件，请将 isShortFile 参数设置为 true）。
2614
1171
 
2615
-
2616
1172
  #### 返回值说明：
2617
1173
 
2618
- 音效管理类 [TXAudioEffectManager](https://write.woa.com/document/87029952305344512)。
1174
+ 音效管理类 TXAudioEffectManager。
2619
1175
 
2620
1176
  ## startSystemAudioLoopback
2621
1177
 
2622
-
2623
-
2624
1178
  #### 开启系统声音采集。
2625
1179
 
2626
1180
  该接口会采集其他应用音频数据，并将其混入到 SDK 当前的音频数据流中，从而使房间中的其他用户也能听到主播的其他应用所播放出的声音。
@@ -2630,42 +1184,33 @@ TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如
2630
1184
  音乐直播场景中，主播可以使用此功能让 SDK 采集音乐播放器中的音乐，从而为自己的直播间增加背景音乐。
2631
1185
 
2632
1186
  > **注意**
2633
- >
1187
+ >
2634
1188
 
2635
1189
  > 1. 该接口只在 Android API 29 及以上的版本生效。
2636
- >
1190
+ >
2637
1191
 
2638
1192
  > 2. 您需要先使用该接口来开启系统声音采集，当使用屏幕分享接口开启屏幕分享时才会真正生效。
2639
- >
1193
+ >
2640
1194
 
2641
1195
  > 3. 您需要添加一个前台服务来确保系统声音采集不被静默，并设置 ` android:foregroundServiceType="mediaProjection" `。
2642
- >
1196
+ >
2643
1197
 
2644
1198
  > 4. SDK 只采集满足捕获策略和音频用法的应用音频，目前采集的音频用法包括USAGE_MEDIA, USAGE_GAME。
2645
- >
2646
-
1199
+ >
2647
1200
 
2648
1201
  ## stopSystemAudioLoopback
2649
1202
 
2650
-
2651
-
2652
1203
  #### 停止系统声音采集（iOS 端暂未支持）。
2653
1204
 
2654
1205
  ## startScreenCapture
2655
1206
 
2656
-
2657
-
2658
1207
  #### 启动屏幕分享。
2659
1208
 
2660
1209
  该接口支持抓取整个 Android 系统的屏幕，可以实现类似腾讯会议的全系统级的屏幕分享。
2661
1210
 
2662
-
2663
-
2664
1211
  参考文档：[实时屏幕分享(Android)](https://cloud.tencent.com/document/product/647/45751)
2665
1212
 
2666
-
2667
-
2668
- Android 推荐的屏幕分享视频编码参数（[TRTCVideoEncParam](https://write.woa.com/document/87029993616093184)）：
1213
+ Android 推荐的屏幕分享视频编码参数（TRTCVideoEncParam）：
2669
1214
  - 分辨率(videoResolution)：1280×720。
2670
1215
 
2671
1216
  - 帧率(videoFps)：10 FPS。
@@ -2674,138 +1219,75 @@ Android 推荐的屏幕分享视频编码参数（[TRTCVideoEncParam](https://wr
2674
1219
 
2675
1220
  - 分辨率自适应(enableAdjustRes)：false。
2676
1221
 
2677
-
2678
1222
  #### [REMARK]
2679
- <table>
2680
- <tr>
2681
- <td rowspan="1" colSpan="1" >参数</td>
2682
-
2683
- <td rowspan="1" colSpan="1" >描述</td>
2684
- </tr>
2685
-
2686
- <tr>
2687
- <td rowspan="1" colSpan="1" >encParams</td>
2688
-
2689
- <td rowspan="1" colSpan="1" >编码参数，请参见 [TRTCVideoEncParam](https://write.woa.com/document/87029993616093184)。如果您指定 ` encParams ` 为 null，SDK 会自动使用之前设定的编码参数。</td>
2690
- </tr>
2691
-
2692
- <tr>
2693
- <td rowspan="1" colSpan="1" >shareParams</td>
2694
-
2695
- <td rowspan="1" colSpan="1" >请参见 [TRTCScreenShareParams](https://write.woa.com/document/87029993616093184)，您可以通过其中的 ` floatingView ` 参数弹出悬浮窗（也可以使用 Android 系统的 WindowManager 接口自行弹出）。</td>
2696
- </tr>
2697
-
2698
- <tr>
2699
- <td rowspan="1" colSpan="1" >streamType</td>
2700
-
2701
- <td rowspan="1" colSpan="1" >屏幕分享使用的线路，可以设置为主路（[TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184)）或者辅路（[TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184)）。</td>
2702
- </tr>
2703
- </table>
2704
-
1223
+ | 参数 | 描述 |
1224
+ | --- | --- |
1225
+ | encParams | 编码参数，请参见 TRTCVideoEncParam。如果您指定 ` encParams ` 为 null，SDK 会自动使用之前设定的编码参数。 |
1226
+ | shareParams | 请参见 TRTCScreenShareParams，您可以通过其中的 ` floatingView ` 参数弹出悬浮窗（也可以使用 Android 系统的 WindowManager 接口自行弹出）。 |
1227
+ | streamType | 屏幕分享使用的线路，可以设置为主路（TRTC_VIDEO_STREAM_TYPE_BIG）或者辅路（TRTC_VIDEO_STREAM_TYPE_SUB）。 |
2705
1228
 
2706
1229
  > **注意**
2707
- >
1230
+ >
2708
1231
 
2709
1232
  > 从 Android 14 版本开始，如果您不需要使用屏幕分享功能，则需要在您工程项目中的 AndroidManifest.xml 中移除屏幕分享前台服务的权限，操作如下：
2710
- >
1233
+ >
2711
1234
 
2712
1235
  > <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" tools:node="remove" />
2713
- >
1236
+ >
2714
1237
 
2715
1238
  > 如果您需要使用屏幕分享功能，则需要按照 Google 的要求填写 Play 管理中心声明，参考文档如下所示：
2716
- >
1239
+ >
2717
1240
 
2718
1241
  > https://support.google.com/googleplay/android-developer/answer/13392821
2719
- >
2720
-
1242
+ >
2721
1243
 
2722
1244
  ## stopScreenCapture
2723
1245
 
2724
-
2725
-
2726
1246
  #### 停止屏幕分享。
2727
1247
 
2728
1248
  ## pauseScreenCapture
2729
1249
 
2730
-
2731
-
2732
1250
  #### 暂停屏幕分享。
2733
1251
 
2734
1252
  > **注意**
2735
- >
1253
+ >
2736
1254
 
2737
1255
  > 从v11.5版本开始，暂停屏幕采集会使用最后一帧按照 1 fps 帧率输出。
2738
- >
2739
-
2740
-
2741
- ## resumeScreenCapture
2742
-
1256
+ >
2743
1257
 
1258
+ ## resumeScreenCapture
2744
1259
 
2745
1260
  #### 恢复屏幕分享。
2746
1261
 
2747
1262
  ## setSubStreamEncoderParam
2748
1263
 
2749
-
2750
-
2751
1264
  #### 设置屏幕分享（即辅路）的视频编码参数（桌面系统和移动系统均已支持）。
2752
1265
 
2753
1266
  该接口可以设定远端用户所看到的屏幕分享（即辅路）的画面质量，同时也能决定云端录制出的视频文件中屏幕分享的画面质量。
2754
1267
 
2755
1268
  请注意如下两个接口的差异：
2756
- - [setVideoEncoderParam](https://write.woa.com/document/87029900866228224) 用于设置主路画面（[TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184)，一般用于摄像头）的视频编码参数。
2757
-
2758
- - [setSubStreamEncoderParam](https://write.woa.com/document/87029900866228224) 用于设置辅路画面（[TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184)，一般用于屏幕分享）的视频编码参数。
1269
+ - setVideoEncoderParam 用于设置主路画面（TRTC_VIDEO_STREAM_TYPE_BIG，一般用于摄像头）的视频编码参数。
2759
1270
 
2760
- <table>
2761
- <tr>
2762
- <td rowspan="1" colSpan="1" >参数</td>
2763
-
2764
- <td rowspan="1" colSpan="1" >描述</td>
2765
- </tr>
2766
-
2767
- <tr>
2768
- <td rowspan="1" colSpan="1" >param</td>
2769
-
2770
- <td rowspan="1" colSpan="1" >辅流编码参数，详情请参见 [TRTCVideoEncParam](https://write.woa.com/document/87029993616093184)。</td>
2771
- </tr>
2772
- </table>
1271
+ - setSubStreamEncoderParam 用于设置辅路画面（TRTC_VIDEO_STREAM_TYPE_SUB，一般用于屏幕分享）的视频编码参数。
2773
1272
 
1273
+ | 参数 | 描述 |
1274
+ | --- | --- |
1275
+ | param | 辅流编码参数，详情请参见 TRTCVideoEncParam。 |
2774
1276
 
2775
1277
  ## enableCustomVideoCapture
2776
1278
 
2777
-
2778
-
2779
1279
  #### 启用/关闭视频自定义采集模式。
2780
1280
 
2781
1281
  开启该模式后，SDK 不再运行原有的视频采集流程，即不再继续从摄像头采集数据和美颜，而是只保留视频编码和发送能力。
2782
1282
 
2783
- 您需要通过 [sendCustomVideoData](https://write.woa.com/document/87029900866228224) 不断地向 SDK 塞入自己采集的视频画面。
2784
- <table>
2785
- <tr>
2786
- <td rowspan="1" colSpan="1" >参数</td>
2787
-
2788
- <td rowspan="1" colSpan="1" >描述</td>
2789
- </tr>
2790
-
2791
- <tr>
2792
- <td rowspan="1" colSpan="1" >enable</td>
2793
-
2794
- <td rowspan="1" colSpan="1" >是否启用视频自定义采集，默认值：false。</td>
2795
- </tr>
2796
-
2797
- <tr>
2798
- <td rowspan="1" colSpan="1" >streamType</td>
2799
-
2800
- <td rowspan="1" colSpan="1" >用于指定视频流类型，[TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184)：高清大画面；[TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184)：辅路画面。</td>
2801
- </tr>
2802
- </table>
2803
-
1283
+ 您需要通过 sendCustomVideoData 不断地向 SDK 塞入自己采集的视频画面。
1284
+ | 参数 | 描述 |
1285
+ | --- | --- |
1286
+ | enable | 是否启用视频自定义采集，默认值：false。 |
1287
+ | streamType | 用于指定视频流类型，TRTC_VIDEO_STREAM_TYPE_BIG：高清大画面；TRTC_VIDEO_STREAM_TYPE_SUB：辅路画面。 |
2804
1288
 
2805
1289
  ## sendCustomVideoData
2806
1290
 
2807
-
2808
-
2809
1291
  #### 向 SDK 投送自己采集的视频帧。
2810
1292
 
2811
1293
  使用此接口可以向 SDK 投送自己采集的视频帧，SDK 会将视频帧进行编码并通过自身的网络模块传输出去。
@@ -2815,82 +1297,46 @@ Android 平台有两种投送方案：
2815
1297
 
2816
1298
  - 显存传递方案：对接需要一定的 OpenGL 基础，但是性能较好，640 × 360 以上的分辨率请采用该方案。
2817
1299
 
2818
-
2819
-
2820
-
2821
1300
  参考文档：[自定义采集和渲染](https://cloud.tencent.com/document/product/647/34066)。
2822
- <table>
2823
- <tr>
2824
- <td rowspan="1" colSpan="1" >参数</td>
2825
-
2826
- <td rowspan="1" colSpan="1" >描述</td>
2827
- </tr>
2828
-
2829
- <tr>
2830
- <td rowspan="1" colSpan="1" >frame</td>
2831
-
2832
- <td rowspan="1" colSpan="1" >视频数据，如果是内存传递方案，请设置 data 字段；如果是显存传递方案，请设置 TRTCTexture 字段。bufferType 推荐选择 [TRTC_VIDEO_BUFFER_TYPE_TEXTURE](https://write.woa.com/document/87029993616093184)，pixelFormat 推荐选择 [TRTC_VIDEO_PIXEL_FORMAT_Texture_2D](https://write.woa.com/document/87029993616093184)，更多支持格式参考 [TRTCVideoFrame](https://write.woa.com/document/87029993616093184)。</td>
2833
- </tr>
2834
-
2835
- <tr>
2836
- <td rowspan="1" colSpan="1" >streamType</td>
2837
-
2838
- <td rowspan="1" colSpan="1" >用于指定视频流类型，[TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184)： 高清大画面；[TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184)： 辅路画面。</td>
2839
- </tr>
2840
- </table>
2841
-
1301
+ | 参数 | 描述 |
1302
+ | --- | --- |
1303
+ | frame | 视频数据，如果是内存传递方案，请设置 data 字段；如果是显存传递方案，请设置 TRTCTexture 字段。bufferType 推荐选择 TRTC_VIDEO_BUFFER_TYPE_TEXTURE，pixelFormat 推荐选择 TRTC_VIDEO_PIXEL_FORMAT_Texture_2D，更多支持格式参考 TRTCVideoFrame。 |
1304
+ | streamType | 用于指定视频流类型，TRTC_VIDEO_STREAM_TYPE_BIG： 高清大画面；TRTC_VIDEO_STREAM_TYPE_SUB： 辅路画面。 |
2842
1305
 
2843
1306
  > **注意**
2844
- >
1307
+ >
2845
1308
 
2846
- > 1. 推荐您在采集到的一帧视频帧后，即调用 [generateCustomPTS](https://write.woa.com/document/87029900866228224) 接口获取该帧的 timestamp 数值，这样可以获得最佳的音画同步效果。
2847
- >
1309
+ > 1. 推荐您在采集到的一帧视频帧后，即调用 generateCustomPTS 接口获取该帧的 timestamp 数值，这样可以获得最佳的音画同步效果。
1310
+ >
2848
1311
 
2849
- > 2. SDK 最终编码出的视频帧率并不是由您调用本接口的频率决定的，而是由您在 [setVideoEncoderParam](https://write.woa.com/document/87029900866228224) 中所设置的 FPS 决定的。
2850
- >
1312
+ > 2. SDK 最终编码出的视频帧率并不是由您调用本接口的频率决定的，而是由您在 setVideoEncoderParam 中所设置的 FPS 决定的。
1313
+ >
2851
1314
 
2852
1315
  > 3. 请尽量保持本接口的调用间隔是均匀的，否则会导致编码器输出帧率不稳或者音画不同步等问题。
2853
- >
2854
-
1316
+ >
2855
1317
 
2856
1318
  ## enableCustomAudioCapture
2857
1319
 
2858
-
2859
-
2860
1320
  #### 启用音频自定义采集模式。
2861
1321
 
2862
1322
  开启该模式后，SDK 不再运行原有的音频采集流程，即不再继续从麦克风采集音频数据，而是只保留音频编码和发送能力。
2863
1323
 
2864
- 您需要通过 [sendCustomAudioData](https://write.woa.com/document/87029900866228224) 不断地向 SDK 塞入自己采集的音频数据。
2865
- <table>
2866
- <tr>
2867
- <td rowspan="1" colSpan="1" >参数</td>
2868
-
2869
- <td rowspan="1" colSpan="1" >描述</td>
2870
- </tr>
2871
-
2872
- <tr>
2873
- <td rowspan="1" colSpan="1" >enable</td>
2874
-
2875
- <td rowspan="1" colSpan="1" >是否启用音频自定义采集模式，默认值：false。</td>
2876
- </tr>
2877
- </table>
2878
-
1324
+ 您需要通过 sendCustomAudioData 不断地向 SDK 塞入自己采集的音频数据。
1325
+ | 参数 | 描述 |
1326
+ | --- | --- |
1327
+ | enable | 是否启用音频自定义采集模式，默认值：false。 |
2879
1328
 
2880
1329
  > **注意**
2881
- >
1330
+ >
2882
1331
 
2883
1332
  > 由于回声抵消（AEC）需要严格的控制声音采集和播放的时间，所以开启自定义音频采集后，AEC 能力可能会失效。
2884
- >
2885
-
1333
+ >
2886
1334
 
2887
1335
  ## sendCustomAudioData
2888
1336
 
2889
-
2890
-
2891
1337
  #### 向 SDK 投送自己采集的音频数据。
2892
1338
 
2893
- 参数 [TRTCAudioFrame](https://write.woa.com/document/87029993616093184) 推荐下列填写方式（其他字段不需要填写）：
1339
+ 参数 TRTCAudioFrame 推荐下列填写方式（其他字段不需要填写）：
2894
1340
  - audioFormat：音频数据格式，仅支持 TRTCAudioFrameFormatPCM。
2895
1341
 
2896
1342
  - data：音频帧 buffer。音频帧数据只支持 PCM 格式，支持 5-100 ms 帧长，推荐使用 20ms 帧长，长度计算方法：48000采样率，单声道的帧长度：` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
@@ -2899,76 +1345,40 @@ Android 平台有两种投送方案：
2899
1345
 
2900
1346
  - channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
2901
1347
 
2902
- - timestamp：时间戳，单位为毫秒（ms），请使用音频帧在采集时被记录下来的时间戳（可以在采集到一帧音频帧之后，通过调用 [generateCustomPTS](https://write.woa.com/document/87029900866228224) 获取时间戳）。
2903
-
2904
-
2905
-
1348
+ - timestamp：时间戳，单位为毫秒（ms），请使用音频帧在采集时被记录下来的时间戳（可以在采集到一帧音频帧之后，通过调用 generateCustomPTS 获取时间戳）。
2906
1349
 
2907
1350
  参考文档：[自定义采集和渲染](https://cloud.tencent.com/document/product/647/74692)。
2908
- <table>
2909
- <tr>
2910
- <td rowspan="1" colSpan="1" >参数</td>
2911
-
2912
- <td rowspan="1" colSpan="1" >描述</td>
2913
- </tr>
2914
-
2915
- <tr>
2916
- <td rowspan="1" colSpan="1" >frame</td>
2917
-
2918
- <td rowspan="1" colSpan="1" >音频数据</td>
2919
- </tr>
2920
- </table>
2921
-
1351
+ | 参数 | 描述 |
1352
+ | --- | --- |
1353
+ | frame | 音频数据 |
2922
1354
 
2923
1355
  > **注意**
2924
- >
1356
+ >
2925
1357
 
2926
1358
  > 请您精准地按每帧时长的间隔调用本接口，数据投送间隔不均匀时极易触发声音卡顿。
2927
- >
2928
-
1359
+ >
2929
1360
 
2930
1361
  ## enableMixExternalAudioFrame
2931
1362
 
2932
-
2933
-
2934
1363
  #### 启用/关闭自定义音轨。
2935
1364
 
2936
1365
  开启后，您可以通过本接口向 SDK 混入一条自定义的音轨。通过两个布尔型参数，您可以控制该音轨是否要在远端和本地播放。
2937
- <table>
2938
- <tr>
2939
- <td rowspan="1" colSpan="1" >参数</td>
2940
-
2941
- <td rowspan="1" colSpan="1" >描述</td>
2942
- </tr>
2943
-
2944
- <tr>
2945
- <td rowspan="1" colSpan="1" >enablePlayout</td>
2946
-
2947
- <td rowspan="1" colSpan="1" >控制混入的音轨是否要在本地播放，默认值：false。</td>
2948
- </tr>
2949
-
2950
- <tr>
2951
- <td rowspan="1" colSpan="1" >enablePublish</td>
2952
-
2953
- <td rowspan="1" colSpan="1" >控制混入的音轨是否要在远端播放，默认值：false。</td>
2954
- </tr>
2955
- </table>
2956
-
1366
+ | 参数 | 描述 |
1367
+ | --- | --- |
1368
+ | enablePlayout | 控制混入的音轨是否要在本地播放，默认值：false。 |
1369
+ | enablePublish | 控制混入的音轨是否要在远端播放，默认值：false。 |
2957
1370
 
2958
1371
  > **注意**
2959
- >
1372
+ >
2960
1373
 
2961
1374
  > 如果您指定参数 ` enablePublish ` 和 ` enablePlayout ` 均为 false，代表完全关闭您的自定义音轨。
2962
- >
2963
-
1375
+ >
2964
1376
 
2965
1377
  ## mixExternalAudioFrame
2966
1378
 
2967
-
2968
-
2969
1379
  #### 向 SDK 混入自定义音轨。
2970
1380
 
2971
- 调用该接口之前，您需要先通过 [enableMixExternalAudioFrame](https://write.woa.com/document/87029900866228224) 开启自定义音轨，之后就可以通过本接口将自己的音轨以 PCM 格式混入到 SDK 中。
1381
+ 调用该接口之前，您需要先通过 enableMixExternalAudioFrame 开启自定义音轨，之后就可以通过本接口将自己的音轨以 PCM 格式混入到 SDK 中。
2972
1382
 
2973
1383
  理想情况下，我们期望您的代码能够以非常均匀的速度向 SDK 提供音轨数据。但我们也非常清楚，完美的调用间隔是一个巨大的挑战。
2974
1384
 
@@ -2978,38 +1388,24 @@ Android 平台有两种投送方案：
2978
1388
 
2979
1389
  当您调用该接口后，如果发现返回值大于 100ms，则可以等待一帧音频帧的播放时间之后再次调用；如果返回值小于 100ms，则代表缓冲区比较小，您可以再次混入一些音轨数据以确保音轨缓冲区的大小维持在“安全水位”以上。
2980
1390
 
2981
-
2982
-
2983
- 参数 [TRTCAudioFrame](https://write.woa.com/document/87029993616093184) 推荐下列填写方式（其他字段不需要填写）：
1391
+ 参数 TRTCAudioFrame 推荐下列填写方式（其他字段不需要填写）：
2984
1392
  - data：音频帧 buffer。音频帧数据只支持 PCM 格式，支持 5ms - 100ms 帧长，推荐使用 20ms 帧长，长度计算方法：48000采样率, 单声道的帧长度：` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
2985
1393
 
2986
1394
  - sampleRate：采样率，支持：16000、24000、32000、44100、48000。
2987
1395
 
2988
1396
  - channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
2989
1397
 
2990
- - timestamp：时间戳，单位为毫秒（ms），请使用音频帧在采集时被记录下来的时间戳（可以在获得一帧音频帧之后，通过调用 [generateCustomPTS](https://write.woa.com/document/87029900866228224) 获得时间戳）。
2991
-
2992
- <table>
2993
- <tr>
2994
- <td rowspan="1" colSpan="1" >参数</td>
2995
-
2996
- <td rowspan="1" colSpan="1" >描述</td>
2997
- </tr>
2998
-
2999
- <tr>
3000
- <td rowspan="1" colSpan="1" >frame</td>
3001
-
3002
- <td rowspan="1" colSpan="1" >音频数据</td>
3003
- </tr>
3004
- </table>
1398
+ - timestamp：时间戳，单位为毫秒（ms），请使用音频帧在采集时被记录下来的时间戳（可以在获得一帧音频帧之后，通过调用 generateCustomPTS 获得时间戳）。
3005
1399
 
1400
+ | 参数 | 描述 |
1401
+ | --- | --- |
1402
+ | frame | 音频数据 |
3006
1403
 
3007
1404
  > **注意**
3008
- >
1405
+ >
3009
1406
 
3010
1407
  > 请您精准地按每帧时长的间隔调用本接口，数据投送间隔不均匀时极易触发声音卡顿。
3011
- >
3012
-
1408
+ >
3013
1409
 
3014
1410
  #### 返回值说明：
3015
1411
 
@@ -3017,47 +1413,25 @@ Android 平台有两种投送方案：
3017
1413
 
3018
1414
  ## setMixExternalAudioVolume
3019
1415
 
3020
-
3021
-
3022
1416
  #### 设置推流时混入外部音频的推流音量和播放音量。
3023
- <table>
3024
- <tr>
3025
- <td rowspan="1" colSpan="1" >参数</td>
3026
-
3027
- <td rowspan="1" colSpan="1" >描述</td>
3028
- </tr>
3029
-
3030
- <tr>
3031
- <td rowspan="1" colSpan="1" >playoutVolume</td>
3032
-
3033
- <td rowspan="1" colSpan="1" >设置的播放音量大小，范围 [0, 150]，-1 表示不改变。</td>
3034
- </tr>
3035
-
3036
- <tr>
3037
- <td rowspan="1" colSpan="1" >publishVolume</td>
3038
-
3039
- <td rowspan="1" colSpan="1" >设置的推流音量大小，范围 [0, 150]，-1 表示不改变。</td>
3040
- </tr>
3041
- </table>
3042
-
1417
+ | 参数 | 描述 |
1418
+ | --- | --- |
1419
+ | playoutVolume | 设置的播放音量大小，范围 [0, 150]，-1 表示不改变。 |
1420
+ | publishVolume | 设置的推流音量大小，范围 [0, 150]，-1 表示不改变。 |
3043
1421
 
3044
1422
  ## generateCustomPTS
3045
1423
 
3046
-
3047
-
3048
1424
  #### 生成自定义采集时的时间戳。
3049
1425
 
3050
1426
  本接口仅适用于自定义采集模式，用于解决音视频帧的采集时间（capture time）和投送时间（send time）不一致所导致的音画不同步问题。
3051
1427
 
3052
-
3053
-
3054
- 当您通过 [sendCustomVideoData](https://write.woa.com/document/87029900866228224) 或 [sendCustomAudioData](https://write.woa.com/document/87029900866228224) 等接口进行自定义视频或音频采集时，请按照如下操作使用该接口：
1428
+ 当您通过 sendCustomVideoData 或 sendCustomAudioData 等接口进行自定义视频或音频采集时，请按照如下操作使用该接口：
3055
1429
 
3056
1430
  1. 首先，在采集到一帧视频或音频帧时，通过调用本接口获得当时的 PTS 时间戳。
3057
1431
 
3058
1432
  2. 之后可以将该视频或音频帧送入您使用的前处理模块（如第三方美颜组件，或第三方音效组件）。
3059
1433
 
3060
- 3. 在真正调用 [sendCustomVideoData](https://write.woa.com/document/87029900866228224) 或 [sendCustomAudioData](https://write.woa.com/document/87029900866228224) 进行投送时，请将该帧在采集时记录的 PTS 时间戳赋值给 [TRTCVideoFrame](https://write.woa.com/document/87029993616093184) 或 [TRTCAudioFrame](https://write.woa.com/document/87029993616093184) 中的 timestamp 字段。
1434
+ 3. 在真正调用 sendCustomVideoData 或 sendCustomAudioData 进行投送时，请将该帧在采集时记录的 PTS 时间戳赋值给 TRTCVideoFrame 或 TRTCAudioFrame 中的 timestamp 字段。
3061
1435
 
3062
1436
  #### 返回值说明：
3063
1437
 
@@ -3065,37 +1439,14 @@ Android 平台有两种投送方案：
3065
1439
 
3066
1440
  ## setLocalVideoProcessListener
3067
1441
 
3068
-
3069
-
3070
1442
  #### 设置第三方美颜的视频数据回调。
3071
1443
 
3072
1444
  设置该回调之后，SDK 会把采集到的视频帧通过您设置的 listener 回调出来，用于第三方美颜组件进行二次处理，之后 SDK 会将处理后的视频帧进行编码和发送。
3073
- <table>
3074
- <tr>
3075
- <td rowspan="1" colSpan="1" >参数</td>
3076
-
3077
- <td rowspan="1" colSpan="1" >描述</td>
3078
- </tr>
3079
-
3080
- <tr>
3081
- <td rowspan="1" colSpan="1" >bufferType</td>
3082
-
3083
- <td rowspan="1" colSpan="1" >指定回调的数据格式，目前支持：<br>- [TRTC_VIDEO_BUFFER_TYPE_TEXTURE](https://write.woa.com/document/87029993616093184)：适用于 pixelFormat 被设置为 [TRTC_VIDEO_PIXEL_FORMAT_Texture_2D](https://write.woa.com/document/87029993616093184) 时。<br>- [TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER](https://write.woa.com/document/87029993616093184)：适用于 pixelFormat 被设置为 [TRTC_VIDEO_PIXEL_FORMAT_I420](https://write.woa.com/document/87029993616093184) 时。<br>- [TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY](https://write.woa.com/document/87029993616093184)：适用于 pixelFormat 被设置为 [TRTC_VIDEO_PIXEL_FORMAT_I420](https://write.woa.com/document/87029993616093184) 时。</td>
3084
- </tr>
3085
-
3086
- <tr>
3087
- <td rowspan="1" colSpan="1" >listener</td>
3088
-
3089
- <td rowspan="1" colSpan="1" >自定义预处理回调，详见 [TRTCVideoFrameListener](https://write.woa.com/document/87029920275542016)。</td>
3090
- </tr>
3091
-
3092
- <tr>
3093
- <td rowspan="1" colSpan="1" >pixelFormat</td>
3094
-
3095
- <td rowspan="1" colSpan="1" >指定回调的像素格式，目前支持：<br>- [TRTC_VIDEO_PIXEL_FORMAT_Texture_2D](https://write.woa.com/document/87029993616093184): 显存纹理方案。<br>- [TRTC_VIDEO_PIXEL_FORMAT_I420](https://write.woa.com/document/87029993616093184)：内存数据方案。</td>
3096
- </tr>
3097
- </table>
3098
-
1445
+ | 参数 | 描述 |
1446
+ | --- | --- |
1447
+ | bufferType | 指定回调的数据格式，目前支持：<br>- TRTC_VIDEO_BUFFER_TYPE_TEXTURE：适用于 pixelFormat 被设置为 TRTC_VIDEO_PIXEL_FORMAT_Texture_2D 时。<br>- TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER：适用于 pixelFormat 被设置为 TRTC_VIDEO_PIXEL_FORMAT_I420 时。<br>- TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY：适用于 pixelFormat 被设置为 TRTC_VIDEO_PIXEL_FORMAT_I420 时。 |
1448
+ | listener | 自定义预处理回调，详见 TRTCVideoFrameListener。 |
1449
+ | pixelFormat | 指定回调的像素格式，目前支持：<br>- TRTC_VIDEO_PIXEL_FORMAT_Texture_2D: 显存纹理方案。<br>- TRTC_VIDEO_PIXEL_FORMAT_I420：内存数据方案。 |
3099
1450
 
3100
1451
  #### 返回值说明：
3101
1452
 
@@ -3103,8 +1454,6 @@ Android 平台有两种投送方案：
3103
1454
 
3104
1455
  ## setLocalVideoRenderListener
3105
1456
 
3106
-
3107
-
3108
1457
  #### 设置本地视频自定义渲染回调。
3109
1458
 
3110
1459
  设置该回调之后，SDK 内部会跳过原来的渲染流程，并把采集到的数据回调出来，您需要自己完成画面渲染。
@@ -3112,36 +1461,12 @@ Android 平台有两种投送方案：
3112
1461
 
3113
1462
  - bufferType 指定 buffer 的类型，BYTE_BUFFER 适合在 jni 层使用，BYTE_ARRAY 则可用于 Java 层的直接操作。
3114
1463
 
3115
-
3116
-
3117
-
3118
1464
  参考文档：[自定义采集和渲染](https://cloud.tencent.com/document/product/647/34066)。
3119
- <table>
3120
- <tr>
3121
- <td rowspan="1" colSpan="1" >参数</td>
3122
-
3123
- <td rowspan="1" colSpan="1" >描述</td>
3124
- </tr>
3125
-
3126
- <tr>
3127
- <td rowspan="1" colSpan="1" >bufferType</td>
3128
-
3129
- <td rowspan="1" colSpan="1" >指定视频帧的数据结构：<br>- [TRTC_VIDEO_BUFFER_TYPE_TEXTURE](https://write.woa.com/document/87029993616093184)：适用于 pixelFormat 被设置为 [TRTC_VIDEO_PIXEL_FORMAT_Texture_2D](https://write.woa.com/document/87029993616093184) 时。<br>- [TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER](https://write.woa.com/document/87029993616093184)：适用于 pixelFormat 被设置为 [TRTC_VIDEO_PIXEL_FORMAT_I420](https://write.woa.com/document/87029993616093184) 和 [TRTC_VIDEO_PIXEL_FORMAT_RGBA](https://write.woa.com/document/87029993616093184) 时。<br>- [TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY](https://write.woa.com/document/87029993616093184)：适用于 pixelFormat 被设置为 [TRTC_VIDEO_PIXEL_FORMAT_I420](https://write.woa.com/document/87029993616093184) 和 [TRTC_VIDEO_PIXEL_FORMAT_RGBA](https://write.woa.com/document/87029993616093184) 时。</td>
3130
- </tr>
3131
-
3132
- <tr>
3133
- <td rowspan="1" colSpan="1" >listener</td>
3134
-
3135
- <td rowspan="1" colSpan="1" >自定义视频渲染回调，每一帧视频数据回调一次。</td>
3136
- </tr>
3137
-
3138
- <tr>
3139
- <td rowspan="1" colSpan="1" >pixelFormat</td>
3140
-
3141
- <td rowspan="1" colSpan="1" >指定视频帧的像素格式，如：<br>- [TRTC_VIDEO_PIXEL_FORMAT_Texture_2D](https://write.woa.com/document/87029993616093184)：OpenGL 纹理格式，比较适合 GPU 进行处理，处理效率高。<br>- [TRTC_VIDEO_PIXEL_FORMAT_I420](https://write.woa.com/document/87029993616093184)：标准 i420 格式，比较适合 CPU 进行处理，处理效率较差。<br>- [TRTC_VIDEO_PIXEL_FORMAT_RGBA](https://write.woa.com/document/87029993616093184)：RGBA 格式，比较适合 CPU 进行处理，处理效率较差。</td>
3142
- </tr>
3143
- </table>
3144
-
1465
+ | 参数 | 描述 |
1466
+ | --- | --- |
1467
+ | bufferType | 指定视频帧的数据结构：<br>- TRTC_VIDEO_BUFFER_TYPE_TEXTURE：适用于 pixelFormat 被设置为 TRTC_VIDEO_PIXEL_FORMAT_Texture_2D 时。<br>- TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER：适用于 pixelFormat 被设置为 TRTC_VIDEO_PIXEL_FORMAT_I420 和 TRTC_VIDEO_PIXEL_FORMAT_RGBA 时。<br>- TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY：适用于 pixelFormat 被设置为 TRTC_VIDEO_PIXEL_FORMAT_I420 和 TRTC_VIDEO_PIXEL_FORMAT_RGBA 时。 |
1468
+ | listener | 自定义视频渲染回调，每一帧视频数据回调一次。 |
1469
+ | pixelFormat | 指定视频帧的像素格式，如：<br>- TRTC_VIDEO_PIXEL_FORMAT_Texture_2D：OpenGL 纹理格式，比较适合 GPU 进行处理，处理效率高。<br>- TRTC_VIDEO_PIXEL_FORMAT_I420：标准 i420 格式，比较适合 CPU 进行处理，处理效率较差。<br>- TRTC_VIDEO_PIXEL_FORMAT_RGBA：RGBA 格式，比较适合 CPU 进行处理，处理效率较差。 |
3145
1470
 
3146
1471
  #### 返回值说明：
3147
1472
 
@@ -3149,8 +1474,6 @@ Android 平台有两种投送方案：
3149
1474
 
3150
1475
  ## setRemoteVideoRenderListener
3151
1476
 
3152
-
3153
-
3154
1477
  #### 设置远端视频自定义渲染回调。
3155
1478
 
3156
1479
  设置该回调之后，SDK 内部会跳过原来的渲染流程，并把采集到的数据回调出来，您需要自己完成画面渲染。
@@ -3158,49 +1481,19 @@ Android 平台有两种投送方案：
3158
1481
 
3159
1482
  - bufferType 指定 buffer 的类型，直接使用 PixelBuffer 效率最高；使用 NSData 相当于让 SDK 在内部做了一次内存转换，因此会有额外的性能损耗。
3160
1483
 
3161
-
3162
-
3163
-
3164
1484
  参考文档：[自定义采集和渲染](https://cloud.tencent.com/document/product/647/34066)。
3165
- <table>
3166
- <tr>
3167
- <td rowspan="1" colSpan="1" >参数</td>
3168
-
3169
- <td rowspan="1" colSpan="1" >描述</td>
3170
- </tr>
3171
-
3172
- <tr>
3173
- <td rowspan="1" colSpan="1" >bufferType</td>
3174
-
3175
- <td rowspan="1" colSpan="1" >指定视频帧的数据结构，如 [TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER](https://write.woa.com/document/87029993616093184)，[TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY](https://write.woa.com/document/87029993616093184)。</td>
3176
- </tr>
3177
-
3178
- <tr>
3179
- <td rowspan="1" colSpan="1" >listener</td>
3180
-
3181
- <td rowspan="1" colSpan="1" >自定义视频渲染回调，每一帧视频数据回调一次。</td>
3182
- </tr>
3183
-
3184
- <tr>
3185
- <td rowspan="1" colSpan="1" >pixelFormat</td>
3186
-
3187
- <td rowspan="1" colSpan="1" >指定视频帧的像素格式，目前支持 [TRTC_VIDEO_PIXEL_FORMAT_I420](https://write.woa.com/document/87029993616093184)，[TRTC_VIDEO_PIXEL_FORMAT_RGBA](https://write.woa.com/document/87029993616093184)。</td>
3188
- </tr>
3189
-
3190
- <tr>
3191
- <td rowspan="1" colSpan="1" >userId</td>
3192
-
3193
- <td rowspan="1" colSpan="1" >指定远端用户的 ID。</td>
3194
- </tr>
3195
- </table>
3196
-
1485
+ | 参数 | 描述 |
1486
+ | --- | --- |
1487
+ | bufferType | 指定视频帧的数据结构，如 TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER，TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY。 |
1488
+ | listener | 自定义视频渲染回调，每一帧视频数据回调一次。 |
1489
+ | pixelFormat | 指定视频帧的像素格式，目前支持 TRTC_VIDEO_PIXEL_FORMAT_I420，TRTC_VIDEO_PIXEL_FORMAT_RGBA。 |
1490
+ | userId | 指定远端用户的 ID。 |
3197
1491
 
3198
1492
  > **注意**
3199
- >
1493
+ >
3200
1494
 
3201
1495
  > 实际使用时，需要先调用 ` startRemoteView(userId, null) ` 启动远程视频流的拉取，并将 view 设置为 null，否则不会有数据回调出来。
3202
- >
3203
-
1496
+ >
3204
1497
 
3205
1498
  #### 返回值说明：
3206
1499
 
@@ -3208,67 +1501,46 @@ Android 平台有两种投送方案：
3208
1501
 
3209
1502
  ## setAudioFrameListener
3210
1503
 
3211
-
3212
-
3213
1504
  #### 设置音频数据自定义回调。
3214
1505
 
3215
1506
  设置该回调之后，SDK 内部会把音频数据（PCM 格式）回调出来，包括：
3216
- - [onCapturedAudioFrame](https://write.woa.com/document/87029920275542016)：本地麦克风采集到的音频数据回调
3217
-
3218
- - [onLocalProcessedAudioFrame](https://write.woa.com/document/87029920275542016)：本地采集并经过音频模块前处理后的音频数据回调
1507
+ - onCapturedAudioFrame：本地麦克风采集到的音频数据回调
3219
1508
 
3220
- - [onRemoteUserAudioFrame](https://write.woa.com/document/87029920275542016)：混音前的每一路远程用户的音频数据
1509
+ - onLocalProcessedAudioFrame：本地采集并经过音频模块前处理后的音频数据回调
3221
1510
 
3222
- - [onMixedPlayAudioFrame](https://write.woa.com/document/87029920275542016)：将各路音频混合之后并最终要由系统播放出的音频数据回调
1511
+ - onRemoteUserAudioFrame：混音前的每一路远程用户的音频数据
3223
1512
 
1513
+ - onMixedPlayAudioFrame：将各路音频混合之后并最终要由系统播放出的音频数据回调
3224
1514
 
3225
1515
  > **注意**
3226
- >
1516
+ >
3227
1517
 
3228
1518
  > 设置回调为空即代表停止自定义音频回调，反之，设置回调不为空则代表启动自定义音频回调。
3229
- >
3230
-
1519
+ >
3231
1520
 
3232
1521
  ## setCapturedAudioFrameCallbackFormat
3233
1522
 
3234
-
3235
-
3236
1523
  #### 设置本地麦克风采集出的音频帧回调格式。
3237
1524
 
3238
- 本接口用于设置 [onCapturedAudioFrame](https://write.woa.com/document/87029920275542016) 回调出来的 AudioFrame 的格式：
1525
+ 本接口用于设置 onCapturedAudioFrame 回调出来的 AudioFrame 的格式：
3239
1526
  - sampleRate：采样率，支持：16000、32000、44100、48000。
3240
1527
 
3241
1528
  - channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
3242
1529
 
3243
1530
  - samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
3244
1531
 
3245
-
3246
-
3247
-
3248
1532
  如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为：` 采样点数 = 毫秒数 * 采样率 / 1000 `。
3249
1533
 
3250
1534
  举例：48000Hz 采样率希望回调 20ms 帧长的数据，则采样点数应该填：` 960 = 20 * 48000 / 1000 `。
3251
- <table>
3252
- <tr>
3253
- <td rowspan="1" colSpan="1" >参数</td>
3254
-
3255
- <td rowspan="1" colSpan="1" >描述</td>
3256
- </tr>
3257
-
3258
- <tr>
3259
- <td rowspan="1" colSpan="1" >format</td>
3260
-
3261
- <td rowspan="1" colSpan="1" >音频数据回调格式。</td>
3262
- </tr>
3263
- </table>
3264
-
1535
+ | 参数 | 描述 |
1536
+ | --- | --- |
1537
+ | format | 音频数据回调格式。 |
3265
1538
 
3266
1539
  > **注意**
3267
- >
1540
+ >
3268
1541
 
3269
1542
  > 最终回调的帧长度是以字节为单位，采样点数转换成字节数的计算公式为：` 字节数 = 采样点数 * channel * 2（位宽） `。举例：48000Hz 采样率，双声道，20ms 帧长，采样点数为 960，字节数为 ` 3840 = 960 * 2 * 2 `。
3270
- >
3271
-
1543
+ >
3272
1544
 
3273
1545
  #### 返回值说明：
3274
1546
 
@@ -3276,44 +1548,27 @@ Android 平台有两种投送方案：
3276
1548
 
3277
1549
  ## setLocalProcessedAudioFrameCallbackFormat
3278
1550
 
3279
-
3280
-
3281
1551
  #### 设置经过前处理后的本地音频帧回调格式。
3282
1552
 
3283
- 本接口用于设置 [onLocalProcessedAudioFrame](https://write.woa.com/document/87029920275542016) 回调出来的 AudioFrame 的格式：
1553
+ 本接口用于设置 onLocalProcessedAudioFrame 回调出来的 AudioFrame 的格式：
3284
1554
  - sampleRate：采样率，支持：16000、32000、44100、48000。
3285
1555
 
3286
1556
  - channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
3287
1557
 
3288
1558
  - samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
3289
1559
 
3290
-
3291
-
3292
-
3293
1560
  如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为：` 采样点数 = 毫秒数 * 采样率 / 1000 `。
3294
1561
 
3295
1562
  举例：48000Hz 采样率希望回调20ms帧长的数据，则采样点数应该填: ` 960 = 20 * 48000 / 1000 `。
3296
- <table>
3297
- <tr>
3298
- <td rowspan="1" colSpan="1" >参数</td>
3299
-
3300
- <td rowspan="1" colSpan="1" >描述</td>
3301
- </tr>
3302
-
3303
- <tr>
3304
- <td rowspan="1" colSpan="1" >format</td>
3305
-
3306
- <td rowspan="1" colSpan="1" >音频数据回调格式。</td>
3307
- </tr>
3308
- </table>
3309
-
1563
+ | 参数 | 描述 |
1564
+ | --- | --- |
1565
+ | format | 音频数据回调格式。 |
3310
1566
 
3311
1567
  > **注意**
3312
- >
1568
+ >
3313
1569
 
3314
1570
  > 最终回调的帧长度是以字节为单位，采样点数转换成字节数的计算公式为：` 字节数 = 采样点数 * channel * 2（位宽） `。 举例：48000Hz 采样率，双声道，20ms 帧长，采样点数为 960，字节数为 ` 3840 = 960 * 2 * 2 `。
3315
- >
3316
-
1571
+ >
3317
1572
 
3318
1573
  #### 返回值说明：
3319
1574
 
@@ -3321,44 +1576,27 @@ Android 平台有两种投送方案：
3321
1576
 
3322
1577
  ## setMixedPlayAudioFrameCallbackFormat
3323
1578
 
3324
-
3325
-
3326
1579
  #### 设置最终要由系统播放出的音频帧回调格式。
3327
1580
 
3328
- 本接口用于设置 [onMixedPlayAudioFrame](https://write.woa.com/document/87029920275542016) 回调出来的 AudioFrame 的格式：
1581
+ 本接口用于设置 onMixedPlayAudioFrame 回调出来的 AudioFrame 的格式：
3329
1582
  - sampleRate：采样率，支持：16000、32000、44100、48000。
3330
1583
 
3331
1584
  - channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
3332
1585
 
3333
1586
  - samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
3334
1587
 
3335
-
3336
-
3337
-
3338
1588
  如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为：` 采样点数 = 毫秒数 * 采样率 / 1000 `。
3339
1589
 
3340
1590
  举例：48000Hz 采样率希望回调 20ms 帧长的数据，则采样点数应该填: ` 960 = 20 * 48000 / 1000 `。
3341
- <table>
3342
- <tr>
3343
- <td rowspan="1" colSpan="1" >参数</td>
3344
-
3345
- <td rowspan="1" colSpan="1" >描述</td>
3346
- </tr>
3347
-
3348
- <tr>
3349
- <td rowspan="1" colSpan="1" >format</td>
3350
-
3351
- <td rowspan="1" colSpan="1" >音频数据回调格式。</td>
3352
- </tr>
3353
- </table>
3354
-
1591
+ | 参数 | 描述 |
1592
+ | --- | --- |
1593
+ | format | 音频数据回调格式。 |
3355
1594
 
3356
1595
  > **注意**
3357
- >
1596
+ >
3358
1597
 
3359
1598
  > 最终回调的帧长度是以字节为单位，采样点数转换成字节数的计算公式为：` 字节数 = 采样点数 * channel * 2（位宽） `。 举例：48000Hz 采样率，双声道，20ms 帧长，采样点数为 960，字节数为 ` 3840 = 960 * 2 * 2 `。
3360
- >
3361
-
1599
+ >
3362
1600
 
3363
1601
  #### 返回值说明：
3364
1602
 
@@ -3366,147 +1604,85 @@ Android 平台有两种投送方案：
3366
1604
 
3367
1605
  ## enableCustomAudioRendering
3368
1606
 
3369
-
3370
-
3371
1607
  #### 开启音频自定义播放。
3372
1608
 
3373
1609
  如果您需要外接一些特定的音频设备，或者希望自己掌控音频的播放逻辑，您可以通过该接口启用音频自定义播放。
3374
1610
 
3375
- 启用音频自定义播放后，SDK 将不再调用系统的音频接口播放数据，您需要通过 [getCustomAudioRenderingFrame](https://write.woa.com/document/87029900866228224) 获取 SDK 要播放的音频帧并自行播放。
3376
- <table>
3377
- <tr>
3378
- <td rowspan="1" colSpan="1" >参数</td>
3379
-
3380
- <td rowspan="1" colSpan="1" >描述</td>
3381
- </tr>
3382
-
3383
- <tr>
3384
- <td rowspan="1" colSpan="1" >enable</td>
3385
-
3386
- <td rowspan="1" colSpan="1" >是否启用音频自定义播放，默认为关闭状态。</td>
3387
- </tr>
3388
- </table>
3389
-
1611
+ 启用音频自定义播放后，SDK 将不再调用系统的音频接口播放数据，您需要通过 getCustomAudioRenderingFrame 获取 SDK 要播放的音频帧并自行播放。
1612
+ | 参数 | 描述 |
1613
+ | --- | --- |
1614
+ | enable | 是否启用音频自定义播放，默认为关闭状态。 |
3390
1615
 
3391
1616
  > **注意**
3392
- >
1617
+ >
3393
1618
 
3394
1619
  > 需要您在进入房间前设置才能生效，暂不支持进入房间后再设置。
3395
- >
3396
-
1620
+ >
3397
1621
 
3398
1622
  ## getCustomAudioRenderingFrame
3399
1623
 
3400
-
3401
-
3402
1624
  #### 获取可播放的音频数据。
3403
1625
 
3404
- 调用该接口之前，您需要先通过 [enableCustomAudioRendering](https://write.woa.com/document/87029900866228224) 开启音频自定义播放。
1626
+ 调用该接口之前，您需要先通过 enableCustomAudioRendering 开启音频自定义播放。
3405
1627
 
3406
-
3407
-
3408
- 参数 [TRTCAudioFrame](https://write.woa.com/document/87029993616093184) 推荐下列填写方式（其他字段不需要填写）：
1628
+ 参数 TRTCAudioFrame 推荐下列填写方式（其他字段不需要填写）：
3409
1629
  - sampleRate：采样率，必填，支持 16000、24000、32000、44100、48000。
3410
1630
 
3411
1631
  - channel：声道数，必填，单声道请填1，双声道请填2，双声道时数据是交叉的。
3412
1632
 
3413
1633
  - data：用于获取音频数据的 buffer。需要您根据一帧音频帧的帧长度分配好 data 的内存大小。获取的 PCM 数据支持 10ms 或 20ms 两种帧长，推荐使用 20ms 的帧长。
3414
1634
 
3415
-
3416
-
3417
-
3418
1635
  计算公式为：` 采样率 x 播放时长 x 声道数量 x 2（每个样点的字节数） `， 例如： 48000Hz 采样率、单声道、且播放时长为 20ms 的一帧音频帧的 buffer 大小为 ` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
3419
- <table>
3420
- <tr>
3421
- <td rowspan="1" colSpan="1" >参数</td>
3422
-
3423
- <td rowspan="1" colSpan="1" >描述</td>
3424
- </tr>
3425
-
3426
- <tr>
3427
- <td rowspan="1" colSpan="1" >audioFrame</td>
3428
-
3429
- <td rowspan="1" colSpan="1" >音频数据帧。</td>
3430
- </tr>
3431
- </table>
3432
-
1636
+ | 参数 | 描述 |
1637
+ | --- | --- |
1638
+ | audioFrame | 音频数据帧。 |
3433
1639
 
3434
1640
  > **注意**
3435
- >
1641
+ >
3436
1642
 
3437
1643
  > 1. 参数 audioFrame 中的 sampleRate、channel 需提前设置好，同时分配好所需读取帧长的 data 空间。
3438
- >
1644
+ >
3439
1645
 
3440
1646
  > 2. SDK 内部会根据 sampleRate 和 channel 自动填充 data 数据。
3441
- >
1647
+ >
3442
1648
 
3443
1649
  > 3. 建议由系统的音频播放线程直接驱动该函数的调用，在播放完一帧音频之后，即调用该接口获取下一帧可播放的音频数据。
3444
- >
3445
-
1650
+ >
3446
1651
 
3447
1652
  ## sendCustomCmdMsg
3448
1653
 
3449
-
3450
-
3451
1654
  #### 使用 UDP 通道发送自定义消息给房间内所有用户。
3452
1655
 
3453
1656
  该接口可以让您借助 TRTC 的 UDP 通道，向当前房间里的其他用户广播自定义数据，以达到传输信令的目的。
3454
1657
 
3455
- 房间中的其他用户可以通过 [TRTCCloudListener](https://write.woa.com/document/87029920275542016) 中的 onRecvCustomCmdMsg 回调接收消息。
3456
- <table>
3457
- <tr>
3458
- <td rowspan="1" colSpan="1" >参数</td>
3459
-
3460
- <td rowspan="1" colSpan="1" >描述</td>
3461
- </tr>
3462
-
3463
- <tr>
3464
- <td rowspan="1" colSpan="1" >cmdID</td>
3465
-
3466
- <td rowspan="1" colSpan="1" >消息 ID，取值范围为 [1, 10]。</td>
3467
- </tr>
3468
-
3469
- <tr>
3470
- <td rowspan="1" colSpan="1" >data</td>
3471
-
3472
- <td rowspan="1" colSpan="1" >待发送的消息，单个消息的最大长度被限制为 1KB。</td>
3473
- </tr>
3474
-
3475
- <tr>
3476
- <td rowspan="1" colSpan="1" >ordered</td>
3477
-
3478
- <td rowspan="1" colSpan="1" >是否要求有序，即是否要求接收端的数据包顺序和发送端的数据包顺序一致（这会带来一定的接收延时）。</td>
3479
- </tr>
3480
-
3481
- <tr>
3482
- <td rowspan="1" colSpan="1" >reliable</td>
3483
-
3484
- <td rowspan="1" colSpan="1" >是否可靠发送，可靠发送可以获得更高的发送成功率，但可靠发送比不可靠发送会带来更大的接收延迟。</td>
3485
- </tr>
3486
- </table>
3487
-
1658
+ 房间中的其他用户可以通过 TRTCCloudListener 中的 onRecvCustomCmdMsg 回调接收消息。
1659
+ | 参数 | 描述 |
1660
+ | --- | --- |
1661
+ | cmdID | 消息 ID，取值范围为 [1, 10]。 |
1662
+ | data | 待发送的消息，单个消息的最大长度被限制为 1KB。 |
1663
+ | ordered | 是否要求有序，即是否要求接收端的数据包顺序和发送端的数据包顺序一致（这会带来一定的接收延时）。 |
1664
+ | reliable | 是否可靠发送，可靠发送可以获得更高的发送成功率，但可靠发送比不可靠发送会带来更大的接收延迟。 |
3488
1665
 
3489
1666
  > **注意**
3490
- >
1667
+ >
3491
1668
 
3492
- > 1. 发送消息到房间内所有用户（暂时不支持 Web/小程序端），每秒最多能发送30条消息（与 [sendSEIMsg](https://write.woa.com/document/87029900866228224) 共享限制）。
3493
- >
1669
+ > 1. 发送消息到房间内所有用户（暂时不支持 Web/小程序端），每秒最多能发送30条消息（与 sendSEIMsg 共享限制）。
1670
+ >
3494
1671
 
3495
1672
  > 2. 每个包最大为 1KB，超过则很有可能会被中间路由器或者服务器丢弃。
3496
- >
1673
+ >
3497
1674
 
3498
- > 3. 每个客户端每秒最多能发送总计 16KB 数据（与 [sendSEIMsg](https://write.woa.com/document/87029900866228224) 共享限制）。
3499
- >
1675
+ > 3. 每个客户端每秒最多能发送总计 16KB 数据（与 sendSEIMsg 共享限制）。
1676
+ >
3500
1677
 
3501
1678
  > 4. 请将 ` reliable ` 和 ` ordered ` 同时设置为 true 或同时设置为 false，暂不支持交叉设置。
3502
- >
1679
+ >
3503
1680
 
3504
1681
  > 5. 强烈建议您将不同类型的消息设定为不同的 cmdID，这样可以在要求有序的情况下减小消息时延。
3505
- >
1682
+ >
3506
1683
 
3507
1684
  > 6. 目前仅支持主播身份。
3508
- >
3509
-
1685
+ >
3510
1686
 
3511
1687
  #### 返回值说明：
3512
1688
 
@@ -3514,67 +1690,44 @@ true：消息已经发出；false：消息发送失败。
3514
1690
 
3515
1691
  ## sendSEIMsg
3516
1692
 
3517
-
3518
-
3519
1693
  #### 使用 SEI 通道发送自定义消息给房间内所有用户。
3520
1694
 
3521
1695
  该接口可以让您借助 TRTC 的 SEI 通道，向当前房间里的其他用户广播自定义数据，已达到传输信令的目的。
3522
1696
 
3523
-
3524
-
3525
1697
  视频帧的头部有一个叫做 SEI 的头部数据块，该接口的原理就是利用这个被称为 SEI 的头部数据块，将您要发送的自定义信令嵌入其中，使其同视频帧一并发送出去。
3526
1698
 
3527
- 因此，与 [sendCustomCmdMsg](https://write.woa.com/document/87029900866228224) 相比，SEI 通道传输的信令具有更好的兼容性：信令可以伴随着视频帧一直传输到直播 CDN 上。
1699
+ 因此，与 sendCustomCmdMsg 相比，SEI 通道传输的信令具有更好的兼容性：信令可以伴随着视频帧一直传输到直播 CDN 上。
3528
1700
 
3529
1701
  不过，由于视频帧头部的数据块不能太大，建议您使用该接口时，尽量将信令控制在几个字节的大小。
3530
1702
 
3531
-
3532
-
3533
1703
  最常见的用法是把自定义的时间戳（timestamp）用本接口嵌入视频帧中，实现消息和画面的完美对齐（例如：教育场景下的课件和视频信号的对齐）。
3534
1704
 
3535
- 房间中的其他用户可以通过 [TRTCCloudListener](https://write.woa.com/document/87029920275542016) 中的 [onRecvSEIMsg](https://write.woa.com/document/87029920275542016) 回调接收消息。
3536
- <table>
3537
- <tr>
3538
- <td rowspan="1" colSpan="1" >参数</td>
3539
-
3540
- <td rowspan="1" colSpan="1" >描述</td>
3541
- </tr>
3542
-
3543
- <tr>
3544
- <td rowspan="1" colSpan="1" >data</td>
3545
-
3546
- <td rowspan="1" colSpan="1" >待发送的数据，最大支持 1KB（1000字节）的数据大小</td>
3547
- </tr>
3548
-
3549
- <tr>
3550
- <td rowspan="1" colSpan="1" >repeatCount</td>
3551
-
3552
- <td rowspan="1" colSpan="1" >发送数据次数</td>
3553
- </tr>
3554
- </table>
3555
-
1705
+ 房间中的其他用户可以通过 TRTCCloudListener 中的 onRecvSEIMsg 回调接收消息。
1706
+ | 参数 | 描述 |
1707
+ | --- | --- |
1708
+ | data | 待发送的数据，最大支持 1KB（1000字节）的数据大小 |
1709
+ | repeatCount | 发送数据次数 |
3556
1710
 
3557
1711
  > **注意**
3558
- >
1712
+ >
3559
1713
 
3560
1714
  > 本接口有以下限制：
3561
- >
1715
+ >
3562
1716
 
3563
1717
  > 1. 数据在接口调用完后不会被即时发送出去，而是从下一帧视频帧开始与视频帧一起发送。
3564
- >
3565
-
3566
- > 2. 发送消息到房间内所有用户，每秒最多能发送 40 条消息（与 [sendCustomCmdMsg](https://write.woa.com/document/87029900866228224) 共享限制）。
3567
- >
1718
+ >
3568
1719
 
3569
- > 3. 每个包最大为 1KB，若发送大量数据，会导致视频码率增大，可能导致视频画质下降甚至卡顿（与 [sendCustomCmdMsg](https://write.woa.com/document/87029900866228224) 共享限制）。
3570
- >
1720
+ > 2. 发送消息到房间内所有用户，每秒最多能发送 40 条消息（与 sendCustomCmdMsg 共享限制）。
1721
+ >
3571
1722
 
3572
- > 4. 每个客户端每秒最多能发送总计 16KB 数据（与 [sendCustomCmdMsg](https://write.woa.com/document/87029900866228224) 共享限制）。
3573
- >
1723
+ > 3. 每个包最大为 1KB，若发送大量数据，会导致视频码率增大，可能导致视频画质下降甚至卡顿（与 sendCustomCmdMsg 共享限制）。
1724
+ >
3574
1725
 
3575
- > 5. 若指定多次发送（repeatCount > 1），则数据会被带在后续的连续 repeatCount 个视频帧中发送出去，同样会导致视频码率增大。接收消息 [onRecvSEIMsg](https://write.woa.com/document/87029920275542016) 回调也可能会收到多次相同的消息，需要去重。
3576
- >
1726
+ > 4. 每个客户端每秒最多能发送总计 16KB 数据（与 sendCustomCmdMsg 共享限制）。
1727
+ >
3577
1728
 
1729
+ > 5. 若指定多次发送（repeatCount > 1），则数据会被带在后续的连续 repeatCount 个视频帧中发送出去，同样会导致视频码率增大。接收消息 onRecvSEIMsg 回调也可能会收到多次相同的消息，需要去重。
1730
+ >
3578
1731
 
3579
1732
  #### 返回值说明：
3580
1733
 
@@ -3582,36 +1735,22 @@ true：消息已通过限制，等待后续视频帧发送；false：消息被
3582
1735
 
3583
1736
  ## startSpeedTest
3584
1737
 
3585
-
3586
-
3587
1738
  #### 开始进行网速测试（进入房间前使用）。
3588
- <table>
3589
- <tr>
3590
- <td rowspan="1" colSpan="1" >参数</td>
3591
-
3592
- <td rowspan="1" colSpan="1" >描述</td>
3593
- </tr>
3594
-
3595
- <tr>
3596
- <td rowspan="1" colSpan="1" >params</td>
3597
-
3598
- <td rowspan="1" colSpan="1" >测速选项</td>
3599
- </tr>
3600
- </table>
3601
-
1739
+ | 参数 | 描述 |
1740
+ | --- | --- |
1741
+ | params | 测速选项 |
3602
1742
 
3603
1743
  > **注意**
3604
- >
1744
+ >
3605
1745
 
3606
1746
  > 1. 测速过程将产生少量的基础服务费用，详见 [计费概述 > 基础服务](https://cloud.tencent.com/document/product/647/17157#.E5.9F.BA.E7.A1.80.E6.9C.8D.E5.8A.A1) 文档说明。
3607
- >
1747
+ >
3608
1748
 
3609
1749
  > 2. 请在进入房间前进行网速测试，在房间中网速测试会影响正常的音视频传输效果，而且由于干扰过多，网速测试结果也不准确。
3610
- >
1750
+ >
3611
1751
 
3612
1752
  > 3. 同一时间只允许一项网速测试任务运行。
3613
- >
3614
-
1753
+ >
3615
1754
 
3616
1755
  #### 返回值说明：
3617
1756
 
@@ -3619,84 +1758,39 @@ true：消息已通过限制，等待后续视频帧发送；false：消息被
3619
1758
 
3620
1759
  ## stopSpeedTest
3621
1760
 
3622
-
3623
-
3624
1761
  #### 停止网络测速。
3625
1762
 
3626
1763
  ## getSDKVersion
3627
1764
 
3628
-
3629
-
3630
1765
  #### 获取 SDK 版本信息。
3631
1766
 
3632
1767
  ## setLogLevel
3633
1768
 
3634
-
3635
-
3636
1769
  #### 设置 Log 输出级别。
3637
- <table>
3638
- <tr>
3639
- <td rowspan="1" colSpan="1" >参数</td>
3640
-
3641
- <td rowspan="1" colSpan="1" >描述</td>
3642
- </tr>
3643
-
3644
- <tr>
3645
- <td rowspan="1" colSpan="1" >level</td>
3646
-
3647
- <td rowspan="1" colSpan="1" >参见 [TRTCLogLevel](https://write.woa.com/document/87029993616093184)，默认值：[TRTC_LOG_LEVEL_NULL](https://write.woa.com/document/87029993616093184)</td>
3648
- </tr>
3649
- </table>
3650
-
1770
+ | 参数 | 描述 |
1771
+ | --- | --- |
1772
+ | level | 参见 TRTCLogLevel，默认值：TRTC_LOG_LEVEL_NULL |
3651
1773
 
3652
1774
  ## setConsoleEnabled
3653
1775
 
3654
-
3655
-
3656
1776
  #### 启用/禁用控制台日志打印。
3657
- <table>
3658
- <tr>
3659
- <td rowspan="1" colSpan="1" >参数</td>
3660
-
3661
- <td rowspan="1" colSpan="1" >描述</td>
3662
- </tr>
3663
-
3664
- <tr>
3665
- <td rowspan="1" colSpan="1" >enabled</td>
3666
-
3667
- <td rowspan="1" colSpan="1" >指定是否启用，默认：禁止状态。</td>
3668
- </tr>
3669
- </table>
3670
-
1777
+ | 参数 | 描述 |
1778
+ | --- | --- |
1779
+ | enabled | 指定是否启用，默认：禁止状态。 |
3671
1780
 
3672
1781
  ## setLogCompressEnabled
3673
1782
 
3674
-
3675
-
3676
1783
  #### 启用/禁用日志的本地压缩。
3677
1784
 
3678
1785
  开启压缩后，Log 存储体积明显减小，但需要腾讯云提供的 Python 脚本解压后才能阅读。
3679
1786
 
3680
1787
  禁用压缩后，Log 采用明文存储，可以直接用记事本打开阅读，但占用空间较大。
3681
- <table>
3682
- <tr>
3683
- <td rowspan="1" colSpan="1" >参数</td>
3684
-
3685
- <td rowspan="1" colSpan="1" >描述</td>
3686
- </tr>
3687
-
3688
- <tr>
3689
- <td rowspan="1" colSpan="1" >enabled</td>
3690
-
3691
- <td rowspan="1" colSpan="1" >指定是否启用，默认为启动状态</td>
3692
- </tr>
3693
- </table>
3694
-
1788
+ | 参数 | 描述 |
1789
+ | --- | --- |
1790
+ | enabled | 指定是否启用，默认为启动状态 |
3695
1791
 
3696
1792
  ## setLogDirPath
3697
1793
 
3698
-
3699
-
3700
1794
  #### 设置本地日志的保存路径。
3701
1795
 
3702
1796
  通过该接口您可以更改 SDK 本地日志的默认存储路径，SDK 默认的本地日志的存储位置：
@@ -3706,127 +1800,59 @@ true：消息已通过限制，等待后续视频帧发送；false：消息被
3706
1800
 
3707
1801
  - Android 平台：在 /app私有目录/files/log/liteav/ 下。
3708
1802
 
3709
- <table>
3710
- <tr>
3711
- <td rowspan="1" colSpan="1" >参数</td>
3712
-
3713
- <td rowspan="1" colSpan="1" >描述</td>
3714
- </tr>
3715
-
3716
- <tr>
3717
- <td rowspan="1" colSpan="1" >path</td>
3718
-
3719
- <td rowspan="1" colSpan="1" >存储日志的路径</td>
3720
- </tr>
3721
- </table>
3722
-
1803
+ | 参数 | 描述 |
1804
+ | --- | --- |
1805
+ | path | 存储日志的路径 |
3723
1806
 
3724
1807
  > **注意**
3725
- >
1808
+ >
3726
1809
 
3727
1810
  > 请务必在所有其他接口之前调用，并且保证您指定的目录是存在的，并且您的应用程序拥有对该目录的读写权限。
3728
- >
3729
-
1811
+ >
3730
1812
 
3731
1813
  ## setLogListener
3732
1814
 
3733
-
3734
-
3735
1815
  #### 设置日志回调。
3736
1816
 
3737
1817
  ## showDebugView
3738
1818
 
3739
-
3740
-
3741
1819
  #### 显示仪表盘。
3742
1820
 
3743
1821
  “仪表盘”是位于视频渲染控件之上的一个半透明的调试信息浮层，用于展示音视频信息和事件信息，便于对接和调试。
3744
- <table>
3745
- <tr>
3746
- <td rowspan="1" colSpan="1" >参数</td>
3747
-
3748
- <td rowspan="1" colSpan="1" >描述</td>
3749
- </tr>
3750
-
3751
- <tr>
3752
- <td rowspan="1" colSpan="1" >showType</td>
3753
-
3754
- <td rowspan="1" colSpan="1" >0：不显示；1：显示精简版（仅显示音视频信息）；2：显示完整版（包含音视频信息和事件信息）。</td>
3755
- </tr>
3756
- </table>
3757
-
1822
+ | 参数 | 描述 |
1823
+ | --- | --- |
1824
+ | showType | 0：不显示；1：显示精简版（仅显示音视频信息）；2：显示完整版（包含音视频信息和事件信息）。 |
3758
1825
 
3759
1826
  ## TRTCViewMargin
3760
1827
 
3761
-
3762
-
3763
1828
  #### 设置仪表盘的边距。
3764
1829
 
3765
- 用于调整仪表盘在视频渲染控件中的位置，必须在 [showDebugView](https://write.woa.com/document/87029900866228224) 之前调用才能生效。
3766
- <table>
3767
- <tr>
3768
- <td rowspan="1" colSpan="1" >参数</td>
3769
-
3770
- <td rowspan="1" colSpan="1" >描述</td>
3771
- </tr>
3772
-
3773
- <tr>
3774
- <td rowspan="1" colSpan="1" >margin</td>
3775
-
3776
- <td rowspan="1" colSpan="1" >仪表盘内边距，注意这里是基于 parentView 的百分比，` margin ` 的取值范围是 [0, 1]。</td>
3777
- </tr>
3778
-
3779
- <tr>
3780
- <td rowspan="1" colSpan="1" >userId</td>
3781
-
3782
- <td rowspan="1" colSpan="1" >用户 ID。</td>
3783
- </tr>
3784
- </table>
3785
-
1830
+ 用于调整仪表盘在视频渲染控件中的位置，必须在 showDebugView 之前调用才能生效。
1831
+ | 参数 | 描述 |
1832
+ | --- | --- |
1833
+ | margin | 仪表盘内边距，注意这里是基于 parentView 的百分比，` margin ` 的取值范围是 [0, 1]。 |
1834
+ | userId | 用户 ID。 |
3786
1835
 
3787
1836
  ## callExperimentalAPI
3788
1837
 
3789
-
3790
-
3791
1838
  #### 调用实验性接口。
3792
1839
 
3793
1840
  ## enablePayloadPrivateEncryption
3794
1841
 
3795
-
3796
-
3797
1842
  #### 开启或关闭媒体流私有加密。
3798
1843
 
3799
1844
  在安全要求较高的场景下，TRTC 建议您在加入房间前，调用 ` enablePayloadPrivateEncryption ` 方法开启媒体流私有加密。
3800
1845
 
3801
1846
  用户退出房间后，SDK 会自动关闭私有加密。如需重新开启私有加密，您需要在用户再次加入房间前调用该方法。
3802
- <table>
3803
- <tr>
3804
- <td rowspan="1" colSpan="1" >参数</td>
3805
-
3806
- <td rowspan="1" colSpan="1" >描述</td>
3807
- </tr>
3808
-
3809
- <tr>
3810
- <td rowspan="1" colSpan="1" >config</td>
3811
-
3812
- <td rowspan="1" colSpan="1" >配置媒体流私有加密的算法和密钥，参见 [TRTCPayloadPrivateEncryptionConfig](https://write.woa.com/document/87029993616093184)。</td>
3813
- </tr>
3814
-
3815
- <tr>
3816
- <td rowspan="1" colSpan="1" >enabled</td>
3817
-
3818
- <td rowspan="1" colSpan="1" >是否开启媒体流私有加密。</td>
3819
- </tr>
3820
- </table>
3821
-
1847
+ | 参数 | 描述 |
1848
+ | --- | --- |
1849
+ | config | 配置媒体流私有加密的算法和密钥，参见 TRTCPayloadPrivateEncryptionConfig。 |
1850
+ | enabled | 是否开启媒体流私有加密。 |
3822
1851
 
3823
1852
  > **注意**
3824
- >
1853
+ >
3825
1854
 
3826
1855
  > TRTC 已经内置对媒体流进行加密后再传输，启用媒体流私有加密后将使用您传入的密匙与初始向量进行再次加密。
3827
- >
3828
-
1856
+ >
3829
1857
 
3830
1858
  #### 返回值说明：
3831
-
3832
- 接口调用结果，0: 方法调用成功， -1: 传入参数无效， -2: 功能已过期。若需解锁：请前往购买 [TRTC 旗舰版（国内站）/ 专业版（国际站）套餐](https://buy.cloud.tencent.com/trtc?tab=uikit&type=call&pkg=top)，并[联系我们](https://console.cloud.tencent.com/workorder/category?from=connect-us)审核后使用。