@tencentcloud/sdk-mcp 1.3.9 → 1.4.0

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