@tencentcloud/sdk-mcp 1.4.7 → 1.6.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.js +0 -1
- package/knowledge/bm25-cache.js +73 -0
- package/knowledge/bm25.js +147 -0
- package/knowledge/build-index.js +65 -0
- package/knowledge/chunker.js +167 -0
- package/knowledge/content-loader.js +44 -0
- package/knowledge/extractors.js +25 -0
- package/knowledge/path-meta.js +175 -0
- package/knowledge/search/exact-lookup.js +330 -0
- package/knowledge/search/filter-pool.js +86 -0
- package/knowledge/search/requires-framework.js +72 -0
- package/knowledge/search/search-knowledge.js +226 -0
- package/package.json +9 -9
- package/resource/_schema/feature-aliases.yaml +10 -0
- package/resource/_schema/goal-tags.yaml +72 -0
- package/resource/_schema/products.yaml +16 -0
- package/resource/_schema/trtc-intents.yaml +27 -0
- package/resource/_schema/types.yaml +44 -0
- package/resource/index/component-slugs.json +1 -0
- package/resource/index/manifest.json +1 -0
- package/resource/{doc → integration}/callkit/preset/android/integration.md +32 -28
- package/resource/{doc → integration}/callkit/preset/flutter/integration.md +109 -54
- package/resource/integration/callkit/preset/ios/integration.md +411 -0
- package/resource/integration/callkit/preset/react/integration.md +499 -0
- package/resource/integration/callkit/preset/vue/integration.md +768 -0
- package/resource/{doc/chatkit → integration/chat/preset}/android/integration.md +11 -11
- package/resource/{doc/chatkit → integration/chat/preset}/flutter/integration.md +59 -37
- package/resource/integration/chat/preset/ios/integration.md +568 -0
- package/resource/{doc/chatkit → integration/chat/preset}/react/integration.md +127 -95
- package/resource/integration/chat/preset/uni-app/integration.md +494 -0
- package/resource/{doc/chatkit → integration/chat/preset}/vue/integration.md +163 -143
- package/resource/{doc → integration}/livekit/preset/live/vue/live-list-integration.md +15 -15
- package/resource/{doc → integration}/livekit/preset/live/vue/live-player-desk-integration.md +25 -13
- package/resource/{doc → integration}/livekit/preset/live/vue/live-player-h5-integration.md +15 -9
- package/resource/{doc → integration}/livekit/preset/live/vue/live-pusher-integration.md +31 -26
- package/resource/integration/roomkit/preset/vue/integration.md +571 -0
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +852 -0
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +929 -0
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +364 -0
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +1150 -0
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +1216 -0
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +412 -0
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1191 -0
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +1292 -0
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +537 -0
- package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +953 -0
- package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +1061 -0
- package/resource/knowledge/callkit/faq/android.md +168 -0
- package/resource/knowledge/callkit/faq/common.md +180 -0
- package/resource/knowledge/callkit/faq/flutter.md +52 -0
- package/resource/knowledge/callkit/faq/ios.md +116 -0
- package/resource/knowledge/callkit/faq/uniapp-app.md +89 -0
- package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +217 -0
- package/resource/knowledge/callkit/faq/web.md +363 -0
- package/resource/knowledge/callkit/preset/android/api.md +413 -0
- package/resource/knowledge/callkit/preset/flutter/api.md +22 -0
- package/resource/knowledge/callkit/preset/ios/api.md +256 -0
- package/resource/knowledge/callkit/preset/web/api.md +79 -0
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +72 -0
- package/resource/knowledge/chat/preset/android/features/contact-list.md +41 -0
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +123 -0
- package/resource/knowledge/chat/preset/android/features/language.md +142 -0
- package/resource/knowledge/chat/preset/android/features/message-input.md +57 -0
- package/resource/knowledge/chat/preset/android/features/message-list.md +142 -0
- package/resource/knowledge/chat/preset/android/features/search.md +64 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/android/features/theme.md +21 -18
- package/resource/knowledge/chat/preset/android-view/integration.md +448 -0
- package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +62 -0
- package/resource/knowledge/chat/preset/flutter/features/contact-list.md +40 -0
- package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +129 -0
- package/resource/knowledge/chat/preset/flutter/features/language.md +104 -0
- package/resource/knowledge/chat/preset/flutter/features/message-input.md +54 -0
- package/resource/knowledge/chat/preset/flutter/features/message-list.md +163 -0
- package/resource/knowledge/chat/preset/flutter/features/search.md +59 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/flutter/features/theme.md +47 -19
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +92 -0
- package/resource/knowledge/chat/preset/ios/features/contact-list.md +119 -0
- package/resource/knowledge/chat/preset/ios/features/conversation-list.md +134 -0
- package/resource/knowledge/chat/preset/ios/features/language.md +105 -0
- package/resource/knowledge/chat/preset/ios/features/message-input.md +69 -0
- package/resource/knowledge/chat/preset/ios/features/message-list.md +164 -0
- package/resource/knowledge/chat/preset/ios/features/search.md +94 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/ios/features/theme.md +54 -51
- package/resource/{doc/chatkit/ios → knowledge/chat/preset/ios-uikit}/integration.md +157 -94
- package/resource/knowledge/chat/preset/react/features/chat-setting.md +123 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/contact-list.md +256 -104
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +217 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/conversation-list.md +86 -79
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +99 -0
- package/resource/knowledge/chat/preset/react/features/conversation-search.md +58 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-input.md +30 -83
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-list.md +22 -25
- package/resource/knowledge/chat/preset/react/features/search.md +531 -0
- package/resource/knowledge/chat/preset/react/features/theme.md +16 -0
- package/resource/knowledge/chat/preset/vue/features/chat-header.md +331 -0
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/chat-setting.md +0 -4
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/contact-list.md +59 -53
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-actions.md +49 -43
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-list.md +61 -49
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-preview.md +43 -40
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-search.md +1 -1
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-input.md +128 -105
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-list.md +108 -195
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/search.md +74 -68
- package/resource/knowledge/chat/preset/vue/features/theme.md +136 -0
- package/resource/knowledge/chat/urls/error-code.md +16 -0
- package/resource/knowledge/chat/urls/product.md +61 -0
- package/resource/knowledge/chat/urls/restapi.md +226 -0
- package/resource/knowledge/chat/urls/sdk/android.md +84 -0
- package/resource/knowledge/chat/urls/sdk/flutter.md +73 -0
- package/resource/knowledge/chat/urls/sdk/ios.md +84 -0
- package/resource/knowledge/chat/urls/sdk/web.md +88 -0
- package/resource/knowledge/chat/urls/webhook.md +73 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/AudioEffectStore.md +79 -76
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +174 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +329 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/CameraView.md +7 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +434 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +362 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +466 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +173 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/LikeStore.md +12 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +291 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +78 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +439 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +221 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/AudioEffectStore.md +79 -76
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +212 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/BaseBeautyStore.md +43 -45
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +312 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +404 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +334 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +420 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +166 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LikeStore.md +12 -11
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +281 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LiveCoreView.md +49 -42
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +397 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +183 -0
- package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/AudioEffectStore.md +79 -75
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +192 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +146 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +309 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +370 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +339 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +503 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +188 -0
- package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/LikeStore.md +12 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +289 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +78 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +434 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +187 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/web/index.md +780 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audience-list.md +59 -51
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audio-effect.md +37 -34
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-barrage.md +68 -38
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-base-beauty.md +18 -15
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-co-guest-interaction.md +17 -17
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-gift.md +86 -80
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-host-interaction.md +53 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-integration.md +47 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-live-list.md +26 -22
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audience-list.md +16 -13
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-barrage.md +33 -21
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-base-beauty.md +29 -25
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-co-guest-interaction.md +21 -20
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-gift.md +78 -69
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-host-interaction.md +47 -43
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-integration.md +48 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-live-list.md +27 -23
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audience-list.md +15 -12
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audio-effect.md +39 -36
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-barrage.md +42 -29
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-base-beauty.md +19 -16
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-co-guest-interaction.md +20 -19
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-gift.md +55 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-host-interaction.md +50 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-integration.md +48 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-live-list.md +26 -22
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audience-list.md +59 -51
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audio-effect.md +41 -38
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-barrage.md +67 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +53 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-gift.md +86 -80
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-host-interaction.md +45 -40
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-integration.md +43 -42
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-room-list.md +523 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audience-list.md +16 -13
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audio-effect.md +54 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-barrage.md +33 -21
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +34 -28
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-gift.md +73 -64
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-integration.md +46 -43
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-room-list.md +165 -148
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audience-list.md +19 -16
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audio-effect.md +40 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-barrage.md +41 -28
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +54 -47
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-gift.md +52 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-host-interaction.md +55 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-integration.md +47 -45
- package/resource/knowledge/livekit/core-sdk/voice/ios/voice-room-list.md +404 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audience-list.md +40 -57
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audio-effect.md +38 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-barrage.md +53 -53
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-co-guest-interaction.md +106 -116
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-gift.md +49 -59
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-integration.md +52 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-room-list.md +38 -46
- package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +915 -0
- package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +179 -0
- package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +419 -0
- package/resource/knowledge/push/config/android/fcm.md +133 -0
- package/resource/knowledge/push/config/android/honor.md +111 -0
- package/resource/knowledge/push/config/android/huawei.md +106 -0
- package/resource/knowledge/push/config/android/meizu.md +121 -0
- package/resource/knowledge/push/config/android/oppo.md +108 -0
- package/resource/knowledge/push/config/android/vivo.md +101 -0
- package/resource/knowledge/push/config/android/xiaomi.md +99 -0
- package/resource/knowledge/push/integration/android.md +1028 -0
- package/resource/knowledge/push/integration/donut.md +271 -0
- package/resource/knowledge/push/integration/flutter.md +363 -0
- package/resource/knowledge/push/integration/harmonyos.md +72 -0
- package/resource/knowledge/push/integration/ios.md +705 -0
- package/resource/knowledge/push/integration/react-native.md +337 -0
- package/resource/knowledge/push/integration/uni-app.md +461 -0
- package/resource/knowledge/push/integration/unity.md +357 -0
- package/resource/knowledge/push/integration/unreal-engine.md +353 -0
- package/resource/knowledge/push/overview/prepare.md +30 -0
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/call-user-to-room.md +22 -20
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-participant-state.md +22 -193
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-state.md +33 -32
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/schedule-room.md +30 -29
- package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +230 -0
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-participant-state.md +22 -21
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-state.md +29 -28
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/schedule-room.md +17 -16
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/call-user-to-room.md +22 -20
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-participant-state.md +49 -218
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-state.md +37 -37
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/schedule-room.md +28 -28
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/call-user-to-room.md +122 -7
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/device-detection.md +318 -3
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +1504 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/free-beauty-panel.md +4 -3
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +709 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +1105 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +635 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +529 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/schedule-room.md +256 -13
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/screen-share.md +218 -25
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/virtual-background.md +4 -3
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/android/integration.md +50 -64
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/flutter/integration.md +34 -31
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/ios/integration.md +45 -53
- package/resource/knowledge/roomkit/preset/react/integration.md +571 -0
- package/resource/{doc → knowledge}/rtcengine/web/how_to_run_web_sdk_demo.md +31 -15
- package/resource/{doc → knowledge}/rtcengine/web/plugin/21-advanced-auto-play-policy.md +9 -3
- package/resource/{doc → knowledge}/rtcengine/web/plugin/22-advanced-audio-mixer.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/23-advanced-support-detection.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/24-advanced-network-quality.md +6 -6
- package/resource/{doc → knowledge}/rtcengine/web/plugin/25-advanced-device-change.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -4
- package/resource/{doc → knowledge}/rtcengine/web/plugin/27-advanced-small-stream.md +4 -4
- package/resource/{doc → knowledge}/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
- package/resource/{doc → knowledge}/trtc/android/TRTCCloud.md +547 -495
- package/resource/{doc → knowledge}/trtc/android/TRTCCloudDef.md +434 -403
- package/resource/{doc → knowledge}/trtc/android/TRTCCloudListener.md +394 -348
- package/resource/{doc → knowledge}/trtc/android/TRTCStatistics.md +17 -15
- package/resource/{doc → knowledge}/trtc/android/TXAudioEffectManager.md +227 -197
- package/resource/knowledge/trtc/android/TXBeautyManager.md +415 -0
- package/resource/{doc → knowledge}/trtc/android/TXDeviceManager.md +70 -63
- package/resource/{doc → knowledge}/trtc/android/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCCloud.md +599 -544
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCStatistics.md +17 -15
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +502 -0
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +403 -0
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCCloudCallback.md +439 -387
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCTypeDef.md +417 -387
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloud.md +619 -559
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloudDelegate.md +409 -360
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCStatistics.md +17 -15
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXAudioEffectManager.md +187 -164
- package/resource/knowledge/trtc/ios/TXBeautyManager.md +416 -0
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +399 -0
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiveSDKTypeDef.md +422 -396
- package/server-config.js +0 -1
- package/server.js +22 -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
package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/screen-share.md
RENAMED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
|
|
8
8
|
- 若在 `iframe` 中集成,需在标签中声明权限。
|
|
9
9
|
|
|
10
|
-
```
|
|
10
|
+
``` java
|
|
11
11
|
<iframe allow="display-capture; fullscreen;"></iframe>
|
|
12
12
|
```
|
|
13
13
|
|
|
@@ -17,6 +17,7 @@
|
|
|
17
17
|
|
|
18
18
|
使用 [startScreenShare](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startScreenShare) 方法开始屏幕分享。在 Web 环境下,您将看到浏览器的屏幕选择器,可以选择分享整个屏幕、应用窗口或浏览器标签页。
|
|
19
19
|
|
|
20
|
+
【Vue3】
|
|
20
21
|
``` typescript
|
|
21
22
|
import { useDeviceState } from 'tuikit-atomicx-vue3/room';
|
|
22
23
|
const { startScreenShare } = useDeviceState();
|
|
@@ -32,10 +33,27 @@ const handleStartShare = async () => {
|
|
|
32
33
|
};
|
|
33
34
|
```
|
|
34
35
|
|
|
36
|
+
【React】
|
|
37
|
+
``` typescript
|
|
38
|
+
import { useDeviceState } from 'tuikit-atomicx-react/room';
|
|
39
|
+
const { startScreenShare } = useDeviceState();
|
|
40
|
+
|
|
41
|
+
// 尝试开始屏幕分享,并尝试分享系统音频
|
|
42
|
+
const handleStartShare = async () => {
|
|
43
|
+
try {
|
|
44
|
+
await startScreenShare({ screenAudio: true });
|
|
45
|
+
} catch (error) {
|
|
46
|
+
// 处理用户拒绝或浏览器不支持等错误
|
|
47
|
+
console.error('开始屏幕分享失败:', error);
|
|
48
|
+
}
|
|
49
|
+
};
|
|
50
|
+
```
|
|
51
|
+
|
|
35
52
|
### 步骤2:分享系统音频
|
|
36
53
|
|
|
37
54
|
通过设置 `screenAudio: true` 参数,可以在屏幕分享时同时分享系统音频。这在分享视频、演示、音乐等包含音频内容时非常有用。
|
|
38
55
|
|
|
56
|
+
【Vue3】
|
|
39
57
|
``` typescript
|
|
40
58
|
import { useDeviceState } from 'tuikit-atomicx-vue3/room';
|
|
41
59
|
const { startScreenShare } = useDeviceState();
|
|
@@ -51,13 +69,30 @@ const handleStartScreenShareWithAudio = async () => {
|
|
|
51
69
|
};
|
|
52
70
|
```
|
|
53
71
|
|
|
72
|
+
【React】
|
|
73
|
+
``` typescript
|
|
74
|
+
import { useDeviceState } from 'tuikit-atomicx-react/room';
|
|
75
|
+
const { startScreenShare } = useDeviceState();
|
|
76
|
+
|
|
77
|
+
// 开始屏幕分享并分享系统音频
|
|
78
|
+
const handleStartScreenShareWithAudio = async () => {
|
|
79
|
+
try {
|
|
80
|
+
await startScreenShare({ screenAudio: true });
|
|
81
|
+
console.log('屏幕分享(含音频)已开始');
|
|
82
|
+
} catch (error) {
|
|
83
|
+
console.error('开始屏幕分享失败:', error);
|
|
84
|
+
}
|
|
85
|
+
};
|
|
86
|
+
```
|
|
87
|
+
|
|
54
88
|
**浏览器兼容性说明:**
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
|
59
|
-
|
|
|
60
|
-
|
|
|
89
|
+
|
|
90
|
+
|浏览器|系统音频分享支持|备注|
|
|
91
|
+
|---------|---------|---------|
|
|
92
|
+
|Chrome 74+|支持|需要在选择器中勾选**分享音频**|
|
|
93
|
+
|Edge 79+|支持|基于 Chromium,体验同 Chrome|
|
|
94
|
+
|Firefox|不支持|暂不支持系统音频分享|
|
|
95
|
+
|Safari|不支持|暂不支持系统音频分享|
|
|
61
96
|
|
|
62
97
|
> **注意:**
|
|
63
98
|
>
|
|
@@ -70,20 +105,38 @@ const handleStartScreenShareWithAudio = async () => {
|
|
|
70
105
|
用户可以通过以下几种方式停止屏幕分享:
|
|
71
106
|
1. **调用 **[**stopScreenShare()**](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopScreenShare)** 接口**
|
|
72
107
|
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
108
|
+
【Vue3】
|
|
109
|
+
``` typescript
|
|
110
|
+
import { useDeviceState, DeviceStatus } from 'tuikit-atomicx-vue3/room';
|
|
111
|
+
const { screenStatus, stopScreenShare } = useDeviceState();
|
|
112
|
+
|
|
113
|
+
// 停止屏幕分享
|
|
114
|
+
const handleStopScreenShare = async () => {
|
|
115
|
+
try {
|
|
116
|
+
await stopScreenShare();
|
|
117
|
+
console.log('屏幕分享已停止');
|
|
118
|
+
} catch (error) {
|
|
119
|
+
console.error('停止屏幕分享失败:', error);
|
|
120
|
+
}
|
|
121
|
+
};
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
【React】
|
|
125
|
+
``` typescript
|
|
126
|
+
import { useDeviceState, DeviceStatus } from 'tuikit-atomicx-react/room';
|
|
127
|
+
const { screenStatus, stopScreenShare } = useDeviceState();
|
|
128
|
+
|
|
129
|
+
// 停止屏幕分享
|
|
130
|
+
const handleStopScreenShare = async () => {
|
|
131
|
+
try {
|
|
132
|
+
await stopScreenShare();
|
|
133
|
+
console.log('屏幕分享已停止');
|
|
134
|
+
} catch (error) {
|
|
135
|
+
console.error('停止屏幕分享失败:', error);
|
|
136
|
+
}
|
|
137
|
+
};
|
|
138
|
+
```
|
|
139
|
+
|
|
87
140
|
2. **点击浏览器原生的"停止分享"按钮**
|
|
88
141
|
|
|
89
142
|
3. **关闭被分享的窗口或标签页**
|
|
@@ -99,6 +152,8 @@ const handleStartScreenShareWithAudio = async () => {
|
|
|
99
152
|
#### **设置屏幕分享权限**
|
|
100
153
|
|
|
101
154
|
您可以通过 [useRoomParticipantState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-RoomParticipantState) 提供的成员管理接口控制房间内的屏幕管理权限。
|
|
155
|
+
|
|
156
|
+
【Vue3】
|
|
102
157
|
``` typescript
|
|
103
158
|
import { useRoomParticipantState, DeviceType } from 'tuikit-atomicx-vue3/room';
|
|
104
159
|
const { disableAllDevices } = useRoomParticipantState();
|
|
@@ -120,9 +175,33 @@ async function handleEnableAllScreen() {
|
|
|
120
175
|
}
|
|
121
176
|
```
|
|
122
177
|
|
|
178
|
+
【React】
|
|
179
|
+
``` typescript
|
|
180
|
+
import { useRoomParticipantState, DeviceType } from 'tuikit-atomicx-react/room';
|
|
181
|
+
const { disableAllDevices } = useRoomParticipantState();
|
|
182
|
+
|
|
183
|
+
// 限制仅房主/管理员可以发起屏幕分享
|
|
184
|
+
async function handleDisableAllScreen() {
|
|
185
|
+
await disableAllDevices({
|
|
186
|
+
deviceType: DeviceType.Screen,
|
|
187
|
+
disable: true,
|
|
188
|
+
});
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
// 允许房间内所有用户发起屏幕分享
|
|
192
|
+
async function handleEnableAllScreen() {
|
|
193
|
+
await disableAllDevices({
|
|
194
|
+
deviceType: DeviceType.Screen,
|
|
195
|
+
disable: false,
|
|
196
|
+
});
|
|
197
|
+
}
|
|
198
|
+
```
|
|
199
|
+
|
|
123
200
|
#### **自动布局切换**
|
|
124
201
|
|
|
125
202
|
当检测到房间中有用户开始屏幕分享时,建议切换到侧边栏布局(`RoomLayoutTemplate.SidebarLayout`),将分享画面放大显示,其他参会者画面显示在侧边栏。
|
|
203
|
+
|
|
204
|
+
【Vue3】
|
|
126
205
|
``` typescript
|
|
127
206
|
<template>
|
|
128
207
|
<div class="room-container">
|
|
@@ -161,9 +240,48 @@ watch(participantWithScreen, (participant) => {
|
|
|
161
240
|
</script>
|
|
162
241
|
```
|
|
163
242
|
|
|
243
|
+
【React】
|
|
244
|
+
``` typescript
|
|
245
|
+
import { useState, useEffect } from 'react';
|
|
246
|
+
import {
|
|
247
|
+
RoomView,
|
|
248
|
+
RoomLayoutTemplate,
|
|
249
|
+
useRoomParticipantState
|
|
250
|
+
} from 'tuikit-atomicx-react/room';
|
|
251
|
+
|
|
252
|
+
const RoomComponent = () => {
|
|
253
|
+
const [layoutTemplate, setLayoutTemplate] = useState(RoomLayoutTemplate.GridLayout);
|
|
254
|
+
const { participantWithScreen } = useRoomParticipantState();
|
|
255
|
+
|
|
256
|
+
// 监听屏幕分享状态,自动切换布局
|
|
257
|
+
useEffect(() => {
|
|
258
|
+
if (participantWithScreen) {
|
|
259
|
+
// 有人分享屏幕,切换到侧边栏布局
|
|
260
|
+
setLayoutTemplate(RoomLayoutTemplate.SidebarLayout);
|
|
261
|
+
} else {
|
|
262
|
+
// 没有人分享屏幕,切换回网格布局
|
|
263
|
+
setLayoutTemplate(RoomLayoutTemplate.GridLayout);
|
|
264
|
+
}
|
|
265
|
+
}, [participantWithScreen]);
|
|
266
|
+
|
|
267
|
+
return (
|
|
268
|
+
<div className="room-container">
|
|
269
|
+
<RoomView
|
|
270
|
+
layoutTemplate={layoutTemplate}
|
|
271
|
+
participantViewUI={({ participant, streamType }) => (
|
|
272
|
+
<ParticipantViewUI participant={participant} streamType={streamType} />
|
|
273
|
+
)}
|
|
274
|
+
/>
|
|
275
|
+
</div>
|
|
276
|
+
);
|
|
277
|
+
};
|
|
278
|
+
```
|
|
279
|
+
|
|
164
280
|
#### **限制仅一人屏幕分享**
|
|
165
281
|
|
|
166
282
|
在房间中应该只允许一个人分享屏幕,当有人正在分享时,禁用其他人的分享按钮:
|
|
283
|
+
|
|
284
|
+
【Vue3】
|
|
167
285
|
``` typescript
|
|
168
286
|
<script setup>
|
|
169
287
|
import { computed } from 'vue';
|
|
@@ -190,11 +308,35 @@ const canStartScreenShare = computed(() => {
|
|
|
190
308
|
<template>
|
|
191
309
|
```
|
|
192
310
|
|
|
311
|
+
【React】
|
|
312
|
+
``` typescript
|
|
313
|
+
import { useRoomParticipantState } from 'tuikit-atomicx-react/room';
|
|
314
|
+
|
|
315
|
+
const { participantWithScreen, localParticipant } = useRoomParticipantState();
|
|
316
|
+
|
|
317
|
+
const isOtherSharing = (() => {
|
|
318
|
+
const sharer = participantWithScreen;
|
|
319
|
+
if (!sharer) return false;
|
|
320
|
+
return sharer.userId !== localParticipant?.userId;
|
|
321
|
+
})();
|
|
322
|
+
|
|
323
|
+
const canStartScreenShare = !isOtherSharing;
|
|
324
|
+
|
|
325
|
+
// 在 JSX 中使用
|
|
326
|
+
return (
|
|
327
|
+
<button disabled={!canStartScreenShare} onClick={handleStartShare}>
|
|
328
|
+
开始屏幕分享
|
|
329
|
+
</button>
|
|
330
|
+
);
|
|
331
|
+
```
|
|
332
|
+
|
|
193
333
|
### 步骤5:处理屏幕分享错误
|
|
194
334
|
|
|
195
335
|
当屏幕分享发生错误时,根据错误信息提示用户做出相应的操作。
|
|
196
336
|
|
|
197
337
|
**代码示例:**
|
|
338
|
+
|
|
339
|
+
【Vue3】
|
|
198
340
|
``` typescript
|
|
199
341
|
import { useDeviceState, DeviceError } from 'tuikit-atomicx-vue3/room';
|
|
200
342
|
import { TUIToast } from '@tencentcloud/uikit-base-component-vue3';
|
|
@@ -226,11 +368,44 @@ try {
|
|
|
226
368
|
}
|
|
227
369
|
```
|
|
228
370
|
|
|
371
|
+
【React】
|
|
372
|
+
``` typescript
|
|
373
|
+
import { useDeviceState, DeviceError } from 'tuikit-atomicx-react/room';
|
|
374
|
+
import { TUIToast } from '@tencentcloud/uikit-base-component-react';
|
|
375
|
+
|
|
376
|
+
const { startScreenShare } = useDeviceState();
|
|
377
|
+
|
|
378
|
+
try {
|
|
379
|
+
await startScreenShare();
|
|
380
|
+
} catch (error: any) {
|
|
381
|
+
let message = '';
|
|
382
|
+
switch (error.name) {
|
|
383
|
+
case 'NotReadableError':
|
|
384
|
+
message = '系统禁止当前浏览器访问屏幕内容,请启用屏幕分享权限。';
|
|
385
|
+
break;
|
|
386
|
+
case 'NotAllowedError':
|
|
387
|
+
if (error.message.includes('Permission denied by system')) {
|
|
388
|
+
message = '系统禁止当前浏览器访问屏幕内容,请启用屏幕分享权限。';
|
|
389
|
+
} else {
|
|
390
|
+
message = '用户取消屏幕分享';
|
|
391
|
+
}
|
|
392
|
+
break;
|
|
393
|
+
default:
|
|
394
|
+
message = '屏幕分享过程中发生未知错误,请重试。';
|
|
395
|
+
break;
|
|
396
|
+
}
|
|
397
|
+
TUIToast.warning({
|
|
398
|
+
message,
|
|
399
|
+
});
|
|
400
|
+
}
|
|
401
|
+
```
|
|
402
|
+
|
|
229
403
|
## API 文档
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
404
|
+
|
|
405
|
+
|**State/Component**|**功能描述**|**API 文档**|
|
|
406
|
+
|---------|---------|---------|
|
|
407
|
+
|**useDeviceState**|包含音视频设备状态,音视频设备列表及操作接口。|[API 文档](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-DeviceState)|
|
|
408
|
+
|**useRoomParticipantState**|包含房间内用户数据,用户管理接口。|[API 文档](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-RoomParticipantState)|
|
|
234
409
|
|
|
235
410
|
## 常见问题
|
|
236
411
|
|
|
@@ -244,6 +419,8 @@ try {
|
|
|
244
419
|
### 如何感知用户通过点击浏览器的“停止分享”按钮后结束屏幕分享?
|
|
245
420
|
|
|
246
421
|
Atomicx 会自动监听浏览器的停止分享事件,并更新 `screenStatus` 状态。您只需要监听 `screenStatus` 的变化即可:
|
|
422
|
+
|
|
423
|
+
【Vue3】
|
|
247
424
|
``` typescript
|
|
248
425
|
watch(screenStatus, (newStatus, oldStatus) => {
|
|
249
426
|
if (oldStatus === DeviceStatus.On && newStatus === DeviceStatus.Off) {
|
|
@@ -252,6 +429,22 @@ watch(screenStatus, (newStatus, oldStatus) => {
|
|
|
252
429
|
});
|
|
253
430
|
```
|
|
254
431
|
|
|
432
|
+
【React】
|
|
433
|
+
``` typescript
|
|
434
|
+
import { useEffect, useRef } from 'react';
|
|
435
|
+
import { useDeviceState, DeviceStatus } from 'tuikit-atomicx-react/room';
|
|
436
|
+
|
|
437
|
+
const { screenStatus } = useDeviceState();
|
|
438
|
+
const prevScreenStatus = useRef(screenStatus);
|
|
439
|
+
|
|
440
|
+
useEffect(() => {
|
|
441
|
+
if (prevScreenStatus.current === DeviceStatus.On && screenStatus === DeviceStatus.Off) {
|
|
442
|
+
console.log('用户已停止屏幕分享。');
|
|
443
|
+
}
|
|
444
|
+
prevScreenStatus.current = screenStatus;
|
|
445
|
+
}, [screenStatus]);
|
|
446
|
+
```
|
|
447
|
+
|
|
255
448
|
### 移动端浏览器是否支持屏幕分享?
|
|
256
449
|
|
|
257
450
|
仅桌面端浏览器支持屏幕分享,移动端浏览器不支持屏幕分享能力。
|
package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/virtual-background.md
RENAMED
|
@@ -255,6 +255,7 @@ WebRTC 相关功能通常要求在 HTTPS 环境下运行,或者是 `localhost`
|
|
|
255
255
|
腾讯云在 GitHub 上提供了示例项目 [atomicx-vite-vue3-ts](https://github.com/Tencent-RTC/TUIRoomKit/tree/main/Web/example/atomicx-vite-vue3-ts) ,您可以参考以实现完整的 RoomKit 功能。
|
|
256
256
|
|
|
257
257
|
## API 文档
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
258
|
+
|
|
259
|
+
|**State/Component**|**功能描述**|**API 文档**|
|
|
260
|
+
|---------|---------|---------|
|
|
261
|
+
|**useVirtualBackgroundState**|虚拟背景管理|[API 文档](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-VirtualBackgroundState)|
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
TUIRoomKit 是腾讯云提供的一站式多人音视频房间解决方案,集成了完整的 UI 组件和核心功能。通过本文档,开发者可以快速了解如何将 TUIRoomKit 集成到项目中,实现多人音视频房间功能。本文还将详细介绍如何快速替换图片资源、本地化文案等个性化配置,帮助开发者打造符合品牌特色的音视频应用。
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
|
|
3
|
+
|房间准备页|房间主页|成员管理|
|
|
4
|
+
|---------|---------|---------|
|
|
5
|
+
||||
|
|
5
6
|
|
|
6
7
|
## 前提条件
|
|
7
8
|
|
|
@@ -95,7 +96,7 @@ dependencies {
|
|
|
95
96
|
|
|
96
97
|
#### 4. 修改 AndroidManifest.xml
|
|
97
98
|
|
|
98
|
-
|
|
99
|
+
为了防止编译时 `AndroidManifest` 合并过程中产生属性冲突,您需要在 `app/src/main/AndroidManifest.xml` 文件的 `<application>` 节点中,添加 `tools:replace="android:allowBackup"` 和 `android:allowBackup="false"`,用以覆盖组件内的设置。
|
|
99
100
|
``` xml
|
|
100
101
|
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
|
|
101
102
|
xmlns:tools="http://schemas.android.com/tools">
|
|
@@ -154,13 +155,13 @@ class MainActivity : AppCompatActivity() {
|
|
|
154
155
|
**登录接口参数说明:**
|
|
155
156
|
| 参数 | 类型 | 说明 |
|
|
156
157
|
| --- | --- | --- |
|
|
157
|
-
|
|
|
158
|
-
|
|
|
159
|
-
|
|
|
158
|
+
| <code>sdkAppID</code> | <code>Int32</code> | 从 <a href="https://console.cloud.tencent.com/trtc">控制台</a> 获取,通常是以 <code>140</code> 或 <code>160</code> 开头的 10 位整数。 |
|
|
159
|
+
| <code>userID</code> | <code>String</code> | 当前用户的唯一 ID,仅包含英文字母、数字、连字符和下划线。为避免多端登录冲突,<strong>请勿使用</strong><code>1</code>、<code>123</code><strong>等简单 ID</strong>。 |
|
|
160
|
+
| <code>userSig</code> | <code>String</code> | 用于腾讯云鉴权的票据。更多信息请参见 如何计算及使用 UserSig。<br>【注意事项】<br>- 开发环境:可以采用本地 <code>GenerateTestUserSig.genTestSig</code> 函数生成 userSig 或者通过 <a href="https://console.cloud.tencent.com/im/tool-usersig">UserSig 辅助工具</a> 生成临时的 userSig。<br>- 生产环境:为了防止密钥泄露,请务必采用服务端生成 userSig 的方式。详细信息请参考 服务端生成 UserSig。 |
|
|
160
161
|
|
|
161
162
|
### 步骤4:设置头像和昵称
|
|
162
163
|
|
|
163
|
-
首次登录的用户没有头像和昵称信息,需要通过 `LoginStore` 的 `setSelfInfo
|
|
164
|
+
首次登录的用户没有头像和昵称信息,需要通过 `LoginStore` 的 `setSelfInfo` 接口设置个人信息:
|
|
164
165
|
``` java
|
|
165
166
|
import android.util.Log
|
|
166
167
|
import io.trtc.tuikit.atomicxcore.api.CompletionHandler
|
|
@@ -188,15 +189,15 @@ fun setSelfInfo() {
|
|
|
188
189
|
}
|
|
189
190
|
```
|
|
190
191
|
|
|
191
|
-
**setSelfInfo接口参数说明:**
|
|
192
|
+
**setSelfInfo 接口参数说明:**
|
|
192
193
|
| 参数 | 类型 | 必填 | 说明 |
|
|
193
194
|
| --- | --- | --- | --- |
|
|
194
|
-
|
|
|
195
|
-
|
|
|
195
|
+
| <code>userProfile</code> | <code>UserProfile</code> | 是 | 个人用户信息核心模型,包含:<br>- userID:要设置用户信息的用户 ID。<br>- nickname:昵称信息。<br>- avatarURL:头像链接。 |
|
|
196
|
+
| <code>completion</code> | <code>CompletionHandler</code> | 否 | 设置个人信息接口的结果回调。若失败会返回错误码和错误信息。 |
|
|
196
197
|
|
|
197
198
|
### 步骤5:创建房间
|
|
198
199
|
|
|
199
|
-
|
|
200
|
+
在 `TUIRoomKit` 组件中,`RoomMainView` 是集成了完整的多人音视频房间功能的核心界面,以下将对开发者演示如何以房主身份将 `RoomMainView` 嵌入到应用中。
|
|
200
201
|
|
|
201
202
|
#### **实现方式:**
|
|
202
203
|
1. **加载创建视图页面**:懒加载方式实例化 `RoomMainView `。
|
|
@@ -205,13 +206,7 @@ fun setSelfInfo() {
|
|
|
205
206
|
|
|
206
207
|
3. **初始化房间主页面**:通过房主身份初始化房间主页面。
|
|
207
208
|
|
|
208
|
-
4. **将视图添加到视图 Activity
|
|
209
|
-
|
|
210
|
-
> **说明:**
|
|
211
|
-
>
|
|
212
|
-
|
|
213
|
-
> 移动端仅支持创建标准房间,如您需要创建大型研讨会房间,请参考 Web 快速接入 使用 Web 端创建。
|
|
214
|
-
>
|
|
209
|
+
4. **将视图添加到视图 Activity**:在 `Activity` 的 `onCreate` 方法中,将 `RoomMainView` 添加到 `Activity` 中,并使用布局使其充满整个视图区域。
|
|
215
210
|
|
|
216
211
|
#### **示例代码:**
|
|
217
212
|
``` java
|
|
@@ -251,30 +246,31 @@ class MainActivity : AppCompatActivity() {
|
|
|
251
246
|
**RoomMainView init 函数参数详细说明****:**
|
|
252
247
|
| 参数 | 类型 | 说明 |
|
|
253
248
|
| --- | --- | --- |
|
|
254
|
-
|
|
|
255
|
-
|
|
|
256
|
-
|
|
|
249
|
+
| <code>roomID</code> | <code>String</code> | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
|
|
250
|
+
| <code>roomType</code> | <code>RoomType</code> | 房间类型<br>- <code>STANDARD</code>:标准房间。<br>- <code>WEBINAR</code>:大型研讨会房间。<br>标准房间这里填写 <code>STANDARD 房间类型</code>。 |
|
|
251
|
+
| <code>behavior</code> | <code>RoomBehavior</code> | 房间主页面初始化来源。<br>- Create: 房主身份创建房间。此方式需要构造创建房间配置项,关于 CreateRoomOptions 的详细用法请参考:CreateRoomOptions 结构体详细说明。<br>- Join:参与者身份加入房间。 |
|
|
252
|
+
| <code>config</code> | <code>ConnectConfig</code> | 进房后音视频设备控制的配置项。 |
|
|
257
253
|
|
|
258
254
|
**ConnectConfig 参数详细说明****:**
|
|
259
255
|
| 参数 | 类型 | 说明 |
|
|
260
256
|
| --- | --- | --- |
|
|
261
|
-
| autoEnableMicrophone |
|
|
262
|
-
| autoEnableCamera |
|
|
263
|
-
| autoEnableSpeaker |
|
|
257
|
+
| autoEnableMicrophone | <code>Boolean</code> | 进房后是否自动开启麦克风<br>- true:自动开启 (默认值)。<br>- false:不自动开启。 |
|
|
258
|
+
| autoEnableCamera | <code>Boolean</code> | 进房后是否自动开启摄像头。<br>- true:自动开启 (默认值)。<br>- false:不自动开启。 |
|
|
259
|
+
| autoEnableSpeaker | <code>Boolean</code> | 进房后是否自动开启扬声器。<br>- true:自动开启 (默认值)。<br>- false:不自动开启。 |
|
|
264
260
|
|
|
265
261
|
##### CreateRoomOptions 结构体详细说明
|
|
266
262
|
| 参数名 | 类型 | 必填 | 说明 |
|
|
267
263
|
| --- | --- | --- | --- |
|
|
268
|
-
|
|
|
269
|
-
|
|
|
270
|
-
|
|
|
271
|
-
|
|
|
272
|
-
|
|
|
273
|
-
|
|
|
264
|
+
| <code>roomName</code> | <code>String</code> | 否 | - 房间名称,可以不设置,默认为空字符串。<br>- 限制长度为 0-60 字节。<br>- 支持中英文、数字、特殊字符。 |
|
|
265
|
+
| <code>password</code> | <code>String</code> | 否 | - 房间密码,空字符串 "" 通常表示该房间不设密码。<br>- 限制长度为 0-32 字节。<br>- 推荐使用 4-8 位纯数字,方便移动端输入。设置后,其他用户加入房间时需输入密码。建议不要存储明文敏感信息。 |
|
|
266
|
+
| <code>isAllMicrophoneDisabled</code> | <code>Boolean</code> | 否 | 是否全员禁止打开麦克风。开启后,除房主/管理员外,普通参与者默认禁止打开麦克风。<br>- true:禁止。<br>- false:取消禁止 (默认值)。 |
|
|
267
|
+
| <code>isAllCameraDisabled</code> | <code>Boolean</code> | 否 | 是否全员禁止打开摄像头。开启后,除房主/管理员外,普通参与者默认禁止打开摄像头。<br>- true:禁止。<br>- false:取消禁止(默认值)。 |
|
|
268
|
+
| <code>isAllScreenShareDisabled</code> | <code>Boolean</code> | 否 | 是否全员禁止发起屏幕共享。开启后,仅房主/管理员可进行屏幕共享。<br>- true:禁止。<br>- false:取消禁止(默认值)。 |
|
|
269
|
+
| <code>isAllMessageDisabled</code> | <code>Boolean</code> | 否 | 是否全员禁止发送聊天消息(禁言)。开启后,普通参与者无法在房间内发送文字消息。<br>- true:禁止。<br>- false:取消禁止(默认值)。 |
|
|
274
270
|
|
|
275
271
|
### 步骤6:加入房间
|
|
276
272
|
|
|
277
|
-
|
|
273
|
+
以下示例将向开发者演示如何以参与者身份将 `RoomMainView` 嵌入到应用中。
|
|
278
274
|
|
|
279
275
|
#### **实现方式:**
|
|
280
276
|
1. **加载创建视图页面**:懒加载方式实例化 `RoomMainView `。
|
|
@@ -283,13 +279,7 @@ class MainActivity : AppCompatActivity() {
|
|
|
283
279
|
|
|
284
280
|
3. **初始化房间主页面**:通过参与者身份初始化房间主页面。
|
|
285
281
|
|
|
286
|
-
4. **将视图添加到视图 Activity
|
|
287
|
-
|
|
288
|
-
> **说明:**
|
|
289
|
-
>
|
|
290
|
-
|
|
291
|
-
> 使用 **TUIRoomKit** 组件进入大型研讨会房间时,需确保 Web 端创建的研讨会房间的房间 ID 以 `webinar_` 开头。
|
|
292
|
-
>
|
|
282
|
+
4. **将视图添加到视图 Activity**:在 `Activity` 的 `onCreate` 方法中,将 `RoomMainView` 添加到 `Activity` 中,并使用布局使其充满整个视图区域。
|
|
293
283
|
|
|
294
284
|
#### 代码示例:
|
|
295
285
|
``` java
|
|
@@ -328,44 +318,40 @@ class MainActivity : AppCompatActivity() {
|
|
|
328
318
|
|
|
329
319
|
## 核心功能
|
|
330
320
|
|
|
331
|
-
|
|
332
|
-
| 标准房间 | 大型研讨会房间 |
|
|
333
|
-
| --- | --- |
|
|
334
|
-
| | |
|
|
321
|
+
接入 `RoomMainView` 代码后,开发者将得到一个完整的多人音视频页面,内部包含成员管理,音视频设备控制,房间信息展示等功能,这是 `TUIRoomKit` 组件的核心。
|
|
335
322
|
|
|
336
323
|
## 界面定制
|
|
337
324
|
|
|
338
|
-
`RoomMainView
|
|
339
|
-
| 标准房间 | 大型研讨会房间 |
|
|
340
|
-
| --- | --- |
|
|
341
|
-
| | |
|
|
325
|
+
`RoomMainView` 房间主页面内功能丰富,可定制化度高,开发者可以根据实际产品需求,对 UI 进行定制化修改,以适配业务交互场景。以下将详细为开发者展示 `RoomMainView` 页面中视图组件,便于开发者快速修改。
|
|
342
326
|
|
|
343
327
|
`RoomMainView`**中组件详细说明**
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
|
348
|
-
|
|
|
349
|
-
|
|
|
350
|
-
|
|
|
328
|
+
|
|
329
|
+
|组件|功能描述|定制化建议|
|
|
330
|
+
|---------|---------|---------|
|
|
331
|
+
|[RoomMainView](https://github.com/Tencent-RTC/TUIKit_Android/blob/main/room/tuiroomkit/src/main/java/com/trtc/uikit/roomkit/view/RoomMainView.kt)|房间主视图容器,负责协调各子组件的布局与数据流转。|可调整整体背景、安全区域适配、组件显隐逻辑。|
|
|
332
|
+
|[RoomTopBarView](https://github.com/Tencent-RTC/TUIKit_Android/blob/main/room/tuiroomkit/src/main/java/com/trtc/uikit/roomkit/view/main/RoomTopBarView.kt)|顶部导航栏,包含房间信息、摄像头和声音控制、退出房间功能入口。|可替换图标、调整背景透明度、添加自定义按钮(例如录制、 窗口化)。|
|
|
333
|
+
|[RoomView](https://github.com/Tencent-RTC/TUIKit_Android/blob/main/room/tuiroomkit/src/main/java/com/trtc/uikit/roomkit/view/main/RoomView.kt)|视频流展示区域,采用瀑布流布局管理多个用户视频画面。|可修改布局算法(行列数、间距)、分页指示器样式、空状态视图。|
|
|
334
|
+
|[RoomVideoNameOverlayView](https://github.com/Tencent-RTC/TUIKit_Android/blob/main/room/tuiroomkit/src/main/java/com/trtc/uikit/roomkit/view/main/roomview/RoomVideoNameOverlayView.kt)|单个视频流单元格挂件,承载用户视频画面与基本信息。|可自定义视频渲染层、用户信息面板(头像、徽章)、互动控件(语音波形)。|
|
|
335
|
+
|[RoomBottomBarView](https://github.com/Tencent-RTC/TUIKit_Android/blob/main/room/tuiroomkit/src/main/java/com/trtc/uikit/roomkit/view/main/RoomBottomBarView.kt)|底部工具栏,集成麦克风、摄像头、成员管理操作按钮。|可重新排列按钮顺序、修改按钮样式(颜色、尺寸)、添加业务相关功能(例如屏幕分享、会中呼叫、美颜)。|
|
|
351
336
|
|
|
352
337
|
## 图标定制
|
|
353
338
|
|
|
354
|
-
接入 `TUIRoomKit
|
|
339
|
+
接入 `TUIRoomKit` 组件后,开发者可以根据实际 UI 交互需求直接替换组件下的图标资源, 以适配开发者的业务场景。
|
|
355
340
|
|
|
356
341
|
**常用的图片文件列表**
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
342
|
+
|
|
343
|
+
|图标|文件名|说明|
|
|
344
|
+
|---------|---------|---------|
|
|
345
|
+
||roomkit_ic_camera_off.png|摄像头关闭图标|
|
|
346
|
+
||roomkit_ic_camera_on.png|摄像头开启图标|
|
|
347
|
+
||roomkit_ic_microphone_off.png|麦克风关闭图标|
|
|
348
|
+
||roomkit_ic_microphone_on.png|麦克风开启图标|
|
|
349
|
+
||roomkit_icon_user_room_manager.png|管理员身份标识图标|
|
|
350
|
+
||roomkit_ic_video_seat_owner.png|房主身份标识图标|
|
|
365
351
|
|
|
366
352
|
## 文案定制
|
|
367
353
|
|
|
368
|
-
TUIRoomKit 使用 Android 通用的 XML 资源文件来管理 UI 所需的文案显示,您可以直接通过
|
|
354
|
+
TUIRoomKit 使用 Android 通用的 XML 资源文件来管理 UI 所需的文案显示,您可以直接通过 `XML` 文件修改需要调整的文案:
|
|
369
355
|
|
|
370
356
|
## 常见问题
|
|
371
357
|
|