@tencentcloud/sdk-mcp 1.3.9 → 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/index.js +1 -1
- package/index.js.map +1 -1
- package/package.json +2 -2
- package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/android-faq.md} +75 -308
- package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +2 -2
- package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/flutter-faq.md} +83 -315
- package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/ios-faq.md} +76 -313
- package/resource/doc/{tuicallkit/vue/faq.md → callkit/faq/web-faq.md} +78 -311
- package/resource/doc/callkit/preset/android/api.md +330 -0
- package/resource/doc/{tuicallkit → callkit/preset}/android/integration.md +63 -420
- package/resource/doc/callkit/preset/flutter/api.md +401 -0
- package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +53 -273
- package/resource/doc/callkit/preset/ios/api.md +282 -0
- package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +39 -120
- package/resource/doc/callkit/preset/react/api.md +600 -0
- package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +6 -6
- package/resource/doc/callkit/preset/vue/api.md +600 -0
- package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +5 -5
- package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -37
- package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
- package/resource/doc/{chatuikit → chatkit}/android/integration.md +30 -126
- package/resource/doc/chatkit/faq/android_sdk/client-api.md +280 -0
- package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +4 -17
- package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -2
- package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +183 -0
- package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
- package/resource/doc/chatkit/faq/ios_sdk/client-api.md +279 -0
- package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +1 -1
- package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +4 -4
- package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
- package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +20 -95
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -37
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +78 -280
- package/resource/doc/{chatuikit/vue → chatkit/react}/components/avatar.md +0 -1
- package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +7 -12
- package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +10 -17
- package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +1 -1
- package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -1
- package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +122 -703
- 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 +116 -0
- package/resource/doc/chatkit/react/components/conversation-search.md +57 -0
- package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -186
- package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +21 -113
- package/resource/doc/chatkit/react/components/search.md +282 -0
- package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +5 -26
- package/resource/doc/{chatuikit → chatkit}/react/integration.md +37 -104
- package/resource/doc/{chatuikit/react → chatkit/vue}/components/avatar.md +0 -1
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -13
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +13 -18
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +1 -2
- package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -1
- 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 -316
- 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 +1 -23
- package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -134
- package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
- package/resource/doc/chatkit/vue/components/tuikit.md +45 -0
- package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +4 -4
- package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
- package/resource/doc/{chatuikit → chatkit}/vue/integration.md +53 -121
- package/resource/doc/livekit/core-sdk/live/android/api-reference/AudioEffectStore.md +283 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +148 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +316 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CameraView.md +57 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +419 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +325 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +436 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +165 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LikeStore.md +49 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +239 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +74 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +417 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +207 -0
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +17 -88
- 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 +26 -139
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +16 -99
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +54 -161
- 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 +91 -338
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +108 -492
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +27 -165
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/AudioEffectStore.md +279 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +158 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BaseBeautyStore.md +155 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +304 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +394 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +303 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +410 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +160 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LikeStore.md +51 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +231 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveCoreView.md +143 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +375 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +170 -0
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +13 -91
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -177
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +18 -102
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -164
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -161
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +66 -460
- 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 +160 -543
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +22 -161
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/AudioEffectStore.md +287 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +165 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +143 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +298 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +349 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +297 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +471 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +179 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LikeStore.md +49 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +238 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +74 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +412 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +173 -0
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +23 -96
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +33 -195
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +35 -150
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +20 -105
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +35 -140
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +77 -457
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +70 -317
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +90 -473
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +28 -163
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audience-list.md +17 -88
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audio-effect.md +34 -192
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-barrage.md +26 -139
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-co-guest-interaction.md +53 -262
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-gift.md +75 -455
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-host-interaction.md +60 -272
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-integration.md +63 -440
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-room-list.md +23 -151
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-audience-list.md +13 -91
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-audio-effect.md +34 -177
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-barrage.md +18 -102
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-co-guest-interaction.md +44 -201
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-gift.md +66 -460
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-integration.md +57 -419
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-room-list.md +24 -157
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audience-list.md +23 -96
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audio-effect.md +33 -195
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-barrage.md +35 -150
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-co-guest-interaction.md +45 -254
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-gift.md +77 -457
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-host-interaction.md +52 -261
- package/resource/doc/livekit/core-sdk/voice/ios/voice-integration.md +478 -0
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-room-list.md +36 -167
- package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-audience-list.md +15 -45
- package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-audio-effect.md +23 -137
- package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-barrage.md +25 -131
- package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-co-guest-interaction.md +70 -366
- package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-gift.md +70 -424
- package/resource/doc/livekit/core-sdk/voice/uni-app/voice-integration.md +323 -0
- package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-room-list.md +24 -116
- package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -3
- 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 +9 -48
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +27 -145
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +13 -76
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +33 -224
- package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +211 -0
- package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
- package/resource/doc/livekit/preset/live/vue/live-list-integration.md +244 -0
- package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +301 -0
- package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +307 -0
- package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +754 -0
- package/resource/doc/roomkit/android/features/call-user-to-room.md +234 -0
- package/resource/doc/roomkit/android/features/room-participant-state.md +850 -0
- package/resource/doc/roomkit/android/features/room-state.md +358 -0
- package/resource/doc/roomkit/android/features/schedule-room.md +336 -0
- package/resource/doc/roomkit/android/integration.md +433 -0
- package/resource/doc/roomkit/{common/error_code.md → faq/common/error-code.md} +1 -1
- package/resource/doc/roomkit/flutter/features/call-user-to-room.md +228 -0
- package/resource/doc/roomkit/flutter/features/room-participant-state.md +796 -0
- package/resource/doc/roomkit/flutter/features/room-state.md +324 -0
- package/resource/doc/roomkit/flutter/features/schedule-room.md +324 -0
- package/resource/doc/roomkit/flutter/integration.md +405 -0
- package/resource/doc/roomkit/ios/features/call-user-to-room.md +226 -0
- package/resource/doc/roomkit/ios/features/room-participant-state.md +821 -0
- package/resource/doc/roomkit/ios/features/room-state.md +320 -0
- package/resource/doc/roomkit/ios/features/schedule-room.md +318 -0
- package/resource/doc/roomkit/ios/integration.md +384 -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 -36
- package/resource/doc/roomkit/vue/features/room-view.md +30 -127
- 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 -34
- package/resource/doc/roomkit/vue/integration.md +21 -80
- package/resource/doc/rtcengine/faq/common/userSig.md +17 -141
- package/resource/doc/rtcengine/faq/web/web.md +15 -22
- package/resource/doc/rtcengine/web/api.md +17 -21
- package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +4 -10
- package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +4 -8
- package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +3 -3
- package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -3
- package/resource/doc/rtcengine/web/plugin/22-advanced-audio-mixer.md +6 -6
- package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +2 -2
- package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +2 -4
- package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +1 -2
- package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +2 -6
- package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +13 -14
- package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +10 -90
- package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -8
- package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +31 -35
- package/resource/doc/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -2
- package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +7 -49
- package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -1
- package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -3
- package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +20 -20
- 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 -4
- package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
- package/resource/doc/trtc/C++/ITRTCCloud.md +718 -2847
- package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
- package/resource/doc/trtc/C++/ITXAudioEffectManager.md +207 -1041
- package/resource/doc/trtc/C++/ITXDeviceManager.md +127 -768
- package/resource/doc/trtc/C++/TRTCCloudCallback.md +634 -2259
- package/resource/doc/trtc/C++/TRTCTypeDef.md +726 -3465
- package/resource/doc/trtc/C++/TXLiteAVCode.md +117 -916
- package/resource/doc/trtc/android/TRTCCloud.md +638 -2612
- package/resource/doc/trtc/android/TRTCCloudDef.md +769 -3697
- package/resource/doc/trtc/android/TRTCCloudListener.md +609 -2070
- package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
- package/resource/doc/trtc/android/TXAudioEffectManager.md +207 -1049
- 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 +115 -900
- package/resource/doc/trtc/iOS/TRTCCloud.md +726 -2930
- package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +580 -2099
- package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
- package/resource/doc/trtc/iOS/TXAudioEffectManager.md +179 -896
- 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/resource/doc/trtc/iOS/TXLiveSDKTypeDef.md +747 -3559
- 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 +28 -0
- package/tools/definitions/get_callkit_api_def.js.map +1 -0
- package/tools/definitions/get_faq_def.js +18 -19
- package/tools/definitions/get_faq_def.js.map +1 -1
- package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
- 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 -41
- package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_native_livekit_core_features_def.js +33 -0
- package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
- package/tools/definitions/get_native_livekit_core_integration_def.js +33 -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 -24
- 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 +13 -18
- package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_livekit_api_def.js +27 -0
- package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
- package/tools/definitions/get_web_livekit_component_detail_def.js +29 -0
- package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
- package/tools/definitions/get_web_room_uikit_integration_def.js +13 -46
- package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_roomkit_feature_detail_def.js +30 -0
- package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_api_def.js +25 -0
- package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_integration_def.js +25 -0
- package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js +25 -0
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
- package/tools/definitions/present_framework_choice_def.js +23 -12
- package/tools/definitions/present_framework_choice_def.js.map +1 -1
- package/tools/index.js +47 -61
- 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 +1 -1
- package/resource/doc/chatuikit/android/workflow.md +0 -713
- package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1376
- package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -860
- package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1371
- package/resource/doc/chatuikit/flutter/workflow.md +0 -816
- package/resource/doc/chatuikit/iOS/workflow.md +0 -0
- package/resource/doc/chatuikit/react/components/conversation-list.md +0 -765
- package/resource/doc/chatuikit/react/components/search.md +0 -885
- package/resource/doc/chatuikit/react/create-group.md +0 -22
- package/resource/doc/chatuikit/react/init.md +0 -25
- package/resource/doc/chatuikit/react/workflow.md +0 -254
- package/resource/doc/chatuikit/uniapp-app/faq.md +0 -0
- package/resource/doc/chatuikit/uniapp-app/integration.md +0 -619
- package/resource/doc/chatuikit/uniapp-app/workflow.md +0 -576
- package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
- package/resource/doc/chatuikit/vue/components/tuikit.md +0 -110
- package/resource/doc/chatuikit/vue/create-group.md +0 -26
- package/resource/doc/chatuikit/vue/init.md +0 -35
- package/resource/doc/chatuikit/vue/workflow.md +0 -395
- package/resource/doc/livekit/live/android/workflow.md +0 -322
- package/resource/doc/livekit/live/flutter/workflow.md +0 -353
- package/resource/doc/livekit/live/ios/workflow.md +0 -352
- package/resource/doc/livekit/live/vue/components/barrage.md +0 -615
- package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -442
- package/resource/doc/livekit/live/vue/faq.md +0 -0
- package/resource/doc/livekit/live/vue/live-list-integration.md +0 -195
- package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -293
- package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -381
- package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -598
- package/resource/doc/livekit/live/vue/states/live-state.md +0 -2656
- package/resource/doc/livekit/live/vue/workflow.md +0 -219
- package/resource/doc/livekit/voice/android/workflow.md +0 -333
- package/resource/doc/livekit/voice/flutter/workflow.md +0 -359
- package/resource/doc/livekit/voice/ios/voice-integration.md +0 -853
- package/resource/doc/livekit/voice/ios/workflow.md +0 -358
- package/resource/doc/livekit/voice/uni-app/voice-integration.md +0 -613
- package/resource/doc/livekit/voice/uni-app/workflow.md +0 -369
- package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -334
- package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -434
- package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -685
- package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -712
- package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -284
- 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 -879
- package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -668
- package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -456
- package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -332
- package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
- package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -328
- package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -505
- package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
- package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -676
- package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
- package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -820
- package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1065
- package/resource/doc/roomkit/vue/features/workflow.md +0 -553
- package/resource/doc/roomkit/vue/workflow.md +0 -733
- package/resource/doc/tuicallkit/android/workflow.md +0 -432
- package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -786
- package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -663
- package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -932
- package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -926
- package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -452
- package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -779
- package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -635
- package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
- package/resource/doc/tuicallkit/react/api.md +0 -1512
- package/resource/doc/tuicallkit/react/faq.md +0 -986
- package/resource/doc/tuicallkit/vue/api.md +0 -1512
- 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/present-scenario-choice.js +0 -16
- package/tools/common/present-scenario-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 -22
- package/tools/definitions/get_native_live_api_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -109
- 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 -75
- package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
- package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
- package/tools/definitions/get_trtc_native_api_def.js +0 -17
- 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 -92
- package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
- package/tools/definitions/present_scenario_choice_def.js +0 -53
- package/tools/definitions/present_scenario_choice_def.js.map +0 -1
- package/tools/definitions/record_prompt_def.js +0 -58
- package/tools/definitions/record_prompt_def.js.map +0 -1
- package/tools/definitions/record_result_def.js +0 -46
- package/tools/definitions/record_result_def.js.map +0 -1
- package/tools/live/get-native-live-uikit-integration.js +0 -177
- 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 -194
- 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/{rtcengine/web → callkit/core-sdk}/.gitkeep +0 -0
- /package/resource/doc/{chatuikit → chatkit}/faq/common/server_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
|
@@ -3,972 +3,293 @@
|
|
|
3
3
|
## 概述
|
|
4
4
|
`ITRTCCloud.h` 是腾讯云实时音视频(TRTC SDK ) C++ 的 API 文档，包含了推流、拉流、拉流、混流、录制等功能详细说明。
|
|
5
5
|
|
|
6
|
-
|
|
7
6
|
## ITRTCCloud
|
|
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
|
-
|
|
120
|
-
<td rowspan="1" colSpan="1" >停止发布媒体流。</td>
|
|
121
|
-
</tr>
|
|
122
|
-
|
|
123
|
-
<tr>
|
|
124
|
-
<td rowspan="1" colSpan="1" >[startLocalPreview](https://write.woa.com/document/87030026264555520)</td>
|
|
125
|
-
|
|
126
|
-
<td rowspan="1" colSpan="1" >开启本地摄像头的预览画面（移动端）。</td>
|
|
127
|
-
</tr>
|
|
128
|
-
|
|
129
|
-
<tr>
|
|
130
|
-
<td rowspan="1" colSpan="1" >[startLocalPreview](https://write.woa.com/document/87030026264555520)</td>
|
|
131
|
-
|
|
132
|
-
<td rowspan="1" colSpan="1" >开启本地摄像头的预览画面（桌面端）。</td>
|
|
133
|
-
</tr>
|
|
134
|
-
|
|
135
|
-
<tr>
|
|
136
|
-
<td rowspan="1" colSpan="1" >[updateLocalView](https://write.woa.com/document/87030026264555520)</td>
|
|
137
|
-
|
|
138
|
-
<td rowspan="1" colSpan="1" >更新本地摄像头的预览画面。</td>
|
|
139
|
-
</tr>
|
|
140
|
-
|
|
141
|
-
<tr>
|
|
142
|
-
<td rowspan="1" colSpan="1" >[stopLocalPreview](https://write.woa.com/document/87030026264555520)</td>
|
|
143
|
-
|
|
144
|
-
<td rowspan="1" colSpan="1" >停止摄像头预览。</td>
|
|
145
|
-
</tr>
|
|
146
|
-
|
|
147
|
-
<tr>
|
|
148
|
-
<td rowspan="1" colSpan="1" >[muteLocalVideo](https://write.woa.com/document/87030026264555520)</td>
|
|
149
|
-
|
|
150
|
-
<td rowspan="1" colSpan="1" >暂停/恢复发布本地的视频流。</td>
|
|
151
|
-
</tr>
|
|
152
|
-
|
|
153
|
-
<tr>
|
|
154
|
-
<td rowspan="1" colSpan="1" >[setVideoMuteImage](https://write.woa.com/document/87030026264555520)</td>
|
|
155
|
-
|
|
156
|
-
<td rowspan="1" colSpan="1" >设置本地画面被暂停期间的替代图片。</td>
|
|
157
|
-
</tr>
|
|
158
|
-
|
|
159
|
-
<tr>
|
|
160
|
-
<td rowspan="1" colSpan="1" >[startRemoteView](https://write.woa.com/document/87030026264555520)</td>
|
|
161
|
-
|
|
162
|
-
<td rowspan="1" colSpan="1" >订阅远端用户的视频流，并绑定视频渲染控件。</td>
|
|
163
|
-
</tr>
|
|
164
|
-
|
|
165
|
-
<tr>
|
|
166
|
-
<td rowspan="1" colSpan="1" >[updateRemoteView](https://write.woa.com/document/87030026264555520)</td>
|
|
167
|
-
|
|
168
|
-
<td rowspan="1" colSpan="1" >更新远端用户的视频渲染控件。</td>
|
|
169
|
-
</tr>
|
|
170
|
-
|
|
171
|
-
<tr>
|
|
172
|
-
<td rowspan="1" colSpan="1" >[stopRemoteView](https://write.woa.com/document/87030026264555520)</td>
|
|
173
|
-
|
|
174
|
-
<td rowspan="1" colSpan="1" >停止订阅远端用户的视频流，并释放渲染控件。</td>
|
|
175
|
-
</tr>
|
|
176
|
-
|
|
177
|
-
<tr>
|
|
178
|
-
<td rowspan="1" colSpan="1" >[stopAllRemoteView](https://write.woa.com/document/87030026264555520)</td>
|
|
179
|
-
|
|
180
|
-
<td rowspan="1" colSpan="1" >停止订阅所有远端用户的视频流，并释放全部渲染资源。</td>
|
|
181
|
-
</tr>
|
|
182
|
-
|
|
183
|
-
<tr>
|
|
184
|
-
<td rowspan="1" colSpan="1" >[muteRemoteVideoStream](https://write.woa.com/document/87030026264555520)</td>
|
|
185
|
-
|
|
186
|
-
<td rowspan="1" colSpan="1" >暂停/恢复订阅远端用户的视频流。</td>
|
|
187
|
-
</tr>
|
|
188
|
-
|
|
189
|
-
<tr>
|
|
190
|
-
<td rowspan="1" colSpan="1" >[muteAllRemoteVideoStreams](https://write.woa.com/document/87030026264555520)</td>
|
|
191
|
-
|
|
192
|
-
<td rowspan="1" colSpan="1" >暂停/恢复订阅所有远端用户的视频流。</td>
|
|
193
|
-
</tr>
|
|
194
|
-
|
|
195
|
-
<tr>
|
|
196
|
-
<td rowspan="1" colSpan="1" >[setVideoEncoderParam](https://write.woa.com/document/87030026264555520)</td>
|
|
197
|
-
|
|
198
|
-
<td rowspan="1" colSpan="1" >设置视频编码器的编码参数。</td>
|
|
199
|
-
</tr>
|
|
200
|
-
|
|
201
|
-
<tr>
|
|
202
|
-
<td rowspan="1" colSpan="1" >[setNetworkQosParam](https://write.woa.com/document/87030026264555520)</td>
|
|
203
|
-
|
|
204
|
-
<td rowspan="1" colSpan="1" >设置网络质量控制的相关参数。</td>
|
|
205
|
-
</tr>
|
|
206
|
-
|
|
207
|
-
<tr>
|
|
208
|
-
<td rowspan="1" colSpan="1" >[setLocalRenderParams](https://write.woa.com/document/87030026264555520)</td>
|
|
209
|
-
|
|
210
|
-
<td rowspan="1" colSpan="1" >设置本地画面的渲染参数。</td>
|
|
211
|
-
</tr>
|
|
212
|
-
|
|
213
|
-
<tr>
|
|
214
|
-
<td rowspan="1" colSpan="1" >[setRemoteRenderParams](https://write.woa.com/document/87030026264555520)</td>
|
|
215
|
-
|
|
216
|
-
<td rowspan="1" colSpan="1" >设置远端画面的渲染模式。</td>
|
|
217
|
-
</tr>
|
|
218
|
-
|
|
219
|
-
<tr>
|
|
220
|
-
<td rowspan="1" colSpan="1" >[enableSmallVideoStream](https://write.woa.com/document/87030026264555520)</td>
|
|
221
|
-
|
|
222
|
-
<td rowspan="1" colSpan="1" >开启大小画面双路编码模式。</td>
|
|
223
|
-
</tr>
|
|
224
|
-
|
|
225
|
-
<tr>
|
|
226
|
-
<td rowspan="1" colSpan="1" >[setRemoteVideoStreamType](https://write.woa.com/document/87030026264555520)</td>
|
|
227
|
-
|
|
228
|
-
<td rowspan="1" colSpan="1" >切换指定远端用户的大小画面。</td>
|
|
229
|
-
</tr>
|
|
230
|
-
|
|
231
|
-
<tr>
|
|
232
|
-
<td rowspan="1" colSpan="1" >[snapshotVideo](https://write.woa.com/document/87030026264555520)</td>
|
|
233
|
-
|
|
234
|
-
<td rowspan="1" colSpan="1" >视频画面截图。</td>
|
|
235
|
-
</tr>
|
|
236
|
-
|
|
237
|
-
<tr>
|
|
238
|
-
<td rowspan="1" colSpan="1" >[setGravitySensorAdaptiveMode](https://write.woa.com/document/87030026264555520)</td>
|
|
239
|
-
|
|
240
|
-
<td rowspan="1" colSpan="1" >设置重力感应的适配模式（11.7 及以上版本）。</td>
|
|
241
|
-
</tr>
|
|
242
|
-
|
|
243
|
-
<tr>
|
|
244
|
-
<td rowspan="1" colSpan="1" >[startLocalAudio](https://write.woa.com/document/87030026264555520)</td>
|
|
245
|
-
|
|
246
|
-
<td rowspan="1" colSpan="1" >开启本地音频的采集和发布。</td>
|
|
247
|
-
</tr>
|
|
248
|
-
|
|
249
|
-
<tr>
|
|
250
|
-
<td rowspan="1" colSpan="1" >[stopLocalAudio](https://write.woa.com/document/87030026264555520)</td>
|
|
251
|
-
|
|
252
|
-
<td rowspan="1" colSpan="1" >停止本地音频的采集和发布。</td>
|
|
253
|
-
</tr>
|
|
254
|
-
|
|
255
|
-
<tr>
|
|
256
|
-
<td rowspan="1" colSpan="1" >[muteLocalAudio](https://write.woa.com/document/87030026264555520)</td>
|
|
257
|
-
|
|
258
|
-
<td rowspan="1" colSpan="1" >暂停/恢复发布本地的音频流。</td>
|
|
259
|
-
</tr>
|
|
260
|
-
|
|
261
|
-
<tr>
|
|
262
|
-
<td rowspan="1" colSpan="1" >[muteRemoteAudio](https://write.woa.com/document/87030026264555520)</td>
|
|
263
|
-
|
|
264
|
-
<td rowspan="1" colSpan="1" >暂停/恢复播放远端的音频流。</td>
|
|
265
|
-
</tr>
|
|
266
|
-
|
|
267
|
-
<tr>
|
|
268
|
-
<td rowspan="1" colSpan="1" >[muteAllRemoteAudio](https://write.woa.com/document/87030026264555520)</td>
|
|
269
|
-
|
|
270
|
-
<td rowspan="1" colSpan="1" >暂停/恢复播放所有远端用户的音频流。</td>
|
|
271
|
-
</tr>
|
|
272
|
-
|
|
273
|
-
<tr>
|
|
274
|
-
<td rowspan="1" colSpan="1" >[setRemoteAudioVolume](https://write.woa.com/document/87030026264555520)</td>
|
|
275
|
-
|
|
276
|
-
<td rowspan="1" colSpan="1" >设定某一个远端用户的声音播放音量。</td>
|
|
277
|
-
</tr>
|
|
278
|
-
|
|
279
|
-
<tr>
|
|
280
|
-
<td rowspan="1" colSpan="1" >[setAudioCaptureVolume](https://write.woa.com/document/87030026264555520)</td>
|
|
281
|
-
|
|
282
|
-
<td rowspan="1" colSpan="1" >设定本地音频的采集音量。</td>
|
|
283
|
-
</tr>
|
|
284
|
-
|
|
285
|
-
<tr>
|
|
286
|
-
<td rowspan="1" colSpan="1" >[getAudioCaptureVolume](https://write.woa.com/document/87030026264555520)</td>
|
|
287
|
-
|
|
288
|
-
<td rowspan="1" colSpan="1" >获取本地音频的采集音量。</td>
|
|
289
|
-
</tr>
|
|
290
|
-
|
|
291
|
-
<tr>
|
|
292
|
-
<td rowspan="1" colSpan="1" >[setAudioPlayoutVolume](https://write.woa.com/document/87030026264555520)</td>
|
|
293
|
-
|
|
294
|
-
<td rowspan="1" colSpan="1" >设定远端音频的播放音量。</td>
|
|
295
|
-
</tr>
|
|
296
|
-
|
|
297
|
-
<tr>
|
|
298
|
-
<td rowspan="1" colSpan="1" >[getAudioPlayoutVolume](https://write.woa.com/document/87030026264555520)</td>
|
|
299
|
-
|
|
300
|
-
<td rowspan="1" colSpan="1" >获取远端音频的播放音量。</td>
|
|
301
|
-
</tr>
|
|
302
|
-
|
|
303
|
-
<tr>
|
|
304
|
-
<td rowspan="1" colSpan="1" >[enableAudioVolumeEvaluation](https://write.woa.com/document/87030026264555520)</td>
|
|
305
|
-
|
|
306
|
-
<td rowspan="1" colSpan="1" >启用音量大小提示。</td>
|
|
307
|
-
</tr>
|
|
308
|
-
|
|
309
|
-
<tr>
|
|
310
|
-
<td rowspan="1" colSpan="1" >[startAudioRecording](https://write.woa.com/document/87030026264555520)</td>
|
|
311
|
-
|
|
312
|
-
<td rowspan="1" colSpan="1" >开始录音。</td>
|
|
313
|
-
</tr>
|
|
314
|
-
|
|
315
|
-
<tr>
|
|
316
|
-
<td rowspan="1" colSpan="1" >[stopAudioRecording](https://write.woa.com/document/87030026264555520)</td>
|
|
317
|
-
|
|
318
|
-
<td rowspan="1" colSpan="1" >停止录音。</td>
|
|
319
|
-
</tr>
|
|
320
|
-
|
|
321
|
-
<tr>
|
|
322
|
-
<td rowspan="1" colSpan="1" >[startLocalRecording](https://write.woa.com/document/87030026264555520)</td>
|
|
323
|
-
|
|
324
|
-
<td rowspan="1" colSpan="1" >开启本地媒体录制。</td>
|
|
325
|
-
</tr>
|
|
326
|
-
|
|
327
|
-
<tr>
|
|
328
|
-
<td rowspan="1" colSpan="1" >[stopLocalRecording](https://write.woa.com/document/87030026264555520)</td>
|
|
329
|
-
|
|
330
|
-
<td rowspan="1" colSpan="1" >停止本地媒体录制。</td>
|
|
331
|
-
</tr>
|
|
332
|
-
|
|
333
|
-
<tr>
|
|
334
|
-
<td rowspan="1" colSpan="1" >[setRemoteAudioParallelParams](https://write.woa.com/document/87030026264555520)</td>
|
|
335
|
-
|
|
336
|
-
<td rowspan="1" colSpan="1" >设置远端音频流智能并发播放策略。</td>
|
|
337
|
-
</tr>
|
|
338
|
-
|
|
339
|
-
<tr>
|
|
340
|
-
<td rowspan="1" colSpan="1" >[enable3DSpatialAudioEffect](https://write.woa.com/document/87030026264555520)</td>
|
|
341
|
-
|
|
342
|
-
<td rowspan="1" colSpan="1" >启用 3D 音效。</td>
|
|
343
|
-
</tr>
|
|
344
|
-
|
|
345
|
-
<tr>
|
|
346
|
-
<td rowspan="1" colSpan="1" >[updateSelf3DSpatialPosition](https://write.woa.com/document/87030026264555520)</td>
|
|
347
|
-
|
|
348
|
-
<td rowspan="1" colSpan="1" >设置 3D 音效中自身坐标及朝向信息。</td>
|
|
349
|
-
</tr>
|
|
350
|
-
|
|
351
|
-
<tr>
|
|
352
|
-
<td rowspan="1" colSpan="1" >[updateRemote3DSpatialPosition](https://write.woa.com/document/87030026264555520)</td>
|
|
353
|
-
|
|
354
|
-
<td rowspan="1" colSpan="1" >设置 3D 音效中远端用户坐标信息。</td>
|
|
355
|
-
</tr>
|
|
356
|
-
|
|
357
|
-
<tr>
|
|
358
|
-
<td rowspan="1" colSpan="1" >[set3DSpatialReceivingRange](https://write.woa.com/document/87030026264555520)</td>
|
|
359
|
-
|
|
360
|
-
<td rowspan="1" colSpan="1" >设置指定用户所发出声音的可被接收范围。</td>
|
|
361
|
-
</tr>
|
|
362
|
-
|
|
363
|
-
<tr>
|
|
364
|
-
<td rowspan="1" colSpan="1" >[getDeviceManager](https://write.woa.com/document/87030026264555520)</td>
|
|
365
|
-
|
|
366
|
-
<td rowspan="1" colSpan="1" >获取设备管理类（TXDeviceManager）。</td>
|
|
367
|
-
</tr>
|
|
368
|
-
|
|
369
|
-
<tr>
|
|
370
|
-
<td rowspan="1" colSpan="1" >[getBeautyManager](https://write.woa.com/document/87030026264555520)</td>
|
|
371
|
-
|
|
372
|
-
<td rowspan="1" colSpan="1" >获取美颜管理类（TXBeautyManager）。</td>
|
|
373
|
-
</tr>
|
|
374
|
-
|
|
375
|
-
<tr>
|
|
376
|
-
<td rowspan="1" colSpan="1" >[setWaterMark](https://write.woa.com/document/87030026264555520)</td>
|
|
377
|
-
|
|
378
|
-
<td rowspan="1" colSpan="1" >添加水印。</td>
|
|
379
|
-
</tr>
|
|
380
|
-
|
|
381
|
-
<tr>
|
|
382
|
-
<td rowspan="1" colSpan="1" >[getAudioEffectManager](https://write.woa.com/document/87030026264555520)</td>
|
|
383
|
-
|
|
384
|
-
<td rowspan="1" colSpan="1" >获取音效管理类（TXAudioEffectManager）。</td>
|
|
385
|
-
</tr>
|
|
386
|
-
|
|
387
|
-
<tr>
|
|
388
|
-
<td rowspan="1" colSpan="1" >[startSystemAudioLoopback](https://write.woa.com/document/87030026264555520)</td>
|
|
389
|
-
|
|
390
|
-
<td rowspan="1" colSpan="1" >开启系统声音采集（iOS 端暂未支持）。</td>
|
|
391
|
-
</tr>
|
|
392
|
-
|
|
393
|
-
<tr>
|
|
394
|
-
<td rowspan="1" colSpan="1" >[stopSystemAudioLoopback](https://write.woa.com/document/87030026264555520)</td>
|
|
395
|
-
|
|
396
|
-
<td rowspan="1" colSpan="1" >停止系统声音采集（iOS 端暂未支持）。</td>
|
|
397
|
-
</tr>
|
|
398
|
-
|
|
399
|
-
<tr>
|
|
400
|
-
<td rowspan="1" colSpan="1" >[setSystemAudioLoopbackVolume](https://write.woa.com/document/87030026264555520)</td>
|
|
401
|
-
|
|
402
|
-
<td rowspan="1" colSpan="1" >设置系统声音的采集音量。</td>
|
|
403
|
-
</tr>
|
|
404
|
-
|
|
405
|
-
<tr>
|
|
406
|
-
<td rowspan="1" colSpan="1" >[startScreenCapture](https://write.woa.com/document/87030026264555520)</td>
|
|
407
|
-
|
|
408
|
-
<td rowspan="1" colSpan="1" >启动屏幕分享。</td>
|
|
409
|
-
</tr>
|
|
410
|
-
|
|
411
|
-
<tr>
|
|
412
|
-
<td rowspan="1" colSpan="1" >[stopScreenCapture](https://write.woa.com/document/87030026264555520)</td>
|
|
413
|
-
|
|
414
|
-
<td rowspan="1" colSpan="1" >停止屏幕分享。</td>
|
|
415
|
-
</tr>
|
|
416
|
-
|
|
417
|
-
<tr>
|
|
418
|
-
<td rowspan="1" colSpan="1" >[pauseScreenCapture](https://write.woa.com/document/87030026264555520)</td>
|
|
419
|
-
|
|
420
|
-
<td rowspan="1" colSpan="1" >暂停屏幕分享。</td>
|
|
421
|
-
</tr>
|
|
422
|
-
|
|
423
|
-
<tr>
|
|
424
|
-
<td rowspan="1" colSpan="1" >[resumeScreenCapture](https://write.woa.com/document/87030026264555520)</td>
|
|
425
|
-
|
|
426
|
-
<td rowspan="1" colSpan="1" >恢复屏幕分享。</td>
|
|
427
|
-
</tr>
|
|
428
|
-
|
|
429
|
-
<tr>
|
|
430
|
-
<td rowspan="1" colSpan="1" >[getScreenCaptureSources](https://write.woa.com/document/87030026264555520)</td>
|
|
431
|
-
|
|
432
|
-
<td rowspan="1" colSpan="1" >枚举可分享的屏幕和窗口（该接口仅支持桌面系统）。</td>
|
|
433
|
-
</tr>
|
|
434
|
-
|
|
435
|
-
<tr>
|
|
436
|
-
<td rowspan="1" colSpan="1" >[selectScreenCaptureTarget](https://write.woa.com/document/87030026264555520)</td>
|
|
437
|
-
|
|
438
|
-
<td rowspan="1" colSpan="1" >选取要分享的屏幕或窗口（该接口仅支持桌面系统）。</td>
|
|
439
|
-
</tr>
|
|
440
|
-
|
|
441
|
-
<tr>
|
|
442
|
-
<td rowspan="1" colSpan="1" >[setSubStreamEncoderParam](https://write.woa.com/document/87030026264555520)</td>
|
|
443
|
-
|
|
444
|
-
<td rowspan="1" colSpan="1" >设置屏幕分享（即辅路）的视频编码参数（桌面系统和移动系统均已支持）。</td>
|
|
445
|
-
</tr>
|
|
446
|
-
|
|
447
|
-
<tr>
|
|
448
|
-
<td rowspan="1" colSpan="1" >[setSubStreamMixVolume](https://write.woa.com/document/87030026264555520)</td>
|
|
449
|
-
|
|
450
|
-
<td rowspan="1" colSpan="1" >设置屏幕分享时的混音音量大小（该接口仅支持桌面系统）。</td>
|
|
451
|
-
</tr>
|
|
452
|
-
|
|
453
|
-
<tr>
|
|
454
|
-
<td rowspan="1" colSpan="1" >[addExcludedShareWindow](https://write.woa.com/document/87030026264555520)</td>
|
|
455
|
-
|
|
456
|
-
<td rowspan="1" colSpan="1" >将指定窗口加入屏幕分享的排除列表中（该接口仅支持桌面系统）。</td>
|
|
457
|
-
</tr>
|
|
458
|
-
|
|
459
|
-
<tr>
|
|
460
|
-
<td rowspan="1" colSpan="1" >[removeExcludedShareWindow](https://write.woa.com/document/87030026264555520)</td>
|
|
461
|
-
|
|
462
|
-
<td rowspan="1" colSpan="1" >将指定窗口从屏幕分享的排除列表中移除（该接口仅支持桌面系统）。</td>
|
|
463
|
-
</tr>
|
|
464
|
-
|
|
465
|
-
<tr>
|
|
466
|
-
<td rowspan="1" colSpan="1" >[removeAllExcludedShareWindow](https://write.woa.com/document/87030026264555520)</td>
|
|
467
|
-
|
|
468
|
-
<td rowspan="1" colSpan="1" >将所有窗口从屏幕分享的排除列表中移除（该接口仅支持桌面系统）。</td>
|
|
469
|
-
</tr>
|
|
470
|
-
|
|
471
|
-
<tr>
|
|
472
|
-
<td rowspan="1" colSpan="1" >[addIncludedShareWindow](https://write.woa.com/document/87030026264555520)</td>
|
|
473
|
-
|
|
474
|
-
<td rowspan="1" colSpan="1" >将指定窗口加入屏幕分享的包含列表中（该接口仅支持桌面系统）。</td>
|
|
475
|
-
</tr>
|
|
476
|
-
|
|
477
|
-
<tr>
|
|
478
|
-
<td rowspan="1" colSpan="1" >[removeIncludedShareWindow](https://write.woa.com/document/87030026264555520)</td>
|
|
479
|
-
|
|
480
|
-
<td rowspan="1" colSpan="1" >将指定窗口从屏幕分享的包含列表中移除（该接口仅支持桌面系统）。</td>
|
|
481
|
-
</tr>
|
|
482
|
-
|
|
483
|
-
<tr>
|
|
484
|
-
<td rowspan="1" colSpan="1" >[removeAllIncludedShareWindow](https://write.woa.com/document/87030026264555520)</td>
|
|
485
|
-
|
|
486
|
-
<td rowspan="1" colSpan="1" >将全部窗口从屏幕分享的包含列表中移除（该接口仅支持桌面系统）。</td>
|
|
487
|
-
</tr>
|
|
488
|
-
|
|
489
|
-
<tr>
|
|
490
|
-
<td rowspan="1" colSpan="1" >[enableCustomVideoCapture](https://write.woa.com/document/87030026264555520)</td>
|
|
491
|
-
|
|
492
|
-
<td rowspan="1" colSpan="1" >启用/关闭视频自定义采集模式。</td>
|
|
493
|
-
</tr>
|
|
494
|
-
|
|
495
|
-
<tr>
|
|
496
|
-
<td rowspan="1" colSpan="1" >[sendCustomVideoData](https://write.woa.com/document/87030026264555520)</td>
|
|
497
|
-
|
|
498
|
-
<td rowspan="1" colSpan="1" >向 SDK 投送自己采集的视频帧。</td>
|
|
499
|
-
</tr>
|
|
500
|
-
|
|
501
|
-
<tr>
|
|
502
|
-
<td rowspan="1" colSpan="1" >[enableCustomAudioCapture](https://write.woa.com/document/87030026264555520)</td>
|
|
503
|
-
|
|
504
|
-
<td rowspan="1" colSpan="1" >启用音频自定义采集模式。</td>
|
|
505
|
-
</tr>
|
|
506
|
-
|
|
507
|
-
<tr>
|
|
508
|
-
<td rowspan="1" colSpan="1" >[sendCustomAudioData](https://write.woa.com/document/87030026264555520)</td>
|
|
509
|
-
|
|
510
|
-
<td rowspan="1" colSpan="1" >向 SDK 投送自己采集的音频数据。</td>
|
|
511
|
-
</tr>
|
|
512
|
-
|
|
513
|
-
<tr>
|
|
514
|
-
<td rowspan="1" colSpan="1" >[enableMixExternalAudioFrame](https://write.woa.com/document/87030026264555520)</td>
|
|
515
|
-
|
|
516
|
-
<td rowspan="1" colSpan="1" >启用/关闭自定义音轨。</td>
|
|
517
|
-
</tr>
|
|
518
|
-
|
|
519
|
-
<tr>
|
|
520
|
-
<td rowspan="1" colSpan="1" >[mixExternalAudioFrame](https://write.woa.com/document/87030026264555520)</td>
|
|
521
|
-
|
|
522
|
-
<td rowspan="1" colSpan="1" >向 SDK 混入自定义音轨。</td>
|
|
523
|
-
</tr>
|
|
524
|
-
|
|
525
|
-
<tr>
|
|
526
|
-
<td rowspan="1" colSpan="1" >[setMixExternalAudioVolume](https://write.woa.com/document/87030026264555520)</td>
|
|
527
|
-
|
|
528
|
-
<td rowspan="1" colSpan="1" >设置推流时混入外部音频的推流音量和播放音量。</td>
|
|
529
|
-
</tr>
|
|
530
|
-
|
|
531
|
-
<tr>
|
|
532
|
-
<td rowspan="1" colSpan="1" >[generateCustomPTS](https://write.woa.com/document/87030026264555520)</td>
|
|
533
|
-
|
|
534
|
-
<td rowspan="1" colSpan="1" >生成自定义采集时的时间戳。</td>
|
|
535
|
-
</tr>
|
|
536
|
-
|
|
537
|
-
<tr>
|
|
538
|
-
<td rowspan="1" colSpan="1" >[enableLocalVideoCustomProcess](https://write.woa.com/document/87030026264555520)</td>
|
|
539
|
-
|
|
540
|
-
<td rowspan="1" colSpan="1" >.1 开启视频第三方美颜。</td>
|
|
541
|
-
</tr>
|
|
542
|
-
|
|
543
|
-
<tr>
|
|
544
|
-
<td rowspan="1" colSpan="1" >[setLocalVideoCustomProcessCallback](https://write.woa.com/document/87030026264555520)</td>
|
|
545
|
-
|
|
546
|
-
<td rowspan="1" colSpan="1" >.2 设置第三方美颜的视频数据回调。</td>
|
|
547
|
-
</tr>
|
|
548
|
-
|
|
549
|
-
<tr>
|
|
550
|
-
<td rowspan="1" colSpan="1" >[setLocalVideoRenderCallback](https://write.woa.com/document/87030026264555520)</td>
|
|
551
|
-
|
|
552
|
-
<td rowspan="1" colSpan="1" >设置本地视频自定义渲染回调。</td>
|
|
553
|
-
</tr>
|
|
554
|
-
|
|
555
|
-
<tr>
|
|
556
|
-
<td rowspan="1" colSpan="1" >[setRemoteVideoRenderCallback](https://write.woa.com/document/87030026264555520)</td>
|
|
557
|
-
|
|
558
|
-
<td rowspan="1" colSpan="1" >设置远端视频自定义渲染回调。</td>
|
|
559
|
-
</tr>
|
|
560
|
-
|
|
561
|
-
<tr>
|
|
562
|
-
<td rowspan="1" colSpan="1" >[setAudioFrameCallback](https://write.woa.com/document/87030026264555520)</td>
|
|
563
|
-
|
|
564
|
-
<td rowspan="1" colSpan="1" >设置音频数据自定义回调。</td>
|
|
565
|
-
</tr>
|
|
566
|
-
|
|
567
|
-
<tr>
|
|
568
|
-
<td rowspan="1" colSpan="1" >[setCapturedAudioFrameCallbackFormat](https://write.woa.com/document/87030026264555520)</td>
|
|
569
|
-
|
|
570
|
-
<td rowspan="1" colSpan="1" >设置本地麦克风采集出的音频帧回调格式。</td>
|
|
571
|
-
</tr>
|
|
572
|
-
|
|
573
|
-
<tr>
|
|
574
|
-
<td rowspan="1" colSpan="1" >[setLocalProcessedAudioFrameCallbackFormat](https://write.woa.com/document/87030026264555520)</td>
|
|
575
|
-
|
|
576
|
-
<td rowspan="1" colSpan="1" >设置经过前处理后的本地音频帧回调格式。</td>
|
|
577
|
-
</tr>
|
|
578
|
-
|
|
579
|
-
<tr>
|
|
580
|
-
<td rowspan="1" colSpan="1" >[setMixedPlayAudioFrameCallbackFormat](https://write.woa.com/document/87030026264555520)</td>
|
|
581
|
-
|
|
582
|
-
<td rowspan="1" colSpan="1" >设置最终要由系统播放出的音频帧回调格式。</td>
|
|
583
|
-
</tr>
|
|
584
|
-
|
|
585
|
-
<tr>
|
|
586
|
-
<td rowspan="1" colSpan="1" >[enableCustomAudioRendering](https://write.woa.com/document/87030026264555520)</td>
|
|
587
|
-
|
|
588
|
-
<td rowspan="1" colSpan="1" >开启音频自定义播放。</td>
|
|
589
|
-
</tr>
|
|
590
|
-
|
|
591
|
-
<tr>
|
|
592
|
-
<td rowspan="1" colSpan="1" >[getCustomAudioRenderingFrame](https://write.woa.com/document/87030026264555520)</td>
|
|
593
|
-
|
|
594
|
-
<td rowspan="1" colSpan="1" >获取可播放的音频数据。</td>
|
|
595
|
-
</tr>
|
|
596
|
-
|
|
597
|
-
<tr>
|
|
598
|
-
<td rowspan="1" colSpan="1" >[sendCustomCmdMsg](https://write.woa.com/document/87030026264555520)</td>
|
|
599
|
-
|
|
600
|
-
<td rowspan="1" colSpan="1" >使用 UDP 通道发送自定义消息给房间内所有用户。</td>
|
|
601
|
-
</tr>
|
|
602
|
-
|
|
603
|
-
<tr>
|
|
604
|
-
<td rowspan="1" colSpan="1" >[sendSEIMsg](https://write.woa.com/document/87030026264555520)</td>
|
|
605
|
-
|
|
606
|
-
<td rowspan="1" colSpan="1" >使用 SEI 通道发送自定义消息给房间内所有用户。</td>
|
|
607
|
-
</tr>
|
|
608
|
-
|
|
609
|
-
<tr>
|
|
610
|
-
<td rowspan="1" colSpan="1" >[startSpeedTest](https://write.woa.com/document/87030026264555520)</td>
|
|
611
|
-
|
|
612
|
-
<td rowspan="1" colSpan="1" >开始进行网速测试（进入房间前使用）。</td>
|
|
613
|
-
</tr>
|
|
614
|
-
|
|
615
|
-
<tr>
|
|
616
|
-
<td rowspan="1" colSpan="1" >[stopSpeedTest](https://write.woa.com/document/87030026264555520)</td>
|
|
617
|
-
|
|
618
|
-
<td rowspan="1" colSpan="1" >停止网络测速。</td>
|
|
619
|
-
</tr>
|
|
620
|
-
|
|
621
|
-
<tr>
|
|
622
|
-
<td rowspan="1" colSpan="1" >[getSDKVersion](https://write.woa.com/document/87030026264555520)</td>
|
|
623
|
-
|
|
624
|
-
<td rowspan="1" colSpan="1" >获取 SDK 版本信息。</td>
|
|
625
|
-
</tr>
|
|
626
|
-
|
|
627
|
-
<tr>
|
|
628
|
-
<td rowspan="1" colSpan="1" >[setLogLevel](https://write.woa.com/document/87030026264555520)</td>
|
|
629
|
-
|
|
630
|
-
<td rowspan="1" colSpan="1" >设置 Log 输出级别。</td>
|
|
631
|
-
</tr>
|
|
632
|
-
|
|
633
|
-
<tr>
|
|
634
|
-
<td rowspan="1" colSpan="1" >[setConsoleEnabled](https://write.woa.com/document/87030026264555520)</td>
|
|
635
|
-
|
|
636
|
-
<td rowspan="1" colSpan="1" >启用/禁用控制台日志打印。</td>
|
|
637
|
-
</tr>
|
|
638
|
-
|
|
639
|
-
<tr>
|
|
640
|
-
<td rowspan="1" colSpan="1" >[setLogCompressEnabled](https://write.woa.com/document/87030026264555520)</td>
|
|
641
|
-
|
|
642
|
-
<td rowspan="1" colSpan="1" >启用/禁用日志的本地压缩。</td>
|
|
643
|
-
</tr>
|
|
644
|
-
|
|
645
|
-
<tr>
|
|
646
|
-
<td rowspan="1" colSpan="1" >[setLogDirPath](https://write.woa.com/document/87030026264555520)</td>
|
|
647
|
-
|
|
648
|
-
<td rowspan="1" colSpan="1" >设置本地日志的保存路径。</td>
|
|
649
|
-
</tr>
|
|
650
|
-
|
|
651
|
-
<tr>
|
|
652
|
-
<td rowspan="1" colSpan="1" >[setLogCallback](https://write.woa.com/document/87030026264555520)</td>
|
|
653
|
-
|
|
654
|
-
<td rowspan="1" colSpan="1" >设置日志回调。</td>
|
|
655
|
-
</tr>
|
|
656
|
-
|
|
657
|
-
<tr>
|
|
658
|
-
<td rowspan="1" colSpan="1" >[showDebugView](https://write.woa.com/document/87030026264555520)</td>
|
|
659
|
-
|
|
660
|
-
<td rowspan="1" colSpan="1" >显示仪表盘。</td>
|
|
661
|
-
</tr>
|
|
662
|
-
|
|
663
|
-
<tr>
|
|
664
|
-
<td rowspan="1" colSpan="1" >[callExperimentalAPI](https://write.woa.com/document/87030026264555520)</td>
|
|
665
|
-
|
|
666
|
-
<td rowspan="1" colSpan="1" >调用实验性接口。</td>
|
|
667
|
-
</tr>
|
|
668
|
-
|
|
669
|
-
<tr>
|
|
670
|
-
<td rowspan="1" colSpan="1" >[enablePayloadPrivateEncryption](https://write.woa.com/document/87030026264555520)</td>
|
|
671
|
-
|
|
672
|
-
<td rowspan="1" colSpan="1" >开启或关闭媒体流私有加密。</td>
|
|
673
|
-
</tr>
|
|
674
|
-
</table>
|
|
675
|
-
|
|
7
|
+
| 函数列表 | 描述 |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| getTRTCShareInstance | 创建 TRTCCloud 实例（单例模式）。 |
|
|
10
|
+
| destroyTRTCShareInstance | 销毁 TRTCCloud 实例（单例模式）。 |
|
|
11
|
+
| addCallback | 添加 TRTC 事件回调。 |
|
|
12
|
+
| removeCallback | 移除 TRTC 事件回调。 |
|
|
13
|
+
| enterRoom | 进入房间。 |
|
|
14
|
+
| exitRoom | 离开房间。 |
|
|
15
|
+
| switchRole | 切换角色。 |
|
|
16
|
+
| switchRole | 切换角色（支持设置权限位）。 |
|
|
17
|
+
| switchRoom | 切换房间。 |
|
|
18
|
+
| connectOtherRoom | 请求跨房通话。 |
|
|
19
|
+
| disconnectOtherRoom | 退出跨房通话。 |
|
|
20
|
+
| setDefaultStreamRecvMode | 设置订阅模式（需要在进入房前设置才能生效）。 |
|
|
21
|
+
| createSubCloud | 创建子房间实例（用于多房间并发观看）。 |
|
|
22
|
+
| destroySubCloud | 销毁子房间实例。 |
|
|
23
|
+
| updateOtherRoomForwardMode | 更改跨房主播在本房间的上行能力。 |
|
|
24
|
+
| startPublishMediaStream | 开始发布媒体流。 |
|
|
25
|
+
| updatePublishMediaStream | 更新发布媒体流。 |
|
|
26
|
+
| stopPublishMediaStream | 停止发布媒体流。 |
|
|
27
|
+
| startLocalPreview | 开启本地摄像头的预览画面（移动端）。 |
|
|
28
|
+
| startLocalPreview | 开启本地摄像头的预览画面（桌面端）。 |
|
|
29
|
+
| updateLocalView | 更新本地摄像头的预览画面。 |
|
|
30
|
+
| stopLocalPreview | 停止摄像头预览。 |
|
|
31
|
+
| muteLocalVideo | 暂停/恢复发布本地的视频流。 |
|
|
32
|
+
| setVideoMuteImage | 设置本地画面被暂停期间的替代图片。 |
|
|
33
|
+
| startRemoteView | 订阅远端用户的视频流，并绑定视频渲染控件。 |
|
|
34
|
+
| updateRemoteView | 更新远端用户的视频渲染控件。 |
|
|
35
|
+
| stopRemoteView | 停止订阅远端用户的视频流，并释放渲染控件。 |
|
|
36
|
+
| stopAllRemoteView | 停止订阅所有远端用户的视频流，并释放全部渲染资源。 |
|
|
37
|
+
| muteRemoteVideoStream | 暂停/恢复订阅远端用户的视频流。 |
|
|
38
|
+
| muteAllRemoteVideoStreams | 暂停/恢复订阅所有远端用户的视频流。 |
|
|
39
|
+
| setVideoEncoderParam | 设置视频编码器的编码参数。 |
|
|
40
|
+
| setNetworkQosParam | 设置网络质量控制的相关参数。 |
|
|
41
|
+
| setLocalRenderParams | 设置本地画面的渲染参数。 |
|
|
42
|
+
| setRemoteRenderParams | 设置远端画面的渲染模式。 |
|
|
43
|
+
| enableSmallVideoStream | 开启大小画面双路编码模式。 |
|
|
44
|
+
| setRemoteVideoStreamType | 切换指定远端用户的大小画面。 |
|
|
45
|
+
| snapshotVideo | 视频画面截图。 |
|
|
46
|
+
| setGravitySensorAdaptiveMode | 设置重力感应的适配模式（11.7 及以上版本）。 |
|
|
47
|
+
| startLocalAudio | 开启本地音频的采集和发布。 |
|
|
48
|
+
| stopLocalAudio | 停止本地音频的采集和发布。 |
|
|
49
|
+
| muteLocalAudio | 暂停/恢复发布本地的音频流。 |
|
|
50
|
+
| muteRemoteAudio | 暂停/恢复播放远端的音频流。 |
|
|
51
|
+
| muteAllRemoteAudio | 暂停/恢复播放所有远端用户的音频流。 |
|
|
52
|
+
| setRemoteAudioVolume | 设定某一个远端用户的声音播放音量。 |
|
|
53
|
+
| setAudioCaptureVolume | 设定本地音频的采集音量。 |
|
|
54
|
+
| getAudioCaptureVolume | 获取本地音频的采集音量。 |
|
|
55
|
+
| setAudioPlayoutVolume | 设定远端音频的播放音量。 |
|
|
56
|
+
| getAudioPlayoutVolume | 获取远端音频的播放音量。 |
|
|
57
|
+
| enableAudioVolumeEvaluation | 启用音量大小提示。 |
|
|
58
|
+
| startAudioRecording | 开始录音。 |
|
|
59
|
+
| stopAudioRecording | 停止录音。 |
|
|
60
|
+
| startLocalRecording | 开启本地媒体录制。 |
|
|
61
|
+
| stopLocalRecording | 停止本地媒体录制。 |
|
|
62
|
+
| setRemoteAudioParallelParams | 设置远端音频流智能并发播放策略。 |
|
|
63
|
+
| enable3DSpatialAudioEffect | 启用 3D 音效。 |
|
|
64
|
+
| updateSelf3DSpatialPosition | 设置 3D 音效中自身坐标及朝向信息。 |
|
|
65
|
+
| updateRemote3DSpatialPosition | 设置 3D 音效中远端用户坐标信息。 |
|
|
66
|
+
| set3DSpatialReceivingRange | 设置指定用户所发出声音的可被接收范围。 |
|
|
67
|
+
| getDeviceManager | 获取设备管理类（TXDeviceManager）。 |
|
|
68
|
+
| getBeautyManager | 获取美颜管理类（TXBeautyManager）。 |
|
|
69
|
+
| setWaterMark | 添加水印。 |
|
|
70
|
+
| getAudioEffectManager | 获取音效管理类（TXAudioEffectManager）。 |
|
|
71
|
+
| startSystemAudioLoopback | 开启系统声音采集（iOS 端暂未支持）。 |
|
|
72
|
+
| stopSystemAudioLoopback | 停止系统声音采集（iOS 端暂未支持）。 |
|
|
73
|
+
| setSystemAudioLoopbackVolume | 设置系统声音的采集音量。 |
|
|
74
|
+
| startScreenCapture | 启动屏幕分享。 |
|
|
75
|
+
| stopScreenCapture | 停止屏幕分享。 |
|
|
76
|
+
| pauseScreenCapture | 暂停屏幕分享。 |
|
|
77
|
+
| resumeScreenCapture | 恢复屏幕分享。 |
|
|
78
|
+
| getScreenCaptureSources | 枚举可分享的屏幕和窗口（该接口仅支持桌面系统）。 |
|
|
79
|
+
| selectScreenCaptureTarget | 选取要分享的屏幕或窗口（该接口仅支持桌面系统）。 |
|
|
80
|
+
| setSubStreamEncoderParam | 设置屏幕分享（即辅路）的视频编码参数（桌面系统和移动系统均已支持）。 |
|
|
81
|
+
| setSubStreamMixVolume | 设置屏幕分享时的混音音量大小（该接口仅支持桌面系统）。 |
|
|
82
|
+
| addExcludedShareWindow | 将指定窗口加入屏幕分享的排除列表中（该接口仅支持桌面系统）。 |
|
|
83
|
+
| removeExcludedShareWindow | 将指定窗口从屏幕分享的排除列表中移除（该接口仅支持桌面系统）。 |
|
|
84
|
+
| removeAllExcludedShareWindow | 将所有窗口从屏幕分享的排除列表中移除（该接口仅支持桌面系统）。 |
|
|
85
|
+
| addIncludedShareWindow | 将指定窗口加入屏幕分享的包含列表中（该接口仅支持桌面系统）。 |
|
|
86
|
+
| removeIncludedShareWindow | 将指定窗口从屏幕分享的包含列表中移除（该接口仅支持桌面系统）。 |
|
|
87
|
+
| removeAllIncludedShareWindow | 将全部窗口从屏幕分享的包含列表中移除（该接口仅支持桌面系统）。 |
|
|
88
|
+
| enableCustomVideoCapture | 启用/关闭视频自定义采集模式。 |
|
|
89
|
+
| sendCustomVideoData | 向 SDK 投送自己采集的视频帧。 |
|
|
90
|
+
| enableCustomAudioCapture | 启用音频自定义采集模式。 |
|
|
91
|
+
| sendCustomAudioData | 向 SDK 投送自己采集的音频数据。 |
|
|
92
|
+
| enableMixExternalAudioFrame | 启用/关闭自定义音轨。 |
|
|
93
|
+
| mixExternalAudioFrame | 向 SDK 混入自定义音轨。 |
|
|
94
|
+
| setMixExternalAudioVolume | 设置推流时混入外部音频的推流音量和播放音量。 |
|
|
95
|
+
| generateCustomPTS | 生成自定义采集时的时间戳。 |
|
|
96
|
+
| enableLocalVideoCustomProcess | .1 开启视频第三方美颜。 |
|
|
97
|
+
| setLocalVideoCustomProcessCallback | .2 设置第三方美颜的视频数据回调。 |
|
|
98
|
+
| setLocalVideoRenderCallback | 设置本地视频自定义渲染回调。 |
|
|
99
|
+
| setRemoteVideoRenderCallback | 设置远端视频自定义渲染回调。 |
|
|
100
|
+
| setAudioFrameCallback | 设置音频数据自定义回调。 |
|
|
101
|
+
| setCapturedAudioFrameCallbackFormat | 设置本地麦克风采集出的音频帧回调格式。 |
|
|
102
|
+
| setLocalProcessedAudioFrameCallbackFormat | 设置经过前处理后的本地音频帧回调格式。 |
|
|
103
|
+
| setMixedPlayAudioFrameCallbackFormat | 设置最终要由系统播放出的音频帧回调格式。 |
|
|
104
|
+
| enableCustomAudioRendering | 开启音频自定义播放。 |
|
|
105
|
+
| getCustomAudioRenderingFrame | 获取可播放的音频数据。 |
|
|
106
|
+
| sendCustomCmdMsg | 使用 UDP 通道发送自定义消息给房间内所有用户。 |
|
|
107
|
+
| sendSEIMsg | 使用 SEI 通道发送自定义消息给房间内所有用户。 |
|
|
108
|
+
| startSpeedTest | 开始进行网速测试（进入房间前使用）。 |
|
|
109
|
+
| stopSpeedTest | 停止网络测速。 |
|
|
110
|
+
| getSDKVersion | 获取 SDK 版本信息。 |
|
|
111
|
+
| setLogLevel | 设置 Log 输出级别。 |
|
|
112
|
+
| setConsoleEnabled | 启用/禁用控制台日志打印。 |
|
|
113
|
+
| setLogCompressEnabled | 启用/禁用日志的本地压缩。 |
|
|
114
|
+
| setLogDirPath | 设置本地日志的保存路径。 |
|
|
115
|
+
| setLogCallback | 设置日志回调。 |
|
|
116
|
+
| showDebugView | 显示仪表盘。 |
|
|
117
|
+
| callExperimentalAPI | 调用实验性接口。 |
|
|
118
|
+
| enablePayloadPrivateEncryption | 开启或关闭媒体流私有加密。 |
|
|
676
119
|
|
|
677
120
|
## getTRTCShareInstance
|
|
678
121
|
|
|
679
|
-
|
|
680
|
-
|
|
681
122
|
#### 创建 TRTCCloud 实例（单例模式）。
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
687
|
-
</tr>
|
|
688
|
-
|
|
689
|
-
<tr>
|
|
690
|
-
<td rowspan="1" colSpan="1" >context</td>
|
|
691
|
-
|
|
692
|
-
<td rowspan="1" colSpan="1" >仅适用于 Android 平台，SDK 内部会将其转化为 Android 平台的 ApplicationContext 用于调用 Android System API。<br>如果传入的 ` context ` 参数为空，SDK 内部会自动获取当前进程的 ApplicationContext。</td>
|
|
693
|
-
</tr>
|
|
694
|
-
</table>
|
|
695
|
-
|
|
123
|
+
| 参数 | 描述 |
|
|
124
|
+
| --- | --- |
|
|
125
|
+
| context | 仅适用于 Android 平台，SDK 内部会将其转化为 Android 平台的 ApplicationContext 用于调用 Android System API。<br>如果传入的 ` context ` 参数为空，SDK 内部会自动获取当前进程的 ApplicationContext。 |
|
|
696
126
|
|
|
697
127
|
> **注意**
|
|
698
|
-
>
|
|
128
|
+
>
|
|
699
129
|
|
|
700
|
-
> 1. 如果您使用 ` delete ITRTCCloud* ` 会导致编译错误，请使用
|
|
701
|
-
>
|
|
130
|
+
> 1. 如果您使用 ` delete ITRTCCloud* ` 会导致编译错误，请使用 destroyTRTCShareInstance 释放对象指针。
|
|
131
|
+
>
|
|
702
132
|
|
|
703
133
|
> 2. 在 Windows、Mac 和 iOS 平台上，请调用 ` getTRTCShareInstance() ` 接口。
|
|
704
|
-
>
|
|
134
|
+
>
|
|
705
135
|
|
|
706
136
|
> 3. 在 Android 平台上，请调用 ` getTRTCShareInstance(void *context) ` 接口。
|
|
707
|
-
>
|
|
708
|
-
|
|
137
|
+
>
|
|
709
138
|
|
|
710
139
|
## destroyTRTCShareInstance
|
|
711
140
|
|
|
712
|
-
|
|
713
|
-
|
|
714
141
|
#### 销毁 TRTCCloud 实例（单例模式）。
|
|
715
142
|
|
|
716
143
|
## addCallback
|
|
717
144
|
|
|
718
|
-
|
|
719
|
-
|
|
720
145
|
#### 添加 TRTC 事件回调。
|
|
721
146
|
|
|
722
|
-
您可以通过
|
|
147
|
+
您可以通过 ITRTCCloudCallback 获得来自 SDK 的各类事件通知（例如：错误码，警告码，音视频状态参数等）。
|
|
723
148
|
|
|
724
149
|
## removeCallback
|
|
725
150
|
|
|
726
|
-
|
|
727
|
-
|
|
728
151
|
#### 移除 TRTC 事件回调。
|
|
729
152
|
|
|
730
153
|
## enterRoom
|
|
731
154
|
|
|
732
|
-
|
|
733
|
-
|
|
734
155
|
#### 进入房间。
|
|
735
156
|
|
|
736
157
|
TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视频流，“发布”是指将自己的音频和视频推送到云端，“订阅”是指从云端拉取房间里其他用户的音视频流。
|
|
737
158
|
|
|
738
|
-
调用该接口时，您需要指定您的应用场景
|
|
739
|
-
|
|
740
|
-
|
|
159
|
+
调用该接口时，您需要指定您的应用场景 TRTCAppScene 以获取最佳的音视频传输体验，这些场景可以分成两大类：
|
|
741
160
|
|
|
742
161
|
**实时通话：**
|
|
743
162
|
|
|
744
|
-
包括
|
|
745
|
-
|
|
746
|
-
|
|
163
|
+
包括 TRTCAppSceneVideoCall 和 TRTCAppSceneAudioCall 两个可选项，分别是视频通话和语音通话，该模式适合 1对1 的音视频通话，或者参会人数在 300 人以内的在线会议。
|
|
747
164
|
|
|
748
165
|
**在线直播：**
|
|
749
166
|
|
|
750
|
-
包括
|
|
751
|
-
|
|
167
|
+
包括 TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom 两个可选项，分别是视频直播和语音直播，该模式适合十万人以内的在线直播场景，但需要您在接下来介绍的 TRTCParams 参数中指定 **角色(role)** 这个字段，也就是将房间中的用户区分为 **主播** (TRTCRoleAnchor) 和 **观众** (TRTCRoleAudience) 两种不同的角色。
|
|
752
168
|
|
|
753
|
-
|
|
754
|
-
调用该接口后，您会收到来自 [ITRTCCloudCallback](https://write.woa.com/document/87030021158866944) 中的 [onEnterRoom](https://write.woa.com/document/87030021158866944) 回调：
|
|
169
|
+
调用该接口后，您会收到来自 ITRTCCloudCallback 中的 onEnterRoom 回调：
|
|
755
170
|
- 如果进房成功，参数 ` result ` 会是一个正数（result > 0），表示从函数调用到进入房间所花费的时间，单位是毫秒（ms）。
|
|
756
171
|
|
|
757
172
|
- 如果进房失败，参数 ` result ` 会是一个负数（result < 0），表示进房失败的[错误码](https://cloud.tencent.com/document/product/647/32257)。
|
|
758
173
|
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
764
|
-
</tr>
|
|
765
|
-
|
|
766
|
-
<tr>
|
|
767
|
-
<td rowspan="1" colSpan="1" >param</td>
|
|
768
|
-
|
|
769
|
-
<td rowspan="1" colSpan="1" >进房参数，用于指定用户的身份、角色和安全票据等信息，详情请参见 [TRTCParams](https://write.woa.com/document/87030132707430400) 。</td>
|
|
770
|
-
</tr>
|
|
771
|
-
|
|
772
|
-
<tr>
|
|
773
|
-
<td rowspan="1" colSpan="1" >scene</td>
|
|
774
|
-
|
|
775
|
-
<td rowspan="1" colSpan="1" >应用场景，用于指定您的业务场景，同一个房间内的所有用户需要设定相同的 [TRTCAppScene](https://write.woa.com/document/87030132707430400)。</td>
|
|
776
|
-
</tr>
|
|
777
|
-
</table>
|
|
778
|
-
|
|
174
|
+
| 参数 | 描述 |
|
|
175
|
+
| --- | --- |
|
|
176
|
+
| param | 进房参数，用于指定用户的身份、角色和安全票据等信息，详情请参见 TRTCParams 。 |
|
|
177
|
+
| scene | 应用场景，用于指定您的业务场景，同一个房间内的所有用户需要设定相同的 TRTCAppScene。 |
|
|
779
178
|
|
|
780
179
|
> **注意**
|
|
781
|
-
>
|
|
180
|
+
>
|
|
782
181
|
|
|
783
182
|
> 1. 同一个房间内的所有用户需要设定相同的 ` scene `。不同的 ` scene ` 会导致偶现的异常问题。
|
|
784
|
-
>
|
|
183
|
+
>
|
|
785
184
|
|
|
786
|
-
> 2. 当您指定参数 ` scene ` 为
|
|
787
|
-
>
|
|
788
|
-
|
|
789
|
-
> 3. 请您尽量保证 [enterRoom](https://write.woa.com/document/87030026264555520) 与 [exitRoom](https://write.woa.com/document/87030026264555520) 前后配对使用，即保证“先退出前一个房间再进入下一个房间”，否则会导致很多异常问题。
|
|
790
|
-
>
|
|
185
|
+
> 2. 当您指定参数 ` scene ` 为 TRTCAppSceneLIVE 或 TRTCAppSceneVoiceChatRoom 时，您必须通过 TRTCParams 中的 ` role `字段为当前用户设定他/她在房间中的角色。
|
|
186
|
+
>
|
|
791
187
|
|
|
188
|
+
> 3. 请您尽量保证 enterRoom 与 exitRoom 前后配对使用，即保证“先退出前一个房间再进入下一个房间”，否则会导致很多异常问题。
|
|
189
|
+
>
|
|
792
190
|
|
|
793
191
|
## exitRoom
|
|
794
192
|
|
|
795
|
-
|
|
796
|
-
|
|
797
193
|
#### 离开房间。
|
|
798
194
|
|
|
799
195
|
调用该接口会让用户离开自己所在的音视频房间，并释放摄像头、麦克风、扬声器等设备资源。
|
|
800
196
|
|
|
801
|
-
等资源释放完毕之后，SDK 会通过
|
|
802
|
-
|
|
197
|
+
等资源释放完毕之后，SDK 会通过 ITRTCCloudCallback 中的 onExitRoom 回调向您通知。
|
|
803
198
|
|
|
804
|
-
|
|
805
|
-
如果您要再次调用 [enterRoom](https://write.woa.com/document/87030026264555520) 或者切换到其他的供应商的 SDK，建议等待 [onExitRoom](https://write.woa.com/document/87030021158866944) 回调到来之后再执行之后的操作，以避免摄像头或麦克风被占用的问题。
|
|
199
|
+
如果您要再次调用 enterRoom 或者切换到其他的供应商的 SDK，建议等待 onExitRoom 回调到来之后再执行之后的操作，以避免摄像头或麦克风被占用的问题。
|
|
806
200
|
|
|
807
201
|
## switchRole
|
|
808
202
|
|
|
809
|
-
|
|
810
|
-
|
|
811
203
|
#### 切换角色。
|
|
812
204
|
|
|
813
205
|
调用本接口可以实现用户在“主播”和“观众”两种角色之间来回切换。
|
|
814
206
|
|
|
815
|
-
|
|
816
|
-
|
|
817
207
|
由于视频直播和语音聊天室需要支持多达10万名观众同时观看，所以设定了 **只有主播才能发布自己的音视频** 的规则。因此，当有些观众希望发布自己的音视频流（以便能跟主播互动）时，就需要先把自己的角色切换成 **主播**。
|
|
818
208
|
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
<tr>
|
|
824
|
-
<td rowspan="1" colSpan="1" >参数</td>
|
|
825
|
-
|
|
826
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
827
|
-
</tr>
|
|
828
|
-
|
|
829
|
-
<tr>
|
|
830
|
-
<td rowspan="1" colSpan="1" >role</td>
|
|
831
|
-
|
|
832
|
-
<td rowspan="1" colSpan="1" >角色，默认为 **主播**。<br>- [TRTCRoleAnchor](https://write.woa.com/document/87030132707430400) ：主播，可以发布自己的音视频，同一个房间里最多支持50个主播同时发布音视频。<br>- [TRTCRoleAudience](https://write.woa.com/document/87030132707430400) ：观众，不能发布自己的音视频流，只能观看房间中其他主播的音视频。如果要发布自己的音视频，需要先通过 [switchRole](https://write.woa.com/document/87030026264555520) 切换成 **主播**，同一个房间内同时最多可以容纳 10 万名观众。</td>
|
|
833
|
-
</tr>
|
|
834
|
-
</table>
|
|
835
|
-
|
|
209
|
+
您可以在进入房间时通过 TRTCParams 中的 ` role ` 字段事先确定用户的角色，也可以在进入房间后通过该接口动态切换角色。
|
|
210
|
+
| 参数 | 描述 |
|
|
211
|
+
| --- | --- |
|
|
212
|
+
| role | 角色，默认为 **主播**。<br>- TRTCRoleAnchor ：主播，可以发布自己的音视频，同一个房间里最多支持50个主播同时发布音视频。<br>- TRTCRoleAudience ：观众，不能发布自己的音视频流，只能观看房间中其他主播的音视频。如果要发布自己的音视频，需要先通过 switchRole 切换成 **主播**，同一个房间内同时最多可以容纳 10 万名观众。 |
|
|
836
213
|
|
|
837
214
|
> **注意**
|
|
838
|
-
>
|
|
839
|
-
|
|
840
|
-
> 1. 该接口仅适用于视频直播（[TRTCAppSceneLIVE](https://write.woa.com/document/87030132707430400)）和语音聊天室（[TRTCAppSceneVoiceChatRoom](https://write.woa.com/document/87030132707430400)）这两个场景。
|
|
841
|
-
>
|
|
215
|
+
>
|
|
842
216
|
|
|
843
|
-
>
|
|
844
|
-
>
|
|
217
|
+
> 1. 该接口仅适用于视频直播（TRTCAppSceneLIVE）和语音聊天室（TRTCAppSceneVoiceChatRoom）这两个场景。
|
|
218
|
+
>
|
|
845
219
|
|
|
220
|
+
> 2. 如果您在调用 enterRoom 时指定的 ` scene ` 为 TRTCAppSceneVideoCall 或 TRTCAppSceneAudioCall，请不要调用这个接口。
|
|
221
|
+
>
|
|
846
222
|
|
|
847
223
|
## switchRole
|
|
848
224
|
|
|
849
|
-
|
|
850
|
-
|
|
851
225
|
#### 切换角色（支持设置权限位）。
|
|
852
226
|
|
|
853
227
|
调用本接口可以实现用户在“主播”和“观众”两种角色之间来回切换。
|
|
854
228
|
|
|
855
|
-
|
|
856
|
-
|
|
857
229
|
由于视频直播和语音聊天室需要支持多达10万名观众同时观看，所以设定了 **只有主播才能发布自己的音视频** 的规则。因此，当有些观众希望发布自己的音视频流（以便能跟主播互动）时，就需要先把自己的角色切换成 **主播**。
|
|
858
230
|
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
864
|
-
<td rowspan="1" colSpan="1" >参数</td>
|
|
865
|
-
|
|
866
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
867
|
-
</tr>
|
|
868
|
-
|
|
869
|
-
<tr>
|
|
870
|
-
<td rowspan="1" colSpan="1" >privateMapKey</td>
|
|
871
|
-
|
|
872
|
-
<td rowspan="1" colSpan="1" >用于权限控制的权限票据，当您希望某个房间只能让特定的 userId 进入或者上行视频时，需要使用 ` privateMapKey ` 进行权限保护。<br>- 仅建议有高级别安全需求的客户使用，更多详情请参见 [开启高级权限控制](https://cloud.tencent.com/document/product/647/32240)。</td>
|
|
873
|
-
</tr>
|
|
874
|
-
|
|
875
|
-
<tr>
|
|
876
|
-
<td rowspan="1" colSpan="1" >role</td>
|
|
877
|
-
|
|
878
|
-
<td rowspan="1" colSpan="1" >角色，默认为 **主播**。<br>- [TRTCRoleAnchor](https://write.woa.com/document/87030132707430400) ：主播，可以发布自己的音视频，同一个房间里最多支持50个主播同时发布音视频。<br>- [TRTCRoleAudience](https://write.woa.com/document/87030132707430400) ：观众，不能发布自己的音视频流，只能观看房间中其他主播的音视频。如果要发布自己的音视频，需要先通过 [switchRole](https://write.woa.com/document/87030026264555520) 切换成 **主播**，同一个房间内同时最多可以容纳 10 万名观众。</td>
|
|
879
|
-
</tr>
|
|
880
|
-
</table>
|
|
881
|
-
|
|
231
|
+
您可以在进入房间时通过 TRTCParams 中的 ` role ` 字段事先确定用户的角色，也可以在进入房间后通过该接口动态切换角色。
|
|
232
|
+
| 参数 | 描述 |
|
|
233
|
+
| --- | --- |
|
|
234
|
+
| privateMapKey | 用于权限控制的权限票据，当您希望某个房间只能让特定的 userId 进入或者上行视频时，需要使用 ` privateMapKey ` 进行权限保护。<br>- 仅建议有高级别安全需求的客户使用，更多详情请参见 [开启高级权限控制](https://cloud.tencent.com/document/product/647/32240)。 |
|
|
235
|
+
| role | 角色，默认为 **主播**。<br>- TRTCRoleAnchor ：主播，可以发布自己的音视频，同一个房间里最多支持50个主播同时发布音视频。<br>- TRTCRoleAudience ：观众，不能发布自己的音视频流，只能观看房间中其他主播的音视频。如果要发布自己的音视频，需要先通过 switchRole 切换成 **主播**，同一个房间内同时最多可以容纳 10 万名观众。 |
|
|
882
236
|
|
|
883
237
|
> **注意**
|
|
884
|
-
>
|
|
885
|
-
|
|
886
|
-
> 1. 该接口仅适用于视频直播（[TRTCAppSceneLIVE](https://write.woa.com/document/87030132707430400)）和语音聊天室（[TRTCAppSceneVoiceChatRoom](https://write.woa.com/document/87030132707430400)）这两个场景。
|
|
887
|
-
>
|
|
238
|
+
>
|
|
888
239
|
|
|
889
|
-
>
|
|
890
|
-
>
|
|
240
|
+
> 1. 该接口仅适用于视频直播（TRTCAppSceneLIVE）和语音聊天室（TRTCAppSceneVoiceChatRoom）这两个场景。
|
|
241
|
+
>
|
|
891
242
|
|
|
243
|
+
> 2. 如果您在 enterRoom 时指定的 ` scene ` 为 TRTCAppSceneVideoCall 或 TRTCAppSceneAudioCall，请不要调用这个接口。
|
|
244
|
+
>
|
|
892
245
|
|
|
893
246
|
## switchRoom
|
|
894
247
|
|
|
895
|
-
|
|
896
|
-
|
|
897
248
|
#### 切换房间。
|
|
898
249
|
|
|
899
250
|
使用该接口可以让用户快速从一个房间切换到另一个房间。
|
|
900
251
|
- 如果用户的身份是“观众”，该接口的调用效果等同于 ` exitRoom(当前房间) + enterRoom（新的房间） `。
|
|
901
252
|
|
|
902
|
-
- 如果用户的身份是“主播”，该接口在切换房间的同时还会保持自己的音视频发布状态，因此在房间切换过程中，摄像头的预览和声音的采集都不会中断。
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
|
|
906
|
-
|
|
907
|
-
该接口适用于在线教育场景中，监课老师在多个房间中进行快速切换的场景。在该场景下使用 ` switchRoom ` 可以获得比 ` exitRoom + enterRoom ` 更好的流畅性和更少的代码量。
|
|
908
|
-
|
|
909
|
-
接口调用结果会通过 [ITRTCCloudCallback](https://write.woa.com/document/87030021158866944) 中的 [onSwitchRoom](https://write.woa.com/document/87030021158866944) 回调。
|
|
910
|
-
<table>
|
|
911
|
-
<tr>
|
|
912
|
-
<td rowspan="1" colSpan="1" >参数</td>
|
|
913
|
-
|
|
914
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
915
|
-
</tr>
|
|
916
|
-
|
|
917
|
-
<tr>
|
|
918
|
-
<td rowspan="1" colSpan="1" >config</td>
|
|
253
|
+
- 如果用户的身份是“主播”，该接口在切换房间的同时还会保持自己的音视频发布状态，因此在房间切换过程中，摄像头的预览和声音的采集都不会中断。
|
|
919
254
|
|
|
920
|
-
|
|
921
|
-
</tr>
|
|
922
|
-
</table>
|
|
255
|
+
该接口适用于在线教育场景中，监课老师在多个房间中进行快速切换的场景。在该场景下使用 ` switchRoom ` 可以获得比 ` exitRoom + enterRoom ` 更好的流畅性和更少的代码量。
|
|
923
256
|
|
|
257
|
+
接口调用结果会通过 ITRTCCloudCallback 中的 onSwitchRoom 回调。
|
|
258
|
+
| 参数 | 描述 |
|
|
259
|
+
| --- | --- |
|
|
260
|
+
| config | 房间参数，详情请参见 TRTCSwitchRoomConfig。 |
|
|
924
261
|
|
|
925
262
|
> **注意**
|
|
926
|
-
>
|
|
263
|
+
>
|
|
927
264
|
|
|
928
265
|
> 由于对老版本 SDK 兼容的需求，参数 ` config ` 中同时包含 ` roomId ` 与 ` strRoomId ` 两个参数，这两个参数的填写格外讲究，请注意如下事项：
|
|
929
|
-
>
|
|
266
|
+
>
|
|
930
267
|
|
|
931
268
|
> 1. 若您选用 ` strRoomId `，则 ` roomId ` 需要填写为0。若两者都填，将优先选用 ` roomId `。
|
|
932
|
-
>
|
|
269
|
+
>
|
|
933
270
|
|
|
934
271
|
> 2. 所有房间需要同时使用 ` strRoomId ` 或同时使用 ` roomId `，不可混用，否则将会出现很多预期之外的 bug。
|
|
935
|
-
>
|
|
936
|
-
|
|
272
|
+
>
|
|
937
273
|
|
|
938
274
|
## connectOtherRoom
|
|
939
275
|
|
|
940
|
-
|
|
941
|
-
|
|
942
276
|
#### 请求跨房通话。
|
|
943
277
|
|
|
944
278
|
默认情况下，只有同一个房间中的用户之间可以进行音视频通话，不同的房间之间的音视频流是相互隔离的。
|
|
945
279
|
|
|
946
280
|
但您可以通过调用该接口，将另一个房间中某个主播音视频流发布到自己所在的房间中，与此同时，该接口也会将自己的音视频流发布到目标主播的房间中。
|
|
947
281
|
|
|
948
|
-
|
|
949
|
-
|
|
950
282
|
也就是说，您可以使用该接口让身处两个不同房间中的主播进行跨房间的音视频流分享，从而让每个房间中的观众都能观看到这两个主播的音视频。该功能可以用来实现主播之间的 PK 功能。
|
|
951
283
|
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
跨房通话的请求结果会通过 [ITRTCCloudCallback](https://write.woa.com/document/87030021158866944) 中的 [onConnectOtherRoom](https://write.woa.com/document/87030021158866944) 回调通知给您。
|
|
955
|
-
|
|
956
|
-
|
|
284
|
+
跨房通话的请求结果会通过 ITRTCCloudCallback 中的 onConnectOtherRoom 回调通知给您。
|
|
957
285
|
|
|
958
286
|
例如：当房间“101”中的主播 A 通过 ` connectOtherRoom() ` 跟房间“102”中的主播 B 建立跨房通话后，
|
|
959
287
|
- 房间“101”中的用户都会收到主播 B 的 ` onRemoteUserEnterRoom(B) ` 和 ` onUserVideoAvailable(B,true) ` 这两个事件回调，即房间“101”中的用户都可以订阅主播 B 的音视频。
|
|
960
288
|
|
|
961
289
|
- 房间“102”中的用户都会收到主播 A 的 ` onRemoteUserEnterRoom(A) ` 和 ` onUserVideoAvailable(A,true) ` 这两个事件回调，即房间“102”中的用户都可以订阅主播 A 的音视频。
|
|
962
290
|
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
291
|
跨房通话的参数考虑到后续扩展字段的兼容性问题，暂时采用了 JSON 格式的参数：
|
|
969
292
|
|
|
970
|
-
|
|
971
|
-
|
|
972
293
|
**情况一：数字房间号**
|
|
973
294
|
|
|
974
295
|
如果房间“101”中的主播 A 要跟房间“102”中的主播 B 连麦，那么主播 A 调用该接口时需要传入：` {"roomId": 102, "userId": "userB"} `
|
|
@@ -983,8 +304,6 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
983
304
|
trtc.connectOtherRoom(params.c_str());
|
|
984
305
|
```
|
|
985
306
|
|
|
986
|
-
|
|
987
|
-
|
|
988
307
|
**情况二：字符串房间号**
|
|
989
308
|
|
|
990
309
|
如果您使用的是字符串房间号，务必请将 json 中的 “roomId” 替换成 “strRoomId”: ` {"strRoomId": "102", "userId": "userB"} `
|
|
@@ -998,97 +317,54 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
998
317
|
std::string params = writer.write(jsonObj);
|
|
999
318
|
trtc.connectOtherRoom(params.c_str());
|
|
1000
319
|
```
|
|
1001
|
-
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1006
|
-
</tr>
|
|
1007
|
-
|
|
1008
|
-
<tr>
|
|
1009
|
-
<td rowspan="1" colSpan="1" >param</td>
|
|
1010
|
-
|
|
1011
|
-
<td rowspan="1" colSpan="1" >需要您传入 JSON 格式的字符串参数，` roomId ` 代表数字格式的房间号，` strRoomId ` 代表字符串格式的房间号，` userId ` 代表目标主播的用户 ID。</td>
|
|
1012
|
-
</tr>
|
|
1013
|
-
</table>
|
|
1014
|
-
|
|
320
|
+
| 参数 | 描述 |
|
|
321
|
+
| --- | --- |
|
|
322
|
+
| param | 需要您传入 JSON 格式的字符串参数，` roomId ` 代表数字格式的房间号，` strRoomId ` 代表字符串格式的房间号，` userId ` 代表目标主播的用户 ID。 |
|
|
1015
323
|
|
|
1016
324
|
## disconnectOtherRoom
|
|
1017
325
|
|
|
1018
|
-
|
|
1019
|
-
|
|
1020
326
|
#### 退出跨房通话。
|
|
1021
327
|
|
|
1022
|
-
退出结果会通过
|
|
328
|
+
退出结果会通过 ITRTCCloudCallback 中的 onDisconnectOtherRoom 回调通知给您。
|
|
1023
329
|
|
|
1024
330
|
## setDefaultStreamRecvMode
|
|
1025
331
|
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
332
|
#### 设置订阅模式（需要在进入房前设置才能生效）。
|
|
1029
333
|
|
|
1030
334
|
您可以通过该接口在“自动订阅”和“手动订阅”两种模式下进行切换：
|
|
1031
|
-
- 自动订阅：默认模式，用户在进入房间后会立刻接收到该房间中的音视频流，音频会自动播放，视频会自动开始解码（依然需要您通过
|
|
1032
|
-
|
|
1033
|
-
- 手动订阅：在用户进入房间后，需要手动调用 [startRemoteView](https://write.woa.com/document/87030026264555520) 接口才能启动视频流的订阅和解码，需要手动调用 [muteRemoteAudio](https://write.woa.com/document/87030026264555520) (false) 接口才能启动声音的播放。
|
|
1034
|
-
|
|
1035
|
-
|
|
335
|
+
- 自动订阅：默认模式，用户在进入房间后会立刻接收到该房间中的音视频流，音频会自动播放，视频会自动开始解码（依然需要您通过 startRemoteView 接口绑定渲染控件）。
|
|
1036
336
|
|
|
337
|
+
- 手动订阅：在用户进入房间后，需要手动调用 startRemoteView 接口才能启动视频流的订阅和解码，需要手动调用 muteRemoteAudio (false) 接口才能启动声音的播放。
|
|
1037
338
|
|
|
1038
339
|
在绝大多数场景下，用户进入房间后都会订阅房间中所有主播的音视频流，因此 TRTC 默认采用了自动订阅模式，以求得最佳的“秒开体验”。
|
|
1039
340
|
|
|
1040
341
|
如果您的应用场景中每个房间同时会有很多路音视频流在发布，而每个用户只想选择性地订阅其中的 1-2 路，则推荐使用“手动订阅”模式以节省流量费用。
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1046
|
-
</tr>
|
|
1047
|
-
|
|
1048
|
-
<tr>
|
|
1049
|
-
<td rowspan="1" colSpan="1" >autoRecvAudio</td>
|
|
1050
|
-
|
|
1051
|
-
<td rowspan="1" colSpan="1" >true：自动订阅音频；false：需手动调用 ` muteRemoteAudio(false) ` 订阅音频。默认值：true。</td>
|
|
1052
|
-
</tr>
|
|
1053
|
-
|
|
1054
|
-
<tr>
|
|
1055
|
-
<td rowspan="1" colSpan="1" >autoRecvVideo</td>
|
|
1056
|
-
|
|
1057
|
-
<td rowspan="1" colSpan="1" >true：自动订阅视频；false：需手动调用 ` startRemoteView ` 订阅视频。默认值：true。</td>
|
|
1058
|
-
</tr>
|
|
1059
|
-
</table>
|
|
1060
|
-
|
|
342
|
+
| 参数 | 描述 |
|
|
343
|
+
| --- | --- |
|
|
344
|
+
| autoRecvAudio | true：自动订阅音频；false：需手动调用 ` muteRemoteAudio(false) ` 订阅音频。默认值：true。 |
|
|
345
|
+
| autoRecvVideo | true：自动订阅视频；false：需手动调用 ` startRemoteView ` 订阅视频。默认值：true。 |
|
|
1061
346
|
|
|
1062
347
|
> **注意**
|
|
1063
|
-
>
|
|
348
|
+
>
|
|
1064
349
|
|
|
1065
350
|
> 1. 需要在进入房间前调用该接口进行设置才能生效。
|
|
1066
|
-
>
|
|
1067
|
-
|
|
1068
|
-
> 2. 在自动订阅模式下，如果用户在进入房间后没有调用 [startRemoteView](https://write.woa.com/document/87030026264555520) 订阅视频流，SDK 会自动停止订阅视频流，以便达到节省流量的目的。
|
|
1069
|
-
>
|
|
351
|
+
>
|
|
1070
352
|
|
|
353
|
+
> 2. 在自动订阅模式下，如果用户在进入房间后没有调用 startRemoteView 订阅视频流，SDK 会自动停止订阅视频流，以便达到节省流量的目的。
|
|
354
|
+
>
|
|
1071
355
|
|
|
1072
356
|
## createSubCloud
|
|
1073
357
|
|
|
1074
|
-
|
|
1075
|
-
|
|
1076
358
|
#### 创建子房间实例（用于多房间并发观看）。
|
|
1077
359
|
|
|
1078
360
|
TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的能力。
|
|
1079
361
|
|
|
1080
362
|
通过调用该接口，您可以创建出多个 TRTCCloud 实例，以便同时进入多个不同的房间观看音视频流。
|
|
1081
363
|
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
364
|
但需要注意的是，您在多个 TRTCCloud 实例中发布音视频流的能力会受到一定限制。
|
|
1085
365
|
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
366
|
该功能主要用于在线教育场景中一种被称为“超级小班课”的业务场景中，用于解决“每个 TRTC 的房间中最多只能有 50 人同时发布自己音视频流”的限制。
|
|
1089
367
|
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
368
|
示例代码如下：
|
|
1093
369
|
``` cpp
|
|
1094
370
|
//In the small room that needs interaction, enter the room as an anchor and push audio and video streams
|
|
@@ -1100,7 +376,7 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
|
|
|
1100
376
|
//...
|
|
1101
377
|
mainCloud->startLocalAudio(TRTCAudioQualityDefault);
|
|
1102
378
|
mainCloud->startLocalPreview(renderView);
|
|
1103
|
-
|
|
379
|
+
|
|
1104
380
|
//In the large room that only needs to watch, enter the room as an audience and pull audio and video streams
|
|
1105
381
|
ITRTCCloud *subCloud = mainCloud->createSubCloud();
|
|
1106
382
|
TRTCParams subParams;
|
|
@@ -1116,22 +392,21 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
|
|
|
1116
392
|
```
|
|
1117
393
|
|
|
1118
394
|
> **注意**
|
|
1119
|
-
>
|
|
395
|
+
>
|
|
1120
396
|
|
|
1121
397
|
> 1. 同一个用户，可以使用同一个 userId 进入多个不同 roomId 的房间。
|
|
1122
|
-
>
|
|
398
|
+
>
|
|
1123
399
|
|
|
1124
400
|
> 2. 两台不同的终端设备不可以同时使用同一个 userId 进入同一个 roomId 的房间。
|
|
1125
|
-
>
|
|
401
|
+
>
|
|
1126
402
|
|
|
1127
|
-
> 3. 您可以分别为不同实例分别设置
|
|
1128
|
-
>
|
|
403
|
+
> 3. 您可以分别为不同实例分别设置 ITRTCCloudCallback 获取各自的事件通知。
|
|
404
|
+
>
|
|
1129
405
|
|
|
1130
406
|
> 4. 同一个用户可以在多个 TRTCCloud 实例中推流，也可以调用子实例中与本地音视频相关的接口。但需要注意：
|
|
1131
|
-
>
|
|
407
|
+
>
|
|
1132
408
|
> - 多实例的音频需要同时为麦克风采集或自定义采集，而且与音频设备相关的接口调用会以最后一次为准；
|
|
1133
|
-
> - 与摄像头相关的调用会以最后一次为准：
|
|
1134
|
-
|
|
409
|
+
> - 与摄像头相关的调用会以最后一次为准：startLocalPreview。
|
|
1135
410
|
|
|
1136
411
|
#### 返回值说明：
|
|
1137
412
|
|
|
@@ -1139,62 +414,35 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
|
|
|
1139
414
|
|
|
1140
415
|
## destroySubCloud
|
|
1141
416
|
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
417
|
#### 销毁子房间实例。
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1150
|
-
</tr>
|
|
1151
|
-
|
|
1152
|
-
<tr>
|
|
1153
|
-
<td rowspan="1" colSpan="1" >subCloud</td>
|
|
1154
|
-
|
|
1155
|
-
<td rowspan="1" colSpan="1" >子房间实例</td>
|
|
1156
|
-
</tr>
|
|
1157
|
-
</table>
|
|
1158
|
-
|
|
418
|
+
| 参数 | 描述 |
|
|
419
|
+
| --- | --- |
|
|
420
|
+
| subCloud | 子房间实例 |
|
|
1159
421
|
|
|
1160
422
|
## updateOtherRoomForwardMode
|
|
1161
423
|
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
424
|
#### 更改跨房主播在本房间的上行能力。
|
|
1165
425
|
|
|
1166
|
-
通常情况下，在调用
|
|
426
|
+
通常情况下，在调用 connectOtherRoom 接口与另一个房间的主播进行跨房通话后，本房间内的所有观众都将收到该主播发布的音视频流。
|
|
1167
427
|
|
|
1168
428
|
您可以通过调用该接口，限制跨房主播在本房间内的上行能力，禁止或允许跨房主播发布音频/主路视频/辅路视频，该行为会影响房间内的所有用户。
|
|
1169
429
|
|
|
1170
430
|
在禁用跨房主播某种上行能力后，本房间内所有用户将无法收到对应音视频流，且无法再订阅对应的音视频。
|
|
1171
431
|
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
432
|
需要注意的是，该接口只能由进行跨房通话的主播调用，且通过该接口设置的限制会因为跨房通话的中断或对应主播退房重置。
|
|
1175
433
|
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
该接口的调用结果会通过 [ITRTCCloudCallback](https://write.woa.com/document/87030021158866944) 中的 [onUpdateOtherRoomForwardMode](https://write.woa.com/document/87030021158866944) 回调通知给您。
|
|
1179
|
-
|
|
1180
|
-
|
|
434
|
+
该接口的调用结果会通过 ITRTCCloudCallback 中的 onUpdateOtherRoomForwardMode 回调通知给您。
|
|
1181
435
|
|
|
1182
436
|
例如：
|
|
1183
437
|
|
|
1184
|
-
房间“101”中有主播 A 与观众 B，房间“102”中有主播 C，主播 C 正常发布音视频流。主播 A 通过
|
|
438
|
+
房间“101”中有主播 A 与观众 B，房间“102”中有主播 C，主播 C 正常发布音视频流。主播 A 通过 connectOtherRoom 跟主播 C 建立跨房通话。
|
|
1185
439
|
- 此时，主播 A 与观众 B 都会收到主播 C 的 ` onRemoteUserEnterRoom(C) `, ` onUserVideoAvailable(C,true) ` 和 ` onUserAudioAvailable(C,true) ` 这三个事件回调，可以订阅主播 C 的音视频。
|
|
1186
440
|
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
441
|
之后，主播 A 调用该接口禁用主播 C 在本房间发布音频的能力。
|
|
1191
442
|
- 此后，主播 C 的音频流将无法发布至房间“101”，主播 A 与观众 B 都将收到 ` onUserAudioAvailable(C,false) ` 事件回调，且无法再通过 ` muteRemoteAudio(C,false) ` 订阅主播 C 的音频。
|
|
1192
443
|
|
|
1193
444
|
- 主播 C 的视频流将不受影响。房间“102”中的其他观众也不受影响，可以正常订阅主播 C 的音频。
|
|
1194
445
|
|
|
1195
|
-
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
446
|
该接口的参数考虑到后续扩展字段的兼容性问题，暂时采用了 JSON 格式的参数，示例如下：
|
|
1199
447
|
|
|
1200
448
|
**情况一：数字房间号**
|
|
@@ -1208,8 +456,6 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
|
|
|
1208
456
|
}
|
|
1209
457
|
```
|
|
1210
458
|
|
|
1211
|
-
|
|
1212
|
-
|
|
1213
459
|
**情况二：字符串房间号**
|
|
1214
460
|
``` cpp
|
|
1215
461
|
{
|
|
@@ -1220,665 +466,321 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
|
|
|
1220
466
|
"muteSubStream":false
|
|
1221
467
|
}
|
|
1222
468
|
```
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
|
|
1226
|
-
|
|
1227
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1228
|
-
</tr>
|
|
1229
|
-
|
|
1230
|
-
<tr>
|
|
1231
|
-
<td rowspan="1" colSpan="1" >param</td>
|
|
1232
|
-
|
|
1233
|
-
<td rowspan="1" colSpan="1" >需要您传入 JSON 格式的字符串参数，` roomId ` 代表数字格式的房间号，` strRoomId ` 代表字符串格式的房间号，` userId ` 代表目标主播的用户 ID，` muteAudio `, ` muteVideo `,` muteSubStream ` 均为可选项，分表代表禁止或允许跨房主播发布音频/主路视频/辅路视频的能力。</td>
|
|
1234
|
-
</tr>
|
|
1235
|
-
</table>
|
|
1236
|
-
|
|
469
|
+
| 参数 | 描述 |
|
|
470
|
+
| --- | --- |
|
|
471
|
+
| param | 需要您传入 JSON 格式的字符串参数，` roomId ` 代表数字格式的房间号，` strRoomId ` 代表字符串格式的房间号，` userId ` 代表目标主播的用户 ID，` muteAudio `, ` muteVideo `,` muteSubStream ` 均为可选项，分表代表禁止或允许跨房主播发布音频/主路视频/辅路视频的能力。 |
|
|
1237
472
|
|
|
1238
473
|
## startPublishMediaStream
|
|
1239
474
|
|
|
1240
|
-
|
|
1241
|
-
|
|
1242
475
|
#### 开始发布媒体流。
|
|
1243
476
|
|
|
1244
|
-
该接口会向 TRTC 服务器发送指令，要求其将当前用户的音视频流转推/转码到直播 CDN 或者回推到 TRTC 房间中您可以通过
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
</tr>
|
|
1251
|
-
|
|
1252
|
-
<tr>
|
|
1253
|
-
<td rowspan="1" colSpan="1" >config</td>
|
|
1254
|
-
|
|
1255
|
-
<td rowspan="1" colSpan="1" >媒体流转码配置参数。具体配置参考 [TRTCStreamMixingConfig](https://write.woa.com/document/87030132707430400)。转码和回推到 TRTC 房间中时为必填项，您需要指定您预期的转码配置参数。转推模式下则无效。</td>
|
|
1256
|
-
</tr>
|
|
1257
|
-
|
|
1258
|
-
<tr>
|
|
1259
|
-
<td rowspan="1" colSpan="1" >params</td>
|
|
1260
|
-
|
|
1261
|
-
<td rowspan="1" colSpan="1" >媒体流编码输出参数，具体配置参考 [TRTCStreamEncoderParam](https://write.woa.com/document/87030132707430400)。转码和回推到 TRTC 房间中时为必填项，您需要指定您预期的转码输出参数。在转推时，为了更好的转推稳定性和 CDN 兼容性，也建议您进行配置。</td>
|
|
1262
|
-
</tr>
|
|
1263
|
-
|
|
1264
|
-
<tr>
|
|
1265
|
-
<td rowspan="1" colSpan="1" >target</td>
|
|
1266
|
-
|
|
1267
|
-
<td rowspan="1" colSpan="1" >媒体流发布的目标地址，具体配置参考 [TRTCPublishTarget](https://write.woa.com/document/87030132707430400)。支持转推/转码到腾讯或者第三方 CDN，也支持转码回推到 TRTC 房间中。</td>
|
|
1268
|
-
</tr>
|
|
1269
|
-
</table>
|
|
1270
|
-
|
|
477
|
+
该接口会向 TRTC 服务器发送指令，要求其将当前用户的音视频流转推/转码到直播 CDN 或者回推到 TRTC 房间中您可以通过 TRTCPublishTarget 配置中的 TRTCPublishMode 指定具体的发布模式
|
|
478
|
+
| 参数 | 描述 |
|
|
479
|
+
| --- | --- |
|
|
480
|
+
| config | 媒体流转码配置参数。具体配置参考 TRTCStreamMixingConfig。转码和回推到 TRTC 房间中时为必填项，您需要指定您预期的转码配置参数。转推模式下则无效。 |
|
|
481
|
+
| params | 媒体流编码输出参数，具体配置参考 TRTCStreamEncoderParam。转码和回推到 TRTC 房间中时为必填项，您需要指定您预期的转码输出参数。在转推时，为了更好的转推稳定性和 CDN 兼容性，也建议您进行配置。 |
|
|
482
|
+
| target | 媒体流发布的目标地址，具体配置参考 TRTCPublishTarget。支持转推/转码到腾讯或者第三方 CDN，也支持转码回推到 TRTC 房间中。 |
|
|
1271
483
|
|
|
1272
484
|
> **注意**
|
|
1273
|
-
>
|
|
485
|
+
>
|
|
1274
486
|
|
|
1275
|
-
> 1. SDK 会通过回调
|
|
1276
|
-
>
|
|
487
|
+
> 1. SDK 会通过回调 onStartPublishMediaStream 带给您后台启动的任务标识（即 taskId）。
|
|
488
|
+
>
|
|
1277
489
|
|
|
1278
|
-
> 2. 同一个任务（
|
|
1279
|
-
>
|
|
490
|
+
> 2. 同一个任务（TRTCPublishMode 与 TRTCPublishCdnUrl 均相同）仅支持启动一次。若您后续需要更新或者停止该项任务，需要记录并使用返回的 taskId，通过 updatePublishMediaStream 或者 stopPublishMediaStream 来操作。
|
|
491
|
+
>
|
|
1280
492
|
|
|
1281
493
|
> 3. ` target ` 支持同时配置多个 CDN URL（最多同时 10 个）。若您的同一个转推/转码任务需要发布至多路 CDN，则仅需要在 ` target ` 中配置多个 CDN URL 即可。同一个转码任务即使有多个转推地址，对应的转码计费仍只收取一份。
|
|
1282
|
-
>
|
|
494
|
+
>
|
|
1283
495
|
|
|
1284
496
|
> 4. 使用时需要注意不要多个任务同时往相同的 URL 地址推送，以免引起异常推流状态。一种推荐的方案是 URL 中使用 “sdkappid_roomid_userid_main” 作为区分标识，这种命名方式容易辨认且不会在您的多个应用中发生冲突。
|
|
1285
|
-
>
|
|
1286
|
-
|
|
497
|
+
>
|
|
1287
498
|
|
|
1288
499
|
## updatePublishMediaStream
|
|
1289
500
|
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
501
|
#### 更新发布媒体流。
|
|
1293
502
|
|
|
1294
|
-
该接口会向 TRTC 服务器发送指令，更新通过
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
<tr>
|
|
1303
|
-
<td rowspan="1" colSpan="1" >config</td>
|
|
1304
|
-
|
|
1305
|
-
<td rowspan="1" colSpan="1" >媒体流转码配置参数。具体配置参考 [TRTCStreamMixingConfig](https://write.woa.com/document/87030132707430400)。转码和回推到 TRTC 房间中时为必填项，您需要指定您预期的转码配置参数。转推模式下则无效。</td>
|
|
1306
|
-
</tr>
|
|
1307
|
-
|
|
1308
|
-
<tr>
|
|
1309
|
-
<td rowspan="1" colSpan="1" >params</td>
|
|
1310
|
-
|
|
1311
|
-
<td rowspan="1" colSpan="1" >媒体流编码输出参数，具体配置参考 [TRTCStreamEncoderParam](https://write.woa.com/document/87030132707430400)。转码和回推到 TRTC 房间中时为必填项，您需要指定您预期的转码输出参数。在转推时，为了更好的转推稳定性和 CDN 兼容性，也建议您进行配置。</td>
|
|
1312
|
-
</tr>
|
|
1313
|
-
|
|
1314
|
-
<tr>
|
|
1315
|
-
<td rowspan="1" colSpan="1" >target</td>
|
|
1316
|
-
|
|
1317
|
-
<td rowspan="1" colSpan="1" >媒体流发布的目标地址，具体配置参考 [TRTCPublishTarget](https://write.woa.com/document/87030132707430400)。支持转推/转码到腾讯或者第三方 CDN，也支持转码回推到 TRTC 房间中。</td>
|
|
1318
|
-
</tr>
|
|
1319
|
-
|
|
1320
|
-
<tr>
|
|
1321
|
-
<td rowspan="1" colSpan="1" >taskId</td>
|
|
1322
|
-
|
|
1323
|
-
<td rowspan="1" colSpan="1" >通过回调 [onStartPublishMediaStream](https://write.woa.com/document/87030021158866944) 带给您后台启动的任务标识（即 taskId）</td>
|
|
1324
|
-
</tr>
|
|
1325
|
-
</table>
|
|
1326
|
-
|
|
503
|
+
该接口会向 TRTC 服务器发送指令，更新通过 startPublishMediaStream 启动的媒体流
|
|
504
|
+
| 参数 | 描述 |
|
|
505
|
+
| --- | --- |
|
|
506
|
+
| config | 媒体流转码配置参数。具体配置参考 TRTCStreamMixingConfig。转码和回推到 TRTC 房间中时为必填项，您需要指定您预期的转码配置参数。转推模式下则无效。 |
|
|
507
|
+
| params | 媒体流编码输出参数，具体配置参考 TRTCStreamEncoderParam。转码和回推到 TRTC 房间中时为必填项，您需要指定您预期的转码输出参数。在转推时，为了更好的转推稳定性和 CDN 兼容性，也建议您进行配置。 |
|
|
508
|
+
| target | 媒体流发布的目标地址，具体配置参考 TRTCPublishTarget。支持转推/转码到腾讯或者第三方 CDN，也支持转码回推到 TRTC 房间中。 |
|
|
509
|
+
| taskId | 通过回调 onStartPublishMediaStream 带给您后台启动的任务标识（即 taskId） |
|
|
1327
510
|
|
|
1328
511
|
> **注意**
|
|
1329
|
-
>
|
|
512
|
+
>
|
|
1330
513
|
|
|
1331
514
|
> 1. 您可以通过本接口来更新发布的 CDN URL（支持增删，最多同时 10 个），但您使用时需要注意不要多个任务同时往相同的 URL 地址推送，以免引起异常推流状态。
|
|
1332
|
-
>
|
|
515
|
+
>
|
|
1333
516
|
|
|
1334
|
-
> 2. 您可以通过 ` taskId ` 来更新调整转推/转码任务。例如在 pk 业务中，您可以先通过
|
|
1335
|
-
>
|
|
517
|
+
> 2. 您可以通过 ` taskId ` 来更新调整转推/转码任务。例如在 pk 业务中，您可以先通过 startPublishMediaStream 发起转推，接着在主播发起 pk 时，通过 ` taskId ` 和本接口将转推更新为转码任务。此时，CDN 播放将连续并且不会发生断流（您需要保持媒体流编码输出参数 param 一致）。
|
|
518
|
+
>
|
|
1336
519
|
|
|
1337
520
|
> 3. 同一个任务不支持纯音频、音视频、纯视频之间的切换。
|
|
1338
|
-
>
|
|
1339
|
-
|
|
521
|
+
>
|
|
1340
522
|
|
|
1341
523
|
## stopPublishMediaStream
|
|
1342
524
|
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
525
|
#### 停止发布媒体流。
|
|
1346
526
|
|
|
1347
|
-
该接口会向 TRTC 服务器发送指令，停止通过
|
|
1348
|
-
|
|
1349
|
-
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1353
|
-
</tr>
|
|
1354
|
-
|
|
1355
|
-
<tr>
|
|
1356
|
-
<td rowspan="1" colSpan="1" >taskId</td>
|
|
1357
|
-
|
|
1358
|
-
<td rowspan="1" colSpan="1" >通过回调 [onStartPublishMediaStream](https://write.woa.com/document/87030021158866944) 带给您后台启动的任务标识（即 taskId）</td>
|
|
1359
|
-
</tr>
|
|
1360
|
-
</table>
|
|
1361
|
-
|
|
527
|
+
该接口会向 TRTC 服务器发送指令，停止通过 startPublishMediaStream 启动的媒体流
|
|
528
|
+
| 参数 | 描述 |
|
|
529
|
+
| --- | --- |
|
|
530
|
+
| taskId | 通过回调 onStartPublishMediaStream 带给您后台启动的任务标识（即 taskId） |
|
|
1362
531
|
|
|
1363
532
|
> **注意**
|
|
1364
|
-
>
|
|
1365
|
-
|
|
1366
|
-
> 1. 若您的业务后台并没有保存该 ` taskId `，在您的主播异常退房重进后，如果您需要重新获取 ` taskId `，您可以再次调用 [startPublishMediaStream](https://write.woa.com/document/87030026264555520) 启动任务。此时 TRTC 后台会返回任务启动失败，同时带给您上一次启动的 ` taskId `。
|
|
1367
|
-
>
|
|
533
|
+
>
|
|
1368
534
|
|
|
1369
|
-
>
|
|
1370
|
-
>
|
|
535
|
+
> 1. 若您的业务后台并没有保存该 ` taskId `，在您的主播异常退房重进后，如果您需要重新获取 ` taskId `，您可以再次调用 startPublishMediaStream 启动任务。此时 TRTC 后台会返回任务启动失败，同时带给您上一次启动的 ` taskId `。
|
|
536
|
+
>
|
|
1371
537
|
|
|
538
|
+
> 2. 若 ` taskId ` 填空字符串，将会停止该用户所有通过 startPublishMediaStream 启动的媒体流，如果您只启动了一个媒体流或者想停止所有通过您启动的媒体流，推荐使用这种方式。
|
|
539
|
+
>
|
|
1372
540
|
|
|
1373
541
|
## startLocalPreview
|
|
1374
542
|
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
543
|
#### 开启本地摄像头的预览画面（移动端）。
|
|
1378
544
|
|
|
1379
|
-
在
|
|
1380
|
-
|
|
1381
|
-
在 [enterRoom](https://write.woa.com/document/87030026264555520) 之后调用此函数，SDK 会开启摄像头并自动开始视频推流。
|
|
1382
|
-
|
|
1383
|
-
当开始渲染首帧摄像头画面时，您会收到 [ITRTCCloudCallback](https://write.woa.com/document/87030021158866944) 中的 [onCameraDidReady](https://write.woa.com/document/87030021158866944) 回调通知。
|
|
1384
|
-
<table>
|
|
1385
|
-
<tr>
|
|
1386
|
-
<td rowspan="1" colSpan="1" >参数</td>
|
|
1387
|
-
|
|
1388
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1389
|
-
</tr>
|
|
1390
|
-
|
|
1391
|
-
<tr>
|
|
1392
|
-
<td rowspan="1" colSpan="1" >frontCamera</td>
|
|
1393
|
-
|
|
1394
|
-
<td rowspan="1" colSpan="1" >true：前置摄像头；false：后置摄像头。</td>
|
|
1395
|
-
</tr>
|
|
1396
|
-
|
|
1397
|
-
<tr>
|
|
1398
|
-
<td rowspan="1" colSpan="1" >view</td>
|
|
545
|
+
在 enterRoom 之前调用此函数，SDK 只会开启摄像头，并一直等到您调用 enterRoom 之后才开始推流。
|
|
1399
546
|
|
|
1400
|
-
|
|
1401
|
-
</tr>
|
|
1402
|
-
</table>
|
|
547
|
+
在 enterRoom 之后调用此函数，SDK 会开启摄像头并自动开始视频推流。
|
|
1403
548
|
|
|
549
|
+
当开始渲染首帧摄像头画面时，您会收到 ITRTCCloudCallback 中的 onCameraDidReady 回调通知。
|
|
550
|
+
| 参数 | 描述 |
|
|
551
|
+
| --- | --- |
|
|
552
|
+
| frontCamera | true：前置摄像头；false：后置摄像头。 |
|
|
553
|
+
| view | 承载视频画面的控件。 |
|
|
1404
554
|
|
|
1405
555
|
> **注意**
|
|
1406
|
-
>
|
|
556
|
+
>
|
|
1407
557
|
|
|
1408
558
|
> 如果希望开播前预览摄像头画面并通过 BeautyManager 调节美颜参数，您可以：
|
|
1409
|
-
>
|
|
1410
|
-
> - 方案一：在调用
|
|
1411
|
-
> - 方案二：在调用
|
|
1412
|
-
|
|
559
|
+
>
|
|
560
|
+
> - 方案一：在调用 enterRoom 之前调用 ` startLocalPreview `。
|
|
561
|
+
> - 方案二：在调用 enterRoom 之后调用 ` startLocalPreview + muteLocalVideo(true) `。
|
|
1413
562
|
|
|
1414
563
|
## startLocalPreview
|
|
1415
564
|
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
565
|
#### 开启本地摄像头的预览画面（桌面端）。
|
|
1419
566
|
|
|
1420
|
-
在调用该接口之前，您可以先调用
|
|
1421
|
-
|
|
1422
|
-
在 [enterRoom](https://write.woa.com/document/87030026264555520) 之前调用此函数，SDK 只会开启摄像头，并一直等到您调用 [enterRoom](https://write.woa.com/document/87030026264555520) 之后才开始推流。
|
|
567
|
+
在调用该接口之前，您可以先调用 setCurrentDevice 选择使用桌面端设备自带摄像头或外接摄像头。
|
|
1423
568
|
|
|
1424
|
-
在
|
|
569
|
+
在 enterRoom 之前调用此函数，SDK 只会开启摄像头，并一直等到您调用 enterRoom 之后才开始推流。
|
|
1425
570
|
|
|
1426
|
-
|
|
1427
|
-
<table>
|
|
1428
|
-
<tr>
|
|
1429
|
-
<td rowspan="1" colSpan="1" >参数</td>
|
|
1430
|
-
|
|
1431
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1432
|
-
</tr>
|
|
1433
|
-
|
|
1434
|
-
<tr>
|
|
1435
|
-
<td rowspan="1" colSpan="1" >view</td>
|
|
1436
|
-
|
|
1437
|
-
<td rowspan="1" colSpan="1" >承载视频画面的控件。</td>
|
|
1438
|
-
</tr>
|
|
1439
|
-
</table>
|
|
571
|
+
在 enterRoom 之后调用此函数，SDK 会开启摄像头并自动开始视频推流。
|
|
1440
572
|
|
|
573
|
+
当开始渲染首帧摄像头画面时，您会收到 ITRTCCloudCallback 中的 onCameraDidReady 回调通知。
|
|
574
|
+
| 参数 | 描述 |
|
|
575
|
+
| --- | --- |
|
|
576
|
+
| view | 承载视频画面的控件。 |
|
|
1441
577
|
|
|
1442
578
|
> **注意**
|
|
1443
|
-
>
|
|
579
|
+
>
|
|
1444
580
|
|
|
1445
581
|
> 如果希望开播前预览摄像头画面并通过 BeautyManager 调节美颜参数，您可以：
|
|
1446
|
-
>
|
|
1447
|
-
> - 方案一：在调用
|
|
1448
|
-
> - 方案二：在调用
|
|
1449
|
-
|
|
582
|
+
>
|
|
583
|
+
> - 方案一：在调用 enterRoom 之前调用 ` startLocalPreview `。
|
|
584
|
+
> - 方案二：在调用 enterRoom 之后调用 ` startLocalPreview + muteLocalVideo(true) `。
|
|
1450
585
|
|
|
1451
586
|
## updateLocalView
|
|
1452
587
|
|
|
1453
|
-
|
|
1454
|
-
|
|
1455
588
|
#### 更新本地摄像头的预览画面。
|
|
1456
589
|
|
|
1457
590
|
## stopLocalPreview
|
|
1458
591
|
|
|
1459
|
-
|
|
1460
|
-
|
|
1461
592
|
#### 停止摄像头预览。
|
|
1462
593
|
|
|
1463
594
|
## muteLocalVideo
|
|
1464
595
|
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
596
|
#### 暂停/恢复发布本地的视频流。
|
|
1468
597
|
|
|
1469
598
|
该接口可以暂停（或恢复）发布本地的视频画面，暂停之后，同一房间中的其他用户将无法继续看到自己画面。
|
|
1470
599
|
|
|
1471
|
-
该接口在指定
|
|
600
|
+
该接口在指定 TRTCVideoStreamTypeBig 时等效于 ` startLocalPreview + stopLocalPreview ` 这两个接口，但具有更好的响应速度。
|
|
1472
601
|
|
|
1473
602
|
因为 ` startLocalPreview + stopLocalPreview ` 需要打开和关闭摄像头，而打开和关闭摄像头都是硬件设备相关的操作，非常耗时。
|
|
1474
603
|
|
|
1475
604
|
相比之下，` muteLocalVideo ` 只需要在软件层面对数据流进行暂停或者放行即可，因此效率更高，也更适合需要频繁打开关闭的场景。
|
|
1476
605
|
|
|
606
|
+
当暂停/恢复发布指定 TRTCVideoStreamTypeBig 后，同一房间中的其他用户将会收到 onUserVideoAvailable 回调通知。
|
|
1477
607
|
|
|
1478
|
-
|
|
1479
|
-
|
|
1480
|
-
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
<tr>
|
|
1484
|
-
<td rowspan="1" colSpan="1" >参数</td>
|
|
1485
|
-
|
|
1486
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1487
|
-
</tr>
|
|
1488
|
-
|
|
1489
|
-
<tr>
|
|
1490
|
-
<td rowspan="1" colSpan="1" >mute</td>
|
|
1491
|
-
|
|
1492
|
-
<td rowspan="1" colSpan="1" >true：暂停；false：恢复。</td>
|
|
1493
|
-
</tr>
|
|
1494
|
-
|
|
1495
|
-
<tr>
|
|
1496
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
1497
|
-
|
|
1498
|
-
<td rowspan="1" colSpan="1" >要暂停/恢复的视频流类型（仅支持 [TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400) 和 [TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400)）。</td>
|
|
1499
|
-
</tr>
|
|
1500
|
-
</table>
|
|
1501
|
-
|
|
608
|
+
当暂停/恢复发布指定 TRTCVideoStreamTypeSub 后，同一房间中的其他用户将会收到 onUserSubStreamAvailable 回调通知。
|
|
609
|
+
| 参数 | 描述 |
|
|
610
|
+
| --- | --- |
|
|
611
|
+
| mute | true：暂停；false：恢复。 |
|
|
612
|
+
| streamType | 要暂停/恢复的视频流类型（仅支持 TRTCVideoStreamTypeBig 和 TRTCVideoStreamTypeSub）。 |
|
|
1502
613
|
|
|
1503
614
|
## setVideoMuteImage
|
|
1504
615
|
|
|
1505
|
-
|
|
1506
|
-
|
|
1507
616
|
#### 设置本地画面被暂停期间的替代图片。
|
|
1508
617
|
|
|
1509
618
|
当您调用 ` muteLocalVideo(true) ` 暂停本地画面时，您可以通过调用本接口设置一张替代图片，设置后，房间中的其他用户会看到这张替代图片，而不是黑屏画面。
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
|
|
1513
|
-
|
|
1514
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1515
|
-
</tr>
|
|
1516
|
-
|
|
1517
|
-
<tr>
|
|
1518
|
-
<td rowspan="1" colSpan="1" >fps</td>
|
|
1519
|
-
|
|
1520
|
-
<td rowspan="1" colSpan="1" >设置替代图片帧率，最小值为5，最大值为10，默认5。</td>
|
|
1521
|
-
</tr>
|
|
1522
|
-
|
|
1523
|
-
<tr>
|
|
1524
|
-
<td rowspan="1" colSpan="1" >image</td>
|
|
1525
|
-
|
|
1526
|
-
<td rowspan="1" colSpan="1" >设置替代图片，空值代表在 [muteLocalVideo](https://write.woa.com/document/87030026264555520) 之后不再发送视频流数据，默认值为空。</td>
|
|
1527
|
-
</tr>
|
|
1528
|
-
</table>
|
|
1529
|
-
|
|
619
|
+
| 参数 | 描述 |
|
|
620
|
+
| --- | --- |
|
|
621
|
+
| fps | 设置替代图片帧率，最小值为5，最大值为10，默认5。 |
|
|
622
|
+
| image | 设置替代图片，空值代表在 muteLocalVideo 之后不再发送视频流数据，默认值为空。 |
|
|
1530
623
|
|
|
1531
624
|
## startRemoteView
|
|
1532
625
|
|
|
1533
|
-
|
|
1534
|
-
|
|
1535
626
|
#### 订阅远端用户的视频流，并绑定视频渲染控件。
|
|
1536
627
|
|
|
1537
|
-
调用该接口可以让 SDK 拉取指定 userId 的视频流，并渲染到参数 ` view ` 指定的渲染控件上。您可以通过
|
|
628
|
+
调用该接口可以让 SDK 拉取指定 userId 的视频流，并渲染到参数 ` view ` 指定的渲染控件上。您可以通过 setRemoteRenderParams 设置画面的显示模式。
|
|
1538
629
|
- 如果您已经知道房间中有视频流的用户的 userId，可以直接调用 ` startRemoteView ` 订阅该用户的画面。
|
|
1539
630
|
|
|
1540
|
-
- 如果您不知道房间中有哪些用户在发布视频，您可以在
|
|
1541
|
-
|
|
1542
|
-
|
|
1543
|
-
|
|
1544
|
-
|
|
1545
|
-
调用本接口只是启动视频流的拉取，此时画面还需要加载和缓冲，当缓冲完毕后您会收到来自 [onFirstVideoFrame](https://write.woa.com/document/87030021158866944) 的通知。
|
|
1546
|
-
<table>
|
|
1547
|
-
<tr>
|
|
1548
|
-
<td rowspan="1" colSpan="1" >参数</td>
|
|
1549
|
-
|
|
1550
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1551
|
-
</tr>
|
|
1552
|
-
|
|
1553
|
-
<tr>
|
|
1554
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
1555
|
-
|
|
1556
|
-
<td rowspan="1" colSpan="1" >指定要观看 userId 的视频流类型。<br>- 高清大画面：[TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400)。<br>- 低清小画面：[TRTCVideoStreamTypeSmall](https://write.woa.com/document/87030132707430400)（需要远端用户通过 [enableSmallVideoStream](https://write.woa.com/document/87030026264555520) 开启双路编码后才有效果）。<br>- 辅流画面（常用于屏幕分享）：[TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400)。</td>
|
|
1557
|
-
</tr>
|
|
1558
|
-
|
|
1559
|
-
<tr>
|
|
1560
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
1561
|
-
|
|
1562
|
-
<td rowspan="1" colSpan="1" >指定远端用户的 ID。</td>
|
|
1563
|
-
</tr>
|
|
1564
|
-
|
|
1565
|
-
<tr>
|
|
1566
|
-
<td rowspan="1" colSpan="1" >view</td>
|
|
1567
|
-
|
|
1568
|
-
<td rowspan="1" colSpan="1" >用于承载视频画面的渲染控件。</td>
|
|
1569
|
-
</tr>
|
|
1570
|
-
</table>
|
|
631
|
+
- 如果您不知道房间中有哪些用户在发布视频，您可以在 enterRoom 之后等待来自 onUserVideoAvailable 的通知。
|
|
1571
632
|
|
|
633
|
+
调用本接口只是启动视频流的拉取，此时画面还需要加载和缓冲，当缓冲完毕后您会收到来自 onFirstVideoFrame 的通知。
|
|
634
|
+
| 参数 | 描述 |
|
|
635
|
+
| --- | --- |
|
|
636
|
+
| streamType | 指定要观看 userId 的视频流类型。<br>- 高清大画面：TRTCVideoStreamTypeBig。<br>- 低清小画面：TRTCVideoStreamTypeSmall（需要远端用户通过 enableSmallVideoStream 开启双路编码后才有效果）。<br>- 辅流画面（常用于屏幕分享）：TRTCVideoStreamTypeSub。 |
|
|
637
|
+
| userId | 指定远端用户的 ID。 |
|
|
638
|
+
| view | 用于承载视频画面的渲染控件。 |
|
|
1572
639
|
|
|
1573
640
|
> **注意**
|
|
1574
|
-
>
|
|
641
|
+
>
|
|
1575
642
|
|
|
1576
643
|
> 注意几点规则需要您关注：
|
|
1577
|
-
>
|
|
644
|
+
>
|
|
1578
645
|
|
|
1579
646
|
> 1. SDK 支持同时观看某 userId 的大画面和辅路画面，或者同时观看某 userId 的小画面和辅路画面，但不支持同时观看大画面和小画面。
|
|
1580
|
-
>
|
|
647
|
+
>
|
|
1581
648
|
|
|
1582
|
-
> 2. 只有当指定的 userId 通过
|
|
1583
|
-
>
|
|
649
|
+
> 2. 只有当指定的 userId 通过 enableSmallVideoStream 开启双路编码后，才能观看该用户的小画面。
|
|
650
|
+
>
|
|
1584
651
|
|
|
1585
652
|
> 3. 当指定的 userId 的小画面不存在时，SDK 默认切换到该用户的大画面。
|
|
1586
|
-
>
|
|
1587
|
-
|
|
653
|
+
>
|
|
1588
654
|
|
|
1589
655
|
## updateRemoteView
|
|
1590
656
|
|
|
1591
|
-
|
|
1592
|
-
|
|
1593
657
|
#### 更新远端用户的视频渲染控件。
|
|
1594
658
|
|
|
1595
659
|
该接口可用于更新远端视频画面的渲染控件，常被用于切换显示区域的交互场景中。
|
|
1596
|
-
|
|
1597
|
-
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
</tr>
|
|
1602
|
-
|
|
1603
|
-
<tr>
|
|
1604
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
1605
|
-
|
|
1606
|
-
<td rowspan="1" colSpan="1" >要设置预览窗口的流类型（仅支持 [TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400) 和 [TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400)）。</td>
|
|
1607
|
-
</tr>
|
|
1608
|
-
|
|
1609
|
-
<tr>
|
|
1610
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
1611
|
-
|
|
1612
|
-
<td rowspan="1" colSpan="1" >指定远端用户的 ID。</td>
|
|
1613
|
-
</tr>
|
|
1614
|
-
|
|
1615
|
-
<tr>
|
|
1616
|
-
<td rowspan="1" colSpan="1" >view</td>
|
|
1617
|
-
|
|
1618
|
-
<td rowspan="1" colSpan="1" >承载视频画面的控件。</td>
|
|
1619
|
-
</tr>
|
|
1620
|
-
</table>
|
|
1621
|
-
|
|
660
|
+
| 参数 | 描述 |
|
|
661
|
+
| --- | --- |
|
|
662
|
+
| streamType | 要设置预览窗口的流类型（仅支持 TRTCVideoStreamTypeBig 和 TRTCVideoStreamTypeSub）。 |
|
|
663
|
+
| userId | 指定远端用户的 ID。 |
|
|
664
|
+
| view | 承载视频画面的控件。 |
|
|
1622
665
|
|
|
1623
666
|
## stopRemoteView
|
|
1624
667
|
|
|
1625
|
-
|
|
1626
|
-
|
|
1627
668
|
#### 停止订阅远端用户的视频流，并释放渲染控件。
|
|
1628
669
|
|
|
1629
670
|
调用此接口会让 SDK 停止接收该用户的视频流，并释放该路视频流的解码和渲染资源。
|
|
1630
|
-
|
|
1631
|
-
|
|
1632
|
-
|
|
1633
|
-
|
|
1634
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1635
|
-
</tr>
|
|
1636
|
-
|
|
1637
|
-
<tr>
|
|
1638
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
1639
|
-
|
|
1640
|
-
<td rowspan="1" colSpan="1" >指定要观看 userId 的视频流类型。<br>- 高清大画面：[TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400)。<br>- 低清小画面：[TRTCVideoStreamTypeSmall](https://write.woa.com/document/87030132707430400)。<br>- 辅流画面（常用于屏幕分享）：[TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400)。</td>
|
|
1641
|
-
</tr>
|
|
1642
|
-
|
|
1643
|
-
<tr>
|
|
1644
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
1645
|
-
|
|
1646
|
-
<td rowspan="1" colSpan="1" >指定远端用户的 ID。</td>
|
|
1647
|
-
</tr>
|
|
1648
|
-
</table>
|
|
1649
|
-
|
|
671
|
+
| 参数 | 描述 |
|
|
672
|
+
| --- | --- |
|
|
673
|
+
| streamType | 指定要观看 userId 的视频流类型。<br>- 高清大画面：TRTCVideoStreamTypeBig。<br>- 低清小画面：TRTCVideoStreamTypeSmall。<br>- 辅流画面（常用于屏幕分享）：TRTCVideoStreamTypeSub。 |
|
|
674
|
+
| userId | 指定远端用户的 ID。 |
|
|
1650
675
|
|
|
1651
676
|
## stopAllRemoteView
|
|
1652
677
|
|
|
1653
|
-
|
|
1654
|
-
|
|
1655
678
|
#### 停止订阅所有远端用户的视频流，并释放全部渲染资源。
|
|
1656
679
|
|
|
1657
680
|
调用此接口会让 SDK 停止接收所有来自远端的视频流，并释放全部的解码和渲染资源。
|
|
1658
681
|
|
|
1659
682
|
> **注意**
|
|
1660
|
-
>
|
|
683
|
+
>
|
|
1661
684
|
|
|
1662
685
|
> 如果当前有正在显示的辅路画面（屏幕分享）也会一并被停止。
|
|
1663
|
-
>
|
|
1664
|
-
|
|
686
|
+
>
|
|
1665
687
|
|
|
1666
688
|
## muteRemoteVideoStream
|
|
1667
689
|
|
|
1668
|
-
|
|
1669
|
-
|
|
1670
690
|
#### 暂停/恢复订阅远端用户的视频流。
|
|
1671
691
|
|
|
1672
692
|
该接口仅暂停/恢复接收指定用户的视频流，但并不释放显示资源，视频画面会被冻屏在接口调用时的最后一帧。
|
|
1673
|
-
|
|
1674
|
-
|
|
1675
|
-
|
|
1676
|
-
|
|
1677
|
-
|
|
1678
|
-
</tr>
|
|
1679
|
-
|
|
1680
|
-
<tr>
|
|
1681
|
-
<td rowspan="1" colSpan="1" >mute</td>
|
|
1682
|
-
|
|
1683
|
-
<td rowspan="1" colSpan="1" >是否暂停接收。</td>
|
|
1684
|
-
</tr>
|
|
1685
|
-
|
|
1686
|
-
<tr>
|
|
1687
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
1688
|
-
|
|
1689
|
-
<td rowspan="1" colSpan="1" >要暂停/恢复的视频流类型。<br>- 高清大画面：[TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400)。<br>- 低清小画面：[TRTCVideoStreamTypeSmall](https://write.woa.com/document/87030132707430400)。<br>- 辅流画面（常用于屏幕分享）：[TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400)。</td>
|
|
1690
|
-
</tr>
|
|
1691
|
-
|
|
1692
|
-
<tr>
|
|
1693
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
1694
|
-
|
|
1695
|
-
<td rowspan="1" colSpan="1" >指定远端用户的 ID。</td>
|
|
1696
|
-
</tr>
|
|
1697
|
-
</table>
|
|
1698
|
-
|
|
693
|
+
| 参数 | 描述 |
|
|
694
|
+
| --- | --- |
|
|
695
|
+
| mute | 是否暂停接收。 |
|
|
696
|
+
| streamType | 要暂停/恢复的视频流类型。<br>- 高清大画面：TRTCVideoStreamTypeBig。<br>- 低清小画面：TRTCVideoStreamTypeSmall。<br>- 辅流画面（常用于屏幕分享）：TRTCVideoStreamTypeSub。 |
|
|
697
|
+
| userId | 指定远端用户的 ID。 |
|
|
1699
698
|
|
|
1700
699
|
> **注意**
|
|
1701
|
-
>
|
|
1702
|
-
|
|
1703
|
-
> 该接口支持您在进入房间（[enterRoom](https://write.woa.com/document/87030026264555520)）前调用，暂停状态在退出房间（[exitRoom](https://write.woa.com/document/87030026264555520)）之后会被重置。调用该接口暂停接收指定用户的视频流后，只调用 [startRemoteView](https://write.woa.com/document/87030026264555520) 接口无法播放指定用户的视频，需要调用 [muteRemoteVideoStream](https://write.woa.com/document/87030026264555520)(false) 或 [muteAllRemoteVideoStreams](https://write.woa.com/document/87030026264555520)(false) 才能恢复。
|
|
1704
|
-
>
|
|
700
|
+
>
|
|
1705
701
|
|
|
702
|
+
> 该接口支持您在进入房间（enterRoom）前调用，暂停状态在退出房间（exitRoom）之后会被重置。调用该接口暂停接收指定用户的视频流后，只调用 startRemoteView 接口无法播放指定用户的视频，需要调用 muteRemoteVideoStream(false) 或 muteAllRemoteVideoStreams(false) 才能恢复。
|
|
703
|
+
>
|
|
1706
704
|
|
|
1707
705
|
## muteAllRemoteVideoStreams
|
|
1708
706
|
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
707
|
#### 暂停/恢复订阅所有远端用户的视频流。
|
|
1712
708
|
|
|
1713
709
|
该接口仅暂停/恢复接收所有用户的视频流，但并不释放显示资源，视频画面会被冻屏在接口调用时的最后一帧。
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
|
|
1717
|
-
|
|
1718
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1719
|
-
</tr>
|
|
1720
|
-
|
|
1721
|
-
<tr>
|
|
1722
|
-
<td rowspan="1" colSpan="1" >mute</td>
|
|
1723
|
-
|
|
1724
|
-
<td rowspan="1" colSpan="1" >是否暂停接收。</td>
|
|
1725
|
-
</tr>
|
|
1726
|
-
</table>
|
|
1727
|
-
|
|
710
|
+
| 参数 | 描述 |
|
|
711
|
+
| --- | --- |
|
|
712
|
+
| mute | 是否暂停接收。 |
|
|
1728
713
|
|
|
1729
714
|
> **注意**
|
|
1730
|
-
>
|
|
715
|
+
>
|
|
1731
716
|
|
|
1732
|
-
> 该接口支持您在进入房间（
|
|
1733
|
-
>
|
|
1734
|
-
|
|
1735
|
-
> 调用该接口暂停接收所有用户的视频流后，只调用 [startRemoteView](https://write.woa.com/document/87030026264555520) 接口无法播放指定用户的视频，需要调用 [muteRemoteVideoStream](https://write.woa.com/document/87030026264555520)(false) 或 [muteAllRemoteVideoStreams](https://write.woa.com/document/87030026264555520)(false) 才能恢复。
|
|
1736
|
-
>
|
|
717
|
+
> 该接口支持您在进入房间（enterRoom）前调用，暂停状态在退出房间（exitRoom）之后会被重置。
|
|
718
|
+
>
|
|
1737
719
|
|
|
720
|
+
> 调用该接口暂停接收所有用户的视频流后，只调用 startRemoteView 接口无法播放指定用户的视频，需要调用 muteRemoteVideoStream(false) 或 muteAllRemoteVideoStreams(false) 才能恢复。
|
|
721
|
+
>
|
|
1738
722
|
|
|
1739
723
|
## setVideoEncoderParam
|
|
1740
724
|
|
|
1741
|
-
|
|
1742
|
-
|
|
1743
725
|
#### 设置视频编码器的编码参数。
|
|
1744
726
|
|
|
1745
727
|
该设置能够决定远端用户看到的画面质量，同时也能决定云端录制出的视频文件的画面质量。
|
|
1746
|
-
|
|
1747
|
-
|
|
1748
|
-
|
|
1749
|
-
|
|
1750
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1751
|
-
</tr>
|
|
1752
|
-
|
|
1753
|
-
<tr>
|
|
1754
|
-
<td rowspan="1" colSpan="1" >param</td>
|
|
1755
|
-
|
|
1756
|
-
<td rowspan="1" colSpan="1" >用于设置视频编码器的相关参数，详情请参见 [TRTCVideoEncParam](https://write.woa.com/document/87030132707430400)。</td>
|
|
1757
|
-
</tr>
|
|
1758
|
-
</table>
|
|
1759
|
-
|
|
728
|
+
| 参数 | 描述 |
|
|
729
|
+
| --- | --- |
|
|
730
|
+
| param | 用于设置视频编码器的相关参数，详情请参见 TRTCVideoEncParam。 |
|
|
1760
731
|
|
|
1761
732
|
> **注意**
|
|
1762
|
-
>
|
|
733
|
+
>
|
|
1763
734
|
|
|
1764
735
|
> 从v11.5版本开始，编码输出分辨率会按照宽8高2字节对齐，并且是向下调整，eg:输入分辨率540x960，实际编码输出分辨率536x960。
|
|
1765
|
-
>
|
|
1766
|
-
|
|
736
|
+
>
|
|
1767
737
|
|
|
1768
738
|
## setNetworkQosParam
|
|
1769
739
|
|
|
1770
|
-
|
|
1771
|
-
|
|
1772
740
|
#### 设置网络质量控制的相关参数。
|
|
1773
741
|
|
|
1774
742
|
该设置决定在差网络环境下的质量调控策略，如“画质优先”或“流畅优先”等策略。
|
|
1775
|
-
|
|
1776
|
-
|
|
1777
|
-
|
|
1778
|
-
|
|
1779
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1780
|
-
</tr>
|
|
1781
|
-
|
|
1782
|
-
<tr>
|
|
1783
|
-
<td rowspan="1" colSpan="1" >param</td>
|
|
1784
|
-
|
|
1785
|
-
<td rowspan="1" colSpan="1" >用于设置网络质量控制的相关参数，详情请参见 [TRTCNetworkQosParam](https://write.woa.com/document/87030132707430400)。</td>
|
|
1786
|
-
</tr>
|
|
1787
|
-
</table>
|
|
1788
|
-
|
|
743
|
+
| 参数 | 描述 |
|
|
744
|
+
| --- | --- |
|
|
745
|
+
| param | 用于设置网络质量控制的相关参数，详情请参见 TRTCNetworkQosParam。 |
|
|
1789
746
|
|
|
1790
747
|
## setLocalRenderParams
|
|
1791
748
|
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
749
|
#### 设置本地画面的渲染参数。
|
|
1795
750
|
|
|
1796
751
|
可设置的参数包括有：画面的旋转角度、填充模式以及左右镜像等。
|
|
1797
|
-
|
|
1798
|
-
|
|
1799
|
-
|
|
1800
|
-
|
|
1801
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1802
|
-
</tr>
|
|
1803
|
-
|
|
1804
|
-
<tr>
|
|
1805
|
-
<td rowspan="1" colSpan="1" >params</td>
|
|
1806
|
-
|
|
1807
|
-
<td rowspan="1" colSpan="1" >画面渲染参数，详情请参见 [TRTCRenderParams](https://write.woa.com/document/87030132707430400)。</td>
|
|
1808
|
-
</tr>
|
|
1809
|
-
</table>
|
|
1810
|
-
|
|
752
|
+
| 参数 | 描述 |
|
|
753
|
+
| --- | --- |
|
|
754
|
+
| params | 画面渲染参数，详情请参见 TRTCRenderParams。 |
|
|
1811
755
|
|
|
1812
756
|
## setRemoteRenderParams
|
|
1813
757
|
|
|
1814
|
-
|
|
1815
|
-
|
|
1816
758
|
#### 设置远端画面的渲染模式。
|
|
1817
759
|
|
|
1818
760
|
可设置的参数包括有：画面的旋转角度、填充模式以及左右镜像等。
|
|
1819
|
-
|
|
1820
|
-
|
|
1821
|
-
|
|
1822
|
-
|
|
1823
|
-
|
|
1824
|
-
</tr>
|
|
1825
|
-
|
|
1826
|
-
<tr>
|
|
1827
|
-
<td rowspan="1" colSpan="1" >params</td>
|
|
1828
|
-
|
|
1829
|
-
<td rowspan="1" colSpan="1" >画面渲染参数，详情请参见 [TRTCRenderParams](https://write.woa.com/document/87030132707430400)。</td>
|
|
1830
|
-
</tr>
|
|
1831
|
-
|
|
1832
|
-
<tr>
|
|
1833
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
1834
|
-
|
|
1835
|
-
<td rowspan="1" colSpan="1" >可以设置为主路画面（[TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400)）或辅路画面（[TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400)）。</td>
|
|
1836
|
-
</tr>
|
|
1837
|
-
|
|
1838
|
-
<tr>
|
|
1839
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
1840
|
-
|
|
1841
|
-
<td rowspan="1" colSpan="1" >指定远端用户的 ID。</td>
|
|
1842
|
-
</tr>
|
|
1843
|
-
</table>
|
|
1844
|
-
|
|
761
|
+
| 参数 | 描述 |
|
|
762
|
+
| --- | --- |
|
|
763
|
+
| params | 画面渲染参数，详情请参见 TRTCRenderParams。 |
|
|
764
|
+
| streamType | 可以设置为主路画面（TRTCVideoStreamTypeBig）或辅路画面（TRTCVideoStreamTypeSub）。 |
|
|
765
|
+
| userId | 指定远端用户的 ID。 |
|
|
1845
766
|
|
|
1846
767
|
## enableSmallVideoStream
|
|
1847
768
|
|
|
1848
|
-
|
|
1849
|
-
|
|
1850
769
|
#### 开启大小画面双路编码模式。
|
|
1851
770
|
|
|
1852
771
|
开启双路编码模式后，当前用户的编码器会同时输出【高清大画面】和【低清小画面】两路视频流（但只有一路音频流）。
|
|
1853
772
|
|
|
1854
773
|
如此以来，房间中的其他用户就可以根据自身的网络情况或屏幕大小选择订阅【高清大画面】或是【低清小画面】。
|
|
1855
|
-
|
|
1856
|
-
|
|
1857
|
-
|
|
1858
|
-
|
|
1859
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1860
|
-
</tr>
|
|
1861
|
-
|
|
1862
|
-
<tr>
|
|
1863
|
-
<td rowspan="1" colSpan="1" >enable</td>
|
|
1864
|
-
|
|
1865
|
-
<td rowspan="1" colSpan="1" >是否开启小画面编码，默认值：false。</td>
|
|
1866
|
-
</tr>
|
|
1867
|
-
|
|
1868
|
-
<tr>
|
|
1869
|
-
<td rowspan="1" colSpan="1" >smallVideoEncParam</td>
|
|
1870
|
-
|
|
1871
|
-
<td rowspan="1" colSpan="1" >小流的视频参数。</td>
|
|
1872
|
-
</tr>
|
|
1873
|
-
</table>
|
|
1874
|
-
|
|
774
|
+
| 参数 | 描述 |
|
|
775
|
+
| --- | --- |
|
|
776
|
+
| enable | 是否开启小画面编码，默认值：false。 |
|
|
777
|
+
| smallVideoEncParam | 小流的视频参数。 |
|
|
1875
778
|
|
|
1876
779
|
> **注意**
|
|
1877
|
-
>
|
|
780
|
+
>
|
|
1878
781
|
|
|
1879
782
|
> 双路编码开启后，会消耗更多的 CPU 和 网络带宽，所以 Mac、Windows 或者高性能 Pad 可以考虑开启，不建议手机端开启。
|
|
1880
|
-
>
|
|
1881
|
-
|
|
783
|
+
>
|
|
1882
784
|
|
|
1883
785
|
#### 返回值说明：
|
|
1884
786
|
|
|
@@ -1886,85 +788,40 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
|
|
|
1886
788
|
|
|
1887
789
|
## setRemoteVideoStreamType
|
|
1888
790
|
|
|
1889
|
-
|
|
1890
|
-
|
|
1891
791
|
#### 切换指定远端用户的大小画面。
|
|
1892
792
|
|
|
1893
|
-
当房间中某个主播开启了双路编码之后，房间中其他用户通过
|
|
1894
|
-
|
|
1895
|
-
您可以通过此接口选定希望订阅的画面是大画面还是小画面，该接口在 [startRemoteView](https://write.woa.com/document/87030026264555520) 之前和之后调用均可生效。
|
|
1896
|
-
<table>
|
|
1897
|
-
<tr>
|
|
1898
|
-
<td rowspan="1" colSpan="1" >参数</td>
|
|
1899
|
-
|
|
1900
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1901
|
-
</tr>
|
|
1902
|
-
|
|
1903
|
-
<tr>
|
|
1904
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
1905
|
-
|
|
1906
|
-
<td rowspan="1" colSpan="1" >视频流类型，即选择看大画面还是小画面，默认为大画面。</td>
|
|
1907
|
-
</tr>
|
|
1908
|
-
|
|
1909
|
-
<tr>
|
|
1910
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
1911
|
-
|
|
1912
|
-
<td rowspan="1" colSpan="1" >指定远端用户的 ID。</td>
|
|
1913
|
-
</tr>
|
|
1914
|
-
</table>
|
|
793
|
+
当房间中某个主播开启了双路编码之后，房间中其他用户通过 startRemoteView 订阅到的画面默认会是【高清大画面】。
|
|
1915
794
|
|
|
795
|
+
您可以通过此接口选定希望订阅的画面是大画面还是小画面，该接口在 startRemoteView 之前和之后调用均可生效。
|
|
796
|
+
| 参数 | 描述 |
|
|
797
|
+
| --- | --- |
|
|
798
|
+
| streamType | 视频流类型，即选择看大画面还是小画面，默认为大画面。 |
|
|
799
|
+
| userId | 指定远端用户的 ID。 |
|
|
1916
800
|
|
|
1917
801
|
> **注意**
|
|
1918
|
-
>
|
|
1919
|
-
|
|
1920
|
-
> 此功能需要目标用户已经通过 [enableSmallVideoStream](https://write.woa.com/document/87030026264555520) 提前开启了双路编码模式，否则此调用无实际效果。
|
|
1921
|
-
>
|
|
802
|
+
>
|
|
1922
803
|
|
|
804
|
+
> 此功能需要目标用户已经通过 enableSmallVideoStream 提前开启了双路编码模式，否则此调用无实际效果。
|
|
805
|
+
>
|
|
1923
806
|
|
|
1924
807
|
## snapshotVideo
|
|
1925
808
|
|
|
1926
|
-
|
|
1927
|
-
|
|
1928
809
|
#### 视频画面截图。
|
|
1929
810
|
|
|
1930
811
|
您可以通过本接口截取本地的视频画面，远端用户的主路画面以及远端用户的辅路（屏幕分享）画面。
|
|
1931
|
-
|
|
1932
|
-
|
|
1933
|
-
|
|
1934
|
-
|
|
1935
|
-
|
|
1936
|
-
</tr>
|
|
1937
|
-
|
|
1938
|
-
<tr>
|
|
1939
|
-
<td rowspan="1" colSpan="1" >sourceType</td>
|
|
1940
|
-
|
|
1941
|
-
<td rowspan="1" colSpan="1" >画面来源，可选择截取视频流画面（[TRTCSnapshotSourceTypeStream](https://write.woa.com/document/87030132707430400)）、视频渲染画面（[TRTCSnapshotSourceTypeView](https://write.woa.com/document/87030132707430400)）或 采集画面（[TRTCSnapshotSourceTypeCapture](https://write.woa.com/document/87030132707430400)），采集画面截图更清晰。</td>
|
|
1942
|
-
</tr>
|
|
1943
|
-
|
|
1944
|
-
<tr>
|
|
1945
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
1946
|
-
|
|
1947
|
-
<td rowspan="1" colSpan="1" >视频流类型，可选择截取主路画面（[TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400)，常用于摄像头）或辅路画面（[TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400)，常用于屏幕分享）。</td>
|
|
1948
|
-
</tr>
|
|
1949
|
-
|
|
1950
|
-
<tr>
|
|
1951
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
1952
|
-
|
|
1953
|
-
<td rowspan="1" colSpan="1" >用户 ID，如指定空置表示截取本地的视频画面。</td>
|
|
1954
|
-
</tr>
|
|
1955
|
-
</table>
|
|
1956
|
-
|
|
812
|
+
| 参数 | 描述 |
|
|
813
|
+
| --- | --- |
|
|
814
|
+
| sourceType | 画面来源，可选择截取视频流画面（TRTCSnapshotSourceTypeStream）、视频渲染画面（TRTCSnapshotSourceTypeView）或 采集画面（TRTCSnapshotSourceTypeCapture），采集画面截图更清晰。 |
|
|
815
|
+
| streamType | 视频流类型，可选择截取主路画面（TRTCVideoStreamTypeBig，常用于摄像头）或辅路画面（TRTCVideoStreamTypeSub，常用于屏幕分享）。 |
|
|
816
|
+
| userId | 用户 ID，如指定空置表示截取本地的视频画面。 |
|
|
1957
817
|
|
|
1958
818
|
> **注意**
|
|
1959
|
-
>
|
|
1960
|
-
|
|
1961
|
-
> Windows 平台目前仅支持截取 [TRTCSnapshotSourceTypeStream](https://write.woa.com/document/87030132707430400) 来源的视频画面。
|
|
1962
|
-
>
|
|
1963
|
-
|
|
1964
|
-
|
|
1965
|
-
## setGravitySensorAdaptiveMode
|
|
819
|
+
>
|
|
1966
820
|
|
|
821
|
+
> Windows 平台目前仅支持截取 TRTCSnapshotSourceTypeStream 来源的视频画面。
|
|
822
|
+
>
|
|
1967
823
|
|
|
824
|
+
## setGravitySensorAdaptiveMode
|
|
1968
825
|
|
|
1969
826
|
#### 设置重力感应的适配模式（11.7 及以上版本）。
|
|
1970
827
|
|
|
@@ -1975,222 +832,112 @@ TRTCCloud 一开始被设计成单例模式，限制了多房间并发观看的
|
|
|
1975
832
|
1. 该接口仅对采集端起作用，如果只是观看房间中的画面，开启此接口是无效的
|
|
1976
833
|
|
|
1977
834
|
2. 当采集端设备发生 90 度或 270 度旋转时，采集端或者观众看到的画面可能会被裁剪以保持比例的协调
|
|
1978
|
-
|
|
1979
|
-
|
|
1980
|
-
|
|
1981
|
-
|
|
1982
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
1983
|
-
</tr>
|
|
1984
|
-
|
|
1985
|
-
<tr>
|
|
1986
|
-
<td rowspan="1" colSpan="1" >mode</td>
|
|
1987
|
-
|
|
1988
|
-
<td rowspan="1" colSpan="1" >重力感应模式，详情请参见 [TRTCGravitySensorAdaptiveMode_Disable](https://write.woa.com/document/87030132707430400)、[TRTCGravitySensorAdaptiveMode_FillByCenterCrop](https://write.woa.com/document/87030132707430400) 和 [TRTCGravitySensorAdaptiveMode_FitWithBlackBorder](https://write.woa.com/document/87030132707430400) 默认值：[TRTCGravitySensorAdaptiveMode_Disable](https://write.woa.com/document/87030132707430400)。</td>
|
|
1989
|
-
</tr>
|
|
1990
|
-
</table>
|
|
1991
|
-
|
|
835
|
+
| 参数 | 描述 |
|
|
836
|
+
| --- | --- |
|
|
837
|
+
| mode | 重力感应模式，详情请参见 TRTCGravitySensorAdaptiveMode_Disable、TRTCGravitySensorAdaptiveMode_FillByCenterCrop 和 TRTCGravitySensorAdaptiveMode_FitWithBlackBorder 默认值：TRTCGravitySensorAdaptiveMode_Disable。 |
|
|
1992
838
|
|
|
1993
839
|
## startLocalAudio
|
|
1994
840
|
|
|
1995
|
-
|
|
1996
|
-
|
|
1997
841
|
#### 开启本地音频的采集和发布。
|
|
1998
842
|
|
|
1999
843
|
SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调用该接口开启麦克风采集，并将音频编码并发布到当前的房间中。
|
|
2000
844
|
|
|
2001
|
-
开启本地音频的采集和发布后，房间中的其他用户会收到
|
|
2002
|
-
|
|
2003
|
-
|
|
2004
|
-
|
|
2005
|
-
|
|
2006
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2007
|
-
</tr>
|
|
2008
|
-
|
|
2009
|
-
<tr>
|
|
2010
|
-
<td rowspan="1" colSpan="1" >quality</td>
|
|
2011
|
-
|
|
2012
|
-
<td rowspan="1" colSpan="1" >声音音质<br>- [TRTCAudioQualitySpeech](https://write.woa.com/document/87030132707430400)，流畅：单声道；音频裸码率：18kbps；适合语音通话为主的场景，例如在线会议，语音通话。<br>- [TRTCAudioQualityDefault](https://write.woa.com/document/87030132707430400)，默认：单声道；音频裸码率：50kbps；SDK 默认的音频质量，如无特殊需求推荐选择之。<br>- [TRTCAudioQualityMusic](https://write.woa.com/document/87030132707430400)，高音质：双声道 + 全频带；音频裸码率：128kbps；适合需要高保真传输音乐的场景，例如在线K歌、音乐直播等。</td>
|
|
2013
|
-
</tr>
|
|
2014
|
-
</table>
|
|
2015
|
-
|
|
845
|
+
开启本地音频的采集和发布后，房间中的其他用户会收到 onUserAudioAvailable(userId, true) 的通知。
|
|
846
|
+
| 参数 | 描述 |
|
|
847
|
+
| --- | --- |
|
|
848
|
+
| quality | 声音音质<br>- TRTCAudioQualitySpeech，流畅：单声道；音频裸码率：18kbps；适合语音通话为主的场景，例如在线会议，语音通话。<br>- TRTCAudioQualityDefault，默认：单声道；音频裸码率：50kbps；SDK 默认的音频质量，如无特殊需求推荐选择之。<br>- TRTCAudioQualityMusic，高音质：双声道 + 全频带；音频裸码率：128kbps；适合需要高保真传输音乐的场景，例如在线K歌、音乐直播等。 |
|
|
2016
849
|
|
|
2017
850
|
> **注意**
|
|
2018
|
-
>
|
|
851
|
+
>
|
|
2019
852
|
|
|
2020
853
|
> 该函数会检查麦克风的使用权限，如果当前 App 没有麦克风权限，SDK 会自动向用户申请麦克风使用权限。
|
|
2021
|
-
>
|
|
2022
|
-
|
|
854
|
+
>
|
|
2023
855
|
|
|
2024
856
|
## stopLocalAudio
|
|
2025
857
|
|
|
2026
|
-
|
|
2027
|
-
|
|
2028
858
|
#### 停止本地音频的采集和发布。
|
|
2029
859
|
|
|
2030
|
-
停止本地音频的采集和发布后，房间中的其他用户会收到
|
|
860
|
+
停止本地音频的采集和发布后，房间中的其他用户会收到 onUserAudioAvailable(userId, false) 的通知。
|
|
2031
861
|
|
|
2032
862
|
## muteLocalAudio
|
|
2033
863
|
|
|
2034
|
-
|
|
2035
|
-
|
|
2036
864
|
#### 暂停/恢复发布本地的音频流。
|
|
2037
865
|
|
|
2038
|
-
当您暂停发布本地音频流之后，房间中的其他用户会收到
|
|
866
|
+
当您暂停发布本地音频流之后，房间中的其他用户会收到 onUserAudioAvailable(userId, false) 的通知。
|
|
2039
867
|
|
|
2040
|
-
当您恢复发布本地音频流之后，房间中的其他用户会收到
|
|
868
|
+
当您恢复发布本地音频流之后，房间中的其他用户会收到 onUserAudioAvailable(userId, true) 的通知。
|
|
2041
869
|
|
|
870
|
+
与 stopLocalAudio 的不同之处在于，` muteLocalAudio(true) ` 并不会释放麦克风权限，而是继续发送码率极低的静音包。
|
|
2042
871
|
|
|
872
|
+
这对于需要云端录制的场景非常适用，因为 MP4 等格式的视频文件，对于音频数据的连续性要求很高，使用 stopLocalAudio 会导致录制出的 MP4 文件不易播放。
|
|
2043
873
|
|
|
2044
|
-
|
|
2045
|
-
|
|
2046
|
-
|
|
2047
|
-
|
|
2048
|
-
因此在对录制文件的质量要求较高的场景中，建议选择 ` muteLocalAudio ` 而不建议使用 [stopLocalAudio](https://write.woa.com/document/87030026264555520)。
|
|
2049
|
-
<table>
|
|
2050
|
-
<tr>
|
|
2051
|
-
<td rowspan="1" colSpan="1" >参数</td>
|
|
2052
|
-
|
|
2053
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2054
|
-
</tr>
|
|
2055
|
-
|
|
2056
|
-
<tr>
|
|
2057
|
-
<td rowspan="1" colSpan="1" >mute</td>
|
|
2058
|
-
|
|
2059
|
-
<td rowspan="1" colSpan="1" >true：静音；false：恢复。</td>
|
|
2060
|
-
</tr>
|
|
2061
|
-
</table>
|
|
2062
|
-
|
|
874
|
+
因此在对录制文件的质量要求较高的场景中，建议选择 ` muteLocalAudio ` 而不建议使用 stopLocalAudio。
|
|
875
|
+
| 参数 | 描述 |
|
|
876
|
+
| --- | --- |
|
|
877
|
+
| mute | true：静音；false：恢复。 |
|
|
2063
878
|
|
|
2064
879
|
## muteRemoteAudio
|
|
2065
880
|
|
|
2066
|
-
|
|
2067
|
-
|
|
2068
881
|
#### 暂停/恢复播放远端的音频流。
|
|
2069
882
|
|
|
2070
883
|
当您静音某用户的远端音频时，SDK 会停止播放指定用户的声音，同时也会停止拉取该用户的音频数据。
|
|
2071
|
-
|
|
2072
|
-
|
|
2073
|
-
|
|
2074
|
-
|
|
2075
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2076
|
-
</tr>
|
|
2077
|
-
|
|
2078
|
-
<tr>
|
|
2079
|
-
<td rowspan="1" colSpan="1" >mute</td>
|
|
2080
|
-
|
|
2081
|
-
<td rowspan="1" colSpan="1" >true：静音；false：取消静音。</td>
|
|
2082
|
-
</tr>
|
|
2083
|
-
|
|
2084
|
-
<tr>
|
|
2085
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
2086
|
-
|
|
2087
|
-
<td rowspan="1" colSpan="1" >用于指定远端用户的 ID。</td>
|
|
2088
|
-
</tr>
|
|
2089
|
-
</table>
|
|
2090
|
-
|
|
884
|
+
| 参数 | 描述 |
|
|
885
|
+
| --- | --- |
|
|
886
|
+
| mute | true：静音；false：取消静音。 |
|
|
887
|
+
| userId | 用于指定远端用户的 ID。 |
|
|
2091
888
|
|
|
2092
889
|
> **注意**
|
|
2093
|
-
>
|
|
2094
|
-
|
|
2095
|
-
> 在进入房间（[enterRoom](https://write.woa.com/document/87030026264555520)）之前或之后调用本接口均生效，静音状态在退出房间（[exitRoom](https://write.woa.com/document/87030026264555520)）之后会被重置为 false。
|
|
2096
|
-
>
|
|
890
|
+
>
|
|
2097
891
|
|
|
892
|
+
> 在进入房间（enterRoom）之前或之后调用本接口均生效，静音状态在退出房间（exitRoom）之后会被重置为 false。
|
|
893
|
+
>
|
|
2098
894
|
|
|
2099
895
|
## muteAllRemoteAudio
|
|
2100
896
|
|
|
2101
|
-
|
|
2102
|
-
|
|
2103
897
|
#### 暂停/恢复播放所有远端用户的音频流。
|
|
2104
898
|
|
|
2105
899
|
当您静音所有用户的远端音频时，SDK 会停止播放所有来自远端的音频流，同时也会停止拉取所有用户的音频数据。
|
|
2106
|
-
|
|
2107
|
-
|
|
2108
|
-
|
|
2109
|
-
|
|
2110
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2111
|
-
</tr>
|
|
2112
|
-
|
|
2113
|
-
<tr>
|
|
2114
|
-
<td rowspan="1" colSpan="1" >mute</td>
|
|
2115
|
-
|
|
2116
|
-
<td rowspan="1" colSpan="1" >true：静音；false：取消静音。</td>
|
|
2117
|
-
</tr>
|
|
2118
|
-
</table>
|
|
2119
|
-
|
|
900
|
+
| 参数 | 描述 |
|
|
901
|
+
| --- | --- |
|
|
902
|
+
| mute | true：静音；false：取消静音。 |
|
|
2120
903
|
|
|
2121
904
|
> **注意**
|
|
2122
|
-
>
|
|
2123
|
-
|
|
2124
|
-
> 在进入房间（[enterRoom](https://write.woa.com/document/87030026264555520)）之前或之后调用本接口均生效，静音状态在退出房间（[exitRoom](https://write.woa.com/document/87030026264555520)）之后会被重置为 false。
|
|
2125
|
-
>
|
|
905
|
+
>
|
|
2126
906
|
|
|
907
|
+
> 在进入房间（enterRoom）之前或之后调用本接口均生效，静音状态在退出房间（exitRoom）之后会被重置为 false。
|
|
908
|
+
>
|
|
2127
909
|
|
|
2128
910
|
## setRemoteAudioVolume
|
|
2129
911
|
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
912
|
#### 设定某一个远端用户的声音播放音量。
|
|
2133
913
|
|
|
2134
914
|
您可以通过 ` setRemoteAudioVolume(userId, 0) ` 将某一个远端用户的声音静音。
|
|
2135
|
-
|
|
2136
|
-
|
|
2137
|
-
|
|
2138
|
-
|
|
2139
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2140
|
-
</tr>
|
|
2141
|
-
|
|
2142
|
-
<tr>
|
|
2143
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
2144
|
-
|
|
2145
|
-
<td rowspan="1" colSpan="1" >用于指定远端用户的 ID。</td>
|
|
2146
|
-
</tr>
|
|
2147
|
-
|
|
2148
|
-
<tr>
|
|
2149
|
-
<td rowspan="1" colSpan="1" >volume</td>
|
|
2150
|
-
|
|
2151
|
-
<td rowspan="1" colSpan="1" >音量大小，取值范围为 [0, 150]，默认值：100。</td>
|
|
2152
|
-
</tr>
|
|
2153
|
-
</table>
|
|
2154
|
-
|
|
915
|
+
| 参数 | 描述 |
|
|
916
|
+
| --- | --- |
|
|
917
|
+
| userId | 用于指定远端用户的 ID。 |
|
|
918
|
+
| volume | 音量大小，取值范围为 [0, 150]，默认值：100。 |
|
|
2155
919
|
|
|
2156
920
|
> **注意**
|
|
2157
|
-
>
|
|
921
|
+
>
|
|
2158
922
|
|
|
2159
923
|
> 如果将 ` volume ` 设置成 100 之后感觉音量还是太小，可以将 ` volume ` 最大设置成 150，但超过 100 的 ` volume ` 会有爆音的风险，请谨慎操作。
|
|
2160
|
-
>
|
|
2161
|
-
|
|
924
|
+
>
|
|
2162
925
|
|
|
2163
926
|
## setAudioCaptureVolume
|
|
2164
927
|
|
|
2165
|
-
|
|
2166
|
-
|
|
2167
928
|
#### 设定本地音频的采集音量。
|
|
2168
|
-
|
|
2169
|
-
|
|
2170
|
-
|
|
2171
|
-
|
|
2172
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2173
|
-
</tr>
|
|
2174
|
-
|
|
2175
|
-
<tr>
|
|
2176
|
-
<td rowspan="1" colSpan="1" >volume</td>
|
|
2177
|
-
|
|
2178
|
-
<td rowspan="1" colSpan="1" >音量大小，取值范围为 [0, 150]；默认值：100。</td>
|
|
2179
|
-
</tr>
|
|
2180
|
-
</table>
|
|
2181
|
-
|
|
929
|
+
| 参数 | 描述 |
|
|
930
|
+
| --- | --- |
|
|
931
|
+
| volume | 音量大小，取值范围为 [0, 150]；默认值：100。 |
|
|
2182
932
|
|
|
2183
933
|
> **注意**
|
|
2184
|
-
>
|
|
934
|
+
>
|
|
2185
935
|
|
|
2186
936
|
> 如果将 ` volume ` 设置成 100 之后感觉音量还是太小，可以将 ` volume ` 最大设置成 150，但超过 100 的 ` volume ` 会有爆音的风险，请谨慎操作。
|
|
2187
|
-
>
|
|
2188
|
-
|
|
937
|
+
>
|
|
2189
938
|
|
|
2190
939
|
## getAudioCaptureVolume
|
|
2191
940
|
|
|
2192
|
-
|
|
2193
|
-
|
|
2194
941
|
#### 获取本地音频的采集音量。
|
|
2195
942
|
|
|
2196
943
|
#### 返回值说明：
|
|
@@ -2199,106 +946,57 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
|
|
|
2199
946
|
|
|
2200
947
|
## setAudioPlayoutVolume
|
|
2201
948
|
|
|
2202
|
-
|
|
2203
|
-
|
|
2204
949
|
#### 设定远端音频的播放音量。
|
|
2205
950
|
|
|
2206
951
|
该接口会控制 SDK 最终交给系统播放的声音音量，调节效果会影响到本地音频录制文件的音量大小，但不会影响到耳返的音量大小。
|
|
2207
|
-
|
|
2208
|
-
|
|
2209
|
-
|
|
2210
|
-
|
|
2211
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2212
|
-
</tr>
|
|
2213
|
-
|
|
2214
|
-
<tr>
|
|
2215
|
-
<td rowspan="1" colSpan="1" >volume</td>
|
|
2216
|
-
|
|
2217
|
-
<td rowspan="1" colSpan="1" >音量大小，取值范围为 [0, 150]，默认值：100。</td>
|
|
2218
|
-
</tr>
|
|
2219
|
-
</table>
|
|
2220
|
-
|
|
952
|
+
| 参数 | 描述 |
|
|
953
|
+
| --- | --- |
|
|
954
|
+
| volume | 音量大小，取值范围为 [0, 150]，默认值：100。 |
|
|
2221
955
|
|
|
2222
956
|
> **注意**
|
|
2223
|
-
>
|
|
957
|
+
>
|
|
2224
958
|
|
|
2225
959
|
> 如果将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作。
|
|
2226
|
-
>
|
|
2227
|
-
|
|
960
|
+
>
|
|
2228
961
|
|
|
2229
962
|
## getAudioPlayoutVolume
|
|
2230
963
|
|
|
2231
|
-
|
|
2232
|
-
|
|
2233
964
|
#### 获取远端音频的播放音量。
|
|
2234
965
|
|
|
2235
966
|
## enableAudioVolumeEvaluation
|
|
2236
967
|
|
|
2237
|
-
|
|
2238
|
-
|
|
2239
968
|
#### 启用音量大小提示。
|
|
2240
969
|
|
|
2241
|
-
开启此功能后，SDK 会在
|
|
2242
|
-
|
|
2243
|
-
|
|
2244
|
-
|
|
2245
|
-
|
|
2246
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2247
|
-
</tr>
|
|
2248
|
-
|
|
2249
|
-
<tr>
|
|
2250
|
-
<td rowspan="1" colSpan="1" >enable</td>
|
|
2251
|
-
|
|
2252
|
-
<td rowspan="1" colSpan="1" >是否启用音量提示，默认为关闭状态。</td>
|
|
2253
|
-
</tr>
|
|
2254
|
-
|
|
2255
|
-
<tr>
|
|
2256
|
-
<td rowspan="1" colSpan="1" >params</td>
|
|
2257
|
-
|
|
2258
|
-
<td rowspan="1" colSpan="1" >音量评估等相关参数，请参见 [TRTCAudioVolumeEvaluateParams](https://write.woa.com/document/87030132707430400)。</td>
|
|
2259
|
-
</tr>
|
|
2260
|
-
</table>
|
|
2261
|
-
|
|
970
|
+
开启此功能后，SDK 会在 ITRTCCloudCallback 中的 onUserVoiceVolume 回调中反馈本地和远端用户的音频音量评估信息，包括音量大小、人声检测、音频频谱等。
|
|
971
|
+
| 参数 | 描述 |
|
|
972
|
+
| --- | --- |
|
|
973
|
+
| enable | 是否启用音量提示，默认为关闭状态。 |
|
|
974
|
+
| params | 音量评估等相关参数，请参见 TRTCAudioVolumeEvaluateParams。 |
|
|
2262
975
|
|
|
2263
976
|
> **注意**
|
|
2264
|
-
>
|
|
2265
|
-
|
|
2266
|
-
> 如需启用音量大小提示，请在调用 [startLocalAudio](https://write.woa.com/document/87030026264555520) 之前调用该接口.
|
|
2267
|
-
>
|
|
977
|
+
>
|
|
2268
978
|
|
|
979
|
+
> 如需启用音量大小提示，请在调用 startLocalAudio 之前调用该接口.
|
|
980
|
+
>
|
|
2269
981
|
|
|
2270
982
|
## startAudioRecording
|
|
2271
983
|
|
|
2272
|
-
|
|
2273
|
-
|
|
2274
984
|
#### 开始录音。
|
|
2275
985
|
|
|
2276
986
|
当您调用该接口后， SDK 会将本地和远端的所有音频（包括本地音频，远端音频，背景音乐和音效等）混合并录制到一个本地文件中。
|
|
2277
987
|
|
|
2278
|
-
该接口在进入房间前后调用均可生效，如果录制任务在退出房间前尚未通过
|
|
2279
|
-
|
|
2280
|
-
本次录制的启动、完成状态会通过本地录制相关回调进行通知。参见 [ITRTCCloudCallback](https://write.woa.com/document/87030021158866944) 相关回调。
|
|
2281
|
-
<table>
|
|
2282
|
-
<tr>
|
|
2283
|
-
<td rowspan="1" colSpan="1" >参数</td>
|
|
2284
|
-
|
|
2285
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2286
|
-
</tr>
|
|
2287
|
-
|
|
2288
|
-
<tr>
|
|
2289
|
-
<td rowspan="1" colSpan="1" >param</td>
|
|
2290
|
-
|
|
2291
|
-
<td rowspan="1" colSpan="1" >录音参数，请参见 [TRTCAudioRecordingParams](https://write.woa.com/document/87030132707430400)。</td>
|
|
2292
|
-
</tr>
|
|
2293
|
-
</table>
|
|
988
|
+
该接口在进入房间前后调用均可生效，如果录制任务在退出房间前尚未通过 stopAudioRecording 停止，则退出房间后录制任务会自动被停止。
|
|
2294
989
|
|
|
990
|
+
本次录制的启动、完成状态会通过本地录制相关回调进行通知。参见 ITRTCCloudCallback 相关回调。
|
|
991
|
+
| 参数 | 描述 |
|
|
992
|
+
| --- | --- |
|
|
993
|
+
| param | 录音参数，请参见 TRTCAudioRecordingParams。 |
|
|
2295
994
|
|
|
2296
995
|
> **注意**
|
|
2297
|
-
>
|
|
2298
|
-
|
|
2299
|
-
> 自 v11.5 版本，音频录制的状态结果由返回值统一调整为异步回调进行通知。参见 [ITRTCCloudCallback](https://write.woa.com/document/87030021158866944) 相关回调。
|
|
2300
|
-
>
|
|
996
|
+
>
|
|
2301
997
|
|
|
998
|
+
> 自 v11.5 版本，音频录制的状态结果由返回值统一调整为异步回调进行通知。参见 ITRTCCloudCallback 相关回调。
|
|
999
|
+
>
|
|
2302
1000
|
|
|
2303
1001
|
#### 返回值说明：
|
|
2304
1002
|
|
|
@@ -2306,206 +1004,95 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
|
|
|
2306
1004
|
|
|
2307
1005
|
## stopAudioRecording
|
|
2308
1006
|
|
|
2309
|
-
|
|
2310
|
-
|
|
2311
1007
|
#### 停止录音。
|
|
2312
1008
|
|
|
2313
1009
|
如果录制任务在退出房间前尚未通过本接口停止，则退出房间后录音任务会自动被停止。
|
|
2314
1010
|
|
|
2315
1011
|
## startLocalRecording
|
|
2316
1012
|
|
|
2317
|
-
|
|
2318
|
-
|
|
2319
1013
|
#### 开启本地媒体录制。
|
|
2320
1014
|
|
|
2321
1015
|
开启后把直播过程中的音视频内容录制到本地的一个文件中，该功能不会产生额外费用。
|
|
2322
|
-
|
|
2323
|
-
|
|
2324
|
-
|
|
2325
|
-
|
|
2326
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2327
|
-
</tr>
|
|
2328
|
-
|
|
2329
|
-
<tr>
|
|
2330
|
-
<td rowspan="1" colSpan="1" >params</td>
|
|
2331
|
-
|
|
2332
|
-
<td rowspan="1" colSpan="1" >录制参数，请参见 [TRTCLocalRecordingParams](https://write.woa.com/document/87030132707430400)。</td>
|
|
2333
|
-
</tr>
|
|
2334
|
-
</table>
|
|
2335
|
-
|
|
1016
|
+
| 参数 | 描述 |
|
|
1017
|
+
| --- | --- |
|
|
1018
|
+
| params | 录制参数，请参见 TRTCLocalRecordingParams。 |
|
|
2336
1019
|
|
|
2337
1020
|
## stopLocalRecording
|
|
2338
1021
|
|
|
2339
|
-
|
|
2340
|
-
|
|
2341
1022
|
#### 停止本地媒体录制。
|
|
2342
1023
|
|
|
2343
1024
|
如果录制任务在退出房间前尚未通过本接口停止，则退出房间后录音任务会自动被停止。
|
|
2344
1025
|
|
|
2345
1026
|
## setRemoteAudioParallelParams
|
|
2346
1027
|
|
|
2347
|
-
|
|
2348
|
-
|
|
2349
1028
|
#### 设置远端音频流智能并发播放策略。
|
|
2350
1029
|
|
|
2351
1030
|
设置远端音频流智能并发播放策略，适用于上麦人数比较多的场景。
|
|
2352
|
-
|
|
2353
|
-
|
|
2354
|
-
|
|
2355
|
-
|
|
2356
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2357
|
-
</tr>
|
|
2358
|
-
|
|
2359
|
-
<tr>
|
|
2360
|
-
<td rowspan="1" colSpan="1" >params</td>
|
|
2361
|
-
|
|
2362
|
-
<td rowspan="1" colSpan="1" >音频并发参数，请参见 [TRTCAudioParallelParams](https://write.woa.com/document/87030132707430400)。</td>
|
|
2363
|
-
</tr>
|
|
2364
|
-
</table>
|
|
2365
|
-
|
|
1031
|
+
| 参数 | 描述 |
|
|
1032
|
+
| --- | --- |
|
|
1033
|
+
| params | 音频并发参数，请参见 TRTCAudioParallelParams。 |
|
|
2366
1034
|
|
|
2367
1035
|
## enable3DSpatialAudioEffect
|
|
2368
1036
|
|
|
2369
|
-
|
|
2370
|
-
|
|
2371
1037
|
#### 启用 3D 音效。
|
|
2372
1038
|
|
|
2373
|
-
启用 3D 音效。注意需使用流畅音质
|
|
2374
|
-
|
|
2375
|
-
|
|
2376
|
-
|
|
2377
|
-
|
|
2378
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2379
|
-
</tr>
|
|
2380
|
-
|
|
2381
|
-
<tr>
|
|
2382
|
-
<td rowspan="1" colSpan="1" >enabled</td>
|
|
2383
|
-
|
|
2384
|
-
<td rowspan="1" colSpan="1" >是否启用 3D 音效，默认为关闭状态。</td>
|
|
2385
|
-
</tr>
|
|
2386
|
-
</table>
|
|
2387
|
-
|
|
1039
|
+
启用 3D 音效。注意需使用流畅音质 TRTCAudioQualitySpeech 或默认音质 TRTCAudioQualityDefault。
|
|
1040
|
+
| 参数 | 描述 |
|
|
1041
|
+
| --- | --- |
|
|
1042
|
+
| enabled | 是否启用 3D 音效，默认为关闭状态。 |
|
|
2388
1043
|
|
|
2389
1044
|
## updateSelf3DSpatialPosition
|
|
2390
1045
|
|
|
2391
|
-
|
|
2392
|
-
|
|
2393
1046
|
#### 设置 3D 音效中自身坐标及朝向信息。
|
|
2394
1047
|
|
|
2395
1048
|
更新自身在世界坐标系中的位置和朝向， SDK 会根据该方法参数计算自身和远端用户之间的相对位置，进而渲染出空间音效。
|
|
2396
|
-
|
|
2397
|
-
|
|
2398
|
-
|
|
2399
|
-
|
|
2400
|
-
|
|
2401
|
-
|
|
2402
|
-
|
|
2403
|
-
<tr>
|
|
2404
|
-
<td rowspan="1" colSpan="1" >axisForward</td>
|
|
2405
|
-
|
|
2406
|
-
<td rowspan="1" colSpan="1" >自身坐标系前轴在世界坐标系中的单位向量，三个值依次表示前、右、上坐标值。</td>
|
|
2407
|
-
</tr>
|
|
2408
|
-
|
|
2409
|
-
<tr>
|
|
2410
|
-
<td rowspan="1" colSpan="1" >axisRight</td>
|
|
2411
|
-
|
|
2412
|
-
<td rowspan="1" colSpan="1" >自身坐标系右轴在世界坐标系中的单位向量，三个值依次表示前、右、上坐标值。</td>
|
|
2413
|
-
</tr>
|
|
2414
|
-
|
|
2415
|
-
<tr>
|
|
2416
|
-
<td rowspan="1" colSpan="1" >axisUp</td>
|
|
2417
|
-
|
|
2418
|
-
<td rowspan="1" colSpan="1" >自身坐标系上轴在世界坐标系中的单位向量，三个值依次表示前、右、上坐标值。</td>
|
|
2419
|
-
</tr>
|
|
2420
|
-
|
|
2421
|
-
<tr>
|
|
2422
|
-
<td rowspan="1" colSpan="1" >position</td>
|
|
2423
|
-
|
|
2424
|
-
<td rowspan="1" colSpan="1" >自身在世界坐标系中的坐标，三个值依次表示前、右、上坐标值。</td>
|
|
2425
|
-
</tr>
|
|
2426
|
-
</table>
|
|
2427
|
-
|
|
1049
|
+
| 参数 | 描述 |
|
|
1050
|
+
| --- | --- |
|
|
1051
|
+
| axisForward | 自身坐标系前轴在世界坐标系中的单位向量，三个值依次表示前、右、上坐标值。 |
|
|
1052
|
+
| axisRight | 自身坐标系右轴在世界坐标系中的单位向量，三个值依次表示前、右、上坐标值。 |
|
|
1053
|
+
| axisUp | 自身坐标系上轴在世界坐标系中的单位向量，三个值依次表示前、右、上坐标值。 |
|
|
1054
|
+
| position | 自身在世界坐标系中的坐标，三个值依次表示前、右、上坐标值。 |
|
|
2428
1055
|
|
|
2429
1056
|
> **注意**
|
|
2430
|
-
>
|
|
1057
|
+
>
|
|
2431
1058
|
|
|
2432
1059
|
> 1. 各参数应分别传入长度为 3 的数组。
|
|
2433
|
-
>
|
|
1060
|
+
>
|
|
2434
1061
|
|
|
2435
1062
|
> 2. 请适当限制调用频率，推荐两次坐标设置至少间隔 100ms。
|
|
2436
|
-
>
|
|
2437
|
-
|
|
1063
|
+
>
|
|
2438
1064
|
|
|
2439
1065
|
## updateRemote3DSpatialPosition
|
|
2440
1066
|
|
|
2441
|
-
|
|
2442
|
-
|
|
2443
1067
|
#### 设置 3D 音效中远端用户坐标信息。
|
|
2444
1068
|
|
|
2445
1069
|
更新远端用户在世界坐标系中的位置，SDK 会根据自身和远端用户之间的相对位置，进而渲染出空间音效。
|
|
2446
|
-
|
|
2447
|
-
|
|
2448
|
-
|
|
2449
|
-
|
|
2450
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2451
|
-
</tr>
|
|
2452
|
-
|
|
2453
|
-
<tr>
|
|
2454
|
-
<td rowspan="1" colSpan="1" >position</td>
|
|
2455
|
-
|
|
2456
|
-
<td rowspan="1" colSpan="1" >该远端用户在世界坐标系中的坐标，三个值依次表示前、右、上坐标值。</td>
|
|
2457
|
-
</tr>
|
|
2458
|
-
|
|
2459
|
-
<tr>
|
|
2460
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
2461
|
-
|
|
2462
|
-
<td rowspan="1" colSpan="1" >指定远端用户的 ID。</td>
|
|
2463
|
-
</tr>
|
|
2464
|
-
</table>
|
|
2465
|
-
|
|
1070
|
+
| 参数 | 描述 |
|
|
1071
|
+
| --- | --- |
|
|
1072
|
+
| position | 该远端用户在世界坐标系中的坐标，三个值依次表示前、右、上坐标值。 |
|
|
1073
|
+
| userId | 指定远端用户的 ID。 |
|
|
2466
1074
|
|
|
2467
1075
|
> **注意**
|
|
2468
|
-
>
|
|
1076
|
+
>
|
|
2469
1077
|
|
|
2470
1078
|
> 1. 各参数应分别传入长度为 3 的数组。
|
|
2471
|
-
>
|
|
1079
|
+
>
|
|
2472
1080
|
|
|
2473
1081
|
> 2. 请适当限制调用频率，推荐同一远端用户两次坐标设置至少间隔 100ms。
|
|
2474
|
-
>
|
|
2475
|
-
|
|
1082
|
+
>
|
|
2476
1083
|
|
|
2477
1084
|
## set3DSpatialReceivingRange
|
|
2478
1085
|
|
|
2479
|
-
|
|
2480
|
-
|
|
2481
1086
|
#### 设置指定用户所发出声音的可被接收范围。
|
|
2482
1087
|
|
|
2483
1088
|
设置该范围大小之后，该指定用户的声音将在该范围内可被听见，超出该范围将被衰减为 0。
|
|
2484
|
-
|
|
2485
|
-
|
|
2486
|
-
|
|
2487
|
-
|
|
2488
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2489
|
-
</tr>
|
|
2490
|
-
|
|
2491
|
-
<tr>
|
|
2492
|
-
<td rowspan="1" colSpan="1" >range</td>
|
|
2493
|
-
|
|
2494
|
-
<td rowspan="1" colSpan="1" >声音最大可被接收范围。</td>
|
|
2495
|
-
</tr>
|
|
2496
|
-
|
|
2497
|
-
<tr>
|
|
2498
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
2499
|
-
|
|
2500
|
-
<td rowspan="1" colSpan="1" >指定远端用户的 ID。</td>
|
|
2501
|
-
</tr>
|
|
2502
|
-
</table>
|
|
2503
|
-
|
|
1089
|
+
| 参数 | 描述 |
|
|
1090
|
+
| --- | --- |
|
|
1091
|
+
| range | 声音最大可被接收范围。 |
|
|
1092
|
+
| userId | 指定远端用户的 ID。 |
|
|
2504
1093
|
|
|
2505
1094
|
## getDeviceManager
|
|
2506
1095
|
|
|
2507
|
-
|
|
2508
|
-
|
|
2509
1096
|
#### 获取设备管理类（TXDeviceManager）。
|
|
2510
1097
|
|
|
2511
1098
|
通过设备管理，您可以设置摄像头、麦克风和扬声器等音视频相关的硬件设备功能。
|
|
@@ -2516,8 +1103,6 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
|
|
|
2516
1103
|
|
|
2517
1104
|
## getBeautyManager
|
|
2518
1105
|
|
|
2519
|
-
|
|
2520
|
-
|
|
2521
1106
|
#### 获取美颜管理类（TXBeautyManager）。
|
|
2522
1107
|
|
|
2523
1108
|
通过美颜管理，您可以使用以下功能：
|
|
@@ -2533,15 +1118,12 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
|
|
|
2533
1118
|
|
|
2534
1119
|
- 设置动态贴纸和人脸挂件等动画特效。
|
|
2535
1120
|
|
|
2536
|
-
|
|
2537
1121
|
#### 返回值说明：
|
|
2538
1122
|
|
|
2539
1123
|
美颜管理类 TXBeautyManager。
|
|
2540
1124
|
|
|
2541
1125
|
## setWaterMark
|
|
2542
1126
|
|
|
2543
|
-
|
|
2544
|
-
|
|
2545
1127
|
#### 添加水印。
|
|
2546
1128
|
|
|
2547
1129
|
水印的位置是通过 xOffset, yOffset, fWidthRatio 来指定的。
|
|
@@ -2551,80 +1133,26 @@ SDK 默认不开启麦克风，当用户需要发布本地音频时，需要调
|
|
|
2551
1133
|
|
|
2552
1134
|
- fWidthRatio：水印的大小比例，取值范围为 [0, 1] 的浮点数。
|
|
2553
1135
|
|
|
2554
|
-
|
|
2555
|
-
|
|
2556
|
-
|
|
2557
|
-
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
|
|
2561
|
-
|
|
2562
|
-
|
|
2563
|
-
|
|
2564
|
-
|
|
2565
|
-
</tr>
|
|
2566
|
-
|
|
2567
|
-
<tr>
|
|
2568
|
-
<td rowspan="1" colSpan="1" >isVisibleOnLocalPreview</td>
|
|
2569
|
-
|
|
2570
|
-
<td rowspan="1" colSpan="1" >true：本地预览显示水印；false：本地预览不显示水印，仅在win/mac下生效。</td>
|
|
2571
|
-
</tr>
|
|
2572
|
-
|
|
2573
|
-
<tr>
|
|
2574
|
-
<td rowspan="1" colSpan="1" >nHeight</td>
|
|
2575
|
-
|
|
2576
|
-
<td rowspan="1" colSpan="1" >水印图片像素高度（源数据为文件路径时忽略该参数）。</td>
|
|
2577
|
-
</tr>
|
|
2578
|
-
|
|
2579
|
-
<tr>
|
|
2580
|
-
<td rowspan="1" colSpan="1" >nWidth</td>
|
|
2581
|
-
|
|
2582
|
-
<td rowspan="1" colSpan="1" >水印图片像素宽度（源数据为文件路径时忽略该参数）。</td>
|
|
2583
|
-
</tr>
|
|
2584
|
-
|
|
2585
|
-
<tr>
|
|
2586
|
-
<td rowspan="1" colSpan="1" >srcData</td>
|
|
2587
|
-
|
|
2588
|
-
<td rowspan="1" colSpan="1" >水印图片源数据（传 nullptr 表示去掉水印）。</td>
|
|
2589
|
-
</tr>
|
|
2590
|
-
|
|
2591
|
-
<tr>
|
|
2592
|
-
<td rowspan="1" colSpan="1" >srcType</td>
|
|
2593
|
-
|
|
2594
|
-
<td rowspan="1" colSpan="1" >水印图片源数据类型。请参见 [TRTCWaterMarkSrcType](https://write.woa.com/document/87030132707430400)。</td>
|
|
2595
|
-
</tr>
|
|
2596
|
-
|
|
2597
|
-
<tr>
|
|
2598
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
2599
|
-
|
|
2600
|
-
<td rowspan="1" colSpan="1" >要设置水印的流类型（[TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400)，[TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400)）。</td>
|
|
2601
|
-
</tr>
|
|
2602
|
-
|
|
2603
|
-
<tr>
|
|
2604
|
-
<td rowspan="1" colSpan="1" >xOffset</td>
|
|
2605
|
-
|
|
2606
|
-
<td rowspan="1" colSpan="1" >水印显示的左上角 x 轴偏移。</td>
|
|
2607
|
-
</tr>
|
|
2608
|
-
|
|
2609
|
-
<tr>
|
|
2610
|
-
<td rowspan="1" colSpan="1" >yOffset</td>
|
|
2611
|
-
|
|
2612
|
-
<td rowspan="1" colSpan="1" >水印显示的左上角 y 轴偏移。</td>
|
|
2613
|
-
</tr>
|
|
2614
|
-
</table>
|
|
2615
|
-
|
|
1136
|
+
| 参数 | 描述 |
|
|
1137
|
+
| --- | --- |
|
|
1138
|
+
| fWidthRatio | 水印显示的宽度占画面宽度比例（水印按该参数等比例缩放显示）。 |
|
|
1139
|
+
| isVisibleOnLocalPreview | true：本地预览显示水印；false：本地预览不显示水印，仅在win/mac下生效。 |
|
|
1140
|
+
| nHeight | 水印图片像素高度（源数据为文件路径时忽略该参数）。 |
|
|
1141
|
+
| nWidth | 水印图片像素宽度（源数据为文件路径时忽略该参数）。 |
|
|
1142
|
+
| srcData | 水印图片源数据（传 nullptr 表示去掉水印）。 |
|
|
1143
|
+
| srcType | 水印图片源数据类型。请参见 TRTCWaterMarkSrcType。 |
|
|
1144
|
+
| streamType | 要设置水印的流类型（TRTCVideoStreamTypeBig，TRTCVideoStreamTypeSub）。 |
|
|
1145
|
+
| xOffset | 水印显示的左上角 x 轴偏移。 |
|
|
1146
|
+
| yOffset | 水印显示的左上角 y 轴偏移。 |
|
|
2616
1147
|
|
|
2617
1148
|
> **注意**
|
|
2618
|
-
>
|
|
1149
|
+
>
|
|
2619
1150
|
|
|
2620
1151
|
> 本接口只支持给主路视频添加图片水印。
|
|
2621
|
-
>
|
|
2622
|
-
|
|
1152
|
+
>
|
|
2623
1153
|
|
|
2624
1154
|
## getAudioEffectManager
|
|
2625
1155
|
|
|
2626
|
-
|
|
2627
|
-
|
|
2628
1156
|
#### 获取音效管理类（TXAudioEffectManager）。
|
|
2629
1157
|
|
|
2630
1158
|
TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如下功能：
|
|
@@ -2638,15 +1166,12 @@ TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如
|
|
|
2638
1166
|
|
|
2639
1167
|
- 短音效：鼓掌声、欢笑声等简短的音效文件（对于小于10秒的文件，请将 isShortFile 参数设置为 true）。
|
|
2640
1168
|
|
|
2641
|
-
|
|
2642
1169
|
#### 返回值说明：
|
|
2643
1170
|
|
|
2644
1171
|
音效管理类 TXAudioEffectManager。
|
|
2645
1172
|
|
|
2646
1173
|
## startSystemAudioLoopback
|
|
2647
1174
|
|
|
2648
|
-
|
|
2649
|
-
|
|
2650
1175
|
#### 开启系统声音采集（iOS 端暂未支持）。
|
|
2651
1176
|
|
|
2652
1177
|
该接口会从电脑的声卡中采集音频数据，并将其混入到 SDK 当前的音频数据流中，从而使房间中的其他用户也能听到主播的电脑所播放出的声音。
|
|
@@ -2654,177 +1179,100 @@ TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如
|
|
|
2654
1179
|
在线教育场景中，老师可以使用此功能让 SDK 采集教学影片中的声音，并广播给同房间中的学生。
|
|
2655
1180
|
|
|
2656
1181
|
音乐直播场景中，主播可以使用此功能让 SDK 采集音乐播放器中的音乐，从而为自己的直播间增加背景音乐。
|
|
2657
|
-
|
|
2658
|
-
|
|
2659
|
-
|
|
2660
|
-
|
|
2661
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2662
|
-
</tr>
|
|
2663
|
-
|
|
2664
|
-
<tr>
|
|
2665
|
-
<td rowspan="1" colSpan="1" >deviceName</td>
|
|
2666
|
-
|
|
2667
|
-
<td rowspan="1" colSpan="1" >您可以指定该参数为空值（nullptr），代表让 SDK 采集整个系统的声音。</td>
|
|
2668
|
-
</tr>
|
|
2669
|
-
</table>
|
|
2670
|
-
|
|
1182
|
+
| 参数 | 描述 |
|
|
1183
|
+
| --- | --- |
|
|
1184
|
+
| deviceName | 您可以指定该参数为空值（nullptr），代表让 SDK 采集整个系统的声音。 |
|
|
2671
1185
|
|
|
2672
1186
|
> **注意**
|
|
2673
|
-
>
|
|
1187
|
+
>
|
|
2674
1188
|
|
|
2675
1189
|
> 在 Windows 平台下，您也可以将参数 ` deviceName ` 设置为某个应用程序的可执行文件（如 QQMuisc.exe）的绝对路径，此时 SDK 只会采集该应用程序的声音（支持 32 位版本的 SDK，64 位版本的 SDK 需要满足 Windows 版本为 10.0.19042 或更高版本）。
|
|
2676
|
-
>
|
|
1190
|
+
>
|
|
2677
1191
|
|
|
2678
|
-
> 您也可以指定该参数为某个扬声器设备的名称来采集特定扬声器声音（通过接口 TXDeviceManager 中的 getDevicesList 接口，可以获取类型为
|
|
2679
|
-
>
|
|
1192
|
+
> 您也可以指定该参数为某个扬声器设备的名称来采集特定扬声器声音（通过接口 TXDeviceManager 中的 getDevicesList 接口，可以获取类型为 TXMediaDeviceTypeSpeaker 的扬声器设备）。
|
|
1193
|
+
>
|
|
2680
1194
|
|
|
2681
1195
|
> 在 Windows 平台下您也可以指定该参数为某个进程的进程 id（格式为 “process_xxx”，其中 xxx 为进程 id），此时 SDK 知会采集该进程的声音（需要满足 Windows 版本为 10.0.19042或更高版本）。
|
|
2682
|
-
>
|
|
1196
|
+
>
|
|
2683
1197
|
|
|
2684
1198
|
> 在 Windows 平台下您也可以指定该参数为某个进程的进程 id（格式为 “exclude_process_xxx”，其中 xxx 为进程 id），此时 SDK 会采集除了该进程的其他所有声音（需要满足 Windows 版本为 10.0.19042或更高版本）。
|
|
2685
|
-
>
|
|
2686
|
-
|
|
1199
|
+
>
|
|
2687
1200
|
|
|
2688
1201
|
## stopSystemAudioLoopback
|
|
2689
1202
|
|
|
2690
|
-
|
|
2691
|
-
|
|
2692
1203
|
#### 停止系统声音采集（iOS 端暂未支持）。
|
|
2693
1204
|
|
|
2694
1205
|
## setSystemAudioLoopbackVolume
|
|
2695
1206
|
|
|
2696
|
-
|
|
2697
|
-
|
|
2698
1207
|
#### 设置系统声音的采集音量。
|
|
2699
|
-
|
|
2700
|
-
|
|
2701
|
-
|
|
2702
|
-
|
|
2703
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2704
|
-
</tr>
|
|
2705
|
-
|
|
2706
|
-
<tr>
|
|
2707
|
-
<td rowspan="1" colSpan="1" >volume</td>
|
|
2708
|
-
|
|
2709
|
-
<td rowspan="1" colSpan="1" >设置的音量大小，范围是：[0, 150]，默认值为 100。</td>
|
|
2710
|
-
</tr>
|
|
2711
|
-
</table>
|
|
2712
|
-
|
|
1208
|
+
| 参数 | 描述 |
|
|
1209
|
+
| --- | --- |
|
|
1210
|
+
| volume | 设置的音量大小，范围是：[0, 150]，默认值为 100。 |
|
|
2713
1211
|
|
|
2714
1212
|
## startScreenCapture
|
|
2715
1213
|
|
|
2716
|
-
|
|
2717
|
-
|
|
2718
1214
|
#### 启动屏幕分享。
|
|
2719
1215
|
|
|
2720
1216
|
该接口可以抓取整个屏幕的内容，或抓取您指定的某个应用的窗口内容，并将其分享给同房间中的其他用户。
|
|
2721
|
-
|
|
2722
|
-
|
|
2723
|
-
|
|
2724
|
-
|
|
2725
|
-
|
|
2726
|
-
</tr>
|
|
2727
|
-
|
|
2728
|
-
<tr>
|
|
2729
|
-
<td rowspan="1" colSpan="1" >encParam</td>
|
|
2730
|
-
|
|
2731
|
-
<td rowspan="1" colSpan="1" >屏幕分享的画面编码参数，SDK 会优先使用您通过此接口设置的编码参数：<br>- 如果您设置 ` encParam ` 为空值，且您已通过 [setSubStreamEncoderParam](https://write.woa.com/document/87030026264555520) 设置过辅路视频编码参数，SDK 将使用您设置过的辅路编码参数进行屏幕分享。<br>- 如果您设置 ` encParam ` 为空值，且您未通过 [setSubStreamEncoderParam](https://write.woa.com/document/87030026264555520) 设置过辅路视频编码参数，SDK 将自动选择一个最佳的编码参数进行屏幕分享。</td>
|
|
2732
|
-
</tr>
|
|
2733
|
-
|
|
2734
|
-
<tr>
|
|
2735
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
2736
|
-
|
|
2737
|
-
<td rowspan="1" colSpan="1" >屏幕分享使用的线路，可以设置为主路（TRTCVideoStreamTypeBig）或者辅路（TRTCVideoStreamTypeSub），推荐使用辅路。</td>
|
|
2738
|
-
</tr>
|
|
2739
|
-
|
|
2740
|
-
<tr>
|
|
2741
|
-
<td rowspan="1" colSpan="1" >view</td>
|
|
2742
|
-
|
|
2743
|
-
<td rowspan="1" colSpan="1" >渲染控件所在的父控件，可以设置为空值，表示不显示屏幕分享的预览效果。</td>
|
|
2744
|
-
</tr>
|
|
2745
|
-
</table>
|
|
2746
|
-
|
|
1217
|
+
| 参数 | 描述 |
|
|
1218
|
+
| --- | --- |
|
|
1219
|
+
| encParam | 屏幕分享的画面编码参数，SDK 会优先使用您通过此接口设置的编码参数：<br>- 如果您设置 ` encParam ` 为空值，且您已通过 setSubStreamEncoderParam 设置过辅路视频编码参数，SDK 将使用您设置过的辅路编码参数进行屏幕分享。<br>- 如果您设置 ` encParam ` 为空值，且您未通过 setSubStreamEncoderParam 设置过辅路视频编码参数，SDK 将自动选择一个最佳的编码参数进行屏幕分享。 |
|
|
1220
|
+
| streamType | 屏幕分享使用的线路，可以设置为主路（TRTCVideoStreamTypeBig）或者辅路（TRTCVideoStreamTypeSub），推荐使用辅路。 |
|
|
1221
|
+
| view | 渲染控件所在的父控件，可以设置为空值，表示不显示屏幕分享的预览效果。 |
|
|
2747
1222
|
|
|
2748
1223
|
> **注意**
|
|
2749
|
-
>
|
|
1224
|
+
>
|
|
2750
1225
|
|
|
2751
|
-
> 1. 同一个用户同时最多只能发布一路主路（
|
|
2752
|
-
>
|
|
1226
|
+
> 1. 同一个用户同时最多只能发布一路主路（TRTCVideoStreamTypeBig）画面和一路辅路（TRTCVideoStreamTypeSub）画面。
|
|
1227
|
+
>
|
|
2753
1228
|
|
|
2754
|
-
> 2. 默认情况下，屏幕分享使用辅路画面。如果使用主路做屏幕分享，您需要提前停止摄像头采集（
|
|
2755
|
-
>
|
|
1229
|
+
> 2. 默认情况下，屏幕分享使用辅路画面。如果使用主路做屏幕分享，您需要提前停止摄像头采集（stopLocalPreview）以避免相互冲突。
|
|
1230
|
+
>
|
|
2756
1231
|
|
|
2757
1232
|
> 3. 同一个房间中同时只能有一个用户使用辅路做屏幕分享，也就是说，同一个房间中同时只允许一个用户开启辅路。
|
|
2758
|
-
>
|
|
2759
|
-
|
|
2760
|
-
> 4. 当房间中已经有其他用户在使用辅路分享屏幕时，此时调用该接口会收到来自 [ITRTCCloudCallback](https://write.woa.com/document/87030021158866944) 的 ` onError(ERR_SERVER_CENTER_ANOTHER_USER_PUSH_SUB_VIDEO) ` 回调。
|
|
2761
|
-
>
|
|
1233
|
+
>
|
|
2762
1234
|
|
|
1235
|
+
> 4. 当房间中已经有其他用户在使用辅路分享屏幕时，此时调用该接口会收到来自 ITRTCCloudCallback 的 ` onError(ERR_SERVER_CENTER_ANOTHER_USER_PUSH_SUB_VIDEO) ` 回调。
|
|
1236
|
+
>
|
|
2763
1237
|
|
|
2764
1238
|
## stopScreenCapture
|
|
2765
1239
|
|
|
2766
|
-
|
|
2767
|
-
|
|
2768
1240
|
#### 停止屏幕分享。
|
|
2769
1241
|
|
|
2770
1242
|
## pauseScreenCapture
|
|
2771
1243
|
|
|
2772
|
-
|
|
2773
|
-
|
|
2774
1244
|
#### 暂停屏幕分享。
|
|
2775
1245
|
|
|
2776
1246
|
> **注意**
|
|
2777
|
-
>
|
|
1247
|
+
>
|
|
2778
1248
|
|
|
2779
1249
|
> 从v11.5版本开始，暂停屏幕采集会使用最后一帧按照 1 fps 帧率输出。
|
|
2780
|
-
>
|
|
2781
|
-
|
|
1250
|
+
>
|
|
2782
1251
|
|
|
2783
1252
|
## resumeScreenCapture
|
|
2784
1253
|
|
|
2785
|
-
|
|
2786
|
-
|
|
2787
1254
|
#### 恢复屏幕分享。
|
|
2788
1255
|
|
|
2789
1256
|
## getScreenCaptureSources
|
|
2790
1257
|
|
|
2791
|
-
|
|
2792
|
-
|
|
2793
1258
|
#### 枚举可分享的屏幕和窗口（该接口仅支持桌面系统）。
|
|
2794
1259
|
|
|
2795
1260
|
当您在对接桌面端系统的屏幕分享功能时，一般都需要展示一个选择分享目标的界面，这样用户能够使用这个界面选择是分享整个屏幕还是某个窗口。
|
|
2796
1261
|
|
|
2797
1262
|
通过本接口，您就可以查询到当前系统中可用于分享的窗口的 ID、名称以及缩略图。我们在 Demo 中提供了一份默认的界面实现供您参考。
|
|
2798
|
-
|
|
2799
|
-
|
|
2800
|
-
|
|
2801
|
-
|
|
2802
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2803
|
-
</tr>
|
|
2804
|
-
|
|
2805
|
-
<tr>
|
|
2806
|
-
<td rowspan="1" colSpan="1" >iconSize</td>
|
|
2807
|
-
|
|
2808
|
-
<td rowspan="1" colSpan="1" >指定要获取的窗口图标大小。</td>
|
|
2809
|
-
</tr>
|
|
2810
|
-
|
|
2811
|
-
<tr>
|
|
2812
|
-
<td rowspan="1" colSpan="1" >thumbnailSize</td>
|
|
2813
|
-
|
|
2814
|
-
<td rowspan="1" colSpan="1" >指定要获取的窗口缩略图大小，缩略图可用于绘制在窗口选择界面上。</td>
|
|
2815
|
-
</tr>
|
|
2816
|
-
</table>
|
|
2817
|
-
|
|
1263
|
+
| 参数 | 描述 |
|
|
1264
|
+
| --- | --- |
|
|
1265
|
+
| iconSize | 指定要获取的窗口图标大小。 |
|
|
1266
|
+
| thumbnailSize | 指定要获取的窗口缩略图大小，缩略图可用于绘制在窗口选择界面上。 |
|
|
2818
1267
|
|
|
2819
1268
|
> **注意**
|
|
2820
|
-
>
|
|
1269
|
+
>
|
|
2821
1270
|
|
|
2822
1271
|
> 1. 返回的列表中包含屏幕和应用窗口，屏幕是列表中的第一个元素。如果用户有多个显示器，那么每个显示器都是一个分享目标。
|
|
2823
|
-
>
|
|
1272
|
+
>
|
|
2824
1273
|
|
|
2825
1274
|
> 2. 请不要使用 ` delete ITRTCScreenCaptureSourceList* ` 删除 SourceList，这很容易导致崩溃，请使用 ITRTCScreenCaptureSourceList 中的 release 方法释放列表。
|
|
2826
|
-
>
|
|
2827
|
-
|
|
1275
|
+
>
|
|
2828
1276
|
|
|
2829
1277
|
#### 返回值说明：
|
|
2830
1278
|
|
|
@@ -2832,281 +1280,149 @@ TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如
|
|
|
2832
1280
|
|
|
2833
1281
|
## selectScreenCaptureTarget
|
|
2834
1282
|
|
|
2835
|
-
|
|
2836
|
-
|
|
2837
1283
|
#### 选取要分享的屏幕或窗口（该接口仅支持桌面系统）。
|
|
2838
1284
|
|
|
2839
|
-
当您通过
|
|
1285
|
+
当您通过 getScreenCaptureSources 获取到可以分享的屏幕和窗口之后，您可以调用该接口选定期望分享的目标屏幕或目标窗口。
|
|
2840
1286
|
|
|
2841
1287
|
在屏幕分享的过程中，您也可以随时调用该接口以切换分享目标。
|
|
2842
1288
|
|
|
2843
|
-
|
|
2844
|
-
|
|
2845
1289
|
支持如下四种情况：
|
|
2846
|
-
- 共享整个屏幕：source 中 type 为
|
|
2847
|
-
|
|
2848
|
-
- 共享指定区域：source 中 type 为 [TRTCScreenCaptureSourceTypeScreen](https://write.woa.com/document/87030132707430400) 的 source，captureRect 设为非 nullptr，例如 { 100, 100, 300, 300 }。
|
|
2849
|
-
|
|
2850
|
-
- 共享整个窗口：source 中 type 为 [TRTCScreenCaptureSourceTypeWindow](https://write.woa.com/document/87030132707430400) 的 source，captureRect 设为 { 0, 0, 0, 0 }。
|
|
2851
|
-
|
|
2852
|
-
- 共享窗口区域：source 中 type 为 [TRTCScreenCaptureSourceTypeWindow](https://write.woa.com/document/87030132707430400) 的 source，captureRect 设为非 nullptr，例如 { 100, 100, 300, 300 }。
|
|
2853
|
-
|
|
2854
|
-
<table>
|
|
2855
|
-
<tr>
|
|
2856
|
-
<td rowspan="1" colSpan="1" >参数</td>
|
|
2857
|
-
|
|
2858
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2859
|
-
</tr>
|
|
2860
|
-
|
|
2861
|
-
<tr>
|
|
2862
|
-
<td rowspan="1" colSpan="1" >captureRect</td>
|
|
1290
|
+
- 共享整个屏幕：source 中 type 为 TRTCScreenCaptureSourceTypeScreen 的 source，captureRect 设为 { 0, 0, 0, 0 }。
|
|
2863
1291
|
|
|
2864
|
-
|
|
2865
|
-
</tr>
|
|
1292
|
+
- 共享指定区域：source 中 type 为 TRTCScreenCaptureSourceTypeScreen 的 source，captureRect 设为非 nullptr，例如 { 100, 100, 300, 300 }。
|
|
2866
1293
|
|
|
2867
|
-
|
|
2868
|
-
<td rowspan="1" colSpan="1" >property</td>
|
|
1294
|
+
- 共享整个窗口：source 中 type 为 TRTCScreenCaptureSourceTypeWindow 的 source，captureRect 设为 { 0, 0, 0, 0 }。
|
|
2869
1295
|
|
|
2870
|
-
|
|
2871
|
-
</tr>
|
|
2872
|
-
|
|
2873
|
-
<tr>
|
|
2874
|
-
<td rowspan="1" colSpan="1" >source</td>
|
|
2875
|
-
|
|
2876
|
-
<td rowspan="1" colSpan="1" >指定分享源。详情参考 [TRTCScreenCaptureSourceInfo](https://write.woa.com/document/87030132707430400)</td>
|
|
2877
|
-
</tr>
|
|
2878
|
-
</table>
|
|
1296
|
+
- 共享窗口区域：source 中 type 为 TRTCScreenCaptureSourceTypeWindow 的 source，captureRect 设为非 nullptr，例如 { 100, 100, 300, 300 }。
|
|
2879
1297
|
|
|
1298
|
+
| 参数 | 描述 |
|
|
1299
|
+
| --- | --- |
|
|
1300
|
+
| captureRect | 指定捕获的区域。 |
|
|
1301
|
+
| property | 指定屏幕分享目标的属性，包括捕获鼠标，高亮捕获窗口等，详情参考 TRTCScreenCaptureProperty。 |
|
|
1302
|
+
| source | 指定分享源。详情参考 TRTCScreenCaptureSourceInfo |
|
|
2880
1303
|
|
|
2881
1304
|
> **注意**
|
|
2882
|
-
>
|
|
1305
|
+
>
|
|
2883
1306
|
|
|
2884
1307
|
> 设置高亮边框颜色、宽度参数在 Mac 平台不生效。
|
|
2885
|
-
>
|
|
2886
|
-
|
|
1308
|
+
>
|
|
2887
1309
|
|
|
2888
1310
|
## setSubStreamEncoderParam
|
|
2889
1311
|
|
|
2890
|
-
|
|
2891
|
-
|
|
2892
1312
|
#### 设置屏幕分享（即辅路）的视频编码参数（桌面系统和移动系统均已支持）。
|
|
2893
1313
|
|
|
2894
1314
|
该接口可以设定远端用户所看到的屏幕分享（即辅路）的画面质量，同时也能决定云端录制出的视频文件中屏幕分享的画面质量。
|
|
2895
1315
|
|
|
2896
1316
|
请注意如下两个接口的差异：
|
|
2897
|
-
-
|
|
2898
|
-
|
|
2899
|
-
- [setSubStreamEncoderParam](https://write.woa.com/document/87030026264555520) 用于设置辅路画面（[TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400)，一般用于屏幕分享）的视频编码参数。
|
|
2900
|
-
|
|
2901
|
-
<table>
|
|
2902
|
-
<tr>
|
|
2903
|
-
<td rowspan="1" colSpan="1" >参数</td>
|
|
2904
|
-
|
|
2905
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2906
|
-
</tr>
|
|
1317
|
+
- setVideoEncoderParam 用于设置主路画面（TRTCVideoStreamTypeBig，一般用于摄像头）的视频编码参数。
|
|
2907
1318
|
|
|
2908
|
-
|
|
2909
|
-
<td rowspan="1" colSpan="1" >param</td>
|
|
2910
|
-
|
|
2911
|
-
<td rowspan="1" colSpan="1" >辅流编码参数，详情请参见 [TRTCVideoEncParam](https://write.woa.com/document/87030132707430400)。</td>
|
|
2912
|
-
</tr>
|
|
2913
|
-
</table>
|
|
1319
|
+
- setSubStreamEncoderParam 用于设置辅路画面（TRTCVideoStreamTypeSub，一般用于屏幕分享）的视频编码参数。
|
|
2914
1320
|
|
|
1321
|
+
| 参数 | 描述 |
|
|
1322
|
+
| --- | --- |
|
|
1323
|
+
| param | 辅流编码参数，详情请参见 TRTCVideoEncParam。 |
|
|
2915
1324
|
|
|
2916
1325
|
## setSubStreamMixVolume
|
|
2917
1326
|
|
|
2918
|
-
|
|
2919
|
-
|
|
2920
1327
|
#### 设置屏幕分享时的混音音量大小（该接口仅支持桌面系统）。
|
|
2921
1328
|
|
|
2922
1329
|
这个数值越高，屏幕分享音量的占比就越高，麦克风音量占比就越小，所以不推荐设置得太大，否则会导致麦克风的声音被压制。
|
|
2923
|
-
|
|
2924
|
-
|
|
2925
|
-
|
|
2926
|
-
|
|
2927
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2928
|
-
</tr>
|
|
2929
|
-
|
|
2930
|
-
<tr>
|
|
2931
|
-
<td rowspan="1" colSpan="1" >volume</td>
|
|
2932
|
-
|
|
2933
|
-
<td rowspan="1" colSpan="1" >设置的混音音量大小，范围 [0, 150]。</td>
|
|
2934
|
-
</tr>
|
|
2935
|
-
</table>
|
|
2936
|
-
|
|
1330
|
+
| 参数 | 描述 |
|
|
1331
|
+
| --- | --- |
|
|
1332
|
+
| volume | 设置的混音音量大小，范围 [0, 150]。 |
|
|
2937
1333
|
|
|
2938
1334
|
## addExcludedShareWindow
|
|
2939
1335
|
|
|
2940
|
-
|
|
2941
|
-
|
|
2942
1336
|
#### 将指定窗口加入屏幕分享的排除列表中（该接口仅支持桌面系统）。
|
|
2943
1337
|
|
|
2944
1338
|
加入排除列表中的窗口不会被分享出去，常见的用法是将某个应用的窗口加入到排除列表中以避免隐私问题。
|
|
2945
1339
|
|
|
2946
1340
|
支持启动屏幕分享前设置过滤窗口，也支持屏幕分享过程中动态添加过滤窗口。
|
|
2947
|
-
|
|
2948
|
-
|
|
2949
|
-
|
|
2950
|
-
|
|
2951
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2952
|
-
</tr>
|
|
2953
|
-
|
|
2954
|
-
<tr>
|
|
2955
|
-
<td rowspan="1" colSpan="1" >windowID</td>
|
|
2956
|
-
|
|
2957
|
-
<td rowspan="1" colSpan="1" >不希望分享出去的窗口</td>
|
|
2958
|
-
</tr>
|
|
2959
|
-
</table>
|
|
2960
|
-
|
|
1341
|
+
| 参数 | 描述 |
|
|
1342
|
+
| --- | --- |
|
|
1343
|
+
| windowID | 不希望分享出去的窗口 |
|
|
2961
1344
|
|
|
2962
1345
|
> **注意**
|
|
2963
|
-
>
|
|
1346
|
+
>
|
|
2964
1347
|
|
|
2965
|
-
> 1. 该接口只有在
|
|
2966
|
-
>
|
|
1348
|
+
> 1. 该接口只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeScreen 时生效，即只有在分享整个屏幕内容时，排除指定窗口的功能才生效。
|
|
1349
|
+
>
|
|
2967
1350
|
|
|
2968
1351
|
> 2. 使用该接口添加到排除列表中的窗口会在退出房间后被 SDK 自动清除。
|
|
2969
|
-
>
|
|
2970
|
-
|
|
2971
|
-
> 3. Mac 平台下请传入窗口 ID（即 CGWindowID），您可以通过 [TRTCScreenCaptureSourceInfo](https://write.woa.com/document/87030132707430400) 中的 ` sourceId ` 成员获得。
|
|
2972
|
-
>
|
|
1352
|
+
>
|
|
2973
1353
|
|
|
1354
|
+
> 3. Mac 平台下请传入窗口 ID（即 CGWindowID），您可以通过 TRTCScreenCaptureSourceInfo 中的 ` sourceId ` 成员获得。
|
|
1355
|
+
>
|
|
2974
1356
|
|
|
2975
1357
|
## removeExcludedShareWindow
|
|
2976
1358
|
|
|
2977
|
-
|
|
2978
|
-
|
|
2979
1359
|
#### 将指定窗口从屏幕分享的排除列表中移除（该接口仅支持桌面系统）。
|
|
2980
|
-
|
|
2981
|
-
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
2985
|
-
</tr>
|
|
2986
|
-
|
|
2987
|
-
<tr>
|
|
2988
|
-
<td rowspan="1" colSpan="1" >windowID</td>
|
|
2989
|
-
|
|
2990
|
-
<td rowspan="1" colSpan="1" >要排除的窗口 id。</td>
|
|
2991
|
-
</tr>
|
|
2992
|
-
</table>
|
|
2993
|
-
|
|
2994
|
-
|
|
2995
|
-
## removeAllExcludedShareWindow
|
|
2996
|
-
|
|
2997
|
-
|
|
2998
|
-
|
|
2999
|
-
#### 将所有窗口从屏幕分享的排除列表中移除（该接口仅支持桌面系统）。
|
|
3000
|
-
|
|
3001
|
-
## addIncludedShareWindow
|
|
3002
|
-
|
|
3003
|
-
|
|
3004
|
-
|
|
3005
|
-
#### 将指定窗口加入屏幕分享的包含列表中（该接口仅支持桌面系统）。
|
|
1360
|
+
| 参数 | 描述 |
|
|
1361
|
+
| --- | --- |
|
|
1362
|
+
| windowID | 要排除的窗口 id。 |
|
|
3006
1363
|
|
|
3007
|
-
|
|
1364
|
+
## removeAllExcludedShareWindow
|
|
3008
1365
|
|
|
3009
|
-
|
|
3010
|
-
<table>
|
|
3011
|
-
<tr>
|
|
3012
|
-
<td rowspan="1" colSpan="1" >参数</td>
|
|
1366
|
+
#### 将所有窗口从屏幕分享的排除列表中移除（该接口仅支持桌面系统）。
|
|
3013
1367
|
|
|
3014
|
-
|
|
3015
|
-
</tr>
|
|
1368
|
+
## addIncludedShareWindow
|
|
3016
1369
|
|
|
3017
|
-
|
|
3018
|
-
<td rowspan="1" colSpan="1" >windowID</td>
|
|
1370
|
+
#### 将指定窗口加入屏幕分享的包含列表中（该接口仅支持桌面系统）。
|
|
3019
1371
|
|
|
3020
|
-
|
|
3021
|
-
</tr>
|
|
3022
|
-
</table>
|
|
1372
|
+
该接口只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效。即只有在分享窗口内容时，额外包含指定窗口的功能才生效。
|
|
3023
1373
|
|
|
1374
|
+
您在 startScreenCapture 之前和之后调用均可。
|
|
1375
|
+
| 参数 | 描述 |
|
|
1376
|
+
| --- | --- |
|
|
1377
|
+
| windowID | 希望被分享出去的窗口（Windows 平台下为窗口句柄： HWND） |
|
|
3024
1378
|
|
|
3025
1379
|
> **注意**
|
|
3026
|
-
>
|
|
1380
|
+
>
|
|
3027
1381
|
|
|
3028
1382
|
> 通过该方法添加到包含列表中的窗口，会在退出房间后被 SDK 自动清除。
|
|
3029
|
-
>
|
|
3030
|
-
|
|
1383
|
+
>
|
|
3031
1384
|
|
|
3032
1385
|
## removeIncludedShareWindow
|
|
3033
1386
|
|
|
3034
|
-
|
|
3035
|
-
|
|
3036
1387
|
#### 将指定窗口从屏幕分享的包含列表中移除（该接口仅支持桌面系统）。
|
|
3037
1388
|
|
|
3038
|
-
该接口只有在
|
|
1389
|
+
该接口只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效。
|
|
3039
1390
|
|
|
3040
1391
|
即只有在分享窗口内容时，额外包含指定窗口的功能才生效。
|
|
3041
|
-
|
|
3042
|
-
|
|
3043
|
-
|
|
3044
|
-
|
|
3045
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3046
|
-
</tr>
|
|
3047
|
-
|
|
3048
|
-
<tr>
|
|
3049
|
-
<td rowspan="1" colSpan="1" >windowID</td>
|
|
3050
|
-
|
|
3051
|
-
<td rowspan="1" colSpan="1" >希望被分享出去的窗口（Mac 平台：窗口 ID；Windows 平台：HWND）</td>
|
|
3052
|
-
</tr>
|
|
3053
|
-
</table>
|
|
3054
|
-
|
|
1392
|
+
| 参数 | 描述 |
|
|
1393
|
+
| --- | --- |
|
|
1394
|
+
| windowID | 希望被分享出去的窗口（Mac 平台：窗口 ID；Windows 平台：HWND） |
|
|
3055
1395
|
|
|
3056
1396
|
## removeAllIncludedShareWindow
|
|
3057
1397
|
|
|
3058
|
-
|
|
3059
|
-
|
|
3060
1398
|
#### 将全部窗口从屏幕分享的包含列表中移除（该接口仅支持桌面系统）。
|
|
3061
1399
|
|
|
3062
|
-
该接口只有在
|
|
1400
|
+
该接口只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeWindow 时生效。
|
|
3063
1401
|
|
|
3064
1402
|
即只有在分享窗口内容时，额外包含指定窗口的功能才生效。
|
|
3065
1403
|
|
|
3066
1404
|
## enableCustomVideoCapture
|
|
3067
1405
|
|
|
3068
|
-
|
|
3069
|
-
|
|
3070
1406
|
#### 启用/关闭视频自定义采集模式。
|
|
3071
1407
|
|
|
3072
1408
|
开启该模式后，SDK 不再运行原有的视频采集流程，即不再继续从摄像头采集数据和美颜，而是只保留视频编码和发送能力。
|
|
3073
1409
|
|
|
3074
|
-
您需要通过
|
|
3075
|
-
|
|
3076
|
-
|
|
3077
|
-
|
|
3078
|
-
|
|
3079
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3080
|
-
</tr>
|
|
3081
|
-
|
|
3082
|
-
<tr>
|
|
3083
|
-
<td rowspan="1" colSpan="1" >enable</td>
|
|
3084
|
-
|
|
3085
|
-
<td rowspan="1" colSpan="1" >是否启用视频自定义采集，默认值：false。</td>
|
|
3086
|
-
</tr>
|
|
3087
|
-
|
|
3088
|
-
<tr>
|
|
3089
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
3090
|
-
|
|
3091
|
-
<td rowspan="1" colSpan="1" >用于指定视频流类型，[TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400)：高清大画面；[TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400)：辅路画面。</td>
|
|
3092
|
-
</tr>
|
|
3093
|
-
</table>
|
|
3094
|
-
|
|
1410
|
+
您需要通过 sendCustomVideoData 不断地向 SDK 塞入自己采集的视频画面。
|
|
1411
|
+
| 参数 | 描述 |
|
|
1412
|
+
| --- | --- |
|
|
1413
|
+
| enable | 是否启用视频自定义采集，默认值：false。 |
|
|
1414
|
+
| streamType | 用于指定视频流类型，TRTCVideoStreamTypeBig：高清大画面；TRTCVideoStreamTypeSub：辅路画面。 |
|
|
3095
1415
|
|
|
3096
1416
|
## sendCustomVideoData
|
|
3097
1417
|
|
|
3098
|
-
|
|
3099
|
-
|
|
3100
1418
|
#### 向 SDK 投送自己采集的视频帧。
|
|
3101
1419
|
|
|
3102
1420
|
使用此接口可以向 SDK 投送自己采集的视频帧，SDK 会将视频帧进行编码并通过自身的网络模块传输出去。
|
|
3103
1421
|
|
|
1422
|
+
参数 TRTCVideoFrame 推荐下列填写方式（其他字段不需要填写）：
|
|
1423
|
+
- pixelFormat：Windows 和 Android 平台仅支持 TRTCVideoPixelFormat_I420，iOS 和 Mac平台支持 TRTCVideoPixelFormat_I420 和 TRTCVideoPixelFormat_BGRA32。
|
|
3104
1424
|
|
|
3105
|
-
|
|
3106
|
-
参数 [TRTCVideoFrame](https://write.woa.com/document/87030132707430400) 推荐下列填写方式（其他字段不需要填写）：
|
|
3107
|
-
- pixelFormat：Windows 和 Android 平台仅支持 [TRTCVideoPixelFormat_I420](https://write.woa.com/document/87030132707430400)，iOS 和 Mac平台支持 [TRTCVideoPixelFormat_I420](https://write.woa.com/document/87030132707430400) 和 [TRTCVideoPixelFormat_BGRA32](https://write.woa.com/document/87030132707430400)。
|
|
3108
|
-
|
|
3109
|
-
- bufferType：推荐选择 [TRTCVideoBufferType_Buffer](https://write.woa.com/document/87030132707430400)。
|
|
1425
|
+
- bufferType：推荐选择 TRTCVideoBufferType_Buffer。
|
|
3110
1426
|
|
|
3111
1427
|
- data：用于承载视频帧数据的 buffer。
|
|
3112
1428
|
|
|
@@ -3116,90 +1432,54 @@ TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如
|
|
|
3116
1432
|
|
|
3117
1433
|
- height：视频图像的高度，如 480 px。
|
|
3118
1434
|
|
|
3119
|
-
- timestamp：时间戳，单位为毫秒（ms），请使用视频帧在采集时被记录下来的时间戳（可以在采集到一帧视频帧之后，通过调用
|
|
3120
|
-
|
|
3121
|
-
|
|
3122
|
-
|
|
1435
|
+
- timestamp：时间戳，单位为毫秒（ms），请使用视频帧在采集时被记录下来的时间戳（可以在采集到一帧视频帧之后，通过调用 generateCustomPTS 获取时间戳）。
|
|
3123
1436
|
|
|
3124
1437
|
参考文档：[自定义采集和渲染](https://cloud.tencent.com/document/product/647/34066)。
|
|
3125
|
-
|
|
3126
|
-
|
|
3127
|
-
|
|
3128
|
-
|
|
3129
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3130
|
-
</tr>
|
|
3131
|
-
|
|
3132
|
-
<tr>
|
|
3133
|
-
<td rowspan="1" colSpan="1" >frame</td>
|
|
3134
|
-
|
|
3135
|
-
<td rowspan="1" colSpan="1" >视频数据，支持 I420 格式数据。</td>
|
|
3136
|
-
</tr>
|
|
3137
|
-
|
|
3138
|
-
<tr>
|
|
3139
|
-
<td rowspan="1" colSpan="1" >streamType</td>
|
|
3140
|
-
|
|
3141
|
-
<td rowspan="1" colSpan="1" >用于指定视频流类型，[TRTCVideoStreamTypeBig](https://write.woa.com/document/87030132707430400)： 高清大画面；[TRTCVideoStreamTypeSub](https://write.woa.com/document/87030132707430400)： 辅路画面。</td>
|
|
3142
|
-
</tr>
|
|
3143
|
-
</table>
|
|
3144
|
-
|
|
1438
|
+
| 参数 | 描述 |
|
|
1439
|
+
| --- | --- |
|
|
1440
|
+
| frame | 视频数据，支持 I420 格式数据。 |
|
|
1441
|
+
| streamType | 用于指定视频流类型，TRTCVideoStreamTypeBig： 高清大画面；TRTCVideoStreamTypeSub： 辅路画面。 |
|
|
3145
1442
|
|
|
3146
1443
|
> **注意**
|
|
3147
|
-
>
|
|
1444
|
+
>
|
|
3148
1445
|
|
|
3149
|
-
> 1. 推荐您在采集到的一帧视频帧后，即调用
|
|
3150
|
-
>
|
|
1446
|
+
> 1. 推荐您在采集到的一帧视频帧后，即调用 generateCustomPTS 接口获取该帧的 timestamp 数值，这样可以获得最佳的音画同步效果。
|
|
1447
|
+
>
|
|
3151
1448
|
|
|
3152
|
-
> 2. SDK 最终编码出的视频帧率并不是由您调用本接口的频率决定的，而是由您在
|
|
3153
|
-
>
|
|
1449
|
+
> 2. SDK 最终编码出的视频帧率并不是由您调用本接口的频率决定的，而是由您在 setVideoEncoderParam 中所设置的 FPS 决定的。
|
|
1450
|
+
>
|
|
3154
1451
|
|
|
3155
1452
|
> 3. 请尽量保持本接口的调用间隔是均匀的，否则会导致编码器输出帧率不稳或者音画不同步等问题。
|
|
3156
|
-
>
|
|
1453
|
+
>
|
|
3157
1454
|
|
|
3158
|
-
> 4. iOS 和 Mac平台目前支持传入
|
|
3159
|
-
>
|
|
3160
|
-
|
|
3161
|
-
> 5. Windows 和 Android 平台目前仅支持传入 [TRTCVideoPixelFormat_I420](https://write.woa.com/document/87030132707430400) 格式的视频帧。
|
|
3162
|
-
>
|
|
1455
|
+
> 4. iOS 和 Mac平台目前支持传入 TRTCVideoPixelFormat_I420 或 TRTCVideoPixelFormat_BGRA32 格式的视频帧。
|
|
1456
|
+
>
|
|
3163
1457
|
|
|
1458
|
+
> 5. Windows 和 Android 平台目前仅支持传入 TRTCVideoPixelFormat_I420 格式的视频帧。
|
|
1459
|
+
>
|
|
3164
1460
|
|
|
3165
1461
|
## enableCustomAudioCapture
|
|
3166
1462
|
|
|
3167
|
-
|
|
3168
|
-
|
|
3169
1463
|
#### 启用音频自定义采集模式。
|
|
3170
1464
|
|
|
3171
1465
|
开启该模式后，SDK 不再运行原有的音频采集流程，即不再继续从麦克风采集音频数据，而是只保留音频编码和发送能力。
|
|
3172
1466
|
|
|
3173
|
-
您需要通过
|
|
3174
|
-
|
|
3175
|
-
|
|
3176
|
-
|
|
3177
|
-
|
|
3178
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3179
|
-
</tr>
|
|
3180
|
-
|
|
3181
|
-
<tr>
|
|
3182
|
-
<td rowspan="1" colSpan="1" >enable</td>
|
|
3183
|
-
|
|
3184
|
-
<td rowspan="1" colSpan="1" >是否启用音频自定义采集模式，默认值：false。</td>
|
|
3185
|
-
</tr>
|
|
3186
|
-
</table>
|
|
3187
|
-
|
|
1467
|
+
您需要通过 sendCustomAudioData 不断地向 SDK 塞入自己采集的音频数据。
|
|
1468
|
+
| 参数 | 描述 |
|
|
1469
|
+
| --- | --- |
|
|
1470
|
+
| enable | 是否启用音频自定义采集模式，默认值：false。 |
|
|
3188
1471
|
|
|
3189
1472
|
> **注意**
|
|
3190
|
-
>
|
|
1473
|
+
>
|
|
3191
1474
|
|
|
3192
1475
|
> 由于回声抵消（AEC）需要严格的控制声音采集和播放的时间，所以开启自定义音频采集后，AEC 能力可能会失效。
|
|
3193
|
-
>
|
|
3194
|
-
|
|
1476
|
+
>
|
|
3195
1477
|
|
|
3196
1478
|
## sendCustomAudioData
|
|
3197
1479
|
|
|
3198
|
-
|
|
3199
|
-
|
|
3200
1480
|
#### 向 SDK 投送自己采集的音频数据。
|
|
3201
1481
|
|
|
3202
|
-
参数
|
|
1482
|
+
参数 TRTCAudioFrame 推荐下列填写方式（其他字段不需要填写）：
|
|
3203
1483
|
- audioFormat：音频数据格式，仅支持 TRTCAudioFrameFormatPCM。
|
|
3204
1484
|
|
|
3205
1485
|
- data：音频帧 buffer。音频帧数据只支持 PCM 格式，支持 5-100 ms 帧长，推荐使用 20ms 帧长，长度计算方法：48000采样率，单声道的帧长度：` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
|
|
@@ -3208,76 +1488,40 @@ TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如
|
|
|
3208
1488
|
|
|
3209
1489
|
- channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
|
|
3210
1490
|
|
|
3211
|
-
- timestamp：时间戳，单位为毫秒（ms），请使用音频帧在采集时被记录下来的时间戳（可以在采集到一帧音频帧之后，通过调用
|
|
3212
|
-
|
|
3213
|
-
|
|
3214
|
-
|
|
1491
|
+
- timestamp：时间戳，单位为毫秒（ms），请使用音频帧在采集时被记录下来的时间戳（可以在采集到一帧音频帧之后，通过调用 generateCustomPTS 获取时间戳）。
|
|
3215
1492
|
|
|
3216
1493
|
参考文档：[自定义采集和渲染](https://cloud.tencent.com/document/product/647/74692)。
|
|
3217
|
-
|
|
3218
|
-
|
|
3219
|
-
|
|
3220
|
-
|
|
3221
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3222
|
-
</tr>
|
|
3223
|
-
|
|
3224
|
-
<tr>
|
|
3225
|
-
<td rowspan="1" colSpan="1" >frame</td>
|
|
3226
|
-
|
|
3227
|
-
<td rowspan="1" colSpan="1" >音频数据</td>
|
|
3228
|
-
</tr>
|
|
3229
|
-
</table>
|
|
3230
|
-
|
|
1494
|
+
| 参数 | 描述 |
|
|
1495
|
+
| --- | --- |
|
|
1496
|
+
| frame | 音频数据 |
|
|
3231
1497
|
|
|
3232
1498
|
> **注意**
|
|
3233
|
-
>
|
|
1499
|
+
>
|
|
3234
1500
|
|
|
3235
1501
|
> 请您精准地按每帧时长的间隔调用本接口，数据投送间隔不均匀时极易触发声音卡顿。
|
|
3236
|
-
>
|
|
3237
|
-
|
|
1502
|
+
>
|
|
3238
1503
|
|
|
3239
1504
|
## enableMixExternalAudioFrame
|
|
3240
1505
|
|
|
3241
|
-
|
|
3242
|
-
|
|
3243
1506
|
#### 启用/关闭自定义音轨。
|
|
3244
1507
|
|
|
3245
1508
|
开启后，您可以通过本接口向 SDK 混入一条自定义的音轨。通过两个布尔型参数，您可以控制该音轨是否要在远端和本地播放。
|
|
3246
|
-
|
|
3247
|
-
|
|
3248
|
-
|
|
3249
|
-
|
|
3250
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3251
|
-
</tr>
|
|
3252
|
-
|
|
3253
|
-
<tr>
|
|
3254
|
-
<td rowspan="1" colSpan="1" >enablePlayout</td>
|
|
3255
|
-
|
|
3256
|
-
<td rowspan="1" colSpan="1" >控制混入的音轨是否要在本地播放，默认值：false。</td>
|
|
3257
|
-
</tr>
|
|
3258
|
-
|
|
3259
|
-
<tr>
|
|
3260
|
-
<td rowspan="1" colSpan="1" >enablePublish</td>
|
|
3261
|
-
|
|
3262
|
-
<td rowspan="1" colSpan="1" >控制混入的音轨是否要在远端播放，默认值：false。</td>
|
|
3263
|
-
</tr>
|
|
3264
|
-
</table>
|
|
3265
|
-
|
|
1509
|
+
| 参数 | 描述 |
|
|
1510
|
+
| --- | --- |
|
|
1511
|
+
| enablePlayout | 控制混入的音轨是否要在本地播放，默认值：false。 |
|
|
1512
|
+
| enablePublish | 控制混入的音轨是否要在远端播放，默认值：false。 |
|
|
3266
1513
|
|
|
3267
1514
|
> **注意**
|
|
3268
|
-
>
|
|
1515
|
+
>
|
|
3269
1516
|
|
|
3270
1517
|
> 如果您指定参数 ` enablePublish ` 和 ` enablePlayout ` 均为 false，代表完全关闭您的自定义音轨。
|
|
3271
|
-
>
|
|
3272
|
-
|
|
1518
|
+
>
|
|
3273
1519
|
|
|
3274
1520
|
## mixExternalAudioFrame
|
|
3275
1521
|
|
|
3276
|
-
|
|
3277
|
-
|
|
3278
1522
|
#### 向 SDK 混入自定义音轨。
|
|
3279
1523
|
|
|
3280
|
-
调用该接口之前，您需要先通过
|
|
1524
|
+
调用该接口之前，您需要先通过 enableMixExternalAudioFrame 开启自定义音轨，之后就可以通过本接口将自己的音轨以 PCM 格式混入到 SDK 中。
|
|
3281
1525
|
|
|
3282
1526
|
理想情况下，我们期望您的代码能够以非常均匀的速度向 SDK 提供音轨数据。但我们也非常清楚，完美的调用间隔是一个巨大的挑战。
|
|
3283
1527
|
|
|
@@ -3287,38 +1531,24 @@ TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如
|
|
|
3287
1531
|
|
|
3288
1532
|
当您调用该接口后，如果发现返回值大于 100ms，则可以等待一帧音频帧的播放时间之后再次调用；如果返回值小于 100ms，则代表缓冲区比较小，您可以再次混入一些音轨数据以确保音轨缓冲区的大小维持在“安全水位”以上。
|
|
3289
1533
|
|
|
3290
|
-
|
|
3291
|
-
|
|
3292
|
-
参数 [TRTCAudioFrame](https://write.woa.com/document/87030132707430400) 推荐下列填写方式（其他字段不需要填写）：
|
|
1534
|
+
参数 TRTCAudioFrame 推荐下列填写方式（其他字段不需要填写）：
|
|
3293
1535
|
- data：音频帧 buffer。音频帧数据只支持 PCM 格式，支持 5ms - 100ms 帧长，推荐使用 20ms 帧长，长度计算方法：48000采样率, 单声道的帧长度：` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
|
|
3294
1536
|
|
|
3295
1537
|
- sampleRate：采样率，支持：16000、24000、32000、44100、48000。
|
|
3296
1538
|
|
|
3297
1539
|
- channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
|
|
3298
1540
|
|
|
3299
|
-
- timestamp：时间戳，单位为毫秒（ms），请使用音频帧在采集时被记录下来的时间戳（可以在获得一帧音频帧之后，通过调用
|
|
3300
|
-
|
|
3301
|
-
<table>
|
|
3302
|
-
<tr>
|
|
3303
|
-
<td rowspan="1" colSpan="1" >参数</td>
|
|
3304
|
-
|
|
3305
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3306
|
-
</tr>
|
|
3307
|
-
|
|
3308
|
-
<tr>
|
|
3309
|
-
<td rowspan="1" colSpan="1" >frame</td>
|
|
3310
|
-
|
|
3311
|
-
<td rowspan="1" colSpan="1" >音频数据</td>
|
|
3312
|
-
</tr>
|
|
3313
|
-
</table>
|
|
1541
|
+
- timestamp：时间戳，单位为毫秒（ms），请使用音频帧在采集时被记录下来的时间戳（可以在获得一帧音频帧之后，通过调用 generateCustomPTS 获得时间戳）。
|
|
3314
1542
|
|
|
1543
|
+
| 参数 | 描述 |
|
|
1544
|
+
| --- | --- |
|
|
1545
|
+
| frame | 音频数据 |
|
|
3315
1546
|
|
|
3316
1547
|
> **注意**
|
|
3317
|
-
>
|
|
1548
|
+
>
|
|
3318
1549
|
|
|
3319
1550
|
> 请您精准地按每帧时长的间隔调用本接口，数据投送间隔不均匀时极易触发声音卡顿。
|
|
3320
|
-
>
|
|
3321
|
-
|
|
1551
|
+
>
|
|
3322
1552
|
|
|
3323
1553
|
#### 返回值说明：
|
|
3324
1554
|
|
|
@@ -3326,47 +1556,25 @@ TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如
|
|
|
3326
1556
|
|
|
3327
1557
|
## setMixExternalAudioVolume
|
|
3328
1558
|
|
|
3329
|
-
|
|
3330
|
-
|
|
3331
1559
|
#### 设置推流时混入外部音频的推流音量和播放音量。
|
|
3332
|
-
|
|
3333
|
-
|
|
3334
|
-
|
|
3335
|
-
|
|
3336
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3337
|
-
</tr>
|
|
3338
|
-
|
|
3339
|
-
<tr>
|
|
3340
|
-
<td rowspan="1" colSpan="1" >playoutVolume</td>
|
|
3341
|
-
|
|
3342
|
-
<td rowspan="1" colSpan="1" >设置的播放音量大小，范围 [0, 150]，-1 表示不改变。</td>
|
|
3343
|
-
</tr>
|
|
3344
|
-
|
|
3345
|
-
<tr>
|
|
3346
|
-
<td rowspan="1" colSpan="1" >publishVolume</td>
|
|
3347
|
-
|
|
3348
|
-
<td rowspan="1" colSpan="1" >设置的推流音量大小，范围 [0, 150]，-1 表示不改变。</td>
|
|
3349
|
-
</tr>
|
|
3350
|
-
</table>
|
|
3351
|
-
|
|
1560
|
+
| 参数 | 描述 |
|
|
1561
|
+
| --- | --- |
|
|
1562
|
+
| playoutVolume | 设置的播放音量大小，范围 [0, 150]，-1 表示不改变。 |
|
|
1563
|
+
| publishVolume | 设置的推流音量大小，范围 [0, 150]，-1 表示不改变。 |
|
|
3352
1564
|
|
|
3353
1565
|
## generateCustomPTS
|
|
3354
1566
|
|
|
3355
|
-
|
|
3356
|
-
|
|
3357
1567
|
#### 生成自定义采集时的时间戳。
|
|
3358
1568
|
|
|
3359
1569
|
本接口仅适用于自定义采集模式，用于解决音视频帧的采集时间（capture time）和投送时间（send time）不一致所导致的音画不同步问题。
|
|
3360
1570
|
|
|
3361
|
-
|
|
3362
|
-
|
|
3363
|
-
当您通过 [sendCustomVideoData](https://write.woa.com/document/87030026264555520) 或 [sendCustomAudioData](https://write.woa.com/document/87030026264555520) 等接口进行自定义视频或音频采集时，请按照如下操作使用该接口：
|
|
1571
|
+
当您通过 sendCustomVideoData 或 sendCustomAudioData 等接口进行自定义视频或音频采集时，请按照如下操作使用该接口：
|
|
3364
1572
|
|
|
3365
1573
|
1. 首先，在采集到一帧视频或音频帧时，通过调用本接口获得当时的 PTS 时间戳。
|
|
3366
1574
|
|
|
3367
1575
|
2. 之后可以将该视频或音频帧送入您使用的前处理模块（如第三方美颜组件，或第三方音效组件）。
|
|
3368
1576
|
|
|
3369
|
-
3. 在真正调用
|
|
1577
|
+
3. 在真正调用 sendCustomVideoData 或 sendCustomAudioData 进行投送时，请将该帧在采集时记录的 PTS 时间戳赋值给 TRTCVideoFrame 或 TRTCAudioFrame 中的 timestamp 字段。
|
|
3370
1578
|
|
|
3371
1579
|
#### 返回值说明：
|
|
3372
1580
|
|
|
@@ -3374,37 +1582,14 @@ TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如
|
|
|
3374
1582
|
|
|
3375
1583
|
## enableLocalVideoCustomProcess
|
|
3376
1584
|
|
|
3377
|
-
|
|
3378
|
-
|
|
3379
1585
|
#### .1 开启视频第三方美颜。
|
|
3380
1586
|
|
|
3381
|
-
开启后，您可以通过
|
|
3382
|
-
|
|
3383
|
-
|
|
3384
|
-
|
|
3385
|
-
|
|
3386
|
-
|
|
3387
|
-
</tr>
|
|
3388
|
-
|
|
3389
|
-
<tr>
|
|
3390
|
-
<td rowspan="1" colSpan="1" >bufferType</td>
|
|
3391
|
-
|
|
3392
|
-
<td rowspan="1" colSpan="1" >指定视频数据结构类型。</td>
|
|
3393
|
-
</tr>
|
|
3394
|
-
|
|
3395
|
-
<tr>
|
|
3396
|
-
<td rowspan="1" colSpan="1" >enable</td>
|
|
3397
|
-
|
|
3398
|
-
<td rowspan="1" colSpan="1" >是否启用视频第三方美颜，默认为关闭状态。</td>
|
|
3399
|
-
</tr>
|
|
3400
|
-
|
|
3401
|
-
<tr>
|
|
3402
|
-
<td rowspan="1" colSpan="1" >pixelFormat</td>
|
|
3403
|
-
|
|
3404
|
-
<td rowspan="1" colSpan="1" >指定回调的像素格式。</td>
|
|
3405
|
-
</tr>
|
|
3406
|
-
</table>
|
|
3407
|
-
|
|
1587
|
+
开启后，您可以通过 ITRTCVideoFrameCallback 获取到指定像素格式和视频数据结构类型的图像帧。
|
|
1588
|
+
| 参数 | 描述 |
|
|
1589
|
+
| --- | --- |
|
|
1590
|
+
| bufferType | 指定视频数据结构类型。 |
|
|
1591
|
+
| enable | 是否启用视频第三方美颜，默认为关闭状态。 |
|
|
1592
|
+
| pixelFormat | 指定回调的像素格式。 |
|
|
3408
1593
|
|
|
3409
1594
|
#### 返回值说明：
|
|
3410
1595
|
|
|
@@ -3412,65 +1597,29 @@ TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如
|
|
|
3412
1597
|
|
|
3413
1598
|
## setLocalVideoCustomProcessCallback
|
|
3414
1599
|
|
|
3415
|
-
|
|
3416
|
-
|
|
3417
1600
|
#### .2 设置第三方美颜的视频数据回调。
|
|
3418
1601
|
|
|
3419
1602
|
设置该回调之后，SDK 会把采集到的视频帧通过您设置的 callback 回调出来，用于第三方美颜组件进行二次处理，之后 SDK 会将处理后的视频帧进行编码和发送。
|
|
3420
|
-
|
|
3421
|
-
|
|
3422
|
-
|
|
3423
|
-
|
|
3424
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3425
|
-
</tr>
|
|
3426
|
-
|
|
3427
|
-
<tr>
|
|
3428
|
-
<td rowspan="1" colSpan="1" >callback</td>
|
|
3429
|
-
|
|
3430
|
-
<td rowspan="1" colSpan="1" >自定义美颜回调，详见 [ITRTCVideoFrameCallback](https://write.woa.com/document/87030021158866944)。</td>
|
|
3431
|
-
</tr>
|
|
3432
|
-
</table>
|
|
3433
|
-
|
|
1603
|
+
| 参数 | 描述 |
|
|
1604
|
+
| --- | --- |
|
|
1605
|
+
| callback | 自定义美颜回调，详见 ITRTCVideoFrameCallback。 |
|
|
3434
1606
|
|
|
3435
1607
|
## setLocalVideoRenderCallback
|
|
3436
1608
|
|
|
3437
|
-
|
|
3438
|
-
|
|
3439
1609
|
#### 设置本地视频自定义渲染回调。
|
|
3440
1610
|
|
|
3441
1611
|
设置该回调之后，SDK 内部会跳过原来的渲染流程，并把采集到的数据回调出来，您需要自己完成画面渲染。
|
|
3442
1612
|
- 您可以通过调用 ` setLocalVideoRenderCallback(TRTCVideoPixelFormat_Unknown, TRTCVideoBufferType_Unknown, nullptr) ` 停止回调。
|
|
3443
1613
|
|
|
3444
|
-
- iOS、Mac、Windows 平台目前仅支持回调
|
|
3445
|
-
|
|
3446
|
-
- Android 平台目前仅支持传入 [TRTCVideoPixelFormat_I420](https://write.woa.com/document/87030132707430400), [TRTCVideoPixelFormat_RGBA32](https://write.woa.com/document/87030132707430400) 或 [TRTCVideoPixelFormat_Texture_2D](https://write.woa.com/document/87030132707430400) 像素格式的视频帧。
|
|
3447
|
-
|
|
3448
|
-
<table>
|
|
3449
|
-
<tr>
|
|
3450
|
-
<td rowspan="1" colSpan="1" >参数</td>
|
|
3451
|
-
|
|
3452
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3453
|
-
</tr>
|
|
3454
|
-
|
|
3455
|
-
<tr>
|
|
3456
|
-
<td rowspan="1" colSpan="1" >bufferType</td>
|
|
1614
|
+
- iOS、Mac、Windows 平台目前仅支持回调 TRTCVideoPixelFormat_I420 或 TRTCVideoPixelFormat_BGRA32 像素格式的视频帧。
|
|
3457
1615
|
|
|
3458
|
-
|
|
3459
|
-
</tr>
|
|
3460
|
-
|
|
3461
|
-
<tr>
|
|
3462
|
-
<td rowspan="1" colSpan="1" >callback</td>
|
|
3463
|
-
|
|
3464
|
-
<td rowspan="1" colSpan="1" >自定义渲染回调</td>
|
|
3465
|
-
</tr>
|
|
3466
|
-
|
|
3467
|
-
<tr>
|
|
3468
|
-
<td rowspan="1" colSpan="1" >pixelFormat</td>
|
|
3469
|
-
|
|
3470
|
-
<td rowspan="1" colSpan="1" >指定回调的像素格式</td>
|
|
3471
|
-
</tr>
|
|
3472
|
-
</table>
|
|
1616
|
+
- Android 平台目前仅支持传入 TRTCVideoPixelFormat_I420, TRTCVideoPixelFormat_RGBA32 或 TRTCVideoPixelFormat_Texture_2D 像素格式的视频帧。
|
|
3473
1617
|
|
|
1618
|
+
| 参数 | 描述 |
|
|
1619
|
+
| --- | --- |
|
|
1620
|
+
| bufferType | 指定视频数据结构类型 |
|
|
1621
|
+
| callback | 自定义渲染回调 |
|
|
1622
|
+
| pixelFormat | 指定回调的像素格式 |
|
|
3474
1623
|
|
|
3475
1624
|
#### 返回值说明：
|
|
3476
1625
|
|
|
@@ -3478,56 +1627,27 @@ TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如
|
|
|
3478
1627
|
|
|
3479
1628
|
## setRemoteVideoRenderCallback
|
|
3480
1629
|
|
|
3481
|
-
|
|
3482
|
-
|
|
3483
1630
|
#### 设置远端视频自定义渲染回调。
|
|
3484
1631
|
|
|
3485
1632
|
设置该回调之后，SDK 内部会跳过原来的渲染流程，并把采集到的数据回调出来，您需要自己完成画面渲染。
|
|
3486
1633
|
- 您可以通过调用 ` setRemoteVideoRenderCallback(TRTCVideoPixelFormat_Unknown, TRTCVideoBufferType_Unknown, nullptr) ` 停止回调。
|
|
3487
1634
|
|
|
3488
|
-
- iOS、Mac、Windows 平台目前仅支持回调
|
|
3489
|
-
|
|
3490
|
-
- Android 平台目前仅支持传入 [TRTCVideoPixelFormat_I420](https://write.woa.com/document/87030132707430400), [TRTCVideoPixelFormat_RGBA32](https://write.woa.com/document/87030132707430400) 或 [TRTCVideoPixelFormat_Texture_2D](https://write.woa.com/document/87030132707430400) 像素格式的视频帧。
|
|
3491
|
-
|
|
3492
|
-
<table>
|
|
3493
|
-
<tr>
|
|
3494
|
-
<td rowspan="1" colSpan="1" >参数</td>
|
|
1635
|
+
- iOS、Mac、Windows 平台目前仅支持回调 TRTCVideoPixelFormat_I420 或 TRTCVideoPixelFormat_BGRA32 像素格式的视频帧。
|
|
3495
1636
|
|
|
3496
|
-
|
|
3497
|
-
</tr>
|
|
3498
|
-
|
|
3499
|
-
<tr>
|
|
3500
|
-
<td rowspan="1" colSpan="1" >bufferType</td>
|
|
3501
|
-
|
|
3502
|
-
<td rowspan="1" colSpan="1" >指定视频数据结构类型，目前只支持 [TRTCVideoBufferType_Buffer](https://write.woa.com/document/87030132707430400)</td>
|
|
3503
|
-
</tr>
|
|
3504
|
-
|
|
3505
|
-
<tr>
|
|
3506
|
-
<td rowspan="1" colSpan="1" >callback</td>
|
|
3507
|
-
|
|
3508
|
-
<td rowspan="1" colSpan="1" >自定义渲染回调。</td>
|
|
3509
|
-
</tr>
|
|
3510
|
-
|
|
3511
|
-
<tr>
|
|
3512
|
-
<td rowspan="1" colSpan="1" >pixelFormat</td>
|
|
3513
|
-
|
|
3514
|
-
<td rowspan="1" colSpan="1" >指定回调的像素格式</td>
|
|
3515
|
-
</tr>
|
|
3516
|
-
|
|
3517
|
-
<tr>
|
|
3518
|
-
<td rowspan="1" colSpan="1" >userId</td>
|
|
3519
|
-
|
|
3520
|
-
<td rowspan="1" colSpan="1" >远端用户id</td>
|
|
3521
|
-
</tr>
|
|
3522
|
-
</table>
|
|
1637
|
+
- Android 平台目前仅支持传入 TRTCVideoPixelFormat_I420, TRTCVideoPixelFormat_RGBA32 或 TRTCVideoPixelFormat_Texture_2D 像素格式的视频帧。
|
|
3523
1638
|
|
|
1639
|
+
| 参数 | 描述 |
|
|
1640
|
+
| --- | --- |
|
|
1641
|
+
| bufferType | 指定视频数据结构类型，目前只支持 TRTCVideoBufferType_Buffer |
|
|
1642
|
+
| callback | 自定义渲染回调。 |
|
|
1643
|
+
| pixelFormat | 指定回调的像素格式 |
|
|
1644
|
+
| userId | 远端用户id |
|
|
3524
1645
|
|
|
3525
1646
|
> **注意**
|
|
3526
|
-
>
|
|
1647
|
+
>
|
|
3527
1648
|
|
|
3528
1649
|
> 实际使用时，需要先调用 startRemoteView(userid, nullptr) 来获取远端用户的视频流（view 设置为 nullptr 即可），否则不会有数据回调出来。
|
|
3529
|
-
>
|
|
3530
|
-
|
|
1650
|
+
>
|
|
3531
1651
|
|
|
3532
1652
|
#### 返回值说明：
|
|
3533
1653
|
|
|
@@ -3535,67 +1655,46 @@ TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如
|
|
|
3535
1655
|
|
|
3536
1656
|
## setAudioFrameCallback
|
|
3537
1657
|
|
|
3538
|
-
|
|
3539
|
-
|
|
3540
1658
|
#### 设置音频数据自定义回调。
|
|
3541
1659
|
|
|
3542
1660
|
设置该回调之后，SDK 内部会把音频数据（PCM 格式）回调出来，包括：
|
|
3543
|
-
-
|
|
3544
|
-
|
|
3545
|
-
- [onLocalProcessedAudioFrame](https://write.woa.com/document/87030021158866944)：本地采集并经过音频模块前处理后的音频数据回调
|
|
1661
|
+
- onCapturedAudioFrame：本地麦克风采集到的音频数据回调
|
|
3546
1662
|
|
|
3547
|
-
-
|
|
1663
|
+
- onLocalProcessedAudioFrame：本地采集并经过音频模块前处理后的音频数据回调
|
|
3548
1664
|
|
|
3549
|
-
-
|
|
1665
|
+
- onPlayAudioFrame：混音前的每一路远程用户的音频数据
|
|
3550
1666
|
|
|
1667
|
+
- onMixedPlayAudioFrame：将各路音频混合之后并最终要由系统播放出的音频数据回调
|
|
3551
1668
|
|
|
3552
1669
|
> **注意**
|
|
3553
|
-
>
|
|
1670
|
+
>
|
|
3554
1671
|
|
|
3555
1672
|
> 设置回调为空即代表停止自定义音频回调，反之，设置回调不为空则代表启动自定义音频回调。
|
|
3556
|
-
>
|
|
3557
|
-
|
|
1673
|
+
>
|
|
3558
1674
|
|
|
3559
1675
|
## setCapturedAudioFrameCallbackFormat
|
|
3560
1676
|
|
|
3561
|
-
|
|
3562
|
-
|
|
3563
1677
|
#### 设置本地麦克风采集出的音频帧回调格式。
|
|
3564
1678
|
|
|
3565
|
-
本接口用于设置
|
|
1679
|
+
本接口用于设置 onCapturedAudioFrame 回调出来的 AudioFrame 的格式：
|
|
3566
1680
|
- sampleRate：采样率，支持：16000、32000、44100、48000。
|
|
3567
1681
|
|
|
3568
1682
|
- channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
|
|
3569
1683
|
|
|
3570
1684
|
- samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
|
|
3571
1685
|
|
|
3572
|
-
|
|
3573
|
-
|
|
3574
|
-
|
|
3575
1686
|
如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为：` 采样点数 = 毫秒数 * 采样率 / 1000 `。
|
|
3576
1687
|
|
|
3577
1688
|
举例：48000Hz 采样率希望回调 20ms 帧长的数据，则采样点数应该填：` 960 = 20 * 48000 / 1000 `。
|
|
3578
|
-
|
|
3579
|
-
|
|
3580
|
-
|
|
3581
|
-
|
|
3582
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3583
|
-
</tr>
|
|
3584
|
-
|
|
3585
|
-
<tr>
|
|
3586
|
-
<td rowspan="1" colSpan="1" >format</td>
|
|
3587
|
-
|
|
3588
|
-
<td rowspan="1" colSpan="1" >音频数据回调格式。</td>
|
|
3589
|
-
</tr>
|
|
3590
|
-
</table>
|
|
3591
|
-
|
|
1689
|
+
| 参数 | 描述 |
|
|
1690
|
+
| --- | --- |
|
|
1691
|
+
| format | 音频数据回调格式。 |
|
|
3592
1692
|
|
|
3593
1693
|
> **注意**
|
|
3594
|
-
>
|
|
1694
|
+
>
|
|
3595
1695
|
|
|
3596
1696
|
> 最终回调的帧长度是以字节为单位，采样点数转换成字节数的计算公式为：` 字节数 = 采样点数 * channel * 2（位宽） `。举例：48000Hz 采样率，双声道，20ms 帧长，采样点数为 960，字节数为 ` 3840 = 960 * 2 * 2 `。
|
|
3597
|
-
>
|
|
3598
|
-
|
|
1697
|
+
>
|
|
3599
1698
|
|
|
3600
1699
|
#### 返回值说明：
|
|
3601
1700
|
|
|
@@ -3603,44 +1702,27 @@ TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如
|
|
|
3603
1702
|
|
|
3604
1703
|
## setLocalProcessedAudioFrameCallbackFormat
|
|
3605
1704
|
|
|
3606
|
-
|
|
3607
|
-
|
|
3608
1705
|
#### 设置经过前处理后的本地音频帧回调格式。
|
|
3609
1706
|
|
|
3610
|
-
本接口用于设置
|
|
1707
|
+
本接口用于设置 onLocalProcessedAudioFrame 回调出来的 AudioFrame 的格式：
|
|
3611
1708
|
- sampleRate：采样率，支持：16000、32000、44100、48000。
|
|
3612
1709
|
|
|
3613
1710
|
- channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
|
|
3614
1711
|
|
|
3615
1712
|
- samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
|
|
3616
1713
|
|
|
3617
|
-
|
|
3618
|
-
|
|
3619
|
-
|
|
3620
1714
|
如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为：` 采样点数 = 毫秒数 * 采样率 / 1000 `。
|
|
3621
1715
|
|
|
3622
1716
|
举例：48000Hz 采样率希望回调20ms帧长的数据，则采样点数应该填: ` 960 = 20 * 48000 / 1000 `。
|
|
3623
|
-
|
|
3624
|
-
|
|
3625
|
-
|
|
3626
|
-
|
|
3627
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3628
|
-
</tr>
|
|
3629
|
-
|
|
3630
|
-
<tr>
|
|
3631
|
-
<td rowspan="1" colSpan="1" >format</td>
|
|
3632
|
-
|
|
3633
|
-
<td rowspan="1" colSpan="1" >音频数据回调格式。</td>
|
|
3634
|
-
</tr>
|
|
3635
|
-
</table>
|
|
3636
|
-
|
|
1717
|
+
| 参数 | 描述 |
|
|
1718
|
+
| --- | --- |
|
|
1719
|
+
| format | 音频数据回调格式。 |
|
|
3637
1720
|
|
|
3638
1721
|
> **注意**
|
|
3639
|
-
>
|
|
1722
|
+
>
|
|
3640
1723
|
|
|
3641
1724
|
> 最终回调的帧长度是以字节为单位，采样点数转换成字节数的计算公式为：` 字节数 = 采样点数 * channel * 2（位宽） `。 举例：48000Hz 采样率，双声道，20ms 帧长，采样点数为 960，字节数为 ` 3840 = 960 * 2 * 2 `。
|
|
3642
|
-
>
|
|
3643
|
-
|
|
1725
|
+
>
|
|
3644
1726
|
|
|
3645
1727
|
#### 返回值说明：
|
|
3646
1728
|
|
|
@@ -3648,44 +1730,27 @@ TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如
|
|
|
3648
1730
|
|
|
3649
1731
|
## setMixedPlayAudioFrameCallbackFormat
|
|
3650
1732
|
|
|
3651
|
-
|
|
3652
|
-
|
|
3653
1733
|
#### 设置最终要由系统播放出的音频帧回调格式。
|
|
3654
1734
|
|
|
3655
|
-
本接口用于设置
|
|
1735
|
+
本接口用于设置 onMixedPlayAudioFrame 回调出来的 AudioFrame 的格式：
|
|
3656
1736
|
- sampleRate：采样率，支持：16000、32000、44100、48000。
|
|
3657
1737
|
|
|
3658
1738
|
- channel：声道数（如果是立体声，数据是交叉的），单声道：1； 双声道：2。
|
|
3659
1739
|
|
|
3660
1740
|
- samplesPerCall：采样点数，定义回调数据帧长。帧长必须为 10ms 的整数倍。
|
|
3661
1741
|
|
|
3662
|
-
|
|
3663
|
-
|
|
3664
|
-
|
|
3665
1742
|
如果希望用毫秒数计算回调帧长，则将毫秒数转换成采样点数的公式为：` 采样点数 = 毫秒数 * 采样率 / 1000 `。
|
|
3666
1743
|
|
|
3667
1744
|
举例：48000Hz 采样率希望回调 20ms 帧长的数据，则采样点数应该填: ` 960 = 20 * 48000 / 1000 `。
|
|
3668
|
-
|
|
3669
|
-
|
|
3670
|
-
|
|
3671
|
-
|
|
3672
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3673
|
-
</tr>
|
|
3674
|
-
|
|
3675
|
-
<tr>
|
|
3676
|
-
<td rowspan="1" colSpan="1" >format</td>
|
|
3677
|
-
|
|
3678
|
-
<td rowspan="1" colSpan="1" >音频数据回调格式。</td>
|
|
3679
|
-
</tr>
|
|
3680
|
-
</table>
|
|
3681
|
-
|
|
1745
|
+
| 参数 | 描述 |
|
|
1746
|
+
| --- | --- |
|
|
1747
|
+
| format | 音频数据回调格式。 |
|
|
3682
1748
|
|
|
3683
1749
|
> **注意**
|
|
3684
|
-
>
|
|
1750
|
+
>
|
|
3685
1751
|
|
|
3686
1752
|
> 最终回调的帧长度是以字节为单位，采样点数转换成字节数的计算公式为：` 字节数 = 采样点数 * channel * 2（位宽） `。 举例：48000Hz 采样率，双声道，20ms 帧长，采样点数为 960，字节数为 ` 3840 = 960 * 2 * 2 `。
|
|
3687
|
-
>
|
|
3688
|
-
|
|
1753
|
+
>
|
|
3689
1754
|
|
|
3690
1755
|
#### 返回值说明：
|
|
3691
1756
|
|
|
@@ -3693,147 +1758,85 @@ TXAudioEffectManager 是音效管理接口，您可以通过该接口实现如
|
|
|
3693
1758
|
|
|
3694
1759
|
## enableCustomAudioRendering
|
|
3695
1760
|
|
|
3696
|
-
|
|
3697
|
-
|
|
3698
1761
|
#### 开启音频自定义播放。
|
|
3699
1762
|
|
|
3700
1763
|
如果您需要外接一些特定的音频设备，或者希望自己掌控音频的播放逻辑，您可以通过该接口启用音频自定义播放。
|
|
3701
1764
|
|
|
3702
|
-
启用音频自定义播放后，SDK 将不再调用系统的音频接口播放数据，您需要通过
|
|
3703
|
-
|
|
3704
|
-
|
|
3705
|
-
|
|
3706
|
-
|
|
3707
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3708
|
-
</tr>
|
|
3709
|
-
|
|
3710
|
-
<tr>
|
|
3711
|
-
<td rowspan="1" colSpan="1" >enable</td>
|
|
3712
|
-
|
|
3713
|
-
<td rowspan="1" colSpan="1" >是否启用音频自定义播放，默认为关闭状态。</td>
|
|
3714
|
-
</tr>
|
|
3715
|
-
</table>
|
|
3716
|
-
|
|
1765
|
+
启用音频自定义播放后，SDK 将不再调用系统的音频接口播放数据，您需要通过 getCustomAudioRenderingFrame 获取 SDK 要播放的音频帧并自行播放。
|
|
1766
|
+
| 参数 | 描述 |
|
|
1767
|
+
| --- | --- |
|
|
1768
|
+
| enable | 是否启用音频自定义播放，默认为关闭状态。 |
|
|
3717
1769
|
|
|
3718
1770
|
> **注意**
|
|
3719
|
-
>
|
|
1771
|
+
>
|
|
3720
1772
|
|
|
3721
1773
|
> 需要您在进入房间前设置才能生效，暂不支持进入房间后再设置。
|
|
3722
|
-
>
|
|
3723
|
-
|
|
1774
|
+
>
|
|
3724
1775
|
|
|
3725
1776
|
## getCustomAudioRenderingFrame
|
|
3726
1777
|
|
|
3727
|
-
|
|
3728
|
-
|
|
3729
1778
|
#### 获取可播放的音频数据。
|
|
3730
1779
|
|
|
3731
|
-
调用该接口之前，您需要先通过
|
|
1780
|
+
调用该接口之前，您需要先通过 enableCustomAudioRendering 开启音频自定义播放。
|
|
3732
1781
|
|
|
3733
|
-
|
|
3734
|
-
|
|
3735
|
-
参数 [TRTCAudioFrame](https://write.woa.com/document/87030132707430400) 推荐下列填写方式（其他字段不需要填写）：
|
|
1782
|
+
参数 TRTCAudioFrame 推荐下列填写方式（其他字段不需要填写）：
|
|
3736
1783
|
- sampleRate：采样率，必填，支持 16000、24000、32000、44100、48000。
|
|
3737
1784
|
|
|
3738
1785
|
- channel：声道数，必填，单声道请填1，双声道请填2，双声道时数据是交叉的。
|
|
3739
1786
|
|
|
3740
1787
|
- data：用于获取音频数据的 buffer。需要您根据一帧音频帧的帧长度分配好 data 的内存大小。获取的 PCM 数据支持 10ms 或 20ms 两种帧长，推荐使用 20ms 的帧长。
|
|
3741
1788
|
|
|
3742
|
-
|
|
3743
|
-
|
|
3744
|
-
|
|
3745
1789
|
计算公式为：` 采样率 x 播放时长 x 声道数量 x 2（每个样点的字节数） `， 例如： 48000Hz 采样率、单声道、且播放时长为 20ms 的一帧音频帧的 buffer 大小为 ` 48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节 `。
|
|
3746
|
-
|
|
3747
|
-
|
|
3748
|
-
|
|
3749
|
-
|
|
3750
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3751
|
-
</tr>
|
|
3752
|
-
|
|
3753
|
-
<tr>
|
|
3754
|
-
<td rowspan="1" colSpan="1" >audioFrame</td>
|
|
3755
|
-
|
|
3756
|
-
<td rowspan="1" colSpan="1" >音频数据帧。</td>
|
|
3757
|
-
</tr>
|
|
3758
|
-
</table>
|
|
3759
|
-
|
|
1790
|
+
| 参数 | 描述 |
|
|
1791
|
+
| --- | --- |
|
|
1792
|
+
| audioFrame | 音频数据帧。 |
|
|
3760
1793
|
|
|
3761
1794
|
> **注意**
|
|
3762
|
-
>
|
|
1795
|
+
>
|
|
3763
1796
|
|
|
3764
1797
|
> 1. 参数 audioFrame 中的 sampleRate、channel 需提前设置好，同时分配好所需读取帧长的 data 空间。
|
|
3765
|
-
>
|
|
1798
|
+
>
|
|
3766
1799
|
|
|
3767
1800
|
> 2. SDK 内部会根据 sampleRate 和 channel 自动填充 data 数据。
|
|
3768
|
-
>
|
|
1801
|
+
>
|
|
3769
1802
|
|
|
3770
1803
|
> 3. 建议由系统的音频播放线程直接驱动该函数的调用，在播放完一帧音频之后，即调用该接口获取下一帧可播放的音频数据。
|
|
3771
|
-
>
|
|
3772
|
-
|
|
1804
|
+
>
|
|
3773
1805
|
|
|
3774
1806
|
## sendCustomCmdMsg
|
|
3775
1807
|
|
|
3776
|
-
|
|
3777
|
-
|
|
3778
1808
|
#### 使用 UDP 通道发送自定义消息给房间内所有用户。
|
|
3779
1809
|
|
|
3780
1810
|
该接口可以让您借助 TRTC 的 UDP 通道，向当前房间里的其他用户广播自定义数据，以达到传输信令的目的。
|
|
3781
1811
|
|
|
3782
|
-
房间中的其他用户可以通过
|
|
3783
|
-
|
|
3784
|
-
|
|
3785
|
-
|
|
3786
|
-
|
|
3787
|
-
|
|
3788
|
-
|
|
3789
|
-
|
|
3790
|
-
<tr>
|
|
3791
|
-
<td rowspan="1" colSpan="1" >cmdID</td>
|
|
3792
|
-
|
|
3793
|
-
<td rowspan="1" colSpan="1" >消息 ID，取值范围为 [1, 10]。</td>
|
|
3794
|
-
</tr>
|
|
3795
|
-
|
|
3796
|
-
<tr>
|
|
3797
|
-
<td rowspan="1" colSpan="1" >data</td>
|
|
3798
|
-
|
|
3799
|
-
<td rowspan="1" colSpan="1" >待发送的消息，单个消息的最大长度被限制为 1KB。</td>
|
|
3800
|
-
</tr>
|
|
3801
|
-
|
|
3802
|
-
<tr>
|
|
3803
|
-
<td rowspan="1" colSpan="1" >ordered</td>
|
|
3804
|
-
|
|
3805
|
-
<td rowspan="1" colSpan="1" >是否要求有序，即是否要求接收端的数据包顺序和发送端的数据包顺序一致（这会带来一定的接收延时）。</td>
|
|
3806
|
-
</tr>
|
|
3807
|
-
|
|
3808
|
-
<tr>
|
|
3809
|
-
<td rowspan="1" colSpan="1" >reliable</td>
|
|
3810
|
-
|
|
3811
|
-
<td rowspan="1" colSpan="1" >是否可靠发送，可靠发送可以获得更高的发送成功率，但可靠发送比不可靠发送会带来更大的接收延迟。</td>
|
|
3812
|
-
</tr>
|
|
3813
|
-
</table>
|
|
3814
|
-
|
|
1812
|
+
房间中的其他用户可以通过 ITRTCCloudCallback 中的 onRecvCustomCmdMsg 回调接收消息。
|
|
1813
|
+
| 参数 | 描述 |
|
|
1814
|
+
| --- | --- |
|
|
1815
|
+
| cmdID | 消息 ID，取值范围为 [1, 10]。 |
|
|
1816
|
+
| data | 待发送的消息，单个消息的最大长度被限制为 1KB。 |
|
|
1817
|
+
| ordered | 是否要求有序，即是否要求接收端的数据包顺序和发送端的数据包顺序一致（这会带来一定的接收延时）。 |
|
|
1818
|
+
| reliable | 是否可靠发送，可靠发送可以获得更高的发送成功率，但可靠发送比不可靠发送会带来更大的接收延迟。 |
|
|
3815
1819
|
|
|
3816
1820
|
> **注意**
|
|
3817
|
-
>
|
|
1821
|
+
>
|
|
3818
1822
|
|
|
3819
|
-
> 1. 发送消息到房间内所有用户（暂时不支持 Web/小程序端），每秒最多能发送30条消息（与
|
|
3820
|
-
>
|
|
1823
|
+
> 1. 发送消息到房间内所有用户（暂时不支持 Web/小程序端），每秒最多能发送30条消息（与 sendSEIMsg 共享限制）。
|
|
1824
|
+
>
|
|
3821
1825
|
|
|
3822
1826
|
> 2. 每个包最大为 1KB，超过则很有可能会被中间路由器或者服务器丢弃。
|
|
3823
|
-
>
|
|
1827
|
+
>
|
|
3824
1828
|
|
|
3825
|
-
> 3. 每个客户端每秒最多能发送总计 16KB 数据（与
|
|
3826
|
-
>
|
|
1829
|
+
> 3. 每个客户端每秒最多能发送总计 16KB 数据（与 sendSEIMsg 共享限制）。
|
|
1830
|
+
>
|
|
3827
1831
|
|
|
3828
1832
|
> 4. 请将 ` reliable ` 和 ` ordered ` 同时设置为 true 或同时设置为 false，暂不支持交叉设置。
|
|
3829
|
-
>
|
|
1833
|
+
>
|
|
3830
1834
|
|
|
3831
1835
|
> 5. 强烈建议您将不同类型的消息设定为不同的 cmdID，这样可以在要求有序的情况下减小消息时延。
|
|
3832
|
-
>
|
|
1836
|
+
>
|
|
3833
1837
|
|
|
3834
1838
|
> 6. 目前仅支持主播身份。
|
|
3835
|
-
>
|
|
3836
|
-
|
|
1839
|
+
>
|
|
3837
1840
|
|
|
3838
1841
|
#### 返回值说明：
|
|
3839
1842
|
|
|
@@ -3841,67 +1844,44 @@ true：消息已经发出；false：消息发送失败。
|
|
|
3841
1844
|
|
|
3842
1845
|
## sendSEIMsg
|
|
3843
1846
|
|
|
3844
|
-
|
|
3845
|
-
|
|
3846
1847
|
#### 使用 SEI 通道发送自定义消息给房间内所有用户。
|
|
3847
1848
|
|
|
3848
1849
|
该接口可以让您借助 TRTC 的 SEI 通道，向当前房间里的其他用户广播自定义数据，已达到传输信令的目的。
|
|
3849
1850
|
|
|
3850
|
-
|
|
3851
|
-
|
|
3852
1851
|
视频帧的头部有一个叫做 SEI 的头部数据块，该接口的原理就是利用这个被称为 SEI 的头部数据块，将您要发送的自定义信令嵌入其中，使其同视频帧一并发送出去。
|
|
3853
1852
|
|
|
3854
|
-
因此，与
|
|
1853
|
+
因此，与 sendCustomCmdMsg 相比，SEI 通道传输的信令具有更好的兼容性：信令可以伴随着视频帧一直传输到直播 CDN 上。
|
|
3855
1854
|
|
|
3856
1855
|
不过，由于视频帧头部的数据块不能太大，建议您使用该接口时，尽量将信令控制在几个字节的大小。
|
|
3857
1856
|
|
|
3858
|
-
|
|
3859
|
-
|
|
3860
1857
|
最常见的用法是把自定义的时间戳（timestamp）用本接口嵌入视频帧中，实现消息和画面的完美对齐（例如：教育场景下的课件和视频信号的对齐）。
|
|
3861
1858
|
|
|
3862
|
-
房间中的其他用户可以通过
|
|
3863
|
-
|
|
3864
|
-
|
|
3865
|
-
|
|
3866
|
-
|
|
3867
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3868
|
-
</tr>
|
|
3869
|
-
|
|
3870
|
-
<tr>
|
|
3871
|
-
<td rowspan="1" colSpan="1" >data</td>
|
|
3872
|
-
|
|
3873
|
-
<td rowspan="1" colSpan="1" >待发送的数据，最大支持 1KB（1000字节）的数据大小</td>
|
|
3874
|
-
</tr>
|
|
3875
|
-
|
|
3876
|
-
<tr>
|
|
3877
|
-
<td rowspan="1" colSpan="1" >repeatCount</td>
|
|
3878
|
-
|
|
3879
|
-
<td rowspan="1" colSpan="1" >发送数据次数</td>
|
|
3880
|
-
</tr>
|
|
3881
|
-
</table>
|
|
3882
|
-
|
|
1859
|
+
房间中的其他用户可以通过 ITRTCCloudCallback 中的 onRecvSEIMsg 回调接收消息。
|
|
1860
|
+
| 参数 | 描述 |
|
|
1861
|
+
| --- | --- |
|
|
1862
|
+
| data | 待发送的数据，最大支持 1KB（1000字节）的数据大小 |
|
|
1863
|
+
| repeatCount | 发送数据次数 |
|
|
3883
1864
|
|
|
3884
1865
|
> **注意**
|
|
3885
|
-
>
|
|
1866
|
+
>
|
|
3886
1867
|
|
|
3887
1868
|
> 本接口有以下限制：
|
|
3888
|
-
>
|
|
1869
|
+
>
|
|
3889
1870
|
|
|
3890
1871
|
> 1. 数据在接口调用完后不会被即时发送出去，而是从下一帧视频帧开始与视频帧一起发送。
|
|
3891
|
-
>
|
|
3892
|
-
|
|
3893
|
-
> 2. 发送消息到房间内所有用户，每秒最多能发送 40 条消息（与 [sendCustomCmdMsg](https://write.woa.com/document/87030026264555520) 共享限制）。
|
|
3894
|
-
>
|
|
1872
|
+
>
|
|
3895
1873
|
|
|
3896
|
-
>
|
|
3897
|
-
>
|
|
1874
|
+
> 2. 发送消息到房间内所有用户，每秒最多能发送 40 条消息（与 sendCustomCmdMsg 共享限制）。
|
|
1875
|
+
>
|
|
3898
1876
|
|
|
3899
|
-
>
|
|
3900
|
-
>
|
|
1877
|
+
> 3. 每个包最大为 1KB，若发送大量数据，会导致视频码率增大，可能导致视频画质下降甚至卡顿（与 sendCustomCmdMsg 共享限制）。
|
|
1878
|
+
>
|
|
3901
1879
|
|
|
3902
|
-
>
|
|
3903
|
-
>
|
|
1880
|
+
> 4. 每个客户端每秒最多能发送总计 16KB 数据（与 sendCustomCmdMsg 共享限制）。
|
|
1881
|
+
>
|
|
3904
1882
|
|
|
1883
|
+
> 5. 若指定多次发送（repeatCount > 1），则数据会被带在后续的连续 repeatCount 个视频帧中发送出去，同样会导致视频码率增大。接收消息 onRecvSEIMsg 回调也可能会收到多次相同的消息，需要去重。
|
|
1884
|
+
>
|
|
3905
1885
|
|
|
3906
1886
|
#### 返回值说明：
|
|
3907
1887
|
|
|
@@ -3909,36 +1889,22 @@ true：消息已通过限制，等待后续视频帧发送；false：消息被
|
|
|
3909
1889
|
|
|
3910
1890
|
## startSpeedTest
|
|
3911
1891
|
|
|
3912
|
-
|
|
3913
|
-
|
|
3914
1892
|
#### 开始进行网速测试（进入房间前使用）。
|
|
3915
|
-
|
|
3916
|
-
|
|
3917
|
-
|
|
3918
|
-
|
|
3919
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3920
|
-
</tr>
|
|
3921
|
-
|
|
3922
|
-
<tr>
|
|
3923
|
-
<td rowspan="1" colSpan="1" >params</td>
|
|
3924
|
-
|
|
3925
|
-
<td rowspan="1" colSpan="1" >测速选项</td>
|
|
3926
|
-
</tr>
|
|
3927
|
-
</table>
|
|
3928
|
-
|
|
1893
|
+
| 参数 | 描述 |
|
|
1894
|
+
| --- | --- |
|
|
1895
|
+
| params | 测速选项 |
|
|
3929
1896
|
|
|
3930
1897
|
> **注意**
|
|
3931
|
-
>
|
|
1898
|
+
>
|
|
3932
1899
|
|
|
3933
1900
|
> 1. 测速过程将产生少量的基础服务费用，详见 [计费概述 > 基础服务](https://cloud.tencent.com/document/product/647/17157#.E5.9F.BA.E7.A1.80.E6.9C.8D.E5.8A.A1) 文档说明。
|
|
3934
|
-
>
|
|
1901
|
+
>
|
|
3935
1902
|
|
|
3936
1903
|
> 2. 请在进入房间前进行网速测试，在房间中网速测试会影响正常的音视频传输效果，而且由于干扰过多，网速测试结果也不准确。
|
|
3937
|
-
>
|
|
1904
|
+
>
|
|
3938
1905
|
|
|
3939
1906
|
> 3. 同一时间只允许一项网速测试任务运行。
|
|
3940
|
-
>
|
|
3941
|
-
|
|
1907
|
+
>
|
|
3942
1908
|
|
|
3943
1909
|
#### 返回值说明：
|
|
3944
1910
|
|
|
@@ -3946,84 +1912,39 @@ true：消息已通过限制，等待后续视频帧发送；false：消息被
|
|
|
3946
1912
|
|
|
3947
1913
|
## stopSpeedTest
|
|
3948
1914
|
|
|
3949
|
-
|
|
3950
|
-
|
|
3951
1915
|
#### 停止网络测速。
|
|
3952
1916
|
|
|
3953
1917
|
## getSDKVersion
|
|
3954
1918
|
|
|
3955
|
-
|
|
3956
|
-
|
|
3957
1919
|
#### 获取 SDK 版本信息。
|
|
3958
1920
|
|
|
3959
1921
|
## setLogLevel
|
|
3960
1922
|
|
|
3961
|
-
|
|
3962
|
-
|
|
3963
1923
|
#### 设置 Log 输出级别。
|
|
3964
|
-
|
|
3965
|
-
|
|
3966
|
-
|
|
3967
|
-
|
|
3968
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3969
|
-
</tr>
|
|
3970
|
-
|
|
3971
|
-
<tr>
|
|
3972
|
-
<td rowspan="1" colSpan="1" >level</td>
|
|
3973
|
-
|
|
3974
|
-
<td rowspan="1" colSpan="1" >参见 [TRTCLogLevel](https://write.woa.com/document/87030132707430400)，默认值：[TRTCLogLevelNone](https://write.woa.com/document/87030132707430400)</td>
|
|
3975
|
-
</tr>
|
|
3976
|
-
</table>
|
|
3977
|
-
|
|
1924
|
+
| 参数 | 描述 |
|
|
1925
|
+
| --- | --- |
|
|
1926
|
+
| level | 参见 TRTCLogLevel，默认值：TRTCLogLevelNone |
|
|
3978
1927
|
|
|
3979
1928
|
## setConsoleEnabled
|
|
3980
1929
|
|
|
3981
|
-
|
|
3982
|
-
|
|
3983
1930
|
#### 启用/禁用控制台日志打印。
|
|
3984
|
-
|
|
3985
|
-
|
|
3986
|
-
|
|
3987
|
-
|
|
3988
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
3989
|
-
</tr>
|
|
3990
|
-
|
|
3991
|
-
<tr>
|
|
3992
|
-
<td rowspan="1" colSpan="1" >enabled</td>
|
|
3993
|
-
|
|
3994
|
-
<td rowspan="1" colSpan="1" >指定是否启用，默认：禁止状态。</td>
|
|
3995
|
-
</tr>
|
|
3996
|
-
</table>
|
|
3997
|
-
|
|
1931
|
+
| 参数 | 描述 |
|
|
1932
|
+
| --- | --- |
|
|
1933
|
+
| enabled | 指定是否启用，默认：禁止状态。 |
|
|
3998
1934
|
|
|
3999
1935
|
## setLogCompressEnabled
|
|
4000
1936
|
|
|
4001
|
-
|
|
4002
|
-
|
|
4003
1937
|
#### 启用/禁用日志的本地压缩。
|
|
4004
1938
|
|
|
4005
1939
|
开启压缩后，Log 存储体积明显减小，但需要腾讯云提供的 Python 脚本解压后才能阅读。
|
|
4006
1940
|
|
|
4007
1941
|
禁用压缩后，Log 采用明文存储，可以直接用记事本打开阅读，但占用空间较大。
|
|
4008
|
-
|
|
4009
|
-
|
|
4010
|
-
|
|
4011
|
-
|
|
4012
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
4013
|
-
</tr>
|
|
4014
|
-
|
|
4015
|
-
<tr>
|
|
4016
|
-
<td rowspan="1" colSpan="1" >enabled</td>
|
|
4017
|
-
|
|
4018
|
-
<td rowspan="1" colSpan="1" >指定是否启用，默认为启动状态</td>
|
|
4019
|
-
</tr>
|
|
4020
|
-
</table>
|
|
4021
|
-
|
|
1942
|
+
| 参数 | 描述 |
|
|
1943
|
+
| --- | --- |
|
|
1944
|
+
| enabled | 指定是否启用，默认为启动状态 |
|
|
4022
1945
|
|
|
4023
1946
|
## setLogDirPath
|
|
4024
1947
|
|
|
4025
|
-
|
|
4026
|
-
|
|
4027
1948
|
#### 设置本地日志的保存路径。
|
|
4028
1949
|
|
|
4029
1950
|
通过该接口您可以更改 SDK 本地日志的默认存储路径，SDK 默认的本地日志的存储位置：
|
|
@@ -4033,99 +1954,49 @@ true：消息已通过限制，等待后续视频帧发送；false：消息被
|
|
|
4033
1954
|
|
|
4034
1955
|
- Android 平台：在 /app私有目录/files/log/liteav/ 下。
|
|
4035
1956
|
|
|
4036
|
-
|
|
4037
|
-
|
|
4038
|
-
|
|
4039
|
-
|
|
4040
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
4041
|
-
</tr>
|
|
4042
|
-
|
|
4043
|
-
<tr>
|
|
4044
|
-
<td rowspan="1" colSpan="1" >path</td>
|
|
4045
|
-
|
|
4046
|
-
<td rowspan="1" colSpan="1" >存储日志的路径</td>
|
|
4047
|
-
</tr>
|
|
4048
|
-
</table>
|
|
4049
|
-
|
|
1957
|
+
| 参数 | 描述 |
|
|
1958
|
+
| --- | --- |
|
|
1959
|
+
| path | 存储日志的路径 |
|
|
4050
1960
|
|
|
4051
1961
|
> **注意**
|
|
4052
|
-
>
|
|
1962
|
+
>
|
|
4053
1963
|
|
|
4054
1964
|
> 请务必在所有其他接口之前调用，并且保证您指定的目录是存在的，并且您的应用程序拥有对该目录的读写权限。
|
|
4055
|
-
>
|
|
4056
|
-
|
|
1965
|
+
>
|
|
4057
1966
|
|
|
4058
1967
|
## setLogCallback
|
|
4059
1968
|
|
|
4060
|
-
|
|
4061
|
-
|
|
4062
1969
|
#### 设置日志回调。
|
|
4063
1970
|
|
|
4064
1971
|
## showDebugView
|
|
4065
1972
|
|
|
4066
|
-
|
|
4067
|
-
|
|
4068
1973
|
#### 显示仪表盘。
|
|
4069
1974
|
|
|
4070
1975
|
“仪表盘”是位于视频渲染控件之上的一个半透明的调试信息浮层，用于展示音视频信息和事件信息，便于对接和调试。
|
|
4071
|
-
|
|
4072
|
-
|
|
4073
|
-
|
|
4074
|
-
|
|
4075
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
4076
|
-
</tr>
|
|
4077
|
-
|
|
4078
|
-
<tr>
|
|
4079
|
-
<td rowspan="1" colSpan="1" >showType</td>
|
|
4080
|
-
|
|
4081
|
-
<td rowspan="1" colSpan="1" >0：不显示；1：显示精简版（仅显示音视频信息）；2：显示完整版（包含音视频信息和事件信息）。</td>
|
|
4082
|
-
</tr>
|
|
4083
|
-
</table>
|
|
4084
|
-
|
|
1976
|
+
| 参数 | 描述 |
|
|
1977
|
+
| --- | --- |
|
|
1978
|
+
| showType | 0：不显示；1：显示精简版（仅显示音视频信息）；2：显示完整版（包含音视频信息和事件信息）。 |
|
|
4085
1979
|
|
|
4086
1980
|
## callExperimentalAPI
|
|
4087
1981
|
|
|
4088
|
-
|
|
4089
|
-
|
|
4090
1982
|
#### 调用实验性接口。
|
|
4091
1983
|
|
|
4092
1984
|
## enablePayloadPrivateEncryption
|
|
4093
1985
|
|
|
4094
|
-
|
|
4095
|
-
|
|
4096
1986
|
#### 开启或关闭媒体流私有加密。
|
|
4097
1987
|
|
|
4098
1988
|
在安全要求较高的场景下，TRTC 建议您在加入房间前，调用 ` enablePayloadPrivateEncryption ` 方法开启媒体流私有加密。
|
|
4099
1989
|
|
|
4100
1990
|
用户退出房间后，SDK 会自动关闭私有加密。如需重新开启私有加密，您需要在用户再次加入房间前调用该方法。
|
|
4101
|
-
|
|
4102
|
-
|
|
4103
|
-
|
|
4104
|
-
|
|
4105
|
-
<td rowspan="1" colSpan="1" >描述</td>
|
|
4106
|
-
</tr>
|
|
4107
|
-
|
|
4108
|
-
<tr>
|
|
4109
|
-
<td rowspan="1" colSpan="1" >config</td>
|
|
4110
|
-
|
|
4111
|
-
<td rowspan="1" colSpan="1" >配置媒体流私有加密的算法和密钥，参见 [TRTCPayloadPrivateEncryptionConfig](https://write.woa.com/document/87030132707430400)。</td>
|
|
4112
|
-
</tr>
|
|
4113
|
-
|
|
4114
|
-
<tr>
|
|
4115
|
-
<td rowspan="1" colSpan="1" >enabled</td>
|
|
4116
|
-
|
|
4117
|
-
<td rowspan="1" colSpan="1" >是否开启媒体流私有加密。</td>
|
|
4118
|
-
</tr>
|
|
4119
|
-
</table>
|
|
4120
|
-
|
|
1991
|
+
| 参数 | 描述 |
|
|
1992
|
+
| --- | --- |
|
|
1993
|
+
| config | 配置媒体流私有加密的算法和密钥，参见 TRTCPayloadPrivateEncryptionConfig。 |
|
|
1994
|
+
| enabled | 是否开启媒体流私有加密。 |
|
|
4121
1995
|
|
|
4122
1996
|
> **注意**
|
|
4123
|
-
>
|
|
1997
|
+
>
|
|
4124
1998
|
|
|
4125
1999
|
> TRTC 已经内置对媒体流进行加密后再传输，启用媒体流私有加密后将使用您传入的密匙与初始向量进行再次加密。
|
|
4126
|
-
>
|
|
4127
|
-
|
|
2000
|
+
>
|
|
4128
2001
|
|
|
4129
2002
|
#### 返回值说明：
|
|
4130
|
-
|
|
4131
|
-
接口调用结果，0: 方法调用成功， -1: 传入参数无效， -2: 功能已过期。若需解锁：请前往购买 [TRTC 旗舰版（国内站）/ 专业版（国际站）套餐](https://buy.cloud.tencent.com/trtc?tab=uikit&type=call&pkg=top)，并[联系我们](https://console.cloud.tencent.com/workorder/category?from=connect-us)审核后使用。
|