@tencentcloud/sdk-mcp 1.4.7 → 1.6.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.js +0 -1
- package/knowledge/bm25-cache.js +73 -0
- package/knowledge/bm25.js +147 -0
- package/knowledge/build-index.js +65 -0
- package/knowledge/chunker.js +167 -0
- package/knowledge/content-loader.js +44 -0
- package/knowledge/extractors.js +25 -0
- package/knowledge/path-meta.js +175 -0
- package/knowledge/search/exact-lookup.js +330 -0
- package/knowledge/search/filter-pool.js +86 -0
- package/knowledge/search/requires-framework.js +72 -0
- package/knowledge/search/search-knowledge.js +226 -0
- package/package.json +9 -9
- package/resource/_schema/feature-aliases.yaml +10 -0
- package/resource/_schema/goal-tags.yaml +72 -0
- package/resource/_schema/products.yaml +16 -0
- package/resource/_schema/trtc-intents.yaml +27 -0
- package/resource/_schema/types.yaml +44 -0
- package/resource/index/component-slugs.json +1 -0
- package/resource/index/manifest.json +1 -0
- package/resource/{doc → integration}/callkit/preset/android/integration.md +32 -28
- package/resource/{doc → integration}/callkit/preset/flutter/integration.md +109 -54
- package/resource/integration/callkit/preset/ios/integration.md +411 -0
- package/resource/integration/callkit/preset/react/integration.md +499 -0
- package/resource/integration/callkit/preset/vue/integration.md +768 -0
- package/resource/{doc/chatkit → integration/chat/preset}/android/integration.md +11 -11
- package/resource/{doc/chatkit → integration/chat/preset}/flutter/integration.md +59 -37
- package/resource/integration/chat/preset/ios/integration.md +568 -0
- package/resource/{doc/chatkit → integration/chat/preset}/react/integration.md +127 -95
- package/resource/integration/chat/preset/uni-app/integration.md +494 -0
- package/resource/{doc/chatkit → integration/chat/preset}/vue/integration.md +163 -143
- package/resource/{doc → integration}/livekit/preset/live/vue/live-list-integration.md +15 -15
- package/resource/{doc → integration}/livekit/preset/live/vue/live-player-desk-integration.md +25 -13
- package/resource/{doc → integration}/livekit/preset/live/vue/live-player-h5-integration.md +15 -9
- package/resource/{doc → integration}/livekit/preset/live/vue/live-pusher-integration.md +31 -26
- package/resource/integration/roomkit/preset/vue/integration.md +571 -0
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +852 -0
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +929 -0
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +364 -0
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +1150 -0
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +1216 -0
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +412 -0
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1191 -0
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +1292 -0
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +537 -0
- package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +953 -0
- package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +1061 -0
- package/resource/knowledge/callkit/faq/android.md +168 -0
- package/resource/knowledge/callkit/faq/common.md +180 -0
- package/resource/knowledge/callkit/faq/flutter.md +52 -0
- package/resource/knowledge/callkit/faq/ios.md +116 -0
- package/resource/knowledge/callkit/faq/uniapp-app.md +89 -0
- package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +217 -0
- package/resource/knowledge/callkit/faq/web.md +363 -0
- package/resource/knowledge/callkit/preset/android/api.md +413 -0
- package/resource/knowledge/callkit/preset/flutter/api.md +22 -0
- package/resource/knowledge/callkit/preset/ios/api.md +256 -0
- package/resource/knowledge/callkit/preset/web/api.md +79 -0
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +72 -0
- package/resource/knowledge/chat/preset/android/features/contact-list.md +41 -0
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +123 -0
- package/resource/knowledge/chat/preset/android/features/language.md +142 -0
- package/resource/knowledge/chat/preset/android/features/message-input.md +57 -0
- package/resource/knowledge/chat/preset/android/features/message-list.md +142 -0
- package/resource/knowledge/chat/preset/android/features/search.md +64 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/android/features/theme.md +21 -18
- package/resource/knowledge/chat/preset/android-view/integration.md +448 -0
- package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +62 -0
- package/resource/knowledge/chat/preset/flutter/features/contact-list.md +40 -0
- package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +129 -0
- package/resource/knowledge/chat/preset/flutter/features/language.md +104 -0
- package/resource/knowledge/chat/preset/flutter/features/message-input.md +54 -0
- package/resource/knowledge/chat/preset/flutter/features/message-list.md +163 -0
- package/resource/knowledge/chat/preset/flutter/features/search.md +59 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/flutter/features/theme.md +47 -19
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +92 -0
- package/resource/knowledge/chat/preset/ios/features/contact-list.md +119 -0
- package/resource/knowledge/chat/preset/ios/features/conversation-list.md +134 -0
- package/resource/knowledge/chat/preset/ios/features/language.md +105 -0
- package/resource/knowledge/chat/preset/ios/features/message-input.md +69 -0
- package/resource/knowledge/chat/preset/ios/features/message-list.md +164 -0
- package/resource/knowledge/chat/preset/ios/features/search.md +94 -0
- package/resource/{doc/chatkit → knowledge/chat/preset}/ios/features/theme.md +54 -51
- package/resource/{doc/chatkit/ios → knowledge/chat/preset/ios-uikit}/integration.md +157 -94
- package/resource/knowledge/chat/preset/react/features/chat-setting.md +123 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/contact-list.md +256 -104
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +217 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/conversation-list.md +86 -79
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +99 -0
- package/resource/knowledge/chat/preset/react/features/conversation-search.md +58 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-input.md +30 -83
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-list.md +22 -25
- package/resource/knowledge/chat/preset/react/features/search.md +531 -0
- package/resource/knowledge/chat/preset/react/features/theme.md +16 -0
- package/resource/knowledge/chat/preset/vue/features/chat-header.md +331 -0
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/chat-setting.md +0 -4
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/contact-list.md +59 -53
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-actions.md +49 -43
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-list.md +61 -49
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-preview.md +43 -40
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-search.md +1 -1
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-input.md +128 -105
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/message-list.md +108 -195
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/search.md +74 -68
- package/resource/knowledge/chat/preset/vue/features/theme.md +136 -0
- package/resource/knowledge/chat/urls/error-code.md +16 -0
- package/resource/knowledge/chat/urls/product.md +61 -0
- package/resource/knowledge/chat/urls/restapi.md +226 -0
- package/resource/knowledge/chat/urls/sdk/android.md +84 -0
- package/resource/knowledge/chat/urls/sdk/flutter.md +73 -0
- package/resource/knowledge/chat/urls/sdk/ios.md +84 -0
- package/resource/knowledge/chat/urls/sdk/web.md +88 -0
- package/resource/knowledge/chat/urls/webhook.md +73 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/AudioEffectStore.md +79 -76
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +174 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +329 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/CameraView.md +7 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +434 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +362 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +466 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +173 -0
- package/resource/{doc/livekit/core-sdk/live/android/api-reference → knowledge/livekit/core-sdk/api-reference/android}/LikeStore.md +12 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +291 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +78 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +439 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +221 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/AudioEffectStore.md +79 -76
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +212 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/BaseBeautyStore.md +43 -45
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +312 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +404 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +334 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +420 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +166 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LikeStore.md +12 -11
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +281 -0
- package/resource/{doc/livekit/core-sdk/live/flutter/api-reference → knowledge/livekit/core-sdk/api-reference/flutter}/LiveCoreView.md +49 -42
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +397 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +183 -0
- package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/AudioEffectStore.md +79 -75
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +192 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +146 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +309 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +370 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +339 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +503 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +188 -0
- package/resource/{doc/livekit/core-sdk/live/ios/api-reference → knowledge/livekit/core-sdk/api-reference/ios}/LikeStore.md +12 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +289 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +78 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +434 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +187 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/web/index.md +780 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audience-list.md +59 -51
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audio-effect.md +37 -34
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-barrage.md +68 -38
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-base-beauty.md +18 -15
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-co-guest-interaction.md +17 -17
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-gift.md +86 -80
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-host-interaction.md +53 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-integration.md +47 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-live-list.md +26 -22
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audience-list.md +16 -13
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-barrage.md +33 -21
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-base-beauty.md +29 -25
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-co-guest-interaction.md +21 -20
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-gift.md +78 -69
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-host-interaction.md +47 -43
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-integration.md +48 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-live-list.md +27 -23
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audience-list.md +15 -12
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audio-effect.md +39 -36
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-barrage.md +42 -29
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-base-beauty.md +19 -16
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-co-guest-interaction.md +20 -19
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-gift.md +55 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-host-interaction.md +50 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-integration.md +48 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-live-list.md +26 -22
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audience-list.md +59 -51
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audio-effect.md +41 -38
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-barrage.md +67 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +53 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-gift.md +86 -80
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-host-interaction.md +45 -40
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-integration.md +43 -42
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-room-list.md +523 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audience-list.md +16 -13
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-audio-effect.md +54 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-barrage.md +33 -21
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +34 -28
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-gift.md +73 -64
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-integration.md +46 -43
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-room-list.md +165 -148
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audience-list.md +19 -16
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audio-effect.md +40 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-barrage.md +41 -28
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +54 -47
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-gift.md +52 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-host-interaction.md +55 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-integration.md +47 -45
- package/resource/knowledge/livekit/core-sdk/voice/ios/voice-room-list.md +404 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audience-list.md +40 -57
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-audio-effect.md +38 -49
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-barrage.md +53 -53
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-co-guest-interaction.md +106 -116
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-gift.md +49 -59
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-integration.md +52 -45
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/uni-app/voice-room-list.md +38 -46
- package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +915 -0
- package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +179 -0
- package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +419 -0
- package/resource/knowledge/push/config/android/fcm.md +133 -0
- package/resource/knowledge/push/config/android/honor.md +111 -0
- package/resource/knowledge/push/config/android/huawei.md +106 -0
- package/resource/knowledge/push/config/android/meizu.md +121 -0
- package/resource/knowledge/push/config/android/oppo.md +108 -0
- package/resource/knowledge/push/config/android/vivo.md +101 -0
- package/resource/knowledge/push/config/android/xiaomi.md +99 -0
- package/resource/knowledge/push/integration/android.md +1028 -0
- package/resource/knowledge/push/integration/donut.md +271 -0
- package/resource/knowledge/push/integration/flutter.md +363 -0
- package/resource/knowledge/push/integration/harmonyos.md +72 -0
- package/resource/knowledge/push/integration/ios.md +705 -0
- package/resource/knowledge/push/integration/react-native.md +337 -0
- package/resource/knowledge/push/integration/uni-app.md +461 -0
- package/resource/knowledge/push/integration/unity.md +357 -0
- package/resource/knowledge/push/integration/unreal-engine.md +353 -0
- package/resource/knowledge/push/overview/prepare.md +30 -0
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/call-user-to-room.md +22 -20
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-participant-state.md +22 -193
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/room-state.md +33 -32
- package/resource/{doc/roomkit/android/features → knowledge/roomkit/core-sdk/android}/schedule-room.md +30 -29
- package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +230 -0
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-participant-state.md +22 -21
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/room-state.md +29 -28
- package/resource/{doc/roomkit/flutter/features → knowledge/roomkit/core-sdk/flutter}/schedule-room.md +17 -16
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/call-user-to-room.md +22 -20
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-participant-state.md +49 -218
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/room-state.md +37 -37
- package/resource/{doc/roomkit/ios/features → knowledge/roomkit/core-sdk/ios}/schedule-room.md +28 -28
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/call-user-to-room.md +122 -7
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/device-detection.md +318 -3
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +1504 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/free-beauty-panel.md +4 -3
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +709 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +1105 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +635 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +529 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/schedule-room.md +256 -13
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/screen-share.md +218 -25
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/virtual-background.md +4 -3
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/android/integration.md +50 -64
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/flutter/integration.md +34 -31
- package/resource/{doc/roomkit → knowledge/roomkit/preset}/ios/integration.md +45 -53
- package/resource/knowledge/roomkit/preset/react/integration.md +571 -0
- package/resource/{doc → knowledge}/rtcengine/web/how_to_run_web_sdk_demo.md +31 -15
- package/resource/{doc → knowledge}/rtcengine/web/plugin/21-advanced-auto-play-policy.md +9 -3
- package/resource/{doc → knowledge}/rtcengine/web/plugin/22-advanced-audio-mixer.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/23-advanced-support-detection.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/24-advanced-network-quality.md +6 -6
- package/resource/{doc → knowledge}/rtcengine/web/plugin/25-advanced-device-change.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +4 -4
- package/resource/{doc → knowledge}/rtcengine/web/plugin/27-advanced-small-stream.md +4 -4
- package/resource/{doc → knowledge}/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
- package/resource/{doc → knowledge}/trtc/android/TRTCCloud.md +547 -495
- package/resource/{doc → knowledge}/trtc/android/TRTCCloudDef.md +434 -403
- package/resource/{doc → knowledge}/trtc/android/TRTCCloudListener.md +394 -348
- package/resource/{doc → knowledge}/trtc/android/TRTCStatistics.md +17 -15
- package/resource/{doc → knowledge}/trtc/android/TXAudioEffectManager.md +227 -197
- package/resource/knowledge/trtc/android/TXBeautyManager.md +415 -0
- package/resource/{doc → knowledge}/trtc/android/TXDeviceManager.md +70 -63
- package/resource/{doc → knowledge}/trtc/android/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCCloud.md +599 -544
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/ITRTCStatistics.md +17 -15
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +502 -0
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +403 -0
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCCloudCallback.md +439 -387
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TRTCTypeDef.md +417 -387
- package/resource/{doc/trtc/C++ → knowledge/trtc/c++}/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloud.md +619 -559
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCCloudDelegate.md +409 -360
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TRTCStatistics.md +17 -15
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXAudioEffectManager.md +187 -164
- package/resource/knowledge/trtc/ios/TXBeautyManager.md +416 -0
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +399 -0
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiteAVCode.md +19 -17
- package/resource/{doc/trtc/iOS → knowledge/trtc/ios}/TXLiveSDKTypeDef.md +422 -396
- package/server-config.js +0 -1
- package/server.js +22 -12
- package/streamable-http.js +0 -1
- package/tools/call/get_native_call_uikit_integration.js +2 -4
- package/tools/call/get_native_callkit_core_integration.js +2 -6
- package/tools/call/get_web_call_uikit_integration.js +2 -4
- package/tools/chat/get_native_chat_uikit_integration.js +2 -4
- package/tools/chat/get_web_chat_uikit_integration.js +2 -4
- package/tools/common/get_usersig.js +0 -1
- package/tools/common/present_framework_choice.js +9 -4
- package/tools/common/record_answer.js +19 -26
- package/tools/common/record_feedback.js +17 -31
- package/tools/common/search_trtc_knowledge.js +44 -0
- package/tools/definitions/get_native_call_uikit_integration_def.js +2 -1
- package/tools/definitions/get_native_callkit_core_integration_def.js +2 -1
- package/tools/definitions/get_native_chat_uikit_integration_def.js +3 -2
- package/tools/definitions/get_native_livekit_core_integration_def.js +2 -1
- package/tools/definitions/get_usersig_def.js +0 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js +2 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js +2 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js +4 -3
- package/tools/definitions/get_web_room_core_integration_def.js +46 -0
- package/tools/definitions/get_web_room_uikit_integration_def.js +3 -1
- package/tools/definitions/integration-boundary.js +5 -0
- package/tools/definitions/present_framework_choice_def.js +11 -10
- package/tools/definitions/record_answer_def.js +6 -5
- package/tools/definitions/record_feedback_def.js +4 -3
- package/tools/definitions/search_trtc_knowledge_def.js +69 -0
- package/tools/index.js +5 -37
- package/tools/live/get_native_livekit_core_integration.js +1 -4
- package/tools/live/get_web_live_uikit_integration.js +2 -5
- package/tools/room/get_web_room_core_integration.js +47 -0
- package/tools/room/get_web_room_uikit_integration.js +2 -4
- package/utils/generate-structured-result.js +4 -11
- package/utils/generate-usersig.js +0 -1
- package/utils/get-device-identifier.js +0 -1
- package/utils/get-doc-content.js +14 -9
- package/utils/http-get.js +0 -1
- package/utils/http-post.js +0 -1
- package/utils/report-cls-client.js +22 -21
- package/utils/report-es-client.js +1 -2
- package/utils/report-runtime-error-cls-client.js +0 -1
- package/index.js.map +0 -1
- package/resource/doc/callkit/core-sdk/.gitkeep +0 -0
- package/resource/doc/callkit/core-sdk/android/answer-call.md +0 -942
- package/resource/doc/callkit/core-sdk/android/make-call.md +0 -876
- package/resource/doc/callkit/core-sdk/android/offline-push.md +0 -368
- package/resource/doc/callkit/core-sdk/flutter/answer-call.md +0 -1132
- package/resource/doc/callkit/core-sdk/flutter/make-call.md +0 -1206
- package/resource/doc/callkit/core-sdk/flutter/offline-push.md +0 -357
- package/resource/doc/callkit/core-sdk/ios/answer-call.md +0 -1009
- package/resource/doc/callkit/core-sdk/ios/make-call.md +0 -1154
- package/resource/doc/callkit/core-sdk/ios/offline-push.md +0 -470
- package/resource/doc/callkit/core-sdk/uni-app/answer-call.md +0 -1146
- package/resource/doc/callkit/core-sdk/uni-app/make-call.md +0 -1267
- package/resource/doc/callkit/faq/android-faq.md +0 -767
- package/resource/doc/callkit/faq/flutter-faq.md +0 -749
- package/resource/doc/callkit/faq/ios-faq.md +0 -759
- package/resource/doc/callkit/faq/web-faq.md +0 -753
- package/resource/doc/callkit/preset/android/api.md +0 -330
- package/resource/doc/callkit/preset/flutter/api.md +0 -401
- package/resource/doc/callkit/preset/ios/api.md +0 -282
- package/resource/doc/callkit/preset/ios/integration.md +0 -188
- package/resource/doc/callkit/preset/react/api.md +0 -600
- package/resource/doc/callkit/preset/react/integration.md +0 -86
- package/resource/doc/callkit/preset/vue/api.md +0 -600
- package/resource/doc/callkit/preset/vue/integration.md +0 -83
- package/resource/doc/chatkit/android/faq.md +0 -109
- package/resource/doc/chatkit/faq/android_sdk/client-api.md +0 -280
- package/resource/doc/chatkit/faq/common/product.md +0 -82
- package/resource/doc/chatkit/faq/common/server.md +0 -53
- package/resource/doc/chatkit/faq/common/server_error_code.md +0 -74
- package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +0 -183
- package/resource/doc/chatkit/faq/flutter_sdk/faq.md +0 -54
- package/resource/doc/chatkit/faq/ios_sdk/client-api.md +0 -279
- package/resource/doc/chatkit/faq/web_sdk/error_code.md +0 -47
- package/resource/doc/chatkit/faq/web_sdk/faq.md +0 -292
- package/resource/doc/chatkit/flutter/faq.md +0 -22
- package/resource/doc/chatkit/ios/faq.md +0 -109
- package/resource/doc/chatkit/react/components/avatar.md +0 -104
- package/resource/doc/chatkit/react/components/chat-header.md +0 -148
- package/resource/doc/chatkit/react/components/chat-setting.md +0 -117
- package/resource/doc/chatkit/react/components/chat.md +0 -38
- package/resource/doc/chatkit/react/components/component-list.md +0 -35
- package/resource/doc/chatkit/react/components/conversation-actions.md +0 -174
- package/resource/doc/chatkit/react/components/conversation-preview.md +0 -116
- package/resource/doc/chatkit/react/components/conversation-search.md +0 -57
- package/resource/doc/chatkit/react/components/search.md +0 -282
- package/resource/doc/chatkit/react/components/tuikit.md +0 -43
- package/resource/doc/chatkit/react/faq.md +0 -26
- package/resource/doc/chatkit/vue/components/avatar.md +0 -104
- package/resource/doc/chatkit/vue/components/chat-header.md +0 -149
- package/resource/doc/chatkit/vue/components/chat.md +0 -42
- package/resource/doc/chatkit/vue/components/component-list.md +0 -89
- package/resource/doc/chatkit/vue/components/tuikit.md +0 -45
- package/resource/doc/chatkit/vue/components/userpicker.md +0 -256
- package/resource/doc/chatkit/vue/faq.md +0 -35
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +0 -148
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +0 -316
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +0 -419
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +0 -325
- package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +0 -436
- package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +0 -165
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +0 -239
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +0 -74
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +0 -417
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +0 -207
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +0 -158
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +0 -304
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +0 -394
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +0 -303
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +0 -410
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +0 -160
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +0 -231
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +0 -375
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +0 -170
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +0 -165
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +0 -143
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +0 -298
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +0 -349
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +0 -297
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +0 -471
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +0 -179
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +0 -238
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +0 -74
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +0 -412
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +0 -173
- package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +0 -365
- package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +0 -336
- package/resource/doc/livekit/preset/live/vue/api-reference/index.md +0 -780
- package/resource/doc/livekit/preset/live/vue/components/barrage.md +0 -291
- package/resource/doc/livekit/preset/live/vue/components/co-guest-panel.md +0 -88
- package/resource/doc/livekit/preset/live/vue/components/live-audience-list.md +0 -164
- package/resource/doc/livekit/preset/live/vue/components/live-scene-panel.md +0 -130
- package/resource/doc/livekit/preset/live/vue/components/live-view.md +0 -203
- package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +0 -211
- package/resource/doc/livekit/preset/live/vue/faq.md +0 -1
- package/resource/doc/roomkit/faq/common/error-code.md +0 -67
- package/resource/doc/roomkit/flutter/features/call-user-to-room.md +0 -228
- package/resource/doc/roomkit/vue/faq.md +0 -1
- package/resource/doc/roomkit/vue/features/device-state.md +0 -460
- package/resource/doc/roomkit/vue/features/room-chat.md +0 -369
- package/resource/doc/roomkit/vue/features/room-participant-state.md +0 -385
- package/resource/doc/roomkit/vue/features/room-state.md +0 -280
- package/resource/doc/roomkit/vue/features/room-view.md +0 -241
- package/resource/doc/roomkit/vue/integration.md +0 -315
- package/resource/doc/rtcengine/faq/web_sdk/.gitkeep +0 -0
- package/resource/doc/trtc/C++/ITXAudioEffectManager.md +0 -472
- package/resource/doc/trtc/C++/ITXDeviceManager.md +0 -388
- package/resource/doc/trtc/android/TXBeautyManager.md +0 -403
- package/resource/doc/trtc/iOS/TXBeautyManager.md +0 -404
- package/resource/doc/trtc/iOS/TXDeviceManager.md +0 -382
- package/server-config.js.map +0 -1
- package/server.js.map +0 -1
- package/streamable-http.js.map +0 -1
- package/tools/call/get_callkit_api.js +0 -33
- package/tools/call/get_callkit_api.js.map +0 -1
- package/tools/call/get_native_call_uikit_integration.js.map +0 -1
- package/tools/call/get_native_callkit_core_integration.js.map +0 -1
- package/tools/call/get_web_call_uikit_integration.js.map +0 -1
- package/tools/chat/get_native_chat_uikit_feature_detail.js +0 -35
- package/tools/chat/get_native_chat_uikit_feature_detail.js.map +0 -1
- package/tools/chat/get_native_chat_uikit_integration.js.map +0 -1
- package/tools/chat/get_web_chat_uikit_component_detail.js +0 -35
- package/tools/chat/get_web_chat_uikit_component_detail.js.map +0 -1
- package/tools/chat/get_web_chat_uikit_integration.js.map +0 -1
- package/tools/common/get_faq.js +0 -266
- package/tools/common/get_faq.js.map +0 -1
- package/tools/common/get_usersig.js.map +0 -1
- package/tools/common/present_framework_choice.js.map +0 -1
- package/tools/common/record_answer.js.map +0 -1
- package/tools/common/record_feedback.js.map +0 -1
- package/tools/common/record_skill_session.js +0 -69
- package/tools/common/record_skill_session.js.map +0 -1
- package/tools/definitions/get_callkit_api_def.js +0 -28
- package/tools/definitions/get_callkit_api_def.js.map +0 -1
- package/tools/definitions/get_faq_def.js +0 -40
- package/tools/definitions/get_faq_def.js.map +0 -1
- package/tools/definitions/get_native_call_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_callkit_core_integration_def.js.map +0 -1
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +0 -31
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_native_chat_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_livekit_core_features_def.js +0 -33
- package/tools/definitions/get_native_livekit_core_features_def.js.map +0 -1
- package/tools/definitions/get_native_livekit_core_integration_def.js.map +0 -1
- package/tools/definitions/get_native_trtc_sdk_docs_def.js +0 -32
- package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +0 -1
- package/tools/definitions/get_usersig_def.js.map +0 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js +0 -31
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_livekit_api_def.js +0 -27
- package/tools/definitions/get_web_livekit_api_def.js.map +0 -1
- package/tools/definitions/get_web_livekit_component_detail_def.js +0 -29
- package/tools/definitions/get_web_livekit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_room_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_web_roomkit_feature_detail_def.js +0 -30
- package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_api_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_api_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_integration_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js +0 -25
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +0 -1
- package/tools/definitions/present_framework_choice_def.js.map +0 -1
- package/tools/definitions/record_answer_def.js.map +0 -1
- package/tools/definitions/record_feedback_def.js.map +0 -1
- package/tools/definitions/record_skill_session_def.js +0 -31
- package/tools/definitions/record_skill_session_def.js.map +0 -1
- package/tools/index.js.map +0 -1
- package/tools/live/get_native_livekit_core_features.js +0 -68
- package/tools/live/get_native_livekit_core_features.js.map +0 -1
- package/tools/live/get_native_livekit_core_integration.js.map +0 -1
- package/tools/live/get_web_live_uikit_integration.js.map +0 -1
- package/tools/live/get_web_livekit_api.js +0 -33
- package/tools/live/get_web_livekit_api.js.map +0 -1
- package/tools/live/get_web_livekit_component_detail.js +0 -35
- package/tools/live/get_web_livekit_component_detail.js.map +0 -1
- package/tools/room/get_web_room_uikit_integration.js.map +0 -1
- package/tools/room/get_web_roomkit_feature_detail.js +0 -69
- package/tools/room/get_web_roomkit_feature_detail.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_api.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_api.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_integration.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +0 -1
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js +0 -32
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +0 -1
- package/tools/trtc/get_native_trtc_sdk_docs.js +0 -74
- package/tools/trtc/get_native_trtc_sdk_docs.js.map +0 -1
- package/utils/build-session-directives.js +0 -122
- package/utils/build-session-directives.js.map +0 -1
- package/utils/generate-structured-result.js.map +0 -1
- package/utils/generate-usersig.js.map +0 -1
- package/utils/get-device-identifier.js.map +0 -1
- package/utils/get-doc-content.js.map +0 -1
- package/utils/handle-framework.js +0 -9
- package/utils/handle-framework.js.map +0 -1
- package/utils/handle-state-name.js +0 -29
- package/utils/handle-state-name.js.map +0 -1
- package/utils/http-get.js.map +0 -1
- package/utils/http-post.js.map +0 -1
- package/utils/report-cls-client.js.map +0 -1
- package/utils/report-es-client.js.map +0 -1
- package/utils/report-runtime-error-cls-client.js.map +0 -1
- /package/resource/{doc/callkit/faq/common → knowledge/callkit/faq}/error-code.md +0 -0
- /package/resource/{doc/livekit/faq/common → knowledge/livekit/faq}/error-code.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/api.md +0 -0
- /package/resource/{doc/rtcengine/faq/web/web.md → knowledge/rtcengine/web/faq.md} +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/how_to_integrated_web_sdk.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/28-advanced-beauty.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/29-advanced-water-mark.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/30-advanced-cross-room-link.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/34-advanced-proxy.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/37-advanced-voice-changer.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/38-advanced-basic-beauty.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/40-advanced-video-mixer.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +0 -0
- /package/resource/{doc → knowledge}/rtcengine/web/plugin/43-advanced-face-detection.md +0 -0
- /package/resource/{doc/rtcengine/faq/common → knowledge/share}/userSig.md +0 -0
|
@@ -14,17 +14,19 @@
|
|
|
14
14
|
## 核心概念解析
|
|
15
15
|
|
|
16
16
|
在开始集成之前,我们先通过下表了解一下 BarrageStore 相关的几个核心概念:
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
|
21
|
-
|
|
|
17
|
+
|
|
18
|
+
|**核心概念**|**类型**|**核心职责与描述**|
|
|
19
|
+
|---------|---------|---------|
|
|
20
|
+
|[Barrage](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barrage)|`struct`|代表一条弹幕消息的数据模型。它包含了发送者信息 (`sender`)、消息内容 (`textContent` 或 `data`)、消息类型 (`messageType`) 等所有关键信息。|
|
|
21
|
+
|[BarrageState](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestate)|`struct`|代表弹幕模块的当前状态。其核心属性 `messageList` 是一个 `[Barrage]` 数组,按时间顺序存储了当前直播间的所有弹幕消息,是 UI 渲染的数据源。|
|
|
22
|
+
|[BarrageStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore)|`class`|这是与弹幕功能交互的核心管理类。通过它,您可以发送消息 (`sendTextMessage`, `sendCustomMessage`),并通过订阅其 `state` 属性来接收和监听所有弹幕消息的更新。|
|
|
22
23
|
|
|
23
24
|
## 实现步骤
|
|
24
25
|
|
|
25
26
|
### 步骤1:组件集成
|
|
27
|
+
- **视频直播**:请参考 开播与观看 集成 **AtomicXCore**,完成接入。
|
|
26
28
|
|
|
27
|
-
|
|
29
|
+
- **语聊房**:请参考 开播与收听 集成 **AtomicXCore**,完成接入。
|
|
28
30
|
|
|
29
31
|
### 步骤2:初始化并监听弹幕
|
|
30
32
|
|
|
@@ -95,11 +97,12 @@ extension BarrageManager {
|
|
|
95
97
|
```
|
|
96
98
|
|
|
97
99
|
#### **接口参数**
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
100
|
+
|
|
101
|
+
|**参数**|**类型**|**描述**|
|
|
102
|
+
|---------|---------|---------|
|
|
103
|
+
|`text`|`String`|要发送的文本内容。|
|
|
104
|
+
|`extensionInfo`|`[String: String]?`|附加的扩展信息,可用于业务自定义。|
|
|
105
|
+
|`completion`|`CompletionClosure?`|发送完成后的回调,包含成功或失败的结果。|
|
|
103
106
|
|
|
104
107
|
### 步骤4:发送自定义弹幕
|
|
105
108
|
|
|
@@ -134,11 +137,12 @@ extension BarrageManager {
|
|
|
134
137
|
```
|
|
135
138
|
|
|
136
139
|
#### **接口参数**
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
140
|
+
|
|
141
|
+
|**参数**|**类型**|**描述**|
|
|
142
|
+
|---------|---------|---------|
|
|
143
|
+
|`businessId`|`String`|业务唯一标识符,例如 "live_gift",用于接收端区分不同的自定义消息。|
|
|
144
|
+
|`data`|`String`|业务数据,通常为 JSON 格式的字符串。|
|
|
145
|
+
|`completion`|`CompletionClosure?`|发送完成后的回调。|
|
|
142
146
|
|
|
143
147
|
### 步骤5:在本地插入提示消息
|
|
144
148
|
|
|
@@ -161,9 +165,10 @@ extension BarrageManager {
|
|
|
161
165
|
```
|
|
162
166
|
|
|
163
167
|
#### **接口参数**
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
168
|
+
|
|
169
|
+
|**参数**|**类型**|**描述**|
|
|
170
|
+
|---------|---------|---------|
|
|
171
|
+
|`message`|`Barrage`|要在本地插入的消息对象。SDK 会将此消息对象追加到 BarrageState 的 messageList 中。|
|
|
167
172
|
|
|
168
173
|
### 步骤6:管理用户发言(禁言与解禁)
|
|
169
174
|
|
|
@@ -230,7 +235,7 @@ liveListStore.updateLiveInfo(currentLiveInfo, modifyFlag: .isMessageDisable) { r
|
|
|
230
235
|
|
|
231
236
|
#### 技术挑战
|
|
232
237
|
|
|
233
|
-
SDK 会以极高频率返回完整的弹幕列表。如果每次都调用 `tableView.reloadData()`,主线程会被密集的UI布局和渲染操作阻塞,导致界面卡顿。
|
|
238
|
+
SDK 会以极高频率返回完整的弹幕列表。如果每次都调用 `tableView.reloadData()`,主线程会被密集的 UI 布局和渲染操作阻塞,导致界面卡顿。
|
|
234
239
|
|
|
235
240
|
#### 优化方案:批处理与流量削峰 (Batch Processing & Debouncing)
|
|
236
241
|
|
|
@@ -284,7 +289,7 @@ class BarrageUIManager {
|
|
|
284
289
|
|
|
285
290
|
#### 技术挑战
|
|
286
291
|
|
|
287
|
-
SDK 返回的全量 `messageList` 会在长时间直播中无限增长,即使 UI
|
|
292
|
+
SDK 返回的全量 `messageList` 会在长时间直播中无限增长,即使 UI 层做了节流,数据层持有的这个巨大数组也会持续占用内存,最终导致应用闪退。
|
|
288
293
|
|
|
289
294
|
#### 优化方案:固定容量的循环数组 (Circular Buffer)
|
|
290
295
|
|
|
@@ -331,7 +336,7 @@ class BarrageUIManager {
|
|
|
331
336
|
``` swift
|
|
332
337
|
import UIKit
|
|
333
338
|
|
|
334
|
-
//
|
|
339
|
+
// 在您的自定义弹幕Cell中
|
|
335
340
|
class BarrageCell: UITableViewCell {
|
|
336
341
|
|
|
337
342
|
// ... (UILabel, UIImageView等子视图的声明)
|
|
@@ -349,7 +354,7 @@ class BarrageCell: UITableViewCell {
|
|
|
349
354
|
}
|
|
350
355
|
|
|
351
356
|
func configure(with viewModel: BarrageViewModel) {
|
|
352
|
-
//
|
|
357
|
+
// 在这里设置您的Label文本、Image图片等
|
|
353
358
|
// 由于开启了异步绘制,这些内容的最终渲染会尽量在后台完成
|
|
354
359
|
}
|
|
355
360
|
|
|
@@ -379,7 +384,7 @@ class BarrageCell: UITableViewCell {
|
|
|
379
384
|
```
|
|
380
385
|
2. **发送端:** 在发送时,将这个 JSON 结构转换为字符串,并通过 `sendCustomMessage` 的 `data` 参数发送出去。`businessId` 可以设置为一个能代表您业务的唯一标识,例如 "`barrage_style_v1`"。
|
|
381
386
|
|
|
382
|
-
3. **接收端**: 在接收到弹幕消息后,检查其 `messageType` 是否为 `.custom` 以及 `businessId` 是否匹配。如果匹配,则解析 `data` 字符串(通常是解析JSON),根据解析出的数据(例如 `color、text`)来渲染您的自定义UI样式。
|
|
387
|
+
3. **接收端**: 在接收到弹幕消息后,检查其 `messageType` 是否为 `.custom` 以及 `businessId` 是否匹配。如果匹配,则解析 `data` 字符串(通常是解析 JSON),根据解析出的数据(例如 `color、text`)来渲染您的自定义 UI 样式。
|
|
383
388
|
|
|
384
389
|
### 我在不同的类、不同的文件中都调用了 `BarrageStore.create(liveID: "some_id")`,这会创建出多个实例导致混乱吗?
|
|
385
390
|
|
|
@@ -400,15 +405,23 @@ class BarrageCell: UITableViewCell {
|
|
|
400
405
|
|
|
401
406
|
`AtomicXCore` 支持拉取历史弹幕消息,但这需要您在**服务端控制台**进行一项简单的配置。配置完成后,SDK 会自动处理后续的一切,您无需编写额外的代码。
|
|
402
407
|
|
|
403
|
-
**步骤1
|
|
404
|
-
|
|
408
|
+
**步骤1:在控制台进行配置**
|
|
409
|
+
|
|
410
|
+
根据您的应用创建方式,选择对应的控制台进行配置(实时音视频控制台或即时通信 IM 控制台)。
|
|
411
|
+
|
|
412
|
+
在控制台的配置页面中,找到**查看直播间历史消息**选项,修改其配置(最大支持 **50** 条消息)。
|
|
413
|
+
- 若您的应用在 [实时音视频控制台](https://console.cloud.tencent.com/trtc/app) 创建,配置步骤如下:
|
|
414
|
+
|
|
415
|
+
左侧导航栏选择**应用管理** > **功能配置 **>** LiveKit 功能**,在**应用管理**选择对应的应用后,单击**查看直播间历史消息 > 编辑**。
|
|
416
|
+
|
|
417
|
+
- 若您的应用在 [即时通信 IM 控制台](https://console.cloud.tencent.com/im/rtc-config) 创建,配置步骤如下:
|
|
405
418
|
|
|
406
|
-
|
|
419
|
+
左侧导航栏选择**音视频服务 RTC**,选择对应的应用后,单击**在线直播/语音聊天室(TUILiveKit) > 配置**。
|
|
407
420
|
|
|
408
|
-
|
|
421
|
+
进入 **LiveKit 功能配置**后,单击**查看直播间历史消息** > **编辑**。
|
|
409
422
|
|
|
410
423
|
**步骤2:客户端无感获取 **
|
|
411
424
|
|
|
412
425
|
完成上述配置后,您的客户端代码**无需做任何改动**。
|
|
413
426
|
|
|
414
|
-
当新用户加入直播间时,`AtomicXCore` 的底层 会自动拉取您配置的历史消息数量。这些历史消息会和实时消息一样,通过您已实现的 `BarrageStore.state` 订阅通道推送给您的UI层。您的应用会像接收实时弹幕一样,自然地接收并展示这些历史弹幕。
|
|
427
|
+
当新用户加入直播间时,`AtomicXCore` 的底层 会自动拉取您配置的历史消息数量。这些历史消息会和实时消息一样,通过您已实现的 `BarrageStore.state` 订阅通道推送给您的 UI 层。您的应用会像接收实时弹幕一样,自然地接收并展示这些历史弹幕。
|
|
@@ -14,16 +14,17 @@
|
|
|
14
14
|
## 核心概念
|
|
15
15
|
|
|
16
16
|
在开始集成之前,我们先通过下表了解一下 BaseBeautyStore 相关的核心概念:
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
17
|
+
|
|
18
|
+
|**核心概念**|**类型**|**核心职责与描述**|
|
|
19
|
+
|---------|---------|---------|
|
|
20
|
+
|`BaseBeautyState`|`struct`|代表基础美颜模块的当前状态。包含了当前生效的磨皮 (`smoothLevel`)、美白 (`whitenessLevel`) 和红润 (`ruddyLevel`) 的强度值。|
|
|
21
|
+
|`BaseBeautyStore`|`class`|这是与基础美颜功能交互的核心管理类。它是一个全局单例 (`shared`),负责所有基础美颜参数的设置、重置和状态同步。|
|
|
21
22
|
|
|
22
23
|
## 实现步骤
|
|
23
24
|
|
|
24
25
|
### 步骤1:组件集成
|
|
25
26
|
|
|
26
|
-
请参考
|
|
27
|
+
请参考 开播与观看 集成 **AtomicXCore**,并完成 **LiveCoreView** 的接入。
|
|
27
28
|
|
|
28
29
|
### 步骤2:获取实例并监听状态
|
|
29
30
|
|
|
@@ -70,7 +71,7 @@ class BeautyManager {
|
|
|
70
71
|
当用户拖动美颜滑块或点击预设按钮时,调用相应的接口设置美颜强度。
|
|
71
72
|
|
|
72
73
|
#### 实现方式
|
|
73
|
-
1. **获取强度值**:从 UI
|
|
74
|
+
1. **获取强度值**:从 UI 控件(例如 `UISlider`)获取用户设定的强度值。请注意,SDK 接口接收的参数范围是 `[0, 9]`,其中 `0` 表示关闭效果,`9` 表示效果最明显。您需要将 UI 控件的值(例如 UISlider 的 `0.0 - 1.0`)映射到 `0 - 9` 的范围。
|
|
74
75
|
|
|
75
76
|
2. **调用接口**:分别调用 `setSmoothLevel(smoothLevel:)`、`setWhitenessLevel(whitenessLevel:)`、`setRuddyLevel(ruddyLevel:) `来设置磨皮、美白、红润的强度。
|
|
76
77
|
|
|
@@ -121,12 +122,13 @@ extension BeautyManager {
|
|
|
121
122
|
### 基础美颜与高级美颜对比
|
|
122
123
|
|
|
123
124
|
AtomicXCore 也提供了高级美颜支持,以满足不同场景的需求
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
125
|
+
|
|
126
|
+
|**对比项**|**基础美颜 (BaseBeautyStore)**|**高级美颜 (TEBeautyKit 需额外集成)**|
|
|
127
|
+
|---------|---------|---------|
|
|
128
|
+
|核心功能|磨皮、美白、红润。|包含基础美颜,并增加 V 脸、眼距、瘦鼻、3D 贴纸、滤镜、美妆等丰富效果。|
|
|
129
|
+
|计费|免费 (包含在 AtomicXCore 授权内)。|付费(需要额外购买腾讯特效 SDK License) 。|
|
|
130
|
+
|集成方式|默认内置,直接使用 `BaseBeautyStore.shared`。|需要额外集成 `TEBeautyKit` 组件并进行鉴权。|
|
|
131
|
+
|推荐场景|对美颜要求不高,需要快速实现基础美颜功能的场景。|对美颜效果有较高要求,需要丰富的美型、贴纸、滤镜等高级功能的场景。|
|
|
130
132
|
|
|
131
133
|
### 集成高级美颜
|
|
132
134
|
|
|
@@ -135,10 +137,11 @@ AtomicXCore 也提供了高级美颜支持,以满足不同场景的需求
|
|
|
135
137
|
## API 文档
|
|
136
138
|
|
|
137
139
|
关于 [BaseBeautyStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/basebeautystore) 及其相关类的所有公开接口、属性和方法的详细信息,请参阅随 [AtomicXCore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore) 框架的官方 API 文档。本指南使用到的相关 Store 如下:
|
|
138
|
-
|
|
139
|
-
|
|
|
140
|
-
|
|
141
|
-
|
|
|
140
|
+
|
|
141
|
+
|Store/Component|功能描述|API 文档|
|
|
142
|
+
|---------|---------|---------|
|
|
143
|
+
|BaseBeautyStore|基础美颜:调节磨皮 / 美白 / 红润(0-9 级),重置美颜状态,同步效果参数。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/basebeautystore)|
|
|
144
|
+
|DeviceStore|音视频设备控制:麦克风(开关 / 音量)、摄像头(开关 / 切换 / 画质)、屏幕共享,设备状态实时监听。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/devicestore)|
|
|
142
145
|
|
|
143
146
|
## 常见问题
|
|
144
147
|
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
|
|
12
12
|
### 步骤1:组件集成
|
|
13
13
|
|
|
14
|
-
请参考
|
|
14
|
+
请参考 开播与观看 集成 **AtomicXCore**,并完成 **LiveCoreView** 的接入。
|
|
15
15
|
|
|
16
16
|
### 步骤2:实现观众申请上麦
|
|
17
17
|
|
|
@@ -52,13 +52,13 @@
|
|
|
52
52
|
.sink { [weak self] event in
|
|
53
53
|
if case let .onGuestApplicationResponded(isAccept, hostUser) = event {
|
|
54
54
|
if isAccept {
|
|
55
|
-
print("主播 \(hostUser.userName)
|
|
55
|
+
print("主播 \(hostUser.userName) 同意了您的申请,准备上麦")
|
|
56
56
|
// 1. 打开摄像头、麦克风
|
|
57
57
|
DeviceStore.shared.openLocalCamera(isFront: true, completion: nil)
|
|
58
58
|
DeviceStore.shared.openLocalMicrophone(completion: nil)
|
|
59
59
|
// 2. 在此更新 UI,例如关闭申请按钮,显示连麦中的状态
|
|
60
60
|
} else {
|
|
61
|
-
print("主播 \(hostUser.userName)
|
|
61
|
+
print("主播 \(hostUser.userName) 拒绝了您的申请")
|
|
62
62
|
// 弹窗提示用户申请被拒绝
|
|
63
63
|
}
|
|
64
64
|
}
|
|
@@ -190,9 +190,9 @@
|
|
|
190
190
|
// 在 hostEventPublisher 的订阅中添加
|
|
191
191
|
if case let .onHostInvitationResponded(isAccept, guestUser) = event {
|
|
192
192
|
if isAccept {
|
|
193
|
-
print("观众 \(guestUser.userName)
|
|
193
|
+
print("观众 \(guestUser.userName) 接受了您的邀请")
|
|
194
194
|
} else {
|
|
195
|
-
print("观众 \(guestUser.userName)
|
|
195
|
+
print("观众 \(guestUser.userName) 拒绝了您的邀请")
|
|
196
196
|
}
|
|
197
197
|
}
|
|
198
198
|
```
|
|
@@ -253,7 +253,7 @@
|
|
|
253
253
|
> **提示:**
|
|
254
254
|
>
|
|
255
255
|
|
|
256
|
-
> 您也可以参考 TUILiveKit 开源项目中的 [AnchorCoGuestView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Features/
|
|
256
|
+
> 您也可以参考 TUILiveKit 开源项目中的 [AnchorCoGuestView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Features/AnchorView/View/VideoWidgets/AnchorCoGuestView.swift) 和 [AnchorEmptySeatView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Features/AnchorView/View/VideoWidgets/AnchorEmptySeatView.swift) 文件来了解完整的实现逻辑。
|
|
257
257
|
>
|
|
258
258
|
|
|
259
259
|
- **步骤 1**:创建前景视图 (**CustomSeatView**),该视图用于在视频流上方显示用户信息。
|
|
@@ -338,24 +338,25 @@
|
|
|
338
338
|
```
|
|
339
339
|
|
|
340
340
|
#### **参数说明**:
|
|
341
|
-
|
|
|
341
|
+
| <strong>参数</strong> | <strong>类型</strong> | <strong>说明</strong> |
|
|
342
342
|
| --- | --- | --- |
|
|
343
|
-
|
|
|
344
|
-
|
|
|
345
|
-
|
|
|
346
|
-
|
|
|
347
|
-
|
|
|
348
|
-
|
|
|
349
|
-
|
|
|
343
|
+
| <code>seatInfo</code> | <code>TUISeatFullInfo</code> | 麦位信息对象,包含麦上用户的详细信息。 |
|
|
344
|
+
| <code>seatInfo.userID</code> | <code>String?</code> | 麦上用户的 ID。 |
|
|
345
|
+
| <code>seatInfo.userName</code> | <code>String? </code> | 麦上用户的昵称。 |
|
|
346
|
+
| <code>seatInfo.userAvatar</code> | <code>String?</code> | 麦上用户的头像 URL。 |
|
|
347
|
+
| <code>seatInfo.userMicrophoneStatus</code> | <code>TUIDeviceStatus</code> | 麦上用户的麦克风状态。 |
|
|
348
|
+
| <code>seatInfo.userCameraStatus </code> | <code>TUIDeviceStatus</code> | 麦上用户的摄像头状态。 |
|
|
349
|
+
| <code>viewLayer</code> | <code>ViewLayer</code> | 视图层级枚举。<br><code>.foreground</code> 表示前景挂件视图,始终显示在视频画面的最上层。<br><code>.background</code> 表示背景挂件视图,位于前景视图下层,仅在对应用户没有视频流(例如未开摄像头)的情况下显示,通常用于展示用户的默认头像或占位图。 |
|
|
350
350
|
|
|
351
351
|
## API 文档
|
|
352
352
|
|
|
353
353
|
关于 [CoGuestStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore) 及其相关类的所有公开接口、属性和方法的详细信息,请参阅 [AtomicXCore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore) 框架的官方 API 文档。本指南使用到的相关 Store 如下:
|
|
354
|
-
|
|
355
|
-
|
|
|
356
|
-
|
|
357
|
-
|
|
|
358
|
-
|
|
|
354
|
+
|
|
355
|
+
|Store/Component|功能描述|API 文档|
|
|
356
|
+
|---------|---------|---------|
|
|
357
|
+
|LiveCoreView|直播视频流展示与交互的核心视图组件:负责视频流渲染和视图挂件处理,支持主播直播、观众连麦、主播连线等场景。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/livecoreview)|
|
|
358
|
+
|DeviceStore|音视频设备控制:麦克风(开关 / 音量)、摄像头(开关 / 切换 / 画质)、屏幕共享,设备状态实时监听。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/devicestore)|
|
|
359
|
+
|CoGuestStore|观众连麦管理:连麦申请 / 邀请 / 同意 / 拒绝,连麦成员权限控制(麦克风 / 摄像头),状态同步。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore)|
|
|
359
360
|
|
|
360
361
|
## 常见问题
|
|
361
362
|
|
|
@@ -1,25 +1,27 @@
|
|
|
1
1
|
`GiftStore` 是 `AtomicXCore` 中专门负责管理直播间礼物功能的模块。通过它,您可以为您的直播应用构建一套完整的礼物系统,实现丰富的营收和互动场景。
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
|
|
3
|
+
|礼物面板|弹幕礼物|全屏礼物|
|
|
4
|
+
|---------|---------|---------|
|
|
5
|
+
||||
|
|
5
6
|
|
|
6
7
|
## 核心功能
|
|
7
8
|
- **礼物列表获取**:从服务端拉取礼物面板所需的数据,包括礼物分类和礼物详情。
|
|
8
9
|
|
|
9
|
-
-
|
|
10
|
+
- **发送礼物功能**:观众可以向主播发送选定的礼物,并附带数量。
|
|
10
11
|
|
|
11
12
|
- **礼物事件广播**:实时接收房间内发生的礼物赠送事件,用于展示礼物动画和弹幕通知。
|
|
12
13
|
|
|
13
14
|
## 核心概念
|
|
14
15
|
|
|
15
16
|
在开始集成之前,我们先通过下表了解一下 `GiftStore` 相关的几个核心概念:
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
17
|
+
|
|
18
|
+
|**核心概念**|**类型**|**核心职责与描述**|
|
|
19
|
+
|---------|---------|---------|
|
|
20
|
+
|`Gift`|`struct`|代表一个具体的礼物数据模型。包含了礼物的 ID、名称、图标地址、动画资源地址 (resourceURL) 和价格 (coins) 等。|
|
|
21
|
+
|`GiftCategory`|`struct`|代表一个礼物分类,例如“热门”、“豪华”等。它包含了分类的名称以及该分类下的 **Gift **列表。|
|
|
22
|
+
|`GiftState`|`struct`|代表礼物模块的当前状态。其核心属性 usableGifts 是一个 [GiftCategory] 数组,存储了从服务端拉取到的完整礼物列表。|
|
|
23
|
+
|`GiftEvent`|`enum`|代表直播间内发生的礼物事件。目前只有 .onReceiveGift,当有任何人(包括自己)调用发送礼物接口时,房间内所有人都会收到此事件。|
|
|
24
|
+
|`GiftStore`|`class`|这是与礼物功能交互的核心管理类。通过它,您可以拉取礼物列表、调用发送礼物接口,并通过订阅其 giftEventPublisher 来接收礼物事件。|
|
|
23
25
|
|
|
24
26
|
## 实现步骤
|
|
25
27
|
|
|
@@ -96,26 +98,26 @@ class GiftManager {
|
|
|
96
98
|
#### 礼物列表结构体参数
|
|
97
99
|
- `GiftCategory`**参数说明**
|
|
98
100
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
101
|
+
|**参数**|**类型**|**描述**|
|
|
102
|
+
|---------|---------|---------|
|
|
103
|
+
|`categoryID`|`String`|礼物分类的唯一 ID。|
|
|
104
|
+
|`name`|`String`|礼物分类的显示名称。|
|
|
105
|
+
|`desc`|`String`|礼物分类的描述信息。|
|
|
106
|
+
|`extensionInfo`|`[String: String]`|扩展信息字段。|
|
|
107
|
+
|`giftList`|`[`[`Gift`](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/gift)`]`|该分类下包含的 Gift 礼物对象数组。|
|
|
106
108
|
|
|
107
109
|
- `Gift`** 参数说明**
|
|
108
110
|
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
111
|
+
|**参数**|**类型**|**描述**|
|
|
112
|
+
|---------|---------|---------|
|
|
113
|
+
|`giftID`|`String`| 礼物的唯一 ID。|
|
|
114
|
+
|`name`|`String`| 礼物的显示名称。|
|
|
115
|
+
|`desc`|`String`| 礼物的描述信息。|
|
|
116
|
+
|`iconURL`|`String`| 礼物图标 URL。|
|
|
117
|
+
|`resourceURL`|`String`| 礼物动画资源 URL。|
|
|
118
|
+
|`level`|`UInt`| 礼物等级。|
|
|
119
|
+
|`coins`|`UInt`| 礼物价格。|
|
|
120
|
+
|`extensionInfo`|`[String: String]`| 扩展信息字段。|
|
|
119
121
|
|
|
120
122
|
### 步骤3:获取礼物列表
|
|
121
123
|
|
|
@@ -146,7 +148,7 @@ extension GiftManager {
|
|
|
146
148
|
}
|
|
147
149
|
```
|
|
148
150
|
|
|
149
|
-
### 步骤4
|
|
151
|
+
### 步骤4:实现发送礼物功能
|
|
150
152
|
|
|
151
153
|
当用户在礼物面板选择一个礼物并点击发送时,调用 `sendGift` 接口将礼物发送出去。
|
|
152
154
|
|
|
@@ -177,11 +179,12 @@ extension GiftManager {
|
|
|
177
179
|
```
|
|
178
180
|
|
|
179
181
|
#### `sendGift`接口参数
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
182
|
+
|
|
183
|
+
|**参数名**|**类型**|**描述**|
|
|
184
|
+
|---------|---------|---------|
|
|
185
|
+
|`giftID`|`String`|要发送的礼物的唯一 ID。|
|
|
186
|
+
|`count`|`UInt`|发送的数量。|
|
|
187
|
+
|`completion`|`CompletionClosure?`|发送完成后的回调。|
|
|
185
188
|
|
|
186
189
|
## 功能进阶
|
|
187
190
|
|
|
@@ -235,9 +238,10 @@ extension GiftManager {
|
|
|
235
238
|
#### 调用流程图
|
|
236
239
|
|
|
237
240
|
#### 涉及 REST API 接口一览
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
+
|
|
242
|
+
|接口|说明|请求示例|
|
|
243
|
+
|---------|---------|---------|
|
|
244
|
+
|回调配置 - 调用发送礼物接口之前回调|客户后台可以通过该回调决定是否通过送礼前校验等场景|调用示例|
|
|
241
245
|
|
|
242
246
|
### 实现全屏礼物动画播放
|
|
243
247
|
|
|
@@ -246,13 +250,14 @@ extension GiftManager {
|
|
|
246
250
|
#### 实现方式
|
|
247
251
|
|
|
248
252
|
`AtomicXCore` 本身不包含礼物动画播放器,您需要根据业务需求选择并集成第三方库。以下是两种方案的对比:
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
253
|
+
|
|
254
|
+
|**对比项**|**基础方案 (SVGAPlayer-iOS)**|**高级方案 (TCEffectPlayerKit)**|
|
|
255
|
+
|---------|---------|---------|
|
|
256
|
+
|计费|免费 (开源库)|付费 (需购买 License),请参见 [付费指引](https://cloud.tencent.com/document/product/616/116461)|
|
|
257
|
+
|集成方式|需手动集成 SVGAPlayer 库 (例如通过 CocoaPods)|需额外集成 TCEffectPlayerKit 并进行鉴权|
|
|
258
|
+
|动画格式支持|仅支持 SVGA|SVGA、PAG、WebP、Lottie、MP4 等多种格式|
|
|
259
|
+
|性能|建议 SVGA 文件 ≤ 10MB|支持更大的动画文件,复杂特效/多动画并发/低端机表现更优|
|
|
260
|
+
|推荐场景|礼物动画格式统一为 SVGA,且文件大小可控|需要支持多种动画格式,或对动画性能/设备兼容性有更高要求|
|
|
256
261
|
|
|
257
262
|
本章节主要演示基础方案的集成。如果您选择高级方案,请参考 [TCEffectPlayer 集成指引](https://cloud.tencent.com/document/product/616/116474)。
|
|
258
263
|
|
|
@@ -330,7 +335,7 @@ class LiveRoomViewController: UIViewController, SVGAPlayerDelegate {
|
|
|
330
335
|
|
|
331
336
|
### 在弹幕区展示礼物赠送消息
|
|
332
337
|
|
|
333
|
-
|
|
338
|
+
当有用户调用发送礼物接口时,不仅播放动画,同时在公屏弹幕区域显示一条系统消息,例如:“【观众昵称】送出了【礼物名称】x【数量】”,让所有观众都能看到。
|
|
334
339
|
|
|
335
340
|
#### 实现方式
|
|
336
341
|
1. **监听事件**:订阅 `giftStore.giftEventPublisher`。
|
|
@@ -372,10 +377,11 @@ private func setupGiftToBarrageFlow() {
|
|
|
372
377
|
## API 文档
|
|
373
378
|
|
|
374
379
|
关于 [GiftStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore) 及其相关类的所有公开接口、属性和方法的详细信息,请参阅随 [AtomicXCore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore) 框架的官方 API 文档。本指南使用到的相关 Store 如下:
|
|
375
|
-
|
|
376
|
-
|
|
|
377
|
-
|
|
378
|
-
|
|
|
380
|
+
|
|
381
|
+
|Store/Component|功能描述|API 文档|
|
|
382
|
+
|---------|---------|---------|
|
|
383
|
+
|GiftStore|礼物互动:获取礼物列表,发送 / 接收礼物,监听礼物事件(含发送者、礼物详情)。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/giftstore)|
|
|
384
|
+
|BarrageStore|弹幕功能:发送文本 / 自定义弹幕,维护弹幕列表,实时监听弹幕状态。|[API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore)|
|
|
379
385
|
|
|
380
386
|
## 常见问题
|
|
381
387
|
|