@tencentcloud/sdk-mcp 1.4.6 → 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 -11
  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 +9 -8
  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 -41
  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,130 +1,135 @@
1
- # 腾讯云实时音视频(TRTC SDK )文档
1
+ Copyright (c) 2021 Tencent. All rights reserved.
2
2
 
3
- ## 概述
4
- `TRTCCloud.h` 是腾讯云实时音视频(TRTC SDK ) iOS 平台的 API 文档,包含了推流、拉流、拉流、混流、录制等功能详细说明。
3
+ Module: TRTCCloud @ TXLiteAVSDK
4
+
5
+ Function: 腾讯云 TRTC 主功能接口
6
+
7
+ Version: 13.3
5
8
 
6
9
  ## TRTCCloud
7
- | 函数列表 | 描述 |
8
- | --- | --- |
9
- | sharedInstance | 创建 TRTCCloud 实例(单例模式)。 |
10
- | destroySharedInstance | 销毁 TRTCCloud 实例(单例模式)。 |
11
- | addDelegate: | 添加 TRTC 事件回调。 |
12
- | removeDelegate: | 移除 TRTC 事件回调。 |
13
- | delegateQueue | 设置驱动 TRTCCloudDelegate 事件回调的队列。 |
14
- | enterRoom:appScene: | 进入房间。 |
15
- | exitRoom | 离开房间。 |
16
- | switchRole: | 切换角色。 |
17
- | switchRole:privateMapKey: | 切换角色(支持设置权限位)。 |
18
- | switchRoom: | 切换房间。 |
19
- | connectOtherRoom: | 请求跨房通话。 |
20
- | disconnectOtherRoom | 退出跨房通话。 |
21
- | setDefaultStreamRecvMode:video: | 设置订阅模式(需要在进入房前设置才能生效)。 |
22
- | createSubCloud | 创建子房间实例(用于多房间并发观看)。 |
23
- | destroySubCloud: | 销毁子房间实例。 |
24
- | updateOtherRoomForwardMode: | 更改跨房主播在本房间的上行能力。 |
25
- | startPublishMediaStream:encoderParam:mixingConfig: | 开始发布媒体流。 |
26
- | updatePublishMediaStream:publishTarget:encoderParam:mixingConfig: | 更新发布媒体流。 |
27
- | stopPublishMediaStream: | 停止发布媒体流。 |
28
- | startLocalPreview:view: | 开启本地摄像头的预览画面(移动端)。 |
29
- | startLocalPreview: | 开启本地摄像头的预览画面(桌面端)。 |
30
- | updateLocalView: | 更新本地摄像头的预览画面。 |
31
- | stopLocalPreview | 停止摄像头预览。 |
32
- | muteLocalVideo:mute: | 暂停/恢复发布本地的视频流。 |
33
- | setVideoMuteImage:fps: | 设置本地画面被暂停期间的替代图片。 |
34
- | startRemoteView:streamType:view: | 订阅远端用户的视频流,并绑定视频渲染控件。 |
35
- | updateRemoteView:streamType:forUser: | 更新远端用户的视频渲染控件。 |
36
- | stopRemoteView:streamType: | 停止订阅远端用户的视频流,并释放渲染控件。 |
37
- | stopAllRemoteView | 停止订阅所有远端用户的视频流,并释放全部渲染资源。 |
38
- | muteRemoteVideoStream:streamType:mute: | 暂停/恢复订阅远端用户的视频流。 |
39
- | muteAllRemoteVideoStreams: | 暂停/恢复订阅所有远端用户的视频流。 |
40
- | setVideoEncoderParam: | 设置视频编码器的编码参数。 |
41
- | setNetworkQosParam: | 设置网络质量控制的相关参数。 |
42
- | setLocalRenderParams: | 设置本地画面的渲染参数。 |
43
- | setRemoteRenderParams:streamType:params: | 设置远端画面的渲染模式。 |
44
- | enableEncSmallVideoStream:withQuality: | 开启大小画面双路编码模式。 |
45
- | setRemoteVideoStreamType:type: | 切换指定远端用户的大小画面。 |
46
- | snapshotVideo:type:sourceType: | 视频画面截图。 |
47
- | setPerspectiveCorrectionWithUser:srcPoints:dstPoints: | 视频画面透视校正坐标设置。 |
48
- | setGravitySensorAdaptiveMode: | 设置重力感应的适配模式(11.7 及以上版本)。 |
49
- | startLocalAudio: | 开启本地音频的采集和发布。 |
50
- | stopLocalAudio | 停止本地音频的采集和发布。 |
51
- | muteLocalAudio: | 暂停/恢复发布本地的音频流。 |
52
- | muteRemoteAudio:mute: | 暂停/恢复播放远端的音频流。 |
53
- | muteAllRemoteAudio: | 暂停/恢复播放所有远端用户的音频流。 |
54
- | setAudioRoute: | 设置音频路由。 |
55
- | setRemoteAudioVolume:volume: | 设定某一个远端用户的声音播放音量。 |
56
- | setAudioCaptureVolume: | 设定本地音频的采集音量。 |
57
- | getAudioCaptureVolume | 获取本地音频的采集音量。 |
58
- | setAudioPlayoutVolume: | 设定远端音频的播放音量。 |
59
- | getAudioPlayoutVolume | 获取远端音频的播放音量。 |
60
- | enableAudioVolumeEvaluation:withParams: | 启用音量大小提示。 |
61
- | startAudioRecording: | 开始录音。 |
62
- | stopAudioRecording | 停止录音。 |
63
- | startLocalRecording: | 开启本地媒体录制。 |
64
- | stopLocalRecording | 停止本地媒体录制。 |
65
- | setRemoteAudioParallelParams: | 设置远端音频流智能并发播放策略。 |
66
- | enable3DSpatialAudioEffect: | 启用 3D 音效。 |
67
- | updateSelf3DSpatialPosition | 设置 3D 音效中自身坐标及朝向信息。 |
68
- | updateRemote3DSpatialPosition: | 设置 3D 音效中远端用户坐标信息。 |
69
- | set3DSpatialReceivingRange:range: | 设置指定用户所发出声音的可被接收范围。 |
70
- | getDeviceManager | 获取设备管理类(TXDeviceManager)。 |
71
- | getBeautyManager | 获取美颜管理类(TXBeautyManager)。 |
72
- | setWatermark:streamType:rect: | 添加水印。 |
73
- | getAudioEffectManager | 获取音效管理类(TXAudioEffectManager)。 |
74
- | startSystemAudioLoopback | 开启系统声音采集(iOS 端暂未支持)。 |
75
- | stopSystemAudioLoopback | 停止系统声音采集(iOS 端暂未支持)。 |
76
- | setSystemAudioLoopbackVolume: | 设置系统声音的采集音量。 |
77
- | startScreenCaptureInApp:encParam: | 开始应用内的屏幕分享(仅支持 iOS 13.0 及以上系统)。 |
78
- | startScreenCaptureByReplaykit:encParam:appGroup: | 开始全系统的屏幕分享(仅支持 iOS 11.0 及以上系统)。 |
79
- | startScreenCapture:streamType:encParam: | 启动屏幕分享。 |
80
- | stopScreenCapture | 停止屏幕分享。 |
81
- | pauseScreenCapture | 暂停屏幕分享。 |
82
- | resumeScreenCapture | 恢复屏幕分享。 |
83
- | getScreenCaptureSourcesWithThumbnailSize:iconSize: | 枚举可分享的屏幕和窗口(该接口仅支持 Mac OS 系统)。 |
84
- | selectScreenCaptureTarget:rect:capturesCursor:highlight: | 选取要分享的屏幕或窗口(该接口仅支持 Mac OS 系统)。 |
85
- | setSubStreamEncoderParam: | 设置屏幕分享(即辅路)的视频编码参数(桌面系统和移动系统均已支持)。 |
86
- | setSubStreamMixVolume: | 设置屏幕分享时的混音音量大小(该接口仅支持桌面系统)。 |
87
- | addExcludedShareWindow: | 将指定窗口加入屏幕分享的排除列表中(该接口仅支持桌面系统)。 |
88
- | removeExcludedShareWindow: | 将指定窗口从屏幕分享的排除列表中移除(该接口仅支持桌面系统)。 |
89
- | removeAllExcludedShareWindows | 将所有窗口从屏幕分享的排除列表中移除(该接口仅支持桌面系统)。 |
90
- | addIncludedShareWindow: | 将指定窗口加入屏幕分享的包含列表中(该接口仅支持桌面系统)。 |
91
- | removeIncludedShareWindow: | 将指定窗口从屏幕分享的包含列表中移除(该接口仅支持桌面系统)。 |
92
- | removeAllIncludedShareWindows | 将全部窗口从屏幕分享的包含列表中移除(该接口仅支持桌面系统)。 |
93
- | enableCustomVideoCapture:enable: | 启用/关闭视频自定义采集模式。 |
94
- | sendCustomVideoData:frame: | 向 SDK 投送自己采集的视频帧。 |
95
- | enableCustomAudioCapture: | 启用音频自定义采集模式。 |
96
- | sendCustomAudioData: | 向 SDK 投送自己采集的音频数据。 |
97
- | enableMixExternalAudioFrame:playout: | 启用/关闭自定义音轨。 |
98
- | mixExternalAudioFrame: | 向 SDK 混入自定义音轨。 |
99
- | setMixExternalAudioVolume:playoutVolume: | 设置推流时混入外部音频的推流音量和播放音量。 |
100
- | generateCustomPTS | 生成自定义采集时的时间戳。 |
101
- | setLocalVideoProcessDelegete:pixelFormat:bufferType: | 设置第三方美颜的视频数据回调。 |
102
- | setLocalVideoRenderDelegate:pixelFormat:bufferType: | 设置本地视频自定义渲染回调。 |
103
- | setRemoteVideoRenderDelegate:delegate:pixelFormat:bufferType: | 设置远端视频自定义渲染回调。 |
104
- | setAudioFrameDelegate: | 设置音频数据自定义回调。 |
105
- | setCapturedAudioFrameDelegateFormat: | 设置本地麦克风采集出的音频帧回调格式。 |
106
- | setLocalProcessedAudioFrameDelegateFormat: | 设置经过前处理后的本地音频帧回调格式。 |
107
- | setMixedPlayAudioFrameDelegateFormat: | 设置最终要由系统播放出的音频帧回调格式。 |
108
- | enableCustomAudioRendering: | 开启音频自定义播放。 |
109
- | getCustomAudioRenderingFrame: | 获取可播放的音频数据。 |
110
- | sendCustomCmdMsg:data:reliable:ordered: | 使用 UDP 通道发送自定义消息给房间内所有用户。 |
111
- | sendSEIMsg:repeatCount: | 使用 SEI 通道发送自定义消息给房间内所有用户。 |
112
- | startSpeedTest: | 开始进行网速测试(进入房间前使用)。 |
113
- | stopSpeedTest | 停止网络测速。 |
114
- | getSDKVersion | 获取 SDK 版本信息。 |
115
- | setLogLevel: | 设置 Log 输出级别。 |
116
- | setConsoleEnabled: | 启用/禁用控制台日志打印。 |
117
- | setLogCompressEnabled: | 启用/禁用日志的本地压缩。 |
118
- | setLogDirPath: | 设置本地日志的保存路径。 |
119
- | setLogDelegate: | 设置日志回调。 |
120
- | showDebugView: | 显示仪表盘。 |
121
- | setDebugViewMargin:margin: | 设置仪表盘的边距。 |
122
- | callExperimentalAPI: | 调用实验性接口。 |
123
- | enablePayloadPrivateEncryption:params: | 开启或关闭媒体流私有加密。 |
10
+
11
+ |函数列表|描述|
12
+ |---------|---------|
13
+ |sharedInstance|创建 TRTCCloud 实例(单例模式)。|
14
+ |destroySharedInstance|销毁 TRTCCloud 实例(单例模式)。|
15
+ |addDelegate:|添加 TRTC 事件回调。|
16
+ |removeDelegate:|移除 TRTC 事件回调。|
17
+ |delegateQueue|设置驱动 TRTCCloudDelegate 事件回调的队列。|
18
+ |enterRoom:appScene:|进入房间。|
19
+ |exitRoom|离开房间。|
20
+ |switchRole:|切换角色。|
21
+ |switchRole:privateMapKey:|切换角色(支持设置权限位)。|
22
+ |switchRoom:|切换房间。|
23
+ |connectOtherRoom:|请求跨房通话。|
24
+ |disconnectOtherRoom|退出跨房通话。|
25
+ |setDefaultStreamRecvMode:video:|设置订阅模式(需要在进入房前设置才能生效)。|
26
+ |createSubCloud|创建子房间实例(用于多房间并发观看)。|
27
+ |destroySubCloud:|销毁子房间实例。|
28
+ |updateOtherRoomForwardMode:|更改跨房主播在本房间的上行能力。|
29
+ |startPublishMediaStream:encoderParam:mixingConfig:|开始发布媒体流。|
30
+ |updatePublishMediaStream:publishTarget:encoderParam:mixingConfig:|更新发布媒体流。|
31
+ |stopPublishMediaStream:|停止发布媒体流。|
32
+ |startLocalPreview:view:|开启本地摄像头的预览画面(移动端)。|
33
+ |startLocalPreview:|开启本地摄像头的预览画面(桌面端)。|
34
+ |updateLocalView:|更新本地摄像头的预览画面。|
35
+ |stopLocalPreview|停止摄像头预览。|
36
+ |muteLocalVideo:mute:|暂停/恢复发布本地的视频流。|
37
+ |setVideoMuteImage:fps:|设置本地画面被暂停期间的替代图片。|
38
+ |startRemoteView:streamType:view:|订阅远端用户的视频流,并绑定视频渲染控件。|
39
+ |updateRemoteView:streamType:forUser:|更新远端用户的视频渲染控件。|
40
+ |stopRemoteView:streamType:|停止订阅远端用户的视频流,并释放渲染控件。|
41
+ |stopAllRemoteView|停止订阅所有远端用户的视频流,并释放全部渲染资源。|
42
+ |muteRemoteVideoStream:streamType:mute:|暂停/恢复订阅远端用户的视频流。|
43
+ |muteAllRemoteVideoStreams:|暂停/恢复订阅所有远端用户的视频流。|
44
+ |setVideoEncoderParam:|设置视频编码器的编码参数。|
45
+ |setNetworkQosParam:|设置网络质量控制的相关参数。|
46
+ |setLocalRenderParams:|设置本地画面的渲染参数。|
47
+ |setRemoteRenderParams:streamType:params:|设置远端画面的渲染模式。|
48
+ |enableEncSmallVideoStream:withQuality:|开启大小画面双路编码模式。|
49
+ |setRemoteVideoStreamType:type:|切换指定远端用户的大小画面。|
50
+ |snapshotVideo:type:sourceType:|视频画面截图。|
51
+ |setPerspectiveCorrectionWithUser:srcPoints:dstPoints:|视频画面透视校正坐标设置。|
52
+ |setGravitySensorAdaptiveMode:|设置重力感应的适配模式(11.7 及以上版本)。|
53
+ |startLocalAudio:|开启本地音频的采集和发布。|
54
+ |stopLocalAudio|停止本地音频的采集和发布。|
55
+ |muteLocalAudio:|暂停/恢复发布本地的音频流。|
56
+ |muteRemoteAudio:mute:|暂停/恢复播放远端的音频流。|
57
+ |muteAllRemoteAudio:|暂停/恢复播放所有远端用户的音频流。|
58
+ |setAudioRoute:|设置音频路由。|
59
+ |setRemoteAudioVolume:volume:|设定某一个远端用户的声音播放音量。|
60
+ |setAudioCaptureVolume:|设定本地音频的采集音量。|
61
+ |getAudioCaptureVolume|获取本地音频的采集音量。|
62
+ |setAudioPlayoutVolume:|设定远端音频的播放音量。|
63
+ |getAudioPlayoutVolume|获取远端音频的播放音量。|
64
+ |enableAudioVolumeEvaluation:withParams:|启用音量大小提示。|
65
+ |startAudioRecording:|开始录音。|
66
+ |stopAudioRecording|停止录音。|
67
+ |startLocalRecording:|开启本地媒体录制。|
68
+ |stopLocalRecording|停止本地媒体录制。|
69
+ |setRemoteAudioParallelParams:|设置远端音频流智能并发播放策略。|
70
+ |enable3DSpatialAudioEffect:|启用 3D 音效。|
71
+ |updateSelf3DSpatialPosition|设置 3D 音效中自身坐标及朝向信息。|
72
+ |updateRemote3DSpatialPosition:|设置 3D 音效中远端用户坐标信息。|
73
+ |set3DSpatialReceivingRange:range:|设置指定用户所发出声音的可被接收范围。|
74
+ |getDeviceManager|获取设备管理类(TXDeviceManager)。|
75
+ |getBeautyManager|获取美颜管理类(TXBeautyManager)。|
76
+ |setWatermark:streamType:rect:|添加水印。|
77
+ |getAudioEffectManager|获取音效管理类(TXAudioEffectManager)。|
78
+ |startSystemAudioLoopback|开启系统声音采集(iOS 端暂未支持)。|
79
+ |stopSystemAudioLoopback|停止系统声音采集(iOS 端暂未支持)。|
80
+ |setSystemAudioLoopbackVolume:|设置系统声音的采集音量。|
81
+ |getAITranscriberManager|获取 AI 转录管理类(AITranscriberManager)。|
82
+ |startScreenCaptureInApp:encParam:|开始应用内的屏幕分享(仅支持 iOS 13.0 及以上系统)。|
83
+ |startScreenCaptureByReplaykit:encParam:appGroup:|开始全系统的屏幕分享(仅支持 iOS 11.0 及以上系统)。|
84
+ |startScreenCapture:streamType:encParam:|启动屏幕分享。|
85
+ |stopScreenCapture|停止屏幕分享。|
86
+ |pauseScreenCapture|暂停屏幕分享。|
87
+ |resumeScreenCapture|恢复屏幕分享。|
88
+ |getScreenCaptureSourcesWithThumbnailSize:iconSize:|枚举可分享的屏幕和窗口(该接口仅支持 Mac OS 系统)。|
89
+ |selectScreenCaptureTarget:rect:capturesCursor:highlight:|选取要分享的屏幕或窗口(该接口仅支持 Mac OS 系统)。|
90
+ |setSubStreamEncoderParam:|设置屏幕分享(即辅路)的视频编码参数(桌面系统和移动系统均已支持)。|
91
+ |setSubStreamMixVolume:|设置屏幕分享时的混音音量大小(该接口仅支持桌面系统)。|
92
+ |addExcludedShareWindow:|将指定窗口加入屏幕分享的排除列表中(该接口仅支持桌面系统)。|
93
+ |removeExcludedShareWindow:|将指定窗口从屏幕分享的排除列表中移除(该接口仅支持桌面系统)。|
94
+ |removeAllExcludedShareWindows|将所有窗口从屏幕分享的排除列表中移除(该接口仅支持桌面系统)。|
95
+ |addIncludedShareWindow:|将指定窗口加入屏幕分享的包含列表中(该接口仅支持桌面系统)。|
96
+ |removeIncludedShareWindow:|将指定窗口从屏幕分享的包含列表中移除(该接口仅支持桌面系统)。|
97
+ |removeAllIncludedShareWindows|将全部窗口从屏幕分享的包含列表中移除(该接口仅支持桌面系统)。|
98
+ |enableCustomVideoCapture:enable:|启用/关闭视频自定义采集模式。|
99
+ |sendCustomVideoData:frame:|向 SDK 投送自己采集的视频帧。|
100
+ |enableCustomAudioCapture:|启用音频自定义采集模式。|
101
+ |sendCustomAudioData:|向 SDK 投送自己采集的音频数据。|
102
+ |enableMixExternalAudioFrame:playout:|启用/关闭自定义音轨。|
103
+ |mixExternalAudioFrame:|向 SDK 混入自定义音轨。|
104
+ |setMixExternalAudioVolume:playoutVolume:|设置推流时混入外部音频的推流音量和播放音量。|
105
+ |generateCustomPTS|生成自定义采集时的时间戳。|
106
+ |setLocalVideoProcessDelegete:pixelFormat:bufferType:|设置第三方美颜的视频数据回调。|
107
+ |setLocalVideoRenderDelegate:pixelFormat:bufferType:|设置本地视频自定义渲染回调。|
108
+ |setRemoteVideoRenderDelegate:delegate:pixelFormat:bufferType:|设置远端视频自定义渲染回调。|
109
+ |setAudioFrameDelegate:|设置音频数据自定义回调。|
110
+ |setCapturedAudioFrameDelegateFormat:|设置本地麦克风采集出的音频帧回调格式。|
111
+ |setLocalProcessedAudioFrameDelegateFormat:|设置经过前处理后的本地音频帧回调格式。|
112
+ |setMixedPlayAudioFrameDelegateFormat:|设置最终要由系统播放出的音频帧回调格式。|
113
+ |enableCustomAudioRendering:|开启音频自定义播放。|
114
+ |getCustomAudioRenderingFrame:|获取可播放的音频数据。|
115
+ |sendCustomCmdMsg:data:reliable:ordered:|使用 UDP 通道发送自定义消息给房间内所有用户。|
116
+ |sendSEIMsg:repeatCount:|使用 SEI 通道发送自定义消息给房间内所有用户。|
117
+ |startSpeedTest:|开始进行网速测试(进入房间前使用)。|
118
+ |stopSpeedTest|停止网络测速。|
119
+ |getSDKVersion|获取 SDK 版本信息。|
120
+ |setLogLevel:|设置 Log 输出级别。|
121
+ |setConsoleEnabled:|启用/禁用控制台日志打印。|
122
+ |setLogCompressEnabled:|启用/禁用日志的本地压缩。|
123
+ |setLogDirPath:|设置本地日志的保存路径。|
124
+ |setLogDelegate:|设置日志回调。|
125
+ |showDebugView:|显示仪表盘。|
126
+ |setDebugViewMargin:margin:|设置仪表盘的边距。|
127
+ |callExperimentalAPI:|调用实验性接口。|
128
+ |enablePayloadPrivateEncryption:params:|开启或关闭媒体流私有加密。|
124
129
 
125
130
  ## sharedInstance
126
131
 
127
- #### 创建 TRTCCloud 实例(单例模式)。
132
+ **创建 TRTCCloud 实例(单例模式)。**
128
133
 
129
134
  > **注意**
130
135
  >
@@ -134,21 +139,21 @@
134
139
 
135
140
  ## destroySharedInstance
136
141
 
137
- #### 销毁 TRTCCloud 实例(单例模式)。
142
+ **销毁 TRTCCloud 实例(单例模式)。**
138
143
 
139
144
  ## addDelegate:
140
145
 
141
- #### 添加 TRTC 事件回调。
146
+ **添加 TRTC 事件回调。**
142
147
 
143
148
  您可以通过 TRTCCloudDelegate 获得来自 SDK 的各类事件通知(例如:错误码,警告码,音视频状态参数等)。
144
149
 
145
150
  ## removeDelegate:
146
151
 
147
- #### 移除 TRTC 事件回调。
152
+ **移除 TRTC 事件回调。**
148
153
 
149
154
  ## delegateQueue
150
155
 
151
- #### 设置驱动 TRTCCloudDelegate 事件回调的队列。
156
+ **设置驱动 TRTCCloudDelegate 事件回调的队列。**
152
157
 
153
158
  如果您不指定自己的 ` delegateQueue `,SDK 默认会采用 MainQueue 作为驱动 TRTCCloudDelegate 事件回调的队列。
154
159
 
@@ -162,7 +167,7 @@
162
167
 
163
168
  ## enterRoom:appScene:
164
169
 
165
- #### 进入房间。
170
+ **进入房间。**
166
171
 
167
172
  TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视频流,“发布”是指将自己的音频和视频推送到云端,“订阅”是指从云端拉取房间里其他用户的音视频流。
168
173
 
@@ -181,10 +186,10 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
181
186
 
182
187
  - 如果进房失败,参数 ` result ` 会是一个负数(result < 0),表示进房失败的[错误码](https://cloud.tencent.com/document/product/647/32257)。
183
188
 
184
- | 参数 | 描述 |
185
- | --- | --- |
186
- | param | 进房参数,用于指定用户的身份、角色和安全票据等信息,详情请参见 TRTCParams 。 |
187
- | scene | 应用场景,用于指定您的业务场景,同一个房间内的所有用户需要设定相同的 TRTCAppScene。 |
189
+ |参数|描述|
190
+ |---------|---------|
191
+ |param|进房参数,用于指定用户的身份、角色和安全票据等信息,详情请参见 TRTCParams 。|
192
+ |scene|应用场景,用于指定您的业务场景,同一个房间内的所有用户需要设定相同的 TRTCAppScene。|
188
193
 
189
194
  > **注意**
190
195
  >
@@ -200,7 +205,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
200
205
 
201
206
  ## exitRoom
202
207
 
203
- #### 离开房间。
208
+ **离开房间。**
204
209
 
205
210
  调用该接口会让用户离开自己所在的音视频房间,并释放摄像头、麦克风、扬声器等设备资源。
206
211
 
@@ -210,7 +215,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
210
215
 
211
216
  ## switchRole:
212
217
 
213
- #### 切换角色。
218
+ **切换角色。**
214
219
 
215
220
  调用本接口可以实现用户在“主播”和“观众”两种角色之间来回切换。
216
221
 
@@ -219,7 +224,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
219
224
  您可以在进入房间时通过 TRTCParams 中的 ` role ` 字段事先确定用户的角色,也可以在进入房间后通过该接口动态切换角色。
220
225
  | 参数 | 描述 |
221
226
  | --- | --- |
222
- | role | 角色,默认为 **主播**。<br>- TRTCRoleAnchor :主播,可以发布自己的音视频,同一个房间里最多支持50个主播同时发布音视频。<br>- TRTCRoleAudience :观众,不能发布自己的音视频流,只能观看房间中其他主播的音视频。如果要发布自己的音视频,需要先通过 switchRole 切换成 **主播**,同一个房间内同时最多可以容纳 10 万名观众。 |
227
+ | role | 角色,默认为 <strong>主播</strong>。<br>- TRTCRoleAnchor :主播,可以发布自己的音视频,同一个房间里最多支持50个主播同时发布音视频。<br>- TRTCRoleAudience :观众,不能发布自己的音视频流,只能观看房间中其他主播的音视频。如果要发布自己的音视频,需要先通过 switchRole 切换成 <strong>主播</strong>,同一个房间内同时最多可以容纳 10 万名观众。 |
223
228
 
224
229
  > **注意**
225
230
  >
@@ -232,7 +237,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
232
237
 
233
238
  ## switchRole:privateMapKey:
234
239
 
235
- #### 切换角色(支持设置权限位)。
240
+ **切换角色(支持设置权限位)。**
236
241
 
237
242
  调用本接口可以实现用户在“主播”和“观众”两种角色之间来回切换。
238
243
 
@@ -241,8 +246,8 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
241
246
  您可以在进入房间时通过 TRTCParams 中的 ` role ` 字段事先确定用户的角色,也可以在进入房间后通过该接口动态切换角色。
242
247
  | 参数 | 描述 |
243
248
  | --- | --- |
244
- | privateMapKey | 用于权限控制的权限票据,当您希望某个房间只能让特定的 userId 进入或者上行视频时,需要使用 ` privateMapKey ` 进行权限保护。<br>- 仅建议有高级别安全需求的客户使用,更多详情请参见 [开启高级权限控制](https://cloud.tencent.com/document/product/647/32240)。 |
245
- | role | 角色,默认为 **主播**。<br>- TRTCRoleAnchor :主播,可以发布自己的音视频,同一个房间里最多支持50个主播同时发布音视频。<br>- TRTCRoleAudience :观众,不能发布自己的音视频流,只能观看房间中其他主播的音视频。如果要发布自己的音视频,需要先通过 switchRole 切换成 **主播**,同一个房间内同时最多可以容纳 10 万名观众。 |
249
+ | privateMapKey | 用于权限控制的权限票据,当您希望某个房间只能让特定的 userId 进入或者上行视频时,需要使用 <code> privateMapKey </code> 进行权限保护。<br>- 仅建议有高级别安全需求的客户使用,更多详情请参见 <a href="https://cloud.tencent.com/document/product/647/32240">开启高级权限控制</a>。 |
250
+ | role | 角色,默认为 <strong>主播</strong>。<br>- TRTCRoleAnchor :主播,可以发布自己的音视频,同一个房间里最多支持50个主播同时发布音视频。<br>- TRTCRoleAudience :观众,不能发布自己的音视频流,只能观看房间中其他主播的音视频。如果要发布自己的音视频,需要先通过 switchRole 切换成 <strong>主播</strong>,同一个房间内同时最多可以容纳 10 万名观众。 |
246
251
 
247
252
  > **注意**
248
253
  >
@@ -255,7 +260,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
255
260
 
256
261
  ## switchRoom:
257
262
 
258
- #### 切换房间。
263
+ **切换房间。**
259
264
 
260
265
  使用该接口可以让用户快速从一个房间切换到另一个房间。
261
266
  - 如果用户的身份是“观众”,该接口的调用效果等同于 ` exitRoom(当前房间) + enterRoom(新的房间) `。
@@ -265,9 +270,10 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
265
270
  该接口适用于在线教育场景中,监课老师在多个房间中进行快速切换的场景。在该场景下使用 ` switchRoom ` 可以获得比 ` exitRoom + enterRoom ` 更好的流畅性和更少的代码量。
266
271
 
267
272
  接口调用结果会通过 TRTCCloudDelegate 中的 onSwitchRoom 回调。
268
- | 参数 | 描述 |
269
- | --- | --- |
270
- | config | 房间参数,详情请参见 TRTCSwitchRoomConfig。 |
273
+
274
+ |参数|描述|
275
+ |---------|---------|
276
+ |config|房间参数,详情请参见 TRTCSwitchRoomConfig。|
271
277
 
272
278
  > **注意**
273
279
  >
@@ -283,7 +289,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
283
289
 
284
290
  ## connectOtherRoom:
285
291
 
286
- #### 请求跨房通话。
292
+ **请求跨房通话。**
287
293
 
288
294
  默认情况下,只有同一个房间中的用户之间可以进行音视频通话,不同的房间之间的音视频流是相互隔离的。
289
295
 
@@ -327,19 +333,20 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
327
333
  NSString* jsonString = [[NSString alloc] initWithData:jsonData encoding:NSUTF8StringEncoding];
328
334
  [trtc connectOtherRoom:jsonString];
329
335
  ```
330
- | 参数 | 描述 |
331
- | --- | --- |
332
- | param | 需要您传入 JSON 格式的字符串参数,` roomId ` 代表数字格式的房间号,` strRoomId ` 代表字符串格式的房间号,` userId ` 代表目标主播的用户 ID。 |
336
+
337
+ |参数|描述|
338
+ |---------|---------|
339
+ |param|需要您传入 JSON 格式的字符串参数,` roomId ` 代表数字格式的房间号,` strRoomId ` 代表字符串格式的房间号,` userId ` 代表目标主播的用户 ID。|
333
340
 
334
341
  ## disconnectOtherRoom
335
342
 
336
- #### 退出跨房通话。
343
+ **退出跨房通话。**
337
344
 
338
345
  退出结果会通过 TRTCCloudDelegate 中的 onDisconnectOtherRoom 回调通知给您。
339
346
 
340
347
  ## setDefaultStreamRecvMode:video:
341
348
 
342
- #### 设置订阅模式(需要在进入房前设置才能生效)。
349
+ **设置订阅模式(需要在进入房前设置才能生效)。**
343
350
 
344
351
  您可以通过该接口在“自动订阅”和“手动订阅”两种模式下进行切换:
345
352
  - 自动订阅:默认模式,用户在进入房间后会立刻接收到该房间中的音视频流,音频会自动播放,视频会自动开始解码(依然需要您通过 startRemoteView 接口绑定渲染控件)。
@@ -349,10 +356,11 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
349
356
  在绝大多数场景下,用户进入房间后都会订阅房间中所有主播的音视频流,因此 TRTC 默认采用了自动订阅模式,以求得最佳的“秒开体验”。
350
357
 
351
358
  如果您的应用场景中每个房间同时会有很多路音视频流在发布,而每个用户只想选择性地订阅其中的 1-2 路,则推荐使用“手动订阅”模式以节省流量费用。
352
- | 参数 | 描述 |
353
- | --- | --- |
354
- | autoRecvAudio | YES:自动订阅音频;NO:需手动调用 ` muteRemoteAudio(NO) ` 订阅音频。默认值:YES。 |
355
- | autoRecvVideo | YES:自动订阅视频;NO:需手动调用 ` startRemoteView ` 订阅视频。默认值:YES。 |
359
+
360
+ |参数|描述|
361
+ |---------|---------|
362
+ |autoRecvAudio|YES:自动订阅音频;NO:需手动调用 ` muteRemoteAudio(NO) ` 订阅音频。默认值:YES。|
363
+ |autoRecvVideo|YES:自动订阅视频;NO:需手动调用 ` startRemoteView ` 订阅视频。默认值:YES。|
356
364
 
357
365
  > **注意**
358
366
  >
@@ -365,7 +373,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
365
373
 
366
374
  ## createSubCloud
367
375
 
368
- #### 创建子房间实例(用于多房间并发观看)。
376
+ **创建子房间实例(用于多房间并发观看)。**
369
377
 
370
378
  TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的能力。
371
379
 
@@ -417,21 +425,21 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
417
425
  >
418
426
  > - 多实例的音频需要同时为麦克风采集或自定义采集,而且与音频设备相关的接口调用会以最后一次为准;
419
427
  > - 与摄像头相关的调用会以最后一次为准:startLocalPreview。
420
-
421
- #### 返回值说明:
428
+ **返回值说明:**
422
429
 
423
430
  子 TRTCCloud 实例
424
431
 
425
432
  ## destroySubCloud:
426
433
 
427
- #### 销毁子房间实例。
428
- | 参数 | 描述 |
429
- | --- | --- |
430
- | subCloud | 子房间实例 |
434
+ **销毁子房间实例。**
435
+
436
+ |参数|描述|
437
+ |---------|---------|
438
+ |subCloud|子房间实例|
431
439
 
432
440
  ## updateOtherRoomForwardMode:
433
441
 
434
- #### 更改跨房主播在本房间的上行能力。
442
+ **更改跨房主播在本房间的上行能力。**
435
443
 
436
444
  通常情况下,在调用 connectOtherRoom 接口与另一个房间的主播进行跨房通话后,本房间内的所有观众都将收到该主播发布的音视频流。
437
445
 
@@ -476,20 +484,22 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
476
484
  "muteSubStream":false
477
485
  }
478
486
  ```
479
- | 参数 | 描述 |
480
- | --- | --- |
481
- | param | 需要您传入 JSON 格式的字符串参数,` roomId ` 代表数字格式的房间号,` strRoomId ` 代表字符串格式的房间号,` userId ` 代表目标主播的用户 ID,` muteAudio `, ` muteVideo `,` muteSubStream ` 均为可选项,分表代表禁止或允许跨房主播发布音频/主路视频/辅路视频的能力。 |
487
+
488
+ |参数|描述|
489
+ |---------|---------|
490
+ |param|需要您传入 JSON 格式的字符串参数,` roomId ` 代表数字格式的房间号,` strRoomId ` 代表字符串格式的房间号,` userId ` 代表目标主播的用户 ID,` muteAudio `, ` muteVideo `,` muteSubStream ` 均为可选项,分别代表禁止或允许跨房主播发布音频/主路视频/辅路视频的能力。|
482
491
 
483
492
  ## startPublishMediaStream:encoderParam:mixingConfig:
484
493
 
485
- #### 开始发布媒体流。
494
+ **开始发布媒体流。**
486
495
 
487
496
  该接口会向 TRTC 服务器发送指令,要求其将当前用户的音视频流转推/转码到直播 CDN 或者回推到 TRTC 房间中您可以通过 TRTCPublishTarget 配置中的 TRTCPublishMode 指定具体的发布模式
488
- | 参数 | 描述 |
489
- | --- | --- |
490
- | config | 媒体流转码配置参数。具体配置参考 TRTCStreamMixingConfig。转码和回推到 TRTC 房间中时为必填项,您需要指定您预期的转码配置参数。转推模式下则无效。 |
491
- | params | 媒体流编码输出参数,具体配置参考 TRTCStreamEncoderParam。转码和回推到 TRTC 房间中时为必填项,您需要指定您预期的转码输出参数。在转推时,为了更好的转推稳定性和 CDN 兼容性,也建议您进行配置。 |
492
- | target | 媒体流发布的目标地址,具体配置参考 TRTCPublishTarget。支持转推/转码到腾讯或者第三方 CDN,也支持转码回推到 TRTC 房间中。 |
497
+
498
+ |参数|描述|
499
+ |---------|---------|
500
+ |config|媒体流转码配置参数。具体配置参考 TRTCStreamMixingConfig。转码和回推到 TRTC 房间中时为必填项,您需要指定您预期的转码配置参数。转推模式下则无效。|
501
+ |params|媒体流编码输出参数,具体配置参考 TRTCStreamEncoderParam。转码和回推到 TRTC 房间中时为必填项,您需要指定您预期的转码输出参数。在转推时,为了更好的转推稳定性和 CDN 兼容性,也建议您进行配置。|
502
+ |target|媒体流发布的目标地址,具体配置参考 TRTCPublishTarget。支持转推/转码到腾讯或者第三方 CDN,也支持转码回推到 TRTC 房间中。|
493
503
 
494
504
  > **注意**
495
505
  >
@@ -508,15 +518,16 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
508
518
 
509
519
  ## updatePublishMediaStream:publishTarget:encoderParam:mixingConfig:
510
520
 
511
- #### 更新发布媒体流。
521
+ **更新发布媒体流。**
512
522
 
513
523
  该接口会向 TRTC 服务器发送指令,更新通过 startPublishMediaStream 启动的媒体流
514
- | 参数 | 描述 |
515
- | --- | --- |
516
- | config | 媒体流转码配置参数。具体配置参考 TRTCStreamMixingConfig。转码和回推到 TRTC 房间中时为必填项,您需要指定您预期的转码配置参数。转推模式下则无效。 |
517
- | params | 媒体流编码输出参数,具体配置参考 TRTCStreamEncoderParam。转码和回推到 TRTC 房间中时为必填项,您需要指定您预期的转码输出参数。在转推时,为了更好的转推稳定性和 CDN 兼容性,也建议您进行配置。 |
518
- | target | 媒体流发布的目标地址,具体配置参考 TRTCPublishTarget。支持转推/转码到腾讯或者第三方 CDN,也支持转码回推到 TRTC 房间中。 |
519
- | taskId | 通过回调 onStartPublishMediaStream 带给您后台启动的任务标识(即 taskId) |
524
+
525
+ |参数|描述|
526
+ |---------|---------|
527
+ |config|媒体流转码配置参数。具体配置参考 TRTCStreamMixingConfig。转码和回推到 TRTC 房间中时为必填项,您需要指定您预期的转码配置参数。转推模式下则无效。|
528
+ |params|媒体流编码输出参数,具体配置参考 TRTCStreamEncoderParam。转码和回推到 TRTC 房间中时为必填项,您需要指定您预期的转码输出参数。在转推时,为了更好的转推稳定性和 CDN 兼容性,也建议您进行配置。|
529
+ |target|媒体流发布的目标地址,具体配置参考 TRTCPublishTarget。支持转推/转码到腾讯或者第三方 CDN,也支持转码回推到 TRTC 房间中。|
530
+ |taskId|通过回调 onStartPublishMediaStream 带给您后台启动的任务标识(即 taskId)|
520
531
 
521
532
  > **注意**
522
533
  >
@@ -532,12 +543,13 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
532
543
 
533
544
  ## stopPublishMediaStream:
534
545
 
535
- #### 停止发布媒体流。
546
+ **停止发布媒体流。**
536
547
 
537
548
  该接口会向 TRTC 服务器发送指令,停止通过 startPublishMediaStream 启动的媒体流
538
- | 参数 | 描述 |
539
- | --- | --- |
540
- | taskId | 通过回调 onStartPublishMediaStream 带给您后台启动的任务标识(即 taskId) |
549
+
550
+ |参数|描述|
551
+ |---------|---------|
552
+ |taskId|通过回调 onStartPublishMediaStream 带给您后台启动的任务标识(即 taskId)|
541
553
 
542
554
  > **注意**
543
555
  >
@@ -550,17 +562,18 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
550
562
 
551
563
  ## startLocalPreview:view:
552
564
 
553
- #### 开启本地摄像头的预览画面(移动端)。
565
+ **开启本地摄像头的预览画面(移动端)。**
554
566
 
555
567
  在 enterRoom 之前调用此函数,SDK 只会开启摄像头,并一直等到您调用 enterRoom 之后才开始推流。
556
568
 
557
569
  在 enterRoom 之后调用此函数,SDK 会开启摄像头并自动开始视频推流。
558
570
 
559
571
  当开始渲染首帧摄像头画面时,您会收到 TRTCCloudDelegate 中的 onCameraDidReady 回调通知。
560
- | 参数 | 描述 |
561
- | --- | --- |
562
- | frontCamera | YES:前置摄像头;NO:后置摄像头。 |
563
- | view | 承载视频画面的控件。 |
572
+
573
+ |参数|描述|
574
+ |---------|---------|
575
+ |frontCamera|YES:前置摄像头;NO:后置摄像头。|
576
+ |view|承载视频画面的控件。|
564
577
 
565
578
  > **注意**
566
579
  >
@@ -572,7 +585,7 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
572
585
 
573
586
  ## startLocalPreview:
574
587
 
575
- #### 开启本地摄像头的预览画面(桌面端)。
588
+ **开启本地摄像头的预览画面(桌面端)。**
576
589
 
577
590
  在调用该接口之前,您可以先调用 setCurrentDevice 选择使用桌面端设备自带摄像头或外接摄像头。
578
591
 
@@ -581,9 +594,10 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
581
594
  在 enterRoom 之后调用此函数,SDK 会开启摄像头并自动开始视频推流。
582
595
 
583
596
  当开始渲染首帧摄像头画面时,您会收到 TRTCCloudDelegate 中的 onCameraDidReady 回调通知。
584
- | 参数 | 描述 |
585
- | --- | --- |
586
- | view | 承载视频画面的控件。 |
597
+
598
+ |参数|描述|
599
+ |---------|---------|
600
+ |view|承载视频画面的控件。|
587
601
 
588
602
  > **注意**
589
603
  >
@@ -595,15 +609,15 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
595
609
 
596
610
  ## updateLocalView:
597
611
 
598
- #### 更新本地摄像头的预览画面。
612
+ **更新本地摄像头的预览画面。**
599
613
 
600
614
  ## stopLocalPreview
601
615
 
602
- #### 停止摄像头预览。
616
+ **停止摄像头预览。**
603
617
 
604
618
  ## muteLocalVideo:mute:
605
619
 
606
- #### 暂停/恢复发布本地的视频流。
620
+ **暂停/恢复发布本地的视频流。**
607
621
 
608
622
  该接口可以暂停(或恢复)发布本地的视频画面,暂停之后,同一房间中的其他用户将无法继续看到自己画面。
609
623
 
@@ -616,24 +630,26 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
616
630
  当暂停/恢复发布指定 TRTCVideoStreamTypeBig 后,同一房间中的其他用户将会收到 onUserVideoAvailable 回调通知。
617
631
 
618
632
  当暂停/恢复发布指定 TRTCVideoStreamTypeSub 后,同一房间中的其他用户将会收到 onUserSubStreamAvailable 回调通知。
619
- | 参数 | 描述 |
620
- | --- | --- |
621
- | mute | YES:暂停;NO:恢复。 |
622
- | streamType | 要暂停/恢复的视频流类型(仅支持 TRTCVideoStreamTypeBig 和 TRTCVideoStreamTypeSub)。 |
633
+
634
+ |参数|描述|
635
+ |---------|---------|
636
+ |mute|YES:暂停;NO:恢复。|
637
+ |streamType|要暂停/恢复的视频流类型(仅支持 TRTCVideoStreamTypeBig 和 TRTCVideoStreamTypeSub)。|
623
638
 
624
639
  ## setVideoMuteImage:fps:
625
640
 
626
- #### 设置本地画面被暂停期间的替代图片。
641
+ **设置本地画面被暂停期间的替代图片。**
627
642
 
628
643
  当您调用 ` muteLocalVideo(YES) ` 暂停本地画面时,您可以通过调用本接口设置一张替代图片,设置后,房间中的其他用户会看到这张替代图片,而不是黑屏画面。
629
- | 参数 | 描述 |
630
- | --- | --- |
631
- | fps | 设置替代图片帧率,最小值为5,最大值为10,默认5。 |
632
- | image | 设置替代图片,空值代表在 muteLocalVideo 之后不再发送视频流数据,默认值为空。 |
644
+
645
+ |参数|描述|
646
+ |---------|---------|
647
+ |fps|设置替代图片帧率,最小值为5,最大值为10,默认5。|
648
+ |image|设置替代图片,空值代表在 muteLocalVideo 之后不再发送视频流数据,默认值为空。|
633
649
 
634
650
  ## startRemoteView:streamType:view:
635
651
 
636
- #### 订阅远端用户的视频流,并绑定视频渲染控件。
652
+ **订阅远端用户的视频流,并绑定视频渲染控件。**
637
653
 
638
654
  调用该接口可以让 SDK 拉取指定 userId 的视频流,并渲染到参数 ` view ` 指定的渲染控件上。您可以通过 setRemoteRenderParams 设置画面的显示模式。
639
655
  - 如果您已经知道房间中有视频流的用户的 userId,可以直接调用 ` startRemoteView ` 订阅该用户的画面。
@@ -664,18 +680,19 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
664
680
 
665
681
  ## updateRemoteView:streamType:forUser:
666
682
 
667
- #### 更新远端用户的视频渲染控件。
683
+ **更新远端用户的视频渲染控件。**
668
684
 
669
685
  该接口可用于更新远端视频画面的渲染控件,常被用于切换显示区域的交互场景中。
670
- | 参数 | 描述 |
671
- | --- | --- |
672
- | streamType | 要设置预览窗口的流类型(仅支持 TRTCVideoStreamTypeBig 和 TRTCVideoStreamTypeSub)。 |
673
- | userId | 指定远端用户的 ID。 |
674
- | view | 承载视频画面的控件。 |
686
+
687
+ |参数|描述|
688
+ |---------|---------|
689
+ |streamType|要设置预览窗口的流类型(仅支持 TRTCVideoStreamTypeBig 和 TRTCVideoStreamTypeSub)。|
690
+ |userId|指定远端用户的 ID。|
691
+ |view|承载视频画面的控件。|
675
692
 
676
693
  ## stopRemoteView:streamType:
677
694
 
678
- #### 停止订阅远端用户的视频流,并释放渲染控件。
695
+ **停止订阅远端用户的视频流,并释放渲染控件。**
679
696
 
680
697
  调用此接口会让 SDK 停止接收该用户的视频流,并释放该路视频流的解码和渲染资源。
681
698
  | 参数 | 描述 |
@@ -685,7 +702,7 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
685
702
 
686
703
  ## stopAllRemoteView
687
704
 
688
- #### 停止订阅所有远端用户的视频流,并释放全部渲染资源。
705
+ **停止订阅所有远端用户的视频流,并释放全部渲染资源。**
689
706
 
690
707
  调用此接口会让 SDK 停止接收所有来自远端的视频流,并释放全部的解码和渲染资源。
691
708
 
@@ -697,7 +714,7 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
697
714
 
698
715
  ## muteRemoteVideoStream:streamType:mute:
699
716
 
700
- #### 暂停/恢复订阅远端用户的视频流。
717
+ **暂停/恢复订阅远端用户的视频流。**
701
718
 
702
719
  该接口仅暂停/恢复接收指定用户的视频流,但并不释放显示资源,视频画面会被冻屏在接口调用时的最后一帧。
703
720
  | 参数 | 描述 |
@@ -714,12 +731,13 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
714
731
 
715
732
  ## muteAllRemoteVideoStreams:
716
733
 
717
- #### 暂停/恢复订阅所有远端用户的视频流。
734
+ **暂停/恢复订阅所有远端用户的视频流。**
718
735
 
719
736
  该接口仅暂停/恢复接收所有用户的视频流,但并不释放显示资源,视频画面会被冻屏在接口调用时的最后一帧。
720
- | 参数 | 描述 |
721
- | --- | --- |
722
- | mute | 是否暂停接收。 |
737
+
738
+ |参数|描述|
739
+ |---------|---------|
740
+ |mute|是否暂停接收。|
723
741
 
724
742
  > **注意**
725
743
  >
@@ -732,12 +750,13 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
732
750
 
733
751
  ## setVideoEncoderParam:
734
752
 
735
- #### 设置视频编码器的编码参数。
753
+ **设置视频编码器的编码参数。**
736
754
 
737
755
  该设置能够决定远端用户看到的画面质量,同时也能决定云端录制出的视频文件的画面质量。
738
- | 参数 | 描述 |
739
- | --- | --- |
740
- | param | 用于设置视频编码器的相关参数,详情请参见 TRTCVideoEncParam。 |
756
+
757
+ |参数|描述|
758
+ |---------|---------|
759
+ |param|用于设置视频编码器的相关参数,详情请参见 TRTCVideoEncParam。|
741
760
 
742
761
  > **注意**
743
762
  >
@@ -747,66 +766,70 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
747
766
 
748
767
  ## setNetworkQosParam:
749
768
 
750
- #### 设置网络质量控制的相关参数。
769
+ **设置网络质量控制的相关参数。**
751
770
 
752
771
  该设置决定在差网络环境下的质量调控策略,如“画质优先”或“流畅优先”等策略。
753
- | 参数 | 描述 |
754
- | --- | --- |
755
- | param | 用于设置网络质量控制的相关参数,详情请参见 TRTCNetworkQosParam。 |
772
+
773
+ |参数|描述|
774
+ |---------|---------|
775
+ |param|用于设置网络质量控制的相关参数,详情请参见 TRTCNetworkQosParam。|
756
776
 
757
777
  ## setLocalRenderParams:
758
778
 
759
- #### 设置本地画面的渲染参数。
779
+ **设置本地画面的渲染参数。**
760
780
 
761
781
  可设置的参数包括有:画面的旋转角度、填充模式以及左右镜像等。
762
- | 参数 | 描述 |
763
- | --- | --- |
764
- | params | 画面渲染参数,详情请参见 TRTCRenderParams。 |
782
+
783
+ |参数|描述|
784
+ |---------|---------|
785
+ |params|画面渲染参数,详情请参见 TRTCRenderParams。|
765
786
 
766
787
  ## setRemoteRenderParams:streamType:params:
767
788
 
768
- #### 设置远端画面的渲染模式。
789
+ **设置远端画面的渲染模式。**
769
790
 
770
791
  可设置的参数包括有:画面的旋转角度、填充模式以及左右镜像等。
771
- | 参数 | 描述 |
772
- | --- | --- |
773
- | params | 画面渲染参数,详情请参见 TRTCRenderParams。 |
774
- | streamType | 可以设置为主路画面(TRTCVideoStreamTypeBig)或辅路画面(TRTCVideoStreamTypeSub)。 |
775
- | userId | 指定远端用户的 ID。 |
792
+
793
+ |参数|描述|
794
+ |---------|---------|
795
+ |params|画面渲染参数,详情请参见 TRTCRenderParams。|
796
+ |streamType|可以设置为主路画面(TRTCVideoStreamTypeBig)或辅路画面(TRTCVideoStreamTypeSub)。|
797
+ |userId|指定远端用户的 ID。|
776
798
 
777
799
  ## enableEncSmallVideoStream:withQuality:
778
800
 
779
- #### 开启大小画面双路编码模式。
801
+ **开启大小画面双路编码模式。**
780
802
 
781
803
  开启双路编码模式后,当前用户的编码器会同时输出【高清大画面】和【低清小画面】两路视频流(但只有一路音频流)。
782
804
 
783
805
  如此以来,房间中的其他用户就可以根据自身的网络情况或屏幕大小选择订阅【高清大画面】或是【低清小画面】。
784
- | 参数 | 描述 |
785
- | --- | --- |
786
- | enable | 是否开启小画面编码,默认值:NO。 |
787
- | smallVideoEncParam | 小流的视频参数。 |
806
+
807
+ |参数|描述|
808
+ |---------|---------|
809
+ |enable|是否开启小画面编码,默认值:NO。|
810
+ |smallVideoEncParam|小流的视频参数。|
788
811
 
789
812
  > **注意**
790
813
  >
791
814
 
792
815
  > 双路编码开启后,会消耗更多的 CPU 和 网络带宽,所以 Mac、Windows 或者高性能 Pad 可以考虑开启,不建议手机端开启。
793
816
  >
794
-
795
- #### 返回值说明:
817
+ **返回值说明:**
796
818
 
797
819
  0:成功;-1:当前大画面已被设置为较低画质,开启双路编码已无必要。
798
820
 
799
821
  ## setRemoteVideoStreamType:type:
800
822
 
801
- #### 切换指定远端用户的大小画面。
823
+ **切换指定远端用户的大小画面。**
802
824
 
803
825
  当房间中某个主播开启了双路编码之后,房间中其他用户通过 startRemoteView 订阅到的画面默认会是【高清大画面】。
804
826
 
805
827
  您可以通过此接口选定希望订阅的画面是大画面还是小画面,该接口在 startRemoteView 之前和之后调用均可生效。
806
- | 参数 | 描述 |
807
- | --- | --- |
808
- | streamType | 视频流类型,即选择看大画面还是小画面,默认为大画面。 |
809
- | userId | 指定远端用户的 ID。 |
828
+
829
+ |参数|描述|
830
+ |---------|---------|
831
+ |streamType|视频流类型,即选择看大画面还是小画面,默认为大画面。|
832
+ |userId|指定远端用户的 ID。|
810
833
 
811
834
  > **注意**
812
835
  >
@@ -816,14 +839,15 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
816
839
 
817
840
  ## snapshotVideo:type:sourceType:
818
841
 
819
- #### 视频画面截图。
842
+ **视频画面截图。**
820
843
 
821
844
  您可以通过本接口截取本地的视频画面,远端用户的主路画面以及远端用户的辅路(屏幕分享)画面。
822
- | 参数 | 描述 |
823
- | --- | --- |
824
- | sourceType | 画面来源,可选择截取视频流画面(TRTCSnapshotSourceTypeStream)、视频渲染画面(TRTCSnapshotSourceTypeView)或 采集画面(TRTCSnapshotSourceTypeCapture),采集画面截图更清晰。 |
825
- | streamType | 视频流类型,可选择截取主路画面(TRTCVideoStreamTypeBig,常用于摄像头)或辅路画面(TRTCVideoStreamTypeSub,常用于屏幕分享)。 |
826
- | userId | 用户 ID,如指定空置表示截取本地的视频画面。 |
845
+
846
+ |参数|描述|
847
+ |---------|---------|
848
+ |sourceType|画面来源,可选择截取视频流画面(TRTCSnapshotSourceTypeStream)、视频渲染画面(TRTCSnapshotSourceTypeView)或 采集画面(TRTCSnapshotSourceTypeCapture),采集画面截图更清晰。|
849
+ |streamType|视频流类型,可选择截取主路画面(TRTCVideoStreamTypeBig,常用于摄像头)或辅路画面(TRTCVideoStreamTypeSub,常用于屏幕分享)。|
850
+ |userId|用户 ID,如指定空置表示截取本地的视频画面。|
827
851
 
828
852
  > **注意**
829
853
  >
@@ -833,18 +857,19 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
833
857
 
834
858
  ## setPerspectiveCorrectionWithUser:srcPoints:dstPoints:
835
859
 
836
- #### 视频画面透视校正坐标设置。
860
+ **视频画面透视校正坐标设置。**
837
861
 
838
862
  您可以通过本接口指定渲染画面透视校正的坐标区域。
839
- | 参数 | 描述 |
840
- | --- | --- |
841
- | dstPoints | 期望校正到的目标坐标区域4个顶点坐标,需按照左上、左下、右上、右下的顺序传入,所有的坐标需要根据画面宽高做 [0,1] 区间的归一化;传 null 则停止透视校正。 |
842
- | srcPoints | 原始画面坐标区域4个顶点坐标,需按照左上、左下、右上、右下的顺序传入,所有的坐标需要根据画面宽高做 [0,1] 区间的归一化; 传 null 则停止透视校正。 |
843
- | userId | 用户 ID,如指定空值表示校正本地的视频画面。 |
863
+
864
+ |参数|描述|
865
+ |---------|---------|
866
+ |dstPoints|期望校正到的目标坐标区域4个顶点坐标,需按照左上、左下、右上、右下的顺序传入,所有的坐标需要根据画面宽高做 [0,1] 区间的归一化;传 null 则停止透视校正。|
867
+ |srcPoints|原始画面坐标区域4个顶点坐标,需按照左上、左下、右上、右下的顺序传入,所有的坐标需要根据画面宽高做 [0,1] 区间的归一化; 传 null 则停止透视校正。|
868
+ |userId|用户 ID,如指定空值表示校正本地的视频画面。|
844
869
 
845
870
  ## setGravitySensorAdaptiveMode:
846
871
 
847
- #### 设置重力感应的适配模式(11.7 及以上版本)。
872
+ **设置重力感应的适配模式(11.7 及以上版本)。**
848
873
 
849
874
  开启重力感应后,如果采集端的设备发生旋转,采集端和观众端的画面都会进行相应地渲染以确保视野中的画面始终朝上。
850
875
 
@@ -853,13 +878,14 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
853
878
  1. 该接口仅对采集端起作用,如果只是观看房间中的画面,开启此接口是无效的
854
879
 
855
880
  2. 当采集端设备发生 90 度或 270 度旋转时,采集端或者观众看到的画面可能会被裁剪以保持比例的协调
856
- | 参数 | 描述 |
857
- | --- | --- |
858
- | mode | 重力感应模式,详情请参见 TRTCGravitySensorAdaptiveMode_Disable、TRTCGravitySensorAdaptiveMode_FillByCenterCrop 和 TRTCGravitySensorAdaptiveMode_FitWithBlackBorder 默认值:TRTCGravitySensorAdaptiveMode_Disable。 |
881
+
882
+ |参数|描述|
883
+ |---------|---------|
884
+ |mode|重力感应模式,详情请参见 TRTCGravitySensorAdaptiveMode_Disable、TRTCGravitySensorAdaptiveMode_FillByCenterCrop 和 TRTCGravitySensorAdaptiveMode_FitWithBlackBorder 默认值:TRTCGravitySensorAdaptiveMode_Disable。|
859
885
 
860
886
  ## startLocalAudio:
861
887
 
862
- #### 开启本地音频的采集和发布。
888
+ **开启本地音频的采集和发布。**
863
889
 
864
890
  SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调用该接口开启麦克风采集,并将音频编码并发布到当前的房间中。
865
891
 
@@ -876,13 +902,13 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
876
902
 
877
903
  ## stopLocalAudio
878
904
 
879
- #### 停止本地音频的采集和发布。
905
+ **停止本地音频的采集和发布。**
880
906
 
881
907
  停止本地音频的采集和发布后,房间中的其他用户会收到 onUserAudioAvailable(userId, NO) 的通知。
882
908
 
883
909
  ## muteLocalAudio:
884
910
 
885
- #### 暂停/恢复发布本地的音频流。
911
+ **暂停/恢复发布本地的音频流。**
886
912
 
887
913
  当您暂停发布本地音频流之后,房间中的其他用户会收到 onUserAudioAvailable(userId, NO) 的通知。
888
914
 
@@ -893,19 +919,21 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
893
919
  这对于需要云端录制的场景非常适用,因为 MP4 等格式的视频文件,对于音频数据的连续性要求很高,使用 stopLocalAudio 会导致录制出的 MP4 文件不易播放。
894
920
 
895
921
  因此在对录制文件的质量要求较高的场景中,建议选择 ` muteLocalAudio ` 而不建议使用 stopLocalAudio。
896
- | 参数 | 描述 |
897
- | --- | --- |
898
- | mute | YES:静音;NO:恢复。 |
922
+
923
+ |参数|描述|
924
+ |---------|---------|
925
+ |mute|YES:静音;NO:恢复。|
899
926
 
900
927
  ## muteRemoteAudio:mute:
901
928
 
902
- #### 暂停/恢复播放远端的音频流。
929
+ **暂停/恢复播放远端的音频流。**
903
930
 
904
931
  当您静音某用户的远端音频时,SDK 会停止播放指定用户的声音,同时也会停止拉取该用户的音频数据。
905
- | 参数 | 描述 |
906
- | --- | --- |
907
- | mute | YES:静音;NO:取消静音。 |
908
- | userId | 用于指定远端用户的 ID。 |
932
+
933
+ |参数|描述|
934
+ |---------|---------|
935
+ |mute|YES:静音;NO:取消静音。|
936
+ |userId|用于指定远端用户的 ID。|
909
937
 
910
938
  > **注意**
911
939
  >
@@ -915,12 +943,13 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
915
943
 
916
944
  ## muteAllRemoteAudio:
917
945
 
918
- #### 暂停/恢复播放所有远端用户的音频流。
946
+ **暂停/恢复播放所有远端用户的音频流。**
919
947
 
920
948
  当您静音所有用户的远端音频时,SDK 会停止播放所有来自远端的音频流,同时也会停止拉取所有用户的音频数据。
921
- | 参数 | 描述 |
922
- | --- | --- |
923
- | mute | YES:静音;NO:取消静音。 |
949
+
950
+ |参数|描述|
951
+ |---------|---------|
952
+ |mute|YES:静音;NO:取消静音。|
924
953
 
925
954
  > **注意**
926
955
  >
@@ -930,7 +959,7 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
930
959
 
931
960
  ## setAudioRoute:
932
961
 
933
- #### 设置音频路由。
962
+ **设置音频路由。**
934
963
 
935
964
  设置“音频路由”,即设置声音是从手机的扬声器还是从听筒中播放出来,因此该接口仅适用于手机等移动端设备。
936
965
 
@@ -939,19 +968,21 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
939
968
  设置音频路由为听筒时,声音比较小,只有将耳朵凑近才能听清楚,隐私性较好,适合用于接听电话。
940
969
 
941
970
  设置音频路由为扬声器时,声音比较大,不用将手机贴脸也能听清,因此可以实现“免提”的功能。
942
- | 参数 | 描述 |
943
- | --- | --- |
944
- | route | 音频路由,即声音由哪里输出(扬声器、听筒),默认值:TRTCAudioModeSpeakerphone。 |
971
+
972
+ |参数|描述|
973
+ |---------|---------|
974
+ |route|音频路由,即声音由哪里输出(扬声器、听筒),默认值:TRTCAudioModeSpeakerphone。|
945
975
 
946
976
  ## setRemoteAudioVolume:volume:
947
977
 
948
- #### 设定某一个远端用户的声音播放音量。
978
+ **设定某一个远端用户的声音播放音量。**
949
979
 
950
980
  您可以通过 ` setRemoteAudioVolume(userId, 0) ` 将某一个远端用户的声音静音。
951
- | 参数 | 描述 |
952
- | --- | --- |
953
- | userId | 用于指定远端用户的 ID。 |
954
- | volume | 音量大小,取值范围为 [0, 150],默认值:100。 |
981
+
982
+ |参数|描述|
983
+ |---------|---------|
984
+ |userId|用于指定远端用户的 ID。|
985
+ |volume|音量大小,取值范围为 [0, 150],默认值:100。|
955
986
 
956
987
  > **注意**
957
988
  >
@@ -961,10 +992,11 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
961
992
 
962
993
  ## setAudioCaptureVolume:
963
994
 
964
- #### 设定本地音频的采集音量。
965
- | 参数 | 描述 |
966
- | --- | --- |
967
- | volume | 音量大小,取值范围为 [0, 150];默认值:100。 |
995
+ **设定本地音频的采集音量。**
996
+
997
+ |参数|描述|
998
+ |---------|---------|
999
+ |volume|音量大小,取值范围为 [0, 150];默认值:100。|
968
1000
 
969
1001
  > **注意**
970
1002
  >
@@ -974,20 +1006,19 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
974
1006
 
975
1007
  ## getAudioCaptureVolume
976
1008
 
977
- #### 获取本地音频的采集音量。
978
-
979
- #### 返回值说明:
1009
+ **获取本地音频的采集音量。****返回值说明:**
980
1010
 
981
1011
  采集音量。
982
1012
 
983
1013
  ## setAudioPlayoutVolume:
984
1014
 
985
- #### 设定远端音频的播放音量。
1015
+ **设定远端音频的播放音量。**
986
1016
 
987
1017
  该接口会控制 SDK 最终交给系统播放的声音音量,调节效果会影响到本地音频录制文件的音量大小,但不会影响到耳返的音量大小。
988
- | 参数 | 描述 |
989
- | --- | --- |
990
- | volume | 音量大小,取值范围为 [0, 150],默认值:100。 |
1018
+
1019
+ |参数|描述|
1020
+ |---------|---------|
1021
+ |volume|音量大小,取值范围为 [0, 150],默认值:100。|
991
1022
 
992
1023
  > **注意**
993
1024
  >
@@ -997,17 +1028,18 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
997
1028
 
998
1029
  ## getAudioPlayoutVolume
999
1030
 
1000
- #### 获取远端音频的播放音量。
1031
+ **获取远端音频的播放音量。**
1001
1032
 
1002
1033
  ## enableAudioVolumeEvaluation:withParams:
1003
1034
 
1004
- #### 启用音量大小提示。
1035
+ **启用音量大小提示。**
1005
1036
 
1006
1037
  开启此功能后,SDK 会在 TRTCCloudDelegate 中的 onUserVoiceVolume 回调中反馈本地和远端用户的音频音量评估信息,包括音量大小、人声检测、音频频谱等。
1007
- | 参数 | 描述 |
1008
- | --- | --- |
1009
- | enable | 是否启用音量提示,默认为关闭状态。 |
1010
- | params | 音量评估等相关参数,请参见 TRTCAudioVolumeEvaluateParams。 |
1038
+
1039
+ |参数|描述|
1040
+ |---------|---------|
1041
+ |enable|是否启用音量提示,默认为关闭状态。|
1042
+ |params|音量评估等相关参数,请参见 TRTCAudioVolumeEvaluateParams。|
1011
1043
 
1012
1044
  > **注意**
1013
1045
  >
@@ -1017,77 +1049,81 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
1017
1049
 
1018
1050
  ## startAudioRecording:
1019
1051
 
1020
- #### 开始录音。
1052
+ **开始录音。**
1021
1053
 
1022
1054
  当您调用该接口后, SDK 会将本地和远端的所有音频(包括本地音频,远端音频,背景音乐和音效等)混合并录制到一个本地文件中。
1023
1055
 
1024
1056
  该接口在进入房间前后调用均可生效,如果录制任务在退出房间前尚未通过 stopAudioRecording 停止,则退出房间后录制任务会自动被停止。
1025
1057
 
1026
1058
  本次录制的启动、完成状态会通过本地录制相关回调进行通知。参见 TRTCCloudDelegate 相关回调。
1027
- | 参数 | 描述 |
1028
- | --- | --- |
1029
- | param | 录音参数,请参见 TRTCAudioRecordingParams。 |
1059
+
1060
+ |参数|描述|
1061
+ |---------|---------|
1062
+ |param|录音参数,请参见 TRTCAudioRecordingParams。|
1030
1063
 
1031
1064
  > **注意**
1032
1065
  >
1033
1066
 
1034
1067
  > 自 v11.5 版本,音频录制的状态结果由返回值统一调整为异步回调进行通知。参见 TRTCCloudDelegate 相关回调。
1035
1068
  >
1036
-
1037
- #### 返回值说明:
1069
+ **返回值说明:**
1038
1070
 
1039
1071
  0:成功;-1:录音已开始;-2:文件或目录创建失败;-3:后缀指定的音频格式不支持。
1040
1072
 
1041
1073
  ## stopAudioRecording
1042
1074
 
1043
- #### 停止录音。
1075
+ **停止录音。**
1044
1076
 
1045
1077
  如果录制任务在退出房间前尚未通过本接口停止,则退出房间后录音任务会自动被停止。
1046
1078
 
1047
1079
  ## startLocalRecording:
1048
1080
 
1049
- #### 开启本地媒体录制。
1081
+ **开启本地媒体录制。**
1050
1082
 
1051
1083
  开启后把直播过程中的音视频内容录制到本地的一个文件中,该功能不会产生额外费用。
1052
- | 参数 | 描述 |
1053
- | --- | --- |
1054
- | params | 录制参数,请参见 TRTCLocalRecordingParams。 |
1084
+
1085
+ |参数|描述|
1086
+ |---------|---------|
1087
+ |params|录制参数,请参见 TRTCLocalRecordingParams。|
1055
1088
 
1056
1089
  ## stopLocalRecording
1057
1090
 
1058
- #### 停止本地媒体录制。
1091
+ **停止本地媒体录制。**
1059
1092
 
1060
1093
  如果录制任务在退出房间前尚未通过本接口停止,则退出房间后录音任务会自动被停止。
1061
1094
 
1062
1095
  ## setRemoteAudioParallelParams:
1063
1096
 
1064
- #### 设置远端音频流智能并发播放策略。
1097
+ **设置远端音频流智能并发播放策略。**
1065
1098
 
1066
1099
  设置远端音频流智能并发播放策略,适用于上麦人数比较多的场景。
1067
- | 参数 | 描述 |
1068
- | --- | --- |
1069
- | params | 音频并发参数,请参见 TRTCAudioParallelParams。 |
1100
+
1101
+ |参数|描述|
1102
+ |---------|---------|
1103
+ |params|音频并发参数,请参见 TRTCAudioParallelParams。|
1070
1104
 
1071
1105
  ## enable3DSpatialAudioEffect:
1072
1106
 
1073
- #### 启用 3D 音效。
1107
+ **启用 3D 音效。**
1074
1108
 
1075
1109
  启用 3D 音效。注意需使用流畅音质 TRTCAudioQualitySpeech 或默认音质 TRTCAudioQualityDefault。
1076
- | 参数 | 描述 |
1077
- | --- | --- |
1078
- | enabled | 是否启用 3D 音效,默认为关闭状态。 |
1110
+
1111
+ |参数|描述|
1112
+ |---------|---------|
1113
+ |enabled|是否启用 3D 音效,默认为关闭状态。|
1079
1114
 
1080
1115
  ## updateSelf3DSpatialPosition
1081
1116
 
1082
- #### 设置 3D 音效中自身坐标及朝向信息。
1117
+ **设置 3D 音效中自身坐标及朝向信息。**
1083
1118
 
1084
1119
  更新自身在世界坐标系中的位置和朝向, SDK 会根据该方法参数计算自身和远端用户之间的相对位置,进而渲染出空间音效。
1085
- | 参数 | 描述 |
1086
- | --- | --- |
1087
- | axisForward | 自身坐标系前轴在世界坐标系中的单位向量,三个值依次表示前、右、上坐标值。 |
1088
- | axisRight | 自身坐标系右轴在世界坐标系中的单位向量,三个值依次表示前、右、上坐标值。 |
1089
- | axisUp | 自身坐标系上轴在世界坐标系中的单位向量,三个值依次表示前、右、上坐标值。 |
1090
- | position | 自身在世界坐标系中的坐标,三个值依次表示前、右、上坐标值。 |
1120
+
1121
+ |参数|描述|
1122
+ |---------|---------|
1123
+ |axisForward|自身坐标系前轴在世界坐标系中的单位向量,三个值依次表示前、右、上坐标值。|
1124
+ |axisRight|自身坐标系右轴在世界坐标系中的单位向量,三个值依次表示前、右、上坐标值。|
1125
+ |axisUp|自身坐标系上轴在世界坐标系中的单位向量,三个值依次表示前、右、上坐标值。|
1126
+ |position|自身在世界坐标系中的坐标,三个值依次表示前、右、上坐标值。|
1091
1127
 
1092
1128
  > **注意**
1093
1129
  >
@@ -1100,13 +1136,14 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
1100
1136
 
1101
1137
  ## updateRemote3DSpatialPosition:
1102
1138
 
1103
- #### 设置 3D 音效中远端用户坐标信息。
1139
+ **设置 3D 音效中远端用户坐标信息。**
1104
1140
 
1105
1141
  更新远端用户在世界坐标系中的位置,SDK 会根据自身和远端用户之间的相对位置,进而渲染出空间音效。
1106
- | 参数 | 描述 |
1107
- | --- | --- |
1108
- | position | 该远端用户在世界坐标系中的坐标,三个值依次表示前、右、上坐标值。 |
1109
- | userId | 指定远端用户的 ID。 |
1142
+
1143
+ |参数|描述|
1144
+ |---------|---------|
1145
+ |position|该远端用户在世界坐标系中的坐标,三个值依次表示前、右、上坐标值。|
1146
+ |userId|指定远端用户的 ID。|
1110
1147
 
1111
1148
  > **注意**
1112
1149
  >
@@ -1119,27 +1156,26 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
1119
1156
 
1120
1157
  ## set3DSpatialReceivingRange:range:
1121
1158
 
1122
- #### 设置指定用户所发出声音的可被接收范围。
1159
+ **设置指定用户所发出声音的可被接收范围。**
1123
1160
 
1124
1161
  设置该范围大小之后,该指定用户的声音将在该范围内可被听见,超出该范围将被衰减为 0。
1125
- | 参数 | 描述 |
1126
- | --- | --- |
1127
- | range | 声音最大可被接收范围。 |
1128
- | userId | 指定远端用户的 ID。 |
1129
1162
 
1130
- ## getDeviceManager
1163
+ |参数|描述|
1164
+ |---------|---------|
1165
+ |range|声音最大可被接收范围。|
1166
+ |userId|指定远端用户的 ID。|
1131
1167
 
1132
- #### 获取设备管理类(TXDeviceManager)。
1168
+ ## getDeviceManager
1133
1169
 
1134
- 通过设备管理,您可以设置摄像头、麦克风和扬声器等音视频相关的硬件设备功能。
1170
+ **获取设备管理类(TXDeviceManager)。**
1135
1171
 
1136
- #### 返回值说明:
1172
+ 通过设备管理,您可以设置摄像头、麦克风和扬声器等音视频相关的硬件设备功能。**返回值说明:**
1137
1173
 
1138
1174
  设备管理类 TXDeviceManager。
1139
1175
 
1140
1176
  ## getBeautyManager
1141
1177
 
1142
- #### 获取美颜管理类(TXBeautyManager)。
1178
+ **获取美颜管理类(TXBeautyManager)。**
1143
1179
 
1144
1180
  通过美颜管理,您可以使用以下功能:
1145
1181
  - 设置“磨皮”、“美白”、“红润”等美颜特效。
@@ -1153,14 +1189,13 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
1153
1189
  - 设置“眼影”、“腮红”等美妆特效。
1154
1190
 
1155
1191
  - 设置动态贴纸和人脸挂件等动画特效。
1156
-
1157
- #### 返回值说明:
1192
+ **返回值说明:**
1158
1193
 
1159
1194
  美颜管理类 TXBeautyManager。
1160
1195
 
1161
1196
  ## setWatermark:streamType:rect:
1162
1197
 
1163
- #### 添加水印。
1198
+ **添加水印。**
1164
1199
 
1165
1200
  水印的位置是通过 rect 参数来指定的,rect 是一个四元组参数,其格式为 (x,y,width,height)
1166
1201
  - x:水印的坐标,取值范围为 [0, 1] 的浮点数。
@@ -1176,11 +1211,12 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
1176
1211
  如果当前视频的编码分辨率是 540 × 960,且 rect 参数设置为(0.1,0.1,0.2,0.0),
1177
1212
 
1178
1213
  那么水印的左上坐标点就是(540 × 0.1,960 × 0.1)即(54,96),水印的宽度是 ` 540 × 0.2 = 108px `,水印的高度会根据水印图片的宽高比由 SDK 自动算出。
1179
- | 参数 | 描述 |
1180
- | --- | --- |
1181
- | image | 水印图片,**必须使用透明底色的 png 格式**。 |
1182
- | rect | 水印相对于编码分辨率的归一化坐标,x,y,width,height 取值范围 [0, 1]。 |
1183
- | streamType | 指定给哪一路画面设置水印,详情请参见TRTCVideoStreamType。 |
1214
+
1215
+ |参数|描述|
1216
+ |---------|---------|
1217
+ |image|水印图片,**必须使用透明底色的 png 格式**。|
1218
+ |rect|水印相对于编码分辨率的归一化坐标,x,y,width,height 取值范围 [0, 1]。|
1219
+ |streamType|指定给哪一路画面设置水印,详情请参见TRTCVideoStreamType。|
1184
1220
 
1185
1221
  > **注意**
1186
1222
  >
@@ -1190,7 +1226,7 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
1190
1226
 
1191
1227
  ## getAudioEffectManager
1192
1228
 
1193
- #### 获取音效管理类(TXAudioEffectManager)。
1229
+ **获取音效管理类(TXAudioEffectManager)。**
1194
1230
 
1195
1231
  TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如下功能:
1196
1232
  - 背景音乐:支持在线音乐和本地音乐,支持变速、变调等特效、支持原生和伴奏并播放和循环播放。
@@ -1202,14 +1238,13 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
1202
1238
  - 变声特效:萝莉、大叔、重金属等。
1203
1239
 
1204
1240
  - 短音效:鼓掌声、欢笑声等简短的音效文件(对于小于10秒的文件,请将 isShortFile 参数设置为 YES)。
1205
-
1206
- #### 返回值说明:
1241
+ **返回值说明:**
1207
1242
 
1208
1243
  音效管理类 TXAudioEffectManager。
1209
1244
 
1210
1245
  ## startSystemAudioLoopback
1211
1246
 
1212
- #### 开启系统声音采集(iOS 端暂未支持)。
1247
+ **开启系统声音采集(iOS 端暂未支持)。**
1213
1248
 
1214
1249
  该接口会从电脑的声卡中采集音频数据,并将其混入到 SDK 当前的音频数据流中,从而使房间中的其他用户也能听到主播的电脑所播放出的声音。
1215
1250
 
@@ -1228,18 +1263,27 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
1228
1263
 
1229
1264
  ## stopSystemAudioLoopback
1230
1265
 
1231
- #### 停止系统声音采集(iOS 端暂未支持)。
1266
+ **停止系统声音采集(iOS 端暂未支持)。**
1232
1267
 
1233
1268
  ## setSystemAudioLoopbackVolume:
1234
1269
 
1235
- #### 设置系统声音的采集音量。
1236
- | 参数 | 描述 |
1237
- | --- | --- |
1238
- | volume | 设置的音量大小,范围是:[0, 150],默认值为 100。 |
1270
+ **设置系统声音的采集音量。**
1271
+
1272
+ |参数|描述|
1273
+ |---------|---------|
1274
+ |volume|设置的音量大小,范围是:[0, 150],默认值为 100。|
1275
+
1276
+ ## getAITranscriberManager
1277
+
1278
+ **获取 AI 转录管理类(AITranscriberManager)。**
1279
+
1280
+ 通过 AI 转录管理,您可以启动/停止实时转录服务,对指定用户的音频进行实时转录和翻译。**返回值说明:**
1281
+
1282
+ AI 转录管理类 AITranscriberManager。
1239
1283
 
1240
1284
  ## startScreenCaptureInApp:encParam:
1241
1285
 
1242
- #### 开始应用内的屏幕分享(仅支持 iOS 13.0 及以上系统)。
1286
+ **开始应用内的屏幕分享(仅支持 iOS 13.0 及以上系统)。**
1243
1287
 
1244
1288
  该接口会抓取当前应用内的实时屏幕内容并将其分享给同房间中的其他用户,适用于 13.0 以上的 iOS 系统。
1245
1289
 
@@ -1261,7 +1305,7 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1261
1305
 
1262
1306
  ## startScreenCaptureByReplaykit:encParam:appGroup:
1263
1307
 
1264
- #### 开始全系统的屏幕分享(仅支持 iOS 11.0 及以上系统)。
1308
+ **开始全系统的屏幕分享(仅支持 iOS 11.0 及以上系统)。**
1265
1309
 
1266
1310
  该接口支持抓取整个 iOS 系统的屏幕,可以实现类似腾讯会议的全系统级的屏幕分享。
1267
1311
 
@@ -1278,20 +1322,20 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1278
1322
 
1279
1323
  - 分辨率自适应(enableAdjustRes):NO。
1280
1324
 
1281
- | 参数 | 描述 |
1282
- | --- | --- |
1283
- | appGroup | 用于指定您的应用与录屏进程共享的 Application Group Identifier,您可以指定该参数为 nil,但推荐您按照文档指示进行设置,从而获得更好的可靠性。 |
1284
- | encParams | 设置屏幕分享时的视频编码参数,推荐采用上述推荐配置。如果您指定 encParams 为 nil,SDK 会使用您在调用 startScreenCapture 接口之前所设置的视频编码参数。 |
1285
- | streamType | 屏幕分享使用的线路,可以设置为主路(TRTCVideoStreamTypeBig)或者辅路(TRTCVideoStreamTypeSub)。 |
1325
+ |参数|描述|
1326
+ |---------|---------|
1327
+ |appGroup|用于指定您的应用与录屏进程共享的 Application Group Identifier,您可以指定该参数为 nil,但推荐您按照文档指示进行设置,从而获得更好的可靠性。|
1328
+ |encParams|设置屏幕分享时的视频编码参数,推荐采用上述推荐配置。如果您指定 encParams 为 nil,SDK 会使用您在调用 startScreenCapture 接口之前所设置的视频编码参数。|
1329
+ |streamType|屏幕分享使用的线路,可以设置为主路(TRTCVideoStreamTypeBig)或者辅路(TRTCVideoStreamTypeSub)。|
1286
1330
 
1287
1331
  ## startScreenCapture:streamType:encParam:
1288
1332
 
1289
- #### 启动屏幕分享。
1333
+ **启动屏幕分享。**
1290
1334
 
1291
1335
  该接口可以抓取整个屏幕的内容,或抓取您指定的某个应用的窗口内容,并将其分享给同房间中的其他用户。
1292
1336
  | 参数 | 描述 |
1293
1337
  | --- | --- |
1294
- | encParam | 屏幕分享的画面编码参数,SDK 会优先使用您通过此接口设置的编码参数:<br>- 如果您设置 ` encParam ` 为空值,且您已通过 setSubStreamEncoderParam 设置过辅路视频编码参数,SDK 将使用您设置过的辅路编码参数进行屏幕分享。<br>- 如果您设置 ` encParam ` 为空值,且您未通过 setSubStreamEncoderParam 设置过辅路视频编码参数,SDK 将自动选择一个最佳的编码参数进行屏幕分享。 |
1338
+ | encParam | 屏幕分享的画面编码参数,SDK 会优先使用您通过此接口设置的编码参数:<br>- 如果您设置 <code> encParam </code> 为空值,且您已通过 setSubStreamEncoderParam 设置过辅路视频编码参数,SDK 将使用您设置过的辅路编码参数进行屏幕分享。<br>- 如果您设置 <code> encParam </code> 为空值,且您未通过 setSubStreamEncoderParam 设置过辅路视频编码参数,SDK 将自动选择一个最佳的编码参数进行屏幕分享。 |
1295
1339
  | streamType | 屏幕分享使用的线路,可以设置为主路(TRTCVideoStreamTypeBig)或者辅路(TRTCVideoStreamTypeSub),推荐使用辅路。 |
1296
1340
  | view | 渲染控件所在的父控件,可以设置为空值,表示不显示屏幕分享的预览效果。 |
1297
1341
 
@@ -1312,11 +1356,11 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1312
1356
 
1313
1357
  ## stopScreenCapture
1314
1358
 
1315
- #### 停止屏幕分享。
1359
+ **停止屏幕分享。**
1316
1360
 
1317
1361
  ## pauseScreenCapture
1318
1362
 
1319
- #### 暂停屏幕分享。
1363
+ **暂停屏幕分享。**
1320
1364
 
1321
1365
  > **注意**
1322
1366
  >
@@ -1326,47 +1370,48 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1326
1370
 
1327
1371
  ## resumeScreenCapture
1328
1372
 
1329
- #### 恢复屏幕分享。
1373
+ **恢复屏幕分享。**
1330
1374
 
1331
1375
  ## getScreenCaptureSourcesWithThumbnailSize:iconSize:
1332
1376
 
1333
- #### 枚举可分享的屏幕和窗口(该接口仅支持 Mac OS 系统)。
1377
+ **枚举可分享的屏幕和窗口(该接口仅支持 Mac OS 系统)。**
1334
1378
 
1335
1379
  当您在对接桌面端系统的屏幕分享功能时,一般都需要展示一个选择分享目标的界面,这样用户能够使用这个界面选择是分享整个屏幕还是某个窗口。
1336
1380
 
1337
1381
  通过本接口,您就可以查询到当前系统中可用于分享的窗口的 ID、名称以及缩略图。我们在 Demo 中提供了一份默认的界面实现供您参考。
1338
- | 参数 | 描述 |
1339
- | --- | --- |
1340
- | iconSize | 指定要获取的窗口图标大小。 |
1341
- | thumbnailSize | 指定要获取的窗口缩略图大小,缩略图可用于绘制在窗口选择界面上。 |
1382
+
1383
+ |参数|描述|
1384
+ |---------|---------|
1385
+ |iconSize|指定要获取的窗口图标大小。|
1386
+ |thumbnailSize|指定要获取的窗口缩略图大小,缩略图可用于绘制在窗口选择界面上。|
1342
1387
 
1343
1388
  > **注意**
1344
1389
  >
1345
1390
 
1346
1391
  > 返回的列表中包含屏幕和应用窗口,屏幕是列表中的第一个元素。如果用户有多个显示器,那么每个显示器都是一个分享目标。
1347
1392
  >
1348
-
1349
- #### 返回值说明:
1393
+ **返回值说明:**
1350
1394
 
1351
1395
  窗口列表包括屏幕。
1352
1396
 
1353
1397
  ## selectScreenCaptureTarget:rect:capturesCursor:highlight:
1354
1398
 
1355
- #### 选取要分享的屏幕或窗口(该接口仅支持 Mac OS 系统)。
1399
+ **选取要分享的屏幕或窗口(该接口仅支持 Mac OS 系统)。**
1356
1400
 
1357
1401
  当您通过 getScreenCaptureSources 获取到可以分享的屏幕和窗口之后,您可以调用该接口选定期望分享的目标屏幕或目标窗口。
1358
1402
 
1359
1403
  在屏幕分享的过程中,您也可以随时调用该接口以切换分享目标。
1360
- | 参数 | 描述 |
1361
- | --- | --- |
1362
- | capturesCursor | 是否捕获鼠标光标。 |
1363
- | highlight | 是否高亮正在分享的窗口。 |
1364
- | rect | 指定捕获的区域(设定该参数为 CGRectZero:当分享目标是某个窗口时则分享整个窗口,当分享目标是桌面时则分享整个桌面)。 |
1365
- | screenSource | 指定分享源。 |
1404
+
1405
+ |参数|描述|
1406
+ |---------|---------|
1407
+ |capturesCursor|是否捕获鼠标光标。|
1408
+ |highlight|是否高亮正在分享的窗口。|
1409
+ |rect|指定捕获的区域(设定该参数为 CGRectZero:当分享目标是某个窗口时则分享整个窗口,当分享目标是桌面时则分享整个桌面)。|
1410
+ |screenSource|指定分享源。|
1366
1411
 
1367
1412
  ## setSubStreamEncoderParam:
1368
1413
 
1369
- #### 设置屏幕分享(即辅路)的视频编码参数(桌面系统和移动系统均已支持)。
1414
+ **设置屏幕分享(即辅路)的视频编码参数(桌面系统和移动系统均已支持)。**
1370
1415
 
1371
1416
  该接口可以设定远端用户所看到的屏幕分享(即辅路)的画面质量,同时也能决定云端录制出的视频文件中屏幕分享的画面质量。
1372
1417
 
@@ -1375,29 +1420,31 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1375
1420
 
1376
1421
  - setSubStreamEncoderParam 用于设置辅路画面(TRTCVideoStreamTypeSub,一般用于屏幕分享)的视频编码参数。
1377
1422
 
1378
- | 参数 | 描述 |
1379
- | --- | --- |
1380
- | param | 辅流编码参数,详情请参见 TRTCVideoEncParam。 |
1423
+ |参数|描述|
1424
+ |---------|---------|
1425
+ |param|辅流编码参数,详情请参见 TRTCVideoEncParam。|
1381
1426
 
1382
1427
  ## setSubStreamMixVolume:
1383
1428
 
1384
- #### 设置屏幕分享时的混音音量大小(该接口仅支持桌面系统)。
1429
+ **设置屏幕分享时的混音音量大小(该接口仅支持桌面系统)。**
1385
1430
 
1386
1431
  这个数值越高,屏幕分享音量的占比就越高,麦克风音量占比就越小,所以不推荐设置得太大,否则会导致麦克风的声音被压制。
1387
- | 参数 | 描述 |
1388
- | --- | --- |
1389
- | volume | 设置的混音音量大小,范围 [0, 150]。 |
1432
+
1433
+ |参数|描述|
1434
+ |---------|---------|
1435
+ |volume|设置的混音音量大小,范围 [0, 150]。|
1390
1436
 
1391
1437
  ## addExcludedShareWindow:
1392
1438
 
1393
- #### 将指定窗口加入屏幕分享的排除列表中(该接口仅支持桌面系统)。
1439
+ **将指定窗口加入屏幕分享的排除列表中(该接口仅支持桌面系统)。**
1394
1440
 
1395
1441
  加入排除列表中的窗口不会被分享出去,常见的用法是将某个应用的窗口加入到排除列表中以避免隐私问题。
1396
1442
 
1397
1443
  支持启动屏幕分享前设置过滤窗口,也支持屏幕分享过程中动态添加过滤窗口。
1398
- | 参数 | 描述 |
1399
- | --- | --- |
1400
- | windowID | 不希望分享出去的窗口 |
1444
+
1445
+ |参数|描述|
1446
+ |---------|---------|
1447
+ |windowID|不希望分享出去的窗口|
1401
1448
 
1402
1449
  > **注意**
1403
1450
  >
@@ -1413,25 +1460,27 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1413
1460
 
1414
1461
  ## removeExcludedShareWindow:
1415
1462
 
1416
- #### 将指定窗口从屏幕分享的排除列表中移除(该接口仅支持桌面系统)。
1417
- | 参数 | 描述 |
1418
- | --- | --- |
1419
- | windowID | 要排除的窗口 id。 |
1463
+ **将指定窗口从屏幕分享的排除列表中移除(该接口仅支持桌面系统)。**
1464
+
1465
+ |参数|描述|
1466
+ |---------|---------|
1467
+ |windowID|要排除的窗口 id。|
1420
1468
 
1421
1469
  ## removeAllExcludedShareWindows
1422
1470
 
1423
- #### 将所有窗口从屏幕分享的排除列表中移除(该接口仅支持桌面系统)。
1471
+ **将所有窗口从屏幕分享的排除列表中移除(该接口仅支持桌面系统)。**
1424
1472
 
1425
1473
  ## addIncludedShareWindow:
1426
1474
 
1427
- #### 将指定窗口加入屏幕分享的包含列表中(该接口仅支持桌面系统)。
1475
+ **将指定窗口加入屏幕分享的包含列表中(该接口仅支持桌面系统)。**
1428
1476
 
1429
1477
  该接口只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效。即只有在分享窗口内容时,额外包含指定窗口的功能才生效。
1430
1478
 
1431
1479
  您在 startScreenCapture 之前和之后调用均可。
1432
- | 参数 | 描述 |
1433
- | --- | --- |
1434
- | windowID | 希望被分享出去的窗口(Windows 平台下为窗口句柄: HWND) |
1480
+
1481
+ |参数|描述|
1482
+ |---------|---------|
1483
+ |windowID|希望被分享出去的窗口(Windows 平台下为窗口句柄: HWND)|
1435
1484
 
1436
1485
  > **注意**
1437
1486
  >
@@ -1441,18 +1490,19 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1441
1490
 
1442
1491
  ## removeIncludedShareWindow:
1443
1492
 
1444
- #### 将指定窗口从屏幕分享的包含列表中移除(该接口仅支持桌面系统)。
1493
+ **将指定窗口从屏幕分享的包含列表中移除(该接口仅支持桌面系统)。**
1445
1494
 
1446
1495
  该接口只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效。
1447
1496
 
1448
1497
  即只有在分享窗口内容时,额外包含指定窗口的功能才生效。
1449
- | 参数 | 描述 |
1450
- | --- | --- |
1451
- | windowID | 希望被分享出去的窗口(Mac 平台:窗口 ID;Windows 平台:HWND) |
1498
+
1499
+ |参数|描述|
1500
+ |---------|---------|
1501
+ |windowID|希望被分享出去的窗口(Mac 平台:窗口 ID;Windows 平台:HWND)|
1452
1502
 
1453
1503
  ## removeAllIncludedShareWindows
1454
1504
 
1455
- #### 将全部窗口从屏幕分享的包含列表中移除(该接口仅支持桌面系统)。
1505
+ **将全部窗口从屏幕分享的包含列表中移除(该接口仅支持桌面系统)。**
1456
1506
 
1457
1507
  该接口只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效。
1458
1508
 
@@ -1460,19 +1510,20 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1460
1510
 
1461
1511
  ## enableCustomVideoCapture:enable:
1462
1512
 
1463
- #### 启用/关闭视频自定义采集模式。
1513
+ **启用/关闭视频自定义采集模式。**
1464
1514
 
1465
1515
  开启该模式后,SDK 不再运行原有的视频采集流程,即不再继续从摄像头采集数据和美颜,而是只保留视频编码和发送能力。
1466
1516
 
1467
1517
  您需要通过 sendCustomVideoData 不断地向 SDK 塞入自己采集的视频画面。
1468
- | 参数 | 描述 |
1469
- | --- | --- |
1470
- | enable | 是否启用视频自定义采集,默认值:NO。 |
1471
- | streamType | 用于指定视频流类型,TRTCVideoStreamTypeBig:高清大画面;TRTCVideoStreamTypeSub:辅路画面。 |
1518
+
1519
+ |参数|描述|
1520
+ |---------|---------|
1521
+ |enable|是否启用视频自定义采集,默认值:NO。|
1522
+ |streamType|用于指定视频流类型,TRTCVideoStreamTypeBig:高清大画面;TRTCVideoStreamTypeSub:辅路画面。|
1472
1523
 
1473
1524
  ## sendCustomVideoData:frame:
1474
1525
 
1475
- #### 向 SDK 投送自己采集的视频帧。
1526
+ **向 SDK 投送自己采集的视频帧。**
1476
1527
 
1477
1528
  使用此接口可以向 SDK 投送自己采集的视频帧,SDK 会将视频帧进行编码并通过自身的网络模块传输出去。
1478
1529
 
@@ -1492,10 +1543,11 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1492
1543
  - height:视频图像宽度,bufferType 为 NSData 时填写。
1493
1544
 
1494
1545
  参考文档:[自定义采集和渲染](https://cloud.tencent.com/document/product/647/34066)。
1495
- | 参数 | 描述 |
1496
- | --- | --- |
1497
- | frame | 视频数据,bufferType 推荐选择 TRTCVideoBufferType_PixelBuffer,pixelFormat 推荐选择 TRTCVideoPixelFormat_NV12,更多支持格式参考 TRTCVideoFrame。 |
1498
- | streamType | 用于指定视频流类型,TRTCVideoStreamTypeBig:高清大画面;TRTCVideoStreamTypeSub:辅路画面。 |
1546
+
1547
+ |参数|描述|
1548
+ |---------|---------|
1549
+ |frame|视频数据,bufferType 推荐选择 TRTCVideoBufferType_PixelBuffer,pixelFormat 推荐选择 TRTCVideoPixelFormat_NV12,更多支持格式参考 TRTCVideoFrame。|
1550
+ |streamType|用于指定视频流类型,TRTCVideoStreamTypeBig:高清大画面;TRTCVideoStreamTypeSub:辅路画面。|
1499
1551
 
1500
1552
  > **注意**
1501
1553
  >
@@ -1511,14 +1563,15 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1511
1563
 
1512
1564
  ## enableCustomAudioCapture:
1513
1565
 
1514
- #### 启用音频自定义采集模式。
1566
+ **启用音频自定义采集模式。**
1515
1567
 
1516
1568
  开启该模式后,SDK 不再运行原有的音频采集流程,即不再继续从麦克风采集音频数据,而是只保留音频编码和发送能力。
1517
1569
 
1518
1570
  您需要通过 sendCustomAudioData 不断地向 SDK 塞入自己采集的音频数据。
1519
- | 参数 | 描述 |
1520
- | --- | --- |
1521
- | enable | 是否启用音频自定义采集模式,默认值:NO。 |
1571
+
1572
+ |参数|描述|
1573
+ |---------|---------|
1574
+ |enable|是否启用音频自定义采集模式,默认值:NO。|
1522
1575
 
1523
1576
  > **注意**
1524
1577
  >
@@ -1528,7 +1581,7 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1528
1581
 
1529
1582
  ## sendCustomAudioData:
1530
1583
 
1531
- #### 向 SDK 投送自己采集的音频数据。
1584
+ **向 SDK 投送自己采集的音频数据。**
1532
1585
 
1533
1586
  参数 TRTCAudioFrame 推荐下列填写方式(其他字段不需要填写):
1534
1587
  - audioFormat:音频数据格式,仅支持 TRTCAudioFrameFormatPCM。
@@ -1542,9 +1595,10 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1542
1595
  - timestamp:时间戳,单位为毫秒(ms),请使用音频帧在采集时被记录下来的时间戳(可以在采集到一帧音频帧之后,通过调用 generateCustomPTS 获取时间戳)。
1543
1596
 
1544
1597
  参考文档:[自定义采集和渲染](https://cloud.tencent.com/document/product/647/74692)。
1545
- | 参数 | 描述 |
1546
- | --- | --- |
1547
- | frame | 音频数据 |
1598
+
1599
+ |参数|描述|
1600
+ |---------|---------|
1601
+ |frame|音频数据|
1548
1602
 
1549
1603
  > **注意**
1550
1604
  >
@@ -1554,13 +1608,14 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1554
1608
 
1555
1609
  ## enableMixExternalAudioFrame:playout:
1556
1610
 
1557
- #### 启用/关闭自定义音轨。
1611
+ **启用/关闭自定义音轨。**
1558
1612
 
1559
1613
  开启后,您可以通过本接口向 SDK 混入一条自定义的音轨。通过两个布尔型参数,您可以控制该音轨是否要在远端和本地播放。
1560
- | 参数 | 描述 |
1561
- | --- | --- |
1562
- | enablePlayout | 控制混入的音轨是否要在本地播放,默认值:NO。 |
1563
- | enablePublish | 控制混入的音轨是否要在远端播放,默认值:NO。 |
1614
+
1615
+ |参数|描述|
1616
+ |---------|---------|
1617
+ |enablePlayout|控制混入的音轨是否要在本地播放,默认值:NO。|
1618
+ |enablePublish|控制混入的音轨是否要在远端播放,默认值:NO。|
1564
1619
 
1565
1620
  > **注意**
1566
1621
  >
@@ -1570,7 +1625,7 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1570
1625
 
1571
1626
  ## mixExternalAudioFrame:
1572
1627
 
1573
- #### 向 SDK 混入自定义音轨。
1628
+ **向 SDK 混入自定义音轨。**
1574
1629
 
1575
1630
  调用该接口之前,您需要先通过 enableMixExternalAudioFrame 开启自定义音轨,之后就可以通过本接口将自己的音轨以 PCM 格式混入到 SDK 中。
1576
1631
 
@@ -1585,37 +1640,37 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1585
1640
  参数 TRTCAudioFrame 推荐下列填写方式(其他字段不需要填写):
1586
1641
  - data:音频帧 buffer。音频帧数据只支持 PCM 格式,支持 5ms - 100ms 帧长,推荐使用 20ms 帧长,长度计算方法:48000采样率, 单声道的帧长度:` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
1587
1642
 
1588
- - sampleRate:采样率,支持:16000、24000、32000、44100、48000。
1643
+ - sampleRate:采样率,支持:16000、32000、44100、48000。
1589
1644
 
1590
1645
  - channel:声道数(如果是立体声,数据是交叉的),单声道:1; 双声道:2。
1591
1646
 
1592
1647
  - timestamp:时间戳,单位为毫秒(ms),请使用音频帧在采集时被记录下来的时间戳(可以在获得一帧音频帧之后,通过调用 generateCustomPTS 获得时间戳)。
1593
1648
 
1594
- | 参数 | 描述 |
1595
- | --- | --- |
1596
- | frame | 音频数据 |
1649
+ |参数|描述|
1650
+ |---------|---------|
1651
+ |frame|音频数据|
1597
1652
 
1598
1653
  > **注意**
1599
1654
  >
1600
1655
 
1601
1656
  > 请您精准地按每帧时长的间隔调用本接口,数据投送间隔不均匀时极易触发声音卡顿。
1602
1657
  >
1603
-
1604
- #### 返回值说明:
1658
+ **返回值说明:**
1605
1659
 
1606
1660
  >= 0 缓冲的长度,单位:ms。< 0 错误(-1 未启用 ` mixExternalAudioFrame `)
1607
1661
 
1608
1662
  ## setMixExternalAudioVolume:playoutVolume:
1609
1663
 
1610
- #### 设置推流时混入外部音频的推流音量和播放音量。
1611
- | 参数 | 描述 |
1612
- | --- | --- |
1613
- | playoutVolume | 设置的播放音量大小,范围 [0, 150],-1 表示不改变。 |
1614
- | publishVolume | 设置的推流音量大小,范围 [0, 150],-1 表示不改变。 |
1664
+ **设置推流时混入外部音频的推流音量和播放音量。**
1665
+
1666
+ |参数|描述|
1667
+ |---------|---------|
1668
+ |playoutVolume|设置的播放音量大小,范围 [0, 150],-1 表示不改变。|
1669
+ |publishVolume|设置的推流音量大小,范围 [0, 150],-1 表示不改变。|
1615
1670
 
1616
1671
  ## generateCustomPTS
1617
1672
 
1618
- #### 生成自定义采集时的时间戳。
1673
+ **生成自定义采集时的时间戳。**
1619
1674
 
1620
1675
  本接口仅适用于自定义采集模式,用于解决音视频帧的采集时间(capture time)和投送时间(send time)不一致所导致的音画不同步问题。
1621
1676
 
@@ -1625,30 +1680,28 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1625
1680
 
1626
1681
  2. 之后可以将该视频或音频帧送入您使用的前处理模块(如第三方美颜组件,或第三方音效组件)。
1627
1682
 
1628
- 3. 在真正调用 sendCustomVideoData 或 sendCustomAudioData 进行投送时,请将该帧在采集时记录的 PTS 时间戳赋值给 TRTCVideoFrame 或 TRTCAudioFrame 中的 timestamp 字段。
1629
-
1630
- #### 返回值说明:
1683
+ 3. 在真正调用 sendCustomVideoData 或 sendCustomAudioData 进行投送时,请将该帧在采集时记录的 PTS 时间戳赋值给 TRTCVideoFrame 或 TRTCAudioFrame 中的 timestamp 字段。**返回值说明:**
1631
1684
 
1632
1685
  时间戳(单位:ms)
1633
1686
 
1634
1687
  ## setLocalVideoProcessDelegete:pixelFormat:bufferType:
1635
1688
 
1636
- #### 设置第三方美颜的视频数据回调。
1689
+ **设置第三方美颜的视频数据回调。**
1637
1690
 
1638
1691
  设置该回调之后,SDK 会把采集到的视频帧通过您设置的 delegate 回调出来,用于第三方美颜组件进行二次处理,之后 SDK 会将处理后的视频帧进行编码和发送。
1639
- | 参数 | 描述 |
1640
- | --- | --- |
1641
- | bufferType | 指定回调的数据格式,目前仅支持 TRTCVideoBufferType_Texture。 |
1642
- | delegate | 自定义预处理回调,详见 TRTCVideoFrameDelegate。 |
1643
- | pixelFormat | 指定回调的像素格式,目前仅支持 TRTCVideoPixelFormat_Texture_2D。 |
1644
1692
 
1645
- #### 返回值说明:
1693
+ |参数|描述|
1694
+ |---------|---------|
1695
+ |bufferType|指定回调的数据格式,目前仅支持 TRTCVideoBufferType_Texture。|
1696
+ |delegate|自定义预处理回调,详见 TRTCVideoFrameDelegate。|
1697
+ |pixelFormat|指定回调的像素格式,目前仅支持 TRTCVideoPixelFormat_Texture_2D。|
1698
+ **返回值说明:**
1646
1699
 
1647
1700
  0:成功;<0:错误(详见 [错误码](https://cloud.tencent.com/document/product/647/32257))。
1648
1701
 
1649
1702
  ## setLocalVideoRenderDelegate:pixelFormat:bufferType:
1650
1703
 
1651
- #### 设置本地视频自定义渲染回调。
1704
+ **设置本地视频自定义渲染回调。**
1652
1705
 
1653
1706
  设置该回调之后,SDK 内部会跳过原来的渲染流程,并把采集到的数据回调出来,您需要自己完成画面渲染。
1654
1707
  - pixelFormat 指定回调的数据格式,例如 NV12、i420 以及 32BGRA。
@@ -1656,19 +1709,19 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1656
1709
  - bufferType 指定 buffer 的类型,直接使用 PixelBuffer 效率最高;使用 NSData 相当于让 SDK 在内部做了一次内存转换,因此会有额外的性能损耗。
1657
1710
 
1658
1711
  参考文档:[自定义采集和渲染](https://cloud.tencent.com/document/product/647/34066)。
1659
- | 参数 | 描述 |
1660
- | --- | --- |
1661
- | bufferType | PixelBuffer:可以直接使用 imageWithCVImageBuffer 转成 UIImage;NSData:经过内存整理的视频数据。 |
1662
- | delegate | 自定义渲染回调。 |
1663
- | pixelFormat | 指定回调的像素格式。 |
1664
1712
 
1665
- #### 返回值说明:
1713
+ |参数|描述|
1714
+ |---------|---------|
1715
+ |bufferType|PixelBuffer:可以直接使用 imageWithCVImageBuffer 转成 UIImage;NSData:经过内存整理的视频数据。|
1716
+ |delegate|自定义渲染回调。|
1717
+ |pixelFormat|指定回调的像素格式。|
1718
+ **返回值说明:**
1666
1719
 
1667
1720
  0:成功;< 0:错误(详见 [错误码](https://cloud.tencent.com/document/product/647/32257))。
1668
1721
 
1669
1722
  ## setRemoteVideoRenderDelegate:delegate:pixelFormat:bufferType:
1670
1723
 
1671
- #### 设置远端视频自定义渲染回调。
1724
+ **设置远端视频自定义渲染回调。**
1672
1725
 
1673
1726
  设置该回调之后,SDK 内部会跳过原来的渲染流程,并把采集到的数据回调出来,您需要自己完成画面渲染。
1674
1727
  - pixelFormat 指定回调的数据格式,例如 NV12、i420 以及 32BGRA。
@@ -1676,26 +1729,26 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1676
1729
  - bufferType 指定 buffer 的类型,直接使用 PixelBuffer 效率最高;使用 NSData 相当于让 SDK 在内部做了一次内存转换,因此会有额外的性能损耗。
1677
1730
 
1678
1731
  参考文档:[自定义采集和渲染](https://cloud.tencent.com/document/product/647/34066)。
1679
- | 参数 | 描述 |
1680
- | --- | --- |
1681
- | bufferType | PixelBuffer:可以直接使用 imageWithCVImageBuffer 转成 UIImage;NSData:经过内存整理的视频数据。 |
1682
- | delegate | 自定义渲染回调 |
1683
- | pixelFormat | 指定回调的像素格式 |
1684
- | userId | 指定远端用户的 ID |
1732
+
1733
+ |参数|描述|
1734
+ |---------|---------|
1735
+ |bufferType|PixelBuffer:可以直接使用 imageWithCVImageBuffer 转成 UIImage;NSData:经过内存整理的视频数据。|
1736
+ |delegate|自定义渲染回调|
1737
+ |pixelFormat|指定回调的像素格式|
1738
+ |userId|指定远端用户的 ID|
1685
1739
 
1686
1740
  > **注意**
1687
1741
  >
1688
1742
 
1689
1743
  > 调用此函数之前,需要先调用 ` startRemoteView(nil) ` 来获取远端用户的视频流(view 设置为 nil 即可),否则不会有数据回调出来。
1690
1744
  >
1691
-
1692
- #### 返回值说明:
1745
+ **返回值说明:**
1693
1746
 
1694
1747
  0:成功;<0:错误(详见 [错误码](https://cloud.tencent.com/document/product/647/32257))。
1695
1748
 
1696
1749
  ## setAudioFrameDelegate:
1697
1750
 
1698
- #### 设置音频数据自定义回调。
1751
+ **设置音频数据自定义回调。**
1699
1752
 
1700
1753
  设置该回调之后,SDK 内部会把音频数据(PCM 格式)回调出来,包括:
1701
1754
  - onCapturedAudioFrame:本地麦克风采集到的音频数据回调
@@ -1714,7 +1767,7 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1714
1767
 
1715
1768
  ## setCapturedAudioFrameDelegateFormat:
1716
1769
 
1717
- #### 设置本地麦克风采集出的音频帧回调格式。
1770
+ **设置本地麦克风采集出的音频帧回调格式。**
1718
1771
 
1719
1772
  本接口用于设置 onCapturedAudioFrame 回调出来的 AudioFrame 的格式:
1720
1773
  - sampleRate:采样率,支持:16000、32000、44100、48000。
@@ -1726,23 +1779,23 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1726
1779
  如果希望用毫秒数计算回调帧长,则将毫秒数转换成采样点数的公式为:` 采样点数 = 毫秒数 * 采样率 / 1000 `。
1727
1780
 
1728
1781
  举例:48000Hz 采样率希望回调 20ms 帧长的数据,则采样点数应该填:` 960 = 20 * 48000 / 1000 `。
1729
- | 参数 | 描述 |
1730
- | --- | --- |
1731
- | format | 音频数据回调格式。 |
1782
+
1783
+ |参数|描述|
1784
+ |---------|---------|
1785
+ |format|音频数据回调格式。|
1732
1786
 
1733
1787
  > **注意**
1734
1788
  >
1735
1789
 
1736
1790
  > 最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为:` 字节数 = 采样点数 * channel * 2(位宽) `。举例:48000Hz 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 ` 3840 = 960 * 2 * 2 `。
1737
1791
  >
1738
-
1739
- #### 返回值说明:
1792
+ **返回值说明:**
1740
1793
 
1741
1794
  0:成功;<0:错误。
1742
1795
 
1743
1796
  ## setLocalProcessedAudioFrameDelegateFormat:
1744
1797
 
1745
- #### 设置经过前处理后的本地音频帧回调格式。
1798
+ **设置经过前处理后的本地音频帧回调格式。**
1746
1799
 
1747
1800
  本接口用于设置 onLocalProcessedAudioFrame 回调出来的 AudioFrame 的格式:
1748
1801
  - sampleRate:采样率,支持:16000、32000、44100、48000。
@@ -1754,23 +1807,23 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1754
1807
  如果希望用毫秒数计算回调帧长,则将毫秒数转换成采样点数的公式为:` 采样点数 = 毫秒数 * 采样率 / 1000 `。
1755
1808
 
1756
1809
  举例:48000Hz 采样率希望回调20ms帧长的数据,则采样点数应该填: ` 960 = 20 * 48000 / 1000 `。
1757
- | 参数 | 描述 |
1758
- | --- | --- |
1759
- | format | 音频数据回调格式。 |
1810
+
1811
+ |参数|描述|
1812
+ |---------|---------|
1813
+ |format|音频数据回调格式。|
1760
1814
 
1761
1815
  > **注意**
1762
1816
  >
1763
1817
 
1764
1818
  > 最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为:` 字节数 = 采样点数 * channel * 2(位宽) `。 举例:48000Hz 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 ` 3840 = 960 * 2 * 2 `。
1765
1819
  >
1766
-
1767
- #### 返回值说明:
1820
+ **返回值说明:**
1768
1821
 
1769
1822
  0:成功;<0:错误。
1770
1823
 
1771
1824
  ## setMixedPlayAudioFrameDelegateFormat:
1772
1825
 
1773
- #### 设置最终要由系统播放出的音频帧回调格式。
1826
+ **设置最终要由系统播放出的音频帧回调格式。**
1774
1827
 
1775
1828
  本接口用于设置 onMixedPlayAudioFrame 回调出来的 AudioFrame 的格式:
1776
1829
  - sampleRate:采样率,支持:16000、32000、44100、48000。
@@ -1782,30 +1835,31 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1782
1835
  如果希望用毫秒数计算回调帧长,则将毫秒数转换成采样点数的公式为:` 采样点数 = 毫秒数 * 采样率 / 1000 `。
1783
1836
 
1784
1837
  举例:48000Hz 采样率希望回调 20ms 帧长的数据,则采样点数应该填: ` 960 = 20 * 48000 / 1000 `。
1785
- | 参数 | 描述 |
1786
- | --- | --- |
1787
- | format | 音频数据回调格式。 |
1838
+
1839
+ |参数|描述|
1840
+ |---------|---------|
1841
+ |format|音频数据回调格式。|
1788
1842
 
1789
1843
  > **注意**
1790
1844
  >
1791
1845
 
1792
1846
  > 最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为:` 字节数 = 采样点数 * channel * 2(位宽) `。 举例:48000Hz 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 ` 3840 = 960 * 2 * 2 `。
1793
1847
  >
1794
-
1795
- #### 返回值说明:
1848
+ **返回值说明:**
1796
1849
 
1797
1850
  0:成功;<0:错误。
1798
1851
 
1799
1852
  ## enableCustomAudioRendering:
1800
1853
 
1801
- #### 开启音频自定义播放。
1854
+ **开启音频自定义播放。**
1802
1855
 
1803
1856
  如果您需要外接一些特定的音频设备,或者希望自己掌控音频的播放逻辑,您可以通过该接口启用音频自定义播放。
1804
1857
 
1805
1858
  启用音频自定义播放后,SDK 将不再调用系统的音频接口播放数据,您需要通过 getCustomAudioRenderingFrame 获取 SDK 要播放的音频帧并自行播放。
1806
- | 参数 | 描述 |
1807
- | --- | --- |
1808
- | enable | 是否启用音频自定义播放,默认为关闭状态。 |
1859
+
1860
+ |参数|描述|
1861
+ |---------|---------|
1862
+ |enable|是否启用音频自定义播放,默认为关闭状态。|
1809
1863
 
1810
1864
  > **注意**
1811
1865
  >
@@ -1815,7 +1869,7 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1815
1869
 
1816
1870
  ## getCustomAudioRenderingFrame:
1817
1871
 
1818
- #### 获取可播放的音频数据。
1872
+ **获取可播放的音频数据。**
1819
1873
 
1820
1874
  调用该接口之前,您需要先通过 enableCustomAudioRendering 开启音频自定义播放。
1821
1875
 
@@ -1827,9 +1881,10 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1827
1881
  - data:用于获取音频数据的 buffer。需要您根据一帧音频帧的帧长度分配好 data 的内存大小。获取的 PCM 数据支持 10ms 或 20ms 两种帧长,推荐使用 20ms 的帧长。
1828
1882
 
1829
1883
  计算公式为:` 采样率 x 播放时长 x 声道数量 x 2(每个样点的字节数) `, 例如: 48000Hz 采样率、单声道、且播放时长为 20ms 的一帧音频帧的 buffer 大小为 ` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
1830
- | 参数 | 描述 |
1831
- | --- | --- |
1832
- | audioFrame | 音频数据帧。 |
1884
+
1885
+ |参数|描述|
1886
+ |---------|---------|
1887
+ |audioFrame|音频数据帧。|
1833
1888
 
1834
1889
  > **注意**
1835
1890
  >
@@ -1845,17 +1900,18 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1845
1900
 
1846
1901
  ## sendCustomCmdMsg:data:reliable:ordered:
1847
1902
 
1848
- #### 使用 UDP 通道发送自定义消息给房间内所有用户。
1903
+ **使用 UDP 通道发送自定义消息给房间内所有用户。**
1849
1904
 
1850
1905
  该接口可以让您借助 TRTC 的 UDP 通道,向当前房间里的其他用户广播自定义数据,以达到传输信令的目的。
1851
1906
 
1852
1907
  房间中的其他用户可以通过 TRTCCloudDelegate 中的 onRecvCustomCmdMsg 回调接收消息。
1853
- | 参数 | 描述 |
1854
- | --- | --- |
1855
- | cmdID | 消息 ID,取值范围为 [1, 10]。 |
1856
- | data | 待发送的消息,单个消息的最大长度被限制为 1KB。 |
1857
- | ordered | 是否要求有序,即是否要求接收端的数据包顺序和发送端的数据包顺序一致(这会带来一定的接收延时)。 |
1858
- | reliable | 是否可靠发送,可靠发送可以获得更高的发送成功率,但可靠发送比不可靠发送会带来更大的接收延迟。 |
1908
+
1909
+ |参数|描述|
1910
+ |---------|---------|
1911
+ |cmdID|消息 ID,取值范围为 [1, 10]。|
1912
+ |data|待发送的消息,单个消息的最大长度被限制为 1KB。|
1913
+ |ordered|是否要求有序,即是否要求接收端的数据包顺序和发送端的数据包顺序一致(这会带来一定的接收延时)。|
1914
+ |reliable|是否可靠发送,可靠发送可以获得更高的发送成功率,但可靠发送比不可靠发送会带来更大的接收延迟。|
1859
1915
 
1860
1916
  > **注意**
1861
1917
  >
@@ -1877,14 +1933,13 @@ iPhone 推荐的屏幕分享视频编码参数(TRTCVideoEncParam):
1877
1933
 
1878
1934
  > 6. 目前仅支持主播身份。
1879
1935
  >
1880
-
1881
- #### 返回值说明:
1936
+ **返回值说明:**
1882
1937
 
1883
1938
  YES:消息已经发出;NO:消息发送失败。
1884
1939
 
1885
1940
  ## sendSEIMsg:repeatCount:
1886
1941
 
1887
- #### 使用 SEI 通道发送自定义消息给房间内所有用户。
1942
+ **使用 SEI 通道发送自定义消息给房间内所有用户。**
1888
1943
 
1889
1944
  该接口可以让您借助 TRTC 的 SEI 通道,向当前房间里的其他用户广播自定义数据,已达到传输信令的目的。
1890
1945
 
@@ -1897,10 +1952,11 @@ YES:消息已经发出;NO:消息发送失败。
1897
1952
  最常见的用法是把自定义的时间戳(timestamp)用本接口嵌入视频帧中,实现消息和画面的完美对齐(例如:教育场景下的课件和视频信号的对齐)。
1898
1953
 
1899
1954
  房间中的其他用户可以通过 TRTCCloudDelegate 中的 onRecvSEIMsg 回调接收消息。
1900
- | 参数 | 描述 |
1901
- | --- | --- |
1902
- | data | 待发送的数据,最大支持 1KB(1000字节)的数据大小 |
1903
- | repeatCount | 发送数据次数 |
1955
+
1956
+ |参数|描述|
1957
+ |---------|---------|
1958
+ |data|待发送的数据,最大支持 1KB(1000字节)的数据大小|
1959
+ |repeatCount|发送数据次数|
1904
1960
 
1905
1961
  > **注意**
1906
1962
  >
@@ -1922,17 +1978,17 @@ YES:消息已经发出;NO:消息发送失败。
1922
1978
 
1923
1979
  > 5. 若指定多次发送(repeatCount > 1),则数据会被带在后续的连续 repeatCount 个视频帧中发送出去,同样会导致视频码率增大。接收消息 onRecvSEIMsg 回调也可能会收到多次相同的消息,需要去重。
1924
1980
  >
1925
-
1926
- #### 返回值说明:
1981
+ **返回值说明:**
1927
1982
 
1928
1983
  YES:消息已通过限制,等待后续视频帧发送;NO:消息被限制发送
1929
1984
 
1930
1985
  ## startSpeedTest:
1931
1986
 
1932
- #### 开始进行网速测试(进入房间前使用)。
1933
- | 参数 | 描述 |
1934
- | --- | --- |
1935
- | params | 测速选项 |
1987
+ **开始进行网速测试(进入房间前使用)。**
1988
+
1989
+ |参数|描述|
1990
+ |---------|---------|
1991
+ |params|测速选项|
1936
1992
 
1937
1993
  > **注意**
1938
1994
  >
@@ -1945,47 +2001,49 @@ YES:消息已通过限制,等待后续视频帧发送;NO:消息被限制
1945
2001
 
1946
2002
  > 3. 同一时间只允许一项网速测试任务运行。
1947
2003
  >
1948
-
1949
- #### 返回值说明:
2004
+ **返回值说明:**
1950
2005
 
1951
2006
  接口调用结果,< 0:失败
1952
2007
 
1953
2008
  ## stopSpeedTest
1954
2009
 
1955
- #### 停止网络测速。
2010
+ **停止网络测速。**
1956
2011
 
1957
2012
  ## getSDKVersion
1958
2013
 
1959
- #### 获取 SDK 版本信息。
2014
+ **获取 SDK 版本信息。**
1960
2015
 
1961
2016
  ## setLogLevel:
1962
2017
 
1963
- #### 设置 Log 输出级别。
1964
- | 参数 | 描述 |
1965
- | --- | --- |
1966
- | level | 参见 TRTCLogLevel,默认值:TRTCLogLevelNone |
2018
+ **设置 Log 输出级别。**
2019
+
2020
+ |参数|描述|
2021
+ |---------|---------|
2022
+ |level|参见 TRTCLogLevel,默认值:TRTCLogLevelNone|
1967
2023
 
1968
2024
  ## setConsoleEnabled:
1969
2025
 
1970
- #### 启用/禁用控制台日志打印。
1971
- | 参数 | 描述 |
1972
- | --- | --- |
1973
- | enabled | 指定是否启用,默认:禁止状态。 |
2026
+ **启用/禁用控制台日志打印。**
2027
+
2028
+ |参数|描述|
2029
+ |---------|---------|
2030
+ |enabled|指定是否启用,默认:禁止状态。|
1974
2031
 
1975
2032
  ## setLogCompressEnabled:
1976
2033
 
1977
- #### 启用/禁用日志的本地压缩。
2034
+ **启用/禁用日志的本地压缩。**
1978
2035
 
1979
2036
  开启压缩后,Log 存储体积明显减小,但需要腾讯云提供的 Python 脚本解压后才能阅读。
1980
2037
 
1981
2038
  禁用压缩后,Log 采用明文存储,可以直接用记事本打开阅读,但占用空间较大。
1982
- | 参数 | 描述 |
1983
- | --- | --- |
1984
- | enabled | 指定是否启用,默认为启动状态 |
2039
+
2040
+ |参数|描述|
2041
+ |---------|---------|
2042
+ |enabled|指定是否启用,默认为启动状态|
1985
2043
 
1986
2044
  ## setLogDirPath:
1987
2045
 
1988
- #### 设置本地日志的保存路径。
2046
+ **设置本地日志的保存路径。**
1989
2047
 
1990
2048
  通过该接口您可以更改 SDK 本地日志的默认存储路径,SDK 默认的本地日志的存储位置:
1991
2049
  - Windows 平台:在 C:/Users/[系统用户名]/AppData/Roaming/liteav/log,即 %appdata%/liteav/log 下。
@@ -1994,9 +2052,9 @@ YES:消息已通过限制,等待后续视频帧发送;NO:消息被限制
1994
2052
 
1995
2053
  - Android 平台:在 /app私有目录/files/log/liteav/ 下。
1996
2054
 
1997
- | 参数 | 描述 |
1998
- | --- | --- |
1999
- | path | 存储日志的路径 |
2055
+ |参数|描述|
2056
+ |---------|---------|
2057
+ |path|存储日志的路径|
2000
2058
 
2001
2059
  > **注意**
2002
2060
  >
@@ -2006,47 +2064,49 @@ YES:消息已通过限制,等待后续视频帧发送;NO:消息被限制
2006
2064
 
2007
2065
  ## setLogDelegate:
2008
2066
 
2009
- #### 设置日志回调。
2067
+ **设置日志回调。**
2010
2068
 
2011
2069
  ## showDebugView:
2012
2070
 
2013
- #### 显示仪表盘。
2071
+ **显示仪表盘。**
2014
2072
 
2015
2073
  “仪表盘”是位于视频渲染控件之上的一个半透明的调试信息浮层,用于展示音视频信息和事件信息,便于对接和调试。
2016
- | 参数 | 描述 |
2017
- | --- | --- |
2018
- | showType | 0:不显示;1:显示精简版(仅显示音视频信息);2:显示完整版(包含音视频信息和事件信息)。 |
2074
+
2075
+ |参数|描述|
2076
+ |---------|---------|
2077
+ |showType|0:不显示;1:显示精简版(仅显示音视频信息);2:显示完整版(包含音视频信息和事件信息)。|
2019
2078
 
2020
2079
  ## setDebugViewMargin:margin:
2021
2080
 
2022
- #### 设置仪表盘的边距。
2081
+ **设置仪表盘的边距。**
2023
2082
 
2024
2083
  用于调整仪表盘在视频渲染控件中的位置,必须在 showDebugView 之前调用才能生效。
2025
- | 参数 | 描述 |
2026
- | --- | --- |
2027
- | margin | 仪表盘内边距,注意这里是基于 parentView 的百分比,` margin ` 的取值范围是 [0, 1]。 |
2028
- | userId | 用户 ID。 |
2084
+
2085
+ |参数|描述|
2086
+ |---------|---------|
2087
+ |margin|仪表盘内边距,注意这里是基于 parentView 的百分比,` margin ` 的取值范围是 [0, 1]。|
2088
+ |userId|用户 ID。|
2029
2089
 
2030
2090
  ## callExperimentalAPI:
2031
2091
 
2032
- #### 调用实验性接口。
2092
+ **调用实验性接口。**
2033
2093
 
2034
2094
  ## enablePayloadPrivateEncryption:params:
2035
2095
 
2036
- #### 开启或关闭媒体流私有加密。
2096
+ **开启或关闭媒体流私有加密。**
2037
2097
 
2038
2098
  在安全要求较高的场景下,TRTC 建议您在加入房间前,调用 ` enablePayloadPrivateEncryption ` 方法开启媒体流私有加密。
2039
2099
 
2040
2100
  用户退出房间后,SDK 会自动关闭私有加密。如需重新开启私有加密,您需要在用户再次加入房间前调用该方法。
2041
- | 参数 | 描述 |
2042
- | --- | --- |
2043
- | config | 配置媒体流私有加密的算法和密钥,参见 TRTCPayloadPrivateEncryptionConfig。 |
2044
- | enabled | 是否开启媒体流私有加密。 |
2101
+
2102
+ |参数|描述|
2103
+ |---------|---------|
2104
+ |config|配置媒体流私有加密的算法和密钥,参见 TRTCPayloadPrivateEncryptionConfig。|
2105
+ |enabled|是否开启媒体流私有加密。|
2045
2106
 
2046
2107
  > **注意**
2047
2108
  >
2048
2109
 
2049
- > TRTC 已经内置对媒体流进行加密后再传输,启用媒体流私有加密后将使用您传入的密匙与初始向量进行再次加密。
2110
+ > TRTC 已经内置对媒体流进行加密后再传输,启用媒体流私有加密后将使用您传入的密钥与初始向量进行再次加密。
2050
2111
  >
2051
-
2052
- #### 返回值说明:
2112
+ **返回值说明:**