@tencentcloud/sdk-mcp 1.6.7 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +25 -0
- package/README.md +54 -35
- package/knowledge/build-index.js +32 -5
- package/knowledge/chunker.js +82 -14
- package/knowledge/chunking-policy.js +100 -0
- package/knowledge/content-loader.js +3 -1
- package/knowledge/frontmatter-meta.js +167 -0
- package/knowledge/path-meta.js +28 -6
- package/knowledge/search/exact-lookup.js +26 -123
- package/knowledge/search/filter-pool.js +17 -26
- package/knowledge/search/framework-fallback.js +22 -0
- package/knowledge/search/intent-router.js +13 -0
- package/knowledge/search/query-normalizer.js +129 -0
- package/knowledge/search/search-core.js +391 -0
- package/knowledge/search/search-knowledge.js +351 -323
- package/knowledge/search/search-message.js +87 -0
- package/knowledge/search/search-pass.js +428 -0
- package/knowledge/search/search-types.js +1 -0
- package/knowledge/search/url-row-scorer.js +258 -0
- package/package.json +1 -1
- package/resource/_schema/feature-aliases.yaml +1 -0
- package/resource/_schema/query-normalization.yaml +9 -0
- package/resource/index/manifest.json +1 -1
- package/resource/integration/callkit/preset/android/integration.md +0 -14
- package/resource/integration/callkit/preset/flutter/integration.md +0 -9
- package/resource/integration/callkit/preset/ios/integration.md +2 -14
- package/resource/integration/callkit/preset/react/integration.md +0 -21
- package/resource/integration/callkit/preset/vue/integration.md +0 -27
- package/resource/integration/chat/preset/android/integration.md +3 -10
- package/resource/integration/chat/preset/flutter/integration.md +12 -13
- package/resource/integration/chat/preset/ios/integration.md +9 -16
- package/resource/integration/chat/preset/react/integration.md +1 -9
- package/resource/integration/chat/preset/uni-app/integration.md +0 -9
- package/resource/integration/chat/preset/vue/integration.md +3 -13
- package/resource/integration/livekit/preset/live/android/live-host-integration.md +0 -4
- package/resource/integration/livekit/preset/live/android/prepare-integration.md +8 -21
- package/resource/integration/livekit/preset/live/ios/live-audience-integration.md +0 -1
- package/resource/integration/livekit/preset/live/ios/live-host-integration.md +0 -5
- package/resource/integration/livekit/preset/live/ios/live-list-integration.md +0 -4
- package/resource/integration/livekit/preset/live/ios/prepare-integration.md +0 -9
- package/resource/integration/livekit/preset/live/vue/live-list-integration.md +1 -5
- package/resource/integration/livekit/preset/live/vue/live-player-desk-integration.md +38 -147
- package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +1 -6
- package/resource/integration/livekit/preset/live/vue/live-pusher-integration.md +432 -286
- package/resource/integration/roomkit/preset/vue/integration.md +11 -24
- package/resource/knowledge/callkit/best-practice/callkit-miniprogram/uniapp-shrink.md +64 -0
- package/resource/knowledge/callkit/best-practice/common/call-autoplay-blocked.md +81 -0
- package/resource/knowledge/callkit/best-practice/common/call-message-in-chat.md +84 -0
- package/resource/knowledge/callkit/best-practice/common/call-vs-calls.md +114 -0
- package/resource/knowledge/callkit/best-practice/common/callengine-call-flow.md +128 -0
- package/resource/knowledge/callkit/best-practice/common/callengine-log-level.md +72 -0
- package/resource/knowledge/callkit/best-practice/common/callkit-get-engine-instance.md +87 -0
- package/resource/knowledge/callkit/best-practice/common/callkit-get-roomid.md +83 -0
- package/resource/knowledge/callkit/best-practice/common/callkit-limitations.md +37 -0
- package/resource/knowledge/callkit/best-practice/common/callkit-user-register-and-kicked.md +103 -0
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +1 -20
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +0 -12
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +1 -12
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +0 -19
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +0 -13
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +1 -17
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +0 -13
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +0 -13
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +0 -12
- package/resource/knowledge/callkit/core-sdk/miniprogram/call-engine.md +0 -1
- package/resource/knowledge/callkit/core-sdk/miniprogram/call-event.md +0 -2
- package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +0 -15
- package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +0 -15
- package/resource/knowledge/callkit/core-sdk/web/call-engine.md +0 -1
- package/resource/knowledge/callkit/core-sdk/web/call-event.md +0 -1
- package/resource/knowledge/callkit/core-sdk/web/callengine-api-overview.md +0 -1
- package/resource/knowledge/callkit/faq/android.md +5 -15
- package/resource/knowledge/callkit/faq/common.md +0 -1
- package/resource/knowledge/callkit/faq/ios.md +1 -4
- package/resource/knowledge/callkit/faq/uniapp-app.md +0 -2
- package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +0 -5
- package/resource/knowledge/callkit/faq/web.md +1 -5
- package/resource/knowledge/callkit/preset/android/api.md +0 -6
- package/resource/knowledge/callkit/preset/ios/api.md +0 -4
- package/resource/knowledge/callkit/preset/miniprogram/api.md +0 -2
- package/resource/knowledge/callkit/preset/react/api.md +3 -154
- package/resource/knowledge/callkit/preset/vue/api.md +3 -42
- package/resource/knowledge/chat/best-practice/common/avchatroom-message-loss-diagnosis.md +71 -0
- package/resource/knowledge/chat/best-practice/common/group-conversation-cleanup-on-system-notice.md +67 -0
- package/resource/knowledge/chat/best-practice/common/image-message-url-lifecycle.md +63 -0
- package/resource/knowledge/chat/best-practice/common/login-repeat-2025-diagnosis.md +65 -0
- package/resource/knowledge/chat/best-practice/common/message-read-report-and-receipt.md +72 -0
- package/resource/knowledge/chat/best-practice/common/message-receive-event.md +70 -0
- package/resource/knowledge/chat/best-practice/common/message-risk-error-and-render.md +69 -0
- package/resource/knowledge/chat/best-practice/common/message-unread-count.md +71 -0
- package/resource/knowledge/chat/best-practice/miniprogram/audio-message-send.md +118 -0
- package/resource/knowledge/chat/best-practice/miniprogram/login-timeout-2801-diagnosis.md +67 -0
- package/resource/knowledge/chat/best-practice/miniprogram/media-upload-fail-diagnosis.md +68 -0
- package/resource/knowledge/chat/best-practice/web/audio-message-send.md +123 -0
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +1 -4
- package/resource/knowledge/chat/preset/android/features/contact-list.md +0 -5
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +1 -9
- package/resource/knowledge/chat/preset/android/features/language.md +1 -11
- package/resource/knowledge/chat/preset/android/features/message-input.md +1 -8
- package/resource/knowledge/chat/preset/android/features/message-list.md +1 -10
- package/resource/knowledge/chat/preset/android/features/search.md +0 -7
- package/resource/knowledge/chat/preset/android/features/theme.md +0 -6
- package/resource/knowledge/chat/preset/android-view/integration.md +3 -5
- package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +1 -4
- package/resource/knowledge/chat/preset/flutter/features/contact-list.md +1 -6
- package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +1 -9
- package/resource/knowledge/chat/preset/flutter/features/language.md +0 -3
- package/resource/knowledge/chat/preset/flutter/features/message-input.md +1 -8
- package/resource/knowledge/chat/preset/flutter/features/message-list.md +1 -10
- package/resource/knowledge/chat/preset/flutter/features/search.md +0 -7
- package/resource/knowledge/chat/preset/flutter/features/theme.md +0 -6
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +1 -4
- package/resource/knowledge/chat/preset/ios/features/contact-list.md +1 -8
- package/resource/knowledge/chat/preset/ios/features/conversation-list.md +1 -9
- package/resource/knowledge/chat/preset/ios/features/language.md +0 -11
- package/resource/knowledge/chat/preset/ios/features/message-input.md +1 -8
- package/resource/knowledge/chat/preset/ios/features/message-list.md +1 -10
- package/resource/knowledge/chat/preset/ios/features/search.md +0 -5
- package/resource/knowledge/chat/preset/ios/features/theme.md +0 -6
- package/resource/knowledge/chat/preset/ios-uikit/integration.md +5 -17
- package/resource/knowledge/chat/preset/react/features/chat-setting.md +0 -2
- package/resource/knowledge/chat/preset/react/features/contact-list.md +0 -23
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +2 -11
- package/resource/knowledge/chat/preset/react/features/conversation-list.md +2 -23
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +0 -5
- package/resource/knowledge/chat/preset/react/features/search.md +0 -1
- package/resource/knowledge/chat/preset/vue/features/chat-header.md +1 -3
- package/resource/knowledge/chat/preset/vue/features/chat-setting.md +3 -5
- package/resource/knowledge/chat/preset/vue/features/contact-list.md +3 -9
- package/resource/knowledge/chat/preset/vue/features/conversation-actions.md +0 -3
- package/resource/knowledge/chat/preset/vue/features/conversation-list.md +2 -13
- package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +2 -5
- package/resource/knowledge/chat/preset/vue/features/conversation-search.md +1 -0
- package/resource/knowledge/chat/preset/vue/features/message-input.md +2 -4
- package/resource/knowledge/chat/preset/vue/features/message-list.md +2 -4
- package/resource/knowledge/chat/preset/vue/features/search.md +4 -1
- package/resource/knowledge/chat/preset/vue/features/theme.md +4 -6
- package/resource/knowledge/chat/urls/sdk/web.md +1 -1
- package/resource/knowledge/livekit/best-practice/android/voice-room-anchor-start.md +124 -0
- package/resource/knowledge/livekit/best-practice/common/admin-take-seat.md +73 -0
- package/resource/knowledge/livekit/best-practice/common/audience-leave-live.md +81 -0
- package/resource/knowledge/livekit/best-practice/common/voice-room-no-audio-troubleshoot.md +100 -0
- package/resource/knowledge/livekit/best-practice/common/voice-room-seat-list-change.md +65 -0
- package/resource/knowledge/livekit/best-practice/flutter/voice-room-anchor-start.md +126 -0
- package/resource/knowledge/livekit/best-practice/ios/voice-room-anchor-start.md +130 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +0 -3
- 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 +0 -2
- 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 +0 -2
- 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 +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +0 -3
- 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 +0 -2
- 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 +0 -2
- 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 +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +0 -3
- 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 +0 -2
- 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 +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +1 -3
- package/resource/knowledge/livekit/core-sdk/features/android/audience-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/android/audio-effect.md +1 -3
- package/resource/knowledge/livekit/core-sdk/features/android/barrage.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/android/base-beauty.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/android/gift.md +2 -7
- package/resource/knowledge/livekit/core-sdk/features/android/live-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/audience-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/audio-effect.md +0 -4
- package/resource/knowledge/livekit/core-sdk/features/flutter/barrage.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/base-beauty.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/gift.md +3 -7
- package/resource/knowledge/livekit/core-sdk/features/flutter/live-list.md +3 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/audience-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/audio-effect.md +1 -3
- package/resource/knowledge/livekit/core-sdk/features/ios/barrage.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/base-beauty.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/gift.md +2 -7
- package/resource/knowledge/livekit/core-sdk/features/ios/live-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/uni-app/audience-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/uni-app/audio-effect.md +1 -2
- package/resource/knowledge/livekit/core-sdk/features/uni-app/barrage.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/uni-app/base-beauty.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/uni-app/gift.md +4 -8
- package/resource/knowledge/livekit/core-sdk/features/uni-app/live-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/live/android/co-guest-interaction.md +0 -3
- package/resource/knowledge/livekit/core-sdk/live/android/host-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/live/android/integration.md +0 -7
- package/resource/knowledge/livekit/core-sdk/live/flutter/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/live/flutter/host-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/live/flutter/integration.md +1 -7
- package/resource/knowledge/livekit/core-sdk/live/ios/co-guest-interaction.md +0 -3
- package/resource/knowledge/livekit/core-sdk/live/ios/host-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/live/ios/integration.md +0 -7
- package/resource/knowledge/livekit/core-sdk/live/uni-app/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/live/uni-app/host-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/live/uni-app/integration.md +0 -5
- package/resource/knowledge/livekit/core-sdk/voice/android/co-guest-interaction.md +1 -3
- package/resource/knowledge/livekit/core-sdk/voice/android/host-interaction.md +4 -13
- package/resource/knowledge/livekit/core-sdk/voice/android/integration.md +5 -5
- package/resource/knowledge/livekit/core-sdk/voice/flutter/co-guest-interaction.md +0 -3
- package/resource/knowledge/livekit/core-sdk/voice/flutter/integration.md +18 -21
- package/resource/knowledge/livekit/core-sdk/voice/ios/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/voice/ios/host-interaction.md +2 -11
- package/resource/knowledge/livekit/core-sdk/voice/ios/integration.md +8 -8
- package/resource/knowledge/livekit/core-sdk/voice/uni-app/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/voice/uni-app/integration.md +1 -4
- package/resource/knowledge/livekit/faq/error-code.md +1 -1
- package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +0 -5
- 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 +0 -3
- package/resource/knowledge/push/api-reference/donut.md +1 -6
- package/resource/knowledge/push/api-reference/harmonyos.md +0 -2
- package/resource/knowledge/push/api-reference/react-native.md +0 -3
- package/resource/knowledge/push/api-reference/uni-app.md +3 -5
- package/resource/knowledge/push/api-reference/unity.md +0 -1
- package/resource/knowledge/push/api-reference/unreal-engine.md +0 -1
- package/resource/knowledge/push/config/android/fcm.md +0 -6
- package/resource/knowledge/push/config/android/honor.md +1 -7
- package/resource/knowledge/push/config/android/huawei.md +1 -9
- package/resource/knowledge/push/config/android/meizu.md +1 -7
- package/resource/knowledge/push/config/android/oppo.md +1 -3
- package/resource/knowledge/push/config/android/vivo.md +1 -12
- package/resource/knowledge/push/config/android/xiaomi.md +0 -5
- package/resource/knowledge/push/config/donut.md +0 -12
- package/resource/knowledge/push/config/harmonyos.md +18 -7
- package/resource/knowledge/push/config/ios.md +26 -33
- package/resource/knowledge/push/config/react-native.md +0 -30
- package/resource/knowledge/push/config/unity.md +0 -30
- package/resource/knowledge/push/config/unreal-engine.md +0 -30
- package/resource/knowledge/push/integration/android.md +148 -57
- package/resource/knowledge/push/integration/donut.md +5 -21
- package/resource/knowledge/push/integration/flutter.md +4 -6
- package/resource/knowledge/push/integration/harmonyos.md +17 -16
- package/resource/knowledge/push/integration/ios.md +30 -18
- package/resource/knowledge/push/integration/react-native.md +10 -60
- package/resource/knowledge/push/integration/uni-app.md +3 -25
- package/resource/knowledge/push/integration/unity.md +8 -77
- package/resource/knowledge/push/integration/unreal-engine.md +37 -96
- package/resource/knowledge/roomkit/best-practice/common/room-ghost-member.md +75 -0
- package/resource/knowledge/roomkit/best-practice/common/room-limit-and-multi.md +88 -0
- package/resource/knowledge/roomkit/best-practice/common/room-screen-share-preview.md +87 -0
- package/resource/knowledge/roomkit/best-practice/common/room-status-after-all-leave.md +73 -0
- package/resource/knowledge/roomkit/best-practice/vue/room-uikit-vs-atomicx.md +115 -0
- package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/android/room-state.md +3 -5
- package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md +4 -6
- package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/flutter/room-state.md +2 -4
- package/resource/knowledge/roomkit/core-sdk/flutter/schedule-room.md +4 -6
- package/resource/knowledge/roomkit/core-sdk/ios/call-user-to-room.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +3 -5
- package/resource/knowledge/roomkit/core-sdk/ios/schedule-room.md +4 -6
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +0 -5
- package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +0 -3
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +0 -5
- package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +0 -3
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +1 -7
- package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +1 -2
- package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +0 -1
- package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +0 -3
- package/resource/knowledge/roomkit/preset/android/integration.md +202 -6
- package/resource/knowledge/roomkit/preset/flutter/integration.md +1 -16
- package/resource/knowledge/roomkit/preset/ios/integration.md +201 -7
- package/resource/knowledge/roomkit/preset/react/integration.md +205 -4
- package/resource/knowledge/rtcengine/web/api.md +0 -2
- package/resource/knowledge/rtcengine/web/plugin/22-advanced-audio-mixer.md +2 -2
- package/resource/knowledge/rtcengine/web/plugin/23-advanced-support-detection.md +3 -3
- package/resource/knowledge/rtcengine/web/plugin/28-advanced-beauty.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/30-advanced-cross-room-link.md +2 -0
- package/resource/knowledge/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -4
- package/resource/knowledge/rtcengine/web/plugin/39-advanced-video-decoder.md +2 -0
- package/resource/knowledge/share/userSig.md +2 -2
- package/resource/knowledge/trtc/android/TRTCCloud.md +16 -16
- package/resource/knowledge/trtc/android/TRTCCloudDef.md +5 -5
- package/resource/knowledge/trtc/android/TRTCCloudListener.md +3 -3
- package/resource/knowledge/trtc/android/TXAudioEffectManager.md +2 -2
- package/resource/knowledge/trtc/android/TXDeviceManager.md +1 -1
- package/resource/knowledge/trtc/c++/ITRTCCloud.md +14 -14
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +2 -2
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +4 -4
- package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +3 -3
- package/resource/knowledge/trtc/c++/TRTCTypeDef.md +5 -5
- package/resource/knowledge/trtc/ios/TRTCCloud.md +14 -14
- package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +3 -3
- package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +2 -2
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +4 -4
- package/resource/knowledge/trtc/ios/TXLiveSDKTypeDef.md +5 -5
- package/server.js +8 -3
- package/tools/common/finalize_answer.js +9 -1
- package/tools/common/search_trtc_knowledge.js +3 -1
- package/tools/definitions/finalize_answer_def.js +2 -2
- package/tools/definitions/integration-boundary.js +2 -1
- package/tools/definitions/search_trtc_knowledge_def.js +2 -1
- package/utils/report-cls-client.js +3 -3
- package/utils/report-es-client.js +1 -1
- package/cursor-setting.png +0 -0
- package/mcp-server-prompt.png +0 -0
- package/resource/knowledge/callkit/best-practice/web/callengine-invitation.md +0 -80
- package/resource/knowledge/callkit/best-practice/web/callengine-log-control.md +0 -20
- package/resource/knowledge/callkit/best-practice/web/callkit-call-vs-calls.md +0 -116
- package/resource/knowledge/callkit/preset/react/uikit-api-reference.md +0 -475
- package/resource/knowledge/callkit/preset/vue/uikit-api-reference.md +0 -587
- package/resource/knowledge/callkit/preset/web/api.md +0 -79
- package/resource/knowledge/chat/best-practice/web/image-message-url-handling.md +0 -16
|
@@ -181,13 +181,12 @@
|
|
|
181
181
|
<div class="vsdk-text">
|
|
182
182
|
|
|
183
183
|
<div class="vsdk-title">
|
|
184
|
-
|
|
185
|
-
<span class="vsdk-badge"
|
|
184
|
+
有接入卡点?30 秒反馈
|
|
185
|
+
<span class="vsdk-badge">全部选填</span>
|
|
186
186
|
</div>
|
|
187
187
|
|
|
188
188
|
<div class="vsdk-desc">
|
|
189
|
-
|
|
190
|
-
您的反馈将帮助我们持续优化产品,并优先邀请有相关需求的用户参与新功能内测。
|
|
189
|
+
正在了解或评估视频会议 SDK?UI、功能、文档或套餐开通如有卡点,欢迎填写反馈。
|
|
191
190
|
</div>
|
|
192
191
|
|
|
193
192
|
</div>
|
|
@@ -195,8 +194,8 @@
|
|
|
195
194
|
</div>
|
|
196
195
|
|
|
197
196
|
<div class="vsdk-card-right">
|
|
198
|
-
<a class="vsdk-cta" href="https://wj.qq.com/s2/
|
|
199
|
-
|
|
197
|
+
<a class="vsdk-cta" href="https://wj.qq.com/s2/27395009/ac34/" target="_blank">
|
|
198
|
+
填写反馈
|
|
200
199
|
</a>
|
|
201
200
|
</div>
|
|
202
201
|
|
|
@@ -269,8 +268,8 @@ yarn add @tencentcloud/roomkit-web-vue3 tuikit-atomicx-vue3 @tencentcloud/uikit-
|
|
|
269
268
|
<ConferenceMainViewH5 v-else-if="inRoom" />
|
|
270
269
|
<div v-else class="entry">
|
|
271
270
|
<TUIInput v-model="entry.userId" placeholder="请输入用户 ID" />
|
|
272
|
-
<TUIInput v-model="entry.userName" placeholder="
|
|
273
|
-
<TUIInput v-model="entry.roomId" placeholder="如
|
|
271
|
+
<TUIInput v-model="entry.userName" placeholder="请输入昵称, 非必填" />
|
|
272
|
+
<TUIInput v-model="entry.roomId" placeholder="请输入房间 ID, 如 room_123456" />
|
|
274
273
|
<TUIButton type="primary" :disabled="!entry.userId || !entry.roomId" @click="handleEnterRoom">进入会议</TUIButton>
|
|
275
274
|
</div>
|
|
276
275
|
</UIKitProvider>
|
|
@@ -348,14 +347,8 @@ yarn run dev
|
|
|
348
347
|
**验证多人会议:**建议打开两个浏览器标签页,分别模拟不同用户进入同一房间,验证音视频互通与会中功能。操作步骤如下:
|
|
349
348
|
|
|
350
349
|
**步骤1:**打开两个浏览器标签页,分别填写用户 ID `userA`、`userB` 及相同房间号 `room_123456`,点击 **进入会议**。`userA` 先进入时将自动创建房间并成为房主;`userB` 后进入时将作为参会者加入。
|
|
351
|
-
| 测试用户 A | 测试用户 B |
|
|
352
|
-
| --- | --- |
|
|
353
|
-
| | |
|
|
354
350
|
|
|
355
351
|
**步骤2:**测试用户均进入会中界面后,可在成员列表中互相看到对方;开启摄像头、麦克风,确认能否看到彼此的画面并听到声音。
|
|
356
|
-
| 测试用户 A | 测试用户 B |
|
|
357
|
-
| --- | --- |
|
|
358
|
-
| | |
|
|
359
352
|
|
|
360
353
|
**步骤3:**您还可以体验屏幕共享、聊天、成员管理等会中能力,确认多人场景下的基础功能正常。
|
|
361
354
|
|
|
@@ -363,11 +356,6 @@ yarn run dev
|
|
|
363
356
|
|
|
364
357
|
快速接入章节以一体化示例帮助您完成首次进房体验。若需将会议能力集成至实际业务,可按会议流程分步集成。本节依次介绍 SDK 依赖安装、TUIRoomKit 组件引用、登录鉴权、创建与加入会议、离开会议、监听会议状态等核心能力的用法。
|
|
365
358
|
|
|
366
|
-
> **推荐使用更高效的 AI 集成助手**
|
|
367
|
-
>
|
|
368
|
-
> 我们为您提供 AI 集成助手:描述业务需求即可自动生成集成代码;接入过程中遇到问题,也可向 AI 咨询答疑。点击这里,立即体验 AI 集成
|
|
369
|
-
>
|
|
370
|
-
|
|
371
359
|
### 步骤1:安装 SDK 依赖
|
|
372
360
|
|
|
373
361
|
在您的业务项目中安装 TUIRoomKit 及配套依赖包。
|
|
@@ -492,7 +480,7 @@ const startQuickMeeting = async () => {
|
|
|
492
480
|
|
|
493
481
|
**适用场景:**适用于需要在未来特定时间召开的会议(如团队周会、线上培训等)。用户可在客户端提前设定会议标题、时间及受邀参会成员。
|
|
494
482
|
|
|
495
|
-
**实现方式**:由客户端生成或向业务后台申请一个唯一的房间号,并配合会议时间等参数调用 `scheduleRoom`
|
|
483
|
+
**实现方式**:由客户端生成或向业务后台申请一个唯一的房间号,并配合会议时间等参数调用 `scheduleRoom` 接口提交预定。预定成功后,会议信息将同步至参与者的会议列表中。更多客户端预订会议能力。
|
|
496
484
|
``` typescript
|
|
497
485
|
import { useRoomState } from 'tuikit-atomicx-vue3/room';
|
|
498
486
|
|
|
@@ -643,7 +631,6 @@ const enterDualMeeting = async (bizOrderId: string) => {
|
|
|
643
631
|
```
|
|
644
632
|
|
|
645
633
|
> **说明:**
|
|
646
|
-
>
|
|
647
634
|
> `conference.createAndJoinRoom` 内部封装了“房间不存在则创建并成为房主,已存在则加入并成为参会者”的逻辑,适用于双方对等发起的进房场景。
|
|
648
635
|
>
|
|
649
636
|
|
|
@@ -733,7 +720,7 @@ onUnmounted(() => {
|
|
|
733
720
|
|
|
734
721
|
### 配置主题及语言
|
|
735
722
|
|
|
736
|
-
通过配置 `App.vue` 中 `UIKitProvider`
|
|
723
|
+
通过配置 `App.vue` 中 `UIKitProvider` 的入参,修改主题及语言的默认值。更多自定义主题及语言。
|
|
737
724
|
| <code>UIKitProvider</code> 参数 | 可选值 | 默认值 |
|
|
738
725
|
| --- | --- | --- |
|
|
739
726
|
| theme | "light" \\| "dark" | "light" |
|
|
@@ -786,7 +773,7 @@ conference.setFeatureConfig({ layoutTemplate: RoomLayoutTemplate.SidebarLayout }
|
|
|
786
773
|
conference.setFeatureConfig({ layoutTemplate: RoomLayoutTemplate.CinemaLayout });
|
|
787
774
|
```
|
|
788
775
|
|
|
789
|
-
TUIRoomKit
|
|
776
|
+
TUIRoomKit 默认内置以下视频流挂件,如您需要自定义视频流挂件。
|
|
790
777
|
|
|
791
778
|
## 常见问题
|
|
792
779
|
|
|
@@ -829,7 +816,7 @@ TUIRoomKit 默认内置以下视频流挂件,如您需要自定义视频流挂
|
|
|
829
816
|
|
|
830
817
|
### 是否支持设置内网代理?
|
|
831
818
|
|
|
832
|
-
|
|
819
|
+
支持。更多内网代理信息。
|
|
833
820
|
|
|
834
821
|
### 是否可以直接修改 TUIRoomKit 的底层源码?
|
|
835
822
|
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: uniapp 打包微信小程序 TUICallKit 体积裁剪方案
|
|
3
|
+
product: call
|
|
4
|
+
frameworks: [miniprogram]
|
|
5
|
+
scope: platform_specific
|
|
6
|
+
tags: [TUICallKit, uniapp, 小程序, 体积裁剪, 插件裁剪, 瘦身, 移除插件, GroupCallView]
|
|
7
|
+
version_range: ">=4.0.0"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# uniapp 打包微信小程序 TUICallKit 体积裁剪方案
|
|
11
|
+
|
|
12
|
+
## 1. 核心结论
|
|
13
|
+
|
|
14
|
+
- TUICallKit 默认包含完整插件,核心通话引擎(375 KB)和 1v1 通话(111 KB)为必选模块,不可裁剪。
|
|
15
|
+
- 铃声插件(23 KB)和多人通话插件(27 KB)可按需移除,移除后不影响单人通话功能。
|
|
16
|
+
- 通过删除插件注册代码和对应 pages 配置实现裁剪。
|
|
17
|
+
|
|
18
|
+
## 2. 字段语义对照
|
|
19
|
+
|
|
20
|
+
| 模块 | 大小 | 是否必选 | 移除方式 |
|
|
21
|
+
|---|---|---|---|
|
|
22
|
+
| 核心通话引擎 | 375 KB | 必选 | — |
|
|
23
|
+
| 1v1 单人通话 | 111 KB | 必选 | — |
|
|
24
|
+
| 铃声插件 | 23 KB | 可裁剪 | 删除 `this.registerPlugin(useRingPlugin())` |
|
|
25
|
+
| 多人通话插件 | 27 KB | 可裁剪 | 删除 `this.registerPlugin(useGroupCallPlugin())` + pages.json 中 `GroupCallView` 页面 |
|
|
26
|
+
|
|
27
|
+
## 3. 机制/时序
|
|
28
|
+
|
|
29
|
+
TUICallKit 初始化时通过 `registerPlugin` 注册各功能插件 -> 插件被注册后打包进小程序代码 -> 删除对应注册代码后,该插件不会打包 -> 小程序包体积相应减小。
|
|
30
|
+
|
|
31
|
+
## 4. 标准用法
|
|
32
|
+
|
|
33
|
+
1. 在 TUICallKit 初始化代码中找到插件注册部分。
|
|
34
|
+
2. 删除 `this.registerPlugin(useRingPlugin())` 移除铃声插件。
|
|
35
|
+
3. 删除 `this.registerPlugin(useGroupCallPlugin())` 移除多人通话插件,同步删除 `pages.json` 中的 `GroupCallView` 页面配置。
|
|
36
|
+
|
|
37
|
+
## 5. 结果判定
|
|
38
|
+
|
|
39
|
+
- 铃声插件移除后,通话中不再播放铃声提示,但通话功能不受影响。
|
|
40
|
+
- 多人通话插件移除后,无法发起和参与多人通话,单人通话正常。
|
|
41
|
+
- 小程序打包后体积减少约 50 KB。
|
|
42
|
+
- 功能正常:单人通话(发起、接听、挂断)完整可用。
|
|
43
|
+
|
|
44
|
+
## 6. 常见误区
|
|
45
|
+
|
|
46
|
+
- 误区 1:试图移除核心通话引擎或 1v1 模块(必选,移除后无法通话)。
|
|
47
|
+
- 误区 2:只删除插件注册代码,忘记同步删除 `pages.json` 中的 `GroupCallView` 页面配置,导致编译报错。
|
|
48
|
+
- 误区 3:认为裁剪后还能使用多人通话功能(移除多人通话插件后只能使用单人通话)。
|
|
49
|
+
|
|
50
|
+
## 7. 问题定义(检索辅助,极简)
|
|
51
|
+
|
|
52
|
+
uniapp 打包微信小程序时,TUICallKit 默认插件过多导致包体积大,希望按需移除不必要的功能模块。
|
|
53
|
+
|
|
54
|
+
## 8. 同义问法覆盖(检索召回,极简)
|
|
55
|
+
|
|
56
|
+
- TUICallKit 小程序怎么瘦身?
|
|
57
|
+
- uniapp TUICallKit 如何移除铃声插件?
|
|
58
|
+
- TUICallKit 多人通话怎么裁剪?
|
|
59
|
+
- 微信小程序 TUICallKit 包太大怎么优化?
|
|
60
|
+
- 删除 `GroupCallView` 后多人通话还能用吗?
|
|
61
|
+
|
|
62
|
+
## 9. 参考来源(可选)
|
|
63
|
+
|
|
64
|
+
- 微信小程序 TUICallKit(uniapp)文档:`https://cloud.tencent.com/document/product/647/78912#802b0c00-0ea7-4ca3-8892-62f47f06c92d`
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Web TUICallKit 弹出"恢复播放"弹窗的原因与处理
|
|
3
|
+
product: call
|
|
4
|
+
frameworks: [react, vue, web]
|
|
5
|
+
scope: platform_common
|
|
6
|
+
tags: [TUICallKit, 恢复播放, 自动播放, webview, autoplay, enableAutoPlayDialog, callExperimentalAPI, 无声, vue2.6, vue2.7, vue3]
|
|
7
|
+
version_range: ">=4.0.0"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Web TUICallKit 弹出"恢复播放"弹窗的原因与处理
|
|
11
|
+
|
|
12
|
+
## 1. 核心结论
|
|
13
|
+
|
|
14
|
+
- 浏览器限制自动播放:在用户与网页产生交互前禁止播放带声音的媒体,Web TUICallKit 检测到播放失败后弹出"恢复播放"弹窗,需用户点击"恢复"。
|
|
15
|
+
- 此问题多出现在 webview 中(如 App 内嵌 H5)。
|
|
16
|
+
- 不推荐关闭该弹窗,关闭后可能出现无声问题。如需关闭可通过 `callExperimentalAPI` 设置 `enableAutoPlayDialog: 0`。
|
|
17
|
+
|
|
18
|
+
## 2. 字段语义对照
|
|
19
|
+
|
|
20
|
+
| 字段/能力 | 作用 | 说明 |
|
|
21
|
+
|---|---|---|
|
|
22
|
+
| `enableAutoPlayDialog` | 自动播放弹窗开关 | `1` 开启(默认),`0` 关闭 |
|
|
23
|
+
| `callExperimentalAPI` | 调用实验性 API | 通过 TRTC 实例调用,用于设置 `enableAutoPlayDialog` |
|
|
24
|
+
| `getTUICallEngineInstance()` | 获取 TUICallEngine 实例 | 从 `TUICallKitAPI` 获取底层引擎 |
|
|
25
|
+
| `getTRTCCloudInstance()` | 获取 TRTC 实例 | 从 TUICallEngine 获取 TRTC 云实例 |
|
|
26
|
+
|
|
27
|
+
## 3. 机制/时序
|
|
28
|
+
|
|
29
|
+
用户进入通话页面 -> TUICallKit 尝试自动播放音频 -> 浏览器拦截自动播放 -> 播放失败 -> TUICallKit 弹出"恢复播放"弹窗 -> 用户点击"恢复" -> 音频正常播放。
|
|
30
|
+
|
|
31
|
+
webview 场景下,因宿主 App 对自动播放的限制更严格,此问题更容易出现。
|
|
32
|
+
|
|
33
|
+
## 4. 标准用法
|
|
34
|
+
|
|
35
|
+
不推荐关闭该弹窗。如业务场景确定需要关闭:
|
|
36
|
+
|
|
37
|
+
1. 从 `TUICallKitAPI` 获取 TUICallEngine 实例。
|
|
38
|
+
2. 从 TUICallEngine 获取 TRTC 云实例。
|
|
39
|
+
3. 通过 TRTC 实例的 `callExperimentalAPI` 设置 `enableAutoPlayDialog: 0`。
|
|
40
|
+
|
|
41
|
+
```javascript
|
|
42
|
+
// React: @trtc/calls-uikit-react
|
|
43
|
+
// Vue 3: @trtc/calls-uikit-vue
|
|
44
|
+
// Vue 2.7: @trtc/calls-uikit-vue2
|
|
45
|
+
// Vue 2.6: @trtc/calls-uikit-vue2.6 (API 一致,仅包名不同)
|
|
46
|
+
import { TUICallKitAPI } from "@trtc/calls-uikit-react";
|
|
47
|
+
|
|
48
|
+
const trtcCloudInstance = TUICallKitAPI?.getTUICallEngineInstance()?.getTRTCCloudInstance();
|
|
49
|
+
const params = {
|
|
50
|
+
api: 'enableAutoPlayDialog',
|
|
51
|
+
params: { enable: 0 },
|
|
52
|
+
};
|
|
53
|
+
trtcCloudInstance?.callExperimentalAPI(JSON.stringify(params));
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## 5. 结果判定
|
|
57
|
+
|
|
58
|
+
- 不关闭弹窗:通话时弹出"恢复播放"提示,用户点击后音频正常播放。
|
|
59
|
+
- 关闭弹窗:通话时不再弹出提示,音频在浏览器允许后自动播放(若仍被拦截则无声)。
|
|
60
|
+
|
|
61
|
+
## 6. 常见误区
|
|
62
|
+
|
|
63
|
+
- 误区 1:认为弹窗是 TUICallKit 的 bug(实际是浏览器自动播放限制策略)。
|
|
64
|
+
- 误区 2:直接关闭弹窗后期望所有场景都能正常播放(关闭弹窗不解除自动播放限制,无声问题仍可能发生)。
|
|
65
|
+
- 误区 3:在 TUICallKit 初始化前调用 `enableAutoPlayDialog`(需在获取到 TRTC 实例后调用)。
|
|
66
|
+
|
|
67
|
+
## 7. 问题定义(检索辅助,极简)
|
|
68
|
+
|
|
69
|
+
Web TUICallKit 通话时弹出"恢复播放"弹窗,用户需点击才能听到声音,如何解决及是否可关闭弹窗。
|
|
70
|
+
|
|
71
|
+
## 8. 同义问法覆盖(检索召回,极简)
|
|
72
|
+
|
|
73
|
+
- TUICallKit 通话没有声音怎么办?
|
|
74
|
+
- 为什么 TUICallKit 会弹出"恢复播放"提示?
|
|
75
|
+
- 如何关闭 TUICallKit 的自动播放弹窗?
|
|
76
|
+
- webview 中 TUICallKit 无声怎么处理?
|
|
77
|
+
- `enableAutoPlayDialog` 怎么设置?
|
|
78
|
+
|
|
79
|
+
## 9. 参考来源(可选)
|
|
80
|
+
|
|
81
|
+
- TUICallKit Web 自动播放说明:`https://cloud.tencent.com/document/product/647/78769#066739b9-fb33-4f11-a21c-66edd91be64a`
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 在无 UI Chat SDK 项目中集成 TUICallKit 时如何显示音视频通话消息
|
|
3
|
+
product: call
|
|
4
|
+
frameworks: [react, vue, miniprogram, android, ios, flutter, uni-app, web]
|
|
5
|
+
scope: platform_common
|
|
6
|
+
tags: [TUICallKit, call-message, custom message, actionType, cmd, call_end, 通话消息渲染]
|
|
7
|
+
version_range: ">=2.0.0"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# 在无 UI Chat SDK 项目中集成 TUICallKit 时如何显示音视频通话消息
|
|
11
|
+
|
|
12
|
+
## 1. 核心结论
|
|
13
|
+
|
|
14
|
+
- 通话消息是 TUICallKit 通话过程中由后台通过 Chat REST API 补发的自定义消息,各平台可通过 Chat SDK 的消息接收事件或拉取历史消息获取。
|
|
15
|
+
- 通话过程中的实时状态(振铃、接听、挂断)由 TUICallKit 的事件监听处理,不依赖 Chat 消息。
|
|
16
|
+
- 通过 `actionType` 判断通话结果类型(挂断/取消/拒绝/超时),通过 `cmd` 区分语音/视频/忙线。
|
|
17
|
+
- 通话时长从 `call_end` 字段获取,单位秒。
|
|
18
|
+
|
|
19
|
+
## 2. 字段语义对照
|
|
20
|
+
|
|
21
|
+
| 字段/能力 | 作用 | 说明 |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `actionType` | 通话事件类型 | 1=发起/挂断,2=取消,3=接听,4=拒绝,5=超时未接听 |
|
|
24
|
+
| `cmd` | 通话指令细分 | `videoCall` 视频通话、`audioCall` 语音通话、`hangup` 挂断、`line_busy` 忙线 |
|
|
25
|
+
| `call_end` | 通话时长 | `actionType=1` 且 `cmd=hangup` 时存在,单位秒 |
|
|
26
|
+
| `MESSAGE_RECEIVED` | 消息接收事件 | Chat SDK 统一事件,含通话自定义消息 |
|
|
27
|
+
| `getMessageList` | 拉取历史消息 | 进入会话后拉取,通话消息也在返回列表中 |
|
|
28
|
+
|
|
29
|
+
### actionType 与 cmd 对照表
|
|
30
|
+
|
|
31
|
+
| 场景 | actionType | cmd | 备注 |
|
|
32
|
+
|---|---|---|---|
|
|
33
|
+
| 发起通话 | 1 | `videoCall` 或 `audioCall` | 主叫发出 |
|
|
34
|
+
| 已接听 | 3 | — | 被叫接听后触发 |
|
|
35
|
+
| 通话已结束 | 1 | `hangup` | 有一方挂断;`call_end` 含通话时长 |
|
|
36
|
+
| 取消通话 | 2 | — | 主叫在接听前取消 |
|
|
37
|
+
| 拒绝通话 | 4 | — | 被叫主动拒绝 |
|
|
38
|
+
| 对端忙线 | 4 | `line_busy` | 被叫正在通话中 |
|
|
39
|
+
| 超时未接听 | 5 | — | 被叫在规定时间内未接听 |
|
|
40
|
+
|
|
41
|
+
## 3. 机制/时序
|
|
42
|
+
|
|
43
|
+
主叫发起通话 -> TUICallKit 通过信令通道(非 Chat 消息)建立通话连接 -> 通话过程中,每发生一次状态变化(取消/接听/拒绝/超时/挂断),TUICallKit 后台都会通过 REST API 向 Chat SDK 补发一条自定义消息 -> 双方通过 `MESSAGE_RECEIVED` 收到补发消息 -> 按 `actionType` 和 `cmd` 区分事件类型并更新 UI。
|
|
44
|
+
|
|
45
|
+
通话过程本身(发起、接听、取消、拒绝、超时)不依赖 Chat 自定义消息通知;Chat 消息仅用于通话结束后在会话中展示通话记录。
|
|
46
|
+
|
|
47
|
+
## 4. 标准用法
|
|
48
|
+
|
|
49
|
+
1. 通过 Chat SDK 获取补发的通话自定义消息(监听消息接收事件或拉取历史消息,接口名因平台而异,但语义一致)。
|
|
50
|
+
2. 读取 `message.actionType` 和 `message.cmd` 判断通话事件类型。
|
|
51
|
+
3. 通话挂断消息(`actionType=1, cmd=hangup`)读取 `message.call_end` 显示通话时长。
|
|
52
|
+
4. 其他 `actionType` 值用于判断通话未接通的原因(取消/拒绝/忙线/超时),更新 UI 展示。
|
|
53
|
+
|
|
54
|
+
## 5. 结果判定
|
|
55
|
+
|
|
56
|
+
- 通话各状态变化后,能通过 Chat SDK 收到补发的通话自定义消息。
|
|
57
|
+
- `actionType` 与 `cmd` 能正确反映通话状态变化。
|
|
58
|
+
- `call_end` 值准确反映通话实际时长。
|
|
59
|
+
- `actionType` 与 `cmd` 能正确反映通话状态变化。
|
|
60
|
+
- `call_end` 值准确反映通话实际时长。
|
|
61
|
+
|
|
62
|
+
## 6. 常见误区
|
|
63
|
+
|
|
64
|
+
- 误区 1:将通话消息当作普通自定义消息处理,没有读取 `actionType` 做状态区分。
|
|
65
|
+
- 误区 2:只处理 `MESSAGE_RECEIVED`,不处理 `getMessageList` 拉取的离线通话消息。
|
|
66
|
+
- 误区 3:通话时长从消息的 `timestamp` 差值计算(应直接从 `call_end` 字段读取)。
|
|
67
|
+
- 误区 4:未处理 `line_busy` 场景,导致忙线被当作普通拒绝。
|
|
68
|
+
|
|
69
|
+
## 7. 问题定义(检索辅助,极简)
|
|
70
|
+
|
|
71
|
+
在无 UI Chat SDK 项目中集成 TUICallKit,如何通过 Chat SDK 获取并渲染音视频通话消息(发起/接听/挂断/取消/拒绝/超时/忙线)。
|
|
72
|
+
|
|
73
|
+
## 8. 同义问法覆盖(检索召回,极简)
|
|
74
|
+
|
|
75
|
+
- TUICallKit 通话消息怎么解析?
|
|
76
|
+
- `actionType` 各值代表什么意思?
|
|
77
|
+
- 通话结束后怎么拿到通话时长?
|
|
78
|
+
- `MESSAGE_RECEIVED` 收到通话消息怎么区分是发起还是挂断?
|
|
79
|
+
- 如何判断被叫忙线?
|
|
80
|
+
- 小程序中通话消息和 Web 端解析方式一样吗?
|
|
81
|
+
|
|
82
|
+
## 9. 参考来源(可选)
|
|
83
|
+
|
|
84
|
+
- 音视频通话信令字段说明:`https://cloud.tencent.com/document/product/647/84363`
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: TUICallKit React/Vue 发起音视频通话:calls 与 call/groupCall 的区别与用法
|
|
3
|
+
product: call
|
|
4
|
+
frameworks: [react, vue, web]
|
|
5
|
+
scope: platform_common
|
|
6
|
+
tags: [call, calls, groupCall, userIDList, TUICallKit, init, v4.x, calls-uikit, vue2, vue2.6, vue2.7, vue3, call和calls区别, callMediaType, 参数1和2, 数字字面量, 通话类型, 枚举常量, 发起通话]
|
|
7
|
+
version_range: ">=4.0.0"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# TUICallKit React/Vue 发起音视频通话:calls 与 call/groupCall 的区别与用法
|
|
11
|
+
|
|
12
|
+
## 1. 核心结论
|
|
13
|
+
|
|
14
|
+
- TUICallKit React / Vue **v4.x 必须使用 `calls`** 发起单聊/多人通话。
|
|
15
|
+
- `call`、`groupCall` 在 v4.0.0 起已废弃。
|
|
16
|
+
- 发起通话前必须先完成 `init`,否则会出现调用失败或状态异常。
|
|
17
|
+
- `type` 推荐使用 `CallMediaType` 枚举常量,不建议继续使用数字字面量(1/2)作为主写法。
|
|
18
|
+
- `userIDList` 必须传数组(单聊也是传数组);需要和 Chat 群联动时再传 `chatGroupID`。
|
|
19
|
+
|
|
20
|
+
## 2. 字段语义对照
|
|
21
|
+
|
|
22
|
+
| 字段/能力 | 作用 | 说明 |
|
|
23
|
+
|---|---|---|
|
|
24
|
+
| `TUICallKitAPI` | v4.x 入口对象 | 从 `@trtc/calls-uikit-{react\|vue}` 引入,替代旧版 `TUICallKitServer` |
|
|
25
|
+
| `calls` | 发起通话(v4.x) | 单聊/多人通话统一入口,
|
|
26
|
+
| `call` / `groupCall` | 发起通话(旧版) | v4.0.0 前使用,v4.x 已废弃 |
|
|
27
|
+
| `CallMediaType` | 通话媒体类型枚举 | `AUDIO` 语音、`VIDEO` 视频 |
|
|
28
|
+
| `roomID` / `strRoomID` | 房间号 | 互斥,两者选一;不要混用 |
|
|
29
|
+
|
|
30
|
+
## 3. 机制/时序
|
|
31
|
+
|
|
32
|
+
初始化 -> 登录 -> 调用 `calls` 发起通话 -> 等待被叫接听 -> 通话建立 -> 通话结束。
|
|
33
|
+
|
|
34
|
+
v4.x 新项目直接从 `calls` 开始;旧项目迁移时需将 `call`/`groupCall` 替换为 `calls`,并将 `TUICallKitServer` 替换为 `TUICallKitAPI`。
|
|
35
|
+
|
|
36
|
+
## 4. 标准用法
|
|
37
|
+
|
|
38
|
+
1. 从对应平台的包引入 `TUICallKitAPI`。
|
|
39
|
+
2. 调用 `TUICallKitAPI.init({ SDKAppID, userID, userSig })` 完成初始化。
|
|
40
|
+
3. 调用 `TUICallKitAPI.calls({ userIDList, type })` 发起通话。
|
|
41
|
+
4. 在 `catch` 分支处理通话发起失败的情况。
|
|
42
|
+
|
|
43
|
+
```javascript
|
|
44
|
+
// React: @trtc/calls-uikit-react
|
|
45
|
+
// Vue 3: @trtc/calls-uikit-vue
|
|
46
|
+
// Vue 2.7: @trtc/calls-uikit-vue2
|
|
47
|
+
// Vue 2.6: @trtc/calls-uikit-vue2.6 (API 一致,仅包名不同)
|
|
48
|
+
import { TUICallKitAPI } from "@trtc/calls-uikit-react";
|
|
49
|
+
|
|
50
|
+
// 1. 初始化
|
|
51
|
+
TUICallKitAPI.init({ SDKAppID, userID, userSig });
|
|
52
|
+
|
|
53
|
+
// 2. 发起通话(单聊或多人)
|
|
54
|
+
try {
|
|
55
|
+
await TUICallKitAPI.calls({
|
|
56
|
+
userIDList: ['jack', 'tom'],
|
|
57
|
+
type: CallMediaType.VIDEO_CALL
|
|
58
|
+
});
|
|
59
|
+
} catch (error: any) {
|
|
60
|
+
console.error(`[TUICallKit] Failed to call. Reason:${error}`);
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
`calls` 参数说明:
|
|
65
|
+
|
|
66
|
+
| 参数 | 类型 | 是否必填 | 含义 |
|
|
67
|
+
|---|---|---|---|
|
|
68
|
+
| userIDList | Array\<String\> | 是 | 被呼叫的用户列表 |
|
|
69
|
+
| type | CallMediaType | 是 | 通话的媒体类型(`AUDIO`/`VIDEO`) |
|
|
70
|
+
| chatGroupID | String | 否 | Chat 群组 ID |
|
|
71
|
+
| roomID | Number | 否 | 数字房间号,范围 [1, 2147483647] |
|
|
72
|
+
| strRoomID | String | 否 | 字符串房间号。与 roomID 互斥,两者都填时优先 roomID |
|
|
73
|
+
| timeout | Number | 否 | 通话超时时间,默认 30s,范围 10s-600s |
|
|
74
|
+
| userData | String | 否 | 自定义扩展字段,被叫可在 `ON_CALL_RECEIVED` 中获取 |
|
|
75
|
+
| offlinePushInfo | Object | 否 | 自定义离线消息推送参数 |
|
|
76
|
+
|
|
77
|
+
CallMediaType 取值:
|
|
78
|
+
|
|
79
|
+
| CallMediaType 类型 | 常量值 | 描述 |
|
|
80
|
+
|---|---|---|
|
|
81
|
+
| `CallMediaType.AUDIO` | 1 | 语音通话 |
|
|
82
|
+
| `CallMediaType.VIDEO` | 2 | 视频通话 |
|
|
83
|
+
|
|
84
|
+
## 5. 结果判定
|
|
85
|
+
|
|
86
|
+
- `TUICallKitAPI.calls` 调用成功后,被叫用户能收到通话邀请。
|
|
87
|
+
- 被叫接听后通话建立,双方可正常音视频通话。
|
|
88
|
+
- 通话超时或被叫拒绝时,`catch` 分支能收到明确错误信息。
|
|
89
|
+
|
|
90
|
+
## 6. 常见误区
|
|
91
|
+
|
|
92
|
+
- 误区 1:在 v4.x 里继续调用 `call` / `groupCall`(已废弃,不会报错但功能不完整)。
|
|
93
|
+
- 误区 2:把单聊写成 `userID` 字段而不是 `userIDList`(v4.x 不再支持单字符串传参)。
|
|
94
|
+
- 误区 3:`roomID` 与 `strRoomID` 混用(两者互斥且不互通)。
|
|
95
|
+
- 误区 4:`type` 长期使用数字字面量(1/2)而非 `CallMediaType` 枚举常量。
|
|
96
|
+
|
|
97
|
+
## 7. 问题定义(检索辅助,极简)
|
|
98
|
+
|
|
99
|
+
TUICallKit React/Vue v4.x 用户询问如何发起音视频通话,以及 `calls` 与旧版 `call`/`groupCall` 的区别与迁移方式。
|
|
100
|
+
|
|
101
|
+
## 8. 同义问法覆盖(检索召回,极简)
|
|
102
|
+
|
|
103
|
+
- TUICallKit React/Vue 怎么发起通话?
|
|
104
|
+
- `calls` 和 `call` 有什么区别?
|
|
105
|
+
- v4.x 的 `userIDList` 参数怎么传?
|
|
106
|
+
- `CallMediaType` 和数字 1/2 可以混用吗?
|
|
107
|
+
- 旧项目从 `TUICallKitServer.call` 迁移到 `TUICallKitAPI.calls` 要注意什么?
|
|
108
|
+
- `call` 传入的 `type` 参数 1 和 2 分别代表什么?
|
|
109
|
+
- `callMediaType` 参数 1 和 2 代表语音还是视频?
|
|
110
|
+
- TUICallKit 通话类型数字 1 和 2 是什么意思?
|
|
111
|
+
|
|
112
|
+
## 9. 参考来源(可选)
|
|
113
|
+
|
|
114
|
+
- TUICallKit React/Vue:`https://cloud.tencent.com/document/product/647/81015`
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: TUICallEngine 通话邀请接收与发起流程
|
|
3
|
+
product: call
|
|
4
|
+
frameworks: [web, miniprogram]
|
|
5
|
+
scope: platform_common
|
|
6
|
+
tags: [TUICallEngine, ON_CALL_RECEIVED, calls, accept, reject, 通话邀请, call-engine-lite, userData, callMediaType]
|
|
7
|
+
version_range: ">=4.0.0"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# TUICallEngine 通话邀请接收与发起流程
|
|
11
|
+
|
|
12
|
+
## 1. 核心结论
|
|
13
|
+
|
|
14
|
+
- 接收通话邀请只监听 `TUICallEvent.ON_CALL_RECEIVED`,**不要监听 Chat SDK 的 `MESSAGE_RECEIVED` 自行解析通话邀请**。
|
|
15
|
+
- 发起通话使用 `TUICallEngine.calls()`,参数中 `userIDList` 传数组、`type` 传媒体类型。
|
|
16
|
+
- 收到邀请后用 `accept()` 接听或 `reject()` 拒绝,扩展信息通过 `userData` 字符串传递。
|
|
17
|
+
- Web 与小程序接口一致,仅包名不同(Web: `@trtc/call-engine-lite-js`,小程序: `@trtc/call-engine-lite-wx`)。
|
|
18
|
+
|
|
19
|
+
## 2. 字段语义对照
|
|
20
|
+
|
|
21
|
+
| 字段/能力 | 作用 | 说明 |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| `TUICallEvent.ON_CALL_RECEIVED` | 接收通话邀请事件 | 被叫收到来电时触发,不要从 Chat 自定义消息解析 |
|
|
24
|
+
| `calls({userIDList, type, ...})` | 发起通话 | 主叫调用,单聊/多人通话统一入口 |
|
|
25
|
+
| `accept()` | 接听通话 | 被叫在收到邀请后调用 |
|
|
26
|
+
| `reject()` | 拒绝通话 | 被叫在收到邀请后调用 |
|
|
27
|
+
| `userData` | 自定义扩展信息 | 主叫传入的字符串,被叫从 `ON_CALL_RECEIVED` 事件中读取 |
|
|
28
|
+
| `callMediaType` | 通话媒体类型 | `ON_CALL_RECEIVED` 事件中携带,1=语音、2=视频 |
|
|
29
|
+
| `inviteID` | 邀请 ID | 标识一次通话邀请,用于关联后续事件 |
|
|
30
|
+
| `callId` | 通话 ID | 本次通话的唯一标识 |
|
|
31
|
+
| `callRole` | 角色 | 主叫(`call`)/ 被叫(`called`) |
|
|
32
|
+
|
|
33
|
+
### ON_CALL_RECEIVED 事件字段
|
|
34
|
+
|
|
35
|
+
| 参数 | 类型 | 含义 |
|
|
36
|
+
|---|---|---|
|
|
37
|
+
| callerId | String | 邀请者 |
|
|
38
|
+
| calleeIdList | Array\<String\> | 同时还被邀请的人 |
|
|
39
|
+
| isFromGroup | Boolean | 是否是群组通话 |
|
|
40
|
+
| inviteData | Object | 呼叫数据 |
|
|
41
|
+
| inviteID | String | 邀请 ID |
|
|
42
|
+
| userData | String | 扩展字段,主叫传入的自定义信息 |
|
|
43
|
+
| callId | String | 本次通话的唯一 ID |
|
|
44
|
+
| roomID | Number | 音视频房间 ID |
|
|
45
|
+
| callMediaType | Number | 通话媒体类型(1=语音,2=视频) |
|
|
46
|
+
| callRole | String | 角色:主叫/被叫 |
|
|
47
|
+
|
|
48
|
+
### calls 参数说明
|
|
49
|
+
|
|
50
|
+
| 参数 | 类型 | 是否必填 | 含义 |
|
|
51
|
+
|---|---|---|---|
|
|
52
|
+
| userIDList | Array\<String\> | 是 | 被呼叫的用户列表 |
|
|
53
|
+
| type | Number | 是 | 1=语音,2=视频(`CallMediaType`) |
|
|
54
|
+
| userData | String | 否 | 自定义扩展信息,被叫可从 `ON_CALL_RECEIVED` 读取 |
|
|
55
|
+
| timeout | Number | 否 | 超时时间(秒),默认 30 |
|
|
56
|
+
| roomID | Number | 否 | 数字房间号,范围 [1, 2147483647] |
|
|
57
|
+
| strRoomID | String | 否 | 字符串房间号,与 roomID 互斥 |
|
|
58
|
+
| chatGroupID | String | 否 | Chat 群组 ID,群聊中多人通话时填写 |
|
|
59
|
+
| offlinePushInfo | Object | 否 | 自定义离线消息推送参数 |
|
|
60
|
+
|
|
61
|
+
## 3. 机制/时序
|
|
62
|
+
|
|
63
|
+
主叫调用 `calls()` 发起邀请 -> SDK 通过信令通道发送邀请 -> 被叫触发 `ON_CALL_RECEIVED` -> 被叫调用 `accept()` 接听或 `reject()` 拒绝 -> 通话建立/结束。
|
|
64
|
+
|
|
65
|
+
通话过程中的实时状态变化通过 TUICallEngine 的事件监听处理,不依赖 Chat 消息。
|
|
66
|
+
|
|
67
|
+
## 4. 标准用法
|
|
68
|
+
|
|
69
|
+
1. 创建 `TUICallEngine` 实例并登录。
|
|
70
|
+
2. 主叫调用 `calls()` 发起通话邀请。
|
|
71
|
+
3. 被叫监听 `ON_CALL_RECEIVED` 事件,收到后调用 `accept()` 或 `reject()`。
|
|
72
|
+
4. 扩展信息通过 `userData` 字符串传递,被叫从事件中读取。
|
|
73
|
+
|
|
74
|
+
```javascript
|
|
75
|
+
// Web: @trtc/call-engine-lite-js
|
|
76
|
+
// 小程序: @trtc/call-engine-lite-wx (API 一致,仅包名不同)
|
|
77
|
+
import { TUICallEngine, TUICallEvent } from '@trtc/call-engine-lite-js';
|
|
78
|
+
|
|
79
|
+
// 创建实例并登录
|
|
80
|
+
const tuiCallEngine = TUICallEngine.createInstance({ SDKAppID: xxx, tim: timInstance });
|
|
81
|
+
await tuiCallEngine.login({ userID, userSig });
|
|
82
|
+
|
|
83
|
+
// 主叫:发起通话邀请
|
|
84
|
+
await tuiCallEngine.calls({
|
|
85
|
+
userIDList: ['user_bob'],
|
|
86
|
+
type: 2, // 1=语音 2=视频
|
|
87
|
+
userData: '{"ext":"info"}',
|
|
88
|
+
timeout: 30,
|
|
89
|
+
});
|
|
90
|
+
|
|
91
|
+
// 被叫:监听通话邀请
|
|
92
|
+
tuiCallEngine.on(TUICallEvent.ON_CALL_RECEIVED, (event) => {
|
|
93
|
+
console.log('来电', event);
|
|
94
|
+
// 展示接听 UI,随后调用 accept() 或 reject()
|
|
95
|
+
tuiCallEngine.accept({ inviteID: event.inviteID, roomID: event.roomID });
|
|
96
|
+
});
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## 5. 结果判定
|
|
100
|
+
|
|
101
|
+
- 主叫调用 `calls()` 后,被叫能收到 `ON_CALL_RECEIVED` 事件。
|
|
102
|
+
- 被叫调用 `accept()` 后通话建立,`reject()` 后通话被拒绝。
|
|
103
|
+
- `userData` 在主叫传入后,被叫能从事件中正确读取。
|
|
104
|
+
- 通话过程中的其他事件(接听、挂断、超时等)通过 TUICallEngine 的事件机制正常触发。
|
|
105
|
+
|
|
106
|
+
## 6. 常见误区
|
|
107
|
+
|
|
108
|
+
- 误区 1:监听 `MESSAGE_RECEIVED` 自行解析通话邀请(应使用 `ON_CALL_RECEIVED`)。
|
|
109
|
+
- 误区 2:使用 `businessID` / 底层 payload 格式等 SDK 内部字段(无官方公开文档,不要编造)。
|
|
110
|
+
- 误区 3:认为 `customData` 字段存在(v4.x 使用 `userData` 字符串传递自定义信息)。
|
|
111
|
+
|
|
112
|
+
## 7. 问题定义(检索辅助,极简)
|
|
113
|
+
|
|
114
|
+
TUICallEngine Web/小程序用户需要了解如何接收通话邀请、发起通话以及传递自定义扩展信息。
|
|
115
|
+
|
|
116
|
+
## 8. 同义问法覆盖(检索召回,极简)
|
|
117
|
+
|
|
118
|
+
- TUICallEngine 怎么接收通话邀请?
|
|
119
|
+
- TUICallEngine 怎么发起通话?
|
|
120
|
+
- `ON_CALL_RECEIVED` 各字段含义是什么?
|
|
121
|
+
- `calls` API 参数怎么填?
|
|
122
|
+
- TUICallEngine 如何传递自定义扩展信息?
|
|
123
|
+
- 小程序 TUICallEngine 通话邀请处理和 Web 端一样吗?
|
|
124
|
+
|
|
125
|
+
## 9. 参考来源(可选)
|
|
126
|
+
|
|
127
|
+
- Web TUICallEngine:`https://cloud.tencent.com/document/product/647/78757`
|
|
128
|
+
- 小程序 TUICallEngine:`https://cloud.tencent.com/document/product/647/78761`
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: TUICallEngine 设置日志输出级别
|
|
3
|
+
product: call
|
|
4
|
+
frameworks: [web, miniprogram]
|
|
5
|
+
scope: platform_common
|
|
6
|
+
tags: [TUICallEngine, setLogLevel, 日志级别, log level, 控制台日志, 关闭日志]
|
|
7
|
+
version_range: ">=4.0.0"
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# TUICallEngine 设置日志输出级别
|
|
11
|
+
|
|
12
|
+
## 1. 核心结论
|
|
13
|
+
|
|
14
|
+
- TUICallEngine 提供 `setLogLevel` 接口控制日志输出级别,创建实例后即可调用。
|
|
15
|
+
- 接入阶段建议设为级别 0(全量日志),正式上线后设为级别 1(默认,关键信息)或更高。
|
|
16
|
+
- 需要关闭日志时设为级别 4。
|
|
17
|
+
|
|
18
|
+
## 2. 字段语义对照
|
|
19
|
+
|
|
20
|
+
| 级别 | 值 | 说明 |
|
|
21
|
+
|---|---|---|
|
|
22
|
+
| 普通级别 | 0 | 日志量较多,接入调试时建议使用 |
|
|
23
|
+
| 主要级别 | 1 | SDK 输出关键信息,**默认日志等级** |
|
|
24
|
+
| 告警级别 | 2 | SDK 只输出告警和错误级别的日志 |
|
|
25
|
+
| 错误级别 | 3 | SDK 只输出错误级别的日志 |
|
|
26
|
+
| 无日志级别 | 4 | SDK 将不打印任何日志 |
|
|
27
|
+
|
|
28
|
+
## 3. 机制/时序
|
|
29
|
+
|
|
30
|
+
创建 `TUICallEngine` 实例 -> 调用 `setLogLevel` 设置日志级别 -> 后续 SDK 按指定级别输出日志。调用一次全局生效,无需重复设置。
|
|
31
|
+
|
|
32
|
+
## 4. 标准用法
|
|
33
|
+
|
|
34
|
+
1. 通过 `TUICallEngine.createInstance(options)` 创建引擎实例。
|
|
35
|
+
2. 调用 `tuiCallEngine.setLogLevel(level)` 设置日志级别。
|
|
36
|
+
3. 接入调试时使用级别 0,正式上线后根据需要调整为级别 1-4。
|
|
37
|
+
|
|
38
|
+
```javascript
|
|
39
|
+
import TUICallEngine from '@trtc/call-engine-lite-js'; // Web
|
|
40
|
+
// import TUICallEngine from '@trtc/call-engine-lite-wx'; // 小程序
|
|
41
|
+
|
|
42
|
+
const tuiCallEngine = TUICallEngine.createInstance({ SDKAppID: 0 });
|
|
43
|
+
tuiCallEngine.setLogLevel(0); // 接入调试:全量日志
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## 5. 结果判定
|
|
47
|
+
|
|
48
|
+
- 调用 `setLogLevel` 后,控制台日志量按目标级别输出。
|
|
49
|
+
- 级别 4 下 SDK 不再输出任何日志。
|
|
50
|
+
- 无需重启或重新初始化即可生效。
|
|
51
|
+
|
|
52
|
+
## 6. 常见误区
|
|
53
|
+
|
|
54
|
+
- 误区 1:认为 `setLogLevel` 需要在 `init` 之后才能调用(实际上创建实例后即可调用)。
|
|
55
|
+
- 误区 2:使用级别 4 后期望还能收到关键告警(级别 4 关闭所有日志)。
|
|
56
|
+
|
|
57
|
+
## 7. 问题定义(检索辅助,极简)
|
|
58
|
+
|
|
59
|
+
TUICallEngine 用户希望控制 SDK 日志输出量:接入时查看完整日志、上线后减少日志、或完全关闭日志输出。
|
|
60
|
+
|
|
61
|
+
## 8. 同义问法覆盖(检索召回,极简)
|
|
62
|
+
|
|
63
|
+
- TUICallEngine 怎么关闭日志?
|
|
64
|
+
- TUICallEngine 日志级别怎么设置?
|
|
65
|
+
- `setLogLevel` 各取值含义是什么?
|
|
66
|
+
- 接入阶段怎么查看 TUICallEngine 完整日志?
|
|
67
|
+
- 小程序 TUICallEngine 日志级别和 Web 端一样吗?
|
|
68
|
+
|
|
69
|
+
## 9. 参考来源(可选)
|
|
70
|
+
|
|
71
|
+
- Web `setLogLevel` 文档:`https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#setLogLevel`
|
|
72
|
+
- 小程序 `setLogLevel` 文档:`https://cloud.tencent.com/document/product/647/78761#setLogLevel`
|