@tencentcloud/sdk-mcp 1.6.3 → 1.6.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.js +0 -4
- 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 +166 -0
- 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 +234 -57
- 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/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-config.js +7 -4
- 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/is-valid-sdkappid.js +4 -0
- 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
|
@@ -0,0 +1,358 @@
|
|
|
1
|
+
TUILiveKit 主播开播页为直播场景提供**开箱即用的全功能界面**,支持快速搭建主播开播所需的核心能力,让您无需关注复杂 UI 与逻辑实现,即可高效集成直播开播流程。
|
|
2
|
+
|
|
3
|
+
> **集成提示:**
|
|
4
|
+
>
|
|
5
|
+
> 本文档介绍基于 **UI 组件** 的开播方式(含完整交互 UI)。若您需通过 **Core SDK** 自行搭建主播端界面,请参考 主播开播 (Core SDK)。
|
|
6
|
+
>
|
|
7
|
+
|
|
8
|
+
## 功能概览
|
|
9
|
+
- **开播前预览:**支持主播开播前的房间名称、背景、视频预览、美颜调试、音效调试、布局模板等多种个性化配置。
|
|
10
|
+
|
|
11
|
+
- **连麦互动:**支持直播过程中与观众 或 与其他直播间主播实时互动。
|
|
12
|
+
|
|
13
|
+
- **观众互动:**支持弹幕、礼物等丰富直播互动形式。
|
|
14
|
+
|
|
15
|
+
- **直播间管理:**支持在线用户列表展示、以及直播间内的禁言、踢人等多种管理操作。
|
|
16
|
+
|
|
17
|
+
| 开播前预览 | 连麦互动 | 观众互动 | 直播间管理 |
|
|
18
|
+
| --- | --- | --- | --- |
|
|
19
|
+
| | | | |
|
|
20
|
+
|
|
21
|
+
## 快速接入
|
|
22
|
+
|
|
23
|
+
### 步骤1:开通服务
|
|
24
|
+
|
|
25
|
+
参考 开通服务 文档开通「体验版」或「大规模直播版」套餐。
|
|
26
|
+
|
|
27
|
+
### 步骤2:代码集成
|
|
28
|
+
|
|
29
|
+
参考 准备工作 接入 `TUILiveKit`。
|
|
30
|
+
|
|
31
|
+
### 步骤3:添加开播前的准备页面
|
|
32
|
+
|
|
33
|
+
`AnchorPrepareView` 组件已内置了摄像头预览、音效设置、布局设置、以及其它功能设置,您需创建并加载主播开播页视图,具体示例代码如下:
|
|
34
|
+
|
|
35
|
+
【Swift】
|
|
36
|
+
``` swift
|
|
37
|
+
import UIKit
|
|
38
|
+
import Snapkit
|
|
39
|
+
import TUILiveKit
|
|
40
|
+
import AtomicXCore
|
|
41
|
+
|
|
42
|
+
// YourAnchorPrepareViewController 代表您加载主播开播页的视图控制器
|
|
43
|
+
class YourAnchorPrepareViewController: UIViewController {
|
|
44
|
+
private let roomId = "testLiveId"
|
|
45
|
+
|
|
46
|
+
// 懒加载 AnchorPrepareView
|
|
47
|
+
private lazy var prepareView: AnchorPrepareView = {
|
|
48
|
+
// AnchorPrepareView 初始化时传入roomId
|
|
49
|
+
let view = AnchorPrepareView(roomId: roomId)
|
|
50
|
+
return view
|
|
51
|
+
}()
|
|
52
|
+
|
|
53
|
+
public override func viewDidLoad() {
|
|
54
|
+
super.viewDidLoad()
|
|
55
|
+
// 将 prepareView 添加到视图上
|
|
56
|
+
view.addSubview(prepareView)
|
|
57
|
+
prepareView.snp.makeConstraints { make in
|
|
58
|
+
make.edges.equalToSuperview()
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### 步骤4:添加主播用的推流页面
|
|
65
|
+
|
|
66
|
+
`AnchorView` 组件已内置了音视频推流、观众连麦、直播互动、直播管理等功能,您只需创建并加载 `AnchorView` ,具体示例代码如下:
|
|
67
|
+
|
|
68
|
+
【swift】
|
|
69
|
+
``` swift
|
|
70
|
+
import UIKit
|
|
71
|
+
import Snapkit
|
|
72
|
+
import TUILiveKit
|
|
73
|
+
import AtomicXCore
|
|
74
|
+
|
|
75
|
+
// YourAnchorPrepareViewController 代表您加载主播开播页的视图控制器
|
|
76
|
+
class YourAnchorViewController: UIViewController {
|
|
77
|
+
// 核心 view 组件
|
|
78
|
+
private let coreView: LiveCoreView
|
|
79
|
+
|
|
80
|
+
// 声明 anchorView 实例
|
|
81
|
+
private let anchorView: AnchorView
|
|
82
|
+
|
|
83
|
+
public init(liveInfo: LiveInfo, coreView: LiveCoreView? = nil, behavior: RoomBehavior = .createRoom) {
|
|
84
|
+
if let coreView = coreView {
|
|
85
|
+
self.coreView = coreView
|
|
86
|
+
} else {
|
|
87
|
+
self.coreView = LiveCoreView(viewType: .pushView)
|
|
88
|
+
}
|
|
89
|
+
// 实例化主播开播页
|
|
90
|
+
self.anchorView = AnchorView(liveInfo: liveInfo, coreView: self.coreView, behavior: behavior)
|
|
91
|
+
super.init(nibName: nil, bundle: nil)
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
required init?(coder: NSCoder) {
|
|
95
|
+
fatalError("init(coder:) has not been implemented")
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
public override func viewDidLoad() {
|
|
99
|
+
super.viewDidLoad()
|
|
100
|
+
// 将 anchorView 添加到视图上
|
|
101
|
+
view.addSubview(anchorView)
|
|
102
|
+
anchorView.snp.makeConstraints { make in
|
|
103
|
+
make.edges.equalToSuperview()
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### 步骤5:事件回调定制
|
|
110
|
+
|
|
111
|
+
`AnchorView` 还提供了 `delegate`(`AnchorViewDelegate`)扩展点,用于监听主播开播页内的核心生命周期事件,包括真正开播成功、下播(含统计数据)、点击悬浮窗等回调,建议在 步骤 4 创建 `AnchorView` 后立即设置:
|
|
112
|
+
|
|
113
|
+
|方法|说明|
|
|
114
|
+
|---------|---------|
|
|
115
|
+
|`func onStartLiving()`|主播已成功开始直播(房间创建/进入成功,推流已开始)时回调。|
|
|
116
|
+
|`func onEndLiving(state: AnchorState)`|主播下播时回调,`state` 携带本场直播的统计数据:`totalDuration`(直播时长)、`totalViewers`(观众总数)、`totalMessageSent`(弹幕总数)、`totalGiftCoins`(礼物总收益)、`totalGiftUniqueSenders`(送礼人数)、`totalLikesReceived`(点赞总数)、`liveEndedReason`(下播原因),可用于展示下播结算页。|
|
|
117
|
+
|`func onClickFloatWindow()`|用户点击悬浮窗回调。|
|
|
118
|
+
|
|
119
|
+
``` swift
|
|
120
|
+
import UIKit
|
|
121
|
+
import Snapkit
|
|
122
|
+
import TUILiveKit
|
|
123
|
+
import AtomicXCore
|
|
124
|
+
|
|
125
|
+
// YourAnchorPrepareViewController 代表您加载主播开播页的视图控制器
|
|
126
|
+
class YourAnchorViewController: UIViewController {
|
|
127
|
+
// 核心 view 组件
|
|
128
|
+
private let coreView: LiveCoreView
|
|
129
|
+
|
|
130
|
+
// 声明 anchorView 实例
|
|
131
|
+
private let anchorView: AnchorView
|
|
132
|
+
|
|
133
|
+
public init(liveInfo: LiveInfo, coreView: LiveCoreView? = nil, behavior: RoomBehavior = .createRoom) {
|
|
134
|
+
if let coreView = coreView {
|
|
135
|
+
self.coreView = coreView
|
|
136
|
+
} else {
|
|
137
|
+
self.coreView = LiveCoreView(viewType: .pushView)
|
|
138
|
+
}
|
|
139
|
+
// 实例化主播开播页
|
|
140
|
+
self.anchorView = AnchorView(liveInfo: liveInfo, coreView: self.coreView, behavior: behavior)
|
|
141
|
+
super.init(nibName: nil, bundle: nil)
|
|
142
|
+
// 设置代理,监听主播页核心事件
|
|
143
|
+
anchorView.delegate = self
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
required init?(coder: NSCoder) {
|
|
147
|
+
fatalError("init(coder:) has not been implemented")
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
public override func viewDidLoad() {
|
|
151
|
+
super.viewDidLoad()
|
|
152
|
+
// 将 anchorView 添加到视图上
|
|
153
|
+
view.addSubview(anchorView)
|
|
154
|
+
anchorView.snp.makeConstraints { make in
|
|
155
|
+
make.edges.equalToSuperview()
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
// 实现 AnchorViewDelegate 回调代理
|
|
161
|
+
extension YourAnchorViewController: AnchorViewDelegate {
|
|
162
|
+
// 主播已成功开始直播(推流已开始)
|
|
163
|
+
func onStartLiving() {
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
// 主播下播,state 携带本场直播的统计数据
|
|
167
|
+
func onEndLiving(state: AnchorState) {
|
|
168
|
+
let duration = state.totalDuration
|
|
169
|
+
let viewers = state.totalViewers
|
|
170
|
+
let messageCount = state.totalMessageSent
|
|
171
|
+
let giftCoins = state.totalGiftCoins
|
|
172
|
+
let giftSenders = state.totalGiftUniqueSenders
|
|
173
|
+
let likes = state.totalLikesReceived
|
|
174
|
+
let reason = state.liveEndedReason
|
|
175
|
+
// 可在此处跳转到您的下播结算页,展示以上统计数据
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
// 用户点击了悬浮窗
|
|
179
|
+
func onClickFloatWindow() {
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
// 实现 FloatWindowProvider 回调代理
|
|
184
|
+
extension YourAnchorViewController: FloatWindowProvider {
|
|
185
|
+
public func getRoomId() -> String {
|
|
186
|
+
liveID
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
public func getOwnerId() -> String {
|
|
190
|
+
LiveListStore.shared.state.value.currentLive.liveOwner.userID
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
public func getCoreView() -> AtomicXCore.LiveCoreView {
|
|
194
|
+
coreView
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
public func relayoutCoreView() {
|
|
198
|
+
anchorView.relayoutCoreView()
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
public func getIsLinking() -> Bool {
|
|
202
|
+
let connectedSeats = CoGuestStore.create(liveID: liveID).state.value.connected
|
|
203
|
+
let selfUserID = LoginStore.shared.state.value.loginUserInfo?.userID ?? ""
|
|
204
|
+
return connectedSeats.contains(where: { $0.userID == selfUserID })
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### **步骤6:从准备页面跳转到推流页面**
|
|
211
|
+
|
|
212
|
+
结合 步骤 3 实现 `AnchorPrepareView` 组件的代理事件,完成主播开播页的路由跳转,具体示例代码如下:
|
|
213
|
+
|
|
214
|
+
> **配合服务端 (RESTFUL API) 开播:**
|
|
215
|
+
>
|
|
216
|
+
> 如果您的房间是先通过 服务端 API 创建的,在集成时无需修改任何代码逻辑,只需将示例代码中的 `liveID` 替换为服务端生成的 ID 即可。SDK 将自动接管该房间并开启直播。
|
|
217
|
+
>
|
|
218
|
+
|
|
219
|
+
【swift】
|
|
220
|
+
``` swift
|
|
221
|
+
import UIKit
|
|
222
|
+
import TUILiveKit
|
|
223
|
+
import AtomicXCore
|
|
224
|
+
|
|
225
|
+
// 在 AnchorPrepareView 初始化时设置代理
|
|
226
|
+
class YourAnchorPrepareViewController: UIViewController {
|
|
227
|
+
private lazy var prepareView: AnchorPrepareView = {
|
|
228
|
+
let view = AnchorPrepareView(roomId: roomId)
|
|
229
|
+
// 设置代理
|
|
230
|
+
view.delegate = self
|
|
231
|
+
return view
|
|
232
|
+
}()
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
// 实现 AnchorPrepareViewDelegate 回调代理
|
|
236
|
+
extension YourAnchorPrepareViewController : AnchorPrepareViewDelegate {
|
|
237
|
+
// 响应开播按钮点击事件
|
|
238
|
+
// - state: PrepareState 封装了主播开播页的摄像头、音效等功能设置,您只需按以下示例代码设置即可
|
|
239
|
+
public func onClickStartButton(state: PrepareState) {
|
|
240
|
+
// 跳转到主播开播页
|
|
241
|
+
// 初始化直播信息
|
|
242
|
+
var liveInfo = LiveInfo(seatTemplate: .videoDynamicGrid9Seats)
|
|
243
|
+
// 如果您使用了服务端 API 预创房,请在此处填入服务端返回的 RoomId。
|
|
244
|
+
liveInfo.liveID = roomId
|
|
245
|
+
liveInfo.liveName = state.roomName
|
|
246
|
+
liveInfo.coverURL = state.coverUrl
|
|
247
|
+
liveInfo.isPublicVisible = state.privacyMode == .public
|
|
248
|
+
liveInfo.backgroundURL = state.coverUrl
|
|
249
|
+
|
|
250
|
+
// 实例化您的直播开播视图控制器
|
|
251
|
+
let anchorVC = YourAnchorViewController(liveInfo: liveInfo, coreView: prepareView.getCoreView())
|
|
252
|
+
anchorVC.modalPresentationStyle = .fullScreen
|
|
253
|
+
// 跳转到您的直播开播视图控制器
|
|
254
|
+
present(anchorVC, animated: false)
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
// 响应返回按钮点击事件
|
|
258
|
+
public func onClickBackButton() {
|
|
259
|
+
if let nav = navigationController {
|
|
260
|
+
nav.popViewController(animated: true)
|
|
261
|
+
} else {
|
|
262
|
+
dismiss(animated: true)
|
|
263
|
+
}
|
|
264
|
+
}
|
|
265
|
+
}
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
###
|
|
269
|
+
|
|
270
|
+
## 自定义您的界面布局
|
|
271
|
+
|
|
272
|
+
`TUILiveKit` 支持灵活定制开播页与直播页的功能和样式,您可根据业务需求调整布局、隐藏 / 显示功能模块。
|
|
273
|
+
|
|
274
|
+
### 直播布局模板选择
|
|
275
|
+
|
|
276
|
+
`TUILiveKit` 提供 **4 种直播布局模板**,您可在主播开播页的 **UI 交互「布局」入口** 选择合适样式:
|
|
277
|
+
|
|
278
|
+
#### 布局模板一览:
|
|
279
|
+
| <strong>布局</strong> | <strong>动态宫格布局</strong> | <strong>浮动小窗布局</strong> | <strong>固定宫格布局</strong> | <strong>固定小窗布局</strong> |
|
|
280
|
+
| --- | --- | --- | --- | --- |
|
|
281
|
+
| <strong>模板取值</strong> | <code>.videoDynamicGrid9Seats</code> | <code>.videoDynamicFloat7Seats</code> | <code>.videoFixedGrid9Seats</code> | <code>.videoFixedFloat7Seats</code> |
|
|
282
|
+
| <strong>描述</strong> | 默认布局,可根据连麦人数动态调整宫格大小。 | 连麦嘉宾以浮动小窗形式显示。 | 连麦人数固定,每个嘉宾占据一个固定宫格。 | 连麦人数固定,嘉宾以固定小窗形式显示。 |
|
|
283
|
+
| <strong>预览</strong> | | | | |
|
|
284
|
+
|
|
285
|
+
### 自定义开播页功能区
|
|
286
|
+
|
|
287
|
+
通过调用 步骤 3 创建的 `prepareView` 的 API,可自定义隐藏开播准备页的操作区或特定功能:
|
|
288
|
+
|
|
289
|
+
【swift】
|
|
290
|
+
``` swift
|
|
291
|
+
import UIKit
|
|
292
|
+
import Snapkit
|
|
293
|
+
import TUILiveKit
|
|
294
|
+
import AtomicXCore
|
|
295
|
+
|
|
296
|
+
// YourAnchorPrepareViewController 代表您加载主播开播页的视图控制器
|
|
297
|
+
class YourAnchorPrepareViewController: UIViewController {
|
|
298
|
+
private let roomId = "testLiveId"
|
|
299
|
+
private lazy var prepareView: AnchorPrepareView = {
|
|
300
|
+
let view = AnchorPrepareView(roomId: roomId)
|
|
301
|
+
view.delegate = self
|
|
302
|
+
return view
|
|
303
|
+
}()
|
|
304
|
+
|
|
305
|
+
public override func viewDidLoad() {
|
|
306
|
+
super.viewDidLoad()
|
|
307
|
+
// 1. 将 prepareView 添加到视图上
|
|
308
|
+
view.addSubview(prepareView)
|
|
309
|
+
prepareView.snp.makeConstraints { make in
|
|
310
|
+
make.edges.equalToSuperview()
|
|
311
|
+
}
|
|
312
|
+
// 2. 自定义功能区 - 示例:隐藏美颜功能
|
|
313
|
+
prepareView.disableMenuBeauty(true)
|
|
314
|
+
}
|
|
315
|
+
}
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
|隐藏整个功能区|隐藏美颜按钮|隐藏音效按钮|隐藏摄像头切换按钮|
|
|
319
|
+
|---------|---------|---------|---------|
|
|
320
|
+
|`disableFeatureMenu(true)`|`disableMenuBeauty(true)`|`disableMenuAudioEffect(true)`|`disableMenuSwitchCamera(true)`|
|
|
321
|
+
|||||
|
|
322
|
+
|
|
323
|
+
### 自定义主播直播页界面
|
|
324
|
+
- 参考 主播核心页面 进行主播界面定制,在 `AnchorView` 中修改 UI 样式,添加您的业务组件。
|
|
325
|
+
|
|
326
|
+
- 参考 调整视频直播挂件 进行视频位挂件定制,在 `AnchorView` 中修改视频位上的名称、头像挂件等 UI。
|
|
327
|
+
|
|
328
|
+
### 文案定制
|
|
329
|
+
|
|
330
|
+
`TUILiveKit` 使用更为方便的 [Apple Strings Catalog](https://developer.apple.com/documentation/xcode/localizing-and-varying-text-with-a-string-catalog) 工具来管理 UI 所需的文案显示,您可以很直观的通过 Xcode 视图化管理工具修改需要调整的文案:
|
|
331
|
+
|
|
332
|
+
> **说明:**
|
|
333
|
+
>
|
|
334
|
+
> [Apple Strings Catalog](https://developer.apple.com/documentation/xcode/localizing-and-varying-text-with-a-string-catalog) (.xcstrings) 是在 Xcode 15 中引入的本地化格式。它增强了开发者管理本地化字符串的方式,支持处理复数、设备特定变体等的结构化格式。这种格式正成为管理 iOS 和 macOS 应用程序本地化的推荐方法。
|
|
335
|
+
>
|
|
336
|
+
|
|
337
|
+
### 图标定制
|
|
338
|
+
|
|
339
|
+
`TUILiveKit` 使用 `TUILiveKit.xcassets` 管理 UI 所需的图片资源,您可以借助 Xcode 图形化工具快速修改自定义界面所需的图标。
|
|
340
|
+
|
|
341
|
+
## 下一步
|
|
342
|
+
|
|
343
|
+
恭喜您,现在您已经成功集成了 **主播开播** 。接下来,您可以实现**观众观看**、**直播列表、礼物系统**等功能,可参考下表:
|
|
344
|
+
| <strong>功能</strong> | <strong>描述</strong> | <strong>集成指引</strong> |
|
|
345
|
+
| --- | --- | --- |
|
|
346
|
+
| <strong>观众观看</strong> | 实现观众进入主播的直播间后观看直播,实现观众连麦 、直播间信息、在线观众、弹幕显示等功能。 | 观众观看 |
|
|
347
|
+
| <strong>直播列表</strong> | 展示直播列表界面和功能,包含直播列表,房间信息展示功能。 | 直播列表 |
|
|
348
|
+
| <strong>礼物系统</strong> | 实现自定义礼物素材配置、计费系统对接、PK 场景互动等功能。 | 礼物系统 |
|
|
349
|
+
|
|
350
|
+
## 常见问题
|
|
351
|
+
|
|
352
|
+
### 开播后无画面?
|
|
353
|
+
|
|
354
|
+
请前往手机**设置** > **App** > **相机**,检查摄像头权限是否开启,可参考下图:
|
|
355
|
+
|
|
356
|
+
### 点击开播按钮无法开播,提示“未登录”?
|
|
357
|
+
|
|
358
|
+
参考 登录指引, 确认已完成登录功能接入。
|
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
## 功能预览
|
|
2
|
+
|
|
3
|
+
本文对 TUILiveKit 中的**直播列表页面**进行了详细的介绍,您可以在已有项目中直接参考本文档集成我们开发好的直播列表页面,也可以根据您的需求按照文档中的内容对页面的样式,布局以及功能项进行深度的定制。
|
|
4
|
+
- **双列瀑布流**:默认同时预览2个直播间的画面。
|
|
5
|
+
|
|
6
|
+
- **单列瀑布流**:默认同时预览1个直播间的画面(**仅视频直播支持单列预览**)。
|
|
7
|
+
|
|
8
|
+
| 双列瀑布流 | 单列瀑布流 |
|
|
9
|
+
| --- | --- |
|
|
10
|
+
| | ### |
|
|
11
|
+
|
|
12
|
+
> **注意:**
|
|
13
|
+
>
|
|
14
|
+
> 预览直播间画面时,预览时长都会被计入观众的音视频时长,组件详细计费相关内容请参考 计费说明。
|
|
15
|
+
>
|
|
16
|
+
|
|
17
|
+
## 快速接入
|
|
18
|
+
|
|
19
|
+
### 步骤1:开通服务
|
|
20
|
+
|
|
21
|
+
参考 开通服务 文档开通「体验版」或「大规模直播版」套餐。
|
|
22
|
+
|
|
23
|
+
### 步骤2:代码集成
|
|
24
|
+
|
|
25
|
+
参考 准备工作 接入 `TUILiveKit`。
|
|
26
|
+
|
|
27
|
+
### 步骤3:添加直播列表瀑布流视图
|
|
28
|
+
|
|
29
|
+
您可以根据需要选择使用单列或双列瀑布流。
|
|
30
|
+
|
|
31
|
+
【Swift】
|
|
32
|
+
``` swift
|
|
33
|
+
// 示例: YourLiveListViewController 代表您直播列表瀑布流的视图控制器
|
|
34
|
+
class YourLiveListViewController: UIViewController {
|
|
35
|
+
|
|
36
|
+
// 1. 声明 liveListView 作为成员变量
|
|
37
|
+
// - style: .doubleColumn // 双列瀑布流
|
|
38
|
+
// - style: .singleColumn // 单列瀑布流
|
|
39
|
+
// 示例为双列瀑布流,如需单列传入 .singleColumn即可
|
|
40
|
+
private let liveListView = LiveListView(style: .doubleColumn)
|
|
41
|
+
|
|
42
|
+
public override func viewDidLoad() {
|
|
43
|
+
super.viewDidLoad()
|
|
44
|
+
// 2. 将 liveListView 添加到视图上
|
|
45
|
+
view.addSubview(liveListView)
|
|
46
|
+
liveListView.snp.makeConstraints { make in
|
|
47
|
+
make.edges.equalToSuperview()
|
|
48
|
+
}
|
|
49
|
+
// 3. 设置列表的点击事件代理
|
|
50
|
+
liveListView.itemClickDelegate = self
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### 步骤4:实现直播列表页到观众观看页的路由跳转
|
|
56
|
+
|
|
57
|
+
**双列瀑布流直播列表** 和 **单列瀑布流** 均会通过 `OnItemClickDelegate`回调点击事件,您只需在直播列表视图控制器中实现 `OnItemClickDelegate` 来响应用户的点击事件,并在 `onItemClick` 中实现跳转进入观众观看页的功能,观众观看页的实现可参考 观众观看:
|
|
58
|
+
|
|
59
|
+
**交互示例:**
|
|
60
|
+
|
|
61
|
+
**代码示例**:
|
|
62
|
+
|
|
63
|
+
【Swift】
|
|
64
|
+
``` swift
|
|
65
|
+
// 在您的直播瀑布流列表视图控制器中实现 OnItemClickDelegate, 示例:YourLiveListViewController
|
|
66
|
+
extension YourLiveListViewController: OnItemClickDelegate {
|
|
67
|
+
|
|
68
|
+
func onItemClick(liveInfo: LiveInfo, frame: CGRect) {
|
|
69
|
+
// 1. 实例化您的观众观看视图控制器
|
|
70
|
+
let audienceVC = YourAudienceViewController(roomId: liveInfo.roomId)
|
|
71
|
+
audienceVC.modalPresentationStyle = .fullScreen
|
|
72
|
+
// 2. 跳转到您的观众观看视图控制器
|
|
73
|
+
present(audienceVC, animated: false)
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
}
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### 步骤5:直播列表的页面跳转交互优化
|
|
80
|
+
|
|
81
|
+
为了让您在页面跳转过程中获得更加完整与流畅的体验,结合 iOS 页面路由的系统特性,`LiveListView` 组件提供了 `refreshLiveList` 和 `onRouteToNextPage` 方法,方便您仅通过简单的一行代码调用,就能优化直播列表展示与视频流播放体验。具体优化方式如下:
|
|
82
|
+
|
|
83
|
+
【Swift】
|
|
84
|
+
``` swift
|
|
85
|
+
// 在您的直播瀑布流列表视图控制器中实现,示例:YourLiveListViewController
|
|
86
|
+
class YourLiveListViewController: UIViewController {
|
|
87
|
+
|
|
88
|
+
override func viewDidAppear(_ animated: Bool) {
|
|
89
|
+
super.viewDidAppear(animated)
|
|
90
|
+
// refreshLiveList: 在viewDidAppear时调用此方法,以确保每次回到当前页面都能拿到最新的列表
|
|
91
|
+
liveListView.refreshLiveList()
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
override func viewWillDisappear(_ animated: Bool) {
|
|
95
|
+
super.viewWillDisappear(animated)
|
|
96
|
+
// onRouteToNextPage: 在viewWillDisappear时调用此方法,当您进入别的页面时停止当前直播列表页播放的视频流
|
|
97
|
+
liveListView.onRouteToNextPage()
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
## 自定义您的界面布局
|
|
103
|
+
|
|
104
|
+
TUILiveKit 提供了灵活的接口定制直播列表瀑布流组件,您可以根据业务需求自定义数据源和列表项样式。
|
|
105
|
+
|
|
106
|
+
### 自定义数据源
|
|
107
|
+
|
|
108
|
+
如果您的后台有单独的直播列表数据,可以通过实现 `LiveListDataSource` 接口来自定义数据源,而不使用组件默认的列表数据。
|
|
109
|
+
|
|
110
|
+
【Swift】
|
|
111
|
+
``` swift
|
|
112
|
+
// 示例:YourLiveListViewController 代表您直播列表瀑布流的视图控制器
|
|
113
|
+
class YourLiveListViewController: UIViewController {
|
|
114
|
+
|
|
115
|
+
private let liveListView: LiveListView = LiveListView(style: .doubleColumn)
|
|
116
|
+
|
|
117
|
+
public override func viewDidLoad() {
|
|
118
|
+
super.viewDidLoad()
|
|
119
|
+
view.addSubview(liveListView)
|
|
120
|
+
liveListView.snp.makeConstraints { make in
|
|
121
|
+
make.edges.equalToSuperview()
|
|
122
|
+
}
|
|
123
|
+
liveListView.itemClickDelegate = self
|
|
124
|
+
// 1. 设置自定义数据源代理
|
|
125
|
+
liveListView.dataSource = self
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
// 2. 实现自定义数据源代理: LiveListDataSource
|
|
130
|
+
extension YourLiveListViewController: LiveListDataSource {
|
|
131
|
+
|
|
132
|
+
public func fetchLiveList(cursor: String, onSuccess: @escaping LiveListBlock, onError: @escaping TUIErrorBlock) {
|
|
133
|
+
// 3. 对接自己的业务后台,按照下面的格式返回数据给UI组件
|
|
134
|
+
var liveInfoList: [LiveInfo] = []
|
|
135
|
+
var liveInfo = LiveInfo()
|
|
136
|
+
liveInfo.roomId = "live_123456"
|
|
137
|
+
liveInfo.name = "live_123456"
|
|
138
|
+
liveInfoList.append(liveInfo)
|
|
139
|
+
let cursor = "aabbccdd"
|
|
140
|
+
onSuccess(cursor, liveInfoList)
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### 自定义挂件
|
|
146
|
+
|
|
147
|
+
瀑布流列表项底部默认显示视频流画面或直播封面。如果您需要自定义列表项顶部的 UI 元素(例如主播头像、直播标题等),可以通过实现 `LiveListViewAdapter` 接口来完成。
|
|
148
|
+
|
|
149
|
+
【Swift】
|
|
150
|
+
``` swift
|
|
151
|
+
// 示例:YourLiveListViewController 代表您直播列表瀑布流的视图控制器
|
|
152
|
+
class YourLiveListViewController: UIViewController {
|
|
153
|
+
|
|
154
|
+
private let liveListView: LiveListView = LiveListView(style: .doubleColumn)
|
|
155
|
+
|
|
156
|
+
public override func viewDidLoad() {
|
|
157
|
+
super.viewDidLoad()
|
|
158
|
+
view.addSubview(liveListView)
|
|
159
|
+
liveListView.snp.makeConstraints { make in
|
|
160
|
+
make.edges.equalToSuperview()
|
|
161
|
+
}
|
|
162
|
+
liveListView.itemClickDelegate = self
|
|
163
|
+
liveListView.dataSource = self
|
|
164
|
+
// 1. 设置自定义挂件代理
|
|
165
|
+
liveListView.adapter = self
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
// 2. 实现自定义挂件代理
|
|
170
|
+
extension YourLiveListViewController: LiveListViewAdapter {
|
|
171
|
+
public func createLiveInfoView(info: LiveInfo) -> UIView {
|
|
172
|
+
// 自定义挂件view
|
|
173
|
+
return YourCustomView(liveInfo: info)
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
public func updateLiveInfoView(view: UIView, info: LiveInfo) {
|
|
177
|
+
if let infoView = view as? YourCustomView {
|
|
178
|
+
// 更新挂件view中绑定的数据
|
|
179
|
+
infoView.updateView(liveInfo: info)
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
}
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### 自定义转场动画
|
|
186
|
+
|
|
187
|
+
在**双列瀑布流直播列表**和**单列瀑布流**中跳转到观众观看页,为了转场效果更好,往往需要自定义转场动画。 `TUILiveKit` 在 `GitHub` 仓库开源了直播转场动画 [LiveTransitioningDelegate](https://github.com/Tencent-RTC/TUILiveKit/blob/main/iOS/TUILiveKit/Sources/TUILiveListViewController.swift#L193) ,您只需设置 `audienceVC.transitioningDelegate` 即可实现跟 TUILiveKit 一样的转场动画:
|
|
188
|
+
|
|
189
|
+
【Swift】
|
|
190
|
+
``` swift
|
|
191
|
+
// 在您的直播瀑布流列表视图控制器中的 OnItemClickDelegate 回调中, 示例:YourLiveListViewController
|
|
192
|
+
extension YourLiveListViewController: OnItemClickDelegate {
|
|
193
|
+
|
|
194
|
+
func onItemClick(liveInfo: LiveInfo, frame: CGRect) {
|
|
195
|
+
let audienceVC = YourAudienceViewController(roomId: liveInfo.roomId)
|
|
196
|
+
audienceVC.modalPresentationStyle = .fullScreen
|
|
197
|
+
// 设置过渡动画代理
|
|
198
|
+
audienceVC.transitioningDelegate = LiveTransitioningDelegate(originFrame: frame)
|
|
199
|
+
present(audienceVC, animated: false)
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
}
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
|**双列瀑布流直播列表转场动画**|**单列瀑布流转场动画**|
|
|
206
|
+
|---------|---------|
|
|
207
|
+
|||
|
|
208
|
+
|
|
209
|
+
## 下一步
|
|
210
|
+
|
|
211
|
+
恭喜您,现在您已经成功集成了 **直播列表** 功能。接下来,您可以根据您的业务场景实现**主播开播、观众观看**等功能
|
|
212
|
+
|
|
213
|
+
**视频直播场景:**
|
|
214
|
+
| <strong>功能</strong> | <strong>描述</strong> | <strong>集成指引</strong> |
|
|
215
|
+
| --- | --- | --- |
|
|
216
|
+
| <strong>主播开播</strong> | 实现主播开播全流程功能,包括开播前的准备和开播后的各种互动 | 主播开播 |
|
|
217
|
+
| <strong>观众观看</strong> | 实现观众进入主播的直播间后观看直播,实现观众连麦 、直播间信息、在线观众、弹幕显示等功能 | 观众观看 |
|
|
218
|
+
|
|
219
|
+
**语聊房场景:**
|
|
220
|
+
| <strong>功能</strong> | <strong>描述</strong> | <strong>集成指引</strong> |
|
|
221
|
+
| --- | --- | --- |
|
|
222
|
+
| <strong>主播开播</strong> | 实现主播开播语聊房全流程功能,包括开播前的准备和开播后的各种互动。 | 主播开播 |
|
|
223
|
+
| <strong>观众观看</strong> | 实现观众进入主播的语聊房后进行互动,如上麦、收发弹幕等功能。 | 观众观看 |
|
|
224
|
+
|
|
225
|
+
## 常见问题
|
|
226
|
+
|
|
227
|
+
### 集成直播列表功能后页面没有任何直播怎么办?
|
|
228
|
+
|
|
229
|
+
如果您看到空白页面,需要检查您是否已完成 登录步骤。为了测试该功能,您可以使用两台设备:一台设备用于开播,另一台设备在直播列表页面,就能拉取到已开播的直播间。
|
|
230
|
+
|
|
231
|
+
### 单列瀑布流和双列瀑布流有什么区别?
|
|
232
|
+
|
|
233
|
+
单列瀑布流一次预览一个直播间画面,而双列瀑布流则同时预览两个直播间画面。您可以根据自己的设计需求选择合适的布局。
|
|
234
|
+
|
|
235
|
+
### 预览直播画面是否收费?
|
|
236
|
+
|
|
237
|
+
是的,预览直播间画面时长会计入观众的音视频时长,这部分是需要付费的。详细的 计费说明 可以参考文档中的相关内容。
|
|
238
|
+
|
|
239
|
+
### 我使用了自定义数据源 (LiveListDataSource),但列表不显示/不刷新怎么办?
|
|
240
|
+
|
|
241
|
+
请确保您正确实现了 `LiveListDataSource` 接口。重点检查以下几点:
|
|
242
|
+
- 检查 `fetchLiveList` 方法是否被正确调用。
|
|
243
|
+
|
|
244
|
+
- 确保在获取数据后(无论成功或失败)都调用了 `callback.onSuccess` 或 `callback.onFailure`。
|
|
245
|
+
|
|
246
|
+
- 检查您的业务后台接口是否返回了正确的数据格式。
|