@tencentcloud/sdk-mcp 1.4.7 → 1.6.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.js +0 -1
- package/knowledge/bm25-cache.js +73 -0
- package/knowledge/bm25.js +147 -0
- package/knowledge/build-index.js +65 -0
- package/knowledge/chunker.js +167 -0
- package/knowledge/content-loader.js +36 -0
- package/knowledge/extractors.js +25 -0
- package/knowledge/path-meta.js +175 -0
- package/knowledge/search/exact-lookup.js +330 -0
- package/knowledge/search/filter-pool.js +86 -0
- package/knowledge/search/requires-framework.js +72 -0
- package/knowledge/search/search-knowledge.js +226 -0
- package/package.json +9 -9
- package/resource/_schema/feature-aliases.yaml +10 -0
- package/resource/_schema/goal-tags.yaml +72 -0
- package/resource/_schema/products.yaml +16 -0
- package/resource/_schema/trtc-intents.yaml +27 -0
- package/resource/_schema/types.yaml +44 -0
- package/resource/index/component-slugs.json +1 -0
- package/resource/index/manifest.json +1 -0
- package/resource/{doc → integration}/callkit/preset/android/integration.md +32 -28
- package/resource/{doc → integration}/callkit/preset/flutter/integration.md +109 -54
- package/resource/integration/callkit/preset/ios/integration.md +411 -0
- package/resource/integration/callkit/preset/react/integration.md +499 -0
- package/resource/integration/callkit/preset/vue/integration.md +768 -0
- package/resource/{doc/chatkit → integration/chat/preset}/android/integration.md +11 -11
- package/resource/{doc/chatkit → integration/chat/preset}/flutter/integration.md +59 -37
- package/resource/integration/chat/preset/ios/integration.md +568 -0
- package/resource/{doc/chatkit → integration/chat/preset}/react/integration.md +127 -95
- package/resource/integration/chat/preset/uni-app/integration.md +494 -0
- package/resource/{doc/chatkit → integration/chat/preset}/vue/integration.md +163 -143
- package/resource/{doc → integration}/livekit/preset/live/vue/live-list-integration.md +15 -15
- package/resource/{doc → integration}/livekit/preset/live/vue/live-player-desk-integration.md +25 -13
- package/resource/{doc → integration}/livekit/preset/live/vue/live-player-h5-integration.md +15 -9
- package/resource/{doc → integration}/livekit/preset/live/vue/live-pusher-integration.md +31 -26
- package/resource/integration/roomkit/preset/vue/integration.md +571 -0
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +852 -0
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +929 -0
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +364 -0
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +1150 -0
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +1216 -0
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +412 -0
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1191 -0
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +1292 -0
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +537 -0
- package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +953 -0
- package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +1061 -0
- package/resource/knowledge/callkit/faq/android.md +168 -0
- package/resource/knowledge/callkit/faq/common.md +180 -0
- package/resource/knowledge/callkit/faq/flutter.md +52 -0
- package/resource/knowledge/callkit/faq/ios.md +116 -0
- package/resource/knowledge/callkit/faq/uniapp-app.md +89 -0
- package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +217 -0
- package/resource/knowledge/callkit/faq/web.md +363 -0
- package/resource/knowledge/callkit/preset/android/api.md +413 -0
- package/resource/knowledge/callkit/preset/flutter/api.md +22 -0
- package/resource/knowledge/callkit/preset/ios/api.md +256 -0
- package/resource/knowledge/callkit/preset/web/api.md +79 -0
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +72 -0
- package/resource/knowledge/chat/preset/android/features/contact-list.md +41 -0
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +123 -0
- package/resource/knowledge/chat/preset/android/features/language.md +142 -0
- package/resource/knowledge/chat/preset/android/features/message-input.md +57 -0
- package/resource/knowledge/chat/preset/android/features/message-list.md +142 -0
- package/resource/knowledge/chat/preset/android/features/search.md +64 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/android/features/theme.md +21 -18
- package/resource/knowledge/chat/preset/android-view/integration.md +448 -0
- package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +62 -0
- package/resource/knowledge/chat/preset/flutter/features/contact-list.md +40 -0
- package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +129 -0
- package/resource/knowledge/chat/preset/flutter/features/language.md +104 -0
- package/resource/knowledge/chat/preset/flutter/features/message-input.md +54 -0
- package/resource/knowledge/chat/preset/flutter/features/message-list.md +163 -0
- package/resource/knowledge/chat/preset/flutter/features/search.md +59 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/flutter/features/theme.md +47 -19
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +92 -0
- package/resource/knowledge/chat/preset/ios/features/contact-list.md +119 -0
- package/resource/knowledge/chat/preset/ios/features/conversation-list.md +134 -0
- package/resource/knowledge/chat/preset/ios/features/language.md +105 -0
- package/resource/knowledge/chat/preset/ios/features/message-input.md +69 -0
- package/resource/knowledge/chat/preset/ios/features/message-list.md +164 -0
- package/resource/knowledge/chat/preset/ios/features/search.md +94 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/ios/features/theme.md +54 -51
- package/resource/{doc/chatkit/ios → knowledge/chat/preset/ios-uikit}/integration.md +157 -94
- package/resource/knowledge/chat/preset/react/features/chat-setting.md +123 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/contact-list.md +256 -104
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +217 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/conversation-list.md +86 -79
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +99 -0
- package/resource/knowledge/chat/preset/react/features/conversation-search.md +58 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-input.md +30 -83
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-list.md +22 -25
- package/resource/knowledge/chat/preset/react/features/search.md +531 -0
- package/resource/knowledge/chat/preset/react/features/theme.md +16 -0
- package/resource/knowledge/chat/preset/vue/features/chat-header.md +331 -0
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/chat-setting.md +0 -4
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/contact-list.md +59 -53
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-actions.md +49 -43
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-list.md +61 -49
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-preview.md +43 -40
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-search.md +1 -1
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-input.md +128 -105
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-list.md +108 -195
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/search.md +74 -68
- package/resource/knowledge/chat/preset/vue/features/theme.md +136 -0
- package/resource/knowledge/chat/urls/error-code.md +16 -0
- package/resource/knowledge/chat/urls/product.md +61 -0
- package/resource/knowledge/chat/urls/restapi.md +226 -0
- package/resource/knowledge/chat/urls/sdk/android.md +84 -0
- package/resource/knowledge/chat/urls/sdk/flutter.md +73 -0
- package/resource/knowledge/chat/urls/sdk/ios.md +84 -0
- package/resource/knowledge/chat/urls/sdk/web.md +88 -0
- package/resource/knowledge/chat/urls/webhook.md +73 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/AudioEffectStore.md +79 -76
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +174 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +329 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/CameraView.md +7 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +434 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +362 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +466 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +173 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/LikeStore.md +12 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +291 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +78 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +439 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +221 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/AudioEffectStore.md +79 -76
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +212 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/BaseBeautyStore.md +43 -45
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +312 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +404 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +334 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +420 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +166 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LikeStore.md +12 -11
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +281 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LiveCoreView.md +49 -42
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +397 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +183 -0
- package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/AudioEffectStore.md +79 -75
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +192 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +146 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +309 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +370 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +339 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +503 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +188 -0
- package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/LikeStore.md +12 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +289 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +78 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +434 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +187 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/web/index.md +780 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audience-list.md +59 -51
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audio-effect.md +37 -34
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-barrage.md +68 -38
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-base-beauty.md +18 -15
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-co-guest-interaction.md +17 -17
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-gift.md +86 -80
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-host-interaction.md +53 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-integration.md +47 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-live-list.md +26 -22
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audience-list.md +16 -13
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-barrage.md +33 -21
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-base-beauty.md +29 -25
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-co-guest-interaction.md +21 -20
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-gift.md +78 -69
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-host-interaction.md +47 -43
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-integration.md +48 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-live-list.md +27 -23
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audience-list.md +15 -12
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audio-effect.md +39 -36
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-barrage.md +42 -29
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-base-beauty.md +19 -16
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-co-guest-interaction.md +20 -19
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-gift.md +55 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-host-interaction.md +50 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-integration.md +48 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-live-list.md +26 -22
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audience-list.md +59 -51
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audio-effect.md +41 -38
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-barrage.md +67 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +53 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-gift.md +86 -80
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-host-interaction.md +45 -40
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-integration.md +43 -42
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-room-list.md +523 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audience-list.md +16 -13
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audio-effect.md +54 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-barrage.md +33 -21
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +34 -28
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-gift.md +73 -64
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-integration.md +46 -43
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-room-list.md +165 -148
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audience-list.md +19 -16
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audio-effect.md +40 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-barrage.md +41 -28
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +54 -47
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-gift.md +52 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-host-interaction.md +55 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-integration.md +47 -45
- package/resource/knowledge/livekit/core-sdk/voice/ios/voice-room-list.md +404 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audience-list.md +40 -57
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audio-effect.md +38 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-barrage.md +53 -53
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-co-guest-interaction.md +106 -116
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-gift.md +49 -59
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-integration.md +52 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-room-list.md +38 -46
- package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +915 -0
- package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +179 -0
- package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +419 -0
- package/resource/knowledge/push/config/android/fcm.md +133 -0
- package/resource/knowledge/push/config/android/honor.md +111 -0
- package/resource/knowledge/push/config/android/huawei.md +106 -0
- package/resource/knowledge/push/config/android/meizu.md +121 -0
- package/resource/knowledge/push/config/android/oppo.md +108 -0
- package/resource/knowledge/push/config/android/vivo.md +101 -0
- package/resource/knowledge/push/config/android/xiaomi.md +99 -0
- package/resource/knowledge/push/integration/android.md +1028 -0
- package/resource/knowledge/push/integration/donut.md +271 -0
- package/resource/knowledge/push/integration/flutter.md +363 -0
- package/resource/knowledge/push/integration/harmonyos.md +72 -0
- package/resource/knowledge/push/integration/ios.md +705 -0
- package/resource/knowledge/push/integration/react-native.md +337 -0
- package/resource/knowledge/push/integration/uni-app.md +461 -0
- package/resource/knowledge/push/integration/unity.md +357 -0
- package/resource/knowledge/push/integration/unreal-engine.md +353 -0
- package/resource/knowledge/push/overview/prepare.md +30 -0
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/call-user-to-room.md +22 -20
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-participant-state.md +22 -193
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-state.md +33 -32
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/schedule-room.md +30 -29
- package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +230 -0
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-participant-state.md +22 -21
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-state.md +29 -28
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/schedule-room.md +17 -16
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/call-user-to-room.md +22 -20
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-participant-state.md +49 -218
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-state.md +37 -37
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/schedule-room.md +28 -28
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/call-user-to-room.md +122 -7
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/device-detection.md +318 -3
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +1504 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/free-beauty-panel.md +4 -3
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +709 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +1105 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +635 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +529 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/schedule-room.md +256 -13
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/screen-share.md +218 -25
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/virtual-background.md +4 -3
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/android/integration.md +50 -64
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/flutter/integration.md +34 -31
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/ios/integration.md +45 -53
- package/resource/knowledge/roomkit/preset/react/integration.md +571 -0
- package/resource/{doc → knowledge}/rtcengine/web/how_to_run_web_sdk_demo.md +31 -15
- package/resource/{doc → knowledge}/rtcengine/web/plugin/21-advanced-auto-play-policy.md +9 -3
- package/resource/{doc → knowledge}/rtcengine/web/plugin/22-advanced-audio-mixer.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/23-advanced-support-detection.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/24-advanced-network-quality.md +6 -6
- package/resource/{doc → knowledge}/rtcengine/web/plugin/25-advanced-device-change.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -4
- package/resource/{doc → knowledge}/rtcengine/web/plugin/27-advanced-small-stream.md +4 -4
- package/resource/{doc → knowledge}/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
- package/resource/{doc → knowledge}/trtc/android/TRTCCloud.md +547 -495
- package/resource/{doc → knowledge}/trtc/android/TRTCCloudDef.md +434 -403
- package/resource/{doc → knowledge}/trtc/android/TRTCCloudListener.md +394 -348
- package/resource/{doc → knowledge}/trtc/android/TRTCStatistics.md +17 -15
- package/resource/{doc → knowledge}/trtc/android/TXAudioEffectManager.md +227 -197
- package/resource/knowledge/trtc/android/TXBeautyManager.md +415 -0
- package/resource/{doc → knowledge}/trtc/android/TXDeviceManager.md +70 -63
- package/resource/{doc → knowledge}/trtc/android/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCCloud.md +599 -544
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCStatistics.md +17 -15
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +502 -0
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +403 -0
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCCloudCallback.md +439 -387
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCTypeDef.md +417 -387
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloud.md +619 -559
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloudDelegate.md +409 -360
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCStatistics.md +17 -15
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXAudioEffectManager.md +187 -164
- package/resource/knowledge/trtc/ios/TXBeautyManager.md +416 -0
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +399 -0
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiveSDKTypeDef.md +422 -396
- package/server-config.js +0 -1
- package/server.js +22 -12
- package/streamable-http.js +0 -1
- package/tools/call/get_native_call_uikit_integration.js +2 -4
- package/tools/call/get_native_callkit_core_integration.js +2 -6
- package/tools/call/get_web_call_uikit_integration.js +2 -4
- package/tools/chat/get_native_chat_uikit_integration.js +2 -4
- package/tools/chat/get_web_chat_uikit_integration.js +2 -4
- package/tools/common/get_usersig.js +0 -1
- package/tools/common/present_framework_choice.js +9 -4
- package/tools/common/record_answer.js +19 -26
- package/tools/common/record_feedback.js +17 -31
- package/tools/common/search_trtc_knowledge.js +44 -0
- package/tools/definitions/get_native_call_uikit_integration_def.js +2 -1
- package/tools/definitions/get_native_callkit_core_integration_def.js +2 -1
- package/tools/definitions/get_native_chat_uikit_integration_def.js +3 -2
- package/tools/definitions/get_native_livekit_core_integration_def.js +2 -1
- package/tools/definitions/get_usersig_def.js +0 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js +2 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js +2 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js +4 -3
- package/tools/definitions/get_web_room_core_integration_def.js +46 -0
- package/tools/definitions/get_web_room_uikit_integration_def.js +3 -1
- package/tools/definitions/integration-boundary.js +5 -0
- package/tools/definitions/present_framework_choice_def.js +11 -10
- package/tools/definitions/record_answer_def.js +6 -5
- package/tools/definitions/record_feedback_def.js +4 -3
- package/tools/definitions/search_trtc_knowledge_def.js +69 -0
- package/tools/index.js +5 -37
- package/tools/live/get_native_livekit_core_integration.js +1 -4
- package/tools/live/get_web_live_uikit_integration.js +2 -5
- package/tools/room/get_web_room_core_integration.js +47 -0
- package/tools/room/get_web_room_uikit_integration.js +2 -4
- package/utils/generate-structured-result.js +4 -11
- package/utils/generate-usersig.js +0 -1
- package/utils/get-device-identifier.js +0 -1
- package/utils/get-doc-content.js +14 -9
- package/utils/http-get.js +0 -1
- package/utils/http-post.js +0 -1
- package/utils/report-cls-client.js +22 -21
- package/utils/report-es-client.js +1 -2
- package/utils/report-runtime-error-cls-client.js +0 -1
- package/index.js.map +0 -1
- package/resource/doc/callkit/core-sdk/.gitkeep +0 -0
- package/resource/doc/callkit/core-sdk/android/answer-call.md +0 -942
- package/resource/doc/callkit/core-sdk/android/make-call.md +0 -876
- package/resource/doc/callkit/core-sdk/android/offline-push.md +0 -368
- package/resource/doc/callkit/core-sdk/flutter/answer-call.md +0 -1132
- package/resource/doc/callkit/core-sdk/flutter/make-call.md +0 -1206
- package/resource/doc/callkit/core-sdk/flutter/offline-push.md +0 -357
- package/resource/doc/callkit/core-sdk/ios/answer-call.md +0 -1009
- package/resource/doc/callkit/core-sdk/ios/make-call.md +0 -1154
- package/resource/doc/callkit/core-sdk/ios/offline-push.md +0 -470
- package/resource/doc/callkit/core-sdk/uni-app/answer-call.md +0 -1146
- package/resource/doc/callkit/core-sdk/uni-app/make-call.md +0 -1267
- package/resource/doc/callkit/faq/android-faq.md +0 -767
- package/resource/doc/callkit/faq/flutter-faq.md +0 -749
- package/resource/doc/callkit/faq/ios-faq.md +0 -759
- package/resource/doc/callkit/faq/web-faq.md +0 -753
- package/resource/doc/callkit/preset/android/api.md +0 -330
- package/resource/doc/callkit/preset/flutter/api.md +0 -401
- package/resource/doc/callkit/preset/ios/api.md +0 -282
- package/resource/doc/callkit/preset/ios/integration.md +0 -188
- package/resource/doc/callkit/preset/react/api.md +0 -600
- package/resource/doc/callkit/preset/react/integration.md +0 -86
- package/resource/doc/callkit/preset/vue/api.md +0 -600
- package/resource/doc/callkit/preset/vue/integration.md +0 -83
- package/resource/doc/chatkit/android/faq.md +0 -109
- package/resource/doc/chatkit/faq/android_sdk/client-api.md +0 -280
- package/resource/doc/chatkit/faq/common/product.md +0 -82
- package/resource/doc/chatkit/faq/common/server.md +0 -53
- package/resource/doc/chatkit/faq/common/server_error_code.md +0 -74
- package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +0 -183
- package/resource/doc/chatkit/faq/flutter_sdk/faq.md +0 -54
- package/resource/doc/chatkit/faq/ios_sdk/client-api.md +0 -279
- package/resource/doc/chatkit/faq/web_sdk/error_code.md +0 -47
- package/resource/doc/chatkit/faq/web_sdk/faq.md +0 -292
- package/resource/doc/chatkit/flutter/faq.md +0 -22
- package/resource/doc/chatkit/ios/faq.md +0 -109
- package/resource/doc/chatkit/react/components/avatar.md +0 -104
- package/resource/doc/chatkit/react/components/chat-header.md +0 -148
- package/resource/doc/chatkit/react/components/chat-setting.md +0 -117
- package/resource/doc/chatkit/react/components/chat.md +0 -38
- package/resource/doc/chatkit/react/components/component-list.md +0 -35
- package/resource/doc/chatkit/react/components/conversation-actions.md +0 -174
- package/resource/doc/chatkit/react/components/conversation-preview.md +0 -116
- package/resource/doc/chatkit/react/components/conversation-search.md +0 -57
- package/resource/doc/chatkit/react/components/search.md +0 -282
- package/resource/doc/chatkit/react/components/tuikit.md +0 -43
- package/resource/doc/chatkit/react/faq.md +0 -26
- package/resource/doc/chatkit/vue/components/avatar.md +0 -104
- package/resource/doc/chatkit/vue/components/chat-header.md +0 -149
- package/resource/doc/chatkit/vue/components/chat.md +0 -42
- package/resource/doc/chatkit/vue/components/component-list.md +0 -89
- package/resource/doc/chatkit/vue/components/tuikit.md +0 -45
- package/resource/doc/chatkit/vue/components/userpicker.md +0 -256
- package/resource/doc/chatkit/vue/faq.md +0 -35
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +0 -148
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +0 -316
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +0 -419
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +0 -325
- package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +0 -436
- package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +0 -165
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +0 -239
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +0 -74
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +0 -417
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +0 -207
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +0 -158
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +0 -304
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +0 -394
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +0 -303
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +0 -410
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +0 -160
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +0 -231
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +0 -375
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +0 -170
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +0 -165
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +0 -143
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +0 -298
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +0 -349
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +0 -297
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +0 -471
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +0 -179
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +0 -238
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +0 -74
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +0 -412
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +0 -173
- package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +0 -365
- package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +0 -336
- package/resource/doc/livekit/preset/live/vue/api-reference/index.md +0 -780
- package/resource/doc/livekit/preset/live/vue/components/barrage.md +0 -291
- package/resource/doc/livekit/preset/live/vue/components/co-guest-panel.md +0 -88
- package/resource/doc/livekit/preset/live/vue/components/live-audience-list.md +0 -164
- package/resource/doc/livekit/preset/live/vue/components/live-scene-panel.md +0 -130
- package/resource/doc/livekit/preset/live/vue/components/live-view.md +0 -203
- package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +0 -211
- package/resource/doc/livekit/preset/live/vue/faq.md +0 -1
- package/resource/doc/roomkit/faq/common/error-code.md +0 -67
- package/resource/doc/roomkit/flutter/features/call-user-to-room.md +0 -228
- package/resource/doc/roomkit/vue/faq.md +0 -1
- package/resource/doc/roomkit/vue/features/device-state.md +0 -460
- package/resource/doc/roomkit/vue/features/room-chat.md +0 -369
- package/resource/doc/roomkit/vue/features/room-participant-state.md +0 -385
- package/resource/doc/roomkit/vue/features/room-state.md +0 -280
- package/resource/doc/roomkit/vue/features/room-view.md +0 -241
- package/resource/doc/roomkit/vue/integration.md +0 -315
- package/resource/doc/rtcengine/faq/web_sdk/.gitkeep +0 -0
- package/resource/doc/trtc/C++/ITXAudioEffectManager.md +0 -472
- package/resource/doc/trtc/C++/ITXDeviceManager.md +0 -388
- package/resource/doc/trtc/android/TXBeautyManager.md +0 -403
- package/resource/doc/trtc/iOS/TXBeautyManager.md +0 -404
- package/resource/doc/trtc/iOS/TXDeviceManager.md +0 -382
- package/server-config.js.map +0 -1
- package/server.js.map +0 -1
- package/streamable-http.js.map +0 -1
- package/tools/call/get_callkit_api.js +0 -33
- package/tools/call/get_callkit_api.js.map +0 -1
- package/tools/call/get_native_call_uikit_integration.js.map +0 -1
- package/tools/call/get_native_callkit_core_integration.js.map +0 -1
- package/tools/call/get_web_call_uikit_integration.js.map +0 -1
- package/tools/chat/get_native_chat_uikit_feature_detail.js +0 -35
- package/tools/chat/get_native_chat_uikit_feature_detail.js.map +0 -1
- package/tools/chat/get_native_chat_uikit_integration.js.map +0 -1
- package/tools/chat/get_web_chat_uikit_component_detail.js +0 -35
- package/tools/chat/get_web_chat_uikit_component_detail.js.map +0 -1
- package/tools/chat/get_web_chat_uikit_integration.js.map +0 -1
- package/tools/common/get_faq.js +0 -266
- package/tools/common/get_faq.js.map +0 -1
- package/tools/common/get_usersig.js.map +0 -1
- package/tools/common/present_framework_choice.js.map +0 -1
- package/tools/common/record_answer.js.map +0 -1
- package/tools/common/record_feedback.js.map +0 -1
- package/tools/common/record_skill_session.js +0 -69
- package/tools/common/record_skill_session.js.map +0 -1
- package/tools/definitions/get_callkit_api_def.js +0 -28
- package/tools/definitions/get_callkit_api_def.js.map +0 -1
- package/tools/definitions/get_faq_def.js +0 -40
- package/tools/definitions/get_faq_def.js.map +0 -1
- package/tools/definitions/get_native_call_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_callkit_core_integration_def.js.map +0 -1
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +0 -31
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_native_chat_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_livekit_core_features_def.js +0 -33
- package/tools/definitions/get_native_livekit_core_features_def.js.map +0 -1
- package/tools/definitions/get_native_livekit_core_integration_def.js.map +0 -1
- package/tools/definitions/get_native_trtc_sdk_docs_def.js +0 -32
- package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +0 -1
- package/tools/definitions/get_usersig_def.js.map +0 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js +0 -31
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_livekit_api_def.js +0 -27
- package/tools/definitions/get_web_livekit_api_def.js.map +0 -1
- package/tools/definitions/get_web_livekit_component_detail_def.js +0 -29
- package/tools/definitions/get_web_livekit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_room_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_roomkit_feature_detail_def.js +0 -30
- package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_api_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_api_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_integration_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +0 -1
- package/tools/definitions/present_framework_choice_def.js.map +0 -1
- package/tools/definitions/record_answer_def.js.map +0 -1
- package/tools/definitions/record_feedback_def.js.map +0 -1
- package/tools/definitions/record_skill_session_def.js +0 -31
- package/tools/definitions/record_skill_session_def.js.map +0 -1
- package/tools/index.js.map +0 -1
- package/tools/live/get_native_livekit_core_features.js +0 -68
- package/tools/live/get_native_livekit_core_features.js.map +0 -1
- package/tools/live/get_native_livekit_core_integration.js.map +0 -1
- package/tools/live/get_web_live_uikit_integration.js.map +0 -1
- package/tools/live/get_web_livekit_api.js +0 -33
- package/tools/live/get_web_livekit_api.js.map +0 -1
- package/tools/live/get_web_livekit_component_detail.js +0 -35
- package/tools/live/get_web_livekit_component_detail.js.map +0 -1
- package/tools/room/get_web_room_uikit_integration.js.map +0 -1
- package/tools/room/get_web_roomkit_feature_detail.js +0 -69
- package/tools/room/get_web_roomkit_feature_detail.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_api.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_api.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_integration.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +0 -1
- package/tools/trtc/get_native_trtc_sdk_docs.js +0 -74
- package/tools/trtc/get_native_trtc_sdk_docs.js.map +0 -1
- package/utils/build-session-directives.js +0 -122
- package/utils/build-session-directives.js.map +0 -1
- package/utils/generate-structured-result.js.map +0 -1
- package/utils/generate-usersig.js.map +0 -1
- package/utils/get-device-identifier.js.map +0 -1
- package/utils/get-doc-content.js.map +0 -1
- package/utils/handle-framework.js +0 -9
- package/utils/handle-framework.js.map +0 -1
- package/utils/handle-state-name.js +0 -29
- package/utils/handle-state-name.js.map +0 -1
- package/utils/http-get.js.map +0 -1
- package/utils/http-post.js.map +0 -1
- package/utils/report-cls-client.js.map +0 -1
- package/utils/report-es-client.js.map +0 -1
- package/utils/report-runtime-error-cls-client.js.map +0 -1
- /package/resource/{doc/callkit/faq/common → knowledge/callkit/faq}/error-code.md +0 -0
- /package/resource/{doc/livekit/faq/common → knowledge/livekit/faq}/error-code.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/api.md +0 -0
- /package/resource/{doc/rtcengine/faq/web/web.md → knowledge/rtcengine/web/faq.md} +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/how_to_integrated_web_sdk.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/28-advanced-beauty.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/29-advanced-water-mark.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/30-advanced-cross-room-link.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/34-advanced-proxy.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/37-advanced-voice-changer.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/38-advanced-basic-beauty.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/40-advanced-video-mixer.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/43-advanced-face-detection.md +0 -0
- /package/resource/{doc/rtcengine/faq/common → knowledge/share}/userSig.md +0 -0
|
@@ -1,241 +0,0 @@
|
|
|
1
|
-
本篇文档将指导您使用 Atomicx 的核心视图组件 `RoomView` 实现实时音视频房间的视频画面渲染。通过配置布局模板和利用组件插槽,您可以快速实现视频布局的切换与个性化定制。
|
|
2
|
-
|
|
3
|
-
`RoomView` 是 Atomicx 中负责视频画面渲染的主容器组件。它会自动处理视频流的订阅、渲染和释放,您只需关注其布局配置和 UI 增强。
|
|
4
|
-
|
|
5
|
-
## 核心能力
|
|
6
|
-
|
|
7
|
-
`RoomView` 作为多人音视频房间的核心视图容器,内置了多项企业级音视频处理能力:
|
|
8
|
-
- **智能性能管理**:支持视口内视频流懒加载,并能根据流区域尺寸,远端流数量自动进行高低清流切换,显著降低系统能耗与带宽占用。
|
|
9
|
-
|
|
10
|
-
- **精细化排序策略**:系统根据角色(主持人优先)与媒体状态(音视频开启优先)自动调整画面顺序。
|
|
11
|
-
|
|
12
|
-
- **交互式演讲者模式**:支持双击锁定主画面,并在侧边栏或顶部栏布局中支持收起非核心区域,聚焦演示内容。
|
|
13
|
-
|
|
14
|
-
- **沉浸式视觉设计**:所有视频窗口强制保持 `16:9` 的标准比例,并配合交互显示的工具栏,提供无干扰的多人音视频房间体验。
|
|
15
|
-
|
|
16
|
-
## 可定制范围
|
|
17
|
-
|
|
18
|
-
`RoomView` 仅聚焦于底层视频流的播放,而将视图层的所有“表现权”交给了开发者。使用 `RoomView` 您可以自由定义:
|
|
19
|
-
- **布局切换**:根据业务场景(例如演讲模式或讨论模式)实时变换布局。
|
|
20
|
-
|
|
21
|
-
- **视频挂件 UI:**包含昵称标签、音量动态波形、角色徽章等。
|
|
22
|
-
|
|
23
|
-
## **前提条件**
|
|
24
|
-
- 用户已经通过 [useLoginState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-LoginState) 完成登录鉴权,请参考 接入概览。
|
|
25
|
-
|
|
26
|
-
- 用户已经通过 [useRoomState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-RoomState) 进入房间,参考 房间管理。
|
|
27
|
-
|
|
28
|
-
- 已在 `App.vue` 中配置全局 `UIKitProvider`,具体请参考 [配置 App.vue](https://cloud.tencent.com/document/product/647/81962#ce98ee15-b0cb-43af-81da-70f51231430e)。
|
|
29
|
-
|
|
30
|
-
## 实现视频布局功能
|
|
31
|
-
|
|
32
|
-
### 步骤1:引入并渲染基础布局
|
|
33
|
-
|
|
34
|
-
在您的会议页面(例如 RoomLayoutView.vue)中引入 `RoomView` 及布局枚举 `RoomLayoutTemplate`。
|
|
35
|
-
``` typescript
|
|
36
|
-
<template>
|
|
37
|
-
<div class="room-container">
|
|
38
|
-
<RoomView />
|
|
39
|
-
</div>
|
|
40
|
-
</template>
|
|
41
|
-
|
|
42
|
-
<script setup lang="ts">
|
|
43
|
-
import { ref } from 'vue';
|
|
44
|
-
import { RoomView } from 'tuikit-atomicx-vue3/room';
|
|
45
|
-
</script>
|
|
46
|
-
|
|
47
|
-
<style lang="scss">
|
|
48
|
-
.room-container {
|
|
49
|
-
width: 100%;
|
|
50
|
-
height: 100%;
|
|
51
|
-
}
|
|
52
|
-
</style>
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
> **注意:**
|
|
56
|
-
>
|
|
57
|
-
|
|
58
|
-
> `RoomView` 会自动占满父容器的高度和宽度,请确保其父容器具备明确的尺寸。
|
|
59
|
-
>
|
|
60
|
-
|
|
61
|
-
### 步骤2:切换布局模式
|
|
62
|
-
|
|
63
|
-
您可以根据业务逻辑(例如点击切换按钮)动态更新 `RoomView` 属性 `layoutTemplate` 的值。
|
|
64
|
-
| 属性名 | 类型 | 默认值 | 说明 |
|
|
65
|
-
| --- | --- | --- | --- |
|
|
66
|
-
| `layoutTemplate` | `RoomLayoutTemplate` | `RoomLayoutTemplate.GridLayout` | 视频流布局 |
|
|
67
|
-
|
|
68
|
-
`RoomLayoutTemplate` 可选值解析:
|
|
69
|
-
| 布局模式 | 枚举值 | 描述 |
|
|
70
|
-
| --- | --- | --- |
|
|
71
|
-
| 宫格布局 | `RoomLayoutTemplate.GridLayout` | 默认布局。所有参会者画面均匀排列,参会者超出 9 人时支持翻页。 |
|
|
72
|
-
| 侧边栏布局 | `RoomLayoutTemplate.SidebarLayout` | 主画面突出显示,其余参会者画面以侧边栏的形式排列,适用于演讲、报告等场景。 |
|
|
73
|
-
| 顶部栏布局 | `RoomLayoutTemplate.CinemaLayout` | 主画面突出显示,其余参会者画面以顶部栏的形式排列,适用于演讲、报告等场景。 |
|
|
74
|
-
|
|
75
|
-
``` typescript
|
|
76
|
-
<template>
|
|
77
|
-
<!-- 添加布局切换按钮 -->
|
|
78
|
-
<div class="layout-switcher">
|
|
79
|
-
<button @click="switchLayout(RoomLayoutTemplate.GridLayout)">宫格</button>
|
|
80
|
-
<button @click="switchLayout(RoomLayoutTemplate.SidebarLayout)">侧边栏</button>
|
|
81
|
-
<button @click="switchLayout(RoomLayoutTemplate.CinemaLayout)">顶部栏</button>
|
|
82
|
-
</div>
|
|
83
|
-
<div class="room-container">
|
|
84
|
-
<RoomView :layoutTemplate="currentLayout" />
|
|
85
|
-
</div>
|
|
86
|
-
</template>
|
|
87
|
-
|
|
88
|
-
<script setup lang="ts">
|
|
89
|
-
import { ref } from 'vue';
|
|
90
|
-
import { RoomView, RoomLayoutTemplate } from 'tuikit-atomicx-vue3/room';
|
|
91
|
-
// 默认使用宫格布局
|
|
92
|
-
const currentLayout = ref(RoomLayoutTemplate.GridLayout);
|
|
93
|
-
|
|
94
|
-
// 切换布局
|
|
95
|
-
const switchLayout = (layout: RoomLayoutTemplate) => {
|
|
96
|
-
currentLayout.value = layout;
|
|
97
|
-
};
|
|
98
|
-
</script>
|
|
99
|
-
|
|
100
|
-
<style lang="scss">
|
|
101
|
-
.room-container {
|
|
102
|
-
width: 100%;
|
|
103
|
-
height: 100%;
|
|
104
|
-
}
|
|
105
|
-
</style>
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
### 步骤3:实现视频流挂件信息
|
|
109
|
-
|
|
110
|
-
您可以通过使用 `participantViewUI` 插槽,为视频画面定制 UI 显示内容(例如设置昵称,添加自定义图标)。
|
|
111
|
-
|
|
112
|
-
| 插槽参数 | 类型 | 说明 |
|
|
113
|
-
| --- | --- | --- |
|
|
114
|
-
| `participant` | `RoomParticipant` | 当前视频流对应的参会者对象,包含用户的 `userId`、`userName`、`role` 等实时状态信息。 |
|
|
115
|
-
| `streamType` | `VideoStreamType` | 区分当前是摄像头流(Camera)还是屏幕分享流(Screen) |
|
|
116
|
-
|
|
117
|
-
#### 准备视觉资源
|
|
118
|
-
|
|
119
|
-
为了提供完整的交互反馈,建议您提前准备以下图标:
|
|
120
|
-
- 麦克风状态图标:区分开启、静音及动态音量条。
|
|
121
|
-
|
|
122
|
-
- 身份标识图标:用于区分房主(Owner)、管理员(Admin)与普通成员。
|
|
123
|
-
|
|
124
|
-
- 网络信号图标:展示实时的上/下行网络质量。
|
|
125
|
-
|
|
126
|
-
> **特别说明:**
|
|
127
|
-
>
|
|
128
|
-
|
|
129
|
-
> 我们在示例项目的 @tencentcloud/uikit-base-component-vue3 npm 包中提供了免版权的图标,您可以直接引入使用。
|
|
130
|
-
>
|
|
131
|
-
|
|
132
|
-
#### 实现代码示例
|
|
133
|
-
1. 新增文件 `ParticipantViewUI.vue` 实现单个视频流挂件层 UI 渲染逻辑。
|
|
134
|
-
|
|
135
|
-
``` typescript
|
|
136
|
-
<template>
|
|
137
|
-
<div class="stream-cover-container">
|
|
138
|
-
<div class="corner-user-info-container">
|
|
139
|
-
<div
|
|
140
|
-
v-if="showMasterIcon || showAdminIcon"
|
|
141
|
-
:class="{ 'master-icon': showMasterIcon, 'admin-icon': showAdminIcon }"
|
|
142
|
-
>
|
|
143
|
-
<IconUser />
|
|
144
|
-
</div>
|
|
145
|
-
<div v-if="!isScreenStream" :class="['audio-icon-container']">
|
|
146
|
-
<div class="audio-level-container">
|
|
147
|
-
<div class="audio-level" :style="audioLevelStyle" />
|
|
148
|
-
</div>
|
|
149
|
-
<IconMicOff v-if="!isMicrophoneOn" class="audio-icon" size="20" />
|
|
150
|
-
<IconMicOn v-else class="audio-icon" size="20" />
|
|
151
|
-
</div>
|
|
152
|
-
<span class="user-name" :title="displayName">
|
|
153
|
-
{{ displayName }}
|
|
154
|
-
</span>
|
|
155
|
-
</div>
|
|
156
|
-
</div>
|
|
157
|
-
</template>
|
|
158
|
-
|
|
159
|
-
<script setup lang="ts">
|
|
160
|
-
import { computed, defineProps } from 'vue';
|
|
161
|
-
import {
|
|
162
|
-
IconUser,
|
|
163
|
-
IconMicOff,
|
|
164
|
-
IconMicOn,
|
|
165
|
-
} from '@tencentcloud/uikit-base-component-vue3';
|
|
166
|
-
import { RoomParticipantRole, DeviceStatus, VideoStreamType, useRoomParticipantState } from 'tuikit-atomicx-vue3/room';
|
|
167
|
-
import type { RoomParticipant } from 'tuikit-atomicx-vue3/room';
|
|
168
|
-
|
|
169
|
-
interface Props {
|
|
170
|
-
participant: RoomParticipant;
|
|
171
|
-
streamType: VideoStreamType;
|
|
172
|
-
}
|
|
173
|
-
const props = defineProps<Props>();
|
|
174
|
-
|
|
175
|
-
const { speakingUsers } = useRoomParticipantState();
|
|
176
|
-
const speakingAudioVolume = computed(() => speakingUsers.value.get(props.participant.userId) || 0);
|
|
177
|
-
const audioLevelStyle = computed(() => {
|
|
178
|
-
if (props.participant.microphoneStatus === DeviceStatus.Off || !speakingAudioVolume.value) {
|
|
179
|
-
return '';
|
|
180
|
-
}
|
|
181
|
-
return `height: ${speakingAudioVolume.value * 4}%`;
|
|
182
|
-
});
|
|
183
|
-
|
|
184
|
-
const isMicrophoneOn = computed(() => props.participant.microphoneStatus === DeviceStatus.On);
|
|
185
|
-
const displayName = computed(() => props.participant.nameCard || props.participant.userName || props.participant.userId);
|
|
186
|
-
|
|
187
|
-
const showMasterIcon = computed(() => {
|
|
188
|
-
const { role } = props.participant;
|
|
189
|
-
return role === RoomParticipantRole.Owner && props.streamType === VideoStreamType.Camera;
|
|
190
|
-
});
|
|
191
|
-
|
|
192
|
-
const showAdminIcon = computed(() => {
|
|
193
|
-
const { role } = props.participant;
|
|
194
|
-
return (role === RoomParticipantRole.Admin && props.streamType === VideoStreamType.Camera);
|
|
195
|
-
});
|
|
196
|
-
</script>
|
|
197
|
-
|
|
198
|
-
<style lang="scss" scoped>
|
|
199
|
-
.stream-cover-container { position: absolute; top: 0; left: 0; width: 100%; height: 100%; border-radius: 12px; pointer-events: none; .corner-user-info-container { position: absolute; bottom: 8px; left: 8px; display: flex; align-content: center; align-items: center; box-sizing: border-box; min-width: 118px; max-width: calc(100% - 24px); padding-right: 10px; height: 32px; overflow: hidden; font-size: 14px; color: var(--uikit-color-white-1); border-radius: 16px; background-color: var(--uikit-color-black-5); .master-icon, .admin-icon { display: flex; flex-shrink: 0; align-items: center; justify-content: center; width: 32px; height: 32px; margin-left: 0; border-radius: 50%; background-color: var(--button-color-primary-default); } .admin-icon { background-color: var(--text-color-warning); } .audio-icon-container { margin-left: 4px; position: relative; width: 20px; height: 20px; flex-shrink: 0; min-width: 20px; &:first-child { margin-left: 8px; } .audio-level-container { position: absolute; top: 2px; left: 6px; display: flex; flex-flow: column-reverse wrap; justify-content: space-between; width: 8px; height: 12px; overflow: hidden; border-radius: 4px; .audio-level { width: 100%; background-color: var(--text-color-success); transition: height 0.2s; } } .audio-icon { position: absolute; top: 0; left: 0; } } .user-name { margin-left: 4px; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; min-width: 0; } .screen-icon { flex-shrink: 0; min-width: 0; color: var(--uikit-color-white-1); margin-left: 4px; margin-right: 2px; } .screen-info { margin-left: 4px; font-size: 12px; color: var(--uikit-color-white-1); flex-shrink: 0; min-width: 0; } }}
|
|
200
|
-
</style>
|
|
201
|
-
```
|
|
202
|
-
2. 配置 `RoomView` 插槽,在页面中渲染视频流挂件内容。
|
|
203
|
-
|
|
204
|
-
``` typescript
|
|
205
|
-
<template>
|
|
206
|
-
<div class="room-container">
|
|
207
|
-
<RoomView :layout-template="currentLayout">
|
|
208
|
-
<template #participantViewUI="{ participant, streamType }">
|
|
209
|
-
<ParticipantViewUI :participant="participant" :stream-type="streamType" />
|
|
210
|
-
</template>
|
|
211
|
-
</RoomView>
|
|
212
|
-
</div>
|
|
213
|
-
</template>
|
|
214
|
-
|
|
215
|
-
<script setup lang="ts">
|
|
216
|
-
import { ref } from 'vue';
|
|
217
|
-
import { RoomView, RoomLayoutTemplate } from 'tuikit-atomicx-vue3/room';
|
|
218
|
-
// 引入新增的 ParticipantViewUI.vue 文件
|
|
219
|
-
import ParticipantViewUI from './ParticipantViewUI.vue';
|
|
220
|
-
|
|
221
|
-
// 默认使用宫格布局
|
|
222
|
-
const currentLayout = ref(RoomLayoutTemplate.GridLayout);
|
|
223
|
-
</script>
|
|
224
|
-
```
|
|
225
|
-
|
|
226
|
-
## API 文档
|
|
227
|
-
| **State/Component** | **功能描述** | **API 文档** |
|
|
228
|
-
| --- | --- | --- |
|
|
229
|
-
| **useRoomParticipantState** | 包含房间内用户数据,用户管理接口。 | [API 文档](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-RoomParticipantState) |
|
|
230
|
-
|
|
231
|
-
## 常见问题
|
|
232
|
-
|
|
233
|
-
### **RoomView 是否包含屏幕分享流的渲染?**
|
|
234
|
-
|
|
235
|
-
`RoomView` 内置远端屏幕分享流的渲染,对于本地屏幕共享您需要通过 `participantViewUI` 插槽完成本地屏幕分享的占位 UI。
|
|
236
|
-
|
|
237
|
-
### RoomView 是否默认包含 UI 挂件?
|
|
238
|
-
|
|
239
|
-
`RoomView` 内部无默认 UI 挂件,您可以参考 [RoomView 开源使用示例](https://github.com/Tencent-RTC/TUIRoomKit/tree/main/Web/example/atomicx-vite-vue3-ts/src/components/RoomLayoutView) 快速完成自定义 UI 挂件。
|
|
240
|
-
|
|
241
|
-
### RoomView 提供的布局均不满足需求,是否可以提供更多的可选布局?
|
|
@@ -1,315 +0,0 @@
|
|
|
1
|
-
TUIRoomKit 是腾讯云推出的音视频房间 UI 应用。本次升级引入了全新的原子化组件接入方案,开发者可以灵活组合这些原子化组件,以构建个性化的音视频房间界面。
|
|
2
|
-
|
|
3
|
-
> **推荐使用更高效的 AI 集成助手**
|
|
4
|
-
>
|
|
5
|
-
|
|
6
|
-
> 我们为您提供了全新的 AI 集成方式,只需要描述您的需求,即可自动生成集成代码,大幅提升开发效率。
|
|
7
|
-
>
|
|
8
|
-
|
|
9
|
-
> [点击这里,立即体验 AI 集成](https://cloud.tencent.com/document/product/647/127873)
|
|
10
|
-
>
|
|
11
|
-
|
|
12
|
-
本文档介绍如何将 TUIRoomKit 集成到现有的 Vue3 项目中,同时介绍如何对 TUIRoomKit 的样式、布局及功能进行自定义修改。
|
|
13
|
-
- 桌面端多人会议
|
|
14
|
-
|
|
15
|
-
- H5 多人会议
|
|
16
|
-
|
|
17
|
-
## 前提条件
|
|
18
|
-
|
|
19
|
-
### 开通服务
|
|
20
|
-
|
|
21
|
-
请参考 [开通服务](https://cloud.tencent.com/document/product/647/104842) 领取 TUIRoomKit 体验版,并在 [应用管理](https://console.cloud.tencent.com/trtc) 页面获取以下信息:
|
|
22
|
-
- **SDKAppID**: 应用标识,腾讯云基于 `SDKAppID` 完成计费统计。
|
|
23
|
-
|
|
24
|
-
- **SDKSecretKey**: 应用密钥,用于初始化配置文件的密钥信息。
|
|
25
|
-
|
|
26
|
-
### 环境准备
|
|
27
|
-
- **Node.js**: ≥ 18.19.1 (推荐使用官方 LTS 版本)。
|
|
28
|
-
|
|
29
|
-
- **Vue**: ≥ 3.4.21。
|
|
30
|
-
|
|
31
|
-
- **现代浏览器**:支持 [WebRTC APIs](https://cloud.tencent.com/document/product/647/17249#.E6.94.AF.E6.8C.81.E7.9A.84.E5.B9.B3.E5.8F.B0) 的现代浏览器。
|
|
32
|
-
|
|
33
|
-
- **设备**:摄像头、麦克风、扬声器。
|
|
34
|
-
|
|
35
|
-
## 源码接入
|
|
36
|
-
|
|
37
|
-
### 步骤1:安装项目依赖
|
|
38
|
-
|
|
39
|
-
在您的业务项目中安装以下依赖。
|
|
40
|
-
|
|
41
|
-
【npm】
|
|
42
|
-
``` bash
|
|
43
|
-
npm install @tencentcloud/roomkit-web-vue3@latest tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/universal-api
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
【pnpm】
|
|
47
|
-
``` bash
|
|
48
|
-
pnpm install @tencentcloud/roomkit-web-vue3@latest tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/universal-api
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
【yarn】
|
|
52
|
-
``` bash
|
|
53
|
-
yarn add @tencentcloud/roomkit-web-vue3@latest tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/universal-api
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
### 步骤2:**引用 **TUIRoomKit** 组件**
|
|
57
|
-
``` typescript
|
|
58
|
-
<template>
|
|
59
|
-
<ConferenceMainView v-if="isPC"></ConferenceMainView>
|
|
60
|
-
<ConferenceMainViewH5 v-else></ConferenceMainViewH5>
|
|
61
|
-
</template>
|
|
62
|
-
<script setup>
|
|
63
|
-
import { ref } from 'vue';
|
|
64
|
-
import { ConferenceMainView, ConferenceMainViewH5 } from '@tencentcloud/roomkit-web-vue3';
|
|
65
|
-
import { getPlatform } from '@tencentcloud/universal-api';
|
|
66
|
-
|
|
67
|
-
const isPC = ref(getPlatform() === 'pc');
|
|
68
|
-
</script>
|
|
69
|
-
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
### 步骤3:配置 App.vue 文件
|
|
73
|
-
|
|
74
|
-
将以下内容合并到项目的 App.vue 文件中,以配置全局 UI 样式和用户登录逻辑:
|
|
75
|
-
- 配置全局 `UIKitProvider`:引入 `UIKitProvider` 组件,并设置默认主题和语言;
|
|
76
|
-
|
|
77
|
-
- 用户登录: 在 `onMounted` 钩子中执行 `login` 和 `setSelfInfo`;
|
|
78
|
-
|
|
79
|
-
``` typescript
|
|
80
|
-
<template>
|
|
81
|
-
<!-- Step 1: 配置全局 UIKitProvider -->
|
|
82
|
-
<UIKitProvider theme="light" language="zh-CN">
|
|
83
|
-
<!-- 您包含 ConferenceMainView 的业务组件 -->
|
|
84
|
-
</UIKitProvider>
|
|
85
|
-
</template>
|
|
86
|
-
|
|
87
|
-
<script setup>
|
|
88
|
-
import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
|
|
89
|
-
import { onMounted } from 'vue';
|
|
90
|
-
import { useLoginState } from 'tuikit-atomicx-vue3/room';
|
|
91
|
-
|
|
92
|
-
// step 2: 用户登陆
|
|
93
|
-
const { login, setSelfInfo } = useLoginState();
|
|
94
|
-
const SDKAppID = 0; // 注意:请替换为实时音视频控制台获取的 SDKAppID 信息
|
|
95
|
-
const userId = '填入您真实的 userId'; // 注意:请替换为真实的 userId
|
|
96
|
-
const userName = '填入您真实的 userName'; // 注意:请替换为真实的 userName
|
|
97
|
-
const userSig = '填入您真实的 userSig'; // 注意:生成临时 userSig 请参考 https://cloud.tencent.com/document/product/647/17275#console
|
|
98
|
-
onMounted(async () => {
|
|
99
|
-
try {
|
|
100
|
-
await login({
|
|
101
|
-
userId,
|
|
102
|
-
userSig,
|
|
103
|
-
sdkAppId: SDKAppID,
|
|
104
|
-
});
|
|
105
|
-
await setSelfInfo({
|
|
106
|
-
userName,
|
|
107
|
-
avatarUrl: '',
|
|
108
|
-
});
|
|
109
|
-
} catch (error: any) {
|
|
110
|
-
console.error('Login failed:', error);
|
|
111
|
-
}
|
|
112
|
-
});
|
|
113
|
-
</script>
|
|
114
|
-
|
|
115
|
-
<!-- Step 3: 配置全局样式(此样式用来覆盖脚手架搭建的新项目的默认样式,可按需配置)-->
|
|
116
|
-
<style>
|
|
117
|
-
html, body {
|
|
118
|
-
padding: 0 !important;
|
|
119
|
-
margin: 0 !important;
|
|
120
|
-
}
|
|
121
|
-
|
|
122
|
-
#app {
|
|
123
|
-
width: 100% !important;
|
|
124
|
-
height: 100% !important;
|
|
125
|
-
padding: 0 !important;
|
|
126
|
-
margin: 0 !important;
|
|
127
|
-
max-width: 100% !important;
|
|
128
|
-
max-height: 100% !important;
|
|
129
|
-
text-align: left !important;
|
|
130
|
-
overflow: hidden;
|
|
131
|
-
}
|
|
132
|
-
</style>
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
### 步骤4:发起新的会议
|
|
136
|
-
|
|
137
|
-
会议主持人可以通过调用 `conference.start` 接口来发起一场新的会议,其他参会者可以参见 步骤6 的描述,调用 `conference.join` 接口加入该会议。
|
|
138
|
-
|
|
139
|
-
> **注意:**
|
|
140
|
-
>
|
|
141
|
-
|
|
142
|
-
> 请参考步骤 3 在用户登录成功后调用 `conference.start `接口发起会议。
|
|
143
|
-
>
|
|
144
|
-
|
|
145
|
-
``` typescript
|
|
146
|
-
import { conference } from '@tencentcloud/roomkit-web-vue3';
|
|
147
|
-
const startConference = async () => {
|
|
148
|
-
await conference.start({
|
|
149
|
-
roomId: '123456', // 请替换为您真实的 roomId
|
|
150
|
-
options: {
|
|
151
|
-
roomName: '我的临时会议',
|
|
152
|
-
},
|
|
153
|
-
});
|
|
154
|
-
}
|
|
155
|
-
startConference();
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
### 步骤5:进入已有会议
|
|
159
|
-
|
|
160
|
-
参与者可以通过调用 `conference.join` 接口,填写对应的 roomId 参数,来加入由会议主持人在 步骤4 中发起的会议。
|
|
161
|
-
|
|
162
|
-
> **注意:**
|
|
163
|
-
>
|
|
164
|
-
|
|
165
|
-
> 请参考步骤 3 在用户登录成功后调用 `conference.join `接口加入会议。
|
|
166
|
-
>
|
|
167
|
-
|
|
168
|
-
``` typescript
|
|
169
|
-
import { conference } from '@tencentcloud/roomkit-web-vue3';
|
|
170
|
-
const joinConference = async () => {
|
|
171
|
-
await conference.join({
|
|
172
|
-
roomId: '123456', // 请替换为您真实的 roomId
|
|
173
|
-
});
|
|
174
|
-
}
|
|
175
|
-
joinConference();
|
|
176
|
-
```
|
|
177
|
-
|
|
178
|
-
## 启动项目
|
|
179
|
-
|
|
180
|
-
【npm】
|
|
181
|
-
``` bash
|
|
182
|
-
npm run dev
|
|
183
|
-
```
|
|
184
|
-
|
|
185
|
-
【pnpm】
|
|
186
|
-
``` bash
|
|
187
|
-
pnpm run dev
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
【yarn】
|
|
191
|
-
``` bash
|
|
192
|
-
yarn run dev
|
|
193
|
-
```
|
|
194
|
-
|
|
195
|
-
启动成功后,请在浏览器中打开调试地址(通常为 http://localhost:5173)访问应用。您将看到如下所示的会议界面:
|
|
196
|
-
|
|
197
|
-
## UI 快速自定义
|
|
198
|
-
|
|
199
|
-
### 主题及语言
|
|
200
|
-
|
|
201
|
-
通过配置 App.vue 中 `UIKitProvider` 的入参,修改主题及语言的默认值。
|
|
202
|
-
| UIKitProvider 参数 | 可选值 | 默认值 |
|
|
203
|
-
| --- | --- | --- |
|
|
204
|
-
| theme | "light" \\| "dark" | "light" |
|
|
205
|
-
| language | "zh-CN" \\| "en-US" | "en-US" |
|
|
206
|
-
|
|
207
|
-
``` typescript
|
|
208
|
-
<UIKitProvider theme="light" language="zh-CN">
|
|
209
|
-
<router-view />
|
|
210
|
-
</UIKitProvider>
|
|
211
|
-
|
|
212
|
-
<script setup lang="ts">
|
|
213
|
-
import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
|
|
214
|
-
```
|
|
215
|
-
|
|
216
|
-
### 配置用户联系人列表
|
|
217
|
-
|
|
218
|
-
TUIRoomKit 预定会议用户选择列表和会中呼叫用户选择列表默认展示用户关系链列表,批量导入用户关系链请参考以下步骤:
|
|
219
|
-
|
|
220
|
-
步骤1:使用 [账号管理 > 导入多个账号](https://cloud.tencent.com/document/product/269/4919) REST API 接口批量导入用户账号;
|
|
221
|
-
|
|
222
|
-
步骤2:使用 [好友管理 > 导入好友](https://cloud.tencent.com/document/product/269/8301) REST API 接口批量导入用户关系链;
|
|
223
|
-
|
|
224
|
-
## TUIRoomKit 界面定制
|
|
225
|
-
|
|
226
|
-
### 源码导出
|
|
227
|
-
|
|
228
|
-
【Vue3】
|
|
229
|
-
1. 执行源码导出脚本,默认拷贝路径为 `./src/components/RoomKit`
|
|
230
|
-
|
|
231
|
-
``` bash
|
|
232
|
-
node ./node_modules/@tencentcloud/roomkit-web-vue3/scripts/eject.js
|
|
233
|
-
```
|
|
234
|
-
2. 根据脚本提示确认是否要将 TUIRoomKit 源码拷贝到 `./src/components/RoomKit` 目录。如您需要自定义拷贝目录请输入 'y', 否则输入'n'。
|
|
235
|
-
|
|
236
|
-
3. 源码导出后,在您指定的项目路径中会新增 TUIRoomKit 源码。此时,您需要手动将 ConferenceMainView 组件,ConferenceMainViewH5 组件的 conference 对象的引用从 npm 包地址更改为 TUIRoom 源码的相对路径地址。
|
|
237
|
-
|
|
238
|
-
``` typescript
|
|
239
|
-
- import { ConferenceMainView, conference } from '@tencentcloud/roomkit-web-vue3';
|
|
240
|
-
// 替换引用路径为 TUIRoomKit 源码的真实路径
|
|
241
|
-
+ import { ConferenceMainView, ConferenceMainViewH5, conference } from './components/RoomKit/index.ts';
|
|
242
|
-
```
|
|
243
|
-
4. 配置 ESLint 校验
|
|
244
|
-
|
|
245
|
-
如果您导出 TUIRoomKit 源码后运行项目出现 ESLint 报错,您可以在`.eslintignore`文件中添加 RoomKit 文件夹忽略 ESLint 检测。
|
|
246
|
-
``` javascript
|
|
247
|
-
// 请替换为 TUIRoomKit 源码真实路径
|
|
248
|
-
src/components/RoomKit
|
|
249
|
-
```
|
|
250
|
-
|
|
251
|
-
### 自定义房间流布局
|
|
252
|
-
|
|
253
|
-
TUIRoomKit 目前支持九宫格、侧边栏及顶部栏三种流布局,默认为九宫格布局。
|
|
254
|
-
``` typescript
|
|
255
|
-
// RoomKit/views/ConferenceMainView/index.vue
|
|
256
|
-
import { RoomLayoutTemplate } from 'tuikit-atomicx-vue3/room';
|
|
257
|
-
// 修改默认视频流布局为侧边栏布局
|
|
258
|
-
const participantViewLayout = ref(RoomLayoutTemplate.SidebarLayout);
|
|
259
|
-
function handleLayoutUpdate(layout: RoomLayoutTemplate) {
|
|
260
|
-
participantViewLayout.value = layout;
|
|
261
|
-
}
|
|
262
|
-
|
|
263
|
-
// 修改默认视频流布局为顶部栏布局
|
|
264
|
-
const participantViewLayout = ref(RoomLayoutTemplate.CinemaLayout);
|
|
265
|
-
function handleLayoutUpdate(layout: RoomLayoutTemplate) {
|
|
266
|
-
participantViewLayout.value = layout;
|
|
267
|
-
}
|
|
268
|
-
```
|
|
269
|
-
|
|
270
|
-
### 自定义视频流挂件
|
|
271
|
-
|
|
272
|
-
TUIRoomKit 默认视频流挂件如图所示,如需自定义视频流挂件请修改 `RoomKit/components/RoomLayoutView/ParticipantViewUI/ParticipantViewUI.vue` 组件。
|
|
273
|
-
|
|
274
|
-
## 常见问题
|
|
275
|
-
|
|
276
|
-
#### **TUIRoomKit 在本地开发时使用正常,但部署到线上环境后无法**正常采集用户的摄像头或麦克风设备**?**
|
|
277
|
-
- **原因分析:**浏览器出于安全和隐私保护的考虑,对音视频设备(麦克风、摄像头)的采集有着严格限制。只有在安全环境下,采集操作才会被允许。安全环境协议包括:https://、localhost、file:// 等。HTTP 协议被视为不安全,浏览器会默认禁止访问媒体设备。
|
|
278
|
-
|
|
279
|
-
- **解决方案:**若您在本地(localhost)测试一切正常,但部署后出现采集失败,请立即检查您的网页是否部署在 HTTP 协议上。您必须使用 HTTPS 协议部署您的网页,并确保具备有效的安全证书。
|
|
280
|
-
|
|
281
|
-
- **相关资源:**更多关于 URL 域名及协议的限制详情,请参见 [URL 域名及协议限制说明](https://cloud.tencent.com/document/product/647/17249#URL-.E5.9F.9F.E5.90.8D.E5.8D.8F.E8.AE.AE.E9.99.90.E5.88.B6)。
|
|
282
|
-
|
|
283
|
-
#### **TUIRoomKit 是否支持使用 iframe 集成?**
|
|
284
|
-
|
|
285
|
-
支持。使用 iframe 集成 TUIRoomKit 时, 需要在 iframe 标签中配置 allow 属性以授予必要的浏览器权限(麦克风、摄像头、屏幕共享、全屏等),示例如下:
|
|
286
|
-
``` typescript
|
|
287
|
-
// 开启麦克风、摄像头、屏幕分享、全屏权限
|
|
288
|
-
<iframe allow="microphone; camera; display-capture; display; fullscreen;">
|
|
289
|
-
```
|
|
290
|
-
|
|
291
|
-
#### TUIRoomKit 是否支持设置内网代理?
|
|
292
|
-
|
|
293
|
-
支持。请参考如下指引设置内网代理参数。更多内网代理信息请参考 [应对防火墙受限](https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-34-advanced-proxy.html)。
|
|
294
|
-
``` typescript
|
|
295
|
-
// 请在进房前设置内网代理参数
|
|
296
|
-
import TUIRoomEngine from '@tencentcloud/tuiroom-engine-js';
|
|
297
|
-
import { useRoomEngine } from 'tuikit-atomicx-vue3/room';
|
|
298
|
-
const { roomEngine } = useRoomEngine();
|
|
299
|
-
|
|
300
|
-
TUIRoomEngine.once('ready', () => {
|
|
301
|
-
const trtcCloud = roomEngine.instance?.getTRTCCloud();
|
|
302
|
-
trtcCloud.callExperimentalAPI(JSON.stringify({
|
|
303
|
-
api: 'setNetworkProxy',
|
|
304
|
-
params: {
|
|
305
|
-
websocketProxy: "wss://proxy.example.com/ws/",
|
|
306
|
-
turnServer: [{
|
|
307
|
-
url: '14.3.3.3:3478',
|
|
308
|
-
username: 'turn',
|
|
309
|
-
credential: 'turn',
|
|
310
|
-
}],
|
|
311
|
-
iceTransportPolicy: 'relay',
|
|
312
|
-
},
|
|
313
|
-
}));
|
|
314
|
-
});
|
|
315
|
-
```
|
|
File without changes
|