@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
|
@@ -326,7 +326,7 @@ useEffect(() => {
|
|
|
326
326
|
|
|
327
327
|
## **示例项目**
|
|
328
328
|
|
|
329
|
-
腾讯云在 GitHub 上提供了示例项目 [
|
|
329
|
+
腾讯云在 GitHub 上提供了示例项目 [vite-vue3-ts](https://github.com/Tencent-RTC/TUIRoomKit/tree/main/Web/example/vite-vue3-ts) ,您可以参考以实现完整的 RoomKit 功能。
|
|
330
330
|
|
|
331
331
|
## API 文档
|
|
332
332
|
|
|
@@ -39,7 +39,6 @@
|
|
|
39
39
|
|
|
40
40
|
> **注意:**
|
|
41
41
|
>
|
|
42
|
-
|
|
43
42
|
> 会前设备检测用于确认设备是否可用,不代表用户已经在房间中发布音视频。用户入会后,仍需调用对应的设备控制接口,摄像头或麦克风才会被打开并在房间中发布音视频。
|
|
44
43
|
>
|
|
45
44
|
|
|
@@ -628,7 +627,6 @@ function AudioSettings() {
|
|
|
628
627
|
|
|
629
628
|
> **说明:**
|
|
630
629
|
>
|
|
631
|
-
|
|
632
630
|
> 扬声器设备切换依赖浏览器能力。部分浏览器可能无法获取扬声器列表或无法切换播放设备,建议在列表为空或切换失败时提示用户使用系统声音设置切换输出设备。
|
|
633
631
|
>
|
|
634
632
|
|
|
@@ -1176,7 +1174,6 @@ function AdminDeviceRequestHandler() {
|
|
|
1176
1174
|
|
|
1177
1175
|
> **说明:**
|
|
1178
1176
|
>
|
|
1179
|
-
|
|
1180
1177
|
> 邀请开启设备需要尊重用户授权。即使用户接受邀请,浏览器仍可能弹出系统权限确认;如果用户拒绝授权,设备仍无法打开。
|
|
1181
1178
|
>
|
|
1182
1179
|
|
|
@@ -1323,7 +1320,6 @@ function DeviceInvitationHandler() {
|
|
|
1323
1320
|
|
|
1324
1321
|
> **说明:**
|
|
1325
1322
|
>
|
|
1326
|
-
|
|
1327
1323
|
> 仅当本地用户通过 `joinRoom` 或 `createAndJoinRoom` 加入房间,并且打开麦克风或摄像头后,`networkInfo` 中才可以拿到有效数据。未入会或未开启音视频采集时,建议展示“未知”或不展示网络状态。
|
|
1328
1324
|
>
|
|
1329
1325
|
|
|
@@ -39,7 +39,6 @@ import { FreeBeautyPanel } from 'tuikit-atomicx-vue3/room';
|
|
|
39
39
|
|
|
40
40
|
> **注意:**
|
|
41
41
|
>
|
|
42
|
-
|
|
43
42
|
> 所有 TUIKit 组件必须包裹在 UIKitProvider 内部,否则将无法获取上下文依赖,导致样式异常。
|
|
44
43
|
>
|
|
45
44
|
|
|
@@ -119,7 +118,6 @@ const openBeautySettings = () => {
|
|
|
119
118
|
|
|
120
119
|
> **注意:**
|
|
121
120
|
>
|
|
122
|
-
|
|
123
121
|
> 参数取值范围为 0-100。
|
|
124
122
|
>
|
|
125
123
|
|
|
@@ -145,7 +143,6 @@ const updatePreview = async (beauty: number, white: number, ruddy: number) => {
|
|
|
145
143
|
|
|
146
144
|
> **注意:**
|
|
147
145
|
>
|
|
148
|
-
|
|
149
146
|
> 虚拟背景功能依赖摄像头设备。可使用 [useDeviceState](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#module-DeviceState) 检查设备状态。
|
|
150
147
|
>
|
|
151
148
|
> - [cameraList](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#cameraList):当前可用的摄像头设备列表,如果列表为空,说明未检测到摄像头或摄像头权限被禁止。
|
|
@@ -180,7 +177,7 @@ const closeBeauty = async () => {
|
|
|
180
177
|
```
|
|
181
178
|
|
|
182
179
|
## 开发注意事项
|
|
183
|
-
-
|
|
180
|
+
- **参数范围:** `setFreeBeauty` 接收的参数(`beautyLevel`, `whitenessLevel`, `ruddinessLevel`)范围均为 0-100。
|
|
184
181
|
|
|
185
182
|
- **预览与生效:** 为了提供更好的用户体验,美颜调节分为**“预览”**和**“生效”**两个阶段。`setFreeBeauty` 仅用于本地预览,必须调用 `saveBeautySetting` 才会正式调用 `trtcCloud.setBeautyStyle` 应用到推流中。
|
|
186
183
|
|
|
@@ -207,7 +204,7 @@ const closeBeauty = async () => {
|
|
|
207
204
|
|
|
208
205
|
## **示例项目**
|
|
209
206
|
|
|
210
|
-
腾讯云在 GitHub 上提供了示例项目 [
|
|
207
|
+
腾讯云在 GitHub 上提供了示例项目 [vite-vue3-ts](https://github.com/Tencent-RTC/TUIRoomKit/tree/main/Web/example/vite-vue3-ts) ,您可以参考以实现完整的 RoomKit 功能。
|
|
211
208
|
|
|
212
209
|
## API 文档
|
|
213
210
|
|
|
@@ -100,7 +100,6 @@ function useChatConversationSync() {
|
|
|
100
100
|
|
|
101
101
|
> **注意:**
|
|
102
102
|
>
|
|
103
|
-
|
|
104
103
|
> 所有 TUIKit 组件必须包裹在 UIKitProvider 内部,否则将无法获取上下文依赖,导致样式异常。
|
|
105
104
|
>
|
|
106
105
|
|
|
@@ -432,7 +431,6 @@ function MessageListPanel({ roomId }: { roomId: string }) {
|
|
|
432
431
|
|
|
433
432
|
> **注意:**
|
|
434
433
|
>
|
|
435
|
-
|
|
436
434
|
> `MessageInputStore` 是纯命令式 Store,不持有输入框内容状态。需由业务层自行管理输入内容,发送时将内容通过 `sendMessage({ type: 'textMessage', text })` 传入。
|
|
437
435
|
>
|
|
438
436
|
|
|
@@ -507,7 +505,6 @@ function MessageInputPanel({ roomId }: { roomId: string }) {
|
|
|
507
505
|
|
|
508
506
|
> **注意:**
|
|
509
507
|
>
|
|
510
|
-
|
|
511
508
|
> 在加载历史消息后,通常需要手动调整滚动条位置,以保持当前浏览视角不发生跳变。
|
|
512
509
|
>
|
|
513
510
|
|
|
@@ -35,7 +35,6 @@
|
|
|
35
35
|
|
|
36
36
|
> **说明:**
|
|
37
37
|
>
|
|
38
|
-
|
|
39
38
|
> 房主和管理员权限应同时在 UI 层和接口调用层做校验。UI 层可隐藏当前成员不可见的管理入口;接口调用层仍需通过 `try/catch` 处理无权限错误。
|
|
40
39
|
>
|
|
41
40
|
|
|
@@ -1015,7 +1014,6 @@ async function inviteUserToOpenCamera(userId: string) {
|
|
|
1015
1014
|
|
|
1016
1015
|
> **说明:**
|
|
1017
1016
|
>
|
|
1018
|
-
|
|
1019
1017
|
> 设备申请和邀请的完整设备打开流程请参考设备管理文档。成员管理文档主要说明成员之间的权限协作关系。
|
|
1020
1018
|
>
|
|
1021
1019
|
|
|
@@ -8,8 +8,8 @@
|
|
|
8
8
|
|
|
9
9
|
> **注意:**
|
|
10
10
|
>
|
|
11
|
-
> -
|
|
12
|
-
> -
|
|
11
|
+
> - **异步性:** `login` 方法为异步执行。在单页应用中,建议通过监听 `loginUserInfo.value?.userId` 的变化来确保登录就绪,严禁在未确认登录状态时抢跑调用房间管理方法。
|
|
12
|
+
> - **单例约束:** `useRoomState` 采用单例设计,同一用户同一时刻仅支持存在于一个房间内。
|
|
13
13
|
|
|
14
14
|
## 实现房间管理
|
|
15
15
|
|
|
@@ -49,7 +49,6 @@ const {
|
|
|
49
49
|
|
|
50
50
|
> **注意:**
|
|
51
51
|
>
|
|
52
|
-
|
|
53
52
|
> 创建房间时指定的 `roomId` 建议由业务后台生成并下发,以确保同一场会议在您的业务系统中具备稳定且唯一的标识。
|
|
54
53
|
>
|
|
55
54
|
|
|
@@ -121,7 +120,6 @@ await createAndJoinRoom({
|
|
|
121
120
|
|
|
122
121
|
> **说明:**
|
|
123
122
|
>
|
|
124
|
-
|
|
125
123
|
> 创建者在调用 `createAndJoinRoom` 时会自动加入房间,无需额外输入密码。
|
|
126
124
|
>
|
|
127
125
|
|
|
@@ -288,7 +286,6 @@ await createAndJoinRoom({
|
|
|
288
286
|
|
|
289
287
|
> **说明:**
|
|
290
288
|
>
|
|
291
|
-
|
|
292
289
|
> `createAndJoinRoom` 支持“房间不存在则创建,房间已存在则加入”的进房方式,适合无法预先判断房间状态的业务场景。
|
|
293
290
|
>
|
|
294
291
|
|
|
@@ -328,7 +325,6 @@ await updateRoomInfo({
|
|
|
328
325
|
|
|
329
326
|
> **说明:**
|
|
330
327
|
>
|
|
331
|
-
|
|
332
328
|
> 房主必须已经在房间内才能调用 `updateRoomInfo`。如果房主已经离开房间,需要先重新加入房间。
|
|
333
329
|
>
|
|
334
330
|
|
|
@@ -530,7 +530,7 @@ useEffect(() => {
|
|
|
530
530
|
|
|
531
531
|
请确认已登录且首屏调用过 `getScheduledRoomList`(例如 `cursor: ''`)。返回的 `cursor` 不为空需继续拉取;列表是响应式的,更新后 UI 会同步。
|
|
532
532
|
|
|
533
|
-
2. `joinRoom
|
|
533
|
+
2. `joinRoom` **参数怎么传?**
|
|
534
534
|
|
|
535
535
|
推荐统一使用对象入参:`joinRoom({ roomId, password })`,避免直接传字符串导致类型不匹配或后续扩展受限。
|
|
536
536
|
|
|
@@ -96,14 +96,13 @@ const handleStartScreenShareWithAudio = async () => {
|
|
|
96
96
|
|
|
97
97
|
> **注意:**
|
|
98
98
|
>
|
|
99
|
-
|
|
100
99
|
> 系统音频分享需要浏览器支持,且用户在屏幕选择器中勾选**分享音频**选项。如果浏览器不支持系统音频分享,`screenAudio` 参数会被忽略,但屏幕画面分享功能不受影响,可以正常使用。
|
|
101
100
|
>
|
|
102
101
|
|
|
103
102
|
### 步骤3:停止屏幕分享
|
|
104
103
|
|
|
105
104
|
用户可以通过以下几种方式停止屏幕分享:
|
|
106
|
-
1.
|
|
105
|
+
1. **调用** [**stopScreenShare()**](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#stopScreenShare) **接口**
|
|
107
106
|
|
|
108
107
|
【Vue3】
|
|
109
108
|
``` typescript
|
|
@@ -143,7 +142,6 @@ const handleStopScreenShare = async () => {
|
|
|
143
142
|
|
|
144
143
|
> **说明:**
|
|
145
144
|
>
|
|
146
|
-
|
|
147
145
|
> 用户使用任意一种方式停止屏幕分享时,Atomicx 都会自动更新 [screenStatus](https://web.sdk.qcloud.com/trtc/live/web/doc/zh/index.html#screenStatus) 的状态。
|
|
148
146
|
>
|
|
149
147
|
|
|
@@ -453,6 +451,6 @@ useEffect(() => {
|
|
|
453
451
|
|
|
454
452
|
这是符合预期的系统行为,原因如下:
|
|
455
453
|
|
|
456
|
-
|
|
454
|
+
**技术原理:** `microphoneStatus`表示当前设备是否正在对外传输音频信号。当开启屏幕分享并**勾选采集系统音频**时,Atomicx SDK 会启动一条音频传输通道。由于远端接收到的是连续的音频数据流,系统无法区分音频来源是物理麦克风还是系统播放声音,因此会将音频采集状态统一标识为 `DeviceStatus.On`。
|
|
457
455
|
|
|
458
456
|
**隐私说明:**请放心,这并不代表您的麦克风已经在采集说话声音。 麦克风声音是否在推送仅和麦克风控制接口( `openLocalMicrophone` 和 `unmuteLocalMicrophone` )有关,与屏幕分享音频采集是独立的两个通道。即使屏幕分享音频正在传输,只要未调用麦克风相关接口,您的麦克风声音不会被采集和推送。
|
|
@@ -157,7 +157,6 @@ onMounted(async () => {
|
|
|
157
157
|
|
|
158
158
|
> **说明:**
|
|
159
159
|
>
|
|
160
|
-
|
|
161
160
|
> 调用 `setVirtualBackground` 仅在本地预览画面生效,远端用户不会看到虚拟背景效果,需调用 `saveVirtualBackground` 后才会同步到远端视频流。
|
|
162
161
|
>
|
|
163
162
|
|
|
@@ -220,7 +219,7 @@ const disableVirtualBackground = async () => {
|
|
|
220
219
|
```
|
|
221
220
|
|
|
222
221
|
## 开发注意事项
|
|
223
|
-
-
|
|
222
|
+
- **资源文件路径:** `initVirtualBackground` 中的 `assetsPath` 必须正确指向 AI 模型文件的目录。如果路径错误,会导致虚拟背景无法启动。请查阅 [SDK 文档](https://web.sdk.qcloud.com/trtc/webrtc/doc/zh-cn/tutorial-36-advanced-virtual-background.html) 获取资源文件包。
|
|
224
223
|
|
|
225
224
|
- **性能消耗:** 开启虚拟背景会占用较高的 CPU 和 GPU 资源。在低端设备上可能会导致视频掉帧或发热,建议在检测到设备性能不足时提示用户关闭。
|
|
226
225
|
|
|
@@ -252,7 +251,7 @@ WebRTC 相关功能通常要求在 HTTPS 环境下运行,或者是 `localhost`
|
|
|
252
251
|
|
|
253
252
|
## **示例项目**
|
|
254
253
|
|
|
255
|
-
腾讯云在 GitHub 上提供了示例项目 [
|
|
254
|
+
腾讯云在 GitHub 上提供了示例项目 [vite-vue3-ts](https://github.com/Tencent-RTC/TUIRoomKit/tree/main/Web/example/vite-vue3-ts) ,您可以参考以实现完整的 RoomKit 功能。
|
|
256
255
|
|
|
257
256
|
## API 文档
|
|
258
257
|
|
|
@@ -32,7 +32,7 @@ TUIRoomKit 是腾讯云提供的一站式多人音视频房间解决方案,集
|
|
|
32
32
|
|
|
33
33
|
#### 1. 导入 TUIRoomKit 组件
|
|
34
34
|
|
|
35
|
-
在工程根目录下的 `settings.gradle.kts` 或 `settings.gradle
|
|
35
|
+
在工程根目录下的 `settings.gradle.kts` 或 `settings.gradle` 文件中,增加以下代码以导入 `tuiroomkit` 组件。
|
|
36
36
|
|
|
37
37
|
【settings.gradle.kts】
|
|
38
38
|
``` java
|
|
@@ -72,15 +72,14 @@ dependencies {
|
|
|
72
72
|
}
|
|
73
73
|
```
|
|
74
74
|
|
|
75
|
-
> **说明:**
|
|
76
|
-
>
|
|
77
|
-
|
|
78
|
-
>
|
|
79
|
-
>
|
|
75
|
+
> **说明:**
|
|
76
|
+
>
|
|
77
|
+
> TUIRoomKit 内部已默认依赖 TRTC SDK、IM SDK 等公共库,您无需单独配置。
|
|
78
|
+
>
|
|
80
79
|
|
|
81
80
|
#### 3. 配置混淆规则
|
|
82
81
|
|
|
83
|
-
由于 SDK 内部使用了 Java 反射,请在 `proguard-rules.pro
|
|
82
|
+
由于 SDK 内部使用了 Java 反射,请在 `proguard-rules.pro` 文件中添加以下代码,将相关类加入不混淆名单,以确保功能正常运行。
|
|
84
83
|
``` java
|
|
85
84
|
-keep class com.tencent.** { *; }
|
|
86
85
|
-keep class com.tencent.beacon.** { *; }
|
|
@@ -109,7 +108,7 @@ dependencies {
|
|
|
109
108
|
|
|
110
109
|
#### 5. 完成项目同步
|
|
111
110
|
|
|
112
|
-
在您完成上述步骤后,通常情况下 Android Studio 会自动为您弹出 **Sync Now
|
|
111
|
+
在您完成上述步骤后,通常情况下 Android Studio 会自动为您弹出 **Sync Now** 按钮,您需要点击该同步按钮完成项目的同步,若 IDE 没有自动弹出同步按钮,请您手动点击工具栏中的同步按钮进行项目的同步,同步后 IDE 会完成项目的构建配置和索引等工作,您就可以在您的项目中正常使用 TUIRoomKit 组件了。
|
|
113
112
|
|
|
114
113
|
### 步骤3:登录
|
|
115
114
|
|
|
@@ -117,7 +116,6 @@ dependencies {
|
|
|
117
116
|
|
|
118
117
|
> **说明:**
|
|
119
118
|
>
|
|
120
|
-
|
|
121
119
|
> 在示例代码中,直接进行了登录接口的调用。但在实际项目场景下,强烈推荐**您在完成自己的用户身份验证等相关登录操作后,再调用 AtomicXCore 的登录服务**。这样可以避免因过早调用登录服务,导致业务逻辑混乱或数据不一致的问题,同时也能更好地适配您项目中现有的用户管理和权限控制体系。
|
|
122
120
|
>
|
|
123
121
|
|
|
@@ -156,7 +154,7 @@ class MainActivity : AppCompatActivity() {
|
|
|
156
154
|
| 参数 | 类型 | 说明 |
|
|
157
155
|
| --- | --- | --- |
|
|
158
156
|
| <code>sdkAppID</code> | <code>Int32</code> | 从 <a href="https://console.cloud.tencent.com/trtc">控制台</a> 获取,通常是以 <code>140</code> 或 <code>160</code> 开头的 10 位整数。 |
|
|
159
|
-
| <code>userID</code> | <code>String</code> | 当前用户的唯一 ID,仅包含英文字母、数字、连字符和下划线。为避免多端登录冲突,<strong>请勿使用</strong
|
|
157
|
+
| <code>userID</code> | <code>String</code> | 当前用户的唯一 ID,仅包含英文字母、数字、连字符和下划线。为避免多端登录冲突,<strong>请勿使用</strong> <code>1</code>、<code>123</code> <strong>等简单 ID</strong>。 |
|
|
160
158
|
| <code>userSig</code> | <code>String</code> | 用于腾讯云鉴权的票据。更多信息请参见 如何计算及使用 UserSig。<br>【注意事项】<br>- 开发环境:可以采用本地 <code>GenerateTestUserSig.genTestSig</code> 函数生成 userSig 或者通过 <a href="https://console.cloud.tencent.com/im/tool-usersig">UserSig 辅助工具</a> 生成临时的 userSig。<br>- 生产环境:为了防止密钥泄露,请务必采用服务端生成 userSig 的方式。详细信息请参考 服务端生成 UserSig。 |
|
|
161
159
|
|
|
162
160
|
### 步骤4:设置头像和昵称
|
|
@@ -200,7 +198,7 @@ fun setSelfInfo() {
|
|
|
200
198
|
在 `TUIRoomKit` 组件中,`RoomMainView` 是集成了完整的多人音视频房间功能的核心界面,以下将对开发者演示如何以房主身份将 `RoomMainView` 嵌入到应用中。
|
|
201
199
|
|
|
202
200
|
#### **实现方式:**
|
|
203
|
-
1. **加载创建视图页面**:懒加载方式实例化 `RoomMainView
|
|
201
|
+
1. **加载创建视图页面**:懒加载方式实例化 `RoomMainView` 。
|
|
204
202
|
|
|
205
203
|
2. **构造进房的配置项**:进入房间后是否需要自动打开音视频设备的配置项。
|
|
206
204
|
|
|
@@ -243,7 +241,7 @@ class MainActivity : AppCompatActivity() {
|
|
|
243
241
|
}
|
|
244
242
|
```
|
|
245
243
|
|
|
246
|
-
**RoomMainView init
|
|
244
|
+
**RoomMainView init 函数参数详细说明:**
|
|
247
245
|
| 参数 | 类型 | 说明 |
|
|
248
246
|
| --- | --- | --- |
|
|
249
247
|
| <code>roomID</code> | <code>String</code> | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
|
|
@@ -251,7 +249,7 @@ class MainActivity : AppCompatActivity() {
|
|
|
251
249
|
| <code>behavior</code> | <code>RoomBehavior</code> | 房间主页面初始化来源。<br>- Create: 房主身份创建房间。此方式需要构造创建房间配置项,关于 CreateRoomOptions 的详细用法请参考:CreateRoomOptions 结构体详细说明。<br>- Join:参与者身份加入房间。 |
|
|
252
250
|
| <code>config</code> | <code>ConnectConfig</code> | 进房后音视频设备控制的配置项。 |
|
|
253
251
|
|
|
254
|
-
**ConnectConfig
|
|
252
|
+
**ConnectConfig 参数详细说明:**
|
|
255
253
|
| 参数 | 类型 | 说明 |
|
|
256
254
|
| --- | --- | --- |
|
|
257
255
|
| autoEnableMicrophone | <code>Boolean</code> | 进房后是否自动开启麦克风<br>- true:自动开启 (默认值)。<br>- false:不自动开启。 |
|
|
@@ -273,7 +271,7 @@ class MainActivity : AppCompatActivity() {
|
|
|
273
271
|
以下示例将向开发者演示如何以参与者身份将 `RoomMainView` 嵌入到应用中。
|
|
274
272
|
|
|
275
273
|
#### **实现方式:**
|
|
276
|
-
1. **加载创建视图页面**:懒加载方式实例化 `RoomMainView
|
|
274
|
+
1. **加载创建视图页面**:懒加载方式实例化 `RoomMainView` 。
|
|
277
275
|
|
|
278
276
|
2. **构造进房的配置项**:进入房间后是否需要自动打开音视频设备的配置项。
|
|
279
277
|
|
|
@@ -314,7 +312,7 @@ class MainActivity : AppCompatActivity() {
|
|
|
314
312
|
}
|
|
315
313
|
```
|
|
316
314
|
|
|
317
|
-
**参数详细说明请参考:**RoomMainView init
|
|
315
|
+
**参数详细说明请参考:**RoomMainView init 函数参数详细说明 和 ConnectConfig 参数详细说明。
|
|
318
316
|
|
|
319
317
|
## 核心功能
|
|
320
318
|
|
|
@@ -324,7 +322,7 @@ class MainActivity : AppCompatActivity() {
|
|
|
324
322
|
|
|
325
323
|
`RoomMainView` 房间主页面内功能丰富,可定制化度高,开发者可以根据实际产品需求,对 UI 进行定制化修改,以适配业务交互场景。以下将详细为开发者展示 `RoomMainView` 页面中视图组件,便于开发者快速修改。
|
|
326
324
|
|
|
327
|
-
`RoomMainView
|
|
325
|
+
`RoomMainView` **中组件详细说明**
|
|
328
326
|
|
|
329
327
|
|组件|功能描述|定制化建议|
|
|
330
328
|
|---------|---------|---------|
|
|
@@ -24,7 +24,7 @@ TUIRoomKit 是腾讯云提供的一站式多人音视频房间解决方案,集
|
|
|
24
24
|
|
|
25
25
|
### 步骤1:集成 TUIRoomKit 组件
|
|
26
26
|
|
|
27
|
-
在您的工程 `pubspec.yaml` 文件中,添加 [tencent_conference_uikit](https://pub.dev/packages/tencent_conference_uikit)插件依赖。
|
|
27
|
+
在您的工程 `pubspec.yaml` 文件中,添加 [tencent_conference_uikit](https://pub.dev/packages/tencent_conference_uikit) 插件依赖。
|
|
28
28
|
``` yaml
|
|
29
29
|
dependencies:
|
|
30
30
|
tencent_conference_uikit: 最新版本
|
|
@@ -36,9 +36,9 @@ flutter pub get
|
|
|
36
36
|
```
|
|
37
37
|
|
|
38
38
|
### 步骤2:工程配置
|
|
39
|
-
- 使用 **Xcode
|
|
39
|
+
- 使用 **Xcode** 打开您的工程,选择**项目** > **Build Settings** > **Deployment**,将其下的 **Strip Style** 设置为 `Non-Global Symbols`,以保留所需要的全局符号信息。
|
|
40
40
|
|
|
41
|
-
- 若您需要在 **iOS
|
|
41
|
+
- 若您需要在 **iOS** 端使用音视频功能,需要授权麦克风和摄像头的使用权限(`Android`端已在 SDK 中声明相关权限,您无需手动进行相关配置)。
|
|
42
42
|
|
|
43
43
|
在您 App 的`Info.plist`(路径:`ios/Runner/Info.plist`)中添加以下两项,分别对应麦克风和摄像头在系统弹出授权对话框时的提示信息。
|
|
44
44
|
|
|
@@ -49,7 +49,7 @@ flutter pub get
|
|
|
49
49
|
<string>TUIRoomKit 需要访问您的麦克风权限</string>
|
|
50
50
|
```
|
|
51
51
|
|
|
52
|
-
完成以上添加后,在您的 **ios/Podfile
|
|
52
|
+
完成以上添加后,在您的 **ios/Podfile** 中添加以下预处理器定义,用于启用相机与麦克风权限。
|
|
53
53
|
|
|
54
54
|
``` ruby
|
|
55
55
|
post_install do |installer|
|
|
@@ -112,7 +112,6 @@ flutter pub get
|
|
|
112
112
|
|
|
113
113
|
> **说明:**
|
|
114
114
|
>
|
|
115
|
-
|
|
116
115
|
> 在示例代码中,直接进行了登录接口的调用。但在实际项目场景下,强烈推荐**您在完成自己的用户身份验证等相关登录操作后,再调用 TUIRoomKit 的登录服务**。这样可以避免因过早调用登录服务,导致业务逻辑混乱或数据不一致的问题,同时也能更好地适配您项目中现有的用户管理和权限控制体系。
|
|
117
116
|
>
|
|
118
117
|
|
|
@@ -137,7 +136,7 @@ if (loginResult.isSuccess) {
|
|
|
137
136
|
| 参数 | 类型 | 说明 |
|
|
138
137
|
| --- | --- | --- |
|
|
139
138
|
| <code>sdkAppID</code> | <code>int</code> | 从 <a href="https://console.cloud.tencent.com/trtc">控制台</a> 获取,通常是以 <code>140</code> 或 <code>160</code> 开头的 10 位整数。 |
|
|
140
|
-
| <code>userID</code> | <code>String</code> | 当前用户的唯一 ID,仅包含英文字母、数字、连字符和下划线。为避免多端登录冲突,<strong>请勿使用</strong
|
|
139
|
+
| <code>userID</code> | <code>String</code> | 当前用户的唯一 ID,仅包含英文字母、数字、连字符和下划线。为避免多端登录冲突,<strong>请勿使用</strong> <code>1</code>、<code>123</code> <strong>等简单 ID</strong>。 |
|
|
141
140
|
| <code>userSig</code> | <code>String</code> | 用于腾讯云鉴权的票据。更多信息请参见 如何计算及使用 UserSig。<br>【注意事项】<br>- 开发环境:可以采用本地 <code>GenerateTestUserSig.genTestSig</code> 函数生成 userSig 或者通过 <a href="https://console.cloud.tencent.com/im/tool-usersig">UserSig 辅助工具</a> 生成临时的 userSig。<br>- 生产环境:为了防止密钥泄露,请务必采用服务端生成 userSig 的方式。详细信息请参考 服务端生成 UserSig。 |
|
|
142
141
|
|
|
143
142
|
### 步骤5:设置头像和昵称
|
|
@@ -178,7 +177,6 @@ if (result.isSuccess) {
|
|
|
178
177
|
|
|
179
178
|
> **说明:**
|
|
180
179
|
>
|
|
181
|
-
|
|
182
180
|
> 移动端仅支持创建标准房间,如您需要创建大型研讨会房间,请参考 Web 快速接入 使用Web端创建。
|
|
183
181
|
>
|
|
184
182
|
|
|
@@ -239,7 +237,7 @@ class YourMainPage extends StatelessWidget {
|
|
|
239
237
|
| <code>behavior</code> | <code>RoomBehavior</code> | - 房间主页面初始化来源。<br>- 参数含义:<br>- create: 房主身份创建房间,此方式需要构造创建房间配置项,关于CreateRoomOptions的详细用法请参考:CreateRoomOptions 结构体详细说明。<br>- enter:参与者身份加入房间。 |
|
|
240
238
|
| <code>config</code> | <code>ConnectConfig</code> | 进房后音视频设备控制的配置项。 |
|
|
241
239
|
|
|
242
|
-
**ConnectConfig
|
|
240
|
+
**ConnectConfig 参数详细说明:**
|
|
243
241
|
| 参数 | 类型 | 说明 |
|
|
244
242
|
| --- | --- | --- |
|
|
245
243
|
| autoEnableMicrophone | <code>bool</code> | - 进房后是否自动开启麦克风。<br>- 参数含义:<br>- true: 自动开启 (默认值)。<br>- false: 不自动开启。 |
|
|
@@ -302,13 +300,10 @@ class YourMainPage extends StatelessWidget {
|
|
|
302
300
|
}
|
|
303
301
|
```
|
|
304
302
|
|
|
305
|
-
**参数详细说明请参考:**
|
|
306
|
-
|
|
307
|
-
[RoomMainWidget 构造函数参数详细说明]( 构造函数参数详细说明)和 [ConnectConfig 参数详细说明]( 参数详细说明)
|
|
303
|
+
**参数详细说明请参考:**[RoomMainWidget 构造函数参数详细说明]( 构造函数参数详细说明) 和 [ConnectConfig 参数详细说明]( 参数详细说明)
|
|
308
304
|
|
|
309
305
|
> **说明:**
|
|
310
306
|
>
|
|
311
|
-
|
|
312
307
|
> 使用TUIRoomKit组件进入大型研讨会房间时,需确保Web端创建的研讨会房间的房间ID以 `webinar_` 开头。
|
|
313
308
|
>
|
|
314
309
|
|
|
@@ -323,24 +318,21 @@ class YourMainPage extends StatelessWidget {
|
|
|
323
318
|
|
|
324
319
|
> **注意:**
|
|
325
320
|
>
|
|
326
|
-
|
|
327
321
|
> 界面定制、图标定制、文案定制这部分章节内容,涉及到需要修改 TUIRoomKit 组件源码,通过 pub 依赖管理器集成 TUIRoomKit 为"不可变"的依赖项。每次执行 flutter pub get 时,Flutter 会:
|
|
328
322
|
>
|
|
329
323
|
> 1. 检查 pubspec.lock 中记录的版本号。
|
|
330
324
|
> 2. 从远程仓库重新下载对应版本的源码。
|
|
331
325
|
> 3. 用下载的原始代码覆盖 .pub-cache/ 目录下的现有文件。
|
|
332
|
-
|
|
333
326
|
> **因此,任何对缓存目录的手动修改都只是临时性的,下次执行安装命令时即被还原。**
|
|
334
327
|
>
|
|
335
|
-
|
|
336
328
|
>
|
|
337
329
|
>
|
|
338
|
-
|
|
339
330
|
> **推荐解决方案:**
|
|
340
331
|
>
|
|
341
332
|
> 1. Fork [TUIKit_Flutter](https://github.com/Tencent-RTC/TUIKit_Flutter/tree/main) 的官方仓库。
|
|
342
333
|
> 2. 在 fork 的仓库中修改并提交。
|
|
343
334
|
> 3. 修改 pubspec.yaml ,指向**自定义仓库和分支。**
|
|
335
|
+
|
|
344
336
|
> `dependencies:`
|
|
345
337
|
> ` tencent_conference_uikit:`
|
|
346
338
|
> ` git:`
|
|
@@ -402,7 +394,7 @@ TUIRoomKit 使用 Flutter 标准的 ARB 文件来管理 UI 所需的文案显示
|
|
|
402
394
|
|
|
403
395
|
### 进房后无画面?
|
|
404
396
|
|
|
405
|
-
请前往**手机设置** > **App
|
|
397
|
+
请前往**手机设置** > **App >** **相机**,检查摄像头权限是否开启,可参考如下示例:
|
|
406
398
|
| iOS | Android |
|
|
407
399
|
| --- | --- |
|
|
408
400
|
| | |
|
|
@@ -16,9 +16,9 @@ TUIRoomKit 是腾讯云提供的一站式多人音视频房间解决方案,集
|
|
|
16
16
|
### 环境准备
|
|
17
17
|
|
|
18
18
|
在开始运行 Demo 之前,请确保您的开发环境满足以下要求:
|
|
19
|
-
- **Xcode**:需使用 **Xcode 15
|
|
19
|
+
- **Xcode**:需使用 **Xcode 15** 或更高版本。
|
|
20
20
|
|
|
21
|
-
- **iOS 系统**:支持 **iOS 13.0
|
|
21
|
+
- **iOS 系统**:支持 **iOS 13.0** 或更高版本的设备。
|
|
22
22
|
|
|
23
23
|
- **CocoaPods 环境**:已安装 CocoaPods 环境。如果您尚未安装,请参见 [CocoaPods 官网安装](https://guides.cocoapods.org/using/getting-started.html),或按以下步骤操作:
|
|
24
24
|
|
|
@@ -26,7 +26,6 @@ TUIRoomKit 是腾讯云提供的一站式多人音视频房间解决方案,集
|
|
|
26
26
|
|
|
27
27
|
> **提示:**
|
|
28
28
|
>
|
|
29
|
-
|
|
30
29
|
> `sudo gem install cocoapods` 安装过程中可能需要输入电脑密码,按提示输入管理员密码即可。
|
|
31
30
|
>
|
|
32
31
|
|
|
@@ -87,11 +86,10 @@ TUIRoomKit 是腾讯云提供的一站式多人音视频房间解决方案,集
|
|
|
87
86
|
|
|
88
87
|
### 步骤3:登录
|
|
89
88
|
|
|
90
|
-
|
|
89
|
+
代码集成完成后,需要完成登录操作,这是**使用** `TUIRoomKit` **的关键步骤**。只有在登录成功后,才能正常使用 `TUIRoomKit` 的各项功能,因此请仔细检查相关参数配置是否正确:
|
|
91
90
|
|
|
92
91
|
> **说明:**
|
|
93
92
|
>
|
|
94
|
-
|
|
95
93
|
> 在示例代码中,登录操作是在 `didFinishLaunchingWithOptions` 方法内完成的。但在实际项目场景下,强烈推荐**在完成自己的用户身份验证等相关登录操作后,再调用 AtomicXCore 的登录服务**。这样可以避免因过早调用登录服务,导致业务逻辑混乱或数据不一致的问题,同时也能更好地适配您项目中现有的用户管理和权限控制体系。
|
|
96
94
|
>
|
|
97
95
|
|
|
@@ -119,7 +117,7 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau
|
|
|
119
117
|
| 参数 | 类型 | 说明 |
|
|
120
118
|
| --- | --- | --- |
|
|
121
119
|
| <code>sdkAppID</code> | <code>Int32</code> | 从 <a href="https://console.cloud.tencent.com/trtc">控制台</a> 获取,通常是以 <code>140</code> 或 <code>160</code> 开头的 10 位整数。 |
|
|
122
|
-
| <code>userID</code> | <code>String</code> | 当前用户的唯一 ID,仅包含英文字母、数字、连字符和下划线。为避免多端登录冲突,<strong>请勿使用</strong
|
|
120
|
+
| <code>userID</code> | <code>String</code> | 当前用户的唯一 ID,仅包含英文字母、数字、连字符和下划线。为避免多端登录冲突,<strong>请勿使用</strong> <code>1</code>、<code>123</code> <strong>等简单 ID</strong>。 |
|
|
123
121
|
| <code>userSig</code> | <code>String</code> | 用于腾讯云鉴权的票据。更多信息请参见 如何计算及使用 UserSig。<br><strong>注意:</strong><br>- 开发环境:可以采用本地 <code>GenerateTestUserSig.genTestSig</code> 函数生成 userSig 或者通过 <a href="https://console.cloud.tencent.com/im/tool-usersig">UserSig 辅助工具</a> 生成临时的 userSig。<br>- 生产环境:为了防止密钥泄露,请务必采用服务端生成 userSig 的方式。详细信息请参考 服务端生成 UserSig。 |
|
|
124
122
|
|
|
125
123
|
### 步骤4:设置头像和昵称
|
|
@@ -166,7 +164,6 @@ func setSelfInfo() {
|
|
|
166
164
|
|
|
167
165
|
> **说明:**
|
|
168
166
|
>
|
|
169
|
-
|
|
170
167
|
> `TUIRoomKit` 的内部页面跳转机制基于 `UINavigationController` 的标准导航方法(push/pop)实现。为确保页面路由功能正常工作,开发者的视图控制器必须作为 `UINavigationController` 的根视图控制器或位于其导航栈内。若未将控制器包装至 `UINavigationController` 中,SDK 内部的跳转操作将因缺少有效的导航上下文而失效,导致页面无法正常切换。
|
|
171
168
|
>
|
|
172
169
|
|
|
@@ -217,7 +214,7 @@ class YourMainViewController: UIViewController, RouterContext {
|
|
|
217
214
|
| <code>behavior</code> | <code>RoomBehavior</code> | 房间主页面初始化来源。<br>- create:房主身份创建房间的方式需要构造创建房间配置项。<br>- 关于 <code>CreateRoomOptions</code> 的详细用法请参考:CreateRoomOptions 结构体详细说明。<br>- join:参与者身份加入房间。 |
|
|
218
215
|
| <code>config</code> | <code>ConnectConfig</code> | 进房后音视频设备控制的配置项。 |
|
|
219
216
|
|
|
220
|
-
**ConnectConfig
|
|
217
|
+
**ConnectConfig 参数详细说明:**
|
|
221
218
|
| 参数 | 类型 | 说明 |
|
|
222
219
|
| --- | --- | --- |
|
|
223
220
|
| autoEnableMicrophone | <code>Bool</code> | 进房后是否自动开启麦克风。<br>- true:自动开启 (默认值)。<br>- false:不自动开启。 |
|
|
@@ -276,9 +273,7 @@ class YourMainViewController: UIViewController, RouterContext {
|
|
|
276
273
|
}
|
|
277
274
|
```
|
|
278
275
|
|
|
279
|
-
**参数详细说明请参考:**
|
|
280
|
-
|
|
281
|
-
[RoomMainView 构造函数参数详细说明]( 构造函数参数详细说明)和 [ConnectConfig 参数详细说明]( 参数详细说明)
|
|
276
|
+
**参数详细说明请参考:**[RoomMainView 构造函数参数详细说明]( 构造函数参数详细说明) 和 [ConnectConfig 参数详细说明]( 参数详细说明)
|
|
282
277
|
|
|
283
278
|
## 核心功能
|
|
284
279
|
|
|
@@ -288,26 +283,24 @@ class YourMainViewController: UIViewController, RouterContext {
|
|
|
288
283
|
|
|
289
284
|
> **注意:**
|
|
290
285
|
>
|
|
291
|
-
|
|
292
286
|
> 界面定制、图标定制、文案定制这部分章节内容,涉及到需要修改 `TUIRoomKit` 组件源码,通过 **CocoaPods** 依赖管理器集成 `TUIRoomKit` 将被视为“不可变”的依赖项。每次执行 pod install 时,**CocoaPods** 会:
|
|
293
287
|
>
|
|
294
288
|
> - 检查 Podfile.lock 中记录的版本号。
|
|
295
289
|
> - 从远程仓库重新下载对应版本的源码。
|
|
296
290
|
> - 用下载的原始代码覆盖 Pods/ 目录下的现有文件。
|
|
297
|
-
|
|
298
291
|
> **因此,任何对 Pods/ 目录的手动修改都只是临时性的,下次执行安装命令时即被还原。**
|
|
299
292
|
>
|
|
300
|
-
|
|
301
293
|
> **推荐解决方案:**
|
|
302
294
|
>
|
|
303
295
|
> - Fork [TUIRoomKit](https://github.com/Tencent-RTC/TUIKit_iOS) 的官方仓库。
|
|
304
296
|
> - 在 fork 的仓库中修复问题并提交。
|
|
305
297
|
> - 修改 Podfile,指向自定义仓库和分支。
|
|
298
|
+
|
|
306
299
|
> `pod 'TUIRoomKit', :git => 'https://github.com/your-username/TUIRoomKit.git', :branch => 'your-branch'`
|
|
307
300
|
|
|
308
301
|
`RoomMainView` 房间主页面内功能丰富,可定制化度高,开发者可以根据实际产品需求,对 UI 进行定制化修改,以适配业务交互场景。以下将详细为开发者展示 `RoomMainView` 页面中视图组件,便于开发者快速修改。
|
|
309
302
|
|
|
310
|
-
`RoomMainView
|
|
303
|
+
`RoomMainView` **中的组件详细说明**
|
|
311
304
|
|
|
312
305
|
|组件|功能描述|定制化建议|
|
|
313
306
|
|---------|---------|---------|
|
|
@@ -340,7 +333,6 @@ class YourMainViewController: UIViewController, RouterContext {
|
|
|
340
333
|
|
|
341
334
|
> **说明:**
|
|
342
335
|
>
|
|
343
|
-
|
|
344
336
|
> [Apple Strings Catalog](https://developer.apple.com/documentation/xcode/localizing-and-varying-text-with-a-string-catalog) (.xcstrings) 是在 Xcode 15 中引入的本地化格式。它增强了开发者管理本地化字符串的方式,支持处理复数、设备特定变体等的结构化格式。这种格式正成为管理 iOS 和 macOS 应用程序本地化的推荐方法。
|
|
345
337
|
>
|
|
346
338
|
|
|
@@ -349,7 +341,7 @@ class YourMainViewController: UIViewController, RouterContext {
|
|
|
349
341
|
### pod install 执行后本地安装找不到 TUIRoomKit 最新版本?
|
|
350
342
|
|
|
351
343
|
如果无法安装 `TUIRoomKit` 最新版本,请按以下步骤操作:
|
|
352
|
-
1. 在 Podfile 所在目录下删除 `Podfile.lock
|
|
344
|
+
1. 在 Podfile 所在目录下删除 `Podfile.lock` 和 `Pods`,您可以选择手动删除或终端执行以下命令:
|
|
353
345
|
|
|
354
346
|
``` bash
|
|
355
347
|
// cd 到 Podfile 所在目录下
|
|
@@ -61,7 +61,6 @@ export default function App() {
|
|
|
61
61
|
|
|
62
62
|
> **注意**:
|
|
63
63
|
>
|
|
64
|
-
|
|
65
64
|
> 在配置代码中,请务必填入生成的 UserSig。在正式的生产环境中,建议在您的服务端生成 UserSig,在需要 UserSig 时由您的客户端向业务服务器发起请求获取动态 UserSig 来进行鉴权。详见 [正式运行阶段如何计算 UserSig](https://cloud.tencent.com/document/product/647/17275#formal)。
|
|
66
65
|
>
|
|
67
66
|
|
|
@@ -307,7 +306,6 @@ const enterDualMeeting = async (bizOrderId: string) => {
|
|
|
307
306
|
|
|
308
307
|
> **说明:**
|
|
309
308
|
>
|
|
310
|
-
|
|
311
309
|
> `conference.createAndJoinRoom` 接口内部封装了"不存在则创建(成为房主),已存在则加入(成为普通参会者)"的逻辑,完美解决高并发下的状态冲突问题。
|
|
312
310
|
>
|
|
313
311
|
|
|
@@ -328,7 +326,6 @@ await conference.leaveRoom();
|
|
|
328
326
|
|
|
329
327
|
> **说明**:
|
|
330
328
|
>
|
|
331
|
-
|
|
332
329
|
> 房主离开房间或关闭网页,不会自动解散房间,其他参会成员可继续正常使用 TUIRoomKit 能力,系统会在会议结束时间后 6 小时、且房间内人数为 0 时自动回收房间资源。
|
|
333
330
|
>
|
|
334
331
|
|
|
@@ -343,7 +340,6 @@ await conference.endRoom();
|
|
|
343
340
|
|
|
344
341
|
> **注意**:
|
|
345
342
|
>
|
|
346
|
-
|
|
347
343
|
> `endRoom()` 必须由房主在成功进入房间后才能调用。非房主身份或在尚未进入房间的状态下调用会报错。
|
|
348
344
|
>
|
|
349
345
|
|