@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,124 +1,129 @@
1
- # 腾讯云实时音视频(TRTC SDK )文档
1
+ Copyright (c) 2021 Tencent. All rights reserved.
2
2
 
3
- ## 概述
4
- `TRTCCloudDef.java` 是腾讯云实时音视频(TRTC SDK ) Android 平台的类型定义文档。
3
+ Module: TRTC 关键类型定义
4
+
5
+ Function: 分辨率、质量等级等枚举和常量值的定义
5
6
 
6
7
  ## 结构体类型
7
- | 函数列表 | 描述 |
8
- | --- | --- |
9
- | TRTCParams | 进房参数。 |
10
- | TRTCVideoEncParam | 视频编码参数。 |
11
- | TRTCNetworkQosParam | 网络流控(Qos)参数集。 |
12
- | TRTCRenderParams | 视频画面的渲染参数。 |
13
- | TRTCQuality | 网络质量。 |
14
- | TRTCVolumeInfo | 音量大小。 |
15
- | TRTCSpeedTestParams | 测速参数。 |
16
- | TRTCSpeedTestResult | 网络测速结果。 |
17
- | TRTCTexture | 视频纹理数据。 |
18
- | TRTCVideoFrame | 视频帧信息。 |
19
- | TRTCAudioFrame | 音频帧数据。 |
20
- | TRTCMixUser | 云端混流中各路画面的描述信息。 |
21
- | TRTCTranscodingConfig | 云端混流的排版布局和转码参数。 |
22
- | TRTCPublishCDNParam | 向非腾讯云 CDN 上发布音视频流时需设置的转推参数。 |
23
- | TRTCAudioRecordingParams | 本地音频文件的录制参数。 |
24
- | TRTCLocalRecordingParams | 本地媒体文件的录制参数。 |
25
- | TRTCAudioEffectParam | 音效参数(已废弃)。 |
26
- | TRTCSwitchRoomConfig | 房间切换参数。 |
27
- | TRTCAudioFrameCallbackFormat | 音频自定义回调的格式参数。 |
28
- | TRTCScreenShareParams | 屏幕分享参数(仅适用于 Android 平台)。 |
29
- | TRTCAudioParallelParams | 远端音频流智能并发播放策略的参数。 |
30
- | TRTCUser | 媒体流发布相关配置的用户信息。 |
31
- | TRTCPublishCdnUrl | 向腾讯或者第三方 CDN 上发布音视频流时需设置的 url 配置。 |
32
- | TRTCPublishTarget | 目标推流配置。 |
33
- | TRTCVideoLayout | 转码视频布局。 |
34
- | TRTCWatermark | 水印布局。 |
35
- | TRTCStreamEncoderParam | 媒体流编码输出参数。 |
36
- | TRTCStreamMixingConfig | 媒体流转码配置参数。 |
37
- | TRTCPayloadPrivateEncryptionConfig | 媒体流私有加密配置。 |
38
- | TRTCAudioVolumeEvaluateParams | 音量评估等相关参数设置。 |
8
+
9
+ |函数列表|描述|
10
+ |---------|---------|
11
+ |TRTCParams|进房参数。|
12
+ |TRTCVideoEncParam|视频编码参数。|
13
+ |TRTCNetworkQosParam|网络流控(Qos)参数集。|
14
+ |TRTCRenderParams|视频画面的渲染参数。|
15
+ |TRTCQuality|网络质量。|
16
+ |TRTCVolumeInfo|音量大小。|
17
+ |TRTCSpeedTestParams|测速参数。|
18
+ |TRTCSpeedTestResult|网络测速结果。|
19
+ |TRTCTexture|视频纹理数据。|
20
+ |TRTCVideoFrame|视频帧信息。|
21
+ |TRTCAudioFrame|音频帧数据。|
22
+ |TRTCMixUser|云端混流中各路画面的描述信息。|
23
+ |TRTCTranscodingConfig|云端混流的排版布局和转码参数。|
24
+ |TRTCPublishCDNParam|向非腾讯云 CDN 上发布音视频流时需设置的转推参数。|
25
+ |TRTCAudioRecordingParams|本地音频文件的录制参数。|
26
+ |TRTCLocalRecordingParams|本地媒体文件的录制参数。|
27
+ |TRTCAudioEffectParam|音效参数(已废弃)。|
28
+ |TRTCSwitchRoomConfig|房间切换参数。|
29
+ |TRTCAudioFrameCallbackFormat|音频自定义回调的格式参数。|
30
+ |TRTCScreenShareParams|屏幕分享参数(仅适用于 Android 平台)。|
31
+ |TRTCAudioParallelParams|远端音频流智能并发播放策略的参数。|
32
+ |TRTCUser|媒体流发布相关配置的用户信息。|
33
+ |TRTCPublishCdnUrl|向腾讯或者第三方 CDN 上发布音视频流时需设置的 url 配置。|
34
+ |TRTCPublishTarget|目标推流配置。|
35
+ |TRTCVideoLayout|转码视频布局。|
36
+ |TRTCWatermark|水印布局。|
37
+ |TRTCStreamEncoderParam|媒体流编码输出参数。|
38
+ |TRTCStreamMixingConfig|媒体流转码配置参数。|
39
+ |TRTCPayloadPrivateEncryptionConfig|媒体流私有加密配置。|
40
+ |TRTCAudioVolumeEvaluateParams|音量评估等相关参数设置。|
39
41
 
40
42
  ## 枚举类型
41
- | 枚举类型 | 描述 |
42
- | --- | --- |
43
- | TRTCVideoResolution | 视频分辨率。 |
44
- | TRTCVideoResolutionMode | 视频宽高比模式。 |
45
- | TRTCVideoStreamType | 视频流类型。 |
46
- | TRTCVideoFillMode | 视频画面填充模式。 |
47
- | TRTCVideoRotation | 视频画面旋转方向。 |
48
- | TRTCBeautyStyle | 美颜(磨皮)算法。 |
49
- | TRTCVideoPixelFormat | 视频像素格式。 |
50
- | TRTCVideoBufferType | 视频数据传递方式。 |
51
- | TRTCVideoMirrorType | 视频的镜像类型。 |
52
- | TRTCSnapshotSourceType | 本地视频截图的数据源。 |
53
- | TRTCAppScene | 应用场景。 |
54
- | TRTCRoleType | 角色。 |
55
- | TRTCQosControlMode(Deprecated) | 流控模式(已废弃)。 |
56
- | TRTCVideoQosPreference | 画质偏好。 |
57
- | TRTCQuality | 网络质量。 |
58
- | TRTCAVStatusType | 音视频状态类型。 |
59
- | TRTCAVStatusChangeReason | 音视频状态变化原因类型。 |
60
- | TRTCAudioSampleRate | 音频采样率。 |
61
- | TRTCAudioQuality | 声音音质。 |
62
- | TRTCAudioRoute | 音频路由(即声音的播放模式)。 |
63
- | TRTCReverbType | 声音混响模式。 |
64
- | TRTCVoiceChangerType | 变声类型。 |
65
- | TRTCSystemVolumeType | 系统音量类型(仅适用于移动设备)。 |
66
- | TRTCAudioFrameFormat | 音频帧的内容格式。 |
67
- | TRTCAudioCapabilityType | 系统支持的音频能力类型(仅适用于Android设备)。 |
68
- | TRTCAudioFrameOperationMode | 音频回调数据读写模式。 |
69
- | TRTCLogLevel | Log 级别。 |
70
- | TRTCGSensorMode | 重力感应开关(仅适用于移动端)。 |
71
- | TRTCTranscodingConfigMode | 云端混流的排版模式。 |
72
- | TRTCRecordType | 媒体录制类型。 |
73
- | TRTCMixInputType | 混流输入类型。 |
74
- | TRTCDebugViewLevel | 用于渲染控件上展示的调试信息。 |
75
- | TRTCAudioRecordingContent | 音频录制内容类型。 |
76
- | TRTCPublishMode | 媒体流发布模式。 |
77
- | TRTCEncryptionAlgorithm | 加密算法。 |
78
- | TRTCSpeedTestScene | 测速场景。 |
79
- | TRTCGravitySensorAdaptiveMode | 设置重力感应的适配模式(仅适用于移动端)。 |
43
+
44
+ |枚举类型|描述|
45
+ |---------|---------|
46
+ |TRTCVideoResolution|视频分辨率。|
47
+ |TRTCVideoResolutionMode|视频宽高比模式。|
48
+ |TRTCVideoStreamType|视频流类型。|
49
+ |TRTCVideoFillMode|视频画面填充模式。|
50
+ |TRTCVideoRotation|视频画面旋转方向。|
51
+ |TRTCBeautyStyle|美颜(磨皮)算法。|
52
+ |TRTCVideoPixelFormat|视频像素格式。|
53
+ |TRTCVideoBufferType|视频数据传递方式。|
54
+ |TRTCVideoMirrorType|视频的镜像类型。|
55
+ |TRTCSnapshotSourceType|本地视频截图的数据源。|
56
+ |TRTCAppScene|应用场景。|
57
+ |TRTCRoleType|角色。|
58
+ |TRTCQosControlMode(Deprecated)|流控模式(已废弃)。|
59
+ |TRTCVideoQosPreference|画质偏好。|
60
+ |TRTCQuality|网络质量。|
61
+ |TRTCAVStatusType|音视频状态类型。|
62
+ |TRTCAVStatusChangeReason|音视频状态变化原因类型。|
63
+ |TRTCAudioSampleRate|音频采样率。|
64
+ |TRTCAudioQuality|声音音质。|
65
+ |TRTCAudioRoute|音频路由(即声音的播放模式)。|
66
+ |TRTCReverbType|声音混响模式。|
67
+ |TRTCVoiceChangerType|变声类型。|
68
+ |TRTCSystemVolumeType|系统音量类型(仅适用于移动设备)。|
69
+ |TRTCAudioFrameFormat|音频帧的内容格式。|
70
+ |TRTCAudioCapabilityType|系统支持的音频能力类型(仅适用于Android设备)。|
71
+ |TRTCAudioFrameOperationMode|音频回调数据读写模式。|
72
+ |TRTCLogLevel|Log 级别。|
73
+ |TRTCGSensorMode|重力感应开关(仅适用于移动端)。|
74
+ |TRTCTranscodingConfigMode|云端混流的排版模式。|
75
+ |TRTCRecordType|媒体录制类型。|
76
+ |TRTCMixInputType|混流输入类型。|
77
+ |TRTCDebugViewLevel|用于渲染控件上展示的调试信息。|
78
+ |TRTCAudioRecordingContent|音频录制内容类型。|
79
+ |TRTCPublishMode|媒体流发布模式。|
80
+ |TRTCEncryptionAlgorithm|加密算法。|
81
+ |TRTCSpeedTestScene|测速场景。|
82
+ |TRTCGravitySensorAdaptiveMode|设置重力感应的适配模式(仅适用于移动端)。|
80
83
 
81
84
  ## TRTCVideoResolution
82
85
 
83
- #### 视频分辨率。
86
+ **视频分辨率。**
84
87
 
85
88
  此处仅定义横屏分辨率(如 640 × 360),如需使用竖屏分辨率(如360 × 640),需要同时指定 TRTCVideoResolutionMode 为 Portrait。
86
- | 枚举 | 取值 | 描述 |
87
- | --- | --- | --- |
88
- | TRTC_VIDEO_RESOLUTION_120_120 | 1 | 宽高比 1:1;分辨率 120x120;建议码率(VideoCall)80kbps; 建议码率(LIVE)120kbps。 |
89
- | TRTC_VIDEO_RESOLUTION_160_160 | 3 | 宽高比 1:1 分辨率 160x160;建议码率(VideoCall)100kbps; 建议码率(LIVE)150kbps。 |
90
- | TRTC_VIDEO_RESOLUTION_270_270 | 5 | 宽高比 1:1;分辨率 270x270;建议码率(VideoCall)200kbps; 建议码率(LIVE)300kbps。 |
91
- | TRTC_VIDEO_RESOLUTION_480_480 | 7 | 宽高比 1:1;分辨率 480x480;建议码率(VideoCall)350kbps; 建议码率(LIVE)500kbps。 |
92
- | TRTC_VIDEO_RESOLUTION_160_120 | 50 | 宽高比4:3;分辨率 160x120;建议码率(VideoCall)100kbps; 建议码率(LIVE)150kbps。 |
93
- | TRTC_VIDEO_RESOLUTION_240_180 | 52 | 宽高比 4:3;分辨率 240x180;建议码率(VideoCall)150kbps; 建议码率(LIVE)250kbps。 |
94
- | TRTC_VIDEO_RESOLUTION_280_210 | 54 | 宽高比 4:3;分辨率 280x210;建议码率(VideoCall)200kbps; 建议码率(LIVE)300kbps。 |
95
- | TRTC_VIDEO_RESOLUTION_320_240 | 56 | 宽高比 4:3;分辨率 320x240;建议码率(VideoCall)250kbps; 建议码率(LIVE)375kbps。 |
96
- | TRTC_VIDEO_RESOLUTION_400_300 | 58 | 宽高比 4:3;分辨率 400x300;建议码率(VideoCall)300kbps; 建议码率(LIVE)450kbps。 |
97
- | TRTC_VIDEO_RESOLUTION_480_360 | 60 | 宽高比 4:3;分辨率 480x360;建议码率(VideoCall)400kbps; 建议码率(LIVE)600kbps。 |
98
- | TRTC_VIDEO_RESOLUTION_640_480 | 62 | 宽高比 4:3;分辨率 640x480;建议码率(VideoCall)600kbps; 建议码率(LIVE)900kbps。 |
99
- | TRTC_VIDEO_RESOLUTION_960_720 | 64 | 宽高比 4:3;分辨率 960x720;建议码率(VideoCall)1000kbps; 建议码率(LIVE)1500kbps。 |
100
- | TRTC_VIDEO_RESOLUTION_160_90 | 100 | 宽高比 16:9;分辨率 160x90;建议码率(VideoCall)150kbps; 建议码率(LIVE)250kbps。 |
101
- | TRTC_VIDEO_RESOLUTION_256_144 | 102 | 宽高比 16:9;分辨率 256x144;建议码率(VideoCall)200kbps; 建议码率(LIVE)300kbps。 |
102
- | TRTC_VIDEO_RESOLUTION_320_180 | 104 | 宽高比 16:9;分辨率 320x180;建议码率(VideoCall)250kbps; 建议码率(LIVE)400kbps。 |
103
- | TRTC_VIDEO_RESOLUTION_480_270 | 106 | 宽高比 16:9;分辨率 480x270;建议码率(VideoCall)350kbps; 建议码率(LIVE)550kbps。 |
104
- | TRTC_VIDEO_RESOLUTION_640_360 | 108 | 宽高比 16:9;分辨率 640x360;建议码率(VideoCall)500kbps; 建议码率(LIVE)900kbps。 |
105
- | TRTC_VIDEO_RESOLUTION_960_540 | 110 | 宽高比 16:9;分辨率 960x540;建议码率(VideoCall)850kbps; 建议码率(LIVE)1300kbps。 |
106
- | TRTC_VIDEO_RESOLUTION_1280_720 | 112 | 宽高比 16:9;分辨率 1280x720;建议码率(VideoCall)1200kbps; 建议码率(LIVE)1800kbps。 |
107
- | TRTC_VIDEO_RESOLUTION_1920_1080 | 114 | 宽高比 16:9;分辨率 1920x1080;建议码率(VideoCall)2000kbps; 建议码率(LIVE)3000kbps。 |
89
+
90
+ |枚举|取值|描述|
91
+ |---------|---------|---------|
92
+ |TRTC_VIDEO_RESOLUTION_120_120|1|宽高比 1:1;分辨率 120x120;建议码率(VideoCall)80kbps; 建议码率(LIVE)120kbps。|
93
+ |TRTC_VIDEO_RESOLUTION_160_160|3|宽高比 1:1 分辨率 160x160;建议码率(VideoCall)100kbps; 建议码率(LIVE)150kbps。|
94
+ |TRTC_VIDEO_RESOLUTION_270_270|5|宽高比 1:1;分辨率 270x270;建议码率(VideoCall)200kbps; 建议码率(LIVE)300kbps。|
95
+ |TRTC_VIDEO_RESOLUTION_480_480|7|宽高比 1:1;分辨率 480x480;建议码率(VideoCall)350kbps; 建议码率(LIVE)500kbps。|
96
+ |TRTC_VIDEO_RESOLUTION_160_120|50|宽高比4:3;分辨率 160x120;建议码率(VideoCall)100kbps; 建议码率(LIVE)150kbps。|
97
+ |TRTC_VIDEO_RESOLUTION_240_180|52|宽高比 4:3;分辨率 240x180;建议码率(VideoCall)150kbps; 建议码率(LIVE)250kbps。|
98
+ |TRTC_VIDEO_RESOLUTION_280_210|54|宽高比 4:3;分辨率 280x210;建议码率(VideoCall)200kbps; 建议码率(LIVE)300kbps。|
99
+ |TRTC_VIDEO_RESOLUTION_320_240|56|宽高比 4:3;分辨率 320x240;建议码率(VideoCall)250kbps; 建议码率(LIVE)375kbps。|
100
+ |TRTC_VIDEO_RESOLUTION_400_300|58|宽高比 4:3;分辨率 400x300;建议码率(VideoCall)300kbps; 建议码率(LIVE)450kbps。|
101
+ |TRTC_VIDEO_RESOLUTION_480_360|60|宽高比 4:3;分辨率 480x360;建议码率(VideoCall)400kbps; 建议码率(LIVE)600kbps。|
102
+ |TRTC_VIDEO_RESOLUTION_640_480|62|宽高比 4:3;分辨率 640x480;建议码率(VideoCall)600kbps; 建议码率(LIVE)900kbps。|
103
+ |TRTC_VIDEO_RESOLUTION_960_720|64|宽高比 4:3;分辨率 960x720;建议码率(VideoCall)1000kbps; 建议码率(LIVE)1500kbps。|
104
+ |TRTC_VIDEO_RESOLUTION_160_90|100|宽高比 16:9;分辨率 160x90;建议码率(VideoCall)150kbps; 建议码率(LIVE)250kbps。|
105
+ |TRTC_VIDEO_RESOLUTION_256_144|102|宽高比 16:9;分辨率 256x144;建议码率(VideoCall)200kbps; 建议码率(LIVE)300kbps。|
106
+ |TRTC_VIDEO_RESOLUTION_320_180|104|宽高比 16:9;分辨率 320x180;建议码率(VideoCall)250kbps; 建议码率(LIVE)400kbps。|
107
+ |TRTC_VIDEO_RESOLUTION_480_270|106|宽高比 16:9;分辨率 480x270;建议码率(VideoCall)350kbps; 建议码率(LIVE)550kbps。|
108
+ |TRTC_VIDEO_RESOLUTION_640_360|108|宽高比 16:9;分辨率 640x360;建议码率(VideoCall)500kbps; 建议码率(LIVE)900kbps。|
109
+ |TRTC_VIDEO_RESOLUTION_960_540|110|宽高比 16:9;分辨率 960x540;建议码率(VideoCall)850kbps; 建议码率(LIVE)1300kbps。|
110
+ |TRTC_VIDEO_RESOLUTION_1280_720|112|宽高比 16:9;分辨率 1280x720;建议码率(VideoCall)1200kbps; 建议码率(LIVE)1800kbps。|
111
+ |TRTC_VIDEO_RESOLUTION_1920_1080|114|宽高比 16:9;分辨率 1920x1080;建议码率(VideoCall)2000kbps; 建议码率(LIVE)3000kbps。|
108
112
 
109
113
  ## TRTCVideoResolutionMode
110
114
 
111
- #### 视频宽高比模式。
115
+ **视频宽高比模式。**
112
116
 
113
117
  TRTCVideoResolution 中仅定义了横屏分辨率(如 640 × 360),如需使用竖屏分辨率(如360 × 640),需要同时指定 ` TRTCVideoResolutionMode ` 为 Portrait。
114
- | 枚举 | 取值 | 描述 |
115
- | --- | --- | --- |
116
- | TRTC_VIDEO_RESOLUTION_MODE_LANDSCAPE | 0 | 横屏分辨率,例如:` TRTCVideoResolution_640_360 + TRTCVideoResolutionModeLandscape = 640 × 360 `。 |
117
- | TRTC_VIDEO_RESOLUTION_MODE_PORTRAIT | 1 | 竖屏分辨率,例如:` TRTCVideoResolution_640_360 + TRTCVideoResolutionModePortrait = 360 × 640 `。 |
118
+
119
+ |枚举|取值|描述|
120
+ |---------|---------|---------|
121
+ |TRTC_VIDEO_RESOLUTION_MODE_LANDSCAPE|0|横屏分辨率,例如:` TRTCVideoResolution_640_360 + TRTCVideoResolutionModeLandscape = 640 × 360 `。|
122
+ |TRTC_VIDEO_RESOLUTION_MODE_PORTRAIT|1|竖屏分辨率,例如:` TRTCVideoResolution_640_360 + TRTCVideoResolutionModePortrait = 360 × 640 `。|
118
123
 
119
124
  ## TRTCVideoStreamType
120
125
 
121
- #### 视频流类型。
126
+ **视频流类型。**
122
127
 
123
128
  TRTC 内部有三种不同的视频流,分别是:
124
129
  - 高清大画面:一般用来传输摄像头的视频数据。
@@ -133,67 +138,70 @@ TRTC 内部有三种不同的视频流,分别是:
133
138
  > 不支持单独开启低清小画面,小画面必须依附于大画面而存在,SDK 会自动设定低清小画面的分辨率和码率。
134
139
  >
135
140
 
136
- | 枚举 | 取值 | 描述 |
137
- | --- | --- | --- |
138
- | TRTC_VIDEO_STREAM_TYPE_BIG | 0 | 高清大画面,一般用来传输摄像头的视频数据。 |
139
- | TRTC_VIDEO_STREAM_TYPE_SMALL | 1 | 低清小画面:小画面和大画面的内容相互,但是分辨率和码率都比大画面低,因此清晰度也更低。 |
140
- | TRTC_VIDEO_STREAM_TYPE_SUB | 2 | 辅流画面:一般用于屏幕分享,同一时间在同一个房间中只允许一个用户发布辅流视频,其他用户必须要等该用户关闭之后才能发布自己的辅流。 |
141
+ |枚举|取值|描述|
142
+ |---------|---------|---------|
143
+ |TRTC_VIDEO_STREAM_TYPE_BIG|0|高清大画面,一般用来传输摄像头的视频数据。|
144
+ |TRTC_VIDEO_STREAM_TYPE_SMALL|1|低清小画面:小画面和大画面的内容相互,但是分辨率和码率都比大画面低,因此清晰度也更低。|
145
+ |TRTC_VIDEO_STREAM_TYPE_SUB|2|辅流画面:一般用于屏幕分享,同一时间在同一个房间中只允许一个用户发布辅流视频,其他用户必须要等该用户关闭之后才能发布自己的辅流。|
141
146
 
142
147
  ## TRTCVideoFillMode
143
148
 
144
- #### 视频画面填充模式。
149
+ **视频画面填充模式。**
145
150
 
146
151
  如果视频显示区域的宽高比不等于视频内容的宽高比时,需要指定画面的填充模式。
147
- | 枚举 | 取值 | 描述 |
148
- | --- | --- | --- |
149
- | TRTC_VIDEO_RENDER_MODE_FILL | 0 | 填充模式:即将画面内容居中等比缩放以充满整个显示区域,超出显示区域的部分将会被裁剪掉,此模式下画面可能不完整。 |
150
- | TRTC_VIDEO_RENDER_MODE_FIT | 1 | 适应模式:即按画面长边进行缩放以适应显示区域,短边部分会被填充为黑色,此模式下图像完整但可能留有黑边。 |
151
- | TRTC_VIDEO_RENDER_MODE_SCALE_FILL | 2 | 缩放填充模式:即无论画面的宽高比,都会被拉伸或压缩以完全填充显示区域,此模式下画面宽高比可能会被改变,导致渲染画面变形 |
152
+
153
+ |枚举|取值|描述|
154
+ |---------|---------|---------|
155
+ |TRTC_VIDEO_RENDER_MODE_FILL|0|填充模式:即将画面内容居中等比缩放以充满整个显示区域,超出显示区域的部分将会被裁剪掉,此模式下画面可能不完整。|
156
+ |TRTC_VIDEO_RENDER_MODE_FIT|1|适应模式:即按画面长边进行缩放以适应显示区域,短边部分会被填充为黑色,此模式下图像完整但可能留有黑边。|
157
+ |TRTC_VIDEO_RENDER_MODE_SCALE_FILL|2|缩放填充模式:即无论画面的宽高比,都会被拉伸或压缩以完全填充显示区域,此模式下画面宽高比可能会被改变,导致渲染画面变形|
152
158
 
153
159
  ## TRTCVideoRotation
154
160
 
155
- #### 视频画面旋转方向。
161
+ **视频画面旋转方向。**
156
162
 
157
163
  TRTC 提供了对本地和远程画面的旋转角度设置 API,下列的旋转角度都是指顺时针方向的。
158
- | 枚举 | 取值 | 描述 |
159
- | --- | --- | --- |
160
- | TRTC_VIDEO_ROTATION_0 | 0 | 不旋转。 |
161
- | TRTC_VIDEO_ROTATION_90 | 1 | 顺时针旋转90度。 |
162
- | TRTC_VIDEO_ROTATION_180 | 2 | 顺时针旋转180度。 |
163
- | TRTC_VIDEO_ROTATION_270 | 3 | 顺时针旋转270度。 |
164
+
165
+ |枚举|取值|描述|
166
+ |---------|---------|---------|
167
+ |TRTC_VIDEO_ROTATION_0|0|不旋转。|
168
+ |TRTC_VIDEO_ROTATION_90|1|顺时针旋转90度。|
169
+ |TRTC_VIDEO_ROTATION_180|2|顺时针旋转180度。|
170
+ |TRTC_VIDEO_ROTATION_270|3|顺时针旋转270度。|
164
171
 
165
172
  ## TRTCBeautyStyle
166
173
 
167
- #### 美颜(磨皮)算法。
174
+ **美颜(磨皮)算法。**
168
175
 
169
176
  TRTC 内置多种不同的磨皮算法,您可以选择最适合您产品定位的方案。
170
- | 枚举 | 取值 | 描述 |
171
- | --- | --- | --- |
172
- | TRTC_BEAUTY_STYLE_SMOOTH | 0 | 光滑,算法比较激进,磨皮效果比较明显,适用于秀场直播。 |
173
- | TRTC_BEAUTY_STYLE_NATURE | 1 | 自然,算法更多地保留了面部细节,磨皮效果更加自然,适用于绝大多数直播场景。 |
174
- | TRTC_BEAUTY_STYLE_PITU | 2 | 优图,由优图实验室提供,磨皮效果介于光滑和自然之间,比光滑保留更多皮肤细节,比自然磨皮程度更高。 |
177
+
178
+ |枚举|取值|描述|
179
+ |---------|---------|---------|
180
+ |TRTC_BEAUTY_STYLE_SMOOTH|0|光滑,算法比较激进,磨皮效果比较明显,适用于秀场直播。|
181
+ |TRTC_BEAUTY_STYLE_NATURE|1|自然,算法更多地保留了面部细节,磨皮效果更加自然,适用于绝大多数直播场景。|
182
+ |TRTC_BEAUTY_STYLE_PITU|2|优图,由优图实验室提供,磨皮效果介于光滑和自然之间,比光滑保留更多皮肤细节,比自然磨皮程度更高。|
175
183
 
176
184
  ## TRTCVideoPixelFormat
177
185
 
178
- #### 视频像素格式。
186
+ **视频像素格式。**
179
187
 
180
188
  TRTC 提供针对视频的自定义采集和自定义渲染功能:
181
189
  - 在自定义采集功能中,您可以用下列枚举值描述您采集的视频像素格式。
182
190
 
183
191
  - 在自定义渲染功能中,您可以指定您期望 SDK 回调出的视频像素格式。
184
192
 
185
- | 枚举 | 取值 | 描述 |
186
- | --- | --- | --- |
187
- | TRTC_VIDEO_PIXEL_FORMAT_UNKNOWN | 0 | 未定义的格式。 |
188
- | TRTC_VIDEO_PIXEL_FORMAT_I420 | 1 | YUV420P(I420) 格式。 |
189
- | TRTC_VIDEO_PIXEL_FORMAT_Texture_2D | 2 | OpenGL 2D 纹理格式。 |
190
- | TRTC_VIDEO_PIXEL_FORMAT_TEXTURE_EXTERNAL_OES | 3 | OES 外部纹理格式(适用于 Android 平台)。 |
191
- | TRTC_VIDEO_PIXEL_FORMAT_NV21 | 4 | NV21 格式。 |
192
- | TRTC_VIDEO_PIXEL_FORMAT_RGBA | 5 | RGBA 格式。 |
193
+ |枚举|取值|描述|
194
+ |---------|---------|---------|
195
+ |TRTC_VIDEO_PIXEL_FORMAT_UNKNOWN|0|未定义的格式。|
196
+ |TRTC_VIDEO_PIXEL_FORMAT_I420|1|YUV420P(I420) 格式。|
197
+ |TRTC_VIDEO_PIXEL_FORMAT_Texture_2D|2|OpenGL 2D 纹理格式。|
198
+ |TRTC_VIDEO_PIXEL_FORMAT_TEXTURE_EXTERNAL_OES|3|OES 外部纹理格式(适用于 Android 平台)。|
199
+ |TRTC_VIDEO_PIXEL_FORMAT_NV21|4|NV21 格式。|
200
+ |TRTC_VIDEO_PIXEL_FORMAT_RGBA|5|RGBA 格式。|
193
201
 
194
202
  ## TRTCVideoBufferType
195
203
 
196
- #### 视频数据传递方式。
204
+ **视频数据传递方式。**
197
205
 
198
206
  在自定义采集和自定义渲染功能,您需要用到下列枚举值来指定您希望以什么方式传递视频数据:
199
207
  - 方案一:使用内存 Buffer 传递视频数据,该方案在 iOS 效率尚可,但在 Android 系统上效率较差,Windows 暂时仅支持内存 Buffer 的传递方式。
@@ -203,24 +211,25 @@ TRTC 提供针对视频的自定义采集和自定义渲染功能:
203
211
  | 枚举 | 取值 | 描述 |
204
212
  | --- | --- | --- |
205
213
  | TRTC_VIDEO_BUFFER_TYPE_UNKNOWN | 0 | 未定义的传递方式。 |
206
- | TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER | 1 | 使用内存 Buffer 传递视频数据,iOS:PixelBuffer;Android:用于 JNI 层的 Direct Buffer;Win:内存数据块。 |
214
+ | TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER | 1 | 使用内存 Buffer 传递视频数据,iOS:内存数据块;Android:用于 JNI 层的 Direct Buffer;Win:内存数据块。 |
207
215
  | TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY | 2 | 使用内存 Buffer 传递视频数据,iOS:经过一次额外整理后更加紧凑的 NSData 类型的内存块;Android:用于 JAVA 层的 byte[]。<br>该传递的方式的性能是几种方案中效率较差的一种。 |
208
216
  | TRTC_VIDEO_BUFFER_TYPE_TEXTURE | 3 | 使用 OpengGL 纹理传递视频数据。 |
209
217
 
210
218
  ## TRTCVideoMirrorType
211
219
 
212
- #### 视频的镜像类型。
220
+ **视频的镜像类型。**
213
221
 
214
222
  视频的镜像是指对视频内容进行左右翻转,尤其是对本地的摄像头预览视频,开启镜像后能给主播带来熟悉的“照镜子”体验。
215
- | 枚举 | 取值 | 描述 |
216
- | --- | --- | --- |
217
- | TRTC_VIDEO_MIRROR_TYPE_AUTO | 0 | 自动模式:如果正使用前置摄像头则开启镜像,如果是后置摄像头则不开启镜像(仅适用于移动设备)。 |
218
- | TRTC_VIDEO_MIRROR_TYPE_ENABLE | 1 | 强制开启镜像,不论当前使用的是前置摄像头还是后置摄像头。 |
219
- | TRTC_VIDEO_MIRROR_TYPE_DISABLE | 2 | 强制关闭镜像,不论当前使用的是前置摄像头还是后置摄像头。 |
223
+
224
+ |枚举|取值|描述|
225
+ |---------|---------|---------|
226
+ |TRTC_VIDEO_MIRROR_TYPE_AUTO|0|自动模式:如果正使用前置摄像头则开启镜像,如果是后置摄像头则不开启镜像(仅适用于移动设备)。|
227
+ |TRTC_VIDEO_MIRROR_TYPE_ENABLE|1|强制开启镜像,不论当前使用的是前置摄像头还是后置摄像头。|
228
+ |TRTC_VIDEO_MIRROR_TYPE_DISABLE|2|强制关闭镜像,不论当前使用的是前置摄像头还是后置摄像头。|
220
229
 
221
230
  ## TRTCSnapshotSourceType
222
231
 
223
- #### 本地视频截图的数据源。
232
+ **本地视频截图的数据源。**
224
233
 
225
234
  SDK 支持从如下两种数据源中截取图片并保存成本地文件:
226
235
  - 视频流:从视频流中截取原生的视频内容,截取的内容不受渲染控件的显示控制。
@@ -229,15 +238,15 @@ SDK 支持从如下两种数据源中截取图片并保存成本地文件:
229
238
 
230
239
  - 采集层:从采集控件中截取采集到的视频内容,可以截取采集出来的高清截图。
231
240
 
232
- | 枚举 | 取值 | 描述 |
233
- | --- | --- | --- |
234
- | TRTC_SNAPSHOT_SOURCE_TYPE_STREAM | 0 | 从视频流中截取原生的视频内容,截取的内容不受渲染控件的显示控制。 |
235
- | TRTC_SNAPSHOT_SOURCE_TYPE_VIEW | 1 | 从渲染控件中截取显示的视频内容,可以做到用户所见即所得的效果,但如果显示区域过小,截取出的图片也会很小。 |
236
- | TRTC_SNAPSHOT_SOURCE_TYPE_CAPTURE | 2 | 从采集控件中截取采集到的视频内容,可以截取采集出来的高清截图。 |
241
+ |枚举|取值|描述|
242
+ |---------|---------|---------|
243
+ |TRTC_SNAPSHOT_SOURCE_TYPE_STREAM|0|从视频流中截取原生的视频内容,截取的内容不受渲染控件的显示控制。|
244
+ |TRTC_SNAPSHOT_SOURCE_TYPE_VIEW|1|从渲染控件中截取显示的视频内容,可以做到用户所见即所得的效果,但如果显示区域过小,截取出的图片也会很小。|
245
+ |TRTC_SNAPSHOT_SOURCE_TYPE_CAPTURE|2|从采集控件中截取采集到的视频内容,可以截取采集出来的高清截图。|
237
246
 
238
247
  ## TRTCAppScene
239
248
 
240
- #### 应用场景。
249
+ **应用场景。**
241
250
 
242
251
  TRTC 针对常见的音视频应用场景都进行了定向优化,以满足各种垂直场景下的差异化要求,主要场景可以分为如下两类:
243
252
  - 直播(LIVE)场景:包括 LIVE 和 VoiceChatRoom,前者是音频+视频,后者是纯音频。
@@ -249,98 +258,104 @@ TRTC 针对常见的音视频应用场景都进行了定向优化,以满足各
249
258
  | 枚举 | 取值 | 描述 |
250
259
  | --- | --- | --- |
251
260
  | TRTC_APP_SCENE_VIDEOCALL | 0 | 视频通话场景,支持720P、1080P高清画质,单个房间最多支持300人同时在线,最高支持50人同时发言。<br>适用于[1对1视频通话]、[300人视频会议]、[在线问诊]、[教育小班课]、[远程面试]等业务场景。 |
252
- | TRTC_APP_SCENE_LIVE | 1 | 视频互动直播,支持平滑上下麦,切换过程无需等待,主播延时小于300ms;支持十万级别观众同时播放,播放延时低至1000ms。<br>适用于[低延时互动直播]、[大班课]、[主播PK]、[视频相亲]、[在线互动课堂]、[远程培训]、[超大型会议]等业务场景。<br>**注意**<br>此场景下,您必须通过 TRTCParams 中的 role 字段指定当前用户的角色。 |
261
+ | TRTC_APP_SCENE_LIVE | 1 | 视频互动直播,支持平滑上下麦,切换过程无需等待,主播延时小于300ms;支持十万级别观众同时播放,播放延时低至1000ms。<br>适用于[低延时互动直播]、[大班课]、[主播PK]、[视频相亲]、[在线互动课堂]、[远程培训]、[超大型会议]等业务场景。<br><strong>注意</strong><br>此场景下,您必须通过 TRTCParams 中的 role 字段指定当前用户的角色。 |
253
262
  | TRTC_APP_SCENE_AUDIOCALL | 2 | 语音通话场景,默认采用 SPEECH 音质,单个房间最多支持300人同时在线,最高支持50人同时发言。<br>适用于 [1对1语音通话]、[300人语音会议]、[语音聊天]、[语音会议]、[在线狼人杀] 等业务场景。 |
254
- | TRTC_APP_SCENE_VOICE_CHATROOM | 3 | 语音互动直播,支持平滑上下麦,切换过程无需等待,主播延时小于 300ms;支持十万级别观众同时播放,播放延时低至 1000ms。<br>适用于 [语音俱乐部]、[在线K歌房]、[音乐直播间]、[FM电台] 等业务场景。<br>**注意**<br>此场景下,您必须通过 TRTCParams 中的 role 字段指定当前用户的角色。 |
263
+ | TRTC_APP_SCENE_VOICE_CHATROOM | 3 | 语音互动直播,支持平滑上下麦,切换过程无需等待,主播延时小于 300ms;支持十万级别观众同时播放,播放延时低至 1000ms。<br>适用于 [语音俱乐部]、[在线K歌房]、[音乐直播间]、[FM电台] 等业务场景。<br><strong>注意</strong><br>此场景下,您必须通过 TRTCParams 中的 role 字段指定当前用户的角色。 |
255
264
 
256
265
  ## TRTCRoleType
257
266
 
258
- #### 角色。
267
+ **角色。**
259
268
 
260
269
  仅适用于直播类场景(即 TRTC_APP_SCENE_LIVE 和 TRTC_APP_SCENE_VOICE_CHATROOM),把用户区分成两种不同的身份:
261
270
  - 主播:可以随时发布自己的音视频流,但人数有限制,同一个房间中最多只允许 50 个主播同时发布自己的音视频流。
262
271
 
263
272
  - 观众:只能观看其他用户的音视频流,要发布音视频流,需要先通过 switchRole 切换成主播,同一个房间中最多能容纳10万观众。
264
273
 
265
- | 枚举 | 取值 | 描述 |
266
- | --- | --- | --- |
267
- | TRTCRoleAnchor | 20 | 主播:可以随时发布自己的音视频流,但人数有限制,同一个房间中最多只允许 50 个主播同时发布自己的音视频流。 |
268
- | TRTCRoleAudience | 21 | 观众:只能观看其他用户的音视频流,要发布音视频流,需要先通过 switchRole 切换成主播,同一个房间中最多能容纳10万观众。 |
274
+ |枚举|取值|描述|
275
+ |---------|---------|---------|
276
+ |TRTCRoleAnchor|20|主播:可以随时发布自己的音视频流,但人数有限制,同一个房间中最多只允许 50 个主播同时发布自己的音视频流。|
277
+ |TRTCRoleAudience|21|观众:只能观看其他用户的音视频流,要发布音视频流,需要先通过 switchRole 切换成主播,同一个房间中最多能容纳10万观众。|
269
278
 
270
279
  ## TRTCQosControlMode(Deprecated)
271
280
 
272
- #### 流控模式(已废弃)。
273
- | 枚举 | 取值 | 描述 |
274
- | --- | --- | --- |
275
- | VIDEO_QOS_CONTROL_CLIENT | 0 | 本地控制,用于 SDK 开发内部调试,客户请勿使用。 |
276
- | VIDEO_QOS_CONTROL_SERVER | 1 | 云端控制,默认模式,推荐选择。 |
281
+ **流控模式(已废弃)。**
282
+
283
+ |枚举|取值|描述|
284
+ |---------|---------|---------|
285
+ |VIDEO_QOS_CONTROL_CLIENT|0|本地控制,用于 SDK 开发内部调试,客户请勿使用。|
286
+ |VIDEO_QOS_CONTROL_SERVER|1|云端控制,默认模式,推荐选择。|
277
287
 
278
288
  ## TRTCVideoQosPreference
279
289
 
280
- #### 画质偏好。
290
+ **画质偏好。**
281
291
 
282
292
  TRTC 在弱网络环境下有两种调控模式:“优先保证画面清晰”或“优先保证画面流畅”,两种模式均会优先保障声音数据的传输。
283
- | 枚举 | 取值 | 描述 |
284
- | --- | --- | --- |
285
- | TRTC_VIDEO_QOS_PREFERENCE_SMOOTH | 1 | 流畅优先:即当前网络不足以传输既清晰又流畅的画面时,优先保证画面的流畅性,代价就是画面会比较模糊且伴随有较多的马赛克。 |
286
- | TRTC_VIDEO_QOS_PREFERENCE_CLEAR | 2 | 清晰优先(默认值):即当前网络不足以传输既清晰又流畅的画面时,优先保证画面的清晰度,代价就是画面会比较卡顿。 |
293
+
294
+ |枚举|取值|描述|
295
+ |---------|---------|---------|
296
+ |TRTC_VIDEO_QOS_PREFERENCE_SMOOTH|1|流畅优先:即当前网络不足以传输既清晰又流畅的画面时,优先保证画面的流畅性,代价就是画面会比较模糊且伴随有较多的马赛克。|
297
+ |TRTC_VIDEO_QOS_PREFERENCE_CLEAR|2|清晰优先(默认值):即当前网络不足以传输既清晰又流畅的画面时,优先保证画面的清晰度,代价就是画面会比较卡顿。|
287
298
 
288
299
  ## TRTCQuality
289
300
 
290
- #### 网络质量。
301
+ **网络质量。**
291
302
 
292
303
  TRTC 会每隔两秒对当前的网络质量进行评估,评估结果为六个等级:Excellent 表示最好,Down 表示最差。
293
- | 枚举 | 取值 | 描述 |
294
- | --- | --- | --- |
295
- | TRTC_QUALITY_UNKNOWN | 0 | 未定义。 |
296
- | TRTC_QUALITY_Excellent | 1 | 当前网络非常好。 |
297
- | TRTC_QUALITY_Good | 2 | 当前网络比较好。 |
298
- | TRTC_QUALITY_Poor | 3 | 当前网络一般。 |
299
- | TRTC_QUALITY_Bad | 4 | 当前网络较差。 |
300
- | TRTC_QUALITY_Vbad | 5 | 当前网络很差。 |
301
- | TRTC_QUALITY_Down | 6 | 当前网络不满足 TRTC 的最低要求。 |
304
+
305
+ |枚举|取值|描述|
306
+ |---------|---------|---------|
307
+ |TRTC_QUALITY_UNKNOWN|0|未定义。|
308
+ |TRTC_QUALITY_Excellent|1|当前网络非常好。|
309
+ |TRTC_QUALITY_Good|2|当前网络比较好。|
310
+ |TRTC_QUALITY_Poor|3|当前网络一般。|
311
+ |TRTC_QUALITY_Bad|4|当前网络较差。|
312
+ |TRTC_QUALITY_Vbad|5|当前网络很差。|
313
+ |TRTC_QUALITY_Down|6|当前网络不满足 TRTC 的最低要求。|
302
314
 
303
315
  ## TRTCAVStatusType
304
316
 
305
- #### 音视频状态类型。
317
+ **音视频状态类型。**
306
318
 
307
319
  该枚举类型用于音频状态变化回调接口(onRemoteAudioStatusUpdated)与视频状态变化回调接口(onRemoteVideoStatusUpdated),用于指定当前的音频或视频状态。
308
- | 枚举 | 取值 | 描述 |
309
- | --- | --- | --- |
310
- | TRTCAVStatusStopped | 0 | 停止播放。 |
311
- | TRTCAVStatusPlaying | 1 | 正在播放。 |
312
- | TRTCAVStatusLoading | 2 | 正在加载。 |
320
+
321
+ |枚举|取值|描述|
322
+ |---------|---------|---------|
323
+ |TRTCAVStatusStopped|0|停止播放。|
324
+ |TRTCAVStatusPlaying|1|正在播放。|
325
+ |TRTCAVStatusLoading|2|正在加载。|
313
326
 
314
327
  ## TRTCAVStatusChangeReason
315
328
 
316
- #### 音视频状态变化原因类型。
329
+ **音视频状态变化原因类型。**
317
330
 
318
331
  该枚举类型用于音频状态变化回调接口(onRemoteAudioStatusUpdated)与视频状态变化回调接口(onRemoteVideoStatusUpdated),用于指定当前的音频或视频状态变化原因。
319
- | 枚举 | 取值 | 描述 |
320
- | --- | --- | --- |
321
- | TRTCAVStatusChangeReasonInternal | 0 | 缺省值。 |
322
- | TRTCAVStatusChangeReasonBufferingBegin | 1 | 网络缓冲。 |
323
- | TRTCAVStatusChangeReasonBufferingEnd | 2 | 结束缓冲。 |
324
- | TRTCAVStatusChangeReasonLocalStarted | 3 | 本地启动音频或视频流播放。 |
325
- | TRTCAVStatusChangeReasonLocalStopped | 4 | 本地停止音频或视频流播放。 |
326
- | TRTCAVStatusChangeReasonRemoteStarted | 5 | 远端音频或视频流开始(或继续)。 |
327
- | TRTCAVStatusChangeReasonRemoteStopped | 6 | 远端音频或视频流停止(或中断)。 |
332
+
333
+ |枚举|取值|描述|
334
+ |---------|---------|---------|
335
+ |TRTCAVStatusChangeReasonInternal|0|缺省值。|
336
+ |TRTCAVStatusChangeReasonBufferingBegin|1|网络缓冲。|
337
+ |TRTCAVStatusChangeReasonBufferingEnd|2|结束缓冲。|
338
+ |TRTCAVStatusChangeReasonLocalStarted|3|本地启动音频或视频流播放。|
339
+ |TRTCAVStatusChangeReasonLocalStopped|4|本地停止音频或视频流播放。|
340
+ |TRTCAVStatusChangeReasonRemoteStarted|5|远端音频或视频流开始(或继续)。|
341
+ |TRTCAVStatusChangeReasonRemoteStopped|6|远端音频或视频流停止(或中断)。|
328
342
 
329
343
  ## TRTCAudioSampleRate
330
344
 
331
- #### 音频采样率。
345
+ **音频采样率。**
332
346
 
333
347
  音频采样率用来衡量声音的保真程度,采样率越高保真程度越好,如果您的应用场景有音乐的存在,推荐使用 ` TRTCAudioSampleRate48000 `。
334
- | 枚举 | 取值 | 描述 |
335
- | --- | --- | --- |
336
- | TRTCAudioSampleRate16000 | 16000 | 16k 采样率。 |
337
- | TRTCAudioSampleRate32000 | 32000 | 32k 采样率。 |
338
- | TRTCAudioSampleRate44100 | 44100 | 44.1k 采样率。 |
339
- | TRTCAudioSampleRate48000 | 48000 | 48k采样率 |
348
+
349
+ |枚举|取值|描述|
350
+ |---------|---------|---------|
351
+ |TRTCAudioSampleRate16000|16000|16k 采样率。|
352
+ |TRTCAudioSampleRate32000|32000|32k 采样率。|
353
+ |TRTCAudioSampleRate44100|44100|44.1k 采样率。|
354
+ |TRTCAudioSampleRate48000|48000|48k采样率|
340
355
 
341
356
  ## TRTCAudioQuality
342
357
 
343
- #### 声音音质。
358
+ **声音音质。**
344
359
 
345
360
  TRTC 提供了三种精心校调好的模式,用来满足各种垂直场景下对音质的差异化追求:
346
361
  - 人声模式(Speech):适用于以人声沟通为主的应用场景,该模式下音频传输的抗性较强,TRTC 会通过各种人声处理技术保障在弱网络环境下的流畅度最佳。
@@ -349,15 +364,15 @@ TRTC 提供了三种精心校调好的模式,用来满足各种垂直场景下
349
364
 
350
365
  - 默认模式(Default):介于 Speech 和 Music 之间的档位,对音乐的还原度比人声模式要好,但传输数据量比音乐模式要低很多,对各种场景均有不错的适应性。
351
366
 
352
- | 枚举 | 取值 | 描述 |
353
- | --- | --- | --- |
354
- | TRTC_AUDIO_QUALITY_SPEECH | 1 | 人声模式:单声道;编码码率:18kbps;具备几个模式中最强的网络抗性,适合语音通话为主的场景,例如在线会议,语音通话等。 |
355
- | TRTC_AUDIO_QUALITY_DEFAULT | 2 | 默认模式:单声道;编码码率:50kbps;介于 Speech 和 Music 之间的档位,SDK 默认档位,推荐选择。 |
356
- | TRTC_AUDIO_QUALITY_MUSIC | 3 | 音乐模式:全频带立体声;编码码率:128kbps;适合需要高保真传输音乐的场景,例如在线K歌、音乐直播等。 |
367
+ |枚举|取值|描述|
368
+ |---------|---------|---------|
369
+ |TRTC_AUDIO_QUALITY_SPEECH|1|人声模式:单声道;编码码率:18kbps;具备几个模式中最强的网络抗性,适合语音通话为主的场景,例如在线会议,语音通话等。|
370
+ |TRTC_AUDIO_QUALITY_DEFAULT|2|默认模式:单声道;编码码率:50kbps;介于 Speech 和 Music 之间的档位,SDK 默认档位,推荐选择。|
371
+ |TRTC_AUDIO_QUALITY_MUSIC|3|音乐模式:全频带立体声;编码码率:128kbps;适合需要高保真传输音乐的场景,例如在线K歌、音乐直播等。|
357
372
 
358
373
  ## TRTCAudioRoute
359
374
 
360
- #### 音频路由(即声音的播放模式)。
375
+ **音频路由(即声音的播放模式)。**
361
376
 
362
377
  音频路由,即声音是从手机的扬声器还是从听筒中播放出来,因此该接口仅适用于手机等移动端设备。
363
378
 
@@ -372,54 +387,56 @@ TRTC 提供了三种精心校调好的模式,用来满足各种垂直场景下
372
387
 
373
388
  - 音频路由为USB专业声卡设备。
374
389
 
375
- | 枚举 | 取值 | 描述 |
376
- | --- | --- | --- |
377
- | TRTC_AUDIO_ROUTE_UNKNOWN | -1 | Unknown:默认的路由设备。 |
378
- | TRTC_AUDIO_ROUTE_SPEAKER | 0 | Speakerphone:使用扬声器播放(即“免提”),扬声器位于手机底部,声音偏大,适合外放音乐。 |
379
- | TRTC_AUDIO_ROUTE_EARPIECE | 1 | Earpiece:使用听筒播放,听筒位于手机顶部,声音偏小,适合需要保护隐私的通话场景。 |
380
- | TRTC_AUDIO_ROUTE_WIRED_HEADSET | 2 | WiredHeadset:使用有线耳机播放。 |
381
- | TRTC_AUDIO_ROUTE_BLUETOOTH_HEADSET | 3 | BluetoothHeadset:使用蓝牙耳机播放。 |
382
- | TRTC_AUDIO_ROUTE_SOUND_CARD | 4 | SoundCard:使用 USB 声卡播放。 |
390
+ |枚举|取值|描述|
391
+ |---------|---------|---------|
392
+ |TRTC_AUDIO_ROUTE_UNKNOWN|-1|Unknown:默认的路由设备。|
393
+ |TRTC_AUDIO_ROUTE_SPEAKER|0|Speakerphone:使用扬声器播放(即“免提”),扬声器位于手机底部,声音偏大,适合外放音乐。|
394
+ |TRTC_AUDIO_ROUTE_EARPIECE|1|Earpiece:使用听筒播放,听筒位于手机顶部,声音偏小,适合需要保护隐私的通话场景。|
395
+ |TRTC_AUDIO_ROUTE_WIRED_HEADSET|2|WiredHeadset:使用有线耳机播放。|
396
+ |TRTC_AUDIO_ROUTE_BLUETOOTH_HEADSET|3|BluetoothHeadset:使用蓝牙耳机播放。|
397
+ |TRTC_AUDIO_ROUTE_SOUND_CARD|4|SoundCard:使用 USB 声卡播放。|
383
398
 
384
399
  ## TRTCReverbType
385
400
 
386
- #### 声音混响模式。
401
+ **声音混响模式。**
387
402
 
388
403
  该枚举值应用于设定直播场景中的混响模式,常用于秀场直播中。
389
- | 枚举 | 取值 | 描述 |
390
- | --- | --- | --- |
391
- | TRTC_REVERB_TYPE_0 | 0 | 关闭混响。 |
392
- | TRTC_REVERB_TYPE_1 | 1 | KTV。 |
393
- | TRTC_REVERB_TYPE_2 | 2 | 小房间。 |
394
- | TRTC_REVERB_TYPE_3 | 3 | 大会堂。 |
395
- | TRTC_REVERB_TYPE_4 | 4 | 低沉。 |
396
- | TRTC_REVERB_TYPE_5 | 5 | 洪亮。 |
397
- | TRTC_REVERB_TYPE_6 | 6 | 金属声。 |
398
- | TRTC_REVERB_TYPE_7 | 7 | 磁性。 |
404
+
405
+ |枚举|取值|描述|
406
+ |---------|---------|---------|
407
+ |TRTC_REVERB_TYPE_0|0|关闭混响。|
408
+ |TRTC_REVERB_TYPE_1|1|KTV。|
409
+ |TRTC_REVERB_TYPE_2|2|小房间。|
410
+ |TRTC_REVERB_TYPE_3|3|大会堂。|
411
+ |TRTC_REVERB_TYPE_4|4|低沉。|
412
+ |TRTC_REVERB_TYPE_5|5|洪亮。|
413
+ |TRTC_REVERB_TYPE_6|6|金属声。|
414
+ |TRTC_REVERB_TYPE_7|7|磁性。|
399
415
 
400
416
  ## TRTCVoiceChangerType
401
417
 
402
- #### 变声类型。
418
+ **变声类型。**
403
419
 
404
420
  该枚举值应用于设定直播场景中的变声模式,常用于秀场直播中。
405
- | 枚举 | 取值 | 描述 |
406
- | --- | --- | --- |
407
- | TRTC_VOICE_CHANGER_TYPE_0 | 0 | 关闭变声。 |
408
- | TRTC_VOICE_CHANGER_TYPE_1 | 1 | 熊孩子。 |
409
- | TRTC_VOICE_CHANGER_TYPE_2 | 2 | 萝莉。 |
410
- | TRTC_VOICE_CHANGER_TYPE_3 | 3 | 大叔。 |
411
- | TRTC_VOICE_CHANGER_TYPE_4 | 4 | 重金属。 |
412
- | TRTC_VOICE_CHANGER_TYPE_5 | 5 | 感冒。 |
413
- | TRTC_VOICE_CHANGER_TYPE_6 | 6 | 外国人。 |
414
- | TRTC_VOICE_CHANGER_TYPE_7 | 7 | 困兽。 |
415
- | TRTC_VOICE_CHANGER_TYPE_8 | 8 | 死肥仔。 |
416
- | TRTC_VOICE_CHANGER_TYPE_9 | 9 | 强电流。 |
417
- | TRTC_VOICE_CHANGER_TYPE_10 | 10 | 重机械。 |
418
- | TRTC_VOICE_CHANGER_TYPE_11 | 11 | 空灵。 |
421
+
422
+ |枚举|取值|描述|
423
+ |---------|---------|---------|
424
+ |TRTC_VOICE_CHANGER_TYPE_0|0|关闭变声。|
425
+ |TRTC_VOICE_CHANGER_TYPE_1|1|熊孩子。|
426
+ |TRTC_VOICE_CHANGER_TYPE_2|2|萝莉。|
427
+ |TRTC_VOICE_CHANGER_TYPE_3|3|大叔。|
428
+ |TRTC_VOICE_CHANGER_TYPE_4|4|重金属。|
429
+ |TRTC_VOICE_CHANGER_TYPE_5|5|感冒。|
430
+ |TRTC_VOICE_CHANGER_TYPE_6|6|外国人。|
431
+ |TRTC_VOICE_CHANGER_TYPE_7|7|困兽。|
432
+ |TRTC_VOICE_CHANGER_TYPE_8|8|死肥仔。|
433
+ |TRTC_VOICE_CHANGER_TYPE_9|9|强电流。|
434
+ |TRTC_VOICE_CHANGER_TYPE_10|10|重机械。|
435
+ |TRTC_VOICE_CHANGER_TYPE_11|11|空灵。|
419
436
 
420
437
  ## TRTCSystemVolumeType
421
438
 
422
- #### 系统音量类型(仅适用于移动设备)。
439
+ **系统音量类型(仅适用于移动设备)。**
423
440
 
424
441
  现代智能手机中一般都具备两套系统音量类型,即“通话音量”和“媒体音量”。
425
442
  - 通话音量:手机专门为接打电话所设计的音量类型,自带回声抵消(AEC)功能,并且支持通过蓝牙耳机上的麦克风进行拾音,缺点是音质比较一般。当您通过手机侧面的音量按键下调手机音量时,如果无法将其调至零(也就是无法彻底静音),说明您的手机当前处于通话音量。
@@ -435,119 +452,126 @@ SDK 目前提供了三种系统音量类型的控制模式:自动切换模式
435
452
 
436
453
  ## TRTCAudioFrameFormat
437
454
 
438
- #### 音频帧的内容格式。
439
- | 枚举 | 取值 | 描述 |
440
- | --- | --- | --- |
441
- | TRTC_AUDIO_FRAME_FORMAT_PCM | 1 | PCM 格式的音频数据。 |
455
+ **音频帧的内容格式。**
456
+
457
+ |枚举|取值|描述|
458
+ |---------|---------|---------|
459
+ |TRTC_AUDIO_FRAME_FORMAT_PCM|1|PCM 格式的音频数据。|
442
460
 
443
461
  ## TRTCAudioCapabilityType
444
462
 
445
- #### 系统支持的音频能力类型(仅适用于Android设备)。
463
+ **系统支持的音频能力类型(仅适用于Android设备)。**
446
464
 
447
465
  SDK 目前提供了两种系统音频能力类型是否支持的查询:低延时合唱能力、低延时耳返能力。
448
- | 枚举 | 取值 | 描述 |
449
- | --- | --- | --- |
450
- | TRTCAudioCapabilityLowLatencyChorus | 1 | 低延时合唱能力。 |
451
- | TRTCAudioCapabilityLowLatencyEarMonitor | 2 | 低延时耳返能力。 |
466
+
467
+ |枚举|取值|描述|
468
+ |---------|---------|---------|
469
+ |TRTCAudioCapabilityLowLatencyChorus|1|低延时合唱能力。|
470
+ |TRTCAudioCapabilityLowLatencyEarMonitor|2|低延时耳返能力。|
452
471
 
453
472
  ## TRTCAudioFrameOperationMode
454
473
 
455
- #### 音频回调数据读写模式。
474
+ **音频回调数据读写模式。**
456
475
 
457
476
  TRTC 提供了两种音频回调数据的操作模式。
458
477
  - 读写模式(ReadWrite):可以获取并修改回调的音频数据,默认模式。
459
478
 
460
479
  - 只读模式(ReadOnly):仅从回调中获取音频数据。
461
480
 
462
- | 枚举 | 取值 | 描述 |
463
- | --- | --- | --- |
464
- | TRTC_AUDIO_FRAME_OPERATION_MODE_READWRITE | 0 | 读写模式:可以获取并修改回调的音频数据。 |
465
- | TRTC_AUDIO_FRAME_OPERATION_MODE_READONLY | 1 | 只读模式:仅从回调中获取音频数据。 |
481
+ |枚举|取值|描述|
482
+ |---------|---------|---------|
483
+ |TRTC_AUDIO_FRAME_OPERATION_MODE_READWRITE|0|读写模式:可以获取并修改回调的音频数据。|
484
+ |TRTC_AUDIO_FRAME_OPERATION_MODE_READONLY|1|只读模式:仅从回调中获取音频数据。|
466
485
 
467
486
  ## TRTCLogLevel
468
487
 
469
- #### Log 级别。
488
+ **Log 级别。**
470
489
 
471
490
  不同的日志等级定义了不同的详实程度和日志数量,推荐一般情况下将日志等级设置为:TRTCLogLevelInfo。
472
- | 枚举 | 取值 | 描述 |
473
- | --- | --- | --- |
474
- | TRTC_LOG_LEVEL_VERBOSE | 0 | 输出所有级别的 Log。 |
475
- | TRTC_LOG_LEVEL_DEBUG | 1 | 输出 DEBUG,INFO,WARNING,ERROR 和 FATAL 级别的 Log。 |
476
- | TRTC_LOG_LEVEL_INFO | 2 | 输出 INFO,WARNING,ERROR 和 FATAL 级别的 Log。 |
477
- | TRTC_LOG_LEVEL_WARN | 3 | 输出WARNING,ERROR 和 FATAL 级别的 Log。 |
478
- | TRTC_LOG_LEVEL_ERROR | 4 | 输出ERROR 和 FATAL 级别的 Log。 |
479
- | TRTC_LOG_LEVEL_FATAL | 5 | 仅输出 FATAL 级别的 Log。 |
480
- | TRTC_LOG_LEVEL_NULL | 6 | 不输出任何 SDK Log。 |
491
+
492
+ |枚举|取值|描述|
493
+ |---------|---------|---------|
494
+ |TRTC_LOG_LEVEL_VERBOSE|0|输出所有级别的 Log。|
495
+ |TRTC_LOG_LEVEL_DEBUG|1|输出 DEBUG,INFO,WARNING,ERROR 和 FATAL 级别的 Log。|
496
+ |TRTC_LOG_LEVEL_INFO|2|输出 INFO,WARNING,ERROR 和 FATAL 级别的 Log。|
497
+ |TRTC_LOG_LEVEL_WARN|3|输出WARNING,ERROR 和 FATAL 级别的 Log。|
498
+ |TRTC_LOG_LEVEL_ERROR|4|输出ERROR 和 FATAL 级别的 Log。|
499
+ |TRTC_LOG_LEVEL_FATAL|5|仅输出 FATAL 级别的 Log。|
500
+ |TRTC_LOG_LEVEL_NULL|6|不输出任何 SDK Log。|
481
501
 
482
502
  ## TRTCGSensorMode
483
503
 
484
- #### 重力感应开关(仅适用于移动端)。
504
+ **重力感应开关(仅适用于移动端)。**
485
505
 
486
506
  @deprecated 从v11.7版本开始,推荐使用新重力感应枚举 TRTCGravitySensorAdaptiveMode。
487
507
  | 枚举 | 取值 | 描述 |
488
508
  | --- | --- | --- |
489
509
  | TRTC_GSENSOR_MODE_DISABLE | 0 | 不适配重力感应,该模式是桌面平台上的默认值,该模式下,当前用户发布出去的视频画面不受重力感应方向变化的影响。 |
490
- | TRTC_GSENSOR_MODE_UIAUTOLAYOUT | 1 | 适配重力感应,该模式是移动平台上的默认值,该模式下,当前用户发布出去的视频画面会跟随设备的重力感应方向进行相应的调整,同时本地预览画面保持方向不变。<br>SDK 目前支持的一种适配模式是:当手机或 Pad 上下颠倒时,为了保证远端用户看到的画面方向正常,SDK 会自动将发布出去的画面上下旋转180度。如果您的 APP 的界面层开启了重力感应自适应,推荐使用 UIFixLayout 模式。 |
491
- | TRTC_GSENSOR_MODE_UIFIXLAYOUT | 2 | 适配重力感应<br>该模式下,当前用户发布出去的视频画面会跟随设备的重力感应方向进行相应的调整,同时本地预览画面也会进行相应的旋转适配。<br>目前支持的一种特性是:当手机或 Pad 上下颠倒时,为了保证远端用户看到的画面方向正常,SDK 会自动将发布出去的画面上下旋转180度。<br>如果您的 APP 的界面层不支持重力感应自适应,并且希望 SDK 的视频画面能够适配重力感应方向,推荐使用 UIFixLayout 模式。<br>@deprecated 从v11.5版本开始,不再支持 TRTCGSensorMode_UIFixLayout,只支持上面两种模式。 |
510
+ | TRTC_GSENSOR_MODE_UIAUTOLAYOUT | 1 | 适配重力感应,该模式是移动平台上的默认值,该模式下,当前用户发布出去的视频画面会跟随设备的重力感应方向进行相应的调整,同时本地预览画面保持方向不变。<br>SDK 目前支持的一种适配模式是:当手机或 Pad 上下颠倒时,为了保证远端用户看到的画面方向正常,SDK 会自动将发布出去的画面上下旋转180度。如果您的 App 的界面层开启了重力感应自适应,推荐使用 UIFixLayout 模式。 |
511
+ | TRTC_GSENSOR_MODE_UIFIXLAYOUT | 2 | 适配重力感应<br>该模式下,当前用户发布出去的视频画面会跟随设备的重力感应方向进行相应的调整,同时本地预览画面也会进行相应的旋转适配。<br>目前支持的一种特性是:当手机或 Pad 上下颠倒时,为了保证远端用户看到的画面方向正常,SDK 会自动将发布出去的画面上下旋转180度。<br>如果您的 App 的界面层不支持重力感应自适应,并且希望 SDK 的视频画面能够适配重力感应方向,推荐使用 UIFixLayout 模式。<br>@deprecated 从v11.5版本开始,不再支持 TRTCGSensorMode_UIFixLayout,只支持上面两种模式。 |
492
512
 
493
513
  ## TRTCTranscodingConfigMode
494
514
 
495
- #### 云端混流的排版模式。
515
+ **云端混流的排版模式。**
496
516
 
497
517
  TRTC 的云端混流服务能够将房间中的多路音视频流混合成一路,因此您需要指定画面的排版方案,我们提供了如下几种排版模式。
498
518
  | 枚举 | 取值 | 描述 |
499
519
  | --- | --- | --- |
500
520
  | TRTC_TranscodingConfigMode_Unknown | 0 | 未定义。 |
501
- | TRTC_TranscodingConfigMode_Manual | 1 | 全手动排版模式。<br>该模式下,您需要指定每一路画面的精确排版位置。该模式的自由度最高,但易用性也最差:<br>- 您需要填写 TRTCTranscodingConfig 中的所有参数,包括每一路画面(TRTCMixUser)的位置坐标。<br>- 您需要监听 TRTCCloudListener 中的 onUserVideoAvailable 和 onUserAudioAvailable 事件回调,并根据当前房间中各个麦上用户的音视频状态不断地调整 ` mixUsers ` 参数。 |
502
- | TRTC_TranscodingConfigMode_Template_PureAudio | 2 | 纯音频模式。<br>该模式适用于语音通话(AudioCall)和语音聊天室(VoiceChatRoom)等纯音频的应用场景。<br>- 您只需要在进入房间后,通过 setMixTranscodingConfig 接口设置一次,之后 SDK 就会自动把房间内所有上麦用户的声音混流到当前用户的直播流上。<br>- 您无需设置 TRTCTranscodingConfig 中的 ` mixUsers ` 参数,只需设置 ` audioSampleRate `、` audioBitrate ` 和 ` audioChannels ` 等参数即可。 |
521
+ | TRTC_TranscodingConfigMode_Manual | 1 | 全手动排版模式。<br>该模式下,您需要指定每一路画面的精确排版位置。该模式的自由度最高,但易用性也最差:<br>- 您需要填写 TRTCTranscodingConfig 中的所有参数,包括每一路画面(TRTCMixUser)的位置坐标。<br>- 您需要监听 TRTCCloudListener 中的 onUserVideoAvailable 和 onUserAudioAvailable 事件回调,并根据当前房间中各个麦上用户的音视频状态不断地调整 <code> mixUsers </code> 参数。 |
522
+ | TRTC_TranscodingConfigMode_Template_PureAudio | 2 | 纯音频模式。<br>该模式适用于语音通话(AudioCall)和语音聊天室(VoiceChatRoom)等纯音频的应用场景。<br>- 您只需要在进入房间后,通过 setMixTranscodingConfig 接口设置一次,之后 SDK 就会自动把房间内所有上麦用户的声音混流到当前用户的直播流上。<br>- 您无需设置 TRTCTranscodingConfig 中的 <code> mixUsers </code> 参数,只需设置 <code> audioSampleRate </code>、<code> audioBitrate </code> 和 <code> audioChannels </code> 等参数即可。 |
503
523
  | TRTC_TranscodingConfigMode_Template_PresetLayout | 3 | 预排版模式。<br>最受欢迎的排版模式,因为该模式支持您通过占位符提前对各路画面的位置进行设定,之后 SDK 会自动根据房间中画面的路数动态进行适配调整。<br>此模式下,您依然需要设置 mixUsers 参数,但可以将 userId 设置为“占位符”,可选的占位符有:<br>- "$PLACE_HOLDER_REMOTE$" : 指代远程用户的画面,可以设置多个。<br>- "$PLACE_HOLDER_LOCAL_MAIN$" : 指代本地摄像头画面,只允许设置一个。<br>- "$PLACE_HOLDER_LOCAL_SUB$" : 指代本地屏幕分享画面,只允许设置一个。<br>此模式下,您不需要监听 TRTCCloudListener 中的 onUserVideoAvailable 和 onUserAudioAvailable 回调进行实时调整,只需要在进房成功后调用一次 setMixTranscodingConfig 即可,之后 SDK 会自动将真实的 userId 补位到您设置的占位符上。 |
504
- | TRTC_TranscodingConfigMode_Template_ScreenSharing | 4 | 屏幕分享模式。<br>适用于在线教育场景等以屏幕分享为主的应用场景,仅支持 Windows 和 Mac 两个平台的 SDK。<br>该模式下,SDK 会先根据您通过 videoWidth 和 videoHeight 参数设置的目标分辨率构建一张画布,<br>- 当老师未开启屏幕分享时,SDK 会将老师的摄像头画面等比例拉伸绘制到该画布上;<br>- 当老师开启屏幕分享之后,SDK 会将屏幕分享画面绘制到同样的画布上。<br>此种排版模式的目的是为了确保混流模块的输出分辨率一致,避免课程回放和网页观看的花屏问题(网页播放器不支持可变分辨率)。<br>同时,连麦学生的声音也会被默认混合到老师的音视频流中。<br>由于教学模式下的视频内容以屏幕分享为主,因此同时传输摄像头画面和屏幕分享画面是非常浪费带宽的。<br>推荐的做法是直接将摄像头画面通过 setLocalVideoRenderCallback 接口自定义绘制到当前屏幕上。<br>在该模式下,您无需设置 TRTCTranscodingConfig 中的 ` mixUsers ` 参数,SDK 不会混合学生的画面,以免干扰屏幕分享的效果。<br>您可以将 TRTCTranscodingConfig 中的 width x height 设为 0px × 0px,SDK 会自动根据用户当前屏幕的宽高比计算出一个合适的分辨率:<br>- 如果老师当前屏幕宽度 <= 1920px,SDK 会使用老师当前屏幕的实际分辨率。<br>- 如果老师当前屏幕宽度 > 1920px,SDK 会根据当前屏幕宽高比,选择 1920x1080(16:9)、1920x1200(16:10)、1920x1440(4:3) 三种分辨率中的一种。 |
524
+ | TRTC_TranscodingConfigMode_Template_ScreenSharing | 4 | 屏幕分享模式。<br>适用于在线教育场景等以屏幕分享为主的应用场景,仅支持 Windows 和 Mac 两个平台的 SDK。<br>该模式下,SDK 会先根据您通过 videoWidth 和 videoHeight 参数设置的目标分辨率构建一张画布,<br>- 当老师未开启屏幕分享时,SDK 会将老师的摄像头画面等比例拉伸绘制到该画布上;<br>- 当老师开启屏幕分享之后,SDK 会将屏幕分享画面绘制到同样的画布上。<br>此种排版模式的目的是为了确保混流模块的输出分辨率一致,避免课程回放和网页观看的花屏问题(网页播放器不支持可变分辨率)。<br>同时,连麦学生的声音也会被默认混合到老师的音视频流中。<br>由于教学模式下的视频内容以屏幕分享为主,因此同时传输摄像头画面和屏幕分享画面是非常浪费带宽的。<br>推荐的做法是直接将摄像头画面通过 setLocalVideoRenderCallback 接口自定义绘制到当前屏幕上。<br>在该模式下,您无需设置 TRTCTranscodingConfig 中的 <code> mixUsers </code> 参数,SDK 不会混合学生的画面,以免干扰屏幕分享的效果。<br>您可以将 TRTCTranscodingConfig 中的 width x height 设为 0px × 0px,SDK 会自动根据用户当前屏幕的宽高比计算出一个合适的分辨率:<br>- 如果老师当前屏幕宽度 <= 1920px,SDK 会使用老师当前屏幕的实际分辨率。<br>- 如果老师当前屏幕宽度 > 1920px,SDK 会根据当前屏幕宽高比,选择 1920x1080(16:9)、1920x1200(16:10)、1920x1440(4:3) 三种分辨率中的一种。 |
505
525
 
506
526
  ## TRTCRecordType
507
527
 
508
- #### 媒体录制类型。
528
+ **媒体录制类型。**
509
529
 
510
530
  该枚举类型用于本地媒体录制接口 startLocalRecording,用于指定是录制音视频文件还是纯音频文件。
511
- | 枚举 | 取值 | 描述 |
512
- | --- | --- | --- |
513
- | TRTC_RECORD_TYPE_AUDIO | 0 | 仅录制音频。 |
514
- | TRTC_RECORD_TYPE_VIDEO | 1 | 仅录制视频。 |
515
- | TRTC_RECORD_TYPE_BOTH | 2 | 同时录制音频和视频。 |
531
+
532
+ |枚举|取值|描述|
533
+ |---------|---------|---------|
534
+ |TRTC_RECORD_TYPE_AUDIO|0|仅录制音频。|
535
+ |TRTC_RECORD_TYPE_VIDEO|1|仅录制视频。|
536
+ |TRTC_RECORD_TYPE_BOTH|2|同时录制音频和视频。|
516
537
 
517
538
  ## TRTCMixInputType
518
539
 
519
- #### 混流输入类型。
520
- | 枚举 | 取值 | 描述 |
521
- | --- | --- | --- |
522
- | TRTC_MixInputType_Undefined | 0 | 默认值,考虑到针对老版本的兼容性,如果您指定了 inputType 为 Undefined,SDK 会根据另一个参数 pureAudio 的数值决定混流输入类型。 |
523
- | TRTC_MixInputType_AudioVideo | 1 | 混入音频和视频。 |
524
- | TRTC_MixInputType_PureVideo | 2 | 只混入视频。 |
525
- | TRTC_MixInputType_PureAudio | 3 | 只混入音频。 |
526
- | TRTC_MixInputType_Watermark | 4 | 混入水印,此时您无需指定 userId 字段,但需要指定 image 字段,推荐使用 png 格式的图片。 |
540
+ **混流输入类型。**
541
+
542
+ |枚举|取值|描述|
543
+ |---------|---------|---------|
544
+ |TRTC_MixInputType_Undefined|0|默认值,考虑到针对老版本的兼容性,如果您指定了 inputType 为 Undefined,SDK 会根据另一个参数 pureAudio 的数值决定混流输入类型。|
545
+ |TRTC_MixInputType_AudioVideo|1|混入音频和视频。|
546
+ |TRTC_MixInputType_PureVideo|2|只混入视频。|
547
+ |TRTC_MixInputType_PureAudio|3|只混入音频。|
548
+ |TRTC_MixInputType_Watermark|4|混入水印,此时您无需指定 userId 字段,但需要指定 image 字段,推荐使用 png 格式的图片。|
527
549
 
528
550
  ## TRTCDebugViewLevel
529
551
 
530
- #### 用于渲染控件上展示的调试信息。
531
- | 枚举 | 取值 | 描述 |
532
- | --- | --- | --- |
533
- | TRTC_DEBUG_VIEW_LEVEL_GONE | 0 | 不在渲染控件上展示调试信息。 |
534
- | TRTC_DEBUG_VIEW_LEVEL_STATUS | 1 | 在渲染控件上展示音视频统计信息。 |
535
- | TRTC_DEBUG_VIEW_LEVEL_ALL | 2 | 在渲染控件上展示音视频统计信息和关键历史事件。 |
552
+ **用于渲染控件上展示的调试信息。**
553
+
554
+ |枚举|取值|描述|
555
+ |---------|---------|---------|
556
+ |TRTC_DEBUG_VIEW_LEVEL_GONE|0|不在渲染控件上展示调试信息。|
557
+ |TRTC_DEBUG_VIEW_LEVEL_STATUS|1|在渲染控件上展示音视频统计信息。|
558
+ |TRTC_DEBUG_VIEW_LEVEL_ALL|2|在渲染控件上展示音视频统计信息和关键历史事件。|
536
559
 
537
560
  ## TRTCAudioRecordingContent
538
561
 
539
- #### 音频录制内容类型。
562
+ **音频录制内容类型。**
540
563
 
541
564
  该枚举类型用于音频录制接口 startAudioRecording,用于指定录制音频的内容。
542
- | 枚举 | 取值 | 描述 |
543
- | --- | --- | --- |
544
- | TRTC_AudioRecordingContent_All | 0 | 录制本地和远端所有音频。 |
545
- | TRTC_AudioRecordingContent_Local | 1 | 仅录制本地音频。 |
546
- | TRTC_AudioRecordingContent_Remote | 2 | 仅录制远端音频。 |
565
+
566
+ |枚举|取值|描述|
567
+ |---------|---------|---------|
568
+ |TRTC_AudioRecordingContent_All|0|录制本地和远端所有音频。|
569
+ |TRTC_AudioRecordingContent_Local|1|仅录制本地音频。|
570
+ |TRTC_AudioRecordingContent_Remote|2|仅录制远端音频。|
547
571
 
548
572
  ## TRTCPublishMode
549
573
 
550
- #### 媒体流发布模式。
574
+ **媒体流发布模式。**
551
575
 
552
576
  该枚举类型用于媒体流发布接口 startPublishMediaStream TRTC 的媒体流发布服务能够将房间中的多路音视频流混合成一路发布至 CDN 或者回推到房间内,也可以将您当前的这路音视频发布到腾讯或者第三方 CDN 因此您需要指定对应媒体流的发布模式,我们提供了如下几种模式。
553
577
  | 枚举 | 取值 | 描述 |
@@ -560,39 +584,42 @@ TRTC 的云端混流服务能够将房间中的多路音视频流混合成一路
560
584
 
561
585
  ## TRTCEncryptionAlgorithm
562
586
 
563
- #### 加密算法。
587
+ **加密算法。**
564
588
 
565
589
  该枚举类型用于媒体流私有加密算法选择。
566
- | 枚举 | 取值 | 描述 |
567
- | --- | --- | --- |
568
- | TRTC_EncryptionAlgorithm_Aes_128_Gcm | 0 | AES GCM 128。 |
569
- | TRTC_EncryptionAlgorithm_Aes_256_Gcm | 1 | AES GCM 256。 |
590
+
591
+ |枚举|取值|描述|
592
+ |---------|---------|---------|
593
+ |TRTC_EncryptionAlgorithm_Aes_128_Gcm|0|AES GCM 128。|
594
+ |TRTC_EncryptionAlgorithm_Aes_256_Gcm|1|AES GCM 256。|
570
595
 
571
596
  ## TRTCSpeedTestScene
572
597
 
573
- #### 测速场景。
598
+ **测速场景。**
574
599
 
575
600
  该枚举类型用于测速场景选择。
576
- | 枚举 | 取值 | 描述 |
577
- | --- | --- | --- |
578
- | TRTC_SpeedTestScene_Delay_Testing | 1 | 延迟测试。 |
579
- | TRTC_SpeedTestScene_Delay_Bandwidth_Testing | 2 | 延迟与带宽测试。 |
580
- | TRTC_SpeedTestScene_Online_Chorus_Testing | 3 | 在线合唱测试。 |
601
+
602
+ |枚举|取值|描述|
603
+ |---------|---------|---------|
604
+ |TRTC_SpeedTestScene_Delay_Testing|1|延迟测试。|
605
+ |TRTC_SpeedTestScene_Delay_Bandwidth_Testing|2|延迟与带宽测试。|
606
+ |TRTC_SpeedTestScene_Online_Chorus_Testing|3|在线合唱测试。|
581
607
 
582
608
  ## TRTCGravitySensorAdaptiveMode
583
609
 
584
- #### 设置重力感应的适配模式(仅适用于移动端)。
610
+ **设置重力感应的适配模式(仅适用于移动端)。**
585
611
 
586
- v11.7版本开始支持,只在sdk内部摄像头采集场景生效
587
- | 枚举 | 取值 | 描述 |
588
- | --- | --- | --- |
589
- | TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_DISABLE | 0 | 关闭重力感应,根据当前采集分辨率与设置的编码分辨率决策,如果两者不一致,则通过旋转90度,保证最大画幅。 |
590
- | TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_FILL_BY_CENTER_CROP | 1 | 开启重力感应,始终保证远端画面图像为正,中间过程需要处理分辨率不一致时,采用居中裁剪模式。 |
591
- | TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_FIT_WITH_BLACK_BORDER | 2 | 开启重力感应,始终保证远端画面图像为正,中间过程需要处理分辨率不一致时,采用叠加黑边模式。 |
612
+ v11.7 版本开始支持,只在 SDK 内部摄像头采集场景生效
613
+
614
+ |枚举|取值|描述|
615
+ |---------|---------|---------|
616
+ |TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_DISABLE|0|关闭重力感应,根据当前采集分辨率与设置的编码分辨率决策,如果两者不一致,则通过旋转90度,保证最大画幅。|
617
+ |TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_FILL_BY_CENTER_CROP|1|开启重力感应,始终保证远端画面图像为正,中间过程需要处理分辨率不一致时,采用居中裁剪模式。|
618
+ |TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_FIT_WITH_BLACK_BORDER|2|开启重力感应,始终保证远端画面图像为正,中间过程需要处理分辨率不一致时,采用叠加黑边模式。|
592
619
 
593
620
  ## TRTCParams
594
621
 
595
- #### 进房参数。
622
+ **进房参数。**
596
623
 
597
624
  作为 TRTC SDK 的进房参数,只有该参数填写正确,才能顺利进入 roomId 或者 strRoomId 所指定的音视频房间。
598
625
 
@@ -602,33 +629,33 @@ v11.7版本开始支持,只在sdk内部摄像头采集场景生效
602
629
  | 枚举类型 | 描述 |
603
630
  | --- | --- |
604
631
  | businessInfo | 【字段含义】业务数据字段(选填),部分高级特性才需要用到此字段。<br>【推荐取值】请不要自行设置该字段。 |
605
- | privateMapKey | 【字段含义】用于权限控制的权限票据(选填),当您希望某个房间只能让特定的 userId 进入时,需要使用 privateMapKey 进行权限保护。<br>【推荐取值】仅建议有高级别安全需求的客户使用,更多详情请参见 [进房权限保护](https://cloud.tencent.com/document/product/647/32240)。 |
632
+ | privateMapKey | 【字段含义】用于权限控制的权限票据(选填),当您希望某个房间只能让特定的 userId 进入时,需要使用 privateMapKey 进行权限保护。<br>【推荐取值】仅建议有高级别安全需求的客户使用,更多详情请参见 <a href="https://cloud.tencent.com/document/product/647/32240">进房权限保护</a>。 |
606
633
  | role | 【字段含义】直播场景下的角色,仅适用于直播场景(TRTC_APP_SCENE_LIVE 和 TRTC_APP_SCENE_VOICE_CHATROOM),通话场景下指定该参数是无效的。<br>【推荐取值】默认值:主播(TRTCRoleAnchor)。 |
607
- | roomId | 【字段含义】数字房间号,在同一个房间里的用户(userId)可以彼此看到对方并进行音视频通话。<br>【推荐取值】取值范围:1 - 4294967294。<br>【特别说明】1. roomId 与 strRoomId 是互斥的,若您选用 strRoomId,则 roomId 需要填写为 0。若两者都填,SDK 将优先选用 roomId。<br>2. 不要混用 roomId 和 strRoomId,因为它们之间是不互通的,例如数字 123 和字符串 ` 123 ` 在 TRTC 看来是两个完全不同的房间。 |
608
- | sdkAppId | 【字段含义】应用标识(必填),腾讯云基于 sdkAppId 完成计费统计。<br>【推荐取值】在 [实时音视频控制台](https://console.cloud.tencent.com/rav/) 创建应用后可以在账号信息页面中得到该 ID。 |
609
- | strRoomId | 【字段含义】字符串房间号,在同一个房间里的用户(userId)可以彼此看到对方并进行音视频通话。<br>【推荐取值】限制长度为 64 字节。以下为支持的字符集范围(共 89 个字符):<br>- 大小写英文字母(a-zA-Z);<br>- 数字(0-9);<br>- 空格、` ! `、` # `、` $ `、` % `、` & `、` ( `、` ) `、` + `、` - `、` : `、` ; `、` < `、` = `、` . `、` > `、` ? `、` @ `、` [ `、` ] `、` ^ `、` _ `、` { `、` } `、` \\| `、` ~ `、` , `。<br>【特别说明】1. roomId 与 strRoomId 是互斥的,若您选用 strRoomId,则 roomId 需要填写为0。若两者都填,SDK 将优先选用 roomId。<br>2. 不要混用 roomId 和 strRoomId,因为它们之间是不互通的,例如数字 123 和字符串 ` 123 ` 在 TRTC 看来是两个完全不同的房间。 |
610
- | streamId | 【字段含义】用于指定在腾讯云直播平台上的 streamId(选填),设置之后,您可以在腾讯云直播 CDN 上通过标准拉流方案(FLV 或 HLS)播放该用户的音视频流。<br>【推荐取值】限制长度为64字节,可以不填写,一种推荐的方案是使用 ` sdkappid_roomid_userid_main ` 作为 streamid,这种命名方式容易辨认且不会在您的多个应用中发生冲突。<br>【特殊说明】要使用腾讯云直播 CDN,您需要先在 [控制台](https://console.cloud.tencent.com/trtc/) 中的功能配置页开启“启动自动旁路直播”开关。<br>【参考文档】[发布音视频流到直播 CDN](https://cloud.tencent.com/document/product/647/84721)。 |
611
- | userDefineRecordId | 【字段含义】云端录制开关(选填),用于指定是否要在云端将该用户的音视频流录制下来。<br>【参考文档】[云端录制](https://cloud.tencent.com/document/product/647/76497)。<br>【推荐取值】限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。<br>方案一:手动录制方案:<br>1. 在 [控制台](https://console.cloud.tencent.com/trtc)>应用管理>云端录制配置 中开启云端录制。<br>2. 设置 ` 录制形式 ` 为 ` 手动录制 `。<br>3. 设置手动录制后,在一个 TRTC 房间中只有设置了 userDefineRecordId 参数的用户才会在云端录制出视频文件,不指定该参数的用户不会产生录制行为。<br>4. 云端会以 “userDefineRecordId_起始时间_结束时间” 的格式命名录制下来的文件。<br>方案二:自动录制方案:<br>1. 需要在 [控制台](https://console.cloud.tencent.com/trtc)>应用管理>云端录制配置 中开启云端录制。<br>2. 设置` 录制形式 `为` 自动录制 `。<br>3. 设置自动录制后,在一个 TRTC 房间中的任何一个有音视频上行的用户,均会在云端录制出视频文件。<br>4. 文件会以 ` userDefineRecordId_起始时间_结束时间 ` 的格式命名,如果不指定 userDefineRecordId,则文件会以 ` streamId_起始时间_结束时间 ` 命名。 |
634
+ | roomId | 【字段含义】数字房间号,在同一个房间里的用户(userId)可以彼此看到对方并进行音视频通话。<br>【推荐取值】取值范围:1 - 4294967294。<br>【特别说明】1. roomId 与 strRoomId 是互斥的,若您选用 strRoomId,则 roomId 需要填写为 0。若两者都填,SDK 将优先选用 roomId。<br>2. 不要混用 roomId 和 strRoomId,因为它们之间是不互通的,例如数字 123 和字符串 <code> 123 </code> 在 TRTC 看来是两个完全不同的房间。 |
635
+ | sdkAppId | 【字段含义】应用标识(必填),腾讯云基于 sdkAppId 完成计费统计。<br>【推荐取值】在 <a href="https://console.cloud.tencent.com/rav/">实时音视频控制台</a> 创建应用后可以在账号信息页面中得到该 ID。 |
636
+ | strRoomId | 【字段含义】字符串房间号,在同一个房间里的用户(userId)可以彼此看到对方并进行音视频通话。<br>【推荐取值】限制长度为 64 字节。以下为支持的字符集范围(共 89 个字符):<br>- 大小写英文字母(a-zA-Z);<br>- 数字(0-9);<br>- 空格、<code> ! </code>、<code> # </code>、<code> $ </code>、<code> % </code>、<code> & </code>、<code> ( </code>、<code> ) </code>、<code> + </code>、<code> - </code>、<code> : </code>、<code> ; </code>、<code> < </code>、<code> = </code>、<code> . </code>、<code> > </code>、<code> ? </code>、<code> @ </code>、<code> [ </code>、<code> ] </code>、<code> ^ </code>、<code> _ </code>、<code> { </code>、<code> } </code>、<code> \\| </code>、<code> ~ </code>、<code> , </code>。<br>【特别说明】1. roomId 与 strRoomId 是互斥的,若您选用 strRoomId,则 roomId 需要填写为0。若两者都填,SDK 将优先选用 roomId。<br>2. 不要混用 roomId 和 strRoomId,因为它们之间是不互通的,例如数字 123 和字符串 <code> 123 </code> 在 TRTC 看来是两个完全不同的房间。 |
637
+ | streamId | 【字段含义】用于指定在腾讯云直播平台上的 streamId(选填),设置之后,您可以在腾讯云直播 CDN 上通过标准拉流方案(FLV 或 HLS)播放该用户的音视频流。<br>【推荐取值】限制长度为64字节,可以不填写,一种推荐的方案是使用 <code> sdkappid_roomid_userid_main </code> 作为 streamid,这种命名方式容易辨认且不会在您的多个应用中发生冲突。<br>【特别说明】要使用腾讯云直播 CDN,您需要先在 <a href="https://console.cloud.tencent.com/trtc/">控制台</a> 中的功能配置页开启“启动自动旁路直播”开关。<br>【参考文档】<a href="https://cloud.tencent.com/document/product/647/84721">发布音视频流到直播 CDN</a>。 |
638
+ | userDefineRecordId | 【字段含义】云端录制开关(选填),用于指定是否要在云端将该用户的音视频流录制下来。<br>【参考文档】<a href="https://cloud.tencent.com/document/product/647/76497">云端录制</a>。<br>【推荐取值】限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。<br>方案一:手动录制方案:<br>1. 在 <a href="https://console.cloud.tencent.com/trtc">控制台</a>>应用管理>云端录制配置 中开启云端录制。<br>2. 设置 <code> 录制形式 </code> 为 <code> 手动录制 </code>。<br>3. 设置手动录制后,在一个 TRTC 房间中只有设置了 userDefineRecordId 参数的用户才会在云端录制出视频文件,不指定该参数的用户不会产生录制行为。<br>4. 云端会以 “userDefineRecordId_起始时间_结束时间” 的格式命名录制下来的文件。<br>方案二:自动录制方案:<br>1. 需要在 <a href="https://console.cloud.tencent.com/trtc">控制台</a>>应用管理>云端录制配置 中开启云端录制。<br>2. 设置<code> 录制形式 </code>为<code> 自动录制 </code>。<br>3. 设置自动录制后,在一个 TRTC 房间中的任何一个有音视频上行的用户,均会在云端录制出视频文件。<br>4. 文件会以 <code> userDefineRecordId_起始时间_结束时间 </code> 的格式命名,如果不指定 userDefineRecordId,则文件会以 <code> streamId_起始时间_结束时间 </code> 命名。 |
612
639
  | userId | 【字段含义】用户标识(必填),当前用户的 userId,相当于用户名,使用 UTF-8 编码。<br>【推荐取值】如果一个用户在您的账号系统中的 ID 为 “mike”,则 userId 即可设置为 “mike”。 |
613
- | userSig | 【字段含义】用户签名(必填),当前 userId 对应的验证签名,相当于使用云服务的登录密码。<br>【推荐取值】具体计算方法请参见 [如何计算UserSig](https://cloud.tencent.com/document/product/647/17275)。 |
640
+ | userSig | 【字段含义】用户签名(必填),当前 userId 对应的验证签名,相当于使用云服务的登录密码。<br>【推荐取值】具体计算方法请参见 <a href="https://cloud.tencent.com/document/product/647/17275">如何计算UserSig</a>。 |
614
641
 
615
642
  ## TRTCVideoEncParam
616
643
 
617
- #### 视频编码参数。
644
+ **视频编码参数。**
618
645
 
619
646
  该设置决定远端用户看到的画面质量,同时也决定了云端录制出的视频文件的画面质量。
620
647
  | 枚举类型 | 描述 |
621
648
  | --- | --- |
622
649
  | enableAdjustRes | 【字段含义】是否允许动态调整分辨率(开启后会对云端录制产生影响)。<br>【推荐取值】该功能适用于不需要云端录制的场景,开启后 SDK 会根据当前网络情况,智能选择出一个合适的分辨率,避免出现“大分辨率+小码率”的低效编码模式。<br>【特别说明】默认值:关闭。如有云端录制的需求,请不要开启此功能,因为如果视频分辨率发生变化后,云端录制出的 MP4 在普通的播放器上无法正常播放。 |
623
- | minVideoBitrate | 【字段含义】最低视频码率,SDK 会在网络不佳的情况下主动降低视频码率以保持流畅度,最低会降至 minVideoBitrate 所设定的数值。<br>【特别说明】 默认值:0,此时最低码率由 SDK 会根据您指定的分辨率,自动计算出合适的数值。<br>【推荐取值】您可以通过同时设置 videoBitrate 和 minVideoBitrate 两个参数,用于约束 SDK 对视频码率的调整范围:<br>- 如果您追求` 弱网络下允许卡顿但要保持清晰 `的效果,可以设置 minVideoBitrate 为 videoBitrate 的 60%。<br>- 如果您追求` 弱网络下允许模糊但要保持流畅 `的效果,可以设置 minVideoBitrate 为一个较低的数值(例如 100kbps)。<br>- 如果您将 videoBitrate 和 minVideoBitrate 设置为同一个值,等价于关闭 SDK 对视频码率的自适应调节能力。 |
650
+ | minVideoBitrate | 【字段含义】最低视频码率,SDK 会在网络不佳的情况下主动降低视频码率以保持流畅度,最低会降至 minVideoBitrate 所设定的数值。<br>【特别说明】 默认值:0,此时最低码率由 SDK 会根据您指定的分辨率,自动计算出合适的数值。<br>【推荐取值】您可以通过同时设置 videoBitrate 和 minVideoBitrate 两个参数,用于约束 SDK 对视频码率的调整范围:<br>- 如果您追求<code> 弱网络下允许卡顿但要保持清晰 </code>的效果,可以设置 minVideoBitrate 为 videoBitrate 的 60%。<br>- 如果您追求<code> 弱网络下允许模糊但要保持流畅 </code>的效果,可以设置 minVideoBitrate 为一个较低的数值(例如 100kbps)。<br>- 如果您将 videoBitrate 和 minVideoBitrate 设置为同一个值,等价于关闭 SDK 对视频码率的自适应调节能力。 |
624
651
  | videoBitrate | 【字段含义】目标视频码率,SDK 会按照目标码率进行编码,只有在弱网络环境下才会主动降低视频码率。<br>【推荐取值】请参见本 TRTCVideoResolution 在各档位注释的最佳码率,也可以在此基础上适当调高。例如:TRTCVideoResolution_1280_720 对应 1200kbps 的目标码率,您也可以设置为 1500kbps 用来获得更好的观感清晰度。<br>【特别说明】您可以通过同时设置 videoBitrate 和 minVideoBitrate 两个参数,用于约束 SDK 对视频码率的调整范围:<br>- 如果您追求“弱网络下允许卡顿但要保持清晰”的效果,可以设置 minVideoBitrate 为 videoBitrate 的 60%。<br>- 如果您追求“弱网络下允许模糊但要保持流畅”的效果,可以设置 minVideoBitrate 为一个较低的数值(例如 100kbps)。<br>- 如果您将 videoBitrate 和 minVideoBitrate 设置为同一个值,等价于关闭 SDK 对视频码率的自适应调节能力。 |
625
652
  | videoFps | 【字段含义】视频采集帧率。<br>【推荐取值】15fps或20fps。5fps以下,卡顿感明显。10fps以下,会有轻微卡顿感。20fps以上,会浪费带宽(电影的帧率为24fps)。<br>【特别说明】部分 Android 手机的前置摄像头并不支持15fps以上的采集帧率,部分主打美颜功能的 Android 手机的前置摄像头的采集帧率可能低于10fps。 |
626
- | videoResolution | 【字段含义】视频分辨率。<br>【特别说明】如需使用竖屏分辨率,请指定 resMode 为 Portrait,例如: ` 640 × 360 + Portrait = 360 × 640 `。<br>【推荐取值】<br>- 手机视频通话:建议选择 360 × 640 及以下分辨率,resMode 选择 Portrait,即竖屏分辨率。<br>- 手机在线直播:建议选择 540 × 960,resMode 选择 Portrait,即竖屏分辨率。<br>- 桌面平台(Win + Mac):建议选择 640 × 360 及以上分辨率,resMode 选择 Landscape,即横屏分辨率。 |
627
- | videoResolutionMode | 【字段含义】分辨率模式(横屏分辨率 or 竖屏分辨率)。<br>【推荐取值】手机平台(iOS、Android)建议选择 Portrait,桌面平台(Windows、Mac)建议选择 Landscape。<br>【特别说明】如需使用竖屏分辨率,请指定 resMode 为 Portrait,例如: ` 640 × 360 + Portrait = 360 × 640 `。 |
653
+ | videoResolution | 【字段含义】视频分辨率。<br>【特别说明】如需使用竖屏分辨率,请指定 resMode 为 Portrait,例如: <code> 640 × 360 + Portrait = 360 × 640 </code>。<br>【推荐取值】<br>- 手机视频通话:建议选择 360 × 640 及以下分辨率,resMode 选择 Portrait,即竖屏分辨率。<br>- 手机在线直播:建议选择 540 × 960,resMode 选择 Portrait,即竖屏分辨率。<br>- 桌面平台(Win + Mac):建议选择 640 × 360 及以上分辨率,resMode 选择 Landscape,即横屏分辨率。 |
654
+ | videoResolutionMode | 【字段含义】分辨率模式(横屏分辨率 or 竖屏分辨率)。<br>【推荐取值】手机平台(iOS、Android)建议选择 Portrait,桌面平台(Windows、Mac)建议选择 Landscape。<br>【特别说明】如需使用竖屏分辨率,请指定 resMode 为 Portrait,例如: <code> 640 × 360 + Portrait = 360 × 640 </code>。 |
628
655
 
629
656
  ## TRTCNetworkQosParam
630
657
 
631
- #### 网络流控(Qos)参数集。
658
+ **网络流控(Qos)参数集。**
632
659
 
633
660
  网络流控相关参数,该设置决定 SDK 在弱网络环境下的调控策略(例如:“清晰优先”或“流畅优先”)。
634
661
  | 枚举类型 | 描述 |
@@ -638,7 +665,7 @@ v11.7版本开始支持,只在sdk内部摄像头采集场景生效
638
665
 
639
666
  ## TRTCRenderParams
640
667
 
641
- #### 视频画面的渲染参数。
668
+ **视频画面的渲染参数。**
642
669
 
643
670
  您可以通过设置此参数来控制画面的旋转角度、填充模式和左右镜像模式。
644
671
  | 枚举类型 | 描述 |
@@ -649,36 +676,37 @@ v11.7版本开始支持,只在sdk内部摄像头采集场景生效
649
676
 
650
677
  ## TRTCQualityInfo
651
678
 
652
- #### 网络质量。
679
+ **网络质量。**
653
680
 
654
681
  表征网络质量的好坏,您可以通过该数值在用户界面上展示每个用户的网络质量。
655
- | 枚举类型 | 描述 |
656
- | --- | --- |
657
- | quality | 网络质量 |
658
- | userId | 用户 ID |
682
+
683
+ |枚举类型|描述|
684
+ |---------|---------|
685
+ |quality|网络质量|
686
+ |userId|用户 ID|
659
687
 
660
688
  ## TRTCVolumeInfo
661
689
 
662
- #### 音量大小。
690
+ **音量大小。**
663
691
 
664
692
  表征语音音量的评估值,您可以通过该数值在用户界面上展示每个用户的音量大小。
665
693
  | 枚举类型 | 描述 |
666
694
  | --- | --- |
667
695
  | pitch | 本地用户的人声频率(单位:Hz),取值范围[0 - 4000],对于远端用户,该值始终为0。 |
668
- | spectrumData | 音频频谱数据是将音频数据在频率域中的分布,划分为 256 个频率段,使用 spectrumData 记录各个频率段的能量值,每个能量值的取值范围为 [-300, 0],单位为 dBFS。<br>**注意**<br>本地频谱使用编码前的音频数据计算,会受到本地采集音量、BGM等影响;远端频谱使用接收到的音频数据计算,本地调整远端播放音量等操作不会对其产生影响。 |
696
+ | spectrumData | 音频频谱数据是将音频数据在频率域中的分布,划分为 256 个频率段,使用 spectrumData 记录各个频率段的能量值,每个能量值的取值范围为 [-300, 0],单位为 dBFS。<br><strong>注意</strong><br>本地频谱使用编码前的音频数据计算,会受到本地采集音量、BGM等影响;远端频谱使用接收到的音频数据计算,本地调整远端播放音量等操作不会对其产生影响。 |
669
697
  | userId | 说话者的 userId, 如果 userId 为空则代表是当前用户自己。 |
670
698
  | vad | 是否检测到人声,0:非人声 1:人声。 |
671
699
  | volume | 说话者的音量大小, 取值范围[0 - 100]。 |
672
700
 
673
701
  ## TRTCSpeedTestParams
674
702
 
675
- #### 测速参数。
703
+ **测速参数。**
676
704
 
677
705
  您可以在用户进入房间前通过 startSpeedTest 接口测试网速(注意:请不要在通话中调用)。
678
706
  | 枚举类型 | 描述 |
679
707
  | --- | --- |
680
- | expectedDownBandwidth | 预期的下行带宽(kbps,取值范围:[10, 5000],为 0 时不测试)。<br>**注意**<br>当参数 scene 设置为 TRTC_SpeedTestScene_Online_Chorus_Testing 时,为了获取更准确的 ` rtt / jitter ` 等信息,取值范围限制为 [10, 1000]。 |
681
- | expectedUpBandwidth | 预期的上行带宽(kbps,取值范围: [10, 5000],为 0 时不测试)。<br>**注意**<br>当参数 scene 设置为 TRTC_SpeedTestScene_Online_Chorus_Testing 时,为了获取更准确的 ` rtt / jitter ` 等信息,取值范围限制为 [10, 1000]。 |
708
+ | expectedDownBandwidth | 预期的下行带宽(kbps,取值范围:[10, 5000],为 0 时不测试)。<br><strong>注意</strong><br>当参数 scene 设置为 TRTC_SpeedTestScene_Online_Chorus_Testing 时,为了获取更准确的 <code> rtt / jitter </code> 等信息,取值范围限制为 [10, 1000]。 |
709
+ | expectedUpBandwidth | 预期的上行带宽(kbps,取值范围: [10, 5000],为 0 时不测试)。<br><strong>注意</strong><br>当参数 scene 设置为 TRTC_SpeedTestScene_Online_Chorus_Testing 时,为了获取更准确的 <code> rtt / jitter </code> 等信息,取值范围限制为 [10, 1000]。 |
682
710
  | scene | 测速场景。 |
683
711
  | sdkAppId | 应用标识,请参见 TRTCParams 中的相关说明。 |
684
712
  | userId | 用户标识,请参见 TRTCParams 中的相关说明。 |
@@ -686,35 +714,37 @@ v11.7版本开始支持,只在sdk内部摄像头采集场景生效
686
714
 
687
715
  ## TRTCSpeedTestResult
688
716
 
689
- #### 网络测速结果。
717
+ **网络测速结果。**
690
718
 
691
719
  您可以在用户进入房间前通过 startSpeedTest 接口进行测速(注意:请不要在通话中调用)。
692
- | 枚举类型 | 描述 |
693
- | --- | --- |
694
- | availableDownBandwidth | 下行带宽(kbps,-1:无效值)。 |
695
- | availableUpBandwidth | 上行带宽(kbps,-1:无效值)。 |
696
- | downJitter | 下行数据包抖动(ms),指用户当前网络环境下数据通信的稳定性,该值越小越好,正常数值范围是 [0, 100],-1 代表此次测速没有成功测得有效值,一般情况下 Wi-Fi 网络的 Jitter 会比 4G/5G 环境稍大。 |
697
- | downLostRate | 下行丢包率,取值范围是 [0 - 1.0],例如 0.2 表示每从服务器收取 10 个数据包可能会在中途丢失 2 个。 |
698
- | errMsg | 带宽测试错误信息。 |
699
- | ip | 服务器 IP 地址。 |
700
- | quality | 内部通过评估算法测算出的网络质量,更多信息请参见 TRTCQuality。 |
701
- | rtt | 延迟(毫秒),指当前设备到 TRTC 服务器的一次网络往返时间,该值越小越好,正常数值范围是10ms - 100ms。 |
702
- | success | 测试是否成功。 |
703
- | upJitter | 上行数据包抖动(ms),指用户当前网络环境下数据通信的稳定性,该值越小越好,正常数值范围是 [0, 100],-1 代表此次测速没有成功测得有效值,一般情况下 Wi-Fi 网络的 Jitter 会比 4G/5G 环境稍大。 |
704
- | upLostRate | 上行丢包率,取值范围是 [0 - 1.0],例如 0.3 表示每向服务器发送 10 个数据包可能会在中途丢失 3 个。 |
720
+
721
+ |枚举类型|描述|
722
+ |---------|---------|
723
+ |availableDownBandwidth|下行带宽(kbps,-1:无效值)。|
724
+ |availableUpBandwidth|上行带宽(kbps,-1:无效值)。|
725
+ |downJitter|下行数据包抖动(ms),指用户当前网络环境下数据通信的稳定性,该值越小越好,正常数值范围是 [0, 100],-1 代表此次测速没有成功测得有效值,一般情况下 Wi-Fi 网络的 Jitter 会比 4G/5G 环境稍大。|
726
+ |downLostRate|下行丢包率,取值范围是 [0 - 1.0],例如 0.2 表示每从服务器收取 10 个数据包可能会在中途丢失 2 个。|
727
+ |errMsg|带宽测试错误信息。|
728
+ |ip|服务器 IP 地址。|
729
+ |quality|内部通过评估算法测算出的网络质量,更多信息请参见 TRTCQuality。|
730
+ |rtt|延迟(毫秒),指当前设备到 TRTC 服务器的一次网络往返时间,该值越小越好,正常数值范围是10ms - 100ms。|
731
+ |success|测试是否成功。|
732
+ |upJitter|上行数据包抖动(ms),指用户当前网络环境下数据通信的稳定性,该值越小越好,正常数值范围是 [0, 100],-1 代表此次测速没有成功测得有效值,一般情况下 Wi-Fi 网络的 Jitter 会比 4G/5G 环境稍大。|
733
+ |upLostRate|上行丢包率,取值范围是 [0 - 1.0],例如 0.3 表示每向服务器发送 10 个数据包可能会在中途丢失 3 个。|
705
734
 
706
735
  ## TRTCTexture
707
736
 
708
- #### 视频纹理数据。
709
- | 枚举类型 | 描述 |
710
- | --- | --- |
711
- | eglContext10 | 【字段含义】使用 (javax.microedition.khronos.egl.*) 定义的 OpenGL 上下文环境。 |
712
- | eglContext14 | 【字段含义】使用 (android.opengl.*) 定义的 OpenGL 上下文环境。 |
713
- | textureId | 【字段含义】视频纹理 ID。 |
737
+ **视频纹理数据。**
738
+
739
+ |枚举类型|描述|
740
+ |---------|---------|
741
+ |eglContext10|【字段含义】使用 (javax.microedition.khronos.egl.*) 定义的 OpenGL 上下文环境。|
742
+ |eglContext14|【字段含义】使用 (android.opengl.*) 定义的 OpenGL 上下文环境。|
743
+ |textureId|【字段含义】视频纹理 ID。|
714
744
 
715
745
  ## TRTCVideoFrame
716
746
 
717
- #### 视频帧信息。
747
+ **视频帧信息。**
718
748
 
719
749
  TRTCVideoFrame 用来描述一帧视频画面的裸数据,也就是编码前或者解码后的视频画面数据。
720
750
  | 枚举类型 | 描述 |
@@ -731,24 +761,25 @@ TRTCVideoFrame 用来描述一帧视频画面的裸数据,也就是编码前
731
761
 
732
762
  ## TRTCAudioFrame
733
763
 
734
- #### 音频帧数据。
735
- | 枚举类型 | 描述 |
736
- | --- | --- |
737
- | channel | 【字段含义】声道数。 |
738
- | data | 【字段含义】音频数据。 |
739
- | extraData | 【字段含义】音频额外数据,远端用户通过 onLocalProcessedAudioFrame 写入的数据会通过该字段回调。 |
740
- | sampleRate | 【字段含义】采样率。 |
741
- | timestamp | 【字段含义】时间戳,单位ms。 |
764
+ **音频帧数据。**
765
+
766
+ |枚举类型|描述|
767
+ |---------|---------|
768
+ |channel|【字段含义】声道数。|
769
+ |data|【字段含义】音频数据。|
770
+ |extraData|【字段含义】音频额外数据,远端用户通过 onLocalProcessedAudioFrame 写入的数据会通过该字段回调。|
771
+ |sampleRate|【字段含义】采样率。|
772
+ |timestamp|【字段含义】时间戳,单位ms。|
742
773
 
743
774
  ## TRTCMixUser
744
775
 
745
- #### 云端混流中各路画面的描述信息。
776
+ **云端混流中各路画面的描述信息。**
746
777
 
747
778
  TRTCMixUser 用于指定云端混流中每一路视频画面的位置、大小、图层以及流类型等信息。
748
779
  | 枚举类型 | 描述 |
749
780
  | --- | --- |
750
781
  | height | 【字段含义】指定该路画面的高度(单位:像素)。 |
751
- | image | 【字段含义】占位图或水印图<br>- 占位图是指当对应 userId 混流内容为纯音频时,混合后的画面中显示的是占位图片。<br>- 水印图是指一张贴在混合后画面中的半透明图片,这张图片会一直覆盖于混合后的画面上。<br>- 当指定 inputType 为 TRTC_MixInputType_PureAudio 时,image 为占位图,此时需要您指定 userId。<br>- 当指定 inputType 为 TRTCCloudDef.TRTC_MixInputType_Watermark 时,image 为水印图,此时不需要您指定 userId。<br>【推荐取值】默认值:空值,即不设置占位图或者水印图。<br>【特别说明】<br>- 您可以将 image 设置为控制台中的某一个素材 ID,这需要您事先在 “[控制台](https://console.cloud.tencent.com/trtc) => 应用管理 => 功能配置 => 素材管理” 中单击 [新增图片] 按钮进行上传。<br>- 上传成功后可以获得对应的“图片ID”,然后将“图片ID”转换成字符串类型并设置给 image 字段即可(例如假设“图片ID” 为 63,可以设置 image = @"63")。<br>- 您也可以将 image 设置为图片的 URL 地址,腾讯云的后台服务器会将该 URL 地址指定的图片混合到最终的画面中。<br>- URL 链接长度限制为 512 字节。图片大小限制不超过 2MB。<br>- 图片格式支持 png、jpg、jpeg、bmp 格式,推荐使用 png 格式的半透明图片作为水印。<br>- image 仅在 inputType 为 TRTC_MixInputType_PureAudio 或者 TRTCCloudDef.TRTC_MixInputType_Watermark 时才生效。 |
782
+ | image | 【字段含义】占位图或水印图<br>- 占位图是指当对应 userId 混流内容为纯音频时,混合后的画面中显示的是占位图片。<br>- 水印图是指一张贴在混合后画面中的半透明图片,这张图片会一直覆盖于混合后的画面上。<br>- 当指定 inputType 为 TRTC_MixInputType_PureAudio 时,image 为占位图,此时需要您指定 userId。<br>- 当指定 inputType 为 TRTCCloudDef.TRTC_MixInputType_Watermark 时,image 为水印图,此时不需要您指定 userId。<br>【推荐取值】默认值:空值,即不设置占位图或者水印图。<br>【特别说明】<br>- 您可以将 image 设置为控制台中的某一个素材 ID,这需要您事先在 “<a href="https://console.cloud.tencent.com/trtc">控制台</a> => 应用管理 => 功能配置 => 素材管理” 中单击 [新增图片] 按钮进行上传。<br>- 上传成功后可以获得对应的“图片ID”,然后将“图片ID”转换成字符串类型并设置给 image 字段即可(例如假设“图片ID” 为 63,可以设置 image = @"63")。<br>- 您也可以将 image 设置为图片的 URL 地址,腾讯云的后台服务器会将该 URL 地址指定的图片混合到最终的画面中。<br>- URL 链接长度限制为 512 字节。图片大小限制不超过 2MB。<br>- 图片格式支持 png、jpg、jpeg、bmp 格式,推荐使用 png 格式的半透明图片作为水印。<br>- image 仅在 inputType 为 TRTC_MixInputType_PureAudio 或者 TRTCCloudDef.TRTC_MixInputType_Watermark 时才生效。 |
752
783
  | inputType | 【字段含义】指定该路流的混合内容(只混音频、只混视频、混合音视频、混入水印)。<br>【默认取值】默认值:TRTC_MixInputType_Undefined。<br>【特别说明】<br>- 当指定 inputType 为 TRTC_MixInputType_Undefined 并设置 pureAudio 为 YES 时,等效于设置 inputType 为 TRTC_MixInputType_PureAudio。<br>- 当指定 inputType 为 TRTC_MixInputType_Undefined 并设置 pureAudio 为 NO 时,等效于设置 inputType 为 TRTC_MixInputType_AudioVideo。<br>- 当指定 inputType 为 TRTCCloudDef.TRTC_MixInputType_Watermark 时,您可以不指定 userId 字段,但需要指定 image 字段。 |
753
784
  | pureAudio | 【字段含义】指定该路流是不是只混合声音。<br>【推荐取值】默认值:false。<br>【特别说明】已废弃,推荐使用8.5版本开始新引入的字段:inputType。 |
754
785
  | renderMode | 【字段含义】该画面在输出时的显示模式。<br>【推荐取值】默认值:视频流默认为0。0为裁剪,1为缩放,2为缩放并显示黑底。<br>【特别说明】水印图和占位图暂时不支持设置 renderMode,默认强制拉伸处理。 |
@@ -763,19 +794,19 @@ TRTCMixUser 用于指定云端混流中每一路视频画面的位置、大小
763
794
 
764
795
  ## TRTCTranscodingConfig
765
796
 
766
- #### 云端混流的排版布局和转码参数。
797
+ **云端混流的排版布局和转码参数。**
767
798
 
768
799
  用于指定混流时各路画面的排版位置信息和云端转码的编码参数。
769
800
  | 枚举类型 | 描述 |
770
801
  | --- | --- |
771
- | appId | 【字段含义】腾讯云直播服务的 AppID。<br>【推荐取值】请在 [实时音视频控制台](https://console.cloud.tencent.com/trtc) 依次单击【应用管理】=>【应用信息】,并在【旁路直播信息】中获取 appid。<br>【特别说明】2020年01月09日及此后新建的应用无需再填写该字段。 |
802
+ | appId | 【字段含义】腾讯云直播服务的 AppID。<br>【推荐取值】请在 <a href="https://console.cloud.tencent.com/trtc">实时音视频控制台</a> 依次单击【应用管理】=>【应用信息】,并在【旁路直播信息】中获取 appid。<br>【特别说明】2020年01月09日及此后新建的应用无需再填写该字段。 |
772
803
  | audioBitrate | 【字段含义】指定云端转码的目标音频码率。<br>【推荐取值】默认值:64kbps,取值范围是 [32,192]。 |
773
804
  | audioChannels | 【字段含义】指定云端转码的音频声道数。<br>【推荐取值】默认值:1,代表单声道。可设定的数值只有两个数字:1-单声道,2-双声道。 |
774
805
  | audioCodec | 【字段含义】指定云端转码的输出流音频编码类型。<br>【推荐取值】默认值:0,代表LC-AAC。可设定的数值只有三个数字:0 - LC-AAC,1 - HE-AAC,2 - HE-AACv2。<br>【特别说明】HE-AAC 和 HE-AACv2 支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000]。<br>【特别说明】当音频编码设置为 HE-AACv2 时,只支持输出流音频声道数为双声道。<br>【特别说明】HE-AAC 和 HE-AACv2 取值仅在输出流为您额外设置的 streamId 上时才生效。 |
775
806
  | audioSampleRate | 【字段含义】指定云端转码的目标音频采样率。<br>【推荐取值】默认值:48000Hz。支持12000Hz、16000Hz、22050Hz、24000Hz、32000Hz、44100Hz、48000Hz。 |
776
807
  | backgroundColor | 【字段含义】指定混合画面的底色颜色。<br>【推荐取值】默认值:0x000000 代表黑色。格式为十六进制数字,例如:“0x61B9F1” 代表 RGB 分别为(97,158,241)。 |
777
- | backgroundImage | 【字段含义】指定混合画面的背景图片。<br>【推荐取值】默认值:空值,即不设置背景图片。<br>【特别说明】<br>- 您可以将 image 设置为控制台中的某一个素材 ID,这需要您事先在 “[控制台](https://console.cloud.tencent.com/trtc) => 应用管理 => 功能配置 => 素材管理” 中单击 [新增图片] 按钮进行上传。<br>- 上传成功后可以获得对应的“图片ID”,然后将“图片ID”转换成字符串类型并设置给 image 字段即可(例如假设“图片ID” 为 63,可以设置 image = @"63")。<br>- 您也可以将 image 设置为图片的 URL 地址,腾讯云的后台服务器会将该 URL 地址指定的图片混合到最终的画面中。<br>- URL 链接长度限制为 512 字节。图片大小限制不超过 2MB。<br>- 图片格式支持 png、jpg、jpeg、bmp 格式。 |
778
- | bizId | 【字段含义】腾讯云直播服务的 bizid。<br>【推荐取值】请在 [实时音视频控制台](https://console.cloud.tencent.com/trtc) 依次单击【应用管理】=>【应用信息】,并在【旁路直播信息】中获取 bizid。<br>【特别说明】2020年01月09日及此后新建的应用无需再填写该字段。 |
808
+ | backgroundImage | 【字段含义】指定混合画面的背景图片。<br>【推荐取值】默认值:空值,即不设置背景图片。<br>【特别说明】<br>- 您可以将 image 设置为控制台中的某一个素材 ID,这需要您事先在 “<a href="https://console.cloud.tencent.com/trtc">控制台</a> => 应用管理 => 功能配置 => 素材管理” 中单击 [新增图片] 按钮进行上传。<br>- 上传成功后可以获得对应的“图片ID”,然后将“图片ID”转换成字符串类型并设置给 image 字段即可(例如假设“图片ID” 为 63,可以设置 image = @"63")。<br>- 您也可以将 image 设置为图片的 URL 地址,腾讯云的后台服务器会将该 URL 地址指定的图片混合到最终的画面中。<br>- URL 链接长度限制为 512 字节。图片大小限制不超过 2MB。<br>- 图片格式支持 png、jpg、jpeg、bmp 格式。 |
809
+ | bizId | 【字段含义】腾讯云直播服务的 bizid。<br>【推荐取值】请在 <a href="https://console.cloud.tencent.com/trtc">实时音视频控制台</a> 依次单击【应用管理】=>【应用信息】,并在【旁路直播信息】中获取 bizid。<br>【特别说明】2020年01月09日及此后新建的应用无需再填写该字段。 |
779
810
  | mixUsers | 【字段含义】指定云端混流中每一路视频画面的位置、大小、图层以及流类型等信息。<br>【推荐取值】该字段是一个 TRTCMixUser 类型的数组,数组中的每一个元素都用来代表每一路画面的信息。 |
780
811
  | mode | 【字段含义】排版模式。<br>【推荐取值】请根据您的业务场景要求自行选择,预排版模式是适用性较好的一种模式。 |
781
812
  | streamId | 【字段含义】输出到 CDN 上的直播流 ID。<br>【推荐取值】默认值:空值,即房间里的多路音视频流最终会混合到接口调用者的那一路音视频流上。<br>- 如不设置该参数,SDK 会执行默认逻辑,即房间里的多路音视频流会混合到该接口调用者的那一路音视频流上,也就是 A + B => A。<br>- 如您设置该参数,SDK 会将房间里的多路音视频流混合到您指定的直播流上,也就是 A + B => C(C 代表您指定的 streamId)。 |
@@ -788,21 +819,21 @@ TRTCMixUser 用于指定云端混流中每一路视频画面的位置、大小
788
819
 
789
820
  ## TRTCPublishCDNParam
790
821
 
791
- #### 向非腾讯云 CDN 上发布音视频流时需设置的转推参数。
822
+ **向非腾讯云 CDN 上发布音视频流时需设置的转推参数。**
792
823
 
793
824
  TRTC 的后台服务支持通过标准 RTMP 协议,将其中的音视频流发布到第三方直播 CDN 服务商。
794
825
 
795
826
  如果您使用腾讯云直播 CDN 服务,可无需关注此参数,直接使用 startPublish 接口即可。
796
827
  | 枚举类型 | 描述 |
797
828
  | --- | --- |
798
- | appId | 【字段含义】腾讯云直播服务的 AppID。<br>【推荐取值】请在 [实时音视频控制台](https://console.cloud.tencent.com/trtc) 依次单击【应用管理】=>【应用信息】,并在【旁路直播信息】中获取 appid。 |
799
- | bizId | 【字段含义】腾讯云直播服务的 bizid。<br>【推荐取值】请在 [实时音视频控制台](https://console.cloud.tencent.com/trtc) 依次单击【应用管理】=>【应用信息】,并在【旁路直播信息】中获取 bizid。 |
829
+ | appId | 【字段含义】腾讯云直播服务的 AppID。<br>【推荐取值】请在 <a href="https://console.cloud.tencent.com/trtc">实时音视频控制台</a> 依次单击【应用管理】=>【应用信息】,并在【旁路直播信息】中获取 appid。 |
830
+ | bizId | 【字段含义】腾讯云直播服务的 bizid。<br>【推荐取值】请在 <a href="https://console.cloud.tencent.com/trtc">实时音视频控制台</a> 依次单击【应用管理】=>【应用信息】,并在【旁路直播信息】中获取 bizid。 |
800
831
  | streamId | 【字段含义】需要转推的 streamId。<br>【推荐取值】默认值:空值。如果不填写,则默认转推调用者的旁路流。 |
801
832
  | url | 【字段含义】指定该路音视频流在第三方直播服务商的推流地址(RTMP 格式)。<br>【推荐取值】各家服务商的推流地址规则差异较大,请根据目标服务商的要求填写合法的推流 URL,TRTC 的后台服务器会按照您填写的 URL 向第三方服务商推送标准格式音视频流。<br>【特别说明】推流 URL 必须为 RTMP 格式,必须符合您的目标直播服务商的规范要求,否则目标服务商会拒绝来自 TRTC 后台服务的推流请求。 |
802
833
 
803
834
  ## TRTCAudioRecordingParams
804
835
 
805
- #### 本地音频文件的录制参数。
836
+ **本地音频文件的录制参数。**
806
837
 
807
838
  该参数用于在音频录制接口 startAudioRecording 中指定录制参数。
808
839
  | 枚举类型 | 描述 |
@@ -813,7 +844,7 @@ TRTC 的后台服务支持通过标准 RTMP 协议,将其中的音视频流发
813
844
 
814
845
  ## TRTCLocalRecordingParams
815
846
 
816
- #### 本地媒体文件的录制参数。
847
+ **本地媒体文件的录制参数。**
817
848
 
818
849
  该参数用于在本地媒体文件的录制接口 startLocalRecording 中指定录制相关参数。
819
850
 
@@ -827,7 +858,7 @@ TRTC 的后台服务支持通过标准 RTMP 协议,将其中的音视频流发
827
858
 
828
859
  ## TRTCAudioEffectParam(Deprecated)
829
860
 
830
- #### 音效参数(已废弃)。
861
+ **音效参数(已废弃)。**
831
862
 
832
863
  TRTC 中的“音效”特指一些短暂的音频文件,通常仅有几秒钟的播放时间,例如“鼓掌声”、“欢笑声”等。
833
864
 
@@ -846,19 +877,19 @@ TRTC 中的“音效”特指一些短暂的音频文件,通常仅有几秒钟
846
877
 
847
878
  ## TRTCSwitchRoomConfig
848
879
 
849
- #### 房间切换参数。
880
+ **房间切换参数。**
850
881
 
851
882
  该参数用于切换房间接口switchRoom,可以让用户从一个房间快速切换到另一个房间。
852
883
  | 枚举类型 | 描述 |
853
884
  | --- | --- |
854
- | privateMapKey | 【字段含义】用于权限控制的权限票据(选填),当您希望某个房间只能让特定的 userId 进入时,需要使用 privateMapKey 进行权限保护。<br>【推荐取值】仅建议有高级别安全需求的客户使用,更多详情请参见 [进房权限保护](https://cloud.tencent.com/document/product/647/32240)。 |
885
+ | privateMapKey | 【字段含义】用于权限控制的权限票据(选填),当您希望某个房间只能让特定的 userId 进入时,需要使用 privateMapKey 进行权限保护。<br>【推荐取值】仅建议有高级别安全需求的客户使用,更多详情请参见 <a href="https://cloud.tencent.com/document/product/647/32240">进房权限保护</a>。 |
855
886
  | roomId | 【字段含义】数字房间号码 [选填],在同一个房间内的用户可以看到彼此并能够进行音视频通话。<br>【推荐取值】取值范围:1 - 4294967294。<br>【特别说明】roomId 和 strRoomId 必须并且只能填一个。若两者都填,则优先选择 roomId。 |
856
887
  | strRoomId | 【字段含义】字符串房间号码 [选填],在同一个房间内的用户可以看到彼此并能够进行音视频通话。<br>【特别说明】roomId 和 strRoomId 必须并且只能填一个。若两者都填,则优先选择 roomId。 |
857
- | userSig | 【字段含义】用户签名 [选填],当前 userId 对应的验证签名,相当于登录密码。<br>如果您在切换房间时不指定新计算出的 userSig,SDK 会继续使用您在进入房间时(enterRoom)时所指定的 userSig。<br>这就需要您必须保证旧的 userSig 在切换房间的那一刻仍在签名允许的效期内,否则会导致房间切换失败。<br>【推荐取值】具体计算方法请参见 [如何计算UserSig](https://cloud.tencent.com/document/product/647/17275)。 |
888
+ | userSig | 【字段含义】用户签名 [选填],当前 userId 对应的验证签名,相当于登录密码。<br>如果您在切换房间时不指定新计算出的 userSig,SDK 会继续使用您在进入房间时(enterRoom)时所指定的 userSig。<br>这就需要您必须保证旧的 userSig 在切换房间的那一刻仍在签名允许的效期内,否则会导致房间切换失败。<br>【推荐取值】具体计算方法请参见 <a href="https://cloud.tencent.com/document/product/647/17275">如何计算UserSig</a>。 |
858
889
 
859
890
  ## TRTCAudioFrameDelegateFormat
860
891
 
861
- #### 音频自定义回调的格式参数。
892
+ **音频自定义回调的格式参数。**
862
893
 
863
894
  该参数用于在音频自定义回调相关的接口中,设置 SDK 回调出来的音频数据的相关格式(包括采样率、声道数等)。
864
895
  | 枚举类型 | 描述 |
@@ -866,43 +897,43 @@ TRTC 中的“音效”特指一些短暂的音频文件,通常仅有几秒钟
866
897
  | channel | 【字段含义】声道数。<br>【推荐取值】默认值:1,代表单声道。可设定的数值只有两个数字:1-单声道,2-双声道。 |
867
898
  | mode | 【字段含义】回调数据读写模式<br>【推荐取值】TRTC_AUDIO_FRAME_OPERATION_MODE_READONLY:仅从回调中获取音频数据。可设定的模式有 TRTC_AUDIO_FRAME_OPERATION_MODE_READONLY,TRTC_AUDIO_FRAME_OPERATION_MODE_READWRITE。 |
868
899
  | sampleRate | 【字段含义】采样率。<br>【推荐取值】默认值:48000Hz。支持 16000, 32000, 44100, 48000。 |
869
- | samplesPerCall | 【字段含义】采样点数。<br>【推荐取值】取值必须是 ` sampleRate/100 ` 的整数倍。 |
900
+ | samplesPerCall | 【字段含义】采样点数。<br>【推荐取值】取值必须是 <code> sampleRate/100 </code> 的整数倍。 |
870
901
 
871
902
  ## TRTCScreenShareParams
872
903
 
873
- #### 屏幕分享参数(仅适用于 Android 平台)。
904
+ **屏幕分享参数(仅适用于 Android 平台)。**
874
905
 
875
906
  该参数用于在屏幕分享接口 startScreenCapture 中指定屏幕分享时的悬浮窗等相关信息。
876
907
  | 枚举类型 | 描述 |
877
908
  | --- | --- |
878
909
  | enableForegroundService | @deprecated 从 v11.8 版本开始,为了适配 targetSdkVersion 34 及以上版本,屏幕分享会默认启动内置前台服务。该值设置无效 |
879
- | floatingView | 【字段含义】可以通过此参数设置一个悬浮view。<br>【推荐取值】从 Android 7.0 系统开始,对于没有做过任何保活措施的后台应用,Android 系统会很快将其杀掉以减少系统能耗。<br>但当您的 App 处于屏幕分享状态时,不可避免地要被切到系统后台运行,此时如果能弹出悬浮窗可以避免被系统强杀掉。<br>同时,在手机屏幕上显示悬浮窗,也有利于告知用户当前正在做屏幕分享,以便提醒用户避免泄漏个人隐私。<br>【特殊说明】您也可以使用 Android 系统的 WindowsManager 接口达到同样的效果。 |
910
+ | floatingView | 【字段含义】可以通过此参数设置一个悬浮view。<br>【推荐取值】从 Android 7.0 系统开始,对于没有做过任何保活措施的后台应用,Android 系统会很快将其杀掉以减少系统能耗。<br>但当您的 App 处于屏幕分享状态时,不可避免地要被切到系统后台运行,此时如果能弹出悬浮窗可以避免被系统强杀掉。<br>同时,在手机屏幕上显示悬浮窗,也有利于告知用户当前正在做屏幕分享,以便提醒用户避免泄漏个人隐私。<br>【特别说明】您也可以使用 Android 系统的 WindowsManager 接口达到同样的效果。 |
880
911
  | mediaProjection | 【字段含义】可以通过此参数将您自己创建的 MediaProjection 传入给 SDK 使用。<br>【推荐取值】正常情况下,该参数保持为 null 即可。 |
881
912
 
882
913
  ## TRTCAudioParallelParams
883
914
 
884
- #### 远端音频流智能并发播放策略的参数。
915
+ **远端音频流智能并发播放策略的参数。**
885
916
 
886
917
  该参数用于设置远端音频流智能并发播放策略。
887
918
  | 枚举类型 | 描述 |
888
919
  | --- | --- |
889
- | includeUsers | 【字段含义】指定用户必定能并发播放。<br>【特殊说明】指定必定并发播放的用户 ID 列表。这些用户不参与智能选择。<br>includeUsers 的数量必须小于 maxCount,否则本次并发播放设置失效。<br>includeUsers 仅在 maxCount > 0 时有效。当 includeUsers 生效时,参与智能并发选择的最大播放数 = maxCount - 有效 includeUsers 的数量。 |
920
+ | includeUsers | 【字段含义】指定用户必定能并发播放。<br>【特别说明】指定必定并发播放的用户 ID 列表。这些用户不参与智能选择。<br>includeUsers 的数量必须小于 maxCount,否则本次并发播放设置失效。<br>includeUsers 仅在 maxCount > 0 时有效。当 includeUsers 生效时,参与智能并发选择的最大播放数 = maxCount - 有效 includeUsers 的数量。 |
890
921
  | maxCount | 【字段含义】最大并发播放数。默认值:0。<br>- 如果 maxCount > 0,且实际人数 > maxCount,会实时智能选出 maxCount 路数据进行播放,这会极大的降低性能消耗。<br>- 如果 maxCount = 0,SDK 不限制并发播放数,在上麦人数比较多的房间可能会引发性能问题。 |
891
922
 
892
923
  ## TRTCUser
893
924
 
894
- #### 媒体流发布相关配置的用户信息。
925
+ **媒体流发布相关配置的用户信息。**
895
926
 
896
927
  您可以通过设置该参数,配合媒体流目标发布参数 (TRTCPublishTarget) 和混流转码参数 (TRTCStreamMixingConfig),将您指定的多路音视频流进行转码并发布到您填写的目标发布地址中
897
928
  | 枚举类型 | 描述 |
898
929
  | --- | --- |
899
930
  | intRoomId | 【字段含义】数字房间号,需要和您的进房参数 (TRTCParams) 中的房间号类型相匹配。<br>【推荐取值】取值范围:1 - 4294967294。<br>【特别说明】intRoomId 与 strRoomId 是互斥的,若您进房参数中选用 strRoomId,则 intRoomId 需要填写为0。若两者都填,SDK 将优先选用 intRoomId。 |
900
- | strRoomId | 【字段含义】字符串房间号,需要和您的进房参数 (TRTCParams) 中的房间号类型相匹配。<br>【特别说明】intRoomId 与 strRoomId 是互斥的,若您进房参数中选用 roomId,则 strRoomId 无需填写。若两者都填,SDK 将优先选用 intRoomId。<br>【推荐取值】限制长度为 64 字节。以下为支持的字符集范围(共 89 个字符):<br>- 大小写英文字母(a-zA-Z);<br>- 数字(0-9);<br>- 空格、` ! `、` # `、` $ `、` % `、` & `、` ( `、` ) `、` + `、` - `、` : `、` ; `、` < `、` = `、` . `、` > `、` ? `、` @ `、` [ `、` ] `、` ^ `、` _ `、` { `、` } `、` \\| `、` ~ `、` , `。 |
931
+ | strRoomId | 【字段含义】字符串房间号,需要和您的进房参数 (TRTCParams) 中的房间号类型相匹配。<br>【特别说明】intRoomId 与 strRoomId 是互斥的,若您进房参数中选用 roomId,则 strRoomId 无需填写。若两者都填,SDK 将优先选用 intRoomId。<br>【推荐取值】限制长度为 64 字节。以下为支持的字符集范围(共 89 个字符):<br>- 大小写英文字母(a-zA-Z);<br>- 数字(0-9);<br>- 空格、<code> ! </code>、<code> # </code>、<code> $ </code>、<code> % </code>、<code> & </code>、<code> ( </code>、<code> ) </code>、<code> + </code>、<code> - </code>、<code> : </code>、<code> ; </code>、<code> < </code>、<code> = </code>、<code> . </code>、<code> > </code>、<code> ? </code>、<code> @ </code>、<code> [ </code>、<code> ] </code>、<code> ^ </code>、<code> _ </code>、<code> { </code>、<code> } </code>、<code> \\| </code>、<code> ~ </code>、<code> , </code>。 |
901
932
  | userId | 【字段含义】用户标识,当前用户的 userId,相当于用户名,使用 UTF-8 编码。<br>【推荐取值】如果一个用户在您的账号系统中的 ID 为“mike”,则 userId 即可设置为“mike”。 |
902
933
 
903
934
  ## TRTCPublishCdnUrl
904
935
 
905
- #### 向腾讯或者第三方 CDN 上发布音视频流时需设置的 url 配置。
936
+ **向腾讯或者第三方 CDN 上发布音视频流时需设置的 url 配置。**
906
937
 
907
938
  该配置用于媒体流发布接口 startPublishMediaStream 中的目标推流配置 (TRTCPublishTarget)
908
939
  | 枚举类型 | 描述 |
@@ -912,7 +943,7 @@ TRTC 中的“音效”特指一些短暂的音频文件,通常仅有几秒钟
912
943
 
913
944
  ## TRTCPublishTarget
914
945
 
915
- #### 目标推流配置。
946
+ **目标推流配置。**
916
947
 
917
948
  该配置用于媒体流发布接口 startPublishMediaStream。
918
949
  | 枚举类型 | 描述 |
@@ -923,7 +954,7 @@ TRTC 中的“音效”特指一些短暂的音频文件,通常仅有几秒钟
923
954
 
924
955
  ## TRTCVideoLayout
925
956
 
926
- #### 转码视频布局。
957
+ **转码视频布局。**
927
958
 
928
959
  该配置用于媒体流发布接口(startPublishMediaStream)中的转码配置(TRTCStreamMixingConfig)。
929
960
 
@@ -943,7 +974,7 @@ TRTC 中的“音效”特指一些短暂的音频文件,通常仅有几秒钟
943
974
 
944
975
  ## TRTCWatermark
945
976
 
946
- #### 水印布局。
977
+ **水印布局。**
947
978
 
948
979
  该配置用于媒体流发布接口 (startPublishMediaStream) 中的转码配置 (TRTCStreamMixingConfig)
949
980
  | 枚举类型 | 描述 |
@@ -957,7 +988,7 @@ TRTC 中的“音效”特指一些短暂的音频文件,通常仅有几秒钟
957
988
 
958
989
  ## TRTCStreamEncoderParam
959
990
 
960
- #### 媒体流编码输出参数。
991
+ **媒体流编码输出参数。**
961
992
 
962
993
  【字段含义】该配置用于媒体流发布接口(startPublishMediaStream)。
963
994
 
@@ -980,7 +1011,7 @@ TRTC 中的“音效”特指一些短暂的音频文件,通常仅有几秒钟
980
1011
 
981
1012
  ## TRTCStreamMixingConfig
982
1013
 
983
- #### 媒体流转码配置参数。
1014
+ **媒体流转码配置参数。**
984
1015
 
985
1016
  该配置用于媒体流发布接口(startPublishMediaStream)。
986
1017
 
@@ -995,7 +1026,7 @@ TRTC 中的“音效”特指一些短暂的音频文件,通常仅有几秒钟
995
1026
 
996
1027
  ## TRTCPayloadPrivateEncryptionConfig
997
1028
 
998
- #### 媒体流私有加密配置。
1029
+ **媒体流私有加密配置。**
999
1030
 
1000
1031
  该配置用于设置媒体流私有加密的算法和密钥。
1001
1032
  | 枚举类型 | 描述 |
@@ -1006,7 +1037,7 @@ TRTC 中的“音效”特指一些短暂的音频文件,通常仅有几秒钟
1006
1037
 
1007
1038
  ## TRTCAudioVolumeEvaluateParams
1008
1039
 
1009
- #### 音量评估等相关参数设置。
1040
+ **音量评估等相关参数设置。**
1010
1041
 
1011
1042
  该设置用于开启人声检测、声音频谱计算。
1012
1043
  | 枚举类型 | 描述 |