@tencentcloud/sdk-mcp 1.6.4 → 1.6.5
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 +166 -0
- 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 +234 -57
- 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/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
|
@@ -114,12 +114,12 @@ Function: 分辨率、质量等级等枚举和常量值的定义
|
|
|
114
114
|
|
|
115
115
|
**视频宽高比模式。**
|
|
116
116
|
|
|
117
|
-
TRTCVideoResolution 中仅定义了横屏分辨率(如 640 × 360),如需使用竖屏分辨率(如360 × 640),需要同时指定
|
|
117
|
+
TRTCVideoResolution 中仅定义了横屏分辨率(如 640 × 360),如需使用竖屏分辨率(如360 × 640),需要同时指定 `TRTCVideoResolutionMode` 为 Portrait。
|
|
118
118
|
|
|
119
119
|
|枚举|取值|描述|
|
|
120
120
|
|---------|---------|---------|
|
|
121
|
-
|TRTC_VIDEO_RESOLUTION_MODE_LANDSCAPE|0
|
|
122
|
-
|TRTC_VIDEO_RESOLUTION_MODE_PORTRAIT|1
|
|
121
|
+
|TRTC_VIDEO_RESOLUTION_MODE_LANDSCAPE|0|横屏分辨率,例如: `TRTCVideoResolution_640_360 + TRTCVideoResolutionModeLandscape = 640 × 360` 。|
|
|
122
|
+
|TRTC_VIDEO_RESOLUTION_MODE_PORTRAIT|1|竖屏分辨率,例如: `TRTCVideoResolution_640_360 + TRTCVideoResolutionModePortrait = 360 × 640` 。|
|
|
123
123
|
|
|
124
124
|
## TRTCVideoStreamType
|
|
125
125
|
|
|
@@ -134,7 +134,6 @@ TRTC 内部有三种不同的视频流,分别是:
|
|
|
134
134
|
|
|
135
135
|
> **注意**
|
|
136
136
|
>
|
|
137
|
-
|
|
138
137
|
> 不支持单独开启低清小画面,小画面必须依附于大画面而存在,SDK 会自动设定低清小画面的分辨率和码率。
|
|
139
138
|
>
|
|
140
139
|
|
|
@@ -344,11 +343,12 @@ TRTC 会每隔两秒对当前的网络质量进行评估,评估结果为六个
|
|
|
344
343
|
|
|
345
344
|
**音频采样率。**
|
|
346
345
|
|
|
347
|
-
音频采样率用来衡量声音的保真程度,采样率越高保真程度越好,如果您的应用场景有音乐的存在,推荐使用
|
|
346
|
+
音频采样率用来衡量声音的保真程度,采样率越高保真程度越好,如果您的应用场景有音乐的存在,推荐使用 `TRTCAudioSampleRate48000` 。
|
|
348
347
|
|
|
349
348
|
|枚举|取值|描述|
|
|
350
349
|
|---------|---------|---------|
|
|
351
350
|
|TRTCAudioSampleRate16000|16000|16k 采样率。|
|
|
351
|
+
|TRTCAudioSampleRate24000|24000|24k 采样率。|
|
|
352
352
|
|TRTCAudioSampleRate32000|32000|32k 采样率。|
|
|
353
353
|
|TRTCAudioSampleRate44100|44100|44.1k 采样率。|
|
|
354
354
|
|TRTCAudioSampleRate48000|48000|48k采样率|
|
|
@@ -518,10 +518,10 @@ TRTC 的云端混流服务能够将房间中的多路音视频流混合成一路
|
|
|
518
518
|
| 枚举 | 取值 | 描述 |
|
|
519
519
|
| --- | --- | --- |
|
|
520
520
|
| TRTC_TranscodingConfigMode_Unknown | 0 | 未定义。 |
|
|
521
|
-
| TRTC_TranscodingConfigMode_Manual | 1 | 全手动排版模式。<br>该模式下,您需要指定每一路画面的精确排版位置。该模式的自由度最高,但易用性也最差:<br>- 您需要填写 TRTCTranscodingConfig 中的所有参数,包括每一路画面(TRTCMixUser)的位置坐标。<br>- 您需要监听 TRTCCloudListener 中的 onUserVideoAvailable 和 onUserAudioAvailable 事件回调,并根据当前房间中各个麦上用户的音视频状态不断地调整
|
|
522
|
-
| TRTC_TranscodingConfigMode_Template_PureAudio | 2 | 纯音频模式。<br>该模式适用于语音通话(AudioCall)和语音聊天室(VoiceChatRoom)等纯音频的应用场景。<br>- 您只需要在进入房间后,通过 setMixTranscodingConfig 接口设置一次,之后 SDK 就会自动把房间内所有上麦用户的声音混流到当前用户的直播流上。<br>- 您无需设置 TRTCTranscodingConfig 中的
|
|
521
|
+
| TRTC_TranscodingConfigMode_Manual | 1 | 全手动排版模式。<br>该模式下,您需要指定每一路画面的精确排版位置。该模式的自由度最高,但易用性也最差:<br>- 您需要填写 TRTCTranscodingConfig 中的所有参数,包括每一路画面(TRTCMixUser)的位置坐标。<br>- 您需要监听 TRTCCloudListener 中的 onUserVideoAvailable 和 onUserAudioAvailable 事件回调,并根据当前房间中各个麦上用户的音视频状态不断地调整 <code>mixUsers</code> 参数。 |
|
|
522
|
+
| TRTC_TranscodingConfigMode_Template_PureAudio | 2 | 纯音频模式。<br>该模式适用于语音通话(AudioCall)和语音聊天室(VoiceChatRoom)等纯音频的应用场景。<br>- 您只需要在进入房间后,通过 setMixTranscodingConfig 接口设置一次,之后 SDK 就会自动把房间内所有上麦用户的声音混流到当前用户的直播流上。<br>- 您无需设置 TRTCTranscodingConfig 中的 <code>mixUsers</code> 参数,只需设置 <code>audioSampleRate</code> 、 <code>audioBitrate</code> 和 <code>audioChannels</code> 等参数即可。 |
|
|
523
523
|
| TRTC_TranscodingConfigMode_Template_PresetLayout | 3 | 预排版模式。<br>最受欢迎的排版模式,因为该模式支持您通过占位符提前对各路画面的位置进行设定,之后 SDK 会自动根据房间中画面的路数动态进行适配调整。<br>此模式下,您依然需要设置 mixUsers 参数,但可以将 userId 设置为“占位符”,可选的占位符有:<br>- "$PLACE_HOLDER_REMOTE$" : 指代远程用户的画面,可以设置多个。<br>- "$PLACE_HOLDER_LOCAL_MAIN$" : 指代本地摄像头画面,只允许设置一个。<br>- "$PLACE_HOLDER_LOCAL_SUB$" : 指代本地屏幕分享画面,只允许设置一个。<br>此模式下,您不需要监听 TRTCCloudListener 中的 onUserVideoAvailable 和 onUserAudioAvailable 回调进行实时调整,只需要在进房成功后调用一次 setMixTranscodingConfig 即可,之后 SDK 会自动将真实的 userId 补位到您设置的占位符上。 |
|
|
524
|
-
| TRTC_TranscodingConfigMode_Template_ScreenSharing | 4 | 屏幕分享模式。<br>适用于在线教育场景等以屏幕分享为主的应用场景,仅支持 Windows 和 Mac 两个平台的 SDK。<br>该模式下,SDK 会先根据您通过 videoWidth 和 videoHeight 参数设置的目标分辨率构建一张画布,<br>- 当老师未开启屏幕分享时,SDK 会将老师的摄像头画面等比例拉伸绘制到该画布上;<br>- 当老师开启屏幕分享之后,SDK 会将屏幕分享画面绘制到同样的画布上。<br>此种排版模式的目的是为了确保混流模块的输出分辨率一致,避免课程回放和网页观看的花屏问题(网页播放器不支持可变分辨率)。<br>同时,连麦学生的声音也会被默认混合到老师的音视频流中。<br>由于教学模式下的视频内容以屏幕分享为主,因此同时传输摄像头画面和屏幕分享画面是非常浪费带宽的。<br>推荐的做法是直接将摄像头画面通过 setLocalVideoRenderCallback 接口自定义绘制到当前屏幕上。<br>在该模式下,您无需设置 TRTCTranscodingConfig 中的
|
|
524
|
+
| TRTC_TranscodingConfigMode_Template_ScreenSharing | 4 | 屏幕分享模式。<br>适用于在线教育场景等以屏幕分享为主的应用场景,仅支持 Windows 和 Mac 两个平台的 SDK。<br>该模式下,SDK 会先根据您通过 videoWidth 和 videoHeight 参数设置的目标分辨率构建一张画布,<br>- 当老师未开启屏幕分享时,SDK 会将老师的摄像头画面等比例拉伸绘制到该画布上;<br>- 当老师开启屏幕分享之后,SDK 会将屏幕分享画面绘制到同样的画布上。<br>此种排版模式的目的是为了确保混流模块的输出分辨率一致,避免课程回放和网页观看的花屏问题(网页播放器不支持可变分辨率)。<br>同时,连麦学生的声音也会被默认混合到老师的音视频流中。<br>由于教学模式下的视频内容以屏幕分享为主,因此同时传输摄像头画面和屏幕分享画面是非常浪费带宽的。<br>推荐的做法是直接将摄像头画面通过 setLocalVideoRenderCallback 接口自定义绘制到当前屏幕上。<br>在该模式下,您无需设置 TRTCTranscodingConfig 中的 <code>mixUsers</code> 参数,SDK 不会混合学生的画面,以免干扰屏幕分享的效果。<br>您可以将 TRTCTranscodingConfig 中的 width x height 设为 0px × 0px,SDK 会自动根据用户当前屏幕的宽高比计算出一个合适的分辨率:<br>- 如果老师当前屏幕宽度 <= 1920px,SDK 会使用老师当前屏幕的实际分辨率。<br>- 如果老师当前屏幕宽度 > 1920px,SDK 会根据当前屏幕宽高比,选择 1920x1080(16:9)、1920x1200(16:10)、1920x1440(4:3) 三种分辨率中的一种。 |
|
|
525
525
|
|
|
526
526
|
## TRTCRecordType
|
|
527
527
|
|
|
@@ -631,11 +631,11 @@ v11.7 版本开始支持,只在 SDK 内部摄像头采集场景生效
|
|
|
631
631
|
| businessInfo | 【字段含义】业务数据字段(选填),部分高级特性才需要用到此字段。<br>【推荐取值】请不要自行设置该字段。 |
|
|
632
632
|
| privateMapKey | 【字段含义】用于权限控制的权限票据(选填),当您希望某个房间只能让特定的 userId 进入时,需要使用 privateMapKey 进行权限保护。<br>【推荐取值】仅建议有高级别安全需求的客户使用,更多详情请参见 <a href="https://cloud.tencent.com/document/product/647/32240">进房权限保护</a>。 |
|
|
633
633
|
| role | 【字段含义】直播场景下的角色,仅适用于直播场景(TRTC_APP_SCENE_LIVE 和 TRTC_APP_SCENE_VOICE_CHATROOM),通话场景下指定该参数是无效的。<br>【推荐取值】默认值:主播(TRTCRoleAnchor)。 |
|
|
634
|
-
| roomId | 【字段含义】数字房间号,在同一个房间里的用户(userId)可以彼此看到对方并进行音视频通话。<br>【推荐取值】取值范围:1 - 4294967294。<br>【特别说明】1. roomId 与 strRoomId 是互斥的,若您选用 strRoomId,则 roomId 需要填写为 0。若两者都填,SDK 将优先选用 roomId。<br>2. 不要混用 roomId 和 strRoomId,因为它们之间是不互通的,例如数字 123 和字符串
|
|
634
|
+
| roomId | 【字段含义】数字房间号,在同一个房间里的用户(userId)可以彼此看到对方并进行音视频通话。<br>【推荐取值】取值范围:1 - 4294967294。<br>【特别说明】1. roomId 与 strRoomId 是互斥的,若您选用 strRoomId,则 roomId 需要填写为 0。若两者都填,SDK 将优先选用 roomId。<br>2. 不要混用 roomId 和 strRoomId,因为它们之间是不互通的,例如数字 123 和字符串 <code>123</code> 在 TRTC 看来是两个完全不同的房间。 |
|
|
635
635
|
| sdkAppId | 【字段含义】应用标识(必填),腾讯云基于 sdkAppId 完成计费统计。<br>【推荐取值】在 <a href="https://console.cloud.tencent.com/rav/">实时音视频控制台</a> 创建应用后可以在账号信息页面中得到该 ID。 |
|
|
636
|
-
| strRoomId | 【字段含义】字符串房间号,在同一个房间里的用户(userId)可以彼此看到对方并进行音视频通话。<br>【推荐取值】限制长度为 64 字节。以下为支持的字符集范围(共 89 个字符):<br>- 大小写英文字母(a-zA-Z);<br>- 数字(0-9);<br>-
|
|
637
|
-
| streamId | 【字段含义】用于指定在腾讯云直播平台上的 streamId(选填),设置之后,您可以在腾讯云直播 CDN 上通过标准拉流方案(FLV 或 HLS)播放该用户的音视频流。<br>【推荐取值】限制长度为64字节,可以不填写,一种推荐的方案是使用
|
|
638
|
-
| userDefineRecordId | 【字段含义】云端录制开关(选填),用于指定是否要在云端将该用户的音视频流录制下来。<br>【参考文档】<a href="https://cloud.tencent.com/document/product/647/76497">云端录制</a>。<br>【推荐取值】限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。<br>方案一:手动录制方案:<br>1. 在 <a href="https://console.cloud.tencent.com/trtc">控制台</a>>应用管理>云端录制配置 中开启云端录制。<br>2. 设置
|
|
636
|
+
| strRoomId | 【字段含义】字符串房间号,在同一个房间里的用户(userId)可以彼此看到对方并进行音视频通话。<br>【推荐取值】限制长度为 64 字节。以下为支持的字符集范围(共 89 个字符):<br>- 大小写英文字母(a-zA-Z);<br>- 数字(0-9);<br>- 空格、 <code>!</code> 、 <code>#</code> 、 <code>$</code> 、 <code>%</code> 、 <code>&</code> 、 <code>(</code> 、 <code>)</code> 、 <code>+</code> 、 <code>-</code> 、 <code>:</code> 、 <code>;</code> 、 <code><</code> 、 <code>=</code> 、 <code>.</code> 、 <code>></code> 、 <code>?</code> 、 <code>@</code> 、 <code>[</code> 、 <code>]</code> 、 <code>^</code> 、 <code>_</code> 、 <code>{</code> 、 <code>}</code> 、 <code>\\|</code> 、 <code>~</code> 、 <code>,</code> 。<br>【特别说明】1. roomId 与 strRoomId 是互斥的,若您选用 strRoomId,则 roomId 需要填写为0。若两者都填,SDK 将优先选用 roomId。<br>2. 不要混用 roomId 和 strRoomId,因为它们之间是不互通的,例如数字 123 和字符串 <code>123</code> 在 TRTC 看来是两个完全不同的房间。 |
|
|
637
|
+
| streamId | 【字段含义】用于指定在腾讯云直播平台上的 streamId(选填),设置之后,您可以在腾讯云直播 CDN 上通过标准拉流方案(FLV 或 HLS)播放该用户的音视频流。<br>【推荐取值】限制长度为64字节,可以不填写,一种推荐的方案是使用 <code>sdkappid_roomid_userid_main</code> 作为 streamid,这种命名方式容易辨认且不会在您的多个应用中发生冲突。<br>【特别说明】要使用腾讯云直播 CDN,您需要先在 <a href="https://console.cloud.tencent.com/trtc/">控制台</a> 中的功能配置页开启“启动自动旁路直播”开关。<br>【参考文档】<a href="https://cloud.tencent.com/document/product/647/84721">发布音视频流到直播 CDN</a>。 |
|
|
638
|
+
| userDefineRecordId | 【字段含义】云端录制开关(选填),用于指定是否要在云端将该用户的音视频流录制下来。<br>【参考文档】<a href="https://cloud.tencent.com/document/product/647/76497">云端录制</a>。<br>【推荐取值】限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符。<br>方案一:手动录制方案:<br>1. 在 <a href="https://console.cloud.tencent.com/trtc">控制台</a>>应用管理>云端录制配置 中开启云端录制。<br>2. 设置 <code>录制形式</code> 为 <code>手动录制</code> 。<br>3. 设置手动录制后,在一个 TRTC 房间中只有设置了 userDefineRecordId 参数的用户才会在云端录制出视频文件,不指定该参数的用户不会产生录制行为。<br>4. 云端会以 “userDefineRecordId_起始时间_结束时间” 的格式命名录制下来的文件。<br>方案二:自动录制方案:<br>1. 需要在 <a href="https://console.cloud.tencent.com/trtc">控制台</a>>应用管理>云端录制配置 中开启云端录制。<br>2. 设置 <code>录制形式</code> 为 <code>自动录制</code> 。<br>3. 设置自动录制后,在一个 TRTC 房间中的任何一个有音视频上行的用户,均会在云端录制出视频文件。<br>4. 文件会以 <code>userDefineRecordId_起始时间_结束时间</code> 的格式命名,如果不指定 userDefineRecordId,则文件会以 <code>streamId_起始时间_结束时间</code> 命名。 |
|
|
639
639
|
| userId | 【字段含义】用户标识(必填),当前用户的 userId,相当于用户名,使用 UTF-8 编码。<br>【推荐取值】如果一个用户在您的账号系统中的 ID 为 “mike”,则 userId 即可设置为 “mike”。 |
|
|
640
640
|
| userSig | 【字段含义】用户签名(必填),当前 userId 对应的验证签名,相当于使用云服务的登录密码。<br>【推荐取值】具体计算方法请参见 <a href="https://cloud.tencent.com/document/product/647/17275">如何计算UserSig</a>。 |
|
|
641
641
|
|
|
@@ -647,11 +647,11 @@ v11.7 版本开始支持,只在 SDK 内部摄像头采集场景生效
|
|
|
647
647
|
| 枚举类型 | 描述 |
|
|
648
648
|
| --- | --- |
|
|
649
649
|
| enableAdjustRes | 【字段含义】是否允许动态调整分辨率(开启后会对云端录制产生影响)。<br>【推荐取值】该功能适用于不需要云端录制的场景,开启后 SDK 会根据当前网络情况,智能选择出一个合适的分辨率,避免出现“大分辨率+小码率”的低效编码模式。<br>【特别说明】默认值:关闭。如有云端录制的需求,请不要开启此功能,因为如果视频分辨率发生变化后,云端录制出的 MP4 在普通的播放器上无法正常播放。 |
|
|
650
|
-
| minVideoBitrate | 【字段含义】最低视频码率,SDK 会在网络不佳的情况下主动降低视频码率以保持流畅度,最低会降至 minVideoBitrate 所设定的数值。<br>【特别说明】 默认值:0,此时最低码率由 SDK 会根据您指定的分辨率,自动计算出合适的数值。<br>【推荐取值】您可以通过同时设置 videoBitrate 和 minVideoBitrate 两个参数,用于约束 SDK 对视频码率的调整范围:<br>-
|
|
650
|
+
| minVideoBitrate | 【字段含义】最低视频码率,SDK 会在网络不佳的情况下主动降低视频码率以保持流畅度,最低会降至 minVideoBitrate 所设定的数值。<br>【特别说明】 默认值:0,此时最低码率由 SDK 会根据您指定的分辨率,自动计算出合适的数值。<br>【推荐取值】您可以通过同时设置 videoBitrate 和 minVideoBitrate 两个参数,用于约束 SDK 对视频码率的调整范围:<br>- 如果您追求 <code>弱网络下允许卡顿但要保持清晰</code> 的效果,可以设置 minVideoBitrate 为 videoBitrate 的 60%。<br>- 如果您追求 <code>弱网络下允许模糊但要保持流畅</code> 的效果,可以设置 minVideoBitrate 为一个较低的数值(例如 100kbps)。<br>- 如果您将 videoBitrate 和 minVideoBitrate 设置为同一个值,等价于关闭 SDK 对视频码率的自适应调节能力。 |
|
|
651
651
|
| videoBitrate | 【字段含义】目标视频码率,SDK 会按照目标码率进行编码,只有在弱网络环境下才会主动降低视频码率。<br>【推荐取值】请参见本 TRTCVideoResolution 在各档位注释的最佳码率,也可以在此基础上适当调高。例如:TRTCVideoResolution_1280_720 对应 1200kbps 的目标码率,您也可以设置为 1500kbps 用来获得更好的观感清晰度。<br>【特别说明】您可以通过同时设置 videoBitrate 和 minVideoBitrate 两个参数,用于约束 SDK 对视频码率的调整范围:<br>- 如果您追求“弱网络下允许卡顿但要保持清晰”的效果,可以设置 minVideoBitrate 为 videoBitrate 的 60%。<br>- 如果您追求“弱网络下允许模糊但要保持流畅”的效果,可以设置 minVideoBitrate 为一个较低的数值(例如 100kbps)。<br>- 如果您将 videoBitrate 和 minVideoBitrate 设置为同一个值,等价于关闭 SDK 对视频码率的自适应调节能力。 |
|
|
652
652
|
| videoFps | 【字段含义】视频采集帧率。<br>【推荐取值】15fps或20fps。5fps以下,卡顿感明显。10fps以下,会有轻微卡顿感。20fps以上,会浪费带宽(电影的帧率为24fps)。<br>【特别说明】部分 Android 手机的前置摄像头并不支持15fps以上的采集帧率,部分主打美颜功能的 Android 手机的前置摄像头的采集帧率可能低于10fps。 |
|
|
653
|
-
| videoResolution | 【字段含义】视频分辨率。<br>【特别说明】如需使用竖屏分辨率,请指定 resMode 为 Portrait,例如:
|
|
654
|
-
| videoResolutionMode | 【字段含义】分辨率模式(横屏分辨率 or 竖屏分辨率)。<br>【推荐取值】手机平台(iOS、Android)建议选择 Portrait,桌面平台(Windows、Mac)建议选择 Landscape。<br>【特别说明】如需使用竖屏分辨率,请指定 resMode 为 Portrait,例如:
|
|
653
|
+
| videoResolution | 【字段含义】视频分辨率。<br>【特别说明】如需使用竖屏分辨率,请指定 resMode 为 Portrait,例如: <code>640 × 360 + Portrait = 360 × 640</code> 。<br>【推荐取值】<br>- 手机视频通话:建议选择 360 × 640 及以下分辨率,resMode 选择 Portrait,即竖屏分辨率。<br>- 手机在线直播:建议选择 540 × 960,resMode 选择 Portrait,即竖屏分辨率。<br>- 桌面平台(Win + Mac):建议选择 640 × 360 及以上分辨率,resMode 选择 Landscape,即横屏分辨率。 |
|
|
654
|
+
| videoResolutionMode | 【字段含义】分辨率模式(横屏分辨率 or 竖屏分辨率)。<br>【推荐取值】手机平台(iOS、Android)建议选择 Portrait,桌面平台(Windows、Mac)建议选择 Landscape。<br>【特别说明】如需使用竖屏分辨率,请指定 resMode 为 Portrait,例如: <code>640 × 360 + Portrait = 360 × 640</code> 。 |
|
|
655
655
|
|
|
656
656
|
## TRTCNetworkQosParam
|
|
657
657
|
|
|
@@ -705,8 +705,8 @@ v11.7 版本开始支持,只在 SDK 内部摄像头采集场景生效
|
|
|
705
705
|
您可以在用户进入房间前通过 startSpeedTest 接口测试网速(注意:请不要在通话中调用)。
|
|
706
706
|
| 枚举类型 | 描述 |
|
|
707
707
|
| --- | --- |
|
|
708
|
-
| expectedDownBandwidth | 预期的下行带宽(kbps,取值范围:[10, 5000],为 0 时不测试)。<br><strong>注意</strong><br>当参数 scene 设置为 TRTC_SpeedTestScene_Online_Chorus_Testing 时,为了获取更准确的
|
|
709
|
-
| expectedUpBandwidth | 预期的上行带宽(kbps,取值范围: [10, 5000],为 0 时不测试)。<br><strong>注意</strong><br>当参数 scene 设置为 TRTC_SpeedTestScene_Online_Chorus_Testing 时,为了获取更准确的
|
|
708
|
+
| expectedDownBandwidth | 预期的下行带宽(kbps,取值范围:[10, 5000],为 0 时不测试)。<br><strong>注意</strong><br>当参数 scene 设置为 TRTC_SpeedTestScene_Online_Chorus_Testing 时,为了获取更准确的 <code>rtt / jitter</code> 等信息,取值范围限制为 [10, 1000]。 |
|
|
709
|
+
| expectedUpBandwidth | 预期的上行带宽(kbps,取值范围: [10, 5000],为 0 时不测试)。<br><strong>注意</strong><br>当参数 scene 设置为 TRTC_SpeedTestScene_Online_Chorus_Testing 时,为了获取更准确的 <code>rtt / jitter</code> 等信息,取值范围限制为 [10, 1000]。 |
|
|
710
710
|
| scene | 测速场景。 |
|
|
711
711
|
| sdkAppId | 应用标识,请参见 TRTCParams 中的相关说明。 |
|
|
712
712
|
| userId | 用户标识,请参见 TRTCParams 中的相关说明。 |
|
|
@@ -866,7 +866,7 @@ TRTC 中的“音效”特指一些短暂的音频文件,通常仅有几秒钟
|
|
|
866
866
|
|
|
867
867
|
在 7.3 版本以后,音效接口已被新的接口 startPlayMusic 所取代。
|
|
868
868
|
|
|
869
|
-
您在指定 startPlayMusic 的参数 TXAudioMusicParam 时,如果将
|
|
869
|
+
您在指定 startPlayMusic 的参数 TXAudioMusicParam 时,如果将 `isShortFile` 设置为 true,即为“音效”文件。
|
|
870
870
|
| 枚举类型 | 描述 |
|
|
871
871
|
| --- | --- |
|
|
872
872
|
| effectId | 【字段含义】音效 ID<br>【特别说明】SDK 允许播放多路音效,因此需要音效 ID 进行标记,用于控制音效的开始、停止、音量等。 |
|
|
@@ -897,7 +897,7 @@ TRTC 中的“音效”特指一些短暂的音频文件,通常仅有几秒钟
|
|
|
897
897
|
| channel | 【字段含义】声道数。<br>【推荐取值】默认值:1,代表单声道。可设定的数值只有两个数字:1-单声道,2-双声道。 |
|
|
898
898
|
| mode | 【字段含义】回调数据读写模式<br>【推荐取值】TRTC_AUDIO_FRAME_OPERATION_MODE_READONLY:仅从回调中获取音频数据。可设定的模式有 TRTC_AUDIO_FRAME_OPERATION_MODE_READONLY,TRTC_AUDIO_FRAME_OPERATION_MODE_READWRITE。 |
|
|
899
899
|
| sampleRate | 【字段含义】采样率。<br>【推荐取值】默认值:48000Hz。支持 16000, 32000, 44100, 48000。 |
|
|
900
|
-
| samplesPerCall | 【字段含义】采样点数。<br>【推荐取值】取值必须是
|
|
900
|
+
| samplesPerCall | 【字段含义】采样点数。<br>【推荐取值】取值必须是 <code>sampleRate/100</code> 的整数倍。 |
|
|
901
901
|
|
|
902
902
|
## TRTCScreenShareParams
|
|
903
903
|
|
|
@@ -928,7 +928,7 @@ TRTC 中的“音效”特指一些短暂的音频文件,通常仅有几秒钟
|
|
|
928
928
|
| 枚举类型 | 描述 |
|
|
929
929
|
| --- | --- |
|
|
930
930
|
| intRoomId | 【字段含义】数字房间号,需要和您的进房参数 (TRTCParams) 中的房间号类型相匹配。<br>【推荐取值】取值范围:1 - 4294967294。<br>【特别说明】intRoomId 与 strRoomId 是互斥的,若您进房参数中选用 strRoomId,则 intRoomId 需要填写为0。若两者都填,SDK 将优先选用 intRoomId。 |
|
|
931
|
-
| strRoomId | 【字段含义】字符串房间号,需要和您的进房参数 (TRTCParams) 中的房间号类型相匹配。<br>【特别说明】intRoomId 与 strRoomId 是互斥的,若您进房参数中选用 roomId,则 strRoomId 无需填写。若两者都填,SDK 将优先选用 intRoomId。<br>【推荐取值】限制长度为 64 字节。以下为支持的字符集范围(共 89 个字符):<br>- 大小写英文字母(a-zA-Z);<br>- 数字(0-9);<br>-
|
|
931
|
+
| strRoomId | 【字段含义】字符串房间号,需要和您的进房参数 (TRTCParams) 中的房间号类型相匹配。<br>【特别说明】intRoomId 与 strRoomId 是互斥的,若您进房参数中选用 roomId,则 strRoomId 无需填写。若两者都填,SDK 将优先选用 intRoomId。<br>【推荐取值】限制长度为 64 字节。以下为支持的字符集范围(共 89 个字符):<br>- 大小写英文字母(a-zA-Z);<br>- 数字(0-9);<br>- 空格、 <code>!</code> 、 <code>#</code> 、 <code>$</code> 、 <code>%</code> 、 <code>&</code> 、 <code>(</code> 、 <code>)</code> 、 <code>+</code> 、 <code>-</code> 、 <code>:</code> 、 <code>;</code> 、 <code><</code> 、 <code>=</code> 、 <code>.</code> 、 <code>></code> 、 <code>?</code> 、 <code>@</code> 、 <code>[</code> 、 <code>]</code> 、 <code>^</code> 、 <code>_</code> 、 <code>{</code> 、 <code>}</code> 、 <code>\\|</code> 、 <code>~</code> 、 <code>,</code> 。 |
|
|
932
932
|
| userId | 【字段含义】用户标识,当前用户的 userId,相当于用户名,使用 UTF-8 编码。<br>【推荐取值】如果一个用户在您的账号系统中的 ID 为“mike”,则 userId 即可设置为“mike”。 |
|
|
933
933
|
|
|
934
934
|
## TRTCPublishCdnUrl
|
|
@@ -160,7 +160,6 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
160
160
|
|
|
161
161
|
> **注意**
|
|
162
162
|
>
|
|
163
|
-
|
|
164
163
|
> 目前仅支持 OpenGL 纹理方案( PC 仅支持 TRTCVideoBufferType_Buffer 格式)。
|
|
165
164
|
>
|
|
166
165
|
|
|
@@ -175,9 +174,9 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
175
174
|
当您设置完音频数据自定义回调之后,SDK 内部会把刚采集到并经过前处理(ANS、AEC、AGC)之后的数据,以 PCM 格式的形式通过本接口回调给您。
|
|
176
175
|
- 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
|
|
177
176
|
|
|
178
|
-
- 由时间帧长转化为字节帧长的公式为
|
|
177
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
179
178
|
|
|
180
|
-
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为
|
|
179
|
+
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
181
180
|
|
|
182
181
|
|参数|描述|
|
|
183
182
|
|---------|---------|
|
|
@@ -185,13 +184,10 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
185
184
|
|
|
186
185
|
> **注意**
|
|
187
186
|
>
|
|
188
|
-
|
|
189
187
|
> 1. 请不要在此回调函数中做任何耗时操作,由于 SDK 每隔 20ms 就要处理一帧音频数据,如果您的处理时间超过 20ms,就会导致声音异常。
|
|
190
188
|
>
|
|
191
|
-
|
|
192
189
|
> 2. 此接口回调出的音频数据是可读写的,也就是说您可以在回调函数中同步修改音频数据,但请保证处理耗时。
|
|
193
190
|
>
|
|
194
|
-
|
|
195
191
|
> 3. 此接口回调出的音频数据已经经过了前处理(ANS、AEC、AGC),但**不包含**背景音、音效、混响等前处理效果,延迟较低。
|
|
196
192
|
>
|
|
197
193
|
|
|
@@ -202,15 +198,15 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
202
198
|
当您设置完音频数据自定义回调之后,SDK 内部会把刚采集到并经过前处理、音效处理和混 BGM 之后的数据,在最终进行网络编码之前,以 PCM 格式的形式通过本接口回调给您。
|
|
203
199
|
- 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
|
|
204
200
|
|
|
205
|
-
-
|
|
201
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
206
202
|
|
|
207
|
-
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16
|
|
203
|
+
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
208
204
|
|
|
209
205
|
特殊说明:
|
|
210
206
|
|
|
211
|
-
您可以通过设置接口中的
|
|
207
|
+
您可以通过设置接口中的 `TRTCAudioFrame.extraData` 字段,达到传输信令的目的。由于音频帧头部的数据块不能太大,建议您写入 `extraData` 时,尽量将信令控制在几个字节的大小,如果超过 100 个字节,写入的数据不会被发送。
|
|
212
208
|
|
|
213
|
-
房间内其他用户可以通过 TRTCAudioFrameListener 中的
|
|
209
|
+
房间内其他用户可以通过 TRTCAudioFrameListener 中的 `onRemoteUserAudioFrame` 中的 `TRTCAudioFrame.extraData` 字段回调接收数据。
|
|
214
210
|
|
|
215
211
|
|参数|描述|
|
|
216
212
|
|---------|---------|
|
|
@@ -218,13 +214,10 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
218
214
|
|
|
219
215
|
> **注意**
|
|
220
216
|
>
|
|
221
|
-
|
|
222
217
|
> 1. 请不要在此回调函数中做任何耗时操作,由于 SDK 每隔 20ms 就要处理一帧音频数据,如果您的处理时间超过 20ms,就会导致声音异常。
|
|
223
218
|
>
|
|
224
|
-
|
|
225
219
|
> 2. 此接口回调出的音频数据是可读写的,也就是说您可以在回调函数中同步修改音频数据,但请保证处理耗时。
|
|
226
220
|
>
|
|
227
|
-
|
|
228
221
|
> 3. 此接口回调出的数据已经经过了前处理(ANS、AEC、AGC)、音效和混 BGM 处理,声音的延迟相比于 onCapturedAudioFrame 要高一些。
|
|
229
222
|
>
|
|
230
223
|
|
|
@@ -235,9 +228,9 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
235
228
|
当您设置完音频数据自定义回调之后,SDK 内部会把远端的每一路原始数据,在最终混音之前,以 PCM 格式的形式通过本接口回调给您。
|
|
236
229
|
- 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
|
|
237
230
|
|
|
238
|
-
-
|
|
231
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
239
232
|
|
|
240
|
-
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16
|
|
233
|
+
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
241
234
|
|
|
242
235
|
|参数|描述|
|
|
243
236
|
|---------|---------|
|
|
@@ -246,7 +239,6 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
246
239
|
|
|
247
240
|
> **注意**
|
|
248
241
|
>
|
|
249
|
-
|
|
250
242
|
> 此接口回调出的音频数据是只读的,不支持修改。
|
|
251
243
|
>
|
|
252
244
|
|
|
@@ -257,9 +249,9 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
257
249
|
当您设置完音频数据自定义回调之后,SDK 内部会把各路待播放的音频混合之后的音频数据,在提交系统播放之前,以 PCM 格式的形式通过本接口回调给您。
|
|
258
250
|
- 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
|
|
259
251
|
|
|
260
|
-
- 由时间帧长转化为字节帧长的公式为
|
|
252
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
261
253
|
|
|
262
|
-
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为
|
|
254
|
+
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
263
255
|
|
|
264
256
|
|参数|描述|
|
|
265
257
|
|---------|---------|
|
|
@@ -267,13 +259,10 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
267
259
|
|
|
268
260
|
> **注意**
|
|
269
261
|
>
|
|
270
|
-
|
|
271
262
|
> 1. 请不要在此回调函数中做任何耗时操作,由于 SDK 每隔 20ms 就要处理一帧音频数据,如果您的处理时间超过 20ms,就会导致声音异常。
|
|
272
263
|
>
|
|
273
|
-
|
|
274
264
|
> 2. 此接口回调出的音频数据是可读写的,也就是说您可以在回调函数中同步修改音频数据,但请保证处理耗时。
|
|
275
265
|
>
|
|
276
|
-
|
|
277
266
|
> 3. 此接口回调出的是对各路待播放音频数据的混合,但其中并不包含耳返的音频数据。
|
|
278
267
|
>
|
|
279
268
|
|
|
@@ -284,9 +273,9 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
284
273
|
当您设置完音频数据自定义回调之后,SDK 内部会把所有采集到的和待播放的音频数据混合起来,以 PCM 格式的形式通过本接口回调给您,便于您进行自定义录制。
|
|
285
274
|
- 此接口回调出的音频时间帧长固定为0.02s,格式为 PCM 格式。
|
|
286
275
|
|
|
287
|
-
- 由时间帧长转化为字节帧长的公式为
|
|
276
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
288
277
|
|
|
289
|
-
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为
|
|
278
|
+
- 以 TRTC 默认的音频录制格式48000采样率、单声道、16采样点位宽为例,字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
290
279
|
|
|
291
280
|
|参数|描述|
|
|
292
281
|
|---------|---------|
|
|
@@ -294,10 +283,8 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
294
283
|
|
|
295
284
|
> **注意**
|
|
296
285
|
>
|
|
297
|
-
|
|
298
286
|
> 1. 此接口回调出的是SDK所有音频数据的混合数据,包括:经过 3A 前处理、特效叠加以及背景音乐混音后的本地音频,所有远端音频,但不包括耳返音频。
|
|
299
287
|
>
|
|
300
|
-
|
|
301
288
|
> 2. 此接口回调出的音频数据不支持修改。
|
|
302
289
|
>
|
|
303
290
|
|
|
@@ -308,9 +295,9 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
308
295
|
当您设置完音频数据自定义回调之后,SDK 内部会把耳返的音频数据在播放之前以 PCM 格式的形式通过本接口回调给您。
|
|
309
296
|
- 此接口回调出的音频时间帧长不固定,格式为 PCM 格式。
|
|
310
297
|
|
|
311
|
-
- 由时间帧长转化为字节帧长的公式为
|
|
298
|
+
- 由时间帧长转化为字节帧长的公式为 `采样率 × 时间帧长 × 声道数 × 采样点位宽` 。
|
|
312
299
|
|
|
313
|
-
- 以 TRTC 默认的音频录制格式 48000 采样率、单声道、16采样点位宽为例,0.02s 的音频数据字节帧长为
|
|
300
|
+
- 以 TRTC 默认的音频录制格式 48000 采样率、单声道、16采样点位宽为例,0.02s 的音频数据字节帧长为 `48000 × 0.02s × 1 × 16bit = 15360bit = 1920字节` 。
|
|
314
301
|
|
|
315
302
|
|参数|描述|
|
|
316
303
|
|---------|---------|
|
|
@@ -318,10 +305,8 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
318
305
|
|
|
319
306
|
> **注意**
|
|
320
307
|
>
|
|
321
|
-
|
|
322
308
|
> 1. 请不要在此回调函数中做任何耗时操作,否则会导致声音异常。
|
|
323
309
|
>
|
|
324
|
-
|
|
325
310
|
> 2. 此接口回调出的音频数据是可读写的,也就是说您可以在回调函数中同步修改音频数据,但请保证处理耗时。
|
|
326
311
|
>
|
|
327
312
|
|
|
@@ -335,7 +320,7 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
335
320
|
|---------|---------|
|
|
336
321
|
|level|日志等级请参见 TRTC_LOG_LEVEL。|
|
|
337
322
|
|log|日志内容。|
|
|
338
|
-
|module|保留字段,暂无具体意义,目前为固定值
|
|
323
|
+
|module|保留字段,暂无具体意义,目前为固定值 `TXLiteAVSDK` 。|
|
|
339
324
|
|
|
340
325
|
## onError
|
|
341
326
|
|
|
@@ -369,7 +354,7 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
369
354
|
|
|
370
355
|
**进入房间成功与否的事件回调。**
|
|
371
356
|
|
|
372
|
-
调用 TRTCCloud 中的 enterRoom 接口执行进房操作后,会收到来自 TRTCCloudListener 的
|
|
357
|
+
调用 TRTCCloud 中的 enterRoom 接口执行进房操作后,会收到来自 TRTCCloudListener 的 `onEnterRoom(result)` 回调:
|
|
373
358
|
- 如果加入成功,回调 result 会是一个正数(result > 0),代表进入房间所消耗的时间,单位是毫秒(ms)。
|
|
374
359
|
|
|
375
360
|
- 如果加入失败,回调 result 会是一个负数(result < 0),代表失败原因的错误码。
|
|
@@ -382,11 +367,9 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
382
367
|
|
|
383
368
|
> **注意**
|
|
384
369
|
>
|
|
385
|
-
|
|
386
|
-
> 1. 在 Ver6.6 之前的版本,只有进房成功会抛出 ` onEnterRoom(result) ` 回调,进房失败由 onError 回调抛出。
|
|
370
|
+
> 1. 在 Ver6.6 之前的版本,只有进房成功会抛出 `onEnterRoom(result)` 回调,进房失败由 onError 回调抛出。
|
|
387
371
|
>
|
|
388
|
-
|
|
389
|
-
> 2. 在 Ver6.6 之后的版本:无论进房成功或失败,均会抛出 ` onEnterRoom(result) ` 回调,同时进房失败也会有 onError 回调抛出。
|
|
372
|
+
> 2. 在 Ver6.6 之后的版本:无论进房成功或失败,均会抛出 `onEnterRoom(result)` 回调,同时进房失败也会有 onError 回调抛出。
|
|
390
373
|
>
|
|
391
374
|
|
|
392
375
|
## onExitRoom
|
|
@@ -395,9 +378,9 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
395
378
|
|
|
396
379
|
调用 TRTCCloud 中的 exitRoom 接口会执行退出房间的相关逻辑,例如释放音视频设备资源和编解码器资源等。
|
|
397
380
|
|
|
398
|
-
待 SDK 占用的所有资源释放完毕后,SDK 会抛出
|
|
381
|
+
待 SDK 占用的所有资源释放完毕后,SDK 会抛出 `onExitRoom()` 回调通知到您。
|
|
399
382
|
|
|
400
|
-
如果您要再次调用 enterRoom 或者切换到其他的音视频 SDK,请等待
|
|
383
|
+
如果您要再次调用 enterRoom 或者切换到其他的音视频 SDK,请等待 `onExitRoom` 回调到来后再执行相关操作。否则可能会遇到例如摄像头、麦克风设备被强占等各种异常问题。
|
|
401
384
|
|
|
402
385
|
|参数|描述|
|
|
403
386
|
|---------|---------|
|
|
@@ -407,7 +390,7 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
407
390
|
|
|
408
391
|
**切换角色的事件回调。**
|
|
409
392
|
|
|
410
|
-
调用 TRTCCloud 中的 switchRole 接口会切换主播和观众的角色,该操作会伴随一个线路切换的过程,待 SDK 切换完成后,会抛出
|
|
393
|
+
调用 TRTCCloud 中的 switchRole 接口会切换主播和观众的角色,该操作会伴随一个线路切换的过程,待 SDK 切换完成后,会抛出 `onSwitchRole()` 事件回调。
|
|
411
394
|
|
|
412
395
|
|参数|描述|
|
|
413
396
|
|---------|---------|
|
|
@@ -418,7 +401,7 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
418
401
|
|
|
419
402
|
**切换房间的结果回调。**
|
|
420
403
|
|
|
421
|
-
调用 TRTCCloud 中的 switchRoom 接口可以让用户快速地从一个房间切换到另一个房间,待 SDK 切换完成后,会抛出
|
|
404
|
+
调用 TRTCCloud 中的 switchRoom 接口可以让用户快速地从一个房间切换到另一个房间,待 SDK 切换完成后,会抛出 `onSwitchRoom()` 事件回调。
|
|
422
405
|
|
|
423
406
|
|参数|描述|
|
|
424
407
|
|---------|---------|
|
|
@@ -431,7 +414,7 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
431
414
|
|
|
432
415
|
调用 TRTCCloud 中的 connectOtherRoom 接口会将两个不同房间中的主播拉通视频通话,也就是所谓的“主播PK”功能。
|
|
433
416
|
|
|
434
|
-
调用者会收到
|
|
417
|
+
调用者会收到 `onConnectOtherRoom()` 回调来获知跨房通话是否成功。
|
|
435
418
|
|
|
436
419
|
|参数|描述|
|
|
437
420
|
|---------|---------|
|
|
@@ -445,7 +428,7 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
445
428
|
|
|
446
429
|
调用 TRTCCloud 中的 disConnectOtherRoom 接口会结束两个不同房间中的主播视频通话,也就是所谓的“主播PK”功能。
|
|
447
430
|
|
|
448
|
-
调用者会收到
|
|
431
|
+
调用者会收到 `onDisconnectOtherRoom()` 回调来获知结束跨房通话是否成功。
|
|
449
432
|
|
|
450
433
|
|参数|描述|
|
|
451
434
|
|---------|---------|
|
|
@@ -458,7 +441,7 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
458
441
|
|
|
459
442
|
调用 TRTCCloud 中的 updateOtherRoomForwardMode 接口会限制跨房主播在本房间内的上行能力,禁止或允许跨房主播发布音频/主路视频/辅路视频,该行为会影响房间内的所有用户。
|
|
460
443
|
|
|
461
|
-
调用者会收到
|
|
444
|
+
调用者会收到 `onUpdateOtherRoomForwardMode()` 回调来获知更改跨房主播上行能力是否成功。
|
|
462
445
|
|
|
463
446
|
|参数|描述|
|
|
464
447
|
|---------|---------|
|
|
@@ -469,7 +452,7 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
469
452
|
|
|
470
453
|
**有用户加入当前房间。**
|
|
471
454
|
|
|
472
|
-
出于性能方面的考虑,在 TRTC 两种不同的应用场景(即
|
|
455
|
+
出于性能方面的考虑,在 TRTC 两种不同的应用场景(即 `AppScene` ,在 enterRoom 时通过第二个参数指定)下,该通知的行为会有差别:
|
|
473
456
|
- 直播类场景(TRTC_APP_SCENE_LIVE 和 TRTC_APP_SCENE_VOICE_CHATROOM):该场景下的用户区分主播和观众两种角色,只有主播进入房间时才会触发该通知,观众进入房间时不会触发该通知。
|
|
474
457
|
|
|
475
458
|
- 通话类场景(TRTC_APP_SCENE_VIDEOCALL 和 TRTC_APP_SCENE_AUDIOCALL):该场景下的用户没有角色的区分(可认为都是主播),任何用户进入房间都会触发该通知。
|
|
@@ -480,10 +463,8 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
480
463
|
|
|
481
464
|
> **注意**
|
|
482
465
|
>
|
|
483
|
-
|
|
484
|
-
> 1. 事件回调 ` onRemoteUserEnterRoom ` 和 onRemoteUserLeaveRoom 只适用于维护当前房间里的“用户列表”,有此事件回调不代表一定有视频画面。
|
|
466
|
+
> 1. 事件回调 `onRemoteUserEnterRoom` 和 onRemoteUserLeaveRoom 只适用于维护当前房间里的“用户列表”,有此事件回调不代表一定有视频画面。
|
|
485
467
|
>
|
|
486
|
-
|
|
487
468
|
> 2. 如果需要显示远程画面,请监听代表某个用户是否有视频画面的 onUserVideoAvailable 事件回调。
|
|
488
469
|
>
|
|
489
470
|
|
|
@@ -505,11 +486,11 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
505
486
|
|
|
506
487
|
**某远端用户发布/取消了主路视频画面。**
|
|
507
488
|
|
|
508
|
-
**主路画面** 一般被用于承载摄像头画面。当您收到
|
|
489
|
+
**主路画面** 一般被用于承载摄像头画面。当您收到 `onUserVideoAvailable(userId, true)` 通知时,表示该路画面已经有可播放的视频帧到达。
|
|
509
490
|
|
|
510
|
-
此时,您需要调用 startRemoteView 接口订阅该用户的远程画面,订阅成功后,您会继续收到该用户的首帧画面渲染回调
|
|
491
|
+
此时,您需要调用 startRemoteView 接口订阅该用户的远程画面,订阅成功后,您会继续收到该用户的首帧画面渲染回调 `onFirstVideoFrame(userId)` 。
|
|
511
492
|
|
|
512
|
-
当您收到
|
|
493
|
+
当您收到 `onUserVideoAvailable(userId, false)` 通知时,表示该路远程画面已经被关闭,关闭的原因可能是该用户调用了 muteLocalVideo 或 stopLocalPreview。
|
|
513
494
|
|
|
514
495
|
|参数|描述|
|
|
515
496
|
|---------|---------|
|
|
@@ -520,9 +501,9 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
520
501
|
|
|
521
502
|
**某远端用户发布/取消了辅路视频画面。**
|
|
522
503
|
|
|
523
|
-
“辅路画面”一般被用于承载屏幕分享的画面。当您收到
|
|
504
|
+
“辅路画面”一般被用于承载屏幕分享的画面。当您收到 `onUserSubStreamAvailable(userId, true)` 通知时,表示该路画面已经有可播放的视频帧到达。
|
|
524
505
|
|
|
525
|
-
此时,您需要调用 startRemoteView 接口订阅该用户的远程画面,订阅成功后,您会继续收到该用户的首帧画面渲染回调
|
|
506
|
+
此时,您需要调用 startRemoteView 接口订阅该用户的远程画面,订阅成功后,您会继续收到该用户的首帧画面渲染回调 `onFirstVideoFrame(userId)` 。
|
|
526
507
|
|
|
527
508
|
|参数|描述|
|
|
528
509
|
|---------|---------|
|
|
@@ -531,7 +512,6 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
531
512
|
|
|
532
513
|
> **注意**
|
|
533
514
|
>
|
|
534
|
-
|
|
535
515
|
> 显示辅路画面使用的函数是 startRemoteView 而非 startRemoteSubStreamView,startRemoteSubStreamView 已经被废弃。
|
|
536
516
|
>
|
|
537
517
|
|
|
@@ -539,7 +519,7 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
539
519
|
|
|
540
520
|
**某远端用户发布/取消了自己的音频。**
|
|
541
521
|
|
|
542
|
-
当您收到
|
|
522
|
+
当您收到 `onUserAudioAvailable(userId, true)` 通知时,表示该用户发布了自己的声音,此时 SDK 的表现为:
|
|
543
523
|
- 在自动订阅模式下,您无需做任何操作,SDK 会自动播放该用户的声音。
|
|
544
524
|
|
|
545
525
|
- 在手动订阅模式下,您可以通过 muteRemoteAudio(userid, false) 来播放该用户的声音。
|
|
@@ -551,7 +531,6 @@ int onProcessVideoFrame(TRTCCloudDef.TRTCVideoFrame srcFrame, TRTCCloudDef.TRTCV
|
|
|
551
531
|
|
|
552
532
|
> **注意**
|
|
553
533
|
>
|
|
554
|
-
|
|
555
534
|
> SDK 默认使用自动订阅模式,您可以通过 setDefaultStreamRecvMode 设置为手动订阅,但需要在您进入房间之前调用才生效。
|
|
556
535
|
>
|
|
557
536
|
|
|
@@ -573,10 +552,8 @@ SDK 会在渲染自己本地或远端用户的首帧画面时抛出该事件,
|
|
|
573
552
|
|
|
574
553
|
> **注意**
|
|
575
554
|
>
|
|
576
|
-
|
|
577
555
|
> 1. 只有当您调用了 startLocalPreview 或 startScreenCapture 之后,才会触发自己本地的首帧画面事件回调。
|
|
578
556
|
>
|
|
579
|
-
|
|
580
557
|
> 2. 只有当您调用了 startRemoteView 或 startRemoteSubStreamView 之后,才会触发远端用户的首帧画面事件回调。
|
|
581
558
|
>
|
|
582
559
|
|
|
@@ -594,7 +571,7 @@ SDK 会在播放远端用户的首帧音频时抛出该事件,本地音频的
|
|
|
594
571
|
|
|
595
572
|
**自己本地的首个视频帧已被发布出去。**
|
|
596
573
|
|
|
597
|
-
当您成功进入房间并通过 startLocalPreview 或 startScreenCapture 开启本地视频采集之后(开启采集和进入房间的先后顺序无影响),SDK 就会开始进行视频编码,并通过自身的网络模块向云端发布自己本地的视频数据。当 SDK 成功地向云端送出自己的第一帧视频数据帧以后,就会抛出
|
|
574
|
+
当您成功进入房间并通过 startLocalPreview 或 startScreenCapture 开启本地视频采集之后(开启采集和进入房间的先后顺序无影响),SDK 就会开始进行视频编码,并通过自身的网络模块向云端发布自己本地的视频数据。当 SDK 成功地向云端送出自己的第一帧视频数据帧以后,就会抛出 `onSendFirstLocalVideoFrame` 事件回调。
|
|
598
575
|
|
|
599
576
|
|参数|描述|
|
|
600
577
|
|---------|---------|
|
|
@@ -604,7 +581,7 @@ SDK 会在播放远端用户的首帧音频时抛出该事件,本地音频的
|
|
|
604
581
|
|
|
605
582
|
**自己本地的首个音频帧已被发布出去。**
|
|
606
583
|
|
|
607
|
-
当您成功进入房间并通过 startLocalAudio 开启本地音频采集之后(开启采集和进入房间的先后顺序无影响),SDK 就会开始进行音频编码,并通过自身的网络模块向云端发布自己本地的音频数据。当 SDK 成功地向云端送出自己的第一帧音频数据帧以后,就会抛出
|
|
584
|
+
当您成功进入房间并通过 startLocalAudio 开启本地音频采集之后(开启采集和进入房间的先后顺序无影响),SDK 就会开始进行音频编码,并通过自身的网络模块向云端发布自己本地的音频数据。当 SDK 成功地向云端送出自己的第一帧音频数据帧以后,就会抛出 `onSendFirstLocalAudioFrame` 事件回调。
|
|
608
585
|
|
|
609
586
|
## onRemoteVideoStatusUpdated
|
|
610
587
|
|
|
@@ -637,7 +614,7 @@ SDK 会在播放远端用户的首帧音频时抛出该事件,本地音频的
|
|
|
637
614
|
|
|
638
615
|
**用户视频大小发生改变回调。**
|
|
639
616
|
|
|
640
|
-
当您收到
|
|
617
|
+
当您收到 `onUserVideoSizeChanged(userId, streamType, newWidth, newHeight)` 通知时,表示该路画面大小发生了调整,调整的原因可能是该用户调用了 setVideoEncoderParam 或者 setSubStreamEncoderParam 重新设置了画面尺寸。
|
|
641
618
|
|
|
642
619
|
|参数|描述|
|
|
643
620
|
|---------|---------|
|
|
@@ -650,20 +627,14 @@ SDK 会在播放远端用户的首帧音频时抛出该事件,本地音频的
|
|
|
650
627
|
|
|
651
628
|
**网络质量的实时统计回调。**
|
|
652
629
|
|
|
653
|
-
该统计回调每间隔2秒抛出一次,用于通知 SDK
|
|
630
|
+
该统计回调每间隔2秒抛出一次,用于通知 SDK 感知到的本端用户与远端用户的上行质量。
|
|
654
631
|
|
|
655
632
|
SDK 会使用一组内嵌的自研算法对当前网络的延迟高低、带宽大小以及稳定情况进行评估,并计算出一个评估结果:如果评估结果为 1(Excellent) 代表当前的网络情况非常好,如果评估结果为 6(Down)代表当前网络无法支撑 TRTC 的正常通话。
|
|
656
633
|
|
|
657
634
|
|参数|描述|
|
|
658
635
|
|---------|---------|
|
|
659
|
-
|localQuality
|
|
660
|
-
|remoteQuality
|
|
661
|
-
|
|
662
|
-
> **注意**
|
|
663
|
-
>
|
|
664
|
-
|
|
665
|
-
> 暂时无法通过该接口单独判定远端用户的上行质量。
|
|
666
|
-
>
|
|
636
|
+
|localQuality|本端用户的上行网络质量。|
|
|
637
|
+
|remoteQuality|远端用户的上行网络质量。|
|
|
667
638
|
|
|
668
639
|
## onStatistics
|
|
669
640
|
|
|
@@ -682,7 +653,6 @@ SDK 会使用一组内嵌的自研算法对当前网络的延迟高低、带宽
|
|
|
682
653
|
|
|
683
654
|
> **注意**
|
|
684
655
|
>
|
|
685
|
-
|
|
686
656
|
> 如果您只需要获知当前网络质量的好坏,并不需要花太多时间研究本统计回调,更推荐您使用 onNetworkQuality 来解决问题。
|
|
687
657
|
>
|
|
688
658
|
|
|
@@ -762,7 +732,7 @@ SDK 会在跟云端的连接断开时抛出 onConnectionLost,之后会努力
|
|
|
762
732
|
|
|
763
733
|
**音量大小的反馈回调。**
|
|
764
734
|
|
|
765
|
-
SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该事件回调,您可以根据音量大小在 UI
|
|
735
|
+
SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该事件回调,您可以根据音量大小在 UI 上做出相应的提示,例如 `波形图` 或 `音量槽` 。
|
|
766
736
|
|
|
767
737
|
要完成这个功能, 您需要先调用 enableAudioVolumeEvaluation 开启这个能力并设定事件抛出的时间间隔。
|
|
768
738
|
|
|
@@ -775,7 +745,6 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
|
|
|
775
745
|
|
|
776
746
|
> **注意**
|
|
777
747
|
>
|
|
778
|
-
|
|
779
748
|
> userVolumes 为一个数组,对于数组中的每一个元素,当 userId 为空时表示本地麦克风采集的音量大小,当 userId 不为空时代表远端用户的音量大小。
|
|
780
749
|
>
|
|
781
750
|
|
|
@@ -783,7 +752,7 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
|
|
|
783
752
|
|
|
784
753
|
**收到自定义消息的事件回调。**
|
|
785
754
|
|
|
786
|
-
当房间中的某个用户使用 sendCustomCmdMsg 发送自定义 UDP 消息时,房间中的其他用户可以通过
|
|
755
|
+
当房间中的某个用户使用 sendCustomCmdMsg 发送自定义 UDP 消息时,房间中的其他用户可以通过 `onRecvCustomCmdMsg` 事件回调接收到该条消息。
|
|
787
756
|
|
|
788
757
|
|参数|描述|
|
|
789
758
|
|---------|---------|
|
|
@@ -809,7 +778,6 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
|
|
|
809
778
|
|
|
810
779
|
> **注意**
|
|
811
780
|
>
|
|
812
|
-
|
|
813
781
|
> 只有在发送端设置了可靠传输(reliable),接收方才能收到消息的丢失回调。
|
|
814
782
|
>
|
|
815
783
|
|
|
@@ -817,7 +785,7 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
|
|
|
817
785
|
|
|
818
786
|
**收到 SEI 消息的回调。**
|
|
819
787
|
|
|
820
|
-
当房间中的某个用户使用 sendSEIMsg 借助视频数据帧发送 SEI 消息时,房间中的其他用户可以通过
|
|
788
|
+
当房间中的某个用户使用 sendSEIMsg 借助视频数据帧发送 SEI 消息时,房间中的其他用户可以通过 `onRecvSEIMsg` 事件回调接收到该条消息。
|
|
821
789
|
|
|
822
790
|
|参数|描述|
|
|
823
791
|
|---------|---------|
|
|
@@ -863,7 +831,6 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
|
|
|
863
831
|
|
|
864
832
|
> **注意**
|
|
865
833
|
>
|
|
866
|
-
|
|
867
834
|
> 当您收到成功的事件回调时,只是说明您的发布指令已经同步到腾讯云后台服务器,但如果目标 CDN 厂商的服务器不接收该条视频流,依然可能导致发布失败。
|
|
868
835
|
>
|
|
869
836
|
|
|
@@ -1023,14 +990,13 @@ SDK 可以评估每一路音频的音量大小,并每隔一段时间抛出该
|
|
|
1023
990
|
|data|截图数据,为 nullptr 表示截图失败。|
|
|
1024
991
|
|format|截图数据格式,目前只支持 TRTCVideoPixelFormat_BGRA32。|
|
|
1025
992
|
|height|截图画面的高度。|
|
|
1026
|
-
|length|截图数据长度,对于BGRA32
|
|
993
|
+
|length|截图数据长度,对于BGRA32而言, `length = width * height * 4` 。|
|
|
1027
994
|
|type|视频流类型。|
|
|
1028
995
|
|userId|用户标识,如果 userId 为空字符串,则代表截取的是本地画面。|
|
|
1029
996
|
|width|截图画面的宽度。|
|
|
1030
997
|
|
|
1031
998
|
> **注意**
|
|
1032
999
|
>
|
|
1033
|
-
|
|
1034
1000
|
> 全平台 C++ 接口和 Java 接口在参数上是不一样的,C++ 接口用 7 个参数描述一个截图画面,Java 接口只用一个 Bitmap 描述一个截图画面。
|
|
1035
1001
|
>
|
|
1036
1002
|
|