@tencentcloud/sdk-mcp 1.6.4 → 1.6.6
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/knowledge/build-index.js +1 -1
- package/knowledge/chunker.js +81 -52
- package/knowledge/path-meta.js +181 -21
- package/knowledge/search/exact-lookup.js +245 -43
- package/knowledge/search/filter-pool.js +73 -19
- package/knowledge/search/product-scope-intent.js +2 -2
- package/knowledge/search/requires-framework.js +1 -1
- package/knowledge/search/search-knowledge.js +246 -60
- package/package.json +1 -1
- package/resource/_schema/feature-aliases.yaml +1 -0
- package/resource/integration/callkit/preset/android/integration.md +3 -5
- package/resource/integration/callkit/preset/flutter/integration.md +2 -3
- package/resource/integration/callkit/preset/ios/integration.md +2 -5
- package/resource/integration/callkit/preset/react/integration.md +12 -26
- package/resource/integration/callkit/preset/vue/integration.md +17 -33
- package/resource/integration/chat/preset/android/integration.md +44 -14
- package/resource/integration/chat/preset/flutter/integration.md +54 -13
- package/resource/integration/chat/preset/ios/integration.md +42 -6
- package/resource/integration/chat/preset/react/integration.md +30 -28
- package/resource/integration/chat/preset/uni-app/integration.md +101 -40
- package/resource/integration/chat/preset/vue/integration.md +62 -28
- package/resource/integration/livekit/preset/live/android/live-audience-integration.md +133 -0
- package/resource/integration/livekit/preset/live/android/live-host-integration.md +225 -0
- package/resource/integration/livekit/preset/live/android/live-list-integration.md +278 -0
- package/resource/integration/livekit/preset/live/android/prepare-integration.md +271 -0
- package/resource/integration/livekit/preset/live/ios/live-audience-integration.md +207 -0
- package/resource/integration/livekit/preset/live/ios/live-host-integration.md +358 -0
- package/resource/integration/livekit/preset/live/ios/live-list-integration.md +246 -0
- package/resource/integration/livekit/preset/live/ios/prepare-integration.md +218 -0
- package/resource/integration/livekit/preset/live/vue/live-list-integration.md +4 -7
- package/resource/integration/livekit/preset/live/vue/live-player-desk-integration.md +5 -12
- package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +4 -11
- package/resource/integration/livekit/preset/live/vue/live-pusher-integration.md +250 -482
- package/resource/integration/roomkit/preset/vue/integration.md +399 -106
- package/resource/knowledge/callkit/best-practice/web/callengine-invitation.md +80 -0
- package/resource/knowledge/callkit/best-practice/web/callengine-log-control.md +20 -0
- package/resource/knowledge/callkit/best-practice/web/callkit-call-vs-calls.md +116 -0
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +11 -15
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +10 -13
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +2 -4
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +10 -17
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +11 -17
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +11 -20
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +10 -15
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +9 -14
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +12 -18
- package/resource/knowledge/callkit/core-sdk/miniprogram/call-engine.md +390 -0
- package/resource/knowledge/callkit/core-sdk/miniprogram/call-event.md +317 -0
- package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +16 -22
- package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +17 -23
- package/resource/knowledge/callkit/core-sdk/web/call-engine.md +39 -0
- package/resource/knowledge/callkit/core-sdk/web/call-event.md +341 -0
- package/resource/knowledge/callkit/core-sdk/web/callengine-api-overview.md +39 -0
- package/resource/knowledge/callkit/faq/android.md +1 -5
- package/resource/knowledge/callkit/faq/common.md +10 -12
- package/resource/knowledge/callkit/faq/ios.md +5 -7
- package/resource/knowledge/callkit/faq/uniapp-app.md +7 -7
- package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +9 -12
- package/resource/knowledge/callkit/faq/web.md +2 -12
- package/resource/knowledge/callkit/preset/android/api.md +5 -8
- package/resource/knowledge/callkit/preset/ios/api.md +4 -6
- package/resource/knowledge/callkit/preset/miniprogram/api.md +295 -0
- package/resource/knowledge/callkit/preset/react/api.md +622 -0
- package/resource/knowledge/callkit/preset/react/uikit-api-reference.md +475 -0
- package/resource/knowledge/callkit/preset/vue/api.md +622 -0
- package/resource/knowledge/callkit/preset/vue/uikit-api-reference.md +587 -0
- package/resource/knowledge/callkit/preset/web/api.md +1 -1
- package/resource/knowledge/chat/best-practice/web/image-message-url-handling.md +16 -0
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +1 -1
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +0 -1
- package/resource/knowledge/chat/preset/android/features/language.md +2 -4
- package/resource/knowledge/chat/preset/android/features/message-input.md +1 -1
- package/resource/knowledge/chat/preset/android/features/message-list.md +1 -2
- package/resource/knowledge/chat/preset/android/features/search.md +0 -1
- package/resource/knowledge/chat/preset/android/features/theme.md +1 -1
- package/resource/knowledge/chat/preset/android-view/integration.md +35 -10
- package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +0 -1
- package/resource/knowledge/chat/preset/flutter/features/language.md +1 -1
- package/resource/knowledge/chat/preset/flutter/features/message-list.md +0 -1
- package/resource/knowledge/chat/preset/flutter/features/search.md +4 -5
- package/resource/knowledge/chat/preset/flutter/features/theme.md +1 -1
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +1 -1
- package/resource/knowledge/chat/preset/ios/features/conversation-list.md +0 -1
- package/resource/knowledge/chat/preset/ios/features/language.md +2 -5
- package/resource/knowledge/chat/preset/ios/features/message-list.md +0 -1
- package/resource/knowledge/chat/preset/ios/features/search.md +0 -1
- package/resource/knowledge/chat/preset/ios/features/theme.md +1 -1
- package/resource/knowledge/chat/preset/ios-uikit/integration.md +57 -166
- package/resource/knowledge/chat/preset/react/features/chat-setting.md +0 -1
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +3 -3
- package/resource/knowledge/chat/preset/react/features/conversation-list.md +3 -3
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +1 -1
- package/resource/knowledge/chat/preset/react/features/message-input.md +2 -3
- package/resource/knowledge/chat/preset/react/features/search.md +0 -1
- package/resource/knowledge/chat/preset/vue/features/chat-header.md +1 -1
- package/resource/knowledge/chat/preset/vue/features/chat-setting.md +3 -4
- package/resource/knowledge/chat/preset/vue/features/conversation-list.md +4 -4
- package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +1 -1
- package/resource/knowledge/chat/preset/vue/features/message-input.md +2 -2
- package/resource/knowledge/chat/preset/vue/features/message-list.md +2 -2
- package/resource/knowledge/chat/preset/vue/features/search.md +0 -1
- package/resource/knowledge/chat/preset/vue/features/theme.md +4 -4
- package/resource/knowledge/chat/urls/sdk/android.md +3 -3
- package/resource/knowledge/chat/urls/sdk/flutter.md +3 -3
- package/resource/knowledge/chat/urls/sdk/ios.md +3 -3
- package/resource/knowledge/chat/urls/sdk/web.md +3 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +2 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +12 -15
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +1 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +3 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +12 -15
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +1 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +2 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +3 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +1 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/vue/capability-matrix.md +82 -0
- package/resource/knowledge/livekit/core-sdk/{voice/android/voice-audio-effect.md → features/android/audio-effect.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/{live/android/live-barrage.md → features/android/barrage.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{live/android/live-base-beauty.md → features/android/base-beauty.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{voice/android/voice-gift.md → features/android/gift.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/{live/android/live-live-list.md → features/android/live-list.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{live/flutter/live-audio-effect.md → features/flutter/audio-effect.md} +0 -2
- package/resource/knowledge/livekit/core-sdk/{voice/flutter/voice-barrage.md → features/flutter/barrage.md} +3 -3
- package/resource/knowledge/livekit/core-sdk/{voice/flutter/voice-gift.md → features/flutter/gift.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/{voice/flutter/voice-room-list.md → features/flutter/live-list.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-audience-list.md → features/ios/audience-list.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-audio-effect.md → features/ios/audio-effect.md} +1 -3
- package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-barrage.md → features/ios/barrage.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/{live/ios/live-base-beauty.md → features/ios/base-beauty.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{live/ios/live-gift.md → features/ios/gift.md} +8 -9
- package/resource/knowledge/livekit/core-sdk/{live/ios/live-live-list.md → features/ios/live-list.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-audio-effect.md → features/uni-app/audio-effect.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-barrage.md → features/uni-app/barrage.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/features/uni-app/base-beauty.md +145 -0
- package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-gift.md → features/uni-app/gift.md} +6 -7
- package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-room-list.md → features/uni-app/live-list.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/live/android/{live-co-guest-interaction.md → co-guest-interaction.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/live/android/{live-host-interaction.md → host-interaction.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/live/android/{live-integration.md → integration.md} +6 -9
- package/resource/knowledge/livekit/core-sdk/live/flutter/{live-host-interaction.md → host-interaction.md} +1 -3
- package/resource/knowledge/livekit/core-sdk/live/flutter/{live-integration.md → integration.md} +1 -6
- package/resource/knowledge/livekit/core-sdk/live/ios/{live-co-guest-interaction.md → co-guest-interaction.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/live/ios/{live-host-interaction.md → host-interaction.md} +3 -5
- package/resource/knowledge/livekit/core-sdk/live/ios/{live-integration.md → integration.md} +7 -10
- package/resource/knowledge/livekit/core-sdk/live/uni-app/co-guest-interaction.md +561 -0
- package/resource/knowledge/livekit/core-sdk/live/uni-app/host-interaction.md +323 -0
- package/resource/knowledge/livekit/core-sdk/live/uni-app/integration.md +312 -0
- package/resource/knowledge/livekit/core-sdk/voice/android/{voice-co-guest-interaction.md → co-guest-interaction.md} +3 -3
- package/resource/knowledge/livekit/core-sdk/voice/android/{voice-host-interaction.md → host-interaction.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/voice/android/{voice-integration.md → integration.md} +11 -14
- package/resource/knowledge/livekit/core-sdk/voice/flutter/{voice-co-guest-interaction.md → co-guest-interaction.md} +0 -1
- package/resource/knowledge/livekit/core-sdk/voice/flutter/{voice-integration.md → integration.md} +1 -4
- package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-co-guest-interaction.md → co-guest-interaction.md} +3 -3
- package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-host-interaction.md → host-interaction.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-integration.md → integration.md} +7 -10
- package/resource/knowledge/livekit/core-sdk/voice/uni-app/{voice-co-guest-interaction.md → co-guest-interaction.md} +6 -6
- package/resource/knowledge/livekit/core-sdk/voice/uni-app/{voice-integration.md → integration.md} +6 -7
- package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +2 -3
- package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +1 -1
- package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +1 -1
- package/resource/knowledge/push/api-reference/android.md +337 -0
- package/resource/knowledge/push/api-reference/donut.md +190 -0
- package/resource/knowledge/push/api-reference/flutter.md +176 -0
- package/resource/knowledge/push/api-reference/harmonyos.md +140 -0
- package/resource/knowledge/push/api-reference/ios.md +537 -0
- package/resource/knowledge/push/api-reference/react-native.md +154 -0
- package/resource/knowledge/push/api-reference/uni-app.md +148 -0
- package/resource/knowledge/push/api-reference/unity.md +119 -0
- package/resource/knowledge/push/api-reference/unreal-engine.md +123 -0
- package/resource/knowledge/push/config/android/fcm.md +1 -8
- package/resource/knowledge/push/config/android/honor.md +3 -7
- package/resource/knowledge/push/config/android/huawei.md +0 -5
- package/resource/knowledge/push/config/android/meizu.md +0 -5
- package/resource/knowledge/push/config/android/oppo.md +0 -4
- package/resource/knowledge/push/config/android/vivo.md +0 -4
- package/resource/knowledge/push/config/android/xiaomi.md +0 -2
- package/resource/knowledge/push/config/donut.md +33 -46
- package/resource/knowledge/push/config/harmonyos.md +6 -9
- package/resource/knowledge/push/config/ios.md +2 -9
- package/resource/knowledge/push/config/react-native.md +17 -25
- package/resource/knowledge/push/config/unity.md +16 -24
- package/resource/knowledge/push/config/unreal-engine.md +16 -24
- package/resource/knowledge/push/integration/android.md +21 -21
- package/resource/knowledge/push/integration/donut.md +24 -34
- package/resource/knowledge/push/integration/flutter.md +12 -1
- package/resource/knowledge/push/integration/harmonyos.md +2 -1
- package/resource/knowledge/push/integration/ios.md +16 -10
- package/resource/knowledge/push/integration/react-native.md +10 -14
- package/resource/knowledge/push/integration/uni-app.md +10 -6
- package/resource/knowledge/push/integration/unity.md +19 -22
- package/resource/knowledge/push/integration/unreal-engine.md +7 -9
- package/resource/knowledge/push/overview/prepare.md +2 -2
- package/resource/knowledge/roomkit/core-sdk/android/capability-matrix.md +46 -0
- package/resource/knowledge/roomkit/core-sdk/android/unsupported-features.md +82 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/capability-matrix.md +46 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/flutter/unsupported-features.md +82 -0
- package/resource/knowledge/roomkit/core-sdk/ios/capability-matrix.md +46 -0
- package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/ios/unsupported-features.md +82 -0
- package/resource/knowledge/roomkit/core-sdk/vue/call-user-to-room.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +2 -5
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +0 -3
- package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +2 -6
- package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +0 -1
- package/resource/knowledge/roomkit/core-sdk/vue/schedule-room.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +2 -4
- package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +2 -3
- package/resource/knowledge/roomkit/preset/android/integration.md +14 -16
- package/resource/knowledge/roomkit/preset/flutter/integration.md +9 -17
- package/resource/knowledge/roomkit/preset/ios/integration.md +9 -17
- package/resource/knowledge/roomkit/preset/react/integration.md +0 -4
- package/resource/knowledge/trtc/android/TRTCCloud.md +97 -180
- package/resource/knowledge/trtc/android/TRTCCloudDef.md +20 -20
- package/resource/knowledge/trtc/android/TRTCCloudListener.md +43 -77
- package/resource/knowledge/trtc/android/TRTCStatistics.md +1 -1
- package/resource/knowledge/trtc/android/TXAudioEffectManager.md +4 -24
- package/resource/knowledge/trtc/android/TXDeviceManager.md +2 -2
- package/resource/knowledge/trtc/android/TXLiteAVCode.md +1 -1
- package/resource/knowledge/trtc/c++/ITRTCCloud.md +96 -189
- package/resource/knowledge/trtc/c++/ITRTCStatistics.md +1 -1
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +1 -21
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +4 -6
- package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +42 -76
- package/resource/knowledge/trtc/c++/TRTCTypeDef.md +18 -19
- package/resource/knowledge/trtc/c++/TXLiteAVCode.md +1 -1
- package/resource/knowledge/trtc/ios/TRTCCloud.md +95 -181
- package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +43 -78
- package/resource/knowledge/trtc/ios/TRTCStatistics.md +1 -1
- package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +1 -20
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +4 -6
- package/resource/knowledge/trtc/ios/TXLiteAVCode.md +1 -1
- package/resource/knowledge/trtc/ios/TXLiveSDKTypeDef.md +20 -20
- package/server.js +2 -2
- package/tools/common/finalize_answer.js +1 -1
- package/tools/common/present_framework_choice.js +2 -2
- package/tools/common/search_trtc_knowledge.js +3 -3
- package/tools/common/submit_feedback.js +1 -1
- package/tools/definitions/get_native_live_uikit_integration_def.js +60 -0
- package/tools/definitions/get_native_livekit_core_integration_def.js +1 -1
- package/tools/definitions/present_framework_choice_def.js +2 -2
- package/tools/definitions/search_trtc_knowledge_def.js +5 -5
- package/tools/index.js +2 -0
- package/tools/live/get_native_live_uikit_integration.js +69 -0
- package/tools/live/get_native_livekit_core_integration.js +6 -6
- package/utils/report-cls-client.js +1 -1
- package/utils/report-es-client.js +1 -1
- package/resource/index/component-slugs.json +0 -1
- package/resource/index/doc-source-urls.json +0 -1
- package/resource/index/manifest.json +0 -1
- package/resource/knowledge/livekit/core-sdk/live/android/live-audio-effect.md +0 -229
- package/resource/knowledge/livekit/core-sdk/live/android/live-gift.md +0 -459
- package/resource/knowledge/livekit/core-sdk/live/flutter/live-barrage.md +0 -506
- package/resource/knowledge/livekit/core-sdk/live/flutter/live-gift.md +0 -427
- package/resource/knowledge/livekit/core-sdk/live/flutter/live-live-list.md +0 -726
- package/resource/knowledge/livekit/core-sdk/live/ios/live-audience-list.md +0 -265
- package/resource/knowledge/livekit/core-sdk/live/ios/live-audio-effect.md +0 -214
- package/resource/knowledge/livekit/core-sdk/live/ios/live-barrage.md +0 -427
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-audience-list.md +0 -272
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-barrage.md +0 -486
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-room-list.md +0 -523
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audience-list.md +0 -262
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audio-effect.md +0 -600
- package/resource/knowledge/livekit/core-sdk/voice/ios/voice-gift.md +0 -411
- package/resource/knowledge/livekit/core-sdk/voice/ios/voice-room-list.md +0 -404
- /package/resource/knowledge/livekit/core-sdk/api-reference/{web → vue}/index.md +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/android/live-audience-list.md → features/android/audience-list.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/flutter/live-audience-list.md → features/flutter/audience-list.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/flutter/live-base-beauty.md → features/flutter/base-beauty.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-audience-list.md → features/uni-app/audience-list.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/live/flutter/{live-co-guest-interaction.md → co-guest-interaction.md} +0 -0
|
@@ -4,7 +4,7 @@ Module: TRTCCloud @ TXLiteAVSDK
|
|
|
4
4
|
|
|
5
5
|
Function: 腾讯云 TRTC 主功能接口
|
|
6
6
|
|
|
7
|
-
Version: 13.
|
|
7
|
+
Version: 13.4
|
|
8
8
|
|
|
9
9
|
## ITRTCCloud
|
|
10
10
|
|
|
@@ -127,18 +127,15 @@ Version: 13.3
|
|
|
127
127
|
**创建 TRTCCloud 实例(单例模式)。**
|
|
128
128
|
| 参数 | 描述 |
|
|
129
129
|
| --- | --- |
|
|
130
|
-
| context | 仅适用于 Android 平台,SDK 内部会将其转化为 Android 平台的 ApplicationContext 用于调用 Android System API。<br>如果传入的
|
|
130
|
+
| context | 仅适用于 Android 平台,SDK 内部会将其转化为 Android 平台的 ApplicationContext 用于调用 Android System API。<br>如果传入的 <code>context</code> 参数为空,SDK 内部会自动获取当前进程的 ApplicationContext。 |
|
|
131
131
|
|
|
132
132
|
> **注意**
|
|
133
133
|
>
|
|
134
|
-
|
|
135
|
-
> 1. 如果您使用 ` delete ITRTCCloud* ` 会导致编译错误,请使用 destroyTRTCShareInstance 释放对象指针。
|
|
134
|
+
> 1. 如果您使用 `delete ITRTCCloud*` 会导致编译错误,请使用 destroyTRTCShareInstance 释放对象指针。
|
|
136
135
|
>
|
|
137
|
-
|
|
138
|
-
> 2. 在 Windows、Mac 和 iOS 平台上,请调用 ` getTRTCShareInstance() ` 接口。
|
|
136
|
+
> 2. 在 Windows、Mac 和 iOS 平台上,请调用 `getTRTCShareInstance()` 接口。
|
|
139
137
|
>
|
|
140
|
-
|
|
141
|
-
> 3. 在 Android 平台上,请调用 ` getTRTCShareInstance(void *context) ` 接口。
|
|
138
|
+
> 3. 在 Android 平台上,请调用 `getTRTCShareInstance(void *context)` 接口。
|
|
142
139
|
>
|
|
143
140
|
|
|
144
141
|
## destroyTRTCShareInstance
|
|
@@ -172,9 +169,9 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
172
169
|
包括 TRTCAppSceneLIVE 和 TRTCAppSceneVoiceChatRoom 两个可选项,分别是视频直播和语音直播,该模式适合十万人以内的在线直播场景,但需要您在接下来介绍的 TRTCParams 参数中指定 **角色(role)** 这个字段,也就是将房间中的用户区分为 **主播** (TRTCRoleAnchor) 和 **观众** (TRTCRoleAudience) 两种不同的角色。
|
|
173
170
|
|
|
174
171
|
调用该接口后,您会收到来自 ITRTCCloudCallback 中的 onEnterRoom 回调:
|
|
175
|
-
- 如果进房成功,参数
|
|
172
|
+
- 如果进房成功,参数 `result` 会是一个正数(result > 0),表示从函数调用到进入房间所花费的时间,单位是毫秒(ms)。
|
|
176
173
|
|
|
177
|
-
- 如果进房失败,参数
|
|
174
|
+
- 如果进房失败,参数 `result` 会是一个负数(result < 0),表示进房失败的[错误码](https://cloud.tencent.com/document/product/647/32257)。
|
|
178
175
|
|
|
179
176
|
|参数|描述|
|
|
180
177
|
|---------|---------|
|
|
@@ -183,13 +180,10 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
183
180
|
|
|
184
181
|
> **注意**
|
|
185
182
|
>
|
|
186
|
-
|
|
187
|
-
> 1. 同一个房间内的所有用户需要设定相同的 ` scene `。不同的 ` scene ` 会导致偶现的异常问题。
|
|
183
|
+
> 1. 同一个房间内的所有用户需要设定相同的 `scene` 。不同的 `scene` 会导致偶现的异常问题。
|
|
188
184
|
>
|
|
189
|
-
|
|
190
|
-
> 2. 当您指定参数 ` scene ` 为 TRTCAppSceneLIVE 或 TRTCAppSceneVoiceChatRoom 时,您必须通过 TRTCParams 中的 ` role `字段为当前用户设定他/她在房间中的角色。
|
|
185
|
+
> 2. 当您指定参数 `scene` 为 TRTCAppSceneLIVE 或 TRTCAppSceneVoiceChatRoom 时,您必须通过 TRTCParams 中的 `role` 字段为当前用户设定他/她在房间中的角色。
|
|
191
186
|
>
|
|
192
|
-
|
|
193
187
|
> 3. 请您尽量保证 enterRoom 与 exitRoom 前后配对使用,即保证“先退出前一个房间再进入下一个房间”,否则会导致很多异常问题。
|
|
194
188
|
>
|
|
195
189
|
|
|
@@ -211,18 +205,16 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
211
205
|
|
|
212
206
|
由于视频直播和语音聊天室需要支持多达10万名观众同时观看,所以设定了 **只有主播才能发布自己的音视频** 的规则。因此,当有些观众希望发布自己的音视频流(以便能跟主播互动)时,就需要先把自己的角色切换成 **主播**。
|
|
213
207
|
|
|
214
|
-
您可以在进入房间时通过 TRTCParams 中的
|
|
208
|
+
您可以在进入房间时通过 TRTCParams 中的 `role` 字段事先确定用户的角色,也可以在进入房间后通过该接口动态切换角色。
|
|
215
209
|
| 参数 | 描述 |
|
|
216
210
|
| --- | --- |
|
|
217
|
-
| role | 角色,默认为 <strong>主播</strong>。<br>-
|
|
211
|
+
| role | 角色,默认为 <strong>主播</strong>。<br>- TRTCRoleAnchor :主播,可以发布自己的音视频,同一个房间里最多支持50个主播同时发布音视频。<br>- TRTCRoleAudience :观众,不能发布自己的音视频流,只能观看房间中其他主播的音视频。如果要发布自己的音视频,需要先通过 switchRole 切换成 <strong>主播</strong>,同一个房间内同时最多可以容纳 10 万名观众。 |
|
|
218
212
|
|
|
219
213
|
> **注意**
|
|
220
214
|
>
|
|
221
|
-
|
|
222
215
|
> 1. 该接口仅适用于视频直播(TRTCAppSceneLIVE)和语音聊天室(TRTCAppSceneVoiceChatRoom)这两个场景。
|
|
223
216
|
>
|
|
224
|
-
|
|
225
|
-
> 2. 如果您在调用 enterRoom 时指定的 ` scene ` 为 TRTCAppSceneVideoCall 或 TRTCAppSceneAudioCall,请不要调用这个接口。
|
|
217
|
+
> 2. 如果您在调用 enterRoom 时指定的 `scene` 为 TRTCAppSceneVideoCall 或 TRTCAppSceneAudioCall,请不要调用这个接口。
|
|
226
218
|
>
|
|
227
219
|
|
|
228
220
|
## switchRole
|
|
@@ -233,19 +225,17 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
233
225
|
|
|
234
226
|
由于视频直播和语音聊天室需要支持多达10万名观众同时观看,所以设定了 **只有主播才能发布自己的音视频** 的规则。因此,当有些观众希望发布自己的音视频流(以便能跟主播互动)时,就需要先把自己的角色切换成 **主播**。
|
|
235
227
|
|
|
236
|
-
您可以在进入房间时通过 TRTCParams 中的
|
|
228
|
+
您可以在进入房间时通过 TRTCParams 中的 `role` 字段事先确定用户的角色,也可以在进入房间后通过该接口动态切换角色。
|
|
237
229
|
| 参数 | 描述 |
|
|
238
230
|
| --- | --- |
|
|
239
|
-
| privateMapKey | 用于权限控制的权限票据,当您希望某个房间只能让特定的 userId 进入或者上行视频时,需要使用
|
|
240
|
-
| role | 角色,默认为 <strong>主播</strong>。<br>-
|
|
231
|
+
| privateMapKey | 用于权限控制的权限票据,当您希望某个房间只能让特定的 userId 进入或者上行视频时,需要使用 <code>privateMapKey</code> 进行权限保护。<br>- 仅建议有高级别安全需求的客户使用,更多详情请参见 <a href="https://cloud.tencent.com/document/product/647/32240">开启高级权限控制</a>。 |
|
|
232
|
+
| role | 角色,默认为 <strong>主播</strong>。<br>- TRTCRoleAnchor :主播,可以发布自己的音视频,同一个房间里最多支持50个主播同时发布音视频。<br>- TRTCRoleAudience :观众,不能发布自己的音视频流,只能观看房间中其他主播的音视频。如果要发布自己的音视频,需要先通过 switchRole 切换成 <strong>主播</strong>,同一个房间内同时最多可以容纳 10 万名观众。 |
|
|
241
233
|
|
|
242
234
|
> **注意**
|
|
243
235
|
>
|
|
244
|
-
|
|
245
236
|
> 1. 该接口仅适用于视频直播(TRTCAppSceneLIVE)和语音聊天室(TRTCAppSceneVoiceChatRoom)这两个场景。
|
|
246
237
|
>
|
|
247
|
-
|
|
248
|
-
> 2. 如果您在 enterRoom 时指定的 ` scene ` 为 TRTCAppSceneVideoCall 或 TRTCAppSceneAudioCall,请不要调用这个接口。
|
|
238
|
+
> 2. 如果您在 enterRoom 时指定的 `scene` 为 TRTCAppSceneVideoCall 或 TRTCAppSceneAudioCall,请不要调用这个接口。
|
|
249
239
|
>
|
|
250
240
|
|
|
251
241
|
## switchRoom
|
|
@@ -253,11 +243,11 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
253
243
|
**切换房间。**
|
|
254
244
|
|
|
255
245
|
使用该接口可以让用户快速从一个房间切换到另一个房间。
|
|
256
|
-
- 如果用户的身份是“观众”,该接口的调用效果等同于
|
|
246
|
+
- 如果用户的身份是“观众”,该接口的调用效果等同于 `exitRoom(当前房间) + enterRoom(新的房间)` 。
|
|
257
247
|
|
|
258
248
|
- 如果用户的身份是“主播”,该接口在切换房间的同时还会保持自己的音视频发布状态,因此在房间切换过程中,摄像头的预览和声音的采集都不会中断。
|
|
259
249
|
|
|
260
|
-
该接口适用于在线教育场景中,监课老师在多个房间中进行快速切换的场景。在该场景下使用
|
|
250
|
+
该接口适用于在线教育场景中,监课老师在多个房间中进行快速切换的场景。在该场景下使用 `switchRoom` 可以获得比 `exitRoom + enterRoom` 更好的流畅性和更少的代码量。
|
|
261
251
|
|
|
262
252
|
接口调用结果会通过 ITRTCCloudCallback 中的 onSwitchRoom 回调。
|
|
263
253
|
|
|
@@ -267,14 +257,11 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
267
257
|
|
|
268
258
|
> **注意**
|
|
269
259
|
>
|
|
270
|
-
|
|
271
|
-
> 由于对老版本 SDK 兼容的需求,参数 ` config ` 中同时包含 ` roomId ` 与 ` strRoomId ` 两个参数,这两个参数的填写格外讲究,请注意如下事项:
|
|
260
|
+
> 由于对老版本 SDK 兼容的需求,参数 `config` 中同时包含 `roomId` 与 `strRoomId` 两个参数,这两个参数的填写格外讲究,请注意如下事项:
|
|
272
261
|
>
|
|
273
|
-
|
|
274
|
-
> 1. 若您选用 ` strRoomId `,则 ` roomId ` 需要填写为0。若两者都填,将优先选用 ` roomId `。
|
|
262
|
+
> 1. 若您选用 `strRoomId` ,则 `roomId` 需要填写为0。若两者都填,将优先选用 `roomId` 。
|
|
275
263
|
>
|
|
276
|
-
|
|
277
|
-
> 2. 所有房间需要同时使用 ` strRoomId ` 或同时使用 ` roomId `,不可混用,否则将会出现很多预期之外的 bug。
|
|
264
|
+
> 2. 所有房间需要同时使用 `strRoomId` 或同时使用 `roomId` ,不可混用,否则将会出现很多预期之外的 bug。
|
|
278
265
|
>
|
|
279
266
|
|
|
280
267
|
## connectOtherRoom
|
|
@@ -289,16 +276,16 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
289
276
|
|
|
290
277
|
跨房通话的请求结果会通过 ITRTCCloudCallback 中的 onConnectOtherRoom 回调通知给您。
|
|
291
278
|
|
|
292
|
-
例如:当房间“101”中的主播 A 通过
|
|
293
|
-
- 房间“101”中的用户都会收到主播 B 的
|
|
279
|
+
例如:当房间“101”中的主播 A 通过 `connectOtherRoom()` 跟房间“102”中的主播 B 建立跨房通话后,
|
|
280
|
+
- 房间“101”中的用户都会收到主播 B 的 `onRemoteUserEnterRoom(B)` 和 `onUserVideoAvailable(B,true)` 这两个事件回调,即房间“101”中的用户都可以订阅主播 B 的音视频。
|
|
294
281
|
|
|
295
|
-
- 房间“102”中的用户都会收到主播 A 的
|
|
282
|
+
- 房间“102”中的用户都会收到主播 A 的 `onRemoteUserEnterRoom(A)` 和 `onUserVideoAvailable(A,true)` 这两个事件回调,即房间“102”中的用户都可以订阅主播 A 的音视频。
|
|
296
283
|
|
|
297
284
|
跨房通话的参数考虑到后续扩展字段的兼容性问题,暂时采用了 JSON 格式的参数:
|
|
298
285
|
|
|
299
286
|
**情况一:数字房间号**
|
|
300
287
|
|
|
301
|
-
如果房间“101”中的主播 A 要跟房间“102”中的主播 B 连麦,那么主播 A
|
|
288
|
+
如果房间“101”中的主播 A 要跟房间“102”中的主播 B 连麦,那么主播 A 调用该接口时需要传入: `{"roomId": 102, "userId": "userB"}`
|
|
302
289
|
|
|
303
290
|
示例代码如下:
|
|
304
291
|
``` cpp
|
|
@@ -312,7 +299,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
312
299
|
|
|
313
300
|
**情况二:字符串房间号**
|
|
314
301
|
|
|
315
|
-
如果您使用的是字符串房间号,务必请将 json 中的 “roomId” 替换成 “strRoomId”:
|
|
302
|
+
如果您使用的是字符串房间号,务必请将 json 中的 “roomId” 替换成 “strRoomId”: `{"strRoomId": "102", "userId": "userB"}`
|
|
316
303
|
|
|
317
304
|
示例代码如下:
|
|
318
305
|
``` cpp
|
|
@@ -326,7 +313,7 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
326
313
|
|
|
327
314
|
|参数|描述|
|
|
328
315
|
|---------|---------|
|
|
329
|
-
|param|需要您传入 JSON
|
|
316
|
+
|param|需要您传入 JSON 格式的字符串参数, `roomId` 代表数字格式的房间号, `strRoomId` 代表字符串格式的房间号, `userId` 代表目标主播的用户 ID。|
|
|
330
317
|
|
|
331
318
|
## disconnectOtherRoom
|
|
332
319
|
|
|
@@ -349,15 +336,13 @@ TRTC 的所有用户都需要进入房间才能“发布”或“订阅”音视
|
|
|
349
336
|
|
|
350
337
|
|参数|描述|
|
|
351
338
|
|---------|---------|
|
|
352
|
-
|autoRecvAudio|true:自动订阅音频;false:需手动调用
|
|
353
|
-
|autoRecvVideo|true:自动订阅视频;false:需手动调用
|
|
339
|
+
|autoRecvAudio|true:自动订阅音频;false:需手动调用 `muteRemoteAudio(false)` 订阅音频。默认值:true。|
|
|
340
|
+
|autoRecvVideo|true:自动订阅视频;false:需手动调用 `startRemoteView` 订阅视频。默认值:true。|
|
|
354
341
|
|
|
355
342
|
> **注意**
|
|
356
343
|
>
|
|
357
|
-
|
|
358
344
|
> 1. 需要在进入房间前调用该接口进行设置才能生效。
|
|
359
345
|
>
|
|
360
|
-
|
|
361
346
|
> 2. 在自动订阅模式下,如果用户在进入房间后没有调用 startRemoteView 订阅视频流,SDK 会自动停止订阅视频流,以便达到节省流量的目的。
|
|
362
347
|
>
|
|
363
348
|
|
|
@@ -401,20 +386,17 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
401
386
|
|
|
402
387
|
> **注意**
|
|
403
388
|
>
|
|
404
|
-
|
|
405
389
|
> 1. 同一个用户,可以使用同一个 userId 进入多个不同 roomId 的房间。
|
|
406
390
|
>
|
|
407
|
-
|
|
408
391
|
> 2. 两台不同的终端设备不可以同时使用同一个 userId 进入同一个 roomId 的房间。
|
|
409
392
|
>
|
|
410
|
-
|
|
411
393
|
> 3. 您可以分别为不同实例分别设置 ITRTCCloudCallback 获取各自的事件通知。
|
|
412
394
|
>
|
|
413
|
-
|
|
414
395
|
> 4. 同一个用户可以在多个 TRTCCloud 实例中推流,也可以调用子实例中与本地音视频相关的接口。但需要注意:
|
|
415
396
|
>
|
|
416
397
|
> - 多实例的音频需要同时为麦克风采集或自定义采集,而且与音频设备相关的接口调用会以最后一次为准;
|
|
417
398
|
> - 与摄像头相关的调用会以最后一次为准:startLocalPreview。
|
|
399
|
+
|
|
418
400
|
**返回值说明:**
|
|
419
401
|
|
|
420
402
|
子 TRTCCloud 实例
|
|
@@ -444,10 +426,10 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
444
426
|
例如:
|
|
445
427
|
|
|
446
428
|
房间“101”中有主播 A 与观众 B,房间“102”中有主播 C,主播 C 正常发布音视频流。主播 A 通过 connectOtherRoom 跟主播 C 建立跨房通话。
|
|
447
|
-
- 此时,主播 A 与观众 B 都会收到主播 C 的
|
|
429
|
+
- 此时,主播 A 与观众 B 都会收到主播 C 的 `onRemoteUserEnterRoom(C)` , `onUserVideoAvailable(C,true)` 和 `onUserAudioAvailable(C,true)` 这三个事件回调,可以订阅主播 C 的音视频。
|
|
448
430
|
|
|
449
431
|
之后,主播 A 调用该接口禁用主播 C 在本房间发布音频的能力。
|
|
450
|
-
- 此后,主播 C 的音频流将无法发布至房间“101”,主播 A 与观众 B 都将收到
|
|
432
|
+
- 此后,主播 C 的音频流将无法发布至房间“101”,主播 A 与观众 B 都将收到 `onUserAudioAvailable(C,false)` 事件回调,且无法再通过 `muteRemoteAudio(C,false)` 订阅主播 C 的音频。
|
|
451
433
|
|
|
452
434
|
- 主播 C 的视频流将不受影响。房间“102”中的其他观众也不受影响,可以正常订阅主播 C 的音频。
|
|
453
435
|
|
|
@@ -477,7 +459,7 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
477
459
|
|
|
478
460
|
|参数|描述|
|
|
479
461
|
|---------|---------|
|
|
480
|
-
|param|需要您传入 JSON
|
|
462
|
+
|param|需要您传入 JSON 格式的字符串参数, `roomId` 代表数字格式的房间号, `strRoomId` 代表字符串格式的房间号, `userId` 代表目标主播的用户 ID, `muteAudio` , `muteVideo` , `muteSubStream` 均为可选项,分别代表禁止或允许跨房主播发布音频/主路视频/辅路视频的能力。|
|
|
481
463
|
|
|
482
464
|
## startPublishMediaStream
|
|
483
465
|
|
|
@@ -493,16 +475,12 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
493
475
|
|
|
494
476
|
> **注意**
|
|
495
477
|
>
|
|
496
|
-
|
|
497
478
|
> 1. SDK 会通过回调 onStartPublishMediaStream 带给您后台启动的任务标识(即 taskId)。
|
|
498
479
|
>
|
|
499
|
-
|
|
500
480
|
> 2. 同一个任务(TRTCPublishMode 与 TRTCPublishCdnUrl 均相同)仅支持启动一次。若您后续需要更新或者停止该项任务,需要记录并使用返回的 taskId,通过 updatePublishMediaStream 或者 stopPublishMediaStream 来操作。
|
|
501
481
|
>
|
|
502
|
-
|
|
503
|
-
> 3. ` target ` 支持同时配置多个 CDN URL(最多同时 10 个)。若您的同一个转推/转码任务需要发布至多路 CDN,则仅需要在 ` target ` 中配置多个 CDN URL 即可。同一个转码任务即使有多个转推地址,对应的转码计费仍只收取一份。
|
|
482
|
+
> 3. `target` 支持同时配置多个 CDN URL(最多同时 10 个)。若您的同一个转推/转码任务需要发布至多路 CDN,则仅需要在 `target` 中配置多个 CDN URL 即可。同一个转码任务即使有多个转推地址,对应的转码计费仍只收取一份。
|
|
504
483
|
>
|
|
505
|
-
|
|
506
484
|
> 4. 使用时需要注意不要多个任务同时往相同的 URL 地址推送,以免引起异常推流状态。一种推荐的方案是 URL 中使用 “sdkappid_roomid_userid_main” 作为区分标识,这种命名方式容易辨认且不会在您的多个应用中发生冲突。
|
|
507
485
|
>
|
|
508
486
|
|
|
@@ -521,13 +499,10 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
521
499
|
|
|
522
500
|
> **注意**
|
|
523
501
|
>
|
|
524
|
-
|
|
525
502
|
> 1. 您可以通过本接口来更新发布的 CDN URL(支持增删,最多同时 10 个),但您使用时需要注意不要多个任务同时往相同的 URL 地址推送,以免引起异常推流状态。
|
|
526
503
|
>
|
|
527
|
-
|
|
528
|
-
> 2. 您可以通过 ` taskId ` 来更新调整转推/转码任务。例如在 pk 业务中,您可以先通过 startPublishMediaStream 发起转推,接着在主播发起 pk 时,通过 ` taskId ` 和本接口将转推更新为转码任务。此时,CDN 播放将连续并且不会发生断流(您需要保持媒体流编码输出参数 param 一致)。
|
|
504
|
+
> 2. 您可以通过 `taskId` 来更新调整转推/转码任务。例如在 pk 业务中,您可以先通过 startPublishMediaStream 发起转推,接着在主播发起 pk 时,通过 `taskId` 和本接口将转推更新为转码任务。此时,CDN 播放将连续并且不会发生断流(您需要保持媒体流编码输出参数 param 一致)。
|
|
529
505
|
>
|
|
530
|
-
|
|
531
506
|
> 3. 同一个任务不支持纯音频、音视频、纯视频之间的切换。
|
|
532
507
|
>
|
|
533
508
|
|
|
@@ -543,11 +518,9 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
543
518
|
|
|
544
519
|
> **注意**
|
|
545
520
|
>
|
|
546
|
-
|
|
547
|
-
> 1. 若您的业务后台并没有保存该 ` taskId `,在您的主播异常退房重进后,如果您需要重新获取 ` taskId `,您可以再次调用 startPublishMediaStream 启动任务。此时 TRTC 后台会返回任务启动失败,同时带给您上一次启动的 ` taskId `。
|
|
521
|
+
> 1. 若您的业务后台并没有保存该 `taskId` ,在您的主播异常退房重进后,如果您需要重新获取 `taskId` ,您可以再次调用 startPublishMediaStream 启动任务。此时 TRTC 后台会返回任务启动失败,同时带给您上一次启动的 `taskId` 。
|
|
548
522
|
>
|
|
549
|
-
|
|
550
|
-
> 2. 若 ` taskId ` 填空字符串,将会停止该用户所有通过 startPublishMediaStream 启动的媒体流,如果您只启动了一个媒体流或者想停止所有通过您启动的媒体流,推荐使用这种方式。
|
|
523
|
+
> 2. 若 `taskId` 填空字符串,将会停止该用户所有通过 startPublishMediaStream 启动的媒体流,如果您只启动了一个媒体流或者想停止所有通过您启动的媒体流,推荐使用这种方式。
|
|
551
524
|
>
|
|
552
525
|
|
|
553
526
|
## startLocalPreview
|
|
@@ -567,11 +540,10 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
567
540
|
|
|
568
541
|
> **注意**
|
|
569
542
|
>
|
|
570
|
-
|
|
571
543
|
> 如果希望开播前预览摄像头画面并通过 BeautyManager 调节美颜参数,您可以:
|
|
572
544
|
>
|
|
573
|
-
> - 方案一:在调用 enterRoom 之前调用
|
|
574
|
-
> - 方案二:在调用 enterRoom 之后调用
|
|
545
|
+
> - 方案一:在调用 enterRoom 之前调用 `startLocalPreview` 。
|
|
546
|
+
> - 方案二:在调用 enterRoom 之后调用 `startLocalPreview + muteLocalVideo(true)` 。
|
|
575
547
|
|
|
576
548
|
## startLocalPreview
|
|
577
549
|
|
|
@@ -591,11 +563,10 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
591
563
|
|
|
592
564
|
> **注意**
|
|
593
565
|
>
|
|
594
|
-
|
|
595
566
|
> 如果希望开播前预览摄像头画面并通过 BeautyManager 调节美颜参数,您可以:
|
|
596
567
|
>
|
|
597
|
-
> - 方案一:在调用 enterRoom 之前调用
|
|
598
|
-
> - 方案二:在调用 enterRoom 之后调用
|
|
568
|
+
> - 方案一:在调用 enterRoom 之前调用 `startLocalPreview` 。
|
|
569
|
+
> - 方案二:在调用 enterRoom 之后调用 `startLocalPreview + muteLocalVideo(true)` 。
|
|
599
570
|
|
|
600
571
|
## updateLocalView
|
|
601
572
|
|
|
@@ -611,11 +582,11 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
611
582
|
|
|
612
583
|
该接口可以暂停(或恢复)发布本地的视频画面,暂停之后,同一房间中的其他用户将无法继续看到自己画面。
|
|
613
584
|
|
|
614
|
-
该接口在指定 TRTCVideoStreamTypeBig 时等效于
|
|
585
|
+
该接口在指定 TRTCVideoStreamTypeBig 时等效于 `startLocalPreview + stopLocalPreview` 这两个接口,但具有更好的响应速度。
|
|
615
586
|
|
|
616
|
-
因为
|
|
587
|
+
因为 `startLocalPreview + stopLocalPreview` 需要打开和关闭摄像头,而打开和关闭摄像头都是硬件设备相关的操作,非常耗时。
|
|
617
588
|
|
|
618
|
-
|
|
589
|
+
相比之下, `muteLocalVideo` 只需要在软件层面对数据流进行暂停或者放行即可,因此效率更高,也更适合需要频繁打开关闭的场景。
|
|
619
590
|
|
|
620
591
|
当暂停/恢复发布指定 TRTCVideoStreamTypeBig 后,同一房间中的其他用户将会收到 onUserVideoAvailable 回调通知。
|
|
621
592
|
|
|
@@ -630,7 +601,7 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
630
601
|
|
|
631
602
|
**设置本地画面被暂停期间的替代图片。**
|
|
632
603
|
|
|
633
|
-
当您调用
|
|
604
|
+
当您调用 `muteLocalVideo(true)` 暂停本地画面时,您可以通过调用本接口设置一张替代图片,设置后,房间中的其他用户会看到这张替代图片,而不是黑屏画面。
|
|
634
605
|
|
|
635
606
|
|参数|描述|
|
|
636
607
|
|---------|---------|
|
|
@@ -641,8 +612,8 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
641
612
|
|
|
642
613
|
**订阅远端用户的视频流,并绑定视频渲染控件。**
|
|
643
614
|
|
|
644
|
-
调用该接口可以让 SDK 拉取指定 userId 的视频流,并渲染到参数
|
|
645
|
-
- 如果您已经知道房间中有视频流的用户的 userId,可以直接调用
|
|
615
|
+
调用该接口可以让 SDK 拉取指定 userId 的视频流,并渲染到参数 `view` 指定的渲染控件上。您可以通过 setRemoteRenderParams 设置画面的显示模式。
|
|
616
|
+
- 如果您已经知道房间中有视频流的用户的 userId,可以直接调用 `startRemoteView` 订阅该用户的画面。
|
|
646
617
|
|
|
647
618
|
- 如果您不知道房间中有哪些用户在发布视频,您可以在 enterRoom 之后等待来自 onUserVideoAvailable 的通知。
|
|
648
619
|
|
|
@@ -655,16 +626,12 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
655
626
|
|
|
656
627
|
> **注意**
|
|
657
628
|
>
|
|
658
|
-
|
|
659
629
|
> 注意几点规则需要您关注:
|
|
660
630
|
>
|
|
661
|
-
|
|
662
631
|
> 1. SDK 支持同时观看某 userId 的大画面和辅路画面,或者同时观看某 userId 的小画面和辅路画面,但不支持同时观看大画面和小画面。
|
|
663
632
|
>
|
|
664
|
-
|
|
665
633
|
> 2. 只有当指定的 userId 通过 enableSmallVideoStream 开启双路编码后,才能观看该用户的小画面。
|
|
666
634
|
>
|
|
667
|
-
|
|
668
635
|
> 3. 当指定的 userId 的小画面不存在时,SDK 默认切换到该用户的大画面。
|
|
669
636
|
>
|
|
670
637
|
|
|
@@ -698,7 +665,6 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
698
665
|
|
|
699
666
|
> **注意**
|
|
700
667
|
>
|
|
701
|
-
|
|
702
668
|
> 如果当前有正在显示的辅路画面(屏幕分享)也会一并被停止。
|
|
703
669
|
>
|
|
704
670
|
|
|
@@ -715,7 +681,6 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
715
681
|
|
|
716
682
|
> **注意**
|
|
717
683
|
>
|
|
718
|
-
|
|
719
684
|
> 该接口支持您在进入房间(enterRoom)前调用,暂停状态在退出房间(exitRoom)之后会被重置。调用该接口暂停接收指定用户的视频流后,只调用 startRemoteView 接口无法播放指定用户的视频,需要调用 muteRemoteVideoStream(false) 或 muteAllRemoteVideoStreams(false) 才能恢复。
|
|
720
685
|
>
|
|
721
686
|
|
|
@@ -731,10 +696,8 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
731
696
|
|
|
732
697
|
> **注意**
|
|
733
698
|
>
|
|
734
|
-
|
|
735
699
|
> 该接口支持您在进入房间(enterRoom)前调用,暂停状态在退出房间(exitRoom)之后会被重置。
|
|
736
700
|
>
|
|
737
|
-
|
|
738
701
|
> 调用该接口暂停接收所有用户的视频流后,只调用 startRemoteView 接口无法播放指定用户的视频,需要调用 muteRemoteVideoStream(false) 或 muteAllRemoteVideoStreams(false) 才能恢复。
|
|
739
702
|
>
|
|
740
703
|
|
|
@@ -750,7 +713,6 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
750
713
|
|
|
751
714
|
> **注意**
|
|
752
715
|
>
|
|
753
|
-
|
|
754
716
|
> 从v11.5版本开始,编码输出分辨率会按照宽8高2字节对齐,并且是向下调整,eg:输入分辨率540x960,实际编码输出分辨率536x960。
|
|
755
717
|
>
|
|
756
718
|
|
|
@@ -801,9 +763,9 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
801
763
|
|
|
802
764
|
> **注意**
|
|
803
765
|
>
|
|
804
|
-
|
|
805
766
|
> 双路编码开启后,会消耗更多的 CPU 和 网络带宽,所以 Mac、Windows 或者高性能 Pad 可以考虑开启,不建议手机端开启。
|
|
806
767
|
>
|
|
768
|
+
|
|
807
769
|
**返回值说明:**
|
|
808
770
|
|
|
809
771
|
0:成功;-1:当前大画面已被设置为较低画质,开启双路编码已无必要。
|
|
@@ -823,7 +785,6 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
823
785
|
|
|
824
786
|
> **注意**
|
|
825
787
|
>
|
|
826
|
-
|
|
827
788
|
> 此功能需要目标用户已经通过 enableSmallVideoStream 提前开启了双路编码模式,否则此调用无实际效果。
|
|
828
789
|
>
|
|
829
790
|
|
|
@@ -841,7 +802,6 @@ TRTCCloud 一开始被设计成单例模式,限制了多房间并发观看的
|
|
|
841
802
|
|
|
842
803
|
> **注意**
|
|
843
804
|
>
|
|
844
|
-
|
|
845
805
|
> Windows 平台目前仅支持截取 TRTCSnapshotSourceTypeStream 来源的视频画面。
|
|
846
806
|
>
|
|
847
807
|
|
|
@@ -870,11 +830,10 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
870
830
|
开启本地音频的采集和发布后,房间中的其他用户会收到 onUserAudioAvailable(userId, true) 的通知。
|
|
871
831
|
| 参数 | 描述 |
|
|
872
832
|
| --- | --- |
|
|
873
|
-
| quality | 声音音质<br>-
|
|
833
|
+
| quality | 声音音质<br>- TRTCAudioQualitySpeech,流畅:单声道;音频裸码率:18kbps;适合语音通话为主的场景,例如在线会议,语音通话。<br>- TRTCAudioQualityDefault,默认:单声道;音频裸码率:50kbps;SDK 默认的音频质量,如无特殊需求推荐选择之。<br>- TRTCAudioQualityMusic,高音质:双声道 + 全频带;音频裸码率:128kbps;适合需要高保真传输音乐的场景,例如在线K歌、音乐直播等。 |
|
|
874
834
|
|
|
875
835
|
> **注意**
|
|
876
836
|
>
|
|
877
|
-
|
|
878
837
|
> 该函数会检查麦克风的使用权限,如果当前 App 没有麦克风权限,SDK 会自动向用户申请麦克风使用权限。
|
|
879
838
|
>
|
|
880
839
|
|
|
@@ -892,11 +851,11 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
892
851
|
|
|
893
852
|
当您恢复发布本地音频流之后,房间中的其他用户会收到 onUserAudioAvailable(userId, true) 的通知。
|
|
894
853
|
|
|
895
|
-
与 stopLocalAudio
|
|
854
|
+
与 stopLocalAudio 的不同之处在于, `muteLocalAudio(true)` 并不会释放麦克风权限,而是继续发送码率极低的静音包。
|
|
896
855
|
|
|
897
856
|
这对于需要云端录制的场景非常适用,因为 MP4 等格式的视频文件,对于音频数据的连续性要求很高,使用 stopLocalAudio 会导致录制出的 MP4 文件不易播放。
|
|
898
857
|
|
|
899
|
-
因此在对录制文件的质量要求较高的场景中,建议选择
|
|
858
|
+
因此在对录制文件的质量要求较高的场景中,建议选择 `muteLocalAudio` 而不建议使用 stopLocalAudio。
|
|
900
859
|
|
|
901
860
|
|参数|描述|
|
|
902
861
|
|---------|---------|
|
|
@@ -915,7 +874,6 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
915
874
|
|
|
916
875
|
> **注意**
|
|
917
876
|
>
|
|
918
|
-
|
|
919
877
|
> 在进入房间(enterRoom)之前或之后调用本接口均生效,静音状态在退出房间(exitRoom)之后会被重置为 false。
|
|
920
878
|
>
|
|
921
879
|
|
|
@@ -931,7 +889,6 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
931
889
|
|
|
932
890
|
> **注意**
|
|
933
891
|
>
|
|
934
|
-
|
|
935
892
|
> 在进入房间(enterRoom)之前或之后调用本接口均生效,静音状态在退出房间(exitRoom)之后会被重置为 false。
|
|
936
893
|
>
|
|
937
894
|
|
|
@@ -939,7 +896,7 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
939
896
|
|
|
940
897
|
**设定某一个远端用户的声音播放音量。**
|
|
941
898
|
|
|
942
|
-
您可以通过
|
|
899
|
+
您可以通过 `setRemoteAudioVolume(userId, 0)` 将某一个远端用户的声音静音。
|
|
943
900
|
|
|
944
901
|
|参数|描述|
|
|
945
902
|
|---------|---------|
|
|
@@ -948,8 +905,7 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
948
905
|
|
|
949
906
|
> **注意**
|
|
950
907
|
>
|
|
951
|
-
|
|
952
|
-
> 如果将 ` volume ` 设置成 100 之后感觉音量还是太小,可以将 ` volume ` 最大设置成 150,但超过 100 的 ` volume ` 会有爆音的风险,请谨慎操作。
|
|
908
|
+
> 如果将 `volume` 设置成 100 之后感觉音量还是太小,可以将 `volume` 最大设置成 150,但超过 100 的 `volume` 会有爆音的风险,请谨慎操作。
|
|
953
909
|
>
|
|
954
910
|
|
|
955
911
|
## setAudioCaptureVolume
|
|
@@ -962,13 +918,12 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
962
918
|
|
|
963
919
|
> **注意**
|
|
964
920
|
>
|
|
965
|
-
|
|
966
|
-
> 如果将 ` volume ` 设置成 100 之后感觉音量还是太小,可以将 ` volume ` 最大设置成 150,但超过 100 的 ` volume ` 会有爆音的风险,请谨慎操作。
|
|
921
|
+
> 如果将 `volume` 设置成 100 之后感觉音量还是太小,可以将 `volume` 最大设置成 150,但超过 100 的 `volume` 会有爆音的风险,请谨慎操作。
|
|
967
922
|
>
|
|
968
923
|
|
|
969
924
|
## getAudioCaptureVolume
|
|
970
925
|
|
|
971
|
-
|
|
926
|
+
**获取本地音频的采集音量。返回值说明:**
|
|
972
927
|
|
|
973
928
|
采集音量。
|
|
974
929
|
|
|
@@ -984,7 +939,6 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
984
939
|
|
|
985
940
|
> **注意**
|
|
986
941
|
>
|
|
987
|
-
|
|
988
942
|
> 如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。
|
|
989
943
|
>
|
|
990
944
|
|
|
@@ -1005,7 +959,6 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
1005
959
|
|
|
1006
960
|
> **注意**
|
|
1007
961
|
>
|
|
1008
|
-
|
|
1009
962
|
> 如需启用音量大小提示,请在调用 startLocalAudio 之前调用该接口.
|
|
1010
963
|
>
|
|
1011
964
|
|
|
@@ -1025,9 +978,9 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
1025
978
|
|
|
1026
979
|
> **注意**
|
|
1027
980
|
>
|
|
1028
|
-
|
|
1029
981
|
> 自 v11.5 版本,音频录制的状态结果由返回值统一调整为异步回调进行通知。参见 ITRTCCloudCallback 相关回调。
|
|
1030
982
|
>
|
|
983
|
+
|
|
1031
984
|
**返回值说明:**
|
|
1032
985
|
|
|
1033
986
|
0:成功;-1:录音已开始;-2:文件或目录创建失败;-3:后缀指定的音频格式不支持。
|
|
@@ -1089,10 +1042,8 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
1089
1042
|
|
|
1090
1043
|
> **注意**
|
|
1091
1044
|
>
|
|
1092
|
-
|
|
1093
1045
|
> 1. 各参数应分别传入长度为 3 的数组。
|
|
1094
1046
|
>
|
|
1095
|
-
|
|
1096
1047
|
> 2. 请适当限制调用频率,推荐两次坐标设置至少间隔 100ms。
|
|
1097
1048
|
>
|
|
1098
1049
|
|
|
@@ -1109,10 +1060,8 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
1109
1060
|
|
|
1110
1061
|
> **注意**
|
|
1111
1062
|
>
|
|
1112
|
-
|
|
1113
1063
|
> 1. 各参数应分别传入长度为 3 的数组。
|
|
1114
1064
|
>
|
|
1115
|
-
|
|
1116
1065
|
> 2. 请适当限制调用频率,推荐同一远端用户两次坐标设置至少间隔 100ms。
|
|
1117
1066
|
>
|
|
1118
1067
|
|
|
@@ -1180,7 +1129,6 @@ SDK 默认不开启麦克风,当用户需要发布本地音频时,需要调
|
|
|
1180
1129
|
|
|
1181
1130
|
> **注意**
|
|
1182
1131
|
>
|
|
1183
|
-
|
|
1184
1132
|
> 本接口只支持给主路视频添加图片水印。
|
|
1185
1133
|
>
|
|
1186
1134
|
|
|
@@ -1218,16 +1166,12 @@ TXAudioEffectManager 是音效管理接口,您可以通过该接口实现如
|
|
|
1218
1166
|
|
|
1219
1167
|
> **注意**
|
|
1220
1168
|
>
|
|
1221
|
-
|
|
1222
|
-
> 在 Windows 平台下,您也可以将参数 ` deviceName ` 设置为某个应用程序的可执行文件(如 QQMuisc.exe)的绝对路径,此时 SDK 只会采集该应用程序的声音(支持 32 位版本的 SDK,64 位版本的 SDK 需要满足 Windows 版本为 10.0.19042 或更高版本)。
|
|
1169
|
+
> 在 Windows 平台下,您也可以将参数 `deviceName` 设置为某个应用程序的可执行文件(如 QQMuisc.exe)的绝对路径,此时 SDK 只会采集该应用程序的声音(支持 32 位版本的 SDK,64 位版本的 SDK 需要满足 Windows 版本为 10.0.19042 或更高版本)。
|
|
1223
1170
|
>
|
|
1224
|
-
|
|
1225
1171
|
> 您也可以指定该参数为某个扬声器设备的名称来采集特定扬声器声音(通过接口 TXDeviceManager 中的 getDevicesList 接口,可以获取类型为 TXMediaDeviceTypeSpeaker 的扬声器设备)。
|
|
1226
1172
|
>
|
|
1227
|
-
|
|
1228
1173
|
> 在 Windows 平台下您也可以指定该参数为某个进程的进程 id(格式为 “process_xxx”,其中 xxx 为进程 id),此时 SDK 知会采集该进程的声音(需要满足 Windows 版本为 10.0.19042或更高版本)。
|
|
1229
1174
|
>
|
|
1230
|
-
|
|
1231
1175
|
> 在 Windows 平台下您也可以指定该参数为某个进程的进程 id(格式为 “exclude_process_xxx”,其中 xxx 为进程 id),此时 SDK 会采集除了该进程的其他所有声音(需要满足 Windows 版本为 10.0.19042或更高版本)。
|
|
1232
1176
|
>
|
|
1233
1177
|
|
|
@@ -1258,23 +1202,19 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1258
1202
|
该接口可以抓取整个屏幕的内容,或抓取您指定的某个应用的窗口内容,并将其分享给同房间中的其他用户。
|
|
1259
1203
|
| 参数 | 描述 |
|
|
1260
1204
|
| --- | --- |
|
|
1261
|
-
| encParam | 屏幕分享的画面编码参数,SDK 会优先使用您通过此接口设置的编码参数:<br>- 如果您设置
|
|
1205
|
+
| encParam | 屏幕分享的画面编码参数,SDK 会优先使用您通过此接口设置的编码参数:<br>- 如果您设置 <code>encParam</code> 为空值,且您已通过 setSubStreamEncoderParam 设置过辅路视频编码参数,SDK 将使用您设置过的辅路编码参数进行屏幕分享。<br>- 如果您设置 <code>encParam</code> 为空值,且您未通过 setSubStreamEncoderParam 设置过辅路视频编码参数,SDK 将自动选择一个最佳的编码参数进行屏幕分享。 |
|
|
1262
1206
|
| streamType | 屏幕分享使用的线路,可以设置为主路(TRTCVideoStreamTypeBig)或者辅路(TRTCVideoStreamTypeSub),推荐使用辅路。 |
|
|
1263
1207
|
| view | 渲染控件所在的父控件,可以设置为空值,表示不显示屏幕分享的预览效果。 |
|
|
1264
1208
|
|
|
1265
1209
|
> **注意**
|
|
1266
1210
|
>
|
|
1267
|
-
|
|
1268
1211
|
> 1. 同一个用户同时最多只能发布一路主路(TRTCVideoStreamTypeBig)画面和一路辅路(TRTCVideoStreamTypeSub)画面。
|
|
1269
1212
|
>
|
|
1270
|
-
|
|
1271
1213
|
> 2. 默认情况下,屏幕分享使用辅路画面。如果使用主路做屏幕分享,您需要提前停止摄像头采集(stopLocalPreview)以避免相互冲突。
|
|
1272
1214
|
>
|
|
1273
|
-
|
|
1274
1215
|
> 3. 同一个房间中同时只能有一个用户使用辅路做屏幕分享,也就是说,同一个房间中同时只允许一个用户开启辅路。
|
|
1275
1216
|
>
|
|
1276
|
-
|
|
1277
|
-
> 4. 当房间中已经有其他用户在使用辅路分享屏幕时,此时调用该接口会收到来自 ITRTCCloudCallback 的 ` onError(ERR_SERVER_CENTER_ANOTHER_USER_PUSH_SUB_VIDEO) ` 回调。
|
|
1217
|
+
> 4. 当房间中已经有其他用户在使用辅路分享屏幕时,此时调用该接口会收到来自 ITRTCCloudCallback 的 `onError(ERR_SERVER_CENTER_ANOTHER_USER_PUSH_SUB_VIDEO)` 回调。
|
|
1278
1218
|
>
|
|
1279
1219
|
|
|
1280
1220
|
## stopScreenCapture
|
|
@@ -1287,7 +1227,6 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1287
1227
|
|
|
1288
1228
|
> **注意**
|
|
1289
1229
|
>
|
|
1290
|
-
|
|
1291
1230
|
> 从v11.5版本开始,暂停屏幕采集会使用最后一帧按照 1 fps 帧率输出。
|
|
1292
1231
|
>
|
|
1293
1232
|
|
|
@@ -1310,12 +1249,11 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1310
1249
|
|
|
1311
1250
|
> **注意**
|
|
1312
1251
|
>
|
|
1313
|
-
|
|
1314
1252
|
> 1. 返回的列表中包含屏幕和应用窗口,屏幕是列表中的第一个元素。如果用户有多个显示器,那么每个显示器都是一个分享目标。
|
|
1315
1253
|
>
|
|
1316
|
-
|
|
1317
|
-
> 2. 请不要使用 ` delete ITRTCScreenCaptureSourceList* ` 删除 SourceList,这很容易导致崩溃,请使用 ITRTCScreenCaptureSourceList 中的 release 方法释放列表。
|
|
1254
|
+
> 2. 请不要使用 `delete ITRTCScreenCaptureSourceList*` 删除 SourceList,这很容易导致崩溃,请使用 ITRTCScreenCaptureSourceList 中的 release 方法释放列表。
|
|
1318
1255
|
>
|
|
1256
|
+
|
|
1319
1257
|
**返回值说明:**
|
|
1320
1258
|
|
|
1321
1259
|
窗口列表包括屏幕。
|
|
@@ -1345,7 +1283,6 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1345
1283
|
|
|
1346
1284
|
> **注意**
|
|
1347
1285
|
>
|
|
1348
|
-
|
|
1349
1286
|
> 设置高亮边框颜色、宽度参数在 Mac 平台不生效。
|
|
1350
1287
|
>
|
|
1351
1288
|
|
|
@@ -1356,9 +1293,9 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1356
1293
|
该接口可以设定远端用户所看到的屏幕分享(即辅路)的画面质量,同时也能决定云端录制出的视频文件中屏幕分享的画面质量。
|
|
1357
1294
|
|
|
1358
1295
|
请注意如下两个接口的差异:
|
|
1359
|
-
-
|
|
1296
|
+
- setVideoEncoderParam 用于设置主路画面(TRTCVideoStreamTypeBig,一般用于摄像头)的视频编码参数。
|
|
1360
1297
|
|
|
1361
|
-
-
|
|
1298
|
+
- setSubStreamEncoderParam 用于设置辅路画面(TRTCVideoStreamTypeSub,一般用于屏幕分享)的视频编码参数。
|
|
1362
1299
|
|
|
1363
1300
|
|参数|描述|
|
|
1364
1301
|
|---------|---------|
|
|
@@ -1388,14 +1325,11 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1388
1325
|
|
|
1389
1326
|
> **注意**
|
|
1390
1327
|
>
|
|
1391
|
-
|
|
1392
1328
|
> 1. 该接口只有在 TRTCScreenCaptureSourceInfo 中的 type 指定为 TRTCScreenCaptureSourceTypeScreen 时生效,即只有在分享整个屏幕内容时,排除指定窗口的功能才生效。
|
|
1393
1329
|
>
|
|
1394
|
-
|
|
1395
1330
|
> 2. 使用该接口添加到排除列表中的窗口会在退出房间后被 SDK 自动清除。
|
|
1396
1331
|
>
|
|
1397
|
-
|
|
1398
|
-
> 3. Mac 平台下请传入窗口 ID(即 CGWindowID),您可以通过 TRTCScreenCaptureSourceInfo 中的 ` sourceId ` 成员获得。
|
|
1332
|
+
> 3. Mac 平台下请传入窗口 ID(即 CGWindowID),您可以通过 TRTCScreenCaptureSourceInfo 中的 `sourceId` 成员获得。
|
|
1399
1333
|
>
|
|
1400
1334
|
|
|
1401
1335
|
## removeExcludedShareWindow
|
|
@@ -1424,7 +1358,6 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1424
1358
|
|
|
1425
1359
|
> **注意**
|
|
1426
1360
|
>
|
|
1427
|
-
|
|
1428
1361
|
> 通过该方法添加到包含列表中的窗口,会在退出房间后被 SDK 自动清除。
|
|
1429
1362
|
>
|
|
1430
1363
|
|
|
@@ -1474,7 +1407,7 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1474
1407
|
|
|
1475
1408
|
- data:用于承载视频帧数据的 buffer。
|
|
1476
1409
|
|
|
1477
|
-
- length:视频帧数据长度,如果 pixelFormat 设定为 I420 格式,length
|
|
1410
|
+
- length:视频帧数据长度,如果 pixelFormat 设定为 I420 格式,length 可以按照如下公式计算: `length = width × height × 3 / 2` 。
|
|
1478
1411
|
|
|
1479
1412
|
- width:视频图像的宽度,如 640 px。
|
|
1480
1413
|
|
|
@@ -1491,19 +1424,14 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1491
1424
|
|
|
1492
1425
|
> **注意**
|
|
1493
1426
|
>
|
|
1494
|
-
|
|
1495
1427
|
> 1. 推荐您在采集到的一帧视频帧后,即调用 generateCustomPTS 接口获取该帧的 timestamp 数值,这样可以获得最佳的音画同步效果。
|
|
1496
1428
|
>
|
|
1497
|
-
|
|
1498
1429
|
> 2. SDK 最终编码出的视频帧率并不是由您调用本接口的频率决定的,而是由您在 setVideoEncoderParam 中所设置的 FPS 决定的。
|
|
1499
1430
|
>
|
|
1500
|
-
|
|
1501
1431
|
> 3. 请尽量保持本接口的调用间隔是均匀的,否则会导致编码器输出帧率不稳或者音画不同步等问题。
|
|
1502
1432
|
>
|
|
1503
|
-
|
|
1504
1433
|
> 4. iOS 和 Mac平台目前支持传入 TRTCVideoPixelFormat_I420 或 TRTCVideoPixelFormat_BGRA32 格式的视频帧。
|
|
1505
1434
|
>
|
|
1506
|
-
|
|
1507
1435
|
> 5. Windows 和 Android 平台目前仅支持传入 TRTCVideoPixelFormat_I420 格式的视频帧。
|
|
1508
1436
|
>
|
|
1509
1437
|
|
|
@@ -1521,7 +1449,6 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1521
1449
|
|
|
1522
1450
|
> **注意**
|
|
1523
1451
|
>
|
|
1524
|
-
|
|
1525
1452
|
> 由于回声抵消(AEC)需要严格的控制声音采集和播放的时间,所以开启自定义音频采集后,AEC 能力可能会失效。
|
|
1526
1453
|
>
|
|
1527
1454
|
|
|
@@ -1532,7 +1459,7 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1532
1459
|
参数 TRTCAudioFrame 推荐下列填写方式(其他字段不需要填写):
|
|
1533
1460
|
- audioFormat:音频数据格式,仅支持 TRTCAudioFrameFormatPCM。
|
|
1534
1461
|
|
|
1535
|
-
- data:音频帧 buffer。音频帧数据只支持 PCM 格式,支持 5-100 ms 帧长,推荐使用 20ms 帧长,长度计算方法:48000
|
|
1462
|
+
- data:音频帧 buffer。音频帧数据只支持 PCM 格式,支持 5-100 ms 帧长,推荐使用 20ms 帧长,长度计算方法:48000采样率,单声道的帧长度: `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
1536
1463
|
|
|
1537
1464
|
- sampleRate:采样率,支持:16000、24000、32000、44100、48000。
|
|
1538
1465
|
|
|
@@ -1548,7 +1475,6 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1548
1475
|
|
|
1549
1476
|
> **注意**
|
|
1550
1477
|
>
|
|
1551
|
-
|
|
1552
1478
|
> 请您精准地按每帧时长的间隔调用本接口,数据投送间隔不均匀时极易触发声音卡顿。
|
|
1553
1479
|
>
|
|
1554
1480
|
|
|
@@ -1565,8 +1491,7 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1565
1491
|
|
|
1566
1492
|
> **注意**
|
|
1567
1493
|
>
|
|
1568
|
-
|
|
1569
|
-
> 如果您指定参数 ` enablePublish ` 和 ` enablePlayout ` 均为 false,代表完全关闭您的自定义音轨。
|
|
1494
|
+
> 如果您指定参数 `enablePublish` 和 `enablePlayout` 均为 false,代表完全关闭您的自定义音轨。
|
|
1570
1495
|
>
|
|
1571
1496
|
|
|
1572
1497
|
## mixExternalAudioFrame
|
|
@@ -1584,7 +1509,7 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1584
1509
|
当您调用该接口后,如果发现返回值大于 100ms,则可以等待一帧音频帧的播放时间之后再次调用;如果返回值小于 100ms,则代表缓冲区比较小,您可以再次混入一些音轨数据以确保音轨缓冲区的大小维持在“安全水位”以上。
|
|
1585
1510
|
|
|
1586
1511
|
参数 TRTCAudioFrame 推荐下列填写方式(其他字段不需要填写):
|
|
1587
|
-
- data:音频帧 buffer。音频帧数据只支持 PCM 格式,支持 5ms - 100ms 帧长,推荐使用 20ms 帧长,长度计算方法:48000采样率,
|
|
1512
|
+
- data:音频帧 buffer。音频帧数据只支持 PCM 格式,支持 5ms - 100ms 帧长,推荐使用 20ms 帧长,长度计算方法:48000采样率, 单声道的帧长度: `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
1588
1513
|
|
|
1589
1514
|
- sampleRate:采样率,支持:16000、24000、32000、44100、48000。
|
|
1590
1515
|
|
|
@@ -1598,12 +1523,12 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1598
1523
|
|
|
1599
1524
|
> **注意**
|
|
1600
1525
|
>
|
|
1601
|
-
|
|
1602
1526
|
> 请您精准地按每帧时长的间隔调用本接口,数据投送间隔不均匀时极易触发声音卡顿。
|
|
1603
1527
|
>
|
|
1528
|
+
|
|
1604
1529
|
**返回值说明:**
|
|
1605
1530
|
|
|
1606
|
-
>= 0 缓冲的长度,单位:ms。< 0 错误(-1 未启用
|
|
1531
|
+
>= 0 缓冲的长度,单位:ms。< 0 错误(-1 未启用 `mixExternalAudioFrame` )
|
|
1607
1532
|
|
|
1608
1533
|
## setMixExternalAudioVolume
|
|
1609
1534
|
|
|
@@ -1660,7 +1585,7 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1660
1585
|
**设置本地视频自定义渲染回调。**
|
|
1661
1586
|
|
|
1662
1587
|
设置该回调之后,SDK 内部会跳过原来的渲染流程,并把采集到的数据回调出来,您需要自己完成画面渲染。
|
|
1663
|
-
- 您可以通过调用
|
|
1588
|
+
- 您可以通过调用 `setLocalVideoRenderCallback(TRTCVideoPixelFormat_Unknown, TRTCVideoBufferType_Unknown, nullptr)` 停止回调。
|
|
1664
1589
|
|
|
1665
1590
|
- iOS、Mac、Windows 平台目前仅支持回调 TRTCVideoPixelFormat_I420 或 TRTCVideoPixelFormat_BGRA32 像素格式的视频帧。
|
|
1666
1591
|
|
|
@@ -1680,7 +1605,7 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1680
1605
|
**设置远端视频自定义渲染回调。**
|
|
1681
1606
|
|
|
1682
1607
|
设置该回调之后,SDK 内部会跳过原来的渲染流程,并把采集到的数据回调出来,您需要自己完成画面渲染。
|
|
1683
|
-
- 您可以通过调用
|
|
1608
|
+
- 您可以通过调用 `setRemoteVideoRenderCallback(TRTCVideoPixelFormat_Unknown, TRTCVideoBufferType_Unknown, nullptr)` 停止回调。
|
|
1684
1609
|
|
|
1685
1610
|
- iOS、Mac、Windows 平台目前仅支持回调 TRTCVideoPixelFormat_I420 或 TRTCVideoPixelFormat_BGRA32 像素格式的视频帧。
|
|
1686
1611
|
|
|
@@ -1695,9 +1620,9 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1695
1620
|
|
|
1696
1621
|
> **注意**
|
|
1697
1622
|
>
|
|
1698
|
-
|
|
1699
1623
|
> 实际使用时,需要先调用 startRemoteView(userid, nullptr) 来获取远端用户的视频流(view 设置为 nullptr 即可),否则不会有数据回调出来。
|
|
1700
1624
|
>
|
|
1625
|
+
|
|
1701
1626
|
**返回值说明:**
|
|
1702
1627
|
|
|
1703
1628
|
0:成功;< 0:错误(详见 [错误码](https://cloud.tencent.com/document/product/647/38308))。
|
|
@@ -1707,17 +1632,16 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1707
1632
|
**设置音频数据自定义回调。**
|
|
1708
1633
|
|
|
1709
1634
|
设置该回调之后,SDK 内部会把音频数据(PCM 格式)回调出来,包括:
|
|
1710
|
-
-
|
|
1635
|
+
- onCapturedAudioFrame:本地麦克风采集到的音频数据回调
|
|
1711
1636
|
|
|
1712
|
-
-
|
|
1637
|
+
- onLocalProcessedAudioFrame:本地采集并经过音频模块前处理后的音频数据回调
|
|
1713
1638
|
|
|
1714
|
-
-
|
|
1639
|
+
- onPlayAudioFrame:混音前的每一路远程用户的音频数据
|
|
1715
1640
|
|
|
1716
|
-
-
|
|
1641
|
+
- onMixedPlayAudioFrame:将各路音频混合之后并最终要由系统播放出的音频数据回调
|
|
1717
1642
|
|
|
1718
1643
|
> **注意**
|
|
1719
1644
|
>
|
|
1720
|
-
|
|
1721
1645
|
> 设置回调为空即代表停止自定义音频回调,反之,设置回调不为空则代表启动自定义音频回调。
|
|
1722
1646
|
>
|
|
1723
1647
|
|
|
@@ -1732,9 +1656,9 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1732
1656
|
|
|
1733
1657
|
- samplesPerCall:采样点数,定义回调数据帧长。帧长必须为 10ms 的整数倍。
|
|
1734
1658
|
|
|
1735
|
-
|
|
1659
|
+
如果希望用毫秒数计算回调帧长,则将毫秒数转换成采样点数的公式为: `采样点数 = 毫秒数 * 采样率 / 1000` 。
|
|
1736
1660
|
|
|
1737
|
-
举例:48000Hz 采样率希望回调 20ms
|
|
1661
|
+
举例:48000Hz 采样率希望回调 20ms 帧长的数据,则采样点数应该填: `960 = 20 * 48000 / 1000` 。
|
|
1738
1662
|
|
|
1739
1663
|
|参数|描述|
|
|
1740
1664
|
|---------|---------|
|
|
@@ -1742,9 +1666,9 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1742
1666
|
|
|
1743
1667
|
> **注意**
|
|
1744
1668
|
>
|
|
1745
|
-
|
|
1746
|
-
> 最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为:` 字节数 = 采样点数 * channel * 2(位宽) `。举例:48000Hz 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 ` 3840 = 960 * 2 * 2 `。
|
|
1669
|
+
> 最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为: `字节数 = 采样点数 * channel * 2(位宽)` 。举例:48000Hz 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 `3840 = 960 * 2 * 2` 。
|
|
1747
1670
|
>
|
|
1671
|
+
|
|
1748
1672
|
**返回值说明:**
|
|
1749
1673
|
|
|
1750
1674
|
0:成功;<0:错误。
|
|
@@ -1760,9 +1684,9 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1760
1684
|
|
|
1761
1685
|
- samplesPerCall:采样点数,定义回调数据帧长。帧长必须为 10ms 的整数倍。
|
|
1762
1686
|
|
|
1763
|
-
|
|
1687
|
+
如果希望用毫秒数计算回调帧长,则将毫秒数转换成采样点数的公式为: `采样点数 = 毫秒数 * 采样率 / 1000` 。
|
|
1764
1688
|
|
|
1765
|
-
举例:48000Hz 采样率希望回调20ms帧长的数据,则采样点数应该填:
|
|
1689
|
+
举例:48000Hz 采样率希望回调20ms帧长的数据,则采样点数应该填: `960 = 20 * 48000 / 1000` 。
|
|
1766
1690
|
|
|
1767
1691
|
|参数|描述|
|
|
1768
1692
|
|---------|---------|
|
|
@@ -1770,9 +1694,9 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1770
1694
|
|
|
1771
1695
|
> **注意**
|
|
1772
1696
|
>
|
|
1773
|
-
|
|
1774
|
-
> 最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为:` 字节数 = 采样点数 * channel * 2(位宽) `。 举例:48000Hz 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 ` 3840 = 960 * 2 * 2 `。
|
|
1697
|
+
> 最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为: `字节数 = 采样点数 * channel * 2(位宽)` 。 举例:48000Hz 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 `3840 = 960 * 2 * 2` 。
|
|
1775
1698
|
>
|
|
1699
|
+
|
|
1776
1700
|
**返回值说明:**
|
|
1777
1701
|
|
|
1778
1702
|
0:成功;<0:错误。
|
|
@@ -1788,9 +1712,9 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1788
1712
|
|
|
1789
1713
|
- samplesPerCall:采样点数,定义回调数据帧长。帧长必须为 10ms 的整数倍。
|
|
1790
1714
|
|
|
1791
|
-
|
|
1715
|
+
如果希望用毫秒数计算回调帧长,则将毫秒数转换成采样点数的公式为: `采样点数 = 毫秒数 * 采样率 / 1000` 。
|
|
1792
1716
|
|
|
1793
|
-
举例:48000Hz 采样率希望回调 20ms 帧长的数据,则采样点数应该填:
|
|
1717
|
+
举例:48000Hz 采样率希望回调 20ms 帧长的数据,则采样点数应该填: `960 = 20 * 48000 / 1000` 。
|
|
1794
1718
|
|
|
1795
1719
|
|参数|描述|
|
|
1796
1720
|
|---------|---------|
|
|
@@ -1798,9 +1722,9 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1798
1722
|
|
|
1799
1723
|
> **注意**
|
|
1800
1724
|
>
|
|
1801
|
-
|
|
1802
|
-
> 最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为:` 字节数 = 采样点数 * channel * 2(位宽) `。 举例:48000Hz 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 ` 3840 = 960 * 2 * 2 `。
|
|
1725
|
+
> 最终回调的帧长度是以字节为单位,采样点数转换成字节数的计算公式为: `字节数 = 采样点数 * channel * 2(位宽)` 。 举例:48000Hz 采样率,双声道,20ms 帧长,采样点数为 960,字节数为 `3840 = 960 * 2 * 2` 。
|
|
1803
1726
|
>
|
|
1727
|
+
|
|
1804
1728
|
**返回值说明:**
|
|
1805
1729
|
|
|
1806
1730
|
0:成功;<0:错误。
|
|
@@ -1819,7 +1743,6 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1819
1743
|
|
|
1820
1744
|
> **注意**
|
|
1821
1745
|
>
|
|
1822
|
-
|
|
1823
1746
|
> 需要您在进入房间前设置才能生效,暂不支持进入房间后再设置。
|
|
1824
1747
|
>
|
|
1825
1748
|
|
|
@@ -1836,7 +1759,7 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1836
1759
|
|
|
1837
1760
|
- data:用于获取音频数据的 buffer。需要您根据一帧音频帧的帧长度分配好 data 的内存大小。获取的 PCM 数据支持 10ms 或 20ms 两种帧长,推荐使用 20ms 的帧长。
|
|
1838
1761
|
|
|
1839
|
-
|
|
1762
|
+
计算公式为: `采样率 x 播放时长 x 声道数量 x 2(每个样点的字节数)` , 例如: 48000Hz 采样率、单声道、且播放时长为 20ms 的一帧音频帧的 buffer 大小为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
1840
1763
|
|
|
1841
1764
|
|参数|描述|
|
|
1842
1765
|
|---------|---------|
|
|
@@ -1844,13 +1767,10 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1844
1767
|
|
|
1845
1768
|
> **注意**
|
|
1846
1769
|
>
|
|
1847
|
-
|
|
1848
1770
|
> 1. 参数 audioFrame 中的 sampleRate、channel 需提前设置好,同时分配好所需读取帧长的 data 空间。
|
|
1849
1771
|
>
|
|
1850
|
-
|
|
1851
1772
|
> 2. SDK 内部会根据 sampleRate 和 channel 自动填充 data 数据。
|
|
1852
1773
|
>
|
|
1853
|
-
|
|
1854
1774
|
> 3. 建议由系统的音频播放线程直接驱动该函数的调用,在播放完一帧音频之后,即调用该接口获取下一帧可播放的音频数据。
|
|
1855
1775
|
>
|
|
1856
1776
|
|
|
@@ -1871,24 +1791,19 @@ AI 转录管理类 AITranscriberManager。
|
|
|
1871
1791
|
|
|
1872
1792
|
> **注意**
|
|
1873
1793
|
>
|
|
1874
|
-
|
|
1875
1794
|
> 1. 发送消息到房间内所有用户(暂时不支持 Web/小程序端),每秒最多能发送30条消息(与 sendSEIMsg 共享限制)。
|
|
1876
1795
|
>
|
|
1877
|
-
|
|
1878
1796
|
> 2. 每个包最大为 1KB,超过则很有可能会被中间路由器或者服务器丢弃。
|
|
1879
1797
|
>
|
|
1880
|
-
|
|
1881
1798
|
> 3. 每个客户端每秒最多能发送总计 16KB 数据(与 sendSEIMsg 共享限制)。
|
|
1882
1799
|
>
|
|
1883
|
-
|
|
1884
|
-
> 4. 请将 ` reliable ` 和 ` ordered ` 同时设置为 true 或同时设置为 false,暂不支持交叉设置。
|
|
1800
|
+
> 4. 请将 `reliable` 和 `ordered` 同时设置为 true 或同时设置为 false,暂不支持交叉设置。
|
|
1885
1801
|
>
|
|
1886
|
-
|
|
1887
1802
|
> 5. 强烈建议您将不同类型的消息设定为不同的 cmdID,这样可以在要求有序的情况下减小消息时延。
|
|
1888
1803
|
>
|
|
1889
|
-
|
|
1890
1804
|
> 6. 目前仅支持主播身份。
|
|
1891
1805
|
>
|
|
1806
|
+
|
|
1892
1807
|
**返回值说明:**
|
|
1893
1808
|
|
|
1894
1809
|
true:消息已经发出;false:消息发送失败。
|
|
@@ -1916,24 +1831,19 @@ true:消息已经发出;false:消息发送失败。
|
|
|
1916
1831
|
|
|
1917
1832
|
> **注意**
|
|
1918
1833
|
>
|
|
1919
|
-
|
|
1920
1834
|
> 本接口有以下限制:
|
|
1921
1835
|
>
|
|
1922
|
-
|
|
1923
1836
|
> 1. 数据在接口调用完后不会被即时发送出去,而是从下一帧视频帧开始与视频帧一起发送。
|
|
1924
1837
|
>
|
|
1925
|
-
|
|
1926
1838
|
> 2. 发送消息到房间内所有用户,每秒最多能发送 40 条消息(与 sendCustomCmdMsg 共享限制)。
|
|
1927
1839
|
>
|
|
1928
|
-
|
|
1929
1840
|
> 3. 每个包最大为 1KB,若发送大量数据,会导致视频码率增大,可能导致视频画质下降甚至卡顿(与 sendCustomCmdMsg 共享限制)。
|
|
1930
1841
|
>
|
|
1931
|
-
|
|
1932
1842
|
> 4. 每个客户端每秒最多能发送总计 16KB 数据(与 sendCustomCmdMsg 共享限制)。
|
|
1933
1843
|
>
|
|
1934
|
-
|
|
1935
1844
|
> 5. 若指定多次发送(repeatCount > 1),则数据会被带在后续的连续 repeatCount 个视频帧中发送出去,同样会导致视频码率增大。接收消息 onRecvSEIMsg 回调也可能会收到多次相同的消息,需要去重。
|
|
1936
1845
|
>
|
|
1846
|
+
|
|
1937
1847
|
**返回值说明:**
|
|
1938
1848
|
|
|
1939
1849
|
true:消息已通过限制,等待后续视频帧发送;false:消息被限制发送
|
|
@@ -1948,15 +1858,13 @@ true:消息已通过限制,等待后续视频帧发送;false:消息被
|
|
|
1948
1858
|
|
|
1949
1859
|
> **注意**
|
|
1950
1860
|
>
|
|
1951
|
-
|
|
1952
1861
|
> 1. 测速过程将产生少量的基础服务费用,详见 [计费概述 > 基础服务](https://cloud.tencent.com/document/product/647/17157#.E5.9F.BA.E7.A1.80.E6.9C.8D.E5.8A.A1) 文档说明。
|
|
1953
1862
|
>
|
|
1954
|
-
|
|
1955
1863
|
> 2. 请在进入房间前进行网速测试,在房间中网速测试会影响正常的音视频传输效果,而且由于干扰过多,网速测试结果也不准确。
|
|
1956
1864
|
>
|
|
1957
|
-
|
|
1958
1865
|
> 3. 同一时间只允许一项网速测试任务运行。
|
|
1959
1866
|
>
|
|
1867
|
+
|
|
1960
1868
|
**返回值说明:**
|
|
1961
1869
|
|
|
1962
1870
|
接口调用结果,< 0:失败
|
|
@@ -2014,7 +1922,6 @@ true:消息已通过限制,等待后续视频帧发送;false:消息被
|
|
|
2014
1922
|
|
|
2015
1923
|
> **注意**
|
|
2016
1924
|
>
|
|
2017
|
-
|
|
2018
1925
|
> 请务必在所有其他接口之前调用,并且保证您指定的目录是存在的,并且您的应用程序拥有对该目录的读写权限。
|
|
2019
1926
|
>
|
|
2020
1927
|
|
|
@@ -2040,7 +1947,7 @@ true:消息已通过限制,等待后续视频帧发送;false:消息被
|
|
|
2040
1947
|
|
|
2041
1948
|
**开启或关闭媒体流私有加密。**
|
|
2042
1949
|
|
|
2043
|
-
在安全要求较高的场景下,TRTC 建议您在加入房间前,调用
|
|
1950
|
+
在安全要求较高的场景下,TRTC 建议您在加入房间前,调用 `enablePayloadPrivateEncryption` 方法开启媒体流私有加密。
|
|
2044
1951
|
|
|
2045
1952
|
用户退出房间后,SDK 会自动关闭私有加密。如需重新开启私有加密,您需要在用户再次加入房间前调用该方法。
|
|
2046
1953
|
|
|
@@ -2051,7 +1958,7 @@ true:消息已通过限制,等待后续视频帧发送;false:消息被
|
|
|
2051
1958
|
|
|
2052
1959
|
> **注意**
|
|
2053
1960
|
>
|
|
2054
|
-
|
|
2055
1961
|
> TRTC 已经内置对媒体流进行加密后再传输,启用媒体流私有加密后将使用您传入的密钥与初始向量进行再次加密。
|
|
2056
1962
|
>
|
|
1963
|
+
|
|
2057
1964
|
**返回值说明:**
|