@tencentcloud/sdk-mcp 1.6.3 → 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/index.js +0 -4
- 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-config.js +7 -4
- 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/is-valid-sdkappid.js +4 -0
- 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
|
@@ -2,13 +2,7 @@ TUIKit 是基于腾讯云 Chat SDK 的一款 React 组件库,它提供了一
|
|
|
2
2
|
|
|
3
3
|
> **AI 助手使用说明:**
|
|
4
4
|
>
|
|
5
|
-
>
|
|
6
|
-
|
|
7
|
-
> Skill 提供** IM 知识咨询**能力,您可以用 Skill 在 IDE 中直接查询 SDK、UIKit、服务端 API、产品计费等内容,[点击这里,立即体验 AI 咨询助手](https://cloud.tencent.com/document/product/269/125822)。
|
|
8
|
-
>
|
|
9
|
-
> - **AI 集成**
|
|
10
|
-
|
|
11
|
-
> MCP 提供全新的 AI 集成方式,只需要简单描述您的需求,即可**自动生成集成代码**,大幅提升开发效率,[点击这里,立即体验 AI 集成助手](https://cloud.tencent.com/document/product/269/124481)。
|
|
5
|
+
> MCP 提供了 **IM 知识咨询**和**含 UI 集成**的 AI 解决方案,您可以通过 MCP 查询 IM 相关的知识和集成 UIKit,[点击这里,立即体验 AI 助手](https://cloud.tencent.com/document/product/269/126983)。
|
|
12
6
|
>
|
|
13
7
|
|
|
14
8
|
## 关键概念
|
|
@@ -37,10 +31,32 @@ chat-uikit-react 主要分为 ConversationList、Chat、MessageList、ChatHeader
|
|
|
37
31
|
|
|
38
32
|
- TypeScript@^5.0.0
|
|
39
33
|
|
|
34
|
+
## 快速体验完整示例项目
|
|
35
|
+
|
|
36
|
+
如果您希望先快速跑通完整效果,或在接入过程中对照最终代码结构,可以直接克隆我们已经完成接入的示例项目。示例项目已完成 Chat UIKit 相关依赖安装、组件引入、初始化配置和基础页面接入,适合作为接入参考。
|
|
37
|
+
``` bash
|
|
38
|
+
git clone https://gitee.com/tencent-cloud-uikit/rtc-chat-web.git
|
|
39
|
+
cd chat-desktop-react
|
|
40
|
+
npm install
|
|
41
|
+
npm run dev
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
> **说明:**
|
|
45
|
+
>
|
|
46
|
+
> 示例项目地址:[点击查看 Gitee 示例项目](https://gitee.com/tencent-cloud-uikit/rtc-chat-web)。
|
|
47
|
+
>
|
|
48
|
+
> 示例项目用于帮助您快速体验和对照接入流程。若您需要在已有项目中集成,建议继续阅读下方步骤,按文档逐步完成接入。
|
|
49
|
+
>
|
|
50
|
+
|
|
40
51
|
## 创建项目
|
|
41
52
|
|
|
42
53
|
创建一个新的名为 **chat-integration-react** 的 React 项目,并按照脚手架的步骤提示完成项目的初始化。
|
|
43
54
|
|
|
55
|
+
> **注意:**
|
|
56
|
+
>
|
|
57
|
+
> 1. 建议使用 npm 进行安装,npm 会主动下载所需的 peerDependencies 依赖。
|
|
58
|
+
> 2. `npm create vite@latest` 会使用最新的 vite 版本,最新版本的 vite 可能会与低版本的 node.js 冲突,请检查您电脑上的相关环境配置。
|
|
59
|
+
|
|
44
60
|
【shell】
|
|
45
61
|
``` bash
|
|
46
62
|
npm create vite@latest
|
|
@@ -65,13 +81,7 @@ npm create vite@latest
|
|
|
65
81
|
|
|
66
82
|
### 步骤 1. 安装依赖
|
|
67
83
|
|
|
68
|
-
通过 npm 方式下载 [chat-uikit-react](https://www.npmjs.com/package/@tencentcloud/chat-uikit-react)
|
|
69
|
-
|
|
70
|
-
> **说明:**
|
|
71
|
-
>
|
|
72
|
-
|
|
73
|
-
> 建议使用 npm 进行安装,npm 会主动下载所需的 peerDependencies 依赖。
|
|
74
|
-
>
|
|
84
|
+
通过 npm 方式下载 [chat-uikit-react](https://www.npmjs.com/package/@tencentcloud/chat-uikit-react) 并在项目中使用(建议使用 npm 进行安装,npm 会主动下载所需的 peerDependencies 依赖)。
|
|
75
85
|
|
|
76
86
|
【shell】
|
|
77
87
|
``` bash
|
|
@@ -82,7 +92,6 @@ npm i @tencentcloud/chat-uikit-react
|
|
|
82
92
|
|
|
83
93
|
> **说明:**
|
|
84
94
|
>
|
|
85
|
-
|
|
86
95
|
> 以下代码中未填入 `SDKAppID`、`userID` 和 `userSig`,需在 步骤3 中获取相关信息后进行替换。
|
|
87
96
|
>
|
|
88
97
|
|
|
@@ -343,7 +352,6 @@ const { status } = useLoginState({
|
|
|
343
352
|
|
|
344
353
|
> **注意:**
|
|
345
354
|
>
|
|
346
|
-
|
|
347
355
|
> 本文示例代码采用从 [即时通信 IM 控制台](https://console.cloud.tencent.com/im) 获取 UserSig 的方案,**该方法仅适合本地跑通功能调试**。 正确的 UserSig 签发方式请参见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
|
|
348
356
|
>
|
|
349
357
|
|
|
@@ -351,7 +359,7 @@ const { status } = useLoginState({
|
|
|
351
359
|
|
|
352
360
|
- userID:单击 [即时通信 IM 控制台 > 消息服务 Chat > 账号管理](https://console.cloud.tencent.com/im/account-management),切换至目标应用所在账号,您可以创建 2~3 个账号用于体验单聊、群聊的功能。
|
|
353
361
|
|
|
354
|
-
- userSig:单击 [即时通信 IM 控制台 > 开发工具 > UserSig生成校验](https://console.cloud.tencent.com/im/tool-usersig),切换至目标应用所在账号,填写创建的 userID,即可生成 userSig。
|
|
362
|
+
- userSig:单击 [即时通信 IM 控制台 > 开发工具 > UserSig 生成校验](https://console.cloud.tencent.com/im/tool-usersig),切换至目标应用所在账号,填写创建的 userID,即可生成 userSig。
|
|
355
363
|
|
|
356
364
|
## 运行和测试
|
|
357
365
|
|
|
@@ -364,8 +372,8 @@ npm run dev
|
|
|
364
372
|
|
|
365
373
|
> **注意:**
|
|
366
374
|
>
|
|
367
|
-
> - 请确保 步骤3 代码中
|
|
368
|
-
> - userID 和 userSig
|
|
375
|
+
> - 请确保 步骤3 代码中 SDKAppID、userID 和 userSig 均已成功替换,如未替换将会导致项目表现异常。
|
|
376
|
+
> - userID 和 userSig 为一一对应关系,具体参见 生成 UserSig(用户鉴权)。
|
|
369
377
|
> - 如遇到项目启动失败,请检查 开发环境要求 是否满足。
|
|
370
378
|
|
|
371
379
|
## 集成更多高级特性
|
|
@@ -374,10 +382,8 @@ npm run dev
|
|
|
374
382
|
|
|
375
383
|
> **说明:**
|
|
376
384
|
>
|
|
377
|
-
|
|
378
385
|
> TUICallKit 是腾讯云推出一款音视频通话 UI 组件,通过集成该组件,您只需要编写几行代码就可以在聊天应用中体验音视频通话功能。
|
|
379
386
|
>
|
|
380
|
-
|
|
381
387
|
> 更多详细信息可参考:音视频通话-开通服务。
|
|
382
388
|
>
|
|
383
389
|
|
|
@@ -415,13 +421,10 @@ npm run dev
|
|
|
415
421
|
|
|
416
422
|
> **说明:**
|
|
417
423
|
>
|
|
418
|
-
|
|
419
424
|
> 搜索,在客服、社交、在线教育、在线医疗、OA 等场景下是刚需功能,可帮助用户快速查找群组、用户、消息,提升产品使用体验和用户粘性。
|
|
420
425
|
>
|
|
421
|
-
|
|
422
|
-
> 由于 Web 平台本地存储特殊性等原因,Vue **无法实现本地搜索**,为了更好的满足对于搜索能力的需求,推出了**云端搜索能力**。**云端搜索功能支持全局搜索和会话内搜索,同时支持搜索群组、用户和消息。**
|
|
426
|
+
> 由于 Web 平台本地存储特殊性等原因,Vue **无法实现本地搜索**,为了更好地满足对于搜索能力的需求,推出了**云端搜索能力**。**云端搜索功能支持全局搜索和会话内搜索,同时支持搜索群组、用户和消息。**
|
|
423
427
|
>
|
|
424
|
-
|
|
425
428
|
> 此功能属于增值服务,需要您购买云端搜索插件,请点击 [购买](https://console.cloud.tencent.com/im/plugin/TUICloudSearch)。
|
|
426
429
|
>
|
|
427
430
|
|
|
@@ -459,17 +462,16 @@ npm run dev
|
|
|
459
462
|
|
|
460
463
|
### 什么是 UserSig?如何生成 UserSig?
|
|
461
464
|
|
|
462
|
-
UserSig 是用户登录即时通信 IM 的密码,其本质是对 UserID 等信息加密后得到的密文。UserSig
|
|
465
|
+
UserSig 是用户登录即时通信 IM 的密码,其本质是对 UserID 等信息加密后得到的密文。UserSig 的签发方式是需将 UserSig 的计算代码集成到您的服务端,并提供面向项目的接口,在需要 UserSig 时由您的项目向业务服务器发起请求获取动态 UserSig。更多详情请参见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
|
|
463
466
|
|
|
464
467
|
> **注意:**
|
|
465
468
|
>
|
|
466
|
-
|
|
467
469
|
> 本文示例代码采用在 [即时通信 IM 控制台](https://console.cloud.tencent.com/im) 获取 UserSig 的方案,**该方法仅适合本地跑通功能调试**。 正确的 UserSig 签发方式请参见[服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
|
|
468
470
|
>
|
|
469
471
|
|
|
470
472
|
### 是否支持 react 17 版本?
|
|
471
473
|
|
|
472
|
-
目前不支持 React v17.x,仅支持 React v18.2+
|
|
474
|
+
目前不支持 React v17.x,仅支持 React v18.2+ 版本。
|
|
473
475
|
|
|
474
476
|
### 我能不能使用第三方组件库,例如 Ant-Design?
|
|
475
477
|
|
|
@@ -14,26 +14,26 @@ TUIKit 是一款基于腾讯云 IM SDK 和 UTS 原生渲染技术的 uni-app UI
|
|
|
14
14
|
|
|
15
15
|
- **支持平台**: 仅支持打包为 Android / iOS App,不支持 H5 和小程序。
|
|
16
16
|
|
|
17
|
+
- **支持项目**: uni-app 项目、uni-app x 项目。
|
|
18
|
+
|
|
17
19
|
> **说明:**
|
|
18
20
|
>
|
|
19
|
-
|
|
20
21
|
> H5 和小程序项目,如有需要请参考以下替代方案:
|
|
21
22
|
>
|
|
22
|
-
>
|
|
23
|
-
>
|
|
24
|
-
>
|
|
23
|
+
> - 打包 Web H5,可参考:Web H5(Vue3)。
|
|
24
|
+
> - 打包小程序,可参考:uni-app 完整版(Vue3/Vue2)。
|
|
25
|
+
> - 接入过程中遇到任何卡点或有改进建议,欢迎通过 [UniApp Atomicx 接入体验反馈](https://wj.qq.com/s2/26120470/621d/) 反馈,官方会及时跟进处理。
|
|
25
26
|
|
|
26
27
|
## 集成步骤
|
|
27
28
|
|
|
28
29
|
> **说明:**
|
|
29
30
|
>
|
|
30
|
-
|
|
31
|
-
> **Demo: **[GitHub 完整 Demo](https://github.com/Tencent-RTC/TUIKit_uni-app)开箱即用,5 分钟跑通聊天 + 音视频通话全功能。
|
|
31
|
+
> **Demo:** [GitHub 完整 Demo](https://github.com/Tencent-RTC/TUIKit_uni-app) 开箱即用,5 分钟跑通聊天 + 音视频通话全功能。
|
|
32
32
|
>
|
|
33
33
|
|
|
34
34
|
### 步骤1:创建项目
|
|
35
35
|
|
|
36
|
-
打开 HBuilderX,在菜单栏中选择 “**文件 > 新建 > 项目**”,创建一个名为 `chat-example` 的 uni-app 项目。
|
|
36
|
+
打开 HBuilderX,在菜单栏中选择 “**文件 > 新建 > 项目**”,创建一个名为 `chat-example` 的 uni-app / uni-app x 项目。
|
|
37
37
|
|
|
38
38
|
### 步骤2:安装 TUIKit 插件
|
|
39
39
|
|
|
@@ -41,28 +41,40 @@ TUIKit 是一款基于腾讯云 IM SDK 和 UTS 原生渲染技术的 uni-app UI
|
|
|
41
41
|
|
|
42
42
|
### 步骤3:配置原生模块与 Android 权限
|
|
43
43
|
|
|
44
|
+
【uni-app 项目】
|
|
45
|
+
|
|
44
46
|
> **说明:**
|
|
45
47
|
>
|
|
46
|
-
|
|
47
|
-
> `Camera` 、`Record`**、**`VideoPlayer` 模块用于聊天中的拍照、录音、视频播放功能。Android 权限用于录音、网络访问和文件存储。
|
|
48
|
+
> `Camera` 、`Record`**、** `VideoPlayer` 模块用于聊天中的拍照、录音、视频播放功能。Android 权限用于录音、网络访问和文件存储。
|
|
48
49
|
>
|
|
49
50
|
|
|
50
|
-
1. **模块配置**。点击 `manifest.json` > 点击**安卓 / iOS
|
|
51
|
+
1. **模块配置**。点击 `manifest.json` > 点击**安卓 / iOS 模块配置** > 勾选 **Camera&Gallery(相机和相册)、Record(录音)、 VideoPlayer(视频播放)**。如图所示:
|
|
51
52
|
|
|
52
|
-
2. **配置 Android 相关权限**。点击 `manifest.json`> 点击**安卓 / iOS
|
|
53
|
+
2. **配置 Android 相关权限**。点击 `manifest.json`> 点击**安卓 / iOS权限配置** > Android 云打包配置中配置如下权限。如图所示:
|
|
53
54
|
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
55
|
+
``` bash
|
|
56
|
+
<uses-permission android:name="android.permission.RECORD_AUDIO" />
|
|
57
|
+
<uses-permission android:name="android.permission.INTERNET" />
|
|
58
|
+
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
|
|
59
|
+
<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW"/>
|
|
60
|
+
<uses-permission android:name="android.permission.VIBRATE"/>
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
【uni-app x 项目】
|
|
64
|
+
|
|
65
|
+
**配置 Android 相关权限**。点击 `manifest.json`> 点击**安卓 App 配置** > 权限配置中配置如下权限。如图所示:
|
|
66
|
+
``` bash
|
|
67
|
+
<uses-permission android:name="android.permission.RECORD_AUDIO" />
|
|
68
|
+
<uses-permission android:name="android.permission.INTERNET" />
|
|
69
|
+
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
|
|
70
|
+
<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW"/>
|
|
71
|
+
<uses-permission android:name="android.permission.VIBRATE"/>
|
|
72
|
+
```
|
|
61
73
|
|
|
62
74
|
### 步骤4:集成 TUIKit
|
|
63
|
-
1.
|
|
75
|
+
1. **集成 TUIKit**:uni-app 项目根据 `manifest.json` > **基础配置** > **Vue 版本,**集成 TUIKit**。uni-app x 不区分 vue 版本。**
|
|
64
76
|
|
|
65
|
-
【Vue3
|
|
77
|
+
【uni-app Vue3 项目】
|
|
66
78
|
|
|
67
79
|
**拷贝 TUIKit 页面及静态资源**:将 `uni_modules/tuikit-atomic-x/quickstart/`下的`pages/*` 拷贝到项目 `page` 目录,`static/*` 拷贝到项目 `static` 目录下。
|
|
68
80
|
|
|
@@ -76,14 +88,13 @@ cp -r uni_modules/tuikit-atomic-x/quickstart/static/* static/ && cp -r uni_modul
|
|
|
76
88
|
xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart\static\*" "static\" && xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart\pages\*" "pages\"
|
|
77
89
|
```
|
|
78
90
|
|
|
79
|
-
【Vue2
|
|
91
|
+
【uni-app Vue2 项目】
|
|
80
92
|
1. **转换兼容模式:**仅 Vue2 项目,Vue3 项目可忽略**。**
|
|
81
93
|
|
|
82
|
-
> **说明:**
|
|
83
|
-
>
|
|
84
|
-
|
|
85
|
-
>
|
|
86
|
-
>
|
|
94
|
+
> **说明:**
|
|
95
|
+
>
|
|
96
|
+
> 该脚本用于将插件源码中 Vue3 的 Composition API 写法自动转换为 Vue2 的 Options API 写法,以确保在 Vue2 项目中正常运行。
|
|
97
|
+
>
|
|
87
98
|
|
|
88
99
|
``` bash
|
|
89
100
|
node ./uni_modules/tuikit-atomic-x/scripts/switch-to-compatible-mode.js
|
|
@@ -100,7 +111,30 @@ cp -r uni_modules/tuikit-atomic-x/quickstart/static/* static/ && cp -r uni_modul
|
|
|
100
111
|
xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart\static\*" "static\" && xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart\pages\*" "pages\"
|
|
101
112
|
```
|
|
102
113
|
|
|
103
|
-
|
|
114
|
+
【uni-app x 项目】
|
|
115
|
+
1. **转换 uniappx 模式:**仅 uni-app x 项目,uni-app 项目可忽略**。**
|
|
116
|
+
|
|
117
|
+
> **说明:**
|
|
118
|
+
>
|
|
119
|
+
> 该脚本用于将插件中 nvue 组件转化为 uvue 组件。
|
|
120
|
+
>
|
|
121
|
+
|
|
122
|
+
``` bash
|
|
123
|
+
node ./uni_modules/tuikit-atomic-x/scripts/switch-to-uniappx-mode.js
|
|
124
|
+
```
|
|
125
|
+
2. **拷贝 TUIKit 页面及静态资源**:将 `uni_modules/tuikit-atomic-x/quickstart/` 下的 `pages/*` 拷贝到项目 `page` 目录,`static/*` 拷贝到项目 `static` 目录下。
|
|
126
|
+
|
|
127
|
+
【Mac 端】
|
|
128
|
+
``` bash
|
|
129
|
+
cp -r uni_modules/tuikit-atomic-x/quickstart/static/* static/ && cp -r uni_modules/tuikit-atomic-x/quickstart/pages/* pages/
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
【Windows 端】
|
|
133
|
+
``` bash
|
|
134
|
+
xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart\static\*" "static\" && xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart\pages\*" "pages\"
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
2. **配置页面路由:**替换 `pages.json` 内容,注册所需页面路由:
|
|
104
138
|
|
|
105
139
|
``` json
|
|
106
140
|
{
|
|
@@ -315,7 +349,6 @@ xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart\static\*" "static\" && xc
|
|
|
315
349
|
|
|
316
350
|
> **说明:**
|
|
317
351
|
>
|
|
318
|
-
|
|
319
352
|
> 如需调整页面路由,请同步修改页面和 `uni_modules/tuikit-atomic-x/components` 中路由跳转逻辑。
|
|
320
353
|
>
|
|
321
354
|
|
|
@@ -323,28 +356,26 @@ xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart\static\*" "static\" && xc
|
|
|
323
356
|
|
|
324
357
|
> **说明:**
|
|
325
358
|
>
|
|
326
|
-
|
|
327
359
|
> 接入过程中遇到任何卡点或有改进建议,欢迎通过 [UniApp Atomicx 接入体验反馈](https://wj.qq.com/s2/26120470/621d/) 反馈,官方会及时跟进处理。
|
|
328
360
|
>
|
|
329
361
|
|
|
330
|
-
1.
|
|
362
|
+
1. **制作自定义基座。**点击**运行** > **运行到手机或模拟器** > **制作自定义调试基座:**
|
|
331
363
|
|
|
332
364
|
> **说明:**
|
|
333
365
|
>
|
|
334
|
-
|
|
335
|
-
> 首次制作自定义基座需要下载 Gradle 依赖,Android 通常需要 10~20 分钟,iOS 需要 5~10 分钟,请耐心等待,请勿中断。
|
|
366
|
+
> 首次制作自定义基座需要下载 Gradle 依赖,Android 通常需要 10~20 分钟,iOS 需要 5~10 分钟。过程中请勿中断。
|
|
336
367
|
>
|
|
337
368
|
|
|
338
|
-
2. **登录。**在 `pages/login/login.vue` 中,填入 `SDKAppID`、 `
|
|
369
|
+
2. **登录。**在 `pages/login/login.vue` 中,填入 `SDKAppID`、 `userID`、`userSig`,点击登录。
|
|
339
370
|
|
|
340
371
|
| 参数 | 类型 | 说明 |
|
|
341
372
|
| --- | --- | --- |
|
|
342
373
|
| SDKAppID | Number | SDKAppID 是腾讯云 IM 客户应用的唯一标识。您可以在 <a href="https://console.cloud.tencent.com/im">即时通信 IM 控制台</a> 创建新应用获取 。<br><strong>说明:</strong><br>SDKAppID 是腾讯云 IM 客户应用的唯一标识。我们建议每一个独立的 App 都申请一个新的 SDKAppID。不同 SDKAppID 之间的消息是天然隔离的,不能互通。 |
|
|
343
374
|
| SecretKey | String | SecretKey 是腾讯云 IM 客户应用的密钥。您可以在 <a href="https://console.cloud.tencent.com/im">即时通信 IM 控制台</a> 对应应用获取。 |
|
|
344
375
|
| userID | String | 用户的唯一标识符,由您定义,只能包含大小写字母(a-z,A-Z)、数字(0-9)、下划线和连字符。 |
|
|
345
|
-
| userSig | String | 用户登录即时通信 IM 的密码,其本质是对 UserID
|
|
376
|
+
| userSig | String | 用户登录即时通信 IM 的密码,其本质是对 UserID 等信息加密后得到的密文。您可以在 <a href="https://console.cloud.tencent.com/im">即时通信 IM 控制台</a> 生成。<br><strong>安全提示:</strong><br>- uni-app Vue3、uni-app Vue2 项目示例支持通过 <code>genTestUserSig</code> 函数生成 <code>userSig</code>。该方法中 <code>SecretKey</code> 很容易被反编译逆向破解,一旦您的密钥泄露,攻击者就可以盗用您的腾讯云流量。<strong>该方法仅适合本地跑通功能调试</strong>。 正确的 UserSig 签发方式请参见 <a href="https://cloud.tencent.com/document/product/269/32688">服务端生成 UserSig</a>。<br>- uni-app x 项目不支持通过 <code>genTestUserSig</code> 函数生成 <code>userSig</code>。您可以在 <a href="https://console.cloud.tencent.com/im">即时通信 IM 控制台</a> 或者通过 服务端生成自行生成 userSig。<br>- 示例代码中的 UserSig 仅供测试使用,生产环境请通过 服务端生成。<br>- 敏感信息(UserSig/SecretKey)仅用于 Demo 测试,不可提交到代码仓库或用于生产环境。 |
|
|
346
377
|
|
|
347
|
-
【vue3
|
|
378
|
+
【uni-app vue3 项目】
|
|
348
379
|
``` typescript
|
|
349
380
|
import { ref } from 'vue'
|
|
350
381
|
import { useLoginState } from '@/uni_modules/tuikit-atomic-x/state/LoginState';
|
|
@@ -373,7 +404,7 @@ login({
|
|
|
373
404
|
})
|
|
374
405
|
```
|
|
375
406
|
|
|
376
|
-
【vue2
|
|
407
|
+
【uni-app vue2 项目】
|
|
377
408
|
``` typescript
|
|
378
409
|
import { useLoginState } from '@/uni_modules/tuikit-atomic-x/state/LoginState'
|
|
379
410
|
import { genTestUserSig } from '@/uni_modules/tuikit-atomic-x/debug/GenerateTestUserSig'
|
|
@@ -410,11 +441,41 @@ export default {
|
|
|
410
441
|
}
|
|
411
442
|
```
|
|
412
443
|
|
|
413
|
-
|
|
444
|
+
【uni-app x 项目】
|
|
445
|
+
``` typescript
|
|
446
|
+
import { useLoginState } from '@/uni_modules/tuikit-atomic-x/state/LoginState';
|
|
447
|
+
const { login } = useLoginState();
|
|
448
|
+
|
|
449
|
+
const sdkAppId = 0; // SDKAppID
|
|
450
|
+
const userId = ref(''); // userID
|
|
451
|
+
const userSig = ''; // userSig
|
|
452
|
+
|
|
453
|
+
// 登录
|
|
454
|
+
login({
|
|
455
|
+
sdkAppID: sdkAppId,
|
|
456
|
+
userID: userId.value,
|
|
457
|
+
userSig: userSig,
|
|
458
|
+
success: () => {
|
|
459
|
+
uni.reLaunch({ url: '/pages/scenes/chat/conversationList/conversationList' })
|
|
460
|
+
},
|
|
461
|
+
fail: (code: number, msg: string) => {
|
|
462
|
+
uni.showToast({ title: msg || '登录失败', icon: 'none' })
|
|
463
|
+
}
|
|
464
|
+
})
|
|
465
|
+
|
|
466
|
+
```
|
|
467
|
+
|
|
468
|
+
3. **运行项目。**点击**运行** > **运行到手机或模拟器** > **运行到 Android/iOS 基座**,使用制作好的**自定义基座**运行到手机。
|
|
414
469
|
|
|
415
470
|
## 集成音视频通话(推荐)
|
|
416
471
|
|
|
417
472
|
**初始化 TUICallKit 服务。**在根目录下的 `App.vue` 中引入如下代码。
|
|
473
|
+
|
|
474
|
+
> **说明:**
|
|
475
|
+
>
|
|
476
|
+
> TUICallKit 暂不支持 uni-app x 项目**,仅支持 uni-app 项目。**
|
|
477
|
+
>
|
|
478
|
+
|
|
418
479
|
``` typescript
|
|
419
480
|
import { initCallService } from '@/uni_modules/tuikit-atomic-x/server/callService';
|
|
420
481
|
initCallService();
|
|
@@ -432,7 +493,7 @@ A:**不支持。**由于新版 TUIKit 基于 **UTS (Uni-app Type Script)** 插
|
|
|
432
493
|
|
|
433
494
|
A:**不支持。**新版 TUIKit 基于 **UTS(Uni-app Type Script)**插件架构开发,其底层为**原生 SDK**,数据通过 hybridApi 进行交互,因此无法获取 **Chat 实例**。
|
|
434
495
|
|
|
435
|
-
#### **Q
|
|
496
|
+
#### **Q:我的现有项目全是** `.vue` **页面(Webview 渲染),能直接集成吗?**
|
|
436
497
|
|
|
437
498
|
A:**可以混用,但需要注意页面模式。**
|
|
438
499
|
|
|
@@ -454,7 +515,7 @@ nvue 页面中:
|
|
|
454
515
|
|
|
455
516
|
3. 不支持简写属性(例如 `margin: 10px 20px`),必须写全(`margin-top`, `margin-left` 等)。
|
|
456
517
|
|
|
457
|
-
4. 更多参考信息:[uni-app-nvue 开发与
|
|
518
|
+
4. 更多参考信息:[uni-app-nvue 开发与 Vue 开发的常见区别](https://uniapp.dcloud.net.cn/tutorial/page.html#nvue-%E5%BC%80%E5%8F%91%E4%B8%8E-vue-%E5%BC%80%E5%8F%91%E7%9A%84%E5%B8%B8%E8%A7%81%E5%8C%BA%E5%88%AB)。
|
|
458
519
|
|
|
459
520
|
### 集成与构建类
|
|
460
521
|
|
|
@@ -463,7 +524,7 @@ nvue 页面中:
|
|
|
463
524
|
A:请检查是否制作并使用了**自定义调试基座**。
|
|
464
525
|
|
|
465
526
|
由于插件包含原生代码(Java/Objective-C),标准基座不包含这些原生库。
|
|
466
|
-
- **解决步骤:** 请严格按照文档“运行和测试-步骤2”操作,在 HBuilderX 中点击
|
|
527
|
+
- **解决步骤:** 请严格按照文档“运行和测试-步骤2”操作,在 HBuilderX 中点击 **运行** > **运行到手机或模拟器** > **制作自定义调试基座**。制作完成后,运行时请务必选择**运行到 Android/iOS 基座**,并勾选“使用自定义基座”。
|
|
467
528
|
|
|
468
529
|
#### **Q:制作自定义基座时一直失败或卡顿怎么办?**
|
|
469
530
|
|
|
@@ -3,16 +3,8 @@ TUIKit 是基于腾讯云 Chat SDK 的一款 Vue 3 UI 组件库,它提供了
|
|
|
3
3
|
> **说明:**
|
|
4
4
|
>
|
|
5
5
|
> - **AI 助手使用说明**
|
|
6
|
-
|
|
7
|
-
> Skill 提供了** IM 知识咨询**和 **Vue3 State API 无 UI 集成**能力,您可以用 Skill 在 IDE 中直接查询 SDK、UIKit、服务端 API、产品计费等内容,也可以用 Skill 在 Vue3 项目中集成 IM 能力, [点击这里,立即体验 AI 集成和咨询助手](https://cloud.tencent.com/document/product/269/125822)。
|
|
8
|
-
>
|
|
9
|
-
|
|
10
|
-
> 您好!我们正在开发一款即时通信产品 UIKit,它基于腾讯云 Chat SDK,是一款 Vue3 UI 组件库,能帮助您快速集成并实现核心功能。
|
|
11
|
-
>
|
|
12
|
-
|
|
13
|
-
> 您的反馈我们会**高度重视**,本问卷填写**仅需要 30 秒**!诚邀您的参与。
|
|
6
|
+
> MCP 提供了 **IM 知识咨询**和**含 UI 集成**的 AI 解决方案,您可以通过 MCP 查询 IM 相关的知识和集成 UIKit,[点击这里,立即体验 AI 助手](https://cloud.tencent.com/document/product/269/126983)。
|
|
14
7
|
>
|
|
15
|
-
> - **请根据您的技术栈和目标平台,选择对应的接入文档开始集成:**
|
|
16
8
|
|
|
17
9
|
|接入需求|桌面端|移动端 H5|
|
|
18
10
|
|---------|---------|---------|
|
|
@@ -46,15 +38,31 @@ chat-uikit-vue3 主要分为 ConversationList、Chat、MessageList、ChatHeader
|
|
|
46
38
|
|
|
47
39
|
- Node.js(Node.js ≥ 20.0.0,建议使用目前的 LTS v22 版本)
|
|
48
40
|
|
|
49
|
-
##
|
|
41
|
+
## 快速体验完整示例项目
|
|
50
42
|
|
|
51
|
-
|
|
43
|
+
如果您希望先快速跑通完整效果,或在接入过程中对照最终代码结构,可以直接克隆我们已经完成接入的示例项目。示例项目已完成 Chat UIKit 相关依赖安装、组件引入、初始化配置和基础页面接入,适合作为接入参考。
|
|
44
|
+
``` bash
|
|
45
|
+
git clone https://gitee.com/tencent-cloud-uikit/rtc-chat-web.git
|
|
46
|
+
cd chat-desktop-vue3
|
|
47
|
+
npm install
|
|
48
|
+
npm run dev
|
|
49
|
+
```
|
|
52
50
|
|
|
53
51
|
> **说明:**
|
|
54
52
|
>
|
|
53
|
+
> 示例项目地址:[点击查看 Gitee 示例项目](https://gitee.com/tencent-cloud-uikit/rtc-chat-web)。
|
|
54
|
+
>
|
|
55
|
+
> 示例项目用于帮助您快速体验和对照接入流程。若您需要在已有项目中集成,建议继续阅读下方步骤,按文档逐步完成接入。
|
|
56
|
+
>
|
|
57
|
+
|
|
58
|
+
## 创建项目
|
|
55
59
|
|
|
56
|
-
|
|
60
|
+
使用 Vite 创建一个新的名称为 **chat-integration-vue3** 的 Vue3 项目。
|
|
61
|
+
|
|
62
|
+
> **注意:**
|
|
57
63
|
>
|
|
64
|
+
> 1. 建议使用 npm 进行安装,npm 会主动下载所需的 peerDependencies 依赖。
|
|
65
|
+
> 2. `npm create vite@latest` 会使用最新的 vite 版本,最新版本的 vite 可能会与低版本的 node.js 冲突,请检查您电脑上的相关环境配置。
|
|
58
66
|
|
|
59
67
|
【shell】
|
|
60
68
|
``` bash
|
|
@@ -90,7 +98,6 @@ cd chat-integration-vue3
|
|
|
90
98
|
|
|
91
99
|
> **说明:**
|
|
92
100
|
>
|
|
93
|
-
|
|
94
101
|
> 建议使用 npm 进行安装,npm 会主动下载所需的 peerDependencies 依赖。
|
|
95
102
|
>
|
|
96
103
|
|
|
@@ -103,7 +110,6 @@ npm i @tencentcloud/chat-uikit-vue3@6 tuikit-atomicx-vue3@6
|
|
|
103
110
|
|
|
104
111
|
> **注意:**
|
|
105
112
|
>
|
|
106
|
-
|
|
107
113
|
> 以下代码中未填入 `SDKAppID`、`userID` 和 `userSig`,需在 步骤3 中获取相关信息后进行替换。
|
|
108
114
|
>
|
|
109
115
|
|
|
@@ -168,7 +174,13 @@ body { margin: 0; padding: 0; font-family: Inter, Avenir, Helvetica, Arial, sans
|
|
|
168
174
|
<template #headerToolbar>
|
|
169
175
|
<div class="toolbar">
|
|
170
176
|
<div class="toolbar-left">
|
|
171
|
-
<EmojiPicker
|
|
177
|
+
<EmojiPicker />
|
|
178
|
+
<FilePicker />
|
|
179
|
+
<VideoPicker />
|
|
180
|
+
<ImagePicker />
|
|
181
|
+
<AudioCallPicker />
|
|
182
|
+
<VideoCallPicker />
|
|
183
|
+
<QuickConferencePicker />
|
|
172
184
|
</div>
|
|
173
185
|
<button class="icon-btn" @click="searchOpen = !searchOpen">
|
|
174
186
|
<IconSearch size="20" />
|
|
@@ -191,7 +203,10 @@ body { margin: 0; padding: 0; font-family: Inter, Avenir, Helvetica, Arial, sans
|
|
|
191
203
|
</div>
|
|
192
204
|
|
|
193
205
|
<div v-show="activeTab === 'contacts'" class="detail-panel">
|
|
194
|
-
<ContactInfo
|
|
206
|
+
<ContactInfo
|
|
207
|
+
@send-message="activeTab = 'conversations'"
|
|
208
|
+
@enter-group="activeTab = 'conversations'"
|
|
209
|
+
/>
|
|
195
210
|
</div>
|
|
196
211
|
</div>
|
|
197
212
|
</template>
|
|
@@ -203,6 +218,7 @@ import {
|
|
|
203
218
|
ConversationList, ContactList, ContactInfo, ChatSetting,
|
|
204
219
|
EmojiPicker, FilePicker, VideoPicker, ImagePicker,
|
|
205
220
|
VariantType, useChatContext,
|
|
221
|
+
AudioCallPicker, VideoCallPicker, QuickConferencePicker
|
|
206
222
|
} from '@tencentcloud/chat-uikit-vue3';
|
|
207
223
|
import { IconMenu, IconSearch } from '@tencentcloud/uikit-base-component-vue3';
|
|
208
224
|
import SideTab from './SideTab.vue';
|
|
@@ -341,7 +357,6 @@ login({
|
|
|
341
357
|
|
|
342
358
|
> **注意:**
|
|
343
359
|
>
|
|
344
|
-
|
|
345
360
|
> 本文示例代码采用在[即时通信 IM 控制台](https://console.cloud.tencent.com/im) 获取 UserSig 的方案,**该方法仅适合本地跑通功能调试**。 正确的 UserSig 签发方式请参见[服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
|
|
346
361
|
>
|
|
347
362
|
|
|
@@ -357,7 +372,7 @@ login({
|
|
|
357
372
|
|
|
358
373
|
【shell】
|
|
359
374
|
``` bash
|
|
360
|
-
|
|
375
|
+
npm run dev
|
|
361
376
|
```
|
|
362
377
|
|
|
363
378
|
> **注意:**
|
|
@@ -372,17 +387,15 @@ login({
|
|
|
372
387
|
|
|
373
388
|
> **说明:**
|
|
374
389
|
>
|
|
375
|
-
|
|
376
390
|
> TUICallKit 是腾讯云推出一款音视频通话 UI 组件,通过集成该组件,您只需要编写几行代码就可以在聊天应用中体验音视频通话功能。
|
|
377
391
|
>
|
|
378
|
-
|
|
379
392
|
> 更多详细信息可参考:音视频通话-开通服务。
|
|
380
393
|
>
|
|
381
394
|
|
|
382
395
|
1. 安装 `@trtc/calls-uikit-vue` 依赖。
|
|
383
396
|
|
|
384
397
|
``` bash
|
|
385
|
-
|
|
398
|
+
npm install @trtc/calls-uikit-vue
|
|
386
399
|
```
|
|
387
400
|
2. 从 `@trtc/calls-uikit-vue` 导出 `TUICallKit`,并挂载到 DOM 节点上。
|
|
388
401
|
|
|
@@ -403,7 +416,7 @@ login({
|
|
|
403
416
|
import { TUICallKit } from '@trtc/calls-uikit-vue';
|
|
404
417
|
</script>
|
|
405
418
|
```
|
|
406
|
-
3.
|
|
419
|
+
3. 在 `<MessageInput />` 组件中,使用 `#headerToolbar` 插槽控制输入框工具栏。
|
|
407
420
|
|
|
408
421
|
``` java
|
|
409
422
|
<MessageInput class="message-input-container">
|
|
@@ -426,20 +439,42 @@ login({
|
|
|
426
439
|
```
|
|
427
440
|
4. 拨打语音通话。
|
|
428
441
|
|
|
442
|
+
### 视频会议
|
|
443
|
+
|
|
444
|
+
TUIRoomKit 是一款定位企业会议、网络研讨会、在线教育等多人音视频会话场景的含 UI 低代码组件,提供房间管理、成员管理、屏幕分享等会控功能,支持标清、高清、超高清等多种画质。
|
|
445
|
+
|
|
446
|
+
上述接入过程默认集成视频会议功能,如果需要关闭视频会议功能,在 `<MessageInput />` 组件中,使用 `#headerToolbar` 插槽控制输入框工具栏,注释掉视频会议的工具(QuickConferencePicker)即可。
|
|
447
|
+
``` typescript
|
|
448
|
+
<MessageInput>
|
|
449
|
+
<template #headerToolbar>
|
|
450
|
+
<div class="toolbar">
|
|
451
|
+
<div class="toolbar-left">
|
|
452
|
+
<EmojiPicker />
|
|
453
|
+
<FilePicker />
|
|
454
|
+
<VideoPicker />
|
|
455
|
+
<ImagePicker />
|
|
456
|
+
<AudioCallPicker />
|
|
457
|
+
<VideoCallPicker />
|
|
458
|
+
<!-- <QuickConferencePicker /> -->
|
|
459
|
+
</div>
|
|
460
|
+
<button class="icon-btn" @click="searchOpen = !searchOpen">
|
|
461
|
+
<IconSearch size="20" />
|
|
462
|
+
</button>
|
|
463
|
+
</div>
|
|
464
|
+
</template>
|
|
465
|
+
</MessageInput>
|
|
466
|
+
```
|
|
467
|
+
|
|
429
468
|
### 云端搜索
|
|
430
469
|
|
|
431
470
|
> **说明:**
|
|
432
471
|
>
|
|
433
|
-
|
|
434
472
|
> 搜索,在客服、社交、在线教育、在线医疗、OA 等场景下是刚需功能,可帮助用户快速查找群组、用户、消息,提升产品使用体验和用户粘性。
|
|
435
473
|
>
|
|
436
|
-
|
|
437
474
|
> 由于 Web 平台本地存储特殊性等原因,Vue **无法实现本地搜索**,为了更好的满足对于搜索能力的需求,推出了**云端搜索能力**。**云端搜索功能支持全局搜索和会话内搜索,同时支持搜索群组、用户和消息。**
|
|
438
475
|
>
|
|
439
|
-
|
|
440
476
|
>
|
|
441
477
|
>
|
|
442
|
-
|
|
443
478
|
> 此功能属于增值服务,需要您购买云端搜索插件,请点击 [购买](https://console.cloud.tencent.com/im/plugin/TUICloudSearch)。
|
|
444
479
|
>
|
|
445
480
|
|
|
@@ -475,7 +510,6 @@ UserSig 是用户登录即时通信 IM 的密码,其本质是对 UserID 等信
|
|
|
475
510
|
|
|
476
511
|
> **注意:**
|
|
477
512
|
>
|
|
478
|
-
|
|
479
513
|
> 本文示例代码采用在 [即时通信 IM 控制台](https://console.cloud.tencent.com/im) 获取 UserSig 的方案,**该方法仅适合本地跑通功能调试**。 正确的 UserSig 签发方式请参见 [服务端生成 UserSig](https://cloud.tencent.com/document/product/269/32688)。
|
|
480
514
|
>
|
|
481
515
|
|
|
@@ -520,7 +554,7 @@ const isChatSettingShow = ref(false);
|
|
|
520
554
|
|
|
521
555
|
### NPM 包
|
|
522
556
|
|
|
523
|
-
[chat-uikit-vue3 npm](https://www.npmjs.com/package/@tencentcloud/chat-uikit-vue3)
|
|
557
|
+
[chat-uikit-vue3 npm](https://www.npmjs.com/package/@tencentcloud/chat-uikit-vue3)
|
|
524
558
|
|
|
525
559
|
### GitHub
|
|
526
560
|
|