@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,133 +1,142 @@
1
- # 腾讯云实时音视频(TRTC SDK )文档
1
+ Copyright (c) 2021 Tencent. All rights reserved.
2
2
 
3
- ## 概述
4
- `TRTCCloudCallback.h` 是腾讯云实时音视频(TRTC SDK ) C++ 的事件回调接口文档。
3
+ Module: ITRTCCloudCallback @ TXLiteAVSDK
4
+
5
+ Function: 腾讯云实时音视频的事件回调接口
5
6
 
6
7
  ## ITRTCCloudCallback
7
- | 函数列表 | 描述 |
8
- | --- | --- |
9
- | onError | 错误事件回调。 |
10
- | onWarning | 警告事件回调。 |
11
- | onEnterRoom | 进入房间成功与否的事件回调。 |
12
- | onExitRoom | 离开房间的事件回调。 |
13
- | onSwitchRole | 切换角色的事件回调。 |
14
- | onSwitchRoom | 切换房间的结果回调。 |
15
- | onConnectOtherRoom | 请求跨房通话的结果回调。 |
16
- | onDisconnectOtherRoom | 结束跨房通话的结果回调。 |
17
- | onUpdateOtherRoomForwardMode | 更改跨房主播上行能力的结果回调。 |
18
- | onRemoteUserEnterRoom | 有用户加入当前房间。 |
19
- | onRemoteUserLeaveRoom | 有用户离开当前房间。 |
20
- | onUserVideoAvailable | 某远端用户发布/取消了主路视频画面。 |
21
- | onUserSubStreamAvailable | 某远端用户发布/取消了辅路视频画面。 |
22
- | onUserAudioAvailable | 某远端用户发布/取消了自己的音频。 |
23
- | onFirstVideoFrame | SDK 开始渲染自己本地或远端用户的首帧画面。 |
24
- | onFirstAudioFrame | SDK 开始播放远端用户的首帧音频。 |
25
- | onSendFirstLocalVideoFrame | 自己本地的首个视频帧已被发布出去。 |
26
- | onSendFirstLocalAudioFrame | 自己本地的首个音频帧已被发布出去。 |
27
- | onRemoteVideoStatusUpdated | 远端视频状态变化的事件回调。 |
28
- | onRemoteAudioStatusUpdated | 远端音频状态变化的事件回调。 |
29
- | onUserVideoSizeChanged | 用户视频大小发生改变回调。 |
30
- | onNetworkQuality | 网络质量的实时统计回调。 |
31
- | onStatistics | 音视频技术指标的实时统计回调。 |
32
- | onSpeedTestResult | 网速测试的结果回调。 |
33
- | onConnectionLost | SDK 与云端的连接已经断开。 |
34
- | onTryToReconnect | SDK 正在尝试重新连接到云端。 |
35
- | onConnectionRecovery | SDK 与云端的连接已经恢复。 |
36
- | onCameraDidReady | 摄像头准备就绪。 |
37
- | onMicDidReady | 麦克风准备就绪。 |
38
- | onAudioRouteChanged | 当前音频路由发生变化(仅适用于移动设备)。 |
39
- | onUserVoiceVolume | 音量大小的反馈回调。 |
40
- | onDeviceChange | 本地设备的通断状态发生变化(仅适用于桌面系统)。 |
41
- | onAudioDeviceCaptureVolumeChanged | 当前麦克风的系统采集音量发生变化。 |
42
- | onAudioDevicePlayoutVolumeChanged | 当前系统的播放音量发生变化。 |
43
- | onSystemAudioLoopbackError | 系统声音采集是否被成功开启的事件回调(仅适用于桌面系统)。 |
44
- | onTestMicVolume | 测试麦克风时的音量回调。 |
45
- | onTestSpeakerVolume | 测试扬声器时的音量回调。 |
46
- | onRecvCustomCmdMsg | 收到自定义消息的事件回调。 |
47
- | onMissCustomCmdMsg | 自定义消息丢失的事件回调。 |
48
- | onRecvSEIMsg | 收到 SEI 消息的回调。 |
49
- | onStartPublishing | 开始向腾讯云直播 CDN 上发布音视频流的事件回调。 |
50
- | onStopPublishing | 停止向腾讯云直播 CDN 上发布音视频流的事件回调。 |
51
- | onStartPublishCDNStream | 开始向非腾讯云 CDN 上发布音视频流的事件回调。 |
52
- | onStopPublishCDNStream | 停止向非腾讯云 CDN 上发布音视频流的事件回调。 |
53
- | onSetMixTranscodingConfig | 设置云端混流的排版布局和转码参数的事件回调。 |
54
- | onStartPublishMediaStream | 开始发布媒体流的事件回调。 |
55
- | onUpdatePublishMediaStream | 更新媒体流的事件回调。 |
56
- | onStopPublishMediaStream | 停止媒体流的事件回调。 |
57
- | onCdnStreamStateChanged | RTMP/RTMPS 推流状态发生改变回调。 |
58
- | onScreenCaptureStarted | 屏幕分享开启的事件回调。 |
59
- | onScreenCapturePaused | 屏幕分享暂停的事件回调。 |
60
- | onScreenCaptureResumed | 屏幕分享恢复的事件回调。 |
61
- | onScreenCaptureStoped | 屏幕分享停止的事件回调。 |
62
- | onScreenCaptureCovered | 屏幕分享的目标窗口被遮挡的事件回调(仅适用于 Windows 操作系统)。 |
63
- | onLocalRecordBegin | 本地录制任务已经开始的事件回调。 |
64
- | onLocalRecording | 本地录制任务正在进行中的进展事件回调。 |
65
- | onLocalRecordFragment | 本地录制分片的事件回调。 |
66
- | onLocalRecordComplete | 本地录制任务已经结束的事件回调。 |
67
- | onSnapshotComplete | 本地截图完成的事件回调。 |
68
- | onUserEnter | 有主播加入当前房间(已废弃)。 |
69
- | onUserExit | 有主播离开当前房间(已废弃)。 |
70
- | onAudioEffectFinished | 音效播放已结束(已废弃)。 |
71
- | onPlayBGMBegin | 开始播放背景音乐(已废弃)。 |
72
- | onPlayBGMProgress | 背景音乐的播放进度回调(已废弃)。 |
73
- | onPlayBGMComplete | 背景音乐播放已经结束(已废弃)。 |
74
- | onSpeedTest | 服务器测速的结果回调(已废弃)。 |
8
+
9
+ |函数列表|描述|
10
+ |---------|---------|
11
+ |onError|错误事件回调。|
12
+ |onWarning|警告事件回调。|
13
+ |onEnterRoom|进入房间成功与否的事件回调。|
14
+ |onExitRoom|离开房间的事件回调。|
15
+ |onSwitchRole|切换角色的事件回调。|
16
+ |onSwitchRoom|切换房间的结果回调。|
17
+ |onConnectOtherRoom|请求跨房通话的结果回调。|
18
+ |onDisconnectOtherRoom|结束跨房通话的结果回调。|
19
+ |onUpdateOtherRoomForwardMode|更改跨房主播上行能力的结果回调。|
20
+ |onRemoteUserEnterRoom|有用户加入当前房间。|
21
+ |onRemoteUserLeaveRoom|有用户离开当前房间。|
22
+ |onUserVideoAvailable|某远端用户发布/取消了主路视频画面。|
23
+ |onUserSubStreamAvailable|某远端用户发布/取消了辅路视频画面。|
24
+ |onUserAudioAvailable|某远端用户发布/取消了自己的音频。|
25
+ |onFirstVideoFrame|SDK 开始渲染自己本地或远端用户的首帧画面。|
26
+ |onFirstAudioFrame|SDK 开始播放远端用户的首帧音频。|
27
+ |onSendFirstLocalVideoFrame|自己本地的首个视频帧已被发布出去。|
28
+ |onSendFirstLocalAudioFrame|自己本地的首个音频帧已被发布出去。|
29
+ |onRemoteVideoStatusUpdated|远端视频状态变化的事件回调。|
30
+ |onRemoteAudioStatusUpdated|远端音频状态变化的事件回调。|
31
+ |onUserVideoSizeChanged|用户视频大小发生改变回调。|
32
+ |onNetworkQuality|网络质量的实时统计回调。|
33
+ |onStatistics|音视频技术指标的实时统计回调。|
34
+ |onSpeedTestResult|网速测试的结果回调。|
35
+ |onConnectionLost|SDK 与云端的连接已经断开。|
36
+ |onTryToReconnect|SDK 正在尝试重新连接到云端。|
37
+ |onConnectionRecovery|SDK 与云端的连接已经恢复。|
38
+ |onCameraDidReady|摄像头准备就绪。|
39
+ |onMicDidReady|麦克风准备就绪。|
40
+ |onAudioRouteChanged|当前音频路由发生变化(仅适用于移动设备)。|
41
+ |onUserVoiceVolume|音量大小的反馈回调。|
42
+ |onDeviceChange|本地设备的通断状态发生变化(仅适用于桌面系统)。|
43
+ |onAudioDeviceCaptureVolumeChanged|当前麦克风的系统采集音量发生变化。|
44
+ |onAudioDevicePlayoutVolumeChanged|当前系统的播放音量发生变化。|
45
+ |onSystemAudioLoopbackError|系统声音采集是否被成功开启的事件回调(仅适用于桌面系统)。|
46
+ |onTestMicVolume|测试麦克风时的音量回调。|
47
+ |onTestSpeakerVolume|测试扬声器时的音量回调。|
48
+ |onRecvCustomCmdMsg|收到自定义消息的事件回调。|
49
+ |onMissCustomCmdMsg|自定义消息丢失的事件回调。|
50
+ |onRecvSEIMsg|收到 SEI 消息的回调。|
51
+ |onStartPublishing|开始向腾讯云直播 CDN 上发布音视频流的事件回调。|
52
+ |onStopPublishing|停止向腾讯云直播 CDN 上发布音视频流的事件回调。|
53
+ |onStartPublishCDNStream|开始向非腾讯云 CDN 上发布音视频流的事件回调。|
54
+ |onStopPublishCDNStream|停止向非腾讯云 CDN 上发布音视频流的事件回调。|
55
+ |onSetMixTranscodingConfig|设置云端混流的排版布局和转码参数的事件回调。|
56
+ |onStartPublishMediaStream|开始发布媒体流的事件回调。|
57
+ |onUpdatePublishMediaStream|更新媒体流的事件回调。|
58
+ |onStopPublishMediaStream|停止媒体流的事件回调。|
59
+ |onCdnStreamStateChanged|RTMP/RTMPS 推流状态发生改变回调。|
60
+ |onScreenCaptureStarted|屏幕分享开启的事件回调。|
61
+ |onScreenCapturePaused|屏幕分享暂停的事件回调。|
62
+ |onScreenCaptureResumed|屏幕分享恢复的事件回调。|
63
+ |onScreenCaptureStoped|屏幕分享停止的事件回调。|
64
+ |onScreenCaptureCovered|屏幕分享的目标窗口被遮挡的事件回调(仅适用于 Windows 操作系统)。|
65
+ |onLocalRecordBegin|本地录制任务已经开始的事件回调。|
66
+ |onLocalRecording|本地录制任务正在进行中的进展事件回调。|
67
+ |onLocalRecordFragment|本地录制分片的事件回调。|
68
+ |onLocalRecordComplete|本地录制任务已经结束的事件回调。|
69
+ |onSnapshotComplete|本地截图完成的事件回调。|
70
+ |onExperimentalEvent|实验性接口的事件回调。|
71
+ |onUserEnter|有主播加入当前房间(已废弃)。|
72
+ |onUserExit|有主播离开当前房间(已废弃)。|
73
+ |onAudioEffectFinished|音效播放已结束(已废弃)。|
74
+ |onPlayBGMBegin|开始播放背景音乐(已废弃)。|
75
+ |onPlayBGMProgress|背景音乐的播放进度回调(已废弃)。|
76
+ |onPlayBGMComplete|背景音乐播放已经结束(已废弃)。|
77
+ |onSpeedTest|服务器测速的结果回调(已废弃)。|
75
78
 
76
79
  ## ITRTCVideoRenderCallback
77
- | 函数列表 | 描述 |
78
- | --- | --- |
79
- | onRenderVideoFrame | 自定义视频渲染回调。 |
80
+
81
+ |函数列表|描述|
82
+ |---------|---------|
83
+ |onRenderVideoFrame|自定义视频渲染回调。|
80
84
 
81
85
  ## ITRTCVideoFrameCallback
82
- | 函数列表 | 描述 |
83
- | --- | --- |
84
- | onGLContextCreated | SDK 内部 OpenGL 环境已经创建的通知。 |
85
- | onProcessVideoFrame | 用于对接第三方美颜组件的视频处理回调。 |
86
- | onGLContextDestroy | SDK 内部 OpenGL 环境被销毁的通知。 |
86
+
87
+ |函数列表|描述|
88
+ |---------|---------|
89
+ |onGLContextCreated|SDK 内部 OpenGL 环境已经创建的通知。|
90
+ |onProcessVideoFrame|用于对接第三方美颜组件的视频处理回调。|
91
+ |onGLContextDestroy|SDK 内部 OpenGL 环境被销毁的通知。|
87
92
 
88
93
  ## ITRTCAudioFrameCallback
89
- | 函数列表 | 描述 |
90
- | --- | --- |
91
- | onCapturedAudioFrame | 本地采集并经过音频模块前处理后的音频数据回调。 |
92
- | onLocalProcessedAudioFrame | 本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调。 |
93
- | onPlayAudioFrame | 混音前的每一路远程用户的音频数据。 |
94
- | onMixedPlayAudioFrame | 将各路待播放音频混合之后并在最终提交系统播放之前的数据回调。 |
95
- | onMixedAllAudioFrame | SDK 所有音频混合后的音频数据(包括采集到的和待播放的)。 |
94
+
95
+ |函数列表|描述|
96
+ |---------|---------|
97
+ |onCapturedAudioFrame|本地采集并经过音频模块前处理后的音频数据回调。|
98
+ |onLocalProcessedAudioFrame|本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调。|
99
+ |onPlayAudioFrame|混音前的每一路远程用户的音频数据。|
100
+ |onMixedPlayAudioFrame|将各路待播放音频混合之后并在最终提交系统播放之前的数据回调。|
101
+ |onMixedAllAudioFrame|SDK 所有音频混合后的音频数据(包括采集到的和待播放的)。|
96
102
 
97
103
  ## ITRTCLogCallback
98
- | 函数列表 | 描述 |
99
- | --- | --- |
100
- | onLog | 本地 LOG 的打印回调。 |
104
+
105
+ |函数列表|描述|
106
+ |---------|---------|
107
+ |onLog|本地 LOG 的打印回调。|
101
108
 
102
109
  ## onError
103
110
 
104
- #### 错误事件回调。
111
+ **错误事件回调。**
105
112
 
106
113
  错误事件,表示 SDK 抛出的不可恢复的错误,例如进入房间失败或设备开启失败等。
107
114
 
108
115
  参考文档:[错误码表](https://cloud.tencent.com/document/product/647/38308)
109
- | 参数 | 描述 |
110
- | --- | --- |
111
- | errCode | 错误码 |
112
- | errMsg | 错误信息 |
113
- | extInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题 |
116
+
117
+ |参数|描述|
118
+ |---------|---------|
119
+ |errCode|错误码|
120
+ |errMsg|错误信息|
121
+ |extInfo|扩展信息字段,个别错误码可能会带额外的信息帮助定位问题|
114
122
 
115
123
  ## onWarning
116
124
 
117
- #### 警告事件回调。
125
+ **警告事件回调。**
118
126
 
119
127
  警告事件,表示 SDK 抛出的提示性问题,例如视频出现卡顿或 CPU 使用率太高等。
120
128
 
121
129
  参考文档:[错误码表](https://cloud.tencent.com/document/product/647/38308)
122
- | 参数 | 描述 |
123
- | --- | --- |
124
- | extInfo | 扩展信息字段,个别警告码可能会带额外的信息帮助定位问题 |
125
- | warningCode | 警告码 |
126
- | warningMsg | 警告信息 |
130
+
131
+ |参数|描述|
132
+ |---------|---------|
133
+ |extInfo|扩展信息字段,个别警告码可能会带额外的信息帮助定位问题|
134
+ |warningCode|警告码|
135
+ |warningMsg|警告信息|
127
136
 
128
137
  ## onEnterRoom
129
138
 
130
- #### 进入房间成功与否的事件回调。
139
+ **进入房间成功与否的事件回调。**
131
140
 
132
141
  调用 TRTCCloud 中的 enterRoom 接口执行进房操作后,会收到来自 ITRTCCloudCallback 的 ` onEnterRoom(result) ` 回调:
133
142
  - 如果加入成功,回调 result 会是一个正数(result > 0),代表进入房间所消耗的时间,单位是毫秒(ms)。
@@ -135,9 +144,10 @@
135
144
  - 如果加入失败,回调 result 会是一个负数(result < 0),代表失败原因的错误码。
136
145
 
137
146
  进房失败的错误码含义请参见[错误码表](https://cloud.tencent.com/document/product/647/38308)。
138
- | 参数 | 描述 |
139
- | --- | --- |
140
- | result | result > 0 时为进房耗时(ms),result < 0 时为进房错误码。 |
147
+
148
+ |参数|描述|
149
+ |---------|---------|
150
+ |result|result > 0 时为进房耗时(ms),result < 0 时为进房错误码。|
141
151
 
142
152
  > **注意**
143
153
  >
@@ -150,86 +160,92 @@
150
160
 
151
161
  ## onExitRoom
152
162
 
153
- #### 离开房间的事件回调。
163
+ **离开房间的事件回调。**
154
164
 
155
165
  调用 TRTCCloud 中的 exitRoom 接口会执行退出房间的相关逻辑,例如释放音视频设备资源和编解码器资源等。
156
166
 
157
167
  待 SDK 占用的所有资源释放完毕后,SDK 会抛出 ` onExitRoom() ` 回调通知到您。
158
168
 
159
169
  如果您要再次调用 enterRoom 或者切换到其他的音视频 SDK,请等待 ` onExitRoom ` 回调到来后再执行相关操作。否则可能会遇到例如摄像头、麦克风设备被强占等各种异常问题。
160
- | 参数 | 描述 |
161
- | --- | --- |
162
- | reason | 离开房间原因,0:主动调用 exitRoom 退出房间;1:被服务器移出当前房间;2:当前房间整个被解散 3: 服务器状态异常。 |
170
+
171
+ |参数|描述|
172
+ |---------|---------|
173
+ |reason|离开房间原因,0:主动调用 exitRoom 退出房间;1:被服务器移出当前房间;2:当前房间整个被解散 3: 服务器状态异常。|
163
174
 
164
175
  ## onSwitchRole
165
176
 
166
- #### 切换角色的事件回调。
177
+ **切换角色的事件回调。**
167
178
 
168
179
  调用 TRTCCloud 中的 switchRole 接口会切换主播和观众的角色,该操作会伴随一个线路切换的过程,待 SDK 切换完成后,会抛出 ` onSwitchRole() ` 事件回调。
169
- | 参数 | 描述 |
170
- | --- | --- |
171
- | errCode | 错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
172
- | errMsg | 错误信息。 |
180
+
181
+ |参数|描述|
182
+ |---------|---------|
183
+ |errCode|错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
184
+ |errMsg|错误信息。|
173
185
 
174
186
  ## onSwitchRoom
175
187
 
176
- #### 切换房间的结果回调。
188
+ **切换房间的结果回调。**
177
189
 
178
190
  调用 TRTCCloud 中的 switchRoom 接口可以让用户快速地从一个房间切换到另一个房间,待 SDK 切换完成后,会抛出 ` onSwitchRoom() ` 事件回调。
179
- | 参数 | 描述 |
180
- | --- | --- |
181
- | errCode | 错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
182
- | errMsg | 错误信息。 |
191
+
192
+ |参数|描述|
193
+ |---------|---------|
194
+ |errCode|错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
195
+ |errMsg|错误信息。|
183
196
 
184
197
  ## onConnectOtherRoom
185
198
 
186
- #### 请求跨房通话的结果回调。
199
+ **请求跨房通话的结果回调。**
187
200
 
188
201
  调用 TRTCCloud 中的 connectOtherRoom 接口会将两个不同房间中的主播拉通视频通话,也就是所谓的“主播PK”功能。
189
202
 
190
203
  调用者会收到 ` onConnectOtherRoom() ` 回调来获知跨房通话是否成功。
191
- | 参数 | 描述 |
192
- | --- | --- |
193
- | errCode | 错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
194
- | errMsg | 错误信息。 |
195
- | userId | 要跨房通话的另一个房间中的主播的用户 ID。 |
204
+
205
+ |参数|描述|
206
+ |---------|---------|
207
+ |errCode|错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
208
+ |errMsg|错误信息。|
209
+ |userId|要跨房通话的另一个房间中的主播的用户 ID。|
196
210
 
197
211
  ## onDisconnectOtherRoom
198
212
 
199
- #### 结束跨房通话的结果回调。
213
+ **结束跨房通话的结果回调。**
200
214
 
201
215
  调用 TRTCCloud 中的 disConnectOtherRoom 接口会结束两个不同房间中的主播视频通话,也就是所谓的“主播PK”功能。
202
216
 
203
217
  调用者会收到 ` onDisconnectOtherRoom() ` 回调来获知结束跨房通话是否成功。
204
- | 参数 | 描述 |
205
- | --- | --- |
206
- | errCode | 错误码,ERR_NULL 代表成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
207
- | errMsg | 错误信息。 |
218
+
219
+ |参数|描述|
220
+ |---------|---------|
221
+ |errCode|错误码,ERR_NULL 代表成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
222
+ |errMsg|错误信息。|
208
223
 
209
224
  ## onUpdateOtherRoomForwardMode
210
225
 
211
- #### 更改跨房主播上行能力的结果回调。
226
+ **更改跨房主播上行能力的结果回调。**
212
227
 
213
228
  调用 TRTCCloud 中的 updateOtherRoomForwardMode 接口会限制跨房主播在本房间内的上行能力,禁止或允许跨房主播发布音频/主路视频/辅路视频,该行为会影响房间内的所有用户。
214
229
 
215
230
  调用者会收到 ` onUpdateOtherRoomForwardMode() ` 回调来获知更改跨房主播上行能力是否成功。
216
- | 参数 | 描述 |
217
- | --- | --- |
218
- | errCode | 错误码,ERR_NULL 代表成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
219
- | errMsg | 错误信息。 |
231
+
232
+ |参数|描述|
233
+ |---------|---------|
234
+ |errCode|错误码,ERR_NULL 代表成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
235
+ |errMsg|错误信息。|
220
236
 
221
237
  ## onRemoteUserEnterRoom
222
238
 
223
- #### 有用户加入当前房间。
239
+ **有用户加入当前房间。**
224
240
 
225
241
  出于性能方面的考虑,在 TRTC 两种不同的应用场景(即 ` AppScene `,在 enterRoom 时通过第二个参数指定)下,该通知的行为会有差别:
226
242
  - 直播类场景(TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom):该场景下的用户区分主播和观众两种角色,只有主播进入房间时才会触发该通知,观众进入房间时不会触发该通知。
227
243
 
228
244
  - 通话类场景(TRTCAppSceneVideoCall 和 TRTCAppSceneAudioCall):该场景下的用户没有角色的区分(可认为都是主播),任何用户进入房间都会触发该通知。
229
245
 
230
- | 参数 | 描述 |
231
- | --- | --- |
232
- | userId | 远端用户的用户标识。 |
246
+ |参数|描述|
247
+ |---------|---------|
248
+ |userId|远端用户的用户标识。|
233
249
 
234
250
  > **注意**
235
251
  >
@@ -242,43 +258,45 @@
242
258
 
243
259
  ## onRemoteUserLeaveRoom
244
260
 
245
- #### 有用户离开当前房间。
261
+ **有用户离开当前房间。**
246
262
 
247
263
  与 onRemoteUserEnterRoom 相对应,在两种不同的应用场景(即 AppScene,在 enterRoom 时通过第二个参数指定)下,该通知的行为会有差别:
248
264
  - 直播类场景(TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom):该场景下的用户区分主播和观众两种角色,只有主播离开房间时才会触发该通知,观众离开房间时不会触发该通知。
249
265
 
250
266
  - 通话类场景(TRTCAppSceneVideoCall 和 TRTCAppSceneAudioCall):该场景下的用户没有角色的区分(可认为都是主播),任何用户离开房间都会触发该通知。
251
267
 
252
- | 参数 | 描述 |
253
- | --- | --- |
254
- | reason | 离开原因,0表示用户主动退出房间,1表示用户超时退出,2表示被移出房间,3表示主播因切换到观众退出房间。 |
255
- | userId | 远端用户的用户标识。 |
268
+ |参数|描述|
269
+ |---------|---------|
270
+ |reason|离开原因,0表示用户主动退出房间,1表示用户超时退出,2表示被移出房间,3表示主播因切换到观众退出房间。|
271
+ |userId|远端用户的用户标识。|
256
272
 
257
273
  ## onUserVideoAvailable
258
274
 
259
- #### 某远端用户发布/取消了主路视频画面。
275
+ **某远端用户发布/取消了主路视频画面。**
260
276
 
261
277
  **主路画面** 一般被用于承载摄像头画面。当您收到 ` onUserVideoAvailable(userId, true) ` 通知时,表示该路画面已经有可播放的视频帧到达。
262
278
 
263
279
  此时,您需要调用 startRemoteView 接口订阅该用户的远程画面,订阅成功后,您会继续收到该用户的首帧画面渲染回调 ` onFirstVideoFrame(userId) `。
264
280
 
265
281
  当您收到 ` onUserVideoAvailable(userId, false) ` 通知时,表示该路远程画面已经被关闭,关闭的原因可能是该用户调用了 muteLocalVideo 或 stopLocalPreview。
266
- | 参数 | 描述 |
267
- | --- | --- |
268
- | available | 该用户是否发布(或取消发布)了主路视频画面,true:发布;false:取消发布。 |
269
- | userId | 远端用户的用户标识。 |
282
+
283
+ |参数|描述|
284
+ |---------|---------|
285
+ |available|该用户是否发布(或取消发布)了主路视频画面,true:发布;false:取消发布。|
286
+ |userId|远端用户的用户标识。|
270
287
 
271
288
  ## onUserSubStreamAvailable
272
289
 
273
- #### 某远端用户发布/取消了辅路视频画面。
290
+ **某远端用户发布/取消了辅路视频画面。**
274
291
 
275
292
  “辅路画面”一般被用于承载屏幕分享的画面。当您收到 ` onUserSubStreamAvailable(userId, true) ` 通知时,表示该路画面已经有可播放的视频帧到达。
276
293
 
277
294
  此时,您需要调用 startRemoteView 接口订阅该用户的远程画面,订阅成功后,您会继续收到该用户的首帧画面渲染回调 ` onFirstVideoFrame(userId) `。
278
- | 参数 | 描述 |
279
- | --- | --- |
280
- | available | 该用户是否发布(或取消发布)了辅路视频画面,true: 发布;false:取消发布。 |
281
- | userId | 远端用户的用户标识。 |
295
+
296
+ |参数|描述|
297
+ |---------|---------|
298
+ |available|该用户是否发布(或取消发布)了辅路视频画面,true: 发布;false:取消发布。|
299
+ |userId|远端用户的用户标识。|
282
300
 
283
301
  > **注意**
284
302
  >
@@ -288,17 +306,17 @@
288
306
 
289
307
  ## onUserAudioAvailable
290
308
 
291
- #### 某远端用户发布/取消了自己的音频。
309
+ **某远端用户发布/取消了自己的音频。**
292
310
 
293
311
  当您收到 ` onUserAudioAvailable(userId, true) ` 通知时,表示该用户发布了自己的声音,此时 SDK 的表现为:
294
312
  - 在自动订阅模式下,您无需做任何操作,SDK 会自动播放该用户的声音。
295
313
 
296
314
  - 在手动订阅模式下,您可以通过 muteRemoteAudio(userid, false) 来播放该用户的声音。
297
315
 
298
- | 参数 | 描述 |
299
- | --- | --- |
300
- | available | 该用户是否发布(或取消发布)了自己的音频,true: 发布;false:取消发布。 |
301
- | userId | 远端用户的用户标识。 |
316
+ |参数|描述|
317
+ |---------|---------|
318
+ |available|该用户是否发布(或取消发布)了自己的音频,true: 发布;false:取消发布。|
319
+ |userId|远端用户的用户标识。|
302
320
 
303
321
  > **注意**
304
322
  >
@@ -308,19 +326,19 @@
308
326
 
309
327
  ## onFirstVideoFrame
310
328
 
311
- #### SDK 开始渲染自己本地或远端用户的首帧画面。
329
+ **SDK 开始渲染自己本地或远端用户的首帧画面。**
312
330
 
313
331
  SDK 会在渲染自己本地或远端用户的首帧画面时抛出该事件,您可以通过回调事件中的 userId 参数来判断事件来自于“本地”还是来自于“远端”。
314
332
  - 如果 userId 为空值,代表 SDK 已经开始渲染自己本地的视频画面,不过前提是您已经调用了 startLocalPreview 或 startScreenCapture。
315
333
 
316
334
  - 如果 userId 不为空,代表 SDK 已经开始渲染远端用户的视频画面,不过前提是您已经调用了 startRemoteView 订阅了该用户的视频画面。
317
335
 
318
- | 参数 | 描述 |
319
- | --- | --- |
320
- | height | 画面的高度。 |
321
- | streamType | 视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。 |
322
- | userId | 本地或远端的用户标识,如果 userId 为空值代表自己本地的首帧画面已到来,userId 不为空则代表远端用户的首帧画面已到来。 |
323
- | width | 画面的宽度。 |
336
+ |参数|描述|
337
+ |---------|---------|
338
+ |height|画面的高度。|
339
+ |streamType|视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。|
340
+ |userId|本地或远端的用户标识,如果 userId 为空值代表自己本地的首帧画面已到来,userId 不为空则代表远端用户的首帧画面已到来。|
341
+ |width|画面的宽度。|
324
342
 
325
343
  > **注意**
326
344
  >
@@ -333,76 +351,82 @@ SDK 会在渲染自己本地或远端用户的首帧画面时抛出该事件,
333
351
 
334
352
  ## onFirstAudioFrame
335
353
 
336
- #### SDK 开始播放远端用户的首帧音频。
354
+ **SDK 开始播放远端用户的首帧音频。**
337
355
 
338
356
  SDK 会在播放远端用户的首帧音频时抛出该事件,本地音频的首帧事件暂不抛出。
339
- | 参数 | 描述 |
340
- | --- | --- |
341
- | userId | 远端用户的用户标识。 |
357
+
358
+ |参数|描述|
359
+ |---------|---------|
360
+ |userId|远端用户的用户标识。|
342
361
 
343
362
  ## onSendFirstLocalVideoFrame
344
363
 
345
- #### 自己本地的首个视频帧已被发布出去。
364
+ **自己本地的首个视频帧已被发布出去。**
346
365
 
347
366
  当您成功进入房间并通过 startLocalPreview 或 startScreenCapture 开启本地视频采集之后(开启采集和进入房间的先后顺序无影响),SDK 就会开始进行视频编码,并通过自身的网络模块向云端发布自己本地的视频数据。当 SDK 成功地向云端送出自己的第一帧视频数据帧以后,就会抛出 ` onSendFirstLocalVideoFrame ` 事件回调。
348
- | 参数 | 描述 |
349
- | --- | --- |
350
- | streamType | 视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。 |
367
+
368
+ |参数|描述|
369
+ |---------|---------|
370
+ |streamType|视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。|
351
371
 
352
372
  ## onSendFirstLocalAudioFrame
353
373
 
354
- #### 自己本地的首个音频帧已被发布出去。
374
+ **自己本地的首个音频帧已被发布出去。**
355
375
 
356
376
  当您成功进入房间并通过 startLocalAudio 开启本地音频采集之后(开启采集和进入房间的先后顺序无影响),SDK 就会开始进行音频编码,并通过自身的网络模块向云端发布自己本地的音频数据。当 SDK 成功地向云端送出自己的第一帧音频数据帧以后,就会抛出 ` onSendFirstLocalAudioFrame ` 事件回调。
357
377
 
358
378
  ## onRemoteVideoStatusUpdated
359
379
 
360
- #### 远端视频状态变化的事件回调。
380
+ **远端视频状态变化的事件回调。**
361
381
 
362
382
  您可以通过此事件回调获取远端每一路画面的播放状态(包括 Playing、Loading 和 Stopped 三种状态),从而进行相应的 UI 展示。
363
- | 参数 | 描述 |
364
- | --- | --- |
365
- | extrainfo | 额外信息。 |
366
- | reason | 视频状态改变的原因。 |
367
- | status | 视频状态:包括 Playing、Loading 和 Stopped 三种状态。 |
368
- | streamType | 视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。 |
369
- | userId | 用户标识。 |
383
+
384
+ |参数|描述|
385
+ |---------|---------|
386
+ |extrainfo|额外信息。|
387
+ |reason|视频状态改变的原因。|
388
+ |status|视频状态:包括 Playing、Loading 和 Stopped 三种状态。|
389
+ |streamType|视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。|
390
+ |userId|用户标识。|
370
391
 
371
392
  ## onRemoteAudioStatusUpdated
372
393
 
373
- #### 远端音频状态变化的事件回调。
394
+ **远端音频状态变化的事件回调。**
374
395
 
375
396
  您可以通过此事件回调获取远端每一路音频的播放状态(包括 Playing、Loading 和 Stopped 三种状态),从而进行相应的 UI 展示。
376
- | 参数 | 描述 |
377
- | --- | --- |
378
- | extrainfo | 额外信息。 |
379
- | reason | 音频状态改变的原因。 |
380
- | status | 音频状态:包括 Playing、Loading 和 Stopped 三种状态。 |
381
- | userId | 用户标识。 |
397
+
398
+ |参数|描述|
399
+ |---------|---------|
400
+ |extrainfo|额外信息。|
401
+ |reason|音频状态改变的原因。|
402
+ |status|音频状态:包括 Playing、Loading 和 Stopped 三种状态。|
403
+ |userId|用户标识。|
382
404
 
383
405
  ## onUserVideoSizeChanged
384
406
 
385
- #### 用户视频大小发生改变回调。
407
+ **用户视频大小发生改变回调。**
386
408
 
387
409
  当您收到 ` onUserVideoSizeChanged(userId, streamType, newWidth, newHeight) ` 通知时,表示该路画面大小发生了调整,调整的原因可能是该用户调用了 setVideoEncoderParam 或者 setSubStreamEncoderParam 重新设置了画面尺寸。
388
- | 参数 | 描述 |
389
- | --- | --- |
390
- | newHeight | 视频流的高度(像素)。 |
391
- | newWidth | 视频流的宽度(像素)。 |
392
- | streamType | 视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。 |
393
- | userId | 用户标识。 |
410
+
411
+ |参数|描述|
412
+ |---------|---------|
413
+ |newHeight|视频流的高度(像素)。|
414
+ |newWidth|视频流的宽度(像素)。|
415
+ |streamType|视频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。|
416
+ |userId|用户标识。|
394
417
 
395
418
  ## onNetworkQuality
396
419
 
397
- #### 网络质量的实时统计回调。
420
+ **网络质量的实时统计回调。**
398
421
 
399
422
  该统计回调每间隔2秒抛出一次,用于通知 SDK 感知到的当前网络的上行和下行质量。
400
423
 
401
424
  SDK 会使用一组内嵌的自研算法对当前网络的延迟高低、带宽大小以及稳定情况进行评估,并计算出一个评估结果:如果评估结果为 1(Excellent) 代表当前的网络情况非常好,如果评估结果为 6(Down)代表当前网络无法支撑 TRTC 的正常通话。
402
- | 参数 | 描述 |
403
- | --- | --- |
404
- | localQuality | 上行网络质量。 |
405
- | remoteQuality | 下行网络质量,代表数据流历经“远端->云端->本端”这样一条完整的传输链路后,最终在本端统计到的数据质量。因此,这里的下行网络质量代表的是远端上行链路与本端下行链路共同影响的结果。 |
425
+
426
+ |参数|描述|
427
+ |---------|---------|
428
+ |localQuality|上行网络质量。|
429
+ |remoteQuality|下行网络质量,代表数据流历经“远端->云端->本端”这样一条完整的传输链路后,最终在本端统计到的数据质量。因此,这里的下行网络质量代表的是远端上行链路与本端下行链路共同影响的结果。|
406
430
 
407
431
  > **注意**
408
432
  >
@@ -412,7 +436,7 @@ SDK 会使用一组内嵌的自研算法对当前网络的延迟高低、带宽
412
436
 
413
437
  ## onStatistics
414
438
 
415
- #### 音视频技术指标的实时统计回调。
439
+ **音视频技术指标的实时统计回调。**
416
440
 
417
441
  该统计回调每间隔2秒抛出一次,用于通知 SDK 内部音频、视频以及网络相关的专业技术指标,这些信息在 TRTCStatistics 均有罗列:
418
442
  - 视频统计信息:视频的分辨率(resolution)、帧率(FPS)和比特率(bitrate)等信息。
@@ -421,9 +445,9 @@ SDK 会使用一组内嵌的自研算法对当前网络的延迟高低、带宽
421
445
 
422
446
  - 网络统计信息:SDK 和云端一次往返(SDK > Cloud > SDK)的网络耗时(rtt)、丢包率(loss)、上行流量(sentBytes)和下行流量(receivedBytes)等信息。
423
447
 
424
- | 参数 | 描述 |
425
- | --- | --- |
426
- | statistics | 统计数据,包括自己本地的统计信息和远端用户的统计信息,详情请参考 TRTCStatistics。 |
448
+ |参数|描述|
449
+ |---------|---------|
450
+ |statistics|统计数据,包括自己本地的统计信息和远端用户的统计信息,详情请参考 TRTCStatistics。|
427
451
 
428
452
  > **注意**
429
453
  >
@@ -433,16 +457,17 @@ SDK 会使用一组内嵌的自研算法对当前网络的延迟高低、带宽
433
457
 
434
458
  ## onSpeedTestResult
435
459
 
436
- #### 网速测试的结果回调。
460
+ **网速测试的结果回调。**
437
461
 
438
462
  该统计回调由 startSpeedTest 触发。
439
- | 参数 | 描述 |
440
- | --- | --- |
441
- | result | 网速测试结果,包括丢包、往返延迟、上下行的带宽速率,详情请参见 TRTCSpeedTestResult。 |
463
+
464
+ |参数|描述|
465
+ |---------|---------|
466
+ |result|网速测试结果,包括丢包、往返延迟、上下行的带宽速率,详情请参见 TRTCSpeedTestResult。|
442
467
 
443
468
  ## onConnectionLost
444
469
 
445
- #### SDK 与云端的连接已经断开。
470
+ **SDK 与云端的连接已经断开。**
446
471
 
447
472
  SDK 会在跟云端的连接断开时抛出此事件回调,导致断开的原因大多是网络不可用或者网络切换所致,例如用户在通话中走进电梯时就可能会遇到此事件。
448
473
 
@@ -452,19 +477,19 @@ SDK 会在跟云端的连接断开时抛出此事件回调,导致断开的原
452
477
 
453
478
  ## onTryToReconnect
454
479
 
455
- #### SDK 正在尝试重新连接到云端。
480
+ **SDK 正在尝试重新连接到云端。**
456
481
 
457
482
  SDK 会在跟云端的连接断开时抛出 onConnectionLost,之后会努力跟云端重新建立连接并抛出本事件,连接恢复后会抛出 onConnectionRecovery。
458
483
 
459
484
  ## onConnectionRecovery
460
485
 
461
- #### SDK 与云端的连接已经恢复。
486
+ **SDK 与云端的连接已经恢复。**
462
487
 
463
488
  SDK 会在跟云端的连接断开时抛出 onConnectionLost,之后会努力跟云端重新建立连接并抛出 onTryToReconnect,连接恢复后会抛出本事件回调。
464
489
 
465
490
  ## onCameraDidReady
466
491
 
467
- #### 摄像头准备就绪。
492
+ **摄像头准备就绪。**
468
493
 
469
494
  当您调用 startLocalPreview 之后,SDK 会尝试启动摄像头,如果摄像头能够启动成功就会抛出本事件。
470
495
 
@@ -474,7 +499,7 @@ SDK 会在跟云端的连接断开时抛出 onConnectionLost,之后会努力
474
499
 
475
500
  ## onMicDidReady
476
501
 
477
- #### 麦克风准备就绪。
502
+ **麦克风准备就绪。**
478
503
 
479
504
  当您调用 startLocalAudio 之后,SDK 会尝试启动麦克风,如果麦克风能够启动成功就会抛出本事件。
480
505
 
@@ -484,7 +509,7 @@ SDK 会在跟云端的连接断开时抛出 onConnectionLost,之后会努力
484
509
 
485
510
  ## onAudioRouteChanged
486
511
 
487
- #### 当前音频路由发生变化(仅适用于移动设备)。
512
+ **当前音频路由发生变化(仅适用于移动设备)。**
488
513
 
489
514
  所谓“音频路由”,是指声音是从手机的扬声器还是从听筒中播放出来,音频路由变化也就是声音的播放位置发生了变化。
490
515
  - 当音频路由为听筒时,声音比较小,只有将耳朵凑近才能听清楚,隐私性较好,适合用于接听电话。
@@ -497,24 +522,25 @@ SDK 会在跟云端的连接断开时抛出 onConnectionLost,之后会努力
497
522
 
498
523
  - 当音频路由为USB专业声卡设备。
499
524
 
500
- | 参数 | 描述 |
501
- | --- | --- |
502
- | fromRoute | 变更前的音频路由。 |
503
- | route | 音频路由,即声音由哪里输出(扬声器、听筒)。 |
525
+ |参数|描述|
526
+ |---------|---------|
527
+ |fromRoute|变更前的音频路由。|
528
+ |route|音频路由,即声音由哪里输出(扬声器、听筒)。|
504
529
 
505
530
  ## onUserVoiceVolume
506
531
 
507
- #### 音量大小的反馈回调。
532
+ **音量大小的反馈回调。**
508
533
 
509
534
  SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该事件回调,您可以根据音量大小在 UI 上做出相应的提示,例如` 波形图 `或` 音量槽 `。
510
535
 
511
536
  要完成这个功能, 您需要先调用 enableAudioVolumeEvaluation 开启这个能力并设定事件抛出的时间间隔。
512
537
 
513
538
  需要补充说明的是,无论当前房间中是否有人说话,SDK 都会按照您设定的时间间隔定时抛出此事件回调。
514
- | 参数 | 描述 |
515
- | --- | --- |
516
- | totalVolume | 所有远端用户的总音量大小,取值范围 [0, 100]。 |
517
- | userVolumes | 是一个数组,用于承载所有正在说话的用户的音量大小,取值范围 [0, 100]。 |
539
+
540
+ |参数|描述|
541
+ |---------|---------|
542
+ |totalVolume|所有远端用户的总音量大小,取值范围 [0, 100]。|
543
+ |userVolumes|是一个数组,用于承载所有正在说话的用户的音量大小,取值范围 [0, 100]。|
518
544
 
519
545
  > **注意**
520
546
  >
@@ -524,18 +550,19 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
524
550
 
525
551
  ## onDeviceChange
526
552
 
527
- #### 本地设备的通断状态发生变化(仅适用于桌面系统)。
553
+ **本地设备的通断状态发生变化(仅适用于桌面系统)。**
528
554
 
529
555
  当本地设备(包括摄像头、麦克风以及扬声器)被插入或者拔出时,SDK 便会抛出此事件回调。
530
- | 参数 | 描述 |
531
- | --- | --- |
532
- | deviceId | 设备 ID。 |
533
- | deviceType | 设备类型。0:麦克风设备;1:扬声器设备;2:摄像头设备。 |
534
- | state | 通断状态,0:设备已添加;1:设备已被移除;2:设备已启用。 |
556
+
557
+ |参数|描述|
558
+ |---------|---------|
559
+ |deviceId|设备 ID。|
560
+ |deviceType|设备类型。0:麦克风设备;1:扬声器设备;2:摄像头设备。|
561
+ |state|通断状态,0:设备已添加;1:设备已被移除;2:设备已启用。|
535
562
 
536
563
  ## onAudioDeviceCaptureVolumeChanged
537
564
 
538
- #### 当前麦克风的系统采集音量发生变化。
565
+ **当前麦克风的系统采集音量发生变化。**
539
566
 
540
567
  在 Mac 或 Windows 这样的桌面操作系统上,用户可以在设置中心找到声音相关的设置面板,并设置麦克风的采集音量大小。
541
568
 
@@ -544,10 +571,11 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
544
571
  在有些型号的键盘以及笔记本电脑上,用户还可以通过按下` 禁用麦克风 `按钮(图标是一个` 话筒 `叠加了一道代表禁用的斜线)来将麦克风静音。
545
572
 
546
573
  当用户通过系统设置界面或者通过键盘上的快捷键设定操作系统的麦克风采集音量时,SDK 便会抛出此事件。
547
- | 参数 | 描述 |
548
- | --- | --- |
549
- | muted | 麦克风是否被用户禁用了:true 被禁用,false 被启用。 |
550
- | volume | 系统采集音量,取值范围 0 - 100,用户可以在系统的声音设置面板上进行拖拽调整。 |
574
+
575
+ |参数|描述|
576
+ |---------|---------|
577
+ |muted|麦克风是否被用户禁用了:true 被禁用,false 被启用。|
578
+ |volume|系统采集音量,取值范围 0 - 100,用户可以在系统的声音设置面板上进行拖拽调整。|
551
579
 
552
580
  > **注意**
553
581
  >
@@ -557,17 +585,18 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
557
585
 
558
586
  ## onAudioDevicePlayoutVolumeChanged
559
587
 
560
- #### 当前系统的播放音量发生变化。
588
+ **当前系统的播放音量发生变化。**
561
589
 
562
590
  在 Mac 或 Windows 这样的桌面操作系统上,用户可以在设置中心找到声音相关的设置面板,并设置系统的播放音量大小。
563
591
 
564
592
  在有些型号的键盘以及笔记本电脑上,用户还可以通过按下“静音”按钮(图标是一个喇叭上叠加了一道代表禁用的斜线)来将系统静音。
565
593
 
566
594
  当用户通过系统设置界面或者通过键盘上的快捷键设定操作系统的播放音量时,SDK 便会抛出此事件。
567
- | 参数 | 描述 |
568
- | --- | --- |
569
- | muted | 系统是否被用户静音了:true 被静音,false 已恢复。 |
570
- | volume | 系统播放音量,取值范围 [0, 100],用户可以在系统的声音设置面板上进行拖拽调整。 |
595
+
596
+ |参数|描述|
597
+ |---------|---------|
598
+ |muted|系统是否被用户静音了:true 被静音,false 已恢复。|
599
+ |volume|系统播放音量,取值范围 [0, 100],用户可以在系统的声音设置面板上进行拖拽调整。|
571
600
 
572
601
  > **注意**
573
602
  >
@@ -577,7 +606,7 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
577
606
 
578
607
  ## onSystemAudioLoopbackError
579
608
 
580
- #### 系统声音采集是否被成功开启的事件回调(仅适用于桌面系统)。
609
+ **系统声音采集是否被成功开启的事件回调(仅适用于桌面系统)。**
581
610
 
582
611
  在 Mac 系统上,您可以通过调用 startSystemAudioLoopback 为当前系统安装一个音频驱动,并让 SDK 通过该音频驱动捕获当前 Mac 系统播放出的声音。
583
612
 
@@ -586,57 +615,62 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
586
615
  当用于播片教学或音乐直播中,例如老师端可以使用此功能,让 SDK 能够采集老师所播放的电影中的声音,使同房间的学生端也能听到电影中的声音。
587
616
 
588
617
  SDK 会将系统声音采集是否被成功开启的结果,通过本事件回调抛出,需要您关注参数中的错误码。
589
- | 参数 | 描述 |
590
- | --- | --- |
591
- | err | ERR_NULL 表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
618
+
619
+ |参数|描述|
620
+ |---------|---------|
621
+ |err|ERR_NULL 表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
592
622
 
593
623
  ## onTestMicVolume
594
624
 
595
- #### 测试麦克风时的音量回调。
625
+ **测试麦克风时的音量回调。**
596
626
 
597
627
  当您调用 startMicDeviceTest 测试麦克风是否正常工作时,SDK 会不断地抛出此回调,参数中的 volume 代表当前麦克风采集到的音量大小。
598
628
 
599
629
  如果在测试期间 volume 出现了大小波动的情况,说明麦克风状态健康;如果 volume 的数值始终是 0,说明麦克风的状态异常,需要提示用户进行更换。
600
- | 参数 | 描述 |
601
- | --- | --- |
602
- | volume | 麦克风采集到的音量值,取值范围 [0, 100]。 |
630
+
631
+ |参数|描述|
632
+ |---------|---------|
633
+ |volume|麦克风采集到的音量值,取值范围 [0, 100]。|
603
634
 
604
635
  ## onTestSpeakerVolume
605
636
 
606
- #### 测试扬声器时的音量回调。
637
+ **测试扬声器时的音量回调。**
607
638
 
608
639
  当您调用 startSpeakerDeviceTest 测试扬声器是否正常工作时,SDK 会不断地抛出此回调。
609
640
 
610
641
  参数中的 volume 代表的是 SDK 提交给系统扬声器去播放的声音的音量值大小,如果该数值持续变化,但用户反馈听不到声音,则说明扬声器状态异常。
611
- | 参数 | 描述 |
612
- | --- | --- |
613
- | volume | SDK 提交给扬声器去播放的声音的音量,取值范围 [0, 100]。 |
642
+
643
+ |参数|描述|
644
+ |---------|---------|
645
+ |volume|SDK 提交给扬声器去播放的声音的音量,取值范围 [0, 100]。|
614
646
 
615
647
  ## onRecvCustomCmdMsg
616
648
 
617
- #### 收到自定义消息的事件回调。
649
+ **收到自定义消息的事件回调。**
618
650
 
619
651
  当房间中的某个用户使用 sendCustomCmdMsg 发送自定义 UDP 消息时,房间中的其他用户可以通过 ` onRecvCustomCmdMsg ` 事件回调接收到该条消息。
620
- | 参数 | 描述 |
621
- | --- | --- |
622
- | cmdID | 命令 ID。 |
623
- | message | 消息数据。 |
624
- | seq | 消息序号。 |
625
- | userId | 用户标识。 |
652
+
653
+ |参数|描述|
654
+ |---------|---------|
655
+ |cmdID|命令 ID。|
656
+ |message|消息数据。|
657
+ |seq|消息序号。|
658
+ |userId|用户标识。|
626
659
 
627
660
  ## onMissCustomCmdMsg
628
661
 
629
- #### 自定义消息丢失的事件回调。
662
+ **自定义消息丢失的事件回调。**
630
663
 
631
664
  当您使用 sendCustomCmdMsg 发送自定义 UDP 消息时,即使设置了可靠传输(reliable),也无法确 100% 不丢失,只是丢消息概率极低,能满足常规可靠性要求。
632
665
 
633
666
  在发送端设置了可靠运输(reliable)后,SDK 都会通过此回调通知过去时间段内(通常为5s)传输途中丢失的自定义消息数量统计信息。
634
- | 参数 | 描述 |
635
- | --- | --- |
636
- | cmdID | 命令 ID。 |
637
- | errCode | 错误码。 |
638
- | missed | 丢失的消息数量。 |
639
- | userId | 用户标识。 |
667
+
668
+ |参数|描述|
669
+ |---------|---------|
670
+ |cmdID|命令 ID。|
671
+ |errCode|错误码。|
672
+ |missed|丢失的消息数量。|
673
+ |userId|用户标识。|
640
674
 
641
675
  > **注意**
642
676
  >
@@ -646,47 +680,51 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
646
680
 
647
681
  ## onRecvSEIMsg
648
682
 
649
- #### 收到 SEI 消息的回调。
683
+ **收到 SEI 消息的回调。**
650
684
 
651
685
  当房间中的某个用户使用 sendSEIMsg 借助视频数据帧发送 SEI 消息时,房间中的其他用户可以通过 ` onRecvSEIMsg ` 事件回调接收到该条消息。
652
- | 参数 | 描述 |
653
- | --- | --- |
654
- | message | 数据。 |
655
- | userId | 用户标识。 |
686
+
687
+ |参数|描述|
688
+ |---------|---------|
689
+ |message|数据。|
690
+ |userId|用户标识。|
656
691
 
657
692
  ## onStartPublishing
658
693
 
659
- #### 开始向腾讯云直播 CDN 上发布音视频流的事件回调。
694
+ **开始向腾讯云直播 CDN 上发布音视频流的事件回调。**
660
695
 
661
696
  当您调用 startPublishing 开始向腾讯云直播 CDN 上发布音视频流时,SDK 会立刻将这一指令同步给云端服务器。
662
697
 
663
698
  随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
664
- | 参数 | 描述 |
665
- | --- | --- |
666
- | err | 0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
667
- | errMsg | 具体错误原因。 |
699
+
700
+ |参数|描述|
701
+ |---------|---------|
702
+ |err|0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
703
+ |errMsg|具体错误原因。|
668
704
 
669
705
  ## onStopPublishing
670
706
 
671
- #### 停止向腾讯云直播 CDN 上发布音视频流的事件回调。
707
+ **停止向腾讯云直播 CDN 上发布音视频流的事件回调。**
672
708
 
673
709
  当您调用 stopPublishing 停止向腾讯云直播 CDN 上发布音视频流时,SDK 会立刻将这一指令同步给云端服务器。
674
710
 
675
711
  随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
676
- | 参数 | 描述 |
677
- | --- | --- |
678
- | err | 0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
679
- | errMsg | 具体错误原因。 |
712
+
713
+ |参数|描述|
714
+ |---------|---------|
715
+ |err|0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
716
+ |errMsg|具体错误原因。|
680
717
 
681
718
  ## onStartPublishCDNStream
682
719
 
683
- #### 开始向非腾讯云 CDN 上发布音视频流的事件回调。
720
+ **开始向非腾讯云 CDN 上发布音视频流的事件回调。**
684
721
 
685
722
  当您调用 startPublishCDNStream 开始向非腾讯云直播 CDN 上发布音视频流时,SDK 会立刻将这一指令同步给云端服务器。随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
686
- | 参数 | 描述 |
687
- | --- | --- |
688
- | err | 0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
689
- | errMsg | 具体错误原因。 |
723
+
724
+ |参数|描述|
725
+ |---------|---------|
726
+ |err|0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
727
+ |errMsg|具体错误原因。|
690
728
 
691
729
  > **注意**
692
730
  >
@@ -696,63 +734,65 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
696
734
 
697
735
  ## onStopPublishCDNStream
698
736
 
699
- #### 停止向非腾讯云 CDN 上发布音视频流的事件回调。
737
+ **停止向非腾讯云 CDN 上发布音视频流的事件回调。**
700
738
 
701
739
  当您调用 stopPublishCDNStream 开始向非腾讯云直播 CDN 上发布音视频流时,SDK 会立刻将这一指令同步给云端服务器。随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
702
- | 参数 | 描述 |
703
- | --- | --- |
704
- | err | 0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
705
- | errMsg | 具体错误原因。 |
740
+
741
+ |参数|描述|
742
+ |---------|---------|
743
+ |err|0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
744
+ |errMsg|具体错误原因。|
706
745
 
707
746
  ## onSetMixTranscodingConfig
708
747
 
709
- #### 设置云端混流的排版布局和转码参数的事件回调。
748
+ **设置云端混流的排版布局和转码参数的事件回调。**
710
749
 
711
750
  当您调用 setMixTranscodingConfig 调整云端混流的排版布局和转码参数时,SDK 会立刻将这一调整指令同步给云端服务器。随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
712
- | 参数 | 描述 |
713
- | --- | --- |
714
- | err | 错误码:0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
715
- | errMsg | 具体的错误原因。 |
751
+
752
+ |参数|描述|
753
+ |---------|---------|
754
+ |err|错误码:0表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。|
755
+ |errMsg|具体的错误原因。|
716
756
 
717
757
  ## onStartPublishMediaStream
718
758
 
719
- #### 开始发布媒体流的事件回调。
759
+ **开始发布媒体流的事件回调。**
720
760
 
721
761
  当您调用 startPublishMediaStream 开始向 TRTC 后台服务发布媒体流时,SDK 会立刻将这一指令同步给云端服务器,随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
722
762
  | 参数 | 描述 |
723
763
  | --- | --- |
724
- | code | 回调结果,0 表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
725
- | extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用"error_code"做为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>- 2000: 参数错误,建议检查请求参数<br>- 2001: 未开通直播服务,建议去直播控制台开通直播服务<br>- 2021: 未开通转推第三方服务,建议联系产品开通转推第三方服务<br>- 3000: 服务器内部错误,建议重试<br>- 4006: 同一个任务并发冲突,上一个 startPublishMediaStream 任务服务器还在处理中,建议延迟重试<br>- 4007: 同一个任务已经通过 startPublishMediaStream 启动成功,建议使用返回的 taskId 调用 updatePublishMediaStream 接口更新任务<br>- 5001: 资源受限,建议延迟重试 |
764
+ | code | 回调结果,0 表示成功,其余值表示失败,详见<a href="https://cloud.tencent.com/document/product/647/32257">错误码</a>。 |
765
+ | extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用“error_code” 作为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>- 2000: 参数错误,建议检查请求参数<br>- 2001: 未开通直播服务,建议去直播控制台开通直播服务<br>- 2021: 未开通转推第三方服务,建议联系产品开通转推第三方服务<br>- 3000: 服务器内部错误,建议重试<br>- 4006: 同一个任务并发冲突,上一个 startPublishMediaStream 任务服务器还在处理中,建议延迟重试<br>- 4007: 同一个任务已经通过 startPublishMediaStream 启动成功,建议使用返回的 taskId 调用 updatePublishMediaStream 接口更新任务<br>- 5001: 资源受限,建议延迟重试 |
726
766
  | message | 具体回调信息。 |
727
767
  | taskId | 当请求成功时,TRTC 后台会在回调中提供给您这项任务的 taskId,后续您可以通过该 taskId 结合 updatePublishMediaStream 和 stopPublishMediaStream 进行更新和停止。 |
728
768
 
729
769
  ## onUpdatePublishMediaStream
730
770
 
731
- #### 更新媒体流的事件回调。
771
+ **更新媒体流的事件回调。**
732
772
 
733
773
  当您调用媒体流发布接口 (updatePublishMediaStream) 开始向 TRTC 后台服务更新媒体流时,SDK 会立刻将这一指令同步给云端服务器,随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
734
774
  | 参数 | 描述 |
735
775
  | --- | --- |
736
- | code | 回调结果,0 表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
737
- | extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用"error_code"做为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>- 2000: 参数错误,建议检查请求参数<br>- 2001: 未开通直播服务,建议去直播控制台开通直播服务<br>- 2002: 找不到任务,建议调用 startPublishMediaStream 接口重新启动任务<br>- 2018: 并发请求乱序,建议使用最新混流参数重试<br>- 2021: 未开通转推第三方服务,建议联系产品开通转推第三方服务<br>- 3000: 服务器内部错误,建议重试<br>- 4003: 任务正在退出中,建议先调用 stopPublishMediaStream 接口停止任务,再调用 startPublishMediaStream 接口启动任务 |
776
+ | code | 回调结果,0 表示成功,其余值表示失败,详见<a href="https://cloud.tencent.com/document/product/647/32257">错误码</a>。 |
777
+ | extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用“error_code” 作为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>- 2000: 参数错误,建议检查请求参数<br>- 2001: 未开通直播服务,建议去直播控制台开通直播服务<br>- 2002: 找不到任务,建议调用 startPublishMediaStream 接口重新启动任务<br>- 2018: 并发请求乱序,建议使用最新混流参数重试<br>- 2021: 未开通转推第三方服务,建议联系产品开通转推第三方服务<br>- 3000: 服务器内部错误,建议重试<br>- 4003: 任务正在退出中,建议先调用 stopPublishMediaStream 接口停止任务,再调用 startPublishMediaStream 接口启动任务 |
738
778
  | message | 具体回调信息。 |
739
779
  | taskId | 您调用媒体流发布接口 (updatePublishMediaStream) 时传入的 taskId,会通过此回调再带回给您,用于标识该回调属于哪一次更新请求。 |
740
780
 
741
781
  ## onStopPublishMediaStream
742
782
 
743
- #### 停止媒体流的事件回调。
783
+ **停止媒体流的事件回调。**
744
784
 
745
785
  当您调用停止发布媒体流 (stopPublishMediaStream) 开始向 TRTC 后台服务停止媒体流时,SDK 会立刻将这一指令同步给云端服务器,随后 SDK 会收到来自云端服务器的处理结果,并将指令的执行结果通过本事件回调通知给您。
746
786
  | 参数 | 描述 |
747
787
  | --- | --- |
748
- | code | 回调结果,0 表示成功,其余值表示失败,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
749
- | extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用"error_code"做为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>- 2000: 参数错误,建议检查请求参数<br>- 2002: 找不到任务,无需处理<br>- 3000: 服务器内部错误,建议重试<br>- 4003: 任务正在退出中,无需处理 |
788
+ | code | 回调结果,0 表示成功,其余值表示失败,详见<a href="https://cloud.tencent.com/document/product/647/32257">错误码</a>。 |
789
+ | extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。<br>当 code 返回值为 ERR_SERVER_PROCESS_FAILED 时,意味着服务器无法处理您的请求,此时可使用“error_code” 作为 key 获取到服务器返回的错误码,具体的错误码以及建议处理措施说明如下:<br>- 2000: 参数错误,建议检查请求参数<br>- 2002: 找不到任务,无需处理<br>- 3000: 服务器内部错误,建议重试<br>- 4003: 任务正在退出中,无需处理 |
750
790
  | message | 具体回调信息。 |
751
791
  | taskId | 您调用停止发布媒体流 (stopPublishMediaStream) 时传入的 taskId,会通过此回调再带回给您,用于标识该回调属于哪一次停止请求。 |
752
792
 
753
793
  ## onCdnStreamStateChanged
754
794
 
755
- #### RTMP/RTMPS 推流状态发生改变回调。
795
+ **RTMP/RTMPS 推流状态发生改变回调。**
756
796
 
757
797
  当您调用 startPublishMediaStream 开始向 TRTC 后台服务发布媒体流时,SDK 会立刻将这一指令同步给云端服务。
758
798
 
@@ -760,53 +800,54 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
760
800
  | 参数 | 描述 |
761
801
  | --- | --- |
762
802
  | cdnUrl | 您调用 startPublishMediaStream 时通过目标推流配置 (TRTCPublishTarget) 传入的 url,在推流状态变更时,会通过此回调同步给您。 |
763
- | code | 推流结果,0 表示成功,其余值表示出错,详见[错误码](https://cloud.tencent.com/document/product/647/32257)。 |
803
+ | code | 推流结果,0 表示成功,其余值表示出错,详见<a href="https://cloud.tencent.com/document/product/647/32257">错误码</a>。 |
764
804
  | extraInfo | 扩展信息字段,个别错误码可能会带额外的信息帮助定位问题。 |
765
805
  | message | 具体推流信息。 |
766
806
  | 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。 |
767
807
 
768
808
  ## onScreenCaptureStarted
769
809
 
770
- #### 屏幕分享开启的事件回调。
810
+ **屏幕分享开启的事件回调。**
771
811
 
772
812
  当您通过 startScreenCapture 等相关接口启动屏幕分享时,SDK 便会抛出此事件回调。
773
813
 
774
814
  ## onScreenCapturePaused
775
815
 
776
- #### 屏幕分享暂停的事件回调。
816
+ **屏幕分享暂停的事件回调。**
777
817
 
778
818
  当您通过 pauseScreenCapture 暂停屏幕分享时,SDK 便会抛出此事件回调。
779
819
  | 参数 | 描述 |
780
820
  | --- | --- |
781
- | reason | 原因。<br>- 0:用户主动暂停。<br>- 1:注意此字段的含义在 MAC 和 Windows 平台有稍微差异。屏幕窗口不可见暂停(Mac)。表示设置屏幕分享参数导致的暂停(Windows)。<br>- 2:表示屏幕分享窗口被最小化导致的暂停(仅 Windows)。<br>- 3:表示屏幕分享窗口被隐藏导致的暂停(仅 Windows)。<br>- 4:表示屏幕共享因系统操作而暂停(仅 iOS)。 |
821
+ | reason | 暂停原因:<br>- 0:用户主动暂停。<br>- 1:屏幕窗口不可见导致的暂停(macOS)/ 屏幕分享参数设置导致的暂停(Windows)。<br>- 2:屏幕分享窗口被最小化导致的暂停(仅 Windows)。<br>- 3:屏幕分享窗口被隐藏导致的暂停(仅 Windows)。<br>- 4:系统操作导致屏幕分享暂停(仅 iOS)。 |
782
822
 
783
823
  ## onScreenCaptureResumed
784
824
 
785
- #### 屏幕分享恢复的事件回调。
825
+ **屏幕分享恢复的事件回调。**
786
826
 
787
827
  当您通过 resumeScreenCapture 恢复屏幕分享时,SDK 便会抛出此事件回调。
788
828
  | 参数 | 描述 |
789
829
  | --- | --- |
790
- | reason | 恢复原因。<br>- 0:用户主动恢复。<br>- 1:注意此字段的含义在 MAC 和 Windows 平台有稍微差异。屏幕窗口恢复可见从而恢复分享(Mac)。屏幕分享参数设置完毕后自动恢复(Windows)。<br>- 2:表示屏幕分享窗口从最小化被恢复(仅 Windows)。<br>- 3:表示屏幕分享窗口从隐藏被恢复(仅 Windows)。<br>- 4:表示屏幕共享因系统操作而恢复(仅 iOS)。 |
830
+ | reason | 恢复原因:<br>- 0:用户主动恢复。<br>- 1:屏幕窗口恢复可见导致的分享恢复(macOS)/ 屏幕分享参数设置完毕后自动恢复(Windows)。<br>- 2:屏幕分享窗口从最小化状态恢复(仅 Windows)。<br>- 3:屏幕分享窗口从隐藏状态恢复(仅 Windows)。<br>- 4:系统操作导致屏幕分享恢复(仅 iOS)。 |
791
831
 
792
832
  ## onScreenCaptureStoped
793
833
 
794
- #### 屏幕分享停止的事件回调。
834
+ **屏幕分享停止的事件回调。**
795
835
 
796
836
  当您通过 stopScreenCapture 停止屏幕分享时,SDK 便会抛出此事件回调。
797
- | 参数 | 描述 |
798
- | --- | --- |
799
- | reason | 停止原因,0:用户主动停止;1:屏幕窗口关闭导致停止;2:表示屏幕分享的显示屏状态变更(如接口被拔出、投影模式变更等)。 |
837
+
838
+ |参数|描述|
839
+ |---------|---------|
840
+ |reason|停止原因,0:用户主动停止;1:屏幕窗口关闭导致停止;2:表示屏幕分享的显示屏状态变更(如接口被拔出、投影模式变更等)。|
800
841
 
801
842
  ## onScreenCaptureCovered
802
843
 
803
- #### 屏幕分享的目标窗口被遮挡的事件回调(仅适用于 Windows 操作系统)。
844
+ **屏幕分享的目标窗口被遮挡的事件回调(仅适用于 Windows 操作系统)。**
804
845
 
805
846
  当屏幕分享的目标窗口被遮挡无法正常捕获时,SDK 会抛出此事件回调,您可以在捕获到该事件回调后,通过 UI 上的一些变化来提示用户移开遮盖窗口。
806
847
 
807
848
  ## onLocalRecordBegin
808
849
 
809
- #### 本地录制任务已经开始的事件回调。
850
+ **本地录制任务已经开始的事件回调。**
810
851
 
811
852
  当您调用 startLocalRecording 启动本地媒体录制任务时,SDK 会抛出该事件回调,用于通知您录制任务是否已经顺利启动。
812
853
  | 参数 | 描述 |
@@ -816,30 +857,32 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
816
857
 
817
858
  ## onLocalRecording
818
859
 
819
- #### 本地录制任务正在进行中的进展事件回调。
860
+ **本地录制任务正在进行中的进展事件回调。**
820
861
 
821
862
  当您调用 startLocalRecording 成功启动本地媒体录制任务后,SDK 会定时地抛出本事件回调。
822
863
 
823
864
  您可通过捕获该事件回调来获知录制任务的健康状况。
824
865
 
825
866
  您可以在 startLocalRecording 时设定本事件回调的抛出间隔。
826
- | 参数 | 描述 |
827
- | --- | --- |
828
- | duration | 已经录制的累计时长,单位毫秒。 |
829
- | storagePath | 录制文件存储路径。 |
867
+
868
+ |参数|描述|
869
+ |---------|---------|
870
+ |duration|已经录制的累计时长,单位毫秒。|
871
+ |storagePath|录制文件存储路径。|
830
872
 
831
873
  ## onLocalRecordFragment
832
874
 
833
- #### 本地录制分片的事件回调。
875
+ **本地录制分片的事件回调。**
834
876
 
835
877
  当您开启分片录制时,每完成一个分片,都会通过此接口回调。
836
- | 参数 | 描述 |
837
- | --- | --- |
838
- | storagePath | 分片文件存储路径。 |
878
+
879
+ |参数|描述|
880
+ |---------|---------|
881
+ |storagePath|分片文件存储路径。|
839
882
 
840
883
  ## onLocalRecordComplete
841
884
 
842
- #### 本地录制任务已经结束的事件回调。
885
+ **本地录制任务已经结束的事件回调。**
843
886
 
844
887
  当您调用 stopLocalRecording 停止本地媒体录制任务时,SDK 会抛出该事件回调,用于通知您录制任务的最终结果。
845
888
  | 参数 | 描述 |
@@ -849,17 +892,18 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
849
892
 
850
893
  ## onSnapshotComplete
851
894
 
852
- #### 本地截图完成的事件回调。
853
- | 参数 | 描述 |
854
- | --- | --- |
855
- | bmp | 截图结果,如果 bmp 为 null 代表本次截图操作失败。 |
856
- | data | 截图数据,为 nullptr 表示截图失败。 |
857
- | format | 截图数据格式,目前只支持 TRTCVideoPixelFormat_BGRA32。 |
858
- | height | 截图画面的高度。 |
859
- | length | 截图数据长度,对于BGRA32而言,` length = width * height * 4 `。 |
860
- | type | 视频流类型。 |
861
- | userId | 用户标识,如果 userId 为空字符串,则代表截取的是本地画面。 |
862
- | width | 截图画面的宽度。 |
895
+ **本地截图完成的事件回调。**
896
+
897
+ |参数|描述|
898
+ |---------|---------|
899
+ |bmp|截图结果,如果 bmp 为 null 代表本次截图操作失败。|
900
+ |data|截图数据,为 nullptr 表示截图失败。|
901
+ |format|截图数据格式,目前只支持 TRTCVideoPixelFormat_BGRA32。|
902
+ |height|截图画面的高度。|
903
+ |length|截图数据长度,对于BGRA32而言,` length = width * height * 4 `。|
904
+ |type|视频流类型。|
905
+ |userId|用户标识,如果 userId 为空字符串,则代表截取的是本地画面。|
906
+ |width|截图画面的宽度。|
863
907
 
864
908
  > **注意**
865
909
  >
@@ -867,21 +911,25 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
867
911
  > 全平台 C++ 接口和 Java 接口在参数上是不一样的,C++ 接口用 7 个参数描述一个截图画面,Java 接口只用一个 Bitmap 描述一个截图画面。
868
912
  >
869
913
 
914
+ ## onExperimentalEvent
915
+
916
+ **实验性接口的事件回调。**
917
+
870
918
  ## onUserEnter
871
919
 
872
- #### 有主播加入当前房间(已废弃)。
920
+ **有主播加入当前房间(已废弃)。**
873
921
 
874
922
  @deprecated 新版本开始不推荐使用,建议使用 onRemoteUserEnterRoom 替代之。
875
923
 
876
924
  ## onUserExit
877
925
 
878
- #### 有主播离开当前房间(已废弃)。
926
+ **有主播离开当前房间(已废弃)。**
879
927
 
880
928
  @deprecated 新版本开始不推荐使用,建议使用 onRemoteUserLeaveRoom 替代之。
881
929
 
882
930
  ## onAudioEffectFinished
883
931
 
884
- #### 音效播放已结束(已废弃)。
932
+ **音效播放已结束(已废弃)。**
885
933
 
886
934
  @deprecated 新版本开始不推荐使用,建议使用 TXAudioEffectManager 接口替代之。
887
935
 
@@ -889,7 +937,7 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
889
937
 
890
938
  ## onPlayBGMBegin
891
939
 
892
- #### 开始播放背景音乐(已废弃)。
940
+ **开始播放背景音乐(已废弃)。**
893
941
 
894
942
  @deprecated 新版本开始不推荐使用,建议使用 ITXMusicPlayObserver 接口替代之。
895
943
 
@@ -897,7 +945,7 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
897
945
 
898
946
  ## onPlayBGMProgress
899
947
 
900
- #### 背景音乐的播放进度回调(已废弃)。
948
+ **背景音乐的播放进度回调(已废弃)。**
901
949
 
902
950
  @deprecated 新版本开始不推荐使用,建议使用 ITXMusicPlayObserver 接口替代之。
903
951
 
@@ -905,7 +953,7 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
905
953
 
906
954
  ## onPlayBGMComplete
907
955
 
908
- #### 背景音乐播放已经结束(已废弃)。
956
+ **背景音乐播放已经结束(已废弃)。**
909
957
 
910
958
  @deprecated 新版本开始不推荐使用,建议使用 ITXMusicPlayObserver 接口替代之。
911
959
 
@@ -913,28 +961,29 @@ SDK 会将系统声音采集是否被成功开启的结果,通过本事件回
913
961
 
914
962
  ## onSpeedTest
915
963
 
916
- #### 服务器测速的结果回调(已废弃)。
964
+ **服务器测速的结果回调(已废弃)。**
917
965
 
918
966
  @deprecated 新版本开始不推荐使用,建议使用 onSpeedTestResult 接口替代之。
919
967
 
920
968
  ## onRenderVideoFrame
921
969
 
922
- #### 自定义视频渲染回调。
970
+ **自定义视频渲染回调。**
923
971
 
924
972
  当您设置了本地或者远端的视频自定义渲染回调之后,SDK 就会将原本要交给渲染控件进行渲染的视频帧通过此回调接口抛送给您,以便于您进行自定义渲染。
925
- | 参数 | 描述 |
926
- | --- | --- |
927
- | frame | 待渲染的视频帧信息。 |
928
- | streamType | 频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。 |
929
- | userId | 视频源的 userId,如果是本地视频回调(setLocalVideoRenderDelegate),该参数可以忽略。 |
973
+
974
+ |参数|描述|
975
+ |---------|---------|
976
+ |frame|待渲染的视频帧信息。|
977
+ |streamType|频流类型:主路(Main)一般用于承载摄像头画面,辅路(Sub)一般用于承载屏幕分享画面。|
978
+ |userId|视频源的 userId,如果是本地视频回调(setLocalVideoRenderDelegate),该参数可以忽略。|
930
979
 
931
980
  ## onGLContextCreated
932
981
 
933
- #### SDK 内部 OpenGL 环境已经创建的通知。
982
+ **SDK 内部 OpenGL 环境已经创建的通知。**
934
983
 
935
984
  ## onProcessVideoFrame
936
985
 
937
- #### 用于对接第三方美颜组件的视频处理回调。
986
+ **用于对接第三方美颜组件的视频处理回调。**
938
987
 
939
988
  如果您选购了第三方美颜组件,就需要在 TRTCCloud 中设置第三方美颜回调,之后 TRTC 就会将原本要进行预处理的视频帧通过此回调接口抛送给您。
940
989
 
@@ -959,10 +1008,11 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
959
1008
  return 0;
960
1009
  }
961
1010
  ```
962
- | 参数 | 描述 |
963
- | --- | --- |
964
- | dstFrame | 用于接收第三方美颜处理过的视频画面。 |
965
- | srcFrame | 用于承载 TRTC 采集到的摄像头画面。 |
1011
+
1012
+ |参数|描述|
1013
+ |---------|---------|
1014
+ |dstFrame|用于接收第三方美颜处理过的视频画面。|
1015
+ |srcFrame|用于承载 TRTC 采集到的摄像头画面。|
966
1016
 
967
1017
  > **注意**
968
1018
  >
@@ -972,11 +1022,11 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
972
1022
 
973
1023
  ## onGLContextDestroy
974
1024
 
975
- #### SDK 内部 OpenGL 环境被销毁的通知。
1025
+ **SDK 内部 OpenGL 环境被销毁的通知。**
976
1026
 
977
1027
  ## onCapturedAudioFrame
978
1028
 
979
- #### 本地采集并经过音频模块前处理后的音频数据回调。
1029
+ **本地采集并经过音频模块前处理后的音频数据回调。**
980
1030
 
981
1031
  当您设置完音频数据自定义回调之后,SDK 内部会把刚采集到并经过前处理(ANS、AEC、AGC)之后的数据,以 PCM 格式的形式通过本接口回调给您。
982
1032
  - 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
@@ -985,9 +1035,9 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
985
1035
 
986
1036
  - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 ` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
987
1037
 
988
- | 参数 | 描述 |
989
- | --- | --- |
990
- | frame | PCM 格式的音频数据帧。 |
1038
+ |参数|描述|
1039
+ |---------|---------|
1040
+ |frame|PCM 格式的音频数据帧。|
991
1041
 
992
1042
  > **注意**
993
1043
  >
@@ -1003,7 +1053,7 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
1003
1053
 
1004
1054
  ## onLocalProcessedAudioFrame
1005
1055
 
1006
- #### 本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调。
1056
+ **本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调。**
1007
1057
 
1008
1058
  当您设置完音频数据自定义回调之后,SDK 内部会把刚采集到并经过前处理、音效处理和混 BGM 之后的数据,在最终进行网络编码之前,以 PCM 格式的形式通过本接口回调给您。
1009
1059
  - 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
@@ -1017,9 +1067,10 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
1017
1067
  您可以通过设置接口中的 ` TRTCAudioFrame.extraData ` 字段,达到传输信令的目的。由于音频帧头部的数据块不能太大,建议您写入 ` extraData ` 时,尽量将信令控制在几个字节的大小,如果超过 100 个字节,写入的数据不会被发送。
1018
1068
 
1019
1069
  房间内其他用户可以通过 ITRTCAudioFrameCallback 中的 ` onRemoteUserAudioFrame ` 中的 ` TRTCAudioFrame.extraData ` 字段回调接收数据。
1020
- | 参数 | 描述 |
1021
- | --- | --- |
1022
- | frame | PCM 格式的音频数据帧。 |
1070
+
1071
+ |参数|描述|
1072
+ |---------|---------|
1073
+ |frame|PCM 格式的音频数据帧。|
1023
1074
 
1024
1075
  > **注意**
1025
1076
  >
@@ -1035,7 +1086,7 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
1035
1086
 
1036
1087
  ## onPlayAudioFrame
1037
1088
 
1038
- #### 混音前的每一路远程用户的音频数据。
1089
+ **混音前的每一路远程用户的音频数据。**
1039
1090
 
1040
1091
  当您设置完音频数据自定义回调之后,SDK 内部会把远端的每一路原始数据,在最终混音之前,以 PCM 格式的形式通过本接口回调给您。
1041
1092
  - 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
@@ -1044,10 +1095,10 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
1044
1095
 
1045
1096
  - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
1046
1097
 
1047
- | 参数 | 描述 |
1048
- | --- | --- |
1049
- | frame | PCM 格式的音频数据帧。 |
1050
- | userId | 用户标识。 |
1098
+ |参数|描述|
1099
+ |---------|---------|
1100
+ |frame|PCM 格式的音频数据帧。|
1101
+ |userId|用户标识。|
1051
1102
 
1052
1103
  > **注意**
1053
1104
  >
@@ -1057,7 +1108,7 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
1057
1108
 
1058
1109
  ## onMixedPlayAudioFrame
1059
1110
 
1060
- #### 将各路待播放音频混合之后并在最终提交系统播放之前的数据回调。
1111
+ **将各路待播放音频混合之后并在最终提交系统播放之前的数据回调。**
1061
1112
 
1062
1113
  当您设置完音频数据自定义回调之后,SDK 内部会把各路待播放的音频混合之后的音频数据,在提交系统播放之前,以 PCM 格式的形式通过本接口回调给您。
1063
1114
  - 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
@@ -1066,9 +1117,9 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
1066
1117
 
1067
1118
  - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 ` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
1068
1119
 
1069
- | 参数 | 描述 |
1070
- | --- | --- |
1071
- | frame | PCM 格式的音频数据帧。 |
1120
+ |参数|描述|
1121
+ |---------|---------|
1122
+ |frame|PCM 格式的音频数据帧。|
1072
1123
 
1073
1124
  > **注意**
1074
1125
  >
@@ -1084,7 +1135,7 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
1084
1135
 
1085
1136
  ## onMixedAllAudioFrame
1086
1137
 
1087
- #### SDK 所有音频混合后的音频数据(包括采集到的和待播放的)。
1138
+ **SDK 所有音频混合后的音频数据(包括采集到的和待播放的)。**
1088
1139
 
1089
1140
  当您设置完音频数据自定义回调之后,SDK 内部会把所有采集到的和待播放的音频数据混合起来,以 PCM 格式的形式通过本接口回调给您,便于您进行自定义录制。
1090
1141
  - 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
@@ -1093,9 +1144,9 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
1093
1144
 
1094
1145
  - 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 ` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
1095
1146
 
1096
- | 参数 | 描述 |
1097
- | --- | --- |
1098
- | frame | PCM 格式的音频数据帧。 |
1147
+ |参数|描述|
1148
+ |---------|---------|
1149
+ |frame|PCM 格式的音频数据帧。|
1099
1150
 
1100
1151
  > **注意**
1101
1152
  >
@@ -1108,11 +1159,12 @@ int onProcessVideoFrame(TRTCVideoFrame *srcFrame, TRTCVideoFrame *dstFrame) {
1108
1159
 
1109
1160
  ## onLog
1110
1161
 
1111
- #### 本地 LOG 的打印回调。
1162
+ **本地 LOG 的打印回调。**
1112
1163
 
1113
1164
  如果您希望捕获 SDK 的本地日志打印行为,可以通过设置日志回调,让 SDK 将要打印的日志都通过本回调接口抛送给您。
1114
- | 参数 | 描述 |
1115
- | --- | --- |
1116
- | level | 日志等级请参见 TRTC_LOG_LEVEL。 |
1117
- | log | 日志内容。 |
1118
- | module | 保留字段,暂无具体意义,目前为固定值 ` TXLiteAVSDK `。 |
1165
+
1166
+ |参数|描述|
1167
+ |---------|---------|
1168
+ |level|日志等级请参见 TRTC_LOG_LEVEL。|
1169
+ |log|日志内容。|
1170
+ |module|保留字段,暂无具体意义,目前为固定值 ` TXLiteAVSDK `。|