@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
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## 核心功能
|
|
4
4
|
|
|
5
5
|
通过组合 `AudioEffectStore` 和 `DeviceStore`,您将能实现以下核心功能:
|
|
6
|
-
-
|
|
6
|
+
- **人声音量调节**:控制本地音频上行的采集音量大小,即观众听到主播声音的大小。
|
|
7
7
|
|
|
8
8
|
- **耳返功能**:允许主播或连麦用户通过耳机实时听到自己的声音,用于监听和矫正发音。
|
|
9
9
|
|
|
@@ -12,27 +12,28 @@
|
|
|
12
12
|
- **混响效果**:模拟不同环境的声场效果,例如 KTV、金属声、低沉、洪亮等。
|
|
13
13
|
|
|
14
14
|
## 概念说明
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
|
19
|
-
|
|
|
20
|
-
|
|
|
15
|
+
|
|
16
|
+
|**核心概念**|**类型**|**核心职责与描述**|
|
|
17
|
+
|---------|---------|---------|
|
|
18
|
+
|[AudioEffectState](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioEffectState-class.html)|`class`|代表音效模块的当前状态,通常用于 UI 渲染。包括变声状态、混响状态、耳返开启状态、耳返音量。所有属性均为 `ValueListenable` 类型,支持订阅监听。|
|
|
19
|
+
|[AudioEffectStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioEffectStore-class.html)|`class`|代表音效模块**单例数据管理类**。通过它您可以调用修改音效接口,当您调用接口后,相应的 `audioEffectState` 属性会自动更新,可以通过订阅这个 state 响应式数据来接收和监听状态更新。|
|
|
20
|
+
|[DeviceState](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_device_store/DeviceState-class.html)|`class`|代表设备模块的当前状态,通常用于 UI 渲染。核心属性包括摄像头、麦克风的设备状态、采集音量等。所有属性均为 `ValueListenable` 类型,支持订阅监听。|
|
|
21
|
+
|[DeviceStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_device_store/DeviceStore-class.html)|`class`|代表设备模块**单例数据管理类**。通过它您可以调用操作摄像头、麦克风接口,当您调用接口后,相应的 `state` 属性会自动更新,可以通过订阅这个 state 响应式数据来接收和监听状态更新。|
|
|
21
22
|
|
|
22
23
|
## 实现步骤
|
|
23
24
|
|
|
24
25
|
### 步骤1:组件集成
|
|
25
26
|
|
|
26
|
-
请参考
|
|
27
|
+
请参考 开播与收听 集成 **AtomicXCore**,完成接入。
|
|
27
28
|
|
|
28
29
|
### 步骤2:获取 Store 实例
|
|
29
30
|
|
|
30
|
-
`AudioEffectStore` 和 `DeviceStore` 是单例对象,您可以直接通过 `shared`
|
|
31
|
-
```
|
|
31
|
+
`AudioEffectStore` 和 `DeviceStore` 是单例对象,您可以直接通过 `shared` 属性在项目的任何位置获取实例。您也可以参考 TUILiveKit 开源 UI demo 项目中的 [audio_effect_panel_widget.dart](https://github.com/Tencent-RTC/TUIKit_Flutter/blob/main/live/livekit/lib/component/audio_effect/audio_effect_panel_widget.dart) 文件来了解完整的实现逻辑。
|
|
32
|
+
``` java
|
|
32
33
|
import 'package:flutter/material.dart';
|
|
33
|
-
import 'package:atomic_x_core/
|
|
34
|
+
import 'package:atomic_x_core/atomicxcore.dart';
|
|
34
35
|
|
|
35
|
-
class
|
|
36
|
+
class _AudioEffectPanelWidgetState {
|
|
36
37
|
final _audioEffectStore = AudioEffectStore.shared;
|
|
37
38
|
final _deviceStore = DeviceStore.shared;
|
|
38
39
|
}
|
|
@@ -51,14 +52,14 @@ class AudioEffectManager {
|
|
|
51
52
|
#### 实现方式
|
|
52
53
|
1. **开关耳返**:您可以使用 `Switch` 控件实现开关耳返功能。
|
|
53
54
|
|
|
54
|
-
2. **设置耳返音量值**:您可以使用 `Slider` 控件实现左右拖动滑块来调节音量的功能,并将 `Slider` 的值映射成音量值,调用 `setVoiceEarMonitorVolume(volume)`。请注意,该接口接收的参数范围是 `[0, 150]`,所以您需要将 UI 控件的值(例如 Slider 的 `
|
|
55
|
+
2. **设置耳返音量值**:您可以使用 `Slider` 控件实现左右拖动滑块来调节音量的功能,并将 `Slider` 的值映射成音量值,调用 `setVoiceEarMonitorVolume(volume)`。请注意,该接口接收的参数范围是 `[0, 150]`,所以您需要将 UI 控件的值(例如 Slider 的 `0.0 - 1.0`)映射到 `0 - 150` 的范围。
|
|
55
56
|
|
|
56
57
|
3. **监听状态更新 UI**:您可以订阅实时的耳返状态值更新 UI。
|
|
57
58
|
|
|
58
59
|
#### 代码示例
|
|
59
|
-
```
|
|
60
|
+
``` java
|
|
60
61
|
import 'package:flutter/material.dart';
|
|
61
|
-
import 'package:atomic_x_core/
|
|
62
|
+
import 'package:atomic_x_core/atomicxcore.dart';
|
|
62
63
|
|
|
63
64
|
/// 耳返控制组件
|
|
64
65
|
class EarMonitorWidget extends StatelessWidget {
|
|
@@ -111,28 +112,28 @@ class EarMonitorWidget extends StatelessWidget {
|
|
|
111
112
|
```
|
|
112
113
|
|
|
113
114
|
#### setVoiceEarMonitorEnable 接口参数
|
|
114
|
-
|
|
|
115
|
+
| <strong>参数名</strong> | <strong>类型</strong> | <strong>描述</strong> |
|
|
115
116
|
| --- | --- | --- |
|
|
116
|
-
|
|
|
117
|
+
| <code>enable</code> | <code>bool</code> | 是否开启耳返。<br>- true:开启<br>- false:关闭 |
|
|
117
118
|
|
|
118
119
|
#### setVoiceEarMonitorVolume 接口参数
|
|
119
|
-
|
|
|
120
|
+
| <strong>参数名</strong> | <strong>类型</strong> | <strong>描述</strong> |
|
|
120
121
|
| --- | --- | --- |
|
|
121
|
-
|
|
|
122
|
+
| <code>volume</code> | <code>int</code> | 耳返音量大小。<br>- 取值范围:[0, 150]<br>- 默认值:100 |
|
|
122
123
|
|
|
123
124
|
### 步骤4:实现人声音量调节
|
|
124
125
|
|
|
125
126
|
当主播希望调节自己的上行采集音量大小时,调用 `DeviceStore` 的 `setCaptureVolume(volume)` 方法传入音量值即可。
|
|
126
127
|
|
|
127
128
|
#### 实现方式
|
|
128
|
-
1. **设置采集音量值**:您可以使用 `Slider` 控件实现左右拖动滑块来调节音量的功能,并将 `Slider` 的值映射成音量值后调用 `setCaptureVolume(volume)`。请注意,该接口接收的参数范围是 `[0, 150]`,所以您需要将 UI 控件的值(例如 Slider 的 `
|
|
129
|
+
1. **设置采集音量值**:您可以使用 `Slider` 控件实现左右拖动滑块来调节音量的功能,并将 `Slider` 的值映射成音量值后调用 `setCaptureVolume(volume)`。请注意,该接口接收的参数范围是 `[0, 150]`,所以您需要将 UI 控件的值(例如 Slider 的 `0.0 - 1.0`)映射到 `0 - 150` 的范围。
|
|
129
130
|
|
|
130
131
|
2. **监听状态更新 UI**:您可以订阅实时的音量状态值更新 UI。
|
|
131
132
|
|
|
132
133
|
#### 代码示例
|
|
133
|
-
```
|
|
134
|
+
``` java
|
|
134
135
|
import 'package:flutter/material.dart';
|
|
135
|
-
import 'package:atomic_x_core/
|
|
136
|
+
import 'package:atomic_x_core/atomicxcore.dart';
|
|
136
137
|
|
|
137
138
|
/// 人声音量控制组件
|
|
138
139
|
class CaptureVolumeWidget extends StatelessWidget {
|
|
@@ -165,18 +166,18 @@ class CaptureVolumeWidget extends StatelessWidget {
|
|
|
165
166
|
```
|
|
166
167
|
|
|
167
168
|
#### setCaptureVolume 接口参数
|
|
168
|
-
|
|
|
169
|
+
| <strong>参数名</strong> | <strong>类型</strong> | <strong>描述</strong> |
|
|
169
170
|
| --- | --- | --- |
|
|
170
|
-
|
|
|
171
|
+
| <code>volume</code> | <code>int</code> | 采集音量大小。<br>- 取值范围:[0, 150]<br>- 默认值:100 |
|
|
171
172
|
|
|
172
173
|
### 步骤5:实现变声效果
|
|
173
174
|
|
|
174
175
|
当主播希望改变自己的声音时,您可以调用 `setAudioChangerType(type)` 方法,传入相应的 Type 枚举值即可切换效果。
|
|
175
176
|
|
|
176
177
|
#### 代码示例
|
|
177
|
-
```
|
|
178
|
+
``` java
|
|
178
179
|
import 'package:flutter/material.dart';
|
|
179
|
-
import 'package:atomic_x_core/
|
|
180
|
+
import 'package:atomic_x_core/atomicxcore.dart';
|
|
180
181
|
|
|
181
182
|
/// 变声效果选择组件
|
|
182
183
|
class VoiceChangerWidget extends StatelessWidget {
|
|
@@ -238,18 +239,19 @@ class VoiceChangerWidget extends StatelessWidget {
|
|
|
238
239
|
```
|
|
239
240
|
|
|
240
241
|
#### setAudioChangerType 接口参数
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
242
|
+
|
|
243
|
+
|**参数名**|**类型**|**描述**|
|
|
244
|
+
|---------|---------|---------|
|
|
245
|
+
|`type`|[AudioChangerType](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioChangerType.html)|变声效果枚举。|
|
|
244
246
|
|
|
245
247
|
### 步骤6:实现混响效果
|
|
246
248
|
|
|
247
249
|
当主播希望给自己的声音添加混响效果时,您可以调用 `setAudioReverbType(type)` 方法,传入相应的 Type 枚举值即可切换效果。
|
|
248
250
|
|
|
249
251
|
#### 代码示例
|
|
250
|
-
```
|
|
252
|
+
``` java
|
|
251
253
|
import 'package:flutter/material.dart';
|
|
252
|
-
import 'package:atomic_x_core/
|
|
254
|
+
import 'package:atomic_x_core/atomicxcore.dart';
|
|
253
255
|
|
|
254
256
|
/// 混响效果选择组件
|
|
255
257
|
class ReverbWidget extends StatelessWidget {
|
|
@@ -319,16 +321,17 @@ class ReverbWidget extends StatelessWidget {
|
|
|
319
321
|
```
|
|
320
322
|
|
|
321
323
|
#### setAudioReverbType 接口参数
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
324
|
+
|
|
325
|
+
|**参数名**|**类型**|**描述**|
|
|
326
|
+
|---------|---------|---------|
|
|
327
|
+
|`type`|[AudioReverbType](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioReverbType.html)|混响效果枚举。|
|
|
325
328
|
|
|
326
329
|
### 步骤7:重置音效设置
|
|
327
330
|
|
|
328
331
|
> **重要:**
|
|
329
332
|
>
|
|
330
333
|
|
|
331
|
-
>
|
|
334
|
+
> AudioEffectStore 和 DeviceStore 是单例,即音效和设备设置会全局生效,如果您不希望当前直播间的设置影响到之后创建的其他直播间,就需要在当前直播间结束的时候重置音效和设备设置。
|
|
332
335
|
>
|
|
333
336
|
|
|
334
337
|
以下两种情况您可能需要重置音效设置:
|
|
@@ -336,9 +339,9 @@ class ReverbWidget extends StatelessWidget {
|
|
|
336
339
|
|
|
337
340
|
2. **需要重置所有设备和音效设置时**,调用 `store` 的 `reset()` 方法实现音效重置。
|
|
338
341
|
|
|
339
|
-
```
|
|
342
|
+
``` java
|
|
340
343
|
import 'package:flutter/material.dart';
|
|
341
|
-
import 'package:atomic_x_core/
|
|
344
|
+
import 'package:atomic_x_core/atomicxcore.dart';
|
|
342
345
|
|
|
343
346
|
/// 音效重置组件
|
|
344
347
|
class AudioEffectResetWidget extends StatelessWidget {
|
|
@@ -360,9 +363,9 @@ class ReverbWidget extends StatelessWidget {
|
|
|
360
363
|
```
|
|
361
364
|
|
|
362
365
|
## 完整示例
|
|
363
|
-
```
|
|
366
|
+
``` java
|
|
364
367
|
import 'package:flutter/material.dart';
|
|
365
|
-
import 'package:atomic_x_core/
|
|
368
|
+
import 'package:atomic_x_core/atomicxcore.dart';
|
|
366
369
|
|
|
367
370
|
/// 音效设置页面
|
|
368
371
|
class AudioEffectPage extends StatelessWidget {
|
|
@@ -559,32 +562,33 @@ class AudioEffectPage extends StatelessWidget {
|
|
|
559
562
|
|
|
560
563
|
## API 文档
|
|
561
564
|
|
|
562
|
-
关于 [AudioEffectStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioEffectStore-class.html) 和 [DeviceStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_device_store/DeviceStore-class.html)
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
565
|
+
关于 [AudioEffectStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioEffectStore-class.html) 和 [DeviceStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_device_store/DeviceStore-class.html) 及其相关类的所有公开接口、属性的详细信息,请参阅 [AtomicXCore](https://tencent-rtc.github.io/TUIKit_Flutter/index.html) 框架的官方 API 文档。
|
|
566
|
+
|
|
567
|
+
|**Store/Component**|**功能描述**|**API 文档**|
|
|
568
|
+
|---------|---------|---------|
|
|
569
|
+
|**AudioEffectStore**|音效管理:进行音效设置,并获取实时音效状态。|[API 文档](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_audio_effect_store/AudioEffectStore-class.html)|
|
|
570
|
+
|**DeviceStore**|设备管理:进行摄像头、麦克风操作,并获取实时设备状态。|[API 文档](https://tencent-rtc.github.io/TUIKit_Flutter/api_device_device_store/DeviceStore-class.html)|
|
|
567
571
|
|
|
568
572
|
## 常见问题
|
|
569
573
|
|
|
570
|
-
###
|
|
574
|
+
### 音效和设备接口的调用时机是否有要求?
|
|
571
575
|
|
|
572
576
|
没有限制。`AudioEffectStore` 和 `DeviceStore` 的设置是全局生效的,您可以在进入直播间之前或之后随时调用相关接口(例如设置变声、混响或耳返),设置会立即生效并被保留。
|
|
573
577
|
|
|
574
|
-
###
|
|
578
|
+
### "人声音量" 和"耳返音量" 有什么区别?
|
|
575
579
|
|
|
576
580
|
这是一个非常重要且易混淆的概念,区别如下:
|
|
577
|
-
- **人声音量 (CaptureVolume):**通过 `DeviceStore.shared.setCaptureVolume()`
|
|
581
|
+
- **人声音量 (CaptureVolume):**通过 `DeviceStore.shared.setCaptureVolume()` 设置。它决定了观众能听到主播的声音大小。
|
|
578
582
|
|
|
579
|
-
- **耳返音量 (EarMonitorVolume):**通过 `AudioEffectStore.shared.setVoiceEarMonitorVolume()`
|
|
583
|
+
- **耳返音量 (EarMonitorVolume):**通过 `AudioEffectStore.shared.setVoiceEarMonitorVolume()` 设置。它只决定了主播在耳机里听到的监听声音大小,**不会**影响观众。
|
|
580
584
|
|
|
581
585
|
### 新创建的直播间为什么直接就有音效、或者出现音量很大、很小等问题?
|
|
582
586
|
|
|
583
587
|
`AudioEffectStore` 和 `DeviceStore` 是单例,这意味着音效和设备设置是全局生效的,出现这种情况很可能是因为您之前设置过音效但是没有重置,需要在合适的地方调用 `reset()` 方法重置。
|
|
584
588
|
|
|
585
|
-
###
|
|
589
|
+
### 为什么我开启了"耳返",但是听不到自己的声音?
|
|
586
590
|
|
|
587
|
-
|
|
591
|
+
请您按照以下步骤检查:
|
|
588
592
|
1. **是否插入耳机**:耳返功能绝大多数情况下依赖耳机才能生效,请确保已连接有线或蓝牙耳机。
|
|
589
593
|
|
|
590
594
|
2. **音量是否为0**:检查“耳返音量”是否被设置为 0。
|
|
@@ -12,19 +12,21 @@
|
|
|
12
12
|
- 在本地消息列表中插入系统提示(例如,"欢迎 XX 进入直播间")。
|
|
13
13
|
|
|
14
14
|
## 核心概念解析
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
|
19
|
-
|
|
|
15
|
+
|
|
16
|
+
|**核心概念**|**类型**|**核心职责与描述**|
|
|
17
|
+
|---------|---------|---------|
|
|
18
|
+
|[Barrage](https://tencent-rtc.github.io/TUIKit_Flutter/api_barrage_barrage_store/Barrage-class.html)|`class`|代表一条弹幕消息的数据模型。它包含了发送者信息 (`sender`)、消息内容 (`textContent` 或 `data`)、消息类型 (`messageType`) 等所有关键信息。|
|
|
19
|
+
|[BarrageState](https://tencent-rtc.github.io/TUIKit_Flutter/api_barrage_barrage_store/BarrageState-class.html)|`class`|代表弹幕模块的当前状态。其核心属性 `messageList` 是一个 `ValueListenable<List<Barrage>>`,按时间顺序存储了当前直播间的所有弹幕消息,是 UI 渲染的数据源。|
|
|
20
|
+
|[BarrageStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_barrage_barrage_store/BarrageStore-class.html)|`class`|这是与弹幕功能交互的核心管理类。通过它,您可以发送消息 (`sendTextMessage`, `sendCustomMessage`),并通过监听其 `barrageState.messageList` 属性来接收和监听所有弹幕消息的更新。|
|
|
20
21
|
|
|
21
22
|
## 实现步骤
|
|
22
23
|
|
|
23
24
|
### 步骤1:组件集成
|
|
25
|
+
- **视频直播**:请参考 开播与观看 集成 **AtomicXCore**,完成接入。
|
|
24
26
|
|
|
25
|
-
|
|
27
|
+
- **语聊房**:请参考 开播与收听 集成 **AtomicXCore**,完成接入。
|
|
26
28
|
|
|
27
|
-
完成集成后回到当前工程。
|
|
29
|
+
完成集成后回到当前工程。
|
|
28
30
|
|
|
29
31
|
### 步骤2:初始化并监听弹幕
|
|
30
32
|
|
|
@@ -98,10 +100,11 @@ extension BarrageManagerSend on BarrageManager {
|
|
|
98
100
|
```
|
|
99
101
|
|
|
100
102
|
**接口参数:**
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
103
|
+
|
|
104
|
+
|**参数**|**类型**|**描述**|
|
|
105
|
+
|---------|---------|---------|
|
|
106
|
+
|`text`|`String`|要发送的文本内容。|
|
|
107
|
+
|`extensionInfo`|`Map<String, String>?`|附加的扩展信息,可用于业务自定义。|
|
|
105
108
|
|
|
106
109
|
### 步骤4:发送自定义弹幕
|
|
107
110
|
|
|
@@ -138,10 +141,11 @@ extension BarrageManagerCustom on BarrageManager {
|
|
|
138
141
|
```
|
|
139
142
|
|
|
140
143
|
**接口参数:**
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
144
|
+
|
|
145
|
+
|**参数**|**类型**|**描述**|
|
|
146
|
+
|---------|---------|---------|
|
|
147
|
+
|`businessID`|`String`|业务唯一标识符,例如 "live_gift",用于接收端区分不同的自定义消息。|
|
|
148
|
+
|`data`|`String`|业务数据,通常为 JSON 格式的字符串。|
|
|
145
149
|
|
|
146
150
|
### 步骤5:在本地插入提示消息
|
|
147
151
|
|
|
@@ -374,7 +378,7 @@ SDK 会以极高频率返回完整的弹幕列表。如果每次都重建 UI,
|
|
|
374
378
|
|
|
375
379
|
#### **优化方案: **批处理与流量削峰 (Batch Processing & Debouncing)
|
|
376
380
|
|
|
377
|
-
不必响应每一次的数据更新,而是设定一个时间阈值(例如300毫秒)。只在距离上次 UI 刷新超过这个阈值后,才执行下一次刷新操作。这能将每秒数十次的 UI重绘,降低到每秒3-4次,极大提升流畅度。
|
|
381
|
+
不必响应每一次的数据更新,而是设定一个时间阈值(例如300毫秒)。只在距离上次 UI 刷新超过这个阈值后,才执行下一次刷新操作。这能将每秒数十次的 UI 重绘,降低到每秒3-4次,极大提升流畅度。
|
|
378
382
|
``` java
|
|
379
383
|
class BarrageUIManager {
|
|
380
384
|
List<Barrage>? _latestMessageList;
|
|
@@ -419,7 +423,7 @@ class BarrageUIManager {
|
|
|
419
423
|
|
|
420
424
|
#### 技术挑战
|
|
421
425
|
|
|
422
|
-
SDK 返回的全量 `messageList` 会在长时间直播中无限增长,即使 UI
|
|
426
|
+
SDK 返回的全量 `messageList` 会在长时间直播中无限增长,即使 UI 层做了节流,数据层持有的这个巨大数组也会持续占用内存,最终导致应用闪退。
|
|
423
427
|
|
|
424
428
|
#### **优化方案**:固定容量的循环数组 (Circular Buffer)
|
|
425
429
|
|
|
@@ -480,12 +484,20 @@ void _refreshUIIfNeeded() {
|
|
|
480
484
|
|
|
481
485
|
`AtomicXCore` 支持拉取历史弹幕消息,但这需要您在**服务端控制台**进行一项简单的配置。配置完成后,SDK 会自动处理后续的一切,您无需编写额外的代码。
|
|
482
486
|
|
|
483
|
-
**步骤1
|
|
484
|
-
|
|
487
|
+
**步骤1:在控制台进行配置**
|
|
488
|
+
|
|
489
|
+
根据您的应用创建方式,选择对应的控制台进行配置(实时音视频控制台或即时通信 IM 控制台)。
|
|
490
|
+
|
|
491
|
+
在控制台的配置页面中,找到**查看直播间历史消息**选项,修改其配置(最大支持 **50** 条消息)。
|
|
492
|
+
- 若您的应用在 [实时音视频控制台](https://console.cloud.tencent.com/trtc/app) 创建,配置步骤如下:
|
|
493
|
+
|
|
494
|
+
左侧导航栏选择**应用管理** > **功能配置 **>** LiveKit 功能**,在**应用管理**选择对应的应用后,单击**查看直播间历史消息 > 编辑**。
|
|
495
|
+
|
|
496
|
+
- 若您的应用在 [即时通信 IM 控制台](https://console.cloud.tencent.com/im/rtc-config) 创建,配置步骤如下:
|
|
485
497
|
|
|
486
|
-
|
|
498
|
+
左侧导航栏选择**音视频服务 RTC**,选择对应的应用后,单击**在线直播/语音聊天室(TUILiveKit) > 配置**。
|
|
487
499
|
|
|
488
|
-
|
|
500
|
+
进入 **LiveKit 功能配置**后,单击**查看直播间历史消息** > **编辑**。
|
|
489
501
|
|
|
490
502
|
**步骤2:客户端无感获取 **
|
|
491
503
|
|
package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md
RENAMED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
### 步骤1:组件集成
|
|
15
15
|
|
|
16
|
-
请参考
|
|
16
|
+
请参考 开播与收听 集成 **AtomicXCore**。
|
|
17
17
|
|
|
18
18
|
> **说明:**
|
|
19
19
|
>
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
> 在开始实现连麦功能之前,您需要获取 `liveId`(直播间唯一标识),用于区分不同的直播房间。获取方式如下
|
|
22
22
|
>
|
|
23
23
|
> - **主播端**:通过 `LiveListStore.shared.createLive(liveInfo)` 创建直播时指定。
|
|
24
|
-
> -
|
|
24
|
+
> - **观众端**:通过 `LiveListState.liveList.value` 中的 `liveInfo` 获取,或由主播分享直播间 ID 获取。
|
|
25
25
|
|
|
26
26
|
### 步骤2:实现观众申请上麦
|
|
27
27
|
|
|
@@ -383,15 +383,17 @@ void dispose() {
|
|
|
383
383
|
```
|
|
384
384
|
|
|
385
385
|
#### closeRemoteMicrophone 接口参数:
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
386
|
+
|
|
387
|
+
|**参数**|**类型**|**描述**|
|
|
388
|
+
|---------|---------|---------|
|
|
389
|
+
|`userID`|`String`|被操作的用户 `userID`。|
|
|
389
390
|
|
|
390
391
|
#### openRemoteMicrophone 接口参数:
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
392
|
+
|
|
393
|
+
|**参数**|**类型**|**描述**|
|
|
394
|
+
|---------|---------|---------|
|
|
395
|
+
|`userID`|`String`|被操作的用户 `userID`。|
|
|
396
|
+
|`policy`|`DeviceControlPolicy`|打开麦克风的策略。|
|
|
395
397
|
|
|
396
398
|
### 主播将麦上用户踢下麦位
|
|
397
399
|
|
|
@@ -421,9 +423,10 @@ _guestListener = GuestListener(
|
|
|
421
423
|
```
|
|
422
424
|
|
|
423
425
|
#### kickUserOutOfSeat 接口参数:
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
426
|
+
|
|
427
|
+
|**参数**|**类型**|**描述**|
|
|
428
|
+
|---------|---------|---------|
|
|
429
|
+
|`userID`|`String`|被踢下麦的用户 `userID`。|
|
|
427
430
|
|
|
428
431
|
### 主播锁定和解锁麦位
|
|
429
432
|
|
|
@@ -450,14 +453,16 @@ if (result2.isSuccess) {
|
|
|
450
453
|
```
|
|
451
454
|
|
|
452
455
|
#### lockSeat 接口参数:
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
+
|
|
457
|
+
|**参数**|**类型**|**描述**|
|
|
458
|
+
|---------|---------|---------|
|
|
459
|
+
|`seatIndex`|`int`|需要锁定的麦位索引。|
|
|
456
460
|
|
|
457
461
|
#### unlockSeat 接口参数:
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
462
|
+
|
|
463
|
+
|**参数**|**类型**|**描述**|
|
|
464
|
+
|---------|---------|---------|
|
|
465
|
+
|`seatIndex`|`int`|需要解锁的麦位索引。|
|
|
461
466
|
|
|
462
467
|
### 移动麦位
|
|
463
468
|
|
|
@@ -483,30 +488,31 @@ if (result.isSuccess) {
|
|
|
483
488
|
```
|
|
484
489
|
|
|
485
490
|
#### moveUserToSeat 接口参数:
|
|
486
|
-
|
|
|
491
|
+
| <strong>参数</strong> | <strong>类型</strong> | <strong>描述</strong> |
|
|
487
492
|
| --- | --- | --- |
|
|
488
|
-
|
|
|
489
|
-
|
|
|
490
|
-
|
|
|
493
|
+
| <code>userID</code> | <code>String</code> | 需要移麦的用户 <code>userID</code>。 |
|
|
494
|
+
| <code>targetIndex</code> | <code>int</code> | 目标麦位索引。 |
|
|
495
|
+
| <code>policy</code> | <code>MoveSeatPolicy</code> | 目标麦位已被占用时的处理策略:<br>- <code>abortWhenOccupied</code>:目标麦位有人时放弃移动(默认策略)<br>- <code>forceReplace</code>:强制替换目标麦位上的用户,被替换的用户将会被踢下麦。<br>- <code>swapPosition</code>:与目标麦位用户交换。 |
|
|
491
496
|
|
|
492
497
|
## API 文档
|
|
493
498
|
|
|
494
499
|
关于 [CoGuestStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_live_co_guest_store/CoGuestStore-class.html) 和 [LiveSeatStore](https://tencent-rtc.github.io/TUIKit_Flutter/api_live_live_seat_store/LiveSeatStore-class.html) 及其相关类的所有公开接口、属性和方法的详细信息,请参阅 [AtomicXCore](https://tencent-rtc.github.io/TUIKit_Flutter) 框架的官方 API 文档。本指南使用到的相关 Store 如下:
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
500
|
+
|
|
501
|
+
|**Store/Component**|**功能描述**|**API 文档**|
|
|
502
|
+
|---------|---------|---------|
|
|
503
|
+
|**CoGuestStore**|观众连麦管理:连麦申请 / 邀请 / 同意 / 拒绝,连麦成员权限控制(麦克风 / 摄像头),状态同步。|[API 文档](https://tencent-rtc.github.io/TUIKit_Flutter/api_live_co_guest_store/CoGuestStore-class.html)|
|
|
504
|
+
|**LiveSeatStore**|麦位管理:静音/解除静音,锁定/解锁麦位,踢人下麦、远程控制麦上用户麦克风,麦列表状态监听。|[API 文档](https://tencent-rtc.github.io/TUIKit_Flutter/api_live_live_seat_store/LiveSeatStore-class.html)|
|
|
499
505
|
|
|
500
506
|
## 常见问题
|
|
501
507
|
|
|
502
508
|
### 语音房连麦和视频直播连麦的实现有何不同?
|
|
503
509
|
|
|
504
510
|
两者的主要区别在于业务形态与 UI 展现:
|
|
505
|
-
- 视频直播:核心是视频画面。您会使用 `LiveCoreWidget` 作为核心组件来渲染主播和连麦观众的视频流。UI 的重点是处理视频画面的布局、大小,以及通过 `VideoViewDelegate`
|
|
511
|
+
- 视频直播:核心是视频画面。您会使用 `LiveCoreWidget` 作为核心组件来渲染主播和连麦观众的视频流。UI 的重点是处理视频画面的布局、大小,以及通过 `VideoViewDelegate` 在视频流上添加挂件(例如昵称、占位图)。您可以同时打开摄像头、麦克风。
|
|
506
512
|
|
|
507
513
|
- 语音房(语聊房):核心是麦位网格。您不会使用 `LiveCoreWidget`,而是会基于 `LiveSeatStore` 的 `liveSeatState`(特别是 `seatList`)来构建一个网格 UI(例如 `GridView`)。UI 的重点是实时显示每个麦位 `SeatInfo` 的状态:是否有人、是否静音、是否被锁定,以及是否正在说话。您只需要打开麦克风。
|
|
508
514
|
|
|
509
|
-
### 如何在 UI
|
|
515
|
+
### 如何在 UI 上实时刷新麦位信息(例如是否有人、是否静音)?
|
|
510
516
|
|
|
511
517
|
您应该订阅 `LiveSeatState` 中的 `seatList` 属性,它是一个 `ValueListenable<List<SeatInfo>>` 类型的响应式数据,每当数组变化时都会通知您重新渲染麦位列表。遍历此数组,您可以:
|
|
512
518
|
- 通过 `seatInfo.userInfo` 来获取麦位上的用户信息。
|