@tencentcloud/sdk-mcp 1.4.7 → 1.6.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (556) hide show
  1. package/index.js +0 -1
  2. package/knowledge/bm25-cache.js +73 -0
  3. package/knowledge/bm25.js +147 -0
  4. package/knowledge/build-index.js +65 -0
  5. package/knowledge/chunker.js +167 -0
  6. package/knowledge/content-loader.js +44 -0
  7. package/knowledge/extractors.js +25 -0
  8. package/knowledge/path-meta.js +175 -0
  9. package/knowledge/search/exact-lookup.js +330 -0
  10. package/knowledge/search/filter-pool.js +86 -0
  11. package/knowledge/search/requires-framework.js +72 -0
  12. package/knowledge/search/search-knowledge.js +226 -0
  13. package/package.json +9 -9
  14. package/resource/_schema/feature-aliases.yaml +10 -0
  15. package/resource/_schema/goal-tags.yaml +72 -0
  16. package/resource/_schema/products.yaml +16 -0
  17. package/resource/_schema/trtc-intents.yaml +27 -0
  18. package/resource/_schema/types.yaml +44 -0
  19. package/resource/index/component-slugs.json +1 -0
  20. package/resource/index/manifest.json +1 -0
  21. package/resource/{doc → integration}/callkit/preset/android/integration.md +32 -28
  22. package/resource/{doc → integration}/callkit/preset/flutter/integration.md +109 -54
  23. package/resource/integration/callkit/preset/ios/integration.md +411 -0
  24. package/resource/integration/callkit/preset/react/integration.md +499 -0
  25. package/resource/integration/callkit/preset/vue/integration.md +768 -0
  26. package/resource/{doc/chatkit → integration/chat/preset}/android/integration.md +11 -11
  27. package/resource/{doc/chatkit → integration/chat/preset}/flutter/integration.md +59 -37
  28. package/resource/integration/chat/preset/ios/integration.md +568 -0
  29. package/resource/{doc/chatkit → integration/chat/preset}/react/integration.md +127 -95
  30. package/resource/integration/chat/preset/uni-app/integration.md +494 -0
  31. package/resource/{doc/chatkit → integration/chat/preset}/vue/integration.md +163 -143
  32. package/resource/{doc → integration}/livekit/preset/live/vue/live-list-integration.md +15 -15
  33. package/resource/{doc → integration}/livekit/preset/live/vue/live-player-desk-integration.md +25 -13
  34. package/resource/{doc → integration}/livekit/preset/live/vue/live-player-h5-integration.md +15 -9
  35. package/resource/{doc → integration}/livekit/preset/live/vue/live-pusher-integration.md +31 -26
  36. package/resource/integration/roomkit/preset/vue/integration.md +571 -0
  37. package/resource/knowledge/callkit/core-sdk/android/answer-call.md +852 -0
  38. package/resource/knowledge/callkit/core-sdk/android/make-call.md +929 -0
  39. package/resource/knowledge/callkit/core-sdk/android/offline-push.md +364 -0
  40. package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +1150 -0
  41. package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +1216 -0
  42. package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +412 -0
  43. package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1191 -0
  44. package/resource/knowledge/callkit/core-sdk/ios/make-call.md +1292 -0
  45. package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +537 -0
  46. package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +953 -0
  47. package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +1061 -0
  48. package/resource/knowledge/callkit/faq/android.md +168 -0
  49. package/resource/knowledge/callkit/faq/common.md +180 -0
  50. package/resource/knowledge/callkit/faq/flutter.md +52 -0
  51. package/resource/knowledge/callkit/faq/ios.md +116 -0
  52. package/resource/knowledge/callkit/faq/uniapp-app.md +89 -0
  53. package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +217 -0
  54. package/resource/knowledge/callkit/faq/web.md +363 -0
  55. package/resource/knowledge/callkit/preset/android/api.md +413 -0
  56. package/resource/knowledge/callkit/preset/flutter/api.md +22 -0
  57. package/resource/knowledge/callkit/preset/ios/api.md +256 -0
  58. package/resource/knowledge/callkit/preset/web/api.md +79 -0
  59. package/resource/knowledge/chat/preset/android/features/chat-setting.md +72 -0
  60. package/resource/knowledge/chat/preset/android/features/contact-list.md +41 -0
  61. package/resource/knowledge/chat/preset/android/features/conversation-list.md +123 -0
  62. package/resource/knowledge/chat/preset/android/features/language.md +142 -0
  63. package/resource/knowledge/chat/preset/android/features/message-input.md +57 -0
  64. package/resource/knowledge/chat/preset/android/features/message-list.md +142 -0
  65. package/resource/knowledge/chat/preset/android/features/search.md +64 -0
  66. package/resource/{doc/chatkit → knowledge/chat/preset}/android/features/theme.md +21 -18
  67. package/resource/knowledge/chat/preset/android-view/integration.md +448 -0
  68. package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +62 -0
  69. package/resource/knowledge/chat/preset/flutter/features/contact-list.md +40 -0
  70. package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +129 -0
  71. package/resource/knowledge/chat/preset/flutter/features/language.md +104 -0
  72. package/resource/knowledge/chat/preset/flutter/features/message-input.md +54 -0
  73. package/resource/knowledge/chat/preset/flutter/features/message-list.md +163 -0
  74. package/resource/knowledge/chat/preset/flutter/features/search.md +59 -0
  75. package/resource/{doc/chatkit → knowledge/chat/preset}/flutter/features/theme.md +47 -19
  76. package/resource/knowledge/chat/preset/ios/features/chat-setting.md +92 -0
  77. package/resource/knowledge/chat/preset/ios/features/contact-list.md +119 -0
  78. package/resource/knowledge/chat/preset/ios/features/conversation-list.md +134 -0
  79. package/resource/knowledge/chat/preset/ios/features/language.md +105 -0
  80. package/resource/knowledge/chat/preset/ios/features/message-input.md +69 -0
  81. package/resource/knowledge/chat/preset/ios/features/message-list.md +164 -0
  82. package/resource/knowledge/chat/preset/ios/features/search.md +94 -0
  83. package/resource/{doc/chatkit → knowledge/chat/preset}/ios/features/theme.md +54 -51
  84. package/resource/{doc/chatkit/ios → knowledge/chat/preset/ios-uikit}/integration.md +157 -94
  85. package/resource/knowledge/chat/preset/react/features/chat-setting.md +123 -0
  86. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/contact-list.md +256 -104
  87. package/resource/knowledge/chat/preset/react/features/conversation-actions.md +217 -0
  88. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/conversation-list.md +86 -79
  89. package/resource/knowledge/chat/preset/react/features/conversation-preview.md +99 -0
  90. package/resource/knowledge/chat/preset/react/features/conversation-search.md +58 -0
  91. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-input.md +30 -83
  92. package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-list.md +22 -25
  93. package/resource/knowledge/chat/preset/react/features/search.md +531 -0
  94. package/resource/knowledge/chat/preset/react/features/theme.md +16 -0
  95. package/resource/knowledge/chat/preset/vue/features/chat-header.md +331 -0
  96. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/chat-setting.md +0 -4
  97. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/contact-list.md +59 -53
  98. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-actions.md +49 -43
  99. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-list.md +61 -49
  100. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-preview.md +43 -40
  101. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-search.md +1 -1
  102. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-input.md +128 -105
  103. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-list.md +108 -195
  104. package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/search.md +74 -68
  105. package/resource/knowledge/chat/preset/vue/features/theme.md +136 -0
  106. package/resource/knowledge/chat/urls/error-code.md +16 -0
  107. package/resource/knowledge/chat/urls/product.md +61 -0
  108. package/resource/knowledge/chat/urls/restapi.md +226 -0
  109. package/resource/knowledge/chat/urls/sdk/android.md +84 -0
  110. package/resource/knowledge/chat/urls/sdk/flutter.md +73 -0
  111. package/resource/knowledge/chat/urls/sdk/ios.md +84 -0
  112. package/resource/knowledge/chat/urls/sdk/web.md +88 -0
  113. package/resource/knowledge/chat/urls/webhook.md +73 -0
  114. package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/AudioEffectStore.md +79 -76
  115. package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +174 -0
  116. package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +329 -0
  117. package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/CameraView.md +7 -6
  118. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +434 -0
  119. package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +362 -0
  120. package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +466 -0
  121. package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +173 -0
  122. package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/LikeStore.md +12 -10
  123. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +291 -0
  124. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +78 -0
  125. package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +439 -0
  126. package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +221 -0
  127. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/AudioEffectStore.md +79 -76
  128. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +212 -0
  129. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/BaseBeautyStore.md +43 -45
  130. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +312 -0
  131. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +404 -0
  132. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +334 -0
  133. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +420 -0
  134. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +166 -0
  135. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LikeStore.md +12 -11
  136. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +281 -0
  137. package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LiveCoreView.md +49 -42
  138. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +397 -0
  139. package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +183 -0
  140. package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/AudioEffectStore.md +79 -75
  141. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +192 -0
  142. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +146 -0
  143. package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +309 -0
  144. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +370 -0
  145. package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +339 -0
  146. package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +503 -0
  147. package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +188 -0
  148. package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/LikeStore.md +12 -10
  149. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +289 -0
  150. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +78 -0
  151. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +434 -0
  152. package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +187 -0
  153. package/resource/knowledge/livekit/core-sdk/api-reference/web/index.md +780 -0
  154. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audience-list.md +59 -51
  155. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audio-effect.md +37 -34
  156. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-barrage.md +68 -38
  157. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-base-beauty.md +18 -15
  158. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-co-guest-interaction.md +17 -17
  159. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-gift.md +86 -80
  160. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-host-interaction.md +53 -49
  161. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-integration.md +47 -45
  162. package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-live-list.md +26 -22
  163. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audience-list.md +16 -13
  164. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audio-effect.md +28 -24
  165. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-barrage.md +33 -21
  166. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-base-beauty.md +29 -25
  167. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-co-guest-interaction.md +21 -20
  168. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-gift.md +78 -69
  169. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-host-interaction.md +47 -43
  170. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-integration.md +48 -45
  171. package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-live-list.md +27 -23
  172. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audience-list.md +15 -12
  173. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audio-effect.md +39 -36
  174. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-barrage.md +42 -29
  175. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-base-beauty.md +19 -16
  176. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-co-guest-interaction.md +20 -19
  177. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-gift.md +55 -49
  178. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-host-interaction.md +50 -46
  179. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-integration.md +48 -46
  180. package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-live-list.md +26 -22
  181. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audience-list.md +59 -51
  182. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audio-effect.md +41 -38
  183. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-barrage.md +67 -37
  184. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +53 -46
  185. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-gift.md +86 -80
  186. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-host-interaction.md +45 -40
  187. package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-integration.md +43 -42
  188. package/resource/knowledge/livekit/core-sdk/voice/android/voice-room-list.md +523 -0
  189. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audience-list.md +16 -13
  190. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audio-effect.md +54 -50
  191. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-barrage.md +33 -21
  192. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +34 -28
  193. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-gift.md +73 -64
  194. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-integration.md +46 -43
  195. package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-room-list.md +165 -148
  196. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audience-list.md +19 -16
  197. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audio-effect.md +40 -37
  198. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-barrage.md +41 -28
  199. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +54 -47
  200. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-gift.md +52 -46
  201. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-host-interaction.md +55 -50
  202. package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-integration.md +47 -45
  203. package/resource/knowledge/livekit/core-sdk/voice/ios/voice-room-list.md +404 -0
  204. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audience-list.md +40 -57
  205. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audio-effect.md +38 -49
  206. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-barrage.md +53 -53
  207. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-co-guest-interaction.md +106 -116
  208. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-gift.md +49 -59
  209. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-integration.md +52 -45
  210. package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-room-list.md +38 -46
  211. package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +915 -0
  212. package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +179 -0
  213. package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +419 -0
  214. package/resource/knowledge/push/config/android/fcm.md +133 -0
  215. package/resource/knowledge/push/config/android/honor.md +111 -0
  216. package/resource/knowledge/push/config/android/huawei.md +106 -0
  217. package/resource/knowledge/push/config/android/meizu.md +121 -0
  218. package/resource/knowledge/push/config/android/oppo.md +108 -0
  219. package/resource/knowledge/push/config/android/vivo.md +101 -0
  220. package/resource/knowledge/push/config/android/xiaomi.md +99 -0
  221. package/resource/knowledge/push/integration/android.md +1028 -0
  222. package/resource/knowledge/push/integration/donut.md +271 -0
  223. package/resource/knowledge/push/integration/flutter.md +363 -0
  224. package/resource/knowledge/push/integration/harmonyos.md +72 -0
  225. package/resource/knowledge/push/integration/ios.md +705 -0
  226. package/resource/knowledge/push/integration/react-native.md +337 -0
  227. package/resource/knowledge/push/integration/uni-app.md +461 -0
  228. package/resource/knowledge/push/integration/unity.md +357 -0
  229. package/resource/knowledge/push/integration/unreal-engine.md +353 -0
  230. package/resource/knowledge/push/overview/prepare.md +30 -0
  231. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/call-user-to-room.md +22 -20
  232. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-participant-state.md +22 -193
  233. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-state.md +33 -32
  234. package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/schedule-room.md +30 -29
  235. package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +230 -0
  236. package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-participant-state.md +22 -21
  237. package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-state.md +29 -28
  238. package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/schedule-room.md +17 -16
  239. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/call-user-to-room.md +22 -20
  240. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-participant-state.md +49 -218
  241. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-state.md +37 -37
  242. package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/schedule-room.md +28 -28
  243. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/call-user-to-room.md +122 -7
  244. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/device-detection.md +318 -3
  245. package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +1504 -0
  246. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/free-beauty-panel.md +4 -3
  247. package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +709 -0
  248. package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +1105 -0
  249. package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +635 -0
  250. package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +529 -0
  251. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/schedule-room.md +256 -13
  252. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/screen-share.md +218 -25
  253. package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/virtual-background.md +4 -3
  254. package/resource/{doc/roomkit → knowledge/roomkit/preset}/android/integration.md +50 -64
  255. package/resource/{doc/roomkit → knowledge/roomkit/preset}/flutter/integration.md +34 -31
  256. package/resource/{doc/roomkit → knowledge/roomkit/preset}/ios/integration.md +45 -53
  257. package/resource/knowledge/roomkit/preset/react/integration.md +571 -0
  258. package/resource/{doc → knowledge}/rtcengine/web/how_to_run_web_sdk_demo.md +31 -15
  259. package/resource/{doc → knowledge}/rtcengine/web/plugin/21-advanced-auto-play-policy.md +9 -3
  260. package/resource/{doc → knowledge}/rtcengine/web/plugin/22-advanced-audio-mixer.md +1 -1
  261. package/resource/{doc → knowledge}/rtcengine/web/plugin/23-advanced-support-detection.md +1 -1
  262. package/resource/{doc → knowledge}/rtcengine/web/plugin/24-advanced-network-quality.md +6 -6
  263. package/resource/{doc → knowledge}/rtcengine/web/plugin/25-advanced-device-change.md +1 -1
  264. package/resource/{doc → knowledge}/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -4
  265. package/resource/{doc → knowledge}/rtcengine/web/plugin/27-advanced-small-stream.md +4 -4
  266. package/resource/{doc → knowledge}/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
  267. package/resource/{doc → knowledge}/trtc/android/TRTCCloud.md +547 -495
  268. package/resource/{doc → knowledge}/trtc/android/TRTCCloudDef.md +434 -403
  269. package/resource/{doc → knowledge}/trtc/android/TRTCCloudListener.md +394 -348
  270. package/resource/{doc → knowledge}/trtc/android/TRTCStatistics.md +17 -15
  271. package/resource/{doc → knowledge}/trtc/android/TXAudioEffectManager.md +227 -197
  272. package/resource/knowledge/trtc/android/TXBeautyManager.md +415 -0
  273. package/resource/{doc → knowledge}/trtc/android/TXDeviceManager.md +70 -63
  274. package/resource/{doc → knowledge}/trtc/android/TXLiteAVCode.md +19 -17
  275. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCCloud.md +599 -544
  276. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCStatistics.md +17 -15
  277. package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +502 -0
  278. package/resource/knowledge/trtc/c++/ITXDeviceManager.md +403 -0
  279. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCCloudCallback.md +439 -387
  280. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCTypeDef.md +417 -387
  281. package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TXLiteAVCode.md +19 -17
  282. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloud.md +619 -559
  283. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloudDelegate.md +409 -360
  284. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCStatistics.md +17 -15
  285. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXAudioEffectManager.md +187 -164
  286. package/resource/knowledge/trtc/ios/TXBeautyManager.md +416 -0
  287. package/resource/knowledge/trtc/ios/TXDeviceManager.md +399 -0
  288. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiteAVCode.md +19 -17
  289. package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiveSDKTypeDef.md +422 -396
  290. package/server-config.js +0 -1
  291. package/server.js +22 -12
  292. package/streamable-http.js +0 -1
  293. package/tools/call/get_native_call_uikit_integration.js +2 -4
  294. package/tools/call/get_native_callkit_core_integration.js +2 -6
  295. package/tools/call/get_web_call_uikit_integration.js +2 -4
  296. package/tools/chat/get_native_chat_uikit_integration.js +2 -4
  297. package/tools/chat/get_web_chat_uikit_integration.js +2 -4
  298. package/tools/common/get_usersig.js +0 -1
  299. package/tools/common/present_framework_choice.js +9 -4
  300. package/tools/common/record_answer.js +19 -26
  301. package/tools/common/record_feedback.js +17 -31
  302. package/tools/common/search_trtc_knowledge.js +44 -0
  303. package/tools/definitions/get_native_call_uikit_integration_def.js +2 -1
  304. package/tools/definitions/get_native_callkit_core_integration_def.js +2 -1
  305. package/tools/definitions/get_native_chat_uikit_integration_def.js +3 -2
  306. package/tools/definitions/get_native_livekit_core_integration_def.js +2 -1
  307. package/tools/definitions/get_usersig_def.js +0 -1
  308. package/tools/definitions/get_web_call_uikit_integration_def.js +2 -1
  309. package/tools/definitions/get_web_chat_uikit_integration_def.js +2 -1
  310. package/tools/definitions/get_web_live_uikit_integration_def.js +4 -3
  311. package/tools/definitions/get_web_room_core_integration_def.js +46 -0
  312. package/tools/definitions/get_web_room_uikit_integration_def.js +3 -1
  313. package/tools/definitions/integration-boundary.js +5 -0
  314. package/tools/definitions/present_framework_choice_def.js +11 -10
  315. package/tools/definitions/record_answer_def.js +6 -5
  316. package/tools/definitions/record_feedback_def.js +4 -3
  317. package/tools/definitions/search_trtc_knowledge_def.js +69 -0
  318. package/tools/index.js +5 -37
  319. package/tools/live/get_native_livekit_core_integration.js +1 -4
  320. package/tools/live/get_web_live_uikit_integration.js +2 -5
  321. package/tools/room/get_web_room_core_integration.js +47 -0
  322. package/tools/room/get_web_room_uikit_integration.js +2 -4
  323. package/utils/generate-structured-result.js +4 -11
  324. package/utils/generate-usersig.js +0 -1
  325. package/utils/get-device-identifier.js +0 -1
  326. package/utils/get-doc-content.js +14 -9
  327. package/utils/http-get.js +0 -1
  328. package/utils/http-post.js +0 -1
  329. package/utils/report-cls-client.js +22 -21
  330. package/utils/report-es-client.js +1 -2
  331. package/utils/report-runtime-error-cls-client.js +0 -1
  332. package/index.js.map +0 -1
  333. package/resource/doc/callkit/core-sdk/.gitkeep +0 -0
  334. package/resource/doc/callkit/core-sdk/android/answer-call.md +0 -942
  335. package/resource/doc/callkit/core-sdk/android/make-call.md +0 -876
  336. package/resource/doc/callkit/core-sdk/android/offline-push.md +0 -368
  337. package/resource/doc/callkit/core-sdk/flutter/answer-call.md +0 -1132
  338. package/resource/doc/callkit/core-sdk/flutter/make-call.md +0 -1206
  339. package/resource/doc/callkit/core-sdk/flutter/offline-push.md +0 -357
  340. package/resource/doc/callkit/core-sdk/ios/answer-call.md +0 -1009
  341. package/resource/doc/callkit/core-sdk/ios/make-call.md +0 -1154
  342. package/resource/doc/callkit/core-sdk/ios/offline-push.md +0 -470
  343. package/resource/doc/callkit/core-sdk/uni-app/answer-call.md +0 -1146
  344. package/resource/doc/callkit/core-sdk/uni-app/make-call.md +0 -1267
  345. package/resource/doc/callkit/faq/android-faq.md +0 -767
  346. package/resource/doc/callkit/faq/flutter-faq.md +0 -749
  347. package/resource/doc/callkit/faq/ios-faq.md +0 -759
  348. package/resource/doc/callkit/faq/web-faq.md +0 -753
  349. package/resource/doc/callkit/preset/android/api.md +0 -330
  350. package/resource/doc/callkit/preset/flutter/api.md +0 -401
  351. package/resource/doc/callkit/preset/ios/api.md +0 -282
  352. package/resource/doc/callkit/preset/ios/integration.md +0 -188
  353. package/resource/doc/callkit/preset/react/api.md +0 -600
  354. package/resource/doc/callkit/preset/react/integration.md +0 -86
  355. package/resource/doc/callkit/preset/vue/api.md +0 -600
  356. package/resource/doc/callkit/preset/vue/integration.md +0 -83
  357. package/resource/doc/chatkit/android/faq.md +0 -109
  358. package/resource/doc/chatkit/faq/android_sdk/client-api.md +0 -280
  359. package/resource/doc/chatkit/faq/common/product.md +0 -82
  360. package/resource/doc/chatkit/faq/common/server.md +0 -53
  361. package/resource/doc/chatkit/faq/common/server_error_code.md +0 -74
  362. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +0 -183
  363. package/resource/doc/chatkit/faq/flutter_sdk/faq.md +0 -54
  364. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +0 -279
  365. package/resource/doc/chatkit/faq/web_sdk/error_code.md +0 -47
  366. package/resource/doc/chatkit/faq/web_sdk/faq.md +0 -292
  367. package/resource/doc/chatkit/flutter/faq.md +0 -22
  368. package/resource/doc/chatkit/ios/faq.md +0 -109
  369. package/resource/doc/chatkit/react/components/avatar.md +0 -104
  370. package/resource/doc/chatkit/react/components/chat-header.md +0 -148
  371. package/resource/doc/chatkit/react/components/chat-setting.md +0 -117
  372. package/resource/doc/chatkit/react/components/chat.md +0 -38
  373. package/resource/doc/chatkit/react/components/component-list.md +0 -35
  374. package/resource/doc/chatkit/react/components/conversation-actions.md +0 -174
  375. package/resource/doc/chatkit/react/components/conversation-preview.md +0 -116
  376. package/resource/doc/chatkit/react/components/conversation-search.md +0 -57
  377. package/resource/doc/chatkit/react/components/search.md +0 -282
  378. package/resource/doc/chatkit/react/components/tuikit.md +0 -43
  379. package/resource/doc/chatkit/react/faq.md +0 -26
  380. package/resource/doc/chatkit/vue/components/avatar.md +0 -104
  381. package/resource/doc/chatkit/vue/components/chat-header.md +0 -149
  382. package/resource/doc/chatkit/vue/components/chat.md +0 -42
  383. package/resource/doc/chatkit/vue/components/component-list.md +0 -89
  384. package/resource/doc/chatkit/vue/components/tuikit.md +0 -45
  385. package/resource/doc/chatkit/vue/components/userpicker.md +0 -256
  386. package/resource/doc/chatkit/vue/faq.md +0 -35
  387. package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +0 -148
  388. package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +0 -316
  389. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +0 -419
  390. package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +0 -325
  391. package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +0 -436
  392. package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +0 -165
  393. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +0 -239
  394. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +0 -74
  395. package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +0 -417
  396. package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +0 -207
  397. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +0 -158
  398. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +0 -304
  399. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +0 -394
  400. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +0 -303
  401. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +0 -410
  402. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +0 -160
  403. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +0 -231
  404. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +0 -375
  405. package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +0 -170
  406. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +0 -165
  407. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +0 -143
  408. package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +0 -298
  409. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +0 -349
  410. package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +0 -297
  411. package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +0 -471
  412. package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +0 -179
  413. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +0 -238
  414. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +0 -74
  415. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +0 -412
  416. package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +0 -173
  417. package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +0 -365
  418. package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +0 -336
  419. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +0 -780
  420. package/resource/doc/livekit/preset/live/vue/components/barrage.md +0 -291
  421. package/resource/doc/livekit/preset/live/vue/components/co-guest-panel.md +0 -88
  422. package/resource/doc/livekit/preset/live/vue/components/live-audience-list.md +0 -164
  423. package/resource/doc/livekit/preset/live/vue/components/live-scene-panel.md +0 -130
  424. package/resource/doc/livekit/preset/live/vue/components/live-view.md +0 -203
  425. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +0 -211
  426. package/resource/doc/livekit/preset/live/vue/faq.md +0 -1
  427. package/resource/doc/roomkit/faq/common/error-code.md +0 -67
  428. package/resource/doc/roomkit/flutter/features/call-user-to-room.md +0 -228
  429. package/resource/doc/roomkit/vue/faq.md +0 -1
  430. package/resource/doc/roomkit/vue/features/device-state.md +0 -460
  431. package/resource/doc/roomkit/vue/features/room-chat.md +0 -369
  432. package/resource/doc/roomkit/vue/features/room-participant-state.md +0 -385
  433. package/resource/doc/roomkit/vue/features/room-state.md +0 -280
  434. package/resource/doc/roomkit/vue/features/room-view.md +0 -241
  435. package/resource/doc/roomkit/vue/integration.md +0 -315
  436. package/resource/doc/rtcengine/faq/web_sdk/.gitkeep +0 -0
  437. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +0 -472
  438. package/resource/doc/trtc/C++/ITXDeviceManager.md +0 -388
  439. package/resource/doc/trtc/android/TXBeautyManager.md +0 -403
  440. package/resource/doc/trtc/iOS/TXBeautyManager.md +0 -404
  441. package/resource/doc/trtc/iOS/TXDeviceManager.md +0 -382
  442. package/server-config.js.map +0 -1
  443. package/server.js.map +0 -1
  444. package/streamable-http.js.map +0 -1
  445. package/tools/call/get_callkit_api.js +0 -33
  446. package/tools/call/get_callkit_api.js.map +0 -1
  447. package/tools/call/get_native_call_uikit_integration.js.map +0 -1
  448. package/tools/call/get_native_callkit_core_integration.js.map +0 -1
  449. package/tools/call/get_web_call_uikit_integration.js.map +0 -1
  450. package/tools/chat/get_native_chat_uikit_feature_detail.js +0 -35
  451. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +0 -1
  452. package/tools/chat/get_native_chat_uikit_integration.js.map +0 -1
  453. package/tools/chat/get_web_chat_uikit_component_detail.js +0 -35
  454. package/tools/chat/get_web_chat_uikit_component_detail.js.map +0 -1
  455. package/tools/chat/get_web_chat_uikit_integration.js.map +0 -1
  456. package/tools/common/get_faq.js +0 -266
  457. package/tools/common/get_faq.js.map +0 -1
  458. package/tools/common/get_usersig.js.map +0 -1
  459. package/tools/common/present_framework_choice.js.map +0 -1
  460. package/tools/common/record_answer.js.map +0 -1
  461. package/tools/common/record_feedback.js.map +0 -1
  462. package/tools/common/record_skill_session.js +0 -69
  463. package/tools/common/record_skill_session.js.map +0 -1
  464. package/tools/definitions/get_callkit_api_def.js +0 -28
  465. package/tools/definitions/get_callkit_api_def.js.map +0 -1
  466. package/tools/definitions/get_faq_def.js +0 -40
  467. package/tools/definitions/get_faq_def.js.map +0 -1
  468. package/tools/definitions/get_native_call_uikit_integration_def.js.map +0 -1
  469. package/tools/definitions/get_native_callkit_core_integration_def.js.map +0 -1
  470. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +0 -31
  471. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +0 -1
  472. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +0 -1
  473. package/tools/definitions/get_native_livekit_core_features_def.js +0 -33
  474. package/tools/definitions/get_native_livekit_core_features_def.js.map +0 -1
  475. package/tools/definitions/get_native_livekit_core_integration_def.js.map +0 -1
  476. package/tools/definitions/get_native_trtc_sdk_docs_def.js +0 -32
  477. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +0 -1
  478. package/tools/definitions/get_usersig_def.js.map +0 -1
  479. package/tools/definitions/get_web_call_uikit_integration_def.js.map +0 -1
  480. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +0 -31
  481. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +0 -1
  482. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +0 -1
  483. package/tools/definitions/get_web_live_uikit_integration_def.js.map +0 -1
  484. package/tools/definitions/get_web_livekit_api_def.js +0 -27
  485. package/tools/definitions/get_web_livekit_api_def.js.map +0 -1
  486. package/tools/definitions/get_web_livekit_component_detail_def.js +0 -29
  487. package/tools/definitions/get_web_livekit_component_detail_def.js.map +0 -1
  488. package/tools/definitions/get_web_room_uikit_integration_def.js.map +0 -1
  489. package/tools/definitions/get_web_roomkit_feature_detail_def.js +0 -30
  490. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +0 -1
  491. package/tools/definitions/get_web_trtc_sdk_api_def.js +0 -25
  492. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +0 -1
  493. package/tools/definitions/get_web_trtc_sdk_integration_def.js +0 -25
  494. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +0 -1
  495. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +0 -25
  496. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +0 -1
  497. package/tools/definitions/present_framework_choice_def.js.map +0 -1
  498. package/tools/definitions/record_answer_def.js.map +0 -1
  499. package/tools/definitions/record_feedback_def.js.map +0 -1
  500. package/tools/definitions/record_skill_session_def.js +0 -31
  501. package/tools/definitions/record_skill_session_def.js.map +0 -1
  502. package/tools/index.js.map +0 -1
  503. package/tools/live/get_native_livekit_core_features.js +0 -68
  504. package/tools/live/get_native_livekit_core_features.js.map +0 -1
  505. package/tools/live/get_native_livekit_core_integration.js.map +0 -1
  506. package/tools/live/get_web_live_uikit_integration.js.map +0 -1
  507. package/tools/live/get_web_livekit_api.js +0 -33
  508. package/tools/live/get_web_livekit_api.js.map +0 -1
  509. package/tools/live/get_web_livekit_component_detail.js +0 -35
  510. package/tools/live/get_web_livekit_component_detail.js.map +0 -1
  511. package/tools/room/get_web_room_uikit_integration.js.map +0 -1
  512. package/tools/room/get_web_roomkit_feature_detail.js +0 -69
  513. package/tools/room/get_web_roomkit_feature_detail.js.map +0 -1
  514. package/tools/rtcengine/get_web_trtc_sdk_api.js +0 -32
  515. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +0 -1
  516. package/tools/rtcengine/get_web_trtc_sdk_integration.js +0 -32
  517. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +0 -1
  518. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +0 -32
  519. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +0 -1
  520. package/tools/trtc/get_native_trtc_sdk_docs.js +0 -74
  521. package/tools/trtc/get_native_trtc_sdk_docs.js.map +0 -1
  522. package/utils/build-session-directives.js +0 -122
  523. package/utils/build-session-directives.js.map +0 -1
  524. package/utils/generate-structured-result.js.map +0 -1
  525. package/utils/generate-usersig.js.map +0 -1
  526. package/utils/get-device-identifier.js.map +0 -1
  527. package/utils/get-doc-content.js.map +0 -1
  528. package/utils/handle-framework.js +0 -9
  529. package/utils/handle-framework.js.map +0 -1
  530. package/utils/handle-state-name.js +0 -29
  531. package/utils/handle-state-name.js.map +0 -1
  532. package/utils/http-get.js.map +0 -1
  533. package/utils/http-post.js.map +0 -1
  534. package/utils/report-cls-client.js.map +0 -1
  535. package/utils/report-es-client.js.map +0 -1
  536. package/utils/report-runtime-error-cls-client.js.map +0 -1
  537. /package/resource/{doc/callkit/faq/common → knowledge/callkit/faq}/error-code.md +0 -0
  538. /package/resource/{doc/livekit/faq/common → knowledge/livekit/faq}/error-code.md +0 -0
  539. /package/resource/{doc → knowledge}/rtcengine/web/api.md +0 -0
  540. /package/resource/{doc/rtcengine/faq/web/web.md → knowledge/rtcengine/web/faq.md} +0 -0
  541. /package/resource/{doc → knowledge}/rtcengine/web/how_to_integrated_web_sdk.md +0 -0
  542. /package/resource/{doc → knowledge}/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +0 -0
  543. /package/resource/{doc → knowledge}/rtcengine/web/plugin/28-advanced-beauty.md +0 -0
  544. /package/resource/{doc → knowledge}/rtcengine/web/plugin/29-advanced-water-mark.md +0 -0
  545. /package/resource/{doc → knowledge}/rtcengine/web/plugin/30-advanced-cross-room-link.md +0 -0
  546. /package/resource/{doc → knowledge}/rtcengine/web/plugin/34-advanced-proxy.md +0 -0
  547. /package/resource/{doc → knowledge}/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -0
  548. /package/resource/{doc → knowledge}/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -0
  549. /package/resource/{doc → knowledge}/rtcengine/web/plugin/37-advanced-voice-changer.md +0 -0
  550. /package/resource/{doc → knowledge}/rtcengine/web/plugin/38-advanced-basic-beauty.md +0 -0
  551. /package/resource/{doc → knowledge}/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -0
  552. /package/resource/{doc → knowledge}/rtcengine/web/plugin/40-advanced-video-mixer.md +0 -0
  553. /package/resource/{doc → knowledge}/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +0 -0
  554. /package/resource/{doc → knowledge}/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +0 -0
  555. /package/resource/{doc → knowledge}/rtcengine/web/plugin/43-advanced-face-detection.md +0 -0
  556. /package/resource/{doc/rtcengine/faq/common → knowledge/share}/userSig.md +0 -0
@@ -1,113 +1,121 @@
1
- # 腾讯云实时音视频(TRTC SDK )文档
1
+ Copyright (c) 2021 Tencent. All rights reserved.
2
2
 
3
- ## 概述
4
- `TRTCCloudListener.java` 是腾讯云实时音视频(TRTC SDK ) Android 平台的事件回调接口文档。
3
+ Module: TRTCCloudListener @ TXLiteAVSDK
4
+
5
+ Function: 腾讯云实时音视频的事件回调接口
5
6
 
6
7
  ## TRTCVideoRenderListener
7
- | 函数列表 | 描述 |
8
- | --- | --- |
9
- | onRenderVideoFrame | 自定义视频渲染回调。 |
8
+
9
+ |函数列表|描述|
10
+ |---------|---------|
11
+ |onRenderVideoFrame|自定义视频渲染回调。|
10
12
 
11
13
  ## TRTCVideoFrameListener
12
- | 函数列表 | 描述 |
13
- | --- | --- |
14
- | onGLContextCreated | SDK 内部 OpenGL 环境已经创建的通知。 |
15
- | onProcessVideoFrame | 用于对接第三方美颜组件的视频处理回调。 |
16
- | onGLContextDestory | SDK 内部 OpenGL 环境被销毁的通知。 |
14
+
15
+ |函数列表|描述|
16
+ |---------|---------|
17
+ |onGLContextCreated|SDK 内部 OpenGL 环境已经创建的通知。|
18
+ |onProcessVideoFrame|用于对接第三方美颜组件的视频处理回调。|
19
+ |onGLContextDestory|SDK 内部 OpenGL 环境被销毁的通知。|
17
20
 
18
21
  ## TRTCAudioFrameListener
19
- | 函数列表 | 描述 |
20
- | --- | --- |
21
- | onCapturedAudioFrame | 本地采集并经过音频模块前处理后的音频数据回调。 |
22
- | onLocalProcessedAudioFrame | 本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调。 |
23
- | onRemoteUserAudioFrame | 混音前的每一路远程用户的音频数据。 |
24
- | onMixedPlayAudioFrame | 将各路待播放音频混合之后并在最终提交系统播放之前的数据回调。 |
25
- | onMixedAllAudioFrame | SDK 所有音频混合后的音频数据(包括采集到的和待播放的)。 |
26
- | onVoiceEarMonitorAudioFrame | 耳返的音频数据。 |
22
+
23
+ |函数列表|描述|
24
+ |---------|---------|
25
+ |onCapturedAudioFrame|本地采集并经过音频模块前处理后的音频数据回调。|
26
+ |onLocalProcessedAudioFrame|本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调。|
27
+ |onRemoteUserAudioFrame|混音前的每一路远程用户的音频数据。|
28
+ |onMixedPlayAudioFrame|将各路待播放音频混合之后并在最终提交系统播放之前的数据回调。|
29
+ |onMixedAllAudioFrame|SDK 所有音频混合后的音频数据(包括采集到的和待播放的)。|
30
+ |onVoiceEarMonitorAudioFrame|耳返的音频数据。|
27
31
 
28
32
  ## TRTCLogListener
29
- | 函数列表 | 描述 |
30
- | --- | --- |
31
- | onLog | 本地 LOG 的打印回调。 |
33
+
34
+ |函数列表|描述|
35
+ |---------|---------|
36
+ |onLog|本地 LOG 的打印回调。|
32
37
 
33
38
  ## TRTCCloudListener
34
- | 函数列表 | 描述 |
35
- | --- | --- |
36
- | onError | 错误事件回调。 |
37
- | onWarning | 警告事件回调。 |
38
- | onEnterRoom | 进入房间成功与否的事件回调。 |
39
- | onExitRoom | 离开房间的事件回调。 |
40
- | onSwitchRole | 切换角色的事件回调。 |
41
- | onSwitchRoom | 切换房间的结果回调。 |
42
- | onConnectOtherRoom | 请求跨房通话的结果回调。 |
43
- | onDisConnectOtherRoom | 结束跨房通话的结果回调。 |
44
- | onUpdateOtherRoomForwardMode | 更改跨房主播上行能力的结果回调。 |
45
- | onRemoteUserEnterRoom | 有用户加入当前房间。 |
46
- | onRemoteUserLeaveRoom | 有用户离开当前房间。 |
47
- | onUserVideoAvailable | 某远端用户发布/取消了主路视频画面。 |
48
- | onUserSubStreamAvailable | 某远端用户发布/取消了辅路视频画面。 |
49
- | onUserAudioAvailable | 某远端用户发布/取消了自己的音频。 |
50
- | onFirstVideoFrame | SDK 开始渲染自己本地或远端用户的首帧画面。 |
51
- | onFirstAudioFrame | SDK 开始播放远端用户的首帧音频。 |
52
- | onSendFirstLocalVideoFrame | 自己本地的首个视频帧已被发布出去。 |
53
- | onSendFirstLocalAudioFrame | 自己本地的首个音频帧已被发布出去。 |
54
- | onRemoteVideoStatusUpdated | 远端视频状态变化的事件回调。 |
55
- | onRemoteAudioStatusUpdated | 远端音频状态变化的事件回调。 |
56
- | onUserVideoSizeChanged | 用户视频大小发生改变回调。 |
57
- | onNetworkQuality | 网络质量的实时统计回调。 |
58
- | onStatistics | 音视频技术指标的实时统计回调。 |
59
- | onSpeedTestResult | 网速测试的结果回调。 |
60
- | onConnectionLost | SDK 与云端的连接已经断开。 |
61
- | onTryToReconnect | SDK 正在尝试重新连接到云端。 |
62
- | onConnectionRecovery | SDK 与云端的连接已经恢复。 |
63
- | onCameraDidReady | 摄像头准备就绪。 |
64
- | onMicDidReady | 麦克风准备就绪。 |
65
- | onAudioRouteChanged | 当前音频路由发生变化(仅适用于移动设备)。 |
66
- | onUserVoiceVolume | 音量大小的反馈回调。 |
67
- | onRecvCustomCmdMsg | 收到自定义消息的事件回调。 |
68
- | onMissCustomCmdMsg | 自定义消息丢失的事件回调。 |
69
- | onRecvSEIMsg | 收到 SEI 消息的回调。 |
70
- | onStartPublishing | 开始向腾讯云直播 CDN 上发布音视频流的事件回调。 |
71
- | onStopPublishing | 停止向腾讯云直播 CDN 上发布音视频流的事件回调。 |
72
- | onStartPublishCDNStream | 开始向非腾讯云 CDN 上发布音视频流的事件回调。 |
73
- | onStopPublishCDNStream | 停止向非腾讯云 CDN 上发布音视频流的事件回调。 |
74
- | onSetMixTranscodingConfig | 设置云端混流的排版布局和转码参数的事件回调。 |
75
- | onStartPublishMediaStream | 开始发布媒体流的事件回调。 |
76
- | onUpdatePublishMediaStream | 更新媒体流的事件回调。 |
77
- | onStopPublishMediaStream | 停止媒体流的事件回调。 |
78
- | onCdnStreamStateChanged | RTMP/RTMPS 推流状态发生改变回调。 |
79
- | onScreenCaptureStarted | 屏幕分享开启的事件回调。 |
80
- | onScreenCapturePaused | 屏幕分享暂停的事件回调。 |
81
- | onScreenCaptureResumed | 屏幕分享恢复的事件回调。 |
82
- | onScreenCaptureStopped | 屏幕分享停止的事件回调。 |
83
- | onLocalRecordBegin | 本地录制任务已经开始的事件回调。 |
84
- | onLocalRecording | 本地录制任务正在进行中的进展事件回调。 |
85
- | onLocalRecordFragment | 本地录制分片的事件回调。 |
86
- | onLocalRecordComplete | 本地录制任务已经结束的事件回调。 |
87
- | onSnapshotComplete | 本地截图完成的事件回调。 |
88
- | onUserEnter | 有主播加入当前房间(已废弃)。 |
89
- | onUserExit | 有主播离开当前房间(已废弃)。 |
90
- | onAudioEffectFinished | 音效播放已结束(已废弃)。 |
91
- | onSpeedTest | 服务器测速的结果回调(已废弃)。 |
39
+
40
+ |函数列表|描述|
41
+ |---------|---------|
42
+ |onError|错误事件回调。|
43
+ |onWarning|警告事件回调。|
44
+ |onEnterRoom|进入房间成功与否的事件回调。|
45
+ |onExitRoom|离开房间的事件回调。|
46
+ |onSwitchRole|切换角色的事件回调。|
47
+ |onSwitchRoom|切换房间的结果回调。|
48
+ |onConnectOtherRoom|请求跨房通话的结果回调。|
49
+ |onDisConnectOtherRoom|结束跨房通话的结果回调。|
50
+ |onUpdateOtherRoomForwardMode|更改跨房主播上行能力的结果回调。|
51
+ |onRemoteUserEnterRoom|有用户加入当前房间。|
52
+ |onRemoteUserLeaveRoom|有用户离开当前房间。|
53
+ |onUserVideoAvailable|某远端用户发布/取消了主路视频画面。|
54
+ |onUserSubStreamAvailable|某远端用户发布/取消了辅路视频画面。|
55
+ |onUserAudioAvailable|某远端用户发布/取消了自己的音频。|
56
+ |onFirstVideoFrame|SDK 开始渲染自己本地或远端用户的首帧画面。|
57
+ |onFirstAudioFrame|SDK 开始播放远端用户的首帧音频。|
58
+ |onSendFirstLocalVideoFrame|自己本地的首个视频帧已被发布出去。|
59
+ |onSendFirstLocalAudioFrame|自己本地的首个音频帧已被发布出去。|
60
+ |onRemoteVideoStatusUpdated|远端视频状态变化的事件回调。|
61
+ |onRemoteAudioStatusUpdated|远端音频状态变化的事件回调。|
62
+ |onUserVideoSizeChanged|用户视频大小发生改变回调。|
63
+ |onNetworkQuality|网络质量的实时统计回调。|
64
+ |onStatistics|音视频技术指标的实时统计回调。|
65
+ |onSpeedTestResult|网速测试的结果回调。|
66
+ |onConnectionLost|SDK 与云端的连接已经断开。|
67
+ |onTryToReconnect|SDK 正在尝试重新连接到云端。|
68
+ |onConnectionRecovery|SDK 与云端的连接已经恢复。|
69
+ |onCameraDidReady|摄像头准备就绪。|
70
+ |onMicDidReady|麦克风准备就绪。|
71
+ |onAudioRouteChanged|当前音频路由发生变化(仅适用于移动设备)。|
72
+ |onUserVoiceVolume|音量大小的反馈回调。|
73
+ |onRecvCustomCmdMsg|收到自定义消息的事件回调。|
74
+ |onMissCustomCmdMsg|自定义消息丢失的事件回调。|
75
+ |onRecvSEIMsg|收到 SEI 消息的回调。|
76
+ |onStartPublishing|开始向腾讯云直播 CDN 上发布音视频流的事件回调。|
77
+ |onStopPublishing|停止向腾讯云直播 CDN 上发布音视频流的事件回调。|
78
+ |onStartPublishCDNStream|开始向非腾讯云 CDN 上发布音视频流的事件回调。|
79
+ |onStopPublishCDNStream|停止向非腾讯云 CDN 上发布音视频流的事件回调。|
80
+ |onSetMixTranscodingConfig|设置云端混流的排版布局和转码参数的事件回调。|
81
+ |onStartPublishMediaStream|开始发布媒体流的事件回调。|
82
+ |onUpdatePublishMediaStream|更新媒体流的事件回调。|
83
+ |onStopPublishMediaStream|停止媒体流的事件回调。|
84
+ |onCdnStreamStateChanged|RTMP/RTMPS 推流状态发生改变回调。|
85
+ |onScreenCaptureStarted|屏幕分享开启的事件回调。|
86
+ |onScreenCapturePaused|屏幕分享暂停的事件回调。|
87
+ |onScreenCaptureResumed|屏幕分享恢复的事件回调。|
88
+ |onScreenCaptureStopped|屏幕分享停止的事件回调。|
89
+ |onLocalRecordBegin|本地录制任务已经开始的事件回调。|
90
+ |onLocalRecording|本地录制任务正在进行中的进展事件回调。|
91
+ |onLocalRecordFragment|本地录制分片的事件回调。|
92
+ |onLocalRecordComplete|本地录制任务已经结束的事件回调。|
93
+ |onSnapshotComplete|本地截图完成的事件回调。|
94
+ |onExperimentalEvent|实验性接口的事件回调。|
95
+ |onUserEnter|有主播加入当前房间(已废弃)。|
96
+ |onUserExit|有主播离开当前房间(已废弃)。|
97
+ |onAudioEffectFinished|音效播放已结束(已废弃)。|
98
+ |onSpeedTest|服务器测速的结果回调(已废弃)。|
92
99
 
93
100
  ## onRenderVideoFrame
94
101
 
95
- #### 自定义视频渲染回调。
102
+ **自定义视频渲染回调。**
96
103
 
97
104
  当您设置了本地或者远端的视频自定义渲染回调之后,SDK 就会将原本要交给渲染控件进行渲染的视频帧通过此回调接口抛送给您,以便于您进行自定义渲染。
98
- | 参数 | 描述 |
99
- | --- | --- |
100
- | frame | 待渲染的视频帧信息。 |
101
- | streamType | 频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。 |
102
- | userId | 视频源的 userId,如果是本地视频回调(setLocalVideoRenderDelegate),该参数可以忽略。 |
105
+
106
+ |参数|描述|
107
+ |---------|---------|
108
+ |frame|待渲染的视频帧信息。|
109
+ |streamType|频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。|
110
+ |userId|视频源的 userId,如果是本地视频回调(setLocalVideoRenderDelegate),该参数可以忽略。|
103
111
 
104
112
  ## onGLContextCreated
105
113
 
106
- #### SDK 内部 OpenGL 环境已经创建的通知。
114
+ **SDK 内部 OpenGL 环境已经创建的通知。**
107
115
 
108
116
  ## onProcessVideoFrame
109
117
 
110
- #### 用于对接第三方美颜组件的视频处理回调。
118
+ **用于对接第三方美颜组件的视频处理回调。**
111
119
 
112
120
  如果您选购了第三方美颜组件,就需要在 TRTCCloud 中设置第三方美颜回调,之后 TRTC 就会将原本要进行预处理的视频帧通过此回调接口抛送给您。
113
121
 
@@ -144,10 +152,11 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
144
152
  return 0;
145
153
  }
146
154
  ```
147
- | 参数 | 描述 |
148
- | --- | --- |
149
- | dstFrame | 用于接收第三方美颜处理过的视频画面。 |
150
- | srcFrame | 用于承载 TRTC 采集到的摄像头画面。 |
155
+
156
+ |参数|描述|
157
+ |---------|---------|
158
+ |dstFrame|用于接收第三方美颜处理过的视频画面。|
159
+ |srcFrame|用于承载 TRTC 采集到的摄像头画面。|
151
160
 
152
161
  > **注意**
153
162
  >
@@ -157,11 +166,11 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
157
166
 
158
167
  ## onGLContextDestory
159
168
 
160
- #### SDK 内部 OpenGL 环境被销毁的通知。
169
+ **SDK 内部 OpenGL 环境被销毁的通知。**
161
170
 
162
171
  ## onCapturedAudioFrame
163
172
 
164
- #### 本地采集并经过音频模块前处理后的音频数据回调。
173
+ **本地采集并经过音频模块前处理后的音频数据回调。**
165
174
 
166
175
  当您设置完音频数据自定义回调之后,SDK 内部会把刚采集到并经过前处理(ANS、AEC、AGC)之后的数据,以 PCM 格式的形式通过本接口回调给您。
167
176
  - 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
@@ -170,9 +179,9 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
170
179
 
171
180
  - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 ` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
172
181
 
173
- | 参数 | 描述 |
174
- | --- | --- |
175
- | frame | PCM 格式的音频数据帧。 |
182
+ |参数|描述|
183
+ |---------|---------|
184
+ |frame|PCM 格式的音频数据帧。|
176
185
 
177
186
  > **注意**
178
187
  >
@@ -188,7 +197,7 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
188
197
 
189
198
  ## onLocalProcessedAudioFrame
190
199
 
191
- #### 本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调。
200
+ **本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调。**
192
201
 
193
202
  当您设置完音频数据自定义回调之后,SDK 内部会把刚采集到并经过前处理、音效处理和混 BGM 之后的数据,在最终进行网络编码之前,以 PCM 格式的形式通过本接口回调给您。
194
203
  - 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
@@ -202,9 +211,10 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
202
211
  您可以通过设置接口中的 ` TRTCAudioFrame.extraData ` 字段,达到传输信令的目的。由于音频帧头部的数据块不能太大,建议您写入 ` extraData ` 时,尽量将信令控制在几个字节的大小,如果超过 100 个字节,写入的数据不会被发送。
203
212
 
204
213
  房间内其他用户可以通过 TRTCAudioFrameListener 中的 ` onRemoteUserAudioFrame ` 中的 ` TRTCAudioFrame.extraData ` 字段回调接收数据。
205
- | 参数 | 描述 |
206
- | --- | --- |
207
- | frame | PCM 格式的音频数据帧。 |
214
+
215
+ |参数|描述|
216
+ |---------|---------|
217
+ |frame|PCM 格式的音频数据帧。|
208
218
 
209
219
  > **注意**
210
220
  >
@@ -220,7 +230,7 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
220
230
 
221
231
  ## onRemoteUserAudioFrame
222
232
 
223
- #### 混音前的每一路远程用户的音频数据。
233
+ **混音前的每一路远程用户的音频数据。**
224
234
 
225
235
  当您设置完音频数据自定义回调之后,SDK 内部会把远端的每一路原始数据,在最终混音之前,以 PCM 格式的形式通过本接口回调给您。
226
236
  - 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
@@ -229,10 +239,10 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
229
239
 
230
240
  - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
231
241
 
232
- | 参数 | 描述 |
233
- | --- | --- |
234
- | frame | PCM 格式的音频数据帧。 |
235
- | userId | 用户标识。 |
242
+ |参数|描述|
243
+ |---------|---------|
244
+ |frame|PCM 格式的音频数据帧。|
245
+ |userId|用户标识。|
236
246
 
237
247
  > **注意**
238
248
  >
@@ -242,7 +252,7 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
242
252
 
243
253
  ## onMixedPlayAudioFrame
244
254
 
245
- #### 将各路待播放音频混合之后并在最终提交系统播放之前的数据回调。
255
+ **将各路待播放音频混合之后并在最终提交系统播放之前的数据回调。**
246
256
 
247
257
  当您设置完音频数据自定义回调之后,SDK 内部会把各路待播放的音频混合之后的音频数据,在提交系统播放之前,以 PCM 格式的形式通过本接口回调给您。
248
258
  - 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
@@ -251,9 +261,9 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
251
261
 
252
262
  - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 ` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
253
263
 
254
- | 参数 | 描述 |
255
- | --- | --- |
256
- | frame | PCM 格式的音频数据帧。 |
264
+ |参数|描述|
265
+ |---------|---------|
266
+ |frame|PCM 格式的音频数据帧。|
257
267
 
258
268
  > **注意**
259
269
  >
@@ -269,7 +279,7 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
269
279
 
270
280
  ## onMixedAllAudioFrame
271
281
 
272
- #### SDK 所有音频混合后的音频数据(包括采集到的和待播放的)。
282
+ **SDK 所有音频混合后的音频数据(包括采集到的和待播放的)。**
273
283
 
274
284
  当您设置完音频数据自定义回调之后,SDK 内部会把所有采集到的和待播放的音频数据混合起来,以 PCM 格式的形式通过本接口回调给您,便于您进行自定义录制。
275
285
  - 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
@@ -278,9 +288,9 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
278
288
 
279
289
  - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 ` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
280
290
 
281
- | 参数 | 描述 |
282
- | --- | --- |
283
- | frame | PCM 格式的音频数据帧。 |
291
+ |参数|描述|
292
+ |---------|---------|
293
+ |frame|PCM 格式的音频数据帧。|
284
294
 
285
295
  > **注意**
286
296
  >
@@ -293,7 +303,7 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
293
303
 
294
304
  ## onVoiceEarMonitorAudioFrame
295
305
 
296
- #### 耳返的音频数据。
306
+ **耳返的音频数据。**
297
307
 
298
308
  当您设置完音频数据自定义回调之后,SDK 内部会把耳返的音频数据在播放之前以 PCM 格式的形式通过本接口回调给您。
299
309
  - 此接口回调出的音频时间帧长不固定,格式为 PCM 格式。
@@ -302,9 +312,9 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
302
312
 
303
313
  - 以 TRTC 默认的音频录制格式 48000 采样率、单声道、16采样点位宽为例,0.02s 的音频数据字节帧长为 ` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
304
314
 
305
- | 参数 | 描述 |
306
- | --- | --- |
307
- | frame | PCM 格式的音频数据帧。 |
315
+ |参数|描述|
316
+ |---------|---------|
317
+ |frame|PCM 格式的音频数据帧。|
308
318
 
309
319
  > **注意**
310
320
  >
@@ -317,44 +327,47 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
317
327
 
318
328
  ## onLog
319
329
 
320
- #### 本地 LOG 的打印回调。
330
+ **本地 LOG 的打印回调。**
321
331
 
322
332
  如果您希望捕获 SDK 的本地日志打印行为,可以通过设置日志回调,让 SDK 将要打印的日志都通过本回调接口抛送给您。
323
- | 参数 | 描述 |
324
- | --- | --- |
325
- | level | 日志等级请参见 TRTC_LOG_LEVEL。 |
326
- | log | 日志内容。 |
327
- | module | 保留字段,暂无具体意义,目前为固定值 ` TXLiteAVSDK `。 |
333
+
334
+ |参数|描述|
335
+ |---------|---------|
336
+ |level|日志等级请参见 TRTC_LOG_LEVEL。|
337
+ |log|日志内容。|
338
+ |module|保留字段,暂无具体意义,目前为固定值 ` TXLiteAVSDK `。|
328
339
 
329
340
  ## onError
330
341
 
331
- #### 错误事件回调。
342
+ **错误事件回调。**
332
343
 
333
344
  错误事件,表示 SDK 抛出的不可恢复的错误,例如进入房间失败或设备开启失败等。
334
345
 
335
346
  参考文档:[错误码表](https://cloud.tencent.com/document/product/647/38308)
336
- | 参数 | 描述 |
337
- | --- | --- |
338
- | errCode | 错误码 |
339
- | errMsg | 错误信息 |
340
- | extInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题 |
347
+
348
+ |参数|描述|
349
+ |---------|---------|
350
+ |errCode|错误码|
351
+ |errMsg|错误信息|
352
+ |extInfo|扩展信息字段,个别错误码可能会带额外的信息帮助定位问题|
341
353
 
342
354
  ## onWarning
343
355
 
344
- #### 警告事件回调。
356
+ **警告事件回调。**
345
357
 
346
358
  警告事件,表示 SDK 抛出的提示性问题,例如视频出现卡顿或 CPU 使用率太高等。
347
359
 
348
360
  参考文档:[错误码表](https://cloud.tencent.com/document/product/647/38308)
349
- | 参数 | 描述 |
350
- | --- | --- |
351
- | extInfo | 扩展信息字段,个别警告码可能会带额外的信息帮助定位问题 |
352
- | warningCode | 警告码 |
353
- | warningMsg | 警告信息 |
361
+
362
+ |参数|描述|
363
+ |---------|---------|
364
+ |extInfo|扩展信息字段,个别警告码可能会带额外的信息帮助定位问题|
365
+ |warningCode|警告码|
366
+ |warningMsg|警告信息|
354
367
 
355
368
  ## onEnterRoom
356
369
 
357
- #### 进入房间成功与否的事件回调。
370
+ **进入房间成功与否的事件回调。**
358
371
 
359
372
  调用 TRTCCloud 中的 enterRoom 接口执行进房操作后,会收到来自 TRTCCloudListener 的 ` onEnterRoom(result) ` 回调:
360
373
  - 如果加入成功,回调 result 会是一个正数(result > 0),代表进入房间所消耗的时间,单位是毫秒(ms)。
@@ -362,9 +375,10 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
362
375
  - 如果加入失败,回调 result 会是一个负数(result < 0),代表失败原因的错误码。
363
376
 
364
377
  进房失败的错误码含义请参见[错误码表](https://cloud.tencent.com/document/product/647/38308)。
365
- | 参数 | 描述 |
366
- | --- | --- |
367
- | result | result > 0 时为进房耗时(ms),result < 0 时为进房错误码。 |
378
+
379
+ |参数|描述|
380
+ |---------|---------|
381
+ |result|result > 0 时为进房耗时(ms),result < 0 时为进房错误码。|
368
382
 
369
383
  > **注意**
370
384
  >
@@ -377,86 +391,92 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
377
391
 
378
392
  ## onExitRoom
379
393
 
380
- #### 离开房间的事件回调。
394
+ **离开房间的事件回调。**
381
395
 
382
396
  调用 TRTCCloud 中的 exitRoom 接口会执行退出房间的相关逻辑,例如释放音视频设备资源和编解码器资源等。
383
397
 
384
398
  待 SDK 占用的所有资源释放完毕后,SDK 会抛出 ` onExitRoom() ` 回调通知到您。
385
399
 
386
400
  如果您要再次调用 enterRoom 或者切换到其他的音视频 SDK,请等待 ` onExitRoom ` 回调到来后再执行相关操作。否则可能会遇到例如摄像头、麦克风设备被强占等各种异常问题。
387
- | 参数 | 描述 |
388
- | --- | --- |
389
- | reason | 离开房间原因,0:主动调用 exitRoom 退出房间;1:被服务器移出当前房间;2:当前房间整个被解散 3: 服务器状态异常。 |
401
+
402
+ |参数|描述|
403
+ |---------|---------|
404
+ |reason|离开房间原因,0:主动调用 exitRoom 退出房间;1:被服务器移出当前房间;2:当前房间整个被解散 3: 服务器状态异常。|
390
405
 
391
406
  ## onSwitchRole
392
407
 
393
- #### 切换角色的事件回调。
408
+ **切换角色的事件回调。**
394
409
 
395
410
  调用 TRTCCloud 中的 switchRole 接口会切换主播和观众的角色,该操作会伴随一个线路切换的过程,待 SDK 切换完成后,会抛出 ` onSwitchRole() ` 事件回调。
396
- | 参数 | 描述 |
397
- | --- | --- |
398
- | errCode | 错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
399
- | errMsg | 错误信息。 |
411
+
412
+ |参数|描述|
413
+ |---------|---------|
414
+ |errCode|错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
415
+ |errMsg|错误信息。|
400
416
 
401
417
  ## onSwitchRoom
402
418
 
403
- #### 切换房间的结果回调。
419
+ **切换房间的结果回调。**
404
420
 
405
421
  调用 TRTCCloud 中的 switchRoom 接口可以让用户快速地从一个房间切换到另一个房间,待 SDK 切换完成后,会抛出 ` onSwitchRoom() ` 事件回调。
406
- | 参数 | 描述 |
407
- | --- | --- |
408
- | errCode | 错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
409
- | errMsg | 错误信息。 |
422
+
423
+ |参数|描述|
424
+ |---------|---------|
425
+ |errCode|错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
426
+ |errMsg|错误信息。|
410
427
 
411
428
  ## onConnectOtherRoom
412
429
 
413
- #### 请求跨房通话的结果回调。
430
+ **请求跨房通话的结果回调。**
414
431
 
415
432
  调用 TRTCCloud 中的 connectOtherRoom 接口会将两个不同房间中的主播拉通视频通话,也就是所谓的“主播PK”功能。
416
433
 
417
434
  调用者会收到 ` onConnectOtherRoom() ` 回调来获知跨房通话是否成功。
418
- | 参数 | 描述 |
419
- | --- | --- |
420
- | errCode | 错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
421
- | errMsg | 错误信息。 |
422
- | userId | 要跨房通话的另一个房间中的主播的用户 ID。 |
435
+
436
+ |参数|描述|
437
+ |---------|---------|
438
+ |errCode|错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
439
+ |errMsg|错误信息。|
440
+ |userId|要跨房通话的另一个房间中的主播的用户 ID。|
423
441
 
424
442
  ## onDisConnectOtherRoom
425
443
 
426
- #### 结束跨房通话的结果回调。
444
+ **结束跨房通话的结果回调。**
427
445
 
428
446
  调用 TRTCCloud 中的 disConnectOtherRoom 接口会结束两个不同房间中的主播视频通话,也就是所谓的“主播PK”功能。
429
447
 
430
448
  调用者会收到 ` onDisconnectOtherRoom() ` 回调来获知结束跨房通话是否成功。
431
- | 参数 | 描述 |
432
- | --- | --- |
433
- | errCode | 错误码,ERR_NULL 代表成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
434
- | errMsg | 错误信息。 |
449
+
450
+ |参数|描述|
451
+ |---------|---------|
452
+ |errCode|错误码,ERR_NULL 代表成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
453
+ |errMsg|错误信息。|
435
454
 
436
455
  ## onUpdateOtherRoomForwardMode
437
456
 
438
- #### 更改跨房主播上行能力的结果回调。
457
+ **更改跨房主播上行能力的结果回调。**
439
458
 
440
459
  调用 TRTCCloud 中的 updateOtherRoomForwardMode 接口会限制跨房主播在本房间内的上行能力,禁止或允许跨房主播发布音频/主路视频/辅路视频,该行为会影响房间内的所有用户。
441
460
 
442
461
  调用者会收到 ` onUpdateOtherRoomForwardMode() ` 回调来获知更改跨房主播上行能力是否成功。
443
- | 参数 | 描述 |
444
- | --- | --- |
445
- | errCode | 错误码,ERR_NULL 代表成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
446
- | errMsg | 错误信息。 |
462
+
463
+ |参数|描述|
464
+ |---------|---------|
465
+ |errCode|错误码,ERR_NULL 代表成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
466
+ |errMsg|错误信息。|
447
467
 
448
468
  ## onRemoteUserEnterRoom
449
469
 
450
- #### 有用户加入当前房间。
470
+ **有用户加入当前房间。**
451
471
 
452
472
  出于性能方面的考虑,在 TRTC 两种不同的应用场景(即 ` AppScene `,在 enterRoom 时通过第二个参数指定)下,该通知的行为会有差别:
453
473
  - 直播类场景(TRTC_APP_SCENE_LIVE 和 TRTC_APP_SCENE_VOICE_CHATROOM):该场景下的用户区分主播和观众两种角色,只有主播进入房间时才会触发该通知,观众进入房间时不会触发该通知。
454
474
 
455
475
  - 通话类场景(TRTC_APP_SCENE_VIDEOCALL 和 TRTC_APP_SCENE_AUDIOCALL):该场景下的用户没有角色的区分(可认为都是主播),任何用户进入房间都会触发该通知。
456
476
 
457
- | 参数 | 描述 |
458
- | --- | --- |
459
- | userId | 远端用户的用户标识。 |
477
+ |参数|描述|
478
+ |---------|---------|
479
+ |userId|远端用户的用户标识。|
460
480
 
461
481
  > **注意**
462
482
  >
@@ -469,43 +489,45 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
469
489
 
470
490
  ## onRemoteUserLeaveRoom
471
491
 
472
- #### 有用户离开当前房间。
492
+ **有用户离开当前房间。**
473
493
 
474
494
  与 onRemoteUserEnterRoom 相对应,在两种不同的应用场景(即 AppScene,在 enterRoom 时通过第二个参数指定)下,该通知的行为会有差别:
475
495
  - 直播类场景(TRTC_APP_SCENE_LIVE 和 TRTC_APP_SCENE_VOICE_CHATROOM):该场景下的用户区分主播和观众两种角色,只有主播离开房间时才会触发该通知,观众离开房间时不会触发该通知。
476
496
 
477
497
  - 通话类场景(TRTC_APP_SCENE_VIDEOCALL 和 TRTC_APP_SCENE_AUDIOCALL):该场景下的用户没有角色的区分(可认为都是主播),任何用户离开房间都会触发该通知。
478
498
 
479
- | 参数 | 描述 |
480
- | --- | --- |
481
- | reason | 离开原因,0表示用户主动退出房间,1表示用户超时退出,2表示被移出房间,3表示主播因切换到观众退出房间。 |
482
- | userId | 远端用户的用户标识。 |
499
+ |参数|描述|
500
+ |---------|---------|
501
+ |reason|离开原因,0表示用户主动退出房间,1表示用户超时退出,2表示被移出房间,3表示主播因切换到观众退出房间。|
502
+ |userId|远端用户的用户标识。|
483
503
 
484
504
  ## onUserVideoAvailable
485
505
 
486
- #### 某远端用户发布/取消了主路视频画面。
506
+ **某远端用户发布/取消了主路视频画面。**
487
507
 
488
508
  **主路画面** 一般被用于承载摄像头画面。当您收到 ` onUserVideoAvailable(userId, true) ` 通知时,表示该路画面已经有可播放的视频帧到达。
489
509
 
490
510
  此时,您需要调用 startRemoteView 接口订阅该用户的远程画面,订阅成功后,您会继续收到该用户的首帧画面渲染回调 ` onFirstVideoFrame(userId) `。
491
511
 
492
512
  当您收到 ` onUserVideoAvailable(userId, false) ` 通知时,表示该路远程画面已经被关闭,关闭的原因可能是该用户调用了 muteLocalVideo 或 stopLocalPreview。
493
- | 参数 | 描述 |
494
- | --- | --- |
495
- | available | 该用户是否发布(或取消发布)了主路视频画面,true:发布;false:取消发布。 |
496
- | userId | 远端用户的用户标识。 |
513
+
514
+ |参数|描述|
515
+ |---------|---------|
516
+ |available|该用户是否发布(或取消发布)了主路视频画面,true:发布;false:取消发布。|
517
+ |userId|远端用户的用户标识。|
497
518
 
498
519
  ## onUserSubStreamAvailable
499
520
 
500
- #### 某远端用户发布/取消了辅路视频画面。
521
+ **某远端用户发布/取消了辅路视频画面。**
501
522
 
502
523
  “辅路画面”一般被用于承载屏幕分享的画面。当您收到 ` onUserSubStreamAvailable(userId, true) ` 通知时,表示该路画面已经有可播放的视频帧到达。
503
524
 
504
525
  此时,您需要调用 startRemoteView 接口订阅该用户的远程画面,订阅成功后,您会继续收到该用户的首帧画面渲染回调 ` onFirstVideoFrame(userId) `。
505
- | 参数 | 描述 |
506
- | --- | --- |
507
- | available | 该用户是否发布(或取消发布)了辅路视频画面,true: 发布;false:取消发布。 |
508
- | userId | 远端用户的用户标识。 |
526
+
527
+ |参数|描述|
528
+ |---------|---------|
529
+ |available|该用户是否发布(或取消发布)了辅路视频画面,true: 发布;false:取消发布。|
530
+ |userId|远端用户的用户标识。|
509
531
 
510
532
  > **注意**
511
533
  >
@@ -515,17 +537,17 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
515
537
 
516
538
  ## onUserAudioAvailable
517
539
 
518
- #### 某远端用户发布/取消了自己的音频。
540
+ **某远端用户发布/取消了自己的音频。**
519
541
 
520
542
  当您收到 ` onUserAudioAvailable(userId, true) ` 通知时,表示该用户发布了自己的声音,此时 SDK 的表现为:
521
543
  - 在自动订阅模式下,您无需做任何操作,SDK 会自动播放该用户的声音。
522
544
 
523
545
  - 在手动订阅模式下,您可以通过 muteRemoteAudio(userid, false) 来播放该用户的声音。
524
546
 
525
- | 参数 | 描述 |
526
- | --- | --- |
527
- | available | 该用户是否发布(或取消发布)了自己的音频,true: 发布;false:取消发布。 |
528
- | userId | 远端用户的用户标识。 |
547
+ |参数|描述|
548
+ |---------|---------|
549
+ |available|该用户是否发布(或取消发布)了自己的音频,true: 发布;false:取消发布。|
550
+ |userId|远端用户的用户标识。|
529
551
 
530
552
  > **注意**
531
553
  >
@@ -535,19 +557,19 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
535
557
 
536
558
  ## onFirstVideoFrame
537
559
 
538
- #### SDK 开始渲染自己本地或远端用户的首帧画面。
560
+ **SDK 开始渲染自己本地或远端用户的首帧画面。**
539
561
 
540
562
  SDK 会在渲染自己本地或远端用户的首帧画面时抛出该事件,您可以通过回调事件中的 userId 参数来判断事件来自于“本地”还是来自于“远端”。
541
563
  - 如果 userId 为空值,代表 SDK 已经开始渲染自己本地的视频画面,不过前提是您已经调用了 startLocalPreview 或 startScreenCapture。
542
564
 
543
565
  - 如果 userId 不为空,代表 SDK 已经开始渲染远端用户的视频画面,不过前提是您已经调用了 startRemoteView 订阅了该用户的视频画面。
544
566
 
545
- | 参数 | 描述 |
546
- | --- | --- |
547
- | height | 画面的高度。 |
548
- | streamType | 视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。 |
549
- | userId | 本地或远端的用户标识,如果 userId 为空值代表自己本地的首帧画面已到来,userId 不为空则代表远端用户的首帧画面已到来。 |
550
- | width | 画面的宽度。 |
567
+ |参数|描述|
568
+ |---------|---------|
569
+ |height|画面的高度。|
570
+ |streamType|视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。|
571
+ |userId|本地或远端的用户标识,如果 userId 为空值代表自己本地的首帧画面已到来,userId 不为空则代表远端用户的首帧画面已到来。|
572
+ |width|画面的宽度。|
551
573
 
552
574
  > **注意**
553
575
  >
@@ -560,76 +582,82 @@ SDK 会在渲染自己本地或远端用户的首帧画面时抛出该事件,
560
582
 
561
583
  ## onFirstAudioFrame
562
584
 
563
- #### SDK 开始播放远端用户的首帧音频。
585
+ **SDK 开始播放远端用户的首帧音频。**
564
586
 
565
587
  SDK 会在播放远端用户的首帧音频时抛出该事件,本地音频的首帧事件暂不抛出。
566
- | 参数 | 描述 |
567
- | --- | --- |
568
- | userId | 远端用户的用户标识。 |
588
+
589
+ |参数|描述|
590
+ |---------|---------|
591
+ |userId|远端用户的用户标识。|
569
592
 
570
593
  ## onSendFirstLocalVideoFrame
571
594
 
572
- #### 自己本地的首个视频帧已被发布出去。
595
+ **自己本地的首个视频帧已被发布出去。**
573
596
 
574
597
  当您成功进入房间并通过 startLocalPreview 或 startScreenCapture 开启本地视频采集之后(开启采集和进入房间的先后顺序无影响),SDK 就会开始进行视频编码,并通过自身的网络模块向云端发布自己本地的视频数据。当 SDK 成功地向云端送出自己的第一帧视频数据帧以后,就会抛出 ` onSendFirstLocalVideoFrame ` 事件回调。
575
- | 参数 | 描述 |
576
- | --- | --- |
577
- | streamType | 视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。 |
598
+
599
+ |参数|描述|
600
+ |---------|---------|
601
+ |streamType|视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。|
578
602
 
579
603
  ## onSendFirstLocalAudioFrame
580
604
 
581
- #### 自己本地的首个音频帧已被发布出去。
605
+ **自己本地的首个音频帧已被发布出去。**
582
606
 
583
607
  当您成功进入房间并通过 startLocalAudio 开启本地音频采集之后(开启采集和进入房间的先后顺序无影响),SDK 就会开始进行音频编码,并通过自身的网络模块向云端发布自己本地的音频数据。当 SDK 成功地向云端送出自己的第一帧音频数据帧以后,就会抛出 ` onSendFirstLocalAudioFrame ` 事件回调。
584
608
 
585
609
  ## onRemoteVideoStatusUpdated
586
610
 
587
- #### 远端视频状态变化的事件回调。
611
+ **远端视频状态变化的事件回调。**
588
612
 
589
613
  您可以通过此事件回调获取远端每一路画面的播放状态(包括 Playing、Loading 和 Stopped 三种状态),从而进行相应的 UI 展示。
590
- | 参数 | 描述 |
591
- | --- | --- |
592
- | extrainfo | 额外信息。 |
593
- | reason | 视频状态改变的原因。 |
594
- | status | 视频状态:包括 Playing、Loading 和 Stopped 三种状态。 |
595
- | streamType | 视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。 |
596
- | userId | 用户标识。 |
614
+
615
+ |参数|描述|
616
+ |---------|---------|
617
+ |extrainfo|额外信息。|
618
+ |reason|视频状态改变的原因。|
619
+ |status|视频状态:包括 Playing、Loading 和 Stopped 三种状态。|
620
+ |streamType|视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。|
621
+ |userId|用户标识。|
597
622
 
598
623
  ## onRemoteAudioStatusUpdated
599
624
 
600
- #### 远端音频状态变化的事件回调。
625
+ **远端音频状态变化的事件回调。**
601
626
 
602
627
  您可以通过此事件回调获取远端每一路音频的播放状态(包括 Playing、Loading 和 Stopped 三种状态),从而进行相应的 UI 展示。
603
- | 参数 | 描述 |
604
- | --- | --- |
605
- | extrainfo | 额外信息。 |
606
- | reason | 音频状态改变的原因。 |
607
- | status | 音频状态:包括 Playing、Loading 和 Stopped 三种状态。 |
608
- | userId | 用户标识。 |
628
+
629
+ |参数|描述|
630
+ |---------|---------|
631
+ |extrainfo|额外信息。|
632
+ |reason|音频状态改变的原因。|
633
+ |status|音频状态:包括 Playing、Loading 和 Stopped 三种状态。|
634
+ |userId|用户标识。|
609
635
 
610
636
  ## onUserVideoSizeChanged
611
637
 
612
- #### 用户视频大小发生改变回调。
638
+ **用户视频大小发生改变回调。**
613
639
 
614
640
  当您收到 ` onUserVideoSizeChanged(userId, streamType, newWidth, newHeight) ` 通知时,表示该路画面大小发生了调整,调整的原因可能是该用户调用了 setVideoEncoderParam 或者 setSubStreamEncoderParam 重新设置了画面尺寸。
615
- | 参数 | 描述 |
616
- | --- | --- |
617
- | newHeight | 视频流的高度(像素)。 |
618
- | newWidth | 视频流的宽度(像素)。 |
619
- | streamType | 视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。 |
620
- | userId | 用户标识。 |
641
+
642
+ |参数|描述|
643
+ |---------|---------|
644
+ |newHeight|视频流的高度(像素)。|
645
+ |newWidth|视频流的宽度(像素)。|
646
+ |streamType|视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。|
647
+ |userId|用户标识。|
621
648
 
622
649
  ## onNetworkQuality
623
650
 
624
- #### 网络质量的实时统计回调。
651
+ **网络质量的实时统计回调。**
625
652
 
626
653
  该统计回调每间隔2秒抛出一次,用于通知 SDK 感知到的当前网络的上行和下行质量。
627
654
 
628
655
  SDK 会使用一组内嵌的自研算法对当前网络的延迟高低、带宽大小以及稳定情况进行评估,并计算出一个评估结果:如果评估结果为 1(Excellent) 代表当前的网络情况非常好,如果评估结果为 6(Down)代表当前网络无法支撑 TRTC 的正常通话。
629
- | 参数 | 描述 |
630
- | --- | --- |
631
- | localQuality | 上行网络质量。 |
632
- | remoteQuality | 下行网络质量,代表数据流历经“远端->云端->本端”这样一条完整的传输链路后,最终在本端统计到的数据质量。因此,这里的下行网络质量代表的是远端上行链路与本端下行链路共同影响的结果。 |
656
+
657
+ |参数|描述|
658
+ |---------|---------|
659
+ |localQuality|上行网络质量。|
660
+ |remoteQuality|下行网络质量,代表数据流历经“远端->云端->本端”这样一条完整的传输链路后,最终在本端统计到的数据质量。因此,这里的下行网络质量代表的是远端上行链路与本端下行链路共同影响的结果。|
633
661
 
634
662
  > **注意**
635
663
  >
@@ -639,7 +667,7 @@ SDK 会使用一组内嵌的自研算法对当前网络的延迟高低、带宽
639
667
 
640
668
  ## onStatistics
641
669
 
642
- #### 音视频技术指标的实时统计回调。
670
+ **音视频技术指标的实时统计回调。**
643
671
 
644
672
  该统计回调每间隔2秒抛出一次,用于通知 SDK 内部音频、视频以及网络相关的专业技术指标,这些信息在 TRTCStatistics 均有罗列:
645
673
  - 视频统计信息:视频的分辨率(resolution)、帧率(FPS)和比特率(bitrate)等信息。
@@ -648,9 +676,9 @@ SDK 会使用一组内嵌的自研算法对当前网络的延迟高低、带宽
648
676
 
649
677
  - 网络统计信息:SDK 和云端一次往返(SDK > Cloud > SDK)的网络耗时(rtt)、丢包率(loss)、上行流量(sentBytes)和下行流量(receivedBytes)等信息。
650
678
 
651
- | 参数 | 描述 |
652
- | --- | --- |
653
- | statistics | 统计数据,包括自己本地的统计信息和远端用户的统计信息,详情请参考 TRTCStatistics。 |
679
+ |参数|描述|
680
+ |---------|---------|
681
+ |statistics|统计数据,包括自己本地的统计信息和远端用户的统计信息,详情请参考 TRTCStatistics。|
654
682
 
655
683
  > **注意**
656
684
  >
@@ -660,16 +688,17 @@ SDK 会使用一组内嵌的自研算法对当前网络的延迟高低、带宽
660
688
 
661
689
  ## onSpeedTestResult
662
690
 
663
- #### 网速测试的结果回调。
691
+ **网速测试的结果回调。**
664
692
 
665
693
  该统计回调由 startSpeedTest 触发。
666
- | 参数 | 描述 |
667
- | --- | --- |
668
- | result | 网速测试结果,包括丢包、往返延迟、上下行的带宽速率,详情请参见 TRTCSpeedTestResult。 |
694
+
695
+ |参数|描述|
696
+ |---------|---------|
697
+ |result|网速测试结果,包括丢包、往返延迟、上下行的带宽速率,详情请参见 TRTCSpeedTestResult。|
669
698
 
670
699
  ## onConnectionLost
671
700
 
672
- #### SDK 与云端的连接已经断开。
701
+ **SDK 与云端的连接已经断开。**
673
702
 
674
703
  SDK 会在跟云端的连接断开时抛出此事件回调,导致断开的原因大多是网络不可用或者网络切换所致,例如用户在通话中走进电梯时就可能会遇到此事件。
675
704
 
@@ -679,19 +708,19 @@ SDK 会在跟云端的连接断开时抛出此事件回调,导致断开的原
679
708
 
680
709
  ## onTryToReconnect
681
710
 
682
- #### SDK 正在尝试重新连接到云端。
711
+ **SDK 正在尝试重新连接到云端。**
683
712
 
684
713
  SDK 会在跟云端的连接断开时抛出 onConnectionLost,之后会努力跟云端重新建立连接并抛出本事件,连接恢复后会抛出 onConnectionRecovery。
685
714
 
686
715
  ## onConnectionRecovery
687
716
 
688
- #### SDK 与云端的连接已经恢复。
717
+ **SDK 与云端的连接已经恢复。**
689
718
 
690
719
  SDK 会在跟云端的连接断开时抛出 onConnectionLost,之后会努力跟云端重新建立连接并抛出 onTryToReconnect,连接恢复后会抛出本事件回调。
691
720
 
692
721
  ## onCameraDidReady
693
722
 
694
- #### 摄像头准备就绪。
723
+ **摄像头准备就绪。**
695
724
 
696
725
  当您调用 startLocalPreview 之后,SDK 会尝试启动摄像头,如果摄像头能够启动成功就会抛出本事件。
697
726
 
@@ -701,7 +730,7 @@ SDK 会在跟云端的连接断开时抛出 onConnectionLost,之后会努力
701
730
 
702
731
  ## onMicDidReady
703
732
 
704
- #### 麦克风准备就绪。
733
+ **麦克风准备就绪。**
705
734
 
706
735
  当您调用 startLocalAudio 之后,SDK 会尝试启动麦克风,如果麦克风能够启动成功就会抛出本事件。
707
736
 
@@ -711,7 +740,7 @@ SDK 会在跟云端的连接断开时抛出 onConnectionLost,之后会努力
711
740
 
712
741
  ## onAudioRouteChanged
713
742
 
714
- #### 当前音频路由发生变化(仅适用于移动设备)。
743
+ **当前音频路由发生变化(仅适用于移动设备)。**
715
744
 
716
745
  所谓“音频路由”,是指声音是从手机的扬声器还是从听筒中播放出来,音频路由变化也就是声音的播放位置发生了变化。
717
746
  - 当音频路由为听筒时,声音比较小,只有将耳朵凑近才能听清楚,隐私性较好,适合用于接听电话。
@@ -724,24 +753,25 @@ SDK 会在跟云端的连接断开时抛出 onConnectionLost,之后会努力
724
753
 
725
754
  - 当音频路由为USB专业声卡设备。
726
755
 
727
- | 参数 | 描述 |
728
- | --- | --- |
729
- | fromRoute | 变更前的音频路由。 |
730
- | route | 音频路由,即声音由哪里输出(扬声器、听筒)。 |
756
+ |参数|描述|
757
+ |---------|---------|
758
+ |fromRoute|变更前的音频路由。|
759
+ |route|音频路由,即声音由哪里输出(扬声器、听筒)。|
731
760
 
732
761
  ## onUserVoiceVolume
733
762
 
734
- #### 音量大小的反馈回调。
763
+ **音量大小的反馈回调。**
735
764
 
736
765
  SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该事件回调,您可以根据音量大小在 UI 上做出相应的提示,例如` 波形图 `或` 音量槽 `。
737
766
 
738
767
  要完成这个功能, 您需要先调用 enableAudioVolumeEvaluation 开启这个能力并设定事件抛出的时间间隔。
739
768
 
740
769
  需要补充说明的是,无论当前房间中是否有人说话,SDK 都会按照您设定的时间间隔定时抛出此事件回调。
741
- | 参数 | 描述 |
742
- | --- | --- |
743
- | totalVolume | 所有远端用户的总音量大小,取值范围 [0, 100]。 |
744
- | userVolumes | 是一个数组,用于承载所有正在说话的用户的音量大小,取值范围 [0, 100]。 |
770
+
771
+ |参数|描述|
772
+ |---------|---------|
773
+ |totalVolume|所有远端用户的总音量大小,取值范围 [0, 100]。|
774
+ |userVolumes|是一个数组,用于承载所有正在说话的用户的音量大小,取值范围 [0, 100]。|
745
775
 
746
776
  > **注意**
747
777
  >
@@ -751,29 +781,31 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
751
781
 
752
782
  ## onRecvCustomCmdMsg
753
783
 
754
- #### 收到自定义消息的事件回调。
784
+ **收到自定义消息的事件回调。**
755
785
 
756
786
  当房间中的某个用户使用 sendCustomCmdMsg 发送自定义 UDP 消息时,房间中的其他用户可以通过 ` onRecvCustomCmdMsg ` 事件回调接收到该条消息。
757
- | 参数 | 描述 |
758
- | --- | --- |
759
- | cmdID | 命令 ID。 |
760
- | message | 消息数据。 |
761
- | seq | 消息序号。 |
762
- | userId | 用户标识。 |
787
+
788
+ |参数|描述|
789
+ |---------|---------|
790
+ |cmdID|命令 ID。|
791
+ |message|消息数据。|
792
+ |seq|消息序号。|
793
+ |userId|用户标识。|
763
794
 
764
795
  ## onMissCustomCmdMsg
765
796
 
766
- #### 自定义消息丢失的事件回调。
797
+ **自定义消息丢失的事件回调。**
767
798
 
768
799
  当您使用 sendCustomCmdMsg 发送自定义 UDP 消息时,即使设置了可靠传输(reliable),也无法确 100% 不丢失,只是丢消息概率极低,能满足常规可靠性要求。
769
800
 
770
801
  在发送端设置了可靠运输(reliable)后,SDK 都会通过此回调通知过去时间段内(通常为5s)传输途中丢失的自定义消息数量统计信息。
771
- | 参数 | 描述 |
772
- | --- | --- |
773
- | cmdID | 命令 ID。 |
774
- | errCode | 错误码。 |
775
- | missed | 丢失的消息数量。 |
776
- | userId | 用户标识。 |
802
+
803
+ |参数|描述|
804
+ |---------|---------|
805
+ |cmdID|命令 ID。|
806
+ |errCode|错误码。|
807
+ |missed|丢失的消息数量。|
808
+ |userId|用户标识。|
777
809
 
778
810
  > **注意**
779
811
  >
@@ -783,47 +815,51 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
783
815
 
784
816
  ## onRecvSEIMsg
785
817
 
786
- #### 收到 SEI 消息的回调。
818
+ **收到 SEI 消息的回调。**
787
819
 
788
820
  当房间中的某个用户使用 sendSEIMsg 借助视频数据帧发送 SEI 消息时,房间中的其他用户可以通过 ` onRecvSEIMsg ` 事件回调接收到该条消息。
789
- | 参数 | 描述 |
790
- | --- | --- |
791
- | message | 数据。 |
792
- | userId | 用户标识。 |
821
+
822
+ |参数|描述|
823
+ |---------|---------|
824
+ |message|数据。|
825
+ |userId|用户标识。|
793
826
 
794
827
  ## onStartPublishing
795
828
 
796
- #### 开始向腾讯云直播 CDN 上发布音视频流的事件回调。
829
+ **开始向腾讯云直播 CDN 上发布音视频流的事件回调。**
797
830
 
798
831
  当您调用 startPublishing 开始向腾讯云直播 CDN 上发布音视频流时,SDK 会立刻将这一指令同步给云端服务器。
799
832
 
800
833
  随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
801
- | 参数 | 描述 |
802
- | --- | --- |
803
- | err | 0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
804
- | errMsg | 具体错误原因。 |
834
+
835
+ |参数|描述|
836
+ |---------|---------|
837
+ |err|0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
838
+ |errMsg|具体错误原因。|
805
839
 
806
840
  ## onStopPublishing
807
841
 
808
- #### 停止向腾讯云直播 CDN 上发布音视频流的事件回调。
842
+ **停止向腾讯云直播 CDN 上发布音视频流的事件回调。**
809
843
 
810
844
  当您调用 stopPublishing 停止向腾讯云直播 CDN 上发布音视频流时,SDK 会立刻将这一指令同步给云端服务器。
811
845
 
812
846
  随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
813
- | 参数 | 描述 |
814
- | --- | --- |
815
- | err | 0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
816
- | errMsg | 具体错误原因。 |
847
+
848
+ |参数|描述|
849
+ |---------|---------|
850
+ |err|0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
851
+ |errMsg|具体错误原因。|
817
852
 
818
853
  ## onStartPublishCDNStream
819
854
 
820
- #### 开始向非腾讯云 CDN 上发布音视频流的事件回调。
855
+ **开始向非腾讯云 CDN 上发布音视频流的事件回调。**
821
856
 
822
857
  当您调用 startPublishCDNStream 开始向非腾讯云直播 CDN 上发布音视频流时,SDK 会立刻将这一指令同步给云端服务器。随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
823
- | 参数 | 描述 |
824
- | --- | --- |
825
- | err | 0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
826
- | errMsg | 具体错误原因。 |
858
+
859
+ |参数|描述|
860
+ |---------|---------|
861
+ |err|0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
862
+ |errMsg|具体错误原因。|
827
863
 
828
864
  > **注意**
829
865
  >
@@ -833,63 +869,65 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
833
869
 
834
870
  ## onStopPublishCDNStream
835
871
 
836
- #### 停止向非腾讯云 CDN 上发布音视频流的事件回调。
872
+ **停止向非腾讯云 CDN 上发布音视频流的事件回调。**
837
873
 
838
874
  当您调用 stopPublishCDNStream 开始向非腾讯云直播 CDN 上发布音视频流时,SDK 会立刻将这一指令同步给云端服务器。随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
839
- | 参数 | 描述 |
840
- | --- | --- |
841
- | err | 0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
842
- | errMsg | 具体错误原因。 |
875
+
876
+ |参数|描述|
877
+ |---------|---------|
878
+ |err|0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
879
+ |errMsg|具体错误原因。|
843
880
 
844
881
  ## onSetMixTranscodingConfig
845
882
 
846
- #### 设置云端混流的排版布局和转码参数的事件回调。
883
+ **设置云端混流的排版布局和转码参数的事件回调。**
847
884
 
848
885
  当您调用 setMixTranscodingConfig 调整云端混流的排版布局和转码参数时,SDK 会立刻将这一调整指令同步给云端服务器。随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
849
- | 参数 | 描述 |
850
- | --- | --- |
851
- | err | 错误码:0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
852
- | errMsg | 具体的错误原因。 |
886
+
887
+ |参数|描述|
888
+ |---------|---------|
889
+ |err|错误码:0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
890
+ |errMsg|具体的错误原因。|
853
891
 
854
892
  ## onStartPublishMediaStream
855
893
 
856
- #### 开始发布媒体流的事件回调。
894
+ **开始发布媒体流的事件回调。**
857
895
 
858
896
  当您调用 startPublishMediaStream 开始向 TRTC 后台服务发布媒体流时,SDK 会立刻将这一指令同步给云端服务器,随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
859
897
  | 参数 | 描述 |
860
898
  | --- | --- |
861
- | code | 回调结果,0 表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
862
- | 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: 资源受限,建议延迟重试 |
899
+ | code | 回调结果,0 表示成功,其余值表示失败,详见<a href="https://cloud.tencent.com/document/product/647/32257">错误码</a>。 |
900
+ | 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: 资源受限,建议延迟重试 |
863
901
  | message | 具体回调信息。 |
864
902
  | taskId | 当请求成功时,TRTC 后台会在回调中提供给您这项任务的 taskId,后续您可以通过该 taskId 结合 updatePublishMediaStream 和 stopPublishMediaStream 进行更新和停止。 |
865
903
 
866
904
  ## onUpdatePublishMediaStream
867
905
 
868
- #### 更新媒体流的事件回调。
906
+ **更新媒体流的事件回调。**
869
907
 
870
908
  当您调用媒体流发布接口 (updatePublishMediaStream) 开始向 TRTC 后台服务更新媒体流时,SDK 会立刻将这一指令同步给云端服务器,随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
871
909
  | 参数 | 描述 |
872
910
  | --- | --- |
873
- | code | 回调结果,0 表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
874
- | 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 接口启动任务 |
911
+ | code | 回调结果,0 表示成功,其余值表示失败,详见<a href="https://cloud.tencent.com/document/product/647/32257">错误码</a>。 |
912
+ | 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 接口启动任务 |
875
913
  | message | 具体回调信息。 |
876
914
  | taskId | 您调用媒体流发布接口 (updatePublishMediaStream) 时传入的 taskId,会通过此回调再带回给您,用于标识该回调属于哪一次更新请求。 |
877
915
 
878
916
  ## onStopPublishMediaStream
879
917
 
880
- #### 停止媒体流的事件回调。
918
+ **停止媒体流的事件回调。**
881
919
 
882
920
  当您调用停止发布媒体流 (stopPublishMediaStream) 开始向 TRTC 后台服务停止媒体流时,SDK 会立刻将这一指令同步给云端服务器,随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
883
921
  | 参数 | 描述 |
884
922
  | --- | --- |
885
- | code | 回调结果,0 表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
886
- | extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用"error_code"做为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>- 2000: 参数错误,建议检查请求参数<br>- 2002: 找不到任务,无需处理<br>- 3000: 服务器内部错误,建议重试<br>- 4003: 任务正在退出中,无需处理 |
923
+ | code | 回调结果,0 表示成功,其余值表示失败,详见<a href="https://cloud.tencent.com/document/product/647/32257">错误码</a>。 |
924
+ | extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用“error_code” 作为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>- 2000: 参数错误,建议检查请求参数<br>- 2002: 找不到任务,无需处理<br>- 3000: 服务器内部错误,建议重试<br>- 4003: 任务正在退出中,无需处理 |
887
925
  | message | 具体回调信息。 |
888
926
  | taskId | 您调用停止发布媒体流 (stopPublishMediaStream) 时传入的 taskId,会通过此回调再带回给您,用于标识该回调属于哪一次停止请求。 |
889
927
 
890
928
  ## onCdnStreamStateChanged
891
929
 
892
- #### RTMP/RTMPS 推流状态发生改变回调。
930
+ **RTMP/RTMPS 推流状态发生改变回调。**
893
931
 
894
932
  当您调用 startPublishMediaStream 开始向 TRTC 后台服务发布媒体流时,SDK 会立刻将这一指令同步给云端服务。
895
933
 
@@ -897,41 +935,42 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
897
935
  | 参数 | 描述 |
898
936
  | --- | --- |
899
937
  | cdnUrl | 您调用 startPublishMediaStream 时通过目标推流配置 (TRTCPublishTarget) 传入的 url,在推流状态变更时,会通过此回调同步给您。 |
900
- | code | 推流结果,0 表示成功,其余值表示出错,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
938
+ | code | 推流结果,0 表示成功,其余值表示出错,详见<a href="https://cloud.tencent.com/document/product/647/32257">错误码</a>。 |
901
939
  | extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。 |
902
940
  | message | 具体推流信息。 |
903
941
  | 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。 |
904
942
 
905
943
  ## onScreenCaptureStarted
906
944
 
907
- #### 屏幕分享开启的事件回调。
945
+ **屏幕分享开启的事件回调。**
908
946
 
909
947
  当您通过 startScreenCapture 等相关接口启动屏幕分享时,SDK 便会抛出此事件回调。
910
948
 
911
949
  ## onScreenCapturePaused
912
950
 
913
- #### 屏幕分享暂停的事件回调。
951
+ **屏幕分享暂停的事件回调。**
914
952
 
915
953
  当您通过 pauseScreenCapture 暂停屏幕分享时,SDK 便会抛出此事件回调。
916
954
 
917
955
  ## onScreenCaptureResumed
918
956
 
919
- #### 屏幕分享恢复的事件回调。
957
+ **屏幕分享恢复的事件回调。**
920
958
 
921
959
  当您通过 resumeScreenCapture 恢复屏幕分享时,SDK 便会抛出此事件回调。
922
960
 
923
961
  ## onScreenCaptureStopped
924
962
 
925
- #### 屏幕分享停止的事件回调。
963
+ **屏幕分享停止的事件回调。**
926
964
 
927
965
  当您通过 stopScreenCapture 停止屏幕分享时,SDK 便会抛出此事件回调。
928
- | 参数 | 描述 |
929
- | --- | --- |
930
- | reason | 停止原因,0:用户主动停止;1:屏幕窗口关闭导致停止;2:表示屏幕分享的显示屏状态变更(如接口被拔出、投影模式变更等)。 |
966
+
967
+ |参数|描述|
968
+ |---------|---------|
969
+ |reason|停止原因,0:用户主动停止;1:屏幕窗口关闭导致停止;2:表示屏幕分享的显示屏状态变更(如接口被拔出、投影模式变更等)。|
931
970
 
932
971
  ## onLocalRecordBegin
933
972
 
934
- #### 本地录制任务已经开始的事件回调。
973
+ **本地录制任务已经开始的事件回调。**
935
974
 
936
975
  当您调用 startLocalRecording 启动本地媒体录制任务时,SDK 会抛出该事件回调,用于通知您录制任务是否已经顺利启动。
937
976
  | 参数 | 描述 |
@@ -941,30 +980,32 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
941
980
 
942
981
  ## onLocalRecording
943
982
 
944
- #### 本地录制任务正在进行中的进展事件回调。
983
+ **本地录制任务正在进行中的进展事件回调。**
945
984
 
946
985
  当您调用 startLocalRecording 成功启动本地媒体录制任务后,SDK 会定时地抛出本事件回调。
947
986
 
948
987
  您可通过捕获该事件回调来获知录制任务的健康状况。
949
988
 
950
989
  您可以在 startLocalRecording 时设定本事件回调的抛出间隔。
951
- | 参数 | 描述 |
952
- | --- | --- |
953
- | duration | 已经录制的累计时长,单位毫秒。 |
954
- | storagePath | 录制文件存储路径。 |
990
+
991
+ |参数|描述|
992
+ |---------|---------|
993
+ |duration|已经录制的累计时长,单位毫秒。|
994
+ |storagePath|录制文件存储路径。|
955
995
 
956
996
  ## onLocalRecordFragment
957
997
 
958
- #### 本地录制分片的事件回调。
998
+ **本地录制分片的事件回调。**
959
999
 
960
1000
  当您开启分片录制时,每完成一个分片,都会通过此接口回调。
961
- | 参数 | 描述 |
962
- | --- | --- |
963
- | storagePath | 分片文件存储路径。 |
1001
+
1002
+ |参数|描述|
1003
+ |---------|---------|
1004
+ |storagePath|分片文件存储路径。|
964
1005
 
965
1006
  ## onLocalRecordComplete
966
1007
 
967
- #### 本地录制任务已经结束的事件回调。
1008
+ **本地录制任务已经结束的事件回调。**
968
1009
 
969
1010
  当您调用 stopLocalRecording 停止本地媒体录制任务时,SDK 会抛出该事件回调,用于通知您录制任务的最终结果。
970
1011
  | 参数 | 描述 |
@@ -974,17 +1015,18 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
974
1015
 
975
1016
  ## onSnapshotComplete
976
1017
 
977
- #### 本地截图完成的事件回调。
978
- | 参数 | 描述 |
979
- | --- | --- |
980
- | bmp | 截图结果,如果 bmp 为 null 代表本次截图操作失败。 |
981
- | data | 截图数据,为 nullptr 表示截图失败。 |
982
- | format | 截图数据格式,目前只支持 TRTCVideoPixelFormat_BGRA32。 |
983
- | height | 截图画面的高度。 |
984
- | length | 截图数据长度,对于BGRA32而言,` length = width * height * 4 `。 |
985
- | type | 视频流类型。 |
986
- | userId | 用户标识,如果 userId 为空字符串,则代表截取的是本地画面。 |
987
- | width | 截图画面的宽度。 |
1018
+ **本地截图完成的事件回调。**
1019
+
1020
+ |参数|描述|
1021
+ |---------|---------|
1022
+ |bmp|截图结果,如果 bmp 为 null 代表本次截图操作失败。|
1023
+ |data|截图数据,为 nullptr 表示截图失败。|
1024
+ |format|截图数据格式,目前只支持 TRTCVideoPixelFormat_BGRA32。|
1025
+ |height|截图画面的高度。|
1026
+ |length|截图数据长度,对于BGRA32而言,` length = width * height * 4 `。|
1027
+ |type|视频流类型。|
1028
+ |userId|用户标识,如果 userId 为空字符串,则代表截取的是本地画面。|
1029
+ |width|截图画面的宽度。|
988
1030
 
989
1031
  > **注意**
990
1032
  >
@@ -992,21 +1034,25 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
992
1034
  > 全平台 C++ 接口和 Java 接口在参数上是不一样的,C++ 接口用 7 个参数描述一个截图画面,Java 接口只用一个 Bitmap 描述一个截图画面。
993
1035
  >
994
1036
 
1037
+ ## onExperimentalEvent
1038
+
1039
+ **实验性接口的事件回调。**
1040
+
995
1041
  ## onUserEnter
996
1042
 
997
- #### 有主播加入当前房间(已废弃)。
1043
+ **有主播加入当前房间(已废弃)。**
998
1044
 
999
1045
  @deprecated 新版本开始不推荐使用,建议使用 onRemoteUserEnterRoom 替代之。
1000
1046
 
1001
1047
  ## onUserExit
1002
1048
 
1003
- #### 有主播离开当前房间(已废弃)。
1049
+ **有主播离开当前房间(已废弃)。**
1004
1050
 
1005
1051
  @deprecated 新版本开始不推荐使用,建议使用 onRemoteUserLeaveRoom 替代之。
1006
1052
 
1007
1053
  ## onAudioEffectFinished
1008
1054
 
1009
- #### 音效播放已结束(已废弃)。
1055
+ **音效播放已结束(已废弃)。**
1010
1056
 
1011
1057
  @deprecated 新版本开始不推荐使用,建议使用 TXAudioEffectManager 接口替代之。
1012
1058
 
@@ -1014,6 +1060,6 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
1014
1060
 
1015
1061
  ## onSpeedTest
1016
1062
 
1017
- #### 服务器测速的结果回调(已废弃)。
1063
+ **服务器测速的结果回调(已废弃)。**
1018
1064
 
1019
1065
  @deprecated 新版本开始不推荐使用,建议使用 onSpeedTestResult 接口替代之。