@tencentcloud/sdk-mcp 1.3.8 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (503) 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/react/faq.md → callkit/faq/web-faq.md} +78 -311
  9. package/resource/doc/callkit/preset/android/api.md +330 -0
  10. package/resource/doc/callkit/preset/android/integration.md +530 -0
  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/chatkit/android/integration.md +498 -0
  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/core-sdk/live/flutter/live-integration.md +687 -0
  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/core-sdk/voice/android/voice-audience-list.md +264 -0
  134. package/resource/doc/livekit/core-sdk/voice/android/voice-audio-effect.md +226 -0
  135. package/resource/doc/livekit/core-sdk/voice/android/voice-barrage.md +456 -0
  136. package/resource/doc/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +539 -0
  137. package/resource/doc/livekit/core-sdk/voice/android/voice-gift.md +453 -0
  138. package/resource/doc/livekit/core-sdk/voice/android/voice-host-interaction.md +516 -0
  139. package/resource/doc/livekit/core-sdk/voice/android/voice-integration.md +509 -0
  140. package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +365 -0
  141. package/resource/doc/livekit/core-sdk/voice/flutter/voice-audience-list.md +259 -0
  142. package/resource/doc/livekit/core-sdk/voice/flutter/voice-audio-effect.md +596 -0
  143. package/resource/doc/livekit/core-sdk/voice/flutter/voice-barrage.md +494 -0
  144. package/resource/doc/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +516 -0
  145. package/resource/doc/livekit/core-sdk/voice/flutter/voice-gift.md +418 -0
  146. package/resource/doc/livekit/core-sdk/voice/flutter/voice-integration.md +563 -0
  147. package/resource/doc/livekit/core-sdk/voice/flutter/voice-room-list.md +709 -0
  148. package/resource/doc/livekit/core-sdk/voice/ios/voice-audience-list.md +262 -0
  149. package/resource/doc/livekit/core-sdk/voice/ios/voice-audio-effect.md +211 -0
  150. package/resource/doc/livekit/core-sdk/voice/ios/voice-barrage.md +414 -0
  151. package/resource/doc/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +492 -0
  152. package/resource/doc/livekit/core-sdk/voice/ios/voice-gift.md +405 -0
  153. package/resource/doc/livekit/core-sdk/voice/ios/voice-host-interaction.md +611 -0
  154. package/resource/doc/livekit/core-sdk/voice/ios/voice-integration.md +478 -0
  155. package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +336 -0
  156. package/resource/doc/livekit/core-sdk/voice/uni-app/voice-audience-list.md +234 -0
  157. package/resource/doc/livekit/core-sdk/voice/uni-app/voice-audio-effect.md +218 -0
  158. package/resource/doc/livekit/core-sdk/voice/uni-app/voice-barrage.md +376 -0
  159. package/resource/doc/livekit/core-sdk/voice/uni-app/voice-co-guest-interaction.md +648 -0
  160. package/resource/doc/livekit/core-sdk/voice/uni-app/voice-gift.md +362 -0
  161. package/resource/doc/livekit/core-sdk/voice/uni-app/voice-integration.md +323 -0
  162. package/resource/doc/livekit/core-sdk/voice/uni-app/voice-room-list.md +470 -0
  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 +118 -282
  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 -18
  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 -19
  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 -30
  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 -59
  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/integration.md +0 -612
  346. package/resource/doc/chatuikit/android/workflow.md +0 -0
  347. package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1376
  348. package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -860
  349. package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1371
  350. package/resource/doc/chatuikit/flutter/workflow.md +0 -816
  351. package/resource/doc/chatuikit/iOS/workflow.md +0 -0
  352. package/resource/doc/chatuikit/react/components/conversation-list.md +0 -765
  353. package/resource/doc/chatuikit/react/components/search.md +0 -885
  354. package/resource/doc/chatuikit/react/create-group.md +0 -22
  355. package/resource/doc/chatuikit/react/init.md +0 -25
  356. package/resource/doc/chatuikit/react/workflow.md +0 -254
  357. package/resource/doc/chatuikit/uniapp-app/faq.md +0 -0
  358. package/resource/doc/chatuikit/uniapp-app/integration.md +0 -619
  359. package/resource/doc/chatuikit/uniapp-app/workflow.md +0 -576
  360. package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
  361. package/resource/doc/chatuikit/vue/components/tuikit.md +0 -110
  362. package/resource/doc/chatuikit/vue/create-group.md +0 -26
  363. package/resource/doc/chatuikit/vue/init.md +0 -35
  364. package/resource/doc/chatuikit/vue/workflow.md +0 -395
  365. package/resource/doc/livekit/live/android/workflow.md +0 -322
  366. package/resource/doc/livekit/live/flutter/live-integration.md +0 -1029
  367. package/resource/doc/livekit/live/flutter/workflow.md +0 -353
  368. package/resource/doc/livekit/live/ios/workflow.md +0 -352
  369. package/resource/doc/livekit/live/vue/components/barrage.md +0 -615
  370. package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -442
  371. package/resource/doc/livekit/live/vue/faq.md +0 -0
  372. package/resource/doc/livekit/live/vue/live-list-integration.md +0 -195
  373. package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -293
  374. package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -381
  375. package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -598
  376. package/resource/doc/livekit/live/vue/states/live-state.md +0 -2656
  377. package/resource/doc/livekit/live/vue/workflow.md +0 -219
  378. package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -334
  379. package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -434
  380. package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -685
  381. package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -712
  382. package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -284
  383. package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
  384. package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
  385. package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
  386. package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
  387. package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -879
  388. package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -668
  389. package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -456
  390. package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -332
  391. package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
  392. package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -328
  393. package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -505
  394. package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
  395. package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -676
  396. package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
  397. package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -820
  398. package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1065
  399. package/resource/doc/roomkit/vue/features/workflow.md +0 -553
  400. package/resource/doc/roomkit/vue/workflow.md +0 -487
  401. package/resource/doc/tuicallkit/android/integration.md +0 -302
  402. package/resource/doc/tuicallkit/android/workflow.md +0 -0
  403. package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -786
  404. package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -663
  405. package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -932
  406. package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -926
  407. package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -452
  408. package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -779
  409. package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -635
  410. package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
  411. package/resource/doc/tuicallkit/react/api.md +0 -1512
  412. package/resource/doc/tuicallkit/vue/api.md +0 -1512
  413. package/resource/doc/tuicallkit/vue/faq.md +0 -986
  414. package/tools/call/get-native-call-integration.js +0 -43
  415. package/tools/call/get-native-call-integration.js.map +0 -1
  416. package/tools/call/get-web-call-api.js +0 -27
  417. package/tools/call/get-web-call-api.js.map +0 -1
  418. package/tools/call/get-web-call-integration.js.map +0 -1
  419. package/tools/chat/get-native-chat-feature-detail.js +0 -30
  420. package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
  421. package/tools/chat/get-native-chat-integration.js +0 -45
  422. package/tools/chat/get-native-chat-integration.js.map +0 -1
  423. package/tools/chat/get-web-chat-component-detail.js +0 -31
  424. package/tools/chat/get-web-chat-component-detail.js.map +0 -1
  425. package/tools/chat/get-web-chat-integration.js +0 -45
  426. package/tools/chat/get-web-chat-integration.js.map +0 -1
  427. package/tools/chat/get-web-chat-uikit-init.js +0 -28
  428. package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
  429. package/tools/chat/get-web-create-group-doc.js +0 -28
  430. package/tools/chat/get-web-create-group-doc.js.map +0 -1
  431. package/tools/common/get-faq.js +0 -91
  432. package/tools/common/get-faq.js.map +0 -1
  433. package/tools/common/get-usersig.js.map +0 -1
  434. package/tools/common/present-framework-choice.js +0 -16
  435. package/tools/common/present-framework-choice.js.map +0 -1
  436. package/tools/common/record-prompt.js +0 -55
  437. package/tools/common/record-prompt.js.map +0 -1
  438. package/tools/common/record-result.js +0 -60
  439. package/tools/common/record-result.js.map +0 -1
  440. package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
  441. package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
  442. package/tools/definitions/get_native_live_api_def.js +0 -22
  443. package/tools/definitions/get_native_live_api_def.js.map +0 -1
  444. package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -109
  445. package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
  446. package/tools/definitions/get_native_live_uikit_integration_def.js +0 -50
  447. package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
  448. package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -115
  449. package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
  450. package/tools/definitions/get_trtc_native_api_def.js +0 -17
  451. package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
  452. package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
  453. package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
  454. package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
  455. package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
  456. package/tools/definitions/get_web_create_group_doc_def.js +0 -18
  457. package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
  458. package/tools/definitions/get_web_live_state_detail_def.js +0 -19
  459. package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
  460. package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
  461. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
  462. package/tools/definitions/get_web_room_feature_detail_def.js +0 -95
  463. package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
  464. package/tools/definitions/record_prompt_def.js +0 -53
  465. package/tools/definitions/record_prompt_def.js.map +0 -1
  466. package/tools/definitions/record_result_def.js +0 -30
  467. package/tools/definitions/record_result_def.js.map +0 -1
  468. package/tools/live/get-native-live-uikit-integration.js +0 -101
  469. package/tools/live/get-native-live-uikit-integration.js.map +0 -1
  470. package/tools/live/get-web-live-component-detail.js +0 -31
  471. package/tools/live/get-web-live-component-detail.js.map +0 -1
  472. package/tools/live/get-web-live-state-detail.js +0 -31
  473. package/tools/live/get-web-live-state-detail.js.map +0 -1
  474. package/tools/live/get-web-live-uikit-integration.js +0 -52
  475. package/tools/live/get-web-live-uikit-integration.js.map +0 -1
  476. package/tools/live/get_native_live_uikit_extra_features.js +0 -105
  477. package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
  478. package/tools/live/get_native_live_uikit_interaction.js +0 -101
  479. package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
  480. package/tools/native_live/get-native-live-api.js +0 -31
  481. package/tools/native_live/get-native-live-api.js.map +0 -1
  482. package/tools/room/get-web-room-feature-detail.js.map +0 -1
  483. package/tools/room/get-web-room-integration.js.map +0 -1
  484. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
  485. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
  486. package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
  487. package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
  488. package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
  489. package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
  490. package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
  491. package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
  492. package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
  493. package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
  494. package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
  495. package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
  496. package/tools/trtc/get-trtc-native-api.js +0 -31
  497. package/tools/trtc/get-trtc-native-api.js.map +0 -1
  498. package/utils/handle-component-name.js +0 -33
  499. package/utils/handle-component-name.js.map +0 -1
  500. /package/resource/doc/{rtcengine/web → callkit/core-sdk}/.gitkeep +0 -0
  501. /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
  502. /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
  503. /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
package/resource/doc/trtc/C++/TRTCCloudCallback.md CHANGED
@@ -3,2445 +3,943 @@
3
3
  ## 概述
4
4
  `TRTCCloudCallback.h` 是腾讯云实时音视频(TRTC SDK ) C++ 的事件回调接口文档。
5
5
 
6
-
7
6
  ## ITRTCCloudCallback
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" >[onError](https://write.woa.com/document/87030021158866944)</td>
17
-
18
- <td rowspan="1" colSpan="1" >错误事件回调。</td>
19
- </tr>
20
-
21
- <tr>
22
- <td rowspan="1" colSpan="1" >[onWarning](https://write.woa.com/document/87030021158866944)</td>
23
-
24
- <td rowspan="1" colSpan="1" >警告事件回调。</td>
25
- </tr>
26
-
27
- <tr>
28
- <td rowspan="1" colSpan="1" >[onEnterRoom](https://write.woa.com/document/87030021158866944)</td>
29
-
30
- <td rowspan="1" colSpan="1" >进入房间成功与否的事件回调。</td>
31
- </tr>
32
-
33
- <tr>
34
- <td rowspan="1" colSpan="1" >[onExitRoom](https://write.woa.com/document/87030021158866944)</td>
35
-
36
- <td rowspan="1" colSpan="1" >离开房间的事件回调。</td>
37
- </tr>
38
-
39
- <tr>
40
- <td rowspan="1" colSpan="1" >[onSwitchRole](https://write.woa.com/document/87030021158866944)</td>
41
-
42
- <td rowspan="1" colSpan="1" >切换角色的事件回调。</td>
43
- </tr>
44
-
45
- <tr>
46
- <td rowspan="1" colSpan="1" >[onSwitchRoom](https://write.woa.com/document/87030021158866944)</td>
47
-
48
- <td rowspan="1" colSpan="1" >切换房间的结果回调。</td>
49
- </tr>
50
-
51
- <tr>
52
- <td rowspan="1" colSpan="1" >[onConnectOtherRoom](https://write.woa.com/document/87030021158866944)</td>
53
-
54
- <td rowspan="1" colSpan="1" >请求跨房通话的结果回调。</td>
55
- </tr>
56
-
57
- <tr>
58
- <td rowspan="1" colSpan="1" >[onDisconnectOtherRoom](https://write.woa.com/document/87030021158866944)</td>
59
-
60
- <td rowspan="1" colSpan="1" >结束跨房通话的结果回调。</td>
61
- </tr>
62
-
63
- <tr>
64
- <td rowspan="1" colSpan="1" >[onUpdateOtherRoomForwardMode](https://write.woa.com/document/87030021158866944)</td>
65
-
66
- <td rowspan="1" colSpan="1" >更改跨房主播上行能力的结果回调。</td>
67
- </tr>
68
-
69
- <tr>
70
- <td rowspan="1" colSpan="1" >[onRemoteUserEnterRoom](https://write.woa.com/document/87030021158866944)</td>
71
-
72
- <td rowspan="1" colSpan="1" >有用户加入当前房间。</td>
73
- </tr>
74
-
75
- <tr>
76
- <td rowspan="1" colSpan="1" >[onRemoteUserLeaveRoom](https://write.woa.com/document/87030021158866944)</td>
77
-
78
- <td rowspan="1" colSpan="1" >有用户离开当前房间。</td>
79
- </tr>
80
-
81
- <tr>
82
- <td rowspan="1" colSpan="1" >[onUserVideoAvailable](https://write.woa.com/document/87030021158866944)</td>
83
-
84
- <td rowspan="1" colSpan="1" >某远端用户发布/取消了主路视频画面。</td>
85
- </tr>
86
-
87
- <tr>
88
- <td rowspan="1" colSpan="1" >[onUserSubStreamAvailable](https://write.woa.com/document/87030021158866944)</td>
89
-
90
- <td rowspan="1" colSpan="1" >某远端用户发布/取消了辅路视频画面。</td>
91
- </tr>
92
-
93
- <tr>
94
- <td rowspan="1" colSpan="1" >[onUserAudioAvailable](https://write.woa.com/document/87030021158866944)</td>
95
-
96
- <td rowspan="1" colSpan="1" >某远端用户发布/取消了自己的音频。</td>
97
- </tr>
98
-
99
- <tr>
100
- <td rowspan="1" colSpan="1" >[onFirstVideoFrame](https://write.woa.com/document/87030021158866944)</td>
101
-
102
- <td rowspan="1" colSpan="1" >SDK 开始渲染自己本地或远端用户的首帧画面。</td>
103
- </tr>
104
-
105
- <tr>
106
- <td rowspan="1" colSpan="1" >[onFirstAudioFrame](https://write.woa.com/document/87030021158866944)</td>
107
-
108
- <td rowspan="1" colSpan="1" >SDK 开始播放远端用户的首帧音频。</td>
109
- </tr>
110
-
111
- <tr>
112
- <td rowspan="1" colSpan="1" >[onSendFirstLocalVideoFrame](https://write.woa.com/document/87030021158866944)</td>
113
-
114
- <td rowspan="1" colSpan="1" >自己本地的首个视频帧已被发布出去。</td>
115
- </tr>
116
-
117
- <tr>
118
- <td rowspan="1" colSpan="1" >[onSendFirstLocalAudioFrame](https://write.woa.com/document/87030021158866944)</td>
119
-
120
- <td rowspan="1" colSpan="1" >自己本地的首个音频帧已被发布出去。</td>
121
- </tr>
122
-
123
- <tr>
124
- <td rowspan="1" colSpan="1" >[onRemoteVideoStatusUpdated](https://write.woa.com/document/87030021158866944)</td>
125
-
126
- <td rowspan="1" colSpan="1" >远端视频状态变化的事件回调。</td>
127
- </tr>
128
-
129
- <tr>
130
- <td rowspan="1" colSpan="1" >[onRemoteAudioStatusUpdated](https://write.woa.com/document/87030021158866944)</td>
131
-
132
- <td rowspan="1" colSpan="1" >远端音频状态变化的事件回调。</td>
133
- </tr>
134
-
135
- <tr>
136
- <td rowspan="1" colSpan="1" >[onUserVideoSizeChanged](https://write.woa.com/document/87030021158866944)</td>
137
-
138
- <td rowspan="1" colSpan="1" >用户视频大小发生改变回调。</td>
139
- </tr>
140
-
141
- <tr>
142
- <td rowspan="1" colSpan="1" >[onNetworkQuality](https://write.woa.com/document/87030021158866944)</td>
143
-
144
- <td rowspan="1" colSpan="1" >网络质量的实时统计回调。</td>
145
- </tr>
146
-
147
- <tr>
148
- <td rowspan="1" colSpan="1" >[onStatistics](https://write.woa.com/document/87030021158866944)</td>
149
-
150
- <td rowspan="1" colSpan="1" >音视频技术指标的实时统计回调。</td>
151
- </tr>
152
-
153
- <tr>
154
- <td rowspan="1" colSpan="1" >[onSpeedTestResult](https://write.woa.com/document/87030021158866944)</td>
155
-
156
- <td rowspan="1" colSpan="1" >网速测试的结果回调。</td>
157
- </tr>
158
-
159
- <tr>
160
- <td rowspan="1" colSpan="1" >[onConnectionLost](https://write.woa.com/document/87030021158866944)</td>
161
-
162
- <td rowspan="1" colSpan="1" >SDK 与云端的连接已经断开。</td>
163
- </tr>
164
-
165
- <tr>
166
- <td rowspan="1" colSpan="1" >[onTryToReconnect](https://write.woa.com/document/87030021158866944)</td>
167
-
168
- <td rowspan="1" colSpan="1" >SDK 正在尝试重新连接到云端。</td>
169
- </tr>
170
-
171
- <tr>
172
- <td rowspan="1" colSpan="1" >[onConnectionRecovery](https://write.woa.com/document/87030021158866944)</td>
173
-
174
- <td rowspan="1" colSpan="1" >SDK 与云端的连接已经恢复。</td>
175
- </tr>
176
-
177
- <tr>
178
- <td rowspan="1" colSpan="1" >[onCameraDidReady](https://write.woa.com/document/87030021158866944)</td>
179
-
180
- <td rowspan="1" colSpan="1" >摄像头准备就绪。</td>
181
- </tr>
182
-
183
- <tr>
184
- <td rowspan="1" colSpan="1" >[onMicDidReady](https://write.woa.com/document/87030021158866944)</td>
185
-
186
- <td rowspan="1" colSpan="1" >麦克风准备就绪。</td>
187
- </tr>
188
-
189
- <tr>
190
- <td rowspan="1" colSpan="1" >[onAudioRouteChanged](https://write.woa.com/document/87030021158866944)</td>
191
-
192
- <td rowspan="1" colSpan="1" >当前音频路由发生变化（仅适用于移动设备）。</td>
193
- </tr>
194
-
195
- <tr>
196
- <td rowspan="1" colSpan="1" >[onUserVoiceVolume](https://write.woa.com/document/87030021158866944)</td>
197
-
198
- <td rowspan="1" colSpan="1" >音量大小的反馈回调。</td>
199
- </tr>
200
-
201
- <tr>
202
- <td rowspan="1" colSpan="1" >[onDeviceChange](https://write.woa.com/document/87030021158866944)</td>
203
-
204
- <td rowspan="1" colSpan="1" >本地设备的通断状态发生变化（仅适用于桌面系统）。</td>
205
- </tr>
206
-
207
- <tr>
208
- <td rowspan="1" colSpan="1" >[onAudioDeviceCaptureVolumeChanged](https://write.woa.com/document/87030021158866944)</td>
209
-
210
- <td rowspan="1" colSpan="1" >当前麦克风的系统采集音量发生变化。</td>
211
- </tr>
212
-
213
- <tr>
214
- <td rowspan="1" colSpan="1" >[onAudioDevicePlayoutVolumeChanged](https://write.woa.com/document/87030021158866944)</td>
215
-
216
- <td rowspan="1" colSpan="1" >当前系统的播放音量发生变化。</td>
217
- </tr>
218
-
219
- <tr>
220
- <td rowspan="1" colSpan="1" >[onSystemAudioLoopbackError](https://write.woa.com/document/87030021158866944)</td>
221
-
222
- <td rowspan="1" colSpan="1" >系统声音采集是否被成功开启的事件回调（仅适用于桌面系统）。</td>
223
- </tr>
224
-
225
- <tr>
226
- <td rowspan="1" colSpan="1" >[onTestMicVolume](https://write.woa.com/document/87030021158866944)</td>
227
-
228
- <td rowspan="1" colSpan="1" >测试麦克风时的音量回调。</td>
229
- </tr>
230
-
231
- <tr>
232
- <td rowspan="1" colSpan="1" >[onTestSpeakerVolume](https://write.woa.com/document/87030021158866944)</td>
233
-
234
- <td rowspan="1" colSpan="1" >测试扬声器时的音量回调。</td>
235
- </tr>
236
-
237
- <tr>
238
- <td rowspan="1" colSpan="1" >[onRecvCustomCmdMsg](https://write.woa.com/document/87030021158866944)</td>
239
-
240
- <td rowspan="1" colSpan="1" >收到自定义消息的事件回调。</td>
241
- </tr>
242
-
243
- <tr>
244
- <td rowspan="1" colSpan="1" >[onMissCustomCmdMsg](https://write.woa.com/document/87030021158866944)</td>
245
-
246
- <td rowspan="1" colSpan="1" >自定义消息丢失的事件回调。</td>
247
- </tr>
248
-
249
- <tr>
250
- <td rowspan="1" colSpan="1" >[onRecvSEIMsg](https://write.woa.com/document/87030021158866944)</td>
251
-
252
- <td rowspan="1" colSpan="1" >收到 SEI 消息的回调。</td>
253
- </tr>
254
-
255
- <tr>
256
- <td rowspan="1" colSpan="1" >[onStartPublishing](https://write.woa.com/document/87030021158866944)</td>
257
-
258
- <td rowspan="1" colSpan="1" >开始向腾讯云直播 CDN 上发布音视频流的事件回调。</td>
259
- </tr>
260
-
261
- <tr>
262
- <td rowspan="1" colSpan="1" >[onStopPublishing](https://write.woa.com/document/87030021158866944)</td>
263
-
264
- <td rowspan="1" colSpan="1" >停止向腾讯云直播 CDN 上发布音视频流的事件回调。</td>
265
- </tr>
266
-
267
- <tr>
268
- <td rowspan="1" colSpan="1" >[onStartPublishCDNStream](https://write.woa.com/document/87030021158866944)</td>
269
-
270
- <td rowspan="1" colSpan="1" >开始向非腾讯云 CDN 上发布音视频流的事件回调。</td>
271
- </tr>
272
-
273
- <tr>
274
- <td rowspan="1" colSpan="1" >[onStopPublishCDNStream](https://write.woa.com/document/87030021158866944)</td>
275
-
276
- <td rowspan="1" colSpan="1" >停止向非腾讯云 CDN 上发布音视频流的事件回调。</td>
277
- </tr>
278
-
279
- <tr>
280
- <td rowspan="1" colSpan="1" >[onSetMixTranscodingConfig](https://write.woa.com/document/87030021158866944)</td>
281
-
282
- <td rowspan="1" colSpan="1" >设置云端混流的排版布局和转码参数的事件回调。</td>
283
- </tr>
284
-
285
- <tr>
286
- <td rowspan="1" colSpan="1" >[onStartPublishMediaStream](https://write.woa.com/document/87030021158866944)</td>
287
-
288
- <td rowspan="1" colSpan="1" >开始发布媒体流的事件回调。</td>
289
- </tr>
290
-
291
- <tr>
292
- <td rowspan="1" colSpan="1" >[onUpdatePublishMediaStream](https://write.woa.com/document/87030021158866944)</td>
293
-
294
- <td rowspan="1" colSpan="1" >更新媒体流的事件回调。</td>
295
- </tr>
296
-
297
- <tr>
298
- <td rowspan="1" colSpan="1" >[onStopPublishMediaStream](https://write.woa.com/document/87030021158866944)</td>
299
-
300
- <td rowspan="1" colSpan="1" >停止媒体流的事件回调。</td>
301
- </tr>
302
-
303
- <tr>
304
- <td rowspan="1" colSpan="1" >[onCdnStreamStateChanged](https://write.woa.com/document/87030021158866944)</td>
305
-
306
- <td rowspan="1" colSpan="1" >RTMP/RTMPS 推流状态发生改变回调。</td>
307
- </tr>
308
-
309
- <tr>
310
- <td rowspan="1" colSpan="1" >[onScreenCaptureStarted](https://write.woa.com/document/87030021158866944)</td>
311
-
312
- <td rowspan="1" colSpan="1" >屏幕分享开启的事件回调。</td>
313
- </tr>
314
-
315
- <tr>
316
- <td rowspan="1" colSpan="1" >[onScreenCapturePaused](https://write.woa.com/document/87030021158866944)</td>
317
-
318
- <td rowspan="1" colSpan="1" >屏幕分享暂停的事件回调。</td>
319
- </tr>
320
-
321
- <tr>
322
- <td rowspan="1" colSpan="1" >[onScreenCaptureResumed](https://write.woa.com/document/87030021158866944)</td>
323
-
324
- <td rowspan="1" colSpan="1" >屏幕分享恢复的事件回调。</td>
325
- </tr>
326
-
327
- <tr>
328
- <td rowspan="1" colSpan="1" >[onScreenCaptureStoped](https://write.woa.com/document/87030021158866944)</td>
329
-
330
- <td rowspan="1" colSpan="1" >屏幕分享停止的事件回调。</td>
331
- </tr>
332
-
333
- <tr>
334
- <td rowspan="1" colSpan="1" >[onScreenCaptureCovered](https://write.woa.com/document/87030021158866944)</td>
335
-
336
- <td rowspan="1" colSpan="1" >屏幕分享的目标窗口被遮挡的事件回调（仅适用于 Windows 操作系统）。</td>
337
- </tr>
338
-
339
- <tr>
340
- <td rowspan="1" colSpan="1" >[onLocalRecordBegin](https://write.woa.com/document/87030021158866944)</td>
341
-
342
- <td rowspan="1" colSpan="1" >本地录制任务已经开始的事件回调。</td>
343
- </tr>
344
-
345
- <tr>
346
- <td rowspan="1" colSpan="1" >[onLocalRecording](https://write.woa.com/document/87030021158866944)</td>
347
-
348
- <td rowspan="1" colSpan="1" >本地录制任务正在进行中的进展事件回调。</td>
349
- </tr>
350
-
351
- <tr>
352
- <td rowspan="1" colSpan="1" >[onLocalRecordFragment](https://write.woa.com/document/87030021158866944)</td>
353
-
354
- <td rowspan="1" colSpan="1" >本地录制分片的事件回调。</td>
355
- </tr>
356
-
357
- <tr>
358
- <td rowspan="1" colSpan="1" >[onLocalRecordComplete](https://write.woa.com/document/87030021158866944)</td>
359
-
360
- <td rowspan="1" colSpan="1" >本地录制任务已经结束的事件回调。</td>
361
- </tr>
362
-
363
- <tr>
364
- <td rowspan="1" colSpan="1" >[onSnapshotComplete](https://write.woa.com/document/87030021158866944)</td>
365
-
366
- <td rowspan="1" colSpan="1" >本地截图完成的事件回调。</td>
367
- </tr>
368
-
369
- <tr>
370
- <td rowspan="1" colSpan="1" >[onUserEnter](https://write.woa.com/document/87030021158866944)</td>
371
-
372
- <td rowspan="1" colSpan="1" >有主播加入当前房间（已废弃）。</td>
373
- </tr>
374
-
375
- <tr>
376
- <td rowspan="1" colSpan="1" >[onUserExit](https://write.woa.com/document/87030021158866944)</td>
377
-
378
- <td rowspan="1" colSpan="1" >有主播离开当前房间（已废弃）。</td>
379
- </tr>
380
-
381
- <tr>
382
- <td rowspan="1" colSpan="1" >[onAudioEffectFinished](https://write.woa.com/document/87030021158866944)</td>
383
-
384
- <td rowspan="1" colSpan="1" >音效播放已结束（已废弃）。</td>
385
- </tr>
386
-
387
- <tr>
388
- <td rowspan="1" colSpan="1" >[onPlayBGMBegin](https://write.woa.com/document/87030021158866944)</td>
389
-
390
- <td rowspan="1" colSpan="1" >开始播放背景音乐（已废弃）。</td>
391
- </tr>
392
-
393
- <tr>
394
- <td rowspan="1" colSpan="1" >[onPlayBGMProgress](https://write.woa.com/document/87030021158866944)</td>
395
-
396
- <td rowspan="1" colSpan="1" >背景音乐的播放进度回调（已废弃）。</td>
397
- </tr>
398
-
399
- <tr>
400
- <td rowspan="1" colSpan="1" >[onPlayBGMComplete](https://write.woa.com/document/87030021158866944)</td>
401
-
402
- <td rowspan="1" colSpan="1" >背景音乐播放已经结束（已废弃）。</td>
403
- </tr>
404
-
405
- <tr>
406
- <td rowspan="1" colSpan="1" >[onSpeedTest](https://write.woa.com/document/87030021158866944)</td>
407
-
408
- <td rowspan="1" colSpan="1" >服务器测速的结果回调（已废弃）。</td>
409
- </tr>
410
- </table>
411
-
7
+ | 函数列表 | 描述 |
8
+ | --- | --- |
9
+ | onError | 错误事件回调。 |
10
+ | onWarning | 警告事件回调。 |
11
+ | onEnterRoom | 进入房间成功与否的事件回调。 |
12
+ | onExitRoom | 离开房间的事件回调。 |
13
+ | onSwitchRole | 切换角色的事件回调。 |
14
+ | onSwitchRoom | 切换房间的结果回调。 |
15
+ | onConnectOtherRoom | 请求跨房通话的结果回调。 |
16
+ | onDisconnectOtherRoom | 结束跨房通话的结果回调。 |
17
+ | onUpdateOtherRoomForwardMode | 更改跨房主播上行能力的结果回调。 |
18
+ | onRemoteUserEnterRoom | 有用户加入当前房间。 |
19
+ | onRemoteUserLeaveRoom | 有用户离开当前房间。 |
20
+ | onUserVideoAvailable | 某远端用户发布/取消了主路视频画面。 |
21
+ | onUserSubStreamAvailable | 某远端用户发布/取消了辅路视频画面。 |
22
+ | onUserAudioAvailable | 某远端用户发布/取消了自己的音频。 |
23
+ | onFirstVideoFrame | SDK 开始渲染自己本地或远端用户的首帧画面。 |
24
+ | onFirstAudioFrame | SDK 开始播放远端用户的首帧音频。 |
25
+ | onSendFirstLocalVideoFrame | 自己本地的首个视频帧已被发布出去。 |
26
+ | onSendFirstLocalAudioFrame | 自己本地的首个音频帧已被发布出去。 |
27
+ | onRemoteVideoStatusUpdated | 远端视频状态变化的事件回调。 |
28
+ | onRemoteAudioStatusUpdated | 远端音频状态变化的事件回调。 |
29
+ | onUserVideoSizeChanged | 用户视频大小发生改变回调。 |
30
+ | onNetworkQuality | 网络质量的实时统计回调。 |
31
+ | onStatistics | 音视频技术指标的实时统计回调。 |
32
+ | onSpeedTestResult | 网速测试的结果回调。 |
33
+ | onConnectionLost | SDK 与云端的连接已经断开。 |
34
+ | onTryToReconnect | SDK 正在尝试重新连接到云端。 |
35
+ | onConnectionRecovery | SDK 与云端的连接已经恢复。 |
36
+ | onCameraDidReady | 摄像头准备就绪。 |
37
+ | onMicDidReady | 麦克风准备就绪。 |
38
+ | onAudioRouteChanged | 当前音频路由发生变化（仅适用于移动设备）。 |
39
+ | onUserVoiceVolume | 音量大小的反馈回调。 |
40
+ | onDeviceChange | 本地设备的通断状态发生变化（仅适用于桌面系统）。 |
41
+ | onAudioDeviceCaptureVolumeChanged | 当前麦克风的系统采集音量发生变化。 |
42
+ | onAudioDevicePlayoutVolumeChanged | 当前系统的播放音量发生变化。 |
43
+ | onSystemAudioLoopbackError | 系统声音采集是否被成功开启的事件回调（仅适用于桌面系统）。 |
44
+ | onTestMicVolume | 测试麦克风时的音量回调。 |
45
+ | onTestSpeakerVolume | 测试扬声器时的音量回调。 |
46
+ | onRecvCustomCmdMsg | 收到自定义消息的事件回调。 |
47
+ | onMissCustomCmdMsg | 自定义消息丢失的事件回调。 |
48
+ | onRecvSEIMsg | 收到 SEI 消息的回调。 |
49
+ | onStartPublishing | 开始向腾讯云直播 CDN 上发布音视频流的事件回调。 |
50
+ | onStopPublishing | 停止向腾讯云直播 CDN 上发布音视频流的事件回调。 |
51
+ | onStartPublishCDNStream | 开始向非腾讯云 CDN 上发布音视频流的事件回调。 |
52
+ | onStopPublishCDNStream | 停止向非腾讯云 CDN 上发布音视频流的事件回调。 |
53
+ | onSetMixTranscodingConfig | 设置云端混流的排版布局和转码参数的事件回调。 |
54
+ | onStartPublishMediaStream | 开始发布媒体流的事件回调。 |
55
+ | onUpdatePublishMediaStream | 更新媒体流的事件回调。 |
56
+ | onStopPublishMediaStream | 停止媒体流的事件回调。 |
57
+ | onCdnStreamStateChanged | RTMP/RTMPS 推流状态发生改变回调。 |
58
+ | onScreenCaptureStarted | 屏幕分享开启的事件回调。 |
59
+ | onScreenCapturePaused | 屏幕分享暂停的事件回调。 |
60
+ | onScreenCaptureResumed | 屏幕分享恢复的事件回调。 |
61
+ | onScreenCaptureStoped | 屏幕分享停止的事件回调。 |
62
+ | onScreenCaptureCovered | 屏幕分享的目标窗口被遮挡的事件回调（仅适用于 Windows 操作系统）。 |
63
+ | onLocalRecordBegin | 本地录制任务已经开始的事件回调。 |
64
+ | onLocalRecording | 本地录制任务正在进行中的进展事件回调。 |
65
+ | onLocalRecordFragment | 本地录制分片的事件回调。 |
66
+ | onLocalRecordComplete | 本地录制任务已经结束的事件回调。 |
67
+ | onSnapshotComplete | 本地截图完成的事件回调。 |
68
+ | onUserEnter | 有主播加入当前房间（已废弃）。 |
69
+ | onUserExit | 有主播离开当前房间（已废弃）。 |
70
+ | onAudioEffectFinished | 音效播放已结束（已废弃）。 |
71
+ | onPlayBGMBegin | 开始播放背景音乐（已废弃）。 |
72
+ | onPlayBGMProgress | 背景音乐的播放进度回调（已废弃）。 |
73
+ | onPlayBGMComplete | 背景音乐播放已经结束（已废弃）。 |
74
+ | onSpeedTest | 服务器测速的结果回调（已废弃）。 |
412
75
 
413
76
  ## ITRTCVideoRenderCallback
414
- <table>
415
- <tr>
416
- <td rowspan="1" colSpan="1" >函数列表</td>
417
-
418
- <td rowspan="1" colSpan="1" >描述</td>
419
- </tr>
420
-
421
- <tr>
422
- <td rowspan="1" colSpan="1" >[onRenderVideoFrame](https://write.woa.com/document/87030021158866944)</td>
423
-
424
- <td rowspan="1" colSpan="1" >自定义视频渲染回调。</td>
425
- </tr>
426
- </table>
427
-
77
+ | 函数列表 | 描述 |
78
+ | --- | --- |
79
+ | onRenderVideoFrame | 自定义视频渲染回调。 |
428
80
 
429
81
  ## ITRTCVideoFrameCallback
430
- <table>
431
- <tr>
432
- <td rowspan="1" colSpan="1" >函数列表</td>
433
-
434
- <td rowspan="1" colSpan="1" >描述</td>
435
- </tr>
436
-
437
- <tr>
438
- <td rowspan="1" colSpan="1" >[onGLContextCreated](https://write.woa.com/document/87030021158866944)</td>
439
-
440
- <td rowspan="1" colSpan="1" >SDK 内部 OpenGL 环境已经创建的通知。</td>
441
- </tr>
442
-
443
- <tr>
444
- <td rowspan="1" colSpan="1" >[onProcessVideoFrame](https://write.woa.com/document/87030021158866944)</td>
445
-
446
- <td rowspan="1" colSpan="1" >用于对接第三方美颜组件的视频处理回调。</td>
447
- </tr>
448
-
449
- <tr>
450
- <td rowspan="1" colSpan="1" >[onGLContextDestroy](https://write.woa.com/document/87030021158866944)</td>
451
-
452
- <td rowspan="1" colSpan="1" >SDK 内部 OpenGL 环境被销毁的通知。</td>
453
- </tr>
454
- </table>
455
-
82
+ | 函数列表 | 描述 |
83
+ | --- | --- |
84
+ | onGLContextCreated | SDK 内部 OpenGL 环境已经创建的通知。 |
85
+ | onProcessVideoFrame | 用于对接第三方美颜组件的视频处理回调。 |
86
+ | onGLContextDestroy | SDK 内部 OpenGL 环境被销毁的通知。 |
456
87
 
457
88
  ## ITRTCAudioFrameCallback
458
- <table>
459
- <tr>
460
- <td rowspan="1" colSpan="1" >函数列表</td>
461
-
462
- <td rowspan="1" colSpan="1" >描述</td>
463
- </tr>
464
-
465
- <tr>
466
- <td rowspan="1" colSpan="1" >[onCapturedAudioFrame](https://write.woa.com/document/87030021158866944)</td>
467
-
468
- <td rowspan="1" colSpan="1" >本地采集并经过音频模块前处理后的音频数据回调。</td>
469
- </tr>
470
-
471
- <tr>
472
- <td rowspan="1" colSpan="1" >[onLocalProcessedAudioFrame](https://write.woa.com/document/87030021158866944)</td>
473
-
474
- <td rowspan="1" colSpan="1" >本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调。</td>
475
- </tr>
476
-
477
- <tr>
478
- <td rowspan="1" colSpan="1" >[onPlayAudioFrame](https://write.woa.com/document/87030021158866944)</td>
479
-
480
- <td rowspan="1" colSpan="1" >混音前的每一路远程用户的音频数据。</td>
481
- </tr>
482
-
483
- <tr>
484
- <td rowspan="1" colSpan="1" >[onMixedPlayAudioFrame](https://write.woa.com/document/87030021158866944)</td>
485
-
486
- <td rowspan="1" colSpan="1" >将各路待播放音频混合之后并在最终提交系统播放之前的数据回调。</td>
487
- </tr>
488
-
489
- <tr>
490
- <td rowspan="1" colSpan="1" >[onMixedAllAudioFrame](https://write.woa.com/document/87030021158866944)</td>
491
-
492
- <td rowspan="1" colSpan="1" >SDK 所有音频混合后的音频数据（包括采集到的和待播放的）。</td>
493
- </tr>
494
- </table>
495
-
89
+ | 函数列表 | 描述 |
90
+ | --- | --- |
91
+ | onCapturedAudioFrame | 本地采集并经过音频模块前处理后的音频数据回调。 |
92
+ | onLocalProcessedAudioFrame | 本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调。 |
93
+ | onPlayAudioFrame | 混音前的每一路远程用户的音频数据。 |
94
+ | onMixedPlayAudioFrame | 将各路待播放音频混合之后并在最终提交系统播放之前的数据回调。 |
95
+ | onMixedAllAudioFrame | SDK 所有音频混合后的音频数据（包括采集到的和待播放的）。 |
496
96
 
497
97
  ## ITRTCLogCallback
498
- <table>
499
- <tr>
500
- <td rowspan="1" colSpan="1" >函数列表</td>
501
-
502
- <td rowspan="1" colSpan="1" >描述</td>
503
- </tr>
504
-
505
- <tr>
506
- <td rowspan="1" colSpan="1" >[onLog](https://write.woa.com/document/87030021158866944)</td>
507
-
508
- <td rowspan="1" colSpan="1" >本地 LOG 的打印回调。</td>
509
- </tr>
510
- </table>
511
-
98
+ | 函数列表 | 描述 |
99
+ | --- | --- |
100
+ | onLog | 本地 LOG 的打印回调。 |
512
101
 
513
102
  ## onError
514
103
 
515
-
516
-
517
104
  #### 错误事件回调。
518
105
 
519
106
  错误事件，表示 SDK 抛出的不可恢复的错误，例如进入房间失败或设备开启失败等。
520
107
 
521
108
  参考文档：[错误码表](https://cloud.tencent.com/document/product/647/38308)
522
- <table>
523
- <tr>
524
- <td rowspan="1" colSpan="1" >参数</td>
525
-
526
- <td rowspan="1" colSpan="1" >描述</td>
527
- </tr>
528
-
529
- <tr>
530
- <td rowspan="1" colSpan="1" >errCode</td>
531
-
532
- <td rowspan="1" colSpan="1" >错误码</td>
533
- </tr>
534
-
535
- <tr>
536
- <td rowspan="1" colSpan="1" >errMsg</td>
537
-
538
- <td rowspan="1" colSpan="1" >错误信息</td>
539
- </tr>
540
-
541
- <tr>
542
- <td rowspan="1" colSpan="1" >extInfo</td>
543
-
544
- <td rowspan="1" colSpan="1" >扩展信息字段，个别错误码可能会带额外的信息帮助定位问题</td>
545
- </tr>
546
- </table>
547
-
109
+ | 参数 | 描述 |
110
+ | --- | --- |
111
+ | errCode | 错误码 |
112
+ | errMsg | 错误信息 |
113
+ | extInfo | 扩展信息字段，个别错误码可能会带额外的信息帮助定位问题 |
548
114
 
549
115
  ## onWarning
550
116
 
551
-
552
-
553
117
  #### 警告事件回调。
554
118
 
555
119
  警告事件，表示 SDK 抛出的提示性问题，例如视频出现卡顿或 CPU 使用率太高等。
556
120
 
557
121
  参考文档：[错误码表](https://cloud.tencent.com/document/product/647/38308)
558
- <table>
559
- <tr>
560
- <td rowspan="1" colSpan="1" >参数</td>
561
-
562
- <td rowspan="1" colSpan="1" >描述</td>
563
- </tr>
564
-
565
- <tr>
566
- <td rowspan="1" colSpan="1" >extInfo</td>
567
-
568
- <td rowspan="1" colSpan="1" >扩展信息字段，个别警告码可能会带额外的信息帮助定位问题</td>
569
- </tr>
570
-
571
- <tr>
572
- <td rowspan="1" colSpan="1" >warningCode</td>
573
-
574
- <td rowspan="1" colSpan="1" >警告码</td>
575
- </tr>
576
-
577
- <tr>
578
- <td rowspan="1" colSpan="1" >warningMsg</td>
579
-
580
- <td rowspan="1" colSpan="1" >警告信息</td>
581
- </tr>
582
- </table>
583
-
122
+ | 参数 | 描述 |
123
+ | --- | --- |
124
+ | extInfo | 扩展信息字段，个别警告码可能会带额外的信息帮助定位问题 |
125
+ | warningCode | 警告码 |
126
+ | warningMsg | 警告信息 |
584
127
 
585
128
  ## onEnterRoom
586
129
 
587
-
588
-
589
130
  #### 进入房间成功与否的事件回调。
590
131
 
591
- 调用 TRTCCloud 中的 [enterRoom](https://write.woa.com/document/87030026264555520) 接口执行进房操作后，会收到来自 [ITRTCCloudCallback](https://write.woa.com/document/87030021158866944) 的 ` onEnterRoom(result) ` 回调：
132
+ 调用 TRTCCloud 中的 enterRoom 接口执行进房操作后，会收到来自 ITRTCCloudCallback 的 ` onEnterRoom(result) ` 回调：
592
133
  - 如果加入成功，回调 result 会是一个正数（result > 0），代表进入房间所消耗的时间，单位是毫秒（ms）。
593
134
 
594
135
  - 如果加入失败，回调 result 会是一个负数（result < 0），代表失败原因的错误码。
595
136
 
596
-
597
137
  进房失败的错误码含义请参见[错误码表](https://cloud.tencent.com/document/product/647/38308)。
598
- <table>
599
- <tr>
600
- <td rowspan="1" colSpan="1" >参数</td>
601
-
602
- <td rowspan="1" colSpan="1" >描述</td>
603
- </tr>
604
-
605
- <tr>
606
- <td rowspan="1" colSpan="1" >result</td>
607
-
608
- <td rowspan="1" colSpan="1" >result > 0 时为进房耗时（ms），result < 0 时为进房错误码。</td>
609
- </tr>
610
- </table>
611
-
138
+ | 参数 | 描述 |
139
+ | --- | --- |
140
+ | result | result > 0 时为进房耗时（ms），result < 0 时为进房错误码。 |
612
141
 
613
142
  > **注意**
614
- >
143
+ >
615
144
 
616
- > 1. 在 Ver6.6 之前的版本，只有进房成功会抛出 ` onEnterRoom(result) ` 回调，进房失败由 [onError](https://write.woa.com/document/87030021158866944) 回调抛出。
617
- >
618
-
619
- > 2. 在 Ver6.6 之后的版本：无论进房成功或失败，均会抛出 ` onEnterRoom(result) ` 回调，同时进房失败也会有 [onError](https://write.woa.com/document/87030021158866944) 回调抛出。
620
- >
145
+ > 1. 在 Ver6.6 之前的版本，只有进房成功会抛出 ` onEnterRoom(result) ` 回调，进房失败由 onError 回调抛出。
146
+ >
621
147
 
148
+ > 2. 在 Ver6.6 之后的版本：无论进房成功或失败，均会抛出 ` onEnterRoom(result) ` 回调，同时进房失败也会有 onError 回调抛出。
149
+ >
622
150
 
623
151
  ## onExitRoom
624
152
 
625
-
626
-
627
153
  #### 离开房间的事件回调。
628
154
 
629
- 调用 TRTCCloud 中的 [exitRoom](https://write.woa.com/document/87030026264555520) 接口会执行退出房间的相关逻辑，例如释放音视频设备资源和编解码器资源等。
155
+ 调用 TRTCCloud 中的 exitRoom 接口会执行退出房间的相关逻辑，例如释放音视频设备资源和编解码器资源等。
630
156
 
631
157
  待 SDK 占用的所有资源释放完毕后，SDK 会抛出 ` onExitRoom() ` 回调通知到您。
632
158
 
633
-
634
-
635
- 如果您要再次调用 [enterRoom](https://write.woa.com/document/87030026264555520) 或者切换到其他的音视频 SDK，请等待 ` onExitRoom ` 回调到来后再执行相关操作。否则可能会遇到例如摄像头、麦克风设备被强占等各种异常问题。
636
- <table>
637
- <tr>
638
- <td rowspan="1" colSpan="1" >参数</td>
639
-
640
- <td rowspan="1" colSpan="1" >描述</td>
641
- </tr>
642
-
643
- <tr>
644
- <td rowspan="1" colSpan="1" >reason</td>
645
-
646
- <td rowspan="1" colSpan="1" >离开房间原因，0：主动调用 exitRoom 退出房间；1：被服务器移出当前房间；2：当前房间整个被解散 3: 服务器状态异常。</td>
647
- </tr>
648
- </table>
649
-
159
+ 如果您要再次调用 enterRoom 或者切换到其他的音视频 SDK，请等待 ` onExitRoom ` 回调到来后再执行相关操作。否则可能会遇到例如摄像头、麦克风设备被强占等各种异常问题。
160
+ | 参数 | 描述 |
161
+ | --- | --- |
162
+ | reason | 离开房间原因，0：主动调用 exitRoom 退出房间；1：被服务器移出当前房间；2：当前房间整个被解散 3: 服务器状态异常。 |
650
163
 
651
164
  ## onSwitchRole
652
165
 
653
-
654
-
655
166
  #### 切换角色的事件回调。
656
167
 
657
- 调用 TRTCCloud 中的 [switchRole](https://write.woa.com/document/87030026264555520) 接口会切换主播和观众的角色，该操作会伴随一个线路切换的过程，待 SDK 切换完成后，会抛出 ` onSwitchRole() ` 事件回调。
658
- <table>
659
- <tr>
660
- <td rowspan="1" colSpan="1" >参数</td>
168
+ 调用 TRTCCloud 中的 switchRole 接口会切换主播和观众的角色，该操作会伴随一个线路切换的过程，待 SDK 切换完成后，会抛出 ` onSwitchRole() ` 事件回调。
169
+ | 参数 | 描述 |
170
+ | --- | --- |
171
+ | errCode | 错误码，ERR_NULL 代表切换成功，其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
172
+ | errMsg | 错误信息。 |
661
173
 
662
- <td rowspan="1" colSpan="1" >描述</td>
663
- </tr>
174
+ ## onSwitchRoom
664
175
 
665
- <tr>
666
- <td rowspan="1" colSpan="1" >errCode</td>
176
+ #### 切换房间的结果回调。
667
177
 
668
- <td rowspan="1" colSpan="1" >错误码，ERR_NULL 代表切换成功，其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。</td>
669
- </tr>
178
+ 调用 TRTCCloud 中的 switchRoom 接口可以让用户快速地从一个房间切换到另一个房间，待 SDK 切换完成后，会抛出 ` onSwitchRoom() ` 事件回调。
179
+ | 参数 | 描述 |
180
+ | --- | --- |
181
+ | errCode | 错误码，ERR_NULL 代表切换成功，其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
182
+ | errMsg | 错误信息。 |
670
183
 
671
- <tr>
672
- <td rowspan="1" colSpan="1" >errMsg</td>
184
+ ## onConnectOtherRoom
673
185
 
674
- <td rowspan="1" colSpan="1" >错误信息。</td>
675
- </tr>
676
- </table>
186
+ #### 请求跨房通话的结果回调。
677
187
 
188
+ 调用 TRTCCloud 中的 connectOtherRoom 接口会将两个不同房间中的主播拉通视频通话，也就是所谓的“主播PK”功能。
678
189
 
679
- ## onSwitchRoom
190
+ 调用者会收到 ` onConnectOtherRoom() ` 回调来获知跨房通话是否成功。
191
+ | 参数 | 描述 |
192
+ | --- | --- |
193
+ | errCode | 错误码，ERR_NULL 代表切换成功，其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
194
+ | errMsg | 错误信息。 |
195
+ | userId | 要跨房通话的另一个房间中的主播的用户 ID。 |
680
196
 
197
+ ## onDisconnectOtherRoom
681
198
 
199
+ #### 结束跨房通话的结果回调。
682
200
 
683
- #### 切换房间的结果回调。
201
+ 调用 TRTCCloud 中的 disConnectOtherRoom 接口会结束两个不同房间中的主播视频通话，也就是所谓的“主播PK”功能。
684
202
 
685
- 调用 TRTCCloud 中的 [switchRoom](https://write.woa.com/document/87030026264555520) 接口可以让用户快速地从一个房间切换到另一个房间，待 SDK 切换完成后，会抛出 ` onSwitchRoom() ` 事件回调。
686
- <table>
687
- <tr>
688
- <td rowspan="1" colSpan="1" >参数</td>
203
+ 调用者会收到 ` onDisconnectOtherRoom() ` 回调来获知结束跨房通话是否成功。
204
+ | 参数 | 描述 |
205
+ | --- | --- |
206
+ | errCode | 错误码，ERR_NULL 代表成功，其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
207
+ | errMsg | 错误信息。 |
689
208
 
690
- <td rowspan="1" colSpan="1" >描述</td>
691
- </tr>
209
+ ## onUpdateOtherRoomForwardMode
692
210
 
693
- <tr>
694
- <td rowspan="1" colSpan="1" >errCode</td>
211
+ #### 更改跨房主播上行能力的结果回调。
695
212
 
696
- <td rowspan="1" colSpan="1" >错误码，ERR_NULL 代表切换成功，其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。</td>
697
- </tr>
213
+ 调用 TRTCCloud 中的 updateOtherRoomForwardMode 接口会限制跨房主播在本房间内的上行能力，禁止或允许跨房主播发布音频/主路视频/辅路视频，该行为会影响房间内的所有用户。
698
214
 
699
- <tr>
700
- <td rowspan="1" colSpan="1" >errMsg</td>
215
+ 调用者会收到 ` onUpdateOtherRoomForwardMode() ` 回调来获知更改跨房主播上行能力是否成功。
216
+ | 参数 | 描述 |
217
+ | --- | --- |
218
+ | errCode | 错误码，ERR_NULL 代表成功，其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
219
+ | errMsg | 错误信息。 |
701
220
 
702
- <td rowspan="1" colSpan="1" >错误信息。</td>
703
- </tr>
704
- </table>
221
+ ## onRemoteUserEnterRoom
705
222
 
223
+ #### 有用户加入当前房间。
706
224
 
707
- ## onConnectOtherRoom
225
+ 出于性能方面的考虑，在 TRTC 两种不同的应用场景（即 ` AppScene `，在 enterRoom 时通过第二个参数指定）下，该通知的行为会有差别：
226
+ - 直播类场景（TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom）：该场景下的用户区分主播和观众两种角色，只有主播进入房间时才会触发该通知，观众进入房间时不会触发该通知。
708
227
 
228
+ - 通话类场景（TRTCAppSceneVideoCall 和 TRTCAppSceneAudioCall）：该场景下的用户没有角色的区分（可认为都是主播），任何用户进入房间都会触发该通知。
709
229
 
230
+ | 参数 | 描述 |
231
+ | --- | --- |
232
+ | userId | 远端用户的用户标识。 |
710
233
 
711
- #### 请求跨房通话的结果回调。
234
+ > **注意**
235
+ >
712
236
 
713
- 调用 TRTCCloud 中的 [connectOtherRoom](https://write.woa.com/document/87030021158866944) 接口会将两个不同房间中的主播拉通视频通话，也就是所谓的“主播PK”功能。
237
+ > 1. 事件回调 ` onRemoteUserEnterRoom ` 和 onRemoteUserLeaveRoom 只适用于维护当前房间里的“用户列表”，有此事件回调不代表一定有视频画面。
238
+ >
714
239
 
715
- 调用者会收到 ` onConnectOtherRoom() ` 回调来获知跨房通话是否成功。
716
- <table>
717
- <tr>
718
- <td rowspan="1" colSpan="1" >参数</td>
240
+ > 2. 如果需要显示远程画面，请监听代表某个用户是否有视频画面的 onUserVideoAvailable 事件回调。
241
+ >
719
242
 
720
- <td rowspan="1" colSpan="1" >描述</td>
721
- </tr>
243
+ ## onRemoteUserLeaveRoom
722
244
 
723
- <tr>
724
- <td rowspan="1" colSpan="1" >errCode</td>
245
+ #### 有用户离开当前房间。
725
246
 
726
- <td rowspan="1" colSpan="1" >错误码，ERR_NULL 代表切换成功，其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。</td>
727
- </tr>
247
+ 与 onRemoteUserEnterRoom 相对应，在两种不同的应用场景（即 AppScene，在 enterRoom 时通过第二个参数指定）下，该通知的行为会有差别：
248
+ - 直播类场景（TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom）：该场景下的用户区分主播和观众两种角色，只有主播离开房间时才会触发该通知，观众离开房间时不会触发该通知。
728
249
 
729
- <tr>
730
- <td rowspan="1" colSpan="1" >errMsg</td>
250
+ - 通话类场景（TRTCAppSceneVideoCall 和 TRTCAppSceneAudioCall）：该场景下的用户没有角色的区分（可认为都是主播），任何用户离开房间都会触发该通知。
731
251
 
732
- <td rowspan="1" colSpan="1" >错误信息。</td>
733
- </tr>
252
+ | 参数 | 描述 |
253
+ | --- | --- |
254
+ | reason | 离开原因，0表示用户主动退出房间，1表示用户超时退出，2表示被移出房间，3表示主播因切换到观众退出房间。 |
255
+ | userId | 远端用户的用户标识。 |
734
256
 
735
- <tr>
736
- <td rowspan="1" colSpan="1" >userId</td>
257
+ ## onUserVideoAvailable
737
258
 
738
- <td rowspan="1" colSpan="1" >要跨房通话的另一个房间中的主播的用户 ID。</td>
739
- </tr>
740
- </table>
259
+ #### 某远端用户发布/取消了主路视频画面。
741
260
 
261
+ **主路画面** 一般被用于承载摄像头画面。当您收到 ` onUserVideoAvailable(userId, true) ` 通知时，表示该路画面已经有可播放的视频帧到达。
742
262
 
743
- ## onDisconnectOtherRoom
263
+ 此时，您需要调用 startRemoteView 接口订阅该用户的远程画面，订阅成功后，您会继续收到该用户的首帧画面渲染回调 ` onFirstVideoFrame(userId) `。
744
264
 
265
+ 当您收到 ` onUserVideoAvailable(userId, false) ` 通知时，表示该路远程画面已经被关闭，关闭的原因可能是该用户调用了 muteLocalVideo 或 stopLocalPreview。
266
+ | 参数 | 描述 |
267
+ | --- | --- |
268
+ | available | 该用户是否发布（或取消发布）了主路视频画面，true：发布；false：取消发布。 |
269
+ | userId | 远端用户的用户标识。 |
745
270
 
271
+ ## onUserSubStreamAvailable
746
272
 
747
- #### 结束跨房通话的结果回调。
273
+ #### 某远端用户发布/取消了辅路视频画面。
748
274
 
749
- 调用 TRTCCloud 中的 disConnectOtherRoom 接口会结束两个不同房间中的主播视频通话，也就是所谓的“主播PK”功能。
275
+ “辅路画面”一般被用于承载屏幕分享的画面。当您收到 ` onUserSubStreamAvailable(userId, true) ` 通知时，表示该路画面已经有可播放的视频帧到达。
750
276
 
751
- 调用者会收到 ` onDisconnectOtherRoom() ` 回调来获知结束跨房通话是否成功。
752
- <table>
753
- <tr>
754
- <td rowspan="1" colSpan="1" >参数</td>
277
+ 此时，您需要调用 startRemoteView 接口订阅该用户的远程画面，订阅成功后，您会继续收到该用户的首帧画面渲染回调 ` onFirstVideoFrame(userId) `。
278
+ | 参数 | 描述 |
279
+ | --- | --- |
280
+ | available | 该用户是否发布（或取消发布）了辅路视频画面，true: 发布；false：取消发布。 |
281
+ | userId | 远端用户的用户标识。 |
755
282
 
756
- <td rowspan="1" colSpan="1" >描述</td>
757
- </tr>
283
+ > **注意**
284
+ >
758
285
 
759
- <tr>
760
- <td rowspan="1" colSpan="1" >errCode</td>
286
+ > 显示辅路画面使用的函数是 startRemoteView 而非 startRemoteSubStreamView，startRemoteSubStreamView 已经被废弃。
287
+ >
761
288
 
762
- <td rowspan="1" colSpan="1" >错误码，ERR_NULL 代表成功，其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。</td>
763
- </tr>
289
+ ## onUserAudioAvailable
764
290
 
765
- <tr>
766
- <td rowspan="1" colSpan="1" >errMsg</td>
291
+ #### 某远端用户发布/取消了自己的音频。
767
292
 
768
- <td rowspan="1" colSpan="1" >错误信息。</td>
769
- </tr>
770
- </table>
293
+ 当您收到 ` onUserAudioAvailable(userId, true) ` 通知时，表示该用户发布了自己的声音，此时 SDK 的表现为：
294
+ - 在自动订阅模式下，您无需做任何操作，SDK 会自动播放该用户的声音。
771
295
 
296
+ - 在手动订阅模式下，您可以通过 muteRemoteAudio(userid, false) 来播放该用户的声音。
772
297
 
773
- ## onUpdateOtherRoomForwardMode
298
+ | 参数 | 描述 |
299
+ | --- | --- |
300
+ | available | 该用户是否发布（或取消发布）了自己的音频，true: 发布；false：取消发布。 |
301
+ | userId | 远端用户的用户标识。 |
774
302
 
303
+ > **注意**
304
+ >
775
305
 
306
+ > SDK 默认使用自动订阅模式，您可以通过 setDefaultStreamRecvMode 设置为手动订阅，但需要在您进入房间之前调用才生效。
307
+ >
776
308
 
777
- #### 更改跨房主播上行能力的结果回调。
309
+ ## onFirstVideoFrame
778
310
 
779
- 调用 TRTCCloud 中的 [updateOtherRoomForwardMode](https://write.woa.com/document/87030026264555520) 接口会限制跨房主播在本房间内的上行能力，禁止或允许跨房主播发布音频/主路视频/辅路视频，该行为会影响房间内的所有用户。
311
+ #### SDK 开始渲染自己本地或远端用户的首帧画面。
780
312
 
781
- 调用者会收到 ` onUpdateOtherRoomForwardMode() ` 回调来获知更改跨房主播上行能力是否成功。
782
- <table>
783
- <tr>
784
- <td rowspan="1" colSpan="1" >参数</td>
313
+ SDK 会在渲染自己本地或远端用户的首帧画面时抛出该事件，您可以通过回调事件中的 userId 参数来判断事件来自于“本地”还是来自于“远端”。
314
+ - 如果 userId 为空值，代表 SDK 已经开始渲染自己本地的视频画面，不过前提是您已经调用了 startLocalPreview 或 startScreenCapture。
785
315
 
786
- <td rowspan="1" colSpan="1" >描述</td>
787
- </tr>
316
+ - 如果 userId 不为空，代表 SDK 已经开始渲染远端用户的视频画面，不过前提是您已经调用了 startRemoteView 订阅了该用户的视频画面。
788
317
 
789
- <tr>
790
- <td rowspan="1" colSpan="1" >errCode</td>
318
+ | 参数 | 描述 |
319
+ | --- | --- |
320
+ | height | 画面的高度。 |
321
+ | streamType | 视频流类型：主路（Main）一般用于承载摄像头画面，辅路（Sub）一般用于承载屏幕分享画面。 |
322
+ | userId | 本地或远端的用户标识，如果 userId 为空值代表自己本地的首帧画面已到来，userId 不为空则代表远端用户的首帧画面已到来。 |
323
+ | width | 画面的宽度。 |
791
324
 
792
- <td rowspan="1" colSpan="1" >错误码，ERR_NULL 代表成功，其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。</td>
793
- </tr>
325
+ > **注意**
326
+ >
794
327
 
795
- <tr>
796
- <td rowspan="1" colSpan="1" >errMsg</td>
328
+ > 1. 只有当您调用了 startLocalPreview 或 startScreenCapture 之后，才会触发自己本地的首帧画面事件回调。
329
+ >
797
330
 
798
- <td rowspan="1" colSpan="1" >错误信息。</td>
799
- </tr>
800
- </table>
331
+ > 2. 只有当您调用了 startRemoteView 或 startRemoteSubStreamView 之后，才会触发远端用户的首帧画面事件回调。
332
+ >
801
333
 
334
+ ## onFirstAudioFrame
802
335
 
803
- ## onRemoteUserEnterRoom
336
+ #### SDK 开始播放远端用户的首帧音频。
804
337
 
338
+ SDK 会在播放远端用户的首帧音频时抛出该事件，本地音频的首帧事件暂不抛出。
339
+ | 参数 | 描述 |
340
+ | --- | --- |
341
+ | userId | 远端用户的用户标识。 |
805
342
 
343
+ ## onSendFirstLocalVideoFrame
806
344
 
807
- #### 有用户加入当前房间。
345
+ #### 自己本地的首个视频帧已被发布出去。
808
346
 
809
- 出于性能方面的考虑，在 TRTC 两种不同的应用场景（即 ` AppScene `，在 [enterRoom](https://write.woa.com/document/87030026264555520) 时通过第二个参数指定）下，该通知的行为会有差别：
810
- - 直播类场景（[TRTCAppSceneLIVE](https://write.woa.com/document/87030132707430400) 和 [TRTCAppSceneVoiceChatRoom](https://write.woa.com/document/87030132707430400)）：该场景下的用户区分主播和观众两种角色，只有主播进入房间时才会触发该通知，观众进入房间时不会触发该通知。
347
+ 当您成功进入房间并通过 startLocalPreview 或 startScreenCapture 开启本地视频采集之后（开启采集和进入房间的先后顺序无影响），SDK 就会开始进行视频编码，并通过自身的网络模块向云端发布自己本地的视频数据。当 SDK 成功地向云端送出自己的第一帧视频数据帧以后，就会抛出 ` onSendFirstLocalVideoFrame ` 事件回调。
348
+ | 参数 | 描述 |
349
+ | --- | --- |
350
+ | streamType | 视频流类型：主路（Main）一般用于承载摄像头画面，辅路（Sub）一般用于承载屏幕分享画面。 |
811
351
 
812
- - 通话类场景（[TRTCAppSceneVideoCall](https://write.woa.com/document/87030132707430400) 和 [TRTCAppSceneAudioCall](https://write.woa.com/document/87030132707430400)）：该场景下的用户没有角色的区分（可认为都是主播），任何用户进入房间都会触发该通知。
352
+ ## onSendFirstLocalAudioFrame
813
353
 
814
- <table>
815
- <tr>
816
- <td rowspan="1" colSpan="1" >参数</td>
817
-
818
- <td rowspan="1" colSpan="1" >描述</td>
819
- </tr>
820
-
821
- <tr>
822
- <td rowspan="1" colSpan="1" >userId</td>
823
-
824
- <td rowspan="1" colSpan="1" >远端用户的用户标识。</td>
825
- </tr>
826
- </table>
827
-
828
-
829
- > **注意**
830
- >
831
-
832
- > 1. 事件回调 ` onRemoteUserEnterRoom ` 和 [onRemoteUserLeaveRoom](https://write.woa.com/document/87030021158866944) 只适用于维护当前房间里的“用户列表”，有此事件回调不代表一定有视频画面。
833
- >
834
-
835
- > 2. 如果需要显示远程画面，请监听代表某个用户是否有视频画面的 [onUserVideoAvailable](https://write.woa.com/document/87030021158866944) 事件回调。
836
- >
837
-
838
-
839
- ## onRemoteUserLeaveRoom
840
-
841
-
842
-
843
- #### 有用户离开当前房间。
844
-
845
- 与 [onRemoteUserEnterRoom](https://write.woa.com/document/87030021158866944) 相对应，在两种不同的应用场景（即 AppScene，在 [enterRoom](https://write.woa.com/document/87030026264555520) 时通过第二个参数指定）下，该通知的行为会有差别：
846
- - 直播类场景（[TRTCAppSceneLIVE](https://write.woa.com/document/87030132707430400) 和 [TRTCAppSceneVoiceChatRoom](https://write.woa.com/document/87030132707430400)）：该场景下的用户区分主播和观众两种角色，只有主播离开房间时才会触发该通知，观众离开房间时不会触发该通知。
847
-
848
- - 通话类场景（[TRTCAppSceneVideoCall](https://write.woa.com/document/87030132707430400) 和 [TRTCAppSceneAudioCall](https://write.woa.com/document/87030132707430400)）：该场景下的用户没有角色的区分（可认为都是主播），任何用户离开房间都会触发该通知。
849
-
850
- <table>
851
- <tr>
852
- <td rowspan="1" colSpan="1" >参数</td>
853
-
854
- <td rowspan="1" colSpan="1" >描述</td>
855
- </tr>
856
-
857
- <tr>
858
- <td rowspan="1" colSpan="1" >reason</td>
859
-
860
- <td rowspan="1" colSpan="1" >离开原因，0表示用户主动退出房间，1表示用户超时退出，2表示被移出房间，3表示主播因切换到观众退出房间。</td>
861
- </tr>
862
-
863
- <tr>
864
- <td rowspan="1" colSpan="1" >userId</td>
865
-
866
- <td rowspan="1" colSpan="1" >远端用户的用户标识。</td>
867
- </tr>
868
- </table>
869
-
870
-
871
- ## onUserVideoAvailable
872
-
873
-
874
-
875
- #### 某远端用户发布/取消了主路视频画面。
876
-
877
- **主路画面** 一般被用于承载摄像头画面。当您收到 ` onUserVideoAvailable(userId, true) ` 通知时，表示该路画面已经有可播放的视频帧到达。
878
-
879
- 此时，您需要调用 [startRemoteView](https://write.woa.com/document/87030026264555520) 接口订阅该用户的远程画面，订阅成功后，您会继续收到该用户的首帧画面渲染回调 ` onFirstVideoFrame(userId) `。
880
-
881
-
882
-
883
- 当您收到 ` onUserVideoAvailable(userId, false) ` 通知时，表示该路远程画面已经被关闭，关闭的原因可能是该用户调用了 [muteLocalVideo](https://write.woa.com/document/87030026264555520) 或 [stopLocalPreview](https://write.woa.com/document/87030026264555520)。
884
- <table>
885
- <tr>
886
- <td rowspan="1" colSpan="1" >参数</td>
887
-
888
- <td rowspan="1" colSpan="1" >描述</td>
889
- </tr>
890
-
891
- <tr>
892
- <td rowspan="1" colSpan="1" >available</td>
893
-
894
- <td rowspan="1" colSpan="1" >该用户是否发布（或取消发布）了主路视频画面，true：发布；false：取消发布。</td>
895
- </tr>
896
-
897
- <tr>
898
- <td rowspan="1" colSpan="1" >userId</td>
899
-
900
- <td rowspan="1" colSpan="1" >远端用户的用户标识。</td>
901
- </tr>
902
- </table>
903
-
904
-
905
- ## onUserSubStreamAvailable
906
-
907
-
908
-
909
- #### 某远端用户发布/取消了辅路视频画面。
910
-
911
- “辅路画面”一般被用于承载屏幕分享的画面。当您收到 ` onUserSubStreamAvailable(userId, true) ` 通知时，表示该路画面已经有可播放的视频帧到达。
912
-
913
- 此时，您需要调用 [startRemoteView](https://write.woa.com/document/87030026264555520) 接口订阅该用户的远程画面，订阅成功后，您会继续收到该用户的首帧画面渲染回调 ` onFirstVideoFrame(userId) `。
914
- <table>
915
- <tr>
916
- <td rowspan="1" colSpan="1" >参数</td>
917
-
918
- <td rowspan="1" colSpan="1" >描述</td>
919
- </tr>
920
-
921
- <tr>
922
- <td rowspan="1" colSpan="1" >available</td>
923
-
924
- <td rowspan="1" colSpan="1" >该用户是否发布（或取消发布）了辅路视频画面，true: 发布；false：取消发布。</td>
925
- </tr>
926
-
927
- <tr>
928
- <td rowspan="1" colSpan="1" >userId</td>
929
-
930
- <td rowspan="1" colSpan="1" >远端用户的用户标识。</td>
931
- </tr>
932
- </table>
933
-
934
-
935
- > **注意**
936
- >
937
-
938
- > 显示辅路画面使用的函数是 [startRemoteView](https://write.woa.com/document/87030026264555520) 而非 startRemoteSubStreamView，startRemoteSubStreamView 已经被废弃。
939
- >
940
-
941
-
942
- ## onUserAudioAvailable
943
-
944
-
945
-
946
- #### 某远端用户发布/取消了自己的音频。
947
-
948
- 当您收到 ` onUserAudioAvailable(userId, true) ` 通知时，表示该用户发布了自己的声音，此时 SDK 的表现为：
949
- - 在自动订阅模式下，您无需做任何操作，SDK 会自动播放该用户的声音。
950
-
951
- - 在手动订阅模式下，您可以通过 [muteRemoteAudio](https://write.woa.com/document/87030026264555520)(userid, false) 来播放该用户的声音。
952
-
953
- <table>
954
- <tr>
955
- <td rowspan="1" colSpan="1" >参数</td>
956
-
957
- <td rowspan="1" colSpan="1" >描述</td>
958
- </tr>
959
-
960
- <tr>
961
- <td rowspan="1" colSpan="1" >available</td>
962
-
963
- <td rowspan="1" colSpan="1" >该用户是否发布（或取消发布）了自己的音频，true: 发布；false：取消发布。</td>
964
- </tr>
965
-
966
- <tr>
967
- <td rowspan="1" colSpan="1" >userId</td>
968
-
969
- <td rowspan="1" colSpan="1" >远端用户的用户标识。</td>
970
- </tr>
971
- </table>
972
-
973
-
974
- > **注意**
975
- >
976
-
977
- > SDK 默认使用自动订阅模式，您可以通过 [setDefaultStreamRecvMode](https://write.woa.com/document/87030026264555520) 设置为手动订阅，但需要在您进入房间之前调用才生效。
978
- >
979
-
980
-
981
- ## onFirstVideoFrame
982
-
983
-
984
-
985
- #### SDK 开始渲染自己本地或远端用户的首帧画面。
986
-
987
- SDK 会在渲染自己本地或远端用户的首帧画面时抛出该事件，您可以通过回调事件中的 userId 参数来判断事件来自于“本地”还是来自于“远端”。
988
- - 如果 userId 为空值，代表 SDK 已经开始渲染自己本地的视频画面，不过前提是您已经调用了 [startLocalPreview](https://write.woa.com/document/87030026264555520) 或 [startScreenCapture](https://write.woa.com/document/87030026264555520)。
989
-
990
- - 如果 userId 不为空，代表 SDK 已经开始渲染远端用户的视频画面，不过前提是您已经调用了 [startRemoteView](https://write.woa.com/document/87030026264555520) 订阅了该用户的视频画面。
991
-
992
- <table>
993
- <tr>
994
- <td rowspan="1" colSpan="1" >参数</td>
995
-
996
- <td rowspan="1" colSpan="1" >描述</td>
997
- </tr>
998
-
999
- <tr>
1000
- <td rowspan="1" colSpan="1" >height</td>
1001
-
1002
- <td rowspan="1" colSpan="1" >画面的高度。</td>
1003
- </tr>
1004
-
1005
- <tr>
1006
- <td rowspan="1" colSpan="1" >streamType</td>
1007
-
1008
- <td rowspan="1" colSpan="1" >视频流类型：主路（Main）一般用于承载摄像头画面，辅路（Sub）一般用于承载屏幕分享画面。</td>
1009
- </tr>
1010
-
1011
- <tr>
1012
- <td rowspan="1" colSpan="1" >userId</td>
1013
-
1014
- <td rowspan="1" colSpan="1" >本地或远端的用户标识，如果 userId 为空值代表自己本地的首帧画面已到来，userId 不为空则代表远端用户的首帧画面已到来。</td>
1015
- </tr>
1016
-
1017
- <tr>
1018
- <td rowspan="1" colSpan="1" >width</td>
1019
-
1020
- <td rowspan="1" colSpan="1" >画面的宽度。</td>
1021
- </tr>
1022
- </table>
1023
-
1024
-
1025
- > **注意**
1026
- >
1027
-
1028
- > 1. 只有当您调用了 [startLocalPreview](https://write.woa.com/document/87030026264555520) 或 [startScreenCapture](https://write.woa.com/document/87030026264555520) 之后，才会触发自己本地的首帧画面事件回调。
1029
- >
1030
-
1031
- > 2. 只有当您调用了 [startRemoteView](https://write.woa.com/document/87030026264555520) 或 startRemoteSubStreamView 之后，才会触发远端用户的首帧画面事件回调。
1032
- >
1033
-
1034
-
1035
- ## onFirstAudioFrame
1036
-
1037
-
1038
-
1039
- #### SDK 开始播放远端用户的首帧音频。
1040
-
1041
- SDK 会在播放远端用户的首帧音频时抛出该事件，本地音频的首帧事件暂不抛出。
1042
- <table>
1043
- <tr>
1044
- <td rowspan="1" colSpan="1" >参数</td>
1045
-
1046
- <td rowspan="1" colSpan="1" >描述</td>
1047
- </tr>
1048
-
1049
- <tr>
1050
- <td rowspan="1" colSpan="1" >userId</td>
1051
-
1052
- <td rowspan="1" colSpan="1" >远端用户的用户标识。</td>
1053
- </tr>
1054
- </table>
1055
-
1056
-
1057
- ## onSendFirstLocalVideoFrame
1058
-
1059
-
1060
-
1061
- #### 自己本地的首个视频帧已被发布出去。
1062
-
1063
- 当您成功进入房间并通过 [startLocalPreview](https://write.woa.com/document/87030026264555520) 或 [startScreenCapture](https://write.woa.com/document/87030026264555520) 开启本地视频采集之后（开启采集和进入房间的先后顺序无影响），SDK 就会开始进行视频编码，并通过自身的网络模块向云端发布自己本地的视频数据。当 SDK 成功地向云端送出自己的第一帧视频数据帧以后，就会抛出 ` onSendFirstLocalVideoFrame ` 事件回调。
1064
- <table>
1065
- <tr>
1066
- <td rowspan="1" colSpan="1" >参数</td>
1067
-
1068
- <td rowspan="1" colSpan="1" >描述</td>
1069
- </tr>
1070
-
1071
- <tr>
1072
- <td rowspan="1" colSpan="1" >streamType</td>
1073
-
1074
- <td rowspan="1" colSpan="1" >视频流类型：主路（Main）一般用于承载摄像头画面，辅路（Sub）一般用于承载屏幕分享画面。</td>
1075
- </tr>
1076
- </table>
1077
-
1078
-
1079
- ## onSendFirstLocalAudioFrame
1080
-
1081
-
1082
-
1083
- #### 自己本地的首个音频帧已被发布出去。
1084
-
1085
- 当您成功进入房间并通过 [startLocalAudio](https://write.woa.com/document/87030026264555520) 开启本地音频采集之后（开启采集和进入房间的先后顺序无影响），SDK 就会开始进行音频编码，并通过自身的网络模块向云端发布自己本地的音频数据。当 SDK 成功地向云端送出自己的第一帧音频数据帧以后，就会抛出 ` onSendFirstLocalAudioFrame ` 事件回调。
1086
-
1087
- ## onRemoteVideoStatusUpdated
354
+ #### 自己本地的首个音频帧已被发布出去。
1088
355
 
356
+ 当您成功进入房间并通过 startLocalAudio 开启本地音频采集之后（开启采集和进入房间的先后顺序无影响），SDK 就会开始进行音频编码，并通过自身的网络模块向云端发布自己本地的音频数据。当 SDK 成功地向云端送出自己的第一帧音频数据帧以后，就会抛出 ` onSendFirstLocalAudioFrame ` 事件回调。
1089
357
 
358
+ ## onRemoteVideoStatusUpdated
1090
359
 
1091
360
  #### 远端视频状态变化的事件回调。
1092
361
 
1093
362
  您可以通过此事件回调获取远端每一路画面的播放状态（包括 Playing、Loading 和 Stopped 三种状态），从而进行相应的 UI 展示。
1094
- <table>
1095
- <tr>
1096
- <td rowspan="1" colSpan="1" >参数</td>
1097
-
1098
- <td rowspan="1" colSpan="1" >描述</td>
1099
- </tr>
1100
-
1101
- <tr>
1102
- <td rowspan="1" colSpan="1" >extrainfo</td>
1103
-
1104
- <td rowspan="1" colSpan="1" >额外信息。</td>
1105
- </tr>
1106
-
1107
- <tr>
1108
- <td rowspan="1" colSpan="1" >reason</td>
1109
-
1110
- <td rowspan="1" colSpan="1" >视频状态改变的原因。</td>
1111
- </tr>
1112
-
1113
- <tr>
1114
- <td rowspan="1" colSpan="1" >status</td>
1115
-
1116
- <td rowspan="1" colSpan="1" >视频状态：包括 Playing、Loading 和 Stopped 三种状态。</td>
1117
- </tr>
1118
-
1119
- <tr>
1120
- <td rowspan="1" colSpan="1" >streamType</td>
1121
-
1122
- <td rowspan="1" colSpan="1" >视频流类型：主路（Main）一般用于承载摄像头画面，辅路（Sub）一般用于承载屏幕分享画面。</td>
1123
- </tr>
1124
-
1125
- <tr>
1126
- <td rowspan="1" colSpan="1" >userId</td>
1127
-
1128
- <td rowspan="1" colSpan="1" >用户标识。</td>
1129
- </tr>
1130
- </table>
1131
-
1132
-
1133
- ## onRemoteAudioStatusUpdated
1134
-
1135
-
1136
-
1137
- #### 远端音频状态变化的事件回调。
1138
-
1139
- 您可以通过此事件回调获取远端每一路音频的播放状态（包括 Playing、Loading 和 Stopped 三种状态），从而进行相应的 UI 展示。
1140
- <table>
1141
- <tr>
1142
- <td rowspan="1" colSpan="1" >参数</td>
1143
-
1144
- <td rowspan="1" colSpan="1" >描述</td>
1145
- </tr>
1146
-
1147
- <tr>
1148
- <td rowspan="1" colSpan="1" >extrainfo</td>
1149
-
1150
- <td rowspan="1" colSpan="1" >额外信息。</td>
1151
- </tr>
1152
-
1153
- <tr>
1154
- <td rowspan="1" colSpan="1" >reason</td>
1155
-
1156
- <td rowspan="1" colSpan="1" >音频状态改变的原因。</td>
1157
- </tr>
1158
-
1159
- <tr>
1160
- <td rowspan="1" colSpan="1" >status</td>
1161
-
1162
- <td rowspan="1" colSpan="1" >音频状态：包括 Playing、Loading 和 Stopped 三种状态。</td>
1163
- </tr>
1164
-
1165
- <tr>
1166
- <td rowspan="1" colSpan="1" >userId</td>
1167
-
1168
- <td rowspan="1" colSpan="1" >用户标识。</td>
1169
- </tr>
1170
- </table>
1171
-
1172
-
1173
- ## onUserVideoSizeChanged
1174
-
1175
-
1176
-
1177
- #### 用户视频大小发生改变回调。
1178
-
1179
- 当您收到 ` onUserVideoSizeChanged(userId, streamType, newWidth, newHeight) ` 通知时，表示该路画面大小发生了调整，调整的原因可能是该用户调用了 [setVideoEncoderParam](https://write.woa.com/document/87030026264555520) 或者 [setSubStreamEncoderParam](https://write.woa.com/document/87030026264555520) 重新设置了画面尺寸。
1180
- <table>
1181
- <tr>
1182
- <td rowspan="1" colSpan="1" >参数</td>
1183
-
1184
- <td rowspan="1" colSpan="1" >描述</td>
1185
- </tr>
1186
-
1187
- <tr>
1188
- <td rowspan="1" colSpan="1" >newHeight</td>
1189
-
1190
- <td rowspan="1" colSpan="1" >视频流的高度（像素）。</td>
1191
- </tr>
1192
-
1193
- <tr>
1194
- <td rowspan="1" colSpan="1" >newWidth</td>
1195
-
1196
- <td rowspan="1" colSpan="1" >视频流的宽度（像素）。</td>
1197
- </tr>
1198
-
1199
- <tr>
1200
- <td rowspan="1" colSpan="1" >streamType</td>
1201
-
1202
- <td rowspan="1" colSpan="1" >视频流类型：主路（Main）一般用于承载摄像头画面，辅路（Sub）一般用于承载屏幕分享画面。</td>
1203
- </tr>
1204
-
1205
- <tr>
1206
- <td rowspan="1" colSpan="1" >userId</td>
1207
-
1208
- <td rowspan="1" colSpan="1" >用户标识。</td>
1209
- </tr>
1210
- </table>
1211
-
1212
-
1213
- ## onNetworkQuality
1214
-
1215
-
1216
-
1217
- #### 网络质量的实时统计回调。
1218
-
1219
- 该统计回调每间隔2秒抛出一次，用于通知 SDK 感知到的当前网络的上行和下行质量。
1220
-
1221
- SDK 会使用一组内嵌的自研算法对当前网络的延迟高低、带宽大小以及稳定情况进行评估，并计算出一个评估结果：如果评估结果为 1（Excellent） 代表当前的网络情况非常好，如果评估结果为 6（Down）代表当前网络无法支撑 TRTC 的正常通话。
1222
- <table>
1223
- <tr>
1224
- <td rowspan="1" colSpan="1" >参数</td>
1225
-
1226
- <td rowspan="1" colSpan="1" >描述</td>
1227
- </tr>
1228
-
1229
- <tr>
1230
- <td rowspan="1" colSpan="1" >localQuality</td>
1231
-
1232
- <td rowspan="1" colSpan="1" >上行网络质量。</td>
1233
- </tr>
1234
-
1235
- <tr>
1236
- <td rowspan="1" colSpan="1" >remoteQuality</td>
1237
-
1238
- <td rowspan="1" colSpan="1" >下行网络质量，代表数据流历经“远端->云端->本端”这样一条完整的传输链路后，最终在本端统计到的数据质量。因此，这里的下行网络质量代表的是远端上行链路与本端下行链路共同影响的结果。</td>
1239
- </tr>
1240
- </table>
1241
-
1242
-
1243
- > **注意**
1244
- >
1245
-
1246
- > 暂时无法通过该接口单独判定远端用户的上行质量。
1247
- >
1248
-
1249
-
1250
- ## onStatistics
1251
-
1252
-
1253
-
1254
- #### 音视频技术指标的实时统计回调。
1255
-
1256
- 该统计回调每间隔2秒抛出一次，用于通知 SDK 内部音频、视频以及网络相关的专业技术指标，这些信息在 [TRTCStatistics](https://write.woa.com/document/87030057818304512) 均有罗列：
1257
- - 视频统计信息：视频的分辨率（resolution）、帧率（FPS）和比特率（bitrate）等信息。
1258
-
1259
- - 音频统计信息：音频的采样率（samplerate）、声道（channel）和比特率（bitrate）等信息。
1260
-
1261
- - 网络统计信息：SDK 和云端一次往返（SDK > Cloud > SDK）的网络耗时（rtt）、丢包率（loss）、上行流量（sentBytes）和下行流量（receivedBytes）等信息。
1262
-
1263
- <table>
1264
- <tr>
1265
- <td rowspan="1" colSpan="1" >参数</td>
1266
-
1267
- <td rowspan="1" colSpan="1" >描述</td>
1268
- </tr>
1269
-
1270
- <tr>
1271
- <td rowspan="1" colSpan="1" >statistics</td>
1272
-
1273
- <td rowspan="1" colSpan="1" >统计数据，包括自己本地的统计信息和远端用户的统计信息，详情请参考 [TRTCStatistics](https://write.woa.com/document/87030057818304512)。</td>
1274
- </tr>
1275
- </table>
1276
-
1277
-
1278
- > **注意**
1279
- >
1280
-
1281
- > 如果您只需要获知当前网络质量的好坏，并不需要花太多时间研究本统计回调，更推荐您使用 [onNetworkQuality](https://write.woa.com/document/87030021158866944) 来解决问题。
1282
- >
1283
-
1284
-
1285
- ## onSpeedTestResult
1286
-
1287
-
1288
-
1289
- #### 网速测试的结果回调。
1290
-
1291
- 该统计回调由 [startSpeedTest](https://write.woa.com/document/87030026264555520) 触发。
1292
- <table>
1293
- <tr>
1294
- <td rowspan="1" colSpan="1" >参数</td>
1295
-
1296
- <td rowspan="1" colSpan="1" >描述</td>
1297
- </tr>
1298
-
1299
- <tr>
1300
- <td rowspan="1" colSpan="1" >result</td>
1301
-
1302
- <td rowspan="1" colSpan="1" >网速测试结果，包括丢包、往返延迟、上下行的带宽速率，详情请参见 [TRTCSpeedTestResult](https://write.woa.com/document/87030132707430400)。</td>
1303
- </tr>
1304
- </table>
1305
-
1306
-
1307
- ## onConnectionLost
1308
-
1309
-
1310
-
1311
- #### SDK 与云端的连接已经断开。
1312
-
1313
- SDK 会在跟云端的连接断开时抛出此事件回调，导致断开的原因大多是网络不可用或者网络切换所致，例如用户在通话中走进电梯时就可能会遇到此事件。
1314
-
1315
- 在抛出此事件之后，SDK 会努力跟云端重新建立连接，重连过程中会抛出 [onTryToReconnect](https://write.woa.com/document/87030021158866944)，连接恢复后会抛出 [onConnectionRecovery](https://write.woa.com/document/87030021158866944) 。
1316
-
1317
- 所以，SDK 会在如下三个连接相关的事件中按如下规律切换：
1318
-
1319
- ![](https://qcloudimg.tencent-cloud.cn/raw/fb3c40a4fca55b0010d385cf3b2472cd.png)
1320
-
1321
- ## onTryToReconnect
1322
-
1323
-
1324
-
1325
- #### SDK 正在尝试重新连接到云端。
1326
-
1327
- SDK 会在跟云端的连接断开时抛出 [onConnectionLost](https://write.woa.com/document/87030021158866944)，之后会努力跟云端重新建立连接并抛出本事件，连接恢复后会抛出 [onConnectionRecovery](https://write.woa.com/document/87030021158866944)。
1328
-
1329
- ## onConnectionRecovery
1330
-
1331
-
1332
-
1333
- #### SDK 与云端的连接已经恢复。
1334
-
1335
- SDK 会在跟云端的连接断开时抛出 [onConnectionLost](https://write.woa.com/document/87030021158866944)，之后会努力跟云端重新建立连接并抛出 [onTryToReconnect](https://write.woa.com/document/87030021158866944)，连接恢复后会抛出本事件回调。
1336
-
1337
- ## onCameraDidReady
1338
-
1339
-
1340
-
1341
- #### 摄像头准备就绪。
1342
-
1343
- 当您调用 [startLocalPreview](https://write.woa.com/document/87030026264555520) 之后，SDK 会尝试启动摄像头，如果摄像头能够启动成功就会抛出本事件。
1344
-
1345
- 如果启动失败，大概率是因为当前应用没有获得访问摄像头的权限，或者摄像头当前正在被其他程序独占使用中。
1346
-
1347
- 您可以通过捕获 [onError](https://write.woa.com/document/87030021158866944) 事件回调获知这些异常情况并通过 UI 界面提示用户。
1348
-
1349
- ## onMicDidReady
1350
-
1351
-
1352
-
1353
- #### 麦克风准备就绪。
1354
-
1355
- 当您调用 [startLocalAudio](https://write.woa.com/document/87030026264555520) 之后，SDK 会尝试启动麦克风，如果麦克风能够启动成功就会抛出本事件。
1356
-
1357
- 如果启动失败，大概率是因为当前应用没有获得访问麦克风的权限，或者麦克风当前正在被其他程序独占使用中。
1358
-
1359
- 您可以通过捕获 [onError](https://write.woa.com/document/87030021158866944) 事件回调获知这些异常情况并通过 UI 界面提示用户。
1360
-
1361
- ## onAudioRouteChanged
1362
-
1363
-
1364
-
1365
- #### 当前音频路由发生变化（仅适用于移动设备）。
1366
-
1367
- 所谓“音频路由”，是指声音是从手机的扬声器还是从听筒中播放出来，音频路由变化也就是声音的播放位置发生了变化。
1368
- - 当音频路由为听筒时，声音比较小，只有将耳朵凑近才能听清楚，隐私性较好，适合用于接听电话。
1369
-
1370
- - 当音频路由为扬声器时，声音比较大，不用将手机贴脸也能听清，因此可以实现“免提”的功能。
1371
-
1372
- - 当音频路由为有线耳机。
1373
-
1374
- - 当音频路由为蓝牙耳机。
1375
-
1376
- - 当音频路由为USB专业声卡设备。
1377
-
1378
- <table>
1379
- <tr>
1380
- <td rowspan="1" colSpan="1" >参数</td>
1381
-
1382
- <td rowspan="1" colSpan="1" >描述</td>
1383
- </tr>
1384
-
1385
- <tr>
1386
- <td rowspan="1" colSpan="1" >fromRoute</td>
1387
-
1388
- <td rowspan="1" colSpan="1" >变更前的音频路由。</td>
1389
- </tr>
1390
-
1391
- <tr>
1392
- <td rowspan="1" colSpan="1" >route</td>
1393
-
1394
- <td rowspan="1" colSpan="1" >音频路由，即声音由哪里输出（扬声器、听筒）。</td>
1395
- </tr>
1396
- </table>
1397
-
1398
-
1399
- ## onUserVoiceVolume
1400
-
1401
-
1402
-
1403
- #### 音量大小的反馈回调。
1404
-
1405
- SDK 可以评估每一路音频的音量大小，并每隔一段时间抛出该事件回调，您可以根据音量大小在 UI 上做出相应的提示，例如` 波形图 `或` 音量槽 `。
1406
-
1407
- 要完成这个功能， 您需要先调用 [enableAudioVolumeEvaluation](https://write.woa.com/document/87030026264555520) 开启这个能力并设定事件抛出的时间间隔。
1408
-
1409
- 需要补充说明的是，无论当前房间中是否有人说话，SDK 都会按照您设定的时间间隔定时抛出此事件回调。
1410
- <table>
1411
- <tr>
1412
- <td rowspan="1" colSpan="1" >参数</td>
1413
-
1414
- <td rowspan="1" colSpan="1" >描述</td>
1415
- </tr>
1416
-
1417
- <tr>
1418
- <td rowspan="1" colSpan="1" >totalVolume</td>
1419
-
1420
- <td rowspan="1" colSpan="1" >所有远端用户的总音量大小，取值范围 [0, 100]。</td>
1421
- </tr>
1422
-
1423
- <tr>
1424
- <td rowspan="1" colSpan="1" >userVolumes</td>
1425
-
1426
- <td rowspan="1" colSpan="1" >是一个数组，用于承载所有正在说话的用户的音量大小，取值范围 [0, 100]。</td>
1427
- </tr>
1428
- </table>
1429
-
1430
-
1431
- > **注意**
1432
- >
1433
-
1434
- > userVolumes 为一个数组，对于数组中的每一个元素，当 userId 为空时表示本地麦克风采集的音量大小，当 userId 不为空时代表远端用户的音量大小。
1435
- >
1436
-
1437
-
1438
- ## onDeviceChange
1439
-
1440
-
1441
-
1442
- #### 本地设备的通断状态发生变化（仅适用于桌面系统）。
1443
-
1444
- 当本地设备（包括摄像头、麦克风以及扬声器）被插入或者拔出时，SDK 便会抛出此事件回调。
1445
- <table>
1446
- <tr>
1447
- <td rowspan="1" colSpan="1" >参数</td>
1448
-
1449
- <td rowspan="1" colSpan="1" >描述</td>
1450
- </tr>
1451
-
1452
- <tr>
1453
- <td rowspan="1" colSpan="1" >deviceId</td>
1454
-
1455
- <td rowspan="1" colSpan="1" >设备 ID。</td>
1456
- </tr>
1457
-
1458
- <tr>
1459
- <td rowspan="1" colSpan="1" >deviceType</td>
1460
-
1461
- <td rowspan="1" colSpan="1" >设备类型。0：麦克风设备；1：扬声器设备；2：摄像头设备。</td>
1462
- </tr>
1463
-
1464
- <tr>
1465
- <td rowspan="1" colSpan="1" >state</td>
1466
-
1467
- <td rowspan="1" colSpan="1" >通断状态，0：设备已添加；1：设备已被移除；2：设备已启用。</td>
1468
- </tr>
1469
- </table>
1470
-
1471
-
1472
- ## onAudioDeviceCaptureVolumeChanged
1473
-
1474
-
1475
-
1476
- #### 当前麦克风的系统采集音量发生变化。
1477
-
1478
- 在 Mac 或 Windows 这样的桌面操作系统上，用户可以在设置中心找到声音相关的设置面板，并设置麦克风的采集音量大小。
1479
-
1480
- 用户将麦克风的采集音量设置得越大，麦克风采集到的声音的原始音量也就会越大，反之就会越小。
1481
-
1482
- 在有些型号的键盘以及笔记本电脑上，用户还可以通过按下` 禁用麦克风 `按钮（图标是一个` 话筒 `叠加了一道代表禁用的斜线）来将麦克风静音。
1483
-
1484
-
1485
-
1486
- 当用户通过系统设置界面或者通过键盘上的快捷键设定操作系统的麦克风采集音量时，SDK 便会抛出此事件。
1487
- <table>
1488
- <tr>
1489
- <td rowspan="1" colSpan="1" >参数</td>
1490
-
1491
- <td rowspan="1" colSpan="1" >描述</td>
1492
- </tr>
1493
-
1494
- <tr>
1495
- <td rowspan="1" colSpan="1" >muted</td>
1496
-
1497
- <td rowspan="1" colSpan="1" >麦克风是否被用户禁用了：true 被禁用，false 被启用。</td>
1498
- </tr>
1499
-
1500
- <tr>
1501
- <td rowspan="1" colSpan="1" >volume</td>
1502
-
1503
- <td rowspan="1" colSpan="1" >系统采集音量，取值范围 0 - 100，用户可以在系统的声音设置面板上进行拖拽调整。</td>
1504
- </tr>
1505
- </table>
1506
-
1507
-
1508
- > **注意**
1509
- >
1510
-
1511
- > 您需要调用 [enableAudioVolumeEvaluation](https://write.woa.com/document/87030026264555520) 接口并设定 interval 大于 0 开启次事件回调，设定 interval 等于 0 关闭此事件回调。
1512
- >
1513
-
1514
-
1515
- ## onAudioDevicePlayoutVolumeChanged
1516
-
1517
-
1518
-
1519
- #### 当前系统的播放音量发生变化。
1520
-
1521
- 在 Mac 或 Windows 这样的桌面操作系统上，用户可以在设置中心找到声音相关的设置面板，并设置系统的播放音量大小。
1522
-
1523
- 在有些型号的键盘以及笔记本电脑上，用户还可以通过按下“静音”按钮（图标是一个喇叭上叠加了一道代表禁用的斜线）来将系统静音。
1524
-
1525
-
1526
-
1527
- 当用户通过系统设置界面或者通过键盘上的快捷键设定操作系统的播放音量时，SDK 便会抛出此事件。
1528
- <table>
1529
- <tr>
1530
- <td rowspan="1" colSpan="1" >参数</td>
1531
-
1532
- <td rowspan="1" colSpan="1" >描述</td>
1533
- </tr>
1534
-
1535
- <tr>
1536
- <td rowspan="1" colSpan="1" >muted</td>
1537
-
1538
- <td rowspan="1" colSpan="1" >系统是否被用户静音了：true 被静音，false 已恢复。</td>
1539
- </tr>
1540
-
1541
- <tr>
1542
- <td rowspan="1" colSpan="1" >volume</td>
1543
-
1544
- <td rowspan="1" colSpan="1" >系统播放音量，取值范围 [0, 100]，用户可以在系统的声音设置面板上进行拖拽调整。</td>
1545
- </tr>
1546
- </table>
1547
-
1548
-
1549
- > **注意**
1550
- >
1551
-
1552
- > 您需要调用 [enableAudioVolumeEvaluation](https://write.woa.com/document/87030026264555520) 接口并设定 interval 大于 0 开启次事件回调，设定 interval 等于 0 关闭此事件回调。
1553
- >
1554
-
1555
-
1556
- ## onSystemAudioLoopbackError
1557
-
1558
-
1559
-
1560
- #### 系统声音采集是否被成功开启的事件回调（仅适用于桌面系统）。
1561
-
1562
- 在 Mac 系统上，您可以通过调用 [startSystemAudioLoopback](https://write.woa.com/document/87030026264555520) 为当前系统安装一个音频驱动，并让 SDK 通过该音频驱动捕获当前 Mac 系统播放出的声音。
1563
-
1564
- 在 Windows 系统上，您可以通过调用 [startSystemAudioLoopback](https://write.woa.com/document/87030026264555520) 让 SDK 捕获当前 Windows 系统播放出的声音。
1565
-
1566
- 当用于播片教学或音乐直播中，例如老师端可以使用此功能，让 SDK 能够采集老师所播放的电影中的声音，使同房间的学生端也能听到电影中的声音。
1567
-
1568
- SDK 会将系统声音采集是否被成功开启的结果，通过本事件回调抛出，需要您关注参数中的错误码。
1569
- <table>
1570
- <tr>
1571
- <td rowspan="1" colSpan="1" >参数</td>
1572
-
1573
- <td rowspan="1" colSpan="1" >描述</td>
1574
- </tr>
1575
-
1576
- <tr>
1577
- <td rowspan="1" colSpan="1" >err</td>
1578
-
1579
- <td rowspan="1" colSpan="1" >ERR_NULL 表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。</td>
1580
- </tr>
1581
- </table>
1582
-
1583
-
1584
- ## onTestMicVolume
1585
-
1586
-
1587
-
1588
- #### 测试麦克风时的音量回调。
1589
-
1590
- 当您调用 [startMicDeviceTest](https://write.woa.com/document/87030115247763456) 测试麦克风是否正常工作时，SDK 会不断地抛出此回调，参数中的 volume 代表当前麦克风采集到的音量大小。
1591
-
1592
- 如果在测试期间 volume 出现了大小波动的情况，说明麦克风状态健康；如果 volume 的数值始终是 0，说明麦克风的状态异常，需要提示用户进行更换。
1593
- <table>
1594
- <tr>
1595
- <td rowspan="1" colSpan="1" >参数</td>
1596
-
1597
- <td rowspan="1" colSpan="1" >描述</td>
1598
- </tr>
1599
-
1600
- <tr>
1601
- <td rowspan="1" colSpan="1" >volume</td>
1602
-
1603
- <td rowspan="1" colSpan="1" >麦克风采集到的音量值，取值范围 [0, 100]。</td>
1604
- </tr>
1605
- </table>
1606
-
1607
-
1608
- ## onTestSpeakerVolume
1609
-
1610
-
1611
-
1612
- #### 测试扬声器时的音量回调。
1613
-
1614
- 当您调用 [startSpeakerDeviceTest](https://write.woa.com/document/87030115247763456) 测试扬声器是否正常工作时，SDK 会不断地抛出此回调。
1615
-
1616
- 参数中的 volume 代表的是 SDK 提交给系统扬声器去播放的声音的音量值大小，如果该数值持续变化，但用户反馈听不到声音，则说明扬声器状态异常。
1617
- <table>
1618
- <tr>
1619
- <td rowspan="1" colSpan="1" >参数</td>
1620
-
1621
- <td rowspan="1" colSpan="1" >描述</td>
1622
- </tr>
1623
-
1624
- <tr>
1625
- <td rowspan="1" colSpan="1" >volume</td>
1626
-
1627
- <td rowspan="1" colSpan="1" >SDK 提交给扬声器去播放的声音的音量，取值范围 [0, 100]。</td>
1628
- </tr>
1629
- </table>
1630
-
1631
-
1632
- ## onRecvCustomCmdMsg
1633
-
1634
-
1635
-
1636
- #### 收到自定义消息的事件回调。
1637
-
1638
- 当房间中的某个用户使用 [sendCustomCmdMsg](https://write.woa.com/document/87030026264555520) 发送自定义 UDP 消息时，房间中的其他用户可以通过 ` onRecvCustomCmdMsg ` 事件回调接收到该条消息。
1639
- <table>
1640
- <tr>
1641
- <td rowspan="1" colSpan="1" >参数</td>
1642
-
1643
- <td rowspan="1" colSpan="1" >描述</td>
1644
- </tr>
1645
-
1646
- <tr>
1647
- <td rowspan="1" colSpan="1" >cmdID</td>
1648
-
1649
- <td rowspan="1" colSpan="1" >命令 ID。</td>
1650
- </tr>
1651
-
1652
- <tr>
1653
- <td rowspan="1" colSpan="1" >message</td>
1654
-
1655
- <td rowspan="1" colSpan="1" >消息数据。</td>
1656
- </tr>
1657
-
1658
- <tr>
1659
- <td rowspan="1" colSpan="1" >seq</td>
1660
-
1661
- <td rowspan="1" colSpan="1" >消息序号。</td>
1662
- </tr>
1663
-
1664
- <tr>
1665
- <td rowspan="1" colSpan="1" >userId</td>
1666
-
1667
- <td rowspan="1" colSpan="1" >用户标识。</td>
1668
- </tr>
1669
- </table>
1670
-
1671
-
1672
- ## onMissCustomCmdMsg
1673
-
1674
-
1675
-
1676
- #### 自定义消息丢失的事件回调。
1677
-
1678
- 当您使用 [sendCustomCmdMsg](https://write.woa.com/document/87030026264555520) 发送自定义 UDP 消息时，即使设置了可靠传输（reliable），也无法确 100% 不丢失，只是丢消息概率极低，能满足常规可靠性要求。
1679
-
1680
- 在发送端设置了可靠运输（reliable）后，SDK 都会通过此回调通知过去时间段内（通常为5s）传输途中丢失的自定义消息数量统计信息。
1681
- <table>
1682
- <tr>
1683
- <td rowspan="1" colSpan="1" >参数</td>
1684
-
1685
- <td rowspan="1" colSpan="1" >描述</td>
1686
- </tr>
1687
-
1688
- <tr>
1689
- <td rowspan="1" colSpan="1" >cmdID</td>
1690
-
1691
- <td rowspan="1" colSpan="1" >命令 ID。</td>
1692
- </tr>
1693
-
1694
- <tr>
1695
- <td rowspan="1" colSpan="1" >errCode</td>
1696
-
1697
- <td rowspan="1" colSpan="1" >错误码。</td>
1698
- </tr>
1699
-
1700
- <tr>
1701
- <td rowspan="1" colSpan="1" >missed</td>
1702
-
1703
- <td rowspan="1" colSpan="1" >丢失的消息数量。</td>
1704
- </tr>
1705
-
1706
- <tr>
1707
- <td rowspan="1" colSpan="1" >userId</td>
1708
-
1709
- <td rowspan="1" colSpan="1" >用户标识。</td>
1710
- </tr>
1711
- </table>
1712
-
1713
-
1714
- > **注意**
1715
- >
1716
-
1717
- > 只有在发送端设置了可靠传输（reliable），接收方才能收到消息的丢失回调。
1718
- >
1719
-
1720
-
1721
- ## onRecvSEIMsg
1722
-
1723
-
1724
-
1725
- #### 收到 SEI 消息的回调。
1726
-
1727
- 当房间中的某个用户使用 [sendSEIMsg](https://write.woa.com/document/87030026264555520) 借助视频数据帧发送 SEI 消息时，房间中的其他用户可以通过 ` onRecvSEIMsg ` 事件回调接收到该条消息。
1728
- <table>
1729
- <tr>
1730
- <td rowspan="1" colSpan="1" >参数</td>
1731
-
1732
- <td rowspan="1" colSpan="1" >描述</td>
1733
- </tr>
1734
-
1735
- <tr>
1736
- <td rowspan="1" colSpan="1" >message</td>
1737
-
1738
- <td rowspan="1" colSpan="1" >数据。</td>
1739
- </tr>
1740
-
1741
- <tr>
1742
- <td rowspan="1" colSpan="1" >userId</td>
1743
-
1744
- <td rowspan="1" colSpan="1" >用户标识。</td>
1745
- </tr>
1746
- </table>
1747
-
1748
-
1749
- ## onStartPublishing
1750
-
1751
-
1752
-
1753
- #### 开始向腾讯云直播 CDN 上发布音视频流的事件回调。
1754
-
1755
- 当您调用 startPublishing 开始向腾讯云直播 CDN 上发布音视频流时，SDK 会立刻将这一指令同步给云端服务器。
1756
-
1757
- 随后 SDK 会收到来自云端服务器的处理结果，并将指令的执行结果通过本事件回调通知给您。
1758
- <table>
1759
- <tr>
1760
- <td rowspan="1" colSpan="1" >参数</td>
1761
-
1762
- <td rowspan="1" colSpan="1" >描述</td>
1763
- </tr>
1764
-
1765
- <tr>
1766
- <td rowspan="1" colSpan="1" >err</td>
1767
-
1768
- <td rowspan="1" colSpan="1" >0表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。</td>
1769
- </tr>
1770
-
1771
- <tr>
1772
- <td rowspan="1" colSpan="1" >errMsg</td>
1773
-
1774
- <td rowspan="1" colSpan="1" >具体错误原因。</td>
1775
- </tr>
1776
- </table>
1777
-
1778
-
1779
- ## onStopPublishing
1780
-
1781
-
1782
-
1783
- #### 停止向腾讯云直播 CDN 上发布音视频流的事件回调。
1784
-
1785
- 当您调用 stopPublishing 停止向腾讯云直播 CDN 上发布音视频流时，SDK 会立刻将这一指令同步给云端服务器。
1786
-
1787
- 随后 SDK 会收到来自云端服务器的处理结果，并将指令的执行结果通过本事件回调通知给您。
1788
- <table>
1789
- <tr>
1790
- <td rowspan="1" colSpan="1" >参数</td>
1791
-
1792
- <td rowspan="1" colSpan="1" >描述</td>
1793
- </tr>
1794
-
1795
- <tr>
1796
- <td rowspan="1" colSpan="1" >err</td>
1797
-
1798
- <td rowspan="1" colSpan="1" >0表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。</td>
1799
- </tr>
1800
-
1801
- <tr>
1802
- <td rowspan="1" colSpan="1" >errMsg</td>
1803
-
1804
- <td rowspan="1" colSpan="1" >具体错误原因。</td>
1805
- </tr>
1806
- </table>
1807
-
1808
-
1809
- ## onStartPublishCDNStream
1810
-
1811
-
1812
-
1813
- #### 开始向非腾讯云 CDN 上发布音视频流的事件回调。
1814
-
1815
- 当您调用 startPublishCDNStream 开始向非腾讯云直播 CDN 上发布音视频流时，SDK 会立刻将这一指令同步给云端服务器。随后 SDK 会收到来自云端服务器的处理结果，并将指令的执行结果通过本事件回调通知给您。
1816
- <table>
1817
- <tr>
1818
- <td rowspan="1" colSpan="1" >参数</td>
1819
-
1820
- <td rowspan="1" colSpan="1" >描述</td>
1821
- </tr>
1822
-
1823
- <tr>
1824
- <td rowspan="1" colSpan="1" >err</td>
1825
-
1826
- <td rowspan="1" colSpan="1" >0表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。</td>
1827
- </tr>
1828
-
1829
- <tr>
1830
- <td rowspan="1" colSpan="1" >errMsg</td>
1831
-
1832
- <td rowspan="1" colSpan="1" >具体错误原因。</td>
1833
- </tr>
1834
- </table>
1835
-
1836
-
1837
- > **注意**
1838
- >
1839
-
1840
- > 当您收到成功的事件回调时，只是说明您的发布指令已经同步到腾讯云后台服务器，但如果目标 CDN 厂商的服务器不接收该条视频流，依然可能导致发布失败。
1841
- >
1842
-
1843
-
1844
- ## onStopPublishCDNStream
1845
-
1846
-
1847
-
1848
- #### 停止向非腾讯云 CDN 上发布音视频流的事件回调。
1849
-
1850
- 当您调用 stopPublishCDNStream 开始向非腾讯云直播 CDN 上发布音视频流时，SDK 会立刻将这一指令同步给云端服务器。随后 SDK 会收到来自云端服务器的处理结果，并将指令的执行结果通过本事件回调通知给您。
1851
- <table>
1852
- <tr>
1853
- <td rowspan="1" colSpan="1" >参数</td>
1854
-
1855
- <td rowspan="1" colSpan="1" >描述</td>
1856
- </tr>
1857
-
1858
- <tr>
1859
- <td rowspan="1" colSpan="1" >err</td>
1860
-
1861
- <td rowspan="1" colSpan="1" >0表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。</td>
1862
- </tr>
1863
-
1864
- <tr>
1865
- <td rowspan="1" colSpan="1" >errMsg</td>
1866
-
1867
- <td rowspan="1" colSpan="1" >具体错误原因。</td>
1868
- </tr>
1869
- </table>
1870
-
1871
-
1872
- ## onSetMixTranscodingConfig
1873
-
1874
-
1875
-
1876
- #### 设置云端混流的排版布局和转码参数的事件回调。
1877
-
1878
- 当您调用 setMixTranscodingConfig 调整云端混流的排版布局和转码参数时，SDK 会立刻将这一调整指令同步给云端服务器。随后 SDK 会收到来自云端服务器的处理结果，并将指令的执行结果通过本事件回调通知给您。
1879
- <table>
1880
- <tr>
1881
- <td rowspan="1" colSpan="1" >参数</td>
1882
-
1883
- <td rowspan="1" colSpan="1" >描述</td>
1884
- </tr>
1885
-
1886
- <tr>
1887
- <td rowspan="1" colSpan="1" >err</td>
1888
-
1889
- <td rowspan="1" colSpan="1" >错误码：0表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。</td>
1890
- </tr>
1891
-
1892
- <tr>
1893
- <td rowspan="1" colSpan="1" >errMsg</td>
1894
-
1895
- <td rowspan="1" colSpan="1" >具体的错误原因。</td>
1896
- </tr>
1897
- </table>
1898
-
363
+ | 参数 | 描述 |
364
+ | --- | --- |
365
+ | extrainfo | 额外信息。 |
366
+ | reason | 视频状态改变的原因。 |
367
+ | status | 视频状态：包括 Playing、Loading 和 Stopped 三种状态。 |
368
+ | streamType | 视频流类型：主路（Main）一般用于承载摄像头画面，辅路（Sub）一般用于承载屏幕分享画面。 |
369
+ | userId | 用户标识。 |
1899
370
 
1900
- ## onStartPublishMediaStream
371
+ ## onRemoteAudioStatusUpdated
1901
372
 
373
+ #### 远端音频状态变化的事件回调。
1902
374
 
375
+ 您可以通过此事件回调获取远端每一路音频的播放状态（包括 Playing、Loading 和 Stopped 三种状态），从而进行相应的 UI 展示。
376
+ | 参数 | 描述 |
377
+ | --- | --- |
378
+ | extrainfo | 额外信息。 |
379
+ | reason | 音频状态改变的原因。 |
380
+ | status | 音频状态：包括 Playing、Loading 和 Stopped 三种状态。 |
381
+ | userId | 用户标识。 |
1903
382
 
1904
- #### 开始发布媒体流的事件回调。
383
+ ## onUserVideoSizeChanged
1905
384
 
1906
- 当您调用 [startPublishMediaStream](https://write.woa.com/document/87030026264555520) 开始向 TRTC 后台服务发布媒体流时，SDK 会立刻将这一指令同步给云端服务器，随后 SDK 会收到来自云端服务器的处理结果，并将指令的执行结果通过本事件回调通知给您。
1907
- <table>
1908
- <tr>
1909
- <td rowspan="1" colSpan="1" >参数</td>
385
+ #### 用户视频大小发生改变回调。
1910
386
 
1911
- <td rowspan="1" colSpan="1" >描述</td>
1912
- </tr>
387
+ 当您收到 ` onUserVideoSizeChanged(userId, streamType, newWidth, newHeight) ` 通知时，表示该路画面大小发生了调整，调整的原因可能是该用户调用了 setVideoEncoderParam 或者 setSubStreamEncoderParam 重新设置了画面尺寸。
388
+ | 参数 | 描述 |
389
+ | --- | --- |
390
+ | newHeight | 视频流的高度（像素）。 |
391
+ | newWidth | 视频流的宽度（像素）。 |
392
+ | streamType | 视频流类型：主路（Main）一般用于承载摄像头画面，辅路（Sub）一般用于承载屏幕分享画面。 |
393
+ | userId | 用户标识。 |
1913
394
 
1914
- <tr>
1915
- <td rowspan="1" colSpan="1" >code</td>
395
+ ## onNetworkQuality
1916
396
 
1917
- <td rowspan="1" colSpan="1" >回调结果，0 表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。</td>
1918
- </tr>
397
+ #### 网络质量的实时统计回调。
1919
398
 
1920
- <tr>
1921
- <td rowspan="1" colSpan="1" >extraInfo</td>
399
+ 该统计回调每间隔2秒抛出一次，用于通知 SDK 感知到的当前网络的上行和下行质量。
1922
400
 
1923
- <td rowspan="1" colSpan="1" >扩展信息字段，个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时，意味着服务器无法处理您的请求，此时可使用"error_code"做为 key 获取到服务器返回的错误码，具体的错误码以及建议处理措施说明如下：<br>- 2000: 参数错误，建议检查请求参数<br>- 2001: 未开通直播服务，建议去直播控制台开通直播服务<br>- 2021: 未开通转推第三方服务，建议联系产品开通转推第三方服务<br>- 3000: 服务器内部错误，建议重试<br>- 4006: 同一个任务并发冲突，上一个 startPublishMediaStream 任务服务器还在处理中，建议延迟重试<br>- 4007: 同一个任务已经通过 startPublishMediaStream 启动成功，建议使用返回的 taskId 调用 updatePublishMediaStream 接口更新任务<br>- 5001: 资源受限，建议延迟重试</td>
1924
- </tr>
401
+ SDK 会使用一组内嵌的自研算法对当前网络的延迟高低、带宽大小以及稳定情况进行评估，并计算出一个评估结果：如果评估结果为 1（Excellent） 代表当前的网络情况非常好，如果评估结果为 6（Down）代表当前网络无法支撑 TRTC 的正常通话。
402
+ | 参数 | 描述 |
403
+ | --- | --- |
404
+ | localQuality | 上行网络质量。 |
405
+ | remoteQuality | 下行网络质量，代表数据流历经“远端->云端->本端”这样一条完整的传输链路后，最终在本端统计到的数据质量。因此，这里的下行网络质量代表的是远端上行链路与本端下行链路共同影响的结果。 |
1925
406
 
1926
- <tr>
1927
- <td rowspan="1" colSpan="1" >message</td>
407
+ > **注意**
408
+ >
1928
409
 
1929
- <td rowspan="1" colSpan="1" >具体回调信息。</td>
1930
- </tr>
410
+ > 暂时无法通过该接口单独判定远端用户的上行质量。
411
+ >
1931
412
 
1932
- <tr>
1933
- <td rowspan="1" colSpan="1" >taskId</td>
413
+ ## onStatistics
1934
414
 
1935
- <td rowspan="1" colSpan="1" >当请求成功时，TRTC 后台会在回调中提供给您这项任务的 taskId，后续您可以通过该 taskId 结合 [updatePublishMediaStream](https://write.woa.com/document/87030026264555520) 和 [stopPublishMediaStream](https://write.woa.com/document/87030026264555520) 进行更新和停止。</td>
1936
- </tr>
1937
- </table>
415
+ #### 音视频技术指标的实时统计回调。
1938
416
 
417
+ 该统计回调每间隔2秒抛出一次，用于通知 SDK 内部音频、视频以及网络相关的专业技术指标，这些信息在 TRTCStatistics 均有罗列：
418
+ - 视频统计信息：视频的分辨率（resolution）、帧率（FPS）和比特率（bitrate）等信息。
1939
419
 
1940
- ## onUpdatePublishMediaStream
420
+ - 音频统计信息：音频的采样率（samplerate）、声道（channel）和比特率（bitrate）等信息。
1941
421
 
422
+ - 网络统计信息：SDK 和云端一次往返（SDK > Cloud > SDK）的网络耗时（rtt）、丢包率（loss）、上行流量（sentBytes）和下行流量（receivedBytes）等信息。
1942
423
 
424
+ | 参数 | 描述 |
425
+ | --- | --- |
426
+ | statistics | 统计数据，包括自己本地的统计信息和远端用户的统计信息，详情请参考 TRTCStatistics。 |
1943
427
 
1944
- #### 更新媒体流的事件回调。
428
+ > **注意**
429
+ >
1945
430
 
1946
- 当您调用媒体流发布接口 ([updatePublishMediaStream](https://write.woa.com/document/87030026264555520)) 开始向 TRTC 后台服务更新媒体流时，SDK 会立刻将这一指令同步给云端服务器，随后 SDK 会收到来自云端服务器的处理结果，并将指令的执行结果通过本事件回调通知给您。
1947
- <table>
1948
- <tr>
1949
- <td rowspan="1" colSpan="1" >参数</td>
431
+ > 如果您只需要获知当前网络质量的好坏，并不需要花太多时间研究本统计回调，更推荐您使用 onNetworkQuality 来解决问题。
432
+ >
1950
433
 
1951
- <td rowspan="1" colSpan="1" >描述</td>
1952
- </tr>
434
+ ## onSpeedTestResult
1953
435
 
1954
- <tr>
1955
- <td rowspan="1" colSpan="1" >code</td>
436
+ #### 网速测试的结果回调。
1956
437
 
1957
- <td rowspan="1" colSpan="1" >回调结果，0 表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。</td>
1958
- </tr>
438
+ 该统计回调由 startSpeedTest 触发。
439
+ | 参数 | 描述 |
440
+ | --- | --- |
441
+ | result | 网速测试结果，包括丢包、往返延迟、上下行的带宽速率，详情请参见 TRTCSpeedTestResult。 |
1959
442
 
1960
- <tr>
1961
- <td rowspan="1" colSpan="1" >extraInfo</td>
443
+ ## onConnectionLost
1962
444
 
1963
- <td rowspan="1" colSpan="1" >扩展信息字段，个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时，意味着服务器无法处理您的请求，此时可使用"error_code"做为 key 获取到服务器返回的错误码，具体的错误码以及建议处理措施说明如下：<br>- 2000: 参数错误，建议检查请求参数<br>- 2001: 未开通直播服务，建议去直播控制台开通直播服务<br>- 2002: 找不到任务，建议调用 startPublishMediaStream 接口重新启动任务<br>- 2018: 并发请求乱序，建议使用最新混流参数重试<br>- 2021: 未开通转推第三方服务，建议联系产品开通转推第三方服务<br>- 3000: 服务器内部错误，建议重试<br>- 4003: 任务正在退出中，建议先调用 stopPublishMediaStream 接口停止任务，再调用 startPublishMediaStream 接口启动任务</td>
1964
- </tr>
445
+ #### SDK 与云端的连接已经断开。
1965
446
 
1966
- <tr>
1967
- <td rowspan="1" colSpan="1" >message</td>
447
+ SDK 会在跟云端的连接断开时抛出此事件回调，导致断开的原因大多是网络不可用或者网络切换所致，例如用户在通话中走进电梯时就可能会遇到此事件。
1968
448
 
1969
- <td rowspan="1" colSpan="1" >具体回调信息。</td>
1970
- </tr>
449
+ 在抛出此事件之后，SDK 会努力跟云端重新建立连接，重连过程中会抛出 onTryToReconnect，连接恢复后会抛出 onConnectionRecovery 。
1971
450
 
1972
- <tr>
1973
- <td rowspan="1" colSpan="1" >taskId</td>
451
+ 所以，SDK 会在如下三个连接相关的事件中按如下规律切换：
1974
452
 
1975
- <td rowspan="1" colSpan="1" >您调用媒体流发布接口 ([updatePublishMediaStream](https://write.woa.com/document/87030026264555520)) 时传入的 taskId，会通过此回调再带回给您，用于标识该回调属于哪一次更新请求。</td>
1976
- </tr>
1977
- </table>
453
+ ## onTryToReconnect
1978
454
 
455
+ #### SDK 正在尝试重新连接到云端。
1979
456
 
1980
- ## onStopPublishMediaStream
457
+ SDK 会在跟云端的连接断开时抛出 onConnectionLost，之后会努力跟云端重新建立连接并抛出本事件，连接恢复后会抛出 onConnectionRecovery。
1981
458
 
459
+ ## onConnectionRecovery
1982
460
 
461
+ #### SDK 与云端的连接已经恢复。
1983
462
 
1984
- #### 停止媒体流的事件回调。
463
+ SDK 会在跟云端的连接断开时抛出 onConnectionLost，之后会努力跟云端重新建立连接并抛出 onTryToReconnect，连接恢复后会抛出本事件回调。
1985
464
 
1986
- 当您调用停止发布媒体流 ([stopPublishMediaStream](https://write.woa.com/document/87030026264555520)) 开始向 TRTC 后台服务停止媒体流时，SDK 会立刻将这一指令同步给云端服务器，随后 SDK 会收到来自云端服务器的处理结果，并将指令的执行结果通过本事件回调通知给您。
1987
- <table>
1988
- <tr>
1989
- <td rowspan="1" colSpan="1" >参数</td>
465
+ ## onCameraDidReady
1990
466
 
1991
- <td rowspan="1" colSpan="1" >描述</td>
1992
- </tr>
467
+ #### 摄像头准备就绪。
1993
468
 
1994
- <tr>
1995
- <td rowspan="1" colSpan="1" >code</td>
469
+ 当您调用 startLocalPreview 之后，SDK 会尝试启动摄像头，如果摄像头能够启动成功就会抛出本事件。
1996
470
 
1997
- <td rowspan="1" colSpan="1" >回调结果，0 表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。</td>
1998
- </tr>
471
+ 如果启动失败，大概率是因为当前应用没有获得访问摄像头的权限，或者摄像头当前正在被其他程序独占使用中。
1999
472
 
2000
- <tr>
2001
- <td rowspan="1" colSpan="1" >extraInfo</td>
473
+ 您可以通过捕获 onError 事件回调获知这些异常情况并通过 UI 界面提示用户。
2002
474
 
2003
- <td rowspan="1" colSpan="1" >扩展信息字段，个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时，意味着服务器无法处理您的请求，此时可使用"error_code"做为 key 获取到服务器返回的错误码，具体的错误码以及建议处理措施说明如下：<br>- 2000: 参数错误，建议检查请求参数<br>- 2002: 找不到任务，无需处理<br>- 3000: 服务器内部错误，建议重试<br>- 4003: 任务正在退出中，无需处理</td>
2004
- </tr>
475
+ ## onMicDidReady
2005
476
 
2006
- <tr>
2007
- <td rowspan="1" colSpan="1" >message</td>
477
+ #### 麦克风准备就绪。
2008
478
 
2009
- <td rowspan="1" colSpan="1" >具体回调信息。</td>
2010
- </tr>
479
+ 当您调用 startLocalAudio 之后，SDK 会尝试启动麦克风，如果麦克风能够启动成功就会抛出本事件。
2011
480
 
2012
- <tr>
2013
- <td rowspan="1" colSpan="1" >taskId</td>
481
+ 如果启动失败，大概率是因为当前应用没有获得访问麦克风的权限，或者麦克风当前正在被其他程序独占使用中。
2014
482
 
2015
- <td rowspan="1" colSpan="1" >您调用停止发布媒体流 ([stopPublishMediaStream](https://write.woa.com/document/87030026264555520)) 时传入的 taskId，会通过此回调再带回给您，用于标识该回调属于哪一次停止请求。</td>
2016
- </tr>
2017
- </table>
483
+ 您可以通过捕获 onError 事件回调获知这些异常情况并通过 UI 界面提示用户。
2018
484
 
485
+ ## onAudioRouteChanged
2019
486
 
2020
- ## onCdnStreamStateChanged
487
+ #### 当前音频路由发生变化（仅适用于移动设备）。
2021
488
 
489
+ 所谓“音频路由”，是指声音是从手机的扬声器还是从听筒中播放出来，音频路由变化也就是声音的播放位置发生了变化。
490
+ - 当音频路由为听筒时，声音比较小，只有将耳朵凑近才能听清楚，隐私性较好，适合用于接听电话。
2022
491
 
492
+ - 当音频路由为扬声器时，声音比较大，不用将手机贴脸也能听清，因此可以实现“免提”的功能。
2023
493
 
2024
- #### RTMP/RTMPS 推流状态发生改变回调。
494
+ - 当音频路由为有线耳机。
2025
495
 
2026
- 当您调用 [startPublishMediaStream](https://write.woa.com/document/87030026264555520) 开始向 TRTC 后台服务发布媒体流时，SDK 会立刻将这一指令同步给云端服务。
496
+ - 当音频路由为蓝牙耳机。
2027
497
 
2028
- 若您在目标推流配置 ([TRTCPublishTarget](https://write.woa.com/document/87030132707430400)) 设置了向腾讯或者第三方 CDN 上发布音视频流的 URL 配置，则具体 RTMP 或者 RTMPS 推流状态将通过此回调同步给您。
2029
- <table>
2030
- <tr>
2031
- <td rowspan="1" colSpan="1" >参数</td>
498
+ - 当音频路由为USB专业声卡设备。
2032
499
 
2033
- <td rowspan="1" colSpan="1" >描述</td>
2034
- </tr>
500
+ | 参数 | 描述 |
501
+ | --- | --- |
502
+ | fromRoute | 变更前的音频路由。 |
503
+ | route | 音频路由，即声音由哪里输出（扬声器、听筒）。 |
2035
504
 
2036
- <tr>
2037
- <td rowspan="1" colSpan="1" >cdnUrl</td>
505
+ ## onUserVoiceVolume
2038
506
 
2039
- <td rowspan="1" colSpan="1" >您调用 [startPublishMediaStream](https://write.woa.com/document/87030026264555520) 时通过目标推流配置 ([TRTCPublishTarget](https://write.woa.com/document/87030132707430400)) 传入的 url，在推流状态变更时，会通过此回调同步给您。</td>
2040
- </tr>
507
+ #### 音量大小的反馈回调。
2041
508
 
2042
- <tr>
2043
- <td rowspan="1" colSpan="1" >code</td>
509
+ SDK 可以评估每一路音频的音量大小，并每隔一段时间抛出该事件回调，您可以根据音量大小在 UI 上做出相应的提示，例如` 波形图 `或` 音量槽 `。
2044
510
 
2045
- <td rowspan="1" colSpan="1" >推流结果，0 表示成功，其余值表示出错，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。</td>
2046
- </tr>
511
+ 要完成这个功能， 您需要先调用 enableAudioVolumeEvaluation 开启这个能力并设定事件抛出的时间间隔。
2047
512
 
2048
- <tr>
2049
- <td rowspan="1" colSpan="1" >extraInfo</td>
513
+ 需要补充说明的是，无论当前房间中是否有人说话，SDK 都会按照您设定的时间间隔定时抛出此事件回调。
514
+ | 参数 | 描述 |
515
+ | --- | --- |
516
+ | totalVolume | 所有远端用户的总音量大小，取值范围 [0, 100]。 |
517
+ | userVolumes | 是一个数组，用于承载所有正在说话的用户的音量大小，取值范围 [0, 100]。 |
2050
518
 
2051
- <td rowspan="1" colSpan="1" >扩展信息字段，个别错误码可能会带额外的信息帮助定位问题。</td>
2052
- </tr>
519
+ > **注意**
520
+ >
2053
521
 
2054
- <tr>
2055
- <td rowspan="1" colSpan="1" >message</td>
522
+ > userVolumes 为一个数组，对于数组中的每一个元素，当 userId 为空时表示本地麦克风采集的音量大小，当 userId 不为空时代表远端用户的音量大小。
523
+ >
2056
524
 
2057
- <td rowspan="1" colSpan="1" >具体推流信息。</td>
2058
- </tr>
525
+ ## onDeviceChange
2059
526
 
2060
- <tr>
2061
- <td rowspan="1" colSpan="1" >status</td>
527
+ #### 本地设备的通断状态发生变化（仅适用于桌面系统）。
2062
528
 
2063
- <td rowspan="1" colSpan="1" >推流状态。<br>- 0：推流未开始或者已结束。在您调用 [stopPublishMediaStream](https://write.woa.com/document/87030026264555520) 时会返回该状态。<br>- 1：正在连接 TRTC 服务器和 CDN 服务器。若无法立刻成功，TRTC 后台服务会多次重试尝试推流，并返回该状态（5s回调一次）。如成功进行推流，则进入状态 2；如服务器出错或 60 秒内未成功推流，则进入状态 4。<br>- 2：CDN 推流正在进行。在成功推流后，会返回该状态。<br>- 3：TRTC 服务器和 CDN 服务器推流中断，正在恢复。当 CDN 出现异常，或推流短暂中断时，TRTC 后台服务会自动尝试恢复推流，并返回该状态（5s回调一次）。如成功恢复推流，则进入状态 2；如服务器出错或 60 秒内未成功恢复，则进入状态 4。<br>- 4：TRTC 服务器和 CDN 服务器推流中断，且恢复或连接超时。即此时推流失败，您可以再次调用 [updatePublishMediaStream](https://write.woa.com/document/87030026264555520) 尝试推流。<br>- 5：正在断开 TRTC 服务器和 CDN 服务器。在您调用 [stopPublishMediaStream](https://write.woa.com/document/87030026264555520) 时，TRTC 后台服务会依次同步状态 5 和状态 0。</td>
2064
- </tr>
2065
- </table>
529
+ 当本地设备（包括摄像头、麦克风以及扬声器）被插入或者拔出时，SDK 便会抛出此事件回调。
530
+ | 参数 | 描述 |
531
+ | --- | --- |
532
+ | deviceId | 设备 ID。 |
533
+ | deviceType | 设备类型。0：麦克风设备；1：扬声器设备；2：摄像头设备。 |
534
+ | state | 通断状态，0：设备已添加；1：设备已被移除；2：设备已启用。 |
2066
535
 
536
+ ## onAudioDeviceCaptureVolumeChanged
2067
537
 
2068
- ## onScreenCaptureStarted
538
+ #### 当前麦克风的系统采集音量发生变化。
2069
539
 
540
+ 在 Mac 或 Windows 这样的桌面操作系统上，用户可以在设置中心找到声音相关的设置面板，并设置麦克风的采集音量大小。
2070
541
 
542
+ 用户将麦克风的采集音量设置得越大，麦克风采集到的声音的原始音量也就会越大，反之就会越小。
2071
543
 
2072
- #### 屏幕分享开启的事件回调。
544
+ 在有些型号的键盘以及笔记本电脑上，用户还可以通过按下` 禁用麦克风 `按钮（图标是一个` 话筒 `叠加了一道代表禁用的斜线）来将麦克风静音。
2073
545
 
2074
- 当您通过 [startScreenCapture](https://write.woa.com/document/87030026264555520) 等相关接口启动屏幕分享时，SDK 便会抛出此事件回调。
546
+ 当用户通过系统设置界面或者通过键盘上的快捷键设定操作系统的麦克风采集音量时，SDK 便会抛出此事件。
547
+ | 参数 | 描述 |
548
+ | --- | --- |
549
+ | muted | 麦克风是否被用户禁用了：true 被禁用，false 被启用。 |
550
+ | volume | 系统采集音量，取值范围 0 - 100，用户可以在系统的声音设置面板上进行拖拽调整。 |
2075
551
 
2076
- ## onScreenCapturePaused
552
+ > **注意**
553
+ >
2077
554
 
555
+ > 您需要调用 enableAudioVolumeEvaluation 接口并设定 interval 大于 0 开启次事件回调，设定 interval 等于 0 关闭此事件回调。
556
+ >
2078
557
 
558
+ ## onAudioDevicePlayoutVolumeChanged
2079
559
 
2080
- #### 屏幕分享暂停的事件回调。
560
+ #### 当前系统的播放音量发生变化。
2081
561
 
2082
- 当您通过 [pauseScreenCapture](https://write.woa.com/document/87030026264555520) 暂停屏幕分享时，SDK 便会抛出此事件回调。
2083
- <table>
2084
- <tr>
2085
- <td rowspan="1" colSpan="1" >参数</td>
562
+ 在 Mac 或 Windows 这样的桌面操作系统上，用户可以在设置中心找到声音相关的设置面板，并设置系统的播放音量大小。
2086
563
 
2087
- <td rowspan="1" colSpan="1" >描述</td>
2088
- </tr>
564
+ 在有些型号的键盘以及笔记本电脑上，用户还可以通过按下“静音”按钮（图标是一个喇叭上叠加了一道代表禁用的斜线）来将系统静音。
2089
565
 
2090
- <tr>
2091
- <td rowspan="1" colSpan="1" >reason</td>
566
+ 当用户通过系统设置界面或者通过键盘上的快捷键设定操作系统的播放音量时，SDK 便会抛出此事件。
567
+ | 参数 | 描述 |
568
+ | --- | --- |
569
+ | muted | 系统是否被用户静音了：true 被静音，false 已恢复。 |
570
+ | volume | 系统播放音量，取值范围 [0, 100]，用户可以在系统的声音设置面板上进行拖拽调整。 |
2092
571
 
2093
- <td rowspan="1" colSpan="1" >原因。<br>- 0：用户主动暂停。<br>- 1：注意此字段的含义在 MAC 和 Windows 平台有稍微差异。屏幕窗口不可见暂停（Mac）。表示设置屏幕分享参数导致的暂停（Windows）。<br>- 2：表示屏幕分享窗口被最小化导致的暂停（仅 Windows）。<br>- 3：表示屏幕分享窗口被隐藏导致的暂停（仅 Windows）。<br>- 4：表示屏幕共享因系统操作而暂停（仅 iOS）。</td>
2094
- </tr>
2095
- </table>
572
+ > **注意**
573
+ >
2096
574
 
575
+ > 您需要调用 enableAudioVolumeEvaluation 接口并设定 interval 大于 0 开启次事件回调，设定 interval 等于 0 关闭此事件回调。
576
+ >
2097
577
 
2098
- ## onScreenCaptureResumed
578
+ ## onSystemAudioLoopbackError
2099
579
 
580
+ #### 系统声音采集是否被成功开启的事件回调（仅适用于桌面系统）。
2100
581
 
582
+ 在 Mac 系统上，您可以通过调用 startSystemAudioLoopback 为当前系统安装一个音频驱动，并让 SDK 通过该音频驱动捕获当前 Mac 系统播放出的声音。
2101
583
 
2102
- #### 屏幕分享恢复的事件回调。
584
+ 在 Windows 系统上，您可以通过调用 startSystemAudioLoopback 让 SDK 捕获当前 Windows 系统播放出的声音。
2103
585
 
2104
- 当您通过 [resumeScreenCapture](https://write.woa.com/document/87030026264555520) 恢复屏幕分享时，SDK 便会抛出此事件回调。
2105
- <table>
2106
- <tr>
2107
- <td rowspan="1" colSpan="1" >参数</td>
586
+ 当用于播片教学或音乐直播中，例如老师端可以使用此功能，让 SDK 能够采集老师所播放的电影中的声音，使同房间的学生端也能听到电影中的声音。
2108
587
 
2109
- <td rowspan="1" colSpan="1" >描述</td>
2110
- </tr>
588
+ SDK 会将系统声音采集是否被成功开启的结果，通过本事件回调抛出，需要您关注参数中的错误码。
589
+ | 参数 | 描述 |
590
+ | --- | --- |
591
+ | err | ERR_NULL 表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
2111
592
 
2112
- <tr>
2113
- <td rowspan="1" colSpan="1" >reason</td>
593
+ ## onTestMicVolume
2114
594
 
2115
- <td rowspan="1" colSpan="1" >恢复原因。<br>- 0：用户主动恢复。<br>- 1：注意此字段的含义在 MAC 和 Windows 平台有稍微差异。屏幕窗口恢复可见从而恢复分享（Mac）。屏幕分享参数设置完毕后自动恢复（Windows）。<br>- 2：表示屏幕分享窗口从最小化被恢复（仅 Windows）。<br>- 3：表示屏幕分享窗口从隐藏被恢复（仅 Windows）。<br>- 4：表示屏幕共享因系统操作而恢复（仅 iOS）。</td>
2116
- </tr>
2117
- </table>
595
+ #### 测试麦克风时的音量回调。
2118
596
 
597
+ 当您调用 startMicDeviceTest 测试麦克风是否正常工作时，SDK 会不断地抛出此回调，参数中的 volume 代表当前麦克风采集到的音量大小。
2119
598
 
2120
- ## onScreenCaptureStoped
599
+ 如果在测试期间 volume 出现了大小波动的情况，说明麦克风状态健康；如果 volume 的数值始终是 0，说明麦克风的状态异常，需要提示用户进行更换。
600
+ | 参数 | 描述 |
601
+ | --- | --- |
602
+ | volume | 麦克风采集到的音量值，取值范围 [0, 100]。 |
2121
603
 
604
+ ## onTestSpeakerVolume
2122
605
 
606
+ #### 测试扬声器时的音量回调。
2123
607
 
2124
- #### 屏幕分享停止的事件回调。
608
+ 当您调用 startSpeakerDeviceTest 测试扬声器是否正常工作时，SDK 会不断地抛出此回调。
2125
609
 
2126
- 当您通过 [stopScreenCapture](https://write.woa.com/document/87030026264555520) 停止屏幕分享时，SDK 便会抛出此事件回调。
2127
- <table>
2128
- <tr>
2129
- <td rowspan="1" colSpan="1" >参数</td>
610
+ 参数中的 volume 代表的是 SDK 提交给系统扬声器去播放的声音的音量值大小，如果该数值持续变化，但用户反馈听不到声音，则说明扬声器状态异常。
611
+ | 参数 | 描述 |
612
+ | --- | --- |
613
+ | volume | SDK 提交给扬声器去播放的声音的音量，取值范围 [0, 100]。 |
2130
614
 
2131
- <td rowspan="1" colSpan="1" >描述</td>
2132
- </tr>
615
+ ## onRecvCustomCmdMsg
2133
616
 
2134
- <tr>
2135
- <td rowspan="1" colSpan="1" >reason</td>
617
+ #### 收到自定义消息的事件回调。
2136
618
 
2137
- <td rowspan="1" colSpan="1" >停止原因，0：用户主动停止；1：屏幕窗口关闭导致停止；2：表示屏幕分享的显示屏状态变更（如接口被拔出、投影模式变更等）。</td>
2138
- </tr>
2139
- </table>
619
+ 当房间中的某个用户使用 sendCustomCmdMsg 发送自定义 UDP 消息时，房间中的其他用户可以通过 ` onRecvCustomCmdMsg ` 事件回调接收到该条消息。
620
+ | 参数 | 描述 |
621
+ | --- | --- |
622
+ | cmdID | 命令 ID。 |
623
+ | message | 消息数据。 |
624
+ | seq | 消息序号。 |
625
+ | userId | 用户标识。 |
2140
626
 
627
+ ## onMissCustomCmdMsg
2141
628
 
2142
- ## onScreenCaptureCovered
629
+ #### 自定义消息丢失的事件回调。
2143
630
 
631
+ 当您使用 sendCustomCmdMsg 发送自定义 UDP 消息时，即使设置了可靠传输（reliable），也无法确 100% 不丢失，只是丢消息概率极低，能满足常规可靠性要求。
2144
632
 
633
+ 在发送端设置了可靠运输（reliable）后，SDK 都会通过此回调通知过去时间段内（通常为5s）传输途中丢失的自定义消息数量统计信息。
634
+ | 参数 | 描述 |
635
+ | --- | --- |
636
+ | cmdID | 命令 ID。 |
637
+ | errCode | 错误码。 |
638
+ | missed | 丢失的消息数量。 |
639
+ | userId | 用户标识。 |
2145
640
 
2146
- #### 屏幕分享的目标窗口被遮挡的事件回调（仅适用于 Windows 操作系统）。
641
+ > **注意**
642
+ >
2147
643
 
2148
- 当屏幕分享的目标窗口被遮挡无法正常捕获时，SDK 会抛出此事件回调，您可以在捕获到该事件回调后，通过 UI 上的一些变化来提示用户移开遮盖窗口。
644
+ > 只有在发送端设置了可靠传输（reliable），接收方才能收到消息的丢失回调。
645
+ >
2149
646
 
2150
- ## onLocalRecordBegin
647
+ ## onRecvSEIMsg
2151
648
 
649
+ #### 收到 SEI 消息的回调。
2152
650
 
651
+ 当房间中的某个用户使用 sendSEIMsg 借助视频数据帧发送 SEI 消息时，房间中的其他用户可以通过 ` onRecvSEIMsg ` 事件回调接收到该条消息。
652
+ | 参数 | 描述 |
653
+ | --- | --- |
654
+ | message | 数据。 |
655
+ | userId | 用户标识。 |
2153
656
 
2154
- #### 本地录制任务已经开始的事件回调。
657
+ ## onStartPublishing
2155
658
 
2156
- 当您调用 [startLocalRecording](https://write.woa.com/document/87030026264555520) 启动本地媒体录制任务时，SDK 会抛出该事件回调，用于通知您录制任务是否已经顺利启动。
2157
- <table>
2158
- <tr>
2159
- <td rowspan="1" colSpan="1" >参数</td>
659
+ #### 开始向腾讯云直播 CDN 上发布音视频流的事件回调。
2160
660
 
2161
- <td rowspan="1" colSpan="1" >描述</td>
2162
- </tr>
661
+ 当您调用 startPublishing 开始向腾讯云直播 CDN 上发布音视频流时，SDK 会立刻将这一指令同步给云端服务器。
2163
662
 
2164
- <tr>
2165
- <td rowspan="1" colSpan="1" >errCode</td>
663
+ 随后 SDK 会收到来自云端服务器的处理结果，并将指令的执行结果通过本事件回调通知给您。
664
+ | 参数 | 描述 |
665
+ | --- | --- |
666
+ | err | 0表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
667
+ | errMsg | 具体错误原因。 |
2166
668
 
2167
- <td rowspan="1" colSpan="1" >状态码。<br>- 0：录制任务启动成功。<br>- -1：内部错误导致录制任务启动失败。<br>- -2：文件后缀名有误（例如不支持的录制格式）。<br>- -6：录制已经启动，需要先停止录制。<br>- -7：录制文件已存在，需要先删除文件。<br>- -8：录制目录无写入权限，请检查目录权限问题。</td>
2168
- </tr>
669
+ ## onStopPublishing
2169
670
 
2170
- <tr>
2171
- <td rowspan="1" colSpan="1" >storagePath</td>
671
+ #### 停止向腾讯云直播 CDN 上发布音视频流的事件回调。
2172
672
 
2173
- <td rowspan="1" colSpan="1" >录制文件存储路径。</td>
2174
- </tr>
2175
- </table>
673
+ 当您调用 stopPublishing 停止向腾讯云直播 CDN 上发布音视频流时，SDK 会立刻将这一指令同步给云端服务器。
2176
674
 
675
+ 随后 SDK 会收到来自云端服务器的处理结果，并将指令的执行结果通过本事件回调通知给您。
676
+ | 参数 | 描述 |
677
+ | --- | --- |
678
+ | err | 0表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
679
+ | errMsg | 具体错误原因。 |
2177
680
 
2178
- ## onLocalRecording
681
+ ## onStartPublishCDNStream
2179
682
 
683
+ #### 开始向非腾讯云 CDN 上发布音视频流的事件回调。
2180
684
 
685
+ 当您调用 startPublishCDNStream 开始向非腾讯云直播 CDN 上发布音视频流时，SDK 会立刻将这一指令同步给云端服务器。随后 SDK 会收到来自云端服务器的处理结果，并将指令的执行结果通过本事件回调通知给您。
686
+ | 参数 | 描述 |
687
+ | --- | --- |
688
+ | err | 0表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
689
+ | errMsg | 具体错误原因。 |
2181
690
 
2182
- #### 本地录制任务正在进行中的进展事件回调。
691
+ > **注意**
692
+ >
2183
693
 
2184
- 当您调用 [startLocalRecording](https://write.woa.com/document/87030026264555520) 成功启动本地媒体录制任务后，SDK 会定时地抛出本事件回调。
694
+ > 当您收到成功的事件回调时，只是说明您的发布指令已经同步到腾讯云后台服务器，但如果目标 CDN 厂商的服务器不接收该条视频流，依然可能导致发布失败。
695
+ >
2185
696
 
2186
- 您可通过捕获该事件回调来获知录制任务的健康状况。
697
+ ## onStopPublishCDNStream
2187
698
 
2188
- 您可以在 [startLocalRecording](https://write.woa.com/document/87030026264555520) 时设定本事件回调的抛出间隔。
2189
- <table>
2190
- <tr>
2191
- <td rowspan="1" colSpan="1" >参数</td>
699
+ #### 停止向非腾讯云 CDN 上发布音视频流的事件回调。
2192
700
 
2193
- <td rowspan="1" colSpan="1" >描述</td>
2194
- </tr>
701
+ 当您调用 stopPublishCDNStream 开始向非腾讯云直播 CDN 上发布音视频流时，SDK 会立刻将这一指令同步给云端服务器。随后 SDK 会收到来自云端服务器的处理结果，并将指令的执行结果通过本事件回调通知给您。
702
+ | 参数 | 描述 |
703
+ | --- | --- |
704
+ | err | 0表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
705
+ | errMsg | 具体错误原因。 |
2195
706
 
2196
- <tr>
2197
- <td rowspan="1" colSpan="1" >duration</td>
707
+ ## onSetMixTranscodingConfig
2198
708
 
2199
- <td rowspan="1" colSpan="1" >已经录制的累计时长，单位毫秒。</td>
2200
- </tr>
709
+ #### 设置云端混流的排版布局和转码参数的事件回调。
2201
710
 
2202
- <tr>
2203
- <td rowspan="1" colSpan="1" >storagePath</td>
711
+ 当您调用 setMixTranscodingConfig 调整云端混流的排版布局和转码参数时，SDK 会立刻将这一调整指令同步给云端服务器。随后 SDK 会收到来自云端服务器的处理结果，并将指令的执行结果通过本事件回调通知给您。
712
+ | 参数 | 描述 |
713
+ | --- | --- |
714
+ | err | 错误码：0表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
715
+ | errMsg | 具体的错误原因。 |
2204
716
 
2205
- <td rowspan="1" colSpan="1" >录制文件存储路径。</td>
2206
- </tr>
2207
- </table>
717
+ ## onStartPublishMediaStream
2208
718
 
719
+ #### 开始发布媒体流的事件回调。
2209
720
 
2210
- ## onLocalRecordFragment
721
+ 当您调用 startPublishMediaStream 开始向 TRTC 后台服务发布媒体流时，SDK 会立刻将这一指令同步给云端服务器，随后 SDK 会收到来自云端服务器的处理结果，并将指令的执行结果通过本事件回调通知给您。
722
+ | 参数 | 描述 |
723
+ | --- | --- |
724
+ | code | 回调结果，0 表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
725
+ | extraInfo | 扩展信息字段，个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时，意味着服务器无法处理您的请求，此时可使用"error_code"做为 key 获取到服务器返回的错误码，具体的错误码以及建议处理措施说明如下：<br>- 2000: 参数错误，建议检查请求参数<br>- 2001: 未开通直播服务，建议去直播控制台开通直播服务<br>- 2021: 未开通转推第三方服务，建议联系产品开通转推第三方服务<br>- 3000: 服务器内部错误，建议重试<br>- 4006: 同一个任务并发冲突，上一个 startPublishMediaStream 任务服务器还在处理中，建议延迟重试<br>- 4007: 同一个任务已经通过 startPublishMediaStream 启动成功，建议使用返回的 taskId 调用 updatePublishMediaStream 接口更新任务<br>- 5001: 资源受限，建议延迟重试 |
726
+ | message | 具体回调信息。 |
727
+ | taskId | 当请求成功时，TRTC 后台会在回调中提供给您这项任务的 taskId，后续您可以通过该 taskId 结合 updatePublishMediaStream 和 stopPublishMediaStream 进行更新和停止。 |
2211
728
 
729
+ ## onUpdatePublishMediaStream
2212
730
 
731
+ #### 更新媒体流的事件回调。
2213
732
 
2214
- #### 本地录制分片的事件回调。
733
+ 当您调用媒体流发布接口 (updatePublishMediaStream) 开始向 TRTC 后台服务更新媒体流时，SDK 会立刻将这一指令同步给云端服务器，随后 SDK 会收到来自云端服务器的处理结果，并将指令的执行结果通过本事件回调通知给您。
734
+ | 参数 | 描述 |
735
+ | --- | --- |
736
+ | code | 回调结果，0 表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
737
+ | extraInfo | 扩展信息字段，个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时，意味着服务器无法处理您的请求，此时可使用"error_code"做为 key 获取到服务器返回的错误码，具体的错误码以及建议处理措施说明如下：<br>- 2000: 参数错误，建议检查请求参数<br>- 2001: 未开通直播服务，建议去直播控制台开通直播服务<br>- 2002: 找不到任务，建议调用 startPublishMediaStream 接口重新启动任务<br>- 2018: 并发请求乱序，建议使用最新混流参数重试<br>- 2021: 未开通转推第三方服务，建议联系产品开通转推第三方服务<br>- 3000: 服务器内部错误，建议重试<br>- 4003: 任务正在退出中，建议先调用 stopPublishMediaStream 接口停止任务，再调用 startPublishMediaStream 接口启动任务 |
738
+ | message | 具体回调信息。 |
739
+ | taskId | 您调用媒体流发布接口 (updatePublishMediaStream) 时传入的 taskId，会通过此回调再带回给您，用于标识该回调属于哪一次更新请求。 |
2215
740
 
2216
- 当您开启分片录制时，每完成一个分片，都会通过此接口回调。
2217
- <table>
2218
- <tr>
2219
- <td rowspan="1" colSpan="1" >参数</td>
741
+ ## onStopPublishMediaStream
2220
742
 
2221
- <td rowspan="1" colSpan="1" >描述</td>
2222
- </tr>
743
+ #### 停止媒体流的事件回调。
2223
744
 
2224
- <tr>
2225
- <td rowspan="1" colSpan="1" >storagePath</td>
745
+ 当您调用停止发布媒体流 (stopPublishMediaStream) 开始向 TRTC 后台服务停止媒体流时，SDK 会立刻将这一指令同步给云端服务器，随后 SDK 会收到来自云端服务器的处理结果，并将指令的执行结果通过本事件回调通知给您。
746
+ | 参数 | 描述 |
747
+ | --- | --- |
748
+ | code | 回调结果，0 表示成功，其余值表示失败，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
749
+ | extraInfo | 扩展信息字段，个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时，意味着服务器无法处理您的请求，此时可使用"error_code"做为 key 获取到服务器返回的错误码，具体的错误码以及建议处理措施说明如下：<br>- 2000: 参数错误，建议检查请求参数<br>- 2002: 找不到任务，无需处理<br>- 3000: 服务器内部错误，建议重试<br>- 4003: 任务正在退出中，无需处理 |
750
+ | message | 具体回调信息。 |
751
+ | taskId | 您调用停止发布媒体流 (stopPublishMediaStream) 时传入的 taskId，会通过此回调再带回给您，用于标识该回调属于哪一次停止请求。 |
2226
752
 
2227
- <td rowspan="1" colSpan="1" >分片文件存储路径。</td>
2228
- </tr>
2229
- </table>
753
+ ## onCdnStreamStateChanged
2230
754
 
755
+ #### RTMP/RTMPS 推流状态发生改变回调。
2231
756
 
2232
- ## onLocalRecordComplete
757
+ 当您调用 startPublishMediaStream 开始向 TRTC 后台服务发布媒体流时，SDK 会立刻将这一指令同步给云端服务。
2233
758
 
759
+ 若您在目标推流配置 (TRTCPublishTarget) 设置了向腾讯或者第三方 CDN 上发布音视频流的 URL 配置，则具体 RTMP 或者 RTMPS 推流状态将通过此回调同步给您。
760
+ | 参数 | 描述 |
761
+ | --- | --- |
762
+ | cdnUrl | 您调用 startPublishMediaStream 时通过目标推流配置 (TRTCPublishTarget) 传入的 url，在推流状态变更时，会通过此回调同步给您。 |
763
+ | code | 推流结果，0 表示成功，其余值表示出错，详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
764
+ | extraInfo | 扩展信息字段，个别错误码可能会带额外的信息帮助定位问题。 |
765
+ | message | 具体推流信息。 |
766
+ | status | 推流状态。<br>- 0：推流未开始或者已结束。在您调用 stopPublishMediaStream 时会返回该状态。<br>- 1：正在连接 TRTC 服务器和 CDN 服务器。若无法立刻成功，TRTC 后台服务会多次重试尝试推流，并返回该状态（5s回调一次）。如成功进行推流，则进入状态 2；如服务器出错或 60 秒内未成功推流，则进入状态 4。<br>- 2：CDN 推流正在进行。在成功推流后，会返回该状态。<br>- 3：TRTC 服务器和 CDN 服务器推流中断，正在恢复。当 CDN 出现异常，或推流短暂中断时，TRTC 后台服务会自动尝试恢复推流，并返回该状态（5s回调一次）。如成功恢复推流，则进入状态 2；如服务器出错或 60 秒内未成功恢复，则进入状态 4。<br>- 4：TRTC 服务器和 CDN 服务器推流中断，且恢复或连接超时。即此时推流失败，您可以再次调用 updatePublishMediaStream 尝试推流。<br>- 5：正在断开 TRTC 服务器和 CDN 服务器。在您调用 stopPublishMediaStream 时，TRTC 后台服务会依次同步状态 5 和状态 0。 |
2234
767
 
768
+ ## onScreenCaptureStarted
2235
769
 
2236
- #### 本地录制任务已经结束的事件回调。
770
+ #### 屏幕分享开启的事件回调。
2237
771
 
2238
- 当您调用 [stopLocalRecording](https://write.woa.com/document/87030026264555520) 停止本地媒体录制任务时，SDK 会抛出该事件回调，用于通知您录制任务的最终结果。
2239
- <table>
2240
- <tr>
2241
- <td rowspan="1" colSpan="1" >参数</td>
772
+ 当您通过 startScreenCapture 等相关接口启动屏幕分享时，SDK 便会抛出此事件回调。
2242
773
 
2243
- <td rowspan="1" colSpan="1" >描述</td>
2244
- </tr>
774
+ ## onScreenCapturePaused
2245
775
 
2246
- <tr>
2247
- <td rowspan="1" colSpan="1" >errCode</td>
776
+ #### 屏幕分享暂停的事件回调。
2248
777
 
2249
- <td rowspan="1" colSpan="1" >状态码。<br>- 0：结束录制任务成功。<br>- -1：录制失败。<br>- -2：切换分辨率或横竖屏导致录制结束。<br>- -3：录制时间太短，或未采集到任何视频或音频数据，请检查录制时长，或是否已开启音、视频采集。</td>
2250
- </tr>
778
+ 当您通过 pauseScreenCapture 暂停屏幕分享时，SDK 便会抛出此事件回调。
779
+ | 参数 | 描述 |
780
+ | --- | --- |
781
+ | reason | 原因。<br>- 0：用户主动暂停。<br>- 1：注意此字段的含义在 MAC 和 Windows 平台有稍微差异。屏幕窗口不可见暂停（Mac）。表示设置屏幕分享参数导致的暂停（Windows）。<br>- 2：表示屏幕分享窗口被最小化导致的暂停（仅 Windows）。<br>- 3：表示屏幕分享窗口被隐藏导致的暂停（仅 Windows）。<br>- 4：表示屏幕共享因系统操作而暂停（仅 iOS）。 |
2251
782
 
2252
- <tr>
2253
- <td rowspan="1" colSpan="1" >storagePath</td>
783
+ ## onScreenCaptureResumed
2254
784
 
2255
- <td rowspan="1" colSpan="1" >录制文件存储路径。</td>
2256
- </tr>
2257
- </table>
785
+ #### 屏幕分享恢复的事件回调。
2258
786
 
787
+ 当您通过 resumeScreenCapture 恢复屏幕分享时，SDK 便会抛出此事件回调。
788
+ | 参数 | 描述 |
789
+ | --- | --- |
790
+ | reason | 恢复原因。<br>- 0：用户主动恢复。<br>- 1：注意此字段的含义在 MAC 和 Windows 平台有稍微差异。屏幕窗口恢复可见从而恢复分享（Mac）。屏幕分享参数设置完毕后自动恢复（Windows）。<br>- 2：表示屏幕分享窗口从最小化被恢复（仅 Windows）。<br>- 3：表示屏幕分享窗口从隐藏被恢复（仅 Windows）。<br>- 4：表示屏幕共享因系统操作而恢复（仅 iOS）。 |
2259
791
 
2260
- ## onSnapshotComplete
792
+ ## onScreenCaptureStoped
2261
793
 
794
+ #### 屏幕分享停止的事件回调。
2262
795
 
796
+ 当您通过 stopScreenCapture 停止屏幕分享时，SDK 便会抛出此事件回调。
797
+ | 参数 | 描述 |
798
+ | --- | --- |
799
+ | reason | 停止原因，0：用户主动停止；1：屏幕窗口关闭导致停止；2：表示屏幕分享的显示屏状态变更（如接口被拔出、投影模式变更等）。 |
2263
800
 
2264
- #### 本地截图完成的事件回调。
2265
- <table>
2266
- <tr>
2267
- <td rowspan="1" colSpan="1" >参数</td>
801
+ ## onScreenCaptureCovered
2268
802
 
2269
- <td rowspan="1" colSpan="1" >描述</td>
2270
- </tr>
803
+ #### 屏幕分享的目标窗口被遮挡的事件回调（仅适用于 Windows 操作系统）。
2271
804
 
2272
- <tr>
2273
- <td rowspan="1" colSpan="1" >bmp</td>
805
+ 当屏幕分享的目标窗口被遮挡无法正常捕获时，SDK 会抛出此事件回调，您可以在捕获到该事件回调后，通过 UI 上的一些变化来提示用户移开遮盖窗口。
2274
806
 
2275
- <td rowspan="1" colSpan="1" >截图结果，如果 bmp 为 null 代表本次截图操作失败。</td>
2276
- </tr>
807
+ ## onLocalRecordBegin
2277
808
 
2278
- <tr>
2279
- <td rowspan="1" colSpan="1" >data</td>
809
+ #### 本地录制任务已经开始的事件回调。
2280
810
 
2281
- <td rowspan="1" colSpan="1" >截图数据，为 nullptr 表示截图失败。</td>
2282
- </tr>
811
+ 当您调用 startLocalRecording 启动本地媒体录制任务时，SDK 会抛出该事件回调，用于通知您录制任务是否已经顺利启动。
812
+ | 参数 | 描述 |
813
+ | --- | --- |
814
+ | errCode | 状态码。<br>- 0：录制任务启动成功。<br>- -1：内部错误导致录制任务启动失败。<br>- -2：文件后缀名有误（例如不支持的录制格式）。<br>- -6：录制已经启动，需要先停止录制。<br>- -7：录制文件已存在，需要先删除文件。<br>- -8：录制目录无写入权限，请检查目录权限问题。 |
815
+ | storagePath | 录制文件存储路径。 |
2283
816
 
2284
- <tr>
2285
- <td rowspan="1" colSpan="1" >format</td>
817
+ ## onLocalRecording
2286
818
 
2287
- <td rowspan="1" colSpan="1" >截图数据格式，目前只支持 [TRTCVideoPixelFormat_BGRA32](https://write.woa.com/document/87030132707430400)。</td>
2288
- </tr>
819
+ #### 本地录制任务正在进行中的进展事件回调。
2289
820
 
2290
- <tr>
2291
- <td rowspan="1" colSpan="1" >height</td>
821
+ 当您调用 startLocalRecording 成功启动本地媒体录制任务后，SDK 会定时地抛出本事件回调。
2292
822
 
2293
- <td rowspan="1" colSpan="1" >截图画面的高度。</td>
2294
- </tr>
823
+ 您可通过捕获该事件回调来获知录制任务的健康状况。
2295
824
 
2296
- <tr>
2297
- <td rowspan="1" colSpan="1" >length</td>
825
+ 您可以在 startLocalRecording 时设定本事件回调的抛出间隔。
826
+ | 参数 | 描述 |
827
+ | --- | --- |
828
+ | duration | 已经录制的累计时长，单位毫秒。 |
829
+ | storagePath | 录制文件存储路径。 |
2298
830
 
2299
- <td rowspan="1" colSpan="1" >截图数据长度，对于BGRA32而言，` length = width * height * 4 `。</td>
2300
- </tr>
831
+ ## onLocalRecordFragment
2301
832
 
2302
- <tr>
2303
- <td rowspan="1" colSpan="1" >type</td>
833
+ #### 本地录制分片的事件回调。
2304
834
 
2305
- <td rowspan="1" colSpan="1" >视频流类型。</td>
2306
- </tr>
835
+ 当您开启分片录制时，每完成一个分片，都会通过此接口回调。
836
+ | 参数 | 描述 |
837
+ | --- | --- |
838
+ | storagePath | 分片文件存储路径。 |
2307
839
 
2308
- <tr>
2309
- <td rowspan="1" colSpan="1" >userId</td>
840
+ ## onLocalRecordComplete
2310
841
 
2311
- <td rowspan="1" colSpan="1" >用户标识，如果 userId 为空字符串，则代表截取的是本地画面。</td>
2312
- </tr>
842
+ #### 本地录制任务已经结束的事件回调。
2313
843
 
2314
- <tr>
2315
- <td rowspan="1" colSpan="1" >width</td>
844
+ 当您调用 stopLocalRecording 停止本地媒体录制任务时，SDK 会抛出该事件回调，用于通知您录制任务的最终结果。
845
+ | 参数 | 描述 |
846
+ | --- | --- |
847
+ | errCode | 状态码。<br>- 0：结束录制任务成功。<br>- -1：录制失败。<br>- -2：切换分辨率或横竖屏导致录制结束。<br>- -3：录制时间太短，或未采集到任何视频或音频数据，请检查录制时长，或是否已开启音、视频采集。 |
848
+ | storagePath | 录制文件存储路径。 |
2316
849
 
2317
- <td rowspan="1" colSpan="1" >截图画面的宽度。</td>
2318
- </tr>
2319
- </table>
850
+ ## onSnapshotComplete
2320
851
 
852
+ #### 本地截图完成的事件回调。
853
+ | 参数 | 描述 |
854
+ | --- | --- |
855
+ | bmp | 截图结果，如果 bmp 为 null 代表本次截图操作失败。 |
856
+ | data | 截图数据，为 nullptr 表示截图失败。 |
857
+ | format | 截图数据格式，目前只支持 TRTCVideoPixelFormat_BGRA32。 |
858
+ | height | 截图画面的高度。 |
859
+ | length | 截图数据长度，对于BGRA32而言，` length = width * height * 4 `。 |
860
+ | type | 视频流类型。 |
861
+ | userId | 用户标识，如果 userId 为空字符串，则代表截取的是本地画面。 |
862
+ | width | 截图画面的宽度。 |
2321
863
 
2322
864
  > **注意**
2323
- >
865
+ >
2324
866
 
2325
867
  > 全平台 C++ 接口和 Java 接口在参数上是不一样的，C++ 接口用 7 个参数描述一个截图画面，Java 接口只用一个 Bitmap 描述一个截图画面。
2326
- >
2327
-
868
+ >
2328
869
 
2329
870
  ## onUserEnter
2330
871
 
2331
-
2332
-
2333
872
  #### 有主播加入当前房间（已废弃）。
2334
873
 
2335
- @deprecated 新版本开始不推荐使用，建议使用 [onRemoteUserEnterRoom](https://write.woa.com/document/87030021158866944) 替代之。
874
+ @deprecated 新版本开始不推荐使用，建议使用 onRemoteUserEnterRoom 替代之。
2336
875
 
2337
876
  ## onUserExit
2338
877
 
2339
-
2340
-
2341
878
  #### 有主播离开当前房间（已废弃）。
2342
879
 
2343
- @deprecated 新版本开始不推荐使用，建议使用 [onRemoteUserLeaveRoom](https://write.woa.com/document/87030021158866944) 替代之。
880
+ @deprecated 新版本开始不推荐使用，建议使用 onRemoteUserLeaveRoom 替代之。
2344
881
 
2345
882
  ## onAudioEffectFinished
2346
883
 
2347
-
2348
-
2349
884
  #### 音效播放已结束（已废弃）。
2350
885
 
2351
886
  @deprecated 新版本开始不推荐使用，建议使用 TXAudioEffectManager 接口替代之。
2352
887
 
2353
- 新的接口中不再区分背景音乐和音效，而是统一用 [startPlayMusic](https://write.woa.com/document/87030074293530624) 取代之。
888
+ 新的接口中不再区分背景音乐和音效，而是统一用 startPlayMusic 取代之。
2354
889
 
2355
890
  ## onPlayBGMBegin
2356
891
 
2357
-
2358
-
2359
892
  #### 开始播放背景音乐（已废弃）。
2360
893
 
2361
- @deprecated 新版本开始不推荐使用，建议使用 [ITXMusicPlayObserver](https://write.woa.com/document/87030074293530624) 接口替代之。
894
+ @deprecated 新版本开始不推荐使用，建议使用 ITXMusicPlayObserver 接口替代之。
2362
895
 
2363
- 新的接口中不再区分背景音乐和音效，而是统一用 [startPlayMusic](https://write.woa.com/document/87030074293530624) 取代之。
896
+ 新的接口中不再区分背景音乐和音效，而是统一用 startPlayMusic 取代之。
2364
897
 
2365
898
  ## onPlayBGMProgress
2366
899
 
2367
-
2368
-
2369
900
  #### 背景音乐的播放进度回调（已废弃）。
2370
901
 
2371
- @deprecated 新版本开始不推荐使用，建议使用 [ITXMusicPlayObserver](https://write.woa.com/document/87030074293530624) 接口替代之。
902
+ @deprecated 新版本开始不推荐使用，建议使用 ITXMusicPlayObserver 接口替代之。
2372
903
 
2373
- 新的接口中不再区分背景音乐和音效，而是统一用 [startPlayMusic](https://write.woa.com/document/87030074293530624) 取代之。
904
+ 新的接口中不再区分背景音乐和音效，而是统一用 startPlayMusic 取代之。
2374
905
 
2375
906
  ## onPlayBGMComplete
2376
907
 
2377
-
2378
-
2379
908
  #### 背景音乐播放已经结束（已废弃）。
2380
909
 
2381
- @deprecated 新版本开始不推荐使用，建议使用 [ITXMusicPlayObserver](https://write.woa.com/document/87030074293530624) 接口替代之。
910
+ @deprecated 新版本开始不推荐使用，建议使用 ITXMusicPlayObserver 接口替代之。
2382
911
 
2383
- 新的接口中不再区分背景音乐和音效，而是统一用 [startPlayMusic](https://write.woa.com/document/87030074293530624) 取代之。
912
+ 新的接口中不再区分背景音乐和音效，而是统一用 startPlayMusic 取代之。
2384
913
 
2385
914
  ## onSpeedTest
2386
915
 
2387
-
2388
-
2389
916
  #### 服务器测速的结果回调（已废弃）。
2390
917
 
2391
- @deprecated 新版本开始不推荐使用，建议使用 [onSpeedTestResult](https://write.woa.com/document/87030021158866944) 接口替代之。
918
+ @deprecated 新版本开始不推荐使用，建议使用 onSpeedTestResult 接口替代之。
2392
919
 
2393
920
  ## onRenderVideoFrame
2394
921
 
2395
-
2396
-
2397
922
  #### 自定义视频渲染回调。
2398
923
 
2399
924
  当您设置了本地或者远端的视频自定义渲染回调之后，SDK 就会将原本要交给渲染控件进行渲染的视频帧通过此回调接口抛送给您，以便于您进行自定义渲染。
2400
- <table>
2401
- <tr>
2402
- <td rowspan="1" colSpan="1" >参数</td>
2403
-
2404
- <td rowspan="1" colSpan="1" >描述</td>
2405
- </tr>
2406
-
2407
- <tr>
2408
- <td rowspan="1" colSpan="1" >frame</td>
2409
-
2410
- <td rowspan="1" colSpan="1" >待渲染的视频帧信息。</td>
2411
- </tr>
2412
-
2413
- <tr>
2414
- <td rowspan="1" colSpan="1" >streamType</td>
2415
-
2416
- <td rowspan="1" colSpan="1" >频流类型：主路（Main）一般用于承载摄像头画面，辅路（Sub）一般用于承载屏幕分享画面。</td>
2417
- </tr>
2418
-
2419
- <tr>
2420
- <td rowspan="1" colSpan="1" >userId</td>
2421
-
2422
- <td rowspan="1" colSpan="1" >视频源的 userId，如果是本地视频回调（setLocalVideoRenderDelegate），该参数可以忽略。</td>
2423
- </tr>
2424
- </table>
2425
-
925
+ | 参数 | 描述 |
926
+ | --- | --- |
927
+ | frame | 待渲染的视频帧信息。 |
928
+ | streamType | 频流类型：主路（Main）一般用于承载摄像头画面，辅路（Sub）一般用于承载屏幕分享画面。 |
929
+ | userId | 视频源的 userId，如果是本地视频回调（setLocalVideoRenderDelegate），该参数可以忽略。 |
2426
930
 
2427
931
  ## onGLContextCreated
2428
932
 
2429
-
2430
-
2431
933
  #### SDK 内部 OpenGL 环境已经创建的通知。
2432
934
 
2433
935
  ## onProcessVideoFrame
2434
936
 
2435
-
2436
-
2437
937
  #### 用于对接第三方美颜组件的视频处理回调。
2438
938
 
2439
939
  如果您选购了第三方美颜组件，就需要在 TRTCCloud 中设置第三方美颜回调，之后 TRTC 就会将原本要进行预处理的视频帧通过此回调接口抛送给您。
2440
940
 
2441
941
  之后您就可以将 TRTC 抛出的视频帧交给第三方美颜组件进行图像处理，由于抛出的数据是可读且可写的，因此第三方美颜的处理结果也可以同步给 TRTC 进行后续的编码和发送。
2442
942
 
2443
-
2444
-
2445
943
  情况一：美颜组件自身会产生新的纹理。
2446
944
 
2447
945
  如果您使用的美颜组件会在处理图像的过程中产生一帧全新的纹理（用于承载处理后的图像），那请您在回调函数中将 dstFrame.textureId 设置为新纹理的 ID：
@@ -2452,8 +950,6 @@ int onProcessVideoFrame(TRTCVideoFrame * srcFrame, TRTCVideoFrame *dstFrame) {
2452
950
  }
2453
951
  ```
2454
952
 
2455
-
2456
-
2457
953
  情况二：美颜组件需要您提供目标纹理。
2458
954
 
2459
955
  如果您使用的第三方美颜模块并不生成新的纹理，而是需要您设置给该模块一个输入纹理和一个输出纹理，则可以考虑如下方案：
@@ -2463,44 +959,23 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
2463
959
  return 0;
2464
960
  }
2465
961
  ```
2466
- <table>
2467
- <tr>
2468
- <td rowspan="1" colSpan="1" >参数</td>
2469
-
2470
- <td rowspan="1" colSpan="1" >描述</td>
2471
- </tr>
2472
-
2473
- <tr>
2474
- <td rowspan="1" colSpan="1" >dstFrame</td>
2475
-
2476
- <td rowspan="1" colSpan="1" >用于接收第三方美颜处理过的视频画面。</td>
2477
- </tr>
2478
-
2479
- <tr>
2480
- <td rowspan="1" colSpan="1" >srcFrame</td>
2481
-
2482
- <td rowspan="1" colSpan="1" >用于承载 TRTC 采集到的摄像头画面。</td>
2483
- </tr>
2484
- </table>
2485
-
962
+ | 参数 | 描述 |
963
+ | --- | --- |
964
+ | dstFrame | 用于接收第三方美颜处理过的视频画面。 |
965
+ | srcFrame | 用于承载 TRTC 采集到的摄像头画面。 |
2486
966
 
2487
967
  > **注意**
2488
- >
968
+ >
2489
969
 
2490
970
  > 目前仅支持 OpenGL 纹理方案（ PC 仅支持 TRTCVideoBufferType_Buffer 格式）。
2491
- >
2492
-
971
+ >
2493
972
 
2494
973
  ## onGLContextDestroy
2495
974
 
2496
-
2497
-
2498
975
  #### SDK 内部 OpenGL 环境被销毁的通知。
2499
976
 
2500
977
  ## onCapturedAudioFrame
2501
978
 
2502
-
2503
-
2504
979
  #### 本地采集并经过音频模块前处理后的音频数据回调。
2505
980
 
2506
981
  当您设置完音频数据自定义回调之后，SDK 内部会把刚采集到并经过前处理(ANS、AEC、AGC）之后的数据，以 PCM 格式的形式通过本接口回调给您。
@@ -2510,38 +985,24 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
2510
985
 
2511
986
  - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例，字节帧长为 ` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
2512
987
 
2513
- <table>
2514
- <tr>
2515
- <td rowspan="1" colSpan="1" >参数</td>
2516
-
2517
- <td rowspan="1" colSpan="1" >描述</td>
2518
- </tr>
2519
-
2520
- <tr>
2521
- <td rowspan="1" colSpan="1" >frame</td>
2522
-
2523
- <td rowspan="1" colSpan="1" >PCM 格式的音频数据帧。</td>
2524
- </tr>
2525
- </table>
2526
-
988
+ | 参数 | 描述 |
989
+ | --- | --- |
990
+ | frame | PCM 格式的音频数据帧。 |
2527
991
 
2528
992
  > **注意**
2529
- >
993
+ >
2530
994
 
2531
995
  > 1. 请不要在此回调函数中做任何耗时操作，由于 SDK 每隔 20ms 就要处理一帧音频数据，如果您的处理时间超过 20ms，就会导致声音异常。
2532
- >
996
+ >
2533
997
 
2534
998
  > 2. 此接口回调出的音频数据是可读写的，也就是说您可以在回调函数中同步修改音频数据，但请保证处理耗时。
2535
- >
999
+ >
2536
1000
 
2537
1001
  > 3. 此接口回调出的音频数据已经经过了前处理(ANS、AEC、AGC），但**不包含**背景音、音效、混响等前处理效果，延迟较低。
2538
- >
2539
-
1002
+ >
2540
1003
 
2541
1004
  ## onLocalProcessedAudioFrame
2542
1005
 
2543
-
2544
-
2545
1006
  #### 本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调。
2546
1007
 
2547
1008
  当您设置完音频数据自定义回调之后，SDK 内部会把刚采集到并经过前处理、音效处理和混 BGM 之后的数据，在最终进行网络编码之前，以 PCM 格式的形式通过本接口回调给您。
@@ -2551,48 +1012,29 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
2551
1012
 
2552
1013
  - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例，字节帧长为` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
2553
1014
 
2554
-
2555
-
2556
-
2557
1015
  特殊说明：
2558
1016
 
2559
1017
  您可以通过设置接口中的 ` TRTCAudioFrame.extraData ` 字段，达到传输信令的目的。由于音频帧头部的数据块不能太大，建议您写入 ` extraData ` 时，尽量将信令控制在几个字节的大小，如果超过 100 个字节，写入的数据不会被发送。
2560
1018
 
2561
-
2562
-
2563
- 房间内其他用户可以通过 [ITRTCAudioFrameCallback](https://write.woa.com/document/87030021158866944) 中的 ` onRemoteUserAudioFrame ` 中的 ` TRTCAudioFrame.extraData ` 字段回调接收数据。
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" >frame</td>
2573
-
2574
- <td rowspan="1" colSpan="1" >PCM 格式的音频数据帧。</td>
2575
- </tr>
2576
- </table>
2577
-
1019
+ 房间内其他用户可以通过 ITRTCAudioFrameCallback 中的 ` onRemoteUserAudioFrame ` 中的 ` TRTCAudioFrame.extraData ` 字段回调接收数据。
1020
+ | 参数 | 描述 |
1021
+ | --- | --- |
1022
+ | frame | PCM 格式的音频数据帧。 |
2578
1023
 
2579
1024
  > **注意**
2580
- >
1025
+ >
2581
1026
 
2582
1027
  > 1. 请不要在此回调函数中做任何耗时操作，由于 SDK 每隔 20ms 就要处理一帧音频数据，如果您的处理时间超过 20ms，就会导致声音异常。
2583
- >
1028
+ >
2584
1029
 
2585
1030
  > 2. 此接口回调出的音频数据是可读写的，也就是说您可以在回调函数中同步修改音频数据，但请保证处理耗时。
2586
- >
2587
-
2588
- > 3. 此接口回调出的数据已经经过了前处理(ANS、AEC、AGC）、音效和混 BGM 处理，声音的延迟相比于 [onCapturedAudioFrame](https://write.woa.com/document/87030021158866944) 要高一些。
2589
- >
1031
+ >
2590
1032
 
1033
+ > 3. 此接口回调出的数据已经经过了前处理(ANS、AEC、AGC）、音效和混 BGM 处理，声音的延迟相比于 onCapturedAudioFrame 要高一些。
1034
+ >
2591
1035
 
2592
1036
  ## onPlayAudioFrame
2593
1037
 
2594
-
2595
-
2596
1038
  #### 混音前的每一路远程用户的音频数据。
2597
1039
 
2598
1040
  当您设置完音频数据自定义回调之后，SDK 内部会把远端的每一路原始数据，在最终混音之前，以 PCM 格式的形式通过本接口回调给您。
@@ -2602,38 +1044,19 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
2602
1044
 
2603
1045
  - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例，字节帧长为` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
2604
1046
 
2605
- <table>
2606
- <tr>
2607
- <td rowspan="1" colSpan="1" >参数</td>
2608
-
2609
- <td rowspan="1" colSpan="1" >描述</td>
2610
- </tr>
2611
-
2612
- <tr>
2613
- <td rowspan="1" colSpan="1" >frame</td>
2614
-
2615
- <td rowspan="1" colSpan="1" >PCM 格式的音频数据帧。</td>
2616
- </tr>
2617
-
2618
- <tr>
2619
- <td rowspan="1" colSpan="1" >userId</td>
2620
-
2621
- <td rowspan="1" colSpan="1" >用户标识。</td>
2622
- </tr>
2623
- </table>
2624
-
1047
+ | 参数 | 描述 |
1048
+ | --- | --- |
1049
+ | frame | PCM 格式的音频数据帧。 |
1050
+ | userId | 用户标识。 |
2625
1051
 
2626
1052
  > **注意**
2627
- >
1053
+ >
2628
1054
 
2629
1055
  > 此接口回调出的音频数据是只读的，不支持修改。
2630
- >
2631
-
1056
+ >
2632
1057
 
2633
1058
  ## onMixedPlayAudioFrame
2634
1059
 
2635
-
2636
-
2637
1060
  #### 将各路待播放音频混合之后并在最终提交系统播放之前的数据回调。
2638
1061
 
2639
1062
  当您设置完音频数据自定义回调之后，SDK 内部会把各路待播放的音频混合之后的音频数据，在提交系统播放之前，以 PCM 格式的形式通过本接口回调给您。
@@ -2643,38 +1066,24 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
2643
1066
 
2644
1067
  - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例，字节帧长为 ` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
2645
1068
 
2646
- <table>
2647
- <tr>
2648
- <td rowspan="1" colSpan="1" >参数</td>
2649
-
2650
- <td rowspan="1" colSpan="1" >描述</td>
2651
- </tr>
2652
-
2653
- <tr>
2654
- <td rowspan="1" colSpan="1" >frame</td>
2655
-
2656
- <td rowspan="1" colSpan="1" >PCM 格式的音频数据帧。</td>
2657
- </tr>
2658
- </table>
2659
-
1069
+ | 参数 | 描述 |
1070
+ | --- | --- |
1071
+ | frame | PCM 格式的音频数据帧。 |
2660
1072
 
2661
1073
  > **注意**
2662
- >
1074
+ >
2663
1075
 
2664
1076
  > 1. 请不要在此回调函数中做任何耗时操作，由于 SDK 每隔 20ms 就要处理一帧音频数据，如果您的处理时间超过 20ms，就会导致声音异常。
2665
- >
1077
+ >
2666
1078
 
2667
1079
  > 2. 此接口回调出的音频数据是可读写的，也就是说您可以在回调函数中同步修改音频数据，但请保证处理耗时。
2668
- >
1080
+ >
2669
1081
 
2670
1082
  > 3. 此接口回调出的是对各路待播放音频数据的混合，但其中并不包含耳返的音频数据。
2671
- >
2672
-
1083
+ >
2673
1084
 
2674
1085
  ## onMixedAllAudioFrame
2675
1086
 
2676
-
2677
-
2678
1087
  #### SDK 所有音频混合后的音频数据（包括采集到的和待播放的）。
2679
1088
 
2680
1089
  当您设置完音频数据自定义回调之后，SDK 内部会把所有采集到的和待播放的音频数据混合起来，以 PCM 格式的形式通过本接口回调给您，便于您进行自定义录制。
@@ -2684,60 +1093,26 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
2684
1093
 
2685
1094
  - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例，字节帧长为 ` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
2686
1095
 
2687
- <table>
2688
- <tr>
2689
- <td rowspan="1" colSpan="1" >参数</td>
2690
-
2691
- <td rowspan="1" colSpan="1" >描述</td>
2692
- </tr>
2693
-
2694
- <tr>
2695
- <td rowspan="1" colSpan="1" >frame</td>
2696
-
2697
- <td rowspan="1" colSpan="1" >PCM 格式的音频数据帧。</td>
2698
- </tr>
2699
- </table>
2700
-
1096
+ | 参数 | 描述 |
1097
+ | --- | --- |
1098
+ | frame | PCM 格式的音频数据帧。 |
2701
1099
 
2702
1100
  > **注意**
2703
- >
1101
+ >
2704
1102
 
2705
1103
  > 1. 此接口回调出的是SDK所有音频数据的混合数据，包括：经过 3A 前处理、特效叠加以及背景音乐混音后的本地音频，所有远端音频，但不包括耳返音频。
2706
- >
1104
+ >
2707
1105
 
2708
1106
  > 2. 此接口回调出的音频数据不支持修改。
2709
- >
2710
-
1107
+ >
2711
1108
 
2712
1109
  ## onLog
2713
1110
 
2714
-
2715
-
2716
1111
  #### 本地 LOG 的打印回调。
2717
1112
 
2718
1113
  如果您希望捕获 SDK 的本地日志打印行为，可以通过设置日志回调，让 SDK 将要打印的日志都通过本回调接口抛送给您。
2719
- <table>
2720
- <tr>
2721
- <td rowspan="1" colSpan="1" >参数</td>
2722
-
2723
- <td rowspan="1" colSpan="1" >描述</td>
2724
- </tr>
2725
-
2726
- <tr>
2727
- <td rowspan="1" colSpan="1" >level</td>
2728
-
2729
- <td rowspan="1" colSpan="1" >日志等级请参见 TRTC_LOG_LEVEL。</td>
2730
- </tr>
2731
-
2732
- <tr>
2733
- <td rowspan="1" colSpan="1" >log</td>
2734
-
2735
- <td rowspan="1" colSpan="1" >日志内容。</td>
2736
- </tr>
2737
-
2738
- <tr>
2739
- <td rowspan="1" colSpan="1" >module</td>
2740
-
2741
- <td rowspan="1" colSpan="1" >保留字段，暂无具体意义，目前为固定值 ` TXLiteAVSDK `。</td>
2742
- </tr>
2743
- </table>
1114
+ | 参数 | 描述 |
1115
+ | --- | --- |
1116
+ | level | 日志等级请参见 TRTC_LOG_LEVEL。 |
1117
+ | log | 日志内容。 |
1118
+ | module | 保留字段，暂无具体意义，目前为固定值 ` TXLiteAVSDK `。 |