@tencent-rtc/mcp 1.3.8 → 1.4.0

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 (429) hide show
  1. package/package.json +2 -2
  2. package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/android-faq.md} +10 -22
  3. package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/flutter-faq.md} +10 -22
  4. package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/ios-faq.md} +10 -22
  5. package/resource/doc/callkit/preset/android/api.md +296 -0
  6. package/resource/doc/callkit/preset/android/integration.md +430 -0
  7. package/resource/doc/callkit/preset/flutter/api.md +410 -0
  8. package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +35 -97
  9. package/resource/doc/callkit/preset/ios/api.md +80 -0
  10. package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +37 -118
  11. package/resource/doc/callkit/preset/react/api.md +501 -0
  12. package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +5 -20
  13. package/resource/doc/callkit/preset/vue/api.md +501 -0
  14. package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +4 -19
  15. package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -38
  16. package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
  17. package/resource/doc/chatkit/android/integration.md +490 -0
  18. package/resource/doc/chatkit/faq/android_sdk/client-api.md +281 -0
  19. package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +0 -1
  20. package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -1
  21. package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +199 -0
  22. package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
  23. package/resource/doc/chatkit/faq/ios_sdk/client-api.md +235 -0
  24. package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +3 -3
  25. package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
  26. package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +19 -88
  27. package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -38
  28. package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
  29. package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +47 -165
  30. package/resource/doc/{chatuikit → chatkit}/react/components/avatar.md +0 -33
  31. package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +8 -49
  32. package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +6 -35
  33. package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +0 -6
  34. package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -11
  35. package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +96 -502
  36. package/resource/doc/chatkit/react/components/conversation-actions.md +174 -0
  37. package/resource/doc/chatkit/react/components/conversation-list.md +333 -0
  38. package/resource/doc/chatkit/react/components/conversation-preview.md +118 -0
  39. package/resource/doc/chatkit/react/components/conversation-search.md +60 -0
  40. package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -337
  41. package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +20 -212
  42. package/resource/doc/chatkit/react/components/search.md +243 -0
  43. package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +1 -47
  44. package/resource/doc/{chatuikit → chatkit}/react/integration.md +21 -81
  45. package/resource/doc/{chatuikit → chatkit}/vue/components/avatar.md +0 -33
  46. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -48
  47. package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +3 -5
  48. package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +0 -5
  49. package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -15
  50. package/resource/doc/chatkit/vue/components/contact-list.md +271 -0
  51. package/resource/doc/chatkit/vue/components/conversation-actions.md +228 -0
  52. package/resource/doc/{chatuikit → chatkit}/vue/components/conversation-list.md +42 -492
  53. package/resource/doc/chatkit/vue/components/conversation-preview.md +213 -0
  54. package/resource/doc/chatkit/vue/components/conversation-search.md +50 -0
  55. package/resource/doc/{chatuikit → chatkit}/vue/components/message-input.md +2 -223
  56. package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -252
  57. package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
  58. package/resource/doc/{chatuikit → chatkit}/vue/components/tuikit.md +7 -21
  59. package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +3 -62
  60. package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
  61. package/resource/doc/{chatuikit → chatkit}/vue/integration.md +22 -23
  62. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +18 -89
  63. package/resource/doc/livekit/{live → core-sdk/live}/android/live-audio-effect.md +34 -192
  64. package/resource/doc/livekit/{live → core-sdk/live}/android/live-barrage.md +28 -141
  65. package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +20 -112
  66. package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +59 -193
  67. package/resource/doc/livekit/{live → core-sdk/live}/android/live-gift.md +75 -455
  68. package/resource/doc/livekit/{live → core-sdk/live}/android/live-host-interaction.md +94 -344
  69. package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +107 -515
  70. package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +33 -173
  71. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +14 -93
  72. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -179
  73. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +19 -107
  74. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -166
  75. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -163
  76. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +69 -443
  77. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
  78. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-integration.md +107 -492
  79. package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +23 -165
  80. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +35 -111
  81. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +35 -193
  82. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +31 -144
  83. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +24 -116
  84. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +37 -171
  85. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +79 -459
  86. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +69 -320
  87. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +85 -502
  88. package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +32 -169
  89. package/resource/doc/livekit/core-sdk/voice/android/voice-audience-list.md +263 -0
  90. package/resource/doc/livekit/core-sdk/voice/android/voice-audio-effect.md +222 -0
  91. package/resource/doc/livekit/core-sdk/voice/android/voice-barrage.md +452 -0
  92. package/resource/doc/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +536 -0
  93. package/resource/doc/livekit/core-sdk/voice/android/voice-gift.md +442 -0
  94. package/resource/doc/livekit/core-sdk/voice/android/voice-host-interaction.md +489 -0
  95. package/resource/doc/livekit/core-sdk/voice/android/voice-integration.md +574 -0
  96. package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +435 -0
  97. package/resource/doc/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +516 -0
  98. package/resource/doc/livekit/core-sdk/voice/flutter/voice-integration.md +576 -0
  99. package/resource/doc/livekit/core-sdk/voice/ios/voice-audience-list.md +263 -0
  100. package/resource/doc/livekit/core-sdk/voice/ios/voice-audio-effect.md +212 -0
  101. package/resource/doc/livekit/core-sdk/voice/ios/voice-barrage.md +404 -0
  102. package/resource/doc/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +499 -0
  103. package/resource/doc/livekit/core-sdk/voice/ios/voice-gift.md +403 -0
  104. package/resource/doc/livekit/core-sdk/voice/ios/voice-host-interaction.md +552 -0
  105. package/resource/doc/livekit/core-sdk/voice/ios/voice-integration.md +514 -0
  106. package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +348 -0
  107. package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -2
  108. package/resource/doc/livekit/preset/live/vue/api-reference/index.md +780 -0
  109. package/resource/doc/livekit/preset/live/vue/components/barrage.md +291 -0
  110. package/resource/doc/livekit/{live → preset/live}/vue/components/co-guest-panel.md +10 -49
  111. package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +26 -144
  112. package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +12 -75
  113. package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +36 -227
  114. package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +215 -0
  115. package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
  116. package/resource/doc/livekit/preset/live/vue/live-list-integration.md +241 -0
  117. package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +299 -0
  118. package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +300 -0
  119. package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +743 -0
  120. package/resource/doc/roomkit/vue/faq.md +1 -0
  121. package/resource/doc/roomkit/vue/features/call-user-to-room.md +17 -53
  122. package/resource/doc/roomkit/vue/features/device-detection.md +30 -48
  123. package/resource/doc/roomkit/vue/features/device-state.md +24 -44
  124. package/resource/doc/roomkit/vue/features/free-beauty-panel.md +13 -36
  125. package/resource/doc/roomkit/vue/features/room-chat.md +31 -89
  126. package/resource/doc/roomkit/vue/features/room-participant-state.md +28 -50
  127. package/resource/doc/roomkit/vue/features/room-state.md +25 -34
  128. package/resource/doc/roomkit/vue/features/room-view.md +30 -125
  129. package/resource/doc/roomkit/vue/features/schedule-room.md +9 -40
  130. package/resource/doc/roomkit/vue/features/screen-share.md +22 -90
  131. package/resource/doc/roomkit/vue/features/virtual-background.md +13 -29
  132. package/resource/doc/roomkit/vue/integration.md +173 -337
  133. package/resource/doc/rtcengine/faq/common/error_code.md +1 -0
  134. package/resource/doc/rtcengine/faq/web/web.md +14 -24
  135. package/resource/doc/rtcengine/web/api.md +1 -3
  136. package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +3 -10
  137. package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +1 -5
  138. package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +1 -2
  139. package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -4
  140. package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +3 -5
  141. package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +1 -7
  142. package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +0 -2
  143. package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -8
  144. package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +11 -11
  145. package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +12 -88
  146. package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -5
  147. package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +30 -37
  148. package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +13 -90
  149. package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -2
  150. package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +1 -2
  151. package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +19 -19
  152. package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +1 -1
  153. package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +4 -5
  154. package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
  155. package/resource/doc/trtc/C++/ITRTCCloud.md +686 -2835
  156. package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
  157. package/resource/doc/trtc/C++/ITXAudioEffectManager.md +202 -1022
  158. package/resource/doc/trtc/C++/ITXDeviceManager.md +126 -767
  159. package/resource/doc/trtc/C++/TRTCCloudCallback.md +579 -2147
  160. package/resource/doc/trtc/C++/TRTCTypeDef.md +703 -3378
  161. package/resource/doc/trtc/C++/TXLiteAVCode.md +116 -908
  162. package/resource/doc/trtc/android/TRTCCloud.md +606 -2573
  163. package/resource/doc/trtc/android/TRTCCloudDef.md +752 -3640
  164. package/resource/doc/trtc/android/TRTCCloudListener.md +581 -2008
  165. package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
  166. package/resource/doc/trtc/android/TXAudioEffectManager.md +202 -1022
  167. package/resource/doc/trtc/android/TXBeautyManager.md +127 -704
  168. package/resource/doc/trtc/android/TXDeviceManager.md +51 -318
  169. package/resource/doc/trtc/android/TXLiteAVCode.md +114 -892
  170. package/resource/doc/trtc/iOS/TRTCCloud.md +694 -2904
  171. package/resource/doc/trtc/iOS/TRTCCloudDef.md +726 -3498
  172. package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +543 -2028
  173. package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
  174. package/resource/doc/trtc/iOS/TXAudioEffectManager.md +174 -877
  175. package/resource/doc/trtc/iOS/TXBeautyManager.md +128 -710
  176. package/resource/doc/trtc/iOS/TXDeviceManager.md +129 -772
  177. package/resource/doc/trtc/iOS/TXLiteAVCode.md +117 -915
  178. package/server.js +1 -5
  179. package/server.js.map +1 -1
  180. package/tools/call/get_callkit_api.js +32 -0
  181. package/tools/call/get_callkit_api.js.map +1 -0
  182. package/tools/call/get_native_call_uikit_integration.js +34 -0
  183. package/tools/call/get_native_call_uikit_integration.js.map +1 -0
  184. package/tools/call/{get-web-call-integration.js → get_web_call_uikit_integration.js} +13 -8
  185. package/tools/call/get_web_call_uikit_integration.js.map +1 -0
  186. package/tools/chat/get_native_chat_uikit_feature_detail.js +34 -0
  187. package/tools/chat/get_native_chat_uikit_feature_detail.js.map +1 -0
  188. package/tools/chat/get_native_chat_uikit_integration.js +45 -0
  189. package/tools/chat/get_native_chat_uikit_integration.js.map +1 -0
  190. package/tools/chat/get_web_chat_uikit_component_detail.js +34 -0
  191. package/tools/chat/get_web_chat_uikit_component_detail.js.map +1 -0
  192. package/tools/chat/get_web_chat_uikit_integration.js +45 -0
  193. package/tools/chat/get_web_chat_uikit_integration.js.map +1 -0
  194. package/tools/common/get_faq.js +265 -0
  195. package/tools/common/get_faq.js.map +1 -0
  196. package/tools/common/{get-usersig.js → get_usersig.js} +6 -3
  197. package/tools/common/get_usersig.js.map +1 -0
  198. package/tools/common/present_framework_choice.js +63 -0
  199. package/tools/common/present_framework_choice.js.map +1 -0
  200. package/tools/definitions/get_callkit_api_def.js +29 -0
  201. package/tools/definitions/get_callkit_api_def.js.map +1 -0
  202. package/tools/definitions/get_faq_def.js +17 -18
  203. package/tools/definitions/get_faq_def.js.map +1 -1
  204. package/tools/definitions/get_native_call_uikit_integration_def.js +15 -18
  205. package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
  206. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
  207. package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
  208. package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -19
  209. package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
  210. package/tools/definitions/get_native_livekit_core_features_def.js +34 -0
  211. package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
  212. package/tools/definitions/get_native_livekit_core_integration_def.js +34 -0
  213. package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
  214. package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
  215. package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
  216. package/tools/definitions/get_usersig_def.js +17 -22
  217. package/tools/definitions/get_usersig_def.js.map +1 -1
  218. package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
  219. package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
  220. package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
  221. package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
  222. package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
  223. package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
  224. package/tools/definitions/get_web_live_uikit_integration_def.js +15 -18
  225. package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
  226. package/tools/definitions/get_web_livekit_api_def.js +30 -0
  227. package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
  228. package/tools/definitions/get_web_livekit_component_detail_def.js +32 -0
  229. package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
  230. package/tools/definitions/get_web_room_uikit_integration_def.js +15 -30
  231. package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
  232. package/tools/definitions/get_web_roomkit_feature_detail_def.js +31 -0
  233. package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
  234. package/tools/definitions/get_web_trtc_sdk_api_def.js +27 -0
  235. package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
  236. package/tools/definitions/get_web_trtc_sdk_integration_def.js +27 -0
  237. package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
  238. package/tools/definitions/get_web_trtc_sdk_plugin_def.js +27 -0
  239. package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
  240. package/tools/definitions/present_framework_choice_def.js +24 -12
  241. package/tools/definitions/present_framework_choice_def.js.map +1 -1
  242. package/tools/index.js +47 -59
  243. package/tools/index.js.map +1 -1
  244. package/tools/live/get_native_livekit_core_features.js +65 -0
  245. package/tools/live/get_native_livekit_core_features.js.map +1 -0
  246. package/tools/live/get_native_livekit_core_integration.js +59 -0
  247. package/tools/live/get_native_livekit_core_integration.js.map +1 -0
  248. package/tools/live/get_web_live_uikit_integration.js +48 -0
  249. package/tools/live/get_web_live_uikit_integration.js.map +1 -0
  250. package/tools/live/get_web_livekit_api.js +32 -0
  251. package/tools/live/get_web_livekit_api.js.map +1 -0
  252. package/tools/live/get_web_livekit_component_detail.js +34 -0
  253. package/tools/live/get_web_livekit_component_detail.js.map +1 -0
  254. package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
  255. package/tools/room/get_web_room_uikit_integration.js.map +1 -0
  256. package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
  257. package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
  258. package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
  259. package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
  260. package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
  261. package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
  262. package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
  263. package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
  264. package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
  265. package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
  266. package/utils/generate-structured-result.js +61 -17
  267. package/utils/generate-structured-result.js.map +1 -1
  268. package/utils/report-cls-client.js +12 -1
  269. package/utils/report-cls-client.js.map +1 -1
  270. package/utils/report-es-client.js +2 -2
  271. package/resource/doc/chatuikit/android/integration.md +0 -287
  272. package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1371
  273. package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -932
  274. package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1119
  275. package/resource/doc/chatuikit/flutter/workflow.md +0 -941
  276. package/resource/doc/chatuikit/iOS/workflow.md +0 -0
  277. package/resource/doc/chatuikit/react/components/conversation-list.md +0 -1017
  278. package/resource/doc/chatuikit/react/components/search.md +0 -745
  279. package/resource/doc/chatuikit/react/create-group.md +0 -23
  280. package/resource/doc/chatuikit/react/init.md +0 -26
  281. package/resource/doc/chatuikit/react/workflow.md +0 -258
  282. package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
  283. package/resource/doc/chatuikit/vue/create-group.md +0 -25
  284. package/resource/doc/chatuikit/vue/init.md +0 -40
  285. package/resource/doc/chatuikit/vue/workflow.md +0 -395
  286. package/resource/doc/livekit/live/android/workflow.md +0 -320
  287. package/resource/doc/livekit/live/flutter/workflow.md +0 -353
  288. package/resource/doc/livekit/live/ios/workflow.md +0 -454
  289. package/resource/doc/livekit/live/vue/components/barrage.md +0 -616
  290. package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -446
  291. package/resource/doc/livekit/live/vue/faq.md +0 -0
  292. package/resource/doc/livekit/live/vue/live-list-integration.md +0 -200
  293. package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -269
  294. package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -269
  295. package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -595
  296. package/resource/doc/livekit/live/vue/states/live-state.md +0 -3591
  297. package/resource/doc/livekit/live/vue/workflow.md +0 -218
  298. package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -312
  299. package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -430
  300. package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -679
  301. package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -671
  302. package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -271
  303. package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
  304. package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
  305. package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
  306. package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
  307. package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -865
  308. package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -657
  309. package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -437
  310. package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -335
  311. package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
  312. package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -327
  313. package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -507
  314. package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
  315. package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -659
  316. package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
  317. package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -814
  318. package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1000
  319. package/resource/doc/roomkit/vue/features/workflow.md +0 -553
  320. package/resource/doc/roomkit/vue/workflow.md +0 -487
  321. package/resource/doc/tuicallkit/android/integration.md +0 -286
  322. package/resource/doc/tuicallkit/android/workflow.md +0 -0
  323. package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -784
  324. package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -610
  325. package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -938
  326. package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -897
  327. package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -469
  328. package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -781
  329. package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -398
  330. package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
  331. package/resource/doc/tuicallkit/react/api.md +0 -1404
  332. package/resource/doc/tuicallkit/vue/api.md +0 -1406
  333. package/resource/doc/tuicallkit/vue/faq.md +0 -36
  334. package/tools/call/get-native-call-integration.js +0 -43
  335. package/tools/call/get-native-call-integration.js.map +0 -1
  336. package/tools/call/get-web-call-api.js +0 -27
  337. package/tools/call/get-web-call-api.js.map +0 -1
  338. package/tools/call/get-web-call-integration.js.map +0 -1
  339. package/tools/chat/get-native-chat-feature-detail.js +0 -30
  340. package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
  341. package/tools/chat/get-native-chat-integration.js +0 -45
  342. package/tools/chat/get-native-chat-integration.js.map +0 -1
  343. package/tools/chat/get-web-chat-component-detail.js +0 -31
  344. package/tools/chat/get-web-chat-component-detail.js.map +0 -1
  345. package/tools/chat/get-web-chat-integration.js +0 -45
  346. package/tools/chat/get-web-chat-integration.js.map +0 -1
  347. package/tools/chat/get-web-chat-uikit-init.js +0 -28
  348. package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
  349. package/tools/chat/get-web-create-group-doc.js +0 -28
  350. package/tools/chat/get-web-create-group-doc.js.map +0 -1
  351. package/tools/common/get-faq.js +0 -91
  352. package/tools/common/get-faq.js.map +0 -1
  353. package/tools/common/get-usersig.js.map +0 -1
  354. package/tools/common/present-framework-choice.js +0 -16
  355. package/tools/common/present-framework-choice.js.map +0 -1
  356. package/tools/common/record-prompt.js +0 -55
  357. package/tools/common/record-prompt.js.map +0 -1
  358. package/tools/common/record-result.js +0 -60
  359. package/tools/common/record-result.js.map +0 -1
  360. package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
  361. package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
  362. package/tools/definitions/get_native_live_api_def.js +0 -23
  363. package/tools/definitions/get_native_live_api_def.js.map +0 -1
  364. package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -87
  365. package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
  366. package/tools/definitions/get_native_live_uikit_integration_def.js +0 -49
  367. package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
  368. package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -74
  369. package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
  370. package/tools/definitions/get_trtc_native_api_def.js +0 -16
  371. package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
  372. package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
  373. package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
  374. package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
  375. package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
  376. package/tools/definitions/get_web_create_group_doc_def.js +0 -18
  377. package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
  378. package/tools/definitions/get_web_live_state_detail_def.js +0 -19
  379. package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
  380. package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
  381. package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
  382. package/tools/definitions/get_web_room_feature_detail_def.js +0 -95
  383. package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
  384. package/tools/definitions/get_web_room_state_detail_def.js +0 -19
  385. package/tools/definitions/get_web_room_state_detail_def.js.map +0 -1
  386. package/tools/definitions/record_prompt_def.js +0 -53
  387. package/tools/definitions/record_prompt_def.js.map +0 -1
  388. package/tools/definitions/record_result_def.js +0 -30
  389. package/tools/definitions/record_result_def.js.map +0 -1
  390. package/tools/live/get-native-live-uikit-integration.js +0 -101
  391. package/tools/live/get-native-live-uikit-integration.js.map +0 -1
  392. package/tools/live/get-web-live-component-detail.js +0 -31
  393. package/tools/live/get-web-live-component-detail.js.map +0 -1
  394. package/tools/live/get-web-live-state-detail.js +0 -31
  395. package/tools/live/get-web-live-state-detail.js.map +0 -1
  396. package/tools/live/get-web-live-uikit-integration.js +0 -52
  397. package/tools/live/get-web-live-uikit-integration.js.map +0 -1
  398. package/tools/live/get_native_live_uikit_extra_features.js +0 -105
  399. package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
  400. package/tools/live/get_native_live_uikit_interaction.js +0 -101
  401. package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
  402. package/tools/native_live/get-native-live-api.js +0 -31
  403. package/tools/native_live/get-native-live-api.js.map +0 -1
  404. package/tools/room/get-web-room-feature-detail.js.map +0 -1
  405. package/tools/room/get-web-room-integration.js.map +0 -1
  406. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
  407. package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
  408. package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
  409. package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
  410. package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
  411. package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
  412. package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
  413. package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
  414. package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
  415. package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
  416. package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
  417. package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
  418. package/tools/trtc/get-trtc-native-api.js +0 -31
  419. package/tools/trtc/get-trtc-native-api.js.map +0 -1
  420. package/utils/handle-component-name.js +0 -33
  421. package/utils/handle-component-name.js.map +0 -1
  422. /package/resource/doc/{chatuikit/android/workflow.md → callkit/core-sdk/.gitkeep} +0 -0
  423. /package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +0 -0
  424. /package/resource/doc/{tuicallkit/react/faq.md → callkit/faq/web-faq.md} +0 -0
  425. /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
  426. /package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +0 -0
  427. /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
  428. /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
  429. /package/resource/doc/roomkit/faq/common/{error_code.md → error-code.md} +0 -0
@@ -2,880 +2,259 @@
2
2
  ## Overview
3
3
  `TRTCCloud.java` is the API reference for TRTC Real-Time Communication (TRTC SDK) on Android. It provides detailed documentation for features including stream publishing, stream playback, stream mixing, and recording.
4
4
 
5
-
6
5
  ## TRTCCloud
7
- <table>
8
- <tr>
9
- <td rowspan="1" colSpan="1" >Function List</td>
10
-
11
- <td rowspan="1" colSpan="1" >Description</td>
12
- </tr>
13
-
14
- <tr>
15
- <td rowspan="1" colSpan="1" >[sharedInstance](https://write.woa.com/document/87029900866228224)</td>
16
-
17
- <td rowspan="1" colSpan="1" >Create a `TRTCCloud` Instance (Singleton Pattern)</td>
18
- </tr>
19
-
20
- <tr>
21
- <td rowspan="1" colSpan="1" >[destroySharedInstance](https://write.woa.com/document/87029900866228224)</td>
22
-
23
- <td rowspan="1" colSpan="1" >Terminate `TRTCCloud` Instance (Singleton Pattern)</td>
24
- </tr>
25
-
26
- <tr>
27
- <td rowspan="1" colSpan="1" >[addListener](https://write.woa.com/document/87029900866228224)</td>
28
-
29
- <td rowspan="1" colSpan="1" >Add TRTC Event Callback</td>
30
- </tr>
31
-
32
- <tr>
33
- <td rowspan="1" colSpan="1" >[removeListener](https://write.woa.com/document/87029900866228224)</td>
34
-
35
- <td rowspan="1" colSpan="1" >Remove TRTC Event Callback</td>
36
- </tr>
37
-
38
- <tr>
39
- <td rowspan="1" colSpan="1" >[setListenerHandler](https://write.woa.com/document/87029900866228224)</td>
40
-
41
- <td rowspan="1" colSpan="1" >Set the queue to drive TRTCCloudListener event callbacks</td>
42
- </tr>
43
-
44
- <tr>
45
- <td rowspan="1" colSpan="1" >[enterRoom](https://write.woa.com/document/87029900866228224)</td>
46
-
47
- <td rowspan="1" colSpan="1" >Enter Room</td>
48
- </tr>
49
-
50
- <tr>
51
- <td rowspan="1" colSpan="1" >[exitRoom](https://write.woa.com/document/87029900866228224)</td>
52
-
53
- <td rowspan="1" colSpan="1" >Leave Room</td>
54
- </tr>
55
-
56
- <tr>
57
- <td rowspan="1" colSpan="1" >[switchRole](https://write.woa.com/document/87029900866228224)</td>
58
-
59
- <td rowspan="1" colSpan="1" >Switch Role</td>
60
- </tr>
61
-
62
- <tr>
63
- <td rowspan="1" colSpan="1" >[switchRole](https://write.woa.com/document/87029900866228224)</td>
64
-
65
- <td rowspan="1" colSpan="1" >Switch Role (Supports Setting Permission Bit)</td>
66
- </tr>
67
-
68
- <tr>
69
- <td rowspan="1" colSpan="1" >[switchRoom](https://write.woa.com/document/87029900866228224)</td>
70
-
71
- <td rowspan="1" colSpan="1" >Switch Room</td>
72
- </tr>
73
-
74
- <tr>
75
- <td rowspan="1" colSpan="1" >[ConnectOtherRoom](https://write.woa.com/document/87029900866228224)</td>
76
-
77
- <td rowspan="1" colSpan="1" >Request Cross-room Communication</td>
78
- </tr>
79
-
80
- <tr>
81
- <td rowspan="1" colSpan="1" >[DisconnectOtherRoom](https://write.woa.com/document/87029900866228224)</td>
82
-
83
- <td rowspan="1" colSpan="1" >Exit Cross-room Communication</td>
84
- </tr>
85
-
86
- <tr>
87
- <td rowspan="1" colSpan="1" >[setDefaultStreamRecvMode](https://write.woa.com/document/87029900866228224)</td>
88
-
89
- <td rowspan="1" colSpan="1" >Set Subscription Mode (Needs to be set before entering the room to take effect)</td>
90
- </tr>
91
-
92
- <tr>
93
- <td rowspan="1" colSpan="1" >[createSubCloud](https://write.woa.com/document/87029900866228224)</td>
94
-
95
- <td rowspan="1" colSpan="1" >Create Sub-room Instances (For Multi-room Concurrent Viewing)</td>
96
- </tr>
97
-
98
- <tr>
99
- <td rowspan="1" colSpan="1" >[destroySubCloud](https://write.woa.com/document/87029900866228224)</td>
100
-
101
- <td rowspan="1" colSpan="1" >Terminate Sub-room Instances</td>
102
- </tr>
103
-
104
- <tr>
105
- <td rowspan="1" colSpan="1" >[updateOtherRoomForwardMode](https://write.woa.com/document/87029900866228224)</td>
106
-
107
- <td rowspan="1" colSpan="1" >Modify the uplink capability of cross-room broadcasters in this room</td>
108
- </tr>
109
-
110
- <tr>
111
- <td rowspan="1" colSpan="1" >[startPublishMediaStream](https://write.woa.com/document/87029900866228224)</td>
112
-
113
- <td rowspan="1" colSpan="1" >Start publishing media stream</td>
114
- </tr>
115
-
116
- <tr>
117
- <td rowspan="1" colSpan="1" >[updatePublishMediaStream](https://write.woa.com/document/87029900866228224)</td>
118
-
119
- <td rowspan="1" colSpan="1" >Update the published media stream.</td>
120
- </tr>
121
-
122
- <tr>
123
- <td rowspan="1" colSpan="1" >[stopPublishMediaStream](https://write.woa.com/document/87029900866228224)</td>
124
-
125
- <td rowspan="1" colSpan="1" >Stop publishing media stream.</td>
126
- </tr>
127
-
128
- <tr>
129
- <td rowspan="1" colSpan="1" >[startLocalPreview](https://write.woa.com/document/87029900866228224)</td>
130
-
131
- <td rowspan="1" colSpan="1" >Enable the preview screen of the local camera (Mobile Terminal)</td>
132
- </tr>
133
-
134
- <tr>
135
- <td rowspan="1" colSpan="1" >[updateLocalView](https://write.woa.com/document/87029900866228224)</td>
136
-
137
- <td rowspan="1" colSpan="1" >Update the preview screen of the local camera</td>
138
- </tr>
139
-
140
- <tr>
141
- <td rowspan="1" colSpan="1" >[stopLocalPreview](https://write.woa.com/document/87029900866228224)</td>
142
-
143
- <td rowspan="1" colSpan="1" >Stop camera preview</td>
144
- </tr>
145
-
146
- <tr>
147
- <td rowspan="1" colSpan="1" >[muteLocalVideo](https://write.woa.com/document/87029900866228224)</td>
148
-
149
- <td rowspan="1" colSpan="1" >Suspend/Resume publishing local video stream</td>
150
- </tr>
151
-
152
- <tr>
153
- <td rowspan="1" colSpan="1" >[setVideoMuteImage](https://write.woa.com/document/87029900866228224)</td>
154
-
155
- <td rowspan="1" colSpan="1" >Set the alternative image during the suspension of the local screen</td>
156
- </tr>
157
-
158
- <tr>
159
- <td rowspan="1" colSpan="1" >[startRemoteView](https://write.woa.com/document/87029900866228224)</td>
160
-
161
- <td rowspan="1" colSpan="1" >Subscribe to the video stream of a remote user and bind the video rendering control</td>
162
- </tr>
163
-
164
- <tr>
165
- <td rowspan="1" colSpan="1" >[updateRemoteView](https://write.woa.com/document/87029900866228224)</td>
166
-
167
- <td rowspan="1" colSpan="1" >Update the video rendering control of a remote user</td>
168
- </tr>
169
-
170
- <tr>
171
- <td rowspan="1" colSpan="1" >[stopRemoteView](https://write.woa.com/document/87029900866228224)</td>
172
-
173
- <td rowspan="1" colSpan="1" >Unsubscribe from the remote user's video stream and release the rendering control</td>
174
- </tr>
175
-
176
- <tr>
177
- <td rowspan="1" colSpan="1" >[stopAllRemoteView](https://write.woa.com/document/87029900866228224)</td>
178
-
179
- <td rowspan="1" colSpan="1" >Unsubscribe from all remote users' video streams and release all rendering resources</td>
180
- </tr>
181
-
182
- <tr>
183
- <td rowspan="1" colSpan="1" >[muteRemoteVideoStream](https://write.woa.com/document/87029900866228224)</td>
184
-
185
- <td rowspan="1" colSpan="1" >Suspend/Resume subscription of the remote user's video stream</td>
186
- </tr>
187
-
188
- <tr>
189
- <td rowspan="1" colSpan="1" >[muteAllRemoteVideoStreams](https://write.woa.com/document/87029900866228224)</td>
190
-
191
- <td rowspan="1" colSpan="1" >Suspend/Resume subscription of all remote users' video streams</td>
192
- </tr>
193
-
194
- <tr>
195
- <td rowspan="1" colSpan="1" >[setVideoEncoderParam](https://write.woa.com/document/87029900866228224)</td>
196
-
197
- <td rowspan="1" colSpan="1" >Set encoding parameters for the video encoder</td>
198
- </tr>
199
-
200
- <tr>
201
- <td rowspan="1" colSpan="1" >[setNetworkQosParam](https://write.woa.com/document/87029900866228224)</td>
202
-
203
- <td rowspan="1" colSpan="1" >Set network quality control parameters</td>
204
- </tr>
205
-
206
- <tr>
207
- <td rowspan="1" colSpan="1" >[setLocalRenderParams](https://write.woa.com/document/87029900866228224)</td>
208
-
209
- <td rowspan="1" colSpan="1" >Set rendering parameters for the local screen</td>
210
- </tr>
211
-
212
- <tr>
213
- <td rowspan="1" colSpan="1" >[setRemoteRenderParams](https://write.woa.com/document/87029900866228224)</td>
214
-
215
- <td rowspan="1" colSpan="1" >Set rendering mode for the remote screen</td>
216
- </tr>
217
-
218
- <tr>
219
- <td rowspan="1" colSpan="1" >[enableEncSmallVideoStream](https://write.woa.com/document/87029900866228224)</td>
220
-
221
- <td rowspan="1" colSpan="1" >Enable picture-in-picture dual-stream encoding mode</td>
222
- </tr>
223
-
224
- <tr>
225
- <td rowspan="1" colSpan="1" >[setRemoteVideoStreamType](https://write.woa.com/document/87029900866228224)</td>
226
-
227
- <td rowspan="1" colSpan="1" >Switch picture-in-picture for the specified remote user</td>
228
- </tr>
229
-
230
- <tr>
231
- <td rowspan="1" colSpan="1" >[snapshotVideo](https://write.woa.com/document/87029900866228224)</td>
232
-
233
- <td rowspan="1" colSpan="1" >Take a video screenshot</td>
234
- </tr>
235
-
236
- <tr>
237
- <td rowspan="1" colSpan="1" >[setPerspectiveCorrectionPoints](https://write.woa.com/document/87029900866228224)</td>
238
-
239
- <td rowspan="1" colSpan="1" >Set perspective correction coordinate settings for the video screen</td>
240
- </tr>
241
-
242
- <tr>
243
- <td rowspan="1" colSpan="1" >[setGravitySensorAdaptiveMode](https://write.woa.com/document/87029900866228224)</td>
244
-
245
- <td rowspan="1" colSpan="1" >Set gravity sensing adaptive mode (11.7 and above)</td>
246
- </tr>
247
-
248
- <tr>
249
- <td rowspan="1" colSpan="1" >[startLocalAudio](https://write.woa.com/document/87029900866228224)</td>
250
-
251
- <td rowspan="1" colSpan="1" >Enable collection and publishing of local audio</td>
252
- </tr>
253
-
254
- <tr>
255
- <td rowspan="1" colSpan="1" >[stopLocalAudio](https://write.woa.com/document/87029900866228224)</td>
256
-
257
- <td rowspan="1" colSpan="1" >Stop collection and publishing of local audio</td>
258
- </tr>
259
-
260
- <tr>
261
- <td rowspan="1" colSpan="1" >[muteLocalAudio](https://write.woa.com/document/87029900866228224)</td>
262
-
263
- <td rowspan="1" colSpan="1" >Pause/Resume publishing of the local audio stream</td>
264
- </tr>
265
-
266
- <tr>
267
- <td rowspan="1" colSpan="1" >[muteRemoteAudio](https://write.woa.com/document/87029900866228224)</td>
268
-
269
- <td rowspan="1" colSpan="1" >Pause/Resume playing of the remote audio stream</td>
270
- </tr>
271
-
272
- <tr>
273
- <td rowspan="1" colSpan="1" >[muteAllRemoteAudio](https://write.woa.com/document/87029900866228224)</td>
274
-
275
- <td rowspan="1" colSpan="1" >Pause/Resume playing of all remote users' audio streams</td>
276
- </tr>
277
-
278
- <tr>
279
- <td rowspan="1" colSpan="1" >[setAudioRoute](https://write.woa.com/document/87029900866228224)</td>
280
-
281
- <td rowspan="1" colSpan="1" >Sets audio routing.</td>
282
- </tr>
283
-
284
- <tr>
285
- <td rowspan="1" colSpan="1" >[setRemoteAudioVolume](https://write.woa.com/document/87029900866228224)</td>
286
-
287
- <td rowspan="1" colSpan="1" >Set the playback volume for a specific remote user</td>
288
- </tr>
289
-
290
- <tr>
291
- <td rowspan="1" colSpan="1" >[setAudioCaptureVolume](https://write.woa.com/document/87029900866228224)</td>
292
-
293
- <td rowspan="1" colSpan="1" >Sets the local audio capture volume.</td>
294
- </tr>
295
-
296
- <tr>
297
- <td rowspan="1" colSpan="1" >[getAudioCaptureVolume](https://write.woa.com/document/87029900866228224)</td>
298
-
299
- <td rowspan="1" colSpan="1" >Obtains the local audio capture volume.</td>
300
- </tr>
301
-
302
- <tr>
303
- <td rowspan="1" colSpan="1" >[setAudioPlayoutVolume](https://write.woa.com/document/87029900866228224)</td>
304
-
305
- <td rowspan="1" colSpan="1" >Sets the remote audio playback volume.</td>
306
- </tr>
307
-
308
- <tr>
309
- <td rowspan="1" colSpan="1" >[getAudioPlayoutVolume](https://write.woa.com/document/87029900866228224)</td>
310
-
311
- <td rowspan="1" colSpan="1" >Obtains the remote audio playback volume.</td>
312
- </tr>
313
-
314
- <tr>
315
- <td rowspan="1" colSpan="1" >[enableAudioVolumeEvaluation](https://write.woa.com/document/87029900866228224)</td>
316
-
317
- <td rowspan="1" colSpan="1" >Enable volume reminder</td>
318
- </tr>
319
-
320
- <tr>
321
- <td rowspan="1" colSpan="1" >[startAudioRecording](https://write.woa.com/document/87029900866228224)</td>
322
-
323
- <td rowspan="1" colSpan="1" >Start recording</td>
324
- </tr>
325
-
326
- <tr>
327
- <td rowspan="1" colSpan="1" >[stopAudioRecording](https://write.woa.com/document/87029900866228224)</td>
328
-
329
- <td rowspan="1" colSpan="1" >Stop recording</td>
330
- </tr>
331
-
332
- <tr>
333
- <td rowspan="1" colSpan="1" >[startLocalRecording](https://write.woa.com/document/87029900866228224)</td>
334
-
335
- <td rowspan="1" colSpan="1" >Enable local media recording</td>
336
- </tr>
337
-
338
- <tr>
339
- <td rowspan="1" colSpan="1" >[stopLocalRecording](https://write.woa.com/document/87029900866228224)</td>
340
-
341
- <td rowspan="1" colSpan="1" >Stop local media recording</td>
342
- </tr>
343
-
344
- <tr>
345
- <td rowspan="1" colSpan="1" >[setRemoteAudioParallelParams](https://write.woa.com/document/87029900866228224)</td>
346
-
347
- <td rowspan="1" colSpan="1" >Set intelligent concurrent playback strategy for remote audio streams</td>
348
- </tr>
349
-
350
- <tr>
351
- <td rowspan="1" colSpan="1" >[enable3DSpatialAudioEffect](https://write.woa.com/document/87029900866228224)</td>
352
-
353
- <td rowspan="1" colSpan="1" >Enable 3D audio</td>
354
- </tr>
355
-
356
- <tr>
357
- <td rowspan="1" colSpan="1" >[updateSelf3DSpatialPosition](https://write.woa.com/document/87029900866228224)</td>
358
-
359
- <td rowspan="1" colSpan="1" >Set self coordinates and orientation information in 3D audio</td>
360
- </tr>
361
-
362
- <tr>
363
- <td rowspan="1" colSpan="1" >[updateRemote3DSpatialPosition](https://write.woa.com/document/87029900866228224)</td>
364
-
365
- <td rowspan="1" colSpan="1" >Set remote user coordinate information in 3D audio</td>
366
- </tr>
367
-
368
- <tr>
369
- <td rowspan="1" colSpan="1" >[set3DSpatialReceivingRange](https://write.woa.com/document/87029900866228224)</td>
370
-
371
- <td rowspan="1" colSpan="1" >Set the receivable range of sounds emitted by a specified user</td>
372
- </tr>
373
-
374
- <tr>
375
- <td rowspan="1" colSpan="1" >[getDeviceManager](https://write.woa.com/document/87029900866228224)</td>
376
-
377
- <td rowspan="1" colSpan="1" >Get Device Management Class (TXDeviceManager)</td>
378
- </tr>
379
-
380
- <tr>
381
- <td rowspan="1" colSpan="1" >[getBeautyManager](https://write.woa.com/document/87029900866228224)</td>
382
-
383
- <td rowspan="1" colSpan="1" >Get Beauty Management Class (TXBeautyManager)</td>
384
- </tr>
385
-
386
- <tr>
387
- <td rowspan="1" colSpan="1" >[setWatermark](https://write.woa.com/document/87029900866228224)</td>
388
-
389
- <td rowspan="1" colSpan="1" >Watermarking</td>
390
- </tr>
391
-
392
- <tr>
393
- <td rowspan="1" colSpan="1" >[getAudioEffectManager](https://write.woa.com/document/87029900866228224)</td>
394
-
395
- <td rowspan="1" colSpan="1" >Get Audio Effect Management Class (TXAudioEffectManager)</td>
396
- </tr>
397
-
398
- <tr>
399
- <td rowspan="1" colSpan="1" >[startSystemAudioLoopback](https://write.woa.com/document/87029900866228224)</td>
400
-
401
- <td rowspan="1" colSpan="1" >Enable System Sound Capturing</td>
402
- </tr>
403
-
404
- <tr>
405
- <td rowspan="1" colSpan="1" >[stopSystemAudioLoopback](https://write.woa.com/document/87029900866228224)</td>
406
-
407
- <td rowspan="1" colSpan="1" >Stop System Sound Capture (iOS not yet supported)</td>
408
- </tr>
409
-
410
- <tr>
411
- <td rowspan="1" colSpan="1" >[startScreenCapture](https://write.woa.com/document/87029900866228224)</td>
412
-
413
- <td rowspan="1" colSpan="1" >Start Screen Sharing</td>
414
- </tr>
415
-
416
- <tr>
417
- <td rowspan="1" colSpan="1" >[stopScreenCapture](https://write.woa.com/document/87029900866228224)</td>
418
-
419
- <td rowspan="1" colSpan="1" >Stopping Screen Sharing</td>
420
- </tr>
421
-
422
- <tr>
423
- <td rowspan="1" colSpan="1" >[pauseScreenCapture](https://write.woa.com/document/87029900866228224)</td>
424
-
425
- <td rowspan="1" colSpan="1" >Pause Screen Sharing</td>
426
- </tr>
427
-
428
- <tr>
429
- <td rowspan="1" colSpan="1" >[resumeScreenCapture](https://write.woa.com/document/87029900866228224)</td>
430
-
431
- <td rowspan="1" colSpan="1" >Resume Screen Sharing</td>
432
- </tr>
433
-
434
- <tr>
435
- <td rowspan="1" colSpan="1" >[setSubStreamEncoderParam](https://write.woa.com/document/87029900866228224)</td>
436
-
437
- <td rowspan="1" colSpan="1" >Set Video Encoding Parameters for Screen Sharing (Sub-Stream) (Supported on Both Desktop and Mobile Systems)</td>
438
- </tr>
439
-
440
- <tr>
441
- <td rowspan="1" colSpan="1" >[enableCustomVideoCapture](https://write.woa.com/document/87029900866228224)</td>
442
-
443
- <td rowspan="1" colSpan="1" >Enable/Disable Custom Video Capturing Mode</td>
444
- </tr>
445
-
446
- <tr>
447
- <td rowspan="1" colSpan="1" >[sendCustomVideoData](https://write.woa.com/document/87029900866228224)</td>
448
-
449
- <td rowspan="1" colSpan="1" >Submit Self-collected Video Frames to the SDK</td>
450
- </tr>
451
-
452
- <tr>
453
- <td rowspan="1" colSpan="1" >[enableCustomAudioCapture](https://write.woa.com/document/87029900866228224)</td>
454
-
455
- <td rowspan="1" colSpan="1" >Enable Custom Audio Capturing Mode</td>
456
- </tr>
457
-
458
- <tr>
459
- <td rowspan="1" colSpan="1" >[sendCustomAudioData](https://write.woa.com/document/87029900866228224)</td>
460
-
461
- <td rowspan="1" colSpan="1" >Submit Self-collected Audio Data to the SDK</td>
462
- </tr>
463
-
464
- <tr>
465
- <td rowspan="1" colSpan="1" >[enableMixExternalAudioFrame](https://write.woa.com/document/87029900866228224)</td>
466
-
467
- <td rowspan="1" colSpan="1" >Enable/Disable Custom Audio Track</td>
468
- </tr>
469
-
470
- <tr>
471
- <td rowspan="1" colSpan="1" >[mixExternalAudioFrame](https://write.woa.com/document/87029900866228224)</td>
472
-
473
- <td rowspan="1" colSpan="1" >Mix Custom Audio Track into the SDK</td>
474
- </tr>
475
-
476
- <tr>
477
- <td rowspan="1" colSpan="1" >[setMixExternalAudioVolume](https://write.woa.com/document/87029900866228224)</td>
478
-
479
- <td rowspan="1" colSpan="1" >Set the Streaming Volume and Playback Volume for External Audio Mixed During Streaming</td>
480
- </tr>
481
-
482
- <tr>
483
- <td rowspan="1" colSpan="1" >[generateCustomPTS](https://write.woa.com/document/87029900866228224)</td>
484
-
485
- <td rowspan="1" colSpan="1" >Generate Timestamp for Custom Capturing</td>
486
- </tr>
487
-
488
- <tr>
489
- <td rowspan="1" colSpan="1" >[setLocalVideoProcessListener](https://write.woa.com/document/87029900866228224)</td>
490
-
491
- <td rowspan="1" colSpan="1" >Set Video Data Callback for Third-party Beauty Filter</td>
492
- </tr>
493
-
494
- <tr>
495
- <td rowspan="1" colSpan="1" >[setLocalVideoRenderListener](https://write.woa.com/document/87029900866228224)</td>
496
-
497
- <td rowspan="1" colSpan="1" >Set Local Video Custom Rendering Callback</td>
498
- </tr>
499
-
500
- <tr>
501
- <td rowspan="1" colSpan="1" >[setRemoteVideoRenderListener](https://write.woa.com/document/87029900866228224)</td>
502
-
503
- <td rowspan="1" colSpan="1" >Sets the rendering callback for remote video self-definition</td>
504
- </tr>
505
-
506
- <tr>
507
- <td rowspan="1" colSpan="1" >[setAudioFrameListener](https://write.woa.com/document/87029900866228224)</td>
508
-
509
- <td rowspan="1" colSpan="1" >Sets the audio data self-definition callback</td>
510
- </tr>
511
-
512
- <tr>
513
- <td rowspan="1" colSpan="1" >[setCapturedAudioFrameCallbackFormat](https://write.woa.com/document/87029900866228224)</td>
514
-
515
- <td rowspan="1" colSpan="1" >Sets the callback format for audio frames captured by the local microphone</td>
516
- </tr>
517
-
518
- <tr>
519
- <td rowspan="1" colSpan="1" >[setLocalProcessedAudioFrameCallbackFormat](https://write.woa.com/document/87029900866228224)</td>
520
-
521
- <td rowspan="1" colSpan="1" >Sets the callback format for local audio frames after preprocessing</td>
522
- </tr>
523
-
524
- <tr>
525
- <td rowspan="1" colSpan="1" >[setMixedPlayAudioFrameCallbackFormat](https://write.woa.com/document/87029900866228224)</td>
526
-
527
- <td rowspan="1" colSpan="1" >Sets the callback format for audio frames that will eventually be played by the system</td>
528
- </tr>
529
-
530
- <tr>
531
- <td rowspan="1" colSpan="1" >[enableCustomAudioRendering](https://write.woa.com/document/87029900866228224)</td>
532
-
533
- <td rowspan="1" colSpan="1" >Enable self-definition audio playback</td>
534
- </tr>
535
-
536
- <tr>
537
- <td rowspan="1" colSpan="1" >[getCustomAudioRenderingFrame](https://write.woa.com/document/87029900866228224)</td>
538
-
539
- <td rowspan="1" colSpan="1" >Get playable audio data</td>
540
- </tr>
541
-
542
- <tr>
543
- <td rowspan="1" colSpan="1" >[sendCustomCmdMsg](https://write.woa.com/document/87029900866228224)</td>
544
-
545
- <td rowspan="1" colSpan="1" >Sends a custom message using UDP channel to all users in a room</td>
546
- </tr>
547
-
548
- <tr>
549
- <td rowspan="1" colSpan="1" >[sendSEIMsg](https://write.woa.com/document/87029900866228224)</td>
550
-
551
- <td rowspan="1" colSpan="1" >Sends a custom message using SEI channel to all users in a room</td>
552
- </tr>
553
-
554
- <tr>
555
- <td rowspan="1" colSpan="1" >[startSpeedTest](https://write.woa.com/document/87029900866228224)</td>
556
-
557
- <td rowspan="1" colSpan="1" >Start internet speed test (use before entering the room)</td>
558
- </tr>
559
-
560
- <tr>
561
- <td rowspan="1" colSpan="1" >[stopSpeedTest](https://write.woa.com/document/87029900866228224)</td>
562
-
563
- <td rowspan="1" colSpan="1" >Stops network speed testing</td>
564
- </tr>
565
-
566
- <tr>
567
- <td rowspan="1" colSpan="1" >[getSDKVersion](https://write.woa.com/document/87029900866228224)</td>
568
-
569
- <td rowspan="1" colSpan="1" >Obtains the SDK version.</td>
570
- </tr>
571
-
572
- <tr>
573
- <td rowspan="1" colSpan="1" >[setLogLevel](https://write.woa.com/document/87029900866228224)</td>
574
-
575
- <td rowspan="1" colSpan="1" >Sets the log output level.</td>
576
- </tr>
577
-
578
- <tr>
579
- <td rowspan="1" colSpan="1" >[setConsoleEnabled](https://write.woa.com/document/87029900866228224)</td>
580
-
581
- <td rowspan="1" colSpan="1" >Enables/Disables console log print.</td>
582
- </tr>
583
-
584
- <tr>
585
- <td rowspan="1" colSpan="1" >[setLogCompressEnabled](https://write.woa.com/document/87029900866228224)</td>
586
-
587
- <td rowspan="1" colSpan="1" >Enables/Disables local log compression</td>
588
- </tr>
589
-
590
- <tr>
591
- <td rowspan="1" colSpan="1" >[setLogDirPath](https://write.woa.com/document/87029900866228224)</td>
592
-
593
- <td rowspan="1" colSpan="1" >Sets the save path for local logs</td>
594
- </tr>
595
-
596
- <tr>
597
- <td rowspan="1" colSpan="1" >[setLogListener](https://write.woa.com/document/87029900866228224)</td>
598
-
599
- <td rowspan="1" colSpan="1" >Log callback</td>
600
- </tr>
601
-
602
- <tr>
603
- <td rowspan="1" colSpan="1" >[showDebugView](https://write.woa.com/document/87029900866228224)</td>
604
-
605
- <td rowspan="1" colSpan="1" >Show Dashboard</td>
606
- </tr>
607
-
608
- <tr>
609
- <td rowspan="1" colSpan="1" >[TRTCViewMargin](https://write.woa.com/document/87029900866228224)</td>
610
-
611
- <td rowspan="1" colSpan="1" >Set the dashboard margin</td>
612
- </tr>
613
-
614
- <tr>
615
- <td rowspan="1" colSpan="1" >[callExperimentalAPI](https://write.woa.com/document/87029900866228224)</td>
616
-
617
- <td rowspan="1" colSpan="1" >Calls an experimental API.</td>
618
- </tr>
619
-
620
- <tr>
621
- <td rowspan="1" colSpan="1" >[enablePayloadPrivateEncryption](https://write.woa.com/document/87029900866228224)</td>
622
-
623
- <td rowspan="1" colSpan="1" >Enable or disable media stream private encryption</td>
624
- </tr>
625
- </table>
626
-
6
+ | Function List | Description |
7
+ | --- | --- |
8
+ | sharedInstance | Create a `TRTCCloud` Instance (Singleton Pattern) |
9
+ | destroySharedInstance | Terminate `TRTCCloud` Instance (Singleton Pattern) |
10
+ | addListener | Add TRTC Event Callback |
11
+ | removeListener | Remove TRTC Event Callback |
12
+ | setListenerHandler | Set the queue to drive TRTCCloudListener event callbacks |
13
+ | enterRoom | Enter Room |
14
+ | exitRoom | Leave Room |
15
+ | switchRole | Switch Role |
16
+ | switchRole | Switch Role (Supports Setting Permission Bit) |
17
+ | switchRoom | Switch Room |
18
+ | ConnectOtherRoom | Request Cross-room Communication |
19
+ | DisconnectOtherRoom | Exit Cross-room Communication |
20
+ | setDefaultStreamRecvMode | Set Subscription Mode (Needs to be set before entering the room to take effect) |
21
+ | createSubCloud | Create Sub-room Instances (For Multi-room Concurrent Viewing) |
22
+ | destroySubCloud | Terminate Sub-room Instances |
23
+ | updateOtherRoomForwardMode | Modify the uplink capability of cross-room broadcasters in this room |
24
+ | startPublishMediaStream | Start publishing media stream |
25
+ | updatePublishMediaStream | Update the published media stream. |
26
+ | stopPublishMediaStream | Stop publishing media stream. |
27
+ | startLocalPreview | Enable the preview screen of the local camera (Mobile Terminal) |
28
+ | updateLocalView | Update the preview screen of the local camera |
29
+ | stopLocalPreview | Stop camera preview |
30
+ | muteLocalVideo | Suspend/Resume publishing local video stream |
31
+ | setVideoMuteImage | Set the alternative image during the suspension of the local screen |
32
+ | startRemoteView | Subscribe to the video stream of a remote user and bind the video rendering control |
33
+ | updateRemoteView | Update the video rendering control of a remote user |
34
+ | stopRemoteView | Unsubscribe from the remote user's video stream and release the rendering control |
35
+ | stopAllRemoteView | Unsubscribe from all remote users' video streams and release all rendering resources |
36
+ | muteRemoteVideoStream | Suspend/Resume subscription of the remote user's video stream |
37
+ | muteAllRemoteVideoStreams | Suspend/Resume subscription of all remote users' video streams |
38
+ | setVideoEncoderParam | Set encoding parameters for the video encoder |
39
+ | setNetworkQosParam | Set network quality control parameters |
40
+ | setLocalRenderParams | Set rendering parameters for the local screen |
41
+ | setRemoteRenderParams | Set rendering mode for the remote screen |
42
+ | enableEncSmallVideoStream | Enable picture-in-picture dual-stream encoding mode |
43
+ | setRemoteVideoStreamType | Switch picture-in-picture for the specified remote user |
44
+ | snapshotVideo | Take a video screenshot |
45
+ | setPerspectiveCorrectionPoints | Set perspective correction coordinate settings for the video screen |
46
+ | setGravitySensorAdaptiveMode | Set gravity sensing adaptive mode (11.7 and above) |
47
+ | startLocalAudio | Enable collection and publishing of local audio |
48
+ | stopLocalAudio | Stop collection and publishing of local audio |
49
+ | muteLocalAudio | Pause/Resume publishing of the local audio stream |
50
+ | muteRemoteAudio | Pause/Resume playing of the remote audio stream |
51
+ | muteAllRemoteAudio | Pause/Resume playing of all remote users' audio streams |
52
+ | setAudioRoute | Sets audio routing. |
53
+ | setRemoteAudioVolume | Set the playback volume for a specific remote user |
54
+ | setAudioCaptureVolume | Sets the local audio capture volume. |
55
+ | getAudioCaptureVolume | Obtains the local audio capture volume. |
56
+ | setAudioPlayoutVolume | Sets the remote audio playback volume. |
57
+ | getAudioPlayoutVolume | Obtains the remote audio playback volume. |
58
+ | enableAudioVolumeEvaluation | Enable volume reminder |
59
+ | startAudioRecording | Start recording |
60
+ | stopAudioRecording | Stop recording |
61
+ | startLocalRecording | Enable local media recording |
62
+ | stopLocalRecording | Stop local media recording |
63
+ | setRemoteAudioParallelParams | Set intelligent concurrent playback strategy for remote audio streams |
64
+ | enable3DSpatialAudioEffect | Enable 3D audio |
65
+ | updateSelf3DSpatialPosition | Set self coordinates and orientation information in 3D audio |
66
+ | updateRemote3DSpatialPosition | Set remote user coordinate information in 3D audio |
67
+ | set3DSpatialReceivingRange | Set the receivable range of sounds emitted by a specified user |
68
+ | getDeviceManager | Get Device Management Class (TXDeviceManager) |
69
+ | getBeautyManager | Get Beauty Management Class (TXBeautyManager) |
70
+ | setWatermark | Watermarking |
71
+ | getAudioEffectManager | Get Audio Effect Management Class (TXAudioEffectManager) |
72
+ | startSystemAudioLoopback | Enable System Sound Capturing |
73
+ | stopSystemAudioLoopback | Stop System Sound Capture (iOS not yet supported) |
74
+ | startScreenCapture | Start Screen Sharing |
75
+ | stopScreenCapture | Stopping Screen Sharing |
76
+ | pauseScreenCapture | Pause Screen Sharing |
77
+ | resumeScreenCapture | Resume Screen Sharing |
78
+ | setSubStreamEncoderParam | Set Video Encoding Parameters for Screen Sharing (Sub-Stream) (Supported on Both Desktop and Mobile Systems) |
79
+ | enableCustomVideoCapture | Enable/Disable Custom Video Capturing Mode |
80
+ | sendCustomVideoData | Submit Self-collected Video Frames to the SDK |
81
+ | enableCustomAudioCapture | Enable Custom Audio Capturing Mode |
82
+ | sendCustomAudioData | Submit Self-collected Audio Data to the SDK |
83
+ | enableMixExternalAudioFrame | Enable/Disable Custom Audio Track |
84
+ | mixExternalAudioFrame | Mix Custom Audio Track into the SDK |
85
+ | setMixExternalAudioVolume | Set the Streaming Volume and Playback Volume for External Audio Mixed During Streaming |
86
+ | generateCustomPTS | Generate Timestamp for Custom Capturing |
87
+ | setLocalVideoProcessListener | Set Video Data Callback for Third-party Beauty Filter |
88
+ | setLocalVideoRenderListener | Set Local Video Custom Rendering Callback |
89
+ | setRemoteVideoRenderListener | Sets the rendering callback for remote video self-definition |
90
+ | setAudioFrameListener | Sets the audio data self-definition callback |
91
+ | setCapturedAudioFrameCallbackFormat | Sets the callback format for audio frames captured by the local microphone |
92
+ | setLocalProcessedAudioFrameCallbackFormat | Sets the callback format for local audio frames after preprocessing |
93
+ | setMixedPlayAudioFrameCallbackFormat | Sets the callback format for audio frames that will eventually be played by the system |
94
+ | enableCustomAudioRendering | Enable self-definition audio playback |
95
+ | getCustomAudioRenderingFrame | Get playable audio data |
96
+ | sendCustomCmdMsg | Sends a custom message using UDP channel to all users in a room |
97
+ | sendSEIMsg | Sends a custom message using SEI channel to all users in a room |
98
+ | startSpeedTest | Start internet speed test (use before entering the room) |
99
+ | stopSpeedTest | Stops network speed testing |
100
+ | getSDKVersion | Obtains the SDK version. |
101
+ | setLogLevel | Sets the log output level. |
102
+ | setConsoleEnabled | Enables/Disables console log print. |
103
+ | setLogCompressEnabled | Enables/Disables local log compression |
104
+ | setLogDirPath | Sets the save path for local logs |
105
+ | setLogListener | Log callback |
106
+ | showDebugView | Show Dashboard |
107
+ | TRTCViewMargin | Set the dashboard margin |
108
+ | callExperimentalAPI | Calls an experimental API. |
109
+ | enablePayloadPrivateEncryption | Enable or disable media stream private encryption |
627
110
 
628
111
  ## sharedInstance
629
112
 
630
-
631
-
632
113
  #### Create a `TRTCCloud` Instance (Singleton Pattern)
633
- <table>
634
- <tr>
635
- <td rowspan="1" colSpan="1" >Parameters</td>
636
-
637
- <td rowspan="1" colSpan="1" >Description</td>
638
- </tr>
639
-
640
- <tr>
641
- <td rowspan="1" colSpan="1" >context</td>
642
-
643
- <td rowspan="1" colSpan="1" >Only applies to the Android platform. The SDK internally converts it to the Android platform's ApplicationContext to call Android System API.<br>If the passed context parameter is NULL, the SDK will automatically obtain the current process's ApplicationContext.</td>
644
- </tr>
645
- </table>
646
-
114
+ | Parameters | Description |
115
+ | --- | --- |
116
+ | context | Only applies to the Android platform. The SDK internally converts it to the Android platform's ApplicationContext to call Android System API.<br>If the passed context parameter is NULL, the SDK will automatically obtain the current process's ApplicationContext. |
647
117
 
648
118
  > **Note**
649
- >
119
+ >
650
120
 
651
121
  > 1. Using delete ITRTCCloud* will cause compilation errors. Please use destroyTRTCCloud to release the object pointer.
652
- >
122
+ >
653
123
 
654
124
  > 2. On Windows, Mac, and iOS platforms, please call the getTRTCShareInstance() interface.
655
- >
125
+ >
656
126
 
657
127
  > 3. On the Android platform, please call the getTRTCShareInstance(void *context) interface.
658
- >
659
-
128
+ >
660
129
 
661
130
  ## destroySharedInstance
662
131
 
663
-
664
-
665
132
  #### Terminate `TRTCCloud` Instance (Singleton Pattern)
666
133
 
667
134
  ## addListener
668
135
 
669
-
670
-
671
136
  #### Add TRTC Event Callback
672
137
 
673
- You can receive various event notifications from the SDK (such as error codes, warning codes, audio and video status parameters, etc.) through [TRTCCloudListener](https://write.woa.com/document/87029920275542016).
138
+ You can receive various event notifications from the SDK (such as error codes, warning codes, audio and video status parameters, etc.) through TRTCCloudListener.
674
139
 
675
140
  ## removeListener
676
141
 
677
-
678
-
679
142
  #### Remove TRTC Event Callback
680
143
 
681
144
  ## setListenerHandler
682
145
 
683
-
684
-
685
146
  #### Set the queue to drive TRTCCloudListener event callbacks
686
147
 
687
- If you do not specify your own listenerHandler, MainQueue will be used as the default queue to drive [TRTCCloudListener](https://write.woa.com/document/87029920275542016) event callbacks.
688
-
689
- This means that if you do not set the listenerHandler attribute, all callback functions in [TRTCCloudListener](https://write.woa.com/document/87029920275542016) are driven by MainQueue.
690
- <table>
691
- <tr>
692
- <td rowspan="1" colSpan="1" >Parameters</td>
693
-
694
- <td rowspan="1" colSpan="1" >Description</td>
695
- </tr>
696
-
697
- <tr>
698
- <td rowspan="1" colSpan="1" >listenerHandler</td>
699
-
700
- <td rowspan="1" colSpan="1" >Event callback handler</td>
701
- </tr>
702
- </table>
148
+ If you do not specify your own listenerHandler, MainQueue will be used as the default queue to drive TRTCCloudListener event callbacks.
703
149
 
150
+ This means that if you do not set the listenerHandler attribute, all callback functions in TRTCCloudListener are driven by MainQueue.
151
+ | Parameters | Description |
152
+ | --- | --- |
153
+ | listenerHandler | Event callback handler |
704
154
 
705
155
  > **Note**
706
- >
707
-
708
- > If you specify your own listenerHandler, please do not operate the UI in the [TRTCCloudListener](https://write.woa.com/document/87029920275542016) callback functions, otherwise it will cause thread safety issues.
709
- >
156
+ >
710
157
 
158
+ > If you specify your own listenerHandler, please do not operate the UI in the TRTCCloudListener callback functions, otherwise it will cause thread safety issues.
159
+ >
711
160
 
712
161
  ## enterRoom
713
162
 
714
-
715
-
716
163
  #### Enter Room
717
164
 
718
165
  All TRTC users must enter a room to "publish" or "subscribe" to audio and video streams. "Publish" means pushing your audio and video to the cloud, and "subscribe" means pulling audio and video streams from other users in the room from the cloud.
719
166
 
720
- To call this interface, you need to specify your application scenario [TRTCAppScene](https://write.woa.com/document/87029993616093184) for the best audio and video transmission experience. These scenarios can be divided into two major categories:
721
-
722
-
167
+ To call this interface, you need to specify your application scenario TRTCAppScene for the best audio and video transmission experience. These scenarios can be divided into two major categories:
723
168
 
724
169
  **Real-time Call:**
725
170
 
726
- Including the two options [TRTC_APP_SCENE_VIDEOCALL](https://write.woa.com/document/87029993616093184) and [TRTC_APP_SCENE_AUDIOCALL](https://write.woa.com/document/87029993616093184), which are video call and voice call respectively. This mode is suitable for 1-on-1 audio and video calls or online meetings with fewer than 300 participants.
727
-
728
-
171
+ Including the two options TRTC_APP_SCENE_VIDEOCALL and TRTC_APP_SCENE_AUDIOCALL, which are video call and voice call respectively. This mode is suitable for 1-on-1 audio and video calls or online meetings with fewer than 300 participants.
729
172
 
730
173
  **Online Live Streaming:**
731
174
 
732
- Including the two options [TRTC_APP_SCENE_LIVE](https://write.woa.com/document/87029993616093184) and [TRTC_APP_SCENE_VOICE_CHATROOM](https://write.woa.com/document/87029993616093184), which are video live streaming and voice live streaming respectively. This mode is suitable for online live streaming scenarios with less than 100,000 participants. However, you need to specify the **role** field in the TRTCParams parameter introduced next, distinguishing users in the room as **Anchors** ([TRTCRoleAnchor](https://write.woa.com/document/87029993616093184)) and **Audience** ([TRTCRoleAudience](https://write.woa.com/document/87029993616093184)).
175
+ Including the two options TRTC_APP_SCENE_LIVE and TRTC_APP_SCENE_VOICE_CHATROOM, which are video live streaming and voice live streaming respectively. This mode is suitable for online live streaming scenarios with less than 100,000 participants. However, you need to specify the **role** field in the TRTCParams parameter introduced next, distinguishing users in the room as **Anchors** (TRTCRoleAnchor) and **Audience** (TRTCRoleAudience).
733
176
 
734
-
735
-
736
- After calling this interface, you will receive the onEnterRoom(result) callback from [TRTCCloudListener](https://write.woa.com/document/87029920275542016)
177
+ After calling this interface, you will receive the onEnterRoom(result) callback from TRTCCloudListener
737
178
  - If entering the room is successful, the result parameter will be a positive number (result > 0), indicating the time taken from the function call to entering the room, in milliseconds (ms).
738
179
 
739
180
  - If entering the room fails, the result parameter will be a negative number (result < 0), indicating the failure [Error Code](https://cloud.tencent.com/document/product/647/32257).
740
181
 
741
- <table>
742
- <tr>
743
- <td rowspan="1" colSpan="1" >Parameters</td>
744
-
745
- <td rowspan="1" colSpan="1" >Description</td>
746
- </tr>
747
-
748
- <tr>
749
- <td rowspan="1" colSpan="1" >param</td>
750
-
751
- <td rowspan="1" colSpan="1" >Room entry parameters are used to specify the user's identity, role, and security token information. For details, please refer to [TRTCParams](https://write.woa.com/document/87029993616093184).</td>
752
- </tr>
753
-
754
- <tr>
755
- <td rowspan="1" colSpan="1" >scene</td>
756
-
757
- <td rowspan="1" colSpan="1" >Application scenario parameters are used to specify your business scenario. All users in the same room need to set the same [TRTCAppScene](https://write.woa.com/document/87029993616093184).</td>
758
- </tr>
759
- </table>
760
-
182
+ | Parameters | Description |
183
+ | --- | --- |
184
+ | param | Room entry parameters are used to specify the user's identity, role, and security token information. For details, please refer to TRTCParams. |
185
+ | scene | Application scenario parameters are used to specify your business scenario. All users in the same room need to set the same TRTCAppScene. |
761
186
 
762
187
  > **Note**
763
- >
188
+ >
764
189
 
765
190
  > 1. All users in the same room need to set the same scene. Different scenes can occasionally lead to anomalies.
766
- >
767
-
768
- > 2. When you set the parameter scene to [TRTC_APP_SCENE_LIVE](https://write.woa.com/document/87029993616093184) or [TRTC_APP_SCENE_VOICE_CHATROOM](https://write.woa.com/document/87029993616093184), you must specify the role of the current user in the room through the "role" field in [TRTCParams](https://write.woa.com/document/87029993616093184).
769
- >
191
+ >
770
192
 
771
- > 3. Please ensure that [enterRoom](https://write.woa.com/document/87029900866228224) and [exitRoom](https://write.woa.com/document/87029900866228224) are paired before and after use, i.e., ensure "exit the previous room before entering the next room," otherwise, many anomalies may occur.
772
- >
193
+ > 2. When you set the parameter scene to TRTC_APP_SCENE_LIVE or TRTC_APP_SCENE_VOICE_CHATROOM, you must specify the role of the current user in the room through the "role" field in TRTCParams.
194
+ >
773
195
 
196
+ > 3. Please ensure that enterRoom and exitRoom are paired before and after use, i.e., ensure "exit the previous room before entering the next room," otherwise, many anomalies may occur.
197
+ >
774
198
 
775
199
  ## exitRoom
776
200
 
777
-
778
-
779
201
  #### Leave Room
780
202
 
781
203
  Calling this interface will make the user leave the audio and video room they are in and release resources such as the camera, microphone, and speaker.
782
204
 
783
- After the resources are released, the SDK will notify you through the [TRTCCloudListener](https://write.woa.com/document/87029920275542016) callback [onExitRoom](https://write.woa.com/document/87029920275542016).
205
+ After the resources are released, the SDK will notify you through the TRTCCloudListener callback onExitRoom.
784
206
 
785
-
786
-
787
- If you want to call [enterRoom](https://write.woa.com/document/87029900866228224) again or switch to another provider's SDK, it is recommended to wait for the [onExitRoom](https://write.woa.com/document/87029920275542016) callback before performing subsequent operations to avoid camera or microphone occupation issues.
207
+ If you want to call enterRoom again or switch to another provider's SDK, it is recommended to wait for the onExitRoom callback before performing subsequent operations to avoid camera or microphone occupation issues.
788
208
 
789
209
  ## switchRole
790
210
 
791
-
792
-
793
211
  #### Switch Role
794
212
 
795
213
  This interface allows users to switch between the roles of `Anchor` and `Audience`.
796
214
 
797
-
798
-
799
215
  Since video streaming and voice chat rooms need to support up to 100,000 viewers simultaneously, the rule is set that **only anchors can publish their audio and video**. Therefore, if some audience members wish to publish their audio and video streams (to interact with the anchors), they need to switch their role to **Anchor** first.
800
216
 
801
-
802
-
803
- When entering a room, you can predefine the user's role using the role field in [TRTCParams](https://write.woa.com/document/87029993616093184), or dynamically switch roles after entering the room using the switchRole interface.
804
- <table>
805
- <tr>
806
- <td rowspan="1" colSpan="1" >Parameters</td>
807
-
808
- <td rowspan="1" colSpan="1" >Description</td>
809
- </tr>
810
-
811
- <tr>
812
- <td rowspan="1" colSpan="1" >role</td>
813
-
814
- <td rowspan="1" colSpan="1" >Role, defaults to **Anchor**.<br>- [TRTCRoleAnchor](https://write.woa.com/document/87029993616093184): Anchor, can publish their own audio and video. A maximum of 50 anchors can simultaneously publish audio and video in the same room.<br>- [TRTCRoleAudience](https://write.woa.com/document/87029993616093184): Audience, cannot publish their own audio and video streams, can only view audio and video of other anchors in the room. To publish their own audio and video, they need to switch to **Anchor** via the [switchRole](https://write.woa.com/document/87029900866228224) interface. A maximum of 100,000 audience members can be accommodated in the same room.</td>
815
- </tr>
816
- </table>
817
-
217
+ When entering a room, you can predefine the user's role using the role field in TRTCParams, or dynamically switch roles after entering the room using the switchRole interface.
218
+ | Parameters | Description |
219
+ | --- | --- |
220
+ | role | Role, defaults to **Anchor**.<br>- TRTCRoleAnchor: Anchor, can publish their own audio and video. A maximum of 50 anchors can simultaneously publish audio and video in the same room.<br>- TRTCRoleAudience: Audience, cannot publish their own audio and video streams, can only view audio and video of other anchors in the room. To publish their own audio and video, they need to switch to **Anchor** via the switchRole interface. A maximum of 100,000 audience members can be accommodated in the same room. |
818
221
 
819
222
  > **Note**
820
- >
821
-
822
- > 1. This interface is only applicable to video live streaming ([TRTC_APP_SCENE_LIVE](https://write.woa.com/document/87029993616093184)) and voice chat rooms ([TRTC_APP_SCENE_VOICE_CHATROOM](https://write.woa.com/document/87029993616093184)).
823
- >
223
+ >
824
224
 
825
- > 2. If you specify the scene as [TRTC_APP_SCENE_VIDEOCALL](https://write.woa.com/document/87029993616093184) or [TRTC_APP_SCENE_AUDIOCALL](https://write.woa.com/document/87029993616093184) when calling [enterRoom](https://write.woa.com/document/87029900866228224), do not call this interface.
826
- >
225
+ > 1. This interface is only applicable to video live streaming (TRTC_APP_SCENE_LIVE) and voice chat rooms (TRTC_APP_SCENE_VOICE_CHATROOM).
226
+ >
827
227
 
228
+ > 2. If you specify the scene as TRTC_APP_SCENE_VIDEOCALL or TRTC_APP_SCENE_AUDIOCALL when calling enterRoom, do not call this interface.
229
+ >
828
230
 
829
231
  ## switchRole
830
232
 
831
-
832
-
833
233
  #### Switch Role (Supports Setting Permission Bit)
834
234
 
835
235
  This interface allows users to switch between the roles of `Anchor` and `Audience`.
836
236
 
837
-
838
-
839
237
  Due to video live streaming and voice chat rooms needing to support up to 100,000 viewers simultaneously, a rule has been established that "only the host can publish their own audio and video".
840
238
 
841
239
  Therefore, when some viewers wish to publish their own audio and video streams (in order to interact with the host), they need to first switch their role to "host".
842
240
 
843
- When entering a room, you can predefine the user's role using the role field in [TRTCParams](https://write.woa.com/document/87029993616093184), or dynamically switch roles after entering the room using the switchRole interface.
844
- <table>
845
- <tr>
846
- <td rowspan="1" colSpan="1" >Parameters</td>
847
-
848
- <td rowspan="1" colSpan="1" >Description</td>
849
- </tr>
850
-
851
- <tr>
852
- <td rowspan="1" colSpan="1" >privateMapKey</td>
853
-
854
- <td rowspan="1" colSpan="1" >Permission tickets are used for permission control. When you want to restrict a specific room to allow only specific userIds to enter or upload videos, you need to use privateMapKey for permission protection.<br>- It is recommended only for customers with high-level security requirements. For more details, please refer to [Enabling Advanced Permission Control](https://cloud.tencent.com/document/product/647/32240).</td>
855
- </tr>
856
-
857
- <tr>
858
- <td rowspan="1" colSpan="1" >role</td>
859
-
860
- <td rowspan="1" colSpan="1" >Role, defaults to "Anchor":<br>- [TRTCRoleAnchor](https://write.woa.com/document/87029993616093184): Anchor, can publish their own audio and video. A maximum of 50 anchors can simultaneously publish audio and video in the same room.<br>- [TRTCRoleAudience](https://write.woa.com/document/87029993616093184): Audience cannot publish their own audio and video streams and can only watch other anchors' audio and video in the room. If you want to publish your own audio and video, you need to switch to "Anchor" through [switchRole](https://write.woa.com/document/87029900866228224). A maximum of 100,000 audience members can be accommodated in the same room.</td>
861
- </tr>
862
- </table>
863
-
241
+ When entering a room, you can predefine the user's role using the role field in TRTCParams, or dynamically switch roles after entering the room using the switchRole interface.
242
+ | Parameters | Description |
243
+ | --- | --- |
244
+ | privateMapKey | Permission tickets are used for permission control. When you want to restrict a specific room to allow only specific userIds to enter or upload videos, you need to use privateMapKey for permission protection.<br>- It is recommended only for customers with high-level security requirements. For more details, please refer to [Enabling Advanced Permission Control](https://cloud.tencent.com/document/product/647/32240). |
245
+ | role | Role, defaults to "Anchor":<br>- TRTCRoleAnchor: Anchor, can publish their own audio and video. A maximum of 50 anchors can simultaneously publish audio and video in the same room.<br>- TRTCRoleAudience: Audience cannot publish their own audio and video streams and can only watch other anchors' audio and video in the room. If you want to publish your own audio and video, you need to switch to "Anchor" through switchRole. A maximum of 100,000 audience members can be accommodated in the same room. |
864
246
 
865
247
  > **Note**
866
- >
867
-
868
- > 1. This interface is only applicable to video live streaming ([TRTC_APP_SCENE_LIVE](https://write.woa.com/document/87029993616093184)) and voice chat rooms ([TRTC_APP_SCENE_VOICE_CHATROOM](https://write.woa.com/document/87029993616093184)).
869
- >
248
+ >
870
249
 
871
- > 2. If you specify the scene as [TRTC_APP_SCENE_VIDEOCALL](https://write.woa.com/document/87029993616093184) or [TRTC_APP_SCENE_AUDIOCALL](https://write.woa.com/document/87029993616093184) when calling [enterRoom](https://write.woa.com/document/87029900866228224), do not call this interface.
872
- >
250
+ > 1. This interface is only applicable to video live streaming (TRTC_APP_SCENE_LIVE) and voice chat rooms (TRTC_APP_SCENE_VOICE_CHATROOM).
251
+ >
873
252
 
253
+ > 2. If you specify the scene as TRTC_APP_SCENE_VIDEOCALL or TRTC_APP_SCENE_AUDIOCALL when calling enterRoom, do not call this interface.
254
+ >
874
255
 
875
256
  ## switchRoom
876
257
 
877
-
878
-
879
258
  #### Switch Room
880
259
 
881
260
  This interface allows users to quickly switch from one room to another.
@@ -883,74 +262,44 @@ This interface allows users to quickly switch from one room to another.
883
262
 
884
263
  - If the user's role is "Anchor", this interface will maintain the user's audio and video publishing status while switching rooms. As a result, the preview of the camera and the collection of sound will not be interrupted during the room switching process.
885
264
 
886
-
887
-
888
-
889
265
  This interface is suitable for scenarios in online education where supervising teachers need to switch quickly between multiple rooms. In this scenario, using switchRoom can achieve better smoothness and less code volume compared to using exitRoom + enterRoom.
890
266
 
891
- The result of the interface call will be notified through the onSwitchRoom(errCode, errMsg) callback in [TRTCCloudListener](https://write.woa.com/document/87029920275542016).
892
- <table>
893
- <tr>
894
- <td rowspan="1" colSpan="1" >Parameters</td>
895
-
896
- <td rowspan="1" colSpan="1" >Description</td>
897
- </tr>
898
-
899
- <tr>
900
- <td rowspan="1" colSpan="1" >config</td>
901
-
902
- <td rowspan="1" colSpan="1" >For room parameters, please refer to [TRTCSwitchRoomConfig](https://write.woa.com/document/87029993616093184).</td>
903
- </tr>
904
- </table>
905
-
267
+ The result of the interface call will be notified through the onSwitchRoom(errCode, errMsg) callback in TRTCCloudListener.
268
+ | Parameters | Description |
269
+ | --- | --- |
270
+ | config | For room parameters, please refer to TRTCSwitchRoomConfig. |
906
271
 
907
272
  > **Note**
908
- >
273
+ >
909
274
 
910
275
  > Due to the need for compatibility with older SDK versions, the config parameters contain both roomId and strRoomId. The specifications for filling these parameters are particularly important, so please take note of the following:
911
- >
276
+ >
912
277
 
913
278
  > 1. If you choose strRoomId, then roomId needs to be set to 0. If both are filled, roomId will be selected by default.
914
- >
279
+ >
915
280
 
916
281
  > 2. All rooms must either use strRoomId or roomId consistently. Mixing both will result in unexpected bugs.
917
- >
918
-
282
+ >
919
283
 
920
284
  ## ConnectOtherRoom
921
285
 
922
-
923
-
924
286
  #### Request Cross-room Communication
925
287
 
926
288
  By default, only users within the same room can make audio and video calls. Audio and video streams in different rooms are isolated.
927
289
 
928
290
  However, you can use this interface to publish the audio and video streams of a host in another room to your own room. At the same time, this interface will also publish your own audio and video streams to the target host's room.
929
291
 
930
-
931
-
932
292
  In other words, you can use this interface to enable cross-room audio and video stream sharing between hosts in two different rooms, allowing audiences in each room to watch the audio and video streams of both hosts. This feature can be used to implement a PK feature between hosts.
933
293
 
934
-
935
-
936
- The result of the cross-room call request will be notified to you through the [TRTCCloudListener](https://write.woa.com/document/87029920275542016) callback [onConnectOtherRoom](https://write.woa.com/document/87029920275542016).
937
-
938
-
294
+ The result of the cross-room call request will be notified to you through the TRTCCloudListener callback onConnectOtherRoom.
939
295
 
940
296
  For example, when Host A in room "101" establishes a cross-room call with Host B in room "102" using connectOtherRoom(),
941
297
  - All users in room "101" will receive the two event callbacks onRemoteUserEnterRoom(B) and onUserVideoAvailable(B,true) for host B, meaning all users in room "101" can subscribe to host B's audio and video.
942
298
 
943
299
  - Users in room "102" will receive the onRemoteUserEnterRoom(A) and onUserVideoAvailable(A,true) event callbacks for Anchor A. This means users in room "102" can subscribe to Anchor A's audio and video.
944
300
 
945
-
946
-
947
-
948
- ![](https://qcloudimg.tencent-cloud.cn/raw/c5e6c72fc163ad5c0b6b7b00e1da55b5.png)
949
-
950
301
  To consider compatibility issues with subsequent extension fields, the parameters for cross-room communication temporarily use JSON format:
951
302
 
952
-
953
-
954
303
  **Case 1: Numeric Room Number**
955
304
 
956
305
  If Host A in room '101' wants to connect with Host B in room '102', Host A needs to pass in the following when calling the interface: {"roomId": 102, "userId": "userB"}
@@ -963,8 +312,6 @@ Below is the sample code:
963
312
  trtc.ConnectOtherRoom(jsonObj.toString());
964
313
  ```
965
314
 
966
-
967
-
968
315
  **Case 2: String Room Number**
969
316
 
970
317
  If you are using a string room number, be sure to replace "roomId" in the JSON with "strRoomId": {"strRoomId": "102", "userId": "userB"}
@@ -976,97 +323,54 @@ Below is the sample code:
976
323
  jsonObj.put("userId", "userB");
977
324
  trtc.ConnectOtherRoom(jsonObj.toString());
978
325
  ```
979
- <table>
980
- <tr>
981
- <td rowspan="1" colSpan="1" >Parameters</td>
982
-
983
- <td rowspan="1" colSpan="1" >Description</td>
984
- </tr>
985
-
986
- <tr>
987
- <td rowspan="1" colSpan="1" >param</td>
988
-
989
- <td rowspan="1" colSpan="1" >You need to pass in a JSON-formatted string argument, where roomId represents the room number in numeric format, strRoomId represents the room number in string format, and userId represents the target broadcaster's user ID.</td>
990
- </tr>
991
- </table>
992
-
326
+ | Parameters | Description |
327
+ | --- | --- |
328
+ | param | You need to pass in a JSON-formatted string argument, where roomId represents the room number in numeric format, strRoomId represents the room number in string format, and userId represents the target broadcaster's user ID. |
993
329
 
994
330
  ## DisconnectOtherRoom
995
331
 
996
-
997
-
998
332
  #### Exit Cross-room Communication
999
333
 
1000
- The exit result will be notified through the onDisconnectOtherRoom callback in [TRTCCloudListener](https://write.woa.com/document/87029920275542016).
334
+ The exit result will be notified through the onDisconnectOtherRoom callback in TRTCCloudListener.
1001
335
 
1002
336
  ## setDefaultStreamRecvMode
1003
337
 
1004
-
1005
-
1006
338
  #### Set Subscription Mode (Needs to be set before entering the room to take effect)
1007
339
 
1008
340
  You can switch between "auto-subscribe" and "manual subscribe" modes via this interface:
1009
- - Automatic Subscription: Default mode where users receive audio and video streams from the room immediately after entering. Audio plays automatically and video starts decoding automatically (you still need to bind the rendering control through the [startRemoteView](https://write.woa.com/document/87029900866228224) interface).
1010
-
1011
- - Manual subscription: After the user enters the room, they need to manually call the [startRemoteView](https://write.woa.com/document/87029900866228224) interface to start the subscription and decoding of the video stream. They need to manually call the [muteRemoteAudio](https://write.woa.com/document/87029900866228224)(false) interface to start the playback of the sound.
1012
-
1013
-
341
+ - Automatic Subscription: Default mode where users receive audio and video streams from the room immediately after entering. Audio plays automatically and video starts decoding automatically (you still need to bind the rendering control through the startRemoteView interface).
1014
342
 
343
+ - Manual subscription: After the user enters the room, they need to manually call the startRemoteView interface to start the subscription and decoding of the video stream. They need to manually call the muteRemoteAudio(false) interface to start the playback of the sound.
1015
344
 
1016
345
  In most scenarios, users entering a room will subscribe to all the audio and video streams from the broadcasters within that room. Therefore, TRTC defaults to an automatic subscription mode to achieve the best "instant start experience".
1017
346
 
1018
347
  If your application scenario involves many audio and video streams being published in each room and each user only wants to selectively subscribe to 1-2 of them, it is recommended to use the "manual subscription" mode to save on bandwidth costs.
1019
- <table>
1020
- <tr>
1021
- <td rowspan="1" colSpan="1" >Parameters</td>
1022
-
1023
- <td rowspan="1" colSpan="1" >Description</td>
1024
- </tr>
1025
-
1026
- <tr>
1027
- <td rowspan="1" colSpan="1" >autoRecvAudio</td>
1028
-
1029
- <td rowspan="1" colSpan="1" >true: Automatically subscribe to audio; false: You need to manually call muteRemoteAudio(false) to subscribe to audio. Default value: true.</td>
1030
- </tr>
1031
-
1032
- <tr>
1033
- <td rowspan="1" colSpan="1" >autoRecvVideo</td>
1034
-
1035
- <td rowspan="1" colSpan="1" >true: Automatically subscribe to video; false: You need to manually call startRemoteView to subscribe to video. Default value: true.</td>
1036
- </tr>
1037
- </table>
1038
-
348
+ | Parameters | Description |
349
+ | --- | --- |
350
+ | autoRecvAudio | true: Automatically subscribe to audio; false: You need to manually call muteRemoteAudio(false) to subscribe to audio. Default value: true. |
351
+ | autoRecvVideo | true: Automatically subscribe to video; false: You need to manually call startRemoteView to subscribe to video. Default value: true. |
1039
352
 
1040
353
  > **Note**
1041
- >
354
+ >
1042
355
 
1043
356
  > 1. This setting needs to be called before entering the room to take effect.
1044
- >
1045
-
1046
- > 2. In automatic subscription mode, if the user does not call [startRemoteView](https://write.woa.com/document/87029900866228224) to subscribe to the video stream after entering the room, the SDK will automatically stop subscribing to the video stream to save traffic.
1047
- >
357
+ >
1048
358
 
359
+ > 2. In automatic subscription mode, if the user does not call startRemoteView to subscribe to the video stream after entering the room, the SDK will automatically stop subscribing to the video stream to save traffic.
360
+ >
1049
361
 
1050
362
  ## createSubCloud
1051
363
 
1052
-
1053
-
1054
364
  #### Create Sub-room Instances (For Multi-room Concurrent Viewing)
1055
365
 
1056
366
  TRTCCloud was initially designed as a Singleton Pattern, limiting the ability to watch multiple rooms concurrently.
1057
367
 
1058
368
  By calling this interface, you can create multiple TRTCCloud instances to watch audio and video streams from multiple rooms simultaneously.
1059
369
 
1060
-
1061
-
1062
370
  However, please note that the ability to publish audio and video streams across multiple TRTCCloud instances is subject to certain restrictions.
1063
371
 
1064
-
1065
-
1066
372
  This feature is primarily used in a business scenario called "super small class" in online education settings, aimed at addressing the limitation that "each TRTC room can only have up to 50 people broadcasting their audio and video streams simultaneously".
1067
373
 
1068
-
1069
-
1070
374
  Below is the sample code:
1071
375
  ``` java
1072
376
  //In the small room that needs interaction, enter the room as an anchor and push audio and video streams
@@ -1094,14 +398,13 @@ Below is the sample code:
1094
398
  ```
1095
399
 
1096
400
  > **Note**
1097
- >
401
+ >
1098
402
  > - The same user can enter multiple rooms with different roomIds using the same userId.
1099
403
  > - Two different terminal devices cannot use the same userId to enter the same roomId simultaneously.
1100
- > - You can set different instances to receive their respective event notifications via [TRTCCloudListener](https://write.woa.com/document/87029920275542016).
404
+ > - You can set different instances to receive their respective event notifications via TRTCCloudListener.
1101
405
  > - The same user can stream on multiple TRTCCloud instances and call interfaces related to local audio and video in sub-instances. However, please note:
1102
406
  > - The audio for multiple instances must be either microphone capture or custom data collection, and invoking interfaces related to audio devices will be based on the last call
1103
- > - Calls related to the camera will take the last one as definitive: [startLocalPreview](https://write.woa.com/document/87029900866228224).
1104
-
407
+ > - Calls related to the camera will take the last one as definitive: startLocalPreview.
1105
408
 
1106
409
  #### Return value description:
1107
410
 
@@ -1109,28 +412,13 @@ Sub TRTCCloud instances
1109
412
 
1110
413
  ## destroySubCloud
1111
414
 
1112
-
1113
-
1114
415
  #### Terminate Sub-room Instances
1115
- <table>
1116
- <tr>
1117
- <td rowspan="1" colSpan="1" >Parameters</td>
1118
-
1119
- <td rowspan="1" colSpan="1" >Description</td>
1120
- </tr>
1121
-
1122
- <tr>
1123
- <td rowspan="1" colSpan="1" >subCloud</td>
1124
-
1125
- <td rowspan="1" colSpan="1" >Sub-room instances</td>
1126
- </tr>
1127
- </table>
1128
-
416
+ | Parameters | Description |
417
+ | --- | --- |
418
+ | subCloud | Sub-room instances |
1129
419
 
1130
420
  ## updateOtherRoomForwardMode
1131
421
 
1132
-
1133
-
1134
422
  #### Modify the uplink capability of cross-room broadcasters in this room
1135
423
 
1136
424
  Usually, after calling the connectOtherRoom interface to conduct cross-room communication with another room's broadcaster, all viewers in this room will receive the audio and video stream published by that broadcaster.
@@ -1139,32 +427,20 @@ You can call this interface to restrict the uplink capability of a cross-room br
1139
427
 
1140
428
  After disabling certain uplink capabilities of the cross-room broadcaster, all users in this room will not be able to receive the corresponding audio and video streams, nor will they be able to subscribe to them.
1141
429
 
1142
-
1143
-
1144
430
  It should be noted that this interface can only be called by the broadcaster conducting cross-room communication, and the restrictions set through this interface will reset if the cross-room communication is interrupted or the corresponding broadcaster exits the room.
1145
431
 
1146
-
1147
-
1148
- The result of this API call will be notified to you via the [TRTCCloudListener](https://write.woa.com/document/87029920275542016) in the [onUpdateOtherRoomForwardMode](https://write.woa.com/document/87029920275542016) callback.
1149
-
1150
-
432
+ The result of this API call will be notified to you via the TRTCCloudListener in the onUpdateOtherRoomForwardMode callback.
1151
433
 
1152
434
  For example:
1153
435
 
1154
436
  In room "101", there is Host A and Audience B, while in room "102", there is Host C, who is normally publishing audio and video streams. Host A establishes a cross-room call with Host C using connectOtherRoom().
1155
437
  - At this time, both Anchor A and Viewer B will receive the onRemoteUserEnterRoom(C), onUserVideoAvailable(C,true), and onUserAudioAvailable(C,true) event callbacks for Anchor C and can subscribe to Anchor C's audio and video.
1156
438
 
1157
-
1158
-
1159
-
1160
439
  Later, Host A calls this interface to disable Host C's ability to publish audio in the current room.
1161
440
  - After that, Anchor C's audio stream cannot be published to room "101." Anchor A and Viewer B will receive the onUserAudioAvailable(C,false) event callback and can no longer subscribe to Anchor C's audio through muteRemoteAudio(C,false).
1162
441
 
1163
442
  - Host C's video stream will not be affected. Other audience members in room "102" are also unaffected and can normally subscribe to Host C's audio.
1164
443
 
1165
-
1166
-
1167
-
1168
444
  To consider compatibility issues with subsequent extension fields, the parameters for this interface temporarily use JSON format. The example is as follows:
1169
445
 
1170
446
  **Case 1: Numeric Room Number**
@@ -1178,8 +454,6 @@ To consider compatibility issues with subsequent extension fields, the parameter
1178
454
  }
1179
455
  ```
1180
456
 
1181
-
1182
-
1183
457
  **Case 2: String Room Number**
1184
458
  ``` java
1185
459
  {
@@ -1190,211 +464,108 @@ To consider compatibility issues with subsequent extension fields, the parameter
1190
464
  "muteSubStream":false
1191
465
  }
1192
466
  ```
1193
- <table>
1194
- <tr>
1195
- <td rowspan="1" colSpan="1" >Parameters</td>
1196
-
1197
- <td rowspan="1" colSpan="1" >Description</td>
1198
- </tr>
1199
-
1200
- <tr>
1201
- <td rowspan="1" colSpan="1" >param</td>
1202
-
1203
- <td rowspan="1" colSpan="1" >You need to pass in a JSON-formatted string argument where roomId represents the room number in numeric format, strRoomId represents the room number in string format, userId represents the target broadcaster's user ID. The options muteAudio, muteVideo, and muteSubStream denote whether to disable or allow the cross-room broadcaster to publish audio, main stream video, and sub-stream video respectively.</td>
1204
- </tr>
1205
- </table>
1206
-
467
+ | Parameters | Description |
468
+ | --- | --- |
469
+ | param | You need to pass in a JSON-formatted string argument where roomId represents the room number in numeric format, strRoomId represents the room number in string format, userId represents the target broadcaster's user ID. The options muteAudio, muteVideo, and muteSubStream denote whether to disable or allow the cross-room broadcaster to publish audio, main stream video, and sub-stream video respectively. |
1207
470
 
1208
471
  ## startPublishMediaStream
1209
472
 
1210
-
1211
-
1212
473
  #### Start publishing media stream
1213
474
 
1214
- This interface sends an instruction to the TRTC server to relay/transcode the current user's audio and video streams to the Live CDN or push them back into the TRTC room. You can specify the publishing mode through [TRTCPublishTarget](https://write.woa.com/document/87029993616093184) configuration and [TRTCPublishMode](https://write.woa.com/document/87029993616093184)
1215
- <table>
1216
- <tr>
1217
- <td rowspan="1" colSpan="1" >Parameters</td>
1218
-
1219
- <td rowspan="1" colSpan="1" >Description</td>
1220
- </tr>
1221
-
1222
- <tr>
1223
- <td rowspan="1" colSpan="1" >config</td>
1224
-
1225
- <td rowspan="1" colSpan="1" >Media stream transcoding configuration parameters. Refer to [TRTCStreamMixingConfig](https://write.woa.com/document/87029993616093184) for detailed configuration. This is required when transcoding and pushing back to the TRTC room. You need to specify your desired transcoding configuration parameters. It is invalid in relay mode.</td>
1226
- </tr>
1227
-
1228
- <tr>
1229
- <td rowspan="1" colSpan="1" >params</td>
1230
-
1231
- <td rowspan="1" colSpan="1" >Media stream encoding output parameters. Refer to [TRTCStreamEncoderParam](https://write.woa.com/document/87029993616093184) for detailed configuration. This is required when transcoding and pushing back to the TRTC room. You need to specify your desired transcoding output parameters. For better relay stability and CDN compatibility, it is also recommended to configure this during relay.</td>
1232
- </tr>
1233
-
1234
- <tr>
1235
- <td rowspan="1" colSpan="1" >target</td>
1236
-
1237
- <td rowspan="1" colSpan="1" >The target address for media stream publishing. Refer to [TRTCPublishTarget](https://write.woa.com/document/87029993616093184) for detailed configuration. Supports relay/transcoding to Tencent or third-party CDNs, and also supports transcoding pushback to the TRTC room.</td>
1238
- </tr>
1239
- </table>
1240
-
475
+ This interface sends an instruction to the TRTC server to relay/transcode the current user's audio and video streams to the Live CDN or push them back into the TRTC room. You can specify the publishing mode through TRTCPublishTarget configuration and TRTCPublishMode
476
+ | Parameters | Description |
477
+ | --- | --- |
478
+ | config | Media stream transcoding configuration parameters. Refer to TRTCStreamMixingConfig for detailed configuration. This is required when transcoding and pushing back to the TRTC room. You need to specify your desired transcoding configuration parameters. It is invalid in relay mode. |
479
+ | params | Media stream encoding output parameters. Refer to TRTCStreamEncoderParam for detailed configuration. This is required when transcoding and pushing back to the TRTC room. You need to specify your desired transcoding output parameters. For better relay stability and CDN compatibility, it is also recommended to configure this during relay. |
480
+ | target | The target address for media stream publishing. Refer to TRTCPublishTarget for detailed configuration. Supports relay/transcoding to Tencent or third-party CDNs, and also supports transcoding pushback to the TRTC room. |
1241
481
 
1242
482
  > **Note**
1243
- >
483
+ >
1244
484
 
1245
- > 1. The SDK will provide the task identifier (taskId) for the backend startup through the callback [onStartPublishMediaStream](https://write.woa.com/document/87029920275542016).
1246
- >
485
+ > 1. The SDK will provide the task identifier (taskId) for the backend startup through the callback onStartPublishMediaStream.
486
+ >
1247
487
 
1248
- > 2. The same task (both TRTCPublishMode and TRTCPublishCdnUrl are identical) can only be started once. If you need to update or stop this task later, you must record and use the returned taskId to operate through [updatePublishMediaStream](https://write.woa.com/document/87029900866228224) or [stopPublishMediaStream](https://write.woa.com/document/87029900866228224).
1249
- >
488
+ > 2. The same task (both TRTCPublishMode and TRTCPublishCdnUrl are identical) can only be started once. If you need to update or stop this task later, you must record and use the returned taskId to operate through updatePublishMediaStream or stopPublishMediaStream.
489
+ >
1250
490
 
1251
491
  > 3. The target supports configuring multiple CDN URLs simultaneously (up to 10). If the same relay/transcoding task needs to be published to multiple CDNs, you only need to configure multiple CDN URLs in the target. Even if there are multiple relay addresses for the same transcoding task, only one transcoding fee will be charged.
1252
- >
492
+ >
1253
493
 
1254
494
  > 4. When using, do not push multiple tasks to the same URL addresses simultaneously to avoid abnormal streaming status. A recommended scheme is to use "sdkappid_roomid_userid_main" in the URL as a distinguishing identifier. This naming convention is easy to recognize and will not cause conflicts in your multiple applications.
1255
- >
1256
-
495
+ >
1257
496
 
1258
497
  ## updatePublishMediaStream
1259
498
 
1260
-
1261
-
1262
499
  #### Update the published media stream.
1263
500
 
1264
- This interface will send directives to the TRTC server to update the media stream started by [startPublishMediaStream](https://write.woa.com/document/87029900866228224)
1265
- <table>
1266
- <tr>
1267
- <td rowspan="1" colSpan="1" >Parameters</td>
1268
-
1269
- <td rowspan="1" colSpan="1" >Description</td>
1270
- </tr>
1271
-
1272
- <tr>
1273
- <td rowspan="1" colSpan="1" >config</td>
1274
-
1275
- <td rowspan="1" colSpan="1" >Media stream transcoding configuration parameters. Refer to [TRTCStreamMixingConfig](https://write.woa.com/document/87029993616093184) for detailed configuration. This is required when transcoding and pushing back to the TRTC room. You need to specify your desired transcoding configuration parameters. It is invalid in relay mode.</td>
1276
- </tr>
1277
-
1278
- <tr>
1279
- <td rowspan="1" colSpan="1" >params</td>
1280
-
1281
- <td rowspan="1" colSpan="1" >Media stream encoding output parameters. Refer to [TRTCStreamEncoderParam](https://write.woa.com/document/87029993616093184) for detailed configuration. This is required when transcoding and pushing back to the TRTC room. You need to specify your desired transcoding output parameters. For better relay stability and CDN compatibility, it is also recommended to configure this during relay.</td>
1282
- </tr>
1283
-
1284
- <tr>
1285
- <td rowspan="1" colSpan="1" >target</td>
1286
-
1287
- <td rowspan="1" colSpan="1" >The target address for media stream publishing. Refer to [TRTCPublishTarget](https://write.woa.com/document/87029993616093184) for detailed configuration. Supports relay/transcoding to Tencent or third-party CDNs, and also supports transcoding pushback to the TRTC room.</td>
1288
- </tr>
1289
-
1290
- <tr>
1291
- <td rowspan="1" colSpan="1" >taskId</td>
1292
-
1293
- <td rowspan="1" colSpan="1" >It will provide you with the task identifier (i.e., taskId) for the background start task through the [onStartPublishMediaStream](https://write.woa.com/document/87029920275542016) callback</td>
1294
- </tr>
1295
- </table>
1296
-
501
+ This interface will send directives to the TRTC server to update the media stream started by startPublishMediaStream
502
+ | Parameters | Description |
503
+ | --- | --- |
504
+ | config | Media stream transcoding configuration parameters. Refer to TRTCStreamMixingConfig for detailed configuration. This is required when transcoding and pushing back to the TRTC room. You need to specify your desired transcoding configuration parameters. It is invalid in relay mode. |
505
+ | params | Media stream encoding output parameters. Refer to TRTCStreamEncoderParam for detailed configuration. This is required when transcoding and pushing back to the TRTC room. You need to specify your desired transcoding output parameters. For better relay stability and CDN compatibility, it is also recommended to configure this during relay. |
506
+ | target | The target address for media stream publishing. Refer to TRTCPublishTarget for detailed configuration. Supports relay/transcoding to Tencent or third-party CDNs, and also supports transcoding pushback to the TRTC room. |
507
+ | taskId | It will provide you with the task identifier (i.e., taskId) for the background start task through the onStartPublishMediaStream callback |
1297
508
 
1298
509
  > **Note**
1299
- >
510
+ >
1300
511
 
1301
512
  > 1. You can use this interface to update the published CDN URL (supports add and delete, up to 10 at the same time), but ensure you do not push multiple tasks to the same URL addresses simultaneously to avoid abnormal streaming status.
1302
- >
513
+ >
1303
514
 
1304
- > 2. You can update or adjust relay/transcoding tasks using taskId. For example, in PK business, you can initiate relay through [startPublishMediaStream](https://write.woa.com/document/87029900866228224) first, then use taskId and this interface to update the relay to a transcoding task when the anchor initiates PK. At this time, CDN playback will be continuous and without stream disconnection (you need to keep the media stream encoding output parameters consistent).
1305
- >
515
+ > 2. You can update or adjust relay/transcoding tasks using taskId. For example, in PK business, you can initiate relay through startPublishMediaStream first, then use taskId and this interface to update the relay to a transcoding task when the anchor initiates PK. At this time, CDN playback will be continuous and without stream disconnection (you need to keep the media stream encoding output parameters consistent).
516
+ >
1306
517
 
1307
518
  > 3. The same task does not support switching between Audio Only, Audio and Video, and Pure Video.
1308
- >
1309
-
519
+ >
1310
520
 
1311
521
  ## stopPublishMediaStream
1312
522
 
1313
-
1314
-
1315
523
  #### Stop publishing media stream.
1316
524
 
1317
- This interface will send directives to the TRTC server to stop the media stream started by [startPublishMediaStream](https://write.woa.com/document/87029900866228224)
1318
- <table>
1319
- <tr>
1320
- <td rowspan="1" colSpan="1" >Parameters</td>
1321
-
1322
- <td rowspan="1" colSpan="1" >Description</td>
1323
- </tr>
1324
-
1325
- <tr>
1326
- <td rowspan="1" colSpan="1" >taskId</td>
1327
-
1328
- <td rowspan="1" colSpan="1" >It will provide you with the task identifier (i.e., taskId) for the background start task through the [onStartPublishMediaStream](https://write.woa.com/document/87029920275542016) callback</td>
1329
- </tr>
1330
- </table>
1331
-
525
+ This interface will send directives to the TRTC server to stop the media stream started by startPublishMediaStream
526
+ | Parameters | Description |
527
+ | --- | --- |
528
+ | taskId | It will provide you with the task identifier (i.e., taskId) for the background start task through the onStartPublishMediaStream callback |
1332
529
 
1333
530
  > **Note**
1334
- >
531
+ >
1335
532
 
1336
- > 1. If your business backend has not saved the taskId, after your host re-enters the room following an abnormal exit, you can call [startPublishMediaStream](https://write.woa.com/document/87029900866228224) again to start the task. TRTC backend will return a task start failure and provide you with the taskId from the last attempt
1337
- >
1338
-
1339
- > 2. If the taskId is an empty string, all media streams started by [startPublishMediaStream](https://write.woa.com/document/87029900866228224) for that user will stop. If you have only started one media stream or want to stop all media streams you started, this method is recommended.
1340
- >
533
+ > 1. If your business backend has not saved the taskId, after your host re-enters the room following an abnormal exit, you can call startPublishMediaStream again to start the task. TRTC backend will return a task start failure and provide you with the taskId from the last attempt
534
+ >
1341
535
 
536
+ > 2. If the taskId is an empty string, all media streams started by startPublishMediaStream for that user will stop. If you have only started one media stream or want to stop all media streams you started, this method is recommended.
537
+ >
1342
538
 
1343
539
  ## startLocalPreview
1344
540
 
1345
-
1346
-
1347
541
  #### Enable the preview screen of the local camera (Mobile Terminal)
1348
542
 
1349
543
  Call this function before enterRoom. The SDK will only enable the camera and wait until you call enterRoom to start streaming.
1350
544
 
1351
- Call this function after enterRoom. The SDK will turn on the camera and automatically start video push streaming. You will receive the onCameraDidReady callback notification in [TRTCCloudListener](https://write.woa.com/document/87029920275542016) when the first frame of the camera is rendered.
1352
- <table>
1353
- <tr>
1354
- <td rowspan="1" colSpan="1" >Parameters</td>
1355
-
1356
- <td rowspan="1" colSpan="1" >Description</td>
1357
- </tr>
1358
-
1359
- <tr>
1360
- <td rowspan="1" colSpan="1" >frontCamera</td>
1361
-
1362
- <td rowspan="1" colSpan="1" >true: Front-facing camera; false: Rear-facing camera.</td>
1363
- </tr>
1364
-
1365
- <tr>
1366
- <td rowspan="1" colSpan="1" >view</td>
1367
-
1368
- <td rowspan="1" colSpan="1" >Control carrying the video screen.</td>
1369
- </tr>
1370
- </table>
1371
-
545
+ Call this function after enterRoom. The SDK will turn on the camera and automatically start video push streaming. You will receive the onCameraDidReady callback notification in TRTCCloudListener when the first frame of the camera is rendered.
546
+ | Parameters | Description |
547
+ | --- | --- |
548
+ | frontCamera | true: Front-facing camera; false: Rear-facing camera. |
549
+ | view | Control carrying the video screen. |
1372
550
 
1373
551
  > **Note**
1374
- >
552
+ >
1375
553
 
1376
554
  > If you wish to preview the camera screen and use BeautyManager to adjust the beauty parameters before streaming, you can:
1377
- >
555
+ >
1378
556
  > - Option 1: Call startLocalPreview before enterRoom.
1379
557
  > - Option 2: Call startLocalPreview + muteLocalVideo(true) after enterRoom.
1380
558
 
1381
-
1382
559
  ## updateLocalView
1383
560
 
1384
-
1385
-
1386
561
  #### Update the preview screen of the local camera
1387
562
 
1388
563
  ## stopLocalPreview
1389
564
 
1390
-
1391
-
1392
565
  #### Stop camera preview
1393
566
 
1394
567
  ## muteLocalVideo
1395
568
 
1396
-
1397
-
1398
569
  #### Suspend/Resume publishing local video stream
1399
570
 
1400
571
  This interface can suspend (or recover) the publishing of local video screens. After suspension, other users in the same room will not be able to see your screen.
@@ -1405,414 +576,187 @@ Because start/stopLocalPreview requires turning on and off the camera, and turni
1405
576
 
1406
577
  In comparison, muteLocalVideo only needs to suspend or pass the data stream at the software layer. Therefore, it is more efficient and more suitable for scenarios requiring frequent openings and closings.
1407
578
 
1408
-
1409
-
1410
579
  When pausing/resuming the release of TRTC_VIDEO_STREAM_TYPE_BIG, other users in the same room will receive the onUserVideoAvailable callback notification.
1411
580
 
1412
581
  When pausing/resuming the release of TRTC_VIDEO_STREAM_TYPE_SUB, other users in the same room will receive the onUserSubStreamAvailable callback notification.
1413
- <table>
1414
- <tr>
1415
- <td rowspan="1" colSpan="1" >Parameters</td>
1416
-
1417
- <td rowspan="1" colSpan="1" >Description</td>
1418
- </tr>
1419
-
1420
- <tr>
1421
- <td rowspan="1" colSpan="1" >mute</td>
1422
-
1423
- <td rowspan="1" colSpan="1" >true: pause; false: resume.</td>
1424
- </tr>
1425
-
1426
- <tr>
1427
- <td rowspan="1" colSpan="1" >streamType</td>
1428
-
1429
- <td rowspan="1" colSpan="1" >The type of video stream to pause/resume (only supports [TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184) and [TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184)).</td>
1430
- </tr>
1431
- </table>
1432
-
582
+ | Parameters | Description |
583
+ | --- | --- |
584
+ | mute | true: pause; false: resume. |
585
+ | streamType | The type of video stream to pause/resume (only supports TRTC_VIDEO_STREAM_TYPE_BIG and TRTC_VIDEO_STREAM_TYPE_SUB). |
1433
586
 
1434
587
  ## setVideoMuteImage
1435
588
 
1436
-
1437
-
1438
589
  #### Set the alternative image during the suspension of the local screen
1439
590
 
1440
591
  When you call muteLocalVideo(true) to pause the local video, you can set a placeholder image through this interface. After setting, other users in the room will see this placeholder image instead of a black screen.
1441
- <table>
1442
- <tr>
1443
- <td rowspan="1" colSpan="1" >Parameters</td>
1444
-
1445
- <td rowspan="1" colSpan="1" >Description</td>
1446
- </tr>
1447
-
1448
- <tr>
1449
- <td rowspan="1" colSpan="1" >fps</td>
1450
-
1451
- <td rowspan="1" colSpan="1" >Set the frame rate for the alternative image, with a minimum value of 5 and a maximum value of 10. The default is 5.</td>
1452
- </tr>
1453
-
1454
- <tr>
1455
- <td rowspan="1" colSpan="1" >image</td>
1456
-
1457
- <td rowspan="1" colSpan="1" >Set the alternative image. A null value means no video stream data will be sent after muteLocalVideo. The default is null.</td>
1458
- </tr>
1459
- </table>
1460
-
592
+ | Parameters | Description |
593
+ | --- | --- |
594
+ | fps | Set the frame rate for the alternative image, with a minimum value of 5 and a maximum value of 10. The default is 5. |
595
+ | image | Set the alternative image. A null value means no video stream data will be sent after muteLocalVideo. The default is null. |
1461
596
 
1462
597
  ## startRemoteView
1463
598
 
1464
-
1465
-
1466
599
  #### Subscribe to the video stream of a remote user and bind the video rendering control
1467
600
 
1468
- By calling this API, the SDK can pull the video stream of the specified user ID and render it on the rendering control specified by the parameter view. You can set the display mode of the screen through [setRemoteRenderParams](https://write.woa.com/document/87029900866228224).
601
+ By calling this API, the SDK can pull the video stream of the specified user ID and render it on the rendering control specified by the parameter view. You can set the display mode of the screen through setRemoteRenderParams.
1469
602
  - If you already know the user ID of a user who has a video stream in the room, you can directly call startRemoteView to subscribe to that user's video feed.
1470
603
 
1471
- - If you do not know which users in the room are publishing video, you can wait for a notification from [onUserVideoAvailable](https://write.woa.com/document/87029920275542016) after entering the room.
1472
-
1473
-
1474
-
1475
-
1476
- Calling this API only starts pulling the video stream, at this point the screen still needs to load and buffer. When buffering is complete, you will receive a notification from [onFirstVideoFrame](https://write.woa.com/document/87029920275542016).
1477
- <table>
1478
- <tr>
1479
- <td rowspan="1" colSpan="1" >Parameters</td>
1480
-
1481
- <td rowspan="1" colSpan="1" >Description</td>
1482
- </tr>
1483
-
1484
- <tr>
1485
- <td rowspan="1" colSpan="1" >streamType</td>
1486
-
1487
- <td rowspan="1" colSpan="1" >Specify the type of video stream of the user you want to watch.<br>- HD main video stream: [TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184).<br>- Low-res sub video stream: [TRTC_VIDEO_STREAM_TYPE_SMALL](https://write.woa.com/document/87029993616093184) (effective only if the remote user has enabled dual encoding through [enableEncSmallVideoStream](https://write.woa.com/document/87029900866228224)).<br>- Substream video (typically used for screen sharing): [TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184).</td>
1488
- </tr>
1489
-
1490
- <tr>
1491
- <td rowspan="1" colSpan="1" >userId</td>
1492
-
1493
- <td rowspan="1" colSpan="1" >Specify the remote user's ID.</td>
1494
- </tr>
1495
-
1496
- <tr>
1497
- <td rowspan="1" colSpan="1" >view</td>
1498
-
1499
- <td rowspan="1" colSpan="1" >Rendering control used to display the video screen.</td>
1500
- </tr>
1501
- </table>
604
+ - If you do not know which users in the room are publishing video, you can wait for a notification from onUserVideoAvailable after entering the room.
1502
605
 
606
+ Calling this API only starts pulling the video stream, at this point the screen still needs to load and buffer. When buffering is complete, you will receive a notification from onFirstVideoFrame.
607
+ | Parameters | Description |
608
+ | --- | --- |
609
+ | streamType | Specify the type of video stream of the user you want to watch.<br>- HD main video stream: TRTC_VIDEO_STREAM_TYPE_BIG.<br>- Low-res sub video stream: TRTC_VIDEO_STREAM_TYPE_SMALL (effective only if the remote user has enabled dual encoding through enableEncSmallVideoStream).<br>- Substream video (typically used for screen sharing): TRTC_VIDEO_STREAM_TYPE_SUB. |
610
+ | userId | Specify the remote user's ID. |
611
+ | view | Rendering control used to display the video screen. |
1503
612
 
1504
613
  > **Note**
1505
- >
614
+ >
1506
615
 
1507
616
  > Note a few rules:
1508
- >
617
+ >
1509
618
 
1510
619
  > 1. The SDK supports watching the main stream and substream of a certain user ID simultaneously, or watching the substream and small stream of a certain user ID simultaneously, but does not support watching the main stream and small stream simultaneously.
1511
- >
620
+ >
1512
621
 
1513
- > 2. You can only watch the small stream of the specified user ID when dual-stream encoding is enabled through [enableEncSmallVideoStream](https://write.woa.com/document/87029900866228224).
1514
- >
622
+ > 2. You can only watch the small stream of the specified user ID when dual-stream encoding is enabled through enableEncSmallVideoStream.
623
+ >
1515
624
 
1516
625
  > 3. When the small stream of the specified user ID does not exist, the SDK will default to the user's main stream.
1517
- >
1518
-
626
+ >
1519
627
 
1520
628
  ## updateRemoteView
1521
629
 
1522
-
1523
-
1524
630
  #### Update the video rendering control of a remote user
1525
631
 
1526
632
  This interface can be used to update the rendering control of a remote video image and is commonly used in scenarios that involve switching display areas.
1527
- <table>
1528
- <tr>
1529
- <td rowspan="1" colSpan="1" >Parameters</td>
1530
-
1531
- <td rowspan="1" colSpan="1" >Description</td>
1532
- </tr>
1533
-
1534
- <tr>
1535
- <td rowspan="1" colSpan="1" >streamType</td>
1536
-
1537
- <td rowspan="1" colSpan="1" >The type of stream to set the preview window for (only supports [TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184) and [TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184)).</td>
1538
- </tr>
1539
-
1540
- <tr>
1541
- <td rowspan="1" colSpan="1" >userId</td>
1542
-
1543
- <td rowspan="1" colSpan="1" >Specify the remote user's ID.</td>
1544
- </tr>
1545
-
1546
- <tr>
1547
- <td rowspan="1" colSpan="1" >view</td>
1548
-
1549
- <td rowspan="1" colSpan="1" >Control carrying the video screen.</td>
1550
- </tr>
1551
- </table>
1552
-
633
+ | Parameters | Description |
634
+ | --- | --- |
635
+ | streamType | The type of stream to set the preview window for (only supports TRTC_VIDEO_STREAM_TYPE_BIG and TRTC_VIDEO_STREAM_TYPE_SUB). |
636
+ | userId | Specify the remote user's ID. |
637
+ | view | Control carrying the video screen. |
1553
638
 
1554
639
  ## stopRemoteView
1555
640
 
1556
-
1557
-
1558
641
  #### Unsubscribe from the remote user's video stream and release the rendering control
1559
642
 
1560
643
  Calling this interface will make the SDK stop receiving the video stream of the user and release the decoding and rendering resources of that video stream.
1561
- <table>
1562
- <tr>
1563
- <td rowspan="1" colSpan="1" >Parameters</td>
1564
-
1565
- <td rowspan="1" colSpan="1" >Description</td>
1566
- </tr>
1567
-
1568
- <tr>
1569
- <td rowspan="1" colSpan="1" >streamType</td>
1570
-
1571
- <td rowspan="1" colSpan="1" >Specify the type of video stream of the user you want to watch.<br>- HD main video stream: [TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184).<br>- Low-res sub video stream: [TRTC_VIDEO_STREAM_TYPE_SMALL](https://write.woa.com/document/87029993616093184).<br>- Substream video (typically used for screen sharing): [TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184).</td>
1572
- </tr>
1573
-
1574
- <tr>
1575
- <td rowspan="1" colSpan="1" >userId</td>
1576
-
1577
- <td rowspan="1" colSpan="1" >Specify the remote user's ID.</td>
1578
- </tr>
1579
- </table>
1580
-
644
+ | Parameters | Description |
645
+ | --- | --- |
646
+ | streamType | Specify the type of video stream of the user you want to watch.<br>- HD main video stream: TRTC_VIDEO_STREAM_TYPE_BIG.<br>- Low-res sub video stream: TRTC_VIDEO_STREAM_TYPE_SMALL.<br>- Substream video (typically used for screen sharing): TRTC_VIDEO_STREAM_TYPE_SUB. |
647
+ | userId | Specify the remote user's ID. |
1581
648
 
1582
649
  ## stopAllRemoteView
1583
650
 
1584
-
1585
-
1586
651
  #### Unsubscribe from all remote users' video streams and release all rendering resources
1587
652
 
1588
653
  Calling this interface will make the SDK stop receiving all remote video streams and release all decoding and rendering resources.
1589
654
 
1590
655
  > **Note**
1591
- >
656
+ >
1592
657
 
1593
658
  > If there is a currently displayed substream (screen sharing), it will also be stopped.
1594
- >
1595
-
659
+ >
1596
660
 
1597
661
  ## muteRemoteVideoStream
1598
662
 
1599
-
1600
-
1601
663
  #### Suspend/Resume subscription of the remote user's video stream
1602
664
 
1603
665
  This interface only pauses/resumes receiving the video stream of a designated user but does not release the display resources. The video image will be frozen on the last frame at the time of the interface call.
1604
- <table>
1605
- <tr>
1606
- <td rowspan="1" colSpan="1" >Parameters</td>
1607
-
1608
- <td rowspan="1" colSpan="1" >Description</td>
1609
- </tr>
1610
-
1611
- <tr>
1612
- <td rowspan="1" colSpan="1" >mute</td>
1613
-
1614
- <td rowspan="1" colSpan="1" >Pause receiving or not.</td>
1615
- </tr>
1616
-
1617
- <tr>
1618
- <td rowspan="1" colSpan="1" >streamType</td>
1619
-
1620
- <td rowspan="1" colSpan="1" >The video stream type to be paused/resumed.<br>- HD main video stream: [TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184).<br>- Low-res sub video stream: [TRTC_VIDEO_STREAM_TYPE_SMALL](https://write.woa.com/document/87029993616093184).<br>- Substream video (typically used for screen sharing): [TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184).</td>
1621
- </tr>
1622
-
1623
- <tr>
1624
- <td rowspan="1" colSpan="1" >userId</td>
1625
-
1626
- <td rowspan="1" colSpan="1" >Specify the remote user's ID.</td>
1627
- </tr>
1628
- </table>
1629
-
666
+ | Parameters | Description |
667
+ | --- | --- |
668
+ | mute | Pause receiving or not. |
669
+ | streamType | The video stream type to be paused/resumed.<br>- HD main video stream: TRTC_VIDEO_STREAM_TYPE_BIG.<br>- Low-res sub video stream: TRTC_VIDEO_STREAM_TYPE_SMALL.<br>- Substream video (typically used for screen sharing): TRTC_VIDEO_STREAM_TYPE_SUB. |
670
+ | userId | Specify the remote user's ID. |
1630
671
 
1631
672
  > **Note**
1632
- >
673
+ >
1633
674
 
1634
- > This interface supports calling before entering the room ([enterRoom](https://write.woa.com/document/87029900866228224)), and the paused state will be reset after leaving the room ([exitRoom](https://write.woa.com/document/87029900866228224)).
1635
- >
1636
-
1637
- > After calling this interface to pause receiving a specified user's video stream, calling only the [startRemoteView](https://write.woa.com/document/87029900866228224) interface will not play the specified user's video. You need to call [muteRemoteVideoStream](https://write.woa.com/document/87029900866228224)(false) or [muteAllRemoteVideoStreams](https://write.woa.com/document/87029900866228224)(false) to recover.
1638
- >
675
+ > This interface supports calling before entering the room (enterRoom), and the paused state will be reset after leaving the room (exitRoom).
676
+ >
1639
677
 
678
+ > After calling this interface to pause receiving a specified user's video stream, calling only the startRemoteView interface will not play the specified user's video. You need to call muteRemoteVideoStream(false) or muteAllRemoteVideoStreams(false) to recover.
679
+ >
1640
680
 
1641
681
  ## muteAllRemoteVideoStreams
1642
682
 
1643
-
1644
-
1645
683
  #### Suspend/Resume subscription of all remote users' video streams
1646
684
 
1647
685
  This interface only pauses/resumes receiving all users' video streams but does not release the display resources. The video image will be frozen on the last frame at the time of the interface call.
1648
- <table>
1649
- <tr>
1650
- <td rowspan="1" colSpan="1" >Parameters</td>
1651
-
1652
- <td rowspan="1" colSpan="1" >Description</td>
1653
- </tr>
1654
-
1655
- <tr>
1656
- <td rowspan="1" colSpan="1" >mute</td>
1657
-
1658
- <td rowspan="1" colSpan="1" >Pause receiving or not.</td>
1659
- </tr>
1660
- </table>
1661
-
686
+ | Parameters | Description |
687
+ | --- | --- |
688
+ | mute | Pause receiving or not. |
1662
689
 
1663
690
  > **Note**
1664
- >
1665
-
1666
- > This interface supports calling before entering the room ([enterRoom](https://write.woa.com/document/87029900866228224)), and the paused state will be reset after leaving the room ([exitRoom](https://write.woa.com/document/87029900866228224)).
1667
- >
1668
-
1669
- > After calling this interface to pause receiving all users' video streams, calling only the [startRemoteView](https://write.woa.com/document/87029900866228224) interface will not play a specified user's video. You need to call [muteRemoteVideoStream](https://write.woa.com/document/87029900866228224)(false) or [muteAllRemoteVideoStreams](https://write.woa.com/document/87029900866228224)(false) to recover.
1670
- >
1671
-
691
+ >
1672
692
 
1673
- ## setVideoEncoderParam
1674
-
1675
-
1676
-
1677
- #### Set encoding parameters for the video encoder
1678
-
1679
- This setting determines the screen quality seen by remote users, and also affects the screen quality of the recorded video file on the cloud.
1680
- <table>
1681
- <tr>
1682
- <td rowspan="1" colSpan="1" >Parameters</td>
693
+ > This interface supports calling before entering the room (enterRoom), and the paused state will be reset after leaving the room (exitRoom).
694
+ >
1683
695
 
1684
- <td rowspan="1" colSpan="1" >Description</td>
1685
- </tr>
696
+ > After calling this interface to pause receiving all users' video streams, calling only the startRemoteView interface will not play a specified user's video. You need to call muteRemoteVideoStream(false) or muteAllRemoteVideoStreams(false) to recover.
697
+ >
1686
698
 
1687
- <tr>
1688
- <td rowspan="1" colSpan="1" >param</td>
699
+ ## setVideoEncoderParam
1689
700
 
1690
- <td rowspan="1" colSpan="1" >Used to set the video encoder parameters. For details, see [TRTCVideoEncParam](https://write.woa.com/document/87029993616093184).</td>
1691
- </tr>
1692
- </table>
701
+ #### Set encoding parameters for the video encoder
1693
702
 
703
+ This setting determines the screen quality seen by remote users, and also affects the screen quality of the recorded video file on the cloud.
704
+ | Parameters | Description |
705
+ | --- | --- |
706
+ | param | Used to set the video encoder parameters. For details, see TRTCVideoEncParam. |
1694
707
 
1695
708
  > **Note**
1696
- >
709
+ >
1697
710
 
1698
711
  > Starting from version v11.5, the encoding output resolution will align with width 8 height 2 bytes, and it will be adjusted downwards; eg: input resolution 540x960, actual encoding output resolution 536x960.
1699
- >
1700
-
712
+ >
1701
713
 
1702
714
  ## setNetworkQosParam
1703
715
 
1704
-
1705
-
1706
716
  #### Set network quality control parameters
1707
717
 
1708
718
  This setting determines the quality control strategy under poor network conditions, such as "Quality Priority" or "Smoothness Priority" strategies.
1709
- <table>
1710
- <tr>
1711
- <td rowspan="1" colSpan="1" >Parameters</td>
1712
-
1713
- <td rowspan="1" colSpan="1" >Description</td>
1714
- </tr>
1715
-
1716
- <tr>
1717
- <td rowspan="1" colSpan="1" >param</td>
1718
-
1719
- <td rowspan="1" colSpan="1" >Used to set the network quality control parameters. For details, see [TRTCNetworkQosParam](https://write.woa.com/document/87029993616093184).</td>
1720
- </tr>
1721
- </table>
1722
-
719
+ | Parameters | Description |
720
+ | --- | --- |
721
+ | param | Used to set the network quality control parameters. For details, see TRTCNetworkQosParam. |
1723
722
 
1724
723
  ## setLocalRenderParams
1725
724
 
1726
-
1727
-
1728
725
  #### Set rendering parameters for the local screen
1729
726
 
1730
727
  Configurable parameters include: rotation angle, fill mode, and left-right mirroring of the picture.
1731
- <table>
1732
- <tr>
1733
- <td rowspan="1" colSpan="1" >Parameters</td>
1734
-
1735
- <td rowspan="1" colSpan="1" >Description</td>
1736
- </tr>
1737
-
1738
- <tr>
1739
- <td rowspan="1" colSpan="1" >params</td>
1740
-
1741
- <td rowspan="1" colSpan="1" >Picture render parameters, see [TRTCRenderParams](https://write.woa.com/document/87029993616093184) for details.</td>
1742
- </tr>
1743
- </table>
1744
-
728
+ | Parameters | Description |
729
+ | --- | --- |
730
+ | params | Picture render parameters, see TRTCRenderParams for details. |
1745
731
 
1746
732
  ## setRemoteRenderParams
1747
733
 
1748
-
1749
-
1750
734
  #### Set rendering mode for the remote screen
1751
735
 
1752
736
  Configurable parameters include: rotation angle, fill mode, and left-right mirroring of the picture.
1753
- <table>
1754
- <tr>
1755
- <td rowspan="1" colSpan="1" >Parameters</td>
1756
-
1757
- <td rowspan="1" colSpan="1" >Description</td>
1758
- </tr>
1759
-
1760
- <tr>
1761
- <td rowspan="1" colSpan="1" >params</td>
1762
-
1763
- <td rowspan="1" colSpan="1" >Picture render parameters, see [TRTCRenderParams](https://write.woa.com/document/87029993616093184) for details.</td>
1764
- </tr>
1765
-
1766
- <tr>
1767
- <td rowspan="1" colSpan="1" >streamType</td>
1768
-
1769
- <td rowspan="1" colSpan="1" >It can be set as the main road picture ([TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184)) or the auxiliary stream picture ([TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184)).</td>
1770
- </tr>
1771
-
1772
- <tr>
1773
- <td rowspan="1" colSpan="1" >userId</td>
1774
-
1775
- <td rowspan="1" colSpan="1" >Specify the remote user's ID.</td>
1776
- </tr>
1777
- </table>
1778
-
737
+ | Parameters | Description |
738
+ | --- | --- |
739
+ | params | Picture render parameters, see TRTCRenderParams for details. |
740
+ | streamType | It can be set as the main road picture (TRTC_VIDEO_STREAM_TYPE_BIG) or the auxiliary stream picture (TRTC_VIDEO_STREAM_TYPE_SUB). |
741
+ | userId | Specify the remote user's ID. |
1779
742
 
1780
743
  ## enableEncSmallVideoStream
1781
744
 
1782
-
1783
-
1784
745
  #### Enable picture-in-picture dual-stream encoding mode
1785
746
 
1786
747
  After enabling the dual-stream encoding mode, the current user's encoder will output both [HD large screen] and [low-definition small picture] video streams (but only one audio stream).
1787
748
 
1788
749
  This way, other users in the room can choose to subscribe to [HD large screen] or [low-definition small screen] based on their network conditions or screen size.
1789
- <table>
1790
- <tr>
1791
- <td rowspan="1" colSpan="1" >Parameters</td>
1792
-
1793
- <td rowspan="1" colSpan="1" >Description</td>
1794
- </tr>
1795
-
1796
- <tr>
1797
- <td rowspan="1" colSpan="1" >enable</td>
1798
-
1799
- <td rowspan="1" colSpan="1" >Whether to enable small picture encoding, default value: false.</td>
1800
- </tr>
1801
-
1802
- <tr>
1803
- <td rowspan="1" colSpan="1" >smallVideoEncParam</td>
1804
-
1805
- <td rowspan="1" colSpan="1" >Video parameters for the substream.</td>
1806
- </tr>
1807
- </table>
1808
-
750
+ | Parameters | Description |
751
+ | --- | --- |
752
+ | enable | Whether to enable small picture encoding, default value: false. |
753
+ | smallVideoEncParam | Video parameters for the substream. |
1809
754
 
1810
755
  > **Note**
1811
- >
756
+ >
1812
757
 
1813
758
  > When the dual-stream encoding mode is enabled, it consumes more CPU and network bandwidth. Therefore, it may be considered for use on Mac, Windows, or high-performance Pads. It is not recommended for mobile devices.
1814
- >
1815
-
759
+ >
1816
760
 
1817
761
  #### Return value description:
1818
762
 
@@ -1820,120 +764,52 @@ This way, other users in the room can choose to subscribe to [HD large screen] o
1820
764
 
1821
765
  ## setRemoteVideoStreamType
1822
766
 
1823
-
1824
-
1825
767
  #### Switch picture-in-picture for the specified remote user
1826
768
 
1827
- After a host in the room has enabled dual-channel encoding, the default screen subscribed by other users in the room through [startRemoteView](https://write.woa.com/document/87029900866228224) will be [HD large screen].
1828
-
1829
- You can use this interface to select whether you want to subscribe to the large screen or small screen. This interface is effective whether called before or after [startRemoteView](https://write.woa.com/document/87029900866228224).
1830
- <table>
1831
- <tr>
1832
- <td rowspan="1" colSpan="1" >Parameters</td>
1833
-
1834
- <td rowspan="1" colSpan="1" >Description</td>
1835
- </tr>
1836
-
1837
- <tr>
1838
- <td rowspan="1" colSpan="1" >streamType</td>
1839
-
1840
- <td rowspan="1" colSpan="1" >Video stream type, i.e., choose to watch the large screen or the small screen, default is large screen.</td>
1841
- </tr>
1842
-
1843
- <tr>
1844
- <td rowspan="1" colSpan="1" >userId</td>
1845
-
1846
- <td rowspan="1" colSpan="1" >Specify the remote user's ID.</td>
1847
- </tr>
1848
- </table>
769
+ After a host in the room has enabled dual-channel encoding, the default screen subscribed by other users in the room through startRemoteView will be [HD large screen].
1849
770
 
771
+ You can use this interface to select whether you want to subscribe to the large screen or small screen. This interface is effective whether called before or after startRemoteView.
772
+ | Parameters | Description |
773
+ | --- | --- |
774
+ | streamType | Video stream type, i.e., choose to watch the large screen or the small screen, default is large screen. |
775
+ | userId | Specify the remote user's ID. |
1850
776
 
1851
777
  > **Note**
1852
- >
1853
-
1854
- > This feature requires the target user to have already enabled dual-channel encoding mode through [enableEncSmallVideoStream](https://write.woa.com/document/87029900866228224) in advance; otherwise, this call has no actual effect.
1855
- >
778
+ >
1856
779
 
780
+ > This feature requires the target user to have already enabled dual-channel encoding mode through enableEncSmallVideoStream in advance; otherwise, this call has no actual effect.
781
+ >
1857
782
 
1858
783
  ## snapshotVideo
1859
784
 
1860
-
1861
-
1862
785
  #### Take a video screenshot
1863
786
 
1864
787
  You can use this interface to capture the local video footage, the main stream picture of a remote user, and the auxiliary stream (screen sharing) picture of a remote user.
1865
- <table>
1866
- <tr>
1867
- <td rowspan="1" colSpan="1" >Parameters</td>
1868
-
1869
- <td rowspan="1" colSpan="1" >Description</td>
1870
- </tr>
1871
-
1872
- <tr>
1873
- <td rowspan="1" colSpan="1" >sourceType</td>
1874
-
1875
- <td rowspan="1" colSpan="1" >Picture source can be chosen as video stream capture (TRTCSnapshotSourceTypeStream), video rendering picture (TRTCSnapshotSourceTypeView), or captured frame (TRTCSnapshotSourceTypeCapture). Captured frame screenshots are clearer.</td>
1876
- </tr>
1877
-
1878
- <tr>
1879
- <td rowspan="1" colSpan="1" >streamType</td>
1880
-
1881
- <td rowspan="1" colSpan="1" >Video stream type can be selected as the main road picture ([TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184), commonly used for the camera) or auxiliary stream picture ([TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184), commonly used for screen sharing).</td>
1882
- </tr>
1883
-
1884
- <tr>
1885
- <td rowspan="1" colSpan="1" >userId</td>
1886
-
1887
- <td rowspan="1" colSpan="1" >User ID, if left blank, indicates capturing the local video footage.</td>
1888
- </tr>
1889
- </table>
1890
-
788
+ | Parameters | Description |
789
+ | --- | --- |
790
+ | sourceType | Picture source can be chosen as video stream capture (TRTCSnapshotSourceTypeStream), video rendering picture (TRTCSnapshotSourceTypeView), or captured frame (TRTCSnapshotSourceTypeCapture). Captured frame screenshots are clearer. |
791
+ | streamType | Video stream type can be selected as the main road picture (TRTC_VIDEO_STREAM_TYPE_BIG, commonly used for the camera) or auxiliary stream picture (TRTC_VIDEO_STREAM_TYPE_SUB, commonly used for screen sharing). |
792
+ | userId | User ID, if left blank, indicates capturing the local video footage. |
1891
793
 
1892
794
  > **Note**
1893
- >
795
+ >
1894
796
 
1895
797
  > The Windows platform currently only supports capturing video pictures from TRTCSnapshotSourceTypeStream sources.
1896
- >
1897
-
798
+ >
1898
799
 
1899
800
  ## setPerspectiveCorrectionPoints
1900
801
 
1901
-
1902
-
1903
802
  #### Set perspective correction coordinate settings for the video screen
1904
803
 
1905
804
  You can specify the coordinate area for perspective correction of the rendered image through this interface.
1906
- <table>
1907
- <tr>
1908
- <td rowspan="1" colSpan="1" >Parameters</td>
1909
-
1910
- <td rowspan="1" colSpan="1" >Description</td>
1911
- </tr>
1912
-
1913
- <tr>
1914
- <td rowspan="1" colSpan="1" >dstPoints</td>
1915
-
1916
- <td rowspan="1" colSpan="1" >The target coordinates area to be corrected to, consists of 4 vertex coordinates. They need to be passed in the order of top-left, bottom-left, top-right, and bottom-right. All coordinates need to be normalized to the [0,1] range based on the image width and height; passing null will stop the perspective correction.</td>
1917
- </tr>
1918
-
1919
- <tr>
1920
- <td rowspan="1" colSpan="1" >srcPoints</td>
1921
-
1922
- <td rowspan="1" colSpan="1" >The original image coordinate area consists of 4 vertex coordinates. They need to be passed in the order of top-left, bottom-left, top-right, and bottom-right. All coordinates need to be normalized to the [0,1] range based on the image width and height; passing null will stop the perspective correction.</td>
1923
- </tr>
1924
-
1925
- <tr>
1926
- <td rowspan="1" colSpan="1" >userId</td>
1927
-
1928
- <td rowspan="1" colSpan="1" >User ID, if left blank, indicates correcting the local video footage.</td>
1929
- </tr>
1930
- </table>
1931
-
805
+ | Parameters | Description |
806
+ | --- | --- |
807
+ | dstPoints | The target coordinates area to be corrected to, consists of 4 vertex coordinates. They need to be passed in the order of top-left, bottom-left, top-right, and bottom-right. All coordinates need to be normalized to the [0,1] range based on the image width and height; passing null will stop the perspective correction. |
808
+ | srcPoints | The original image coordinate area consists of 4 vertex coordinates. They need to be passed in the order of top-left, bottom-left, top-right, and bottom-right. All coordinates need to be normalized to the [0,1] range based on the image width and height; passing null will stop the perspective correction. |
809
+ | userId | User ID, if left blank, indicates correcting the local video footage. |
1932
810
 
1933
811
  ## setGravitySensorAdaptiveMode
1934
812
 
1935
-
1936
-
1937
813
  #### Set gravity sensing adaptive mode (11.7 and above)
1938
814
 
1939
815
  After gravity sensing is enabled, if the collection end device rotates, both the collection end and audience side will render the image accordingly to ensure the image in the view is always upright.
@@ -1943,321 +819,160 @@ It only takes effect in the SDK internal camera capture scene and only works on
1943
819
  1. This interface only affects the collection end. If you are just watching the image in the room, enabling this interface is ineffective
1944
820
 
1945
821
  2. When the collection end device rotates 90 degrees or 270 degrees, the image seen by the collection end or audience side may be cropped to maintain aspect ratio coordination
1946
- <table>
1947
- <tr>
1948
- <td rowspan="1" colSpan="1" >Parameters</td>
1949
-
1950
- <td rowspan="1" colSpan="1" >Description</td>
1951
- </tr>
1952
-
1953
- <tr>
1954
- <td rowspan="1" colSpan="1" >mode</td>
1955
-
1956
- <td rowspan="1" colSpan="1" >Gravity sensing mode: for details, please refer to [TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_DISABLE](https://write.woa.com/document/87029993616093184), [TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_FILL_BY_CENTER_CROP](https://write.woa.com/document/87029993616093184), and [TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_FIT_WITH_BLACK_BORDER](https://write.woa.com/document/87029993616093184). Default value: [TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_DISABLE](https://write.woa.com/document/87029993616093184).</td>
1957
- </tr>
1958
- </table>
1959
-
822
+ | Parameters | Description |
823
+ | --- | --- |
824
+ | mode | Gravity sensing mode: for details, please refer to TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_DISABLE, TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_FILL_BY_CENTER_CROP, and TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_FIT_WITH_BLACK_BORDER. Default value: TRTC_GRAVITY_SENSOR_ADAPTIVE_MODE_DISABLE. |
1960
825
 
1961
826
  ## startLocalAudio
1962
827
 
1963
-
1964
-
1965
828
  #### Enable collection and publishing of local audio
1966
829
 
1967
830
  The SDK does not enable the microphone by default. When users need to publish local audio, they need to call this interface to enable microphone collection and encoding and publish the audio to the current room.
1968
831
 
1969
- After enabling the collection and publishing of local audio, other users in the room will receive [onUserAudioAvailable](https://write.woa.com/document/87029920275542016)(userId, true) notification.
1970
- <table>
1971
- <tr>
1972
- <td rowspan="1" colSpan="1" >Parameters</td>
1973
-
1974
- <td rowspan="1" colSpan="1" >Description</td>
1975
- </tr>
1976
-
1977
- <tr>
1978
- <td rowspan="1" colSpan="1" >quality</td>
1979
-
1980
- <td rowspan="1" colSpan="1" >Sound quality<br>- [TRTC_AUDIO_QUALITY_SPEECH](https://write.woa.com/document/87029993616093184), Smooth: Sample rate: 16k; Mono; Audio bitrate: 16kbps; Suitable for voice call-centric scenarios, such as online meetings and voice calls.<br>- [TRTC_AUDIO_QUALITY_DEFAULT](https://write.woa.com/document/87029993616093184), Default: Sample rate: 48k; Mono; Audio bitrate: 50kbps; Default SDK audio quality, recommended if there are no special requirements.<br>- [TRTC_AUDIO_QUALITY_MUSIC](https://write.woa.com/document/87029993616093184), High quality: Sample rate: 48k; Stereo + Full band; Audio bitrate: 128kbps; Suitable for high-fidelity music transmission scenarios, such as online karaoke and music live streaming.</td>
1981
- </tr>
1982
- </table>
1983
-
832
+ After enabling the collection and publishing of local audio, other users in the room will receive onUserAudioAvailable(userId, true) notification.
833
+ | Parameters | Description |
834
+ | --- | --- |
835
+ | quality | Sound quality<br>- TRTC_AUDIO_QUALITY_SPEECH, Smooth: Sample rate: 16k; Mono; Audio bitrate: 16kbps; Suitable for voice call-centric scenarios, such as online meetings and voice calls.<br>- TRTC_AUDIO_QUALITY_DEFAULT, Default: Sample rate: 48k; Mono; Audio bitrate: 50kbps; Default SDK audio quality, recommended if there are no special requirements.<br>- TRTC_AUDIO_QUALITY_MUSIC, High quality: Sample rate: 48k; Stereo + Full band; Audio bitrate: 128kbps; Suitable for high-fidelity music transmission scenarios, such as online karaoke and music live streaming. |
1984
836
 
1985
837
  > **Note**
1986
- >
838
+ >
1987
839
 
1988
840
  > This function checks the microphone permissions. If the current app does not have microphone permissions, the SDK will automatically request microphone permissions from the user.
1989
- >
1990
-
841
+ >
1991
842
 
1992
843
  ## stopLocalAudio
1993
844
 
1994
-
1995
-
1996
845
  #### Stop collection and publishing of local audio
1997
846
 
1998
- After stopping the collection and publishing of local audio, other users in the room will receive [onUserAudioAvailable](https://write.woa.com/document/87029920275542016)(userId, false) notification.
847
+ After stopping the collection and publishing of local audio, other users in the room will receive onUserAudioAvailable(userId, false) notification.
1999
848
 
2000
849
  ## muteLocalAudio
2001
850
 
2002
-
2003
-
2004
851
  #### Pause/Resume publishing of the local audio stream
2005
852
 
2006
- When you pause the publishing of the local audio stream, other users in the room will receive [onUserAudioAvailable](https://write.woa.com/document/87029920275542016)(userId, false) notification.
2007
-
2008
- When you resume the publishing of the local audio stream, other users in the room will receive [onUserAudioAvailable](https://write.woa.com/document/87029920275542016)(userId, true) notification.
2009
-
853
+ When you pause the publishing of the local audio stream, other users in the room will receive onUserAudioAvailable(userId, false) notification.
2010
854
 
855
+ When you resume the publishing of the local audio stream, other users in the room will receive onUserAudioAvailable(userId, true) notification.
2011
856
 
2012
- The difference from [stopLocalAudio](https://write.woa.com/document/87029900866228224) is that muteLocalAudio(true) does not release the microphone permissions but continues to send a low-bit-rate silent packet.
857
+ The difference from stopLocalAudio is that muteLocalAudio(true) does not release the microphone permissions but continues to send a low-bit-rate silent packet.
2013
858
 
2014
- This is very suitable for scenarios that require cloud recording because video files in formats like MP4 demand high continuity of audio data, and using [stopLocalAudio](https://write.woa.com/document/87029900866228224) will make the recorded MP4 files difficult to play.
859
+ This is very suitable for scenarios that require cloud recording because video files in formats like MP4 demand high continuity of audio data, and using stopLocalAudio will make the recorded MP4 files difficult to play.
2015
860
 
2016
861
  Therefore, in scenarios where the quality of the recorded files is highly required, it is recommended to choose muteLocalAudio instead of stopLocalAudio.
2017
- <table>
2018
- <tr>
2019
- <td rowspan="1" colSpan="1" >Parameters</td>
2020
-
2021
- <td rowspan="1" colSpan="1" >Description</td>
2022
- </tr>
2023
-
2024
- <tr>
2025
- <td rowspan="1" colSpan="1" >mute</td>
2026
-
2027
- <td rowspan="1" colSpan="1" >true: Mute; false: Unmute.</td>
2028
- </tr>
2029
- </table>
2030
-
862
+ | Parameters | Description |
863
+ | --- | --- |
864
+ | mute | true: Mute; false: Unmute. |
2031
865
 
2032
866
  ## muteRemoteAudio
2033
867
 
2034
-
2035
-
2036
868
  #### Pause/Resume playing of the remote audio stream
2037
869
 
2038
870
  When you mute a user's remote audio, the SDK will stop playing the specified user's sound and will also stop pulling that user's audio data.
2039
- <table>
2040
- <tr>
2041
- <td rowspan="1" colSpan="1" >Parameters</td>
2042
-
2043
- <td rowspan="1" colSpan="1" >Description</td>
2044
- </tr>
2045
-
2046
- <tr>
2047
- <td rowspan="1" colSpan="1" >mute</td>
2048
-
2049
- <td rowspan="1" colSpan="1" >true: Mute; false: Unmute.</td>
2050
- </tr>
2051
-
2052
- <tr>
2053
- <td rowspan="1" colSpan="1" >userId</td>
2054
-
2055
- <td rowspan="1" colSpan="1" >Used to specify the remote user's ID.</td>
2056
- </tr>
2057
- </table>
2058
-
871
+ | Parameters | Description |
872
+ | --- | --- |
873
+ | mute | true: Mute; false: Unmute. |
874
+ | userId | Used to specify the remote user's ID. |
2059
875
 
2060
876
  > **Note**
2061
- >
877
+ >
2062
878
 
2063
879
  > This interface is effective whether called before or after entering the room (enterRoom). The mute status will be reset to false after exiting the room (exitRoom).
2064
- >
2065
-
880
+ >
2066
881
 
2067
882
  ## muteAllRemoteAudio
2068
883
 
2069
-
2070
-
2071
884
  #### Pause/Resume playing of all remote users' audio streams
2072
885
 
2073
886
  When you mute all users' remote audio, the SDK will stop playing all remote audio streams and will also stop pulling all users' audio data.
2074
- <table>
2075
- <tr>
2076
- <td rowspan="1" colSpan="1" >Parameters</td>
2077
-
2078
- <td rowspan="1" colSpan="1" >Description</td>
2079
- </tr>
2080
-
2081
- <tr>
2082
- <td rowspan="1" colSpan="1" >mute</td>
2083
-
2084
- <td rowspan="1" colSpan="1" >true: Mute; false: Unmute.</td>
2085
- </tr>
2086
- </table>
2087
-
887
+ | Parameters | Description |
888
+ | --- | --- |
889
+ | mute | true: Mute; false: Unmute. |
2088
890
 
2089
891
  > **Note**
2090
- >
892
+ >
2091
893
 
2092
894
  > This interface is effective whether called before or after entering the room (enterRoom). The mute status will be reset to false after exiting the room (exitRoom).
2093
- >
2094
-
895
+ >
2095
896
 
2096
897
  ## setAudioRoute
2097
898
 
2098
-
2099
-
2100
899
  #### Sets audio routing.
2101
900
 
2102
901
  Set "audio routing", i.e., whether the sound is played through the mobile phone's speaker or earpiece. Therefore, this interface is only applicable to mobile devices such as phones.
2103
902
 
2104
-
2105
-
2106
903
  A mobile phone has two speakers: one is the earpiece located at the top of the phone, and the other is the stereo speaker located at the bottom.
2107
904
 
2108
905
  When the audio routing is set to the earpiece, the sound is relatively low, and you need to bring your ear close to hear it clearly, ensuring better privacy. It is suitable for phone calls.
2109
906
 
2110
907
  When the audio routing is set to the speaker, the sound is relatively loud. You can hear it clearly without holding the phone to your face, thus enabling the "hands-free" feature.
2111
- <table>
2112
- <tr>
2113
- <td rowspan="1" colSpan="1" >Parameters</td>
2114
-
2115
- <td rowspan="1" colSpan="1" >Description</td>
2116
- </tr>
2117
-
2118
- <tr>
2119
- <td rowspan="1" colSpan="1" >route</td>
2120
-
2121
- <td rowspan="1" colSpan="1" >Audio routing, i.e., where the sound is output (speaker, earpiece), default value: [TRTC_AUDIO_ROUTE_SPEAKER](https://write.woa.com/document/87029993616093184).</td>
2122
- </tr>
2123
- </table>
2124
-
908
+ | Parameters | Description |
909
+ | --- | --- |
910
+ | route | Audio routing, i.e., where the sound is output (speaker, earpiece), default value: TRTC_AUDIO_ROUTE_SPEAKER. |
2125
911
 
2126
912
  ## setRemoteAudioVolume
2127
913
 
2128
-
2129
-
2130
914
  #### Set the playback volume for a specific remote user
2131
915
 
2132
916
  You can mute a remote user's sound by using setRemoteAudioVolume(userId, 0).
2133
- <table>
2134
- <tr>
2135
- <td rowspan="1" colSpan="1" >Parameters</td>
2136
-
2137
- <td rowspan="1" colSpan="1" >Description</td>
2138
- </tr>
2139
-
2140
- <tr>
2141
- <td rowspan="1" colSpan="1" >userId</td>
2142
-
2143
- <td rowspan="1" colSpan="1" >Used to specify the remote user's ID.</td>
2144
- </tr>
2145
-
2146
- <tr>
2147
- <td rowspan="1" colSpan="1" >volume</td>
2148
-
2149
- <td rowspan="1" colSpan="1" >Volume. Value range: 0-100. Default value: 100.</td>
2150
- </tr>
2151
- </table>
2152
-
917
+ | Parameters | Description |
918
+ | --- | --- |
919
+ | userId | Used to specify the remote user's ID. |
920
+ | volume | Volume. Value range: 0-100. Default value: 100. |
2153
921
 
2154
922
  > **Note**
2155
- >
923
+ >
2156
924
 
2157
925
  > If you still feel the volume is too low after setting it to 100, you can set the maximum volume to 150. However, a volume above 100 carries a risk of pop noise, so proceed with caution.
2158
- >
2159
-
926
+ >
2160
927
 
2161
928
  ## setAudioCaptureVolume
2162
929
 
2163
-
2164
-
2165
930
  #### Sets the local audio capture volume.
2166
- <table>
2167
- <tr>
2168
- <td rowspan="1" colSpan="1" >Parameters</td>
2169
-
2170
- <td rowspan="1" colSpan="1" >Description</td>
2171
- </tr>
2172
-
2173
- <tr>
2174
- <td rowspan="1" colSpan="1" >volume</td>
2175
-
2176
- <td rowspan="1" colSpan="1" >Volume. Value range: 0-100. Default value: 100.</td>
2177
- </tr>
2178
- </table>
2179
-
931
+ | Parameters | Description |
932
+ | --- | --- |
933
+ | volume | Volume. Value range: 0-100. Default value: 100. |
2180
934
 
2181
935
  > **Note**
2182
- >
936
+ >
2183
937
 
2184
938
  > If you still feel the volume is too low after setting it to 100, you can set the maximum volume to 150. However, a volume above 100 carries a risk of pop noise, so proceed with caution.
2185
- >
2186
-
939
+ >
2187
940
 
2188
941
  ## getAudioCaptureVolume
2189
942
 
2190
-
2191
-
2192
943
  #### Obtains the local audio capture volume.
2193
944
 
2194
945
  ## setAudioPlayoutVolume
2195
946
 
2196
-
2197
-
2198
947
  #### Sets the remote audio playback volume.
2199
948
 
2200
949
  This interface controls the volume that the SDK finally delivers to the system for playback. The adjustment will affect the volume of the local audio recording file, but it will not affect the volume of the ear return.
2201
- <table>
2202
- <tr>
2203
- <td rowspan="1" colSpan="1" >Parameters</td>
2204
-
2205
- <td rowspan="1" colSpan="1" >Description</td>
2206
- </tr>
2207
-
2208
- <tr>
2209
- <td rowspan="1" colSpan="1" >volume</td>
2210
-
2211
- <td rowspan="1" colSpan="1" >Volume. Value range: 0-100. Default value: 100.</td>
2212
- </tr>
2213
- </table>
2214
-
950
+ | Parameters | Description |
951
+ | --- | --- |
952
+ | volume | Volume. Value range: 0-100. Default value: 100. |
2215
953
 
2216
954
  > **Note**
2217
- >
955
+ >
2218
956
 
2219
957
  > If you still feel the volume is too low after setting it to 100, you can set the maximum volume to 150. However, a volume above 100 carries a risk of pop noise, so proceed with caution.
2220
- >
2221
-
958
+ >
2222
959
 
2223
960
  ## getAudioPlayoutVolume
2224
961
 
2225
-
2226
-
2227
962
  #### Obtains the remote audio playback volume.
2228
963
 
2229
964
  ## enableAudioVolumeEvaluation
2230
965
 
2231
-
2232
-
2233
966
  #### Enable volume reminder
2234
967
 
2235
- After enabling this feature, the SDK will provide feedback on the audio volume evaluation information of local or remote users in the callback [TRTCCloudListener](https://write.woa.com/document/87029920275542016)[onUserVoiceVolume](https://write.woa.com/document/87029920275542016), including volume level, voice detection, audio spectrum, etc.
2236
- <table>
2237
- <tr>
2238
- <td rowspan="1" colSpan="1" >Parameters</td>
2239
-
2240
- <td rowspan="1" colSpan="1" >Description</td>
2241
- </tr>
2242
-
2243
- <tr>
2244
- <td rowspan="1" colSpan="1" >enable</td>
2245
-
2246
- <td rowspan="1" colSpan="1" >Whether to enable volume prompts, disabled by default.</td>
2247
- </tr>
2248
-
2249
- <tr>
2250
- <td rowspan="1" colSpan="1" >params</td>
2251
-
2252
- <td rowspan="1" colSpan="1" >For volume assessment and other related parameters, please refer to [TRTCAudioVolumeEvaluateParams](https://write.woa.com/document/87029993616093184).</td>
2253
- </tr>
2254
- </table>
2255
-
968
+ After enabling this feature, the SDK will provide feedback on the audio volume evaluation information of local or remote users in the callback TRTCCloudListeneronUserVoiceVolume, including volume level, voice detection, audio spectrum, etc.
969
+ | Parameters | Description |
970
+ | --- | --- |
971
+ | enable | Whether to enable volume prompts, disabled by default. |
972
+ | params | For volume assessment and other related parameters, please refer to TRTCAudioVolumeEvaluateParams. |
2256
973
 
2257
974
  ## startAudioRecording
2258
975
 
2259
-
2260
-
2261
976
  #### Start recording
2262
977
 
2263
978
  When you call this interface, the SDK will mix and record all local and remote audio (including local audio, remote audio, background music, and sound effects) into a local file.
@@ -2265,27 +980,15 @@ When you call this interface, the SDK will mix and record all local and remote a
2265
980
  This interface can be called both before and after entering the room. If the recording task is not stopped by stopAudioRecording before exiting the room, the task will automatically stop after exiting the room.
2266
981
 
2267
982
  The start and completion status of this recording will be notified through local recording-related callbacks. See the TRTCCloud related callbacks.
2268
- <table>
2269
- <tr>
2270
- <td rowspan="1" colSpan="1" >Parameters</td>
2271
-
2272
- <td rowspan="1" colSpan="1" >Description</td>
2273
- </tr>
2274
-
2275
- <tr>
2276
- <td rowspan="1" colSpan="1" >param</td>
2277
-
2278
- <td rowspan="1" colSpan="1" >For recording parameters, please refer to [TRTCAudioRecordingParams](https://write.woa.com/document/87029993616093184).</td>
2279
- </tr>
2280
- </table>
2281
-
983
+ | Parameters | Description |
984
+ | --- | --- |
985
+ | param | For recording parameters, please refer to TRTCAudioRecordingParams. |
2282
986
 
2283
987
  > **Note**
2284
- >
988
+ >
2285
989
 
2286
990
  > Starting from version 11.5, the status results of audio recording are uniformly adjusted to asynchronous callback notifications. See the TRTCCloud related callbacks.
2287
- >
2288
-
991
+ >
2289
992
 
2290
993
  #### Return value description:
2291
994
 
@@ -2293,206 +996,93 @@ The start and completion status of this recording will be notified through local
2293
996
 
2294
997
  ## stopAudioRecording
2295
998
 
2296
-
2297
-
2298
999
  #### Stop recording
2299
1000
 
2300
1001
  If the recording task is not stopped by this interface before exiting the room, the recording task will automatically stop after exiting the room.
2301
1002
 
2302
1003
  ## startLocalRecording
2303
1004
 
2304
-
2305
-
2306
1005
  #### Enable local media recording
2307
1006
 
2308
1007
  After enabling, the audio and video content during the live stream will be recorded to a local file.
2309
- <table>
2310
- <tr>
2311
- <td rowspan="1" colSpan="1" >Parameters</td>
2312
-
2313
- <td rowspan="1" colSpan="1" >Description</td>
2314
- </tr>
2315
-
2316
- <tr>
2317
- <td rowspan="1" colSpan="1" >params</td>
2318
-
2319
- <td rowspan="1" colSpan="1" >For recording parameters, please refer to [TRTCLocalRecordingParams](https://write.woa.com/document/87029993616093184).</td>
2320
- </tr>
2321
- </table>
2322
-
1008
+ | Parameters | Description |
1009
+ | --- | --- |
1010
+ | params | For recording parameters, please refer to TRTCLocalRecordingParams. |
2323
1011
 
2324
1012
  ## stopLocalRecording
2325
1013
 
2326
-
2327
-
2328
1014
  #### Stop local media recording
2329
1015
 
2330
1016
  If the recording task is not stopped by this interface before exiting the room, the recording task will automatically stop after exiting the room.
2331
1017
 
2332
1018
  ## setRemoteAudioParallelParams
2333
1019
 
2334
-
2335
-
2336
1020
  #### Set intelligent concurrent playback strategy for remote audio streams
2337
1021
 
2338
1022
  Set intelligent concurrent playback strategy for remote audio streams, suitable for scenarios with a large number of people on the microphone.
2339
- <table>
2340
- <tr>
2341
- <td rowspan="1" colSpan="1" >Parameters</td>
2342
-
2343
- <td rowspan="1" colSpan="1" >Description</td>
2344
- </tr>
2345
-
2346
- <tr>
2347
- <td rowspan="1" colSpan="1" >params</td>
2348
-
2349
- <td rowspan="1" colSpan="1" >For audio concurrency parameters, please refer to [TRTCAudioParallelParams](https://write.woa.com/document/87029993616093184).</td>
2350
- </tr>
2351
- </table>
2352
-
1023
+ | Parameters | Description |
1024
+ | --- | --- |
1025
+ | params | For audio concurrency parameters, please refer to TRTCAudioParallelParams. |
2353
1026
 
2354
1027
  ## enable3DSpatialAudioEffect
2355
1028
 
2356
-
2357
-
2358
1029
  #### Enable 3D audio
2359
1030
 
2360
- Enable 3D audio effects. Note that smooth audio quality [TRTC_AUDIO_QUALITY_SPEECH](https://write.woa.com/document/87029993616093184) or default audio quality [TRTC_AUDIO_QUALITY_DEFAULT](https://write.woa.com/document/87029993616093184) is required.
2361
- <table>
2362
- <tr>
2363
- <td rowspan="1" colSpan="1" >Parameters</td>
2364
-
2365
- <td rowspan="1" colSpan="1" >Description</td>
2366
- </tr>
2367
-
2368
- <tr>
2369
- <td rowspan="1" colSpan="1" >enabled</td>
2370
-
2371
- <td rowspan="1" colSpan="1" >Whether to enable 3D audio effects, disabled by default.</td>
2372
- </tr>
2373
- </table>
2374
-
1031
+ Enable 3D audio effects. Note that smooth audio quality TRTC_AUDIO_QUALITY_SPEECH or default audio quality TRTC_AUDIO_QUALITY_DEFAULT is required.
1032
+ | Parameters | Description |
1033
+ | --- | --- |
1034
+ | enabled | Whether to enable 3D audio effects, disabled by default. |
2375
1035
 
2376
1036
  ## updateSelf3DSpatialPosition
2377
1037
 
2378
-
2379
-
2380
1038
  #### Set self coordinates and orientation information in 3D audio
2381
1039
 
2382
1040
  Update your position and orientation in the world coordinate system. The SDK will calculate the relative position between yourself and remote users based on the parameters of this method and render spatial audio effects accordingly. Note that each parameter should be passed in as an array of length 3.
2383
- <table>
2384
- <tr>
2385
- <td rowspan="1" colSpan="1" >Parameters</td>
2386
-
2387
- <td rowspan="1" colSpan="1" >Description</td>
2388
- </tr>
2389
-
2390
- <tr>
2391
- <td rowspan="1" colSpan="1" >axisForward</td>
2392
-
2393
- <td rowspan="1" colSpan="1" >The unit vector of the front axis of the local coordinate system in the world coordinate system, with three values representing the front, right, and up coordinate values, respectively.</td>
2394
- </tr>
2395
-
2396
- <tr>
2397
- <td rowspan="1" colSpan="1" >axisRight</td>
2398
-
2399
- <td rowspan="1" colSpan="1" >The unit vector of the right axis of the local coordinate system in the world coordinate system, with three values representing the front, right, and up coordinate values, respectively.</td>
2400
- </tr>
2401
-
2402
- <tr>
2403
- <td rowspan="1" colSpan="1" >axisUp</td>
2404
-
2405
- <td rowspan="1" colSpan="1" >The unit vector of the up axis of the local coordinate system in the world coordinate system, with three values representing the front, right, and up coordinate values, respectively.</td>
2406
- </tr>
2407
-
2408
- <tr>
2409
- <td rowspan="1" colSpan="1" >position</td>
2410
-
2411
- <td rowspan="1" colSpan="1" >Your coordinate in the world coordinate system, with three values representing the front, right, and up coordinate values, respectively.</td>
2412
- </tr>
2413
- </table>
2414
-
1041
+ | Parameters | Description |
1042
+ | --- | --- |
1043
+ | axisForward | The unit vector of the front axis of the local coordinate system in the world coordinate system, with three values representing the front, right, and up coordinate values, respectively. |
1044
+ | axisRight | The unit vector of the right axis of the local coordinate system in the world coordinate system, with three values representing the front, right, and up coordinate values, respectively. |
1045
+ | axisUp | The unit vector of the up axis of the local coordinate system in the world coordinate system, with three values representing the front, right, and up coordinate values, respectively. |
1046
+ | position | Your coordinate in the world coordinate system, with three values representing the front, right, and up coordinate values, respectively. |
2415
1047
 
2416
1048
  > **Note**
2417
- >
1049
+ >
2418
1050
 
2419
1051
  > Please appropriately limit the invocation frequency. It is recommended to set coordinates at intervals of at least 100ms.
2420
- >
2421
-
1052
+ >
2422
1053
 
2423
1054
  ## updateRemote3DSpatialPosition
2424
1055
 
2425
-
2426
-
2427
1056
  #### Set remote user coordinate information in 3D audio
2428
1057
 
2429
1058
  Update the position of remote users in the world coordinate system. The SDK will render spatial audio effects based on the relative position between yourself and the remote users. Note that the parameter is an array of length 3.
2430
- <table>
2431
- <tr>
2432
- <td rowspan="1" colSpan="1" >Parameters</td>
2433
-
2434
- <td rowspan="1" colSpan="1" >Description</td>
2435
- </tr>
2436
-
2437
- <tr>
2438
- <td rowspan="1" colSpan="1" >position</td>
2439
-
2440
- <td rowspan="1" colSpan="1" >The coordinate of the remote user in the world coordinate system, with three values representing the front, right, and up coordinate values, respectively.</td>
2441
- </tr>
2442
-
2443
- <tr>
2444
- <td rowspan="1" colSpan="1" >userId</td>
2445
-
2446
- <td rowspan="1" colSpan="1" >Specify the remote user's ID.</td>
2447
- </tr>
2448
- </table>
2449
-
1059
+ | Parameters | Description |
1060
+ | --- | --- |
1061
+ | position | The coordinate of the remote user in the world coordinate system, with three values representing the front, right, and up coordinate values, respectively. |
1062
+ | userId | Specify the remote user's ID. |
2450
1063
 
2451
1064
  > **Note**
2452
- >
1065
+ >
2453
1066
 
2454
1067
  > Please appropriately limit the invocation frequency. It is recommended to set coordinates for the same remote user at intervals of at least 100ms.
2455
- >
2456
-
1068
+ >
2457
1069
 
2458
1070
  ## set3DSpatialReceivingRange
2459
1071
 
2460
-
2461
-
2462
1072
  #### Set the receivable range of sounds emitted by a specified user
2463
1073
 
2464
1074
  After setting this range size, the specified user's voice will be audible within this range, and any sound beyond this range will be attenuated to 0.
2465
- <table>
2466
- <tr>
2467
- <td rowspan="1" colSpan="1" >Parameters</td>
2468
-
2469
- <td rowspan="1" colSpan="1" >Description</td>
2470
- </tr>
2471
-
2472
- <tr>
2473
- <td rowspan="1" colSpan="1" >range</td>
2474
-
2475
- <td rowspan="1" colSpan="1" >Maximum range at which the sound can be received.</td>
2476
- </tr>
2477
-
2478
- <tr>
2479
- <td rowspan="1" colSpan="1" >userId</td>
2480
-
2481
- <td rowspan="1" colSpan="1" >Specify the remote user's ID.</td>
2482
- </tr>
2483
- </table>
2484
-
1075
+ | Parameters | Description |
1076
+ | --- | --- |
1077
+ | range | Maximum range at which the sound can be received. |
1078
+ | userId | Specify the remote user's ID. |
2485
1079
 
2486
1080
  ## getDeviceManager
2487
1081
 
2488
-
2489
-
2490
1082
  #### Get Device Management Class (TXDeviceManager)
2491
1083
 
2492
1084
  ## getBeautyManager
2493
1085
 
2494
-
2495
-
2496
1086
  #### Get Beauty Management Class (TXBeautyManager)
2497
1087
 
2498
1088
  Through beauty management, you can use the following features:
@@ -2506,11 +1096,8 @@ Through beauty management, you can use the following features:
2506
1096
 
2507
1097
  - Set dynamic stickers and face pendants for animation effects.
2508
1098
 
2509
-
2510
1099
  ## setWatermark
2511
1100
 
2512
-
2513
-
2514
1101
  #### Watermarking
2515
1102
 
2516
1103
  The position of the watermark is specified through the rect parameter. Rect is a quadruplet parameter in the format (x, y, width, height)
@@ -2522,52 +1109,25 @@ The position of the watermark is specified through the rect parameter. Rect is a
2522
1109
 
2523
1110
  - height does not need to be set; the SDK will automatically calculate an appropriate height based on the aspect ratio of the watermark image.
2524
1111
 
2525
-
2526
-
2527
-
2528
1112
  Example of parameter settings:
2529
1113
 
2530
1114
  If the current video encoding resolution is 540 × 960, and the rect parameter is set to (0.1, 0.1, 0.2, 0.0),
2531
1115
 
2532
1116
  Then, the top-left coordinate of the watermark is (540 * 0.1, 960 * 0.1), which is (54, 96). The width of the watermark is 540 * 0.2 = 108px. The height of the watermark will be automatically calculated by the SDK based on the aspect ratio of the watermark image.
2533
- <table>
2534
- <tr>
2535
- <td rowspan="1" colSpan="1" >Parameters</td>
2536
-
2537
- <td rowspan="1" colSpan="1" >Description</td>
2538
- </tr>
2539
-
2540
- <tr>
2541
- <td rowspan="1" colSpan="1" >image</td>
2542
-
2543
- <td rowspan="1" colSpan="1" >Watermark image, ** must be in png format with a transparent background **.</td>
2544
- </tr>
2545
-
2546
- <tr>
2547
- <td rowspan="1" colSpan="1" >rect</td>
2548
-
2549
- <td rowspan="1" colSpan="1" >Normalized coordinates of the watermark relative to the encoding resolution: x, y, width, height. Value range: 0 - 1.</td>
2550
- </tr>
2551
-
2552
- <tr>
2553
- <td rowspan="1" colSpan="1" >streamType</td>
2554
-
2555
- <td rowspan="1" colSpan="1" >Specify which stream to set the watermark for. For details, see [TRTCVideoStreamType](https://write.woa.com/document/87029993616093184).</td>
2556
- </tr>
2557
- </table>
2558
-
1117
+ | Parameters | Description |
1118
+ | --- | --- |
1119
+ | image | Watermark image, ** must be in png format with a transparent background **. |
1120
+ | rect | Normalized coordinates of the watermark relative to the encoding resolution: x, y, width, height. Value range: 0 - 1. |
1121
+ | streamType | Specify which stream to set the watermark for. For details, see TRTCVideoStreamType. |
2559
1122
 
2560
1123
  > **Note**
2561
- >
1124
+ >
2562
1125
 
2563
1126
  > If you need to set the watermark for both the main stream (usually the camera) and the auxiliary stream (usually used for screen sharing), you need to call this interface twice and set different streamTypes.
2564
- >
2565
-
1127
+ >
2566
1128
 
2567
1129
  ## getAudioEffectManager
2568
1130
 
2569
-
2570
-
2571
1131
  #### Get Audio Effect Management Class (TXAudioEffectManager)
2572
1132
 
2573
1133
  TXAudioEffectManager is the audio effect management interface. Through this interface, you can implement the following features:
@@ -2581,11 +1141,8 @@ TXAudioEffectManager is the audio effect management interface. Through this inte
2581
1141
 
2582
1142
  - Short sound effects: short sound effect files such as applause, laughter, etc. (for files less than 10 seconds, please set the isShortFile parameter to true).
2583
1143
 
2584
-
2585
1144
  ## startSystemAudioLoopback
2586
1145
 
2587
-
2588
-
2589
1146
  #### Enable System Sound Capturing
2590
1147
 
2591
1148
  This interface will capture audio data from other applications and mix it into the current audio data stream of the SDK, so that other users in the room can also hear the sound played by the broadcaster's other applications.
@@ -2595,42 +1152,33 @@ In online education scenarios, teachers can use this feature to allow the SDK to
2595
1152
  In music live streaming scenarios, the host can use this feature to allow the SDK to capture audio from the music player to add background music to their live stream.
2596
1153
 
2597
1154
  > **Note**
2598
- >
1155
+ >
2599
1156
 
2600
1157
  > 1. This interface only takes effect on Android API 29 and above.
2601
- >
1158
+ >
2602
1159
 
2603
1160
  > 2. You need to use this interface to enable system sound capture before the screen sharing interface can be effectively used.
2604
- >
1161
+ >
2605
1162
 
2606
1163
  > 3. You need to add a foreground service to ensure that system sound capture is not silenced, and set android:foregroundServiceType="mediaProjection".
2607
- >
1164
+ >
2608
1165
 
2609
1166
  > 4. The SDK only captures the application audio that meets the capture strategy and audio usage. Currently, the captured audio usage includes USAGE_MEDIA and USAGE_GAME.
2610
- >
2611
-
1167
+ >
2612
1168
 
2613
1169
  ## stopSystemAudioLoopback
2614
1170
 
2615
-
2616
-
2617
1171
  #### Stop System Sound Capture (iOS not yet supported)
2618
1172
 
2619
1173
  ## startScreenCapture
2620
1174
 
2621
-
2622
-
2623
1175
  #### Start Screen Sharing
2624
1176
 
2625
1177
  This interface supports capturing the entire Android system screen, enabling system-wide screen sharing similar to Tencent Meeting.
2626
1178
 
2627
-
2628
-
2629
1179
  Refer to documentation: [Real-time Screen Sharing (Android)](https://cloud.tencent.com/document/product/647/45751)
2630
1180
 
2631
-
2632
-
2633
- Recommended screen sharing video encoding parameters for Android ([TRTCVideoEncParam](https://write.woa.com/document/87029993616093184)):
1181
+ Recommended screen sharing video encoding parameters for Android (TRTCVideoEncParam):
2634
1182
  - Resolution (videoResolution): 1280×720.
2635
1183
 
2636
1184
  - Frame Rate (videoFps): 10 FPS.
@@ -2639,120 +1187,59 @@ Recommended screen sharing video encoding parameters for Android ([TRTCVideoEncP
2639
1187
 
2640
1188
  - Resolution Adaptation (enableAdjustRes): false.
2641
1189
 
2642
- <table>
2643
- <tr>
2644
- <td rowspan="1" colSpan="1" >Parameters</td>
2645
-
2646
- <td rowspan="1" colSpan="1" >Description</td>
2647
- </tr>
2648
-
2649
- <tr>
2650
- <td rowspan="1" colSpan="1" >encParams</td>
2651
-
2652
- <td rowspan="1" colSpan="1" >For encoding parameters, please refer to [TRTCVideoEncParam](https://write.woa.com/document/87029993616093184). If you set encParams to null, the SDK will automatically use the previously set encoding parameters.</td>
2653
- </tr>
2654
-
2655
- <tr>
2656
- <td rowspan="1" colSpan="1" >shareParams</td>
2657
-
2658
- <td rowspan="1" colSpan="1" >Please refer to [TRTCScreenShareParams](https://write.woa.com/document/87029993616093184). You can pop up a floating window using the floatingView parameter (or use the Android system's WindowManager interface to pop it up yourself).</td>
2659
- </tr>
2660
-
2661
- <tr>
2662
- <td rowspan="1" colSpan="1" >streamType</td>
2663
-
2664
- <td rowspan="1" colSpan="1" >The circuit used for screen sharing can be set to primary channel ([TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184)) or secondary channel ([TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184)).</td>
2665
- </tr>
2666
- </table>
2667
-
1190
+ | Parameters | Description |
1191
+ | --- | --- |
1192
+ | encParams | For encoding parameters, please refer to TRTCVideoEncParam. If you set encParams to null, the SDK will automatically use the previously set encoding parameters. |
1193
+ | shareParams | Please refer to TRTCScreenShareParams. You can pop up a floating window using the floatingView parameter (or use the Android system's WindowManager interface to pop it up yourself). |
1194
+ | streamType | The circuit used for screen sharing can be set to primary channel (TRTC_VIDEO_STREAM_TYPE_BIG) or secondary channel (TRTC_VIDEO_STREAM_TYPE_SUB). |
2668
1195
 
2669
1196
  ## stopScreenCapture
2670
1197
 
2671
-
2672
-
2673
1198
  #### Stopping Screen Sharing
2674
1199
 
2675
1200
  ## pauseScreenCapture
2676
1201
 
2677
-
2678
-
2679
1202
  #### Pause Screen Sharing
2680
1203
 
2681
1204
  > **Note**
2682
- >
2683
-
2684
- > Starting from version 11.5, suspending screen capture will output the last frame at a frame rate of 1fps.
2685
- >
2686
-
2687
-
2688
- ## resumeScreenCapture
1205
+ >
2689
1206
 
1207
+ > Starting from version 11.5, suspending screen capture will output the last frame at a frame rate of 1fps.
1208
+ >
2690
1209
 
1210
+ ## resumeScreenCapture
2691
1211
 
2692
1212
  #### Resume Screen Sharing
2693
1213
 
2694
1214
  ## setSubStreamEncoderParam
2695
1215
 
2696
-
2697
-
2698
1216
  #### Set Video Encoding Parameters for Screen Sharing (Sub-Stream) (Supported on Both Desktop and Mobile Systems)
2699
1217
 
2700
1218
  This interface can set the screen sharing (sub-stream) quality seen by remote users, and also determine the screen sharing quality in the cloud-recorded video file.
2701
1219
 
2702
1220
  Please note the differences between the following two interfaces:
2703
- - [setVideoEncoderParam](https://write.woa.com/document/87029900866228224) is used to set video encoding parameters for the primary channel ([TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184), typically used for the camera).
2704
-
2705
- - [setSubStreamEncoderParam](https://write.woa.com/document/87029900866228224) is used to set video encoding parameters for the secondary channel ([TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184), typically used for screen sharing).
2706
-
2707
- <table>
2708
- <tr>
2709
- <td rowspan="1" colSpan="1" >Parameters</td>
2710
-
2711
- <td rowspan="1" colSpan="1" >Description</td>
2712
- </tr>
2713
-
2714
- <tr>
2715
- <td rowspan="1" colSpan="1" >param</td>
1221
+ - setVideoEncoderParam is used to set video encoding parameters for the primary channel (TRTC_VIDEO_STREAM_TYPE_BIG, typically used for the camera).
2716
1222
 
2717
- <td rowspan="1" colSpan="1" >For auxiliary stream encoding parameters, please refer to [TRTCVideoEncParam](https://write.woa.com/document/87029993616093184).</td>
2718
- </tr>
2719
- </table>
1223
+ - setSubStreamEncoderParam is used to set video encoding parameters for the secondary channel (TRTC_VIDEO_STREAM_TYPE_SUB, typically used for screen sharing).
2720
1224
 
1225
+ | Parameters | Description |
1226
+ | --- | --- |
1227
+ | param | For auxiliary stream encoding parameters, please refer to TRTCVideoEncParam. |
2721
1228
 
2722
1229
  ## enableCustomVideoCapture
2723
1230
 
2724
-
2725
-
2726
1231
  #### Enable/Disable Custom Video Capturing Mode
2727
1232
 
2728
1233
  After enabling this mode, the SDK will stop running the original video capture process. It will no longer collect data from the camera and apply beauty filters, retaining only video encoding and sending capabilities.
2729
1234
 
2730
- You need to continuously send self-collected video frames to the SDK via [sendCustomVideoData](https://write.woa.com/document/87029900866228224).
2731
- <table>
2732
- <tr>
2733
- <td rowspan="1" colSpan="1" >Parameters</td>
2734
-
2735
- <td rowspan="1" colSpan="1" >Description</td>
2736
- </tr>
2737
-
2738
- <tr>
2739
- <td rowspan="1" colSpan="1" >enable</td>
2740
-
2741
- <td rowspan="1" colSpan="1" >Whether to enable, default value: false.</td>
2742
- </tr>
2743
-
2744
- <tr>
2745
- <td rowspan="1" colSpan="1" >streamType</td>
2746
-
2747
- <td rowspan="1" colSpan="1" >Used to specify video stream type, [TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184): high-definition large image; [TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184): secondary channel image.</td>
2748
- </tr>
2749
- </table>
2750
-
1235
+ You need to continuously send self-collected video frames to the SDK via sendCustomVideoData.
1236
+ | Parameters | Description |
1237
+ | --- | --- |
1238
+ | enable | Whether to enable, default value: false. |
1239
+ | streamType | Used to specify video stream type, TRTC_VIDEO_STREAM_TYPE_BIG: high-definition large image; TRTC_VIDEO_STREAM_TYPE_SUB: secondary channel image. |
2751
1240
 
2752
1241
  ## sendCustomVideoData
2753
1242
 
2754
-
2755
-
2756
1243
  #### Submit Self-collected Video Frames to the SDK
2757
1244
 
2758
1245
  This interface allows you to submit self-collected video frames to the SDK. The SDK will encode the video frames and transmit them through its network module.
@@ -2762,82 +1249,46 @@ There are two casting schemes on the Android platform:
2762
1249
 
2763
1250
  - Video memory transfer scheme: requires some OpenGL basics but performs better; resolutions above 640 × 360 should use this scheme.
2764
1251
 
2765
-
2766
-
2767
-
2768
1252
  Refer to documentation: [Custom Collection and Rendering](https://cloud.tencent.com/document/product/647/34066).
2769
- <table>
2770
- <tr>
2771
- <td rowspan="1" colSpan="1" >Parameters</td>
2772
-
2773
- <td rowspan="1" colSpan="1" >Description</td>
2774
- </tr>
2775
-
2776
- <tr>
2777
- <td rowspan="1" colSpan="1" >frame</td>
2778
-
2779
- <td rowspan="1" colSpan="1" >Video data, if using the memory transfer scheme, please set the data field; if using the video memory transfer scheme, please set the TRTCTexture field. For details, please refer to [TRTCVideoFrame](https://write.woa.com/document/87029993616093184).</td>
2780
- </tr>
2781
-
2782
- <tr>
2783
- <td rowspan="1" colSpan="1" >streamType</td>
2784
-
2785
- <td rowspan="1" colSpan="1" >Used to specify video stream type, [TRTC_VIDEO_STREAM_TYPE_BIG](https://write.woa.com/document/87029993616093184): HD large screen; [TRTC_VIDEO_STREAM_TYPE_SUB](https://write.woa.com/document/87029993616093184): secondary channel image.</td>
2786
- </tr>
2787
- </table>
2788
-
1253
+ | Parameters | Description |
1254
+ | --- | --- |
1255
+ | frame | Video data, if using the memory transfer scheme, please set the data field; if using the video memory transfer scheme, please set the TRTCTexture field. For details, please refer to TRTCVideoFrame. |
1256
+ | streamType | Used to specify video stream type, TRTC_VIDEO_STREAM_TYPE_BIG: HD large screen; TRTC_VIDEO_STREAM_TYPE_SUB: secondary channel image. |
2789
1257
 
2790
1258
  > **Note**
2791
- >
1259
+ >
2792
1260
 
2793
- > 1. It is recommended to call the [generateCustomPTS](https://write.woa.com/document/87029900866228224) interface to get the timestamp value of the frame after capturing a video frame, to achieve the best audio-video synchronization.
2794
- >
1261
+ > 1. It is recommended to call the generateCustomPTS interface to get the timestamp value of the frame after capturing a video frame, to achieve the best audio-video synchronization.
1262
+ >
2795
1263
 
2796
- > 2. The final frame rate of the encoded video by the SDK is determined by the FPS you set in [setVideoEncoderParam](https://write.woa.com/document/87029900866228224), not by the frequency at which you call this interface.
2797
- >
1264
+ > 2. The final frame rate of the encoded video by the SDK is determined by the FPS you set in setVideoEncoderParam, not by the frequency at which you call this interface.
1265
+ >
2798
1266
 
2799
1267
  > 3. Please try to keep the intervals between calls to this interface uniform. Otherwise, it may cause unstable encoder output frame rates or audio-video asynchrony.
2800
- >
2801
-
1268
+ >
2802
1269
 
2803
1270
  ## enableCustomAudioCapture
2804
1271
 
2805
-
2806
-
2807
1272
  #### Enable Custom Audio Capturing Mode
2808
1273
 
2809
1274
  After enabling this mode, the SDK will no longer run the original audio capture process, meaning it will stop capturing audio data from the microphone and only retain audio encoding and sending capabilities.
2810
1275
 
2811
- You need to continuously feed the SDK with your own collected audio data through [sendCustomAudioData](https://write.woa.com/document/87029900866228224).
2812
- <table>
2813
- <tr>
2814
- <td rowspan="1" colSpan="1" >Parameters</td>
2815
-
2816
- <td rowspan="1" colSpan="1" >Description</td>
2817
- </tr>
2818
-
2819
- <tr>
2820
- <td rowspan="1" colSpan="1" >enable</td>
2821
-
2822
- <td rowspan="1" colSpan="1" >Whether to enable, default value: false.</td>
2823
- </tr>
2824
- </table>
2825
-
1276
+ You need to continuously feed the SDK with your own collected audio data through sendCustomAudioData.
1277
+ | Parameters | Description |
1278
+ | --- | --- |
1279
+ | enable | Whether to enable, default value: false. |
2826
1280
 
2827
1281
  > **Note**
2828
- >
1282
+ >
2829
1283
 
2830
1284
  > As Echo Cancellation (AEC) requires strict control over the timing of audio capture and playback, enabling custom audio capture may result in AEC capabilities becoming ineffective.
2831
- >
2832
-
1285
+ >
2833
1286
 
2834
1287
  ## sendCustomAudioData
2835
1288
 
2836
-
2837
-
2838
1289
  #### Submit Self-collected Audio Data to the SDK
2839
1290
 
2840
- Parameter [TRTCAudioFrame](https://write.woa.com/document/87029993616093184) is recommended to be filled as follows (other fields do not need to be filled):
1291
+ Parameter TRTCAudioFrame is recommended to be filled as follows (other fields do not need to be filled):
2841
1292
  - audioFormat: Audio data format, only supports TRTCAudioFrameFormatPCM.
2842
1293
 
2843
1294
  - data: Audio frame buffer. Audio frame data only supports PCM format, with frame lengths ranging from [5ms ~ 100ms]. A frame length of 20ms is recommended. Calculation method: [48000 sampling rate, mono channel frame length: 48000 × 0.02s × 1 × 16bit = 15360bit = 1920 bytes].
@@ -2846,76 +1297,40 @@ Parameter [TRTCAudioFrame](https://write.woa.com/document/87029993616093184) is
2846
1297
 
2847
1298
  - channel: Number of channels (if stereo, data is interleaved), mono: 1; stereo: 2.
2848
1299
 
2849
- - timestamp: Timestamp, in milliseconds (ms). Please use the timestamp recorded when the audio frame is captured (you can get the timestamp by calling [generateCustomPTS](https://write.woa.com/document/87029900866228224) after capturing an audio frame).
2850
-
2851
-
2852
-
1300
+ - timestamp: Timestamp, in milliseconds (ms). Please use the timestamp recorded when the audio frame is captured (you can get the timestamp by calling generateCustomPTS after capturing an audio frame).
2853
1301
 
2854
1302
  Refer to documentation: [Custom Collection and Rendering](https://cloud.tencent.com/document/product/647/74692).
2855
- <table>
2856
- <tr>
2857
- <td rowspan="1" colSpan="1" >Parameters</td>
2858
-
2859
- <td rowspan="1" colSpan="1" >Description</td>
2860
- </tr>
2861
-
2862
- <tr>
2863
- <td rowspan="1" colSpan="1" >frame</td>
2864
-
2865
- <td rowspan="1" colSpan="1" >Audio Data</td>
2866
- </tr>
2867
- </table>
2868
-
1303
+ | Parameters | Description |
1304
+ | --- | --- |
1305
+ | frame | Audio Data |
2869
1306
 
2870
1307
  > **Note**
2871
- >
1308
+ >
2872
1309
 
2873
1310
  > Please call this interface accurately at intervals corresponding to the duration of each frame. Feeding data at uneven intervals is likely to cause audio stutter.
2874
- >
2875
-
1311
+ >
2876
1312
 
2877
1313
  ## enableMixExternalAudioFrame
2878
1314
 
2879
-
2880
-
2881
1315
  #### Enable/Disable Custom Audio Track
2882
1316
 
2883
1317
  Once enabled, you can use this interface to mix a Custom Audio Track into the SDK. With two boolean parameters, you can control whether the track should play remotely and locally.
2884
- <table>
2885
- <tr>
2886
- <td rowspan="1" colSpan="1" >Parameters</td>
2887
-
2888
- <td rowspan="1" colSpan="1" >Description</td>
2889
- </tr>
2890
-
2891
- <tr>
2892
- <td rowspan="1" colSpan="1" >enablePlayout</td>
2893
-
2894
- <td rowspan="1" colSpan="1" >Control whether the mixed audio track should be played locally. Default value: false.</td>
2895
- </tr>
2896
-
2897
- <tr>
2898
- <td rowspan="1" colSpan="1" >enablePublish</td>
2899
-
2900
- <td rowspan="1" colSpan="1" >Control whether the mixed audio track should be played remotely. Default value: false.</td>
2901
- </tr>
2902
- </table>
2903
-
1318
+ | Parameters | Description |
1319
+ | --- | --- |
1320
+ | enablePlayout | Control whether the mixed audio track should be played locally. Default value: false. |
1321
+ | enablePublish | Control whether the mixed audio track should be played remotely. Default value: false. |
2904
1322
 
2905
1323
  > **Note**
2906
- >
1324
+ >
2907
1325
 
2908
1326
  > If you set both enablePublish and enablePlayout parameters to false, it means you completely disable your custom audio track.
2909
- >
2910
-
1327
+ >
2911
1328
 
2912
1329
  ## mixExternalAudioFrame
2913
1330
 
2914
-
2915
-
2916
1331
  #### Mix Custom Audio Track into the SDK
2917
1332
 
2918
- Before calling this interface, you need to enable the Custom Audio Track with [enableMixExternalAudioFrame](https://write.woa.com/document/87029900866228224) first. After that, you can use this interface to mix your own audio track into the SDK in PCM format.
1333
+ Before calling this interface, you need to enable the Custom Audio Track with enableMixExternalAudioFrame first. After that, you can use this interface to mix your own audio track into the SDK in PCM format.
2919
1334
 
2920
1335
  Ideally, we expect your code to provide track data to the SDK at a very consistent rate. However, we understand that maintaining perfect call intervals is a significant challenge.
2921
1336
 
@@ -2925,38 +1340,24 @@ The return value of this interface represents the size of this track buffer zone
2925
1340
 
2926
1341
  When you call this interface, if you find the return value > 100ms, you can wait for one frame of audio playback time before calling again; if the return value < 100ms, it means the buffer is relatively small, you can mix in some more audio track data to ensure the size of the audio track buffer remains above the "safe level".
2927
1342
 
2928
-
2929
-
2930
- Parameter [TRTCAudioFrame](https://write.woa.com/document/87029993616093184) is recommended to be filled as follows (other fields do not need to be filled):
1343
+ Parameter TRTCAudioFrame is recommended to be filled as follows (other fields do not need to be filled):
2931
1344
  - data: Audio frame buffer. Audio frame data only supports PCM format, with frame lengths ranging from [5ms ~ 100ms]. A frame length of 20ms is recommended. Calculation method: [48000 sampling rate, mono channel frame length: 48000 × 0.02s × 1 × 16bit = 15360bit = 1920 bytes].
2932
1345
 
2933
1346
  - sampleRate: Sampling rate, supported values are 16000, 24000, 32000, 44100, 48000.
2934
1347
 
2935
1348
  - channel: Number of channels (if stereo, data is interleaved), mono: 1; stereo: 2.
2936
1349
 
2937
- - timestamp: Timestamp, in milliseconds (ms). Please use the timestamp recorded when the audio frame is captured (you can get the timestamp by calling [generateCustomPTS](https://write.woa.com/document/87029900866228224) after capturing an audio frame).
2938
-
2939
- <table>
2940
- <tr>
2941
- <td rowspan="1" colSpan="1" >Parameters</td>
2942
-
2943
- <td rowspan="1" colSpan="1" >Description</td>
2944
- </tr>
2945
-
2946
- <tr>
2947
- <td rowspan="1" colSpan="1" >frame</td>
2948
-
2949
- <td rowspan="1" colSpan="1" >Audio Data</td>
2950
- </tr>
2951
- </table>
1350
+ - timestamp: Timestamp, in milliseconds (ms). Please use the timestamp recorded when the audio frame is captured (you can get the timestamp by calling generateCustomPTS after capturing an audio frame).
2952
1351
 
1352
+ | Parameters | Description |
1353
+ | --- | --- |
1354
+ | frame | Audio Data |
2953
1355
 
2954
1356
  > **Note**
2955
- >
1357
+ >
2956
1358
 
2957
1359
  > Please call this interface accurately at intervals corresponding to the duration of each frame. Feeding data at uneven intervals is likely to cause audio stutter.
2958
- >
2959
-
1360
+ >
2960
1361
 
2961
1362
  #### Return value description:
2962
1363
 
@@ -2964,47 +1365,25 @@ Parameter [TRTCAudioFrame](https://write.woa.com/document/87029993616093184) is
2964
1365
 
2965
1366
  ## setMixExternalAudioVolume
2966
1367
 
2967
-
2968
-
2969
1368
  #### Set the Streaming Volume and Playback Volume for External Audio Mixed During Streaming
2970
- <table>
2971
- <tr>
2972
- <td rowspan="1" colSpan="1" >Parameters</td>
2973
-
2974
- <td rowspan="1" colSpan="1" >Description</td>
2975
- </tr>
2976
-
2977
- <tr>
2978
- <td rowspan="1" colSpan="1" >playoutVolume</td>
2979
-
2980
- <td rowspan="1" colSpan="1" >Set the playback volume level, ranging from 0 to 100. -1 means no change.</td>
2981
- </tr>
2982
-
2983
- <tr>
2984
- <td rowspan="1" colSpan="1" >publishVolume</td>
2985
-
2986
- <td rowspan="1" colSpan="1" >Set the streaming volume level, ranging from 0 to 100. -1 means no change.</td>
2987
- </tr>
2988
- </table>
2989
-
1369
+ | Parameters | Description |
1370
+ | --- | --- |
1371
+ | playoutVolume | Set the playback volume level, ranging from 0 to 100. -1 means no change. |
1372
+ | publishVolume | Set the streaming volume level, ranging from 0 to 100. -1 means no change. |
2990
1373
 
2991
1374
  ## generateCustomPTS
2992
1375
 
2993
-
2994
-
2995
1376
  #### Generate Timestamp for Custom Capturing
2996
1377
 
2997
1378
  This interface is only applicable to custom capturing mode, used to solve the issue of audio and video out of sync caused by the discrepancy between capture time and delivery time.
2998
1379
 
2999
-
3000
-
3001
- When you use interfaces such as [sendCustomVideoData](https://write.woa.com/document/87029900866228224) or [sendCustomAudioData](https://write.woa.com/document/87029900866228224) for custom video or audio capturing, please follow these steps to use this interface:
1380
+ When you use interfaces such as sendCustomVideoData or sendCustomAudioData for custom video or audio capturing, please follow these steps to use this interface:
3002
1381
 
3003
1382
  1. First, when capturing a video or audio frame, call this interface to obtain the PTS timestamp of that moment.
3004
1383
 
3005
1384
  2. Then, you can send the video or audio frame to the preprocessing module you use (such as third-party beauty components or third-party audio effect components).
3006
1385
 
3007
- 3. When actually calling [sendCustomVideoData](https://write.woa.com/document/87029900866228224) or [sendCustomAudioData](https://write.woa.com/document/87029900866228224) for streaming, please assign the PTS timestamp recorded during capture to the timestamp field in [TRTCVideoFrame](https://write.woa.com/document/87029993616093184) or [TRTCAudioFrame](https://write.woa.com/document/87029993616093184).
1386
+ 3. When actually calling sendCustomVideoData or sendCustomAudioData for streaming, please assign the PTS timestamp recorded during capture to the timestamp field in TRTCVideoFrame or TRTCAudioFrame.
3008
1387
 
3009
1388
  #### Return value description:
3010
1389
 
@@ -3012,37 +1391,14 @@ Timestamp (unit: ms)
3012
1391
 
3013
1392
  ## setLocalVideoProcessListener
3014
1393
 
3015
-
3016
-
3017
1394
  #### Set Video Data Callback for Third-party Beauty Filter
3018
1395
 
3019
1396
  After setting this callback, the SDK will pass the collected video frames to the listener you set for third-party beauty filter components for secondary processing. After that, the SDK will encode and send the processed video frames.
3020
- <table>
3021
- <tr>
3022
- <td rowspan="1" colSpan="1" >Parameters</td>
3023
-
3024
- <td rowspan="1" colSpan="1" >Description</td>
3025
- </tr>
3026
-
3027
- <tr>
3028
- <td rowspan="1" colSpan="1" >bufferType</td>
3029
-
3030
- <td rowspan="1" colSpan="1" >Specify the data format for the callback. Currently supported:<br>- [TRTC_VIDEO_BUFFER_TYPE_TEXTURE](https://write.woa.com/document/87029993616093184): Suitable when pixelFormat is set to [TRTC_VIDEO_PIXEL_FORMAT_Texture_2D](https://write.woa.com/document/87029993616093184).<br>- [TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER](https://write.woa.com/document/87029993616093184): Suitable when pixelFormat is set to [TRTC_VIDEO_PIXEL_FORMAT_I420](https://write.woa.com/document/87029993616093184).<br>- [TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY](https://write.woa.com/document/87029993616093184): Suitable when pixelFormat is set to [TRTC_VIDEO_PIXEL_FORMAT_I420](https://write.woa.com/document/87029993616093184).</td>
3031
- </tr>
3032
-
3033
- <tr>
3034
- <td rowspan="1" colSpan="1" >listener</td>
3035
-
3036
- <td rowspan="1" colSpan="1" >Custom pre-processing callback, see [TRTCVideoFrameListener](https://write.woa.com/document/87029920275542016) for details.</td>
3037
- </tr>
3038
-
3039
- <tr>
3040
- <td rowspan="1" colSpan="1" >pixelFormat</td>
3041
-
3042
- <td rowspan="1" colSpan="1" >Specify the pixel format for the callback. Currently supported:<br>- [TRTC_VIDEO_PIXEL_FORMAT_Texture_2D](https://write.woa.com/document/87029993616093184): Graphics Memory Texture Solution.<br>- [TRTC_VIDEO_PIXEL_FORMAT_I420](https://write.woa.com/document/87029993616093184): Memory Data Solution.</td>
3043
- </tr>
3044
- </table>
3045
-
1397
+ | Parameters | Description |
1398
+ | --- | --- |
1399
+ | bufferType | Specify the data format for the callback. Currently supported:<br>- TRTC_VIDEO_BUFFER_TYPE_TEXTURE: Suitable when pixelFormat is set to TRTC_VIDEO_PIXEL_FORMAT_Texture_2D.<br>- TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER: Suitable when pixelFormat is set to TRTC_VIDEO_PIXEL_FORMAT_I420.<br>- TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY: Suitable when pixelFormat is set to TRTC_VIDEO_PIXEL_FORMAT_I420. |
1400
+ | listener | Custom pre-processing callback, see TRTCVideoFrameListener for details. |
1401
+ | pixelFormat | Specify the pixel format for the callback. Currently supported:<br>- TRTC_VIDEO_PIXEL_FORMAT_Texture_2D: Graphics Memory Texture Solution.<br>- TRTC_VIDEO_PIXEL_FORMAT_I420: Memory Data Solution. |
3046
1402
 
3047
1403
  #### Return value description:
3048
1404
 
@@ -3050,8 +1406,6 @@ After setting this callback, the SDK will pass the collected video frames to the
3050
1406
 
3051
1407
  ## setLocalVideoRenderListener
3052
1408
 
3053
-
3054
-
3055
1409
  #### Set Local Video Custom Rendering Callback
3056
1410
 
3057
1411
  After setting this callback, the SDK will skip the original rendering process and return the captured data. You need to handle the rendering yourself.
@@ -3059,36 +1413,12 @@ After setting this callback, the SDK will skip the original rendering process an
3059
1413
 
3060
1414
  - bufferType specifies the type of buffer. BYTE_BUFFER is suitable for use in the JNI layer, while BYTE_ARRAY can be used for direct operations in the Java layer.
3061
1415
 
3062
-
3063
-
3064
-
3065
1416
  Refer to documentation: [Custom Collection and Rendering](https://cloud.tencent.com/document/product/647/34066).
3066
- <table>
3067
- <tr>
3068
- <td rowspan="1" colSpan="1" >Parameters</td>
3069
-
3070
- <td rowspan="1" colSpan="1" >Description</td>
3071
- </tr>
3072
-
3073
- <tr>
3074
- <td rowspan="1" colSpan="1" >bufferType</td>
3075
-
3076
- <td rowspan="1" colSpan="1" >Specify the data structure of the video frame:<br>- [TRTC_VIDEO_BUFFER_TYPE_TEXTURE](https://write.woa.com/document/87029993616093184): Suitable when pixelFormat is set to [TRTC_VIDEO_PIXEL_FORMAT_Texture_2D](https://write.woa.com/document/87029993616093184).<br>- [TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER](https://write.woa.com/document/87029993616093184): Suitable when pixelFormat is set to [TRTC_VIDEO_PIXEL_FORMAT_I420](https://write.woa.com/document/87029993616093184) and [TRTC_VIDEO_PIXEL_FORMAT_RGBA](https://write.woa.com/document/87029993616093184).<br>- [TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY](https://write.woa.com/document/87029993616093184): Suitable when pixelFormat is set to [TRTC_VIDEO_PIXEL_FORMAT_I420](https://write.woa.com/document/87029993616093184) and [TRTC_VIDEO_PIXEL_FORMAT_RGBA](https://write.woa.com/document/87029993616093184).</td>
3077
- </tr>
3078
-
3079
- <tr>
3080
- <td rowspan="1" colSpan="1" >listener</td>
3081
-
3082
- <td rowspan="1" colSpan="1" >Custom video rendering callback, each video frame triggers a callback.</td>
3083
- </tr>
3084
-
3085
- <tr>
3086
- <td rowspan="1" colSpan="1" >pixelFormat</td>
3087
-
3088
- <td rowspan="1" colSpan="1" >Specify the pixel format of the video frame, such as:<br>- [TRTC_VIDEO_PIXEL_FORMAT_Texture_2D](https://write.woa.com/document/87029993616093184): OpenGL texture format, more suitable for GPU processing, high processing efficiency.<br>- [TRTC_VIDEO_PIXEL_FORMAT_I420](https://write.woa.com/document/87029993616093184): Standard I420 format, more suitable for CPU processing, low processing efficiency.<br>- [TRTC_VIDEO_PIXEL_FORMAT_RGBA](https://write.woa.com/document/87029993616093184): RGBA format, more suitable for CPU processing, low processing efficiency.</td>
3089
- </tr>
3090
- </table>
3091
-
1417
+ | Parameters | Description |
1418
+ | --- | --- |
1419
+ | bufferType | Specify the data structure of the video frame:<br>- TRTC_VIDEO_BUFFER_TYPE_TEXTURE: Suitable when pixelFormat is set to TRTC_VIDEO_PIXEL_FORMAT_Texture_2D.<br>- TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER: Suitable when pixelFormat is set to TRTC_VIDEO_PIXEL_FORMAT_I420 and TRTC_VIDEO_PIXEL_FORMAT_RGBA.<br>- TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY: Suitable when pixelFormat is set to TRTC_VIDEO_PIXEL_FORMAT_I420 and TRTC_VIDEO_PIXEL_FORMAT_RGBA. |
1420
+ | listener | Custom video rendering callback, each video frame triggers a callback. |
1421
+ | pixelFormat | Specify the pixel format of the video frame, such as:<br>- TRTC_VIDEO_PIXEL_FORMAT_Texture_2D: OpenGL texture format, more suitable for GPU processing, high processing efficiency.<br>- TRTC_VIDEO_PIXEL_FORMAT_I420: Standard I420 format, more suitable for CPU processing, low processing efficiency.<br>- TRTC_VIDEO_PIXEL_FORMAT_RGBA: RGBA format, more suitable for CPU processing, low processing efficiency. |
3092
1422
 
3093
1423
  #### Return value description:
3094
1424
 
@@ -3096,8 +1426,6 @@ Refer to documentation: [Custom Collection and Rendering](https://cloud.tencent.
3096
1426
 
3097
1427
  ## setRemoteVideoRenderListener
3098
1428
 
3099
-
3100
-
3101
1429
  #### Sets the rendering callback for remote video self-definition
3102
1430
 
3103
1431
  After setting this callback, the SDK will skip the original rendering process and return the captured data. You need to handle the rendering yourself.
@@ -3105,49 +1433,19 @@ After setting this callback, the SDK will skip the original rendering process an
3105
1433
 
3106
1434
  - bufferType specifies the type of buffer. Using PixelBuffer has the highest efficiency; using NSData involves an internal memory conversion within the SDK, resulting in additional performance loss.
3107
1435
 
3108
-
3109
-
3110
-
3111
1436
  Refer to documentation: [Custom Collection and Rendering](https://cloud.tencent.com/document/product/647/34066).
3112
- <table>
3113
- <tr>
3114
- <td rowspan="1" colSpan="1" >Parameters</td>
3115
-
3116
- <td rowspan="1" colSpan="1" >Description</td>
3117
- </tr>
3118
-
3119
- <tr>
3120
- <td rowspan="1" colSpan="1" >bufferType</td>
3121
-
3122
- <td rowspan="1" colSpan="1" >Specify the data structure of the video frame, such as [TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER](https://write.woa.com/document/87029993616093184), [TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY](https://write.woa.com/document/87029993616093184).</td>
3123
- </tr>
3124
-
3125
- <tr>
3126
- <td rowspan="1" colSpan="1" >listener</td>
3127
-
3128
- <td rowspan="1" colSpan="1" >Custom video rendering callback, each video frame triggers a callback.</td>
3129
- </tr>
3130
-
3131
- <tr>
3132
- <td rowspan="1" colSpan="1" >pixelFormat</td>
3133
-
3134
- <td rowspan="1" colSpan="1" >Specify the pixel format of the video frame. Currently supports [TRTC_VIDEO_PIXEL_FORMAT_I420](https://write.woa.com/document/87029993616093184), [TRTC_VIDEO_PIXEL_FORMAT_RGBA](https://write.woa.com/document/87029993616093184).</td>
3135
- </tr>
3136
-
3137
- <tr>
3138
- <td rowspan="1" colSpan="1" >userId</td>
3139
-
3140
- <td rowspan="1" colSpan="1" >Specify the remote user's ID.</td>
3141
- </tr>
3142
- </table>
3143
-
1437
+ | Parameters | Description |
1438
+ | --- | --- |
1439
+ | bufferType | Specify the data structure of the video frame, such as TRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER, TRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY. |
1440
+ | listener | Custom video rendering callback, each video frame triggers a callback. |
1441
+ | pixelFormat | Specify the pixel format of the video frame. Currently supports TRTC_VIDEO_PIXEL_FORMAT_I420, TRTC_VIDEO_PIXEL_FORMAT_RGBA. |
1442
+ | userId | Specify the remote user's ID. |
3144
1443
 
3145
1444
  > **Note**
3146
- >
1445
+ >
3147
1446
 
3148
1447
  > In actual use, you need to first call startRemoteView(userid, null) to start the remote video stream pulling and set view to null; otherwise, no data callback will occur.
3149
- >
3150
-
1448
+ >
3151
1449
 
3152
1450
  #### Return value description:
3153
1451
 
@@ -3155,67 +1453,46 @@ Refer to documentation: [Custom Collection and Rendering](https://cloud.tencent.
3155
1453
 
3156
1454
  ## setAudioFrameListener
3157
1455
 
3158
-
3159
-
3160
1456
  #### Sets the audio data self-definition callback
3161
1457
 
3162
1458
  After setting this callback, the SDK will internally callback the audio data (PCM format), including:
3163
- - [onCapturedAudioFrame](https://write.woa.com/document/87029920275542016): Audio data callback captured by the local microphone
1459
+ - onCapturedAudioFrame: Audio data callback captured by the local microphone
3164
1460
 
3165
- - [onLocalProcessedAudioFrame](https://write.woa.com/document/87029920275542016): Audio data callback captured locally and preprocessed by the audio module
1461
+ - onLocalProcessedAudioFrame: Audio data callback captured locally and preprocessed by the audio module
3166
1462
 
3167
- - [onRemoteUserAudioFrame](https://write.woa.com/document/87029920275542016): Audio data of each remote user before mixing
3168
-
3169
- - [onMixedPlayAudioFrame](https://write.woa.com/document/87029920275542016): Audio data callback after mixing various audio streams and finally to be played by the system
1463
+ - onRemoteUserAudioFrame: Audio data of each remote user before mixing
3170
1464
 
1465
+ - onMixedPlayAudioFrame: Audio data callback after mixing various audio streams and finally to be played by the system
3171
1466
 
3172
1467
  > **Note**
3173
- >
1468
+ >
3174
1469
 
3175
1470
  > Setting the callback to null means stopping the Definition audio callback; vice versa, setting the callback to non-null means starting the Definition audio callback.
3176
- >
3177
-
1471
+ >
3178
1472
 
3179
1473
  ## setCapturedAudioFrameCallbackFormat
3180
1474
 
3181
-
3182
-
3183
1475
  #### Sets the callback format for audio frames captured by the local microphone
3184
1476
 
3185
- This interface is used to set the format of the AudioFrame callback for [onCapturedAudioFrame](https://write.woa.com/document/87029920275542016):
1477
+ This interface is used to set the format of the AudioFrame callback for onCapturedAudioFrame:
3186
1478
  - sampleRate: Sampling rate, supported values are 16000, 32000, 44100, 48000.
3187
1479
 
3188
1480
  - channel: Number of channels (if stereo, data is interleaved), mono: 1; stereo: 2.
3189
1481
 
3190
1482
  - samplesPerCall: Number of sampling points, Definition callback data frame length. The frame length must be an integer multiple of 10ms.
3191
1483
 
3192
-
3193
-
3194
-
3195
1484
  If you want to calculate the callback frame length in milliseconds, the formula to convert milliseconds to sampling points is: sampling points = milliseconds * sampling rate / 1000.
3196
1485
 
3197
1486
  Example: For a 48000 sampling rate and a desired callback frame length of 20ms, the number of sampling points should be: 960 = 20 * 48000 / 1000.
3198
- <table>
3199
- <tr>
3200
- <td rowspan="1" colSpan="1" >Parameters</td>
3201
-
3202
- <td rowspan="1" colSpan="1" >Description</td>
3203
- </tr>
3204
-
3205
- <tr>
3206
- <td rowspan="1" colSpan="1" >format</td>
3207
-
3208
- <td rowspan="1" colSpan="1" >Audio Data Callback Format.</td>
3209
- </tr>
3210
- </table>
3211
-
1487
+ | Parameters | Description |
1488
+ | --- | --- |
1489
+ | format | Audio Data Callback Format. |
3212
1490
 
3213
1491
  > **Note**
3214
- >
1492
+ >
3215
1493
 
3216
1494
  > The final callback frame length is in bytes. The formula to convert sampling points to bytes is: Byte Count = Sampling Points * Channels * 2 (Bit Width). Example: For a 48000 sampling rate, stereo, and 20ms frame length, the number of sampling points is 960, and the byte count is 3840 = 960 * 2 * 2
3217
- >
3218
-
1495
+ >
3219
1496
 
3220
1497
  #### Return value description:
3221
1498
 
@@ -3223,44 +1500,27 @@ Example: For a 48000 sampling rate and a desired callback frame length of 20ms,
3223
1500
 
3224
1501
  ## setLocalProcessedAudioFrameCallbackFormat
3225
1502
 
3226
-
3227
-
3228
1503
  #### Sets the callback format for local audio frames after preprocessing
3229
1504
 
3230
- This interface is used to set the format of the AudioFrame callback for [onLocalProcessedAudioFrame](https://write.woa.com/document/87029920275542016):
1505
+ This interface is used to set the format of the AudioFrame callback for onLocalProcessedAudioFrame:
3231
1506
  - sampleRate: Sampling rate, supported values are 16000, 32000, 44100, 48000.
3232
1507
 
3233
1508
  - channel: Number of channels (if stereo, data is interleaved), mono: 1; stereo: 2.
3234
1509
 
3235
1510
  - samplesPerCall: Number of sampling points, Definition callback data frame length. The frame length must be an integer multiple of 10ms.
3236
1511
 
3237
-
3238
-
3239
-
3240
1512
  If you want to calculate the callback frame length in milliseconds, the formula to convert milliseconds to sampling points is: sampling points = milliseconds * sampling rate / 1000.
3241
1513
 
3242
1514
  Example: For a 48000 sampling rate and a desired callback frame length of 20ms, the number of sampling points should be: 960 = 20 * 48000 / 1000.
3243
- <table>
3244
- <tr>
3245
- <td rowspan="1" colSpan="1" >Parameters</td>
3246
-
3247
- <td rowspan="1" colSpan="1" >Description</td>
3248
- </tr>
3249
-
3250
- <tr>
3251
- <td rowspan="1" colSpan="1" >format</td>
3252
-
3253
- <td rowspan="1" colSpan="1" >Audio Data Callback Format.</td>
3254
- </tr>
3255
- </table>
3256
-
1515
+ | Parameters | Description |
1516
+ | --- | --- |
1517
+ | format | Audio Data Callback Format. |
3257
1518
 
3258
1519
  > **Note**
3259
- >
1520
+ >
3260
1521
 
3261
1522
  > The final callback frame length is in bytes. The formula to convert sampling points to bytes is: Byte Count = Sampling Points * Channels * 2 (Bit Width). Example: For a 48000 sampling rate, stereo, and 20ms frame length, the number of sampling points is 960, and the byte count is 3840 = 960 * 2 * 2
3262
- >
3263
-
1523
+ >
3264
1524
 
3265
1525
  #### Return value description:
3266
1526
 
@@ -3268,44 +1528,27 @@ Example: For a 48000 sampling rate and a desired callback frame length of 20ms,
3268
1528
 
3269
1529
  ## setMixedPlayAudioFrameCallbackFormat
3270
1530
 
3271
-
3272
-
3273
1531
  #### Sets the callback format for audio frames that will eventually be played by the system
3274
1532
 
3275
- This interface is used to set the format of the AudioFrame callback for [onMixedPlayAudioFrame](https://write.woa.com/document/87029920275542016):
1533
+ This interface is used to set the format of the AudioFrame callback for onMixedPlayAudioFrame:
3276
1534
  - sampleRate: Sampling rate, supported values are 16000, 32000, 44100, 48000.
3277
1535
 
3278
1536
  - channel: Number of channels (if stereo, data is interleaved), mono: 1; stereo: 2.
3279
1537
 
3280
1538
  - samplesPerCall: Number of sampling points, Definition callback data frame length. The frame length must be an integer multiple of 10ms.
3281
1539
 
3282
-
3283
-
3284
-
3285
1540
  If you want to calculate the callback frame length in milliseconds, the formula to convert milliseconds to sampling points is: sampling points = milliseconds * sampling rate / 1000.
3286
1541
 
3287
1542
  Example: For a 48000 sampling rate and a desired callback frame length of 20ms, the number of sampling points should be: 960 = 20 * 48000 / 1000.
3288
- <table>
3289
- <tr>
3290
- <td rowspan="1" colSpan="1" >Parameters</td>
3291
-
3292
- <td rowspan="1" colSpan="1" >Description</td>
3293
- </tr>
3294
-
3295
- <tr>
3296
- <td rowspan="1" colSpan="1" >format</td>
3297
-
3298
- <td rowspan="1" colSpan="1" >Audio Data Callback Format.</td>
3299
- </tr>
3300
- </table>
3301
-
1543
+ | Parameters | Description |
1544
+ | --- | --- |
1545
+ | format | Audio Data Callback Format. |
3302
1546
 
3303
1547
  > **Note**
3304
- >
1548
+ >
3305
1549
 
3306
1550
  > The final callback frame length is in bytes. The formula to convert sampling points to bytes is: Byte Count = Sampling Points * Channels * 2 (Bit Width). Example: For a 48000 sampling rate, stereo, and 20ms frame length, the number of sampling points is 960, and the byte count is 3840 = 960 * 2 * 2
3307
- >
3308
-
1551
+ >
3309
1552
 
3310
1553
  #### Return value description:
3311
1554
 
@@ -3313,147 +1556,85 @@ Example: For a 48000 sampling rate and a desired callback frame length of 20ms,
3313
1556
 
3314
1557
  ## enableCustomAudioRendering
3315
1558
 
3316
-
3317
-
3318
1559
  #### Enable self-definition audio playback
3319
1560
 
3320
1561
  If you need to connect specific audio devices or want to control the audio playback logic yourself, you can enable Custom Playback through this interface.
3321
1562
 
3322
- After enabling Custom Playback, the SDK will no longer use the system's audio interface to play data. You need to get the audio frame that the SDK wants to play through [getCustomAudioRenderingFrame](https://write.woa.com/document/87029900866228224) and play it yourself.
3323
- <table>
3324
- <tr>
3325
- <td rowspan="1" colSpan="1" >Parameters</td>
3326
-
3327
- <td rowspan="1" colSpan="1" >Description</td>
3328
- </tr>
3329
-
3330
- <tr>
3331
- <td rowspan="1" colSpan="1" >enable</td>
3332
-
3333
- <td rowspan="1" colSpan="1" >Whether to enable Custom Playback is off by default.</td>
3334
- </tr>
3335
- </table>
3336
-
1563
+ After enabling Custom Playback, the SDK will no longer use the system's audio interface to play data. You need to get the audio frame that the SDK wants to play through getCustomAudioRenderingFrame and play it yourself.
1564
+ | Parameters | Description |
1565
+ | --- | --- |
1566
+ | enable | Whether to enable Custom Playback is off by default. |
3337
1567
 
3338
1568
  > **Note**
3339
- >
1569
+ >
3340
1570
 
3341
1571
  > You need to set it before entering the room for it to take effect. It is not supported to set it after entering the room.
3342
- >
3343
-
1572
+ >
3344
1573
 
3345
1574
  ## getCustomAudioRenderingFrame
3346
1575
 
3347
-
3348
-
3349
1576
  #### Get playable audio data
3350
1577
 
3351
- Before calling this interface, you need to enable Custom Playback through [enableCustomAudioRendering](https://write.woa.com/document/87029900866228224) first.
3352
-
1578
+ Before calling this interface, you need to enable Custom Playback through enableCustomAudioRendering first.
3353
1579
 
3354
-
3355
- Parameter [TRTCAudioFrame](https://write.woa.com/document/87029993616093184) is recommended to be filled as follows (other fields do not need to be filled):
1580
+ Parameter TRTCAudioFrame is recommended to be filled as follows (other fields do not need to be filled):
3356
1581
  - sampleRate: Sampling rate, required, supported values are 16000, 24000, 32000, 44100, 48000.
3357
1582
 
3358
1583
  - channel: Number of channels, required. Fill in 1 for mono, 2 for stereo. The data is interleaved for stereo.
3359
1584
 
3360
1585
  - data: Buffer for obtaining audio data. You need to allocate the memory size of data according to the frame length of an audio frame. The obtained PCM data supports frame lengths of 10ms or 20ms. It is recommended to use a frame length of 20ms.
3361
1586
 
3362
-
3363
-
3364
-
3365
1587
  Calculation formula: Sampling rate x Playback duration x Number of channels x 2 (bytes per sample). For example, for a frame of audio with a sampling rate of 48000, mono channel, and a playback duration of 20ms, the buffer size is 48000 × 0.02s × 1 × 16bit = 15360bit = 1920 bytes.
3366
- <table>
3367
- <tr>
3368
- <td rowspan="1" colSpan="1" >Parameters</td>
3369
-
3370
- <td rowspan="1" colSpan="1" >Description</td>
3371
- </tr>
3372
-
3373
- <tr>
3374
- <td rowspan="1" colSpan="1" >audioFrame</td>
3375
-
3376
- <td rowspan="1" colSpan="1" >Audio data frame.</td>
3377
- </tr>
3378
- </table>
3379
-
1588
+ | Parameters | Description |
1589
+ | --- | --- |
1590
+ | audioFrame | Audio data frame. |
3380
1591
 
3381
1592
  > **Note**
3382
- >
1593
+ >
3383
1594
 
3384
1595
  > 1. Parameters sampleRate and channel in audioFrame should be set in advance, and the data space required for the frame length to be read should be allocated.
3385
- >
1596
+ >
3386
1597
 
3387
1598
  > 2. The SDK will automatically fill the data according to sampleRate and channel.
3388
- >
1599
+ >
3389
1600
 
3390
1601
  > 3. It is recommended to call this function driven by the system's audio playback thread. After playing one frame of audio, call this API to get the next playable frame of audio data.
3391
- >
3392
-
1602
+ >
3393
1603
 
3394
1604
  ## sendCustomCmdMsg
3395
1605
 
3396
-
3397
-
3398
1606
  #### Sends a custom message using UDP channel to all users in a room
3399
1607
 
3400
1608
  This interface allows you to use TRTC's UDP Channel to broadcast custom data to other users in the room, achieving the purpose of transmitting signaling.
3401
1609
 
3402
- Other users in the room can receive messages through the onRecvCustomCmdMsg callback in [TRTCCloudListener](https://write.woa.com/document/87029920275542016).
3403
- <table>
3404
- <tr>
3405
- <td rowspan="1" colSpan="1" >Parameters</td>
3406
-
3407
- <td rowspan="1" colSpan="1" >Description</td>
3408
- </tr>
3409
-
3410
- <tr>
3411
- <td rowspan="1" colSpan="1" >cmdID</td>
3412
-
3413
- <td rowspan="1" colSpan="1" >Message ID, the value range is 1 - 10.</td>
3414
- </tr>
3415
-
3416
- <tr>
3417
- <td rowspan="1" colSpan="1" >data</td>
3418
-
3419
- <td rowspan="1" colSpan="1" >Message to be sent, the maximum length of a single message is limited to 1KB.</td>
3420
- </tr>
3421
-
3422
- <tr>
3423
- <td rowspan="1" colSpan="1" >ordered</td>
3424
-
3425
- <td rowspan="1" colSpan="1" >Whether orderly sending is enabled, i.e., whether the order of data packets at the receiver matches the order at the sender (this will cause some reception delay).</td>
3426
- </tr>
3427
-
3428
- <tr>
3429
- <td rowspan="1" colSpan="1" >reliable</td>
3430
-
3431
- <td rowspan="1" colSpan="1" >Whether reliable transmission is enabled. Reliable transmission offers a higher success rate but will cause higher reception delays compared to unreliable transmission.</td>
3432
- </tr>
3433
- </table>
3434
-
1610
+ Other users in the room can receive messages through the onRecvCustomCmdMsg callback in TRTCCloudListener.
1611
+ | Parameters | Description |
1612
+ | --- | --- |
1613
+ | cmdID | Message ID, the value range is 1 - 10. |
1614
+ | data | Message to be sent, the maximum length of a single message is limited to 1KB. |
1615
+ | ordered | Whether orderly sending is enabled, i.e., whether the order of data packets at the receiver matches the order at the sender (this will cause some reception delay). |
1616
+ | reliable | Whether reliable transmission is enabled. Reliable transmission offers a higher success rate but will cause higher reception delays compared to unreliable transmission. |
3435
1617
 
3436
1618
  > **Note**
3437
- >
1619
+ >
3438
1620
 
3439
1621
  > 1. Sending messages to all users in the room (currently not supporting Web/Mini program end), up to 30 messages per second.
3440
- >
1622
+ >
3441
1623
 
3442
1624
  > 2. Each data packet can be up to 1KB. If it exceeds this size, it is very likely to be discarded by intermediate routers or servers.
3443
- >
1625
+ >
3444
1626
 
3445
1627
  > 3. Each client can send up to 8 KB of data per second.
3446
- >
1628
+ >
3447
1629
 
3448
1630
  > Please set both reliable and ordered to true or both to false. Interleaved settings are not supported.
3449
- >
1631
+ >
3450
1632
 
3451
1633
  > 5. It is strongly recommended to set different types of messages with different cmdIDs. This can reduce message latency when ordering is required.
3452
- >
1634
+ >
3453
1635
 
3454
1636
  > 6. Currently, only anchor roles are supported.
3455
- >
3456
-
1637
+ >
3457
1638
 
3458
1639
  #### Return value description:
3459
1640
 
@@ -3461,70 +1642,47 @@ true: Message has been sent; false: Message sending failed.
3461
1642
 
3462
1643
  ## sendSEIMsg
3463
1644
 
3464
-
3465
-
3466
1645
  #### Sends a custom message using SEI channel to all users in a room
3467
1646
 
3468
1647
  This interface allows you to broadcast self-defined data to other users in the current room using TRTC's SEI channel to achieve signaling transmission.
3469
1648
 
3470
-
3471
-
3472
1649
  There is a header data block called SEI in the video frame header. The principle of this interface is to use this SEI header data block to embed the self-defined signaling you want to send, so it is sent out along with the video frame.
3473
1650
 
3474
- Therefore, compared to [sendCustomCmdMsg](https://write.woa.com/document/87029900866228224), signaling transmitted via the SEI channel has better compatibility: the signaling can be transmitted along with the video frame all the way to the live CDN.
1651
+ Therefore, compared to sendCustomCmdMsg, signaling transmitted via the SEI channel has better compatibility: the signaling can be transmitted along with the video frame all the way to the live CDN.
3475
1652
 
3476
1653
  However, because the data block in the video frame header cannot be too large, it is recommended to control the signaling size to just a few bytes when using this interface.
3477
1654
 
3478
-
3479
-
3480
1655
  The most common usage is to embed a self-defined timestamp (timestamp) into the video frame using this interface to achieve perfect alignment of messages and screen (e.g., in educational scenarios for aligning courseware and video signals).
3481
1656
 
3482
- Other users in the room can receive messages through the onRecvSEIMsg callback in [TRTCCloudListener](https://write.woa.com/document/87029920275542016).
3483
- <table>
3484
- <tr>
3485
- <td rowspan="1" colSpan="1" >Parameters</td>
3486
-
3487
- <td rowspan="1" colSpan="1" >Description</td>
3488
- </tr>
3489
-
3490
- <tr>
3491
- <td rowspan="1" colSpan="1" >data</td>
3492
-
3493
- <td rowspan="1" colSpan="1" >Data to be sent, which can contain up to 1 KB (1,000 bytes) of data</td>
3494
- </tr>
3495
-
3496
- <tr>
3497
- <td rowspan="1" colSpan="1" >repeatCount</td>
3498
-
3499
- <td rowspan="1" colSpan="1" >Number of data sends</td>
3500
- </tr>
3501
- </table>
3502
-
1657
+ Other users in the room can receive messages through the onRecvSEIMsg callback in TRTCCloudListener.
1658
+ | Parameters | Description |
1659
+ | --- | --- |
1660
+ | data | Data to be sent, which can contain up to 1 KB (1,000 bytes) of data |
1661
+ | repeatCount | Number of data sends |
3503
1662
 
3504
1663
  > **Note**
3505
- >
1664
+ >
3506
1665
 
3507
1666
  > This interface has the following limitations:
3508
- >
1667
+ >
3509
1668
 
3510
1669
  > 1. Data will not be sent immediately after the API invocation, but will be sent along with the next video frame.
3511
- >
1670
+ >
3512
1671
 
3513
1672
  > 2. Send messages to all users in the room, up to 30 messages per second (shared limit with sendCustomCmdMsg).
3514
- >
1673
+ >
3515
1674
 
3516
1675
  > 3. Each package is a maximum of 1 KB. Sending large amounts of data will increase the video bitrate and possibly cause reduced image quality or lag (shared limit with sendCustomCmdMsg).
3517
- >
1676
+ >
3518
1677
 
3519
1678
  > 4. Each client can send up to 8 KB of data per second (shared limit with sendCustomCmdMsg).
3520
- >
1679
+ >
3521
1680
 
3522
1681
  > 5. If multiple sends are specified (repeatCount > 1), the data will be sent with the subsequent repeatCount number of video frames, which will also increase the video bitrate.
3523
- >
1682
+ >
3524
1683
 
3525
1684
  > 6. If repeatCount > 1 and there are multiple sends, the onRecvSEIMsg callback may receive the same message multiple times, and deduplication is needed.
3526
- >
3527
-
1685
+ >
3528
1686
 
3529
1687
  #### Return value description:
3530
1688
 
@@ -3532,36 +1690,22 @@ true: Message has passed the restriction, waiting for subsequent video frame to
3532
1690
 
3533
1691
  ## startSpeedTest
3534
1692
 
3535
-
3536
-
3537
1693
  #### Start internet speed test (use before entering the room)
3538
- <table>
3539
- <tr>
3540
- <td rowspan="1" colSpan="1" >Parameters</td>
3541
-
3542
- <td rowspan="1" colSpan="1" >Description</td>
3543
- </tr>
3544
-
3545
- <tr>
3546
- <td rowspan="1" colSpan="1" >params</td>
3547
-
3548
- <td rowspan="1" colSpan="1" >Speed Test Options</td>
3549
- </tr>
3550
- </table>
3551
-
1694
+ | Parameters | Description |
1695
+ | --- | --- |
1696
+ | params | Speed Test Options |
3552
1697
 
3553
1698
  > **Note**
3554
- >
1699
+ >
3555
1700
 
3556
1701
  > 1. The speed test process will incur a small basic service fee. For details, refer to [Billing Overview > Basic Service](https://cloud.tencent.com/document/product/647/17157#.E5.9F.BA.E7.A1.80.E6.9C.8D.E5.8A.A1) documentation.
3557
- >
1702
+ >
3558
1703
 
3559
1704
  > 2. Please perform the internet speed test before entering the room. Conducting the test in the room will affect normal audio and video transmission and will also be inaccurate due to too much interference.
3560
- >
1705
+ >
3561
1706
 
3562
1707
  > 3. Only one internet speed test task is allowed to run at the same time.
3563
- >
3564
-
1708
+ >
3565
1709
 
3566
1710
  #### Return value description:
3567
1711
 
@@ -3569,84 +1713,39 @@ API Invocation Result, < 0: Failure
3569
1713
 
3570
1714
  ## stopSpeedTest
3571
1715
 
3572
-
3573
-
3574
1716
  #### Stops network speed testing
3575
1717
 
3576
1718
  ## getSDKVersion
3577
1719
 
3578
-
3579
-
3580
1720
  #### Obtains the SDK version.
3581
1721
 
3582
1722
  ## setLogLevel
3583
1723
 
3584
-
3585
-
3586
1724
  #### Sets the log output level.
3587
- <table>
3588
- <tr>
3589
- <td rowspan="1" colSpan="1" >Parameters</td>
3590
-
3591
- <td rowspan="1" colSpan="1" >Description</td>
3592
- </tr>
3593
-
3594
- <tr>
3595
- <td rowspan="1" colSpan="1" >level</td>
3596
-
3597
- <td rowspan="1" colSpan="1" >Refer to [TRTCLogLevel](https://write.woa.com/document/87029993616093184), default value: TRTCLogLevelNone</td>
3598
- </tr>
3599
- </table>
3600
-
1725
+ | Parameters | Description |
1726
+ | --- | --- |
1727
+ | level | Refer to TRTCLogLevel, default value: TRTCLogLevelNone |
3601
1728
 
3602
1729
  ## setConsoleEnabled
3603
1730
 
3604
-
3605
-
3606
1731
  #### Enables/Disables console log print.
3607
- <table>
3608
- <tr>
3609
- <td rowspan="1" colSpan="1" >Parameters</td>
3610
-
3611
- <td rowspan="1" colSpan="1" >Description</td>
3612
- </tr>
3613
-
3614
- <tr>
3615
- <td rowspan="1" colSpan="1" >enabled</td>
3616
-
3617
- <td rowspan="1" colSpan="1" >Specify whether to enable it. Default: Disabled.</td>
3618
- </tr>
3619
- </table>
3620
-
1732
+ | Parameters | Description |
1733
+ | --- | --- |
1734
+ | enabled | Specify whether to enable it. Default: Disabled. |
3621
1735
 
3622
1736
  ## setLogCompressEnabled
3623
1737
 
3624
-
3625
-
3626
1738
  #### Enables/Disables local log compression
3627
1739
 
3628
1740
  After enabling compression, the log storage volume is significantly reduced, but you need to use a Python script provided by Tencent Cloud to decompress and read it.
3629
1741
 
3630
1742
  After disabling compression, logs are stored in plaintext, which can be opened and read directly with Notepad but occupy more space.
3631
- <table>
3632
- <tr>
3633
- <td rowspan="1" colSpan="1" >Parameters</td>
3634
-
3635
- <td rowspan="1" colSpan="1" >Description</td>
3636
- </tr>
3637
-
3638
- <tr>
3639
- <td rowspan="1" colSpan="1" >enabled</td>
3640
-
3641
- <td rowspan="1" colSpan="1" >Specify whether to enable it. Default: Enabled</td>
3642
- </tr>
3643
- </table>
3644
-
1743
+ | Parameters | Description |
1744
+ | --- | --- |
1745
+ | enabled | Specify whether to enable it. Default: Enabled |
3645
1746
 
3646
1747
  ## setLogDirPath
3647
1748
 
3648
-
3649
-
3650
1749
  #### Sets the save path for local logs
3651
1750
 
3652
1751
  This interface allows you to change the default storage path of SDK local logs. The default local log storage locations are:
@@ -3656,127 +1755,61 @@ This interface allows you to change the default storage path of SDK local logs.
3656
1755
 
3657
1756
  - Android platform: /app private directory/files/log/liteav/.
3658
1757
 
3659
- <table>
3660
- <tr>
3661
- <td rowspan="1" colSpan="1" >Parameters</td>
3662
-
3663
- <td rowspan="1" colSpan="1" >Description</td>
3664
- </tr>
3665
-
3666
- <tr>
3667
- <td rowspan="1" colSpan="1" >path</td>
3668
-
3669
- <td rowspan="1" colSpan="1" >Storage path for logs</td>
3670
- </tr>
3671
- </table>
3672
-
1758
+ | Parameters | Description |
1759
+ | --- | --- |
1760
+ | path | Storage path for logs |
3673
1761
 
3674
1762
  > **Note**
3675
- >
1763
+ >
3676
1764
 
3677
1765
  > Make sure to call this before all other interfaces and ensure that the specified directory exists and that your application has read and write permissions for that directory.
3678
- >
3679
-
1766
+ >
3680
1767
 
3681
1768
  ## setLogListener
3682
1769
 
3683
-
3684
-
3685
1770
  #### Log callback
3686
1771
 
3687
1772
  ## showDebugView
3688
1773
 
3689
-
3690
-
3691
1774
  #### Show Dashboard
3692
1775
 
3693
1776
  The "Dashboard" is a semi-transparent debug information overlay located above the video rendering control, used to display audio and video information and event information, aiding in integration and debugging.
3694
- <table>
3695
- <tr>
3696
- <td rowspan="1" colSpan="1" >Parameters</td>
3697
-
3698
- <td rowspan="1" colSpan="1" >Description</td>
3699
- </tr>
3700
-
3701
- <tr>
3702
- <td rowspan="1" colSpan="1" >showType</td>
3703
-
3704
- <td rowspan="1" colSpan="1" >0: Do not display; 1: Display simplified edition (audio and video information only); 2: Display full version (including audio and video information and event information).</td>
3705
- </tr>
3706
- </table>
3707
-
1777
+ | Parameters | Description |
1778
+ | --- | --- |
1779
+ | showType | 0: Do not display; 1: Display simplified edition (audio and video information only); 2: Display full version (including audio and video information and event information). |
3708
1780
 
3709
1781
  ## TRTCViewMargin
3710
1782
 
3711
-
3712
-
3713
1783
  #### Set the dashboard margin
3714
1784
 
3715
1785
  Used to adjust the position of the dashboard within the video rendering control. Must be called before showDebugView to take effect.
3716
- <table>
3717
- <tr>
3718
- <td rowspan="1" colSpan="1" >Parameters</td>
3719
-
3720
- <td rowspan="1" colSpan="1" >Description</td>
3721
- </tr>
3722
-
3723
- <tr>
3724
- <td rowspan="1" colSpan="1" >margin</td>
3725
-
3726
- <td rowspan="1" colSpan="1" >Dashboard inner padding. Note that here it is based on the percentage of the parentView. Margin value range is 0 - 1.</td>
3727
- </tr>
3728
-
3729
- <tr>
3730
- <td rowspan="1" colSpan="1" >userId</td>
3731
-
3732
- <td rowspan="1" colSpan="1" >User ID.</td>
3733
- </tr>
3734
- </table>
3735
-
1786
+ | Parameters | Description |
1787
+ | --- | --- |
1788
+ | margin | Dashboard inner padding. Note that here it is based on the percentage of the parentView. Margin value range is 0 - 1. |
1789
+ | userId | User ID. |
3736
1790
 
3737
1791
  ## callExperimentalAPI
3738
1792
 
3739
-
3740
-
3741
1793
  #### Calls an experimental API.
3742
1794
 
3743
1795
  ## enablePayloadPrivateEncryption
3744
1796
 
3745
-
3746
-
3747
1797
  #### Enable or disable media stream private encryption
3748
1798
 
3749
1799
  In scenarios with high security requirements, TRTC recommends calling the enablePayloadPrivateEncryption method to enable media stream private encryption before joining a room.
3750
1800
 
3751
1801
  After the user leaves the room, the SDK will automatically disable private encryption. If you need to re-enable private encryption, you must call this method before the user rejoins the room.
3752
- <table>
3753
- <tr>
3754
- <td rowspan="1" colSpan="1" >Parameters</td>
3755
-
3756
- <td rowspan="1" colSpan="1" >Description</td>
3757
- </tr>
3758
-
3759
- <tr>
3760
- <td rowspan="1" colSpan="1" >config</td>
3761
-
3762
- <td rowspan="1" colSpan="1" >For configuring the media stream private encryption algorithm and key, refer to [TRTCPayloadPrivateEncryptionConfig](https://write.woa.com/document/87029993616093184).</td>
3763
- </tr>
3764
-
3765
- <tr>
3766
- <td rowspan="1" colSpan="1" >enabled</td>
3767
-
3768
- <td rowspan="1" colSpan="1" >Whether to enable media stream private encryption.</td>
3769
- </tr>
3770
- </table>
3771
-
1802
+ | Parameters | Description |
1803
+ | --- | --- |
1804
+ | config | For configuring the media stream private encryption algorithm and key, refer to TRTCPayloadPrivateEncryptionConfig. |
1805
+ | enabled | Whether to enable media stream private encryption. |
3772
1806
 
3773
1807
  > **Note**
3774
- >
1808
+ >
3775
1809
 
3776
1810
  > TRTC already encrypts media streams before transmission. When media stream private encryption is enabled, it will use the key and initialization vector you provided for additional encryption.
3777
- >
3778
-
1811
+ >
3779
1812
 
3780
1813
  #### Return value description:
3781
1814
 
3782
- API invocation results: 0: Method call successful, -1: Invalid input parameter, -2: Feature expired. To unlock: Please visit the Chinese mainland site to activate the [TRTC Enterprise Edition Package](https://buy.cloud.tencent.com/trtc?tab=month&trtcversion=ultimate), and submit an [application](https://cloud.tencent.com/apply/p/diifjcmffhw). You can use it upon approval.
1815
+ API invocation results: 0: Method call successful, -1: Invalid input parameter, -2: Feature expired. To unlock: Please visit the Chinese mainland site to activate the [TRTC Enterprise Edition Package](https://buy.cloud.tencent.com/trtc?tab=month&trtcversion=ultimate), and submit an [application](https://cloud.tencent.com/apply/p/diifjcmffhw). You can use it upon approval.