@tencent-rtc/mcp 1.3.9 → 1.4.0
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/package.json +2 -2
- package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/android-faq.md} +10 -22
- package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/flutter-faq.md} +10 -22
- package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/ios-faq.md} +10 -22
- package/resource/doc/callkit/preset/android/api.md +296 -0
- package/resource/doc/{tuicallkit → callkit/preset}/android/integration.md +53 -365
- package/resource/doc/callkit/preset/flutter/api.md +410 -0
- package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +35 -97
- package/resource/doc/callkit/preset/ios/api.md +80 -0
- package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +37 -118
- package/resource/doc/callkit/preset/react/api.md +501 -0
- package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +5 -20
- package/resource/doc/callkit/preset/vue/api.md +501 -0
- package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +4 -19
- package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -38
- package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
- package/resource/doc/{chatuikit → chatkit}/android/integration.md +28 -121
- package/resource/doc/chatkit/faq/android_sdk/client-api.md +281 -0
- package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +0 -1
- package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -1
- package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +199 -0
- package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
- package/resource/doc/chatkit/faq/ios_sdk/client-api.md +235 -0
- package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +3 -3
- package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
- package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +18 -87
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -38
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +47 -165
- package/resource/doc/{chatuikit → chatkit}/react/components/avatar.md +0 -33
- package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +8 -49
- package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +6 -35
- package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +0 -6
- package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -11
- package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +96 -502
- package/resource/doc/chatkit/react/components/conversation-actions.md +174 -0
- package/resource/doc/chatkit/react/components/conversation-list.md +333 -0
- package/resource/doc/chatkit/react/components/conversation-preview.md +118 -0
- package/resource/doc/chatkit/react/components/conversation-search.md +60 -0
- package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -337
- package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +20 -212
- package/resource/doc/chatkit/react/components/search.md +243 -0
- package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +1 -47
- package/resource/doc/{chatuikit → chatkit}/react/integration.md +21 -81
- package/resource/doc/{chatuikit → chatkit}/vue/components/avatar.md +0 -33
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -48
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +3 -5
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +0 -5
- package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -15
- package/resource/doc/chatkit/vue/components/contact-list.md +271 -0
- package/resource/doc/chatkit/vue/components/conversation-actions.md +228 -0
- package/resource/doc/{chatuikit → chatkit}/vue/components/conversation-list.md +42 -492
- package/resource/doc/chatkit/vue/components/conversation-preview.md +213 -0
- package/resource/doc/chatkit/vue/components/conversation-search.md +50 -0
- package/resource/doc/{chatuikit → chatkit}/vue/components/message-input.md +2 -223
- package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -252
- package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
- package/resource/doc/{chatuikit → chatkit}/vue/components/tuikit.md +7 -21
- package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +3 -62
- package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
- package/resource/doc/{chatuikit → chatkit}/vue/integration.md +22 -23
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +18 -89
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-audio-effect.md +34 -192
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-barrage.md +28 -141
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +20 -112
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +59 -193
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-gift.md +75 -455
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-host-interaction.md +94 -344
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +107 -515
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +33 -173
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +14 -93
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -179
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +19 -107
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -166
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -163
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +69 -443
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-integration.md +107 -492
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +23 -165
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +35 -111
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +35 -193
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +31 -144
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +24 -116
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +37 -171
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +79 -459
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +69 -320
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +85 -502
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +32 -169
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audience-list.md +18 -89
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audio-effect.md +34 -192
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-barrage.md +28 -141
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-co-guest-interaction.md +50 -259
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-gift.md +75 -455
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-host-interaction.md +51 -265
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-integration.md +61 -427
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-room-list.md +33 -173
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-co-guest-interaction.md +44 -203
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-integration.md +56 -416
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audience-list.md +35 -111
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audio-effect.md +35 -193
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-barrage.md +31 -144
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-co-guest-interaction.md +43 -252
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-gift.md +79 -459
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-host-interaction.md +46 -264
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-integration.md +61 -445
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-room-list.md +32 -169
- package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -2
- package/resource/doc/livekit/preset/live/vue/api-reference/index.md +780 -0
- package/resource/doc/livekit/preset/live/vue/components/barrage.md +291 -0
- package/resource/doc/livekit/{live → preset/live}/vue/components/co-guest-panel.md +10 -49
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +26 -144
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +12 -75
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +36 -227
- package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +215 -0
- package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
- package/resource/doc/livekit/preset/live/vue/live-list-integration.md +241 -0
- package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +299 -0
- package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +300 -0
- package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +743 -0
- package/resource/doc/roomkit/vue/faq.md +1 -0
- package/resource/doc/roomkit/vue/features/call-user-to-room.md +17 -53
- package/resource/doc/roomkit/vue/features/device-detection.md +30 -48
- package/resource/doc/roomkit/vue/features/device-state.md +24 -44
- package/resource/doc/roomkit/vue/features/free-beauty-panel.md +13 -36
- package/resource/doc/roomkit/vue/features/room-chat.md +31 -89
- package/resource/doc/roomkit/vue/features/room-participant-state.md +28 -50
- package/resource/doc/roomkit/vue/features/room-state.md +25 -34
- package/resource/doc/roomkit/vue/features/room-view.md +30 -125
- package/resource/doc/roomkit/vue/features/schedule-room.md +9 -40
- package/resource/doc/roomkit/vue/features/screen-share.md +22 -90
- package/resource/doc/roomkit/vue/features/virtual-background.md +13 -29
- package/resource/doc/roomkit/vue/integration.md +21 -76
- package/resource/doc/rtcengine/faq/common/error_code.md +1 -0
- package/resource/doc/rtcengine/faq/web/web.md +14 -24
- package/resource/doc/rtcengine/web/api.md +1 -3
- package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +3 -10
- package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +1 -5
- package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +1 -2
- package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -4
- package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +3 -5
- package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +1 -7
- package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +0 -2
- package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -8
- package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +11 -11
- package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +12 -88
- package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -5
- package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +30 -37
- package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +13 -90
- package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -2
- package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +1 -2
- package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +19 -19
- package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +1 -1
- package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +4 -5
- package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
- package/resource/doc/trtc/C++/ITRTCCloud.md +686 -2835
- package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
- package/resource/doc/trtc/C++/ITXAudioEffectManager.md +202 -1022
- package/resource/doc/trtc/C++/ITXDeviceManager.md +126 -767
- package/resource/doc/trtc/C++/TRTCCloudCallback.md +579 -2147
- package/resource/doc/trtc/C++/TRTCTypeDef.md +703 -3378
- package/resource/doc/trtc/C++/TXLiteAVCode.md +116 -908
- package/resource/doc/trtc/android/TRTCCloud.md +606 -2573
- package/resource/doc/trtc/android/TRTCCloudDef.md +752 -3640
- package/resource/doc/trtc/android/TRTCCloudListener.md +581 -2008
- package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
- package/resource/doc/trtc/android/TXAudioEffectManager.md +202 -1022
- package/resource/doc/trtc/android/TXBeautyManager.md +127 -704
- package/resource/doc/trtc/android/TXDeviceManager.md +51 -318
- package/resource/doc/trtc/android/TXLiteAVCode.md +114 -892
- package/resource/doc/trtc/iOS/TRTCCloud.md +694 -2904
- package/resource/doc/trtc/iOS/TRTCCloudDef.md +726 -3498
- package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +543 -2028
- package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
- package/resource/doc/trtc/iOS/TXAudioEffectManager.md +174 -877
- package/resource/doc/trtc/iOS/TXBeautyManager.md +128 -710
- package/resource/doc/trtc/iOS/TXDeviceManager.md +129 -772
- package/resource/doc/trtc/iOS/TXLiteAVCode.md +117 -915
- package/server.js +1 -5
- package/server.js.map +1 -1
- package/tools/call/get_callkit_api.js +32 -0
- package/tools/call/get_callkit_api.js.map +1 -0
- package/tools/call/get_native_call_uikit_integration.js +34 -0
- package/tools/call/get_native_call_uikit_integration.js.map +1 -0
- package/tools/call/{get-web-call-integration.js → get_web_call_uikit_integration.js} +13 -8
- package/tools/call/get_web_call_uikit_integration.js.map +1 -0
- package/tools/chat/get_native_chat_uikit_feature_detail.js +34 -0
- package/tools/chat/get_native_chat_uikit_feature_detail.js.map +1 -0
- package/tools/chat/get_native_chat_uikit_integration.js +45 -0
- package/tools/chat/get_native_chat_uikit_integration.js.map +1 -0
- package/tools/chat/get_web_chat_uikit_component_detail.js +34 -0
- package/tools/chat/get_web_chat_uikit_component_detail.js.map +1 -0
- package/tools/chat/get_web_chat_uikit_integration.js +45 -0
- package/tools/chat/get_web_chat_uikit_integration.js.map +1 -0
- package/tools/common/get_faq.js +265 -0
- package/tools/common/get_faq.js.map +1 -0
- package/tools/common/{get-usersig.js → get_usersig.js} +6 -3
- package/tools/common/get_usersig.js.map +1 -0
- package/tools/common/present_framework_choice.js +63 -0
- package/tools/common/present_framework_choice.js.map +1 -0
- package/tools/definitions/get_callkit_api_def.js +29 -0
- package/tools/definitions/get_callkit_api_def.js.map +1 -0
- package/tools/definitions/get_faq_def.js +17 -18
- package/tools/definitions/get_faq_def.js.map +1 -1
- package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
- package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
- package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -41
- package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_native_livekit_core_features_def.js +34 -0
- package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
- package/tools/definitions/get_native_livekit_core_integration_def.js +34 -0
- package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
- package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
- package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
- package/tools/definitions/get_usersig_def.js +17 -22
- package/tools/definitions/get_usersig_def.js.map +1 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
- package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
- package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js +15 -18
- package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_livekit_api_def.js +30 -0
- package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
- package/tools/definitions/get_web_livekit_component_detail_def.js +32 -0
- package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
- package/tools/definitions/get_web_room_uikit_integration_def.js +15 -46
- package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_roomkit_feature_detail_def.js +31 -0
- package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_api_def.js +27 -0
- package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_integration_def.js +27 -0
- package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js +27 -0
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
- package/tools/definitions/present_framework_choice_def.js +24 -12
- package/tools/definitions/present_framework_choice_def.js.map +1 -1
- package/tools/index.js +47 -61
- package/tools/index.js.map +1 -1
- package/tools/live/get_native_livekit_core_features.js +65 -0
- package/tools/live/get_native_livekit_core_features.js.map +1 -0
- package/tools/live/get_native_livekit_core_integration.js +59 -0
- package/tools/live/get_native_livekit_core_integration.js.map +1 -0
- package/tools/live/get_web_live_uikit_integration.js +48 -0
- package/tools/live/get_web_live_uikit_integration.js.map +1 -0
- package/tools/live/get_web_livekit_api.js +32 -0
- package/tools/live/get_web_livekit_api.js.map +1 -0
- package/tools/live/get_web_livekit_component_detail.js +34 -0
- package/tools/live/get_web_livekit_component_detail.js.map +1 -0
- package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
- package/tools/room/get_web_room_uikit_integration.js.map +1 -0
- package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
- package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
- package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
- package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
- package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
- package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
- package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
- package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
- package/utils/generate-structured-result.js +61 -17
- package/utils/generate-structured-result.js.map +1 -1
- package/utils/report-cls-client.js +12 -1
- package/utils/report-cls-client.js.map +1 -1
- package/utils/report-es-client.js +2 -2
- package/resource/doc/chatuikit/android/workflow.md +0 -713
- package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1371
- package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -932
- package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1119
- package/resource/doc/chatuikit/flutter/workflow.md +0 -941
- package/resource/doc/chatuikit/react/components/conversation-list.md +0 -1017
- package/resource/doc/chatuikit/react/components/search.md +0 -745
- package/resource/doc/chatuikit/react/create-group.md +0 -23
- package/resource/doc/chatuikit/react/init.md +0 -26
- package/resource/doc/chatuikit/react/workflow.md +0 -258
- package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
- package/resource/doc/chatuikit/vue/create-group.md +0 -25
- package/resource/doc/chatuikit/vue/init.md +0 -40
- package/resource/doc/chatuikit/vue/workflow.md +0 -395
- package/resource/doc/livekit/live/android/workflow.md +0 -320
- package/resource/doc/livekit/live/flutter/workflow.md +0 -353
- package/resource/doc/livekit/live/ios/workflow.md +0 -454
- package/resource/doc/livekit/live/vue/components/barrage.md +0 -616
- package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -446
- package/resource/doc/livekit/live/vue/faq.md +0 -0
- package/resource/doc/livekit/live/vue/live-list-integration.md +0 -200
- package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -269
- package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -269
- package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -595
- package/resource/doc/livekit/live/vue/states/live-state.md +0 -3591
- package/resource/doc/livekit/live/vue/workflow.md +0 -218
- package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -312
- package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -430
- package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -679
- package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -671
- package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -271
- package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
- package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
- package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
- package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
- package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -865
- package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -657
- package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -437
- package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -335
- package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
- package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -327
- package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -507
- package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
- package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -659
- package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
- package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -814
- package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1000
- package/resource/doc/roomkit/vue/features/workflow.md +0 -553
- package/resource/doc/roomkit/vue/workflow.md +0 -733
- package/resource/doc/tuicallkit/android/workflow.md +0 -441
- package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -784
- package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -610
- package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -938
- package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -897
- package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -469
- package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -781
- package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -398
- package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
- package/resource/doc/tuicallkit/react/api.md +0 -1404
- package/resource/doc/tuicallkit/vue/api.md +0 -1406
- package/resource/doc/tuicallkit/vue/faq.md +0 -36
- package/tools/call/get-native-call-integration.js +0 -43
- package/tools/call/get-native-call-integration.js.map +0 -1
- package/tools/call/get-web-call-api.js +0 -27
- package/tools/call/get-web-call-api.js.map +0 -1
- package/tools/call/get-web-call-integration.js.map +0 -1
- package/tools/chat/get-native-chat-feature-detail.js +0 -30
- package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
- package/tools/chat/get-native-chat-integration.js +0 -45
- package/tools/chat/get-native-chat-integration.js.map +0 -1
- package/tools/chat/get-web-chat-component-detail.js +0 -31
- package/tools/chat/get-web-chat-component-detail.js.map +0 -1
- package/tools/chat/get-web-chat-integration.js +0 -45
- package/tools/chat/get-web-chat-integration.js.map +0 -1
- package/tools/chat/get-web-chat-uikit-init.js +0 -28
- package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
- package/tools/chat/get-web-create-group-doc.js +0 -28
- package/tools/chat/get-web-create-group-doc.js.map +0 -1
- package/tools/common/get-faq.js +0 -91
- 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 +0 -16
- package/tools/common/present-framework-choice.js.map +0 -1
- package/tools/common/present-scenario-choice.js +0 -16
- package/tools/common/present-scenario-choice.js.map +0 -1
- package/tools/common/record-prompt.js +0 -55
- package/tools/common/record-prompt.js.map +0 -1
- package/tools/common/record-result.js +0 -60
- package/tools/common/record-result.js.map +0 -1
- package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
- package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_native_live_api_def.js +0 -23
- package/tools/definitions/get_native_live_api_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -87
- package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_integration_def.js +0 -75
- package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
- package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
- package/tools/definitions/get_trtc_native_api_def.js +0 -16
- package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
- package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
- package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
- package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
- package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
- package/tools/definitions/get_web_create_group_doc_def.js +0 -18
- package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
- package/tools/definitions/get_web_live_state_detail_def.js +0 -19
- package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
- package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
- package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_room_feature_detail_def.js +0 -92
- package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_web_room_state_detail_def.js +0 -19
- package/tools/definitions/get_web_room_state_detail_def.js.map +0 -1
- package/tools/definitions/present_scenario_choice_def.js +0 -53
- package/tools/definitions/present_scenario_choice_def.js.map +0 -1
- package/tools/definitions/record_prompt_def.js +0 -58
- package/tools/definitions/record_prompt_def.js.map +0 -1
- package/tools/definitions/record_result_def.js +0 -46
- package/tools/definitions/record_result_def.js.map +0 -1
- package/tools/live/get-native-live-uikit-integration.js +0 -177
- package/tools/live/get-native-live-uikit-integration.js.map +0 -1
- package/tools/live/get-web-live-component-detail.js +0 -31
- package/tools/live/get-web-live-component-detail.js.map +0 -1
- package/tools/live/get-web-live-state-detail.js +0 -31
- package/tools/live/get-web-live-state-detail.js.map +0 -1
- package/tools/live/get-web-live-uikit-integration.js +0 -52
- package/tools/live/get-web-live-uikit-integration.js.map +0 -1
- package/tools/live/get_native_live_uikit_extra_features.js +0 -105
- package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
- package/tools/live/get_native_live_uikit_interaction.js +0 -194
- package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
- package/tools/native_live/get-native-live-api.js +0 -31
- package/tools/native_live/get-native-live-api.js.map +0 -1
- package/tools/room/get-web-room-feature-detail.js.map +0 -1
- package/tools/room/get-web-room-integration.js.map +0 -1
- package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
- package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
- package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
- package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
- package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
- package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
- package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
- package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
- package/tools/trtc/get-trtc-native-api.js +0 -31
- package/tools/trtc/get-trtc-native-api.js.map +0 -1
- package/utils/handle-component-name.js +0 -33
- package/utils/handle-component-name.js.map +0 -1
- /package/resource/doc/{chatuikit/iOS/workflow.md → callkit/core-sdk/.gitkeep} +0 -0
- /package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +0 -0
- /package/resource/doc/{tuicallkit/react/faq.md → callkit/faq/web-faq.md} +0 -0
- /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
- /package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +0 -0
- /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
- /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
- /package/resource/doc/roomkit/faq/common/{error_code.md → error-code.md} +0 -0
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
This document guides you on how to use Atomicx to implement screen sharing capabilities and handle room interactions based on screen sharing status.
|
|
2
2
|
|
|
3
3
|
## Prerequisites
|
|
4
|
-
- The user has completed login authentication through [useLoginState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-LoginState), please refer to
|
|
4
|
+
- The user has completed login authentication through [useLoginState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-LoginState), please refer to Integration Overview.
|
|
5
5
|
|
|
6
|
-
- The user has entered a room through [useRoomState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-RoomState), please refer to
|
|
6
|
+
- The user has entered a room through [useRoomState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-RoomState), please refer to Room Management.
|
|
7
7
|
|
|
8
8
|
- If integrating in `iframe`, permissions need to be declared in the tag.
|
|
9
9
|
|
|
@@ -17,8 +17,6 @@ This document guides you on how to use Atomicx to implement screen sharing capab
|
|
|
17
17
|
|
|
18
18
|
Use the [startScreenShare](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startScreenShare) method to start screen sharing. In the Web environment, you will see the browser's screen selector where you can choose to share the entire screen, application window, or browser tab.
|
|
19
19
|
|
|
20
|
-

|
|
21
|
-
|
|
22
20
|
``` typescript
|
|
23
21
|
import { useDeviceState } from 'tuikit-atomicx-vue3/room';
|
|
24
22
|
const { startScreenShare } = useDeviceState();
|
|
@@ -38,8 +36,6 @@ const handleStartShare = async () => {
|
|
|
38
36
|
|
|
39
37
|
By setting the `screenAudio: true` parameter, you can share system audio while screen sharing. This is very useful when sharing videos, presentations, music, and other audio content.
|
|
40
38
|
|
|
41
|
-

|
|
42
|
-
|
|
43
39
|
``` typescript
|
|
44
40
|
import { useDeviceState } from 'tuikit-atomicx-vue3/room';
|
|
45
41
|
const { startScreenShare } = useDeviceState();
|
|
@@ -56,55 +52,18 @@ const handleStartScreenShareWithAudio = async () => {
|
|
|
56
52
|
```
|
|
57
53
|
|
|
58
54
|
**Browser Compatibility Notes:**
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
<td rowspan="1" colSpan="1" >Notes</td>
|
|
66
|
-
</tr>
|
|
67
|
-
|
|
68
|
-
<tr>
|
|
69
|
-
<td rowspan="1" colSpan="1" >Chrome 74+</td>
|
|
70
|
-
|
|
71
|
-
<td rowspan="1" colSpan="1" >Supported</td>
|
|
72
|
-
|
|
73
|
-
<td rowspan="1" colSpan="1" >Need to check **Share audio** in selector</td>
|
|
74
|
-
</tr>
|
|
75
|
-
|
|
76
|
-
<tr>
|
|
77
|
-
<td rowspan="1" colSpan="1" >Edge 79+</td>
|
|
78
|
-
|
|
79
|
-
<td rowspan="1" colSpan="1" >Supported</td>
|
|
80
|
-
|
|
81
|
-
<td rowspan="1" colSpan="1" >Based on Chromium, same experience as Chrome</td>
|
|
82
|
-
</tr>
|
|
83
|
-
|
|
84
|
-
<tr>
|
|
85
|
-
<td rowspan="1" colSpan="1" >Firefox</td>
|
|
86
|
-
|
|
87
|
-
<td rowspan="1" colSpan="1" >Not Supported</td>
|
|
88
|
-
|
|
89
|
-
<td rowspan="1" colSpan="1" >System audio sharing not supported yet</td>
|
|
90
|
-
</tr>
|
|
91
|
-
|
|
92
|
-
<tr>
|
|
93
|
-
<td rowspan="1" colSpan="1" >Safari</td>
|
|
94
|
-
|
|
95
|
-
<td rowspan="1" colSpan="1" >Not Supported</td>
|
|
96
|
-
|
|
97
|
-
<td rowspan="1" colSpan="1" >System audio sharing not supported yet</td>
|
|
98
|
-
</tr>
|
|
99
|
-
</table>
|
|
100
|
-
|
|
55
|
+
| Browser | System Audio Sharing Support | Notes |
|
|
56
|
+
| --- | --- | --- |
|
|
57
|
+
| Chrome 74+ | Supported | Need to check **Share audio** in selector |
|
|
58
|
+
| Edge 79+ | Supported | Based on Chromium, same experience as Chrome |
|
|
59
|
+
| Firefox | Not Supported | System audio sharing not supported yet |
|
|
60
|
+
| Safari | Not Supported | System audio sharing not supported yet |
|
|
101
61
|
|
|
102
62
|
> **Note:**
|
|
103
|
-
>
|
|
63
|
+
>
|
|
104
64
|
|
|
105
65
|
> System audio sharing requires browser support, and users need to check the **Share audio** option in the screen selector. If the browser doesn't support system audio sharing, the `screenAudio` parameter will be ignored, but screen video sharing will work normally.
|
|
106
|
-
>
|
|
107
|
-
|
|
66
|
+
>
|
|
108
67
|
|
|
109
68
|
### Step 3: Stop Screen Sharing
|
|
110
69
|
|
|
@@ -114,7 +73,7 @@ Users can stop screen sharing through the following methods:
|
|
|
114
73
|
``` typescript
|
|
115
74
|
import { useDeviceState, DeviceStatus } from 'tuikit-atomicx-vue3/room';
|
|
116
75
|
const { screenStatus, stopScreenShare } = useDeviceState();
|
|
117
|
-
|
|
76
|
+
|
|
118
77
|
// Stop screen sharing
|
|
119
78
|
const handleStopScreenShare = async () => {
|
|
120
79
|
try {
|
|
@@ -127,17 +86,13 @@ Users can stop screen sharing through the following methods:
|
|
|
127
86
|
```
|
|
128
87
|
2. **Click the browser's native "Stop sharing" button**
|
|
129
88
|
|
|
130
|
-

|
|
131
|
-
|
|
132
89
|
3. **Close the shared window or tab**
|
|
133
|
-
|
|
134
90
|
|
|
135
91
|
> **Note:**
|
|
136
|
-
>
|
|
92
|
+
>
|
|
137
93
|
|
|
138
94
|
> When users stop screen sharing using any method, Atomicx will automatically update the [screenStatus](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#screenStatus) state.
|
|
139
|
-
>
|
|
140
|
-
|
|
95
|
+
>
|
|
141
96
|
|
|
142
97
|
### Step 4: Permission Control and State Listening
|
|
143
98
|
|
|
@@ -173,9 +128,9 @@ When detecting that a user in the room has started screen sharing, it is recomme
|
|
|
173
128
|
<div class="room-container">
|
|
174
129
|
<RoomView :layout-template="layoutTemplate">
|
|
175
130
|
<template #participantViewUI="{ participant, streamType }">
|
|
176
|
-
<ParticipantViewUI
|
|
177
|
-
:participant="participant"
|
|
178
|
-
:stream-type="streamType"
|
|
131
|
+
<ParticipantViewUI
|
|
132
|
+
:participant="participant"
|
|
133
|
+
:stream-type="streamType"
|
|
179
134
|
/>
|
|
180
135
|
</template>
|
|
181
136
|
</RoomView>
|
|
@@ -184,8 +139,8 @@ When detecting that a user in the room has started screen sharing, it is recomme
|
|
|
184
139
|
|
|
185
140
|
<script setup lang="ts">
|
|
186
141
|
import { ref, watch } from 'vue';
|
|
187
|
-
import {
|
|
188
|
-
RoomView,
|
|
142
|
+
import {
|
|
143
|
+
RoomView,
|
|
189
144
|
RoomLayoutTemplate,
|
|
190
145
|
useRoomParticipantState
|
|
191
146
|
} from 'tuikit-atomicx-vue3/room';
|
|
@@ -272,32 +227,10 @@ try {
|
|
|
272
227
|
```
|
|
273
228
|
|
|
274
229
|
## API Documentation
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
<td rowspan="1" colSpan="1" >**Feature Description**</td>
|
|
280
|
-
|
|
281
|
-
<td rowspan="1" colSpan="1" >**API Documentation**</td>
|
|
282
|
-
</tr>
|
|
283
|
-
|
|
284
|
-
<tr>
|
|
285
|
-
<td rowspan="1" colSpan="1" >**useDeviceState**</td>
|
|
286
|
-
|
|
287
|
-
<td rowspan="1" colSpan="1" >Contains audio/video device status, audio/video device list, and operation interfaces.</td>
|
|
288
|
-
|
|
289
|
-
<td rowspan="1" colSpan="1" >[API Documentation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-DeviceState)</td>
|
|
290
|
-
</tr>
|
|
291
|
-
|
|
292
|
-
<tr>
|
|
293
|
-
<td rowspan="1" colSpan="1" >**useRoomParticipantState**</td>
|
|
294
|
-
|
|
295
|
-
<td rowspan="1" colSpan="1" >Contains room user data and user management interface.</td>
|
|
296
|
-
|
|
297
|
-
<td rowspan="1" colSpan="1" >[API Documentation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-RoomParticipantState)</td>
|
|
298
|
-
</tr>
|
|
299
|
-
</table>
|
|
300
|
-
|
|
230
|
+
| **State/Component** | **Feature Description** | **API Documentation** |
|
|
231
|
+
| --- | --- | --- |
|
|
232
|
+
| **useDeviceState** | Contains audio/video device status, audio/video device list, and operation interfaces. | [API Documentation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-DeviceState) |
|
|
233
|
+
| **useRoomParticipantState** | Contains room user data and user management interface. | [API Documentation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-RoomParticipantState) |
|
|
301
234
|
|
|
302
235
|
## Common Questions
|
|
303
236
|
|
|
@@ -308,7 +241,6 @@ try {
|
|
|
308
241
|
|
|
309
242
|
- **System Restriction:** Some operating systems do not support sharing audio from specific **application windows**. It is recommended to prioritize selecting **entire screen** or **browser tab**.
|
|
310
243
|
|
|
311
|
-
|
|
312
244
|
### How to detect when users stop screen sharing by clicking the browser's "Stop sharing" button?
|
|
313
245
|
|
|
314
246
|
Atomicx automatically listens for the browser's stop sharing event and updates the `screenStatus` state. You just need to listen for changes in `screenStatus`:
|
|
@@ -14,7 +14,7 @@ Virtual background feature allows users to replace their real background with a
|
|
|
14
14
|
|
|
15
15
|
## Prerequisites
|
|
16
16
|
|
|
17
|
-
- **User Status:** User has completed login authentication through useLoginState, refer to
|
|
17
|
+
- **User Status:** User has completed login authentication through useLoginState, refer to Integration Overview, and is in **logged in** state.
|
|
18
18
|
|
|
19
19
|
- **Environment Dependencies:** The project has imported `tuikit-atomicx-vue3`.
|
|
20
20
|
|
|
@@ -24,9 +24,9 @@ Virtual background feature allows users to replace their real background with a
|
|
|
24
24
|
|
|
25
25
|
- Publish the `node_modules/trtc-sdk-v5/assets` directory to CDN or static resource server, see [SDK Documentation](https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-36-advanced-virtual-background.html) for details.
|
|
26
26
|
|
|
27
|
-
- If choosing
|
|
27
|
+
- If choosing Solution 1: Quick Integration Using UI Components, when using the [VirtualBackgroundPanel](https://github.com/Tencent-RTC/TUIKit_Vue3/tree/main/packages/tuikit-atomicx-vue3/src/components/VirtualBackgroundPanel) component, you need to pass the `assetsPath` static resource address through props.
|
|
28
28
|
|
|
29
|
-
- If choosing
|
|
29
|
+
- If choosing Solution 2: Custom Integration Using Underlying API, when using the [initVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initVirtualBackground) interface, you need to pass the `assetsPath` static resource address.
|
|
30
30
|
|
|
31
31
|
## Implementing Virtual Background Feature
|
|
32
32
|
|
|
@@ -36,8 +36,6 @@ This feature provides two integration solutions, and you can choose the most sui
|
|
|
36
36
|
|
|
37
37
|
- **Solution 2 (Advanced):** Custom integration using underlying API. Implement UI and interaction logic based on atomicx-core SDK API [useVirtualBackgroundState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-VirtualBackgroundState) state hook with the highest flexibility.
|
|
38
38
|
|
|
39
|
-

|
|
40
|
-
|
|
41
39
|
Virtual Background
|
|
42
40
|
|
|
43
41
|
## Solution 1: Quick Integration Using UI Components
|
|
@@ -59,10 +57,10 @@ It is generally recommended to place [VirtualBackgroundPanel](https://github.com
|
|
|
59
57
|
**The following example demonstrates how to implement a complete interaction to open virtual background settings by clicking a button:**
|
|
60
58
|
|
|
61
59
|
> **Note:**
|
|
62
|
-
>
|
|
60
|
+
>
|
|
63
61
|
> - Publish the `node_modules/trtc-sdk-v5/assets` directory to CDN or static resource server, see [SDK Documentation](https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-36-advanced-virtual-background.html) for details.
|
|
64
62
|
> - When using the [VirtualBackgroundPanel](https://github.com/Tencent-RTC/TUIKit_Vue3/tree/main/packages/tuikit-atomicx-vue3/src/components/VirtualBackgroundPanel) component, pass the `assetsPath` static resource address through props.
|
|
65
|
-
> - All TUIKit components must be wrapped inside
|
|
63
|
+
> - All TUIKit components must be wrapped inside UIKitProvider, otherwise they will not be able to obtain context dependencies, resulting in style abnormalities.
|
|
66
64
|
|
|
67
65
|
```typescript
|
|
68
66
|
<template>
|
|
@@ -78,7 +76,7 @@ It is generally recommended to place [VirtualBackgroundPanel](https://github.com
|
|
|
78
76
|
<span>Virtual Background</span>
|
|
79
77
|
<button @click="showSettings = false">Close</button>
|
|
80
78
|
</div>
|
|
81
|
-
|
|
79
|
+
|
|
82
80
|
<div class="modal-body">
|
|
83
81
|
<!-- 3. Import panel component -->
|
|
84
82
|
<!-- @close event: triggered when user clicks close button inside panel (if any) -->
|
|
@@ -105,7 +103,7 @@ const openSettings = () => {
|
|
|
105
103
|
alert('Current browser does not support virtual background');
|
|
106
104
|
return;
|
|
107
105
|
}
|
|
108
|
-
|
|
106
|
+
|
|
109
107
|
// 2. Check if camera is available
|
|
110
108
|
if (cameraList.value.length === 0) {
|
|
111
109
|
alert('No camera detected, unable to set virtual background');
|
|
@@ -131,7 +129,7 @@ This section mainly introduces how to implement virtual background through atomi
|
|
|
131
129
|
Before calling the virtual background feature, you must first check if the browser supports it and initialize the resource path.
|
|
132
130
|
|
|
133
131
|
> **Note:**
|
|
134
|
-
>
|
|
132
|
+
>
|
|
135
133
|
> - Publish the node_modules/trtc-sdk-v5/assets directory to CDN or static resource server, see [SDK Documentation](https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-36-advanced-virtual-background.html) for details.
|
|
136
134
|
> - When using the [initVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#initVirtualBackground) interface, pass the assetsPath static resource address.
|
|
137
135
|
> - Virtual background feature depends on camera devices. You can use [useDeviceState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-DeviceState) to check device status.
|
|
@@ -165,10 +163,10 @@ onMounted(async () => {
|
|
|
165
163
|
Before the user confirms applying the background, a preview effect is usually required. Using the [setVirtualBackground](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#setVirtualBackground) method can set the preview effect, which will not be applied to the video stream visible to remote users.
|
|
166
164
|
|
|
167
165
|
> **Note:**
|
|
168
|
-
>
|
|
166
|
+
>
|
|
169
167
|
|
|
170
168
|
> Calling `setVirtualBackground` only takes effect in the local preview screen, remote users will not see the virtual background effect. You need to call `saveVirtualBackground` to synchronize it to the remote video stream.
|
|
171
|
-
>
|
|
169
|
+
>
|
|
172
170
|
|
|
173
171
|
```typescript
|
|
174
172
|
import { useVirtualBackgroundState } from 'tuikit-atomicx-vue3/room';
|
|
@@ -268,20 +266,6 @@ Tencent Cloud provides a sample project [atomicx-vite-vue3-ts](https://github.co
|
|
|
268
266
|
|
|
269
267
|
## API Documentation
|
|
270
268
|
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
<td rowspan="1" colSpan="1" >**Feature Description**</td>
|
|
276
|
-
|
|
277
|
-
<td rowspan="1" colSpan="1" >**API Documentation**</td>
|
|
278
|
-
</tr>
|
|
279
|
-
|
|
280
|
-
<tr>
|
|
281
|
-
<td rowspan="1" colSpan="1" >**useVirtualBackgroundState**</td>
|
|
282
|
-
|
|
283
|
-
<td rowspan="1" colSpan="1" >Virtual background management</td>
|
|
284
|
-
|
|
285
|
-
<td rowspan="1" colSpan="1" >[API Documentation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-VirtualBackgroundState)</td>
|
|
286
|
-
</tr>
|
|
287
|
-
</table>
|
|
269
|
+
| **State/Component** | **Feature Description** | **API Documentation** |
|
|
270
|
+
| --- | --- | --- |
|
|
271
|
+
| **useVirtualBackgroundState** | Virtual background management | [API Documentation](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-VirtualBackgroundState) |
|
|
@@ -1,25 +1,19 @@
|
|
|
1
1
|
TUIRoomKit is an audio/video room UI application launched by Tencent Cloud. This upgrade introduces a brand new atomic component integration solution, allowing developers to flexibly combine these atomic components to build personalized audio/video room interfaces.
|
|
2
2
|
|
|
3
3
|
> **Recommended: Use More Efficient AI Integration Assistant**
|
|
4
|
-
>
|
|
4
|
+
>
|
|
5
5
|
|
|
6
6
|
> We provide you with a brand new AI integration method. Simply describe your requirements to automatically generate integration code, greatly improving development efficiency.
|
|
7
|
-
>
|
|
7
|
+
>
|
|
8
8
|
|
|
9
9
|
> [Click here to experience AI integration immediately](https://cloud.tencent.com/document/product/647/127873)
|
|
10
|
-
>
|
|
11
|
-
|
|
10
|
+
>
|
|
12
11
|
|
|
13
12
|
This document describes how to integrate TUIRoomKit into existing Vue3 projects, and how to customize TUIRoomKit's styles, layouts, and functionality.
|
|
14
13
|
- Desktop Multi-person Conference
|
|
15
14
|
|
|
16
|
-

|
|
17
|
-
|
|
18
15
|
- H5 Multi-person Conference
|
|
19
16
|
|
|
20
|
-

|
|
21
|
-
|
|
22
|
-
|
|
23
17
|
## Prerequisites
|
|
24
18
|
|
|
25
19
|
### Service Activation
|
|
@@ -29,7 +23,6 @@ Please refer to [Service Activation](https://cloud.tencent.com/document/product/
|
|
|
29
23
|
|
|
30
24
|
- **SDKSecretKey**: Application secret key, used for key information in initialization configuration files.
|
|
31
25
|
|
|
32
|
-
|
|
33
26
|
### Environment Preparation
|
|
34
27
|
- **Node.js**: ≥ 18.19.1 (Recommended to use official LTS version).
|
|
35
28
|
|
|
@@ -39,28 +32,22 @@ Please refer to [Service Activation](https://cloud.tencent.com/document/product/
|
|
|
39
32
|
|
|
40
33
|
- **Devices**: Camera, microphone, speakers.
|
|
41
34
|
|
|
42
|
-
|
|
43
35
|
## Source Code Integration
|
|
44
36
|
|
|
45
37
|
### Step 1: Install Project Dependencies
|
|
46
38
|
|
|
47
39
|
Install the following dependencies in your business project.
|
|
48
40
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
41
|
【npm】
|
|
53
42
|
``` bash
|
|
54
|
-
npm install @tencentcloud/roomkit-web-vue3@latest tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/universal-api
|
|
43
|
+
npm install @tencentcloud/roomkit-web-vue3@latest tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/universal-api
|
|
55
44
|
```
|
|
56
45
|
|
|
57
|
-
|
|
58
46
|
【pnpm】
|
|
59
47
|
``` bash
|
|
60
48
|
pnpm install @tencentcloud/roomkit-web-vue3@latest tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/universal-api
|
|
61
49
|
```
|
|
62
50
|
|
|
63
|
-
|
|
64
51
|
【yarn】
|
|
65
52
|
``` bash
|
|
66
53
|
yarn add @tencentcloud/roomkit-web-vue3@latest tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3 @tencentcloud/universal-api
|
|
@@ -96,12 +83,12 @@ Merge the following content into your project's App.vue file to configure global
|
|
|
96
83
|
<!-- Your business component containing ConferenceMainView -->
|
|
97
84
|
</UIKitProvider>
|
|
98
85
|
</template>
|
|
99
|
-
|
|
86
|
+
|
|
100
87
|
<script setup>
|
|
101
88
|
import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
|
|
102
89
|
import { onMounted } from 'vue';
|
|
103
90
|
import { useLoginState } from 'tuikit-atomicx-vue3/room';
|
|
104
|
-
|
|
91
|
+
|
|
105
92
|
// step 2: User login
|
|
106
93
|
const { login, setSelfInfo } = useLoginState();
|
|
107
94
|
const SDKAppID = 0; // Note: Please replace with SDKAppID obtained from TRTC Console
|
|
@@ -124,14 +111,14 @@ Merge the following content into your project's App.vue file to configure global
|
|
|
124
111
|
}
|
|
125
112
|
});
|
|
126
113
|
</script>
|
|
127
|
-
|
|
114
|
+
|
|
128
115
|
<!-- Step 3: Configure global styles (These styles override default styles of scaffolded new projects, configure as needed)-->
|
|
129
116
|
<style>
|
|
130
117
|
html, body {
|
|
131
118
|
padding: 0 !important;
|
|
132
119
|
margin: 0 !important;
|
|
133
120
|
}
|
|
134
|
-
|
|
121
|
+
|
|
135
122
|
#app {
|
|
136
123
|
width: 100% !important;
|
|
137
124
|
height: 100% !important;
|
|
@@ -147,17 +134,17 @@ Merge the following content into your project's App.vue file to configure global
|
|
|
147
134
|
|
|
148
135
|
### Step 4: Start New Conference
|
|
149
136
|
|
|
150
|
-
Conference hosts can start a new conference by calling the `conference.start` interface. Other participants can refer to the description in
|
|
137
|
+
Conference hosts can start a new conference by calling the `conference.start` interface. Other participants can refer to the description in Step 6 and call the `conference.join` interface to join the conference.
|
|
151
138
|
|
|
152
139
|
> **Note:**
|
|
153
|
-
>
|
|
140
|
+
>
|
|
154
141
|
|
|
155
142
|
> Please refer to Step 3 and call the `conference.start` interface to start a conference after successful user login.
|
|
156
|
-
>
|
|
143
|
+
>
|
|
157
144
|
|
|
158
145
|
``` typescript
|
|
159
146
|
import { conference } from '@tencentcloud/roomkit-web-vue3';
|
|
160
|
-
const startConference = async () => {
|
|
147
|
+
const startConference = async () => {
|
|
161
148
|
await conference.start({
|
|
162
149
|
roomId: '123456', // Please replace with your real roomId
|
|
163
150
|
options: {
|
|
@@ -170,13 +157,13 @@ startConference();
|
|
|
170
157
|
|
|
171
158
|
### Step 5: Join Existing Conference
|
|
172
159
|
|
|
173
|
-
Participants can join a conference started by the conference host in
|
|
160
|
+
Participants can join a conference started by the conference host in Step 4 by calling the `conference.join` interface and filling in the corresponding roomId parameter.
|
|
174
161
|
|
|
175
162
|
> **Note:**
|
|
176
|
-
>
|
|
163
|
+
>
|
|
177
164
|
|
|
178
165
|
> Please refer to Step 3 and call the `conference.join` interface to join a conference after successful user login.
|
|
179
|
-
>
|
|
166
|
+
>
|
|
180
167
|
|
|
181
168
|
``` typescript
|
|
182
169
|
import { conference } from '@tencentcloud/roomkit-web-vue3';
|
|
@@ -190,21 +177,16 @@ joinConference();
|
|
|
190
177
|
|
|
191
178
|
## Start Project
|
|
192
179
|
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
180
|
【npm】
|
|
197
181
|
``` bash
|
|
198
182
|
npm run dev
|
|
199
183
|
```
|
|
200
184
|
|
|
201
|
-
|
|
202
185
|
【pnpm】
|
|
203
186
|
``` bash
|
|
204
187
|
pnpm run dev
|
|
205
188
|
```
|
|
206
189
|
|
|
207
|
-
|
|
208
190
|
【yarn】
|
|
209
191
|
``` bash
|
|
210
192
|
yarn run dev
|
|
@@ -212,45 +194,21 @@ yarn run dev
|
|
|
212
194
|
|
|
213
195
|
After successful startup, please open the debug address (usually http://localhost:5173) in your browser to access the application. You will see the conference interface as shown below:
|
|
214
196
|
|
|
215
|
-

|
|
216
|
-
|
|
217
|
-
|
|
218
197
|
## Quick UI Customization
|
|
219
198
|
|
|
220
199
|
### Theme and Language
|
|
221
200
|
|
|
222
201
|
Modify the default values of theme and language by configuring the parameters of `UIKitProvider` in App.vue.
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
<td rowspan="1" colSpan="1" >Available Values</td>
|
|
228
|
-
|
|
229
|
-
<td rowspan="1" colSpan="1" >Default Value</td>
|
|
230
|
-
</tr>
|
|
231
|
-
|
|
232
|
-
<tr>
|
|
233
|
-
<td rowspan="1" colSpan="1" >theme</td>
|
|
234
|
-
|
|
235
|
-
<td rowspan="1" colSpan="1" >"light" \| "dark"</td>
|
|
236
|
-
|
|
237
|
-
<td rowspan="1" colSpan="1" >"light"</td>
|
|
238
|
-
</tr>
|
|
239
|
-
|
|
240
|
-
<tr>
|
|
241
|
-
<td rowspan="1" colSpan="1" >language</td>
|
|
242
|
-
|
|
243
|
-
<td rowspan="1" colSpan="1" >"zh-CN" \| "en-US"</td>
|
|
244
|
-
|
|
245
|
-
<td rowspan="1" colSpan="1" >"en-US"</td>
|
|
246
|
-
</tr>
|
|
247
|
-
</table>
|
|
202
|
+
| UIKitProvider Parameter | Available Values | Default Value |
|
|
203
|
+
| --- | --- | --- |
|
|
204
|
+
| theme | "light" \\| "dark" | "light" |
|
|
205
|
+
| language | "zh-CN" \\| "en-US" | "en-US" |
|
|
248
206
|
|
|
249
207
|
``` typescript
|
|
250
208
|
<UIKitProvider theme="light" language="en-US">
|
|
251
209
|
<router-view />
|
|
252
210
|
</UIKitProvider>
|
|
253
|
-
|
|
211
|
+
|
|
254
212
|
<script setup lang="ts">
|
|
255
213
|
import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
|
|
256
214
|
```
|
|
@@ -263,15 +221,10 @@ Step 1: Use [Account Management > Import Multiple Accounts](https://cloud.tencen
|
|
|
263
221
|
|
|
264
222
|
Step 2: Use [Friend Management > Import Friends](https://cloud.tencent.com/document/product/269/8301) REST API interface to batch import user relationship chains;
|
|
265
223
|
|
|
266
|
-

|
|
267
|
-
|
|
268
|
-
|
|
269
224
|
## TUIRoomKit Interface Customization
|
|
270
225
|
|
|
271
226
|
### Source Code Export
|
|
272
227
|
|
|
273
|
-
|
|
274
|
-
|
|
275
228
|
【Vue3】
|
|
276
229
|
1. Execute source code export script, default copy path is `./src/components/RoomKit`
|
|
277
230
|
|
|
@@ -280,9 +233,6 @@ Step 2: Use [Friend Management > Import Friends](https://cloud.tencent.com/docum
|
|
|
280
233
|
```
|
|
281
234
|
2. Confirm according to script prompt whether to copy TUIRoomKit source code to `./src/components/RoomKit` directory. If you need to customize the copy directory, please enter 'y', otherwise enter 'n'.
|
|
282
235
|
|
|
283
|
-
|
|
284
|
-

|
|
285
|
-
|
|
286
236
|
3. After source code export, TUIRoomKit source code will be added to your specified project path. At this time, you need to manually change the references of ConferenceMainView component, ConferenceMainViewH5 component and conference object from npm package address to the relative path address of TUIRoom source code.
|
|
287
237
|
|
|
288
238
|
``` typescript
|
|
@@ -292,7 +242,6 @@ Step 2: Use [Friend Management > Import Friends](https://cloud.tencent.com/docum
|
|
|
292
242
|
```
|
|
293
243
|
4. Configure ESLint Validation
|
|
294
244
|
|
|
295
|
-
|
|
296
245
|
If you encounter ESLint errors when running the project after exporting TUIRoomKit source code, you can add the RoomKit folder to the `.eslintignore` file to ignore ESLint detection.
|
|
297
246
|
``` javascript
|
|
298
247
|
// Please replace with the real path of TUIRoomKit source code
|
|
@@ -322,9 +271,6 @@ function handleLayoutUpdate(layout: RoomLayoutTemplate) {
|
|
|
322
271
|
|
|
323
272
|
TUIRoomKit default video stream widgets are shown in the figure. To customize video stream widgets, please modify the `RoomKit/components/RoomLayoutView/ParticipantViewUI/ParticipantViewUI.vue` component.
|
|
324
273
|
|
|
325
|
-

|
|
326
|
-
|
|
327
|
-
|
|
328
274
|
## Frequently Asked Questions
|
|
329
275
|
|
|
330
276
|
#### **TUIRoomKit works normally during local development, but cannot properly capture user's camera or microphone devices after deployment to online environment?**
|
|
@@ -334,10 +280,9 @@ TUIRoomKit default video stream widgets are shown in the figure. To customize vi
|
|
|
334
280
|
|
|
335
281
|
- **Related Resources:** For more details about URL domain and protocol restrictions, please refer to [URL Domain and Protocol Restrictions](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).
|
|
336
282
|
|
|
337
|
-
|
|
338
283
|
#### **Does TUIRoomKit support iframe integration?**
|
|
339
284
|
|
|
340
|
-
Yes. When integrating TUIRoomKit using iframe, you need to configure the allow attribute in the iframe tag to grant necessary browser permissions (microphone, camera, screen sharing, fullscreen, etc.), as shown in the example below:
|
|
285
|
+
Yes. When integrating TUIRoomKit using iframe, you need to configure the allow attribute in the iframe tag to grant necessary browser permissions (microphone, camera, screen sharing, fullscreen, etc.), as shown in the example below:
|
|
341
286
|
``` typescript
|
|
342
287
|
// Enable microphone, camera, screen sharing, fullscreen permissions
|
|
343
288
|
<iframe allow="microphone; camera; display-capture; display; fullscreen;">
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|