@tencentcloud/sdk-mcp 1.6.4 → 1.6.6
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/knowledge/build-index.js +1 -1
- package/knowledge/chunker.js +81 -52
- package/knowledge/path-meta.js +181 -21
- package/knowledge/search/exact-lookup.js +245 -43
- package/knowledge/search/filter-pool.js +73 -19
- package/knowledge/search/product-scope-intent.js +2 -2
- package/knowledge/search/requires-framework.js +1 -1
- package/knowledge/search/search-knowledge.js +246 -60
- package/package.json +1 -1
- package/resource/_schema/feature-aliases.yaml +1 -0
- package/resource/integration/callkit/preset/android/integration.md +3 -5
- package/resource/integration/callkit/preset/flutter/integration.md +2 -3
- package/resource/integration/callkit/preset/ios/integration.md +2 -5
- package/resource/integration/callkit/preset/react/integration.md +12 -26
- package/resource/integration/callkit/preset/vue/integration.md +17 -33
- package/resource/integration/chat/preset/android/integration.md +44 -14
- package/resource/integration/chat/preset/flutter/integration.md +54 -13
- package/resource/integration/chat/preset/ios/integration.md +42 -6
- package/resource/integration/chat/preset/react/integration.md +30 -28
- package/resource/integration/chat/preset/uni-app/integration.md +101 -40
- package/resource/integration/chat/preset/vue/integration.md +62 -28
- package/resource/integration/livekit/preset/live/android/live-audience-integration.md +133 -0
- package/resource/integration/livekit/preset/live/android/live-host-integration.md +225 -0
- package/resource/integration/livekit/preset/live/android/live-list-integration.md +278 -0
- package/resource/integration/livekit/preset/live/android/prepare-integration.md +271 -0
- package/resource/integration/livekit/preset/live/ios/live-audience-integration.md +207 -0
- package/resource/integration/livekit/preset/live/ios/live-host-integration.md +358 -0
- package/resource/integration/livekit/preset/live/ios/live-list-integration.md +246 -0
- package/resource/integration/livekit/preset/live/ios/prepare-integration.md +218 -0
- package/resource/integration/livekit/preset/live/vue/live-list-integration.md +4 -7
- package/resource/integration/livekit/preset/live/vue/live-player-desk-integration.md +5 -12
- package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +4 -11
- package/resource/integration/livekit/preset/live/vue/live-pusher-integration.md +250 -482
- package/resource/integration/roomkit/preset/vue/integration.md +399 -106
- package/resource/knowledge/callkit/best-practice/web/callengine-invitation.md +80 -0
- package/resource/knowledge/callkit/best-practice/web/callengine-log-control.md +20 -0
- package/resource/knowledge/callkit/best-practice/web/callkit-call-vs-calls.md +116 -0
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +11 -15
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +10 -13
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +2 -4
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +10 -17
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +11 -17
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +11 -20
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +10 -15
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +9 -14
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +12 -18
- package/resource/knowledge/callkit/core-sdk/miniprogram/call-engine.md +390 -0
- package/resource/knowledge/callkit/core-sdk/miniprogram/call-event.md +317 -0
- package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +16 -22
- package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +17 -23
- package/resource/knowledge/callkit/core-sdk/web/call-engine.md +39 -0
- package/resource/knowledge/callkit/core-sdk/web/call-event.md +341 -0
- package/resource/knowledge/callkit/core-sdk/web/callengine-api-overview.md +39 -0
- package/resource/knowledge/callkit/faq/android.md +1 -5
- package/resource/knowledge/callkit/faq/common.md +10 -12
- package/resource/knowledge/callkit/faq/ios.md +5 -7
- package/resource/knowledge/callkit/faq/uniapp-app.md +7 -7
- package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +9 -12
- package/resource/knowledge/callkit/faq/web.md +2 -12
- package/resource/knowledge/callkit/preset/android/api.md +5 -8
- package/resource/knowledge/callkit/preset/ios/api.md +4 -6
- package/resource/knowledge/callkit/preset/miniprogram/api.md +295 -0
- package/resource/knowledge/callkit/preset/react/api.md +622 -0
- package/resource/knowledge/callkit/preset/react/uikit-api-reference.md +475 -0
- package/resource/knowledge/callkit/preset/vue/api.md +622 -0
- package/resource/knowledge/callkit/preset/vue/uikit-api-reference.md +587 -0
- package/resource/knowledge/callkit/preset/web/api.md +1 -1
- package/resource/knowledge/chat/best-practice/web/image-message-url-handling.md +16 -0
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +1 -1
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +0 -1
- package/resource/knowledge/chat/preset/android/features/language.md +2 -4
- package/resource/knowledge/chat/preset/android/features/message-input.md +1 -1
- package/resource/knowledge/chat/preset/android/features/message-list.md +1 -2
- package/resource/knowledge/chat/preset/android/features/search.md +0 -1
- package/resource/knowledge/chat/preset/android/features/theme.md +1 -1
- package/resource/knowledge/chat/preset/android-view/integration.md +35 -10
- package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +0 -1
- package/resource/knowledge/chat/preset/flutter/features/language.md +1 -1
- package/resource/knowledge/chat/preset/flutter/features/message-list.md +0 -1
- package/resource/knowledge/chat/preset/flutter/features/search.md +4 -5
- package/resource/knowledge/chat/preset/flutter/features/theme.md +1 -1
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +1 -1
- package/resource/knowledge/chat/preset/ios/features/conversation-list.md +0 -1
- package/resource/knowledge/chat/preset/ios/features/language.md +2 -5
- package/resource/knowledge/chat/preset/ios/features/message-list.md +0 -1
- package/resource/knowledge/chat/preset/ios/features/search.md +0 -1
- package/resource/knowledge/chat/preset/ios/features/theme.md +1 -1
- package/resource/knowledge/chat/preset/ios-uikit/integration.md +57 -166
- package/resource/knowledge/chat/preset/react/features/chat-setting.md +0 -1
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +3 -3
- package/resource/knowledge/chat/preset/react/features/conversation-list.md +3 -3
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +1 -1
- package/resource/knowledge/chat/preset/react/features/message-input.md +2 -3
- package/resource/knowledge/chat/preset/react/features/search.md +0 -1
- package/resource/knowledge/chat/preset/vue/features/chat-header.md +1 -1
- package/resource/knowledge/chat/preset/vue/features/chat-setting.md +3 -4
- package/resource/knowledge/chat/preset/vue/features/conversation-list.md +4 -4
- package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +1 -1
- package/resource/knowledge/chat/preset/vue/features/message-input.md +2 -2
- package/resource/knowledge/chat/preset/vue/features/message-list.md +2 -2
- package/resource/knowledge/chat/preset/vue/features/search.md +0 -1
- package/resource/knowledge/chat/preset/vue/features/theme.md +4 -4
- package/resource/knowledge/chat/urls/sdk/android.md +3 -3
- package/resource/knowledge/chat/urls/sdk/flutter.md +3 -3
- package/resource/knowledge/chat/urls/sdk/ios.md +3 -3
- package/resource/knowledge/chat/urls/sdk/web.md +3 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +2 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +12 -15
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +1 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +3 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +12 -15
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +1 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +2 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +3 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +1 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/vue/capability-matrix.md +82 -0
- package/resource/knowledge/livekit/core-sdk/{voice/android/voice-audio-effect.md → features/android/audio-effect.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/{live/android/live-barrage.md → features/android/barrage.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{live/android/live-base-beauty.md → features/android/base-beauty.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{voice/android/voice-gift.md → features/android/gift.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/{live/android/live-live-list.md → features/android/live-list.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{live/flutter/live-audio-effect.md → features/flutter/audio-effect.md} +0 -2
- package/resource/knowledge/livekit/core-sdk/{voice/flutter/voice-barrage.md → features/flutter/barrage.md} +3 -3
- package/resource/knowledge/livekit/core-sdk/{voice/flutter/voice-gift.md → features/flutter/gift.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/{voice/flutter/voice-room-list.md → features/flutter/live-list.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-audience-list.md → features/ios/audience-list.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-audio-effect.md → features/ios/audio-effect.md} +1 -3
- package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-barrage.md → features/ios/barrage.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/{live/ios/live-base-beauty.md → features/ios/base-beauty.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{live/ios/live-gift.md → features/ios/gift.md} +8 -9
- package/resource/knowledge/livekit/core-sdk/{live/ios/live-live-list.md → features/ios/live-list.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-audio-effect.md → features/uni-app/audio-effect.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-barrage.md → features/uni-app/barrage.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/features/uni-app/base-beauty.md +145 -0
- package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-gift.md → features/uni-app/gift.md} +6 -7
- package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-room-list.md → features/uni-app/live-list.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/live/android/{live-co-guest-interaction.md → co-guest-interaction.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/live/android/{live-host-interaction.md → host-interaction.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/live/android/{live-integration.md → integration.md} +6 -9
- package/resource/knowledge/livekit/core-sdk/live/flutter/{live-host-interaction.md → host-interaction.md} +1 -3
- package/resource/knowledge/livekit/core-sdk/live/flutter/{live-integration.md → integration.md} +1 -6
- package/resource/knowledge/livekit/core-sdk/live/ios/{live-co-guest-interaction.md → co-guest-interaction.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/live/ios/{live-host-interaction.md → host-interaction.md} +3 -5
- package/resource/knowledge/livekit/core-sdk/live/ios/{live-integration.md → integration.md} +7 -10
- package/resource/knowledge/livekit/core-sdk/live/uni-app/co-guest-interaction.md +561 -0
- package/resource/knowledge/livekit/core-sdk/live/uni-app/host-interaction.md +323 -0
- package/resource/knowledge/livekit/core-sdk/live/uni-app/integration.md +312 -0
- package/resource/knowledge/livekit/core-sdk/voice/android/{voice-co-guest-interaction.md → co-guest-interaction.md} +3 -3
- package/resource/knowledge/livekit/core-sdk/voice/android/{voice-host-interaction.md → host-interaction.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/voice/android/{voice-integration.md → integration.md} +11 -14
- package/resource/knowledge/livekit/core-sdk/voice/flutter/{voice-co-guest-interaction.md → co-guest-interaction.md} +0 -1
- package/resource/knowledge/livekit/core-sdk/voice/flutter/{voice-integration.md → integration.md} +1 -4
- package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-co-guest-interaction.md → co-guest-interaction.md} +3 -3
- package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-host-interaction.md → host-interaction.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-integration.md → integration.md} +7 -10
- package/resource/knowledge/livekit/core-sdk/voice/uni-app/{voice-co-guest-interaction.md → co-guest-interaction.md} +6 -6
- package/resource/knowledge/livekit/core-sdk/voice/uni-app/{voice-integration.md → integration.md} +6 -7
- package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +2 -3
- package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +1 -1
- package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +1 -1
- package/resource/knowledge/push/api-reference/android.md +337 -0
- package/resource/knowledge/push/api-reference/donut.md +190 -0
- package/resource/knowledge/push/api-reference/flutter.md +176 -0
- package/resource/knowledge/push/api-reference/harmonyos.md +140 -0
- package/resource/knowledge/push/api-reference/ios.md +537 -0
- package/resource/knowledge/push/api-reference/react-native.md +154 -0
- package/resource/knowledge/push/api-reference/uni-app.md +148 -0
- package/resource/knowledge/push/api-reference/unity.md +119 -0
- package/resource/knowledge/push/api-reference/unreal-engine.md +123 -0
- package/resource/knowledge/push/config/android/fcm.md +1 -8
- package/resource/knowledge/push/config/android/honor.md +3 -7
- package/resource/knowledge/push/config/android/huawei.md +0 -5
- package/resource/knowledge/push/config/android/meizu.md +0 -5
- package/resource/knowledge/push/config/android/oppo.md +0 -4
- package/resource/knowledge/push/config/android/vivo.md +0 -4
- package/resource/knowledge/push/config/android/xiaomi.md +0 -2
- package/resource/knowledge/push/config/donut.md +33 -46
- package/resource/knowledge/push/config/harmonyos.md +6 -9
- package/resource/knowledge/push/config/ios.md +2 -9
- package/resource/knowledge/push/config/react-native.md +17 -25
- package/resource/knowledge/push/config/unity.md +16 -24
- package/resource/knowledge/push/config/unreal-engine.md +16 -24
- package/resource/knowledge/push/integration/android.md +21 -21
- package/resource/knowledge/push/integration/donut.md +24 -34
- package/resource/knowledge/push/integration/flutter.md +12 -1
- package/resource/knowledge/push/integration/harmonyos.md +2 -1
- package/resource/knowledge/push/integration/ios.md +16 -10
- package/resource/knowledge/push/integration/react-native.md +10 -14
- package/resource/knowledge/push/integration/uni-app.md +10 -6
- package/resource/knowledge/push/integration/unity.md +19 -22
- package/resource/knowledge/push/integration/unreal-engine.md +7 -9
- package/resource/knowledge/push/overview/prepare.md +2 -2
- package/resource/knowledge/roomkit/core-sdk/android/capability-matrix.md +46 -0
- package/resource/knowledge/roomkit/core-sdk/android/unsupported-features.md +82 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/capability-matrix.md +46 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/flutter/unsupported-features.md +82 -0
- package/resource/knowledge/roomkit/core-sdk/ios/capability-matrix.md +46 -0
- package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/ios/unsupported-features.md +82 -0
- package/resource/knowledge/roomkit/core-sdk/vue/call-user-to-room.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +2 -5
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +0 -3
- package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +2 -6
- package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +0 -1
- package/resource/knowledge/roomkit/core-sdk/vue/schedule-room.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +2 -4
- package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +2 -3
- package/resource/knowledge/roomkit/preset/android/integration.md +14 -16
- package/resource/knowledge/roomkit/preset/flutter/integration.md +9 -17
- package/resource/knowledge/roomkit/preset/ios/integration.md +9 -17
- package/resource/knowledge/roomkit/preset/react/integration.md +0 -4
- package/resource/knowledge/trtc/android/TRTCCloud.md +97 -180
- package/resource/knowledge/trtc/android/TRTCCloudDef.md +20 -20
- package/resource/knowledge/trtc/android/TRTCCloudListener.md +43 -77
- package/resource/knowledge/trtc/android/TRTCStatistics.md +1 -1
- package/resource/knowledge/trtc/android/TXAudioEffectManager.md +4 -24
- package/resource/knowledge/trtc/android/TXDeviceManager.md +2 -2
- package/resource/knowledge/trtc/android/TXLiteAVCode.md +1 -1
- package/resource/knowledge/trtc/c++/ITRTCCloud.md +96 -189
- package/resource/knowledge/trtc/c++/ITRTCStatistics.md +1 -1
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +1 -21
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +4 -6
- package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +42 -76
- package/resource/knowledge/trtc/c++/TRTCTypeDef.md +18 -19
- package/resource/knowledge/trtc/c++/TXLiteAVCode.md +1 -1
- package/resource/knowledge/trtc/ios/TRTCCloud.md +95 -181
- package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +43 -78
- package/resource/knowledge/trtc/ios/TRTCStatistics.md +1 -1
- package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +1 -20
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +4 -6
- package/resource/knowledge/trtc/ios/TXLiteAVCode.md +1 -1
- package/resource/knowledge/trtc/ios/TXLiveSDKTypeDef.md +20 -20
- package/server.js +2 -2
- package/tools/common/finalize_answer.js +1 -1
- package/tools/common/present_framework_choice.js +2 -2
- package/tools/common/search_trtc_knowledge.js +3 -3
- package/tools/common/submit_feedback.js +1 -1
- package/tools/definitions/get_native_live_uikit_integration_def.js +60 -0
- package/tools/definitions/get_native_livekit_core_integration_def.js +1 -1
- package/tools/definitions/present_framework_choice_def.js +2 -2
- package/tools/definitions/search_trtc_knowledge_def.js +5 -5
- package/tools/index.js +2 -0
- package/tools/live/get_native_live_uikit_integration.js +69 -0
- package/tools/live/get_native_livekit_core_integration.js +6 -6
- package/utils/report-cls-client.js +1 -1
- package/utils/report-es-client.js +1 -1
- package/resource/index/component-slugs.json +0 -1
- package/resource/index/doc-source-urls.json +0 -1
- package/resource/index/manifest.json +0 -1
- package/resource/knowledge/livekit/core-sdk/live/android/live-audio-effect.md +0 -229
- package/resource/knowledge/livekit/core-sdk/live/android/live-gift.md +0 -459
- package/resource/knowledge/livekit/core-sdk/live/flutter/live-barrage.md +0 -506
- package/resource/knowledge/livekit/core-sdk/live/flutter/live-gift.md +0 -427
- package/resource/knowledge/livekit/core-sdk/live/flutter/live-live-list.md +0 -726
- package/resource/knowledge/livekit/core-sdk/live/ios/live-audience-list.md +0 -265
- package/resource/knowledge/livekit/core-sdk/live/ios/live-audio-effect.md +0 -214
- package/resource/knowledge/livekit/core-sdk/live/ios/live-barrage.md +0 -427
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-audience-list.md +0 -272
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-barrage.md +0 -486
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-room-list.md +0 -523
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audience-list.md +0 -262
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audio-effect.md +0 -600
- package/resource/knowledge/livekit/core-sdk/voice/ios/voice-gift.md +0 -411
- package/resource/knowledge/livekit/core-sdk/voice/ios/voice-room-list.md +0 -404
- /package/resource/knowledge/livekit/core-sdk/api-reference/{web → vue}/index.md +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/android/live-audience-list.md → features/android/audience-list.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/flutter/live-audience-list.md → features/flutter/audience-list.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/flutter/live-base-beauty.md → features/flutter/base-beauty.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{voice/uni-app/voice-audience-list.md → features/uni-app/audience-list.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/live/flutter/{live-co-guest-interaction.md → co-guest-interaction.md} +0 -0
|
@@ -4,13 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
> **重要:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> 使用 **create(liveID:)** 工厂方法创建 `LiveSeatStore` 实例,需要传入有效的直播间 ID。
|
|
9
8
|
>
|
|
10
9
|
|
|
11
10
|
> **说明:**
|
|
12
11
|
>
|
|
13
|
-
|
|
14
12
|
> 麦位状态更新通过 **state** 发布者传递。订阅它以接收房间内麦位数据的实时更新。
|
|
15
13
|
>
|
|
16
14
|
|
|
@@ -31,7 +29,7 @@
|
|
|
31
29
|
|---------|---------|---------|
|
|
32
30
|
|seatList|[SeatInfo]|麦位列表。|
|
|
33
31
|
|canvas|LiveCanvas|画布信息。|
|
|
34
|
-
|speakingUsers|[String:Int]|正在说话的用户。|
|
|
32
|
+
|speakingUsers|[String: Int]|正在说话的用户。|
|
|
35
33
|
|avStatistics|[AVStatistics]|音视频相关统计信息。|
|
|
36
34
|
|
|
37
35
|
## API 列表
|
|
@@ -430,5 +428,5 @@ LiveSeatStore 对外提供的麦位状态数据。
|
|
|
430
428
|
|---------|---------|---------|
|
|
431
429
|
|seatList|[SeatInfo]|麦位列表。|
|
|
432
430
|
|canvas|LiveCanvas|画布信息。|
|
|
433
|
-
|speakingUsers|[String:Int]|正在说话的用户。|
|
|
431
|
+
|speakingUsers|[String: Int]|正在说话的用户。|
|
|
434
432
|
|avStatistics|[AVStatistics]|音视频相关统计信息。|
|
|
@@ -4,13 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
> **重要:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> 使用 **shared** 单例对象访问 `LoginStore` 实例。
|
|
9
8
|
>
|
|
10
9
|
|
|
11
10
|
> **说明:**
|
|
12
11
|
>
|
|
13
|
-
|
|
14
12
|
> 登录状态更新通过 **state** 发布者传递。订阅它以接收登录状态的实时更新。
|
|
15
13
|
>
|
|
16
14
|
|
|
@@ -175,7 +173,7 @@ public func setSelfInfo(userProfile: UserProfile, completion: CompletionClosure?
|
|
|
175
173
|
|level|UInt32?|等级,该字段无业务限制,您可以放心使用任意合法的整数值。|
|
|
176
174
|
|birthday|UInt32?|生日,该字段无业务限制,您可以放心使用任意合法的整数值。|
|
|
177
175
|
|allowType|AllowType?|好友验证方式。|
|
|
178
|
-
|customInfo|[String:Data]?|自定义信息。|
|
|
176
|
+
|customInfo|[String: Data]?|自定义信息。|
|
|
179
177
|
|
|
180
178
|
### LoginState
|
|
181
179
|
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# AtomicX Core Web (Vue) 能力矩阵
|
|
2
|
+
|
|
3
|
+
本文用于说明 `knowledge/livekit/core-sdk/api-reference/vue/` 在 MCP 知识库中的能力边界。
|
|
4
|
+
|
|
5
|
+
## 当前能力概览
|
|
6
|
+
|
|
7
|
+
支持的 state(来自 `index.md`):
|
|
8
|
+
- `LoginState`
|
|
9
|
+
- `DeviceState`
|
|
10
|
+
- `LiveListState`
|
|
11
|
+
- `LiveSeatState`
|
|
12
|
+
- `LiveAudienceState`
|
|
13
|
+
- `LiveMonitorState`
|
|
14
|
+
- `CoGuestState`
|
|
15
|
+
- `CoHostState`
|
|
16
|
+
- `BattleState`
|
|
17
|
+
- `BarrageState`
|
|
18
|
+
- `MessageListState`
|
|
19
|
+
- `MessageInputState`
|
|
20
|
+
- `MessageActionState`
|
|
21
|
+
- `ConversationListState`
|
|
22
|
+
- `ContactListState`
|
|
23
|
+
- `C2CSettingState`
|
|
24
|
+
- `GroupSettingState`
|
|
25
|
+
- `VideoMixerState`
|
|
26
|
+
- `VirtualBackgroundState`
|
|
27
|
+
- `ASRState`
|
|
28
|
+
- `SearchState`
|
|
29
|
+
- `SeatStore`
|
|
30
|
+
|
|
31
|
+
## 能力矩阵
|
|
32
|
+
|
|
33
|
+
### 1. 参照 Android 13 个 Store 逐项对照
|
|
34
|
+
|
|
35
|
+
| 能力(Android Store) | Android Core | Web (Vue) Core | 替代路径 |
|
|
36
|
+
| --- | --- | --- | --- |
|
|
37
|
+
| 登录管理 `LoginStore` | ✅ | ✅ | 直接参考 `index.md` 的 `LoginState` |
|
|
38
|
+
| 设备状态 `DeviceStore` | ✅ | ✅ | 直接参考 `index.md` 的 `DeviceState`(web 端粒度更细:mic / camera / speaker / screen / network) |
|
|
39
|
+
| 直播列表 `LiveListStore`(android 无独立 store,能力由其他 store 提供) | ⚠️ 间接 | ✅ | 直接参考 `index.md` 的 `LiveListState`(web 端独立 state,接口更完整:`createLive` / `joinLive` / `fetchLiveList` 等) |
|
|
40
|
+
| 麦位管理 `LiveSeatStore` | ✅ | ✅ | 直接参考 `index.md` 的 `LiveSeatState`(web 端额外提供 `SeatStore` 底层存储) |
|
|
41
|
+
| 观众管理 `LiveAudienceStore` | ✅ | ✅ | 直接参考 `index.md` 的 `LiveAudienceState` |
|
|
42
|
+
| 连麦嘉宾 `CoGuestStore` | ✅ | ✅ | 直接参考 `index.md` 的 `CoGuestState` |
|
|
43
|
+
| 连麦主播 `CoHostStore` | ✅ | ✅ | 直接参考 `index.md` 的 `CoHostState` |
|
|
44
|
+
| PK 对战 `BattleStore` | ✅ | ✅ | 直接参考 `index.md` 的 `BattleState` |
|
|
45
|
+
| 弹幕 `BarrageStore` | ✅ | ✅ | 直接参考 `index.md` 的 `BarrageState` |
|
|
46
|
+
| 音效 `AudioEffectStore` | ✅ | ❌ 不支持 | 当前 Web Core 暂无该能力;若需音效处理,建议使用 Web 端 Web Audio API 自实现 |
|
|
47
|
+
| 礼物 `GiftStore` | ✅ | ❌ 不支持 | 当前 Web Core 暂无礼物能力;如需礼物打赏,建议参考 Web 端自定义消息方案 |
|
|
48
|
+
| 点赞 `LikeStore` | ✅ | ❌ 不支持 | 当前 Web Core 暂无点赞能力;如需点赞交互,建议自行接入 |
|
|
49
|
+
| 相机视图 `CameraView` | ✅ | ❌ 不支持 | 当前 Web Core 暂无独立相机视图组件;如需本地预览,使用 Web 原生 `<video>` 标签 + TRTC 原生 SDK |
|
|
50
|
+
| 主播核心视图 `LiveCoreView` | ✅ | ❌ 不支持 | 当前 Web Core 暂无统一主视图;推荐使用 `TUILiveRoom` / `TUIPlayer` 等预制 UI 组件 |
|
|
51
|
+
|
|
52
|
+
### 2. Web 端独有 state(Android 参照标准外)
|
|
53
|
+
|
|
54
|
+
下列 state 在 Web (Vue) 端独立存在,Android / iOS / Flutter Core **未提供对应 store**。如需在多端保持一致的体验,需要分别在 Web 端实现,**禁止直接套用其他平台的 API**。
|
|
55
|
+
|
|
56
|
+
| Web 独有能力 | 对应 state | Android Core 对应情况 |
|
|
57
|
+
| --- | --- | --- |
|
|
58
|
+
| 直播监控 `LiveMonitorState` | 支持 | ❌ Android Core 无对应 store |
|
|
59
|
+
| 视频混流 `VideoMixerState` | 支持 | ❌ Android Core 无对应 store |
|
|
60
|
+
| 虚拟背景 `VirtualBackgroundState` | 支持 | ❌ Android Core 无对应 store |
|
|
61
|
+
| 语音识别 `ASRState` | 支持 | ❌ Android Core 无对应 store |
|
|
62
|
+
| 全局搜索 `SearchState` | 支持 | ❌ Android Core 无对应 store |
|
|
63
|
+
| 消息列表 `MessageListState` | 支持 | ❌ Android Core 无对应 store;属于 IM / Chat 域 |
|
|
64
|
+
| 消息输入 `MessageInputState` | 支持 | ❌ Android Core 无对应 store;属于 IM / Chat 域 |
|
|
65
|
+
| 消息操作 `MessageActionState` | 支持 | ❌ Android Core 无对应 store;属于 IM / Chat 域 |
|
|
66
|
+
| 会话列表 `ConversationListState` | 支持 | ❌ Android Core 无对应 store;属于 IM / Chat 域 |
|
|
67
|
+
| 联系人列表 `ContactListState` | 支持 | ❌ Android Core 无对应 store;属于 IM / Chat 域 |
|
|
68
|
+
| 单聊设置 `C2CSettingState` | 支持 | ❌ Android Core 无对应 store;属于 IM / Chat 域 |
|
|
69
|
+
| 群聊设置 `GroupSettingState` | 支持 | ❌ Android Core 无对应 store;属于 IM / Chat 域 |
|
|
70
|
+
|
|
71
|
+
## 回答口径
|
|
72
|
+
|
|
73
|
+
当用户询问 Web (Vue) AtomicX Core 是否支持上述 ❌ 能力时:
|
|
74
|
+
1. 必须先明确回答 **不支持**;
|
|
75
|
+
2. 必须说明这是当前 Web Core 文档树中的能力边界,而不是“暂时没找到示例”;
|
|
76
|
+
3. 禁止输出 Web Core 下的伪造 API 调用步骤;
|
|
77
|
+
4. 仅可提供当前平台已支持的替代路径,例如使用 Web 原生 API / 预制 UI 组件;若无明确替代方案,应直接说明暂无可执行路径。
|
|
78
|
+
|
|
79
|
+
当用户询问其他平台(Android / iOS / Flutter)的 ❌ 能力在 Web 端是否可用时:
|
|
80
|
+
1. **必须先回答 web 端不支持**(如上表所示);
|
|
81
|
+
2. **禁止反推**其他平台该能力在 Web 端存在等价 store;
|
|
82
|
+
3. 即使 Web 端 `index.md` 中存在名称相近的 state(如 `MessageListState`),也属于 IM / Chat 域而非 Live Core 域,**不要混为一谈**。
|
|
@@ -44,7 +44,6 @@ val deviceStore = DeviceStore.shared()
|
|
|
44
44
|
|
|
45
45
|
> **注意:**
|
|
46
46
|
>
|
|
47
|
-
|
|
48
47
|
> 耳返功能通常需要连接耳机才能正常工作。
|
|
49
48
|
>
|
|
50
49
|
|
|
@@ -170,7 +169,6 @@ audioEffectStore.setAudioReverbType(AudioReverbType.NONE)
|
|
|
170
169
|
|
|
171
170
|
> **重要:**
|
|
172
171
|
>
|
|
173
|
-
|
|
174
172
|
> `AudioEffectStore` 和 `DeviceStore` 是单例,这意味着音效和设备设置是全局生效的,如果您在当前直播间的设置不想影响到您创建的其他直播间,就需要在当前直播间结束的时候重置音效和设备设置。
|
|
175
173
|
>
|
|
176
174
|
|
|
@@ -196,7 +194,7 @@ audioEffectStore.setAudioReverbType(AudioReverbType.NONE)
|
|
|
196
194
|
|**Store/Component**|**功能描述**|**API 文档**|
|
|
197
195
|
|---------|---------|---------|
|
|
198
196
|
|**AudioEffectStore**|音效管理:进行音效设置,并获取实时音效状态。|[API 文档](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.device/-audio-effect-store/index.html)|
|
|
199
|
-
|**DeviceStore
|
|
197
|
+
|**DeviceStore** |设备管理:进行摄像头、麦克风操作,并获取实时设备状态。|[API 文档](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.device/-device-store/index.html)|
|
|
200
198
|
|
|
201
199
|
## 常见问题
|
|
202
200
|
|
|
@@ -209,7 +207,7 @@ audioEffectStore.setAudioReverbType(AudioReverbType.NONE)
|
|
|
209
207
|
这是一个非常重要且易混淆的概念,区别如下:
|
|
210
208
|
- **人声音量 (CaptureVolume):**通过 `DeviceStore.setCaptureVolume()` 设置**。它决定了观众**能听到的您的声音大小。
|
|
211
209
|
|
|
212
|
-
- **耳返音量 (EarMonitorVolume):**通过 `AudioEffectStore.setVoiceEarMonitorVolume()
|
|
210
|
+
- **耳返音量 (EarMonitorVolume):**通过 `AudioEffectStore.setVoiceEarMonitorVolume()` **设置。它只**决定了**您自己**在耳机里听到的监听声音大小,**不会**影响观众。
|
|
213
211
|
|
|
214
212
|
### **新创建的直播间为什么直接就有音效、或者出现音量很大、很小等问题?**
|
|
215
213
|
|
|
@@ -471,7 +471,7 @@ class BarrageViewHolder(
|
|
|
471
471
|
在控制台的配置页面中,找到**查看直播间历史消息**选项,修改其配置(最大支持 **50** 条消息)。
|
|
472
472
|
- 若您的应用在 [实时音视频控制台](https://console.cloud.tencent.com/trtc/app) 创建,配置步骤如下:
|
|
473
473
|
|
|
474
|
-
左侧导航栏选择**应用管理** >
|
|
474
|
+
左侧导航栏选择**应用管理** > **功能配置** > **LiveKit 功能**,在**应用管理**选择对应的应用后,单击**查看直播间历史消息 > 编辑**。
|
|
475
475
|
|
|
476
476
|
- 若您的应用在 [即时通信 IM 控制台](https://console.cloud.tencent.com/im/rtc-config) 创建,配置步骤如下:
|
|
477
477
|
|
|
@@ -96,7 +96,7 @@ class BeautyManager() {
|
|
|
96
96
|
#### 实现方式:
|
|
97
97
|
1. **获取强度值**:从 UI 控件(例如 `SeekBar`)获取用户设定的强度值。请注意,SDK 接口接收的参数范围是 `[0, 9]`,其中 `0` 表示关闭效果,`9` 表示效果最明显。您需要将 UI 控件的值(例如 SeekBar 的 `0 - 100`)映射到 `0 - 9` 的范围。
|
|
98
98
|
|
|
99
|
-
2. **调用接口**:分别调用 `setSmoothLevel(smoothLevel:)`、`setWhitenessLevel(whitenessLevel:)`、`setRuddyLevel(ruddyLevel:)
|
|
99
|
+
2. **调用接口**:分别调用 `setSmoothLevel(smoothLevel:)`、`setWhitenessLevel(whitenessLevel:)`、`setRuddyLevel(ruddyLevel:)` 来设置磨皮、美白、红润的强度。
|
|
100
100
|
|
|
101
101
|
#### 代码示例:
|
|
102
102
|
``` kotlin
|
package/resource/knowledge/livekit/core-sdk/{voice/android/voice-gift.md → features/android/gift.md}
RENAMED
|
@@ -29,7 +29,6 @@
|
|
|
29
29
|
|
|
30
30
|
> **说明:**
|
|
31
31
|
>
|
|
32
|
-
|
|
33
32
|
> 使用**礼物系统**要求开通TUILiveKit **多人连麦版**、**大规模直播版**,不同套餐中可配置的礼物数量有所不同,详细参见 功能与计费说明 中的**礼物系统**说明。
|
|
34
33
|
>
|
|
35
34
|
|
|
@@ -100,7 +99,7 @@ class GiftManager(
|
|
|
100
99
|
```
|
|
101
100
|
|
|
102
101
|
#### 礼物列表结构体参数
|
|
103
|
-
- `GiftCategory
|
|
102
|
+
- `GiftCategory` **参数说明**
|
|
104
103
|
|
|
105
104
|
|**参数**|**类型**|**描述**|
|
|
106
105
|
|---------|---------|---------|
|
|
@@ -110,7 +109,7 @@ class GiftManager(
|
|
|
110
109
|
|`extensionInfo`|`Map<String, String>`|扩展信息字段。|
|
|
111
110
|
|`giftList`|`List`|该分类下包含的 Gift 礼物对象数组。|
|
|
112
111
|
|
|
113
|
-
- `Gift
|
|
112
|
+
- `Gift` **参数说明**
|
|
114
113
|
|
|
115
114
|
|**参数**|**类型**|**描述**|
|
|
116
115
|
|---------|---------|---------|
|
|
@@ -390,7 +390,7 @@ class LiveFeedActivity : AppCompatActivity() {
|
|
|
390
390
|
|
|
391
391
|
#### 实现方式
|
|
392
392
|
|
|
393
|
-
主播端将当前商品的结构化信息(建议使用 **JSON
|
|
393
|
+
主播端将当前商品的结构化信息(建议使用 **JSON** 格式)通过 `updateLiveMetaData` 接口设置到一个自定义的 key(例如 "`product_info`")中。**AtomicXCore** 会将这个变更实时同步给所有观众。观众端只需订阅 `LiveListStore.liveState.currentLive`,监听 `metaData` 的变化,一旦发现 `product_info` 的值更新,就解析其中的 JSON 数据并刷新商品卡片 UI。
|
|
394
394
|
|
|
395
395
|
#### 代码示例
|
|
396
396
|
``` kotlin
|
|
@@ -45,7 +45,6 @@ class _AudioEffectPanelWidgetState {
|
|
|
45
45
|
|
|
46
46
|
> **注意:**
|
|
47
47
|
>
|
|
48
|
-
|
|
49
48
|
> 耳返功能通常需要连接耳机才能正常工作。
|
|
50
49
|
>
|
|
51
50
|
|
|
@@ -330,7 +329,6 @@ class ReverbWidget extends StatelessWidget {
|
|
|
330
329
|
|
|
331
330
|
> **重要:**
|
|
332
331
|
>
|
|
333
|
-
|
|
334
332
|
> AudioEffectStore 和 DeviceStore 是单例,即音效和设备设置会全局生效,如果您不希望当前直播间的设置影响到之后创建的其他直播间,就需要在当前直播间结束的时候重置音效和设备设置。
|
|
335
333
|
>
|
|
336
334
|
|
|
@@ -376,7 +376,7 @@ class _BarrageWidgetState extends State<BarrageWidget> {
|
|
|
376
376
|
|
|
377
377
|
SDK 会以极高频率返回完整的弹幕列表。如果每次都重建 UI,主线程会被密集的 UI 布局和渲染操作阻塞,导致界面卡顿。
|
|
378
378
|
|
|
379
|
-
####
|
|
379
|
+
#### **优化方案:** 批处理与流量削峰 (Batch Processing & Debouncing)
|
|
380
380
|
|
|
381
381
|
不必响应每一次的数据更新,而是设定一个时间阈值(例如300毫秒)。只在距离上次 UI 刷新超过这个阈值后,才执行下一次刷新操作。这能将每秒数十次的 UI 重绘,降低到每秒3-4次,极大提升流畅度。
|
|
382
382
|
``` java
|
|
@@ -491,7 +491,7 @@ void _refreshUIIfNeeded() {
|
|
|
491
491
|
在控制台的配置页面中,找到**查看直播间历史消息**选项,修改其配置(最大支持 **50** 条消息)。
|
|
492
492
|
- 若您的应用在 [实时音视频控制台](https://console.cloud.tencent.com/trtc/app) 创建,配置步骤如下:
|
|
493
493
|
|
|
494
|
-
左侧导航栏选择**应用管理** >
|
|
494
|
+
左侧导航栏选择**应用管理** > **功能配置** > **LiveKit 功能**,在**应用管理**选择对应的应用后,单击**查看直播间历史消息 > 编辑**。
|
|
495
495
|
|
|
496
496
|
- 若您的应用在 [即时通信 IM 控制台](https://console.cloud.tencent.com/im/rtc-config) 创建,配置步骤如下:
|
|
497
497
|
|
|
@@ -499,7 +499,7 @@ void _refreshUIIfNeeded() {
|
|
|
499
499
|
|
|
500
500
|
进入 **LiveKit 功能配置**后,单击**查看直播间历史消息** > **编辑**。
|
|
501
501
|
|
|
502
|
-
**步骤2
|
|
502
|
+
**步骤2:客户端无感获取**
|
|
503
503
|
|
|
504
504
|
完成上述配置后,您的客户端代码**无需做任何改动**。
|
|
505
505
|
|
package/resource/knowledge/livekit/core-sdk/{voice/flutter/voice-gift.md → features/flutter/gift.md}
RENAMED
|
@@ -96,7 +96,7 @@ class GiftManager {
|
|
|
96
96
|
```
|
|
97
97
|
|
|
98
98
|
#### 礼物列表结构体参数
|
|
99
|
-
- `GiftCategory
|
|
99
|
+
- `GiftCategory` **参数说明**
|
|
100
100
|
|
|
101
101
|
|**参数**|**类型**|**描述**|
|
|
102
102
|
|---------|---------|---------|
|
|
@@ -106,7 +106,7 @@ class GiftManager {
|
|
|
106
106
|
|`extensionInfo`|`Map<String, String>`|扩展信息字段。|
|
|
107
107
|
|`giftList`|`List<Gift>`|该分类下包含的 Gift 礼物对象数组。|
|
|
108
108
|
|
|
109
|
-
- `Gift
|
|
109
|
+
- `Gift` **参数说明**
|
|
110
110
|
|
|
111
111
|
|**参数**|**类型**|**描述**|
|
|
112
112
|
|---------|---------|---------|
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
|**核心概念**|**类型**|**核心职责与描述**|
|
|
19
19
|
|---------|---------|---------|
|
|
20
20
|
|`LiveUserInfo`|struct|代表一个观众(用户)的基础信息模型。它包含了用户的唯一标识 (`userID`)、昵称 (`userName`) 和头像地址 (`avatarURL`)。|
|
|
21
|
-
|`LiveAudienceState`|struct|代表观众模块的当前状态。其核心属性 `audienceList` 是一个 `[LiveUserInfo]
|
|
21
|
+
|`LiveAudienceState`|struct|代表观众模块的当前状态。其核心属性 `audienceList` 是一个 `[LiveUserInfo]` 数组,存储了观众列表的快照;`audienceCount` 则代表当前观众总数。|
|
|
22
22
|
|`LiveAudienceEvent`|enum|代表观众动态的实时事件。分为 `.onAudienceJoined`(观众加入) 和 `.onAudienceLeft`(观众离开)两种,用于实现对观众列表的增量更新。|
|
|
23
23
|
|`LiveAudienceStore`|class|这是与观众列表功能交互的核心管理类。通过它,您可以获取观众列表快照、执行管理操作,并通过订阅其 `liveAudienceEventPublisher` 来接收实时动态。|
|
|
24
24
|
|
|
@@ -45,7 +45,6 @@ let deviceStore = DeviceStore.shared
|
|
|
45
45
|
|
|
46
46
|
> **注意:**
|
|
47
47
|
>
|
|
48
|
-
|
|
49
48
|
> 耳返功能通常需要连接耳机才能正常工作。
|
|
50
49
|
>
|
|
51
50
|
|
|
@@ -156,7 +155,6 @@ audioEffectStore.setAudioReverbType(type: .none)
|
|
|
156
155
|
|
|
157
156
|
> **重要:**
|
|
158
157
|
>
|
|
159
|
-
|
|
160
158
|
> `AudioEffectStore` 和 `DeviceStore` 是单例,这意味着音效和设备设置是全局生效的,如果您在当前直播间的设置不想影响到您创建的其他直播间,就需要在当前直播间结束的时候重置音效和设备设置。
|
|
161
159
|
>
|
|
162
160
|
|
|
@@ -194,7 +192,7 @@ audioEffectStore.setAudioReverbType(type: .none)
|
|
|
194
192
|
这是一个非常重要且易混淆的概念,区别如下:
|
|
195
193
|
- **人声音量 (CaptureVolume):**通过 `DeviceStore.setCaptureVolume()` 设置**。它决定了观众**能听到的您的声音大小。
|
|
196
194
|
|
|
197
|
-
- **耳返音量 (EarMonitorVolume):**通过 `AudioEffectStore.setVoiceEarMonitorVolume()
|
|
195
|
+
- **耳返音量 (EarMonitorVolume):**通过 `AudioEffectStore.setVoiceEarMonitorVolume()` **设置。它只**决定了**您自己**在耳机里听到的监听声音大小,**不会**影响观众。
|
|
198
196
|
|
|
199
197
|
### **新创建的直播间为什么直接就有音效、或者出现音量很大、很小等问题?**
|
|
200
198
|
|
package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-barrage.md → features/ios/barrage.md}
RENAMED
|
@@ -412,7 +412,7 @@ class BarrageCell: UITableViewCell {
|
|
|
412
412
|
在控制台的配置页面中,找到**查看直播间历史消息**选项,修改其配置(最大支持 **50** 条消息)。
|
|
413
413
|
- 若您的应用在 [实时音视频控制台](https://console.cloud.tencent.com/trtc/app) 创建,配置步骤如下:
|
|
414
414
|
|
|
415
|
-
左侧导航栏选择**应用管理** >
|
|
415
|
+
左侧导航栏选择**应用管理** > **功能配置** > **LiveKit 功能**,在**应用管理**选择对应的应用后,单击**查看直播间历史消息 > 编辑**。
|
|
416
416
|
|
|
417
417
|
- 若您的应用在 [即时通信 IM 控制台](https://console.cloud.tencent.com/im/rtc-config) 创建,配置步骤如下:
|
|
418
418
|
|
|
@@ -420,7 +420,7 @@ class BarrageCell: UITableViewCell {
|
|
|
420
420
|
|
|
421
421
|
进入 **LiveKit 功能配置**后,单击**查看直播间历史消息** > **编辑**。
|
|
422
422
|
|
|
423
|
-
**步骤2
|
|
423
|
+
**步骤2:客户端无感获取**
|
|
424
424
|
|
|
425
425
|
完成上述配置后,您的客户端代码**无需做任何改动**。
|
|
426
426
|
|
|
@@ -73,7 +73,7 @@ class BeautyManager {
|
|
|
73
73
|
#### 实现方式
|
|
74
74
|
1. **获取强度值**:从 UI 控件(例如 `UISlider`)获取用户设定的强度值。请注意,SDK 接口接收的参数范围是 `[0, 9]`,其中 `0` 表示关闭效果,`9` 表示效果最明显。您需要将 UI 控件的值(例如 UISlider 的 `0.0 - 1.0`)映射到 `0 - 9` 的范围。
|
|
75
75
|
|
|
76
|
-
2. **调用接口**:分别调用 `setSmoothLevel(smoothLevel:)`、`setWhitenessLevel(whitenessLevel:)`、`setRuddyLevel(ruddyLevel:)
|
|
76
|
+
2. **调用接口**:分别调用 `setSmoothLevel(smoothLevel:)`、`setWhitenessLevel(whitenessLevel:)`、`setRuddyLevel(ruddyLevel:)` 来设置磨皮、美白、红润的强度。
|
|
77
77
|
|
|
78
78
|
#### 代码示例
|
|
79
79
|
``` swift
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
|**核心概念**|**类型**|**核心职责与描述**|
|
|
19
19
|
|---------|---------|---------|
|
|
20
20
|
|`Gift`|`struct`|代表一个具体的礼物数据模型。包含了礼物的 ID、名称、图标地址、动画资源地址 (resourceURL) 和价格 (coins) 等。|
|
|
21
|
-
|`GiftCategory`|`struct`|代表一个礼物分类,例如“热门”、“豪华”等。它包含了分类的名称以及该分类下的 **Gift
|
|
21
|
+
|`GiftCategory`|`struct`|代表一个礼物分类,例如“热门”、“豪华”等。它包含了分类的名称以及该分类下的 **Gift** 列表。|
|
|
22
22
|
|`GiftState`|`struct`|代表礼物模块的当前状态。其核心属性 usableGifts 是一个 [GiftCategory] 数组,存储了从服务端拉取到的完整礼物列表。|
|
|
23
23
|
|`GiftEvent`|`enum`|代表直播间内发生的礼物事件。目前只有 .onReceiveGift,当有任何人(包括自己)调用发送礼物接口时,房间内所有人都会收到此事件。|
|
|
24
24
|
|`GiftStore`|`class`|这是与礼物功能交互的核心管理类。通过它,您可以拉取礼物列表、调用发送礼物接口,并通过订阅其 giftEventPublisher 来接收礼物事件。|
|
|
@@ -29,7 +29,6 @@
|
|
|
29
29
|
|
|
30
30
|
> **说明:**
|
|
31
31
|
>
|
|
32
|
-
|
|
33
32
|
> 使用**礼物系统**要求开通TUILiveKit **多人连麦版**、**大规模直播版**,不同套餐中可配置的礼物数量有所不同,详细参见 功能与计费说明 中的**礼物系统**说明。
|
|
34
33
|
>
|
|
35
34
|
|
|
@@ -44,9 +43,9 @@
|
|
|
44
43
|
#### 实现方式:
|
|
45
44
|
1. **获取实例**:使用 `GiftStore.create(liveID:)` 获取与当前直播间绑定的 `GiftStore` 实例。
|
|
46
45
|
|
|
47
|
-
2. **订阅事件**:订阅 `giftStore.giftEventPublisher` 以接收 `.onReceiveGift
|
|
46
|
+
2. **订阅事件**:订阅 `giftStore.giftEventPublisher` 以接收 `.onReceiveGift` 事件。
|
|
48
47
|
|
|
49
|
-
3. **订阅状态**:订阅 `giftStore.state` 以获取 `usableGifts
|
|
48
|
+
3. **订阅状态**:订阅 `giftStore.state` 以获取 `usableGifts` 礼物列表。
|
|
50
49
|
|
|
51
50
|
#### 代码示例:
|
|
52
51
|
``` swift
|
|
@@ -106,7 +105,7 @@ class GiftManager {
|
|
|
106
105
|
|`extensionInfo`|`[String: String]`|扩展信息字段。|
|
|
107
106
|
|`giftList`|`[`[`Gift`](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/gift)`]`|该分类下包含的 Gift 礼物对象数组。|
|
|
108
107
|
|
|
109
|
-
- `Gift
|
|
108
|
+
- `Gift` **参数说明**
|
|
110
109
|
|
|
111
110
|
|**参数**|**类型**|**描述**|
|
|
112
111
|
|---------|---------|---------|
|
|
@@ -194,7 +193,7 @@ extension GiftManager {
|
|
|
194
193
|
|
|
195
194
|
您需要自定义直播间可用的礼物种类、分类、名称、图标、价格以及动画效果,以满足运营需求和品牌特色。
|
|
196
195
|
|
|
197
|
-
####
|
|
196
|
+
#### **实现方式**
|
|
198
197
|
1. **服务端配置**:使用 LiveKit 服务端 REST API 管理礼物信息、分类、多语言等。请参考 [礼物配置指引文档](https://cloud.tencent.com/document/product/647/121321)。
|
|
199
198
|
|
|
200
199
|
2. **客户端拉取**:在客户端调用 `refreshUsableGifts` 获取配置数据。
|
|
@@ -272,7 +271,7 @@ extension GiftManager {
|
|
|
272
271
|
```
|
|
273
272
|
2. **监听礼物事件**:订阅 `GiftStore` 的 `giftEventPublisher`。
|
|
274
273
|
|
|
275
|
-
3. **解析并播放**:当收到 `.onReceiveGift
|
|
274
|
+
3. **解析并播放**:当收到 `.onReceiveGift` 事件时,检查 `gift.resourceURL` 是否有效且指向一个 SVGA 文件。如果是,则使用 `SVGAParser` 解析 URL,并将解析后的 `SVGAVideoEntity` 交给 `SVGAPlayer` 实例播放。
|
|
276
275
|
|
|
277
276
|
#### 代码示例
|
|
278
277
|
``` swift
|
|
@@ -342,11 +341,11 @@ class LiveRoomViewController: UIViewController, SVGAPlayerDelegate {
|
|
|
342
341
|
|
|
343
342
|
2. **获取信息**:收到 `.onReceiveGift` 事件后,提取发送者 sender、礼物 gift 和数量 count。
|
|
344
343
|
|
|
345
|
-
3. **获取弹幕 Store**:使用 `BarrageStore.create(liveID:)
|
|
344
|
+
3. **获取弹幕 Store**:使用 `BarrageStore.create(liveID:)` 获取与当前房间绑定的实例。
|
|
346
345
|
|
|
347
346
|
4. **拼接消息**:创建一条 `Barrage` 结构体,设置 `messageType = .text`,textContent 为拼接好的字符串(例如 “[`sender.userName`] 送出了 [`gift.name`] x [`count`]”)。
|
|
348
347
|
|
|
349
|
-
5. **本地插入**:调用 `barrageStore.appendLocalTip(message: giftTip)
|
|
348
|
+
5. **本地插入**:调用 `barrageStore.appendLocalTip(message: giftTip)` 将消息插入本地列表。
|
|
350
349
|
|
|
351
350
|
#### 代码示例
|
|
352
351
|
``` swift
|
package/resource/knowledge/livekit/core-sdk/{live/ios/live-live-list.md → features/ios/live-list.md}
RENAMED
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
|**核心概念**|**类型**|**核心职责与描述**|
|
|
19
19
|
|---------|---------|---------|
|
|
20
20
|
|`LiveInfo`|`struct`|代表一个直播间的所有信息模型。包含了直播 ID (`liveID`)、名称 (`liveName`)、房主信息 (`liveOwner`) 以及自定义元数据 (`metaData`) 等。|
|
|
21
|
-
|`LiveListState`|`struct`|代表直播列表模块的当前状态。其核心属性 liveList 是一个 `[LiveInfo]
|
|
21
|
+
|`LiveListState`|`struct`|代表直播列表模块的当前状态。其核心属性 liveList 是一个 `[LiveInfo]` 数组,存储了拉取到的直播列表;`currentLive` 则代表用户当前所在的直播间信息。|
|
|
22
22
|
|`LiveListEvent`|`enum`|代表直播房间的全局事件。分为 `.onLiveEnded` (直播结束) 和 `.onKickedOutOfLive` (被踢出直播) 两种,用于处理关键的房间状态变更。|
|
|
23
23
|
|`LiveListStore`|`class`|这是与直播列表和房间生命周期交互的核心管理类。它是一个全局单例 (shared),负责所有直播房间的创建、加入、信息更新等操作。|
|
|
24
24
|
|
|
@@ -306,7 +306,7 @@ class LiveFeedViewController: UIViewController, UICollectionViewDataSource, UICo
|
|
|
306
306
|
|
|
307
307
|
#### 实现方式
|
|
308
308
|
|
|
309
|
-
主播端将当前商品的结构化信息(建议使用 **JSON
|
|
309
|
+
主播端将当前商品的结构化信息(建议使用 **JSON** 格式)通过 `updateLiveMetaData` 接口设置到一个自定义的 key(例如 "`product_info`")中。**AtomicXCore** 会将这个变更实时同步给所有观众。观众端只需订阅 `LiveListStore.state`,监听 `metaData` 的变化,一旦发现 `product_info` 的值更新,就解析其中的 JSON 数据并刷新商品卡片 UI。
|
|
310
310
|
|
|
311
311
|
#### 代码示例
|
|
312
312
|
``` swift
|
|
@@ -35,7 +35,6 @@ useDeviceState(liveID)
|
|
|
35
35
|
|
|
36
36
|
> **注意:**
|
|
37
37
|
>
|
|
38
|
-
|
|
39
38
|
> 耳返功能通常需要连接耳机才能正常工作。
|
|
40
39
|
>
|
|
41
40
|
|
|
@@ -89,7 +88,7 @@ watch(earMonitorVolume, (newVolume) => {
|
|
|
89
88
|
当主播希望调节自己的上行采集音量大小时,调用 `DeviceState` 的 `setCaptureVolume(volume: )` 方法传入音量值即可。
|
|
90
89
|
|
|
91
90
|
#### 实现方式:
|
|
92
|
-
1. **设置采集音量值**:您可自行实现调节音量的功能,并将 `UI
|
|
91
|
+
1. **设置采集音量值**:您可自行实现调节音量的功能,并将 `UI` 上的值映射成音量值后调用 `setCaptureVolume(volume: 80)`。请注意,该接口接收的参数范围是 `[0, 150],`所以您需要将 UI 控件的值映射到 `0 - 150` 的范围。
|
|
93
92
|
|
|
94
93
|
2. **监听状态更新 UI**:您可以订阅实时的音量状态值更新 UI。
|
|
95
94
|
|
|
@@ -187,7 +186,7 @@ const setAudioReverbType = () => {
|
|
|
187
186
|
这是一个非常重要且易混淆的概念,区别如下:
|
|
188
187
|
- **人声音量 (CaptureVolume):**通过 `setCaptureVolume()` 设置**。它决定了观众**能听到的您的声音大小。
|
|
189
188
|
|
|
190
|
-
- **耳返音量 (EarMonitorVolume):**通过 `setVoiceEarMonitorVolume()
|
|
189
|
+
- **耳返音量 (EarMonitorVolume):**通过 `setVoiceEarMonitorVolume()` **设置。它只**决定了**您自己**在耳机里听到的监听声音大小,**不会**影响观众。
|
|
191
190
|
|
|
192
191
|
### **新创建的直播间为什么直接就有音效、或者出现音量很大、很小等问题?**
|
|
193
192
|
|
|
@@ -357,7 +357,7 @@ SDK 返回的全量 `messageList` 会在长时间直播中无限增长,即使
|
|
|
357
357
|
在控制台的配置页面中,找到**查看直播间历史消息**选项,修改其配置(最大支持 **50** 条消息)。
|
|
358
358
|
- 若您的应用在 [实时音视频控制台](https://console.cloud.tencent.com/trtc/app) 创建,配置步骤如下:
|
|
359
359
|
|
|
360
|
-
左侧导航栏选择**应用管理** >
|
|
360
|
+
左侧导航栏选择**应用管理** > **功能配置** > **LiveKit 功能**,在**应用管理**选择对应的应用后,单击**查看直播间历史消息 > 编辑**。
|
|
361
361
|
|
|
362
362
|
- 若您的应用在 [即时通信 IM 控制台](https://console.cloud.tencent.com/im/rtc-config) 创建,配置步骤如下:
|
|
363
363
|
|
|
@@ -365,7 +365,7 @@ SDK 返回的全量 `messageList` 会在长时间直播中无限增长,即使
|
|
|
365
365
|
|
|
366
366
|
进入 **LiveKit 功能配置**后,单击**查看直播间历史消息** > **编辑**。
|
|
367
367
|
|
|
368
|
-
**步骤2
|
|
368
|
+
**步骤2:客户端无感获取**
|
|
369
369
|
|
|
370
370
|
完成上述配置后,您的客户端代码**无需做任何改动**。
|
|
371
371
|
|