@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.
- package/package.json +2 -2
- package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/android-faq.md} +10 -22
- package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/flutter-faq.md} +10 -22
- package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/ios-faq.md} +10 -22
- package/resource/doc/callkit/preset/android/api.md +296 -0
- package/resource/doc/callkit/preset/android/integration.md +430 -0
- package/resource/doc/callkit/preset/flutter/api.md +410 -0
- package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +35 -97
- package/resource/doc/callkit/preset/ios/api.md +80 -0
- package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +37 -118
- package/resource/doc/callkit/preset/react/api.md +501 -0
- package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +5 -20
- package/resource/doc/callkit/preset/vue/api.md +501 -0
- package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +4 -19
- package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -38
- package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
- package/resource/doc/chatkit/android/integration.md +490 -0
- package/resource/doc/chatkit/faq/android_sdk/client-api.md +281 -0
- package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +0 -1
- package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -1
- package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +199 -0
- package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
- package/resource/doc/chatkit/faq/ios_sdk/client-api.md +235 -0
- package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +3 -3
- package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
- package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +19 -88
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -38
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +47 -165
- package/resource/doc/{chatuikit → chatkit}/react/components/avatar.md +0 -33
- package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +8 -49
- package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +6 -35
- package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +0 -6
- package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -11
- package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +96 -502
- package/resource/doc/chatkit/react/components/conversation-actions.md +174 -0
- package/resource/doc/chatkit/react/components/conversation-list.md +333 -0
- package/resource/doc/chatkit/react/components/conversation-preview.md +118 -0
- package/resource/doc/chatkit/react/components/conversation-search.md +60 -0
- package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -337
- package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +20 -212
- package/resource/doc/chatkit/react/components/search.md +243 -0
- package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +1 -47
- package/resource/doc/{chatuikit → chatkit}/react/integration.md +21 -81
- package/resource/doc/{chatuikit → chatkit}/vue/components/avatar.md +0 -33
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -48
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +3 -5
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +0 -5
- package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -15
- package/resource/doc/chatkit/vue/components/contact-list.md +271 -0
- package/resource/doc/chatkit/vue/components/conversation-actions.md +228 -0
- package/resource/doc/{chatuikit → chatkit}/vue/components/conversation-list.md +42 -492
- package/resource/doc/chatkit/vue/components/conversation-preview.md +213 -0
- package/resource/doc/chatkit/vue/components/conversation-search.md +50 -0
- package/resource/doc/{chatuikit → chatkit}/vue/components/message-input.md +2 -223
- package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -252
- package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
- package/resource/doc/{chatuikit → chatkit}/vue/components/tuikit.md +7 -21
- package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +3 -62
- package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
- package/resource/doc/{chatuikit → chatkit}/vue/integration.md +22 -23
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +18 -89
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-audio-effect.md +34 -192
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-barrage.md +28 -141
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +20 -112
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +59 -193
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-gift.md +75 -455
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-host-interaction.md +94 -344
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +107 -515
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +33 -173
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +14 -93
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -179
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +19 -107
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -166
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -163
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +69 -443
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-integration.md +107 -492
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +23 -165
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +35 -111
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +35 -193
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +31 -144
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +24 -116
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +37 -171
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +79 -459
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +69 -320
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +85 -502
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +32 -169
- package/resource/doc/livekit/core-sdk/voice/android/voice-audience-list.md +263 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-audio-effect.md +222 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-barrage.md +452 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +536 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-gift.md +442 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-host-interaction.md +489 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-integration.md +574 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +435 -0
- package/resource/doc/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +516 -0
- package/resource/doc/livekit/core-sdk/voice/flutter/voice-integration.md +576 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-audience-list.md +263 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-audio-effect.md +212 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-barrage.md +404 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +499 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-gift.md +403 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-host-interaction.md +552 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-integration.md +514 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +348 -0
- package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -2
- package/resource/doc/livekit/preset/live/vue/api-reference/index.md +780 -0
- package/resource/doc/livekit/preset/live/vue/components/barrage.md +291 -0
- package/resource/doc/livekit/{live → preset/live}/vue/components/co-guest-panel.md +10 -49
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +26 -144
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +12 -75
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +36 -227
- package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +215 -0
- package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
- package/resource/doc/livekit/preset/live/vue/live-list-integration.md +241 -0
- package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +299 -0
- package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +300 -0
- package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +743 -0
- package/resource/doc/roomkit/vue/faq.md +1 -0
- package/resource/doc/roomkit/vue/features/call-user-to-room.md +17 -53
- package/resource/doc/roomkit/vue/features/device-detection.md +30 -48
- package/resource/doc/roomkit/vue/features/device-state.md +24 -44
- package/resource/doc/roomkit/vue/features/free-beauty-panel.md +13 -36
- package/resource/doc/roomkit/vue/features/room-chat.md +31 -89
- package/resource/doc/roomkit/vue/features/room-participant-state.md +28 -50
- package/resource/doc/roomkit/vue/features/room-state.md +25 -34
- package/resource/doc/roomkit/vue/features/room-view.md +30 -125
- package/resource/doc/roomkit/vue/features/schedule-room.md +9 -40
- package/resource/doc/roomkit/vue/features/screen-share.md +22 -90
- package/resource/doc/roomkit/vue/features/virtual-background.md +13 -29
- package/resource/doc/roomkit/vue/integration.md +173 -337
- package/resource/doc/rtcengine/faq/common/error_code.md +1 -0
- package/resource/doc/rtcengine/faq/web/web.md +14 -24
- package/resource/doc/rtcengine/web/api.md +1 -3
- package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +3 -10
- package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +1 -5
- package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +1 -2
- package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -4
- package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +3 -5
- package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +1 -7
- package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +0 -2
- package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -8
- package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +11 -11
- package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +12 -88
- package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -5
- package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +30 -37
- package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +13 -90
- package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -2
- package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +1 -2
- package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +19 -19
- package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +1 -1
- package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +4 -5
- package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
- package/resource/doc/trtc/C++/ITRTCCloud.md +686 -2835
- package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
- package/resource/doc/trtc/C++/ITXAudioEffectManager.md +202 -1022
- package/resource/doc/trtc/C++/ITXDeviceManager.md +126 -767
- package/resource/doc/trtc/C++/TRTCCloudCallback.md +579 -2147
- package/resource/doc/trtc/C++/TRTCTypeDef.md +703 -3378
- package/resource/doc/trtc/C++/TXLiteAVCode.md +116 -908
- package/resource/doc/trtc/android/TRTCCloud.md +606 -2573
- package/resource/doc/trtc/android/TRTCCloudDef.md +752 -3640
- package/resource/doc/trtc/android/TRTCCloudListener.md +581 -2008
- package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
- package/resource/doc/trtc/android/TXAudioEffectManager.md +202 -1022
- package/resource/doc/trtc/android/TXBeautyManager.md +127 -704
- package/resource/doc/trtc/android/TXDeviceManager.md +51 -318
- package/resource/doc/trtc/android/TXLiteAVCode.md +114 -892
- package/resource/doc/trtc/iOS/TRTCCloud.md +694 -2904
- package/resource/doc/trtc/iOS/TRTCCloudDef.md +726 -3498
- package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +543 -2028
- package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
- package/resource/doc/trtc/iOS/TXAudioEffectManager.md +174 -877
- package/resource/doc/trtc/iOS/TXBeautyManager.md +128 -710
- package/resource/doc/trtc/iOS/TXDeviceManager.md +129 -772
- package/resource/doc/trtc/iOS/TXLiteAVCode.md +117 -915
- package/server.js +1 -5
- package/server.js.map +1 -1
- package/tools/call/get_callkit_api.js +32 -0
- package/tools/call/get_callkit_api.js.map +1 -0
- package/tools/call/get_native_call_uikit_integration.js +34 -0
- package/tools/call/get_native_call_uikit_integration.js.map +1 -0
- package/tools/call/{get-web-call-integration.js → get_web_call_uikit_integration.js} +13 -8
- package/tools/call/get_web_call_uikit_integration.js.map +1 -0
- package/tools/chat/get_native_chat_uikit_feature_detail.js +34 -0
- package/tools/chat/get_native_chat_uikit_feature_detail.js.map +1 -0
- package/tools/chat/get_native_chat_uikit_integration.js +45 -0
- package/tools/chat/get_native_chat_uikit_integration.js.map +1 -0
- package/tools/chat/get_web_chat_uikit_component_detail.js +34 -0
- package/tools/chat/get_web_chat_uikit_component_detail.js.map +1 -0
- package/tools/chat/get_web_chat_uikit_integration.js +45 -0
- package/tools/chat/get_web_chat_uikit_integration.js.map +1 -0
- package/tools/common/get_faq.js +265 -0
- package/tools/common/get_faq.js.map +1 -0
- package/tools/common/{get-usersig.js → get_usersig.js} +6 -3
- package/tools/common/get_usersig.js.map +1 -0
- package/tools/common/present_framework_choice.js +63 -0
- package/tools/common/present_framework_choice.js.map +1 -0
- package/tools/definitions/get_callkit_api_def.js +29 -0
- package/tools/definitions/get_callkit_api_def.js.map +1 -0
- package/tools/definitions/get_faq_def.js +17 -18
- package/tools/definitions/get_faq_def.js.map +1 -1
- package/tools/definitions/get_native_call_uikit_integration_def.js +15 -18
- package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
- package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -19
- package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_native_livekit_core_features_def.js +34 -0
- package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
- package/tools/definitions/get_native_livekit_core_integration_def.js +34 -0
- package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
- package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
- package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
- package/tools/definitions/get_usersig_def.js +17 -22
- package/tools/definitions/get_usersig_def.js.map +1 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
- package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
- package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js +15 -18
- package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_livekit_api_def.js +30 -0
- package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
- package/tools/definitions/get_web_livekit_component_detail_def.js +32 -0
- package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
- package/tools/definitions/get_web_room_uikit_integration_def.js +15 -30
- package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_roomkit_feature_detail_def.js +31 -0
- package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_api_def.js +27 -0
- package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_integration_def.js +27 -0
- package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js +27 -0
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
- package/tools/definitions/present_framework_choice_def.js +24 -12
- package/tools/definitions/present_framework_choice_def.js.map +1 -1
- package/tools/index.js +47 -59
- package/tools/index.js.map +1 -1
- package/tools/live/get_native_livekit_core_features.js +65 -0
- package/tools/live/get_native_livekit_core_features.js.map +1 -0
- package/tools/live/get_native_livekit_core_integration.js +59 -0
- package/tools/live/get_native_livekit_core_integration.js.map +1 -0
- package/tools/live/get_web_live_uikit_integration.js +48 -0
- package/tools/live/get_web_live_uikit_integration.js.map +1 -0
- package/tools/live/get_web_livekit_api.js +32 -0
- package/tools/live/get_web_livekit_api.js.map +1 -0
- package/tools/live/get_web_livekit_component_detail.js +34 -0
- package/tools/live/get_web_livekit_component_detail.js.map +1 -0
- package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
- package/tools/room/get_web_room_uikit_integration.js.map +1 -0
- package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
- package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
- package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
- package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
- package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
- package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
- package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
- package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
- package/utils/generate-structured-result.js +61 -17
- package/utils/generate-structured-result.js.map +1 -1
- package/utils/report-cls-client.js +12 -1
- package/utils/report-cls-client.js.map +1 -1
- package/utils/report-es-client.js +2 -2
- package/resource/doc/chatuikit/android/integration.md +0 -287
- package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1371
- package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -932
- package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1119
- package/resource/doc/chatuikit/flutter/workflow.md +0 -941
- package/resource/doc/chatuikit/iOS/workflow.md +0 -0
- package/resource/doc/chatuikit/react/components/conversation-list.md +0 -1017
- package/resource/doc/chatuikit/react/components/search.md +0 -745
- package/resource/doc/chatuikit/react/create-group.md +0 -23
- package/resource/doc/chatuikit/react/init.md +0 -26
- package/resource/doc/chatuikit/react/workflow.md +0 -258
- package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
- package/resource/doc/chatuikit/vue/create-group.md +0 -25
- package/resource/doc/chatuikit/vue/init.md +0 -40
- package/resource/doc/chatuikit/vue/workflow.md +0 -395
- package/resource/doc/livekit/live/android/workflow.md +0 -320
- package/resource/doc/livekit/live/flutter/workflow.md +0 -353
- package/resource/doc/livekit/live/ios/workflow.md +0 -454
- package/resource/doc/livekit/live/vue/components/barrage.md +0 -616
- package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -446
- package/resource/doc/livekit/live/vue/faq.md +0 -0
- package/resource/doc/livekit/live/vue/live-list-integration.md +0 -200
- package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -269
- package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -269
- package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -595
- package/resource/doc/livekit/live/vue/states/live-state.md +0 -3591
- package/resource/doc/livekit/live/vue/workflow.md +0 -218
- package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -312
- package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -430
- package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -679
- package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -671
- package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -271
- package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
- package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
- package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
- package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
- package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -865
- package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -657
- package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -437
- package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -335
- package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
- package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -327
- package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -507
- package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
- package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -659
- package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
- package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -814
- package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1000
- package/resource/doc/roomkit/vue/features/workflow.md +0 -553
- package/resource/doc/roomkit/vue/workflow.md +0 -487
- package/resource/doc/tuicallkit/android/integration.md +0 -286
- package/resource/doc/tuicallkit/android/workflow.md +0 -0
- package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -784
- package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -610
- package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -938
- package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -897
- package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -469
- package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -781
- package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -398
- package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
- package/resource/doc/tuicallkit/react/api.md +0 -1404
- package/resource/doc/tuicallkit/vue/api.md +0 -1406
- package/resource/doc/tuicallkit/vue/faq.md +0 -36
- package/tools/call/get-native-call-integration.js +0 -43
- package/tools/call/get-native-call-integration.js.map +0 -1
- package/tools/call/get-web-call-api.js +0 -27
- package/tools/call/get-web-call-api.js.map +0 -1
- package/tools/call/get-web-call-integration.js.map +0 -1
- package/tools/chat/get-native-chat-feature-detail.js +0 -30
- package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
- package/tools/chat/get-native-chat-integration.js +0 -45
- package/tools/chat/get-native-chat-integration.js.map +0 -1
- package/tools/chat/get-web-chat-component-detail.js +0 -31
- package/tools/chat/get-web-chat-component-detail.js.map +0 -1
- package/tools/chat/get-web-chat-integration.js +0 -45
- package/tools/chat/get-web-chat-integration.js.map +0 -1
- package/tools/chat/get-web-chat-uikit-init.js +0 -28
- package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
- package/tools/chat/get-web-create-group-doc.js +0 -28
- package/tools/chat/get-web-create-group-doc.js.map +0 -1
- package/tools/common/get-faq.js +0 -91
- package/tools/common/get-faq.js.map +0 -1
- package/tools/common/get-usersig.js.map +0 -1
- package/tools/common/present-framework-choice.js +0 -16
- package/tools/common/present-framework-choice.js.map +0 -1
- package/tools/common/record-prompt.js +0 -55
- package/tools/common/record-prompt.js.map +0 -1
- package/tools/common/record-result.js +0 -60
- package/tools/common/record-result.js.map +0 -1
- package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
- package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_native_live_api_def.js +0 -23
- package/tools/definitions/get_native_live_api_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -87
- package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_integration_def.js +0 -49
- package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -74
- package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
- package/tools/definitions/get_trtc_native_api_def.js +0 -16
- package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
- package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
- package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
- package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
- package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
- package/tools/definitions/get_web_create_group_doc_def.js +0 -18
- package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
- package/tools/definitions/get_web_live_state_detail_def.js +0 -19
- package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
- package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
- package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_room_feature_detail_def.js +0 -95
- package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_web_room_state_detail_def.js +0 -19
- package/tools/definitions/get_web_room_state_detail_def.js.map +0 -1
- package/tools/definitions/record_prompt_def.js +0 -53
- package/tools/definitions/record_prompt_def.js.map +0 -1
- package/tools/definitions/record_result_def.js +0 -30
- package/tools/definitions/record_result_def.js.map +0 -1
- package/tools/live/get-native-live-uikit-integration.js +0 -101
- package/tools/live/get-native-live-uikit-integration.js.map +0 -1
- package/tools/live/get-web-live-component-detail.js +0 -31
- package/tools/live/get-web-live-component-detail.js.map +0 -1
- package/tools/live/get-web-live-state-detail.js +0 -31
- package/tools/live/get-web-live-state-detail.js.map +0 -1
- package/tools/live/get-web-live-uikit-integration.js +0 -52
- package/tools/live/get-web-live-uikit-integration.js.map +0 -1
- package/tools/live/get_native_live_uikit_extra_features.js +0 -105
- package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
- package/tools/live/get_native_live_uikit_interaction.js +0 -101
- package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
- package/tools/native_live/get-native-live-api.js +0 -31
- package/tools/native_live/get-native-live-api.js.map +0 -1
- package/tools/room/get-web-room-feature-detail.js.map +0 -1
- package/tools/room/get-web-room-integration.js.map +0 -1
- package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
- package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
- package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
- package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
- package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
- package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
- package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
- package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
- package/tools/trtc/get-trtc-native-api.js +0 -31
- package/tools/trtc/get-trtc-native-api.js.map +0 -1
- package/utils/handle-component-name.js +0 -33
- package/utils/handle-component-name.js.map +0 -1
- /package/resource/doc/{chatuikit/android/workflow.md → callkit/core-sdk/.gitkeep} +0 -0
- /package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +0 -0
- /package/resource/doc/{tuicallkit/react/faq.md → callkit/faq/web-faq.md} +0 -0
- /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
- /package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +0 -0
- /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
- /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
- /package/resource/doc/roomkit/faq/common/{error_code.md → error-code.md} +0 -0
|
@@ -2,897 +2,250 @@
|
|
|
2
2
|
## Overview
|
|
3
3
|
`ITRTCCloud.h` is the API reference for TRTC Real-Time Communication (TRTC SDK) on C++. It provides detailed documentation for features including stream publishing, stream playback, stream mixing, and recording.
|
|
4
4
|
|
|
5
|
-
|
|
6
5
|
## ITRTCCloud
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
<td rowspan="1" colSpan="1" >Stop publishing media stream.</td>
|
|
120
|
-
</tr>
|
|
121
|
-
|
|
122
|
-
<tr>
|
|
123
|
-
<td rowspan="1" colSpan="1" >[startLocalPreview](https://write.woa.com/document/87030026264555520)</td>
|
|
124
|
-
|
|
125
|
-
<td rowspan="1" colSpan="1" >Enable the preview screen of the local camera (Mobile Terminal)</td>
|
|
126
|
-
</tr>
|
|
127
|
-
|
|
128
|
-
<tr>
|
|
129
|
-
<td rowspan="1" colSpan="1" >[startLocalPreview](https://write.woa.com/document/87030026264555520)</td>
|
|
130
|
-
|
|
131
|
-
<td rowspan="1" colSpan="1" >Enable the preview screen of the local camera (Desktop Terminal)</td>
|
|
132
|
-
</tr>
|
|
133
|
-
|
|
134
|
-
<tr>
|
|
135
|
-
<td rowspan="1" colSpan="1" >[updateLocalView](https://write.woa.com/document/87030026264555520)</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/87030026264555520)</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/87030026264555520)</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/87030026264555520)</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/87030026264555520)</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/87030026264555520)</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/87030026264555520)</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/87030026264555520)</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/87030026264555520)</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/87030026264555520)</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/87030026264555520)</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/87030026264555520)</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/87030026264555520)</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/87030026264555520)</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" >[enableSmallVideoStream](https://write.woa.com/document/87030026264555520)</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/87030026264555520)</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/87030026264555520)</td>
|
|
232
|
-
|
|
233
|
-
<td rowspan="1" colSpan="1" >Take a video screenshot</td>
|
|
234
|
-
</tr>
|
|
235
|
-
|
|
236
|
-
<tr>
|
|
237
|
-
<td rowspan="1" colSpan="1" >[setGravitySensorAdaptiveMode](https://write.woa.com/document/87030026264555520)</td>
|
|
238
|
-
|
|
239
|
-
<td rowspan="1" colSpan="1" >Set gravity sensing adaptive mode (11.7 and above)</td>
|
|
240
|
-
</tr>
|
|
241
|
-
|
|
242
|
-
<tr>
|
|
243
|
-
<td rowspan="1" colSpan="1" >[startLocalAudio](https://write.woa.com/document/87030026264555520)</td>
|
|
244
|
-
|
|
245
|
-
<td rowspan="1" colSpan="1" >Enable collection and publishing of local audio</td>
|
|
246
|
-
</tr>
|
|
247
|
-
|
|
248
|
-
<tr>
|
|
249
|
-
<td rowspan="1" colSpan="1" >[stopLocalAudio](https://write.woa.com/document/87030026264555520)</td>
|
|
250
|
-
|
|
251
|
-
<td rowspan="1" colSpan="1" >Stop collection and publishing of local audio</td>
|
|
252
|
-
</tr>
|
|
253
|
-
|
|
254
|
-
<tr>
|
|
255
|
-
<td rowspan="1" colSpan="1" >[muteLocalAudio](https://write.woa.com/document/87030026264555520)</td>
|
|
256
|
-
|
|
257
|
-
<td rowspan="1" colSpan="1" >Pause/Resume publishing of the local audio stream</td>
|
|
258
|
-
</tr>
|
|
259
|
-
|
|
260
|
-
<tr>
|
|
261
|
-
<td rowspan="1" colSpan="1" >[muteRemoteAudio](https://write.woa.com/document/87030026264555520)</td>
|
|
262
|
-
|
|
263
|
-
<td rowspan="1" colSpan="1" >Pause/Resume playing of the remote audio stream</td>
|
|
264
|
-
</tr>
|
|
265
|
-
|
|
266
|
-
<tr>
|
|
267
|
-
<td rowspan="1" colSpan="1" >[muteAllRemoteAudio](https://write.woa.com/document/87030026264555520)</td>
|
|
268
|
-
|
|
269
|
-
<td rowspan="1" colSpan="1" >Pause/Resume playing of all remote users' audio streams</td>
|
|
270
|
-
</tr>
|
|
271
|
-
|
|
272
|
-
<tr>
|
|
273
|
-
<td rowspan="1" colSpan="1" >[setRemoteAudioVolume](https://write.woa.com/document/87030026264555520)</td>
|
|
274
|
-
|
|
275
|
-
<td rowspan="1" colSpan="1" >Set the playback volume for a specific remote user</td>
|
|
276
|
-
</tr>
|
|
277
|
-
|
|
278
|
-
<tr>
|
|
279
|
-
<td rowspan="1" colSpan="1" >[setAudioCaptureVolume](https://write.woa.com/document/87030026264555520)</td>
|
|
280
|
-
|
|
281
|
-
<td rowspan="1" colSpan="1" >Sets the local audio capture volume.</td>
|
|
282
|
-
</tr>
|
|
283
|
-
|
|
284
|
-
<tr>
|
|
285
|
-
<td rowspan="1" colSpan="1" >[getAudioCaptureVolume](https://write.woa.com/document/87030026264555520)</td>
|
|
286
|
-
|
|
287
|
-
<td rowspan="1" colSpan="1" >Obtains the local audio capture volume.</td>
|
|
288
|
-
</tr>
|
|
289
|
-
|
|
290
|
-
<tr>
|
|
291
|
-
<td rowspan="1" colSpan="1" >[setAudioPlayoutVolume](https://write.woa.com/document/87030026264555520)</td>
|
|
292
|
-
|
|
293
|
-
<td rowspan="1" colSpan="1" >Sets the remote audio playback volume.</td>
|
|
294
|
-
</tr>
|
|
295
|
-
|
|
296
|
-
<tr>
|
|
297
|
-
<td rowspan="1" colSpan="1" >[getAudioPlayoutVolume](https://write.woa.com/document/87030026264555520)</td>
|
|
298
|
-
|
|
299
|
-
<td rowspan="1" colSpan="1" >Obtains the remote audio playback volume.</td>
|
|
300
|
-
</tr>
|
|
301
|
-
|
|
302
|
-
<tr>
|
|
303
|
-
<td rowspan="1" colSpan="1" >[enableAudioVolumeEvaluation](https://write.woa.com/document/87030026264555520)</td>
|
|
304
|
-
|
|
305
|
-
<td rowspan="1" colSpan="1" >Enable volume reminder</td>
|
|
306
|
-
</tr>
|
|
307
|
-
|
|
308
|
-
<tr>
|
|
309
|
-
<td rowspan="1" colSpan="1" >[startAudioRecording](https://write.woa.com/document/87030026264555520)</td>
|
|
310
|
-
|
|
311
|
-
<td rowspan="1" colSpan="1" >Start recording</td>
|
|
312
|
-
</tr>
|
|
313
|
-
|
|
314
|
-
<tr>
|
|
315
|
-
<td rowspan="1" colSpan="1" >[stopAudioRecording](https://write.woa.com/document/87030026264555520)</td>
|
|
316
|
-
|
|
317
|
-
<td rowspan="1" colSpan="1" >Stop recording</td>
|
|
318
|
-
</tr>
|
|
319
|
-
|
|
320
|
-
<tr>
|
|
321
|
-
<td rowspan="1" colSpan="1" >[startLocalRecording](https://write.woa.com/document/87030026264555520)</td>
|
|
322
|
-
|
|
323
|
-
<td rowspan="1" colSpan="1" >Enable local media recording</td>
|
|
324
|
-
</tr>
|
|
325
|
-
|
|
326
|
-
<tr>
|
|
327
|
-
<td rowspan="1" colSpan="1" >[stopLocalRecording](https://write.woa.com/document/87030026264555520)</td>
|
|
328
|
-
|
|
329
|
-
<td rowspan="1" colSpan="1" >Stop local media recording</td>
|
|
330
|
-
</tr>
|
|
331
|
-
|
|
332
|
-
<tr>
|
|
333
|
-
<td rowspan="1" colSpan="1" >[setRemoteAudioParallelParams](https://write.woa.com/document/87030026264555520)</td>
|
|
334
|
-
|
|
335
|
-
<td rowspan="1" colSpan="1" >Set intelligent concurrent playback strategy for remote audio streams</td>
|
|
336
|
-
</tr>
|
|
337
|
-
|
|
338
|
-
<tr>
|
|
339
|
-
<td rowspan="1" colSpan="1" >[enable3DSpatialAudioEffect](https://write.woa.com/document/87030026264555520)</td>
|
|
340
|
-
|
|
341
|
-
<td rowspan="1" colSpan="1" >Enable 3D audio</td>
|
|
342
|
-
</tr>
|
|
343
|
-
|
|
344
|
-
<tr>
|
|
345
|
-
<td rowspan="1" colSpan="1" >[updateSelf3DSpatialPosition](https://write.woa.com/document/87030026264555520)</td>
|
|
346
|
-
|
|
347
|
-
<td rowspan="1" colSpan="1" >Set self coordinates and orientation information in 3D audio</td>
|
|
348
|
-
</tr>
|
|
349
|
-
|
|
350
|
-
<tr>
|
|
351
|
-
<td rowspan="1" colSpan="1" >[updateRemote3DSpatialPosition](https://write.woa.com/document/87030026264555520)</td>
|
|
352
|
-
|
|
353
|
-
<td rowspan="1" colSpan="1" >Set remote user coordinate information in 3D audio</td>
|
|
354
|
-
</tr>
|
|
355
|
-
|
|
356
|
-
<tr>
|
|
357
|
-
<td rowspan="1" colSpan="1" >[set3DSpatialReceivingRange](https://write.woa.com/document/87030026264555520)</td>
|
|
358
|
-
|
|
359
|
-
<td rowspan="1" colSpan="1" >Set the receivable range of sounds emitted by a specified user</td>
|
|
360
|
-
</tr>
|
|
361
|
-
|
|
362
|
-
<tr>
|
|
363
|
-
<td rowspan="1" colSpan="1" >[getDeviceManager](https://write.woa.com/document/87030026264555520)</td>
|
|
364
|
-
|
|
365
|
-
<td rowspan="1" colSpan="1" >Get Device Management Class (TXDeviceManager)</td>
|
|
366
|
-
</tr>
|
|
367
|
-
|
|
368
|
-
<tr>
|
|
369
|
-
<td rowspan="1" colSpan="1" >[setBeautyStyle](https://write.woa.com/document/87030026264555520)</td>
|
|
370
|
-
|
|
371
|
-
<td rowspan="1" colSpan="1" >Set special effects like beauty filter, whitening, and rosy skin</td>
|
|
372
|
-
</tr>
|
|
373
|
-
|
|
374
|
-
<tr>
|
|
375
|
-
<td rowspan="1" colSpan="1" >[setWaterMark](https://write.woa.com/document/87030026264555520)</td>
|
|
376
|
-
|
|
377
|
-
<td rowspan="1" colSpan="1" >Watermarking</td>
|
|
378
|
-
</tr>
|
|
379
|
-
|
|
380
|
-
<tr>
|
|
381
|
-
<td rowspan="1" colSpan="1" >[getAudioEffectManager](https://write.woa.com/document/87030026264555520)</td>
|
|
382
|
-
|
|
383
|
-
<td rowspan="1" colSpan="1" >Get Audio Effect Management Class (TXAudioEffectManager)</td>
|
|
384
|
-
</tr>
|
|
385
|
-
|
|
386
|
-
<tr>
|
|
387
|
-
<td rowspan="1" colSpan="1" >[startSystemAudioLoopback](https://write.woa.com/document/87030026264555520)</td>
|
|
388
|
-
|
|
389
|
-
<td rowspan="1" colSpan="1" >Enable System Sound Capture (iOS not yet supported)</td>
|
|
390
|
-
</tr>
|
|
391
|
-
|
|
392
|
-
<tr>
|
|
393
|
-
<td rowspan="1" colSpan="1" >[stopSystemAudioLoopback](https://write.woa.com/document/87030026264555520)</td>
|
|
394
|
-
|
|
395
|
-
<td rowspan="1" colSpan="1" >Stop System Sound Capture (iOS not yet supported)</td>
|
|
396
|
-
</tr>
|
|
397
|
-
|
|
398
|
-
<tr>
|
|
399
|
-
<td rowspan="1" colSpan="1" >[setSystemAudioLoopbackVolume](https://write.woa.com/document/87030026264555520)</td>
|
|
400
|
-
|
|
401
|
-
<td rowspan="1" colSpan="1" >Sets the Volume of System Sound Capture</td>
|
|
402
|
-
</tr>
|
|
403
|
-
|
|
404
|
-
<tr>
|
|
405
|
-
<td rowspan="1" colSpan="1" >[startScreenCapture](https://write.woa.com/document/87030026264555520)</td>
|
|
406
|
-
|
|
407
|
-
<td rowspan="1" colSpan="1" >Start Screen Sharing</td>
|
|
408
|
-
</tr>
|
|
409
|
-
|
|
410
|
-
<tr>
|
|
411
|
-
<td rowspan="1" colSpan="1" >[stopScreenCapture](https://write.woa.com/document/87030026264555520)</td>
|
|
412
|
-
|
|
413
|
-
<td rowspan="1" colSpan="1" >Stopping Screen Sharing</td>
|
|
414
|
-
</tr>
|
|
415
|
-
|
|
416
|
-
<tr>
|
|
417
|
-
<td rowspan="1" colSpan="1" >[pauseScreenCapture](https://write.woa.com/document/87030026264555520)</td>
|
|
418
|
-
|
|
419
|
-
<td rowspan="1" colSpan="1" >Pause Screen Sharing</td>
|
|
420
|
-
</tr>
|
|
421
|
-
|
|
422
|
-
<tr>
|
|
423
|
-
<td rowspan="1" colSpan="1" >[resumeScreenCapture](https://write.woa.com/document/87030026264555520)</td>
|
|
424
|
-
|
|
425
|
-
<td rowspan="1" colSpan="1" >Resume Screen Sharing</td>
|
|
426
|
-
</tr>
|
|
427
|
-
|
|
428
|
-
<tr>
|
|
429
|
-
<td rowspan="1" colSpan="1" >[getScreenCaptureSources](https://write.woa.com/document/87030026264555520)</td>
|
|
430
|
-
|
|
431
|
-
<td rowspan="1" colSpan="1" >Enumerate shareable screens and windows (this interface supports only desktop systems)</td>
|
|
432
|
-
</tr>
|
|
433
|
-
|
|
434
|
-
<tr>
|
|
435
|
-
<td rowspan="1" colSpan="1" >[selectScreenCaptureTarget](https://write.woa.com/document/87030026264555520)</td>
|
|
436
|
-
|
|
437
|
-
<td rowspan="1" colSpan="1" >Select the screen or window to share (this interface supports only desktop systems)</td>
|
|
438
|
-
</tr>
|
|
439
|
-
|
|
440
|
-
<tr>
|
|
441
|
-
<td rowspan="1" colSpan="1" >[setSubStreamEncoderParam](https://write.woa.com/document/87030026264555520)</td>
|
|
442
|
-
|
|
443
|
-
<td rowspan="1" colSpan="1" >Set Video Encoding Parameters for Screen Sharing (Sub-Stream) (Supported on Both Desktop and Mobile Systems)</td>
|
|
444
|
-
</tr>
|
|
445
|
-
|
|
446
|
-
<tr>
|
|
447
|
-
<td rowspan="1" colSpan="1" >[setSubStreamMixVolume](https://write.woa.com/document/87030026264555520)</td>
|
|
448
|
-
|
|
449
|
-
<td rowspan="1" colSpan="1" >Set the Mixing Volume for Screen Sharing (This Interface Supports Only Desktop Systems)</td>
|
|
450
|
-
</tr>
|
|
451
|
-
|
|
452
|
-
<tr>
|
|
453
|
-
<td rowspan="1" colSpan="1" >[addExcludedShareWindow](https://write.woa.com/document/87030026264555520)</td>
|
|
454
|
-
|
|
455
|
-
<td rowspan="1" colSpan="1" >Add the Specified Window to the Exclusion List of Screen Sharing (This Interface Supports Only Desktop Systems)</td>
|
|
456
|
-
</tr>
|
|
457
|
-
|
|
458
|
-
<tr>
|
|
459
|
-
<td rowspan="1" colSpan="1" >[removeExcludedShareWindow](https://write.woa.com/document/87030026264555520)</td>
|
|
460
|
-
|
|
461
|
-
<td rowspan="1" colSpan="1" >Remove the Specified Window from the Exclusion List of Screen Sharing (This Interface Supports Only Desktop Systems)</td>
|
|
462
|
-
</tr>
|
|
463
|
-
|
|
464
|
-
<tr>
|
|
465
|
-
<td rowspan="1" colSpan="1" >[removeAllExcludedShareWindow](https://write.woa.com/document/87030026264555520)</td>
|
|
466
|
-
|
|
467
|
-
<td rowspan="1" colSpan="1" >Remove All Windows from the Exclusion List of Screen Sharing (This Interface Supports Only Desktop Systems)</td>
|
|
468
|
-
</tr>
|
|
469
|
-
|
|
470
|
-
<tr>
|
|
471
|
-
<td rowspan="1" colSpan="1" >[addIncludedShareWindow](https://write.woa.com/document/87030026264555520)</td>
|
|
472
|
-
|
|
473
|
-
<td rowspan="1" colSpan="1" >Add the Specified Window to the Contains List of Screen Sharing (This Interface Supports Only Desktop Systems)</td>
|
|
474
|
-
</tr>
|
|
475
|
-
|
|
476
|
-
<tr>
|
|
477
|
-
<td rowspan="1" colSpan="1" >[removeIncludedShareWindow](https://write.woa.com/document/87030026264555520)</td>
|
|
478
|
-
|
|
479
|
-
<td rowspan="1" colSpan="1" >Remove the Specified Window from the Contains List of Screen Sharing (This Interface Supports Only Desktop Systems)</td>
|
|
480
|
-
</tr>
|
|
481
|
-
|
|
482
|
-
<tr>
|
|
483
|
-
<td rowspan="1" colSpan="1" >[removeAllIncludedShareWindow](https://write.woa.com/document/87030026264555520)</td>
|
|
484
|
-
|
|
485
|
-
<td rowspan="1" colSpan="1" >Remove All Windows from the Contains List of Screen Sharing (This Interface Supports Only Desktop Systems)</td>
|
|
486
|
-
</tr>
|
|
487
|
-
|
|
488
|
-
<tr>
|
|
489
|
-
<td rowspan="1" colSpan="1" >[enableCustomVideoCapture](https://write.woa.com/document/87030026264555520)</td>
|
|
490
|
-
|
|
491
|
-
<td rowspan="1" colSpan="1" >Enable/Disable Custom Video Capturing Mode</td>
|
|
492
|
-
</tr>
|
|
493
|
-
|
|
494
|
-
<tr>
|
|
495
|
-
<td rowspan="1" colSpan="1" >[sendCustomVideoData](https://write.woa.com/document/87030026264555520)</td>
|
|
496
|
-
|
|
497
|
-
<td rowspan="1" colSpan="1" >Submit Self-collected Video Frames to the SDK</td>
|
|
498
|
-
</tr>
|
|
499
|
-
|
|
500
|
-
<tr>
|
|
501
|
-
<td rowspan="1" colSpan="1" >[enableCustomAudioCapture](https://write.woa.com/document/87030026264555520)</td>
|
|
502
|
-
|
|
503
|
-
<td rowspan="1" colSpan="1" >Enable Custom Audio Capturing Mode</td>
|
|
504
|
-
</tr>
|
|
505
|
-
|
|
506
|
-
<tr>
|
|
507
|
-
<td rowspan="1" colSpan="1" >[sendCustomAudioData](https://write.woa.com/document/87030026264555520)</td>
|
|
508
|
-
|
|
509
|
-
<td rowspan="1" colSpan="1" >Submit Self-collected Audio Data to the SDK</td>
|
|
510
|
-
</tr>
|
|
511
|
-
|
|
512
|
-
<tr>
|
|
513
|
-
<td rowspan="1" colSpan="1" >[enableMixExternalAudioFrame](https://write.woa.com/document/87030026264555520)</td>
|
|
514
|
-
|
|
515
|
-
<td rowspan="1" colSpan="1" >Enable/Disable Custom Audio Track</td>
|
|
516
|
-
</tr>
|
|
517
|
-
|
|
518
|
-
<tr>
|
|
519
|
-
<td rowspan="1" colSpan="1" >[mixExternalAudioFrame](https://write.woa.com/document/87030026264555520)</td>
|
|
520
|
-
|
|
521
|
-
<td rowspan="1" colSpan="1" >Mix Custom Audio Track into the SDK</td>
|
|
522
|
-
</tr>
|
|
523
|
-
|
|
524
|
-
<tr>
|
|
525
|
-
<td rowspan="1" colSpan="1" >[setMixExternalAudioVolume](https://write.woa.com/document/87030026264555520)</td>
|
|
526
|
-
|
|
527
|
-
<td rowspan="1" colSpan="1" >Set the Streaming Volume and Playback Volume for External Audio Mixed During Streaming</td>
|
|
528
|
-
</tr>
|
|
529
|
-
|
|
530
|
-
<tr>
|
|
531
|
-
<td rowspan="1" colSpan="1" >[generateCustomPTS](https://write.woa.com/document/87030026264555520)</td>
|
|
532
|
-
|
|
533
|
-
<td rowspan="1" colSpan="1" >Generate Timestamp for Custom Capturing</td>
|
|
534
|
-
</tr>
|
|
535
|
-
|
|
536
|
-
<tr>
|
|
537
|
-
<td rowspan="1" colSpan="1" >[enableLocalVideoCustomProcess](https://write.woa.com/document/87030026264555520)</td>
|
|
538
|
-
|
|
539
|
-
<td rowspan="1" colSpan="1" >.1 Enable third-party beauty filter for video</td>
|
|
540
|
-
</tr>
|
|
541
|
-
|
|
542
|
-
<tr>
|
|
543
|
-
<td rowspan="1" colSpan="1" >[setLocalVideoCustomProcessCallback](https://write.woa.com/document/87030026264555520)</td>
|
|
544
|
-
|
|
545
|
-
<td rowspan="1" colSpan="1" >.2 Set video data callback for third-party beauty filter</td>
|
|
546
|
-
</tr>
|
|
547
|
-
|
|
548
|
-
<tr>
|
|
549
|
-
<td rowspan="1" colSpan="1" >[setLocalVideoRenderCallback](https://write.woa.com/document/87030026264555520)</td>
|
|
550
|
-
|
|
551
|
-
<td rowspan="1" colSpan="1" >Set Local Video Custom Rendering Callback</td>
|
|
552
|
-
</tr>
|
|
553
|
-
|
|
554
|
-
<tr>
|
|
555
|
-
<td rowspan="1" colSpan="1" >[setRemoteVideoRenderCallback](https://write.woa.com/document/87030026264555520)</td>
|
|
556
|
-
|
|
557
|
-
<td rowspan="1" colSpan="1" >Sets the rendering callback for remote video self-definition</td>
|
|
558
|
-
</tr>
|
|
559
|
-
|
|
560
|
-
<tr>
|
|
561
|
-
<td rowspan="1" colSpan="1" >[setAudioFrameCallback](https://write.woa.com/document/87030026264555520)</td>
|
|
562
|
-
|
|
563
|
-
<td rowspan="1" colSpan="1" >Sets the audio data self-definition callback</td>
|
|
564
|
-
</tr>
|
|
565
|
-
|
|
566
|
-
<tr>
|
|
567
|
-
<td rowspan="1" colSpan="1" >[setCapturedAudioFrameCallbackFormat](https://write.woa.com/document/87030026264555520)</td>
|
|
568
|
-
|
|
569
|
-
<td rowspan="1" colSpan="1" >Sets the callback format for audio frames captured by the local microphone</td>
|
|
570
|
-
</tr>
|
|
571
|
-
|
|
572
|
-
<tr>
|
|
573
|
-
<td rowspan="1" colSpan="1" >[setLocalProcessedAudioFrameCallbackFormat](https://write.woa.com/document/87030026264555520)</td>
|
|
574
|
-
|
|
575
|
-
<td rowspan="1" colSpan="1" >Sets the callback format for local audio frames after preprocessing</td>
|
|
576
|
-
</tr>
|
|
577
|
-
|
|
578
|
-
<tr>
|
|
579
|
-
<td rowspan="1" colSpan="1" >[setMixedPlayAudioFrameCallbackFormat](https://write.woa.com/document/87030026264555520)</td>
|
|
580
|
-
|
|
581
|
-
<td rowspan="1" colSpan="1" >Sets the callback format for audio frames that will eventually be played by the system</td>
|
|
582
|
-
</tr>
|
|
583
|
-
|
|
584
|
-
<tr>
|
|
585
|
-
<td rowspan="1" colSpan="1" >[enableCustomAudioRendering](https://write.woa.com/document/87030026264555520)</td>
|
|
586
|
-
|
|
587
|
-
<td rowspan="1" colSpan="1" >Enable self-definition audio playback</td>
|
|
588
|
-
</tr>
|
|
589
|
-
|
|
590
|
-
<tr>
|
|
591
|
-
<td rowspan="1" colSpan="1" >[getCustomAudioRenderingFrame](https://write.woa.com/document/87030026264555520)</td>
|
|
592
|
-
|
|
593
|
-
<td rowspan="1" colSpan="1" >Get playable audio data</td>
|
|
594
|
-
</tr>
|
|
595
|
-
|
|
596
|
-
<tr>
|
|
597
|
-
<td rowspan="1" colSpan="1" >[sendCustomCmdMsg](https://write.woa.com/document/87030026264555520)</td>
|
|
598
|
-
|
|
599
|
-
<td rowspan="1" colSpan="1" >Sends a custom message using UDP channel to all users in a room</td>
|
|
600
|
-
</tr>
|
|
601
|
-
|
|
602
|
-
<tr>
|
|
603
|
-
<td rowspan="1" colSpan="1" >[sendSEIMsg](https://write.woa.com/document/87030026264555520)</td>
|
|
604
|
-
|
|
605
|
-
<td rowspan="1" colSpan="1" >Sends a custom message using SEI channel to all users in a room</td>
|
|
606
|
-
</tr>
|
|
607
|
-
|
|
608
|
-
<tr>
|
|
609
|
-
<td rowspan="1" colSpan="1" >[startSpeedTest](https://write.woa.com/document/87030026264555520)</td>
|
|
610
|
-
|
|
611
|
-
<td rowspan="1" colSpan="1" >Start internet speed test (use before entering the room)</td>
|
|
612
|
-
</tr>
|
|
613
|
-
|
|
614
|
-
<tr>
|
|
615
|
-
<td rowspan="1" colSpan="1" >[stopSpeedTest](https://write.woa.com/document/87030026264555520)</td>
|
|
616
|
-
|
|
617
|
-
<td rowspan="1" colSpan="1" >Stops network speed testing</td>
|
|
618
|
-
</tr>
|
|
619
|
-
|
|
620
|
-
<tr>
|
|
621
|
-
<td rowspan="1" colSpan="1" >[getSDKVersion](https://write.woa.com/document/87030026264555520)</td>
|
|
622
|
-
|
|
623
|
-
<td rowspan="1" colSpan="1" >Obtains the SDK version.</td>
|
|
624
|
-
</tr>
|
|
625
|
-
|
|
626
|
-
<tr>
|
|
627
|
-
<td rowspan="1" colSpan="1" >[setLogLevel](https://write.woa.com/document/87030026264555520)</td>
|
|
628
|
-
|
|
629
|
-
<td rowspan="1" colSpan="1" >Sets the log output level.</td>
|
|
630
|
-
</tr>
|
|
631
|
-
|
|
632
|
-
<tr>
|
|
633
|
-
<td rowspan="1" colSpan="1" >[setConsoleEnabled](https://write.woa.com/document/87030026264555520)</td>
|
|
634
|
-
|
|
635
|
-
<td rowspan="1" colSpan="1" >Enables/Disables console log print.</td>
|
|
636
|
-
</tr>
|
|
637
|
-
|
|
638
|
-
<tr>
|
|
639
|
-
<td rowspan="1" colSpan="1" >[setLogCompressEnabled](https://write.woa.com/document/87030026264555520)</td>
|
|
640
|
-
|
|
641
|
-
<td rowspan="1" colSpan="1" >Enables/Disables local log compression</td>
|
|
642
|
-
</tr>
|
|
643
|
-
|
|
644
|
-
<tr>
|
|
645
|
-
<td rowspan="1" colSpan="1" >[setLogDirPath](https://write.woa.com/document/87030026264555520)</td>
|
|
646
|
-
|
|
647
|
-
<td rowspan="1" colSpan="1" >Sets the save path for local logs</td>
|
|
648
|
-
</tr>
|
|
649
|
-
|
|
650
|
-
<tr>
|
|
651
|
-
<td rowspan="1" colSpan="1" >[setLogCallback](https://write.woa.com/document/87030026264555520)</td>
|
|
652
|
-
|
|
653
|
-
<td rowspan="1" colSpan="1" >Log callback</td>
|
|
654
|
-
</tr>
|
|
655
|
-
|
|
656
|
-
<tr>
|
|
657
|
-
<td rowspan="1" colSpan="1" >[showDebugView](https://write.woa.com/document/87030026264555520)</td>
|
|
658
|
-
|
|
659
|
-
<td rowspan="1" colSpan="1" >Show Dashboard</td>
|
|
660
|
-
</tr>
|
|
661
|
-
|
|
662
|
-
<tr>
|
|
663
|
-
<td rowspan="1" colSpan="1" >[callExperimentalAPI](https://write.woa.com/document/87030026264555520)</td>
|
|
664
|
-
|
|
665
|
-
<td rowspan="1" colSpan="1" >Calls an experimental API.</td>
|
|
666
|
-
</tr>
|
|
667
|
-
|
|
668
|
-
<tr>
|
|
669
|
-
<td rowspan="1" colSpan="1" >[enablePayloadPrivateEncryption](https://write.woa.com/document/87030026264555520)</td>
|
|
670
|
-
|
|
671
|
-
<td rowspan="1" colSpan="1" >Enable or disable media stream private encryption</td>
|
|
672
|
-
</tr>
|
|
673
|
-
</table>
|
|
674
|
-
|
|
6
|
+
| Function List | Description |
|
|
7
|
+
| --- | --- |
|
|
8
|
+
| getTRTCShareInstance | Create a `TRTCCloud` Instance (Singleton Pattern) |
|
|
9
|
+
| destroyTRTCShareInstance | Terminate `TRTCCloud` Instance (Singleton Pattern) |
|
|
10
|
+
| addCallback | Add TRTC Event Callback |
|
|
11
|
+
| removeCallback | Remove TRTC Event Callback |
|
|
12
|
+
| enterRoom | Enter Room |
|
|
13
|
+
| exitRoom | Leave Room |
|
|
14
|
+
| switchRole | Switch Role |
|
|
15
|
+
| switchRole | Switch Role (Supports Setting Permission Bit) |
|
|
16
|
+
| switchRoom | Switch Room |
|
|
17
|
+
| connectOtherRoom | Request Cross-room Communication |
|
|
18
|
+
| disconnectOtherRoom | Exit Cross-room Communication |
|
|
19
|
+
| setDefaultStreamRecvMode | Set Subscription Mode (Needs to be set before entering the room to take effect) |
|
|
20
|
+
| createSubCloud | Create Sub-room Instances (For Multi-room Concurrent Viewing) |
|
|
21
|
+
| destroySubCloud | Terminate Sub-room Instances |
|
|
22
|
+
| updateOtherRoomForwardMode | Modify the uplink capability of cross-room broadcasters in this room |
|
|
23
|
+
| startPublishMediaStream | Start publishing media stream |
|
|
24
|
+
| updatePublishMediaStream | Update the published media stream. |
|
|
25
|
+
| stopPublishMediaStream | Stop publishing media stream. |
|
|
26
|
+
| startLocalPreview | Enable the preview screen of the local camera (Mobile Terminal) |
|
|
27
|
+
| startLocalPreview | Enable the preview screen of the local camera (Desktop 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
|
+
| enableSmallVideoStream | 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
|
+
| setGravitySensorAdaptiveMode | Set gravity sensing adaptive mode (11.7 and above) |
|
|
46
|
+
| startLocalAudio | Enable collection and publishing of local audio |
|
|
47
|
+
| stopLocalAudio | Stop collection and publishing of local audio |
|
|
48
|
+
| muteLocalAudio | Pause/Resume publishing of the local audio stream |
|
|
49
|
+
| muteRemoteAudio | Pause/Resume playing of the remote audio stream |
|
|
50
|
+
| muteAllRemoteAudio | Pause/Resume playing of all remote users' audio streams |
|
|
51
|
+
| setRemoteAudioVolume | Set the playback volume for a specific remote user |
|
|
52
|
+
| setAudioCaptureVolume | Sets the local audio capture volume. |
|
|
53
|
+
| getAudioCaptureVolume | Obtains the local audio capture volume. |
|
|
54
|
+
| setAudioPlayoutVolume | Sets the remote audio playback volume. |
|
|
55
|
+
| getAudioPlayoutVolume | Obtains the remote audio playback volume. |
|
|
56
|
+
| enableAudioVolumeEvaluation | Enable volume reminder |
|
|
57
|
+
| startAudioRecording | Start recording |
|
|
58
|
+
| stopAudioRecording | Stop recording |
|
|
59
|
+
| startLocalRecording | Enable local media recording |
|
|
60
|
+
| stopLocalRecording | Stop local media recording |
|
|
61
|
+
| setRemoteAudioParallelParams | Set intelligent concurrent playback strategy for remote audio streams |
|
|
62
|
+
| enable3DSpatialAudioEffect | Enable 3D audio |
|
|
63
|
+
| updateSelf3DSpatialPosition | Set self coordinates and orientation information in 3D audio |
|
|
64
|
+
| updateRemote3DSpatialPosition | Set remote user coordinate information in 3D audio |
|
|
65
|
+
| set3DSpatialReceivingRange | Set the receivable range of sounds emitted by a specified user |
|
|
66
|
+
| getDeviceManager | Get Device Management Class (TXDeviceManager) |
|
|
67
|
+
| setBeautyStyle | Set special effects like beauty filter, whitening, and rosy skin |
|
|
68
|
+
| setWaterMark | Watermarking |
|
|
69
|
+
| getAudioEffectManager | Get Audio Effect Management Class (TXAudioEffectManager) |
|
|
70
|
+
| startSystemAudioLoopback | Enable System Sound Capture (iOS not yet supported) |
|
|
71
|
+
| stopSystemAudioLoopback | Stop System Sound Capture (iOS not yet supported) |
|
|
72
|
+
| setSystemAudioLoopbackVolume | Sets the Volume of System Sound Capture |
|
|
73
|
+
| startScreenCapture | Start Screen Sharing |
|
|
74
|
+
| stopScreenCapture | Stopping Screen Sharing |
|
|
75
|
+
| pauseScreenCapture | Pause Screen Sharing |
|
|
76
|
+
| resumeScreenCapture | Resume Screen Sharing |
|
|
77
|
+
| getScreenCaptureSources | Enumerate shareable screens and windows (this interface supports only desktop systems) |
|
|
78
|
+
| selectScreenCaptureTarget | Select the screen or window to share (this interface supports only desktop systems) |
|
|
79
|
+
| setSubStreamEncoderParam | Set Video Encoding Parameters for Screen Sharing (Sub-Stream) (Supported on Both Desktop and Mobile Systems) |
|
|
80
|
+
| setSubStreamMixVolume | Set the Mixing Volume for Screen Sharing (This Interface Supports Only Desktop Systems) |
|
|
81
|
+
| addExcludedShareWindow | Add the Specified Window to the Exclusion List of Screen Sharing (This Interface Supports Only Desktop Systems) |
|
|
82
|
+
| removeExcludedShareWindow | Remove the Specified Window from the Exclusion List of Screen Sharing (This Interface Supports Only Desktop Systems) |
|
|
83
|
+
| removeAllExcludedShareWindow | Remove All Windows from the Exclusion List of Screen Sharing (This Interface Supports Only Desktop Systems) |
|
|
84
|
+
| addIncludedShareWindow | Add the Specified Window to the Contains List of Screen Sharing (This Interface Supports Only Desktop Systems) |
|
|
85
|
+
| removeIncludedShareWindow | Remove the Specified Window from the Contains List of Screen Sharing (This Interface Supports Only Desktop Systems) |
|
|
86
|
+
| removeAllIncludedShareWindow | Remove All Windows from the Contains List of Screen Sharing (This Interface Supports Only Desktop Systems) |
|
|
87
|
+
| enableCustomVideoCapture | Enable/Disable Custom Video Capturing Mode |
|
|
88
|
+
| sendCustomVideoData | Submit Self-collected Video Frames to the SDK |
|
|
89
|
+
| enableCustomAudioCapture | Enable Custom Audio Capturing Mode |
|
|
90
|
+
| sendCustomAudioData | Submit Self-collected Audio Data to the SDK |
|
|
91
|
+
| enableMixExternalAudioFrame | Enable/Disable Custom Audio Track |
|
|
92
|
+
| mixExternalAudioFrame | Mix Custom Audio Track into the SDK |
|
|
93
|
+
| setMixExternalAudioVolume | Set the Streaming Volume and Playback Volume for External Audio Mixed During Streaming |
|
|
94
|
+
| generateCustomPTS | Generate Timestamp for Custom Capturing |
|
|
95
|
+
| enableLocalVideoCustomProcess | .1 Enable third-party beauty filter for video |
|
|
96
|
+
| setLocalVideoCustomProcessCallback | .2 Set video data callback for third-party beauty filter |
|
|
97
|
+
| setLocalVideoRenderCallback | Set Local Video Custom Rendering Callback |
|
|
98
|
+
| setRemoteVideoRenderCallback | Sets the rendering callback for remote video self-definition |
|
|
99
|
+
| setAudioFrameCallback | Sets the audio data self-definition callback |
|
|
100
|
+
| setCapturedAudioFrameCallbackFormat | Sets the callback format for audio frames captured by the local microphone |
|
|
101
|
+
| setLocalProcessedAudioFrameCallbackFormat | Sets the callback format for local audio frames after preprocessing |
|
|
102
|
+
| setMixedPlayAudioFrameCallbackFormat | Sets the callback format for audio frames that will eventually be played by the system |
|
|
103
|
+
| enableCustomAudioRendering | Enable self-definition audio playback |
|
|
104
|
+
| getCustomAudioRenderingFrame | Get playable audio data |
|
|
105
|
+
| sendCustomCmdMsg | Sends a custom message using UDP channel to all users in a room |
|
|
106
|
+
| sendSEIMsg | Sends a custom message using SEI channel to all users in a room |
|
|
107
|
+
| startSpeedTest | Start internet speed test (use before entering the room) |
|
|
108
|
+
| stopSpeedTest | Stops network speed testing |
|
|
109
|
+
| getSDKVersion | Obtains the SDK version. |
|
|
110
|
+
| setLogLevel | Sets the log output level. |
|
|
111
|
+
| setConsoleEnabled | Enables/Disables console log print. |
|
|
112
|
+
| setLogCompressEnabled | Enables/Disables local log compression |
|
|
113
|
+
| setLogDirPath | Sets the save path for local logs |
|
|
114
|
+
| setLogCallback | Log callback |
|
|
115
|
+
| showDebugView | Show Dashboard |
|
|
116
|
+
| callExperimentalAPI | Calls an experimental API. |
|
|
117
|
+
| enablePayloadPrivateEncryption | Enable or disable media stream private encryption |
|
|
675
118
|
|
|
676
119
|
## getTRTCShareInstance
|
|
677
120
|
|
|
678
|
-
|
|
679
|
-
|
|
680
121
|
#### Create a `TRTCCloud` Instance (Singleton Pattern)
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
686
|
-
</tr>
|
|
687
|
-
|
|
688
|
-
<tr>
|
|
689
|
-
<td rowspan="1" colSpan="1" >context</td>
|
|
690
|
-
|
|
691
|
-
<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>
|
|
692
|
-
</tr>
|
|
693
|
-
</table>
|
|
694
|
-
|
|
122
|
+
| Parameters | Description |
|
|
123
|
+
| --- | --- |
|
|
124
|
+
| 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. |
|
|
695
125
|
|
|
696
126
|
> **Note**
|
|
697
|
-
>
|
|
127
|
+
>
|
|
698
128
|
|
|
699
129
|
> 1. Using delete ITRTCCloud* will cause compilation errors. Please use destroyTRTCCloud to release the object pointer.
|
|
700
|
-
>
|
|
130
|
+
>
|
|
701
131
|
|
|
702
132
|
> 2. On Windows, Mac, and iOS platforms, please call the getTRTCShareInstance() interface.
|
|
703
|
-
>
|
|
133
|
+
>
|
|
704
134
|
|
|
705
135
|
> 3. On the Android platform, please call the getTRTCShareInstance(void *context) interface.
|
|
706
|
-
>
|
|
707
|
-
|
|
136
|
+
>
|
|
708
137
|
|
|
709
138
|
## destroyTRTCShareInstance
|
|
710
139
|
|
|
711
|
-
|
|
712
|
-
|
|
713
140
|
#### Terminate `TRTCCloud` Instance (Singleton Pattern)
|
|
714
141
|
|
|
715
142
|
## addCallback
|
|
716
143
|
|
|
717
|
-
|
|
718
|
-
|
|
719
144
|
#### Add TRTC Event Callback
|
|
720
145
|
|
|
721
|
-
You can obtain various event notifications from the SDK through
|
|
146
|
+
You can obtain various event notifications from the SDK through ITRTCCloudCallback (e.g., Error Code, Warning Code, Audio and Video Status Parameters, etc.).
|
|
722
147
|
|
|
723
148
|
## removeCallback
|
|
724
149
|
|
|
725
|
-
|
|
726
|
-
|
|
727
150
|
#### Remove TRTC Event Callback
|
|
728
151
|
|
|
729
152
|
## enterRoom
|
|
730
153
|
|
|
731
|
-
|
|
732
|
-
|
|
733
154
|
#### Enter Room
|
|
734
155
|
|
|
735
156
|
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.
|
|
736
157
|
|
|
737
|
-
To call this interface, you need to specify your application scenario
|
|
738
|
-
|
|
739
|
-
|
|
158
|
+
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:
|
|
740
159
|
|
|
741
160
|
**Real-time Call:**
|
|
742
161
|
|
|
743
|
-
Includes
|
|
744
|
-
|
|
745
|
-
|
|
162
|
+
Includes TRTCAppSceneVideoCall and TRTCAppSceneAudioCall as two options: video call and audio call. This mode is suitable for 1-on-1 audio and video calls or online meetings with up to 300 participants.
|
|
746
163
|
|
|
747
164
|
**Online Live Streaming:**
|
|
748
165
|
|
|
749
|
-
Includes
|
|
750
|
-
|
|
751
|
-
|
|
166
|
+
Includes TRTCAppSceneLIVE and TRTCAppSceneVoiceChatRoom as two options: video live streaming and voice live streaming. This mode is suitable for online live streaming scenarios with up to 100,000 participants. However, you need to specify the **role** field in the TRTCParams parameter introduced later, distinguishing users in the room into two different roles: **Anchor** (TRTCRoleAnchor) and **Audience** (TRTCRoleAudience).
|
|
752
167
|
|
|
753
|
-
After calling this interface, you will receive the onEnterRoom(result) callback from
|
|
168
|
+
After calling this interface, you will receive the onEnterRoom(result) callback from ITRTCCloudCallback:
|
|
754
169
|
- 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).
|
|
755
170
|
|
|
756
171
|
- 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).
|
|
757
172
|
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
763
|
-
</tr>
|
|
764
|
-
|
|
765
|
-
<tr>
|
|
766
|
-
<td rowspan="1" colSpan="1" >param</td>
|
|
767
|
-
|
|
768
|
-
<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/87030132707430400).</td>
|
|
769
|
-
</tr>
|
|
770
|
-
|
|
771
|
-
<tr>
|
|
772
|
-
<td rowspan="1" colSpan="1" >scene</td>
|
|
773
|
-
|
|
774
|
-
<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/87030132707430400).</td>
|
|
775
|
-
</tr>
|
|
776
|
-
</table>
|
|
777
|
-
|
|
173
|
+
| Parameters | Description |
|
|
174
|
+
| --- | --- |
|
|
175
|
+
| param | Room entry parameters are used to specify the user's identity, role, and security token information. For details, please refer to TRTCParams. |
|
|
176
|
+
| scene | Application scenario parameters are used to specify your business scenario. All users in the same room need to set the same TRTCAppScene. |
|
|
778
177
|
|
|
779
178
|
> **Note**
|
|
780
|
-
>
|
|
179
|
+
>
|
|
781
180
|
|
|
782
181
|
> 1. All users in the same room need to set the same scene. Different scenes can occasionally lead to anomalies.
|
|
783
|
-
>
|
|
182
|
+
>
|
|
784
183
|
|
|
785
|
-
> 2. When you set the parameter scene to
|
|
786
|
-
>
|
|
787
|
-
|
|
788
|
-
> 3. Please ensure that [enterRoom](https://write.woa.com/document/87030026264555520) and [exitRoom](https://write.woa.com/document/87030026264555520) are paired before and after use, i.e., ensure "exit the previous room before entering the next room," otherwise, many anomalies may occur.
|
|
789
|
-
>
|
|
184
|
+
> 2. When you set the parameter scene to TRTCAppSceneLIVE or TRTCAppSceneVoiceChatRoom, you must use the "role" field in TRTCParams to set the role of the current user in the room.
|
|
185
|
+
>
|
|
790
186
|
|
|
187
|
+
> 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.
|
|
188
|
+
>
|
|
791
189
|
|
|
792
190
|
## exitRoom
|
|
793
191
|
|
|
794
|
-
|
|
795
|
-
|
|
796
192
|
#### Leave Room
|
|
797
193
|
|
|
798
194
|
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.
|
|
799
195
|
|
|
800
|
-
After the resources are fully released, the SDK will notify you via the
|
|
801
|
-
|
|
802
|
-
|
|
196
|
+
After the resources are fully released, the SDK will notify you via the ITRTCCloudCallback in the onExitRoom callback.
|
|
803
197
|
|
|
804
|
-
If you want to call
|
|
198
|
+
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.
|
|
805
199
|
|
|
806
200
|
## switchRole
|
|
807
201
|
|
|
808
|
-
|
|
809
|
-
|
|
810
202
|
#### Switch Role
|
|
811
203
|
|
|
812
204
|
This interface allows users to switch between the roles of `Anchor` and `Audience`.
|
|
813
205
|
|
|
814
|
-
|
|
815
|
-
|
|
816
206
|
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.
|
|
817
207
|
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
<tr>
|
|
823
|
-
<td rowspan="1" colSpan="1" >Parameters</td>
|
|
824
|
-
|
|
825
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
826
|
-
</tr>
|
|
827
|
-
|
|
828
|
-
<tr>
|
|
829
|
-
<td rowspan="1" colSpan="1" >role</td>
|
|
830
|
-
|
|
831
|
-
<td rowspan="1" colSpan="1" >Role, defaults to **Anchor**.<br>- [TRTCRoleAnchor](https://write.woa.com/document/87030132707430400): 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/87030132707430400): 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/87030026264555520) interface. A maximum of 100,000 audience members can be accommodated in the same room.</td>
|
|
832
|
-
</tr>
|
|
833
|
-
</table>
|
|
834
|
-
|
|
208
|
+
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.
|
|
209
|
+
| Parameters | Description |
|
|
210
|
+
| --- | --- |
|
|
211
|
+
| 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. |
|
|
835
212
|
|
|
836
213
|
> **Note**
|
|
837
|
-
>
|
|
838
|
-
|
|
839
|
-
> 1. This interface is only applicable to video live streaming ([TRTCAppSceneLIVE](https://write.woa.com/document/87030132707430400)) and voice chat room ([TRTCAppSceneVoiceChatRoom](https://write.woa.com/document/87030132707430400)) scenarios.
|
|
840
|
-
>
|
|
214
|
+
>
|
|
841
215
|
|
|
842
|
-
>
|
|
843
|
-
>
|
|
216
|
+
> 1. This interface is only applicable to video live streaming (TRTCAppSceneLIVE) and voice chat room (TRTCAppSceneVoiceChatRoom) scenarios.
|
|
217
|
+
>
|
|
844
218
|
|
|
219
|
+
> 2. If the scene specified in enterRoom is TRTCAppSceneVideoCall or TRTCAppSceneAudioCall, do not call this interface.
|
|
220
|
+
>
|
|
845
221
|
|
|
846
222
|
## switchRole
|
|
847
223
|
|
|
848
|
-
|
|
849
|
-
|
|
850
224
|
#### Switch Role (Supports Setting Permission Bit)
|
|
851
225
|
|
|
852
226
|
This interface allows users to switch between the roles of `Anchor` and `Audience`.
|
|
853
227
|
|
|
854
|
-
|
|
855
|
-
|
|
856
228
|
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".
|
|
857
229
|
|
|
858
230
|
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".
|
|
859
231
|
|
|
860
|
-
When entering a room, you can predefine the user's role using the role field in
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
|
|
865
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
866
|
-
</tr>
|
|
867
|
-
|
|
868
|
-
<tr>
|
|
869
|
-
<td rowspan="1" colSpan="1" >privateMapKey</td>
|
|
870
|
-
|
|
871
|
-
<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>
|
|
872
|
-
</tr>
|
|
873
|
-
|
|
874
|
-
<tr>
|
|
875
|
-
<td rowspan="1" colSpan="1" >role</td>
|
|
876
|
-
|
|
877
|
-
<td rowspan="1" colSpan="1" >Role, defaults to "Anchor":<br>- [TRTCRoleAnchor](https://write.woa.com/document/87030132707430400): 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/87030132707430400): 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/87030026264555520). A maximum of 100,000 audience members can be accommodated in the same room.</td>
|
|
878
|
-
</tr>
|
|
879
|
-
</table>
|
|
880
|
-
|
|
232
|
+
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.
|
|
233
|
+
| Parameters | Description |
|
|
234
|
+
| --- | --- |
|
|
235
|
+
| 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). |
|
|
236
|
+
| 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. |
|
|
881
237
|
|
|
882
238
|
> **Note**
|
|
883
|
-
>
|
|
884
|
-
|
|
885
|
-
> 1. This interface is only applicable to video live streaming ([TRTCAppSceneLIVE](https://write.woa.com/document/87030132707430400)) and voice chat room ([TRTCAppSceneVoiceChatRoom](https://write.woa.com/document/87030132707430400)) scenarios.
|
|
886
|
-
>
|
|
239
|
+
>
|
|
887
240
|
|
|
888
|
-
>
|
|
889
|
-
>
|
|
241
|
+
> 1. This interface is only applicable to video live streaming (TRTCAppSceneLIVE) and voice chat room (TRTCAppSceneVoiceChatRoom) scenarios.
|
|
242
|
+
>
|
|
890
243
|
|
|
244
|
+
> 2. If the scene specified in enterRoom is TRTCAppSceneVideoCall or TRTCAppSceneAudioCall, do not call this interface.
|
|
245
|
+
>
|
|
891
246
|
|
|
892
247
|
## switchRoom
|
|
893
248
|
|
|
894
|
-
|
|
895
|
-
|
|
896
249
|
#### Switch Room
|
|
897
250
|
|
|
898
251
|
This interface allows users to quickly switch from one room to another.
|
|
@@ -900,74 +253,44 @@ This interface allows users to quickly switch from one room to another.
|
|
|
900
253
|
|
|
901
254
|
- 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.
|
|
902
255
|
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
256
|
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.
|
|
907
257
|
|
|
908
|
-
The result of the interface call will be notified to you through the onSwitchRoom(errCode, errMsg) callback in
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
914
|
-
</tr>
|
|
915
|
-
|
|
916
|
-
<tr>
|
|
917
|
-
<td rowspan="1" colSpan="1" >config</td>
|
|
918
|
-
|
|
919
|
-
<td rowspan="1" colSpan="1" >For room parameters, please refer to [TRTCSwitchRoomConfig](https://write.woa.com/document/87030132707430400).</td>
|
|
920
|
-
</tr>
|
|
921
|
-
</table>
|
|
922
|
-
|
|
258
|
+
The result of the interface call will be notified to you through the onSwitchRoom(errCode, errMsg) callback in ITRTCCloudCallback.
|
|
259
|
+
| Parameters | Description |
|
|
260
|
+
| --- | --- |
|
|
261
|
+
| config | For room parameters, please refer to TRTCSwitchRoomConfig. |
|
|
923
262
|
|
|
924
263
|
> **Note**
|
|
925
|
-
>
|
|
264
|
+
>
|
|
926
265
|
|
|
927
266
|
> 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:
|
|
928
|
-
>
|
|
267
|
+
>
|
|
929
268
|
|
|
930
269
|
> 1. If you choose strRoomId, then roomId needs to be set to 0. If both are filled, roomId will be selected by default.
|
|
931
|
-
>
|
|
270
|
+
>
|
|
932
271
|
|
|
933
272
|
> 2. All rooms must either use strRoomId or roomId consistently. Mixing both will result in unexpected bugs.
|
|
934
|
-
>
|
|
935
|
-
|
|
273
|
+
>
|
|
936
274
|
|
|
937
275
|
## connectOtherRoom
|
|
938
276
|
|
|
939
|
-
|
|
940
|
-
|
|
941
277
|
#### Request Cross-room Communication
|
|
942
278
|
|
|
943
279
|
By default, only users within the same room can make audio and video calls. Audio and video streams in different rooms are isolated.
|
|
944
280
|
|
|
945
281
|
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.
|
|
946
282
|
|
|
947
|
-
|
|
948
|
-
|
|
949
283
|
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.
|
|
950
284
|
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
The result of the cross-room call request will be notified to you via the [ITRTCCloudCallback](https://write.woa.com/document/87030021158866944) in the [onConnectOtherRoom](https://write.woa.com/document/87030021158866944) callback.
|
|
954
|
-
|
|
955
|
-
|
|
285
|
+
The result of the cross-room call request will be notified to you via the ITRTCCloudCallback in the onConnectOtherRoom callback.
|
|
956
286
|
|
|
957
287
|
For example, when Host A in room "101" establishes a cross-room call with Host B in room "102" using connectOtherRoom(),
|
|
958
288
|
- 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.
|
|
959
289
|
|
|
960
290
|
- 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.
|
|
961
291
|
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-

|
|
966
|
-
|
|
967
292
|
To consider compatibility issues with subsequent extension fields, the parameters for cross-room communication temporarily use JSON format:
|
|
968
293
|
|
|
969
|
-
|
|
970
|
-
|
|
971
294
|
**Case 1: Numeric Room Number**
|
|
972
295
|
|
|
973
296
|
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"}
|
|
@@ -982,8 +305,6 @@ Below is the sample code:
|
|
|
982
305
|
trtc.ConnectOtherRoom(params.c_str());
|
|
983
306
|
```
|
|
984
307
|
|
|
985
|
-
|
|
986
|
-
|
|
987
308
|
**Case 2: String Room Number**
|
|
988
309
|
|
|
989
310
|
If you are using a string room number, be sure to replace "roomId" in the JSON with "strRoomId": {"strRoomId": "102", "userId": "userB"}
|
|
@@ -997,97 +318,54 @@ Below is the sample code:
|
|
|
997
318
|
std::string params = writer.write(jsonObj);
|
|
998
319
|
trtc.ConnectOtherRoom(params.c_str());
|
|
999
320
|
```
|
|
1000
|
-
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1005
|
-
</tr>
|
|
1006
|
-
|
|
1007
|
-
<tr>
|
|
1008
|
-
<td rowspan="1" colSpan="1" >param</td>
|
|
1009
|
-
|
|
1010
|
-
<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>
|
|
1011
|
-
</tr>
|
|
1012
|
-
</table>
|
|
1013
|
-
|
|
321
|
+
| Parameters | Description |
|
|
322
|
+
| --- | --- |
|
|
323
|
+
| 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. |
|
|
1014
324
|
|
|
1015
325
|
## disconnectOtherRoom
|
|
1016
326
|
|
|
1017
|
-
|
|
1018
|
-
|
|
1019
327
|
#### Exit Cross-room Communication
|
|
1020
328
|
|
|
1021
|
-
The exit result will be notified to you via the
|
|
329
|
+
The exit result will be notified to you via the ITRTCCloudCallback in the onDisconnectOtherRoom callback.
|
|
1022
330
|
|
|
1023
331
|
## setDefaultStreamRecvMode
|
|
1024
332
|
|
|
1025
|
-
|
|
1026
|
-
|
|
1027
333
|
#### Set Subscription Mode (Needs to be set before entering the room to take effect)
|
|
1028
334
|
|
|
1029
335
|
You can switch between "auto-subscribe" and "manual subscribe" modes via this interface:
|
|
1030
|
-
- 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
|
|
1031
|
-
|
|
1032
|
-
- Manual subscription: After the user enters the room, they need to manually call the [startRemoteView](https://write.woa.com/document/87030026264555520) interface to start the subscription and decoding of the video stream. They need to manually call the [muteRemoteAudio](https://write.woa.com/document/87030026264555520)(false) interface to start the playback of the sound.
|
|
1033
|
-
|
|
1034
|
-
|
|
336
|
+
- 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).
|
|
1035
337
|
|
|
338
|
+
- 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.
|
|
1036
339
|
|
|
1037
340
|
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".
|
|
1038
341
|
|
|
1039
342
|
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.
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1045
|
-
</tr>
|
|
1046
|
-
|
|
1047
|
-
<tr>
|
|
1048
|
-
<td rowspan="1" colSpan="1" >autoRecvAudio</td>
|
|
1049
|
-
|
|
1050
|
-
<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>
|
|
1051
|
-
</tr>
|
|
1052
|
-
|
|
1053
|
-
<tr>
|
|
1054
|
-
<td rowspan="1" colSpan="1" >autoRecvVideo</td>
|
|
1055
|
-
|
|
1056
|
-
<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>
|
|
1057
|
-
</tr>
|
|
1058
|
-
</table>
|
|
1059
|
-
|
|
343
|
+
| Parameters | Description |
|
|
344
|
+
| --- | --- |
|
|
345
|
+
| autoRecvAudio | true: Automatically subscribe to audio; false: You need to manually call muteRemoteAudio(false) to subscribe to audio. Default value: true. |
|
|
346
|
+
| autoRecvVideo | true: Automatically subscribe to video; false: You need to manually call startRemoteView to subscribe to video. Default value: true. |
|
|
1060
347
|
|
|
1061
348
|
> **Note**
|
|
1062
|
-
>
|
|
349
|
+
>
|
|
1063
350
|
|
|
1064
351
|
> 1. This setting needs to be called before entering the room to take effect.
|
|
1065
|
-
>
|
|
1066
|
-
|
|
1067
|
-
> 2. In automatic subscription mode, if the user does not call [startRemoteView](https://write.woa.com/document/87030026264555520) to subscribe to the video stream after entering the room, the SDK will automatically stop subscribing to the video stream to save traffic.
|
|
1068
|
-
>
|
|
352
|
+
>
|
|
1069
353
|
|
|
354
|
+
> 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.
|
|
355
|
+
>
|
|
1070
356
|
|
|
1071
357
|
## createSubCloud
|
|
1072
358
|
|
|
1073
|
-
|
|
1074
|
-
|
|
1075
359
|
#### Create Sub-room Instances (For Multi-room Concurrent Viewing)
|
|
1076
360
|
|
|
1077
361
|
TRTCCloud was initially designed as a Singleton Pattern, limiting the ability to watch multiple rooms concurrently.
|
|
1078
362
|
|
|
1079
363
|
By calling this interface, you can create multiple TRTCCloud instances to watch audio and video streams from multiple rooms simultaneously.
|
|
1080
364
|
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
365
|
However, please note that the ability to publish audio and video streams across multiple TRTCCloud instances is subject to certain restrictions.
|
|
1084
366
|
|
|
1085
|
-
|
|
1086
|
-
|
|
1087
367
|
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".
|
|
1088
368
|
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
369
|
Below is the sample code:
|
|
1092
370
|
``` cpp
|
|
1093
371
|
//In the small room that needs interaction, enter the room as an anchor and push audio and video streams
|
|
@@ -1099,7 +377,7 @@ Below is the sample code:
|
|
|
1099
377
|
//...
|
|
1100
378
|
mainCloud->startLocalAudio(TRTCAudioQualityDefault);
|
|
1101
379
|
mainCloud->startLocalPreview(renderView);
|
|
1102
|
-
|
|
380
|
+
|
|
1103
381
|
//In the large room that only needs to watch, enter the room as an audience and pull audio and video streams
|
|
1104
382
|
ITRTCCloud *subCloud = mainCloud->createSubCloud();
|
|
1105
383
|
TRTCParams subParams;
|
|
@@ -1115,14 +393,13 @@ Below is the sample code:
|
|
|
1115
393
|
```
|
|
1116
394
|
|
|
1117
395
|
> **Note**
|
|
1118
|
-
>
|
|
396
|
+
>
|
|
1119
397
|
> - The same user can enter multiple rooms with different roomIds using the same userId.
|
|
1120
398
|
> - Two different terminal devices cannot use the same userId to enter the same roomId simultaneously.
|
|
1121
|
-
> - You can set
|
|
399
|
+
> - You can set ITRTCCloudCallback for different instances to get their respective event notifications.
|
|
1122
400
|
> - The same user can stream on multiple TRTCCloud instances and call interfaces related to local audio and video in sub-instances. However, please note:
|
|
1123
401
|
> - 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
|
|
1124
|
-
> - Calls related to the camera will take the last one as definitive:
|
|
1125
|
-
|
|
402
|
+
> - Calls related to the camera will take the last one as definitive: startLocalPreview.
|
|
1126
403
|
|
|
1127
404
|
#### Return value description:
|
|
1128
405
|
|
|
@@ -1130,28 +407,13 @@ Sub TRTCCloud instances
|
|
|
1130
407
|
|
|
1131
408
|
## destroySubCloud
|
|
1132
409
|
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
410
|
#### Terminate Sub-room Instances
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1141
|
-
</tr>
|
|
1142
|
-
|
|
1143
|
-
<tr>
|
|
1144
|
-
<td rowspan="1" colSpan="1" >subCloud</td>
|
|
1145
|
-
|
|
1146
|
-
<td rowspan="1" colSpan="1" >Sub-room instances</td>
|
|
1147
|
-
</tr>
|
|
1148
|
-
</table>
|
|
1149
|
-
|
|
411
|
+
| Parameters | Description |
|
|
412
|
+
| --- | --- |
|
|
413
|
+
| subCloud | Sub-room instances |
|
|
1150
414
|
|
|
1151
415
|
## updateOtherRoomForwardMode
|
|
1152
416
|
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
417
|
#### Modify the uplink capability of cross-room broadcasters in this room
|
|
1156
418
|
|
|
1157
419
|
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.
|
|
@@ -1160,32 +422,20 @@ You can call this interface to restrict the uplink capability of a cross-room br
|
|
|
1160
422
|
|
|
1161
423
|
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.
|
|
1162
424
|
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
425
|
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.
|
|
1166
426
|
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
The result of calling this interface will be notified to you via the [ITRTCCloudCallback](https://write.woa.com/document/87030021158866944) in the [onUpdateOtherRoomForwardMode](https://write.woa.com/document/87030021158866944) callback.
|
|
1170
|
-
|
|
1171
|
-
|
|
427
|
+
The result of calling this interface will be notified to you via the ITRTCCloudCallback in the onUpdateOtherRoomForwardMode callback.
|
|
1172
428
|
|
|
1173
429
|
For example:
|
|
1174
430
|
|
|
1175
431
|
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().
|
|
1176
432
|
- 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.
|
|
1177
433
|
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
434
|
Later, Host A calls this interface to disable Host C's ability to publish audio in the current room.
|
|
1182
435
|
- 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).
|
|
1183
436
|
|
|
1184
437
|
- 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.
|
|
1185
438
|
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
439
|
To consider compatibility issues with subsequent extension fields, the parameters for this interface temporarily use JSON format. The example is as follows:
|
|
1190
440
|
|
|
1191
441
|
**Case 1: Numeric Room Number**
|
|
@@ -1199,8 +449,6 @@ To consider compatibility issues with subsequent extension fields, the parameter
|
|
|
1199
449
|
}
|
|
1200
450
|
```
|
|
1201
451
|
|
|
1202
|
-
|
|
1203
|
-
|
|
1204
452
|
**Case 2: String Room Number**
|
|
1205
453
|
``` cpp
|
|
1206
454
|
{
|
|
@@ -1211,199 +459,100 @@ To consider compatibility issues with subsequent extension fields, the parameter
|
|
|
1211
459
|
"muteSubStream":false
|
|
1212
460
|
}
|
|
1213
461
|
```
|
|
1214
|
-
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1219
|
-
</tr>
|
|
1220
|
-
|
|
1221
|
-
<tr>
|
|
1222
|
-
<td rowspan="1" colSpan="1" >param</td>
|
|
1223
|
-
|
|
1224
|
-
<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>
|
|
1225
|
-
</tr>
|
|
1226
|
-
</table>
|
|
1227
|
-
|
|
462
|
+
| Parameters | Description |
|
|
463
|
+
| --- | --- |
|
|
464
|
+
| 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. |
|
|
1228
465
|
|
|
1229
466
|
## startPublishMediaStream
|
|
1230
467
|
|
|
1231
|
-
|
|
1232
|
-
|
|
1233
468
|
#### Start publishing media stream
|
|
1234
469
|
|
|
1235
|
-
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
|
|
1236
|
-
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
|
|
1241
|
-
</tr>
|
|
1242
|
-
|
|
1243
|
-
<tr>
|
|
1244
|
-
<td rowspan="1" colSpan="1" >config</td>
|
|
1245
|
-
|
|
1246
|
-
<td rowspan="1" colSpan="1" >Media stream transcoding configuration parameters. Refer to [TRTCStreamMixingConfig](https://write.woa.com/document/87030132707430400) 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>
|
|
1247
|
-
</tr>
|
|
1248
|
-
|
|
1249
|
-
<tr>
|
|
1250
|
-
<td rowspan="1" colSpan="1" >params</td>
|
|
1251
|
-
|
|
1252
|
-
<td rowspan="1" colSpan="1" >Media stream encoding output parameters. Refer to [TRTCStreamEncoderParam](https://write.woa.com/document/87030132707430400) 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>
|
|
1253
|
-
</tr>
|
|
1254
|
-
|
|
1255
|
-
<tr>
|
|
1256
|
-
<td rowspan="1" colSpan="1" >target</td>
|
|
1257
|
-
|
|
1258
|
-
<td rowspan="1" colSpan="1" >The target address for media stream publishing. Refer to [TRTCPublishTarget](https://write.woa.com/document/87030132707430400) for detailed configuration. Supports relay/transcoding to Tencent or third-party CDNs, and also supports transcoding pushback to the TRTC room.</td>
|
|
1259
|
-
</tr>
|
|
1260
|
-
</table>
|
|
1261
|
-
|
|
470
|
+
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
|
|
471
|
+
| Parameters | Description |
|
|
472
|
+
| --- | --- |
|
|
473
|
+
| 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. |
|
|
474
|
+
| 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. |
|
|
475
|
+
| 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. |
|
|
1262
476
|
|
|
1263
477
|
> **Note**
|
|
1264
|
-
>
|
|
478
|
+
>
|
|
1265
479
|
|
|
1266
|
-
> 1. The SDK will provide the task identifier (taskId) for the backend startup through the callback
|
|
1267
|
-
>
|
|
480
|
+
> 1. The SDK will provide the task identifier (taskId) for the backend startup through the callback onStartPublishMediaStream.
|
|
481
|
+
>
|
|
1268
482
|
|
|
1269
|
-
> 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
|
|
1270
|
-
>
|
|
483
|
+
> 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.
|
|
484
|
+
>
|
|
1271
485
|
|
|
1272
486
|
> 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.
|
|
1273
|
-
>
|
|
487
|
+
>
|
|
1274
488
|
|
|
1275
489
|
> 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.
|
|
1276
|
-
>
|
|
1277
|
-
|
|
490
|
+
>
|
|
1278
491
|
|
|
1279
492
|
## updatePublishMediaStream
|
|
1280
493
|
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
494
|
#### Update the published media stream.
|
|
1284
495
|
|
|
1285
|
-
This interface will send directives to the TRTC server to update the media stream started by
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
<tr>
|
|
1294
|
-
<td rowspan="1" colSpan="1" >config</td>
|
|
1295
|
-
|
|
1296
|
-
<td rowspan="1" colSpan="1" >Media stream transcoding configuration parameters. Refer to [TRTCStreamMixingConfig](https://write.woa.com/document/87030132707430400) 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>
|
|
1297
|
-
</tr>
|
|
1298
|
-
|
|
1299
|
-
<tr>
|
|
1300
|
-
<td rowspan="1" colSpan="1" >params</td>
|
|
1301
|
-
|
|
1302
|
-
<td rowspan="1" colSpan="1" >Media stream encoding output parameters. Refer to [TRTCStreamEncoderParam](https://write.woa.com/document/87030132707430400) 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>
|
|
1303
|
-
</tr>
|
|
1304
|
-
|
|
1305
|
-
<tr>
|
|
1306
|
-
<td rowspan="1" colSpan="1" >target</td>
|
|
1307
|
-
|
|
1308
|
-
<td rowspan="1" colSpan="1" >The target address for media stream publishing. Refer to [TRTCPublishTarget](https://write.woa.com/document/87030132707430400) for detailed configuration. Supports relay/transcoding to Tencent or third-party CDNs, and also supports transcoding pushback to the TRTC room.</td>
|
|
1309
|
-
</tr>
|
|
1310
|
-
|
|
1311
|
-
<tr>
|
|
1312
|
-
<td rowspan="1" colSpan="1" >taskId</td>
|
|
1313
|
-
|
|
1314
|
-
<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/87030021158866944) callback</td>
|
|
1315
|
-
</tr>
|
|
1316
|
-
</table>
|
|
1317
|
-
|
|
496
|
+
This interface will send directives to the TRTC server to update the media stream started by startPublishMediaStream
|
|
497
|
+
| Parameters | Description |
|
|
498
|
+
| --- | --- |
|
|
499
|
+
| 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. |
|
|
500
|
+
| 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. |
|
|
501
|
+
| 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. |
|
|
502
|
+
| taskId | It will provide you with the task identifier (i.e., taskId) for the background start task through the onStartPublishMediaStream callback |
|
|
1318
503
|
|
|
1319
504
|
> **Note**
|
|
1320
|
-
>
|
|
505
|
+
>
|
|
1321
506
|
|
|
1322
507
|
> 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.
|
|
1323
|
-
>
|
|
508
|
+
>
|
|
1324
509
|
|
|
1325
|
-
> 2. You can update or adjust relay/transcoding tasks using taskId. For example, in PK business, you can initiate relay through
|
|
1326
|
-
>
|
|
510
|
+
> 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).
|
|
511
|
+
>
|
|
1327
512
|
|
|
1328
513
|
> 3. The same task does not support switching between Audio Only, Audio and Video, and Pure Video.
|
|
1329
|
-
>
|
|
1330
|
-
|
|
514
|
+
>
|
|
1331
515
|
|
|
1332
516
|
## stopPublishMediaStream
|
|
1333
517
|
|
|
1334
|
-
|
|
1335
|
-
|
|
1336
518
|
#### Stop publishing media stream.
|
|
1337
519
|
|
|
1338
|
-
This interface will send directives to the TRTC server to stop the media stream started by
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1344
|
-
</tr>
|
|
1345
|
-
|
|
1346
|
-
<tr>
|
|
1347
|
-
<td rowspan="1" colSpan="1" >taskId</td>
|
|
1348
|
-
|
|
1349
|
-
<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/87030021158866944) callback</td>
|
|
1350
|
-
</tr>
|
|
1351
|
-
</table>
|
|
1352
|
-
|
|
520
|
+
This interface will send directives to the TRTC server to stop the media stream started by startPublishMediaStream
|
|
521
|
+
| Parameters | Description |
|
|
522
|
+
| --- | --- |
|
|
523
|
+
| taskId | It will provide you with the task identifier (i.e., taskId) for the background start task through the onStartPublishMediaStream callback |
|
|
1353
524
|
|
|
1354
525
|
> **Note**
|
|
1355
|
-
>
|
|
526
|
+
>
|
|
1356
527
|
|
|
1357
|
-
> 1. If your business backend has not saved the taskId, after your host re-enters the room following an abnormal exit, you can call
|
|
1358
|
-
>
|
|
1359
|
-
|
|
1360
|
-
> 2. If the taskId is an empty string, all media streams started by [startPublishMediaStream](https://write.woa.com/document/87030026264555520) 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.
|
|
1361
|
-
>
|
|
528
|
+
> 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
|
|
529
|
+
>
|
|
1362
530
|
|
|
531
|
+
> 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.
|
|
532
|
+
>
|
|
1363
533
|
|
|
1364
534
|
## startLocalPreview
|
|
1365
535
|
|
|
1366
|
-
|
|
1367
|
-
|
|
1368
536
|
#### Enable the preview screen of the local camera (Mobile Terminal)
|
|
1369
537
|
|
|
1370
538
|
Call this function before enterRoom. The SDK will only enable the camera and wait until you call enterRoom to start streaming.
|
|
1371
539
|
|
|
1372
|
-
After calling this function after enterRoom, the SDK will enable the Camera and automatically start Video Push Streaming. When the first frame of the camera image starts to render, you will receive the onCameraDidReady callback notification from
|
|
1373
|
-
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1378
|
-
</tr>
|
|
1379
|
-
|
|
1380
|
-
<tr>
|
|
1381
|
-
<td rowspan="1" colSpan="1" >frontCamera</td>
|
|
1382
|
-
|
|
1383
|
-
<td rowspan="1" colSpan="1" >true: Front-facing camera; false: Rear-facing camera.</td>
|
|
1384
|
-
</tr>
|
|
1385
|
-
|
|
1386
|
-
<tr>
|
|
1387
|
-
<td rowspan="1" colSpan="1" >view</td>
|
|
1388
|
-
|
|
1389
|
-
<td rowspan="1" colSpan="1" >Control carrying the video screen.</td>
|
|
1390
|
-
</tr>
|
|
1391
|
-
</table>
|
|
1392
|
-
|
|
540
|
+
After calling this function after enterRoom, the SDK will enable the Camera and automatically start Video Push Streaming. When the first frame of the camera image starts to render, you will receive the onCameraDidReady callback notification from ITRTCCloudCallback.
|
|
541
|
+
| Parameters | Description |
|
|
542
|
+
| --- | --- |
|
|
543
|
+
| frontCamera | true: Front-facing camera; false: Rear-facing camera. |
|
|
544
|
+
| view | Control carrying the video screen. |
|
|
1393
545
|
|
|
1394
546
|
> **Note**
|
|
1395
|
-
>
|
|
547
|
+
>
|
|
1396
548
|
|
|
1397
549
|
> If you wish to preview the camera screen and use BeautyManager to adjust the beauty parameters before streaming, you can:
|
|
1398
|
-
>
|
|
550
|
+
>
|
|
1399
551
|
> - Option 1: Call startLocalPreview before enterRoom.
|
|
1400
552
|
> - Option 2: Call startLocalPreview + muteLocalVideo(true) after enterRoom.
|
|
1401
553
|
|
|
1402
|
-
|
|
1403
554
|
## startLocalPreview
|
|
1404
555
|
|
|
1405
|
-
|
|
1406
|
-
|
|
1407
556
|
#### Enable the preview screen of the local camera (Desktop Terminal)
|
|
1408
557
|
|
|
1409
558
|
Before calling this interface, you can call setCurrentCameraDevice to choose between the Mac's built-in camera or an external camera.
|
|
@@ -1413,46 +562,28 @@ Call this function before enterRoom. The SDK will only enable the camera and wai
|
|
|
1413
562
|
Call this function after enterRoom. The SDK will enable the camera and automatically begin video streaming.
|
|
1414
563
|
|
|
1415
564
|
When the first frame of the camera image starts to render, you will receive the onCameraDidReady callback notification from TRTCCloudDelegate.
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1421
|
-
</tr>
|
|
1422
|
-
|
|
1423
|
-
<tr>
|
|
1424
|
-
<td rowspan="1" colSpan="1" >view</td>
|
|
1425
|
-
|
|
1426
|
-
<td rowspan="1" colSpan="1" >Control carrying the video screen.</td>
|
|
1427
|
-
</tr>
|
|
1428
|
-
</table>
|
|
1429
|
-
|
|
565
|
+
| Parameters | Description |
|
|
566
|
+
| --- | --- |
|
|
567
|
+
| view | Control carrying the video screen. |
|
|
1430
568
|
|
|
1431
569
|
> **Note**
|
|
1432
|
-
>
|
|
570
|
+
>
|
|
1433
571
|
|
|
1434
572
|
> If you wish to preview the camera screen and use BeautyManager to adjust the beauty parameters before streaming, you can:
|
|
1435
|
-
>
|
|
573
|
+
>
|
|
1436
574
|
> - Option 1: Call startLocalPreview before enterRoom.
|
|
1437
575
|
> - Option 2: Call startLocalPreview + muteLocalVideo(true) after enterRoom.
|
|
1438
576
|
|
|
1439
|
-
|
|
1440
577
|
## updateLocalView
|
|
1441
578
|
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
579
|
#### Update the preview screen of the local camera
|
|
1445
580
|
|
|
1446
581
|
## stopLocalPreview
|
|
1447
582
|
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
583
|
#### Stop camera preview
|
|
1451
584
|
|
|
1452
585
|
## muteLocalVideo
|
|
1453
586
|
|
|
1454
|
-
|
|
1455
|
-
|
|
1456
587
|
#### Suspend/Resume publishing local video stream
|
|
1457
588
|
|
|
1458
589
|
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.
|
|
@@ -1463,414 +594,187 @@ Because start/stopLocalPreview requires turning on and off the camera, and turni
|
|
|
1463
594
|
|
|
1464
595
|
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.
|
|
1465
596
|
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
597
|
When suspending/recovering the publishing of the specified TRTCVideoStreamTypeBig, other users in the same room will receive the onUserVideoAvailable callback notification.
|
|
1469
598
|
|
|
1470
599
|
When suspending/recovering the publishing of the specified TRTCVideoStreamTypeSub, other users in the same room will receive the onUserSubStreamAvailable callback notification.
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
|
|
1475
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1476
|
-
</tr>
|
|
1477
|
-
|
|
1478
|
-
<tr>
|
|
1479
|
-
<td rowspan="1" colSpan="1" >mute</td>
|
|
1480
|
-
|
|
1481
|
-
<td rowspan="1" colSpan="1" >true: pause; false: resume.</td>
|
|
1482
|
-
</tr>
|
|
1483
|
-
|
|
1484
|
-
<tr>
|
|
1485
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
1486
|
-
|
|
1487
|
-
<td rowspan="1" colSpan="1" >The video stream type to be suspended/recovered (only supports [TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400) and [TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400)).</td>
|
|
1488
|
-
</tr>
|
|
1489
|
-
</table>
|
|
1490
|
-
|
|
600
|
+
| Parameters | Description |
|
|
601
|
+
| --- | --- |
|
|
602
|
+
| mute | true: pause; false: resume. |
|
|
603
|
+
| streamType | The video stream type to be suspended/recovered (only supports TRTCVideoStreamTypeBig and TRTCVideoStreamTypeSub). |
|
|
1491
604
|
|
|
1492
605
|
## setVideoMuteImage
|
|
1493
606
|
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
607
|
#### Set the alternative image during the suspension of the local screen
|
|
1497
608
|
|
|
1498
609
|
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.
|
|
1499
|
-
|
|
1500
|
-
|
|
1501
|
-
|
|
1502
|
-
|
|
1503
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1504
|
-
</tr>
|
|
1505
|
-
|
|
1506
|
-
<tr>
|
|
1507
|
-
<td rowspan="1" colSpan="1" >fps</td>
|
|
1508
|
-
|
|
1509
|
-
<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>
|
|
1510
|
-
</tr>
|
|
1511
|
-
|
|
1512
|
-
<tr>
|
|
1513
|
-
<td rowspan="1" colSpan="1" >image</td>
|
|
1514
|
-
|
|
1515
|
-
<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>
|
|
1516
|
-
</tr>
|
|
1517
|
-
</table>
|
|
1518
|
-
|
|
610
|
+
| Parameters | Description |
|
|
611
|
+
| --- | --- |
|
|
612
|
+
| 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. |
|
|
613
|
+
| image | Set the alternative image. A null value means no video stream data will be sent after muteLocalVideo. The default is null. |
|
|
1519
614
|
|
|
1520
615
|
## startRemoteView
|
|
1521
616
|
|
|
1522
|
-
|
|
1523
|
-
|
|
1524
617
|
#### Subscribe to the video stream of a remote user and bind the video rendering control
|
|
1525
618
|
|
|
1526
|
-
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
|
|
619
|
+
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.
|
|
1527
620
|
- 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.
|
|
1528
621
|
|
|
1529
|
-
- If you do not know which users in the room are publishing video, you can wait for a notification from
|
|
1530
|
-
|
|
1531
|
-
|
|
1532
|
-
|
|
1533
|
-
|
|
1534
|
-
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/87030021158866944).
|
|
1535
|
-
<table>
|
|
1536
|
-
<tr>
|
|
1537
|
-
<td rowspan="1" colSpan="1" >Parameters</td>
|
|
1538
|
-
|
|
1539
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1540
|
-
</tr>
|
|
1541
|
-
|
|
1542
|
-
<tr>
|
|
1543
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
1544
|
-
|
|
1545
|
-
<td rowspan="1" colSpan="1" >Specify the type of video stream of the user you want to watch.<br>- High-definition main stream: [TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400).<br>- Low-quality small screen: [TRTCVideoStreamTypeSmall](https://write.woa.com/document/87030132707430400) (effective only after the remote user enables Dual-channel encoding through [enableSmallVideoStream](https://write.woa.com/document/87030026264555520)).<br>- Substream (commonly used for screen sharing): [TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400).</td>
|
|
1546
|
-
</tr>
|
|
1547
|
-
|
|
1548
|
-
<tr>
|
|
1549
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
1550
|
-
|
|
1551
|
-
<td rowspan="1" colSpan="1" >Specify the remote user's ID.</td>
|
|
1552
|
-
</tr>
|
|
1553
|
-
|
|
1554
|
-
<tr>
|
|
1555
|
-
<td rowspan="1" colSpan="1" >view</td>
|
|
1556
|
-
|
|
1557
|
-
<td rowspan="1" colSpan="1" >Rendering control used to display the video screen.</td>
|
|
1558
|
-
</tr>
|
|
1559
|
-
</table>
|
|
622
|
+
- 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.
|
|
1560
623
|
|
|
624
|
+
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.
|
|
625
|
+
| Parameters | Description |
|
|
626
|
+
| --- | --- |
|
|
627
|
+
| streamType | Specify the type of video stream of the user you want to watch.<br>- High-definition main stream: TRTCVideoStreamTypeBig.<br>- Low-quality small screen: TRTCVideoStreamTypeSmall (effective only after the remote user enables Dual-channel encoding through enableSmallVideoStream).<br>- Substream (commonly used for screen sharing): TRTCVideoStreamTypeSub. |
|
|
628
|
+
| userId | Specify the remote user's ID. |
|
|
629
|
+
| view | Rendering control used to display the video screen. |
|
|
1561
630
|
|
|
1562
631
|
> **Note**
|
|
1563
|
-
>
|
|
632
|
+
>
|
|
1564
633
|
|
|
1565
634
|
> Note a few rules:
|
|
1566
|
-
>
|
|
635
|
+
>
|
|
1567
636
|
|
|
1568
637
|
> 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.
|
|
1569
|
-
>
|
|
638
|
+
>
|
|
1570
639
|
|
|
1571
|
-
> 2. Only when the specified userid enables Dual-channel encoding through
|
|
1572
|
-
>
|
|
640
|
+
> 2. Only when the specified userid enables Dual-channel encoding through enableSmallVideoStream can you watch the user's small screen.
|
|
641
|
+
>
|
|
1573
642
|
|
|
1574
643
|
> 3. When the small stream of the specified user ID does not exist, the SDK will default to the user's main stream.
|
|
1575
|
-
>
|
|
1576
|
-
|
|
644
|
+
>
|
|
1577
645
|
|
|
1578
646
|
## updateRemoteView
|
|
1579
647
|
|
|
1580
|
-
|
|
1581
|
-
|
|
1582
648
|
#### Update the video rendering control of a remote user
|
|
1583
649
|
|
|
1584
650
|
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.
|
|
1585
|
-
|
|
1586
|
-
|
|
1587
|
-
|
|
1588
|
-
|
|
1589
|
-
|
|
1590
|
-
</tr>
|
|
1591
|
-
|
|
1592
|
-
<tr>
|
|
1593
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
1594
|
-
|
|
1595
|
-
<td rowspan="1" colSpan="1" >To set the stream type of the preview window (only supports [TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400) and [TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400)).</td>
|
|
1596
|
-
</tr>
|
|
1597
|
-
|
|
1598
|
-
<tr>
|
|
1599
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
1600
|
-
|
|
1601
|
-
<td rowspan="1" colSpan="1" >Specify the remote user's ID.</td>
|
|
1602
|
-
</tr>
|
|
1603
|
-
|
|
1604
|
-
<tr>
|
|
1605
|
-
<td rowspan="1" colSpan="1" >view</td>
|
|
1606
|
-
|
|
1607
|
-
<td rowspan="1" colSpan="1" >Control carrying the video screen.</td>
|
|
1608
|
-
</tr>
|
|
1609
|
-
</table>
|
|
1610
|
-
|
|
651
|
+
| Parameters | Description |
|
|
652
|
+
| --- | --- |
|
|
653
|
+
| streamType | To set the stream type of the preview window (only supports TRTCVideoStreamTypeBig and TRTCVideoStreamTypeSub). |
|
|
654
|
+
| userId | Specify the remote user's ID. |
|
|
655
|
+
| view | Control carrying the video screen. |
|
|
1611
656
|
|
|
1612
657
|
## stopRemoteView
|
|
1613
658
|
|
|
1614
|
-
|
|
1615
|
-
|
|
1616
659
|
#### Unsubscribe from the remote user's video stream and release the rendering control
|
|
1617
660
|
|
|
1618
661
|
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.
|
|
1619
|
-
|
|
1620
|
-
|
|
1621
|
-
|
|
1622
|
-
|
|
1623
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1624
|
-
</tr>
|
|
1625
|
-
|
|
1626
|
-
<tr>
|
|
1627
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
1628
|
-
|
|
1629
|
-
<td rowspan="1" colSpan="1" >Specify the type of video stream of the user you want to watch.<br>- High-definition main stream: [TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400).<br>- Low-definition small picture: [TRTCVideoStreamTypeSmall](https://write.woa.com/document/87030132707430400).<br>- Substream (commonly used for screen sharing): [TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400).</td>
|
|
1630
|
-
</tr>
|
|
1631
|
-
|
|
1632
|
-
<tr>
|
|
1633
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
1634
|
-
|
|
1635
|
-
<td rowspan="1" colSpan="1" >Specify the remote user's ID.</td>
|
|
1636
|
-
</tr>
|
|
1637
|
-
</table>
|
|
1638
|
-
|
|
662
|
+
| Parameters | Description |
|
|
663
|
+
| --- | --- |
|
|
664
|
+
| streamType | Specify the type of video stream of the user you want to watch.<br>- High-definition main stream: TRTCVideoStreamTypeBig.<br>- Low-definition small picture: TRTCVideoStreamTypeSmall.<br>- Substream (commonly used for screen sharing): TRTCVideoStreamTypeSub. |
|
|
665
|
+
| userId | Specify the remote user's ID. |
|
|
1639
666
|
|
|
1640
667
|
## stopAllRemoteView
|
|
1641
668
|
|
|
1642
|
-
|
|
1643
|
-
|
|
1644
669
|
#### Unsubscribe from all remote users' video streams and release all rendering resources
|
|
1645
670
|
|
|
1646
671
|
Calling this interface will make the SDK stop receiving all remote video streams and release all decoding and rendering resources.
|
|
1647
672
|
|
|
1648
673
|
> **Note**
|
|
1649
|
-
>
|
|
674
|
+
>
|
|
1650
675
|
|
|
1651
676
|
> If there is a currently displayed substream (screen sharing), it will also be stopped.
|
|
1652
|
-
>
|
|
1653
|
-
|
|
677
|
+
>
|
|
1654
678
|
|
|
1655
679
|
## muteRemoteVideoStream
|
|
1656
680
|
|
|
1657
|
-
|
|
1658
|
-
|
|
1659
681
|
#### Suspend/Resume subscription of the remote user's video stream
|
|
1660
682
|
|
|
1661
683
|
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.
|
|
1662
|
-
|
|
1663
|
-
|
|
1664
|
-
|
|
1665
|
-
|
|
1666
|
-
|
|
1667
|
-
</tr>
|
|
1668
|
-
|
|
1669
|
-
<tr>
|
|
1670
|
-
<td rowspan="1" colSpan="1" >mute</td>
|
|
1671
|
-
|
|
1672
|
-
<td rowspan="1" colSpan="1" >Pause receiving or not.</td>
|
|
1673
|
-
</tr>
|
|
1674
|
-
|
|
1675
|
-
<tr>
|
|
1676
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
1677
|
-
|
|
1678
|
-
<td rowspan="1" colSpan="1" >The video stream type to be paused/resumed.<br>- High-definition main stream: [TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400).<br>- Low-definition small picture: [TRTCVideoStreamTypeSmall](https://write.woa.com/document/87030132707430400).<br>- Substream (commonly used for screen sharing): [TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400).</td>
|
|
1679
|
-
</tr>
|
|
1680
|
-
|
|
1681
|
-
<tr>
|
|
1682
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
1683
|
-
|
|
1684
|
-
<td rowspan="1" colSpan="1" >Specify the remote user's ID.</td>
|
|
1685
|
-
</tr>
|
|
1686
|
-
</table>
|
|
1687
|
-
|
|
684
|
+
| Parameters | Description |
|
|
685
|
+
| --- | --- |
|
|
686
|
+
| mute | Pause receiving or not. |
|
|
687
|
+
| streamType | The video stream type to be paused/resumed.<br>- High-definition main stream: TRTCVideoStreamTypeBig.<br>- Low-definition small picture: TRTCVideoStreamTypeSmall.<br>- Substream (commonly used for screen sharing): TRTCVideoStreamTypeSub. |
|
|
688
|
+
| userId | Specify the remote user's ID. |
|
|
1688
689
|
|
|
1689
690
|
> **Note**
|
|
1690
|
-
>
|
|
691
|
+
>
|
|
1691
692
|
|
|
1692
|
-
> This interface supports calling before entering the room (
|
|
1693
|
-
>
|
|
1694
|
-
|
|
1695
|
-
> After calling this interface to pause receiving a specified user's video stream, calling only the [startRemoteView](https://write.woa.com/document/87030026264555520) interface will not play the specified user's video. You need to call [muteRemoteVideoStream](https://write.woa.com/document/87030026264555520)(false) or [muteAllRemoteVideoStreams](https://write.woa.com/document/87030026264555520)(false) to recover.
|
|
1696
|
-
>
|
|
693
|
+
> This interface supports calling before entering the room (enterRoom), and the paused state will be reset after leaving the room (exitRoom).
|
|
694
|
+
>
|
|
1697
695
|
|
|
696
|
+
> 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.
|
|
697
|
+
>
|
|
1698
698
|
|
|
1699
699
|
## muteAllRemoteVideoStreams
|
|
1700
700
|
|
|
1701
|
-
|
|
1702
|
-
|
|
1703
701
|
#### Suspend/Resume subscription of all remote users' video streams
|
|
1704
702
|
|
|
1705
703
|
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.
|
|
1706
|
-
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1711
|
-
</tr>
|
|
1712
|
-
|
|
1713
|
-
<tr>
|
|
1714
|
-
<td rowspan="1" colSpan="1" >mute</td>
|
|
1715
|
-
|
|
1716
|
-
<td rowspan="1" colSpan="1" >Pause receiving or not.</td>
|
|
1717
|
-
</tr>
|
|
1718
|
-
</table>
|
|
1719
|
-
|
|
704
|
+
| Parameters | Description |
|
|
705
|
+
| --- | --- |
|
|
706
|
+
| mute | Pause receiving or not. |
|
|
1720
707
|
|
|
1721
708
|
> **Note**
|
|
1722
|
-
>
|
|
1723
|
-
|
|
1724
|
-
> This interface supports calling before entering the room ([enterRoom](https://write.woa.com/document/87030026264555520)), and the paused state will be reset after leaving the room ([exitRoom](https://write.woa.com/document/87030026264555520)).
|
|
1725
|
-
>
|
|
709
|
+
>
|
|
1726
710
|
|
|
1727
|
-
>
|
|
1728
|
-
>
|
|
711
|
+
> This interface supports calling before entering the room (enterRoom), and the paused state will be reset after leaving the room (exitRoom).
|
|
712
|
+
>
|
|
1729
713
|
|
|
714
|
+
> 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.
|
|
715
|
+
>
|
|
1730
716
|
|
|
1731
717
|
## setVideoEncoderParam
|
|
1732
718
|
|
|
1733
|
-
|
|
1734
|
-
|
|
1735
719
|
#### Set encoding parameters for the video encoder
|
|
1736
720
|
|
|
1737
721
|
This setting determines the screen quality seen by remote users, and also affects the screen quality of the recorded video file on the cloud.
|
|
1738
|
-
|
|
1739
|
-
|
|
1740
|
-
|
|
1741
|
-
|
|
1742
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1743
|
-
</tr>
|
|
1744
|
-
|
|
1745
|
-
<tr>
|
|
1746
|
-
<td rowspan="1" colSpan="1" >param</td>
|
|
1747
|
-
|
|
1748
|
-
<td rowspan="1" colSpan="1" >Used to set the video encoder parameters. For details, see [TRTCVideoEncParam](https://write.woa.com/document/87030132707430400).</td>
|
|
1749
|
-
</tr>
|
|
1750
|
-
</table>
|
|
1751
|
-
|
|
722
|
+
| Parameters | Description |
|
|
723
|
+
| --- | --- |
|
|
724
|
+
| param | Used to set the video encoder parameters. For details, see TRTCVideoEncParam. |
|
|
1752
725
|
|
|
1753
726
|
> **Note**
|
|
1754
|
-
>
|
|
727
|
+
>
|
|
1755
728
|
|
|
1756
729
|
> 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.
|
|
1757
|
-
>
|
|
1758
|
-
|
|
730
|
+
>
|
|
1759
731
|
|
|
1760
732
|
## setNetworkQosParam
|
|
1761
733
|
|
|
1762
|
-
|
|
1763
|
-
|
|
1764
734
|
#### Set network quality control parameters
|
|
1765
735
|
|
|
1766
736
|
This setting determines the quality control strategy under poor network conditions, such as "Quality Priority" or "Smoothness Priority" strategies.
|
|
1767
|
-
|
|
1768
|
-
|
|
1769
|
-
|
|
1770
|
-
|
|
1771
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1772
|
-
</tr>
|
|
1773
|
-
|
|
1774
|
-
<tr>
|
|
1775
|
-
<td rowspan="1" colSpan="1" >param</td>
|
|
1776
|
-
|
|
1777
|
-
<td rowspan="1" colSpan="1" >Used to set the network quality control parameters. For details, see [TRTCNetworkQosParam](https://write.woa.com/document/87030132707430400).</td>
|
|
1778
|
-
</tr>
|
|
1779
|
-
</table>
|
|
1780
|
-
|
|
737
|
+
| Parameters | Description |
|
|
738
|
+
| --- | --- |
|
|
739
|
+
| param | Used to set the network quality control parameters. For details, see TRTCNetworkQosParam. |
|
|
1781
740
|
|
|
1782
741
|
## setLocalRenderParams
|
|
1783
742
|
|
|
1784
|
-
|
|
1785
|
-
|
|
1786
743
|
#### Set rendering parameters for the local screen
|
|
1787
744
|
|
|
1788
745
|
Configurable parameters include: rotation angle, fill mode, and left-right mirroring of the picture.
|
|
1789
|
-
|
|
1790
|
-
|
|
1791
|
-
|
|
1792
|
-
|
|
1793
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1794
|
-
</tr>
|
|
1795
|
-
|
|
1796
|
-
<tr>
|
|
1797
|
-
<td rowspan="1" colSpan="1" >params</td>
|
|
1798
|
-
|
|
1799
|
-
<td rowspan="1" colSpan="1" >Picture render parameters, see [TRTCRenderParams](https://write.woa.com/document/87030132707430400) for details.</td>
|
|
1800
|
-
</tr>
|
|
1801
|
-
</table>
|
|
1802
|
-
|
|
746
|
+
| Parameters | Description |
|
|
747
|
+
| --- | --- |
|
|
748
|
+
| params | Picture render parameters, see TRTCRenderParams for details. |
|
|
1803
749
|
|
|
1804
750
|
## setRemoteRenderParams
|
|
1805
751
|
|
|
1806
|
-
|
|
1807
|
-
|
|
1808
752
|
#### Set rendering mode for the remote screen
|
|
1809
753
|
|
|
1810
754
|
Configurable parameters include: rotation angle, fill mode, and left-right mirroring of the picture.
|
|
1811
|
-
|
|
1812
|
-
|
|
1813
|
-
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
|
-
</tr>
|
|
1817
|
-
|
|
1818
|
-
<tr>
|
|
1819
|
-
<td rowspan="1" colSpan="1" >params</td>
|
|
1820
|
-
|
|
1821
|
-
<td rowspan="1" colSpan="1" >Picture render parameters, see [TRTCRenderParams](https://write.woa.com/document/87030132707430400) for details.</td>
|
|
1822
|
-
</tr>
|
|
1823
|
-
|
|
1824
|
-
<tr>
|
|
1825
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
1826
|
-
|
|
1827
|
-
<td rowspan="1" colSpan="1" >It can be set as the main road picture ([TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400)) or auxiliary road picture ([TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400)).</td>
|
|
1828
|
-
</tr>
|
|
1829
|
-
|
|
1830
|
-
<tr>
|
|
1831
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
1832
|
-
|
|
1833
|
-
<td rowspan="1" colSpan="1" >Specify the remote user's ID.</td>
|
|
1834
|
-
</tr>
|
|
1835
|
-
</table>
|
|
1836
|
-
|
|
755
|
+
| Parameters | Description |
|
|
756
|
+
| --- | --- |
|
|
757
|
+
| params | Picture render parameters, see TRTCRenderParams for details. |
|
|
758
|
+
| streamType | It can be set as the main road picture (TRTCVideoStreamTypeBig) or auxiliary road picture (TRTCVideoStreamTypeSub). |
|
|
759
|
+
| userId | Specify the remote user's ID. |
|
|
1837
760
|
|
|
1838
761
|
## enableSmallVideoStream
|
|
1839
762
|
|
|
1840
|
-
|
|
1841
|
-
|
|
1842
763
|
#### Enable picture-in-picture dual-stream encoding mode
|
|
1843
764
|
|
|
1844
765
|
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).
|
|
1845
766
|
|
|
1846
767
|
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.
|
|
1847
|
-
|
|
1848
|
-
|
|
1849
|
-
|
|
1850
|
-
|
|
1851
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1852
|
-
</tr>
|
|
1853
|
-
|
|
1854
|
-
<tr>
|
|
1855
|
-
<td rowspan="1" colSpan="1" >enable</td>
|
|
1856
|
-
|
|
1857
|
-
<td rowspan="1" colSpan="1" >Whether to enable small picture encoding, default value: false.</td>
|
|
1858
|
-
</tr>
|
|
1859
|
-
|
|
1860
|
-
<tr>
|
|
1861
|
-
<td rowspan="1" colSpan="1" >smallVideoEncParam</td>
|
|
1862
|
-
|
|
1863
|
-
<td rowspan="1" colSpan="1" >Video parameters for the substream.</td>
|
|
1864
|
-
</tr>
|
|
1865
|
-
</table>
|
|
1866
|
-
|
|
768
|
+
| Parameters | Description |
|
|
769
|
+
| --- | --- |
|
|
770
|
+
| enable | Whether to enable small picture encoding, default value: false. |
|
|
771
|
+
| smallVideoEncParam | Video parameters for the substream. |
|
|
1867
772
|
|
|
1868
773
|
> **Note**
|
|
1869
|
-
>
|
|
774
|
+
>
|
|
1870
775
|
|
|
1871
776
|
> 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.
|
|
1872
|
-
>
|
|
1873
|
-
|
|
777
|
+
>
|
|
1874
778
|
|
|
1875
779
|
#### Return value description:
|
|
1876
780
|
|
|
@@ -1878,86 +782,41 @@ This way, other users in the room can choose to subscribe to [HD large screen] o
|
|
|
1878
782
|
|
|
1879
783
|
## setRemoteVideoStreamType
|
|
1880
784
|
|
|
1881
|
-
|
|
1882
|
-
|
|
1883
785
|
#### Switch picture-in-picture for the specified remote user
|
|
1884
786
|
|
|
1885
|
-
After a host in the room has enabled dual-channel encoding, the default screen subscribed by other users in the room through
|
|
1886
|
-
|
|
1887
|
-
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/87030026264555520).
|
|
1888
|
-
<table>
|
|
1889
|
-
<tr>
|
|
1890
|
-
<td rowspan="1" colSpan="1" >Parameters</td>
|
|
1891
|
-
|
|
1892
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1893
|
-
</tr>
|
|
1894
|
-
|
|
1895
|
-
<tr>
|
|
1896
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
1897
|
-
|
|
1898
|
-
<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>
|
|
1899
|
-
</tr>
|
|
1900
|
-
|
|
1901
|
-
<tr>
|
|
1902
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
1903
|
-
|
|
1904
|
-
<td rowspan="1" colSpan="1" >Specify the remote user's ID.</td>
|
|
1905
|
-
</tr>
|
|
1906
|
-
</table>
|
|
787
|
+
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].
|
|
1907
788
|
|
|
789
|
+
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.
|
|
790
|
+
| Parameters | Description |
|
|
791
|
+
| --- | --- |
|
|
792
|
+
| streamType | Video stream type, i.e., choose to watch the large screen or the small screen, default is large screen. |
|
|
793
|
+
| userId | Specify the remote user's ID. |
|
|
1908
794
|
|
|
1909
795
|
> **Note**
|
|
1910
|
-
>
|
|
1911
|
-
|
|
1912
|
-
> This feature requires the target user to have already enabled Dual-channel encoding mode in advance through [enableSmallVideoStream](https://write.woa.com/document/87030026264555520), otherwise, this call will have no actual effect.
|
|
1913
|
-
>
|
|
796
|
+
>
|
|
1914
797
|
|
|
798
|
+
> This feature requires the target user to have already enabled Dual-channel encoding mode in advance through enableSmallVideoStream, otherwise, this call will have no actual effect.
|
|
799
|
+
>
|
|
1915
800
|
|
|
1916
801
|
## snapshotVideo
|
|
1917
802
|
|
|
1918
|
-
|
|
1919
|
-
|
|
1920
803
|
#### Take a video screenshot
|
|
1921
804
|
|
|
1922
805
|
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.
|
|
1923
|
-
|
|
1924
|
-
|
|
1925
|
-
|
|
1926
|
-
|
|
1927
|
-
|
|
1928
|
-
</tr>
|
|
1929
|
-
|
|
1930
|
-
<tr>
|
|
1931
|
-
<td rowspan="1" colSpan="1" >sourceType</td>
|
|
1932
|
-
|
|
1933
|
-
<td rowspan="1" colSpan="1" >Source of the picture can be chosen as captured video stream ([TRTCSnapshotSourceTypeStream](https://write.woa.com/document/87030132707430400)), video rendering picture ([TRTCSnapshotSourceTypeView](https://write.woa.com/document/87030132707430400)), or captured picture ([TRTCSnapshotSourceTypeCapture](https://write.woa.com/document/87030132707430400)). Captured picture screenshots are clearer.</td>
|
|
1934
|
-
</tr>
|
|
1935
|
-
|
|
1936
|
-
<tr>
|
|
1937
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
1938
|
-
|
|
1939
|
-
<td rowspan="1" colSpan="1" >Video stream type, you can choose to capture the main stream picture ([TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400), commonly used for cameras) or the auxiliary stream picture ([TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400), commonly used for screen sharing).</td>
|
|
1940
|
-
</tr>
|
|
1941
|
-
|
|
1942
|
-
<tr>
|
|
1943
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
1944
|
-
|
|
1945
|
-
<td rowspan="1" colSpan="1" >User ID, if left blank, indicates capturing the local video footage.</td>
|
|
1946
|
-
</tr>
|
|
1947
|
-
</table>
|
|
1948
|
-
|
|
806
|
+
| Parameters | Description |
|
|
807
|
+
| --- | --- |
|
|
808
|
+
| sourceType | Source of the picture can be chosen as captured video stream (TRTCSnapshotSourceTypeStream), video rendering picture (TRTCSnapshotSourceTypeView), or captured picture (TRTCSnapshotSourceTypeCapture). Captured picture screenshots are clearer. |
|
|
809
|
+
| streamType | Video stream type, you can choose to capture the main stream picture (TRTCVideoStreamTypeBig, commonly used for cameras) or the auxiliary stream picture (TRTCVideoStreamTypeSub, commonly used for screen sharing). |
|
|
810
|
+
| userId | User ID, if left blank, indicates capturing the local video footage. |
|
|
1949
811
|
|
|
1950
812
|
> **Note**
|
|
1951
|
-
>
|
|
1952
|
-
|
|
1953
|
-
> Windows platform currently only supports capturing [TRTCSnapshotSourceTypeStream](https://write.woa.com/document/87030132707430400) source video footage.
|
|
1954
|
-
>
|
|
813
|
+
>
|
|
1955
814
|
|
|
815
|
+
> Windows platform currently only supports capturing TRTCSnapshotSourceTypeStream source video footage.
|
|
816
|
+
>
|
|
1956
817
|
|
|
1957
818
|
## setGravitySensorAdaptiveMode
|
|
1958
819
|
|
|
1959
|
-
|
|
1960
|
-
|
|
1961
820
|
#### Set gravity sensing adaptive mode (11.7 and above)
|
|
1962
821
|
|
|
1963
822
|
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.
|
|
@@ -1967,291 +826,145 @@ It only takes effect in the SDK internal camera capture scene and only works on
|
|
|
1967
826
|
1. This interface only affects the collection end. If you are just watching the image in the room, enabling this interface is ineffective
|
|
1968
827
|
|
|
1969
828
|
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
|
|
1970
|
-
|
|
1971
|
-
|
|
1972
|
-
|
|
1973
|
-
|
|
1974
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1975
|
-
</tr>
|
|
1976
|
-
|
|
1977
|
-
<tr>
|
|
1978
|
-
<td rowspan="1" colSpan="1" >mode</td>
|
|
1979
|
-
|
|
1980
|
-
<td rowspan="1" colSpan="1" >Gravity sensing mode. For details, see [TRTCGravitySensorAdaptiveMode_Disable](https://write.woa.com/document/87030132707430400), [TRTCGravitySensorAdaptiveMode_FillByCenterCrop](https://write.woa.com/document/87030132707430400), and [TRTCGravitySensorAdaptiveMode_FitWithBlackBorder](https://write.woa.com/document/87030132707430400). Default value: [TRTCGravitySensorAdaptiveMode_Disable](https://write.woa.com/document/87030132707430400).</td>
|
|
1981
|
-
</tr>
|
|
1982
|
-
</table>
|
|
1983
|
-
|
|
829
|
+
| Parameters | Description |
|
|
830
|
+
| --- | --- |
|
|
831
|
+
| mode | Gravity sensing mode. For details, see TRTCGravitySensorAdaptiveMode_Disable, TRTCGravitySensorAdaptiveMode_FillByCenterCrop, and TRTCGravitySensorAdaptiveMode_FitWithBlackBorder. Default value: TRTCGravitySensorAdaptiveMode_Disable. |
|
|
1984
832
|
|
|
1985
833
|
## startLocalAudio
|
|
1986
834
|
|
|
835
|
+
#### Enable collection and publishing of local audio
|
|
1987
836
|
|
|
837
|
+
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.
|
|
1988
838
|
|
|
1989
|
-
|
|
1990
|
-
|
|
1991
|
-
|
|
1992
|
-
|
|
1993
|
-
After enabling the collection and publishing of local audio, other users in the room will receive [onUserAudioAvailable](https://write.woa.com/document/87030021158866944)(userId, true) notification.
|
|
1994
|
-
<table>
|
|
1995
|
-
<tr>
|
|
1996
|
-
<td rowspan="1" colSpan="1" >Parameters</td>
|
|
1997
|
-
|
|
1998
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
1999
|
-
</tr>
|
|
2000
|
-
|
|
2001
|
-
<tr>
|
|
2002
|
-
<td rowspan="1" colSpan="1" >quality</td>
|
|
2003
|
-
|
|
2004
|
-
<td rowspan="1" colSpan="1" >Sound quality<br>- [TRTCAudioQualitySpeech](https://write.woa.com/document/87030132707430400), Fluent: Sample rate: 16k; Mono; Audio bitrate: 16kbps; Suitable for voice call-dominated scenarios, such as online meetings and voice calls.<br>- [TRTCAudioQualityDefault](https://write.woa.com/document/87030132707430400), Default: Sample rate: 48k; Mono; Audio bitrate: 50kbps; The default audio quality of the SDK, recommended unless there are special requirements.<br>- [TRTCAudioQualityMusic](https://write.woa.com/document/87030132707430400), High Quality: Sample rate: 48k; Stereo + full band; Audio bitrate: 128kbps; Suitable for high-fidelity music transmission scenarios, such as online KTV and music live streaming.</td>
|
|
2005
|
-
</tr>
|
|
2006
|
-
</table>
|
|
2007
|
-
|
|
839
|
+
After enabling the collection and publishing of local audio, other users in the room will receive onUserAudioAvailable(userId, true) notification.
|
|
840
|
+
| Parameters | Description |
|
|
841
|
+
| --- | --- |
|
|
842
|
+
| quality | Sound quality<br>- TRTCAudioQualitySpeech, Fluent: Sample rate: 16k; Mono; Audio bitrate: 16kbps; Suitable for voice call-dominated scenarios, such as online meetings and voice calls.<br>- TRTCAudioQualityDefault, Default: Sample rate: 48k; Mono; Audio bitrate: 50kbps; The default audio quality of the SDK, recommended unless there are special requirements.<br>- TRTCAudioQualityMusic, High Quality: Sample rate: 48k; Stereo + full band; Audio bitrate: 128kbps; Suitable for high-fidelity music transmission scenarios, such as online KTV and music live streaming. |
|
|
2008
843
|
|
|
2009
844
|
> **Note**
|
|
2010
|
-
>
|
|
845
|
+
>
|
|
2011
846
|
|
|
2012
847
|
> 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.
|
|
2013
|
-
>
|
|
2014
|
-
|
|
848
|
+
>
|
|
2015
849
|
|
|
2016
850
|
## stopLocalAudio
|
|
2017
851
|
|
|
2018
|
-
|
|
2019
|
-
|
|
2020
852
|
#### Stop collection and publishing of local audio
|
|
2021
853
|
|
|
2022
|
-
After stopping the collection and publishing of local audio, other users in the room will receive
|
|
854
|
+
After stopping the collection and publishing of local audio, other users in the room will receive onUserAudioAvailable(userId, false) notification.
|
|
2023
855
|
|
|
2024
856
|
## muteLocalAudio
|
|
2025
857
|
|
|
2026
|
-
|
|
2027
|
-
|
|
2028
858
|
#### Pause/Resume publishing of the local audio stream
|
|
2029
859
|
|
|
2030
|
-
When you pause the publishing of the local audio stream, other users in the room will receive
|
|
2031
|
-
|
|
2032
|
-
When you resume the publishing of the local audio stream, other users in the room will receive [onUserAudioAvailable](https://write.woa.com/document/87030021158866944)(userId, true) notification.
|
|
860
|
+
When you pause the publishing of the local audio stream, other users in the room will receive onUserAudioAvailable(userId, false) notification.
|
|
2033
861
|
|
|
862
|
+
When you resume the publishing of the local audio stream, other users in the room will receive onUserAudioAvailable(userId, true) notification.
|
|
2034
863
|
|
|
864
|
+
The difference from stopLocalAudio is that muteLocalAudio(true) does not release the microphone permissions but continues to send a low-bit-rate silent packet.
|
|
2035
865
|
|
|
2036
|
-
|
|
2037
|
-
|
|
2038
|
-
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/87030026264555520) will make the recorded MP4 files difficult to play.
|
|
866
|
+
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.
|
|
2039
867
|
|
|
2040
868
|
Therefore, in scenarios where the quality of the recorded files is highly required, it is recommended to choose muteLocalAudio instead of stopLocalAudio.
|
|
2041
|
-
|
|
2042
|
-
|
|
2043
|
-
|
|
2044
|
-
|
|
2045
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2046
|
-
</tr>
|
|
2047
|
-
|
|
2048
|
-
<tr>
|
|
2049
|
-
<td rowspan="1" colSpan="1" >mute</td>
|
|
2050
|
-
|
|
2051
|
-
<td rowspan="1" colSpan="1" >true: Mute; false: Unmute.</td>
|
|
2052
|
-
</tr>
|
|
2053
|
-
</table>
|
|
2054
|
-
|
|
869
|
+
| Parameters | Description |
|
|
870
|
+
| --- | --- |
|
|
871
|
+
| mute | true: Mute; false: Unmute. |
|
|
2055
872
|
|
|
2056
873
|
## muteRemoteAudio
|
|
2057
874
|
|
|
2058
|
-
|
|
2059
|
-
|
|
2060
875
|
#### Pause/Resume playing of the remote audio stream
|
|
2061
876
|
|
|
2062
877
|
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.
|
|
2063
|
-
|
|
2064
|
-
|
|
2065
|
-
|
|
2066
|
-
|
|
2067
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2068
|
-
</tr>
|
|
2069
|
-
|
|
2070
|
-
<tr>
|
|
2071
|
-
<td rowspan="1" colSpan="1" >mute</td>
|
|
2072
|
-
|
|
2073
|
-
<td rowspan="1" colSpan="1" >true: Mute; false: Unmute.</td>
|
|
2074
|
-
</tr>
|
|
2075
|
-
|
|
2076
|
-
<tr>
|
|
2077
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
2078
|
-
|
|
2079
|
-
<td rowspan="1" colSpan="1" >Used to specify the remote user's ID.</td>
|
|
2080
|
-
</tr>
|
|
2081
|
-
</table>
|
|
2082
|
-
|
|
878
|
+
| Parameters | Description |
|
|
879
|
+
| --- | --- |
|
|
880
|
+
| mute | true: Mute; false: Unmute. |
|
|
881
|
+
| userId | Used to specify the remote user's ID. |
|
|
2083
882
|
|
|
2084
883
|
> **Note**
|
|
2085
|
-
>
|
|
884
|
+
>
|
|
2086
885
|
|
|
2087
886
|
> 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).
|
|
2088
|
-
>
|
|
2089
|
-
|
|
887
|
+
>
|
|
2090
888
|
|
|
2091
889
|
## muteAllRemoteAudio
|
|
2092
890
|
|
|
2093
|
-
|
|
2094
|
-
|
|
2095
891
|
#### Pause/Resume playing of all remote users' audio streams
|
|
2096
892
|
|
|
2097
893
|
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.
|
|
2098
|
-
|
|
2099
|
-
|
|
2100
|
-
|
|
2101
|
-
|
|
2102
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2103
|
-
</tr>
|
|
2104
|
-
|
|
2105
|
-
<tr>
|
|
2106
|
-
<td rowspan="1" colSpan="1" >mute</td>
|
|
2107
|
-
|
|
2108
|
-
<td rowspan="1" colSpan="1" >true: Mute; false: Unmute.</td>
|
|
2109
|
-
</tr>
|
|
2110
|
-
</table>
|
|
2111
|
-
|
|
894
|
+
| Parameters | Description |
|
|
895
|
+
| --- | --- |
|
|
896
|
+
| mute | true: Mute; false: Unmute. |
|
|
2112
897
|
|
|
2113
898
|
> **Note**
|
|
2114
|
-
>
|
|
899
|
+
>
|
|
2115
900
|
|
|
2116
901
|
> 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).
|
|
2117
|
-
>
|
|
2118
|
-
|
|
902
|
+
>
|
|
2119
903
|
|
|
2120
904
|
## setRemoteAudioVolume
|
|
2121
905
|
|
|
2122
|
-
|
|
2123
|
-
|
|
2124
906
|
#### Set the playback volume for a specific remote user
|
|
2125
907
|
|
|
2126
908
|
You can mute a remote user's sound by using setRemoteAudioVolume(userId, 0).
|
|
2127
|
-
|
|
2128
|
-
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2132
|
-
</tr>
|
|
2133
|
-
|
|
2134
|
-
<tr>
|
|
2135
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
2136
|
-
|
|
2137
|
-
<td rowspan="1" colSpan="1" >Used to specify the remote user's ID.</td>
|
|
2138
|
-
</tr>
|
|
2139
|
-
|
|
2140
|
-
<tr>
|
|
2141
|
-
<td rowspan="1" colSpan="1" >volume</td>
|
|
2142
|
-
|
|
2143
|
-
<td rowspan="1" colSpan="1" >Volume. Value range: 0-100. Default value: 100.</td>
|
|
2144
|
-
</tr>
|
|
2145
|
-
</table>
|
|
2146
|
-
|
|
909
|
+
| Parameters | Description |
|
|
910
|
+
| --- | --- |
|
|
911
|
+
| userId | Used to specify the remote user's ID. |
|
|
912
|
+
| volume | Volume. Value range: 0-100. Default value: 100. |
|
|
2147
913
|
|
|
2148
914
|
> **Note**
|
|
2149
|
-
>
|
|
915
|
+
>
|
|
2150
916
|
|
|
2151
917
|
> 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.
|
|
2152
|
-
>
|
|
2153
|
-
|
|
918
|
+
>
|
|
2154
919
|
|
|
2155
920
|
## setAudioCaptureVolume
|
|
2156
921
|
|
|
2157
|
-
|
|
2158
|
-
|
|
2159
922
|
#### Sets the local audio capture volume.
|
|
2160
|
-
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
|
|
2164
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2165
|
-
</tr>
|
|
2166
|
-
|
|
2167
|
-
<tr>
|
|
2168
|
-
<td rowspan="1" colSpan="1" >volume</td>
|
|
2169
|
-
|
|
2170
|
-
<td rowspan="1" colSpan="1" >Volume. Value range: 0-100. Default value: 100.</td>
|
|
2171
|
-
</tr>
|
|
2172
|
-
</table>
|
|
2173
|
-
|
|
923
|
+
| Parameters | Description |
|
|
924
|
+
| --- | --- |
|
|
925
|
+
| volume | Volume. Value range: 0-100. Default value: 100. |
|
|
2174
926
|
|
|
2175
927
|
> **Note**
|
|
2176
|
-
>
|
|
928
|
+
>
|
|
2177
929
|
|
|
2178
930
|
> 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.
|
|
2179
|
-
>
|
|
2180
|
-
|
|
931
|
+
>
|
|
2181
932
|
|
|
2182
933
|
## getAudioCaptureVolume
|
|
2183
934
|
|
|
2184
|
-
|
|
2185
|
-
|
|
2186
935
|
#### Obtains the local audio capture volume.
|
|
2187
936
|
|
|
2188
937
|
## setAudioPlayoutVolume
|
|
2189
938
|
|
|
2190
|
-
|
|
2191
|
-
|
|
2192
939
|
#### Sets the remote audio playback volume.
|
|
2193
940
|
|
|
2194
941
|
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.
|
|
2195
|
-
|
|
2196
|
-
|
|
2197
|
-
|
|
2198
|
-
|
|
2199
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2200
|
-
</tr>
|
|
2201
|
-
|
|
2202
|
-
<tr>
|
|
2203
|
-
<td rowspan="1" colSpan="1" >volume</td>
|
|
2204
|
-
|
|
2205
|
-
<td rowspan="1" colSpan="1" >Volume. Value range: 0-100. Default value: 100.</td>
|
|
2206
|
-
</tr>
|
|
2207
|
-
</table>
|
|
2208
|
-
|
|
942
|
+
| Parameters | Description |
|
|
943
|
+
| --- | --- |
|
|
944
|
+
| volume | Volume. Value range: 0-100. Default value: 100. |
|
|
2209
945
|
|
|
2210
946
|
> **Note**
|
|
2211
|
-
>
|
|
947
|
+
>
|
|
2212
948
|
|
|
2213
949
|
> 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.
|
|
2214
|
-
>
|
|
2215
|
-
|
|
950
|
+
>
|
|
2216
951
|
|
|
2217
952
|
## getAudioPlayoutVolume
|
|
2218
953
|
|
|
2219
|
-
|
|
2220
|
-
|
|
2221
954
|
#### Obtains the remote audio playback volume.
|
|
2222
955
|
|
|
2223
956
|
## enableAudioVolumeEvaluation
|
|
2224
957
|
|
|
2225
|
-
|
|
2226
|
-
|
|
2227
958
|
#### Enable volume reminder
|
|
2228
959
|
|
|
2229
|
-
After enabling this feature, the SDK will provide feedback on the local or remote user's audio volume assessment information, including volume level, voice detection, audio spectrum, etc., in the
|
|
2230
|
-
|
|
2231
|
-
|
|
2232
|
-
|
|
2233
|
-
|
|
2234
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2235
|
-
</tr>
|
|
2236
|
-
|
|
2237
|
-
<tr>
|
|
2238
|
-
<td rowspan="1" colSpan="1" >enable</td>
|
|
2239
|
-
|
|
2240
|
-
<td rowspan="1" colSpan="1" >Whether to enable volume prompts, disabled by default.</td>
|
|
2241
|
-
</tr>
|
|
2242
|
-
|
|
2243
|
-
<tr>
|
|
2244
|
-
<td rowspan="1" colSpan="1" >params</td>
|
|
2245
|
-
|
|
2246
|
-
<td rowspan="1" colSpan="1" >For volume assessment and other related parameters, please refer to [TRTCAudioVolumeEvaluateParams](https://write.woa.com/document/87030132707430400).</td>
|
|
2247
|
-
</tr>
|
|
2248
|
-
</table>
|
|
2249
|
-
|
|
960
|
+
After enabling this feature, the SDK will provide feedback on the local or remote user's audio volume assessment information, including volume level, voice detection, audio spectrum, etc., in the ITRTCCloudCallback callback onUserVoiceVolume.
|
|
961
|
+
| Parameters | Description |
|
|
962
|
+
| --- | --- |
|
|
963
|
+
| enable | Whether to enable volume prompts, disabled by default. |
|
|
964
|
+
| params | For volume assessment and other related parameters, please refer to TRTCAudioVolumeEvaluateParams. |
|
|
2250
965
|
|
|
2251
966
|
## startAudioRecording
|
|
2252
967
|
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
968
|
#### Start recording
|
|
2256
969
|
|
|
2257
970
|
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.
|
|
@@ -2259,27 +972,15 @@ When you call this interface, the SDK will mix and record all local and remote a
|
|
|
2259
972
|
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.
|
|
2260
973
|
|
|
2261
974
|
The start and completion status of this recording will be notified through local recording-related callbacks. See the TRTCCloud related callbacks.
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
|
|
2265
|
-
|
|
2266
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2267
|
-
</tr>
|
|
2268
|
-
|
|
2269
|
-
<tr>
|
|
2270
|
-
<td rowspan="1" colSpan="1" >param</td>
|
|
2271
|
-
|
|
2272
|
-
<td rowspan="1" colSpan="1" >For recording parameters, please refer to [TRTCAudioRecordingParams](https://write.woa.com/document/87030132707430400).</td>
|
|
2273
|
-
</tr>
|
|
2274
|
-
</table>
|
|
2275
|
-
|
|
975
|
+
| Parameters | Description |
|
|
976
|
+
| --- | --- |
|
|
977
|
+
| param | For recording parameters, please refer to TRTCAudioRecordingParams. |
|
|
2276
978
|
|
|
2277
979
|
> **Note**
|
|
2278
|
-
>
|
|
980
|
+
>
|
|
2279
981
|
|
|
2280
982
|
> Starting from version 11.5, the status results of audio recording are uniformly adjusted to asynchronous callback notifications. See the TRTCCloud related callbacks.
|
|
2281
|
-
>
|
|
2282
|
-
|
|
983
|
+
>
|
|
2283
984
|
|
|
2284
985
|
#### Return value description:
|
|
2285
986
|
|
|
@@ -2287,206 +988,93 @@ The start and completion status of this recording will be notified through local
|
|
|
2287
988
|
|
|
2288
989
|
## stopAudioRecording
|
|
2289
990
|
|
|
2290
|
-
|
|
2291
|
-
|
|
2292
991
|
#### Stop recording
|
|
2293
992
|
|
|
2294
993
|
If the recording task is not stopped by this interface before exiting the room, the recording task will automatically stop after exiting the room.
|
|
2295
994
|
|
|
2296
995
|
## startLocalRecording
|
|
2297
996
|
|
|
2298
|
-
|
|
2299
|
-
|
|
2300
997
|
#### Enable local media recording
|
|
2301
998
|
|
|
2302
999
|
After enabling, the audio and video content during the live stream will be recorded to a local file.
|
|
2303
|
-
|
|
2304
|
-
|
|
2305
|
-
|
|
2306
|
-
|
|
2307
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2308
|
-
</tr>
|
|
2309
|
-
|
|
2310
|
-
<tr>
|
|
2311
|
-
<td rowspan="1" colSpan="1" >params</td>
|
|
2312
|
-
|
|
2313
|
-
<td rowspan="1" colSpan="1" >For recording parameters, please refer to [TRTCLocalRecordingParams](https://write.woa.com/document/87030132707430400).</td>
|
|
2314
|
-
</tr>
|
|
2315
|
-
</table>
|
|
2316
|
-
|
|
1000
|
+
| Parameters | Description |
|
|
1001
|
+
| --- | --- |
|
|
1002
|
+
| params | For recording parameters, please refer to TRTCLocalRecordingParams. |
|
|
2317
1003
|
|
|
2318
1004
|
## stopLocalRecording
|
|
2319
1005
|
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
1006
|
#### Stop local media recording
|
|
2323
1007
|
|
|
2324
1008
|
If the recording task is not stopped by this interface before exiting the room, the recording task will automatically stop after exiting the room.
|
|
2325
1009
|
|
|
2326
1010
|
## setRemoteAudioParallelParams
|
|
2327
1011
|
|
|
2328
|
-
|
|
2329
|
-
|
|
2330
1012
|
#### Set intelligent concurrent playback strategy for remote audio streams
|
|
2331
1013
|
|
|
2332
1014
|
Set intelligent concurrent playback strategy for remote audio streams, suitable for scenarios with a large number of people on the microphone.
|
|
2333
|
-
|
|
2334
|
-
|
|
2335
|
-
|
|
2336
|
-
|
|
2337
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2338
|
-
</tr>
|
|
2339
|
-
|
|
2340
|
-
<tr>
|
|
2341
|
-
<td rowspan="1" colSpan="1" >params</td>
|
|
2342
|
-
|
|
2343
|
-
<td rowspan="1" colSpan="1" >For audio concurrency parameters, please refer to [TRTCAudioParallelParams](https://write.woa.com/document/87030132707430400).</td>
|
|
2344
|
-
</tr>
|
|
2345
|
-
</table>
|
|
2346
|
-
|
|
1015
|
+
| Parameters | Description |
|
|
1016
|
+
| --- | --- |
|
|
1017
|
+
| params | For audio concurrency parameters, please refer to TRTCAudioParallelParams. |
|
|
2347
1018
|
|
|
2348
1019
|
## enable3DSpatialAudioEffect
|
|
2349
1020
|
|
|
2350
|
-
|
|
2351
|
-
|
|
2352
1021
|
#### Enable 3D audio
|
|
2353
1022
|
|
|
2354
|
-
Enable 3D audio effects. Note that smooth sound quality
|
|
2355
|
-
|
|
2356
|
-
|
|
2357
|
-
|
|
2358
|
-
|
|
2359
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2360
|
-
</tr>
|
|
2361
|
-
|
|
2362
|
-
<tr>
|
|
2363
|
-
<td rowspan="1" colSpan="1" >enabled</td>
|
|
2364
|
-
|
|
2365
|
-
<td rowspan="1" colSpan="1" >Whether to enable 3D audio effects, disabled by default.</td>
|
|
2366
|
-
</tr>
|
|
2367
|
-
</table>
|
|
2368
|
-
|
|
1023
|
+
Enable 3D audio effects. Note that smooth sound quality TRTCAudioQualitySpeech or default sound quality TRTCAudioQualityDefault should be used.
|
|
1024
|
+
| Parameters | Description |
|
|
1025
|
+
| --- | --- |
|
|
1026
|
+
| enabled | Whether to enable 3D audio effects, disabled by default. |
|
|
2369
1027
|
|
|
2370
1028
|
## updateSelf3DSpatialPosition
|
|
2371
1029
|
|
|
2372
|
-
|
|
2373
|
-
|
|
2374
1030
|
#### Set self coordinates and orientation information in 3D audio
|
|
2375
1031
|
|
|
2376
1032
|
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.
|
|
2377
|
-
|
|
2378
|
-
|
|
2379
|
-
|
|
2380
|
-
|
|
2381
|
-
|
|
2382
|
-
|
|
2383
|
-
|
|
2384
|
-
<tr>
|
|
2385
|
-
<td rowspan="1" colSpan="1" >axisForward</td>
|
|
2386
|
-
|
|
2387
|
-
<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>
|
|
2388
|
-
</tr>
|
|
2389
|
-
|
|
2390
|
-
<tr>
|
|
2391
|
-
<td rowspan="1" colSpan="1" >axisRight</td>
|
|
2392
|
-
|
|
2393
|
-
<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>
|
|
2394
|
-
</tr>
|
|
2395
|
-
|
|
2396
|
-
<tr>
|
|
2397
|
-
<td rowspan="1" colSpan="1" >axisUp</td>
|
|
2398
|
-
|
|
2399
|
-
<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>
|
|
2400
|
-
</tr>
|
|
2401
|
-
|
|
2402
|
-
<tr>
|
|
2403
|
-
<td rowspan="1" colSpan="1" >position</td>
|
|
2404
|
-
|
|
2405
|
-
<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>
|
|
2406
|
-
</tr>
|
|
2407
|
-
</table>
|
|
2408
|
-
|
|
1033
|
+
| Parameters | Description |
|
|
1034
|
+
| --- | --- |
|
|
1035
|
+
| 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. |
|
|
1036
|
+
| 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. |
|
|
1037
|
+
| 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. |
|
|
1038
|
+
| position | Your coordinate in the world coordinate system, with three values representing the front, right, and up coordinate values, respectively. |
|
|
2409
1039
|
|
|
2410
1040
|
> **Note**
|
|
2411
|
-
>
|
|
1041
|
+
>
|
|
2412
1042
|
|
|
2413
1043
|
> Please appropriately limit the invocation frequency. It is recommended to set coordinates at intervals of at least 100ms.
|
|
2414
|
-
>
|
|
2415
|
-
|
|
1044
|
+
>
|
|
2416
1045
|
|
|
2417
1046
|
## updateRemote3DSpatialPosition
|
|
2418
1047
|
|
|
2419
|
-
|
|
2420
|
-
|
|
2421
1048
|
#### Set remote user coordinate information in 3D audio
|
|
2422
1049
|
|
|
2423
1050
|
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.
|
|
2424
|
-
|
|
2425
|
-
|
|
2426
|
-
|
|
2427
|
-
|
|
2428
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2429
|
-
</tr>
|
|
2430
|
-
|
|
2431
|
-
<tr>
|
|
2432
|
-
<td rowspan="1" colSpan="1" >position</td>
|
|
2433
|
-
|
|
2434
|
-
<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>
|
|
2435
|
-
</tr>
|
|
2436
|
-
|
|
2437
|
-
<tr>
|
|
2438
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
2439
|
-
|
|
2440
|
-
<td rowspan="1" colSpan="1" >Specify the remote user's ID.</td>
|
|
2441
|
-
</tr>
|
|
2442
|
-
</table>
|
|
2443
|
-
|
|
1051
|
+
| Parameters | Description |
|
|
1052
|
+
| --- | --- |
|
|
1053
|
+
| position | The coordinate of the remote user in the world coordinate system, with three values representing the front, right, and up coordinate values, respectively. |
|
|
1054
|
+
| userId | Specify the remote user's ID. |
|
|
2444
1055
|
|
|
2445
1056
|
> **Note**
|
|
2446
|
-
>
|
|
1057
|
+
>
|
|
2447
1058
|
|
|
2448
1059
|
> Please appropriately limit the invocation frequency. It is recommended to set coordinates for the same remote user at intervals of at least 100ms.
|
|
2449
|
-
>
|
|
2450
|
-
|
|
1060
|
+
>
|
|
2451
1061
|
|
|
2452
1062
|
## set3DSpatialReceivingRange
|
|
2453
1063
|
|
|
2454
|
-
|
|
2455
|
-
|
|
2456
1064
|
#### Set the receivable range of sounds emitted by a specified user
|
|
2457
1065
|
|
|
2458
1066
|
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.
|
|
2459
|
-
|
|
2460
|
-
|
|
2461
|
-
|
|
2462
|
-
|
|
2463
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2464
|
-
</tr>
|
|
2465
|
-
|
|
2466
|
-
<tr>
|
|
2467
|
-
<td rowspan="1" colSpan="1" >range</td>
|
|
2468
|
-
|
|
2469
|
-
<td rowspan="1" colSpan="1" >Maximum range at which the sound can be received.</td>
|
|
2470
|
-
</tr>
|
|
2471
|
-
|
|
2472
|
-
<tr>
|
|
2473
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
2474
|
-
|
|
2475
|
-
<td rowspan="1" colSpan="1" >Specify the remote user's ID.</td>
|
|
2476
|
-
</tr>
|
|
2477
|
-
</table>
|
|
2478
|
-
|
|
1067
|
+
| Parameters | Description |
|
|
1068
|
+
| --- | --- |
|
|
1069
|
+
| range | Maximum range at which the sound can be received. |
|
|
1070
|
+
| userId | Specify the remote user's ID. |
|
|
2479
1071
|
|
|
2480
1072
|
## getDeviceManager
|
|
2481
1073
|
|
|
2482
|
-
|
|
2483
|
-
|
|
2484
1074
|
#### Get Device Management Class (TXDeviceManager)
|
|
2485
1075
|
|
|
2486
1076
|
## setBeautyStyle
|
|
2487
1077
|
|
|
2488
|
-
|
|
2489
|
-
|
|
2490
1078
|
#### Set special effects like beauty filter, whitening, and rosy skin
|
|
2491
1079
|
|
|
2492
1080
|
The SDK integrates two different skin smoothing algorithms:
|
|
@@ -2494,43 +1082,15 @@ The SDK integrates two different skin smoothing algorithms:
|
|
|
2494
1082
|
-"Smooth": This algorithm is more aggressive, providing a more noticeable smoothing effect, suitable for show live streaming.
|
|
2495
1083
|
|
|
2496
1084
|
-"Natural": This algorithm retains more facial details, offering a more natural smoothing effect, suitable for most live streaming scenarios.
|
|
2497
|
-
|
|
2498
|
-
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
|
|
2502
|
-
|
|
2503
|
-
|
|
2504
|
-
<tr>
|
|
2505
|
-
<td rowspan="1" colSpan="1" >beautyLevel</td>
|
|
2506
|
-
|
|
2507
|
-
<td rowspan="1" colSpan="1" >Beauty level, value range 0 - 9, 0 means disabled, the greater the value from 1 - 9, the more obvious the effect.</td>
|
|
2508
|
-
</tr>
|
|
2509
|
-
|
|
2510
|
-
<tr>
|
|
2511
|
-
<td rowspan="1" colSpan="1" >ruddinessLevel</td>
|
|
2512
|
-
|
|
2513
|
-
<td rowspan="1" colSpan="1" >Rosy level, value range 0 - 9, 0 means disabled, the greater the value from 1 - 9, the more obvious the effect.</td>
|
|
2514
|
-
</tr>
|
|
2515
|
-
|
|
2516
|
-
<tr>
|
|
2517
|
-
<td rowspan="1" colSpan="1" >style</td>
|
|
2518
|
-
|
|
2519
|
-
<td rowspan="1" colSpan="1" >Skin smoothing algorithm, available in two types: "Smooth" and "Natural".</td>
|
|
2520
|
-
</tr>
|
|
2521
|
-
|
|
2522
|
-
<tr>
|
|
2523
|
-
<td rowspan="1" colSpan="1" >whitenessLevel</td>
|
|
2524
|
-
|
|
2525
|
-
<td rowspan="1" colSpan="1" >Whitening level, value range 0 - 9, 0 means disabled, the greater the value from 1 - 9, the more obvious the effect.</td>
|
|
2526
|
-
</tr>
|
|
2527
|
-
</table>
|
|
2528
|
-
|
|
1085
|
+
| Parameters | Description |
|
|
1086
|
+
| --- | --- |
|
|
1087
|
+
| beautyLevel | Beauty level, value range 0 - 9, 0 means disabled, the greater the value from 1 - 9, the more obvious the effect. |
|
|
1088
|
+
| ruddinessLevel | Rosy level, value range 0 - 9, 0 means disabled, the greater the value from 1 - 9, the more obvious the effect. |
|
|
1089
|
+
| style | Skin smoothing algorithm, available in two types: "Smooth" and "Natural". |
|
|
1090
|
+
| whitenessLevel | Whitening level, value range 0 - 9, 0 means disabled, the greater the value from 1 - 9, the more obvious the effect. |
|
|
2529
1091
|
|
|
2530
1092
|
## setWaterMark
|
|
2531
1093
|
|
|
2532
|
-
|
|
2533
|
-
|
|
2534
1094
|
#### Watermarking
|
|
2535
1095
|
|
|
2536
1096
|
The watermark position is specified by xOffset, yOffset, and fWidthRatio.
|
|
@@ -2540,80 +1100,26 @@ The watermark position is specified by xOffset, yOffset, and fWidthRatio.
|
|
|
2540
1100
|
|
|
2541
1101
|
- fWidthRatio: The watermark's size ratio in the range of 0 - 1 as a floating point number.
|
|
2542
1102
|
|
|
2543
|
-
|
|
2544
|
-
|
|
2545
|
-
|
|
2546
|
-
|
|
2547
|
-
|
|
2548
|
-
|
|
2549
|
-
|
|
2550
|
-
|
|
2551
|
-
|
|
2552
|
-
|
|
2553
|
-
|
|
2554
|
-
</tr>
|
|
2555
|
-
|
|
2556
|
-
<tr>
|
|
2557
|
-
<td rowspan="1" colSpan="1" >isVisibleOnLocalPreview</td>
|
|
2558
|
-
|
|
2559
|
-
<td rowspan="1" colSpan="1" >true: Watermark displayed in local preview; false: Watermark not displayed in local preview, effective only on win/mac.</td>
|
|
2560
|
-
</tr>
|
|
2561
|
-
|
|
2562
|
-
<tr>
|
|
2563
|
-
<td rowspan="1" colSpan="1" >nHeight</td>
|
|
2564
|
-
|
|
2565
|
-
<td rowspan="1" colSpan="1" >Watermark image pixel height (ignored if source data is file path).</td>
|
|
2566
|
-
</tr>
|
|
2567
|
-
|
|
2568
|
-
<tr>
|
|
2569
|
-
<td rowspan="1" colSpan="1" >nWidth</td>
|
|
2570
|
-
|
|
2571
|
-
<td rowspan="1" colSpan="1" >Watermark image pixel width (ignored if source data is file path).</td>
|
|
2572
|
-
</tr>
|
|
2573
|
-
|
|
2574
|
-
<tr>
|
|
2575
|
-
<td rowspan="1" colSpan="1" >srcData</td>
|
|
2576
|
-
|
|
2577
|
-
<td rowspan="1" colSpan="1" >Watermark image source data (set to nullptr to remove watermark).</td>
|
|
2578
|
-
</tr>
|
|
2579
|
-
|
|
2580
|
-
<tr>
|
|
2581
|
-
<td rowspan="1" colSpan="1" >srcType</td>
|
|
2582
|
-
|
|
2583
|
-
<td rowspan="1" colSpan="1" >Watermark image source data type.</td>
|
|
2584
|
-
</tr>
|
|
2585
|
-
|
|
2586
|
-
<tr>
|
|
2587
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
2588
|
-
|
|
2589
|
-
<td rowspan="1" colSpan="1" >Stream type to apply the watermark (TRTCVideoStreamTypeBig, TRTCVideoStreamTypeSub).</td>
|
|
2590
|
-
</tr>
|
|
2591
|
-
|
|
2592
|
-
<tr>
|
|
2593
|
-
<td rowspan="1" colSpan="1" >xOffset</td>
|
|
2594
|
-
|
|
2595
|
-
<td rowspan="1" colSpan="1" >X-axis offset for the top-left corner of watermark display.</td>
|
|
2596
|
-
</tr>
|
|
2597
|
-
|
|
2598
|
-
<tr>
|
|
2599
|
-
<td rowspan="1" colSpan="1" >yOffset</td>
|
|
2600
|
-
|
|
2601
|
-
<td rowspan="1" colSpan="1" >Y-axis offset for the top-left corner of watermark display.</td>
|
|
2602
|
-
</tr>
|
|
2603
|
-
</table>
|
|
2604
|
-
|
|
1103
|
+
| Parameters | Description |
|
|
1104
|
+
| --- | --- |
|
|
1105
|
+
| fWidthRatio | The width of the watermark displayed as a proportion of the screen width (the watermark is proportionally scaled according to this parameter). |
|
|
1106
|
+
| isVisibleOnLocalPreview | true: Watermark displayed in local preview; false: Watermark not displayed in local preview, effective only on win/mac. |
|
|
1107
|
+
| nHeight | Watermark image pixel height (ignored if source data is file path). |
|
|
1108
|
+
| nWidth | Watermark image pixel width (ignored if source data is file path). |
|
|
1109
|
+
| srcData | Watermark image source data (set to nullptr to remove watermark). |
|
|
1110
|
+
| srcType | Watermark image source data type. |
|
|
1111
|
+
| streamType | Stream type to apply the watermark (TRTCVideoStreamTypeBig, TRTCVideoStreamTypeSub). |
|
|
1112
|
+
| xOffset | X-axis offset for the top-left corner of watermark display. |
|
|
1113
|
+
| yOffset | Y-axis offset for the top-left corner of watermark display. |
|
|
2605
1114
|
|
|
2606
1115
|
> **Note**
|
|
2607
|
-
>
|
|
1116
|
+
>
|
|
2608
1117
|
|
|
2609
1118
|
> This interface only supports adding image watermarks to the main video stream.
|
|
2610
|
-
>
|
|
2611
|
-
|
|
1119
|
+
>
|
|
2612
1120
|
|
|
2613
1121
|
## getAudioEffectManager
|
|
2614
1122
|
|
|
2615
|
-
|
|
2616
|
-
|
|
2617
1123
|
#### Get Audio Effect Management Class (TXAudioEffectManager)
|
|
2618
1124
|
|
|
2619
1125
|
TXAudioEffectManager is the audio effect management interface. Through this interface, you can implement the following features:
|
|
@@ -2627,11 +1133,8 @@ TXAudioEffectManager is the audio effect management interface. Through this inte
|
|
|
2627
1133
|
|
|
2628
1134
|
- 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).
|
|
2629
1135
|
|
|
2630
|
-
|
|
2631
1136
|
## startSystemAudioLoopback
|
|
2632
1137
|
|
|
2633
|
-
|
|
2634
|
-
|
|
2635
1138
|
#### Enable System Sound Capture (iOS not yet supported)
|
|
2636
1139
|
|
|
2637
1140
|
This interface captures audio data from the computer's sound card and mixes 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 computer.
|
|
@@ -2639,177 +1142,100 @@ This interface captures audio data from the computer's sound card and mixes it i
|
|
|
2639
1142
|
In online education scenarios, teachers can use this feature to allow the SDK to capture the audio from educational videos and broadcast it to students in the same room.
|
|
2640
1143
|
|
|
2641
1144
|
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.
|
|
2642
|
-
|
|
2643
|
-
|
|
2644
|
-
|
|
2645
|
-
|
|
2646
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2647
|
-
</tr>
|
|
2648
|
-
|
|
2649
|
-
<tr>
|
|
2650
|
-
<td rowspan="1" colSpan="1" >deviceName</td>
|
|
2651
|
-
|
|
2652
|
-
<td rowspan="1" colSpan="1" >You can set this parameter to nullptr, indicating the SDK captures the entire system sound.</td>
|
|
2653
|
-
</tr>
|
|
2654
|
-
</table>
|
|
2655
|
-
|
|
1145
|
+
| Parameters | Description |
|
|
1146
|
+
| --- | --- |
|
|
1147
|
+
| deviceName | You can set this parameter to nullptr, indicating the SDK captures the entire system sound. |
|
|
2656
1148
|
|
|
2657
1149
|
> **Note**
|
|
2658
|
-
>
|
|
1150
|
+
>
|
|
2659
1151
|
|
|
2660
1152
|
> On the Windows platform, you can also set the parameter deviceName to the absolute path of an application executable (e.g., QQMusic.exe). In this case, the SDK will capture only the application's sound (supports 32-bit SDK, and 64-bit SDK requires Windows version 10.0.19042 or higher).
|
|
2661
|
-
>
|
|
1153
|
+
>
|
|
2662
1154
|
|
|
2663
|
-
> You can also set the parameter to a specific speaker device name to capture sound from that speaker (get the speaker devices of type
|
|
2664
|
-
>
|
|
1155
|
+
> You can also set the parameter to a specific speaker device name to capture sound from that speaker (get the speaker devices of type TXMediaDeviceTypeSpeaker from the TXDeviceManager's getDevicesList interface).
|
|
1156
|
+
>
|
|
2665
1157
|
|
|
2666
1158
|
> On the Windows platform, you can also set this parameter to a process id (format as "process_xxx", where xxx is the process id). The SDK will capture the sound from that process (requires Windows version 10.0.19042 or higher).
|
|
2667
|
-
>
|
|
1159
|
+
>
|
|
2668
1160
|
|
|
2669
1161
|
> On the Windows platform, you can also set this parameter as a process ID (format as "exclude_process_xxx", where xxx is the process ID). In this case, the SDK will capture all audio except for the specified process (requires Windows version 10.0.19042 or higher).
|
|
2670
|
-
>
|
|
2671
|
-
|
|
1162
|
+
>
|
|
2672
1163
|
|
|
2673
1164
|
## stopSystemAudioLoopback
|
|
2674
1165
|
|
|
2675
|
-
|
|
2676
|
-
|
|
2677
1166
|
#### Stop System Sound Capture (iOS not yet supported)
|
|
2678
1167
|
|
|
2679
1168
|
## setSystemAudioLoopbackVolume
|
|
2680
1169
|
|
|
2681
|
-
|
|
2682
|
-
|
|
2683
1170
|
#### Sets the Volume of System Sound Capture
|
|
2684
|
-
|
|
2685
|
-
|
|
2686
|
-
|
|
2687
|
-
|
|
2688
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2689
|
-
</tr>
|
|
2690
|
-
|
|
2691
|
-
<tr>
|
|
2692
|
-
<td rowspan="1" colSpan="1" >volume</td>
|
|
2693
|
-
|
|
2694
|
-
<td rowspan="1" colSpan="1" >Set the volume level, range: [0 ~ 150], default value is 100.</td>
|
|
2695
|
-
</tr>
|
|
2696
|
-
</table>
|
|
2697
|
-
|
|
1171
|
+
| Parameters | Description |
|
|
1172
|
+
| --- | --- |
|
|
1173
|
+
| volume | Set the volume level, range: [0 ~ 150], default value is 100. |
|
|
2698
1174
|
|
|
2699
1175
|
## startScreenCapture
|
|
2700
1176
|
|
|
2701
|
-
|
|
2702
|
-
|
|
2703
1177
|
#### Start Screen Sharing
|
|
2704
1178
|
|
|
2705
1179
|
This interface can capture the entire screen content or the content of a specific application window you designate, sharing it with other users in the same room.
|
|
2706
|
-
|
|
2707
|
-
|
|
2708
|
-
<
|
|
2709
|
-
|
|
2710
|
-
|
|
2711
|
-
</tr>
|
|
2712
|
-
|
|
2713
|
-
<tr>
|
|
2714
|
-
<td rowspan="1" colSpan="1" >encParam</td>
|
|
2715
|
-
|
|
2716
|
-
<td rowspan="1" colSpan="1" >Screen Sharing Encoding Parameters: The SDK prioritizes the encoding parameters you set through this interface<br>- If you set encParam to null and have set substream video encoding parameters through setSubStreamEncoderParam, the SDK will use those parameters for screen sharing.<br>- If you set encParam to null and have not set substream video encoding parameters through setSubStreamEncoderParam, the SDK will automatically select the best encoding parameters for screen sharing.</td>
|
|
2717
|
-
</tr>
|
|
2718
|
-
|
|
2719
|
-
<tr>
|
|
2720
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
2721
|
-
|
|
2722
|
-
<td rowspan="1" colSpan="1" >The circuit used for screen sharing can be set to Main Road (TRTCVideoStreamTypeBig) or Auxiliary Road (TRTCVideoStreamTypeSub), with the auxiliary road being recommended.</td>
|
|
2723
|
-
</tr>
|
|
2724
|
-
|
|
2725
|
-
<tr>
|
|
2726
|
-
<td rowspan="1" colSpan="1" >view</td>
|
|
2727
|
-
|
|
2728
|
-
<td rowspan="1" colSpan="1" >The parent control of the rendering control can be set to null, indicating that the preview effect of screen sharing will not be displayed.</td>
|
|
2729
|
-
</tr>
|
|
2730
|
-
</table>
|
|
2731
|
-
|
|
1180
|
+
| Parameters | Description |
|
|
1181
|
+
| --- | --- |
|
|
1182
|
+
| encParam | Screen Sharing Encoding Parameters: The SDK prioritizes the encoding parameters you set through this interface<br>- If you set encParam to null and have set substream video encoding parameters through setSubStreamEncoderParam, the SDK will use those parameters for screen sharing.<br>- If you set encParam to null and have not set substream video encoding parameters through setSubStreamEncoderParam, the SDK will automatically select the best encoding parameters for screen sharing. |
|
|
1183
|
+
| streamType | The circuit used for screen sharing can be set to Main Road (TRTCVideoStreamTypeBig) or Auxiliary Road (TRTCVideoStreamTypeSub), with the auxiliary road being recommended. |
|
|
1184
|
+
| view | The parent control of the rendering control can be set to null, indicating that the preview effect of screen sharing will not be displayed. |
|
|
2732
1185
|
|
|
2733
1186
|
> **Note**
|
|
2734
|
-
>
|
|
1187
|
+
>
|
|
2735
1188
|
|
|
2736
|
-
> 1. The same user can publish only one main road (
|
|
2737
|
-
>
|
|
1189
|
+
> 1. The same user can publish only one main road (TRTCVideoStreamTypeBig) screen and one auxiliary road (TRTCVideoStreamTypeSub) screen at the same time.
|
|
1190
|
+
>
|
|
2738
1191
|
|
|
2739
|
-
> 2. By default, screen sharing uses the auxiliary road. If you use the main road for screen sharing, you need to stop local preview (
|
|
2740
|
-
>
|
|
1192
|
+
> 2. By default, screen sharing uses the auxiliary road. If you use the main road for screen sharing, you need to stop local preview (stopLocalPreview) in advance to avoid conflicts.
|
|
1193
|
+
>
|
|
2741
1194
|
|
|
2742
1195
|
> 3. Only one user can use the auxiliary road for screen sharing in the same room at any given time. In other words, only one user can enable the auxiliary road in the same room simultaneously.
|
|
2743
|
-
>
|
|
2744
|
-
|
|
2745
|
-
> 4. If another user in the room is already sharing the screen using an auxiliary road, calling this interface will receive an onError(ERR_SERVER_CENTER_ANOTHER_USER_PUSH_SUB_VIDEO) callback from [ITRTCCloudCallback](https://write.woa.com/document/87030021158866944).
|
|
2746
|
-
>
|
|
1196
|
+
>
|
|
2747
1197
|
|
|
1198
|
+
> 4. If another user in the room is already sharing the screen using an auxiliary road, calling this interface will receive an onError(ERR_SERVER_CENTER_ANOTHER_USER_PUSH_SUB_VIDEO) callback from ITRTCCloudCallback.
|
|
1199
|
+
>
|
|
2748
1200
|
|
|
2749
1201
|
## stopScreenCapture
|
|
2750
1202
|
|
|
2751
|
-
|
|
2752
|
-
|
|
2753
1203
|
#### Stopping Screen Sharing
|
|
2754
1204
|
|
|
2755
1205
|
## pauseScreenCapture
|
|
2756
1206
|
|
|
2757
|
-
|
|
2758
|
-
|
|
2759
1207
|
#### Pause Screen Sharing
|
|
2760
1208
|
|
|
2761
1209
|
> **Note**
|
|
2762
|
-
>
|
|
1210
|
+
>
|
|
2763
1211
|
|
|
2764
1212
|
> Starting from version 11.5, suspending screen capture will output the last frame at a frame rate of 1fps.
|
|
2765
|
-
>
|
|
2766
|
-
|
|
1213
|
+
>
|
|
2767
1214
|
|
|
2768
1215
|
## resumeScreenCapture
|
|
2769
1216
|
|
|
2770
|
-
|
|
2771
|
-
|
|
2772
1217
|
#### Resume Screen Sharing
|
|
2773
1218
|
|
|
2774
1219
|
## getScreenCaptureSources
|
|
2775
1220
|
|
|
2776
|
-
|
|
2777
|
-
|
|
2778
1221
|
#### Enumerate shareable screens and windows (this interface supports only desktop systems)
|
|
2779
1222
|
|
|
2780
1223
|
When integrating the screen sharing feature on a desktop system, it is usually necessary to display an interface for selecting a sharing target. This allows users to choose whether to share the entire screen or a specific window.
|
|
2781
1224
|
|
|
2782
1225
|
Through this interface, you can query the current system for the ID, name, and thumbnail of available windows for sharing. We provide a default interface implementation in our Demo for your reference.
|
|
2783
|
-
|
|
2784
|
-
|
|
2785
|
-
|
|
2786
|
-
|
|
2787
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2788
|
-
</tr>
|
|
2789
|
-
|
|
2790
|
-
<tr>
|
|
2791
|
-
<td rowspan="1" colSpan="1" >iconSize</td>
|
|
2792
|
-
|
|
2793
|
-
<td rowspan="1" colSpan="1" >Specify the size of the window icon to be retrieved.</td>
|
|
2794
|
-
</tr>
|
|
2795
|
-
|
|
2796
|
-
<tr>
|
|
2797
|
-
<td rowspan="1" colSpan="1" >thumbnailSize</td>
|
|
2798
|
-
|
|
2799
|
-
<td rowspan="1" colSpan="1" >Specify the size of the window thumbnail to be retrieved. Thumbnails can be used to render on the window selection interface.</td>
|
|
2800
|
-
</tr>
|
|
2801
|
-
</table>
|
|
2802
|
-
|
|
1226
|
+
| Parameters | Description |
|
|
1227
|
+
| --- | --- |
|
|
1228
|
+
| iconSize | Specify the size of the window icon to be retrieved. |
|
|
1229
|
+
| thumbnailSize | Specify the size of the window thumbnail to be retrieved. Thumbnails can be used to render on the window selection interface. |
|
|
2803
1230
|
|
|
2804
1231
|
> **Note**
|
|
2805
|
-
>
|
|
1232
|
+
>
|
|
2806
1233
|
|
|
2807
1234
|
> 1. The returned list includes screens and application windows, with the screen being the first element in the list. If the user has multiple monitors, each monitor is a sharing target.
|
|
2808
|
-
>
|
|
1235
|
+
>
|
|
2809
1236
|
|
|
2810
1237
|
> 2. Do not use delete ITRTCScreenCaptureSourceList* to remove SourceList as it is prone to cause crashes. Use the release method in ITRTCScreenCaptureSourceList to release the list.
|
|
2811
|
-
>
|
|
2812
|
-
|
|
1238
|
+
>
|
|
2813
1239
|
|
|
2814
1240
|
#### Return value description:
|
|
2815
1241
|
|
|
@@ -2817,16 +1243,12 @@ The window list includes the screen.
|
|
|
2817
1243
|
|
|
2818
1244
|
## selectScreenCaptureTarget
|
|
2819
1245
|
|
|
2820
|
-
|
|
2821
|
-
|
|
2822
1246
|
#### Select the screen or window to share (this interface supports only desktop systems)
|
|
2823
1247
|
|
|
2824
1248
|
After you retrieve the shareable screens and windows using getScreenCaptureSources, you can call this interface to select the desired target screen or window for sharing.
|
|
2825
1249
|
|
|
2826
1250
|
During screen sharing, you can also call this interface at any time to switch the sharing target.
|
|
2827
1251
|
|
|
2828
|
-
|
|
2829
|
-
|
|
2830
1252
|
Supports the following four cases:
|
|
2831
1253
|
- Share the entire screen: The type in sourceInfoList is Screen, and captureRect is set to { 0, 0, 0, 0 }
|
|
2832
1254
|
|
|
@@ -2836,262 +1258,134 @@ Supports the following four cases:
|
|
|
2836
1258
|
|
|
2837
1259
|
- Share a window area: The type in sourceInfoList is Window, and captureRect is set to a non-nullptr, for example, { 100, 100, 300, 300 }
|
|
2838
1260
|
|
|
2839
|
-
|
|
2840
|
-
|
|
2841
|
-
|
|
2842
|
-
|
|
2843
|
-
|
|
2844
|
-
</tr>
|
|
2845
|
-
|
|
2846
|
-
<tr>
|
|
2847
|
-
<td rowspan="1" colSpan="1" >captureRect</td>
|
|
2848
|
-
|
|
2849
|
-
<td rowspan="1" colSpan="1" >Specify the capture area</td>
|
|
2850
|
-
</tr>
|
|
2851
|
-
|
|
2852
|
-
<tr>
|
|
2853
|
-
<td rowspan="1" colSpan="1" >property</td>
|
|
2854
|
-
|
|
2855
|
-
<td rowspan="1" colSpan="1" >Specify the properties of the screen sharing target, including capturing the mouse, highlighting the capture window, etc. For details, refer to the TRTCScreenCaptureProperty Definition</td>
|
|
2856
|
-
</tr>
|
|
2857
|
-
|
|
2858
|
-
<tr>
|
|
2859
|
-
<td rowspan="1" colSpan="1" >source</td>
|
|
2860
|
-
|
|
2861
|
-
<td rowspan="1" colSpan="1" >Specifying sharing source</td>
|
|
2862
|
-
</tr>
|
|
2863
|
-
</table>
|
|
2864
|
-
|
|
1261
|
+
| Parameters | Description |
|
|
1262
|
+
| --- | --- |
|
|
1263
|
+
| captureRect | Specify the capture area |
|
|
1264
|
+
| property | Specify the properties of the screen sharing target, including capturing the mouse, highlighting the capture window, etc. For details, refer to the TRTCScreenCaptureProperty Definition |
|
|
1265
|
+
| source | Specifying sharing source |
|
|
2865
1266
|
|
|
2866
1267
|
> **Note**
|
|
2867
|
-
>
|
|
1268
|
+
>
|
|
2868
1269
|
|
|
2869
1270
|
> Setting highlight border color and width parameter is not effective on Mac platform.
|
|
2870
|
-
>
|
|
2871
|
-
|
|
1271
|
+
>
|
|
2872
1272
|
|
|
2873
1273
|
## setSubStreamEncoderParam
|
|
2874
1274
|
|
|
2875
|
-
|
|
2876
|
-
|
|
2877
1275
|
#### Set Video Encoding Parameters for Screen Sharing (Sub-Stream) (Supported on Both Desktop and Mobile Systems)
|
|
2878
1276
|
|
|
2879
1277
|
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.
|
|
2880
1278
|
|
|
2881
1279
|
Please note the differences between the following two interfaces:
|
|
2882
|
-
-
|
|
2883
|
-
|
|
2884
|
-
- [setSubStreamEncoderParam](https://write.woa.com/document/87030026264555520) is used to set the video encoding parameters for the auxiliary stream ([TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400), usually for screen sharing).
|
|
2885
|
-
|
|
2886
|
-
<table>
|
|
2887
|
-
<tr>
|
|
2888
|
-
<td rowspan="1" colSpan="1" >Parameters</td>
|
|
2889
|
-
|
|
2890
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2891
|
-
</tr>
|
|
2892
|
-
|
|
2893
|
-
<tr>
|
|
2894
|
-
<td rowspan="1" colSpan="1" >param</td>
|
|
1280
|
+
- setVideoEncoderParam is used to set the video encoding parameters for the main stream (TRTCVideoStreamTypeBig, usually for the camera).
|
|
2895
1281
|
|
|
2896
|
-
|
|
2897
|
-
</tr>
|
|
2898
|
-
</table>
|
|
1282
|
+
- setSubStreamEncoderParam is used to set the video encoding parameters for the auxiliary stream (TRTCVideoStreamTypeSub, usually for screen sharing).
|
|
2899
1283
|
|
|
1284
|
+
| Parameters | Description |
|
|
1285
|
+
| --- | --- |
|
|
1286
|
+
| param | For auxiliary stream encoding parameters, please refer to TRTCVideoEncParam. |
|
|
2900
1287
|
|
|
2901
1288
|
## setSubStreamMixVolume
|
|
2902
1289
|
|
|
2903
|
-
|
|
2904
|
-
|
|
2905
1290
|
#### Set the Mixing Volume for Screen Sharing (This Interface Supports Only Desktop Systems)
|
|
2906
1291
|
|
|
2907
1292
|
The higher this value, the higher the proportion of screen sharing volume, and the lower the proportion of microphone volume. Therefore, it is not recommended to set it too high, as it will suppress the microphone sound.
|
|
2908
|
-
|
|
2909
|
-
|
|
2910
|
-
|
|
2911
|
-
|
|
2912
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2913
|
-
</tr>
|
|
2914
|
-
|
|
2915
|
-
<tr>
|
|
2916
|
-
<td rowspan="1" colSpan="1" >volume</td>
|
|
2917
|
-
|
|
2918
|
-
<td rowspan="1" colSpan="1" >Set the mix volume level, ranging from 0 to 100.</td>
|
|
2919
|
-
</tr>
|
|
2920
|
-
</table>
|
|
2921
|
-
|
|
1293
|
+
| Parameters | Description |
|
|
1294
|
+
| --- | --- |
|
|
1295
|
+
| volume | Set the mix volume level, ranging from 0 to 100. |
|
|
2922
1296
|
|
|
2923
1297
|
## addExcludedShareWindow
|
|
2924
1298
|
|
|
2925
|
-
|
|
2926
|
-
|
|
2927
1299
|
#### Add the Specified Window to the Exclusion List of Screen Sharing (This Interface Supports Only Desktop Systems)
|
|
2928
1300
|
|
|
2929
1301
|
Windows added to the exclusion list will not be shared. A common use case is to add a window from an application to the exclusion list to avoid privacy issues.
|
|
2930
1302
|
|
|
2931
1303
|
Support setting filter windows before starting screen sharing, and also dynamically adding filter windows during screen sharing.
|
|
2932
|
-
|
|
2933
|
-
|
|
2934
|
-
|
|
2935
|
-
|
|
2936
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2937
|
-
</tr>
|
|
2938
|
-
|
|
2939
|
-
<tr>
|
|
2940
|
-
<td rowspan="1" colSpan="1" >windowID</td>
|
|
2941
|
-
|
|
2942
|
-
<td rowspan="1" colSpan="1" >Windows that you do not want to share</td>
|
|
2943
|
-
</tr>
|
|
2944
|
-
</table>
|
|
2945
|
-
|
|
1304
|
+
| Parameters | Description |
|
|
1305
|
+
| --- | --- |
|
|
1306
|
+
| windowID | Windows that you do not want to share |
|
|
2946
1307
|
|
|
2947
1308
|
> **Note**
|
|
2948
|
-
>
|
|
1309
|
+
>
|
|
2949
1310
|
|
|
2950
|
-
> 1. This interface only takes effect when the type in
|
|
2951
|
-
>
|
|
1311
|
+
> 1. This interface only takes effect when the type in TRTCScreenCaptureSourceInfo is specified as TRTCScreenCaptureSourceTypeScreen, meaning the exclusion feature only works when sharing the entire screen content.
|
|
1312
|
+
>
|
|
2952
1313
|
|
|
2953
1314
|
> 2. Windows added to the exclusion list using this interface will be automatically cleared by the SDK upon exiting the room.
|
|
2954
|
-
>
|
|
2955
|
-
|
|
2956
|
-
> 3. On Mac platform, please pass in the window ID (i.e., CGWindowID), which can be obtained from the sourceId member in [TRTCScreenCaptureSourceInfo](https://write.woa.com/document/87030132707430400).
|
|
2957
|
-
>
|
|
1315
|
+
>
|
|
2958
1316
|
|
|
1317
|
+
> 3. On Mac platform, please pass in the window ID (i.e., CGWindowID), which can be obtained from the sourceId member in TRTCScreenCaptureSourceInfo.
|
|
1318
|
+
>
|
|
2959
1319
|
|
|
2960
1320
|
## removeExcludedShareWindow
|
|
2961
1321
|
|
|
1322
|
+
#### Remove the Specified Window from the Exclusion List of Screen Sharing (This Interface Supports Only Desktop Systems)
|
|
1323
|
+
| Parameters | Description |
|
|
1324
|
+
| --- | --- |
|
|
1325
|
+
| windowID | The window ID to be excluded. |
|
|
2962
1326
|
|
|
1327
|
+
## removeAllExcludedShareWindow
|
|
2963
1328
|
|
|
2964
|
-
#### Remove
|
|
2965
|
-
<table>
|
|
2966
|
-
<tr>
|
|
2967
|
-
<td rowspan="1" colSpan="1" >Parameters</td>
|
|
2968
|
-
|
|
2969
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
2970
|
-
</tr>
|
|
2971
|
-
|
|
2972
|
-
<tr>
|
|
2973
|
-
<td rowspan="1" colSpan="1" >windowID</td>
|
|
2974
|
-
|
|
2975
|
-
<td rowspan="1" colSpan="1" >The window ID to be excluded.</td>
|
|
2976
|
-
</tr>
|
|
2977
|
-
</table>
|
|
2978
|
-
|
|
2979
|
-
|
|
2980
|
-
## removeAllExcludedShareWindow
|
|
2981
|
-
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
#### Remove All Windows from the Exclusion List of Screen Sharing (This Interface Supports Only Desktop Systems)
|
|
2985
|
-
|
|
2986
|
-
## addIncludedShareWindow
|
|
2987
|
-
|
|
2988
|
-
|
|
2989
|
-
|
|
2990
|
-
#### Add the Specified Window to the Contains List of Screen Sharing (This Interface Supports Only Desktop Systems)
|
|
2991
|
-
|
|
2992
|
-
This interface only takes effect when the type in [TRTCScreenCaptureSourceInfo](https://write.woa.com/document/87030132707430400) is specified as [TRTCScreenCaptureSourceTypeWindow](https://write.woa.com/document/87030132707430400). This means that the feature of including an additional specified window is only effective when sharing window content.
|
|
2993
|
-
|
|
2994
|
-
You can call it both before and after [startScreenCapture](https://write.woa.com/document/87030026264555520).
|
|
2995
|
-
<table>
|
|
2996
|
-
<tr>
|
|
2997
|
-
<td rowspan="1" colSpan="1" >Parameters</td>
|
|
1329
|
+
#### Remove All Windows from the Exclusion List of Screen Sharing (This Interface Supports Only Desktop Systems)
|
|
2998
1330
|
|
|
2999
|
-
|
|
3000
|
-
</tr>
|
|
1331
|
+
## addIncludedShareWindow
|
|
3001
1332
|
|
|
3002
|
-
|
|
3003
|
-
<td rowspan="1" colSpan="1" >windowID</td>
|
|
1333
|
+
#### Add the Specified Window to the Contains List of Screen Sharing (This Interface Supports Only Desktop Systems)
|
|
3004
1334
|
|
|
3005
|
-
|
|
3006
|
-
</tr>
|
|
3007
|
-
</table>
|
|
1335
|
+
This interface only takes effect when the type in TRTCScreenCaptureSourceInfo is specified as TRTCScreenCaptureSourceTypeWindow. This means that the feature of including an additional specified window is only effective when sharing window content.
|
|
3008
1336
|
|
|
1337
|
+
You can call it both before and after startScreenCapture.
|
|
1338
|
+
| Parameters | Description |
|
|
1339
|
+
| --- | --- |
|
|
1340
|
+
| windowID | Windows desired to be shared (Window Handle: HWND on Windows platform) |
|
|
3009
1341
|
|
|
3010
1342
|
> **Note**
|
|
3011
|
-
>
|
|
1343
|
+
>
|
|
3012
1344
|
|
|
3013
1345
|
> Windows added to the inclusion list through this method will be automatically cleared by the SDK upon exiting the room.
|
|
3014
|
-
>
|
|
3015
|
-
|
|
1346
|
+
>
|
|
3016
1347
|
|
|
3017
1348
|
## removeIncludedShareWindow
|
|
3018
1349
|
|
|
3019
|
-
|
|
3020
|
-
|
|
3021
1350
|
#### Remove the Specified Window from the Contains List of Screen Sharing (This Interface Supports Only Desktop Systems)
|
|
3022
1351
|
|
|
3023
|
-
This interface only takes effect when the type in
|
|
1352
|
+
This interface only takes effect when the type in TRTCScreenCaptureSourceInfo is specified as TRTCScreenCaptureSourceTypeWindow.
|
|
3024
1353
|
|
|
3025
1354
|
This means that the feature of including an additional specified window is only effective when sharing window content.
|
|
3026
|
-
|
|
3027
|
-
|
|
3028
|
-
|
|
3029
|
-
|
|
3030
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3031
|
-
</tr>
|
|
3032
|
-
|
|
3033
|
-
<tr>
|
|
3034
|
-
<td rowspan="1" colSpan="1" >windowID</td>
|
|
3035
|
-
|
|
3036
|
-
<td rowspan="1" colSpan="1" >Windows desired to be shared (Window ID on Mac platform; HWND on Windows platform)</td>
|
|
3037
|
-
</tr>
|
|
3038
|
-
</table>
|
|
3039
|
-
|
|
1355
|
+
| Parameters | Description |
|
|
1356
|
+
| --- | --- |
|
|
1357
|
+
| windowID | Windows desired to be shared (Window ID on Mac platform; HWND on Windows platform) |
|
|
3040
1358
|
|
|
3041
1359
|
## removeAllIncludedShareWindow
|
|
3042
1360
|
|
|
3043
|
-
|
|
3044
|
-
|
|
3045
1361
|
#### Remove All Windows from the Contains List of Screen Sharing (This Interface Supports Only Desktop Systems)
|
|
3046
1362
|
|
|
3047
|
-
This interface only takes effect when the type in
|
|
1363
|
+
This interface only takes effect when the type in TRTCScreenCaptureSourceInfo is specified as TRTCScreenCaptureSourceTypeWindow.
|
|
3048
1364
|
|
|
3049
1365
|
This means that the feature of including an additional specified window is only effective when sharing window content.
|
|
3050
1366
|
|
|
3051
1367
|
## enableCustomVideoCapture
|
|
3052
1368
|
|
|
3053
|
-
|
|
3054
|
-
|
|
3055
1369
|
#### Enable/Disable Custom Video Capturing Mode
|
|
3056
1370
|
|
|
3057
1371
|
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.
|
|
3058
1372
|
|
|
3059
|
-
You need to continuously send self-collected video frames to the SDK via
|
|
3060
|
-
|
|
3061
|
-
|
|
3062
|
-
|
|
3063
|
-
|
|
3064
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3065
|
-
</tr>
|
|
3066
|
-
|
|
3067
|
-
<tr>
|
|
3068
|
-
<td rowspan="1" colSpan="1" >enable</td>
|
|
3069
|
-
|
|
3070
|
-
<td rowspan="1" colSpan="1" >Whether to enable, default value: false.</td>
|
|
3071
|
-
</tr>
|
|
3072
|
-
|
|
3073
|
-
<tr>
|
|
3074
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
3075
|
-
|
|
3076
|
-
<td rowspan="1" colSpan="1" >Used to specify the video stream type, [TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400): High-definition main stream; [TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400): Auxiliary stream.</td>
|
|
3077
|
-
</tr>
|
|
3078
|
-
</table>
|
|
3079
|
-
|
|
1373
|
+
You need to continuously send self-collected video frames to the SDK via sendCustomVideoData.
|
|
1374
|
+
| Parameters | Description |
|
|
1375
|
+
| --- | --- |
|
|
1376
|
+
| enable | Whether to enable, default value: false. |
|
|
1377
|
+
| streamType | Used to specify the video stream type, TRTCVideoStreamTypeBig: High-definition main stream; TRTCVideoStreamTypeSub: Auxiliary stream. |
|
|
3080
1378
|
|
|
3081
1379
|
## sendCustomVideoData
|
|
3082
1380
|
|
|
3083
|
-
|
|
3084
|
-
|
|
3085
1381
|
#### Submit Self-collected Video Frames to the SDK
|
|
3086
1382
|
|
|
3087
1383
|
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.
|
|
3088
1384
|
|
|
1385
|
+
Parameter TRTCVideoFrame is recommended to be filled as follows (other fields do not need to be filled):
|
|
1386
|
+
- pixelFormat: Windows and Android platforms only support TRTCVideoPixelFormat_I420; iOS and Mac platforms support TRTCVideoPixelFormat_I420 and TRTCVideoPixelFormat_BGRA32.
|
|
3089
1387
|
|
|
3090
|
-
|
|
3091
|
-
Parameter [TRTCVideoFrame](https://write.woa.com/document/87030132707430400) is recommended to be filled as follows (other fields do not need to be filled):
|
|
3092
|
-
- pixelFormat: Windows and Android platforms only support [TRTCVideoPixelFormat_I420](https://write.woa.com/document/87030132707430400); iOS and Mac platforms support [TRTCVideoPixelFormat_I420](https://write.woa.com/document/87030132707430400) and [TRTCVideoPixelFormat_BGRA32](https://write.woa.com/document/87030132707430400).
|
|
3093
|
-
|
|
3094
|
-
- bufferType: Recommended choice is [TRTCVideoBufferType_Buffer](https://write.woa.com/document/87030132707430400).
|
|
1388
|
+
- bufferType: Recommended choice is TRTCVideoBufferType_Buffer.
|
|
3095
1389
|
|
|
3096
1390
|
- data: Buffer used to carry video frame data.
|
|
3097
1391
|
|
|
@@ -3101,90 +1395,54 @@ Parameter [TRTCVideoFrame](https://write.woa.com/document/87030132707430400) is
|
|
|
3101
1395
|
|
|
3102
1396
|
- height: Video image height, such as 480 px.
|
|
3103
1397
|
|
|
3104
|
-
- timestamp: Timestamp, in milliseconds (ms). Please use the timestamp recorded when the video frame is captured (you can get the timestamp by calling
|
|
3105
|
-
|
|
3106
|
-
|
|
3107
|
-
|
|
1398
|
+
- timestamp: Timestamp, in milliseconds (ms). Please use the timestamp recorded when the video frame is captured (you can get the timestamp by calling generateCustomPTS after capturing a video frame).
|
|
3108
1399
|
|
|
3109
1400
|
Refer to documentation: [Custom Collection and Rendering](https://cloud.tencent.com/document/product/647/34066).
|
|
3110
|
-
|
|
3111
|
-
|
|
3112
|
-
|
|
3113
|
-
|
|
3114
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3115
|
-
</tr>
|
|
3116
|
-
|
|
3117
|
-
<tr>
|
|
3118
|
-
<td rowspan="1" colSpan="1" >frame</td>
|
|
3119
|
-
|
|
3120
|
-
<td rowspan="1" colSpan="1" >Video data, supports I420 format data.</td>
|
|
3121
|
-
</tr>
|
|
3122
|
-
|
|
3123
|
-
<tr>
|
|
3124
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
3125
|
-
|
|
3126
|
-
<td rowspan="1" colSpan="1" >Used to specify the video stream type,[TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400): HD large screen;[TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400): Auxiliary stream.</td>
|
|
3127
|
-
</tr>
|
|
3128
|
-
</table>
|
|
3129
|
-
|
|
1401
|
+
| Parameters | Description |
|
|
1402
|
+
| --- | --- |
|
|
1403
|
+
| frame | Video data, supports I420 format data. |
|
|
1404
|
+
| streamType | Used to specify the video stream type,TRTCVideoStreamTypeBig: HD large screen;TRTCVideoStreamTypeSub: Auxiliary stream. |
|
|
3130
1405
|
|
|
3131
1406
|
> **Note**
|
|
3132
|
-
>
|
|
1407
|
+
>
|
|
3133
1408
|
|
|
3134
|
-
> 1. It is recommended to call the
|
|
3135
|
-
>
|
|
1409
|
+
> 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.
|
|
1410
|
+
>
|
|
3136
1411
|
|
|
3137
|
-
> 2. The final frame rate of the encoded video by the SDK is determined by the FPS you set in
|
|
3138
|
-
>
|
|
1412
|
+
> 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.
|
|
1413
|
+
>
|
|
3139
1414
|
|
|
3140
1415
|
> 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.
|
|
3141
|
-
>
|
|
3142
|
-
|
|
3143
|
-
> 4. iOS and Mac platforms currently support video frames in [TRTCVideoPixelFormat_I420](https://write.woa.com/document/87030132707430400) or [TRTCVideoPixelFormat_BGRA32](https://write.woa.com/document/87030132707430400) format.
|
|
3144
|
-
>
|
|
1416
|
+
>
|
|
3145
1417
|
|
|
3146
|
-
>
|
|
3147
|
-
>
|
|
1418
|
+
> 4. iOS and Mac platforms currently support video frames in TRTCVideoPixelFormat_I420 or TRTCVideoPixelFormat_BGRA32 format.
|
|
1419
|
+
>
|
|
3148
1420
|
|
|
1421
|
+
> 5. Windows and Android platforms currently support video frames in TRTCVideoPixelFormat_I420 format only.
|
|
1422
|
+
>
|
|
3149
1423
|
|
|
3150
1424
|
## enableCustomAudioCapture
|
|
3151
1425
|
|
|
3152
|
-
|
|
3153
|
-
|
|
3154
1426
|
#### Enable Custom Audio Capturing Mode
|
|
3155
1427
|
|
|
3156
1428
|
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.
|
|
3157
1429
|
|
|
3158
|
-
You need to continuously feed the SDK with your own collected audio data through
|
|
3159
|
-
|
|
3160
|
-
|
|
3161
|
-
|
|
3162
|
-
|
|
3163
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3164
|
-
</tr>
|
|
3165
|
-
|
|
3166
|
-
<tr>
|
|
3167
|
-
<td rowspan="1" colSpan="1" >enable</td>
|
|
3168
|
-
|
|
3169
|
-
<td rowspan="1" colSpan="1" >Whether to enable, default value: false.</td>
|
|
3170
|
-
</tr>
|
|
3171
|
-
</table>
|
|
3172
|
-
|
|
1430
|
+
You need to continuously feed the SDK with your own collected audio data through sendCustomAudioData.
|
|
1431
|
+
| Parameters | Description |
|
|
1432
|
+
| --- | --- |
|
|
1433
|
+
| enable | Whether to enable, default value: false. |
|
|
3173
1434
|
|
|
3174
1435
|
> **Note**
|
|
3175
|
-
>
|
|
1436
|
+
>
|
|
3176
1437
|
|
|
3177
1438
|
> 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.
|
|
3178
|
-
>
|
|
3179
|
-
|
|
1439
|
+
>
|
|
3180
1440
|
|
|
3181
1441
|
## sendCustomAudioData
|
|
3182
1442
|
|
|
3183
|
-
|
|
3184
|
-
|
|
3185
1443
|
#### Submit Self-collected Audio Data to the SDK
|
|
3186
1444
|
|
|
3187
|
-
Parameter
|
|
1445
|
+
Parameter TRTCAudioFrame is recommended to be filled as follows (other fields do not need to be filled):
|
|
3188
1446
|
- audioFormat: Audio data format, only supports TRTCAudioFrameFormatPCM.
|
|
3189
1447
|
|
|
3190
1448
|
- 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].
|
|
@@ -3193,76 +1451,40 @@ Parameter [TRTCAudioFrame](https://write.woa.com/document/87030132707430400) is
|
|
|
3193
1451
|
|
|
3194
1452
|
- channel: Number of channels (if stereo, data is interleaved), mono: 1; stereo: 2.
|
|
3195
1453
|
|
|
3196
|
-
- timestamp: Timestamp, in milliseconds (ms). Please use the timestamp recorded when the audio frame is captured (you can get the timestamp by calling
|
|
3197
|
-
|
|
3198
|
-
|
|
3199
|
-
|
|
1454
|
+
- 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).
|
|
3200
1455
|
|
|
3201
1456
|
Refer to documentation: [Custom Collection and Rendering](https://cloud.tencent.com/document/product/647/74692).
|
|
3202
|
-
|
|
3203
|
-
|
|
3204
|
-
|
|
3205
|
-
|
|
3206
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3207
|
-
</tr>
|
|
3208
|
-
|
|
3209
|
-
<tr>
|
|
3210
|
-
<td rowspan="1" colSpan="1" >frame</td>
|
|
3211
|
-
|
|
3212
|
-
<td rowspan="1" colSpan="1" >Audio Data</td>
|
|
3213
|
-
</tr>
|
|
3214
|
-
</table>
|
|
3215
|
-
|
|
1457
|
+
| Parameters | Description |
|
|
1458
|
+
| --- | --- |
|
|
1459
|
+
| frame | Audio Data |
|
|
3216
1460
|
|
|
3217
1461
|
> **Note**
|
|
3218
|
-
>
|
|
1462
|
+
>
|
|
3219
1463
|
|
|
3220
1464
|
> 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.
|
|
3221
|
-
>
|
|
3222
|
-
|
|
1465
|
+
>
|
|
3223
1466
|
|
|
3224
1467
|
## enableMixExternalAudioFrame
|
|
3225
1468
|
|
|
3226
|
-
|
|
3227
|
-
|
|
3228
1469
|
#### Enable/Disable Custom Audio Track
|
|
3229
1470
|
|
|
3230
1471
|
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.
|
|
3231
|
-
|
|
3232
|
-
|
|
3233
|
-
|
|
3234
|
-
|
|
3235
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3236
|
-
</tr>
|
|
3237
|
-
|
|
3238
|
-
<tr>
|
|
3239
|
-
<td rowspan="1" colSpan="1" >enablePlayout</td>
|
|
3240
|
-
|
|
3241
|
-
<td rowspan="1" colSpan="1" >Control whether the mixed audio track should be played locally. Default value: false.</td>
|
|
3242
|
-
</tr>
|
|
3243
|
-
|
|
3244
|
-
<tr>
|
|
3245
|
-
<td rowspan="1" colSpan="1" >enablePublish</td>
|
|
3246
|
-
|
|
3247
|
-
<td rowspan="1" colSpan="1" >Control whether the mixed audio track should be played remotely. Default value: false.</td>
|
|
3248
|
-
</tr>
|
|
3249
|
-
</table>
|
|
3250
|
-
|
|
1472
|
+
| Parameters | Description |
|
|
1473
|
+
| --- | --- |
|
|
1474
|
+
| enablePlayout | Control whether the mixed audio track should be played locally. Default value: false. |
|
|
1475
|
+
| enablePublish | Control whether the mixed audio track should be played remotely. Default value: false. |
|
|
3251
1476
|
|
|
3252
1477
|
> **Note**
|
|
3253
|
-
>
|
|
1478
|
+
>
|
|
3254
1479
|
|
|
3255
1480
|
> If you set both enablePublish and enablePlayout parameters to false, it means you completely disable your custom audio track.
|
|
3256
|
-
>
|
|
3257
|
-
|
|
1481
|
+
>
|
|
3258
1482
|
|
|
3259
1483
|
## mixExternalAudioFrame
|
|
3260
1484
|
|
|
3261
|
-
|
|
3262
|
-
|
|
3263
1485
|
#### Mix Custom Audio Track into the SDK
|
|
3264
1486
|
|
|
3265
|
-
Before calling this interface, you need to enable the Custom Audio Track with
|
|
1487
|
+
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.
|
|
3266
1488
|
|
|
3267
1489
|
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.
|
|
3268
1490
|
|
|
@@ -3272,38 +1494,24 @@ The return value of this interface represents the size of this track buffer zone
|
|
|
3272
1494
|
|
|
3273
1495
|
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".
|
|
3274
1496
|
|
|
3275
|
-
|
|
3276
|
-
|
|
3277
|
-
Parameter [TRTCAudioFrame](https://write.woa.com/document/87030132707430400) is recommended to be filled as follows (other fields do not need to be filled):
|
|
1497
|
+
Parameter TRTCAudioFrame is recommended to be filled as follows (other fields do not need to be filled):
|
|
3278
1498
|
- 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].
|
|
3279
1499
|
|
|
3280
1500
|
- sampleRate: Sampling rate, supported values are 16000, 24000, 32000, 44100, 48000.
|
|
3281
1501
|
|
|
3282
1502
|
- channel: Number of channels (if stereo, data is interleaved), mono: 1; stereo: 2.
|
|
3283
1503
|
|
|
3284
|
-
- timestamp: Timestamp, in milliseconds (ms). Please use the timestamp recorded when the audio frame is captured (you can get the timestamp by calling
|
|
3285
|
-
|
|
3286
|
-
<table>
|
|
3287
|
-
<tr>
|
|
3288
|
-
<td rowspan="1" colSpan="1" >Parameters</td>
|
|
3289
|
-
|
|
3290
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3291
|
-
</tr>
|
|
3292
|
-
|
|
3293
|
-
<tr>
|
|
3294
|
-
<td rowspan="1" colSpan="1" >frame</td>
|
|
3295
|
-
|
|
3296
|
-
<td rowspan="1" colSpan="1" >Audio Data</td>
|
|
3297
|
-
</tr>
|
|
3298
|
-
</table>
|
|
1504
|
+
- 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).
|
|
3299
1505
|
|
|
1506
|
+
| Parameters | Description |
|
|
1507
|
+
| --- | --- |
|
|
1508
|
+
| frame | Audio Data |
|
|
3300
1509
|
|
|
3301
1510
|
> **Note**
|
|
3302
|
-
>
|
|
1511
|
+
>
|
|
3303
1512
|
|
|
3304
1513
|
> 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.
|
|
3305
|
-
>
|
|
3306
|
-
|
|
1514
|
+
>
|
|
3307
1515
|
|
|
3308
1516
|
#### Return value description:
|
|
3309
1517
|
|
|
@@ -3311,47 +1519,25 @@ Parameter [TRTCAudioFrame](https://write.woa.com/document/87030132707430400) is
|
|
|
3311
1519
|
|
|
3312
1520
|
## setMixExternalAudioVolume
|
|
3313
1521
|
|
|
3314
|
-
|
|
3315
|
-
|
|
3316
1522
|
#### Set the Streaming Volume and Playback Volume for External Audio Mixed During Streaming
|
|
3317
|
-
|
|
3318
|
-
|
|
3319
|
-
|
|
3320
|
-
|
|
3321
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3322
|
-
</tr>
|
|
3323
|
-
|
|
3324
|
-
<tr>
|
|
3325
|
-
<td rowspan="1" colSpan="1" >playoutVolume</td>
|
|
3326
|
-
|
|
3327
|
-
<td rowspan="1" colSpan="1" >Set the playback volume level, ranging from 0 to 100. -1 means no change.</td>
|
|
3328
|
-
</tr>
|
|
3329
|
-
|
|
3330
|
-
<tr>
|
|
3331
|
-
<td rowspan="1" colSpan="1" >publishVolume</td>
|
|
3332
|
-
|
|
3333
|
-
<td rowspan="1" colSpan="1" >Set the streaming volume level, ranging from 0 to 100. -1 means no change.</td>
|
|
3334
|
-
</tr>
|
|
3335
|
-
</table>
|
|
3336
|
-
|
|
1523
|
+
| Parameters | Description |
|
|
1524
|
+
| --- | --- |
|
|
1525
|
+
| playoutVolume | Set the playback volume level, ranging from 0 to 100. -1 means no change. |
|
|
1526
|
+
| publishVolume | Set the streaming volume level, ranging from 0 to 100. -1 means no change. |
|
|
3337
1527
|
|
|
3338
1528
|
## generateCustomPTS
|
|
3339
1529
|
|
|
3340
|
-
|
|
3341
|
-
|
|
3342
1530
|
#### Generate Timestamp for Custom Capturing
|
|
3343
1531
|
|
|
3344
1532
|
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.
|
|
3345
1533
|
|
|
3346
|
-
|
|
3347
|
-
|
|
3348
|
-
When you use interfaces such as [sendCustomVideoData](https://write.woa.com/document/87030026264555520) or [sendCustomAudioData](https://write.woa.com/document/87030026264555520) for custom video or audio capturing, please follow these steps to use this interface:
|
|
1534
|
+
When you use interfaces such as sendCustomVideoData or sendCustomAudioData for custom video or audio capturing, please follow these steps to use this interface:
|
|
3349
1535
|
|
|
3350
1536
|
1. First, when capturing a video or audio frame, call this interface to obtain the PTS timestamp of that moment.
|
|
3351
1537
|
|
|
3352
1538
|
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).
|
|
3353
1539
|
|
|
3354
|
-
3. When actually calling
|
|
1540
|
+
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.
|
|
3355
1541
|
|
|
3356
1542
|
#### Return value description:
|
|
3357
1543
|
|
|
@@ -3359,37 +1545,14 @@ Timestamp (unit: ms)
|
|
|
3359
1545
|
|
|
3360
1546
|
## enableLocalVideoCustomProcess
|
|
3361
1547
|
|
|
3362
|
-
|
|
3363
|
-
|
|
3364
1548
|
#### .1 Enable third-party beauty filter for video
|
|
3365
1549
|
|
|
3366
|
-
Once enabled, you can use
|
|
3367
|
-
|
|
3368
|
-
|
|
3369
|
-
|
|
3370
|
-
|
|
3371
|
-
|
|
3372
|
-
</tr>
|
|
3373
|
-
|
|
3374
|
-
<tr>
|
|
3375
|
-
<td rowspan="1" colSpan="1" >bufferType</td>
|
|
3376
|
-
|
|
3377
|
-
<td rowspan="1" colSpan="1" >Specifying video data structure type.</td>
|
|
3378
|
-
</tr>
|
|
3379
|
-
|
|
3380
|
-
<tr>
|
|
3381
|
-
<td rowspan="1" colSpan="1" >enable</td>
|
|
3382
|
-
|
|
3383
|
-
<td rowspan="1" colSpan="1" >Enable third-party video beautification, disabled by default.</td>
|
|
3384
|
-
</tr>
|
|
3385
|
-
|
|
3386
|
-
<tr>
|
|
3387
|
-
<td rowspan="1" colSpan="1" >pixelFormat</td>
|
|
3388
|
-
|
|
3389
|
-
<td rowspan="1" colSpan="1" >Specify the pixel format for the callback.</td>
|
|
3390
|
-
</tr>
|
|
3391
|
-
</table>
|
|
3392
|
-
|
|
1550
|
+
Once enabled, you can use ITRTCVideoFrameCallback to obtain image frames of specified pixel format and video data structure type.
|
|
1551
|
+
| Parameters | Description |
|
|
1552
|
+
| --- | --- |
|
|
1553
|
+
| bufferType | Specifying video data structure type. |
|
|
1554
|
+
| enable | Enable third-party video beautification, disabled by default. |
|
|
1555
|
+
| pixelFormat | Specify the pixel format for the callback. |
|
|
3393
1556
|
|
|
3394
1557
|
#### Return value description:
|
|
3395
1558
|
|
|
@@ -3397,65 +1560,29 @@ Once enabled, you can use [ITRTCVideoFrameCallback](https://write.woa.com/docume
|
|
|
3397
1560
|
|
|
3398
1561
|
## setLocalVideoCustomProcessCallback
|
|
3399
1562
|
|
|
3400
|
-
|
|
3401
|
-
|
|
3402
1563
|
#### .2 Set video data callback for third-party beauty filter
|
|
3403
1564
|
|
|
3404
1565
|
After setting this callback, the SDK will output the collected video frames through the callback you set for secondary processing by third-party beauty filter components. The SDK will then encode and send the processed video frames.
|
|
3405
|
-
|
|
3406
|
-
|
|
3407
|
-
|
|
3408
|
-
|
|
3409
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3410
|
-
</tr>
|
|
3411
|
-
|
|
3412
|
-
<tr>
|
|
3413
|
-
<td rowspan="1" colSpan="1" >callback</td>
|
|
3414
|
-
|
|
3415
|
-
<td rowspan="1" colSpan="1" >Custom beauty filter callback. See [ITRTCVideoFrameCallback](https://write.woa.com/document/87030021158866944).</td>
|
|
3416
|
-
</tr>
|
|
3417
|
-
</table>
|
|
3418
|
-
|
|
1566
|
+
| Parameters | Description |
|
|
1567
|
+
| --- | --- |
|
|
1568
|
+
| callback | Custom beauty filter callback. See ITRTCVideoFrameCallback. |
|
|
3419
1569
|
|
|
3420
1570
|
## setLocalVideoRenderCallback
|
|
3421
1571
|
|
|
3422
|
-
|
|
3423
|
-
|
|
3424
1572
|
#### Set Local Video Custom Rendering Callback
|
|
3425
1573
|
|
|
3426
1574
|
After setting this callback, the SDK will skip the original rendering process and return the captured data. You need to handle the rendering yourself.
|
|
3427
1575
|
- You can stop the callback by calling setLocalVideoRenderCallback(TRTCVideoPixelFormat_Unknown, TRTCVideoBufferType_Unknown, nullptr).
|
|
3428
1576
|
|
|
3429
|
-
- iOS, Mac, and Windows platforms currently support video frames in
|
|
3430
|
-
|
|
3431
|
-
- Android platform currently supports video frames in [TRTCVideoPixelFormat_I420](https://write.woa.com/document/87030132707430400), [TRTCVideoPixelFormat_RGBA32](https://write.woa.com/document/87030132707430400), or [TRTCVideoPixelFormat_Texture_2D](https://write.woa.com/document/87030132707430400) pixel formats.
|
|
3432
|
-
|
|
3433
|
-
<table>
|
|
3434
|
-
<tr>
|
|
3435
|
-
<td rowspan="1" colSpan="1" >Parameters</td>
|
|
3436
|
-
|
|
3437
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3438
|
-
</tr>
|
|
1577
|
+
- iOS, Mac, and Windows platforms currently support video frames in TRTCVideoPixelFormat_I420 or TRTCVideoPixelFormat_BGRA32 pixel formats.
|
|
3439
1578
|
|
|
3440
|
-
|
|
3441
|
-
<td rowspan="1" colSpan="1" >bufferType</td>
|
|
3442
|
-
|
|
3443
|
-
<td rowspan="1" colSpan="1" >Specifying video data structure type</td>
|
|
3444
|
-
</tr>
|
|
3445
|
-
|
|
3446
|
-
<tr>
|
|
3447
|
-
<td rowspan="1" colSpan="1" >callback</td>
|
|
3448
|
-
|
|
3449
|
-
<td rowspan="1" colSpan="1" >Set Definition Rendering Callback</td>
|
|
3450
|
-
</tr>
|
|
3451
|
-
|
|
3452
|
-
<tr>
|
|
3453
|
-
<td rowspan="1" colSpan="1" >pixelFormat</td>
|
|
3454
|
-
|
|
3455
|
-
<td rowspan="1" colSpan="1" >Specify the pixel format for callback</td>
|
|
3456
|
-
</tr>
|
|
3457
|
-
</table>
|
|
1579
|
+
- Android platform currently supports video frames in TRTCVideoPixelFormat_I420, TRTCVideoPixelFormat_RGBA32, or TRTCVideoPixelFormat_Texture_2D pixel formats.
|
|
3458
1580
|
|
|
1581
|
+
| Parameters | Description |
|
|
1582
|
+
| --- | --- |
|
|
1583
|
+
| bufferType | Specifying video data structure type |
|
|
1584
|
+
| callback | Set Definition Rendering Callback |
|
|
1585
|
+
| pixelFormat | Specify the pixel format for callback |
|
|
3459
1586
|
|
|
3460
1587
|
#### Return value description:
|
|
3461
1588
|
|
|
@@ -3463,56 +1590,27 @@ After setting this callback, the SDK will skip the original rendering process an
|
|
|
3463
1590
|
|
|
3464
1591
|
## setRemoteVideoRenderCallback
|
|
3465
1592
|
|
|
3466
|
-
|
|
3467
|
-
|
|
3468
1593
|
#### Sets the rendering callback for remote video self-definition
|
|
3469
1594
|
|
|
3470
1595
|
After setting this callback, the SDK will skip the original rendering process and return the captured data. You need to handle the rendering yourself.
|
|
3471
1596
|
- You can stop the callback by calling setRemoteVideoRenderCallback(TRTCVideoPixelFormat_Unknown, TRTCVideoBufferType_Unknown, nullptr).
|
|
3472
1597
|
|
|
3473
|
-
- iOS, Mac, and Windows platforms currently support video frames in
|
|
3474
|
-
|
|
3475
|
-
- Android platform currently supports video frames in [TRTCVideoPixelFormat_I420](https://write.woa.com/document/87030132707430400), [TRTCVideoPixelFormat_RGBA32](https://write.woa.com/document/87030132707430400), or [TRTCVideoPixelFormat_Texture_2D](https://write.woa.com/document/87030132707430400) pixel formats.
|
|
1598
|
+
- iOS, Mac, and Windows platforms currently support video frames in TRTCVideoPixelFormat_I420 or TRTCVideoPixelFormat_BGRA32 pixel formats.
|
|
3476
1599
|
|
|
3477
|
-
|
|
3478
|
-
<tr>
|
|
3479
|
-
<td rowspan="1" colSpan="1" >Parameters</td>
|
|
3480
|
-
|
|
3481
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3482
|
-
</tr>
|
|
3483
|
-
|
|
3484
|
-
<tr>
|
|
3485
|
-
<td rowspan="1" colSpan="1" >bufferType</td>
|
|
3486
|
-
|
|
3487
|
-
<td rowspan="1" colSpan="1" >Specifying video data structure type, currently only supports [TRTCVideoBufferType_Buffer](https://write.woa.com/document/87030132707430400)</td>
|
|
3488
|
-
</tr>
|
|
3489
|
-
|
|
3490
|
-
<tr>
|
|
3491
|
-
<td rowspan="1" colSpan="1" >callback</td>
|
|
3492
|
-
|
|
3493
|
-
<td rowspan="1" colSpan="1" >Set Definition Rendering Callback</td>
|
|
3494
|
-
</tr>
|
|
3495
|
-
|
|
3496
|
-
<tr>
|
|
3497
|
-
<td rowspan="1" colSpan="1" >pixelFormat</td>
|
|
3498
|
-
|
|
3499
|
-
<td rowspan="1" colSpan="1" >Specify the pixel format for callback</td>
|
|
3500
|
-
</tr>
|
|
3501
|
-
|
|
3502
|
-
<tr>
|
|
3503
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
3504
|
-
|
|
3505
|
-
<td rowspan="1" colSpan="1" >Remote user ID</td>
|
|
3506
|
-
</tr>
|
|
3507
|
-
</table>
|
|
1600
|
+
- Android platform currently supports video frames in TRTCVideoPixelFormat_I420, TRTCVideoPixelFormat_RGBA32, or TRTCVideoPixelFormat_Texture_2D pixel formats.
|
|
3508
1601
|
|
|
1602
|
+
| Parameters | Description |
|
|
1603
|
+
| --- | --- |
|
|
1604
|
+
| bufferType | Specifying video data structure type, currently only supports TRTCVideoBufferType_Buffer |
|
|
1605
|
+
| callback | Set Definition Rendering Callback |
|
|
1606
|
+
| pixelFormat | Specify the pixel format for callback |
|
|
1607
|
+
| userId | Remote user ID |
|
|
3509
1608
|
|
|
3510
1609
|
> **Note**
|
|
3511
|
-
>
|
|
1610
|
+
>
|
|
3512
1611
|
|
|
3513
1612
|
> In actual use, you need to call startRemoteView(userid, nullptr) to get the remote user's video stream (set view to nullptr), otherwise, no data will be called back.
|
|
3514
|
-
>
|
|
3515
|
-
|
|
1613
|
+
>
|
|
3516
1614
|
|
|
3517
1615
|
#### Return value description:
|
|
3518
1616
|
|
|
@@ -3520,67 +1618,46 @@ After setting this callback, the SDK will skip the original rendering process an
|
|
|
3520
1618
|
|
|
3521
1619
|
## setAudioFrameCallback
|
|
3522
1620
|
|
|
3523
|
-
|
|
3524
|
-
|
|
3525
1621
|
#### Sets the audio data self-definition callback
|
|
3526
1622
|
|
|
3527
1623
|
After setting this callback, the SDK will internally callback the audio data (PCM format), including:
|
|
3528
|
-
-
|
|
1624
|
+
- onCapturedAudioFrame: Audio data callback captured by the local microphone
|
|
3529
1625
|
|
|
3530
|
-
-
|
|
1626
|
+
- onLocalProcessedAudioFrame: Audio data callback captured locally and preprocessed by the audio module
|
|
3531
1627
|
|
|
3532
|
-
-
|
|
3533
|
-
|
|
3534
|
-
- [onMixedPlayAudioFrame](https://write.woa.com/document/87030021158866944): Audio data callback after mixing various audio streams and finally to be played by the system
|
|
1628
|
+
- onPlayAudioFrame: Audio data of each remote user before mixing
|
|
3535
1629
|
|
|
1630
|
+
- onMixedPlayAudioFrame: Audio data callback after mixing various audio streams and finally to be played by the system
|
|
3536
1631
|
|
|
3537
1632
|
> **Note**
|
|
3538
|
-
>
|
|
1633
|
+
>
|
|
3539
1634
|
|
|
3540
1635
|
> 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.
|
|
3541
|
-
>
|
|
3542
|
-
|
|
1636
|
+
>
|
|
3543
1637
|
|
|
3544
1638
|
## setCapturedAudioFrameCallbackFormat
|
|
3545
1639
|
|
|
3546
|
-
|
|
3547
|
-
|
|
3548
1640
|
#### Sets the callback format for audio frames captured by the local microphone
|
|
3549
1641
|
|
|
3550
|
-
This interface is used to set the format of the AudioFrame callback for
|
|
1642
|
+
This interface is used to set the format of the AudioFrame callback for onCapturedAudioFrame:
|
|
3551
1643
|
- sampleRate: Sampling rate, supported values are 16000, 32000, 44100, 48000.
|
|
3552
1644
|
|
|
3553
1645
|
- channel: Number of channels (if stereo, data is interleaved), mono: 1; stereo: 2.
|
|
3554
1646
|
|
|
3555
1647
|
- samplesPerCall: Number of sampling points, Definition callback data frame length. The frame length must be an integer multiple of 10ms.
|
|
3556
1648
|
|
|
3557
|
-
|
|
3558
|
-
|
|
3559
|
-
|
|
3560
1649
|
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.
|
|
3561
1650
|
|
|
3562
1651
|
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.
|
|
3563
|
-
|
|
3564
|
-
|
|
3565
|
-
|
|
3566
|
-
|
|
3567
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3568
|
-
</tr>
|
|
3569
|
-
|
|
3570
|
-
<tr>
|
|
3571
|
-
<td rowspan="1" colSpan="1" >format</td>
|
|
3572
|
-
|
|
3573
|
-
<td rowspan="1" colSpan="1" >Audio Data Callback Format.</td>
|
|
3574
|
-
</tr>
|
|
3575
|
-
</table>
|
|
3576
|
-
|
|
1652
|
+
| Parameters | Description |
|
|
1653
|
+
| --- | --- |
|
|
1654
|
+
| format | Audio Data Callback Format. |
|
|
3577
1655
|
|
|
3578
1656
|
> **Note**
|
|
3579
|
-
>
|
|
1657
|
+
>
|
|
3580
1658
|
|
|
3581
1659
|
> 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
|
|
3582
|
-
>
|
|
3583
|
-
|
|
1660
|
+
>
|
|
3584
1661
|
|
|
3585
1662
|
#### Return value description:
|
|
3586
1663
|
|
|
@@ -3588,44 +1665,27 @@ Example: For a 48000 sampling rate and a desired callback frame length of 20ms,
|
|
|
3588
1665
|
|
|
3589
1666
|
## setLocalProcessedAudioFrameCallbackFormat
|
|
3590
1667
|
|
|
3591
|
-
|
|
3592
|
-
|
|
3593
1668
|
#### Sets the callback format for local audio frames after preprocessing
|
|
3594
1669
|
|
|
3595
|
-
This interface is used to set the format of the AudioFrame callback for
|
|
1670
|
+
This interface is used to set the format of the AudioFrame callback for onLocalProcessedAudioFrame:
|
|
3596
1671
|
- sampleRate: Sampling rate, supported values are 16000, 32000, 44100, 48000.
|
|
3597
1672
|
|
|
3598
1673
|
- channel: Number of channels (if stereo, data is interleaved), mono: 1; stereo: 2.
|
|
3599
1674
|
|
|
3600
1675
|
- samplesPerCall: Number of sampling points, Definition callback data frame length. The frame length must be an integer multiple of 10ms.
|
|
3601
1676
|
|
|
3602
|
-
|
|
3603
|
-
|
|
3604
|
-
|
|
3605
1677
|
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.
|
|
3606
1678
|
|
|
3607
1679
|
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.
|
|
3608
|
-
|
|
3609
|
-
|
|
3610
|
-
|
|
3611
|
-
|
|
3612
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3613
|
-
</tr>
|
|
3614
|
-
|
|
3615
|
-
<tr>
|
|
3616
|
-
<td rowspan="1" colSpan="1" >format</td>
|
|
3617
|
-
|
|
3618
|
-
<td rowspan="1" colSpan="1" >Audio Data Callback Format.</td>
|
|
3619
|
-
</tr>
|
|
3620
|
-
</table>
|
|
3621
|
-
|
|
1680
|
+
| Parameters | Description |
|
|
1681
|
+
| --- | --- |
|
|
1682
|
+
| format | Audio Data Callback Format. |
|
|
3622
1683
|
|
|
3623
1684
|
> **Note**
|
|
3624
|
-
>
|
|
1685
|
+
>
|
|
3625
1686
|
|
|
3626
1687
|
> 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
|
|
3627
|
-
>
|
|
3628
|
-
|
|
1688
|
+
>
|
|
3629
1689
|
|
|
3630
1690
|
#### Return value description:
|
|
3631
1691
|
|
|
@@ -3633,44 +1693,27 @@ Example: For a 48000 sampling rate and a desired callback frame length of 20ms,
|
|
|
3633
1693
|
|
|
3634
1694
|
## setMixedPlayAudioFrameCallbackFormat
|
|
3635
1695
|
|
|
3636
|
-
|
|
3637
|
-
|
|
3638
1696
|
#### Sets the callback format for audio frames that will eventually be played by the system
|
|
3639
1697
|
|
|
3640
|
-
This interface is used to set the format of the AudioFrame callback for
|
|
1698
|
+
This interface is used to set the format of the AudioFrame callback for onMixedPlayAudioFrame:
|
|
3641
1699
|
- sampleRate: Sampling rate, supported values are 16000, 32000, 44100, 48000.
|
|
3642
1700
|
|
|
3643
1701
|
- channel: Number of channels (if stereo, data is interleaved), mono: 1; stereo: 2.
|
|
3644
1702
|
|
|
3645
1703
|
- samplesPerCall: Number of sampling points, Definition callback data frame length. The frame length must be an integer multiple of 10ms.
|
|
3646
1704
|
|
|
3647
|
-
|
|
3648
|
-
|
|
3649
|
-
|
|
3650
1705
|
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.
|
|
3651
1706
|
|
|
3652
1707
|
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.
|
|
3653
|
-
|
|
3654
|
-
|
|
3655
|
-
|
|
3656
|
-
|
|
3657
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3658
|
-
</tr>
|
|
3659
|
-
|
|
3660
|
-
<tr>
|
|
3661
|
-
<td rowspan="1" colSpan="1" >format</td>
|
|
3662
|
-
|
|
3663
|
-
<td rowspan="1" colSpan="1" >Audio Data Callback Format.</td>
|
|
3664
|
-
</tr>
|
|
3665
|
-
</table>
|
|
3666
|
-
|
|
1708
|
+
| Parameters | Description |
|
|
1709
|
+
| --- | --- |
|
|
1710
|
+
| format | Audio Data Callback Format. |
|
|
3667
1711
|
|
|
3668
1712
|
> **Note**
|
|
3669
|
-
>
|
|
1713
|
+
>
|
|
3670
1714
|
|
|
3671
1715
|
> 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
|
|
3672
|
-
>
|
|
3673
|
-
|
|
1716
|
+
>
|
|
3674
1717
|
|
|
3675
1718
|
#### Return value description:
|
|
3676
1719
|
|
|
@@ -3678,147 +1721,85 @@ Example: For a 48000 sampling rate and a desired callback frame length of 20ms,
|
|
|
3678
1721
|
|
|
3679
1722
|
## enableCustomAudioRendering
|
|
3680
1723
|
|
|
3681
|
-
|
|
3682
|
-
|
|
3683
1724
|
#### Enable self-definition audio playback
|
|
3684
1725
|
|
|
3685
1726
|
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.
|
|
3686
1727
|
|
|
3687
|
-
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
|
|
3688
|
-
|
|
3689
|
-
|
|
3690
|
-
|
|
3691
|
-
|
|
3692
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3693
|
-
</tr>
|
|
3694
|
-
|
|
3695
|
-
<tr>
|
|
3696
|
-
<td rowspan="1" colSpan="1" >enable</td>
|
|
3697
|
-
|
|
3698
|
-
<td rowspan="1" colSpan="1" >Whether to enable Custom Playback is off by default.</td>
|
|
3699
|
-
</tr>
|
|
3700
|
-
</table>
|
|
3701
|
-
|
|
1728
|
+
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.
|
|
1729
|
+
| Parameters | Description |
|
|
1730
|
+
| --- | --- |
|
|
1731
|
+
| enable | Whether to enable Custom Playback is off by default. |
|
|
3702
1732
|
|
|
3703
1733
|
> **Note**
|
|
3704
|
-
>
|
|
1734
|
+
>
|
|
3705
1735
|
|
|
3706
1736
|
> 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.
|
|
3707
|
-
>
|
|
3708
|
-
|
|
1737
|
+
>
|
|
3709
1738
|
|
|
3710
1739
|
## getCustomAudioRenderingFrame
|
|
3711
1740
|
|
|
3712
|
-
|
|
3713
|
-
|
|
3714
1741
|
#### Get playable audio data
|
|
3715
1742
|
|
|
3716
|
-
Before calling this interface, you need to enable Custom Playback through
|
|
3717
|
-
|
|
1743
|
+
Before calling this interface, you need to enable Custom Playback through enableCustomAudioRendering first.
|
|
3718
1744
|
|
|
3719
|
-
|
|
3720
|
-
Parameter [TRTCAudioFrame](https://write.woa.com/document/87030132707430400) is recommended to be filled as follows (other fields do not need to be filled):
|
|
1745
|
+
Parameter TRTCAudioFrame is recommended to be filled as follows (other fields do not need to be filled):
|
|
3721
1746
|
- sampleRate: Sampling rate, required, supported values are 16000, 24000, 32000, 44100, 48000.
|
|
3722
1747
|
|
|
3723
1748
|
- channel: Number of channels, required. Fill in 1 for mono, 2 for stereo. The data is interleaved for stereo.
|
|
3724
1749
|
|
|
3725
1750
|
- 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.
|
|
3726
1751
|
|
|
3727
|
-
|
|
3728
|
-
|
|
3729
|
-
|
|
3730
1752
|
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.
|
|
3731
|
-
|
|
3732
|
-
|
|
3733
|
-
|
|
3734
|
-
|
|
3735
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3736
|
-
</tr>
|
|
3737
|
-
|
|
3738
|
-
<tr>
|
|
3739
|
-
<td rowspan="1" colSpan="1" >audioFrame</td>
|
|
3740
|
-
|
|
3741
|
-
<td rowspan="1" colSpan="1" >Audio data frame.</td>
|
|
3742
|
-
</tr>
|
|
3743
|
-
</table>
|
|
3744
|
-
|
|
1753
|
+
| Parameters | Description |
|
|
1754
|
+
| --- | --- |
|
|
1755
|
+
| audioFrame | Audio data frame. |
|
|
3745
1756
|
|
|
3746
1757
|
> **Note**
|
|
3747
|
-
>
|
|
1758
|
+
>
|
|
3748
1759
|
|
|
3749
1760
|
> 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.
|
|
3750
|
-
>
|
|
1761
|
+
>
|
|
3751
1762
|
|
|
3752
1763
|
> 2. The SDK will automatically fill the data according to sampleRate and channel.
|
|
3753
|
-
>
|
|
1764
|
+
>
|
|
3754
1765
|
|
|
3755
1766
|
> 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.
|
|
3756
|
-
>
|
|
3757
|
-
|
|
1767
|
+
>
|
|
3758
1768
|
|
|
3759
1769
|
## sendCustomCmdMsg
|
|
3760
1770
|
|
|
3761
|
-
|
|
3762
|
-
|
|
3763
1771
|
#### Sends a custom message using UDP channel to all users in a room
|
|
3764
1772
|
|
|
3765
1773
|
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.
|
|
3766
1774
|
|
|
3767
|
-
Other users in the room can receive messages through the onRecvCustomCmdMsg callback in
|
|
3768
|
-
|
|
3769
|
-
|
|
3770
|
-
|
|
3771
|
-
|
|
3772
|
-
|
|
3773
|
-
|
|
3774
|
-
|
|
3775
|
-
<tr>
|
|
3776
|
-
<td rowspan="1" colSpan="1" >cmdID</td>
|
|
3777
|
-
|
|
3778
|
-
<td rowspan="1" colSpan="1" >Message ID, the value range is 1 - 10.</td>
|
|
3779
|
-
</tr>
|
|
3780
|
-
|
|
3781
|
-
<tr>
|
|
3782
|
-
<td rowspan="1" colSpan="1" >data</td>
|
|
3783
|
-
|
|
3784
|
-
<td rowspan="1" colSpan="1" >Message to be sent, the maximum length of a single message is limited to 1KB.</td>
|
|
3785
|
-
</tr>
|
|
3786
|
-
|
|
3787
|
-
<tr>
|
|
3788
|
-
<td rowspan="1" colSpan="1" >ordered</td>
|
|
3789
|
-
|
|
3790
|
-
<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>
|
|
3791
|
-
</tr>
|
|
3792
|
-
|
|
3793
|
-
<tr>
|
|
3794
|
-
<td rowspan="1" colSpan="1" >reliable</td>
|
|
3795
|
-
|
|
3796
|
-
<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>
|
|
3797
|
-
</tr>
|
|
3798
|
-
</table>
|
|
3799
|
-
|
|
1775
|
+
Other users in the room can receive messages through the onRecvCustomCmdMsg callback in ITRTCCloudCallback.
|
|
1776
|
+
| Parameters | Description |
|
|
1777
|
+
| --- | --- |
|
|
1778
|
+
| cmdID | Message ID, the value range is 1 - 10. |
|
|
1779
|
+
| data | Message to be sent, the maximum length of a single message is limited to 1KB. |
|
|
1780
|
+
| 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). |
|
|
1781
|
+
| reliable | Whether reliable transmission is enabled. Reliable transmission offers a higher success rate but will cause higher reception delays compared to unreliable transmission. |
|
|
3800
1782
|
|
|
3801
1783
|
> **Note**
|
|
3802
|
-
>
|
|
1784
|
+
>
|
|
3803
1785
|
|
|
3804
1786
|
> 1. Sending messages to all users in the room (currently not supporting Web/Mini program end), up to 30 messages per second.
|
|
3805
|
-
>
|
|
1787
|
+
>
|
|
3806
1788
|
|
|
3807
1789
|
> 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.
|
|
3808
|
-
>
|
|
1790
|
+
>
|
|
3809
1791
|
|
|
3810
1792
|
> 3. Each client can send up to 8 KB of data per second.
|
|
3811
|
-
>
|
|
1793
|
+
>
|
|
3812
1794
|
|
|
3813
1795
|
> Please set both reliable and ordered to true or both to false. Interleaved settings are not supported.
|
|
3814
|
-
>
|
|
1796
|
+
>
|
|
3815
1797
|
|
|
3816
1798
|
> 5. It is strongly recommended to set different types of messages with different cmdIDs. This can reduce message latency when ordering is required.
|
|
3817
|
-
>
|
|
1799
|
+
>
|
|
3818
1800
|
|
|
3819
1801
|
> 6. Currently, only anchor roles are supported.
|
|
3820
|
-
>
|
|
3821
|
-
|
|
1802
|
+
>
|
|
3822
1803
|
|
|
3823
1804
|
#### Return value description:
|
|
3824
1805
|
|
|
@@ -3826,70 +1807,47 @@ true: Message has been sent; false: Message sending failed.
|
|
|
3826
1807
|
|
|
3827
1808
|
## sendSEIMsg
|
|
3828
1809
|
|
|
3829
|
-
|
|
3830
|
-
|
|
3831
1810
|
#### Sends a custom message using SEI channel to all users in a room
|
|
3832
1811
|
|
|
3833
1812
|
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.
|
|
3834
1813
|
|
|
3835
|
-
|
|
3836
|
-
|
|
3837
1814
|
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.
|
|
3838
1815
|
|
|
3839
|
-
Therefore, compared to
|
|
1816
|
+
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.
|
|
3840
1817
|
|
|
3841
1818
|
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.
|
|
3842
1819
|
|
|
3843
|
-
|
|
3844
|
-
|
|
3845
1820
|
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).
|
|
3846
1821
|
|
|
3847
|
-
Other users in the room can receive messages through the onRecvSEIMsg callback in
|
|
3848
|
-
|
|
3849
|
-
|
|
3850
|
-
|
|
3851
|
-
|
|
3852
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3853
|
-
</tr>
|
|
3854
|
-
|
|
3855
|
-
<tr>
|
|
3856
|
-
<td rowspan="1" colSpan="1" >data</td>
|
|
3857
|
-
|
|
3858
|
-
<td rowspan="1" colSpan="1" >Data to be sent, which can contain up to 1 KB (1,000 bytes) of data</td>
|
|
3859
|
-
</tr>
|
|
3860
|
-
|
|
3861
|
-
<tr>
|
|
3862
|
-
<td rowspan="1" colSpan="1" >repeatCount</td>
|
|
3863
|
-
|
|
3864
|
-
<td rowspan="1" colSpan="1" >Number of data sends</td>
|
|
3865
|
-
</tr>
|
|
3866
|
-
</table>
|
|
3867
|
-
|
|
1822
|
+
Other users in the room can receive messages through the onRecvSEIMsg callback in ITRTCCloudCallback.
|
|
1823
|
+
| Parameters | Description |
|
|
1824
|
+
| --- | --- |
|
|
1825
|
+
| data | Data to be sent, which can contain up to 1 KB (1,000 bytes) of data |
|
|
1826
|
+
| repeatCount | Number of data sends |
|
|
3868
1827
|
|
|
3869
1828
|
> **Note**
|
|
3870
|
-
>
|
|
1829
|
+
>
|
|
3871
1830
|
|
|
3872
1831
|
> This interface has the following limitations:
|
|
3873
|
-
>
|
|
1832
|
+
>
|
|
3874
1833
|
|
|
3875
1834
|
> 1. Data will not be sent immediately after the API invocation, but will be sent along with the next video frame.
|
|
3876
|
-
>
|
|
1835
|
+
>
|
|
3877
1836
|
|
|
3878
1837
|
> 2. Send messages to all users in the room, up to 30 messages per second (shared limit with sendCustomCmdMsg).
|
|
3879
|
-
>
|
|
1838
|
+
>
|
|
3880
1839
|
|
|
3881
1840
|
> 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).
|
|
3882
|
-
>
|
|
1841
|
+
>
|
|
3883
1842
|
|
|
3884
1843
|
> 4. Each client can send up to 8 KB of data per second (shared limit with sendCustomCmdMsg).
|
|
3885
|
-
>
|
|
1844
|
+
>
|
|
3886
1845
|
|
|
3887
1846
|
> 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.
|
|
3888
|
-
>
|
|
1847
|
+
>
|
|
3889
1848
|
|
|
3890
1849
|
> 6. If repeatCount > 1 and there are multiple sends, the onRecvSEIMsg callback may receive the same message multiple times, and deduplication is needed.
|
|
3891
|
-
>
|
|
3892
|
-
|
|
1850
|
+
>
|
|
3893
1851
|
|
|
3894
1852
|
#### Return value description:
|
|
3895
1853
|
|
|
@@ -3897,36 +1855,22 @@ true: Message has passed the restriction, waiting for subsequent video frame to
|
|
|
3897
1855
|
|
|
3898
1856
|
## startSpeedTest
|
|
3899
1857
|
|
|
3900
|
-
|
|
3901
|
-
|
|
3902
1858
|
#### Start internet speed test (use before entering the room)
|
|
3903
|
-
|
|
3904
|
-
|
|
3905
|
-
|
|
3906
|
-
|
|
3907
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3908
|
-
</tr>
|
|
3909
|
-
|
|
3910
|
-
<tr>
|
|
3911
|
-
<td rowspan="1" colSpan="1" >params</td>
|
|
3912
|
-
|
|
3913
|
-
<td rowspan="1" colSpan="1" >Speed Test Options</td>
|
|
3914
|
-
</tr>
|
|
3915
|
-
</table>
|
|
3916
|
-
|
|
1859
|
+
| Parameters | Description |
|
|
1860
|
+
| --- | --- |
|
|
1861
|
+
| params | Speed Test Options |
|
|
3917
1862
|
|
|
3918
1863
|
> **Note**
|
|
3919
|
-
>
|
|
1864
|
+
>
|
|
3920
1865
|
|
|
3921
1866
|
> 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.
|
|
3922
|
-
>
|
|
1867
|
+
>
|
|
3923
1868
|
|
|
3924
1869
|
> 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.
|
|
3925
|
-
>
|
|
1870
|
+
>
|
|
3926
1871
|
|
|
3927
1872
|
> 3. Only one internet speed test task is allowed to run at the same time.
|
|
3928
|
-
>
|
|
3929
|
-
|
|
1873
|
+
>
|
|
3930
1874
|
|
|
3931
1875
|
#### Return value description:
|
|
3932
1876
|
|
|
@@ -3934,84 +1878,39 @@ API Invocation Result, < 0: Failure
|
|
|
3934
1878
|
|
|
3935
1879
|
## stopSpeedTest
|
|
3936
1880
|
|
|
3937
|
-
|
|
3938
|
-
|
|
3939
1881
|
#### Stops network speed testing
|
|
3940
1882
|
|
|
3941
1883
|
## getSDKVersion
|
|
3942
1884
|
|
|
3943
|
-
|
|
3944
|
-
|
|
3945
1885
|
#### Obtains the SDK version.
|
|
3946
1886
|
|
|
3947
1887
|
## setLogLevel
|
|
3948
1888
|
|
|
3949
|
-
|
|
3950
|
-
|
|
3951
1889
|
#### Sets the log output level.
|
|
3952
|
-
|
|
3953
|
-
|
|
3954
|
-
|
|
3955
|
-
|
|
3956
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3957
|
-
</tr>
|
|
3958
|
-
|
|
3959
|
-
<tr>
|
|
3960
|
-
<td rowspan="1" colSpan="1" >level</td>
|
|
3961
|
-
|
|
3962
|
-
<td rowspan="1" colSpan="1" >Refer to [TRTCLogLevel](https://write.woa.com/document/87030132707430400), default value: [TRTCLogLevelNone](https://write.woa.com/document/87030132707430400)</td>
|
|
3963
|
-
</tr>
|
|
3964
|
-
</table>
|
|
3965
|
-
|
|
1890
|
+
| Parameters | Description |
|
|
1891
|
+
| --- | --- |
|
|
1892
|
+
| level | Refer to TRTCLogLevel, default value: TRTCLogLevelNone |
|
|
3966
1893
|
|
|
3967
1894
|
## setConsoleEnabled
|
|
3968
1895
|
|
|
3969
|
-
|
|
3970
|
-
|
|
3971
1896
|
#### Enables/Disables console log print.
|
|
3972
|
-
|
|
3973
|
-
|
|
3974
|
-
|
|
3975
|
-
|
|
3976
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
3977
|
-
</tr>
|
|
3978
|
-
|
|
3979
|
-
<tr>
|
|
3980
|
-
<td rowspan="1" colSpan="1" >enabled</td>
|
|
3981
|
-
|
|
3982
|
-
<td rowspan="1" colSpan="1" >Specify whether to enable it. Default: Disabled.</td>
|
|
3983
|
-
</tr>
|
|
3984
|
-
</table>
|
|
3985
|
-
|
|
1897
|
+
| Parameters | Description |
|
|
1898
|
+
| --- | --- |
|
|
1899
|
+
| enabled | Specify whether to enable it. Default: Disabled. |
|
|
3986
1900
|
|
|
3987
1901
|
## setLogCompressEnabled
|
|
3988
1902
|
|
|
3989
|
-
|
|
3990
|
-
|
|
3991
1903
|
#### Enables/Disables local log compression
|
|
3992
1904
|
|
|
3993
1905
|
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.
|
|
3994
1906
|
|
|
3995
1907
|
After disabling compression, logs are stored in plaintext, which can be opened and read directly with Notepad but occupy more space.
|
|
3996
|
-
|
|
3997
|
-
|
|
3998
|
-
|
|
3999
|
-
|
|
4000
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
4001
|
-
</tr>
|
|
4002
|
-
|
|
4003
|
-
<tr>
|
|
4004
|
-
<td rowspan="1" colSpan="1" >enabled</td>
|
|
4005
|
-
|
|
4006
|
-
<td rowspan="1" colSpan="1" >Specify whether to enable it. Default: Enabled</td>
|
|
4007
|
-
</tr>
|
|
4008
|
-
</table>
|
|
4009
|
-
|
|
1908
|
+
| Parameters | Description |
|
|
1909
|
+
| --- | --- |
|
|
1910
|
+
| enabled | Specify whether to enable it. Default: Enabled |
|
|
4010
1911
|
|
|
4011
1912
|
## setLogDirPath
|
|
4012
1913
|
|
|
4013
|
-
|
|
4014
|
-
|
|
4015
1914
|
#### Sets the save path for local logs
|
|
4016
1915
|
|
|
4017
1916
|
This interface allows you to change the default storage path of SDK local logs. The default local log storage locations are:
|
|
@@ -4021,99 +1920,51 @@ This interface allows you to change the default storage path of SDK local logs.
|
|
|
4021
1920
|
|
|
4022
1921
|
- Android platform: /app private directory/files/log/liteav/.
|
|
4023
1922
|
|
|
4024
|
-
|
|
4025
|
-
|
|
4026
|
-
|
|
4027
|
-
|
|
4028
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
4029
|
-
</tr>
|
|
4030
|
-
|
|
4031
|
-
<tr>
|
|
4032
|
-
<td rowspan="1" colSpan="1" >path</td>
|
|
4033
|
-
|
|
4034
|
-
<td rowspan="1" colSpan="1" >Storage path for logs</td>
|
|
4035
|
-
</tr>
|
|
4036
|
-
</table>
|
|
4037
|
-
|
|
1923
|
+
| Parameters | Description |
|
|
1924
|
+
| --- | --- |
|
|
1925
|
+
| path | Storage path for logs |
|
|
4038
1926
|
|
|
4039
1927
|
> **Note**
|
|
4040
|
-
>
|
|
1928
|
+
>
|
|
4041
1929
|
|
|
4042
1930
|
> 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.
|
|
4043
|
-
>
|
|
4044
|
-
|
|
1931
|
+
>
|
|
4045
1932
|
|
|
4046
1933
|
## setLogCallback
|
|
4047
1934
|
|
|
4048
|
-
|
|
4049
|
-
|
|
4050
1935
|
#### Log callback
|
|
4051
1936
|
|
|
4052
1937
|
## showDebugView
|
|
4053
1938
|
|
|
4054
|
-
|
|
4055
|
-
|
|
4056
1939
|
#### Show Dashboard
|
|
4057
1940
|
|
|
4058
1941
|
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.
|
|
4059
|
-
|
|
4060
|
-
|
|
4061
|
-
|
|
4062
|
-
|
|
4063
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
4064
|
-
</tr>
|
|
4065
|
-
|
|
4066
|
-
<tr>
|
|
4067
|
-
<td rowspan="1" colSpan="1" >showType</td>
|
|
4068
|
-
|
|
4069
|
-
<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>
|
|
4070
|
-
</tr>
|
|
4071
|
-
</table>
|
|
4072
|
-
|
|
1942
|
+
| Parameters | Description |
|
|
1943
|
+
| --- | --- |
|
|
1944
|
+
| 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). |
|
|
4073
1945
|
|
|
4074
1946
|
## callExperimentalAPI
|
|
4075
1947
|
|
|
4076
|
-
|
|
4077
|
-
|
|
4078
1948
|
#### Calls an experimental API.
|
|
4079
1949
|
|
|
4080
1950
|
## enablePayloadPrivateEncryption
|
|
4081
1951
|
|
|
4082
|
-
|
|
4083
|
-
|
|
4084
1952
|
#### Enable or disable media stream private encryption
|
|
4085
1953
|
|
|
4086
1954
|
In scenarios with high security requirements, TRTC recommends calling the enablePayloadPrivateEncryption method to enable media stream private encryption before joining a room.
|
|
4087
1955
|
|
|
4088
1956
|
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.
|
|
4089
|
-
|
|
4090
|
-
|
|
4091
|
-
|
|
4092
|
-
|
|
4093
|
-
<td rowspan="1" colSpan="1" >Description</td>
|
|
4094
|
-
</tr>
|
|
4095
|
-
|
|
4096
|
-
<tr>
|
|
4097
|
-
<td rowspan="1" colSpan="1" >config</td>
|
|
4098
|
-
|
|
4099
|
-
<td rowspan="1" colSpan="1" >For configuring the media stream private encryption algorithm and key, refer to [TRTCPayloadPrivateEncryptionConfig](https://write.woa.com/document/87030132707430400).</td>
|
|
4100
|
-
</tr>
|
|
4101
|
-
|
|
4102
|
-
<tr>
|
|
4103
|
-
<td rowspan="1" colSpan="1" >enabled</td>
|
|
4104
|
-
|
|
4105
|
-
<td rowspan="1" colSpan="1" >Whether to enable media stream private encryption.</td>
|
|
4106
|
-
</tr>
|
|
4107
|
-
</table>
|
|
4108
|
-
|
|
1957
|
+
| Parameters | Description |
|
|
1958
|
+
| --- | --- |
|
|
1959
|
+
| config | For configuring the media stream private encryption algorithm and key, refer to TRTCPayloadPrivateEncryptionConfig. |
|
|
1960
|
+
| enabled | Whether to enable media stream private encryption. |
|
|
4109
1961
|
|
|
4110
1962
|
> **Note**
|
|
4111
|
-
>
|
|
1963
|
+
>
|
|
4112
1964
|
|
|
4113
1965
|
> 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.
|
|
4114
|
-
>
|
|
4115
|
-
|
|
1966
|
+
>
|
|
4116
1967
|
|
|
4117
1968
|
#### Return value description:
|
|
4118
1969
|
|
|
4119
|
-
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.
|
|
1970
|
+
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.
|