@tencent-rtc/mcp 1.4.7 → 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/cursor-setting.png +0 -0
- package/knowledge/bm25-cache.js +74 -0
- package/knowledge/bm25-cache.js.map +1 -0
- package/knowledge/bm25.js +148 -0
- package/knowledge/bm25.js.map +1 -0
- package/knowledge/build-index.js +70 -0
- package/knowledge/build-index.js.map +1 -0
- package/knowledge/chunker.js +168 -0
- package/knowledge/chunker.js.map +1 -0
- package/knowledge/content-loader.js +40 -0
- package/knowledge/content-loader.js.map +1 -0
- package/knowledge/doc-url-resolver.js +143 -0
- package/knowledge/doc-url-resolver.js.map +1 -0
- package/knowledge/extractors.js +26 -0
- package/knowledge/extractors.js.map +1 -0
- package/knowledge/path-meta.js +185 -0
- package/knowledge/path-meta.js.map +1 -0
- package/knowledge/search/exact-lookup.js +498 -0
- package/knowledge/search/exact-lookup.js.map +1 -0
- package/knowledge/search/filter-pool.js +105 -0
- package/knowledge/search/filter-pool.js.map +1 -0
- package/knowledge/search/product-scope-intent.js +41 -0
- package/knowledge/search/product-scope-intent.js.map +1 -0
- package/knowledge/search/requires-framework.js +82 -0
- package/knowledge/search/requires-framework.js.map +1 -0
- package/knowledge/search/search-knowledge.js +230 -0
- package/knowledge/search/search-knowledge.js.map +1 -0
- package/mcp-server-prompt.png +0 -0
- package/package.json +1 -1
- package/resource/_schema/feature-aliases.yaml +10 -0
- package/resource/_schema/goal-tags.yaml +72 -0
- package/resource/_schema/products.yaml +19 -0
- package/resource/_schema/trtc-intents.yaml +27 -0
- package/resource/_schema/types.yaml +43 -0
- package/resource/index/component-slugs.json +1 -0
- package/resource/index/doc-source-urls.json +1 -0
- package/resource/index/manifest.json +1 -0
- package/resource/{doc → integration}/callkit/preset/android/integration.md +34 -28
- package/resource/integration/callkit/preset/flutter/integration.md +346 -0
- package/resource/integration/callkit/preset/ios/integration.md +408 -0
- package/resource/integration/callkit/preset/react/integration.md +362 -0
- package/resource/integration/callkit/preset/vue/integration.md +356 -0
- package/resource/integration/chat/preset/android/integration.md +500 -0
- package/resource/integration/chat/preset/flutter/integration.md +370 -0
- package/resource/integration/chat/preset/ios/integration.md +566 -0
- package/resource/integration/chat/preset/react/integration.md +490 -0
- package/resource/integration/chat/preset/vue/integration.md +504 -0
- package/resource/{doc → integration}/livekit/preset/live/vue/live-list-integration.md +26 -22
- package/resource/{doc → integration}/livekit/preset/live/vue/live-player-desk-integration.md +22 -18
- package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +309 -0
- package/resource/{doc → integration}/livekit/preset/live/vue/live-pusher-integration.md +47 -39
- package/resource/integration/roomkit/preset/vue/integration.md +562 -0
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +828 -0
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +897 -0
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +363 -0
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +1111 -0
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +1132 -0
- package/resource/{doc → knowledge}/callkit/core-sdk/flutter/offline-push.md +174 -151
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1084 -0
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +1252 -0
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +534 -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 +92 -0
- package/resource/{doc/callkit/faq/android-faq.md → knowledge/callkit/faq/common.md} +11 -12
- package/resource/knowledge/callkit/faq/error-code.md +67 -0
- package/resource/knowledge/callkit/faq/flutter.md +52 -0
- package/resource/knowledge/callkit/faq/ios.md +104 -0
- package/resource/knowledge/callkit/faq/web.md +74 -0
- package/resource/knowledge/callkit/preset/android/api.md +412 -0
- package/resource/knowledge/callkit/preset/flutter/api.md +22 -0
- package/resource/knowledge/callkit/preset/ios/api.md +234 -0
- package/resource/knowledge/callkit/preset/web/api.md +83 -0
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +74 -0
- package/resource/knowledge/chat/preset/android/features/contact-list.md +43 -0
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +117 -0
- package/resource/knowledge/chat/preset/android/features/language.md +136 -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/knowledge/chat/preset/android/features/theme.md +222 -0
- package/resource/knowledge/chat/preset/android-view/integration.md +300 -0
- package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +64 -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 +158 -0
- package/resource/knowledge/chat/preset/flutter/features/search.md +59 -0
- package/resource/knowledge/chat/preset/flutter/features/theme.md +261 -0
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +94 -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 +125 -0
- package/resource/knowledge/chat/preset/ios/features/message-input.md +69 -0
- package/resource/knowledge/chat/preset/ios/features/message-list.md +162 -0
- package/resource/knowledge/chat/preset/ios/features/search.md +93 -0
- package/resource/knowledge/chat/preset/ios/features/theme.md +270 -0
- package/resource/{doc/chatkit/ios → knowledge/chat/preset/ios-uikit}/integration.md +160 -158
- package/resource/knowledge/chat/preset/react/features/chat-setting.md +101 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/contact-list.md +43 -41
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +215 -0
- package/resource/knowledge/chat/preset/react/features/conversation-list.md +339 -0
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +101 -0
- package/resource/knowledge/chat/preset/react/features/conversation-search.md +61 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-input.md +117 -156
- package/resource/knowledge/chat/preset/react/features/message-list.md +297 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/search.md +65 -59
- package/resource/knowledge/chat/preset/react/features/theme.md +93 -0
- package/resource/knowledge/chat/preset/vue/features/chat-header.md +331 -0
- package/resource/knowledge/chat/preset/vue/features/chat-setting.md +79 -0
- package/resource/knowledge/chat/preset/vue/features/contact-list.md +277 -0
- package/resource/knowledge/chat/preset/vue/features/conversation-actions.md +234 -0
- package/resource/knowledge/chat/preset/vue/features/conversation-list.md +331 -0
- package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +216 -0
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-search.md +13 -13
- package/resource/knowledge/chat/preset/vue/features/message-input.md +551 -0
- package/resource/knowledge/chat/preset/vue/features/message-list.md +350 -0
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/search.md +79 -73
- package/resource/knowledge/chat/preset/vue/features/theme.md +136 -0
- package/resource/knowledge/chat/urls/error-code.md +17 -0
- package/resource/knowledge/chat/urls/product.md +43 -0
- package/resource/knowledge/chat/urls/restapi.md +204 -0
- package/resource/knowledge/chat/urls/sdk/android.md +80 -0
- package/resource/knowledge/chat/urls/sdk/flutter.md +71 -0
- package/resource/knowledge/chat/urls/sdk/ios.md +80 -0
- package/resource/knowledge/chat/urls/sdk/web.md +80 -0
- package/resource/knowledge/chat/urls/webhook.md +68 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +286 -0
- 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/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +55 -0
- 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/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +51 -0
- 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 +488 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +219 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +282 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +212 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +153 -0
- 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 +426 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +166 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +52 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +281 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +150 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +438 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +190 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +291 -0
- 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/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +51 -0
- 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 +487 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +183 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/web/index.md +736 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audience-list.md +53 -47
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-barrage.md +22 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-base-beauty.md +17 -15
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-co-guest-interaction.md +19 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-gift.md +102 -89
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-host-interaction.md +41 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-integration.md +45 -43
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-live-list.md +23 -20
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audience-list.md +41 -41
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audio-effect.md +70 -69
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-barrage.md +68 -71
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-base-beauty.md +43 -47
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-co-guest-interaction.md +59 -56
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-gift.md +103 -105
- package/resource/knowledge/livekit/core-sdk/live/flutter/live-host-interaction.md +869 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-integration.md +84 -87
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-live-list.md +43 -40
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audience-list.md +11 -10
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-barrage.md +22 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-base-beauty.md +15 -14
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-co-guest-interaction.md +19 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-gift.md +54 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-host-interaction.md +41 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-integration.md +40 -40
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-live-list.md +19 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audience-list.md +53 -47
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-barrage.md +22 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +41 -33
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-gift.md +94 -81
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-host-interaction.md +35 -30
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-integration.md +45 -42
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-room-list.md +23 -20
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audience-list.md +260 -0
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audio-effect.md +598 -0
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-barrage.md +490 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +65 -59
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-gift.md +424 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-integration.md +69 -76
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-room-list.md +726 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audience-list.md +11 -10
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-barrage.md +22 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +41 -33
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-gift.md +54 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-host-interaction.md +35 -30
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-integration.md +49 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-room-list.md +19 -18
- package/resource/knowledge/livekit/faq/error-code.md +193 -0
- package/resource/{doc/livekit/preset/live/vue/components → knowledge/livekit/preset/live/vue/features}/barrage.md +56 -53
- package/resource/{doc/livekit/preset/live/vue/components → knowledge/livekit/preset/live/vue/features}/live-audience-list.md +22 -21
- package/resource/{doc/livekit/preset/live/vue/components → knowledge/livekit/preset/live/vue/features}/live-view.md +34 -32
- package/resource/knowledge/push/config/android.md +92 -0
- package/resource/knowledge/push/config/harmonyos.md +83 -0
- package/resource/knowledge/push/config/ios.md +254 -0
- package/resource/knowledge/push/config/react-native.md +254 -0
- package/resource/knowledge/push/config/unity.md +209 -0
- package/resource/knowledge/push/config/unreal-engine.md +194 -0
- package/resource/knowledge/push/integration/android.md +404 -0
- package/resource/knowledge/push/integration/flutter.md +465 -0
- package/resource/knowledge/push/integration/harmonyos.md +63 -0
- package/resource/knowledge/push/integration/ios.md +246 -0
- package/resource/knowledge/push/integration/react-native.md +366 -0
- package/resource/knowledge/push/integration/uni-app.md +208 -0
- package/resource/knowledge/push/integration/unity.md +389 -0
- package/resource/knowledge/push/integration/unreal-engine.md +390 -0
- package/resource/knowledge/push/overview/prepare.md +60 -0
- package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md +241 -0
- package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md +588 -0
- package/resource/knowledge/roomkit/core-sdk/android/room-state.md +364 -0
- package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md +340 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +230 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +797 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/room-state.md +325 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/schedule-room.md +325 -0
- package/resource/knowledge/roomkit/core-sdk/ios/call-user-to-room.md +233 -0
- package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md +569 -0
- package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +325 -0
- package/resource/knowledge/roomkit/core-sdk/ios/schedule-room.md +322 -0
- package/resource/knowledge/roomkit/core-sdk/vue/call-user-to-room.md +221 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/device-detection.md +49 -48
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +461 -0
- package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +216 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +370 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/room-participant-state.md +61 -60
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +280 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/room-view.md +57 -56
- package/resource/knowledge/roomkit/core-sdk/vue/schedule-room.md +319 -0
- package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +267 -0
- package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +261 -0
- package/resource/knowledge/roomkit/preset/android/integration.md +396 -0
- package/resource/knowledge/roomkit/preset/flutter/integration.md +404 -0
- package/resource/knowledge/roomkit/preset/ios/integration.md +369 -0
- package/resource/knowledge/roomkit/preset/react/integration.md +576 -0
- package/resource/knowledge/rtcengine/web/how_to_run_web_sdk_demo.md +44 -0
- package/resource/{doc → knowledge}/rtcengine/web/plugin/21-advanced-auto-play-policy.md +8 -2
- package/resource/{doc → knowledge}/rtcengine/web/plugin/22-advanced-audio-mixer.md +19 -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 +8 -8
- 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 +6 -6
- package/resource/{doc → knowledge}/rtcengine/web/plugin/27-advanced-small-stream.md +3 -3
- package/resource/{doc → knowledge}/rtcengine/web/plugin/29-advanced-water-mark.md +18 -0
- package/resource/{doc → knowledge}/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/34-advanced-proxy.md +2 -2
- package/resource/{doc → knowledge}/rtcengine/web/plugin/35-advanced-ai-denoiser.md +1 -1
- package/resource/knowledge/trtc/android/TRTCCloud.md +1915 -0
- package/resource/knowledge/trtc/android/TRTCCloudDef.md +1029 -0
- package/resource/knowledge/trtc/android/TRTCCloudListener.md +1095 -0
- package/resource/knowledge/trtc/android/TRTCStatistics.md +68 -0
- package/resource/knowledge/trtc/android/TXAudioEffectManager.md +502 -0
- package/resource/knowledge/trtc/android/TXBeautyManager.md +415 -0
- package/resource/knowledge/trtc/android/TXDeviceManager.md +169 -0
- package/resource/knowledge/trtc/android/TXLiteAVCode.md +125 -0
- package/resource/knowledge/trtc/c++/ITRTCCloud.md +2069 -0
- package/resource/knowledge/trtc/c++/ITRTCStatistics.md +73 -0
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +502 -0
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +391 -0
- package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +1191 -0
- package/resource/knowledge/trtc/c++/TRTCTypeDef.md +931 -0
- package/resource/knowledge/trtc/c++/TXLiteAVCode.md +127 -0
- package/resource/knowledge/trtc/ios/TRTCCloud.md +2118 -0
- package/resource/knowledge/trtc/ios/TRTCCloudDef.md +975 -0
- package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +1131 -0
- package/resource/knowledge/trtc/ios/TRTCStatistics.md +68 -0
- package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +423 -0
- package/resource/knowledge/trtc/ios/TXBeautyManager.md +416 -0
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +387 -0
- package/resource/knowledge/trtc/ios/TXLiteAVCode.md +127 -0
- package/server.js +35 -11
- package/server.js.map +1 -1
- package/tools/call/get_native_call_uikit_integration.js +2 -3
- package/tools/call/get_native_call_uikit_integration.js.map +1 -1
- package/tools/call/get_native_callkit_core_integration.js +2 -5
- package/tools/call/get_native_callkit_core_integration.js.map +1 -1
- package/tools/call/get_web_call_uikit_integration.js +2 -3
- package/tools/call/get_web_call_uikit_integration.js.map +1 -1
- package/tools/chat/get_native_chat_uikit_integration.js +2 -3
- package/tools/chat/get_native_chat_uikit_integration.js.map +1 -1
- package/tools/chat/get_web_chat_uikit_integration.js +2 -3
- package/tools/chat/get_web_chat_uikit_integration.js.map +1 -1
- package/tools/common/present_framework_choice.js +19 -13
- package/tools/common/present_framework_choice.js.map +1 -1
- package/tools/common/record_answer.js +19 -25
- package/tools/common/record_answer.js.map +1 -1
- package/tools/common/record_feedback.js +17 -30
- package/tools/common/record_feedback.js.map +1 -1
- package/tools/common/search_trtc_knowledge.js +45 -0
- package/tools/common/search_trtc_knowledge.js.map +1 -0
- package/tools/definitions/get_native_call_uikit_integration_def.js +3 -1
- package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_native_callkit_core_integration_def.js +5 -3
- package/tools/definitions/get_native_callkit_core_integration_def.js.map +1 -1
- package/tools/definitions/get_native_chat_uikit_integration_def.js +5 -2
- package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_native_livekit_core_integration_def.js +6 -5
- package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js +4 -2
- package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js +2 -0
- package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js +5 -5
- package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_room_core_integration_def.js +50 -0
- package/tools/definitions/get_web_room_core_integration_def.js.map +1 -0
- package/tools/definitions/get_web_room_uikit_integration_def.js +5 -4
- package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
- package/tools/definitions/integration-boundary.js +6 -0
- package/tools/definitions/integration-boundary.js.map +1 -0
- package/tools/definitions/present_framework_choice_def.js +12 -10
- package/tools/definitions/present_framework_choice_def.js.map +1 -1
- package/tools/definitions/record_answer_def.js +19 -17
- package/tools/definitions/record_answer_def.js.map +1 -1
- package/tools/definitions/record_feedback_def.js +14 -13
- package/tools/definitions/record_feedback_def.js.map +1 -1
- package/tools/definitions/search_trtc_knowledge_def.js +40 -0
- package/tools/definitions/search_trtc_knowledge_def.js.map +1 -0
- package/tools/index.js +5 -36
- package/tools/index.js.map +1 -1
- package/tools/live/get_native_livekit_core_integration.js +1 -3
- package/tools/live/get_native_livekit_core_integration.js.map +1 -1
- package/tools/live/get_web_live_uikit_integration.js +2 -4
- package/tools/live/get_web_live_uikit_integration.js.map +1 -1
- package/tools/room/get_web_room_core_integration.js +48 -0
- package/tools/room/get_web_room_core_integration.js.map +1 -0
- package/tools/room/get_web_room_uikit_integration.js +2 -3
- package/tools/room/get_web_room_uikit_integration.js.map +1 -1
- package/utils/generate-structured-result.js +24 -30
- package/utils/generate-structured-result.js.map +1 -1
- package/utils/get-doc-content.js +14 -8
- package/utils/get-doc-content.js.map +1 -1
- package/utils/report-cls-client.js +18 -20
- package/utils/report-cls-client.js.map +1 -1
- package/utils/report-es-client.js +1 -1
- package/resource/doc/callkit/core-sdk/.gitkeep +0 -0
- package/resource/doc/callkit/core-sdk/android/answer-call.md +0 -852
- package/resource/doc/callkit/core-sdk/android/make-call.md +0 -954
- package/resource/doc/callkit/core-sdk/android/offline-push.md +0 -361
- package/resource/doc/callkit/core-sdk/flutter/answer-call.md +0 -1160
- package/resource/doc/callkit/core-sdk/flutter/make-call.md +0 -1205
- package/resource/doc/callkit/core-sdk/ios/answer-call.md +0 -1090
- package/resource/doc/callkit/core-sdk/ios/make-call.md +0 -1248
- package/resource/doc/callkit/core-sdk/ios/offline-push.md +0 -485
- package/resource/doc/callkit/core-sdk/uni-app/answer-call.md +0 -950
- package/resource/doc/callkit/core-sdk/uni-app/make-call.md +0 -1052
- package/resource/doc/callkit/faq/common/error-code.md +0 -47
- package/resource/doc/callkit/faq/flutter-faq.md +0 -115
- package/resource/doc/callkit/faq/ios-faq.md +0 -115
- package/resource/doc/callkit/faq/web-faq.md +0 -36
- package/resource/doc/callkit/preset/android/api.md +0 -296
- package/resource/doc/callkit/preset/flutter/api.md +0 -410
- package/resource/doc/callkit/preset/flutter/integration.md +0 -164
- package/resource/doc/callkit/preset/ios/api.md +0 -80
- package/resource/doc/callkit/preset/ios/integration.md +0 -187
- package/resource/doc/callkit/preset/react/api.md +0 -501
- package/resource/doc/callkit/preset/react/integration.md +0 -86
- package/resource/doc/callkit/preset/vue/api.md +0 -501
- package/resource/doc/callkit/preset/vue/integration.md +0 -83
- package/resource/doc/chatkit/android/faq.md +0 -111
- package/resource/doc/chatkit/android/features/theme.md +0 -219
- package/resource/doc/chatkit/android/integration.md +0 -490
- package/resource/doc/chatkit/faq/android_sdk/client-api.md +0 -281
- package/resource/doc/chatkit/faq/common/product.md +0 -7
- package/resource/doc/chatkit/faq/common/server.md +0 -44
- package/resource/doc/chatkit/faq/common/server_error_code.md +0 -74
- package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +0 -199
- package/resource/doc/chatkit/faq/flutter_sdk/faq.md +0 -53
- package/resource/doc/chatkit/faq/ios_sdk/client-api.md +0 -235
- package/resource/doc/chatkit/faq/web_sdk/error_code.md +0 -47
- package/resource/doc/chatkit/faq/web_sdk/faq.md +0 -287
- package/resource/doc/chatkit/flutter/faq.md +0 -23
- package/resource/doc/chatkit/flutter/features/theme.md +0 -235
- package/resource/doc/chatkit/flutter/integration.md +0 -344
- package/resource/doc/chatkit/ios/faq.md +0 -111
- package/resource/doc/chatkit/ios/features/theme.md +0 -267
- 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 -57
- package/resource/doc/chatkit/react/components/chat.md +0 -38
- package/resource/doc/chatkit/react/components/component-list.md +0 -37
- package/resource/doc/chatkit/react/components/conversation-actions.md +0 -174
- package/resource/doc/chatkit/react/components/conversation-list.md +0 -333
- package/resource/doc/chatkit/react/components/conversation-preview.md +0 -118
- package/resource/doc/chatkit/react/components/conversation-search.md +0 -60
- package/resource/doc/chatkit/react/components/message-list.md +0 -293
- package/resource/doc/chatkit/react/components/tuikit.md +0 -34
- package/resource/doc/chatkit/react/faq.md +0 -26
- package/resource/doc/chatkit/react/integration.md +0 -416
- package/resource/doc/chatkit/vue/components/avatar.md +0 -104
- package/resource/doc/chatkit/vue/components/chat-header.md +0 -148
- package/resource/doc/chatkit/vue/components/chat-setting.md +0 -62
- package/resource/doc/chatkit/vue/components/chat.md +0 -45
- package/resource/doc/chatkit/vue/components/component-list.md +0 -87
- package/resource/doc/chatkit/vue/components/contact-list.md +0 -271
- package/resource/doc/chatkit/vue/components/conversation-actions.md +0 -228
- package/resource/doc/chatkit/vue/components/conversation-list.md +0 -320
- package/resource/doc/chatkit/vue/components/conversation-preview.md +0 -213
- package/resource/doc/chatkit/vue/components/message-input.md +0 -1054
- package/resource/doc/chatkit/vue/components/message-list.md +0 -433
- package/resource/doc/chatkit/vue/components/tuikit.md +0 -31
- package/resource/doc/chatkit/vue/components/userpicker.md +0 -256
- package/resource/doc/chatkit/vue/faq.md +0 -36
- package/resource/doc/chatkit/vue/integration.md +0 -428
- package/resource/doc/livekit/core-sdk/live/flutter/live-host-interaction.md +0 -866
- package/resource/doc/livekit/faq/common/error-code.md +0 -88
- package/resource/doc/livekit/preset/live/vue/api-reference/index.md +0 -780
- package/resource/doc/livekit/preset/live/vue/components/co-guest-panel.md +0 -91
- package/resource/doc/livekit/preset/live/vue/components/live-scene-panel.md +0 -112
- package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +0 -215
- package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +0 -300
- package/resource/doc/roomkit/faq/common/error-code.md +0 -67
- package/resource/doc/roomkit/vue/features/call-user-to-room.md +0 -220
- package/resource/doc/roomkit/vue/features/device-state.md +0 -460
- package/resource/doc/roomkit/vue/features/free-beauty-panel.md +0 -215
- package/resource/doc/roomkit/vue/features/room-chat.md +0 -369
- package/resource/doc/roomkit/vue/features/room-state.md +0 -282
- package/resource/doc/roomkit/vue/features/schedule-room.md +0 -318
- package/resource/doc/roomkit/vue/features/screen-share.md +0 -265
- package/resource/doc/roomkit/vue/features/virtual-background.md +0 -271
- package/resource/doc/roomkit/vue/integration.md +0 -315
- package/resource/doc/rtcengine/faq/common/error_code.md +0 -1
- package/resource/doc/rtcengine/faq/web_sdk/.gitkeep +0 -0
- package/resource/doc/rtcengine/web/.gitkeep +0 -0
- package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +0 -59
- package/resource/doc/trtc/C++/ITRTCCloud.md +0 -1970
- package/resource/doc/trtc/C++/ITRTCStatistics.md +0 -70
- package/resource/doc/trtc/C++/ITXAudioEffectManager.md +0 -469
- package/resource/doc/trtc/C++/ITXDeviceManager.md +0 -387
- package/resource/doc/trtc/C++/TRTCCloudCallback.md +0 -1082
- package/resource/doc/trtc/C++/TRTCTypeDef.md +0 -925
- package/resource/doc/trtc/C++/TXLiteAVCode.md +0 -129
- package/resource/doc/trtc/android/TRTCCloud.md +0 -1815
- package/resource/doc/trtc/android/TRTCCloudDef.md +0 -992
- package/resource/doc/trtc/android/TRTCCloudListener.md +0 -1004
- package/resource/doc/trtc/android/TRTCStatistics.md +0 -65
- package/resource/doc/trtc/android/TXAudioEffectManager.md +0 -469
- package/resource/doc/trtc/android/TXBeautyManager.md +0 -402
- package/resource/doc/trtc/android/TXDeviceManager.md +0 -173
- package/resource/doc/trtc/android/TXLiteAVCode.md +0 -127
- package/resource/doc/trtc/iOS/TRTCCloud.md +0 -2028
- package/resource/doc/trtc/iOS/TRTCCloudDef.md +0 -958
- package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +0 -1046
- package/resource/doc/trtc/iOS/TRTCStatistics.md +0 -65
- package/resource/doc/trtc/iOS/TXAudioEffectManager.md +0 -397
- package/resource/doc/trtc/iOS/TXBeautyManager.md +0 -403
- package/resource/doc/trtc/iOS/TXDeviceManager.md +0 -381
- package/resource/doc/trtc/iOS/TXLiteAVCode.md +0 -130
- package/tools/call/get_callkit_api.js +0 -33
- package/tools/call/get_callkit_api.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_web_chat_uikit_component_detail.js +0 -35
- package/tools/chat/get_web_chat_uikit_component_detail.js.map +0 -1
- package/tools/common/get_faq.js +0 -266
- package/tools/common/get_faq.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 -29
- package/tools/definitions/get_callkit_api_def.js.map +0 -1
- package/tools/definitions/get_faq_def.js +0 -47
- package/tools/definitions/get_faq_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_livekit_core_features_def.js +0 -34
- package/tools/definitions/get_native_livekit_core_features_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_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_livekit_api_def.js +0 -30
- package/tools/definitions/get_web_livekit_api_def.js.map +0 -1
- package/tools/definitions/get_web_livekit_component_detail_def.js +0 -32
- package/tools/definitions/get_web_livekit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_roomkit_feature_detail_def.js +0 -31
- package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_api_def.js +0 -27
- package/tools/definitions/get_web_trtc_sdk_api_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_integration_def.js +0 -27
- package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js +0 -27
- package/tools/definitions/get_web_trtc_sdk_plugin_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/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_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_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 -120
- package/utils/build-session-directives.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/report-runtime-error-cls-client.js +0 -91
- package/utils/report-runtime-error-cls-client.js.map +0 -1
- /package/resource/{doc/livekit/preset/live/vue/faq.md → knowledge/push/config/donut.md} +0 -0
- /package/resource/{doc/roomkit/vue/faq.md → knowledge/push/integration/donut.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/30-advanced-cross-room-link.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/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
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
This document provides a detailed introduction to the **barrage component**, including the **barrage message component (BarrageList)** and the **message sending component (BarrageInput)**. You can refer to the sample code in this document for seamless integration of our pre-developed components into your existing project, or customize the style and layout according to your needs by following the component customization section in the document.
|
|
2
2
|
|
|
3
3
|
## Component Composition
|
|
4
|
-
|
|
|
4
|
+
| <strong>Component Name</strong> | <strong>Detailed Description</strong> |
|
|
5
5
|
| --- | --- |
|
|
6
|
-
|
|
|
7
|
-
|
|
|
6
|
+
| <strong>Barrage Message Component (BarrageList)</strong> | A component responsible for real-time display and management of barrage message streams, providing a complete message display solution including <strong>message list rendering, time aggregation, user interaction, and responsive adaptation</strong>. |
|
|
7
|
+
| <strong>Message Sending Component (BarrageInput)</strong> | An input component that provides rich text editing and message sending features, with seamless integration of <strong>emoji selector, character limit, status management, and cross-platform adaptation</strong>, offering users a smooth input experience. |
|
|
8
8
|
|
|
9
9
|
## Component Integration
|
|
10
10
|
|
|
@@ -16,25 +16,25 @@ Before performing quick integration, you need to refer to preparations, meet the
|
|
|
16
16
|
|
|
17
17
|
【npm】
|
|
18
18
|
``` bash
|
|
19
|
-
npm install tuikit-atomicx-vue3
|
|
19
|
+
npm install tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 --save
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
【pnpm】
|
|
23
23
|
``` bash
|
|
24
|
-
pnpm add tuikit-atomicx-vue3
|
|
24
|
+
pnpm add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
【yarn】
|
|
28
28
|
``` bash
|
|
29
|
-
yarn add tuikit-atomicx-vue3
|
|
29
|
+
yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
|
|
30
30
|
```
|
|
31
31
|
|
|
32
32
|
### Step 3: Integrating the Barrage Component
|
|
33
33
|
|
|
34
|
-
Introduce and use the barrage component in your project. You can copy the following example directly to show **a complete live streaming room barrage message component and message
|
|
34
|
+
Introduce and use the barrage component in your project. You can copy the following example directly to show **a complete live streaming room barrage message component and message sending component** in your project.
|
|
35
35
|
``` typescript
|
|
36
36
|
<template>
|
|
37
|
-
<UIKitProvider theme="dark"
|
|
37
|
+
<UIKitProvider theme="dark">
|
|
38
38
|
<div class="app">
|
|
39
39
|
<div class="chat-container">
|
|
40
40
|
<div class="chat-content">
|
|
@@ -51,10 +51,10 @@ Introduce and use the barrage component in your project. You can copy the follow
|
|
|
51
51
|
<script setup lang="ts">
|
|
52
52
|
import { onMounted, ref } from 'vue';
|
|
53
53
|
import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
|
|
54
|
-
import { BarrageList, BarrageInput, useLoginState,
|
|
54
|
+
import { BarrageList, BarrageInput, useLoginState, useLiveListState } from 'tuikit-atomicx-vue3';
|
|
55
55
|
|
|
56
|
-
const { login
|
|
57
|
-
const { joinLive } =
|
|
56
|
+
const { login } = useLoginState();
|
|
57
|
+
const { joinLive } = useLiveListState();
|
|
58
58
|
|
|
59
59
|
async function initLogin() {
|
|
60
60
|
try {
|
|
@@ -71,7 +71,7 @@ async function initLogin() {
|
|
|
71
71
|
onMounted(async () => {
|
|
72
72
|
await initLogin();
|
|
73
73
|
await joinLive({
|
|
74
|
-
liveId: 'input corresponding live streaming room LiveId',
|
|
74
|
+
liveId: 'input corresponding live streaming room LiveId', // enter live room by inputting corresponding liveId
|
|
75
75
|
});
|
|
76
76
|
});
|
|
77
77
|
</script>
|
|
@@ -89,30 +89,31 @@ onMounted(async () => {
|
|
|
89
89
|
> Note: To directly learn about the custom details of the Barrage Message Component (BarrageList), quickly jump to the following link: Barrage Message Component Customization;
|
|
90
90
|
>
|
|
91
91
|
|
|
92
|
-
> Note: To directly learn about the custom details of the Message Sending Component (BarrageInput), quickly jump to the following link: Message Sending Component Customization
|
|
92
|
+
> Note: To directly learn about the custom details of the Message Sending Component (BarrageInput), quickly jump to the following link: Message Sending Component Customization.
|
|
93
93
|
>
|
|
94
94
|
|
|
95
95
|
### Barrage Message Component (BarrageList) Customization
|
|
96
96
|
|
|
97
97
|
#### **Props**
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
|
102
|
-
|
|
|
103
|
-
|
|
|
104
|
-
|
|
|
105
|
-
|
|
|
106
|
-
|
|
|
107
|
-
|
|
|
108
|
-
|
|
|
98
|
+
|
|
99
|
+
|**Parameter Name**|**Parameter Type**|**Default Value**|**Description**|
|
|
100
|
+
|---------|---------|---------|---------|
|
|
101
|
+
|messageAggregationTime|Number|300|Maximum time interval for message grouping (seconds).|
|
|
102
|
+
|filter|(message: IMessageModel) => boolean|-|Functions for filtering messages.|
|
|
103
|
+
|Message|Component|Message|Custom Message Component|
|
|
104
|
+
|MessageTimeDivider|Component|MessageTimeDivider|Custom Message Time Segmentation Component.|
|
|
105
|
+
|LocalNoticeMessage|Component|LocalNoticeMessage|Custom Local Notification Component.|
|
|
106
|
+
|containerStyle|CSSProperties|-|Custom message list container style.|
|
|
107
|
+
|itemStyle|CSSProperties|-|Custom single message item style.|
|
|
108
|
+
|height|String|-|Component height, supports CSS units.|
|
|
109
|
+
|style|CSSProperties|-|Specify the root element's custom style.|
|
|
109
110
|
|
|
110
111
|
As indicated in the table above, the Props custom part of the Barrage Message Component consists of three sections: **component properties, replaceable subcomponents, and custom styles.** Specific content is as shown in the table below.
|
|
111
|
-
|
|
|
112
|
+
| <strong>Content</strong> | <strong>Parameter</strong> |
|
|
112
113
|
| --- | --- |
|
|
113
|
-
|
|
|
114
|
-
|
|
|
115
|
-
|
|
|
114
|
+
| <strong>Component Property</strong> | <code>filter</code>,<code>messageAggregationTime</code> |
|
|
115
|
+
| <strong>Replaceable subcomponent</strong> | <code>Message</code>,<code>MessageTimeDivider</code>,<code>LocalNoticeMessage</code> |
|
|
116
|
+
| <strong>Custom style</strong> | <code>ContainerStyle</code>,<code>ItemStyle</code>,<code>height</code>,<code>style</code> |
|
|
116
117
|
|
|
117
118
|
#### Filter Message
|
|
118
119
|
|
|
@@ -216,39 +217,41 @@ Barrage Message Component provides `containerStyle`, `itemStyle`, `custom child
|
|
|
216
217
|
import MyCustomMessage from "./MyCustomMessage.vue";
|
|
217
218
|
</script>
|
|
218
219
|
```
|
|
219
|
-
|
|
|
220
|
+
| <strong>Before modification</strong> | <strong>After modification</strong> | | |
|
|
220
221
|
| --- | --- | --- | --- |
|
|
221
|
-
|
|
|
222
|
+
| <strong>Custom container padding</strong> | <strong>Custom message item spacing and border</strong> | <strong>Custom Message Component</strong> | |
|
|
222
223
|
| | | | |
|
|
223
224
|
|
|
224
225
|
### Message Sending Component (BarrageInput) Customization
|
|
225
226
|
|
|
226
227
|
#### **Props**
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
|
231
|
-
|
|
|
232
|
-
|
|
|
233
|
-
|
|
|
234
|
-
|
|
|
235
|
-
|
|
|
236
|
-
|
|
|
237
|
-
|
|
|
238
|
-
|
|
|
228
|
+
|
|
229
|
+
|**Parameter Name**|**Type**|**Default Value**|**Description**|
|
|
230
|
+
|---------|---------|---------|---------|
|
|
231
|
+
|containerClass|String|''|Custom container CSS class name.|
|
|
232
|
+
|containerStyle|Record<br>|{}|Inline style of custom container.|
|
|
233
|
+
|width|String|-|Component width, supports CSS units.|
|
|
234
|
+
|height|String|-|Component height, supports CSS units.|
|
|
235
|
+
|minHeight|String|'40px'|Minimum component height, supports CSS units.|
|
|
236
|
+
|maxHeight|String|'140px'|Max component height, supports CSS units.|
|
|
237
|
+
|placeholder|String|-|Placeholder text in the input box.|
|
|
238
|
+
|disabled|Boolean|false|Whether to disable the input box.|
|
|
239
|
+
|autoFocus|Boolean|true|Whether to auto-focus into the input box.|
|
|
240
|
+
|maxLength|Number|80|Maximum character limit for input content.|
|
|
239
241
|
|
|
240
242
|
#### **Events**
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
|
243
|
+
|
|
244
|
+
|**Event Name**|**Parameter**|**Description**|
|
|
245
|
+
|---------|---------|---------|
|
|
246
|
+
|focus|-|Trigger when the input box gets focus.|
|
|
247
|
+
|blur|-|Trigger when the input box loses focus.|
|
|
245
248
|
|
|
246
249
|
As indicated in the table above, the Props custom part of the Message Sending Component consists of three sections: **size control, input restriction, and custom styles.** Specific content is as shown in the table below.
|
|
247
|
-
|
|
|
250
|
+
| <strong>Content</strong> | <strong>Parameter</strong> |
|
|
248
251
|
| --- | --- |
|
|
249
|
-
|
|
|
250
|
-
|
|
|
251
|
-
|
|
|
252
|
+
| <strong>Size control</strong> | <code>width</code>,<code>height</code>,<code>minHeight</code>,<code>minWidth</code> |
|
|
253
|
+
| <strong>Input restriction</strong> | <code>maxLength</code> |
|
|
254
|
+
| <strong>Custom style</strong> | <code>ContainerStyle</code>,<code>ContainerClass</code> |
|
|
252
255
|
|
|
253
256
|
#### Size Control
|
|
254
257
|
|
|
@@ -266,7 +269,7 @@ By setting the `maxLength` parameter, you can control the maximum number of char
|
|
|
266
269
|
|
|
267
270
|
#### Custom Style
|
|
268
271
|
|
|
269
|
-
The message
|
|
272
|
+
The message sending component provides `containerStyle` and `containerClass` attributes for customizing component style.
|
|
270
273
|
1. To customize the input box container style, you can pass a style object to the `containerStyle` attribute.
|
|
271
274
|
|
|
272
275
|
**Example: Custom container background and border rounded corners**
|
|
@@ -285,7 +288,7 @@ The message send component provides `containerStyle` and `containerClass` attrib
|
|
|
285
288
|
|
|
286
289
|
<style>.my-custom-input-container {background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);border: none;border-radius: 20px;padding: 8px 20px;}.my-custom-input-container:focus-within {box-shadow: 0 0 0 3px rgba(102, 126, 234, 0.3);}</style>
|
|
287
290
|
```
|
|
288
|
-
|
|
|
291
|
+
| <strong>Before modification</strong> | <strong>After modification</strong> | |
|
|
289
292
|
| --- | --- | --- |
|
|
290
|
-
|
|
|
293
|
+
| <strong>Custom container background and border rounded corners</strong> | <strong>Custom message item spacing and border</strong> | |
|
|
291
294
|
| | | |
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
This document provides a detailed introduction to the **Audience List Component (LiveAudienceList)**. You can refer to the sample code in this document for seamless integration into your existing project, or customize the style and layout according to your needs by following the component customization section in the document.
|
|
2
2
|
|
|
3
3
|
## Core Features
|
|
4
|
-
|
|
|
4
|
+
| <strong>Feature Category</strong> | <strong>Specific capabilities</strong> |
|
|
5
5
|
| --- | --- |
|
|
6
|
-
|
|
|
7
|
-
|
|
|
8
|
-
|
|
|
6
|
+
| <strong>Real-time audience show</strong> | Display the online audience list in the live streaming room in real time, support avatar and nickname display, and provide a clear audience information view, enabling hosts to intuitively understand audience composition. |
|
|
7
|
+
| <strong>Responsive design</strong> | Component support includes UI solutions for desktop and mobile terminals, automatically adapting to different device screen dimensions to provide consistent user experience and meet multi-platform live streaming needs. |
|
|
8
|
+
| <strong>Customizable UI</strong> | Provide flexible slot mechanism, support customization of audience tags, profile photo style and other elements, enabling you to customize the display effect of the audience list based on business needs, creating a unique visual experience. |
|
|
9
9
|
|
|
10
10
|
## Component Integration
|
|
11
11
|
|
|
@@ -17,17 +17,17 @@ Before performing quick integration, you need to refer to preparations, meet the
|
|
|
17
17
|
|
|
18
18
|
【npm】
|
|
19
19
|
``` bash
|
|
20
|
-
npm install tuikit-atomicx-vue3
|
|
20
|
+
npm install tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 --save
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
【pnpm】
|
|
24
24
|
``` bash
|
|
25
|
-
pnpm add tuikit-atomicx-vue3
|
|
25
|
+
pnpm add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
【yarn】
|
|
29
29
|
``` bash
|
|
30
|
-
yarn add tuikit-atomicx-vue3
|
|
30
|
+
yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
|
|
31
31
|
```
|
|
32
32
|
|
|
33
33
|
### Step 3: Integrating the Audience List Component
|
|
@@ -35,7 +35,7 @@ yarn add tuikit-atomicx-vue3@latest @tencentcloud/uikit-base-component-vue3
|
|
|
35
35
|
Introduce and use the **audience list component** in your project. You can copy the following example code directly to display the live broadcast audience list in your project.
|
|
36
36
|
``` typescript
|
|
37
37
|
<template>
|
|
38
|
-
<UIKitProvider theme="dark"
|
|
38
|
+
<UIKitProvider theme="dark">
|
|
39
39
|
<div class="app">
|
|
40
40
|
<div class="live-audience-container">
|
|
41
41
|
<LiveAudienceList class="live-audience-list"/>
|
|
@@ -47,10 +47,10 @@ Introduce and use the **audience list component** in your project. You can copy
|
|
|
47
47
|
<script setup lang="ts">
|
|
48
48
|
import { onMounted } from 'vue';
|
|
49
49
|
import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
|
|
50
|
-
import { LiveAudienceList, useLoginState,
|
|
50
|
+
import { LiveAudienceList, useLoginState, useLiveListState } from 'tuikit-atomicx-vue3';
|
|
51
51
|
|
|
52
52
|
const { login } = useLoginState();
|
|
53
|
-
const { joinLive } =
|
|
53
|
+
const { joinLive } = useLiveListState();
|
|
54
54
|
|
|
55
55
|
async function initLogin() {
|
|
56
56
|
try {
|
|
@@ -58,6 +58,7 @@ async function initLogin() {
|
|
|
58
58
|
sdkAppId: 0, // SDKAppID, see Step 1 to get
|
|
59
59
|
userId: '', // UserID, see Step 1 to get
|
|
60
60
|
userSig: '', // userSig, see Step 1 to get
|
|
61
|
+
|
|
61
62
|
});
|
|
62
63
|
} catch (error) {
|
|
63
64
|
console.error('login error:', error);
|
|
@@ -80,9 +81,9 @@ onMounted(async () => {
|
|
|
80
81
|
**Audience List Component** provides flexible custom slots, supporting adjustment of audience tags, unique identifiers and other elements' style and layout based on your needs. Below are slot usage examples.
|
|
81
82
|
|
|
82
83
|
### Component Slot
|
|
83
|
-
|
|
|
84
|
+
| <strong>Name</strong> | <strong>Parameter</strong> | <strong>Description</strong> |
|
|
84
85
|
| --- | --- | --- |
|
|
85
|
-
|
|
|
86
|
+
| <strong>customAudienceInfo</strong> | <strong>audience: AudienceInfo</strong> | <strong>Customize audience information display UI</strong> |
|
|
86
87
|
|
|
87
88
|
``` typescript
|
|
88
89
|
// Example of using the customAudienceInfo slot
|
|
@@ -92,13 +93,13 @@ onMounted(async () => {
|
|
|
92
93
|
```
|
|
93
94
|
|
|
94
95
|
`AudienceInfo` defines the basic info and status of each audience in a live streaming room:
|
|
95
|
-
|
|
|
96
|
+
| <strong>Parameter</strong> | <strong>Type</strong> | <strong>Description</strong> |
|
|
96
97
|
| --- | --- | --- |
|
|
97
|
-
|
|
|
98
|
-
|
|
|
99
|
-
|
|
|
100
|
-
|
|
|
101
|
-
|
|
|
98
|
+
| <code>userId</code> | <code>string</code> | The audience's unique identifier must be unique across the entire system. |
|
|
99
|
+
| <code>userName</code> | <code>string</code> | The name displayed for the audience in the live stream supports Chinese and English characters. If empty, the userId is displayed. |
|
|
100
|
+
| <code>avatarUrl</code> | <code>string</code> | The complete URL of the audience avatar supports HTTPS protocol. |
|
|
101
|
+
| <code>isMessageDisabled</code> | <code>boolean</code> | Whether the audience is muted. true indicates muted, false indicates normal speaking. |
|
|
102
|
+
| <code>joinTime</code> | <code>number</code> | Timestamp of audience entering the live room, for sorting and statistics |
|
|
102
103
|
|
|
103
104
|
``` typescript
|
|
104
105
|
interface AudienceInfo {
|
|
@@ -111,10 +112,10 @@ interface AudienceInfo {
|
|
|
111
112
|
```
|
|
112
113
|
|
|
113
114
|
### Component Properties
|
|
114
|
-
|
|
|
115
|
+
| <strong>Attribute name</strong> | <strong>Type</strong> | <strong>Default Value</strong> | <strong>Description</strong> |
|
|
115
116
|
| --- | --- | --- | --- |
|
|
116
|
-
|
|
|
117
|
-
|
|
|
117
|
+
| <code>height</code> | <code>string</code> | <strong>'500px'</strong> | Component height, supports CSS units (px, %, vh) |
|
|
118
|
+
| <code>style</code> | <code>CSSProperties</code> | <strong>{}</strong> | Custom style object used to override component default style |
|
|
118
119
|
|
|
119
120
|
#### Custom Slot Example
|
|
120
121
|
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
This document provides a detailed introduction to the **live stream video component (LiveView)**. You can refer to the sample code in this document to integrate our pre-developed components into your existing project, or customize the style and layout according to your needs by following the component customization section in the document.
|
|
2
2
|
|
|
3
3
|
## Core Features
|
|
4
|
-
|
|
|
4
|
+
| <strong>Feature Category</strong> | <strong>Specific Capacity</strong> |
|
|
5
5
|
| --- | --- |
|
|
6
|
-
|
|
|
7
|
-
|
|
|
6
|
+
| <strong>Smart stream switchover</strong> | LiveView can switch stream types automatically based on the current user's identity (audience or host).<br>- Audience mode: The component plays ultra-low-latency video streams to ensure smooth viewing for millions of audience members while drastically reducing traffic costs.<br>- Connected mode: The component automatically switches to TRTC streaming, providing millisecond-level ultra-low latency to ensure real-time, clear interaction experience between connected users. |
|
|
7
|
+
| <strong>Customizable UI</strong> | To meet diverse business scenarios, LiveView provides custom UI slots, enabling full control over the co-broadcasting user's video stream area. You can rewrite the UI display, flexibly define the user's avatar, nickname, status, and other information, and easily create a unique visual experience that matches your brand style. |
|
|
8
8
|
|
|
9
9
|
## Component Integration
|
|
10
10
|
|
|
@@ -34,7 +34,7 @@ yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
|
|
|
34
34
|
Introduce and use LiveView in your project. Copy the following example code directly to your project to join the corresponding live streaming room for co-streaming.
|
|
35
35
|
``` typescript
|
|
36
36
|
<template>
|
|
37
|
-
<UIKitProvider theme="dark"
|
|
37
|
+
<UIKitProvider theme="dark">
|
|
38
38
|
<div class="app">
|
|
39
39
|
<LiveView />
|
|
40
40
|
</div>
|
|
@@ -44,11 +44,11 @@ Introduce and use LiveView in your project. Copy the following example code dire
|
|
|
44
44
|
<script setup lang="ts">
|
|
45
45
|
import { onMounted } from 'vue';
|
|
46
46
|
import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
|
|
47
|
-
import { LiveView, useLoginState,
|
|
47
|
+
import { LiveView, useLoginState, useLiveListState, useCoGuestState } from 'tuikit-atomicx-vue3';
|
|
48
48
|
|
|
49
49
|
const { login } = useLoginState();
|
|
50
|
-
const { joinLive } =
|
|
51
|
-
const {
|
|
50
|
+
const { joinLive } = useLiveListState();
|
|
51
|
+
const { applyForSeat } = useCoGuestState();
|
|
52
52
|
|
|
53
53
|
async function initLogin() {
|
|
54
54
|
try {
|
|
@@ -73,6 +73,7 @@ onMounted(async () => {
|
|
|
73
73
|
// After the audience successfully goes on mic, LiveView autoplays TRTC streaming.
|
|
74
74
|
await sendCoGuestRequest();
|
|
75
75
|
});
|
|
76
|
+
|
|
76
77
|
</script>
|
|
77
78
|
|
|
78
79
|
<style>.app {width: 100vw; height: 100vh; display: flex; justify-content: center; align-items: center}</style>
|
|
@@ -83,9 +84,10 @@ onMounted(async () => {
|
|
|
83
84
|
LiveView provides flexible component customization slots. These slots support adjusting the style and layout of elements like avatars, nicknames, and status based on your needs, and also allow customizing the video stream area UI for co-streaming. Below are usage examples for the slots.
|
|
84
85
|
|
|
85
86
|
#### Component Slot
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
87
|
+
|
|
88
|
+
|**Name**|**Parameter**|**Description**|
|
|
89
|
+
|---------|---------|---------|
|
|
90
|
+
|streamViewUI|userInfo|Display UI for custom seat|
|
|
89
91
|
|
|
90
92
|
``` java
|
|
91
93
|
// Example of using the streamViewUI slot
|
|
@@ -95,9 +97,9 @@ LiveView provides flexible component customization slots. These slots support ad
|
|
|
95
97
|
```
|
|
96
98
|
1. `userInfo` defines the basic info and status of each seat in a live streaming room:
|
|
97
99
|
|
|
98
|
-
|
|
|
99
|
-
|
|
100
|
-
|
|
100
|
+
|Parameter|Type|Required|Description|
|
|
101
|
+
|---------|---------|---------|---------|
|
|
102
|
+
|`userInfo`|`userInfo`|optional|User information of the current occupant in this seat. If the seat is empty, it is `undefined`.|
|
|
101
103
|
|
|
102
104
|
``` typescript
|
|
103
105
|
interface SeatInfo {
|
|
@@ -106,16 +108,16 @@ LiveView provides flexible component customization slots. These slots support ad
|
|
|
106
108
|
```
|
|
107
109
|
2. `userInfo` defines the user details of each seat in a live streaming room:
|
|
108
110
|
|
|
109
|
-
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
111
|
+
|Parameter|Type|Required|Description|
|
|
112
|
+
|---------|---------|---------|---------|
|
|
113
|
+
|`roomId`|`string`|Required|The unique identifier of the current live streaming room, used to distinguish different live streaming rooms|
|
|
114
|
+
|`userId`|`string`|Required|User's unique identifier must be unique in the entire system|
|
|
115
|
+
|`userName`|`string`|Required|The name displayed for users in live streams supports Chinese and English characters.|
|
|
116
|
+
|`avatarUrl`|`string`|Required|The complete URL address of the user profile photo, supporting HTTPS protocol|
|
|
117
|
+
|`microphoneStatus`|`DeviceStatus`|Required|Microphone status|
|
|
118
|
+
|`microphoneStatusReason`|`DeviceStatusReason`|Required|The cause for mic status change, to distinguish between user proactive operation and administrator operation|
|
|
119
|
+
|`cameraStatus`|`DeviceStatus`|Required|Camera status|
|
|
120
|
+
|`cameraStatusReason`|`DeviceStatusReason`|Required|The cause for camera status change, to distinguish between user proactive operation and administrator operation|
|
|
119
121
|
|
|
120
122
|
``` typescript
|
|
121
123
|
interface SeatUserInfo {
|
|
@@ -142,13 +144,13 @@ LiveView provides flexible component customization slots. These slots support ad
|
|
|
142
144
|
```
|
|
143
145
|
3. `RegionInfo` defines the display area and hierarchical information of the seat in the video canvas:
|
|
144
146
|
|
|
145
|
-
|
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
147
|
+
|Parameter|Type|Required|Description|
|
|
148
|
+
|---------|---------|---------|---------|
|
|
149
|
+
|`x`|`number`|Required|X-coordinate of the region's top-left corner relative to the canvas (pixel value)|
|
|
150
|
+
|`y`|`number`|Required|Y-coordinate of the region's top-left corner relative to the canvas (pixel value)|
|
|
151
|
+
|`w`|`number`|Required|Width of the region (pixel value), must be greater than 0|
|
|
152
|
+
|`h`|`number`|Required|Height of the region (pixel value), must be greater than 0|
|
|
153
|
+
|`zOrder`|`number`|Required|Z-order, the larger the value, the more positioned towards the front, for processing display priority of overlap regions|
|
|
152
154
|
|
|
153
155
|
``` typescript
|
|
154
156
|
interface RegionInfo {
|
|
@@ -160,9 +162,9 @@ LiveView provides flexible component customization slots. These slots support ad
|
|
|
160
162
|
}
|
|
161
163
|
```
|
|
162
164
|
|
|
163
|
-
#### Custom
|
|
165
|
+
#### Custom Mic Seat Example
|
|
164
166
|
|
|
165
|
-
To help you better experience and understand the customized capability of the LiveView component's streamViewUI
|
|
167
|
+
To help you better experience and understand the customized capability of the LiveView component's streamViewUI, we provide a **live streaming and mic connection scenario** example for your reference. You can refer to the above **Step 3** to incrementally copy the following code into your project to achieve a similar scenario effect.
|
|
166
168
|
``` typescript
|
|
167
169
|
<template>
|
|
168
170
|
<LiveView>
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
## Operation step
|
|
2
|
+
|
|
3
|
+
### Step 1. Register your app with vendor push platforms
|
|
4
|
+
|
|
5
|
+
Offline push requires registering your app with each vendor's push platform to obtain parameters such as AppID and AppKey to enable the offline push feature. Currently supported mobile manufacturers are: [Mi](https://dev.mi.com/console/doc/detail), [Huawei](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/service-introduction-0000001050040060), [HONOR](https://developer.hihonor.com/cn/kitdoc), [OPPO](https://open.oppomobile.com/wiki/doc#id=10195), [vivo](https://dev.vivo.com.cn/documentCenter/doc/281), [Meizu](https://open.flyme.cn/service/3), [Google FCM](https://console.firebase.google.com/u/0/).
|
|
6
|
+
|
|
7
|
+
### Step 2. Create resources in the Chat console
|
|
8
|
+
|
|
9
|
+
Log in to Tencent Cloud [Chat Console](https://console.trtc.io/chat/push-plugin-push-identifier), then in the **Push Management** > **Access Settings** feature section, add each vendor's push certificate, and configure the AppID, AppKey, AppSecret, and other parameters obtained in Step 1 to the added push certificate.
|
|
10
|
+
|
|
11
|
+
Explanation of the **Subsequent Actions** option:
|
|
12
|
+
- Open Application: Clicking the notification bar launches the app, by default starting the app's Launcher interface;
|
|
13
|
+
|
|
14
|
+
- Open Web Page: Clicking the notification bar will redirect to the configured web link;
|
|
15
|
+
|
|
16
|
+
- Open the specified interface within the app: clicking the notification bar will redirect the interface based on the configured self Definition, see [Custom Redirect on Click](https://www.tencentcloud.com/zh/document/product/1047/60575).
|
|
17
|
+
|
|
18
|
+
> **Note:**
|
|
19
|
+
>
|
|
20
|
+
|
|
21
|
+
> Each vendor only supports the configuration of one certificate.
|
|
22
|
+
>
|
|
23
|
+
|
|
24
|
+
【Mi】
|
|
25
|
+
|
|
26
|
+
|Vendor Push Platform|Configuring in the Chat console|
|
|
27
|
+
|---------|---------|
|
|
28
|
+
|||
|
|
29
|
+
|
|
30
|
+
【Huawei】
|
|
31
|
+
| Vendor Push Platform | Configuring in the Chat console |
|
|
32
|
+
| --- | --- |
|
|
33
|
+
| | <strong>Note:</strong><br>Client ID corresponds to AppID, Client Secret corresponds to AppSecret. |
|
|
34
|
+
|
|
35
|
+
【OPPO】
|
|
36
|
+
|
|
37
|
+
|Vendor Push Platform|Configuring in the Chat console|
|
|
38
|
+
|---------|---------|
|
|
39
|
+
|||
|
|
40
|
+
|
|
41
|
+
【vivo】
|
|
42
|
+
|
|
43
|
+
|Vendor Push Platform|Configuring in the Chat console|
|
|
44
|
+
|---------|---------|
|
|
45
|
+
|||
|
|
46
|
+
|
|
47
|
+
For receipt configuration, please refer to: [Message Delivery Statistics Configuration - vivo](https://www.tencentcloud.com/document/product/1047/60552#daa658b0-1ac0-44a8-8a47-7ec8822ebe82).
|
|
48
|
+
|
|
49
|
+
【Meizu】
|
|
50
|
+
|
|
51
|
+
|Vendor Push Platform|Configuring in the Chat console|
|
|
52
|
+
|---------|---------|
|
|
53
|
+
|||
|
|
54
|
+
|
|
55
|
+
For receipt configuration, please refer to: [Message Delivery Statistics Configuration - Meizu](https://www.tencentcloud.com/document/product/1047/60552#daa658b0-1ac0-44a8-8a47-7ec8822ebe82).
|
|
56
|
+
|
|
57
|
+
【HONOR】
|
|
58
|
+
|
|
59
|
+
|Vendor Push Platform|Configuring in the Chat console|
|
|
60
|
+
|---------|---------|
|
|
61
|
+
|||
|
|
62
|
+
|
|
63
|
+
【Google FCM】
|
|
64
|
+
|
|
65
|
+
|Vendor Push Platform|Configuring in the Chat console|
|
|
66
|
+
|---------|---------|
|
|
67
|
+
|||
|
|
68
|
+
|
|
69
|
+
> **Note:**
|
|
70
|
+
>
|
|
71
|
+
|
|
72
|
+
> Regarding **Click for Subsequent Actions** supports the Report Statistics feature:
|
|
73
|
+
>
|
|
74
|
+
> 1. If you choose to open an app or a web page, purchasing the plugin will by default support reporting statistics.
|
|
75
|
+
> 2. If you choose to open a specified interface within the application:
|
|
76
|
+
> - For new certificate status, please directly use the auto-fill default value to support click statistics reporting.
|
|
77
|
+
> - If there was a certificate configured previously, continue using the old certificate and modify it to the default value to support reporting statistics, or regenerate a new certificate.
|
|
78
|
+
|
|
79
|
+
### About FCM Data Messaging
|
|
80
|
+
|
|
81
|
+
FCM provides two push methods: Notification Message and Data Messaging.
|
|
82
|
+
- Notification messages have a simple style and do not differentiate between devices. Once successfully integrated, offline push can be performed.
|
|
83
|
+
|
|
84
|
+
- Data Messaging, offering rich customization for specific devices, supports reach and click reporting, and requires testing on the device before going live after integration.
|
|
85
|
+
|
|
86
|
+
The console defaults to Notification Message, and switching between modes can be done in the Chat Console:
|
|
87
|
+
|
|
88
|
+
> **Note:**
|
|
89
|
+
>
|
|
90
|
+
|
|
91
|
+
> FCM data messaging capability only supports TIMPush version 7.8 and above on pixel phones. Other manufacturers' devices need to be tested for support.
|
|
92
|
+
>
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
> **Note:**
|
|
2
|
+
>
|
|
3
|
+
|
|
4
|
+
> Each vendor only supports the configuration of one certificate.
|
|
5
|
+
>
|
|
6
|
+
|
|
7
|
+
## HarmonyOS Console Configuration
|
|
8
|
+
|
|
9
|
+
### Step 1: Enabling the Push Service
|
|
10
|
+
1. Log in to [AppGallery Connect](https://developer.huawei.com/consumer/cn/service/josp/agc/index.html#/), select **Develop and Services** on the homepage, choose the corresponding project, and click **Enable Now** to enable the push service.
|
|
11
|
+
|
|
12
|
+
2. In the project setting, search for "Push" on the API management tab and enable the push service.
|
|
13
|
+
|
|
14
|
+
### Step 2: Certificate and Signature Application
|
|
15
|
+
1. **Certificate application: You must apply for a debug certificate in the debug stage, and apply for a release certificate in the release stage.**
|
|
16
|
+
|
|
17
|
+
- Log in to [AppGallery Connect](https://developer.huawei.com/consumer/cn/service/josp/agc/index.html), select **Certificates, APP ID and Profile**.
|
|
18
|
+
|
|
19
|
+
- Select **Certificates, APP ID and Profile** in the left sidebar, choose **Certificate**, then click **Add Certificate** on the **Certificate** page.
|
|
20
|
+
|
|
21
|
+
- In the pop-up "Add Certificate" window, fill in the applied certificate information and click **Submit**.
|
|
22
|
+
|
|
23
|
+
> **Note:**
|
|
24
|
+
>
|
|
25
|
+
|
|
26
|
+
> Certificate request file (CSR) need to be applied for in DevEco Studio. For details, see [generate certificate request file](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/ide-signing#section462703710326).
|
|
27
|
+
>
|
|
28
|
+
|
|
29
|
+
- After a successful application, the **certificate management** page displays the certificate name and other information. Click **Download** to save the generated certificate to your local directory for subsequent debug signature usage.
|
|
30
|
+
|
|
31
|
+
2. **Register debug device (required during debug stage only)**
|
|
32
|
+
|
|
33
|
+
- Log in to [AppGallery Connect](https://developer.huawei.com/consumer/cn/service/josp/agc/index.html), select **Certificates, APP ID and Profile**.
|
|
34
|
+
|
|
35
|
+
- Select **Certificates, APP ID and Profile** in the left sidebar, choose **Device**, then enter the **Device** page.
|
|
36
|
+
|
|
37
|
+
- To add a single device, click **Add Device** in the upper right corner, fill in the device information in the popup window, then click **Submit** once completed.
|
|
38
|
+
|
|
39
|
+
> **Note:**
|
|
40
|
+
>
|
|
41
|
+
|
|
42
|
+
> Note: For how to obtain UDID for different device types, please refer to [UDID Retrieval Method](https://developer.huawei.com/consumer/cn/doc/app/agc-help-add-device-0000001946142249#section67331926102911).
|
|
43
|
+
>
|
|
44
|
+
|
|
45
|
+
3. **Profile file application: You must apply for a debug profile file in the debug stage, and apply for a release profile file in the release stage.**
|
|
46
|
+
|
|
47
|
+
- Log in to [AppGallery Connect](https://developer.huawei.com/consumer/cn/service/josp/agc/index.html), select **Certificates, APP ID and Profile**.
|
|
48
|
+
|
|
49
|
+
- Select **Profile** in the left sidebar, then click **Add**.
|
|
50
|
+
|
|
51
|
+
- On the **Add Profile** page, enter the application name, profile name and other required information, then click **Add** once all information is provided.
|
|
52
|
+
|
|
53
|
+
4. **Manual signing.**
|
|
54
|
+
|
|
55
|
+
Configure the SecretKey (.p12) file, applied debug certificate (.cer) file, and debug Profile (.p7b) file in DevEco Studio. In the **File > Project Structure > Project > Signing Configs** window, uncheck "Automatically generate signature" (if it is a HarmonyOS app, check "**Support HarmonyOS**"), then configure the project's signature information.
|
|
56
|
+
|
|
57
|
+
### Step 3: Create an IM Console Certificate Credential
|
|
58
|
+
1. Log in to the [API Console](https://gitee.com/link), click **My APIs** in the sidebar on the left side of the page. Ensure push service is available under the project name. If not, click **Apply for new HMS API service** on the right.
|
|
59
|
+
|
|
60
|
+
2. Click in the left sidebar **API service** > **Credential**, then click **Create credential** under **Service account key**.
|
|
61
|
+
|
|
62
|
+
3. Fill in the required fields and click **Create public/private key**. Create and download the JSON file. The downloaded file is exactly your Service Account credential file.
|
|
63
|
+
|
|
64
|
+
4. Save the downloaded file for IM Console Configuration usage.
|
|
65
|
+
|
|
66
|
+
### Step 4: Apply for Scenario-Based Rights and Interests
|
|
67
|
+
|
|
68
|
+
Push Kit supports various scenario-based message types. Among them, certain scenario-based message types require you to apply for special rights and interests for normal sending, such as Chat message type scenarios.
|
|
69
|
+
|
|
70
|
+
Log in to [AppGallery Connect](https://developer.huawei.com/consumer/cn/service/josp/agc/index.html), select **Develop and Services**, click **Push Service**, and on the **Configuration** page, click to apply for self-categorization benefits. Follow the prompts to apply and activate. For detailed introduction, refer to [Push Scenario-Based Message Benefits](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/push-apply-right).
|
|
71
|
+
|
|
72
|
+
## Chat Console Configuration
|
|
73
|
+
1. Log in to [Chat Console](https://console.qcloud.com/avc), go to the [Chat > Push > Access Settings](https://console.trtc.io/chat/push-plugin-push-identifier) page, and click Add Certificate to create a certificate.
|
|
74
|
+
|
|
75
|
+
2. Select the certificate credential generated in Procedure 3 above and upload it to the newly added HarmonyOS certificate.
|
|
76
|
+
|
|
77
|
+
3. Click subsequent actions
|
|
78
|
+
|
|
79
|
+
- Open app: Click the notification bar message to pull up the application homepage by default.
|
|
80
|
+
|
|
81
|
+
- Open specified in-app page: After receiving a push message, click the notification bar. The component will Webhook this click event and offline message pass-through.
|
|
82
|
+
|
|
83
|
+
4. After adding a certificate, the IM console will allocate a certificate ID for you to access and use.
|