@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/ios/features → knowledge/roomkit/core-sdk/ios}/schedule-room.md
RENAMED
|
@@ -14,13 +14,13 @@
|
|
|
14
14
|
## 核心概念
|
|
15
15
|
|
|
16
16
|
在开始集成之前,您可能需要通过下表了解一下`RoomStore`中与预订房间相关的几个核心概念:
|
|
17
|
-
|
|
|
17
|
+
| <strong>核心概念</strong> | <strong>类型</strong> | <strong>核心职责与描述</strong> |
|
|
18
18
|
| --- | --- | --- |
|
|
19
|
-
|
|
|
20
|
-
|
|
|
21
|
-
|
|
|
22
|
-
|
|
|
23
|
-
|
|
|
19
|
+
| <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomstatus">RoomStatus</a> | <code>enum</code> | 代表当前房间的状态,包含:<br>- scheduled(预定状态)。<br>- running(进行中)。 |
|
|
20
|
+
| <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/scheduleroomoptions">ScheduleRoomOptions</a> | <code>struct</code> | 代表预定房间的核心数据结构,包含:开始时间,结束时间,预定成员列表等。 |
|
|
21
|
+
| <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomstate">RoomState</a> | <code>struct</code> | 代表房间状态管理的核心数据结构,负责维护用户的房间相关状态信息。<br>核心属性:<br>- <code>scheduledRoomList</code>存储了当前账号下所有预定的房间列表信息。<br>- <code>scheduledRoomListCursor</code> 则代表预定房间列表的分页游标。 |
|
|
22
|
+
| <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent">RoomEvent</a> | <code>enum</code> | 代表房间动态的实时事件。其中包含预定房间相关的事件。 |
|
|
23
|
+
| <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomstore">RoomStore</a> | <code>class</code> | 这是与房间全生命周期相关的核心类。通过它,您可以主动发起预定房间,获取预定房间列表等功能,并通过订阅其 <code>roomEventPublisher</code> 来接收与预定房间相关的实时动态事件。 |
|
|
24
24
|
|
|
25
25
|
## 实现步骤
|
|
26
26
|
|
|
@@ -77,23 +77,23 @@ func scheduleRoom() {
|
|
|
77
77
|
##### scheduleRoom 接口参数详细说明
|
|
78
78
|
| 参数名 | 类型 | 必填 | 说明 |
|
|
79
79
|
| --- | --- | --- | --- |
|
|
80
|
-
|
|
|
81
|
-
|
|
|
82
|
-
|
|
|
80
|
+
| <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
|
|
81
|
+
| <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 创建房间配置对象。<br>- 详细用法请参考:ScheduleRoomOptions 结构体详细说明 |
|
|
82
|
+
| <code>completion</code> | <code>CompletionClosure</code> | 否 | 操作完成回调,用于返回预定房间的结果。若预定失败则会返回错误码和错误信息。 |
|
|
83
83
|
|
|
84
84
|
##### ScheduleRoomOptions 结构体详细说明
|
|
85
85
|
| 参数名 | 类型 | 必填 | 说明 |
|
|
86
86
|
| --- | --- | --- | --- |
|
|
87
|
-
|
|
|
88
|
-
|
|
|
89
|
-
|
|
|
90
|
-
|
|
|
91
|
-
|
|
|
92
|
-
|
|
|
93
|
-
|
|
|
94
|
-
|
|
|
95
|
-
|
|
|
96
|
-
|
|
|
87
|
+
| <code>roomName</code> | <code>String</code> | 否 | - 房间名称,可以不设置,默认为空字符串。<br>- 限制长度为 0-60 字节。<br>- 支持中英文、数字、特殊字符。 |
|
|
88
|
+
| <code>password</code> | <code>String</code> | 否 | - 房间密码,空字符串 "" 通常表示该房间不设密码。<br>- 限制长度为 0-32 字节。<br>- 推荐使用 4-8 位纯数字,方便移动端输入。设置后,其他用户加入房间时需输入密码。建议不要存储明文敏感信息。 |
|
|
89
|
+
| <code>scheduleStartTime</code> | <code>Int</code> | 是 | - 预定的房间开始时间(Unix 时间戳,单位:秒)。<br>- 取值必须大于当前时间。<br>- 推荐设置为未来的整分时间。例如:1736164800(代表 2025-01-06 20:00:00)。 |
|
|
90
|
+
| <code>scheduleEndTime</code> | <code>Int</code> | 是 | - 预定的房间结束时间(Unix 时间戳,单位:秒)。<br>- 取值必须大于 <code>scheduleStartTime</code>。<br>- 建议根据预期时长设置。例如:<code>scheduleStartTime</code> + 3600(预定 1 小时时长的房间)。 |
|
|
91
|
+
| <code>reminderSecondsBeforeStart</code> | <code>Int</code> | 否 | - 房间开始前的提醒时间(单位:秒)。用于系统触发开始提醒。<br>- 推荐设置为 300(5分钟)或 900(15分钟),用于在 App 端触发本地通知。 |
|
|
92
|
+
| <code>scheduleAttendees</code> | <code>[String]</code> | 否 | - 预定参与者的用户 ID 列表,在预定房间时设置,系统将向这些用户发送预约邀请。<br>- 获取请参考获取指定预定房间的参与成员列表。 |
|
|
93
|
+
| <code>isAllMicrophoneDisabled</code> | <code>Bool</code> | 否 | 是否全员禁止打开麦克风。开启后,除房主/管理员外,普通参与者默认禁止打开麦克风。<br>- true : 禁止<br>- false :取消禁止 (默认值) |
|
|
94
|
+
| <code>isAllCameraDisabled</code> | <code>Bool</code> | 否 | 是否全员禁止打开摄像头。开启后,除房主/管理员外,普通参与者默认禁止打开摄像头。<br>- true : 禁止<br>- false :取消禁止(默认值) |
|
|
95
|
+
| <code>isAllScreenShareDisabled</code> | <code>Bool</code> | 否 | 是否全员禁止发起屏幕共享。开启后,仅房主/管理员可进行屏幕共享。<br>- true : 禁止<br>- false :取消禁止(默认值) |
|
|
96
|
+
| <code>isAllMessageDisabled</code> | <code>Bool</code> | 否 | 是否全员禁止发送聊天消息(禁言)。开启后,普通参与者无法在房间内发送文字消息。<br>- true : 禁止<br>- false :取消禁止(默认值) |
|
|
97
97
|
|
|
98
98
|
#### **二、取消房间预定**
|
|
99
99
|
|
|
@@ -151,17 +151,17 @@ func updateScheduledRoom() {
|
|
|
151
151
|
##### updateScheduledRoom 接口参数详细说明
|
|
152
152
|
| 参数名 | 类型 | 必填 | 说明 |
|
|
153
153
|
| --- | --- | --- | --- |
|
|
154
|
-
|
|
|
155
|
-
|
|
|
156
|
-
|
|
|
157
|
-
|
|
|
154
|
+
| <code>roomID</code> | <code>String</code> | 是 | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
|
|
155
|
+
| <code>options</code> | <code>ScheduleRoomOptions</code> | 是 | - 预定房间配置对象。<br>- 详细用法请参考:ScheduleRoomOptions 结构体详细说明 |
|
|
156
|
+
| <code>modifyFlag</code> | <code>ScheduleRoomOptions.ModifyFlag</code> | 是 | - 更新房间属性修改标志位。目前支持更新<strong>房间名称</strong>、<strong>开始时间</strong>、<strong>结束时间。</strong><br>- 详细用法请参考:ScheduleRoomOptions.ModifyFlag 详细说明。 |
|
|
157
|
+
| <code>completion</code> | <code>CompletionClosure</code> | 否 | 操作完成回调,用于返回更新预定房间的结果。若更新失败则会返回错误码和错误信息。 |
|
|
158
158
|
|
|
159
159
|
**ScheduleRoomOptions.ModifyFlag 详细说明**
|
|
160
160
|
| 参数名 | 类型 | 说明 |
|
|
161
161
|
| --- | --- | --- |
|
|
162
|
-
|
|
|
163
|
-
|
|
|
164
|
-
|
|
|
162
|
+
| <code>roomName</code> | <code>UInt</code> | - 修改预定房间名称时的标识位。<br>- 当修改<code>ScheduleRoomOptions</code>中的<code>roomName</code>后,需要同步设置<code>ModifyFlag</code>的<br>- <code>roomName</code>标识位。 |
|
|
163
|
+
| <code>scheduleStartTime</code> | <code>UInt</code> | - 修改预定房间开始时间时的标识位。<br>- 当修改<code>ScheduleRoomOptions</code>中的<code>scheduleStartTime</code>后,需要同步设置<code>ModifyFlag</code>的<code>scheduleStartTime</code>标识位。 |
|
|
164
|
+
| <code>scheduleEndTime</code> | <code>UInt</code> | - 修改预定房间结束时间时的标识位。<br>- 当修改<code>ScheduleRoomOptions</code>中的<code>scheduleEndTime</code>后,需要同步设置<code>ModifyFlag</code>的<code>scheduleEndTime</code>标识位。 |
|
|
165
165
|
|
|
166
166
|
#### **四、添加、删除参与成员**
|
|
167
167
|
|
|
@@ -292,9 +292,9 @@ private func subscribeScheduledRoomListState() {
|
|
|
292
292
|
```
|
|
293
293
|
|
|
294
294
|
## API 文档
|
|
295
|
-
|
|
|
295
|
+
| <strong>Store/Component</strong> | <strong>功能描述</strong> | <strong>API文档</strong> |
|
|
296
296
|
| --- | --- | --- |
|
|
297
|
-
|
|
|
297
|
+
| <strong>RoomStore</strong> | 房间全生命周期管理:创建并加入 / 加入 / 离开 / 结束房间 / 更新、获取房间信息 / 房间预定 / 呼叫房间外成员 / 监听房间内被动事件(例如房间解散,房间信息更新等)。 | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomstore">API 文档</a> |
|
|
298
298
|
|
|
299
299
|
## 常见问题
|
|
300
300
|
|
package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/call-user-to-room.md
RENAMED
|
@@ -25,6 +25,8 @@
|
|
|
25
25
|
### 步骤1:发起呼叫(邀请者)
|
|
26
26
|
|
|
27
27
|
邀请者调用 [callUserToRoom](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#callUserToRoom) 接口发起邀请。请确保邀请者当前已在房间内(即 [currentRoom](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#currentRoom) 不为空),否则无法发起呼叫。
|
|
28
|
+
|
|
29
|
+
【Vue3】
|
|
28
30
|
``` typescript
|
|
29
31
|
import { useRoomState } from 'tuikit-atomicx-vue3/room';
|
|
30
32
|
|
|
@@ -54,9 +56,41 @@ const inviteUser = async () => {
|
|
|
54
56
|
};
|
|
55
57
|
```
|
|
56
58
|
|
|
59
|
+
【React】
|
|
60
|
+
``` typescript
|
|
61
|
+
import { useRoomState } from 'tuikit-atomicx-react/room';
|
|
62
|
+
|
|
63
|
+
const { currentRoom, callUserToRoom } = useRoomState();
|
|
64
|
+
|
|
65
|
+
const inviteUser = async () => {
|
|
66
|
+
// 会中呼叫必须关联一个已存在的 roomId,因此需先校验当前用户的进房状态
|
|
67
|
+
if (!currentRoom) {
|
|
68
|
+
console.warn('请先进入房间再发起邀请');
|
|
69
|
+
return;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
try {
|
|
73
|
+
const resultMap = await callUserToRoom({
|
|
74
|
+
roomId: currentRoom.roomId, // 被邀请者将要加入的房间 ID
|
|
75
|
+
userIdList: ['user1', 'user2'], // 目标用户 ID 数组,支持单人或多人
|
|
76
|
+
timeout: 60, // 邀请有效时长(秒),超时后双方会触发 onCallTimeout
|
|
77
|
+
// extensionInfo 可用于传递业务自定义数据,例如邀请类型、附加消息等
|
|
78
|
+
extensionInfo: JSON.stringify({ type: 'emergency', priority: 'high' })
|
|
79
|
+
});
|
|
80
|
+
|
|
81
|
+
// resultMap 返回每个 userId 对应的状态,例如 Success、AlreadyInRoom (已在房) 或 AlreadyInCalling (通话中)
|
|
82
|
+
console.log('邀请发送完成,详情状态映射:', resultMap);
|
|
83
|
+
} catch (error) {
|
|
84
|
+
console.error('呼叫请求发送失败,请检查网络或登录状态:', error);
|
|
85
|
+
}
|
|
86
|
+
};
|
|
87
|
+
```
|
|
88
|
+
|
|
57
89
|
### 步骤2:监听呼叫事件(被邀请者)
|
|
58
90
|
|
|
59
91
|
被邀请者需要监听 `onCallReceived` 事件。建议在例如 `App.vue`等长驻组件中实现,以确保无论用户在哪个页面都能响应。
|
|
92
|
+
|
|
93
|
+
【Vue3】
|
|
60
94
|
``` typescript
|
|
61
95
|
import { ref, onMounted, onUnmounted } from 'vue';
|
|
62
96
|
import { useRoomState, RoomEvent } from 'tuikit-atomicx-vue3/room';
|
|
@@ -136,30 +170,110 @@ onUnmounted(() => {
|
|
|
136
170
|
});
|
|
137
171
|
```
|
|
138
172
|
|
|
173
|
+
【React】
|
|
174
|
+
``` typescript
|
|
175
|
+
import { useState, useEffect } from 'react';
|
|
176
|
+
import { useRoomState, RoomEvent } from 'tuikit-atomicx-react/room';
|
|
177
|
+
|
|
178
|
+
const {
|
|
179
|
+
subscribeEvent,
|
|
180
|
+
unsubscribeEvent,
|
|
181
|
+
acceptCall,
|
|
182
|
+
rejectCall,
|
|
183
|
+
joinRoom,
|
|
184
|
+
currentRoom
|
|
185
|
+
} = useRoomState();
|
|
186
|
+
|
|
187
|
+
const [showInviteDialog, setShowInviteDialog] = useState(false); // 控制 UI 弹窗显隐
|
|
188
|
+
const [currentCallInfo, setCurrentCallInfo] = useState(null); // 缓存收到的邀请上下文
|
|
189
|
+
|
|
190
|
+
const handleCallReceived = async ({ roomInfo, call, extensionInfo }) => {
|
|
191
|
+
// 冲突处理:如果用户当前已经在会议中,根据业务策略通常应直接拒绝新邀请,防止干扰
|
|
192
|
+
if (currentRoom?.roomId) {
|
|
193
|
+
await rejectCall({ roomId: roomInfo.roomId });
|
|
194
|
+
return;
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
// 记录邀请详情,用于在 UI 上展示邀请者名称或业务透传数据
|
|
198
|
+
setCurrentCallInfo({ roomInfo, call });
|
|
199
|
+
setShowInviteDialog(true);
|
|
200
|
+
};
|
|
201
|
+
|
|
202
|
+
// 接受邀请逻辑
|
|
203
|
+
const onUserAccept = async () => {
|
|
204
|
+
if (!currentCallInfo) return;
|
|
205
|
+
const { roomId } = currentCallInfo.roomInfo;
|
|
206
|
+
|
|
207
|
+
try {
|
|
208
|
+
// 关键流程 A:响应信令。告知邀请者已接受,使其能更新 UI(例如显示"对方已接听")
|
|
209
|
+
await acceptCall({ roomId });
|
|
210
|
+
|
|
211
|
+
// 关键流程 B:执行进房。只有调用 joinRoom 才会真正开启音视频推拉流链路
|
|
212
|
+
await joinRoom({ roomId });
|
|
213
|
+
} catch (error) {
|
|
214
|
+
console.error('接受呼叫后的进房操作失败:', error);
|
|
215
|
+
} finally {
|
|
216
|
+
closeDialog();
|
|
217
|
+
}
|
|
218
|
+
};
|
|
219
|
+
|
|
220
|
+
// 拒绝邀请逻辑
|
|
221
|
+
const onUserReject = async () => {
|
|
222
|
+
if (currentCallInfo) {
|
|
223
|
+
// 告知邀请者已拒绝,邀请者会收到 onCallRejected 事件
|
|
224
|
+
await rejectCall({ roomId: currentCallInfo.roomInfo.roomId });
|
|
225
|
+
}
|
|
226
|
+
closeDialog();
|
|
227
|
+
};
|
|
228
|
+
|
|
229
|
+
const closeDialog = () => {
|
|
230
|
+
setShowInviteDialog(false);
|
|
231
|
+
setCurrentCallInfo(null);
|
|
232
|
+
};
|
|
233
|
+
|
|
234
|
+
// 事件全生命周期管理:确保在组件挂载时监听,销毁时移除,防止事件溢出
|
|
235
|
+
useEffect(() => {
|
|
236
|
+
subscribeEvent(RoomEvent.onCallReceived, handleCallReceived);
|
|
237
|
+
|
|
238
|
+
// 监听导致邀请结束的各种异常/同步事件,确保 UI 弹窗能及时闭合
|
|
239
|
+
subscribeEvent(RoomEvent.onCallCancelled, closeDialog); // 邀请者取消了呼叫
|
|
240
|
+
subscribeEvent(RoomEvent.onCallTimeout, closeDialog); // 呼叫超时未响应
|
|
241
|
+
subscribeEvent(RoomEvent.onCallHandledByOtherDevice, closeDialog); // 用户在其他设备已处理该呼叫
|
|
242
|
+
|
|
243
|
+
return () => {
|
|
244
|
+
// 移除所有监听器,避免在组件销毁后继续执行 handleCallReceived 导致内存泄漏或报错
|
|
245
|
+
unsubscribeEvent(RoomEvent.onCallReceived, handleCallReceived);
|
|
246
|
+
unsubscribeEvent(RoomEvent.onCallCancelled, closeDialog);
|
|
247
|
+
unsubscribeEvent(RoomEvent.onCallTimeout, closeDialog);
|
|
248
|
+
unsubscribeEvent(RoomEvent.onCallHandledByOtherDevice, closeDialog);
|
|
249
|
+
};
|
|
250
|
+
}, []);
|
|
251
|
+
```
|
|
252
|
+
|
|
139
253
|
## 实践教程:提升呼叫接通率
|
|
140
254
|
|
|
141
255
|
为了在业务中获得更高的呼叫接通率,除了基础功能的实现外,建议参考以下策略优化用户体验:
|
|
142
256
|
|
|
143
|
-
###
|
|
257
|
+
### 增强呼叫感知(避免用户遗漏)
|
|
144
258
|
|
|
145
259
|
由于 Web 端特性,浏览器静音或页面处于后台运行状态可能导致用户遗漏呼叫。
|
|
146
260
|
- **视觉提醒**:利用 [Page Visibility API](https://developer.mozilla.org/en-US/docs/Web/API/Page_Visibility_API) 检测页面可见性状态。若页面处于后台,可通过循环修改 `document.title` 实现标题栏闪烁提示(例如:“【新邀请】UserA 邀请您入会...”),以吸引用户注意。
|
|
147
261
|
|
|
148
262
|
- **听觉提醒**:在 `onCallReceived` 事件触发时播放高优先级的提示铃声。注意:需遵循浏览器的 [自动播放策略](https://developer.mozilla.org/zh-CN/docs/Web/Media/Guides/Autoplay),大部分浏览器在缺乏用户交互(例如点击、触摸或按键)的情况下会限制音频自动播放。
|
|
149
263
|
|
|
150
|
-
###
|
|
264
|
+
### 丰富邀请上下文(提升接听意愿)
|
|
151
265
|
|
|
152
266
|
缺乏明确意图的邀请容易被用户拒绝。建议充分利用 `extensionInfo` 字段传递关键业务信息,以提升用户的接听意愿。
|
|
153
267
|
- **传递业务上下文**:利用 `extensionInfo` 透传如 `reason`(例如:“项目紧急评审”)、`level`(例如:“P0故障排查”)等业务字段,告知用户呼叫的紧迫性和重要性。
|
|
154
268
|
|
|
155
|
-
###
|
|
269
|
+
### 多通道触达兜底(确保消息可达)
|
|
156
270
|
|
|
157
271
|
受限于 Web 端机制,浏览器进程结束将无法接收实时信令。建议采取以下替代方案以确保触达:
|
|
158
272
|
- **浏览器系统通知**:引导用户授权 [Web Notification API](https://developer.mozilla.org/en-US/docs/Web/API/Notification)。只要浏览器进程未关闭(包括最小化或在后台标签页),即可触发操作系统级别的弹窗通知,有效提醒用户。
|
|
159
273
|
|
|
160
274
|
- **多通道触达**:建议结合业务后端逻辑,在检测到用户不在线或超时未响应时,通过**短信**、**邮件**或**企业微信**等外部渠道发送入会链接,实现全方位触达。
|
|
161
275
|
|
|
162
|
-
###
|
|
276
|
+
### 智能重试机制(解决“接受邀请后进房失败”)
|
|
163
277
|
|
|
164
278
|
在弱网或其他不稳定环境下,用户点击接受邀请后调用 `joinRoom` 可能会出现偶发性失败。
|
|
165
279
|
- **自动重试**:建议在 `onUserAccept` 的异常处理逻辑(`catch`)中引入 2-3 次自动重试机制(推荐结合指数退避策略),以最大程度确保用户点击“接受”后能成功加入会议。
|
|
@@ -215,6 +329,7 @@ onUnmounted(() => {
|
|
|
215
329
|
腾讯云在 GitHub 上提供了示例项目 [atomicx-vite-vue3-ts](https://github.com/Tencent-RTC/TUIRoomKit/tree/main/Web/example/atomicx-vite-vue3-ts) ,您可以参考以实现完整的 RoomKit 功能。
|
|
216
330
|
|
|
217
331
|
## API 文档
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
332
|
+
|
|
333
|
+
|**State/Component**|**功能描述**|**API 文档**|
|
|
334
|
+
|---------|---------|---------|
|
|
335
|
+
|**useRoomState**|房间状态管理(创建、加入、预约等)|[API 文档](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-RoomState)|
|
package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/device-detection.md
RENAMED
|
@@ -19,6 +19,8 @@
|
|
|
19
19
|
使用 [startCameraTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startCameraTest) 方法启动摄像头测试。该方法仅用于本地预览,不会产生网络流量。
|
|
20
20
|
|
|
21
21
|
**代码示例:**
|
|
22
|
+
|
|
23
|
+
【Vue3】
|
|
22
24
|
``` typescript
|
|
23
25
|
<template>
|
|
24
26
|
<div class="preview-container">
|
|
@@ -115,11 +117,108 @@ const handleCameraChange = async (event: Event) => {
|
|
|
115
117
|
</style>
|
|
116
118
|
```
|
|
117
119
|
|
|
120
|
+
【React】
|
|
121
|
+
``` typescript
|
|
122
|
+
import React, { useEffect } from 'react';
|
|
123
|
+
import {
|
|
124
|
+
useDeviceState,
|
|
125
|
+
DeviceStatus,
|
|
126
|
+
DeviceError,
|
|
127
|
+
} from 'tuikit-atomicx-react/room';
|
|
128
|
+
|
|
129
|
+
const CameraTest: React.FC = () => {
|
|
130
|
+
const {
|
|
131
|
+
isCameraTesting,
|
|
132
|
+
isCameraTestLoading,
|
|
133
|
+
cameraList,
|
|
134
|
+
currentCamera,
|
|
135
|
+
startCameraTest,
|
|
136
|
+
stopCameraTest,
|
|
137
|
+
getCameraList,
|
|
138
|
+
setCurrentCamera
|
|
139
|
+
} = useDeviceState();
|
|
140
|
+
|
|
141
|
+
useEffect(() => {
|
|
142
|
+
return () => {
|
|
143
|
+
if (isCameraTesting) {
|
|
144
|
+
stopCameraTest();
|
|
145
|
+
}
|
|
146
|
+
};
|
|
147
|
+
}, []);
|
|
148
|
+
|
|
149
|
+
const toggleCameraTest = async () => {
|
|
150
|
+
if (isCameraTesting) {
|
|
151
|
+
await stopCameraTest();
|
|
152
|
+
} else {
|
|
153
|
+
const previewElement = document.getElementById('camera-preview');
|
|
154
|
+
if (previewElement) {
|
|
155
|
+
await startCameraTest({ view: previewElement });
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
};
|
|
159
|
+
|
|
160
|
+
const handleCameraChange = async (event: React.ChangeEvent<HTMLSelectElement>) => {
|
|
161
|
+
const deviceId = event.target.value;
|
|
162
|
+
try {
|
|
163
|
+
await setCurrentCamera({ deviceId });
|
|
164
|
+
} catch (error) {
|
|
165
|
+
console.error('切换摄像头失败:', error);
|
|
166
|
+
}
|
|
167
|
+
};
|
|
168
|
+
|
|
169
|
+
return (
|
|
170
|
+
<div className="preview-container">
|
|
171
|
+
{/* 摄像头预览区域 */}
|
|
172
|
+
<div id="camera-preview" className="camera-preview">
|
|
173
|
+
{/* 加载状态 */}
|
|
174
|
+
{isCameraTestLoading && (
|
|
175
|
+
<div className="loading-overlay">
|
|
176
|
+
<div className="loading-spinner" />
|
|
177
|
+
<span>正在启动摄像头...</span>
|
|
178
|
+
</div>
|
|
179
|
+
)}
|
|
180
|
+
</div>
|
|
181
|
+
|
|
182
|
+
{/* 摄像头选择 */}
|
|
183
|
+
<div className="camera-selector">
|
|
184
|
+
<label>选择摄像头</label>
|
|
185
|
+
<select
|
|
186
|
+
value={currentCamera?.deviceId}
|
|
187
|
+
onChange={handleCameraChange}
|
|
188
|
+
disabled={isCameraTestLoading}
|
|
189
|
+
>
|
|
190
|
+
{cameraList.map(camera => (
|
|
191
|
+
<option key={camera.deviceId} value={camera.deviceId}>
|
|
192
|
+
{camera.deviceName}
|
|
193
|
+
</option>
|
|
194
|
+
))}
|
|
195
|
+
</select>
|
|
196
|
+
</div>
|
|
197
|
+
|
|
198
|
+
{/* 控制按钮 */}
|
|
199
|
+
<div className="control-buttons">
|
|
200
|
+
<button onClick={getCameraList}>获取摄像头列表</button>
|
|
201
|
+
<button
|
|
202
|
+
onClick={toggleCameraTest}
|
|
203
|
+
disabled={isCameraTestLoading}
|
|
204
|
+
>
|
|
205
|
+
{isCameraTesting ? '停止预览' : '开始预览'}
|
|
206
|
+
</button>
|
|
207
|
+
</div>
|
|
208
|
+
</div>
|
|
209
|
+
);
|
|
210
|
+
};
|
|
211
|
+
|
|
212
|
+
export default CameraTest;
|
|
213
|
+
```
|
|
214
|
+
|
|
118
215
|
### 步骤2:麦克风测试
|
|
119
216
|
|
|
120
217
|
通过 [startMicrophoneTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startMicrophoneTest) 启动麦克风测试,并利用 [testingMicVolume](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#testingMicVolume) 实现 UI 音量条的实时波动。
|
|
121
218
|
|
|
122
219
|
**代码示例:**
|
|
220
|
+
|
|
221
|
+
【Vue3】
|
|
123
222
|
``` typescript
|
|
124
223
|
<template>
|
|
125
224
|
<div class="microphone-test">
|
|
@@ -238,11 +337,127 @@ const handleMicrophoneChange = async (event: Event) => {
|
|
|
238
337
|
</style>
|
|
239
338
|
```
|
|
240
339
|
|
|
340
|
+
【React】
|
|
341
|
+
``` typescript
|
|
342
|
+
import React, { useMemo, useEffect } from 'react';
|
|
343
|
+
import {
|
|
344
|
+
useDeviceState,
|
|
345
|
+
DeviceError,
|
|
346
|
+
} from 'tuikit-atomicx-react/room';
|
|
347
|
+
|
|
348
|
+
const MicrophoneTest: React.FC = () => {
|
|
349
|
+
const {
|
|
350
|
+
isMicrophoneTesting,
|
|
351
|
+
testingMicVolume,
|
|
352
|
+
microphoneList,
|
|
353
|
+
currentMicrophone,
|
|
354
|
+
startMicrophoneTest,
|
|
355
|
+
stopMicrophoneTest,
|
|
356
|
+
getMicrophoneList,
|
|
357
|
+
setCurrentMicrophone
|
|
358
|
+
} = useDeviceState();
|
|
359
|
+
|
|
360
|
+
// Volume bar style class
|
|
361
|
+
const volumeClass = useMemo(() => {
|
|
362
|
+
const volume = testingMicVolume;
|
|
363
|
+
if (volume === 0) return 'volume-zero';
|
|
364
|
+
if (volume < 30) return 'volume-low';
|
|
365
|
+
if (volume < 70) return 'volume-medium';
|
|
366
|
+
return 'volume-high';
|
|
367
|
+
}, [testingMicVolume]);
|
|
368
|
+
|
|
369
|
+
// Cleanup: stop test
|
|
370
|
+
useEffect(() => {
|
|
371
|
+
return () => {
|
|
372
|
+
if (isMicrophoneTesting) {
|
|
373
|
+
stopMicrophoneTest();
|
|
374
|
+
}
|
|
375
|
+
};
|
|
376
|
+
}, []);
|
|
377
|
+
|
|
378
|
+
// Toggle microphone test
|
|
379
|
+
const toggleMicrophoneTest = async () => {
|
|
380
|
+
if (isMicrophoneTesting) {
|
|
381
|
+
await stopMicrophoneTest();
|
|
382
|
+
} else {
|
|
383
|
+
try {
|
|
384
|
+
await startMicrophoneTest({ interval: 200 });
|
|
385
|
+
} catch (error) {
|
|
386
|
+
console.error('启动麦克风测试失败:', error);
|
|
387
|
+
}
|
|
388
|
+
}
|
|
389
|
+
};
|
|
390
|
+
|
|
391
|
+
// Switch microphone device
|
|
392
|
+
const handleMicrophoneChange = async (event: React.ChangeEvent<HTMLSelectElement>) => {
|
|
393
|
+
const deviceId = event.target.value;
|
|
394
|
+
try {
|
|
395
|
+
await setCurrentMicrophone({ deviceId });
|
|
396
|
+
} catch (error) {
|
|
397
|
+
console.error('切换麦克风失败:', error);
|
|
398
|
+
}
|
|
399
|
+
};
|
|
400
|
+
|
|
401
|
+
return (
|
|
402
|
+
<div className="microphone-test">
|
|
403
|
+
{/* 音量显示 */}
|
|
404
|
+
<div className="volume-display">
|
|
405
|
+
<div className="volume-label">麦克风音量</div>
|
|
406
|
+
<div className="volume-bar-container">
|
|
407
|
+
<div
|
|
408
|
+
className={`volume-bar ${volumeClass}`}
|
|
409
|
+
style={{ width: `${testingMicVolume}%` }}
|
|
410
|
+
/>
|
|
411
|
+
</div>
|
|
412
|
+
<div className="volume-value">{testingMicVolume}</div>
|
|
413
|
+
</div>
|
|
414
|
+
|
|
415
|
+
{/* 麦克风选择 */}
|
|
416
|
+
<div className="microphone-selector">
|
|
417
|
+
<label>选择麦克风</label>
|
|
418
|
+
<select
|
|
419
|
+
value={currentMicrophone?.deviceId}
|
|
420
|
+
onChange={handleMicrophoneChange}
|
|
421
|
+
disabled={isMicrophoneTesting}
|
|
422
|
+
>
|
|
423
|
+
{microphoneList.map(mic => (
|
|
424
|
+
<option key={mic.deviceId} value={mic.deviceId}>
|
|
425
|
+
{mic.deviceName}
|
|
426
|
+
</option>
|
|
427
|
+
))}
|
|
428
|
+
</select>
|
|
429
|
+
</div>
|
|
430
|
+
|
|
431
|
+
{/* 控制按钮 */}
|
|
432
|
+
<div className="control-buttons">
|
|
433
|
+
<button onClick={getMicrophoneList}>
|
|
434
|
+
获取设备
|
|
435
|
+
</button>
|
|
436
|
+
<button onClick={toggleMicrophoneTest}>
|
|
437
|
+
{isMicrophoneTesting ? '停止测试' : '开始测试'}
|
|
438
|
+
</button>
|
|
439
|
+
</div>
|
|
440
|
+
|
|
441
|
+
{/* 测试提示 */}
|
|
442
|
+
{isMicrophoneTesting && (
|
|
443
|
+
<div className="test-tip">
|
|
444
|
+
<span>请对着麦克风说话,查看音量变化</span>
|
|
445
|
+
</div>
|
|
446
|
+
)}
|
|
447
|
+
</div>
|
|
448
|
+
);
|
|
449
|
+
};
|
|
450
|
+
|
|
451
|
+
export default MicrophoneTest;
|
|
452
|
+
```
|
|
453
|
+
|
|
241
454
|
### 步骤3:扬声器测试
|
|
242
455
|
|
|
243
456
|
使用 [startSpeakerTest](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#startSpeakerTest) 方法播放一段指定的音频文件来确认扬声器是否工作正常。
|
|
244
457
|
|
|
245
458
|
**代码示例:**
|
|
459
|
+
|
|
460
|
+
【Vue3】
|
|
246
461
|
``` typescript
|
|
247
462
|
<template>
|
|
248
463
|
<div class="speaker-test">
|
|
@@ -342,10 +557,110 @@ const handleSpeakerChange = async (event: Event) => {
|
|
|
342
557
|
</style>
|
|
343
558
|
```
|
|
344
559
|
|
|
560
|
+
【React】
|
|
561
|
+
``` typescript
|
|
562
|
+
import React, { useEffect } from 'react';
|
|
563
|
+
import { useDeviceState } from 'tuikit-atomicx-react/room';
|
|
564
|
+
|
|
565
|
+
const SpeakerTest: React.FC = () => {
|
|
566
|
+
const {
|
|
567
|
+
isSpeakerTesting,
|
|
568
|
+
speakerList,
|
|
569
|
+
currentSpeaker,
|
|
570
|
+
startSpeakerTest,
|
|
571
|
+
stopSpeakerTest,
|
|
572
|
+
getSpeakerList,
|
|
573
|
+
setCurrentSpeaker,
|
|
574
|
+
} = useDeviceState();
|
|
575
|
+
|
|
576
|
+
// Test audio file path
|
|
577
|
+
// Note: This URL is for development testing only. In production, use your own audio file. Recommended: 3-5 second MP3 format.
|
|
578
|
+
const testAudioPath = 'https://web.sdk.qcloud.com/trtc/electron/download/resources/media/TestSpeaker.mp3';
|
|
579
|
+
|
|
580
|
+
// Cleanup: stop test
|
|
581
|
+
useEffect(() => {
|
|
582
|
+
return () => {
|
|
583
|
+
if (isSpeakerTesting) {
|
|
584
|
+
stopSpeakerTest();
|
|
585
|
+
}
|
|
586
|
+
};
|
|
587
|
+
}, []);
|
|
588
|
+
|
|
589
|
+
// Toggle speaker test
|
|
590
|
+
const toggleSpeakerTest = async () => {
|
|
591
|
+
if (isSpeakerTesting) {
|
|
592
|
+
await stopSpeakerTest();
|
|
593
|
+
} else {
|
|
594
|
+
try {
|
|
595
|
+
await startSpeakerTest({ filePath: testAudioPath });
|
|
596
|
+
} catch (error) {
|
|
597
|
+
console.error('启动扬声器测试失败:', error);
|
|
598
|
+
}
|
|
599
|
+
}
|
|
600
|
+
};
|
|
601
|
+
|
|
602
|
+
// Switch speaker device
|
|
603
|
+
const handleSpeakerChange = async (event: React.ChangeEvent<HTMLSelectElement>) => {
|
|
604
|
+
const deviceId = event.target.value;
|
|
605
|
+
try {
|
|
606
|
+
await setCurrentSpeaker({ deviceId });
|
|
607
|
+
} catch (error) {
|
|
608
|
+
console.error('切换扬声器失败:', error);
|
|
609
|
+
}
|
|
610
|
+
};
|
|
611
|
+
|
|
612
|
+
return (
|
|
613
|
+
<div className="speaker-test">
|
|
614
|
+
{/* 扬声器选择 */}
|
|
615
|
+
<div className="speaker-selector">
|
|
616
|
+
<label>选择扬声器</label>
|
|
617
|
+
<select
|
|
618
|
+
value={currentSpeaker?.deviceId}
|
|
619
|
+
onChange={handleSpeakerChange}
|
|
620
|
+
disabled={isSpeakerTesting}
|
|
621
|
+
>
|
|
622
|
+
{speakerList.map(speaker => (
|
|
623
|
+
<option key={speaker.deviceId} value={speaker.deviceId}>
|
|
624
|
+
{speaker.deviceName}
|
|
625
|
+
</option>
|
|
626
|
+
))}
|
|
627
|
+
</select>
|
|
628
|
+
</div>
|
|
629
|
+
|
|
630
|
+
{/* 控制按钮 */}
|
|
631
|
+
<div className="control-buttons">
|
|
632
|
+
<button onClick={getSpeakerList}>获取扬声器列表</button>
|
|
633
|
+
<button
|
|
634
|
+
onClick={toggleSpeakerTest}
|
|
635
|
+
disabled={isSpeakerTesting}
|
|
636
|
+
>
|
|
637
|
+
{isSpeakerTesting ? '正在播放...' : '播放测试音频'}
|
|
638
|
+
</button>
|
|
639
|
+
{isSpeakerTesting && (
|
|
640
|
+
<button onClick={stopSpeakerTest}>
|
|
641
|
+
停止播放
|
|
642
|
+
</button>
|
|
643
|
+
)}
|
|
644
|
+
</div>
|
|
645
|
+
|
|
646
|
+
{/* 测试提示 */}
|
|
647
|
+
{isSpeakerTesting && (
|
|
648
|
+
<div className="test-tip">
|
|
649
|
+
<span>正在播放测试音频,请确认是否能听到声音</span>
|
|
650
|
+
</div>
|
|
651
|
+
)}
|
|
652
|
+
</div>
|
|
653
|
+
);
|
|
654
|
+
};
|
|
655
|
+
|
|
656
|
+
export default SpeakerTest;
|
|
657
|
+
```
|
|
658
|
+
|
|
345
659
|
## API 文档
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
660
|
+
|
|
661
|
+
|**State/Component**|**功能描述**|**API 文档**|
|
|
662
|
+
|---------|---------|---------|
|
|
663
|
+
|**useDeviceState**|包含音视频设备状态,音视频设备列表及操作接口。|[API 文档](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-DeviceState)|
|
|
349
664
|
|
|
350
665
|
## 常见问题
|
|
351
666
|
|