@tencentcloud/sdk-mcp 1.4.6 → 1.6.0-beta.1
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 -1
- package/knowledge/bm25-cache.js +73 -0
- package/knowledge/bm25.js +147 -0
- package/knowledge/build-index.js +65 -0
- package/knowledge/chunker.js +167 -0
- package/knowledge/content-loader.js +44 -0
- package/knowledge/extractors.js +25 -0
- package/knowledge/path-meta.js +175 -0
- package/knowledge/search/exact-lookup.js +330 -0
- package/knowledge/search/filter-pool.js +86 -0
- package/knowledge/search/requires-framework.js +72 -0
- package/knowledge/search/search-knowledge.js +226 -0
- package/package.json +9 -9
- package/resource/_schema/feature-aliases.yaml +10 -0
- package/resource/_schema/goal-tags.yaml +72 -0
- package/resource/_schema/products.yaml +16 -0
- package/resource/_schema/trtc-intents.yaml +27 -0
- package/resource/_schema/types.yaml +44 -0
- package/resource/index/component-slugs.json +1 -0
- package/resource/index/manifest.json +1 -0
- package/resource/{doc → integration}/callkit/preset/android/integration.md +32 -28
- package/resource/{doc → integration}/callkit/preset/flutter/integration.md +109 -54
- package/resource/integration/callkit/preset/ios/integration.md +411 -0
- package/resource/integration/callkit/preset/react/integration.md +499 -0
- package/resource/integration/callkit/preset/vue/integration.md +768 -0
- package/resource/{doc/chatkit → integration/chat/preset}/android/integration.md +11 -11
- package/resource/{doc/chatkit → integration/chat/preset}/flutter/integration.md +59 -37
- package/resource/integration/chat/preset/ios/integration.md +568 -0
- package/resource/{doc/chatkit → integration/chat/preset}/react/integration.md +127 -95
- package/resource/integration/chat/preset/uni-app/integration.md +494 -0
- package/resource/{doc/chatkit → integration/chat/preset}/vue/integration.md +163 -143
- package/resource/{doc → integration}/livekit/preset/live/vue/live-list-integration.md +15 -15
- package/resource/{doc → integration}/livekit/preset/live/vue/live-player-desk-integration.md +25 -13
- package/resource/{doc → integration}/livekit/preset/live/vue/live-player-h5-integration.md +15 -9
- package/resource/{doc → integration}/livekit/preset/live/vue/live-pusher-integration.md +31 -26
- package/resource/integration/roomkit/preset/vue/integration.md +571 -0
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +852 -0
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +929 -0
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +364 -0
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +1150 -0
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +1216 -0
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +412 -0
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1191 -0
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +1292 -0
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +537 -0
- package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +953 -0
- package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +1061 -0
- package/resource/knowledge/callkit/faq/android.md +168 -0
- package/resource/knowledge/callkit/faq/common.md +180 -0
- package/resource/knowledge/callkit/faq/flutter.md +52 -0
- package/resource/knowledge/callkit/faq/ios.md +116 -0
- package/resource/knowledge/callkit/faq/uniapp-app.md +89 -0
- package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +217 -0
- package/resource/knowledge/callkit/faq/web.md +363 -0
- package/resource/knowledge/callkit/preset/android/api.md +413 -0
- package/resource/knowledge/callkit/preset/flutter/api.md +22 -0
- package/resource/knowledge/callkit/preset/ios/api.md +256 -0
- package/resource/knowledge/callkit/preset/web/api.md +79 -0
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +72 -0
- package/resource/knowledge/chat/preset/android/features/contact-list.md +41 -0
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +123 -0
- package/resource/knowledge/chat/preset/android/features/language.md +142 -0
- package/resource/knowledge/chat/preset/android/features/message-input.md +57 -0
- package/resource/knowledge/chat/preset/android/features/message-list.md +142 -0
- package/resource/knowledge/chat/preset/android/features/search.md +64 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/android/features/theme.md +21 -18
- package/resource/knowledge/chat/preset/android-view/integration.md +448 -0
- package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +62 -0
- package/resource/knowledge/chat/preset/flutter/features/contact-list.md +40 -0
- package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +129 -0
- package/resource/knowledge/chat/preset/flutter/features/language.md +104 -0
- package/resource/knowledge/chat/preset/flutter/features/message-input.md +54 -0
- package/resource/knowledge/chat/preset/flutter/features/message-list.md +163 -0
- package/resource/knowledge/chat/preset/flutter/features/search.md +59 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/flutter/features/theme.md +47 -19
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +92 -0
- package/resource/knowledge/chat/preset/ios/features/contact-list.md +119 -0
- package/resource/knowledge/chat/preset/ios/features/conversation-list.md +134 -0
- package/resource/knowledge/chat/preset/ios/features/language.md +105 -0
- package/resource/knowledge/chat/preset/ios/features/message-input.md +69 -0
- package/resource/knowledge/chat/preset/ios/features/message-list.md +164 -0
- package/resource/knowledge/chat/preset/ios/features/search.md +94 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/ios/features/theme.md +54 -51
- package/resource/{doc/chatkit/ios → knowledge/chat/preset/ios-uikit}/integration.md +157 -94
- package/resource/knowledge/chat/preset/react/features/chat-setting.md +123 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/contact-list.md +256 -104
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +217 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/conversation-list.md +86 -79
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +99 -0
- package/resource/knowledge/chat/preset/react/features/conversation-search.md +58 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-input.md +30 -83
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-list.md +22 -25
- package/resource/knowledge/chat/preset/react/features/search.md +531 -0
- package/resource/knowledge/chat/preset/react/features/theme.md +16 -0
- package/resource/knowledge/chat/preset/vue/features/chat-header.md +331 -0
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/chat-setting.md +0 -4
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/contact-list.md +59 -53
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-actions.md +49 -43
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-list.md +61 -49
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-preview.md +43 -40
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-search.md +1 -1
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-input.md +128 -105
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-list.md +108 -195
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/search.md +74 -68
- package/resource/knowledge/chat/preset/vue/features/theme.md +136 -0
- package/resource/knowledge/chat/urls/error-code.md +16 -0
- package/resource/knowledge/chat/urls/product.md +61 -0
- package/resource/knowledge/chat/urls/restapi.md +226 -0
- package/resource/knowledge/chat/urls/sdk/android.md +84 -0
- package/resource/knowledge/chat/urls/sdk/flutter.md +73 -0
- package/resource/knowledge/chat/urls/sdk/ios.md +84 -0
- package/resource/knowledge/chat/urls/sdk/web.md +88 -0
- package/resource/knowledge/chat/urls/webhook.md +73 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/AudioEffectStore.md +79 -76
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +174 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +329 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/CameraView.md +7 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +434 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +362 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +466 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +173 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/LikeStore.md +12 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +291 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +78 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +439 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +221 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/AudioEffectStore.md +79 -76
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +212 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/BaseBeautyStore.md +43 -45
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +312 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +404 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +334 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +420 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +166 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LikeStore.md +12 -11
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +281 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LiveCoreView.md +49 -42
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +397 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +183 -0
- package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/AudioEffectStore.md +79 -75
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +192 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +146 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +309 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +370 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +339 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +503 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +188 -0
- package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/LikeStore.md +12 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +289 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +78 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +434 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +187 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/web/index.md +780 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audience-list.md +59 -51
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audio-effect.md +37 -34
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-barrage.md +68 -38
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-base-beauty.md +18 -15
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-co-guest-interaction.md +17 -17
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-gift.md +86 -80
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-host-interaction.md +53 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-integration.md +47 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-live-list.md +26 -22
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audience-list.md +16 -13
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-barrage.md +33 -21
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-base-beauty.md +29 -25
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-co-guest-interaction.md +21 -20
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-gift.md +78 -69
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-host-interaction.md +47 -43
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-integration.md +48 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-live-list.md +27 -23
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audience-list.md +15 -12
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audio-effect.md +39 -36
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-barrage.md +42 -29
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-base-beauty.md +19 -16
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-co-guest-interaction.md +20 -19
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-gift.md +55 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-host-interaction.md +50 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-integration.md +48 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-live-list.md +26 -22
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audience-list.md +59 -51
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audio-effect.md +41 -38
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-barrage.md +67 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +53 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-gift.md +86 -80
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-host-interaction.md +45 -40
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-integration.md +43 -42
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-room-list.md +523 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audience-list.md +16 -13
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audio-effect.md +54 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-barrage.md +33 -21
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +34 -28
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-gift.md +73 -64
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-integration.md +46 -43
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-room-list.md +165 -148
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audience-list.md +19 -16
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audio-effect.md +40 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-barrage.md +41 -28
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +54 -47
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-gift.md +52 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-host-interaction.md +55 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-integration.md +47 -45
- package/resource/knowledge/livekit/core-sdk/voice/ios/voice-room-list.md +404 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audience-list.md +40 -57
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audio-effect.md +38 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-barrage.md +53 -53
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-co-guest-interaction.md +106 -116
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-gift.md +49 -59
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-integration.md +52 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-room-list.md +38 -46
- package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +915 -0
- package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +179 -0
- package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +419 -0
- package/resource/knowledge/push/config/android/fcm.md +133 -0
- package/resource/knowledge/push/config/android/honor.md +111 -0
- package/resource/knowledge/push/config/android/huawei.md +106 -0
- package/resource/knowledge/push/config/android/meizu.md +121 -0
- package/resource/knowledge/push/config/android/oppo.md +108 -0
- package/resource/knowledge/push/config/android/vivo.md +101 -0
- package/resource/knowledge/push/config/android/xiaomi.md +99 -0
- package/resource/knowledge/push/integration/android.md +1028 -0
- package/resource/knowledge/push/integration/donut.md +271 -0
- package/resource/knowledge/push/integration/flutter.md +363 -0
- package/resource/knowledge/push/integration/harmonyos.md +72 -0
- package/resource/knowledge/push/integration/ios.md +705 -0
- package/resource/knowledge/push/integration/react-native.md +337 -0
- package/resource/knowledge/push/integration/uni-app.md +461 -0
- package/resource/knowledge/push/integration/unity.md +357 -0
- package/resource/knowledge/push/integration/unreal-engine.md +353 -0
- package/resource/knowledge/push/overview/prepare.md +30 -0
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/call-user-to-room.md +22 -20
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-participant-state.md +22 -193
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-state.md +33 -32
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/schedule-room.md +30 -29
- package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +230 -0
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-participant-state.md +22 -21
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-state.md +29 -28
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/schedule-room.md +17 -16
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/call-user-to-room.md +22 -20
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-participant-state.md +49 -218
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-state.md +37 -37
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/schedule-room.md +28 -28
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/call-user-to-room.md +122 -7
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/device-detection.md +318 -3
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +1504 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/free-beauty-panel.md +4 -3
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +709 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +1105 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +635 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +529 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/schedule-room.md +256 -13
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/screen-share.md +218 -25
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/virtual-background.md +4 -3
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/android/integration.md +50 -64
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/flutter/integration.md +34 -31
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/ios/integration.md +45 -53
- package/resource/knowledge/roomkit/preset/react/integration.md +571 -0
- package/resource/{doc → knowledge}/rtcengine/web/how_to_run_web_sdk_demo.md +31 -15
- package/resource/{doc → knowledge}/rtcengine/web/plugin/21-advanced-auto-play-policy.md +9 -3
- package/resource/{doc → knowledge}/rtcengine/web/plugin/22-advanced-audio-mixer.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/23-advanced-support-detection.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/24-advanced-network-quality.md +6 -6
- package/resource/{doc → knowledge}/rtcengine/web/plugin/25-advanced-device-change.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -4
- package/resource/{doc → knowledge}/rtcengine/web/plugin/27-advanced-small-stream.md +4 -4
- package/resource/{doc → knowledge}/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
- package/resource/{doc → knowledge}/trtc/android/TRTCCloud.md +547 -495
- package/resource/{doc → knowledge}/trtc/android/TRTCCloudDef.md +434 -403
- package/resource/{doc → knowledge}/trtc/android/TRTCCloudListener.md +394 -348
- package/resource/{doc → knowledge}/trtc/android/TRTCStatistics.md +17 -15
- package/resource/{doc → knowledge}/trtc/android/TXAudioEffectManager.md +227 -197
- package/resource/knowledge/trtc/android/TXBeautyManager.md +415 -0
- package/resource/{doc → knowledge}/trtc/android/TXDeviceManager.md +70 -63
- package/resource/{doc → knowledge}/trtc/android/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCCloud.md +599 -544
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCStatistics.md +17 -15
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +502 -0
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +403 -0
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCCloudCallback.md +439 -387
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCTypeDef.md +417 -387
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloud.md +619 -559
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloudDelegate.md +409 -360
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCStatistics.md +17 -15
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXAudioEffectManager.md +187 -164
- package/resource/knowledge/trtc/ios/TXBeautyManager.md +416 -0
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +399 -0
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiveSDKTypeDef.md +422 -396
- package/server-config.js +0 -1
- package/server.js +22 -11
- package/streamable-http.js +0 -1
- package/tools/call/get_native_call_uikit_integration.js +2 -4
- package/tools/call/get_native_callkit_core_integration.js +2 -6
- package/tools/call/get_web_call_uikit_integration.js +2 -4
- package/tools/chat/get_native_chat_uikit_integration.js +2 -4
- package/tools/chat/get_web_chat_uikit_integration.js +2 -4
- package/tools/common/get_usersig.js +0 -1
- package/tools/common/present_framework_choice.js +9 -4
- package/tools/common/record_answer.js +19 -26
- package/tools/common/record_feedback.js +17 -31
- package/tools/common/search_trtc_knowledge.js +44 -0
- package/tools/definitions/get_native_call_uikit_integration_def.js +2 -1
- package/tools/definitions/get_native_callkit_core_integration_def.js +2 -1
- package/tools/definitions/get_native_chat_uikit_integration_def.js +3 -2
- package/tools/definitions/get_native_livekit_core_integration_def.js +2 -1
- package/tools/definitions/get_usersig_def.js +0 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js +2 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js +2 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js +4 -3
- package/tools/definitions/get_web_room_core_integration_def.js +46 -0
- package/tools/definitions/get_web_room_uikit_integration_def.js +3 -1
- package/tools/definitions/integration-boundary.js +5 -0
- package/tools/definitions/present_framework_choice_def.js +11 -10
- package/tools/definitions/record_answer_def.js +9 -8
- package/tools/definitions/record_feedback_def.js +4 -3
- package/tools/definitions/search_trtc_knowledge_def.js +69 -0
- package/tools/index.js +5 -37
- package/tools/live/get_native_livekit_core_integration.js +1 -4
- package/tools/live/get_web_live_uikit_integration.js +2 -5
- package/tools/room/get_web_room_core_integration.js +47 -0
- package/tools/room/get_web_room_uikit_integration.js +2 -4
- package/utils/generate-structured-result.js +4 -11
- package/utils/generate-usersig.js +0 -1
- package/utils/get-device-identifier.js +0 -1
- package/utils/get-doc-content.js +14 -9
- package/utils/http-get.js +0 -1
- package/utils/http-post.js +0 -1
- package/utils/report-cls-client.js +22 -21
- package/utils/report-es-client.js +1 -2
- package/utils/report-runtime-error-cls-client.js +0 -1
- package/index.js.map +0 -1
- package/resource/doc/callkit/core-sdk/.gitkeep +0 -0
- package/resource/doc/callkit/core-sdk/android/answer-call.md +0 -942
- package/resource/doc/callkit/core-sdk/android/make-call.md +0 -876
- package/resource/doc/callkit/core-sdk/android/offline-push.md +0 -368
- package/resource/doc/callkit/core-sdk/flutter/answer-call.md +0 -1132
- package/resource/doc/callkit/core-sdk/flutter/make-call.md +0 -1206
- package/resource/doc/callkit/core-sdk/flutter/offline-push.md +0 -357
- package/resource/doc/callkit/core-sdk/ios/answer-call.md +0 -1009
- package/resource/doc/callkit/core-sdk/ios/make-call.md +0 -1154
- package/resource/doc/callkit/core-sdk/ios/offline-push.md +0 -470
- package/resource/doc/callkit/core-sdk/uni-app/answer-call.md +0 -1146
- package/resource/doc/callkit/core-sdk/uni-app/make-call.md +0 -1267
- package/resource/doc/callkit/faq/android-faq.md +0 -767
- package/resource/doc/callkit/faq/flutter-faq.md +0 -749
- package/resource/doc/callkit/faq/ios-faq.md +0 -759
- package/resource/doc/callkit/faq/web-faq.md +0 -753
- package/resource/doc/callkit/preset/android/api.md +0 -330
- package/resource/doc/callkit/preset/flutter/api.md +0 -401
- package/resource/doc/callkit/preset/ios/api.md +0 -282
- package/resource/doc/callkit/preset/ios/integration.md +0 -188
- package/resource/doc/callkit/preset/react/api.md +0 -600
- package/resource/doc/callkit/preset/react/integration.md +0 -86
- package/resource/doc/callkit/preset/vue/api.md +0 -600
- package/resource/doc/callkit/preset/vue/integration.md +0 -83
- package/resource/doc/chatkit/android/faq.md +0 -109
- package/resource/doc/chatkit/faq/android_sdk/client-api.md +0 -280
- package/resource/doc/chatkit/faq/common/product.md +0 -82
- package/resource/doc/chatkit/faq/common/server.md +0 -53
- package/resource/doc/chatkit/faq/common/server_error_code.md +0 -74
- package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +0 -183
- package/resource/doc/chatkit/faq/flutter_sdk/faq.md +0 -54
- package/resource/doc/chatkit/faq/ios_sdk/client-api.md +0 -279
- package/resource/doc/chatkit/faq/web_sdk/error_code.md +0 -47
- package/resource/doc/chatkit/faq/web_sdk/faq.md +0 -292
- package/resource/doc/chatkit/flutter/faq.md +0 -22
- package/resource/doc/chatkit/ios/faq.md +0 -109
- package/resource/doc/chatkit/react/components/avatar.md +0 -104
- package/resource/doc/chatkit/react/components/chat-header.md +0 -148
- package/resource/doc/chatkit/react/components/chat-setting.md +0 -117
- package/resource/doc/chatkit/react/components/chat.md +0 -38
- package/resource/doc/chatkit/react/components/component-list.md +0 -35
- package/resource/doc/chatkit/react/components/conversation-actions.md +0 -174
- package/resource/doc/chatkit/react/components/conversation-preview.md +0 -116
- package/resource/doc/chatkit/react/components/conversation-search.md +0 -57
- package/resource/doc/chatkit/react/components/search.md +0 -282
- package/resource/doc/chatkit/react/components/tuikit.md +0 -43
- package/resource/doc/chatkit/react/faq.md +0 -26
- package/resource/doc/chatkit/vue/components/avatar.md +0 -104
- package/resource/doc/chatkit/vue/components/chat-header.md +0 -149
- package/resource/doc/chatkit/vue/components/chat.md +0 -42
- package/resource/doc/chatkit/vue/components/component-list.md +0 -89
- package/resource/doc/chatkit/vue/components/tuikit.md +0 -45
- package/resource/doc/chatkit/vue/components/userpicker.md +0 -256
- package/resource/doc/chatkit/vue/faq.md +0 -35
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +0 -148
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +0 -316
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +0 -419
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +0 -325
- package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +0 -436
- package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +0 -165
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +0 -239
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +0 -74
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +0 -417
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +0 -207
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +0 -158
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +0 -304
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +0 -394
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +0 -303
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +0 -410
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +0 -160
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +0 -231
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +0 -375
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +0 -170
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +0 -165
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +0 -143
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +0 -298
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +0 -349
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +0 -297
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +0 -471
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +0 -179
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +0 -238
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +0 -74
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +0 -412
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +0 -173
- package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +0 -365
- package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +0 -336
- package/resource/doc/livekit/preset/live/vue/api-reference/index.md +0 -780
- package/resource/doc/livekit/preset/live/vue/components/barrage.md +0 -291
- package/resource/doc/livekit/preset/live/vue/components/co-guest-panel.md +0 -88
- package/resource/doc/livekit/preset/live/vue/components/live-audience-list.md +0 -164
- package/resource/doc/livekit/preset/live/vue/components/live-scene-panel.md +0 -130
- package/resource/doc/livekit/preset/live/vue/components/live-view.md +0 -203
- package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +0 -211
- package/resource/doc/livekit/preset/live/vue/faq.md +0 -1
- package/resource/doc/roomkit/faq/common/error-code.md +0 -67
- package/resource/doc/roomkit/flutter/features/call-user-to-room.md +0 -228
- package/resource/doc/roomkit/vue/faq.md +0 -1
- package/resource/doc/roomkit/vue/features/device-state.md +0 -460
- package/resource/doc/roomkit/vue/features/room-chat.md +0 -369
- package/resource/doc/roomkit/vue/features/room-participant-state.md +0 -385
- package/resource/doc/roomkit/vue/features/room-state.md +0 -280
- package/resource/doc/roomkit/vue/features/room-view.md +0 -241
- package/resource/doc/roomkit/vue/integration.md +0 -315
- package/resource/doc/rtcengine/faq/web_sdk/.gitkeep +0 -0
- package/resource/doc/trtc/C++/ITXAudioEffectManager.md +0 -472
- package/resource/doc/trtc/C++/ITXDeviceManager.md +0 -388
- package/resource/doc/trtc/android/TXBeautyManager.md +0 -403
- package/resource/doc/trtc/iOS/TXBeautyManager.md +0 -404
- package/resource/doc/trtc/iOS/TXDeviceManager.md +0 -382
- package/server-config.js.map +0 -1
- package/server.js.map +0 -1
- package/streamable-http.js.map +0 -1
- package/tools/call/get_callkit_api.js +0 -33
- package/tools/call/get_callkit_api.js.map +0 -1
- package/tools/call/get_native_call_uikit_integration.js.map +0 -1
- package/tools/call/get_native_callkit_core_integration.js.map +0 -1
- package/tools/call/get_web_call_uikit_integration.js.map +0 -1
- package/tools/chat/get_native_chat_uikit_feature_detail.js +0 -35
- package/tools/chat/get_native_chat_uikit_feature_detail.js.map +0 -1
- package/tools/chat/get_native_chat_uikit_integration.js.map +0 -1
- package/tools/chat/get_web_chat_uikit_component_detail.js +0 -35
- package/tools/chat/get_web_chat_uikit_component_detail.js.map +0 -1
- package/tools/chat/get_web_chat_uikit_integration.js.map +0 -1
- package/tools/common/get_faq.js +0 -266
- package/tools/common/get_faq.js.map +0 -1
- package/tools/common/get_usersig.js.map +0 -1
- package/tools/common/present_framework_choice.js.map +0 -1
- package/tools/common/record_answer.js.map +0 -1
- package/tools/common/record_feedback.js.map +0 -1
- package/tools/common/record_skill_session.js +0 -69
- package/tools/common/record_skill_session.js.map +0 -1
- package/tools/definitions/get_callkit_api_def.js +0 -28
- package/tools/definitions/get_callkit_api_def.js.map +0 -1
- package/tools/definitions/get_faq_def.js +0 -41
- package/tools/definitions/get_faq_def.js.map +0 -1
- package/tools/definitions/get_native_call_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_callkit_core_integration_def.js.map +0 -1
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +0 -31
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_native_chat_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_livekit_core_features_def.js +0 -33
- package/tools/definitions/get_native_livekit_core_features_def.js.map +0 -1
- package/tools/definitions/get_native_livekit_core_integration_def.js.map +0 -1
- package/tools/definitions/get_native_trtc_sdk_docs_def.js +0 -32
- package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +0 -1
- package/tools/definitions/get_usersig_def.js.map +0 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js +0 -31
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_livekit_api_def.js +0 -27
- package/tools/definitions/get_web_livekit_api_def.js.map +0 -1
- package/tools/definitions/get_web_livekit_component_detail_def.js +0 -29
- package/tools/definitions/get_web_livekit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_room_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_roomkit_feature_detail_def.js +0 -30
- package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_api_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_api_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_integration_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +0 -1
- package/tools/definitions/present_framework_choice_def.js.map +0 -1
- package/tools/definitions/record_answer_def.js.map +0 -1
- package/tools/definitions/record_feedback_def.js.map +0 -1
- package/tools/definitions/record_skill_session_def.js +0 -31
- package/tools/definitions/record_skill_session_def.js.map +0 -1
- package/tools/index.js.map +0 -1
- package/tools/live/get_native_livekit_core_features.js +0 -68
- package/tools/live/get_native_livekit_core_features.js.map +0 -1
- package/tools/live/get_native_livekit_core_integration.js.map +0 -1
- package/tools/live/get_web_live_uikit_integration.js.map +0 -1
- package/tools/live/get_web_livekit_api.js +0 -33
- package/tools/live/get_web_livekit_api.js.map +0 -1
- package/tools/live/get_web_livekit_component_detail.js +0 -35
- package/tools/live/get_web_livekit_component_detail.js.map +0 -1
- package/tools/room/get_web_room_uikit_integration.js.map +0 -1
- package/tools/room/get_web_roomkit_feature_detail.js +0 -69
- package/tools/room/get_web_roomkit_feature_detail.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_api.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_api.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_integration.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +0 -1
- package/tools/trtc/get_native_trtc_sdk_docs.js +0 -74
- package/tools/trtc/get_native_trtc_sdk_docs.js.map +0 -1
- package/utils/build-session-directives.js +0 -122
- package/utils/build-session-directives.js.map +0 -1
- package/utils/generate-structured-result.js.map +0 -1
- package/utils/generate-usersig.js.map +0 -1
- package/utils/get-device-identifier.js.map +0 -1
- package/utils/get-doc-content.js.map +0 -1
- package/utils/handle-framework.js +0 -9
- package/utils/handle-framework.js.map +0 -1
- package/utils/handle-state-name.js +0 -29
- package/utils/handle-state-name.js.map +0 -1
- package/utils/http-get.js.map +0 -1
- package/utils/http-post.js.map +0 -1
- package/utils/report-cls-client.js.map +0 -1
- package/utils/report-es-client.js.map +0 -1
- package/utils/report-runtime-error-cls-client.js.map +0 -1
- /package/resource/{doc/callkit/faq/common → knowledge/callkit/faq}/error-code.md +0 -0
- /package/resource/{doc/livekit/faq/common → knowledge/livekit/faq}/error-code.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/api.md +0 -0
- /package/resource/{doc/rtcengine/faq/web/web.md → knowledge/rtcengine/web/faq.md} +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/how_to_integrated_web_sdk.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/28-advanced-beauty.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/29-advanced-water-mark.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/30-advanced-cross-room-link.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/34-advanced-proxy.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/37-advanced-voice-changer.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/38-advanced-basic-beauty.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/40-advanced-video-mixer.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/43-advanced-face-detection.md +0 -0
- /package/resource/{doc/rtcengine/faq/common → knowledge/share}/userSig.md +0 -0
|
@@ -1,89 +0,0 @@
|
|
|
1
|
-
# atomicx 组件库清单与组件的适用场景与注意事项
|
|
2
|
-
|
|
3
|
-
## 组件清单
|
|
4
|
-
|
|
5
|
-
共 25 个组件:
|
|
6
|
-
|
|
7
|
-
### 适用于聊天场景的组件
|
|
8
|
-
|
|
9
|
-
1. ConversationList
|
|
10
|
-
会话列表组件,适用于聊天场景,以纵向列表形态,可以通过点击切换会话,如果仅需要聊天不需要该组件
|
|
11
|
-
2. ChatHeader
|
|
12
|
-
聊天头部组件,是聊天界面的顶部导航组件,用于显示当前会话的基本信息。能够展示会话标题、头像、在线状态、输入状态提示等信息。组件采用容器组件模式,提供了灵活的插槽机制用于自定义左右两侧的操作区域。
|
|
13
|
-
3. MessageInput
|
|
14
|
-
消息输入组件,聊天场景的核心组件,可以发送聊天消息,需要发送消息则必须使用该组件
|
|
15
|
-
4. MessageList
|
|
16
|
-
消息列表组件,聊天场景的核心组件,可以显示聊天消息列表,支持消息的上下滑动,聊天场景必须使用该组件
|
|
17
|
-
5. ContactList
|
|
18
|
-
联系人列表组件,适用于聊天场景,可以显示和管理用户联系人,如果仅需要聊天不需要该组件
|
|
19
|
-
6. ChatSetting
|
|
20
|
-
聊天设置组件,适用于聊天场景,管理聊天相关配置,比如置顶、免打扰,群聊加人、踢人、管理员管理、禁言等,如果仅需要聊天不需要该组件
|
|
21
|
-
7. Search
|
|
22
|
-
搜索组件,用于搜索消息、用户等内容,如果仅需要聊天不需要该组件
|
|
23
|
-
|
|
24
|
-
### 适用于会议场景的组件
|
|
25
|
-
|
|
26
|
-
1. CameraButton
|
|
27
|
-
摄像头控制按钮,仅适用于会议场景,用于开启/关闭摄像头
|
|
28
|
-
2. StreamView
|
|
29
|
-
视频流显示组件,仅适用于会议场景,用于显示视频流
|
|
30
|
-
3. UserList
|
|
31
|
-
用户列表组件,仅适用于会议场景,显示会议或房间中的用户
|
|
32
|
-
4. VideoSetting
|
|
33
|
-
视频设置组件,仅适用于会议场景,用于摄像头、画质等视频配置
|
|
34
|
-
5. VideoSettingPanel
|
|
35
|
-
视频设置面板,仅适用于会议场景,提供完整的视频配置界面
|
|
36
|
-
6. AudioSetting
|
|
37
|
-
音频设置组件,仅适用于会议场景,可以设置麦克风、音量等音频设备配置
|
|
38
|
-
7. AudioSettingPanel
|
|
39
|
-
音频设置面板,仅适用于会议场景,提供完整的音频配置界面
|
|
40
|
-
8. BarrageInput
|
|
41
|
-
弹幕输入组件,适用于会议、直播场景,用于发送直播弹幕消息
|
|
42
|
-
9. BarrageList
|
|
43
|
-
弹幕列表组件,适用于会议、直播场景,显示直播间的弹幕消息
|
|
44
|
-
10. UserPicker
|
|
45
|
-
用户选择器,适用于会议、直播场景,用于邀请用户或分配权限
|
|
46
|
-
11. MicButton
|
|
47
|
-
麦克风控制按钮,适用于会议、直播场景,用于静音/取消静音
|
|
48
|
-
|
|
49
|
-
### 适用于直播场景的组件
|
|
50
|
-
|
|
51
|
-
1. CoGuestPanel
|
|
52
|
-
连麦嘉宾管理面板,仅适用于直播场景,用于直播连麦功能
|
|
53
|
-
2. LiveAudienceList
|
|
54
|
-
直播观众列表,仅适用于直播场景,显示当前直播间的观众
|
|
55
|
-
3. LiveList
|
|
56
|
-
直播房间列表,仅适用于直播场景,展示可用的直播房间
|
|
57
|
-
4. LiveMonitorView
|
|
58
|
-
直播监控视图,仅适用于直播场景,用于直播管理和监控
|
|
59
|
-
5. LiveScenePanel
|
|
60
|
-
直播场景控制面板,仅适用于直播场景,管理直播场景和效果
|
|
61
|
-
6. LiveStreamView
|
|
62
|
-
直播视频流显示组件,仅适用于直播场景,播放直播画面
|
|
63
|
-
7. StreamMixer
|
|
64
|
-
流混合器组件,仅适用于直播场景,用于多路视频流合成
|
|
65
|
-
8. BarrageInput
|
|
66
|
-
弹幕输入组件,适用于会议、直播场景,用于发送直播弹幕消息
|
|
67
|
-
9. BarrageList
|
|
68
|
-
弹幕列表组件,适用于会议、直播场景,显示直播间的弹幕消息
|
|
69
|
-
10. UserPicker
|
|
70
|
-
用户选择器,适用于会议、直播场景,用于邀请用户或分配权限
|
|
71
|
-
11. MicButton
|
|
72
|
-
麦克风控制按钮,适用于会议、直播场景,用于静音/取消静音
|
|
73
|
-
|
|
74
|
-
### 通用组件
|
|
75
|
-
|
|
76
|
-
1. Avatar
|
|
77
|
-
通用头像组件,显示用户头像/在线状态/消息未读数
|
|
78
|
-
2. UserPicker
|
|
79
|
-
用户选择器,用于发起群聊、发起群视频、群语音等选择用户的场景
|
|
80
|
-
|
|
81
|
-
## 注意事项
|
|
82
|
-
|
|
83
|
-
在开始集成任何组件到真实项目之前,**必须**首先确保已经调用以下工具获取到了集成文档,并根据文档进行集成:
|
|
84
|
-
|
|
85
|
-
1. 当创建真实的项目时,请调用 MCP Tools get_atomicx_integration_guide(framework) 的组件集成文档
|
|
86
|
-
2. 当选择使用的组件时,应先考虑满足需求的最少组件,再考虑推荐可额外使用的扩展组件,不要放大需求
|
|
87
|
-
3. 不同场景适用的组件有交集
|
|
88
|
-
4. 根据用户需求,判断有没有可能是一个综合场景,比如聊天 + 直播,概率较低,应该谨慎
|
|
89
|
-
5. 如需了解具体组件的使用方法,请询问用户:"你可以问 ${componentname} 怎么用?" 这样的问题
|
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
## TUIKit 介绍
|
|
2
|
-
|
|
3
|
-
TUIKit 是基于腾讯云 IM SDK 的一款 UI 组件库,它提供了一些通用的 UI 组件,包含会话、聊天、关系链、群组、音视频通话等功能。
|
|
4
|
-
基于 UI 组件您可以像搭积木一样快速搭建起自己的业务逻辑。
|
|
5
|
-
TUIKit 中的组件在实现 UI 功能的同时,会调用 IM SDK 相应的接口实现 IM 相关逻辑和数据的处理,因而开发者在使用 TUIKit 时只需关注自身业务或个性化扩展即可。
|
|
6
|
-
|
|
7
|
-
## TUIKit 主要功能介绍
|
|
8
|
-
|
|
9
|
-
TUIKit 主要分为 Chat、ConversationList、 ChatSetting 、ContactList、Search 几个 UI 子组件,每个 UI 组件负责展示不同的内容。
|
|
10
|
-
TUIKit Web 端界面效果如下图所示:
|
|
11
|
-
|
|
12
|
-
## Chat 重点功能介绍
|
|
13
|
-
|
|
14
|
-
TUIChat 主要负责消息界面的展示。您可以利用它直接发送不同类型的消息,支持文字/表情/图片/视频/文件/自定义等消息类型,同时您还可以利用它对消息长按进行转发/撤回/引用、查询消息已读回执详情等。TUIChat Web 端界面效果如下图所示:
|
|
15
|
-
| 消息界面 | 消息引用/撤回/转发 |
|
|
16
|
-
| --- | --- |
|
|
17
|
-
| | |
|
|
18
|
-
|
|
19
|
-
| 消息快捷操作 | 消息已读回执 |
|
|
20
|
-
| --- | --- |
|
|
21
|
-
| | |
|
|
22
|
-
|
|
23
|
-
## ConversationList 重点功能介绍
|
|
24
|
-
|
|
25
|
-
ConversationList 主要负责会话列表的展示和编辑,包括会话置顶、会话消息免打扰、会话删除等功能。TUIConversation Web 端界面效果如下图所示:
|
|
26
|
-
| 会话菜单 | 在线状态 |
|
|
27
|
-
| --- | --- |
|
|
28
|
-
| | |
|
|
29
|
-
|
|
30
|
-
## Search 重点功能介绍
|
|
31
|
-
|
|
32
|
-
| 全局搜索 | 会话内搜索 |
|
|
33
|
-
| --- | --- |
|
|
34
|
-
| 通过全局搜索,搜索所有包含“你好”的相关文本 | 搜索指定会话内所有文件消息 |
|
|
35
|
-
|
|
36
|
-
## ChatSetting 重点功能介绍
|
|
37
|
-
|
|
38
|
-
ChatSetting 主要负责群资料、群成员、群组权限的管理。TUIGroup Web 端界面效果如下图所示:
|
|
39
|
-
| 群资料及管理 | 群成员管理 |
|
|
40
|
-
| --- | --- |
|
|
41
|
-
| | |
|
|
42
|
-
|
|
43
|
-
## ContactList 重点功能介绍
|
|
44
|
-
|
|
45
|
-
TUIContact 主要负责联系人的展示、权限设置等。TUIContact Web 端界面效果如下图所示:
|
|
@@ -1,256 +0,0 @@
|
|
|
1
|
-
## 概述
|
|
2
|
-
|
|
3
|
-
UserPicker 是一个功能强大的用户选择器组件,支持列表和树形两种显示模式。组件提供了搜索、多选、懒加载、自定义渲染等功能,适用于用户选择、组织架构选择、权限分配等业务场景。组件内置了选择状态管理、搜索过滤、树形展开等复杂逻辑,提供了简洁易用的 API 接口。
|
|
4
|
-
|
|
5
|
-
## Props 速查表
|
|
6
|
-
|
|
7
|
-
| 字段 | 类型 | 默认值 | 描述 |
|
|
8
|
-
| -------------------- | -------------------------------------------- | -------------------------- | ----------- |
|
|
9
|
-
| displayMode | `'list' \| 'tree'` | 必填 | 显示模式,列表或树形 |
|
|
10
|
-
| dataSource | `UserPickerDataSource<T>` | `[]` | 数据源 |
|
|
11
|
-
| defaultSelectedItems | `Array<{ key: string; [key: string]: any }>` | `[]` | 默认选中项 |
|
|
12
|
-
| lockedItems | `Array<{ key: string; [key: string]: any }>` | `[]` | 锁定项(不可取消选择) |
|
|
13
|
-
| maxCount | `number` | `Number.POSITIVE_INFINITY` | 最大选择数量 |
|
|
14
|
-
| minCount | `number` | `0` | 最小选择数量 |
|
|
15
|
-
| enableSearch | `boolean` | `true` | 是否启用搜索功能 |
|
|
16
|
-
| searchPlaceholder | `string` | `undefined` | 搜索框占位符 |
|
|
17
|
-
| renderItem | `Function` | `undefined` | 自定义渲染函数 |
|
|
18
|
-
| onSelectedChange | `Function` | `undefined` | 选择变化回调 |
|
|
19
|
-
| onMaxCountExceed | `Function` | `undefined` | 超出最大数量回调 |
|
|
20
|
-
| onSearch | `Function` | `undefined` | 搜索回调 |
|
|
21
|
-
| onReachEnd | `Function` | `undefined` | 列表模式滚动到底部回调 |
|
|
22
|
-
| onExpand | `Function` | `undefined` | 树形模式展开回调 |
|
|
23
|
-
|
|
24
|
-
## Ref expose 方法速查表
|
|
25
|
-
|
|
26
|
-
|方法名 | 参数 | 返回值 | 描述 |
|
|
27
|
-
| -------- | ---- | ---- | ---- |
|
|
28
|
-
| getSelectedItems | 无 | UserPickerResult<T> | 获取当前选中的项目 |
|
|
29
|
-
| updateTreeData | nodeKey: string, partialNode: Partial<UserPickerNode<T>> | void | 更新树形模式节点数据
|
|
30
|
-
|
|
31
|
-
## Props 详细介绍
|
|
32
|
-
|
|
33
|
-
### displayMode
|
|
34
|
-
|
|
35
|
-
- `类型`: `'list' | 'tree'`
|
|
36
|
-
- `描述`:组件的显示模式。`list` 模式显示平铺列表,`tree` 模式显示树形结构,支持层级展开和懒加载。
|
|
37
|
-
|
|
38
|
-
### dataSource
|
|
39
|
-
|
|
40
|
-
- `类型`: `UserPickerDataSource<T>`
|
|
41
|
-
- `描述`:组件的数据源,根据 displayMode 的不同接受不同的数据结构,默认值为 `[]`。
|
|
42
|
-
|
|
43
|
-
```typescript
|
|
44
|
-
// 列表模式数据结构
|
|
45
|
-
interface UserPickerRow<T = unknown> {
|
|
46
|
-
key: string; // 唯一标识符
|
|
47
|
-
label: string; // 显示名称
|
|
48
|
-
avatarUrl?: string; // 头像URL
|
|
49
|
-
extraData?: T; // 扩展数据
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
// 树形模式数据结构
|
|
53
|
-
interface UserPickerNode<T = unknown> {
|
|
54
|
-
key: string; // 唯一标识符
|
|
55
|
-
label: string; // 显示名称
|
|
56
|
-
isLeafNode: boolean; // 是否为叶子节点
|
|
57
|
-
avatarUrl?: string; // 头像URL
|
|
58
|
-
lazyLoad?: boolean; // 是否支持懒加载
|
|
59
|
-
children?: Array<UserPickerNode<T>>; // 子节点
|
|
60
|
-
extraData?: T; // 扩展数据
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
export type UserPickerDataSource<T = unknown> = Array<UserPickerRow<T>> | Array<UserPickerNode<T>>;
|
|
64
|
-
```
|
|
65
|
-
|
|
66
|
-
#### Example 1: 列表模式数据源
|
|
67
|
-
|
|
68
|
-
```vue
|
|
69
|
-
<template>
|
|
70
|
-
<UserPicker
|
|
71
|
-
display-mode="list"
|
|
72
|
-
:data-source="listData"
|
|
73
|
-
@selected-change="handleSelectionChange"
|
|
74
|
-
/>
|
|
75
|
-
</template>
|
|
76
|
-
|
|
77
|
-
<script setup lang="ts">
|
|
78
|
-
import { ref } from 'vue';
|
|
79
|
-
import { UserPicker } from 'tuikit-atomicx-vue3';
|
|
80
|
-
import type { UserPickerRow } from 'tuikit-atomicx-vue3/types';
|
|
81
|
-
|
|
82
|
-
// 用户列表数据
|
|
83
|
-
const listData = ref<UserPickerRow[]>([
|
|
84
|
-
{
|
|
85
|
-
key: 'user1',
|
|
86
|
-
label: '张三',
|
|
87
|
-
avatarUrl: 'https://example.com/avatar1.jpg',
|
|
88
|
-
extraData: { department: '技术部', role: '前端工程师' }
|
|
89
|
-
},
|
|
90
|
-
{
|
|
91
|
-
key: 'user2',
|
|
92
|
-
label: '李四',
|
|
93
|
-
avatarUrl: 'https://example.com/avatar2.jpg',
|
|
94
|
-
extraData: { department: '产品部', role: '产品经理' }
|
|
95
|
-
}
|
|
96
|
-
]);
|
|
97
|
-
|
|
98
|
-
const handleSelectionChange = (selectedItems: any[]) => {
|
|
99
|
-
console.log('选中的用户:', selectedItems);
|
|
100
|
-
};
|
|
101
|
-
</script>
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
### defaultSelectedItems
|
|
105
|
-
|
|
106
|
-
- `类型`: `Array<{ key: string; [key: string]: any }>`
|
|
107
|
-
- `描述`:默认选中的项目列表,通过 key 字段标识选中项,默认值为 `[]`。
|
|
108
|
-
|
|
109
|
-
### lockedItems
|
|
110
|
-
|
|
111
|
-
- `类型`: `Array<{ key: string; [key: string]: any }>`
|
|
112
|
-
- `描述`:锁定的项目列表,这些项目将被强制选中且用户无法取消选择,默认值为 `[]`。
|
|
113
|
-
|
|
114
|
-
### maxCount
|
|
115
|
-
|
|
116
|
-
- `类型`: `number`
|
|
117
|
-
- `描述`:允许选择的最大数量限制,超出时会触发 onMaxCountExceed 回调,默认值为 `Number.POSITIVE_INFINITY`。
|
|
118
|
-
|
|
119
|
-
### minCount
|
|
120
|
-
|
|
121
|
-
- `类型`: `number`
|
|
122
|
-
- `描述`:要求选择的最小数量,用于表单验证等场景,默认值为 `0`。
|
|
123
|
-
|
|
124
|
-
### enableSearch
|
|
125
|
-
|
|
126
|
-
- `类型`: `boolean`
|
|
127
|
-
- `描述`:是否启用搜索功能,启用后会显示搜索框,默认值为 `true`。
|
|
128
|
-
|
|
129
|
-
### searchPlaceholder
|
|
130
|
-
|
|
131
|
-
- `类型`: `string`
|
|
132
|
-
- `描述`:搜索框的占位符文本,如果不设置则使用默认的国际化文本,默认值为 `undefined`。
|
|
133
|
-
|
|
134
|
-
### renderItem
|
|
135
|
-
|
|
136
|
-
- `类型`: `(data: UserPickerRow<T> | UserPickerNode<T>) => any`
|
|
137
|
-
- `描述`:自定义项目渲染函数,可以自定义每个选项的显示内容和样式,默认值为 `undefined`。
|
|
138
|
-
|
|
139
|
-
```typescript
|
|
140
|
-
type RenderItemFunction<T> = (data: UserPickerRow<T> | UserPickerNode<T>) => VNode | string;
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
#### Example: 自定义渲染函数
|
|
144
|
-
|
|
145
|
-
```vue
|
|
146
|
-
<template>
|
|
147
|
-
<UserPicker
|
|
148
|
-
display-mode="list"
|
|
149
|
-
:data-source="userData"
|
|
150
|
-
:render-item="customRenderItem"
|
|
151
|
-
/>
|
|
152
|
-
</template>
|
|
153
|
-
|
|
154
|
-
<script setup lang="ts">
|
|
155
|
-
import { h } from 'vue';
|
|
156
|
-
import { UserPicker } from 'tuikit-atomicx-vue3';
|
|
157
|
-
import type { UserPickerRow } from 'tuikit-atomicx-vue3/types';
|
|
158
|
-
|
|
159
|
-
const userData = ref<UserPickerRow[]>([
|
|
160
|
-
{
|
|
161
|
-
key: 'user1',
|
|
162
|
-
label: '张三',
|
|
163
|
-
extraData: { status: 'online', department: '技术部' }
|
|
164
|
-
}
|
|
165
|
-
]);
|
|
166
|
-
|
|
167
|
-
// 自定义渲染函数,显示用户状态和部门信息
|
|
168
|
-
const customRenderItem = (data: UserPickerRow) => {
|
|
169
|
-
return h('div', { class: 'custom-user-item' }, [
|
|
170
|
-
h('div', { class: 'user-name' }, data.label),
|
|
171
|
-
h('div', { class: 'user-info' }, [
|
|
172
|
-
h('span', {
|
|
173
|
-
class: `status ${data.extraData?.status}`
|
|
174
|
-
}, data.extraData?.status === 'online' ? '在线' : '离线'),
|
|
175
|
-
h('span', { class: 'department' }, data.extraData?.department)
|
|
176
|
-
])
|
|
177
|
-
]);
|
|
178
|
-
};
|
|
179
|
-
</script>
|
|
180
|
-
```
|
|
181
|
-
|
|
182
|
-
### onSelectedChange
|
|
183
|
-
|
|
184
|
-
- `类型`: `(selectedItems: UserPickerResult<T>) => void`
|
|
185
|
-
- `描述`:选择状态变化时的回调函数,会传入当前选中的所有项目,默认值为 `undefined`。应该尽量减少使用避免频繁的触发回调函数。
|
|
186
|
-
|
|
187
|
-
```typescript
|
|
188
|
-
interface UserPickerResultItem<T = unknown> {
|
|
189
|
-
key: string;
|
|
190
|
-
label: string;
|
|
191
|
-
avatarUrl?: string;
|
|
192
|
-
isLeafNode?: boolean; // 仅树形模式有意义
|
|
193
|
-
extraData?: T;
|
|
194
|
-
path?: string[]; // 仅树形模式有意义,记录节点路径
|
|
195
|
-
}
|
|
196
|
-
|
|
197
|
-
type UserPickerResult<T = unknown> = Array<UserPickerResultItem<T>>;
|
|
198
|
-
```
|
|
199
|
-
|
|
200
|
-
### onMaxCountExceed
|
|
201
|
-
|
|
202
|
-
- `类型`: `(selectedItems: UserPickerResult<T>) => void`
|
|
203
|
-
- `描述`:当选择数量超出 maxCount 限制时触发的回调函数,默认值为 `undefined`。
|
|
204
|
-
|
|
205
|
-
### onSearch
|
|
206
|
-
|
|
207
|
-
- `类型`: `(value: string) => void`
|
|
208
|
-
- `描述`:搜索输入变化时的回调函数,可用于实现服务端搜索,默认值为 `undefined`。
|
|
209
|
-
|
|
210
|
-
### onReachEnd
|
|
211
|
-
|
|
212
|
-
- `类型`: `() => void`
|
|
213
|
-
- `描述`:列表模式下滚动到底部时的回调函数,常用于实现分页加载,默认值为 `undefined`。
|
|
214
|
-
|
|
215
|
-
### onExpand
|
|
216
|
-
|
|
217
|
-
- `类型`: `(node: UserPickerNode<T>) => void`
|
|
218
|
-
- `描述`:树形模式下节点展开时的回调函数,用于实现懒加载子节点,默认值为 `undefined`。
|
|
219
|
-
|
|
220
|
-
## Ref Expose 方法详细介绍
|
|
221
|
-
|
|
222
|
-
### getSelectedItems
|
|
223
|
-
|
|
224
|
-
- `类型`:`() => UserPickerResult<T>`
|
|
225
|
-
- `描述`:作为选择完成后确认时的最佳实践。
|
|
226
|
-
|
|
227
|
-
```typescript
|
|
228
|
-
interface UserPickerResultItem<T = unknown> {
|
|
229
|
-
key: string;
|
|
230
|
-
label: string;
|
|
231
|
-
avatarUrl?: string;
|
|
232
|
-
isLeafNode?: boolean; // 仅树形模式有意义
|
|
233
|
-
extraData?: T;
|
|
234
|
-
path?: string[]; // 仅树形模式有意义,记录节点路径
|
|
235
|
-
}
|
|
236
|
-
|
|
237
|
-
type UserPickerResult<T = unknown> = Array<UserPickerResultItem<T>>;
|
|
238
|
-
```
|
|
239
|
-
|
|
240
|
-
#### Example: 选择完成后确认时获取选中的项
|
|
241
|
-
|
|
242
|
-
```vue
|
|
243
|
-
<template>
|
|
244
|
-
<UserPicker
|
|
245
|
-
ref="userPickerRef"
|
|
246
|
-
display-mode="list"
|
|
247
|
-
:data-source="userData"
|
|
248
|
-
/>
|
|
249
|
-
</template>
|
|
250
|
-
|
|
251
|
-
<script setup lang="ts">
|
|
252
|
-
const userPickerRef = useRef();
|
|
253
|
-
|
|
254
|
-
function onConfirm() {
|
|
255
|
-
userPickerRef.value.getSelectedItems();
|
|
256
|
-
}
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
product: 'Chat'
|
|
3
|
-
tech_stack: 'web_js_sdk'
|
|
4
|
-
framework: 'vue'
|
|
5
|
-
title: 'vue uikit 集成和常见问题解决方案'
|
|
6
|
-
keywords: ['vue', '初始化', '组件', '集成', 'TUIKit']
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
# Vue TUIKit 集成与常见问题解决方案
|
|
10
|
-
|
|
11
|
-
## 模块一:环境准备与快速初始化 (Topic: Setup)
|
|
12
|
-
|
|
13
|
-
### Q: 如何在 Vue 项目中安装 TUIKit?
|
|
14
|
-
|
|
15
|
-
**A:** TUIKit 是基于 Web SDK 开发的,您需要安装 `@tencentcloud/chat-uikit-vue3`。
|
|
16
|
-
|
|
17
|
-
```bash
|
|
18
|
-
# 安装 TUIKit Vue 版本
|
|
19
|
-
npm install @tencentcloud/chat-uikit-vue3@latest
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
## 模块二:常见问题解决方案 (Topic: Question)
|
|
23
|
-
|
|
24
|
-
### Q: 我能不能在 TUIKit 中使用第三方组件库,例如 Element-Plus?
|
|
25
|
-
|
|
26
|
-
**A:** 核心组件之间的粘连代码可以使用其他组件库,这一点在示例代码中也可以看到,例如您可以将 <ChatSetting /> 封装成全屏抽屉组件。但是核心组件内部已经存在的组件暂时不支持修改。
|
|
27
|
-
```typescript
|
|
28
|
-
const isChatSettingShow = ref(false);
|
|
29
|
-
<el-drawer
|
|
30
|
-
v-model="isChatSettingShow"
|
|
31
|
-
title="设置"
|
|
32
|
-
>
|
|
33
|
-
<ChatSetting />
|
|
34
|
-
</el-drawer>
|
|
35
|
-
```
|
|
@@ -1,148 +0,0 @@
|
|
|
1
|
-
## 简介
|
|
2
|
-
|
|
3
|
-
**BarrageStore** 提供了一套完整的弹幕管理 API,包括发送文本弹幕、发送自定义弹幕和添加本地提示消息。
|
|
4
|
-
通过该类,可以在直播间内实现弹幕互动功能。
|
|
5
|
-
|
|
6
|
-
> **重要:**
|
|
7
|
-
>
|
|
8
|
-
|
|
9
|
-
> 使用 **BarrageStore.create** 工厂方法创建 **BarrageStore** 实例,需要传入有效的直播间 ID。
|
|
10
|
-
>
|
|
11
|
-
|
|
12
|
-
> **说明:**
|
|
13
|
-
>
|
|
14
|
-
|
|
15
|
-
> 弹幕状态更新通过 **barrageState** 发布者传递。订阅它以接收房间内弹幕数据的实时更新。
|
|
16
|
-
>
|
|
17
|
-
|
|
18
|
-
## 功能特性
|
|
19
|
-
- **文本弹幕**:支持发送纯文本弹幕消息。
|
|
20
|
-
|
|
21
|
-
- **自定义弹幕**:支持发送自定义格式的弹幕(如带特效的弹幕)。
|
|
22
|
-
|
|
23
|
-
- **本地提示**:支持添加仅本地可见的提示消息。
|
|
24
|
-
|
|
25
|
-
## 可订阅数据
|
|
26
|
-
|
|
27
|
-
**BarrageState** 的字段描述如下:
|
|
28
|
-
| **属性名** | **类型** | **描述** |
|
|
29
|
-
| --- | --- | --- |
|
|
30
|
-
| messageList | StateFlow<List<Barrage>> | 当前房间的弹幕消息列表,支持实时更新并可被订阅监听。 |
|
|
31
|
-
|
|
32
|
-
## API 列表
|
|
33
|
-
| **函数名** | **描述** |
|
|
34
|
-
| --- | --- |
|
|
35
|
-
| BarrageStore.create | 创建弹幕管理实例。 |
|
|
36
|
-
| sendTextMessage | 发送文本弹幕。 |
|
|
37
|
-
| sendCustomMessage | 发送自定义弹幕。 |
|
|
38
|
-
| appendLocalTip | 添加本地提示消息。 |
|
|
39
|
-
|
|
40
|
-
### 创建实例
|
|
41
|
-
|
|
42
|
-
#### BarrageStore.create
|
|
43
|
-
|
|
44
|
-
创建弹幕管理实例。
|
|
45
|
-
|
|
46
|
-
### 发送弹幕
|
|
47
|
-
|
|
48
|
-
#### sendTextMessage
|
|
49
|
-
|
|
50
|
-
发送文本类型弹幕。
|
|
51
|
-
``` kotlin
|
|
52
|
-
abstract fun sendTextMessage(
|
|
53
|
-
text: String?,
|
|
54
|
-
extensionInfo: Map<String, String>?,
|
|
55
|
-
completion: CompletionHandler?
|
|
56
|
-
)
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
**版本信息**
|
|
60
|
-
|
|
61
|
-
从 3.5 版本开始支持。
|
|
62
|
-
|
|
63
|
-
**参数说明**
|
|
64
|
-
| **参数名** | **类型** | **是否必填** | **描述** |
|
|
65
|
-
| --- | --- | --- | --- |
|
|
66
|
-
| text | String? | 必填 | 文本弹幕内容。 |
|
|
67
|
-
| extensionInfo | Map<String,String>? | 必填 | 扩展信息,可包含自定义字段(如指定弹幕颜色、字体大小等)。 |
|
|
68
|
-
| completion | CompletionHandler? | 必填 | 完成回调(成功/失败状态)。 |
|
|
69
|
-
|
|
70
|
-
#### sendCustomMessage
|
|
71
|
-
|
|
72
|
-
发送自定义类型弹幕。
|
|
73
|
-
``` kotlin
|
|
74
|
-
abstract fun sendCustomMessage(
|
|
75
|
-
businessID: String?,
|
|
76
|
-
data: String?,
|
|
77
|
-
completion: CompletionHandler?
|
|
78
|
-
)
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
**版本信息**
|
|
82
|
-
|
|
83
|
-
从 3.5 版本开始支持。
|
|
84
|
-
|
|
85
|
-
**参数说明**
|
|
86
|
-
| **参数名** | **类型** | **是否必填** | **描述** |
|
|
87
|
-
| --- | --- | --- | --- |
|
|
88
|
-
| businessID | String? | 必填 | 业务标识ID,用于区分不同业务场景的自定义弹幕。 |
|
|
89
|
-
| data | String? | 必填 | 自定义数据内容,通常为JSON格式字符串,用于传递业务自定义的数据。 |
|
|
90
|
-
| completion | CompletionHandler? | 必填 | 完成回调(成功/失败状态)。 |
|
|
91
|
-
|
|
92
|
-
### 本地消息
|
|
93
|
-
|
|
94
|
-
#### appendLocalTip
|
|
95
|
-
|
|
96
|
-
添加本地提示消息(在本地添加提示或操作反馈消息,仅当前客户端可见)。
|
|
97
|
-
``` kotlin
|
|
98
|
-
abstract fun appendLocalTip(message: Barrage)
|
|
99
|
-
```
|
|
100
|
-
|
|
101
|
-
**版本信息**
|
|
102
|
-
|
|
103
|
-
从 3.5 版本开始支持。
|
|
104
|
-
|
|
105
|
-
**注意事项**
|
|
106
|
-
|
|
107
|
-
> **说明:**
|
|
108
|
-
>
|
|
109
|
-
|
|
110
|
-
> 该消息仅在本地显示,不会通过网络发送给其他用户。
|
|
111
|
-
>
|
|
112
|
-
|
|
113
|
-
**参数说明**
|
|
114
|
-
| **参数名** | **类型** | **是否必填** | **描述** |
|
|
115
|
-
| --- | --- | --- | --- |
|
|
116
|
-
| message | Barrage | 必填 | 本地弹幕消息(如系统提示、操作反馈等,仅当前用户可见)。 |
|
|
117
|
-
|
|
118
|
-
## 数据结构
|
|
119
|
-
|
|
120
|
-
### BarrageType
|
|
121
|
-
|
|
122
|
-
弹幕类型枚举,用于区分不同的弹幕消息种类。
|
|
123
|
-
| **枚举值** | **值** | **说明** |
|
|
124
|
-
| --- | --- | --- |
|
|
125
|
-
| TEXT | 0 | 文本类型弹幕,包含纯文字内容。 |
|
|
126
|
-
| CUSTOM | 1 | 自定义类型弹幕,支持业务自定义数据格式(如带特效的弹幕、互动消息等)。 |
|
|
127
|
-
|
|
128
|
-
### Barrage
|
|
129
|
-
|
|
130
|
-
弹幕数据模型,包含单条弹幕的完整属性信息。
|
|
131
|
-
| **属性** | **类型** | **说明** |
|
|
132
|
-
| --- | --- | --- |
|
|
133
|
-
| liveID | String | 弹幕所属直播间/语音聊天房的唯一标识ID。 |
|
|
134
|
-
| sender | LiveUserInfo | 弹幕发送者的用户信息(如用户ID、昵称、头像等)。 |
|
|
135
|
-
| sequence | Long | 弹幕消息的唯一序列ID,用于消息排序和去重。 |
|
|
136
|
-
| timestampInSecond | Long | 弹幕发送时间戳(单位:秒),用于展示发送时间顺序。 |
|
|
137
|
-
| messageType | BarrageType | 弹幕消息类型(文本或自定义)。 |
|
|
138
|
-
| textContent | String | 文本类型弹幕的消息内容,即弹幕的文本内容。 |
|
|
139
|
-
| extensionInfo | Map<String,String> | 弹幕扩展信息,可自定义字段(如显示样式、优先级等)。当 messageType 为 TEXT 时有效。 |
|
|
140
|
-
| businessID | String | 自定义类型弹幕的业务标识ID,用于区分不同业务场景的自定义弹幕。 |
|
|
141
|
-
| data | String | 自定义类型弹幕的具体数据内容(通常为JSON格式字符串),当 messageType 为 CUSTOM 时有效。 |
|
|
142
|
-
|
|
143
|
-
### BarrageState
|
|
144
|
-
|
|
145
|
-
弹幕状态,管理当前房间的弹幕数据状态。
|
|
146
|
-
| **属性** | **类型** | **说明** |
|
|
147
|
-
| --- | --- | --- |
|
|
148
|
-
| messageList | StateFlow<List<Barrage>> | 当前房间的弹幕消息列表,支持实时更新并可被订阅监听。 |
|