@tencentcloud/sdk-mcp 1.4.7 → 1.6.0-beta.2
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 +36 -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
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
`GiftStore` 是 `AtomicXCore` 中专门负责管理直播间礼物功能的模块。通过它,您可以为您的直播应用构建一套完整的礼物系统,实现丰富的营收和互动场景。
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
|
|
3
|
+
|礼物面板|弹幕礼物|全屏礼物|
|
|
4
|
+
|---------|---------|---------|
|
|
5
|
+
||||
|
|
5
6
|
|
|
6
7
|
## 核心功能
|
|
7
8
|
- **礼物列表获取**:从服务端拉取礼物面板所需的数据,包括礼物分类和礼物详情。
|
|
@@ -13,13 +14,14 @@
|
|
|
13
14
|
## 核心概念
|
|
14
15
|
|
|
15
16
|
在开始集成之前,我们先通过下表了解一下 `GiftStore` 相关的几个核心概念:
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
17
|
+
|
|
18
|
+
|**核心概念**|**类型**|**核心职责与描述**|
|
|
19
|
+
|---------|---------|---------|
|
|
20
|
+
|`Gift`|`data class`|代表一个具体的礼物数据模型。包含了礼物的 ID、名称、图标地址、动画资源地址 (resourceURL) 和价格 (coins) 等。|
|
|
21
|
+
|`GiftCategory`|`data class`|代表一个礼物分类,例如“热门”、“豪华”等。它包含了分类的名称以及该分类下的 **Gift** 列表。|
|
|
22
|
+
|`GiftState`|`data class`|代表礼物模块的当前状态。其核心属性 usableGifts 是一个 `StateFlow`,存储了从服务端拉取到的完整礼物列表。|
|
|
23
|
+
|`GiftEvent`|`abstract class`|代表直播间内发生的礼物事件监听器。目前只有 onReceiveGift,当有任何人(包括自己)发送礼物时,房间内所有人都会收到此事件。|
|
|
24
|
+
|`GiftStore`|`abstract class`|这是与礼物功能交互的核心管理类。通过它,您可以拉取礼物列表、发送礼物,并通过添加监听器来接收礼物事件。|
|
|
23
25
|
|
|
24
26
|
## 实现步骤
|
|
25
27
|
|
|
@@ -69,6 +71,12 @@ class GiftManager(
|
|
|
69
71
|
private val _giftList = MutableStateFlow<List<GiftCategory>>(emptyList())
|
|
70
72
|
val giftList: StateFlow<List<GiftCategory>> = _giftList.asStateFlow()
|
|
71
73
|
|
|
74
|
+
private val giftListener = object : GiftListener() {
|
|
75
|
+
override fun onReceiveGift(liveID: String, gift: Gift, count: Int, sender: LiveUserInfo) {
|
|
76
|
+
// 收到事件后,将其转发给UI层处理
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
|
|
72
80
|
init {
|
|
73
81
|
setupGiftListener()
|
|
74
82
|
subscribeToGiftState()
|
|
@@ -76,11 +84,7 @@ class GiftManager(
|
|
|
76
84
|
|
|
77
85
|
/// 2. 订阅礼物事件
|
|
78
86
|
private fun setupGiftListener() {
|
|
79
|
-
giftStore.addGiftListener(
|
|
80
|
-
override fun onReceiveGift(liveID: String, gift: Gift, count: Int, sender: LiveUserInfo) {
|
|
81
|
-
// 收到事件后,将其转发给UI层处理
|
|
82
|
-
}
|
|
83
|
-
})
|
|
87
|
+
giftStore.addGiftListener(giftListener)
|
|
84
88
|
}
|
|
85
89
|
|
|
86
90
|
/// 3. 订阅礼物列表状态
|
|
@@ -98,26 +102,26 @@ class GiftManager(
|
|
|
98
102
|
#### 礼物列表结构体参数
|
|
99
103
|
- `GiftCategory`**参数说明**
|
|
100
104
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
105
|
+
|**参数**|**类型**|**描述**|
|
|
106
|
+
|---------|---------|---------|
|
|
107
|
+
|`categoryID`|`String`|礼物分类的唯一 ID。|
|
|
108
|
+
|`name`|`String`|礼物分类的显示名称。|
|
|
109
|
+
|`desc`|`String`|礼物分类的描述信息。|
|
|
110
|
+
|`extensionInfo`|`Map<String, String>`|扩展信息字段。|
|
|
111
|
+
|`giftList`|`List`|该分类下包含的 Gift 礼物对象数组。|
|
|
108
112
|
|
|
109
113
|
- `Gift`** 参数说明**
|
|
110
114
|
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
115
|
+
|**参数**|**类型**|**描述**|
|
|
116
|
+
|---------|---------|---------|
|
|
117
|
+
|`giftID`|`String`| 礼物的唯一 ID。|
|
|
118
|
+
|`name`|`String`| 礼物的显示名称。|
|
|
119
|
+
|`desc`|`String`| 礼物的描述信息。|
|
|
120
|
+
|`iconURL`|`String`| 礼物图标 URL。|
|
|
121
|
+
|`resourceURL`|`String`| 礼物动画资源 URL。|
|
|
122
|
+
|`level`|`Long`| 礼物等级。|
|
|
123
|
+
|`coins`|`Long`| 礼物价格。|
|
|
124
|
+
|`extensionInfo`|`Map<String, String>`| 扩展信息字段。|
|
|
121
125
|
|
|
122
126
|
### 步骤3:获取礼物列表
|
|
123
127
|
|
|
@@ -189,11 +193,12 @@ class GiftManager(
|
|
|
189
193
|
```
|
|
190
194
|
|
|
191
195
|
#### `sendGift`接口参数
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
196
|
+
|
|
197
|
+
|**参数名**|**类型**|**描述**|
|
|
198
|
+
|---------|---------|---------|
|
|
199
|
+
|`giftID`|`String`|要发送的礼物的唯一 ID。|
|
|
200
|
+
|`count`|`Int`|发送的数量。|
|
|
201
|
+
|`completion`|`CompletionHandler?`|发送完成后的回调。|
|
|
197
202
|
|
|
198
203
|
## 功能进阶
|
|
199
204
|
|
|
@@ -247,9 +252,10 @@ class GiftManager(
|
|
|
247
252
|
#### 调用流程图
|
|
248
253
|
|
|
249
254
|
#### 涉及 REST API 接口一览
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
255
|
+
|
|
256
|
+
|接口|说明|请求示例|
|
|
257
|
+
|---------|---------|---------|
|
|
258
|
+
|回调配置 - 发送礼物之前回调|客户后台可以通过该回调决定是否通过送礼前校验等场景|调用示例|
|
|
253
259
|
|
|
254
260
|
### 实现全屏礼物动画播放
|
|
255
261
|
|
|
@@ -258,13 +264,14 @@ class GiftManager(
|
|
|
258
264
|
#### 实现方式
|
|
259
265
|
|
|
260
266
|
`AtomicXCore` 本身不包含礼物动画播放器,您需要根据业务需求选择并集成第三方库。以下是两种方案的对比:
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
267
|
+
|
|
268
|
+
|**对比项**|**基础方案 (SVGAPlayer-Android)**|**高级方案 (TCEffectPlayerKit)**|
|
|
269
|
+
|---------|---------|---------|
|
|
270
|
+
|计费|免费 (开源库)|付费 (需购买 License),请参见 [付费指引](https://cloud.tencent.com/document/product/616/116461)|
|
|
271
|
+
|集成方式|需手动集成 SVGAPlayer 库 (例如通过 Gradle)|需额外集成 TCEffectPlayerKit 并进行鉴权|
|
|
272
|
+
|动画格式支持|仅支持 SVGA|SVGA、PAG、WebP、Lottie、MP4 等多种格式|
|
|
273
|
+
|性能|建议 SVGA 文件 ≤ 10MB|支持更大的动画文件,复杂特效/多动画并发/低端机表现更优|
|
|
274
|
+
|推荐场景|礼物动画格式统一为 SVGA,且文件大小可控|需要支持多种动画格式,或对动画性能/设备兼容性有更高要求|
|
|
268
275
|
|
|
269
276
|
本章节主要演示基础方案的集成。如果您选择高级方案,请参见 [TCEffectPlayer 集成指引](https://cloud.tencent.com/document/product/616/116472)。
|
|
270
277
|
|
|
@@ -326,21 +333,23 @@ class LiveRoomActivity : AppCompatActivity() {
|
|
|
326
333
|
}
|
|
327
334
|
}
|
|
328
335
|
|
|
336
|
+
private val giftListener = object : GiftListener() {
|
|
337
|
+
override fun onReceiveGift(liveID: String, gift: Gift, count: Int, sender: LiveUserInfo) {
|
|
338
|
+
if (gift.resourceURL.isNotEmpty()) {
|
|
339
|
+
try {
|
|
340
|
+
val url = URL(gift.resourceURL)
|
|
341
|
+
playAnimation(url)
|
|
342
|
+
} catch (e: Exception) {
|
|
343
|
+
println("无效的动画URL: ${gift.resourceURL}")
|
|
344
|
+
}
|
|
345
|
+
}
|
|
346
|
+
}
|
|
347
|
+
}
|
|
348
|
+
|
|
329
349
|
fun setupGiftSubscription(liveId: String) {
|
|
330
350
|
giftStore = GiftStore.create(liveId)
|
|
331
351
|
|
|
332
|
-
giftStore.addGiftListener(
|
|
333
|
-
override fun onReceiveGift(liveID: String, gift: Gift, count: Int, sender: LiveUserInfo) {
|
|
334
|
-
if (gift.resourceURL.isNotEmpty()) {
|
|
335
|
-
try {
|
|
336
|
-
val url = URL(gift.resourceURL)
|
|
337
|
-
playAnimation(url)
|
|
338
|
-
} catch (e: Exception) {
|
|
339
|
-
println("无效的动画URL: ${gift.resourceURL}")
|
|
340
|
-
}
|
|
341
|
-
}
|
|
342
|
-
}
|
|
343
|
-
})
|
|
352
|
+
giftStore.addGiftListener(giftListener)
|
|
344
353
|
}
|
|
345
354
|
|
|
346
355
|
private fun playAnimation(url: URL) {
|
|
@@ -394,25 +403,21 @@ class LiveRoomManager(
|
|
|
394
403
|
) {
|
|
395
404
|
private val giftStore: GiftStore = GiftStore.create(liveId)
|
|
396
405
|
private val barrageStore: BarrageStore = BarrageStore.create(liveId)
|
|
406
|
+
private val giftListener = object : GiftListener() {
|
|
407
|
+
override fun onReceiveGift(liveID: String, gift: Gift, count: Int, sender: LiveUserInfo) {
|
|
408
|
+
val tipText = "送出了 ${gift.name} x $count"
|
|
409
|
+
val giftTip = Barrage(
|
|
410
|
+
liveID = liveID,
|
|
411
|
+
messageType = BarrageType.TEXT,
|
|
412
|
+
textContent = tipText
|
|
413
|
+
sender = sender
|
|
414
|
+
)
|
|
415
|
+
barrageStore.appendLocalTip(giftTip)
|
|
416
|
+
}
|
|
417
|
+
}
|
|
397
418
|
|
|
398
419
|
private fun setupGiftToBarrageFlow() {
|
|
399
|
-
giftStore.addGiftListener(
|
|
400
|
-
override fun onReceiveGift(liveID: String, gift: Gift, count: Int, sender: LiveUserInfo) {
|
|
401
|
-
// 1. 监听事件 2. 获取信息
|
|
402
|
-
|
|
403
|
-
// 4. 拼接消息
|
|
404
|
-
val tipText = "送出了 ${gift.name} x $count"
|
|
405
|
-
val giftTip = Barrage(
|
|
406
|
-
liveID = liveID,
|
|
407
|
-
messageType = BarrageType.TEXT,
|
|
408
|
-
textContent = tipText
|
|
409
|
-
sender = sender
|
|
410
|
-
)
|
|
411
|
-
|
|
412
|
-
// 5. 本地插入
|
|
413
|
-
barrageStore.appendLocalTip(giftTip)
|
|
414
|
-
}
|
|
415
|
-
})
|
|
420
|
+
giftStore.addGiftListener(giftListener)
|
|
416
421
|
}
|
|
417
422
|
}
|
|
418
423
|
```
|
|
@@ -420,10 +425,11 @@ class LiveRoomManager(
|
|
|
420
425
|
## API 文档
|
|
421
426
|
|
|
422
427
|
关于 [GiftStore](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.gift/-gift-store/index.html) 及其相关类的所有公开接口、属性和方法的详细信息,请参阅随 [AtomicXCore](https://tencent-rtc.github.io/TUIKit_Android/index.html) 框架的官方 API 文档。本指南使用到的相关 Store 如下:
|
|
423
|
-
|
|
424
|
-
|
|
|
425
|
-
|
|
426
|
-
|
|
|
428
|
+
|
|
429
|
+
|Store/Component|功能描述|API 文档|
|
|
430
|
+
|---------|---------|---------|
|
|
431
|
+
|GiftStore|礼物互动:获取礼物列表,发送 / 接收礼物,监听礼物事件(含发送者、礼物详情)。|[API 文档](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.gift/-gift-store/index.html)|
|
|
432
|
+
|BarrageStore|弹幕功能:发送文本 / 自定义弹幕,维护弹幕列表,实时监听弹幕状态。|[API 文档](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.barrage/-barrage-store/index.html)|
|
|
427
433
|
|
|
428
434
|
## 常见问题
|
|
429
435
|
|
|
@@ -3,18 +3,19 @@
|
|
|
3
3
|
## 核心概念
|
|
4
4
|
|
|
5
5
|
在开始集成之前,我们先通过下表了解一下跨房连线与 PK 相关的几个核心概念。
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
6
|
+
|
|
7
|
+
|**核心概念**|**类型**|**核心职责与描述**|
|
|
8
|
+
|---------|---------|---------|
|
|
9
|
+
|**CoHostStore**|抽象类|管理主播间的连线生命周期,提供连线功能 API(requestHostConnection、acceptHostConnection)。|
|
|
10
|
+
|**BattleStore**|抽象类|管理跨房 PK 对战的信令与数据,包括 PK 状态。|
|
|
11
|
+
|**LiveListStore**|单例|提供直播房间列表的拉取功能 (`fetchLiveList`),用于获取可连线的其他房间信息。|
|
|
12
|
+
|**LiveSeatStore**|抽象类|管理房间内所有麦位状态(包括连线状态下的跨房间麦位),用于监听用户上下麦、麦克风等状态。|
|
|
13
|
+
|**CoHostLayoutTemplate**|枚举|连线时,用于指定房间麦位布局模板,例如 `HOST_STATIC_VOICE_6V6`。|
|
|
14
|
+
|**BattleConfig**|数据模型|配置 PK 的详细信息,例如 PK 时长 (`duration`) 和是否需要二次响应 (`needResponse`)。|
|
|
14
15
|
|
|
15
16
|
## 前提条件
|
|
16
17
|
|
|
17
|
-
请参考
|
|
18
|
+
请参考 开播与收听 集成 **AtomicXCore SDK**,并完成 **主播开播** 和 **观众观看** 的功能实现。
|
|
18
19
|
|
|
19
20
|
## 主播发起一场连线
|
|
20
21
|
|
|
@@ -28,7 +29,7 @@
|
|
|
28
29
|
>
|
|
29
30
|
> - 如果接口返回的列表中没有找到您想要的直播间,您需要检查开播时设置的 `TUILiveInfo` 的 `isPublicVisible` 字段是否为 `true`;
|
|
30
31
|
> - 该接口支持分页继续拉取,您可以使用接口 `onSuccess` 回调中 `cursor` 作为下一次续拉的游标,如果返回的 `cursor` 为空,则表示直播间列表已全部拉取完;
|
|
31
|
-
> - 为了性能考虑,建议您将pageCount设置为 20。
|
|
32
|
+
> - 为了性能考虑,建议您将 pageCount 设置为 20。
|
|
32
33
|
|
|
33
34
|
``` java
|
|
34
35
|
import io.trtc.tuikit.atomicxcore.api.live.LiveListStore
|
|
@@ -150,7 +151,7 @@ liveSeatStore.liveSeatState.seatList.collect { seatList: List<SeatInfo> ->
|
|
|
150
151
|
|
|
151
152
|
### 步骤6:连线过程中继续邀请其他主播参与连线
|
|
152
153
|
|
|
153
|
-
AtomicXCore
|
|
154
|
+
AtomicXCore 支持您在已经连线的过程中,还可以继续邀请其他主播参与连线,您可以继续调用 `requestHostConnection` 邀请新的主播参与连线。
|
|
154
155
|
``` java
|
|
155
156
|
import io.trtc.tuikit.atomicxcore.api.live.CoHostLayoutTemplate
|
|
156
157
|
import io.trtc.tuikit.atomicxcore.api.CompletionHandler
|
|
@@ -198,10 +199,11 @@ public void onExitButtonClicked() {
|
|
|
198
199
|
## 主播发起 PK
|
|
199
200
|
|
|
200
201
|
主播发起 PK 支持两种主要业务流程,以满足不同直播互动需求。核心区别在于 PK 发起前房间的状态。
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
202
|
+
|
|
203
|
+
|**PK 模式**|**房间状态(PK 前)**|**房间状态(PK 后)**|
|
|
204
|
+
|---------|---------|---------|
|
|
205
|
+
|**场景一:主播在连线后再发起 PK**|双方**已连线**|恢复连线状态|
|
|
206
|
+
|**场景二:主播发起带 PK 模式的连线**|双方**未连线**|恢复连线状态|
|
|
205
207
|
|
|
206
208
|
### 场景一:主播在连线后再发起 PK
|
|
207
209
|
|
|
@@ -210,7 +212,7 @@ AtomicXCore 支持您在这些主播中发起限时的对战 PK。交互如下
|
|
|
210
212
|
|
|
211
213
|
2. 参与连线的主播,点击 PK 按钮发起一场限时的对战,可以通过主播收到的礼物数来判定对战的胜负。
|
|
212
214
|
|
|
213
|
-
3. 对端主播可以弹框提醒,并提示是否加入PK,当被邀请的主播同意后对战即刻开始。
|
|
215
|
+
3. 对端主播可以弹框提醒,并提示是否加入 PK,当被邀请的主播同意后对战即刻开始。
|
|
214
216
|
|
|
215
217
|
4. PK 开始后,UI 进入对战状态,显示 PK 进度条;该进度条可以是主播收到的礼物数,也可以是收到的点赞数等业务数据。
|
|
216
218
|
|
|
@@ -249,7 +251,7 @@ battleStore.requestBattle(
|
|
|
249
251
|
|
|
250
252
|
#### 步骤 2. 对端主播收到 PK 邀请
|
|
251
253
|
|
|
252
|
-
当 PK 请求成功发出后,对端主播会收到 `BattleListener` 的 `onBattleRequestReceived` 回调,您可以在这个回调中给对端主播的UI 提醒 “有人邀请您 PK”,您也可以通过该回调的 battleInfo 参数的 config 字段中的 needResponse 信息确认是否需要 UI 提醒,例如:
|
|
254
|
+
当 PK 请求成功发出后,对端主播会收到 `BattleListener` 的 `onBattleRequestReceived` 回调,您可以在这个回调中给对端主播的 UI 提醒 “有人邀请您 PK”,您也可以通过该回调的 battleInfo 参数的 config 字段中的 needResponse 信息确认是否需要 UI 提醒,例如:
|
|
253
255
|
- 当 needResponse 为 false 时,您无需提醒,直接进入 PK 状态(详见步骤 3)。
|
|
254
256
|
|
|
255
257
|
- 当 needResponse 为 true 时,您可以弹框提醒 “有人邀请您 PK”,当对端主播点击同意后进入 PK 状态(详见步骤 3)。
|
|
@@ -292,7 +294,7 @@ battleStore.requestBattle(
|
|
|
292
294
|
|
|
293
295
|
##### 2. 主动调用 exitBattle 结束 PK
|
|
294
296
|
|
|
295
|
-
在 PK 过程中,参与 PK 的任一主播均可以调用 `BattleStore` 的 `exitBattle` 退出 PK,其他主播依然处于 PK 中不受影响,且会收到 `BattleListener` 的 `onUserExitBattle` 回调,您可以在这个回调中提醒 “有人退出 PK”;如果在 PK 的 `duration` 还未结束之前,其余人都主动调用 `BattleStore` 的 `exitBattle` 结束 PK 后,整个 PK 同样也会提前结束,最后一个 PK
|
|
297
|
+
在 PK 过程中,参与 PK 的任一主播均可以调用 `BattleStore` 的 `exitBattle` 退出 PK,其他主播依然处于 PK 中不受影响,且会收到 `BattleListener` 的 `onUserExitBattle` 回调,您可以在这个回调中提醒 “有人退出 PK”;如果在 PK 的 `duration` 还未结束之前,其余人都主动调用 `BattleStore` 的 `exitBattle` 结束 PK 后,整个 PK 同样也会提前结束,最后一个 PK 主播也会收到 `BattleListener` 的 `onUserExitBattle` 回调。
|
|
296
298
|
``` java
|
|
297
299
|
val battleStore:BattleStore = BattleStore.create(liveID)
|
|
298
300
|
battleID = battleStore.battleState.currentBattleInfo.value?.battleID
|
|
@@ -327,7 +329,7 @@ AtomicXCore 支持您在房间内直播时,直接发起 PK (中间不经历
|
|
|
327
329
|
|
|
328
330
|
#### 步骤 1. 主播发起连线请求
|
|
329
331
|
|
|
330
|
-
此处的步骤与 《主播发起一场连线》中的步骤 1 和步骤 2
|
|
332
|
+
此处的步骤与 《主播发起一场连线》中的步骤 1 和步骤 2 相似。唯一的区别在于:主播发起连线请求时,通过 `CoHostStore` 的 `requestConnection` 接口设置 `extensionInfo` 字段来标识当前的连线发起后需要同步发起 PK,用于对端主播 UI 提示信息的区分。
|
|
331
333
|
|
|
332
334
|
例如:
|
|
333
335
|
- 当 `extensionInfo` 设置为 {"withPK:true"} 时,对端主播收到连线请求后 UI 提示 “主播向您发起 PK”。
|
|
@@ -431,12 +433,13 @@ override fun onCoHostRequestReceived(inviter: SeatUserInfo, extensionInfo: Strin
|
|
|
431
433
|
|
|
432
434
|
> LiveKit 后台的 PK 分数系统采用纯数值计算和累加机制,所以您需要根据自身的运营策略和业务需求,调用更新接口前完成 PK 分数的计算,您可以参考以下的 PK 分数计算示例:
|
|
433
435
|
>
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
436
|
+
|
|
437
|
+
|礼物类型|分数计算规则|示例|
|
|
438
|
+
|---------|---------|---------|
|
|
439
|
+
|基础礼物|礼物价值 × 5|10元礼物 → 50分|
|
|
440
|
+
|中级礼物|礼物价值 × 8|50元礼物 → 400分|
|
|
441
|
+
|高级礼物|礼物价值 × 12|100元礼物 → 1200分|
|
|
442
|
+
|特效礼物|固定高分数|520元礼物 → 1314分|
|
|
440
443
|
|
|
441
444
|
#### REST API 调用流程
|
|
442
445
|
|
|
@@ -454,12 +457,13 @@ override fun onCoHostRequestReceived(inviter: SeatUserInfo, extensionInfo: Strin
|
|
|
454
457
|
4. **LiveKit 后台 同步客户端**:LiveKit 后台自动将更新后的 PK 分数同步到所有客户端。
|
|
455
458
|
|
|
456
459
|
#### 涉及的 REST API 接口
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
460
|
+
|
|
461
|
+
|接口|功能描述|请求示例|
|
|
462
|
+
|---------|---------|---------|
|
|
463
|
+
|主动接口 - 查询 PK 状态|可根据此接口查询当前房间是否在 PK。|请求示例|
|
|
464
|
+
|主动接口 - 修改 PK 分数|将计算后的 PK 数值通过此接口更新。|请求示例|
|
|
465
|
+
|回调配置 - PK 开始时回调|客户后台可以通过该回调及时知晓 PK 开启。|回调示例|
|
|
466
|
+
|回调配置 - PK 结束时回调|客户后台可以通过该回调及时知晓 PK 结束。|回调示例|
|
|
463
467
|
|
|
464
468
|
### 区分 PK 胜负
|
|
465
469
|
|
|
@@ -480,12 +484,13 @@ override fun onCoHostRequestReceived(inviter: SeatUserInfo, extensionInfo: Strin
|
|
|
480
484
|
## API 文档
|
|
481
485
|
|
|
482
486
|
关于 `CoHostStore`、`BattleStore`、`LiveListStore` 和 `LiveSeatStore` 及其相关类的所有公开接口、属性和方法的详细信息,请参阅随 [**AtomicXCore**](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore) 框架的官方 API 文档。
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
487
|
+
|
|
488
|
+
|**Store/Component**|**功能描述**|**API 文档**|
|
|
489
|
+
|---------|---------|---------|
|
|
490
|
+
|**CoHostStore**|直播视频流展示与交互的核心视图组件:负责视频流渲染和视图挂件处理,支持主播直播、观众连麦、主播连线等场景。|[API 文档](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-co-host-store/index.html)|
|
|
491
|
+
|**BattleStore**|直播间全生命周期管理:创建 / 加入 / 离开 / 销毁房间,查询房间列表,修改直播信息(名称、公告等),监听直播状态(例如被踢出、结束)。|[API 文档](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-battle-store/index.html)|
|
|
492
|
+
|**LiveListStore**|直播间全生命周期管理:查询房间列表,修改直播信息等。|[API 文档](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-live-list-store/index.html)|
|
|
493
|
+
|**LiveSeatStore**|麦位状态管理: 管理房间内所有麦位状态(包括连线状态下的跨房间麦位),用于监听用户上下麦、麦克风、麦位状态等信息。|[API 文档](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-live-seat-store/index.html)|
|
|
489
494
|
|
|
490
495
|
## 常见问题
|
|
491
496
|
|
|
@@ -502,13 +507,13 @@ override fun onCoHostRequestReceived(inviter: SeatUserInfo, extensionInfo: Strin
|
|
|
502
507
|
|
|
503
508
|
- 检查网络连接是否通畅,邀请信令有30秒的默认超时时间。
|
|
504
509
|
|
|
505
|
-
#### 连线或 PK 过程中,一方主播网络断开或App崩溃了怎么办?
|
|
510
|
+
#### 连线或 PK 过程中,一方主播网络断开或 App 崩溃了怎么办?
|
|
506
511
|
|
|
507
|
-
**CoHostStore** 和 **BattleStore** 内部都有心跳和超时检测机制。如果一方异常退出,另一方会通过 `onCoHostUserLeft` 或 `onUserExitBattle` 等事件收到通知,您可以根据这些事件来处理UI,例如提示"对方已掉线"并结束互动。
|
|
512
|
+
**CoHostStore** 和 **BattleStore** 内部都有心跳和超时检测机制。如果一方异常退出,另一方会通过 `onCoHostUserLeft` 或 `onUserExitBattle` 等事件收到通知,您可以根据这些事件来处理 UI,例如提示"对方已掉线"并结束互动。
|
|
508
513
|
|
|
509
514
|
#### 为什么 PK 分数只能通过 REST API 更新?
|
|
510
515
|
|
|
511
|
-
因为 REST API能同时满足 PK 分数的**安全性、实时性、扩展性**需求:
|
|
516
|
+
因为 REST API 能同时满足 PK 分数的**安全性、实时性、扩展性**需求:
|
|
512
517
|
- **防篡改保公平**:需鉴权 + 数据校验,每笔更新可追溯来源(例如礼物行为),杜绝手动改分、刷分,保障竞技公平。
|
|
513
518
|
|
|
514
519
|
- **多端实时同步**:用标准化格式(例如 JSON)快速对接礼物、PK、展示系统,确保主播 / 观众 / 后台分数实时一致,无延迟。
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
本文档将帮助开发者使用 `AtomicXCore SDK
|
|
1
|
+
本文档将帮助开发者使用 `AtomicXCore SDK` 的 `LiveListStore` 和 `LiveSeatStore` 快速构建一个包含主播开播和观众进房功能的语聊房 App。
|
|
2
2
|
|
|
3
3
|
## 核心概念
|
|
4
4
|
|
|
5
5
|
在开始集成之前,我们先通过下表了解一下 `LiveSeatStore` 相关的几个核心概念:
|
|
6
|
-
|
|
|
6
|
+
| <strong>核心概念</strong> | <strong>类型</strong> | <strong>核心职责与描述</strong> |
|
|
7
7
|
| --- | --- | --- |
|
|
8
|
-
|
|
|
9
|
-
|
|
|
10
|
-
|
|
|
11
|
-
|
|
|
8
|
+
| <code>LiveSeatStore</code> | <code>abstract class</code> | 麦位管理核心,负责管理房间内的所有麦位信息和麦位相关操作。<br>通过 <code>liveSeatState.seatList</code> 暴露实时的麦位列表数据流。 |
|
|
9
|
+
| <code>LiveSeatState</code> | <code>data class</code> | 代表麦位的当前状态。<br>- <code>seatList</code> :是一个 <code>StateFlow</code>,存储了麦位列表的实时状态。<br>- <code>speakingUsers</code> :则代表当前正在说话的人和对应的音量。 |
|
|
10
|
+
| <code>SeatInfo</code> | <code>data class</code> | 单个麦位的数据模型。<code> LiveSeatStore</code> 所推送的麦位列表(<code>seatList</code>)就是由多个 <code>SeatInfo</code> 对象组成的。<br>关键字段:<br>- <code>index</code>:麦位的索引(位置)。<br>- <code>isLocked </code>:麦位是否被锁定。<br>- <code>userInfo</code>: 麦位上的用户信息。如果麦位为空,此字段也为空对象。 |
|
|
11
|
+
| <code>SeatUserInfo</code> | <code>data class</code> | 麦上用户的详细数据模型。 当一个用户成功上麦后,<code>SeatInfo</code> 中的 <code>userInfo</code> 字段就会被填充为此用户。<br>关键字段:<br>- <code>userID</code>: 用户的唯一 ID。<br>- <code>userName</code>: 用户的昵称。<br>- <code>avatarURL</code>: 用户的头像 URL。<br>- <code>microphoneStatus</code>: 麦克风状态(开/关)。<br>- <code>cameraStatus</code>: 摄像头状态(开/关)。 |
|
|
12
12
|
|
|
13
13
|
## 准备工作
|
|
14
14
|
|
|
@@ -72,11 +72,11 @@ class MainActivity : AppCompatActivity() {
|
|
|
72
72
|
```
|
|
73
73
|
|
|
74
74
|
**登录接口参数说明:**
|
|
75
|
-
|
|
|
75
|
+
| <strong>参数</strong> | <strong>类型</strong> | <strong>说明</strong> |
|
|
76
76
|
| --- | --- | --- |
|
|
77
|
-
|
|
|
78
|
-
|
|
|
79
|
-
|
|
|
77
|
+
| <code>sdkAppId</code> | <code>Int</code> | 从 <a href="https://console.cloud.tencent.com/trtc">控制台</a> 获取,通常是以 <code>140</code> 或 <code>160</code> 开头的10位整数。 |
|
|
78
|
+
| <code>userID</code> | <code>String</code> | 当前用户的唯一 <code>ID</code>,仅包含英文字母、数字、连字符和下划线。为避免多端登录冲突,<strong>请勿使用</strong><code>1</code>、<code>123</code><strong>等简单 ID</strong>。 |
|
|
79
|
+
| <code>userSig</code> | <code>String</code> | 用于腾讯云鉴权的票据。请注意:<br>- 开发环境:您可以采用本地 <code>GenerateTestUserSig.genTestSig</code> 函数生成 <code>userSig</code> 或者 通过 <a href="https://console.cloud.tencent.com/im/tool-usersig">UserSig 辅助工具</a> 生成临时的 <code>UserSig</code>。<br>- 生产环境:为了防止密钥泄露,请务必采用服务端生成 <code>UserSig</code> 的方式。详细信息请参考 <a href="https://cloud.tencent.com/document/product/647/17275">服务端生成 UserSig</a>。<br>更多信息请参见 <a href="https://cloud.tencent.com/document/product/647/17275">如何计算及使用 UserSig</a>。 |
|
|
80
80
|
|
|
81
81
|
## 搭建基础语聊房
|
|
82
82
|
|
|
@@ -201,20 +201,20 @@ class YourAnchorActivity : AppCompatActivity() {
|
|
|
201
201
|
```
|
|
202
202
|
|
|
203
203
|
`LiveInfo`** 参数说明**
|
|
204
|
-
|
|
|
204
|
+
| <strong>参数名</strong> | <strong>类型</strong> | <strong>属性</strong> | <strong>描述</strong> |
|
|
205
205
|
| --- | --- | --- | --- |
|
|
206
|
-
|
|
|
207
|
-
|
|
|
208
|
-
|
|
|
209
|
-
|
|
|
210
|
-
|
|
|
211
|
-
|
|
|
212
|
-
|
|
|
213
|
-
|
|
|
214
|
-
|
|
|
215
|
-
|
|
|
216
|
-
|
|
|
217
|
-
|
|
|
206
|
+
| <code>liveID</code> | <code>String</code> | 必填 | 直播间的唯一标识符。 |
|
|
207
|
+
| <code>liveName</code> | <code>String</code> | 选填 | 直播间的标题。 |
|
|
208
|
+
| <code>notice</code> | <code>String</code> | 选填 | 直播间的公告信息。 |
|
|
209
|
+
| <code>isMessageDisable</code> | <code>Boolean</code> | 选填 | 是否禁言(<code>true</code>:是,<code>false</code>:否)。 |
|
|
210
|
+
| <code>isPublicVisible</code> | <code>Boolean</code> | 选填 | 是否公开可见(<code>true</code>:是,<code>false</code>:否)。 |
|
|
211
|
+
| <code>seatMode</code> | <code>TakeSeatMode</code> | 选填 | 上麦模式(<code>FREE</code>:自由上麦,<code>APPLY</code>:申请上麦)。 |
|
|
212
|
+
| <code>seatTemplate</code> | <code>SeatLayoutTemplate</code> | 必填 | 麦位布局模板。 |
|
|
213
|
+
| <code>coverURL</code> | <code>String</code> | 选填 | 直播间的封面图片地址。 |
|
|
214
|
+
| <code>backgroundURL</code> | <code>String</code> | 选填 | 直播间的背景图片地址。 |
|
|
215
|
+
| <code>categoryList</code> | <code>List<Int></code> | 选填 | 直播间的分类标签列表。 |
|
|
216
|
+
| <code>activityStatus</code> | <code>Int</code> | 选填 | 直播活动状态。 |
|
|
217
|
+
| <code>isGiftEnabled</code> | <code>Boolean</code> | 选填 | 是否启用礼物功能(<code>true</code>:是,<code>false</code>:否)。 |
|
|
218
218
|
|
|
219
219
|
#### **4. 构建麦位 UI 界面**
|
|
220
220
|
|
|
@@ -469,28 +469,29 @@ class YourAnchorActivity : AppCompatActivity() {
|
|
|
469
469
|
## 丰富语聊房场景
|
|
470
470
|
|
|
471
471
|
当您完成了基础的语聊房功能后,您可以参考以下功能指南来为语聊房添加丰富的互动玩法。
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
472
|
+
|
|
473
|
+
|**功能**|**功能介绍**|**功能 Stores**|**实现指南**|
|
|
474
|
+
|---------|---------|---------|---------|
|
|
475
|
+
|**实现听众上麦**|听众申请上麦,与房主进行实时语音互动。|[CoGuestStore](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-co-guest-store/index.html)|观众上麦|
|
|
476
|
+
|**实现房主跨房连线 PK**|两个不同房间的主播进行连线,实现互动或 PK。|[CoHostStore](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-co-host-store/index.html)<br>[BattleStore](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-battle-store/index.html)|主播连线 & PK|
|
|
477
|
+
|**添加弹幕聊天功能**|房间内成员可以发送和接收实时文字消息。|[BarrageStore](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.barrage/-barrage-store/index.html)|实现弹幕功能|
|
|
478
|
+
|**构建礼物赠送系统**|观众可以向主播赠送虚拟礼物,增加互动和趣味性。|[GiftStore](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.gift/-gift-store/index.html)|实现礼物功能|
|
|
478
479
|
|
|
479
480
|
## API 文档
|
|
480
|
-
|
|
|
481
|
+
| <strong>Store/Component</strong> | <strong>功能描述</strong> | <strong>API 文档</strong> |
|
|
481
482
|
| --- | --- | --- |
|
|
482
|
-
|
|
|
483
|
-
|
|
|
484
|
-
|
|
|
485
|
-
|
|
|
486
|
-
|
|
|
487
|
-
|
|
|
488
|
-
|
|
|
489
|
-
|
|
|
490
|
-
|
|
|
491
|
-
|
|
|
492
|
-
|
|
|
493
|
-
|
|
|
483
|
+
| <strong>LiveListStore</strong> | 直播间全生命周期管理:创建 / 加入 / 离开 / 销毁房间,查询房间列表,修改直播信息(名称、公告等),监听直播状态(例如被踢出、结束)。 | <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-live-list-store/index.html">API 文档</a> |
|
|
484
|
+
| <strong>LiveSeatStore</strong> | 麦位管理核心:管理麦位列表、麦上用户状态、麦位相关操作(上麦、下麦、踢人、锁麦、开关麦克风/摄像头等),监听麦位事件。 | <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-live-seat-store/index.html">API 文档</a> |
|
|
485
|
+
| <strong>DeviceStore</strong> | 音视频设备控制:麦克风(开关 / 音量)、摄像头(开关 / 切换 / 画质)、屏幕共享,设备状态实时监听。 | <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.device/-device-store/index.html">API 文档</a> |
|
|
486
|
+
| <strong>CoGuestStore</strong> | 观众连麦管理:连麦申请 / 邀请 / 同意 / 拒绝,连麦成员权限控制(麦克风 / 摄像头),状态同步。 | <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-co-guest-store/index.html">API 文档</a> |
|
|
487
|
+
| <strong>CoHostStore</strong> | 主播跨房连线:支持多布局模板(动态网格等),发起 / 接受 / 拒绝连线,连麦主播互动管理。 | <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-co-host-store/index.html">API 文档</a> |
|
|
488
|
+
| <strong>BattleStore</strong> | 主播 PK 对战:发起 PK(配置时长 / 对手),管理 PK 状态(开始 / 结束),同步分数,监听对战结果。 | <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-battle-store/index.html">API 文档</a> |
|
|
489
|
+
| <strong>GiftStore</strong> | 礼物互动:获取礼物列表,发送 / 接收礼物,监听礼物事件(含发送者、礼物详情)。 | <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.gift/-gift-store/index.html">API 文档</a> |
|
|
490
|
+
| <strong>BarrageStore</strong> | 弹幕功能:发送文本 / 自定义弹幕,维护弹幕列表,实时监听弹幕状态。 | <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.barrage/-barrage-store/index.html">API 文档</a> |
|
|
491
|
+
| <strong>LikeStore</strong> | 点赞互动:发送点赞,监听点赞事件,同步总点赞数。 | <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-like-store/index.html">API 文档</a> |
|
|
492
|
+
| <strong>LiveAudienceStore</strong> | 观众管理:获取实时观众列表(ID / 名称 / 头像),统计观众数量,监听观众进出事件。 | <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-live-audience-store/index.html">API 文档</a> |
|
|
493
|
+
| <strong>AudioEffectStore</strong> | 音频特效:变声(童声 / 男声)、混响(KTV 等)、耳返调节,实时切换特效。 | <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.device/-audio-effect-store/index.html">API 文档</a> |
|
|
494
|
+
| <strong>BaseBeautyStore</strong> | 基础美颜:调节磨皮 / 美白 / 红润(0-100 级),重置美颜状态,同步效果参数。 | <a href="https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.device/-base-beauty-store/index.html">API 文档</a> |
|
|
494
495
|
|
|
495
496
|
## 常见问题
|
|
496
497
|
|