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