@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
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
## TUICallKit (Includes UI Components)
|
|
2
|
+
|
|
3
|
+
TUICallKit is an audio and video call component that **includes a UI component**. You can quickly implement a WhatsApp-like audio and video calling scenario with this component.
|
|
4
|
+
|
|
5
|
+
|API|Description|
|
|
6
|
+
|---------|---------|
|
|
7
|
+
|[init](https://www.tencentcloud.com/document/product/647/51015#init)|Initialize TUICallKit.|
|
|
8
|
+
|[calls](https://www.tencentcloud.com/document/product/647/51015#calls)|Initiate a one-to-one or multi-person call.|
|
|
9
|
+
|[join](https://www.tencentcloud.com/document/product/647/51015#join)|Proactively join a call.|
|
|
10
|
+
|[setCallingBell](https://www.tencentcloud.com/document/product/647/51015#setCallingBell)|Customize user's ringtone.|
|
|
11
|
+
|[setSelfInfo](https://www.tencentcloud.com/document/product/647/51015#setSelfInfo)|Set your own nickname and avatar.|
|
|
12
|
+
|[enableMuteMode](https://www.tencentcloud.com/document/product/647/51015#enableMuteMode)|Turn on/off ringtone.|
|
|
13
|
+
|[enableFloatWindow](https://www.tencentcloud.com/document/product/647/51015#enableFloatWindow)|Turn on/off the floating window function.|
|
|
14
|
+
|[enableVirtualBackground](https://www.tencentcloud.com/document/product/647/51015#enableVirtualBackground)|Turn on/off the blurred background function button.|
|
|
15
|
+
|[setLanguage](https://www.tencentcloud.com/document/product/647/51015#setLanguage)|Set the call language for the TUICallKit component.|
|
|
16
|
+
|[hideFeatureButton](https://www.tencentcloud.com/document/product/647/51015#hideFeatureButton)|Hidden Button.|
|
|
17
|
+
|[setLocalViewBackgroundImage](https://www.tencentcloud.com/document/product/647/51015#setLocalViewBackgroundImage)|Set the background image for the local user's call interface.|
|
|
18
|
+
|[setRemoteViewBackgroundImage](https://www.tencentcloud.com/document/product/647/51015#setRemoteViewBackgroundImage)|Set the background image for the remote user's call interface.|
|
|
19
|
+
|[setLayoutMode](https://www.tencentcloud.com/document/product/647/51015#setLayoutMode)|Set the call interface layout mode.|
|
|
20
|
+
|[setCameraDefaultState](https://www.tencentcloud.com/document/product/647/51015#setCameraDefaultState)|Set whether the camera is opened by default.|
|
|
21
|
+
|[destroyed](https://www.tencentcloud.com/document/product/647/51015#destroyed)|Destroy TUICallKit.|
|
|
22
|
+
|[getTUICallEngineInstance](https://www.tencentcloud.com/document/product/647/51015#getTUICallEngineInstance)|Get TUICallEngine instance.|
|
|
23
|
+
|
|
24
|
+
## TUICallEngine (No UI)
|
|
25
|
+
|
|
26
|
+
TUICallEngine API is an audio and video call component that **offers a No UI interface**. You can use this set of APIs to custom encapsulate according to your business needs.
|
|
27
|
+
|
|
28
|
+
|API|Description|
|
|
29
|
+
|---------|---------|
|
|
30
|
+
|[createInstance](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#.createInstance)|Creating a TUICallEngine Instance (Singleton Pattern)|
|
|
31
|
+
|[destroyInstance](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#destroyInstance)|Terminating a TUICallEngine Instance (Singleton Pattern)|
|
|
32
|
+
|[on](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#on)|Listening on events|
|
|
33
|
+
|[off](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#off)|Canceling Event Listening|
|
|
34
|
+
|[login](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#login)|Sign in Interface|
|
|
35
|
+
|[logout](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#logout)|Logout Interface|
|
|
36
|
+
|[setSelfInfo](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#setSelfInfo)|Configure the user's nickname and profile photo|
|
|
37
|
+
|[calls](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#calls)|Initiate a one-on-one call|
|
|
38
|
+
|[join](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#join)|Proactively join a call.|
|
|
39
|
+
|[accept](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#accept)|Answer Calls|
|
|
40
|
+
|[reject](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#reject)|Decline Call|
|
|
41
|
+
|[hangup](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#hangup)|End Calls|
|
|
42
|
+
|[startRemoteView](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#startRemoteView)|Initiate Remote Screen Rendering|
|
|
43
|
+
|[stopRemoteView](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#stopRemoteView)|Stop Remote Screen Rendering|
|
|
44
|
+
|[openCamera](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#openCamera)|Enable the camera|
|
|
45
|
+
|[closeCamera](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#closeCamera)|Turn Off Camera|
|
|
46
|
+
|[switchCamera](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#switchCamera)|Switch between front and rear cameras, note: only supported on mobile devices.|
|
|
47
|
+
|[openMicrophone](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#openMicrophone)|Enable Microphone|
|
|
48
|
+
|[closeMicrophone](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#closeMicrophone)|Turn off the microphone|
|
|
49
|
+
|[setVideoQuality](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#setVideoQuality)|Set video quality|
|
|
50
|
+
|[getDeviceList](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#getDeviceList)|Access device list|
|
|
51
|
+
|[switchDevice](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#switchDevice)|Switch camera or microphone devices|
|
|
52
|
+
|[enableMultiDeviceAbility](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#enableMultiDeviceAbility)|Turn on/off the multi-device login mode of TUICallEngine.|
|
|
53
|
+
|[setBlurBackground](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#setBlurBackground)|Switch/set background blur|
|
|
54
|
+
|[setVirtualBackground](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#setVirtualBackground)|Switch/set image background blur|
|
|
55
|
+
|
|
56
|
+
## Event Types
|
|
57
|
+
|
|
58
|
+
TUICallEvent is the callback event class corresponding to TUICallEngine. Through this callback, you can listen to the callback events of interest.
|
|
59
|
+
|
|
60
|
+
|EVENT|Description|
|
|
61
|
+
|---------|---------|
|
|
62
|
+
|[TUICallEvent.ERROR](https://www.tencentcloud.com/document/product/647/51017#error)|An error occurred during the call.|
|
|
63
|
+
|[TUICallEvent.KICKED_OUT](https://www.tencentcloud.com/document/product/647/51017#kicked_out)|Receiving this event after a duplicate sign-in indicates that the user has been removed from the room|
|
|
64
|
+
|[TUICallEvent.USER_ACCEPT](https://www.tencentcloud.com/document/product/647/51017#user_accept)|If a user answers, this event will be received.** v4.x.x is deprecated**|
|
|
65
|
+
|[TUICallEvent.USER_ENTER](https://www.tencentcloud.com/document/product/647/51017#user_enter)|A user joined the call.|
|
|
66
|
+
|[TUICallEvent.USER_LEAVE](https://www.tencentcloud.com/document/product/647/51017#user_leave)|A user left the call.|
|
|
67
|
+
|[TUICallEvent.REJECT](https://www.tencentcloud.com/document/product/647/51017#reject)|A user declined the call.|
|
|
68
|
+
|[TUICallEvent.NO_RESP](https://www.tencentcloud.com/document/product/647/51017#no_resp)|A user didn't respond.|
|
|
69
|
+
|[TUICallEvent.LINE_BUSY](https://www.tencentcloud.com/document/product/647/51017#line_busy)|A user was busy.|
|
|
70
|
+
|[TUICallEvent.USER_VIDEO_AVAILABLE](https://www.tencentcloud.com/document/product/647/51017#user_video_available)|Whether a user has a video stream.|
|
|
71
|
+
|[TUICallEvent.USER_AUDIO_AVAILABLE](https://www.tencentcloud.com/document/product/647/51017#user_audio_available)|Whether a user has an audio stream.|
|
|
72
|
+
|[TUICallEvent.USER_VOICE_VOLUME](https://www.tencentcloud.com/document/product/647/51017#user_voice_volume)|The volume levels of all users.|
|
|
73
|
+
|TUICallEvent.ON_CALL_BEGIN|Call connected event|
|
|
74
|
+
|TUICallEvent.ON_CALL_RECEIVED|Call request event|
|
|
75
|
+
|TUICallEvent.ON_CALL_CONNECTED|Call not connected event|
|
|
76
|
+
|TUICallEvent.ON_CALL_END|The call ended.|
|
|
77
|
+
|[TUICallEvent.DEVICED_UPDATED](https://www.tencentcloud.com/document/product/647/51017#deviced_updated)|Device list update, this event will be received|
|
|
78
|
+
|TUICallEvent.ON_USER_NETWORK_QUALITY_CHANGED|All user network quality events|
|
|
79
|
+
|
|
80
|
+
## Document Link
|
|
81
|
+
- [TUICallEngine](https://www.tencentcloud.com/document/product/647/51016)
|
|
82
|
+
|
|
83
|
+
- [TUICallEvent](https://www.tencentcloud.com/document/product/647/51017)
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
## Component Overview
|
|
2
|
+
|
|
3
|
+
ChatSetting is a set of chat settings components built with Jetpack Compose. It includes two main components: C2CChatSetting (C2C Chat Settings) and GroupChatSetting (Group Chat Settings).
|
|
4
|
+
|
|
5
|
+
These components offer comprehensive chat session management features, such as user information management, permission controls, group management, and other essential capabilities.
|
|
6
|
+
| <strong>C2C Chat Settings Interface</strong> | <strong>Group Chat Settings Interface</strong> |
|
|
7
|
+
| --- | --- |
|
|
8
|
+
| | |
|
|
9
|
+
|
|
10
|
+
## Component Integration
|
|
11
|
+
|
|
12
|
+
The ChatSetting component is included in TUIKit Compose. To use ChatSetting, integrate TUIKit Compose into your project. For detailed integration steps, see the [TUIKit Compose documentation](https://www.tencentcloud.com/document/product/1047/77459).
|
|
13
|
+
|
|
14
|
+
## Component Structure
|
|
15
|
+
|
|
16
|
+
ChatSetting consists of two main components: C2CChatSetting (C2C Chat Settings) and GroupChatSetting (Group Chat Settings). Each component offers a variety of configuration options.
|
|
17
|
+
|
|
18
|
+
### C2C Chat Settings (C2CChatSetting)
|
|
19
|
+
|
|
20
|
+
#### Public Methods
|
|
21
|
+
| Method | Parameter | Description |
|
|
22
|
+
| --- | --- | --- |
|
|
23
|
+
| <code>C2CChatSetting</code> | <code>userID: String</code> | The user ID of the other participant. Used to identify the chat target. |
|
|
24
|
+
| <code>modifier: Modifier</code> | Jetpack Compose modifier for setting the component's style, layout, behavior, and appearance. | |
|
|
25
|
+
| <code>onSendMessageClick: () -> Unit</code> | Webhook triggered when the Send Message button is clicked. Optional parameter. | |
|
|
26
|
+
| <code>onContactDelete: () -> Unit</code> | Webhook triggered when the Delete Contact button is clicked. Optional parameter. | |
|
|
27
|
+
| <code>c2cChatSettingViewModelFactory: C2CChatSettingViewModelFactory</code> | Factory for creating the internal C2CChatSettingViewModel. Typically, you do not need to provide this manually, as the component supplies a default implementation. | |
|
|
28
|
+
|
|
29
|
+
### Group Chat Settings (GroupChatSetting)
|
|
30
|
+
|
|
31
|
+
#### Public Methods
|
|
32
|
+
| Method | Parameter | Description |
|
|
33
|
+
| --- | --- | --- |
|
|
34
|
+
| <code>GroupChatSetting</code> | <code>groupID: String</code> | Group ID. Used to identify the group chat. |
|
|
35
|
+
| <code>modifier: Modifier</code> | Jetpack Compose modifier for setting the component's style, layout, behavior, and appearance. | |
|
|
36
|
+
| <code>onSendMessageClick: () -> Unit</code> | Webhook triggered when the Send Message button is clicked. Optional parameter. | |
|
|
37
|
+
| <code>onGroupMemberClick: (GroupMember) -> Unit </code> | Webhook triggered when a group member is clicked. Optional parameter. | |
|
|
38
|
+
| <code>onGroupDelete: () -> Unit</code> | Webhook triggered when the Dissolve/Leave Group button is clicked. Optional parameter. | |
|
|
39
|
+
| <code>groupChatSettingViewModelFactory: GroupChatSettingViewModelFactory</code> | Factory for creating the internal GroupChatSettingViewModel. Typically, you do not need to provide this manually, as the component supplies a default implementation. | |
|
|
40
|
+
|
|
41
|
+
## Basic Usage
|
|
42
|
+
|
|
43
|
+
To display the C2C Chat Settings page, initialize C2CChatSetting as shown below:
|
|
44
|
+
``` swift
|
|
45
|
+
Box {
|
|
46
|
+
C2CChatSetting(
|
|
47
|
+
userID = userID,
|
|
48
|
+
onSendMessageClick = {
|
|
49
|
+
// Handle send message click event
|
|
50
|
+
},
|
|
51
|
+
onContactDelete = {
|
|
52
|
+
// Handle contact delete click event
|
|
53
|
+
},
|
|
54
|
+
)
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
To display the Group Chat Settings page, initialize GroupChatSetting as shown below:
|
|
59
|
+
``` swift
|
|
60
|
+
Box {
|
|
61
|
+
GroupChatSetting(
|
|
62
|
+
groupID = groupID,
|
|
63
|
+
onGroupMemberClick = { groupMember ->
|
|
64
|
+
// Handle group member click event
|
|
65
|
+
},
|
|
66
|
+
onSendMessageClick = {
|
|
67
|
+
// Handle send message click event
|
|
68
|
+
},
|
|
69
|
+
onGroupDelete = {
|
|
70
|
+
// Handle dissolve/leave group event
|
|
71
|
+
},
|
|
72
|
+
)
|
|
73
|
+
}
|
|
74
|
+
```
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
## Component Overview
|
|
2
|
+
|
|
3
|
+
ContactList is a Jetpack Compose-based contact list component that provides users with robust contact management features. It supports displaying friends, handling friend requests, managing group lists, managing blacklists, and offers a comprehensive set of interactive webhook interfaces.
|
|
4
|
+
| <strong>Contact List</strong> | <strong>Group List</strong> | <strong>Friend Request List</strong> |
|
|
5
|
+
| --- | --- | --- |
|
|
6
|
+
| | | |
|
|
7
|
+
|
|
8
|
+
## Component Integration
|
|
9
|
+
|
|
10
|
+
The `ContactList` component is included in TUIKit Compose. To use `ContactList`, integrate TUIKit Compose into your project. For detailed integration steps, see the [TUIKit Compose documentation](https://www.tencentcloud.com/document/product/1047/77459).
|
|
11
|
+
|
|
12
|
+
## Component Structure
|
|
13
|
+
|
|
14
|
+
`ContactList` is the primary component for displaying the contact list page:
|
|
15
|
+
| <strong>Method</strong> | <strong>Parameter</strong> | <strong>Description</strong> |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| <code>ContactList</code> | <code>modifier: Modifier</code> | Jetpack Compose modifier for configuring the component’s style, layout, behavior, and appearance. |
|
|
18
|
+
| <code>onGroupClick: (ContactInfo) -> Unit</code> | Webhook triggered when a group is clicked; this parameter is optional. | |
|
|
19
|
+
| <code>onContactClick: (ContactInfo) -> Unit</code> | Webhook triggered when a contact is clicked; this parameter is optional. | |
|
|
20
|
+
| <code>contactListViewModelFactory: ContactListViewModelFactory</code> | Factory for creating the internal ContactListViewModel. Typically, you do not need to provide this manually, as a default implementation is included. | |
|
|
21
|
+
|
|
22
|
+
The top section of `ContactList` provides entry points for subviews such as friend requests, group chat requests, group chat list, and blacklist. The bottom section displays the contact list, as shown below:
|
|
23
|
+
|
|
24
|
+
## Basic Usage
|
|
25
|
+
- When you tap the entry points for friend requests, group chat requests, group chat list, or blacklist in `ContactList`, the component automatically handles navigation—no extra configuration is required.
|
|
26
|
+
|
|
27
|
+
- When you tap a group in the group chat list or a contact in the contact list or blacklist, the corresponding webhook (`onGroupClick` or `onContactClick`) is triggered. You must handle these webhooks to implement custom navigation. See the routing example below:
|
|
28
|
+
|
|
29
|
+
To display the contact list directly, initialize `ContactList` as shown below:
|
|
30
|
+
|
|
31
|
+
``` swift
|
|
32
|
+
Box(
|
|
33
|
+
modifier = Modifier
|
|
34
|
+
.fillMaxSize()
|
|
35
|
+
.systemBarsPadding()
|
|
36
|
+
) {
|
|
37
|
+
ContactList(onGroupClick = {
|
|
38
|
+
// Handle group click event
|
|
39
|
+
}, onContactClick = {
|
|
40
|
+
// Handle contact click event
|
|
41
|
+
})
|
|
42
|
+
}
|
|
43
|
+
```
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
## Component Overview
|
|
2
|
+
|
|
3
|
+
ConversationList is a Jetpack Compose component designed to display and manage user chat conversations. It offers a comprehensive set of features for viewing and interacting with conversations.
|
|
4
|
+
| <strong>Conversation List</strong> | <strong>Conversation Actions</strong> |
|
|
5
|
+
| --- | --- |
|
|
6
|
+
| | |
|
|
7
|
+
|
|
8
|
+
## Component Integration
|
|
9
|
+
|
|
10
|
+
ConversationList is part of TUIKit Compose. To use ConversationList, integrate TUIKit Compose into your project. For detailed integration steps, see the [TUIKit Compose documentation](https://www.tencentcloud.com/document/product/1047/77459).
|
|
11
|
+
|
|
12
|
+
## Component Structure
|
|
13
|
+
|
|
14
|
+
ConversationList exposes only its initialization method; all other logic is handled internally.
|
|
15
|
+
|
|
16
|
+
#### Public Methods
|
|
17
|
+
| Method | Parameter | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| <code>ConversationList</code> | <code>modifier: Modifier</code> | Sets the component's style, layout, behavior, and appearance in Jetpack Compose. |
|
|
20
|
+
| <code>conversationListViewModelFactory: ConversationListViewModelFactory</code> | Factory for creating the internal ConversationListViewModel. Typically, you do not need to provide this manually, as a default implementation is included. | |
|
|
21
|
+
| <code>config: ConversationActionConfigProtocol</code> | Initializes the component and sets conversation action menu items. Optional. | |
|
|
22
|
+
| <code>customActions: List</code> | Initializes the component and sets custom conversation action options. Optional. | |
|
|
23
|
+
| <code>onConversationClick: (ConversationInfo) -> Unit</code> | Sets the conversation click webhook. | |
|
|
24
|
+
|
|
25
|
+
## Basic Usage
|
|
26
|
+
|
|
27
|
+
Initialize the ConversationList component directly. The onConversationClick webhook is required.
|
|
28
|
+
|
|
29
|
+
|Parameter Name|Type|Description|
|
|
30
|
+
|---------|---------|---------|
|
|
31
|
+
|`onConversationClick`|`(ConversationInfo) -> Unit`|Conversation click webhook, triggered when a user taps a conversation cell.|
|
|
32
|
+
|
|
33
|
+
Example code:
|
|
34
|
+
``` swift
|
|
35
|
+
Box(
|
|
36
|
+
modifier = Modifier
|
|
37
|
+
.fillMaxSize()
|
|
38
|
+
.systemBarsPadding()
|
|
39
|
+
) {
|
|
40
|
+
ConversationList(onConversationClick = {
|
|
41
|
+
// Recommended: Navigate to the chat page here
|
|
42
|
+
})
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Customization
|
|
47
|
+
|
|
48
|
+
You can customize the conversation list action items as follows.
|
|
49
|
+
|
|
50
|
+
#### Method 1. Hide Conversation Action Items Locally
|
|
51
|
+
|
|
52
|
+
Set `actions` when initializing ConversationList to specify which action items appear in each conversation cell:
|
|
53
|
+
``` swift
|
|
54
|
+
Box {
|
|
55
|
+
ConversationList(
|
|
56
|
+
// Hide ClearHistory
|
|
57
|
+
config = ChatConversationActionConfig(
|
|
58
|
+
isSupportDelete = true,
|
|
59
|
+
isSupportPin = true,
|
|
60
|
+
isSupportClearHistory = false
|
|
61
|
+
)
|
|
62
|
+
) {
|
|
63
|
+
// Navigate on conversation cell click
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
**Supported Action Menu Toggles**
|
|
69
|
+
|
|
70
|
+
|Action Type|Description|
|
|
71
|
+
|---------|---------|
|
|
72
|
+
|`isSupportDelete`|Enable or disable deleting conversations.|
|
|
73
|
+
|`isSupportPin`|Enable or disable pinning conversations.|
|
|
74
|
+
|`isSupportClearHistory`|Enable or disable clearing conversation history.|
|
|
75
|
+
|
|
76
|
+
#### Method 2. Add Conversation Action Items Locally
|
|
77
|
+
|
|
78
|
+
Pass `customActions` when initializing ConversationList. Custom options will be added to the end of the default action menu:
|
|
79
|
+
|
|
80
|
+
|Parameter Name|Type|Description|
|
|
81
|
+
|---------|---------|---------|
|
|
82
|
+
|`customActions`|`List`|Custom conversation actions, shown when the user opens the conversation action menu.|
|
|
83
|
+
|
|
84
|
+
Example code:
|
|
85
|
+
``` swift
|
|
86
|
+
Box {
|
|
87
|
+
ConversationList(
|
|
88
|
+
customActions = listOf(ConversationCustomAction(title = "Share") {
|
|
89
|
+
println("Share conversation: ${it.title}")
|
|
90
|
+
})
|
|
91
|
+
) {
|
|
92
|
+
// Handle click events
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
#### Method 3. Global Configuration
|
|
98
|
+
|
|
99
|
+
Configure globally using `AppBuilderConfig`:
|
|
100
|
+
``` swift
|
|
101
|
+
// Set up at app startup; if omitted, the feature is disabled
|
|
102
|
+
AppBuilderConfig.conversationActionList = listOf(
|
|
103
|
+
ConversationAction.DELETE, // Enable delete
|
|
104
|
+
ConversationAction.PIN, // Enable pin
|
|
105
|
+
ConversationAction.CLEAR_HISTORY // Enable clear conversation messages
|
|
106
|
+
)
|
|
107
|
+
|
|
108
|
+
// Then, initialize ConversationList. All ConversationList instances will use the above conversationActionList configuration.
|
|
109
|
+
ConversationList() {
|
|
110
|
+
// Navigate to the chat page here if needed
|
|
111
|
+
}
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
The following images show the customization effects:
|
|
115
|
+
| <strong>Conversation Actions</strong><br><strong> (Default Options)</strong> | <strong>Conversation Actions</strong><br><strong> (Delete Option Hidden)</strong> | <strong>Conversation Actions </strong><br><strong>(Share Option Added)</strong> |
|
|
116
|
+
| --- | --- | --- |
|
|
117
|
+
| | | |
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
## Feature Description
|
|
2
|
+
|
|
3
|
+
`TUIKit Compose` includes built-in language packs for **English**, **Simplified Chinese**, **Traditional Chinese**, and **Arabic** as default interface languages.
|
|
4
|
+
|
|
5
|
+
You can use these default language packs, customize translation strings, or add additional language packs as needed.
|
|
6
|
+
|
|
7
|
+
|**English**|**Arabic**|**Simplified Chinese**|
|
|
8
|
+
|---------|---------|---------|
|
|
9
|
+
||||
|
|
10
|
+
|
|
11
|
+
## Using Built-in Languages
|
|
12
|
+
|
|
13
|
+
If your application only needs to support **English**, **Simplified Chinese**, **Traditional Chinese**, or **Arabic**, follow the instructions in this section.
|
|
14
|
+
|
|
15
|
+
### Following System Language
|
|
16
|
+
|
|
17
|
+
By default, `TUIKit Compose` automatically adapts to the system language without additional configuration. If the system language is not one of the four supported languages, the interface defaults to English.
|
|
18
|
+
|
|
19
|
+
### Setting a Specific Display Language
|
|
20
|
+
|
|
21
|
+
To manually specify the interface language for `TUIKit Compose`, use `setApplicationLocales` to set the desired language. Once specified, the component will not follow the system language. Example:
|
|
22
|
+
``` swift
|
|
23
|
+
// Supported languages:
|
|
24
|
+
// "zh" for Simplified Chinese
|
|
25
|
+
// "zh-hk" for Traditional Chinese
|
|
26
|
+
// "en" for English
|
|
27
|
+
// "ar" for Arabic
|
|
28
|
+
AppCompatDelegate.setApplicationLocales(LocaleListCompat.forLanguageTags("zh"))
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
> **Notice:**
|
|
32
|
+
>
|
|
33
|
+
|
|
34
|
+
> The `setApplicationLocales` method requires a dependency on androidx.appcompat:appcompat, version 1.6.0 or higher.
|
|
35
|
+
>
|
|
36
|
+
|
|
37
|
+
## Using Additional Languages or Custom Translations
|
|
38
|
+
|
|
39
|
+
If your application needs to support more languages or modify specific translation strings, follow the steps in this section.
|
|
40
|
+
|
|
41
|
+
This example demonstrates how to add a Korean language pack and customize translations.
|
|
42
|
+
|
|
43
|
+
### Adding Language Resource Files
|
|
44
|
+
|
|
45
|
+
Create a `values-ko` directory and the corresponding string resource files under the `res` directory for each module. `ko` is the language code for Korean, following Android resource qualifier conventions. After adding Korean, your project structure will look like this:
|
|
46
|
+
``` plaintext
|
|
47
|
+
chat/demo/app/src/main/res/
|
|
48
|
+
├── values/strings.xml
|
|
49
|
+
├── values-zh/strings.xml
|
|
50
|
+
├── values-zh-rHK/strings.xml
|
|
51
|
+
├── values-ar/strings.xml
|
|
52
|
+
└── values-ko/strings.xml
|
|
53
|
+
|
|
54
|
+
chat/uikit/src/main/res/
|
|
55
|
+
├── values/strings.xml
|
|
56
|
+
├── values-zh/strings.xml
|
|
57
|
+
├── values-zh-rHK/strings.xml
|
|
58
|
+
├── values-ar/strings.xml
|
|
59
|
+
└── values-ko/strings.xml
|
|
60
|
+
|
|
61
|
+
atomic-x/src/main/
|
|
62
|
+
├── res-album-picker/values-ko/strings.xml
|
|
63
|
+
├── res-base-component/values-ko/strings.xml
|
|
64
|
+
├── res-chat-setting/values-ko/strings.xml
|
|
65
|
+
├── res-contact-list/values-ko/strings.xml
|
|
66
|
+
├── res-conversation-list/values-ko/strings.xml
|
|
67
|
+
├── res-emoji-picker/values-ko/strings.xml
|
|
68
|
+
├── res-emoji-picker/values-ko/strings-emoji.xml
|
|
69
|
+
├── res-message-input/values-ko/strings.xml
|
|
70
|
+
├── res-message-list/values-ko/strings.xml
|
|
71
|
+
├── res-search/values-ko/strings.xml
|
|
72
|
+
└── res-video-recorder/values-ko/strings.xml
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Use the default `strings.xml` file in each module as a reference and translate each `key` into Korean.
|
|
76
|
+
|
|
77
|
+
> **Note:**
|
|
78
|
+
>
|
|
79
|
+
> 1. Multilingual resources for `TUIKit Compose` are distributed across multiple modules: `app`, `uikit`, and `atomic-x`. Add `values-ko` to all relevant modules.
|
|
80
|
+
> 2. The `res-emoji-picker` module includes both `strings.xml` and `strings-emoji.xml`. When adding a new language, complete both files.
|
|
81
|
+
> 3. For language codes, see Resource Qualifier Rules.
|
|
82
|
+
|
|
83
|
+
### Customizing Translation Strings
|
|
84
|
+
|
|
85
|
+
After adding the Korean resource file (`values-ko/strings.xml`), the string `key`s remain consistent across language files. Customize translation content as needed for your business. To update specific text, override the relevant entry in the target module; you do not need to modify other language files.
|
|
86
|
+
|
|
87
|
+
### Following System Language
|
|
88
|
+
|
|
89
|
+
Android automatically matches the resource directory based on the system language. For example, if the system language is Korean, it will load resources from `values-ko`.
|
|
90
|
+
|
|
91
|
+
The newly added resource directory must follow Android resource qualifier rules to ensure the component adapts to the system language.
|
|
92
|
+
|
|
93
|
+
If you previously set a specific language using `setApplicationLocales`, clear the setting to revert to system language adaptation:
|
|
94
|
+
``` swift
|
|
95
|
+
AppCompatDelegate.setApplicationLocales(LocaleListCompat.getEmptyLocaleList())
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Setting a Specific Display Language
|
|
99
|
+
|
|
100
|
+
To set the interface language of `TUIKit Compose` to Korean, use `setApplicationLocales` with the Korean language code. Once set, the component will not follow the system language. Example:
|
|
101
|
+
``` swift
|
|
102
|
+
// Supported languages:
|
|
103
|
+
// "zh" for Simplified Chinese
|
|
104
|
+
// "zh-hk" for Traditional Chinese
|
|
105
|
+
// "en" for English
|
|
106
|
+
// "ar" for Arabic
|
|
107
|
+
// "ko" for Korean
|
|
108
|
+
AppCompatDelegate.setApplicationLocales(LocaleListCompat.forLanguageTags("ko"))
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Once these steps are complete, the interface displays in Korean, as shown below:
|
|
112
|
+
|
|
113
|
+
## Appendix: Resource Qualifier Rules
|
|
114
|
+
|
|
115
|
+
|Language|Code|Language|Code|
|
|
116
|
+
|---------|---------|---------|---------|
|
|
117
|
+
|Arabic|ar|Bulgarian|bg|
|
|
118
|
+
|Croatian|hr|Czech|cs|
|
|
119
|
+
|Danish|da|German|de|
|
|
120
|
+
|Greek|el|English|en|
|
|
121
|
+
|Estonian|et|Spanish|es|
|
|
122
|
+
|Finnish|fi|French|fr|
|
|
123
|
+
|Irish|ga|Hindi|hi|
|
|
124
|
+
|Hungarian|hu|Hebrew|he|
|
|
125
|
+
|Italian|it|Japanese|ja|
|
|
126
|
+
|Korean|ko|Latvian|lv|
|
|
127
|
+
|Lithuanian|lt|Dutch|nl|
|
|
128
|
+
|Norwegian|no|Polish|pl|
|
|
129
|
+
|Portuguese|pt|Swedish|sv|
|
|
130
|
+
|Romanian|ro|Russian|ru|
|
|
131
|
+
|Serbian|sr|Slovak|sk|
|
|
132
|
+
|Slovenian|sl|Thai|th|
|
|
133
|
+
|Turkish|tr|Ukrainian|uk|
|
|
134
|
+
|Chinese (Simplified)|zh|Chinese (Traditional)|zh-rHK|
|
|
135
|
+
|
|
136
|
+
For the full list, [see here](https://quickref.me/iso-639-1).
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
## Component Overview
|
|
2
|
+
|
|
3
|
+
MessageInput is a Jetpack Compose component that provides a full-featured message input interface for users. It supports composing and sending various message types, including text, images, videos, files, and voice messages. Additional features include emoji selection, flexible style configuration, and extensive customization options.
|
|
4
|
+
| <strong>Message Input Interface</strong> | <strong>Emoji Picker</strong> |
|
|
5
|
+
| --- | --- |
|
|
6
|
+
| | |
|
|
7
|
+
|
|
8
|
+
## Component Integration
|
|
9
|
+
|
|
10
|
+
MessageInput is included in TUIKit Compose. To use MessageInput, integrate TUIKit Compose into your project. For detailed integration steps, see the [TUIKit Compose](https://www.tencentcloud.com/document/product/1047/77459) documentation.
|
|
11
|
+
|
|
12
|
+
## Component Structure
|
|
13
|
+
|
|
14
|
+
MessageInput consists of the main input component and a style configuration protocol, enabling message input functionality with support for customization.
|
|
15
|
+
|
|
16
|
+
#### Public Methods
|
|
17
|
+
| Method | Parameter | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| <code> MessageInput</code> | <code>conversationID: String</code> | Conversation ID that identifies the current chat session.<br>- For C2C Chat, use the format c2c_userID.<br>- For group chat, use group_groupID. |
|
|
20
|
+
| <code>modifier: Modifier</code> | Jetpack Compose modifier for configuring style, layout, behavior, and appearance. | |
|
|
21
|
+
| <code>config: MessageInputConfigProtocol</code> | Input style configuration that controls which function buttons are displayed. | |
|
|
22
|
+
| <code>messageInputViewModelFactory: MessageInputViewModelFactory</code> | Factory for creating the internal MessageInputViewModel. Typically, you do not need to provide this manually, as a default implementation is available. | |
|
|
23
|
+
|
|
24
|
+
## Basic Usage
|
|
25
|
+
|
|
26
|
+
Initialize and use the MessageInput component by passing a conversation ID.
|
|
27
|
+
``` swift
|
|
28
|
+
Box(
|
|
29
|
+
modifier = Modifier
|
|
30
|
+
.fillMaxWidth()
|
|
31
|
+
) {
|
|
32
|
+
MessageInput(
|
|
33
|
+
conversationID = conversationID,
|
|
34
|
+
modifier = Modifier.navigationBarsPadding()
|
|
35
|
+
)
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Customization
|
|
40
|
+
|
|
41
|
+
Customize which feature buttons appear on the input bar:
|
|
42
|
+
``` swift
|
|
43
|
+
// Specify which function buttons to display
|
|
44
|
+
MessageInput(
|
|
45
|
+
conversationID = conversationID,
|
|
46
|
+
config = ChatMessageInputConfig(
|
|
47
|
+
isShowAudioRecorder = false, // Hide audio recording
|
|
48
|
+
isShowPhotoTaker = true, // Show photo capture
|
|
49
|
+
isShowMore = true, // Show more features
|
|
50
|
+
)
|
|
51
|
+
)
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
See the customization results below:
|
|
55
|
+
| <strong>Default Input Box</strong> | <strong>Audio Recording Hidden</strong> | <strong>All Features Hidden</strong> |
|
|
56
|
+
| --- | --- | --- |
|
|
57
|
+
| | | |
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
## Component Overview
|
|
2
|
+
|
|
3
|
+
MessageList is a Jetpack Compose component designed to display and manage chat messages. It provides robust support for various message types and operations:
|
|
4
|
+
- Supported message types: text, image, video, audio, file, system notification, emoji, and more.
|
|
5
|
+
|
|
6
|
+
- Message actions: supports long-press menus for actions such as copy, delete, recall, and custom options.
|
|
7
|
+
|
|
8
|
+
- Highly customizable: configure styles (bubble color, corner radius, font, etc.) and custom action items.
|
|
9
|
+
|
|
10
|
+
| <strong>Chat Message List</strong> | <strong>Message Long-Press Menu</strong> |
|
|
11
|
+
| --- | --- |
|
|
12
|
+
| | |
|
|
13
|
+
|
|
14
|
+
## Component Integration
|
|
15
|
+
|
|
16
|
+
MessageList is part of TUIKit Compose. To use MessageList, integrate TUIKit Compose into your project. For integration instructions, see the [TUIKit Compose documentation](https://www.tencentcloud.com/document/product/1047/77459).
|
|
17
|
+
|
|
18
|
+
## Component Structure
|
|
19
|
+
|
|
20
|
+
MessageList exposes only its initialization method; all other logic is handled internally.
|
|
21
|
+
|
|
22
|
+
#### Public Methods
|
|
23
|
+
| Method | Parameter | Description |
|
|
24
|
+
| --- | --- | --- |
|
|
25
|
+
| <code>MessageList</code> | <code>conversationID: String</code> | Initializes the component and sets the conversation ID.<br>- For C2C Chat, use the format c2c_userID.<br>- For group chat, use group_groupID. |
|
|
26
|
+
| <code>modifier: Modifier </code> | Jetpack Compose modifier for setting style, layout, behavior, and appearance. | |
|
|
27
|
+
| <code>config: MessageListConfigProtocol</code> | Initializes the component and applies message list styles. | |
|
|
28
|
+
| <code>customActions: List</code> | Initializes the component and adds custom message menu actions. | |
|
|
29
|
+
| <code>locateMessage: MessageInfo?</code> | Initializes the component and sets the message to locate. Typically used to jump from message search results to the target message. | |
|
|
30
|
+
| <code>messageListViewModelFactory: MessageListViewModelFactory</code> | Factory for creating the internal MessageListViewModel. Usually, you do not need to provide this, as a default implementation is included. | |
|
|
31
|
+
| <code>onUserClick: (String) -> Unit</code> | Initializes the component and sets the handler for user avatar clicks. | |
|
|
32
|
+
|
|
33
|
+
## Basic Usage
|
|
34
|
+
|
|
35
|
+
You can initialize the MessageList component directly by providing a conversation ID. It is also recommended to implement the onUserClick handler during initialization.
|
|
36
|
+
``` swift
|
|
37
|
+
Box(modifier = Modifier.systemBarsPadding()) {
|
|
38
|
+
MessageList(conversationID = conversationID) {
|
|
39
|
+
// Handle user avatar click event
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Customization
|
|
45
|
+
|
|
46
|
+
You can customize both the style and action items of the message list as needed.
|
|
47
|
+
|
|
48
|
+
#### Custom Styles
|
|
49
|
+
|
|
50
|
+
Implement `MessageListConfigProtocol` to define a fully customized style:
|
|
51
|
+
``` swift
|
|
52
|
+
class MyCustomConfig(
|
|
53
|
+
override val alignment: MessageAlignment = MessageAlignment.TWO_SIDED,
|
|
54
|
+
override val isShowTimeMessage: Boolean = true,
|
|
55
|
+
override val isShowLeftAvatar: Boolean = true,
|
|
56
|
+
override val isShowLeftNickname: Boolean = true,
|
|
57
|
+
override val isShowRightAvatar: Boolean = true,
|
|
58
|
+
override val isShowRightNickname: Boolean = true,
|
|
59
|
+
// ... other required properties
|
|
60
|
+
) : MessageListConfigProtocol
|
|
61
|
+
|
|
62
|
+
MessageList(conversationID = conversationID, config = MyCustomConfig()) {
|
|
63
|
+
// Handle user avatar click event
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
`MessageListConfigProtocol` Property Descriptions:
|
|
68
|
+
| Property | Type | Description | Remarks |
|
|
69
|
+
| --- | --- | --- | --- |
|
|
70
|
+
| <code>alignment</code> | <code>MessageAlignment</code> | Message alignment | - <code>MessageAlignment.LEFT</code>: left aligned. - <code>MessageAlignment.RIGHT</code>: right aligned. - <code>MessageAlignment.TWO_SIDED</code>: both sides aligned. |
|
|
71
|
+
| <code>isShowTimeMessage</code> | <code>Boolean</code> | Show message timestamps | Controls whether message timestamps are displayed. |
|
|
72
|
+
| <code>isShowLeftAvatar</code> | <code>Boolean</code> | Show left avatar | Controls whether the sender's avatar is shown for received messages. |
|
|
73
|
+
| <code>isShowLeftNickname</code> | <code>Boolean</code> | Show left nickname | Controls whether the sender's nickname is shown for received messages. |
|
|
74
|
+
| <code>isShowRightAvatar</code> | <code>Boolean</code> | Show right avatar | Controls whether your avatar is shown for sent messages. |
|
|
75
|
+
| <code>isShowRightNickname</code> | <code>Boolean</code> | Show right nickname | Controls whether your nickname is shown for sent messages. |
|
|
76
|
+
| <code>isShowTimeInBubble</code> | <code>Boolean</code> | Show time inside bubble | Controls whether the timestamp appears inside the message bubble. |
|
|
77
|
+
| <code>cellSpacing</code> | <code>Dp</code> | Message spacing | Controls the spacing between adjacent messages. |
|
|
78
|
+
| <code>isShowSystemMessage</code> | <code>Boolean</code> | Show system notifications | Controls whether system notification messages are displayed. |
|
|
79
|
+
| <code>isShowUnsupportMessage</code> | <code>Boolean</code> | Show unsupported messages | Controls whether unsupported message types are displayed. |
|
|
80
|
+
| <code>horizontalPadding</code> | <code>Dp</code> | Horizontal padding | Controls the left and right padding of the message list. |
|
|
81
|
+
| <code>avatarSpacing</code> | <code>Dp</code> | Avatar spacing | Controls the spacing between the avatar and message content. |
|
|
82
|
+
| <code>isSupportCopy</code> | <code>Boolean</code> | Enable copy in message menu | - <code>true</code>: Display the copy action.<br>- <code>false</code>: Do not display the copy action. |
|
|
83
|
+
| <code>isSupportDelete</code> | <code>Boolean</code> | Enable delete in message menu | - <code>true</code>: Display the delete action.<br>- <code>false</code>: Do not display the delete action. |
|
|
84
|
+
| <code>isSupportRecall</code> | <code>Boolean</code> | Enable recall in message menu | - <code>true</code>: Display the recall action.<br>- <code>false</code>: Do not display the recall action. |
|
|
85
|
+
|
|
86
|
+
### Custom Action Items
|
|
87
|
+
|
|
88
|
+
You can customize the long-press message menu in several ways.
|
|
89
|
+
|
|
90
|
+
#### Method 1. Show or Hide Action Items Locally
|
|
91
|
+
|
|
92
|
+
Set `isSupportCopy`, `isSupportDelete`, and `isSupportRecall` in the config parameter when initializing MessageList to control which actions are available:
|
|
93
|
+
``` swift
|
|
94
|
+
MessageList(
|
|
95
|
+
conversationID = conversationID,
|
|
96
|
+
config = ChatMessageListConfig(isSupportCopy = false)
|
|
97
|
+
) {
|
|
98
|
+
// Handle user avatar click event
|
|
99
|
+
}
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
#### Method 2. Add Custom Action Items Locally
|
|
103
|
+
|
|
104
|
+
Pass a list of custom actions to the `customActions` parameter when initializing MessageList. Your custom actions will appear below the default actions:
|
|
105
|
+
``` swift
|
|
106
|
+
MessageList(
|
|
107
|
+
conversationID = conversationID,
|
|
108
|
+
customActions = listOf(
|
|
109
|
+
MessageCustomAction(title = "Share", iconResID = R.drawable.message_list_menu_forward_icon) {
|
|
110
|
+
println("Share Message")
|
|
111
|
+
}
|
|
112
|
+
)
|
|
113
|
+
)
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
#### Method 3. Configure Action Items Globally
|
|
117
|
+
|
|
118
|
+
Set global action items using `AppBuilderConfig`:
|
|
119
|
+
``` swift
|
|
120
|
+
// Configure at app startup
|
|
121
|
+
AppBuilderConfig.messageActionList = listOf(
|
|
122
|
+
MessageAction.COPY, // Enable copy
|
|
123
|
+
MessageAction.DELETE, // Enable delete
|
|
124
|
+
MessageAction.RECALL // Enable recall
|
|
125
|
+
)
|
|
126
|
+
|
|
127
|
+
// Then initialize MessageList; all instances will use the above configuration
|
|
128
|
+
MessageList(
|
|
129
|
+
conversationID = conversationID,
|
|
130
|
+
)
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
> **Note:**
|
|
134
|
+
>
|
|
135
|
+
|
|
136
|
+
> Local configuration takes precedence over global configuration.
|
|
137
|
+
>
|
|
138
|
+
|
|
139
|
+
Customization examples:
|
|
140
|
+
| <strong>Message List Actions</strong><br><strong> (Default Options)</strong> | <strong>Message List Actions</strong><br><strong> (Copy Option Hidden)</strong> | <strong>Message List Actions </strong><br><strong>(Share Option Added)</strong> |
|
|
141
|
+
| --- | --- | --- |
|
|
142
|
+
| | | |
|