@tencent-rtc/mcp 1.6.7 → 1.7.0
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/CHANGELOG.md +25 -0
- package/README.md +53 -39
- package/knowledge/build-index.js +31 -4
- package/knowledge/chunker.js +82 -14
- package/knowledge/chunking-policy.js +100 -0
- package/knowledge/content-loader.js +3 -1
- package/knowledge/frontmatter-meta.js +167 -0
- package/knowledge/path-meta.js +28 -6
- package/knowledge/search/exact-lookup.js +9 -227
- package/knowledge/search/filter-pool.js +17 -26
- package/knowledge/search/framework-fallback.js +22 -0
- package/knowledge/search/intent-router.js +13 -0
- package/knowledge/search/query-normalizer.js +129 -0
- package/knowledge/search/search-core.js +391 -0
- package/knowledge/search/search-knowledge.js +351 -323
- package/knowledge/search/search-message.js +87 -0
- package/knowledge/search/search-pass.js +428 -0
- package/knowledge/search/search-types.js +1 -0
- package/knowledge/search/url-row-scorer.js +258 -0
- package/package.json +1 -1
- package/resource/_schema/feature-aliases.yaml +1 -0
- package/resource/_schema/query-normalization.yaml +9 -0
- package/resource/index/manifest.json +1 -1
- package/resource/integration/callkit/preset/android/integration.md +3 -14
- package/resource/integration/callkit/preset/flutter/integration.md +1 -12
- package/resource/integration/callkit/preset/ios/integration.md +2 -12
- package/resource/integration/callkit/preset/react/integration.md +1 -14
- package/resource/integration/callkit/preset/vue/integration.md +1 -14
- package/resource/integration/chat/preset/android/integration.md +6 -13
- package/resource/integration/chat/preset/flutter/integration.md +1 -8
- package/resource/integration/chat/preset/ios/integration.md +4 -12
- package/resource/integration/chat/preset/react/integration.md +6 -16
- package/resource/integration/chat/preset/vue/integration.md +0 -9
- package/resource/integration/livekit/preset/live/android/live-audience-integration.md +2 -6
- package/resource/integration/livekit/preset/live/android/live-host-integration.md +1 -11
- package/resource/integration/livekit/preset/live/android/live-list-integration.md +2 -6
- package/resource/integration/livekit/preset/live/android/prepare-integration.md +2 -7
- package/resource/integration/livekit/preset/live/ios/live-audience-integration.md +2 -7
- package/resource/integration/livekit/preset/live/ios/live-host-integration.md +1 -13
- package/resource/integration/livekit/preset/live/ios/live-list-integration.md +2 -10
- package/resource/integration/livekit/preset/live/ios/prepare-integration.md +3 -8
- package/resource/integration/livekit/preset/live/vue/live-list-integration.md +0 -4
- package/resource/integration/livekit/preset/live/vue/live-player-desk-integration.md +1 -5
- package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +2 -7
- package/resource/integration/livekit/preset/live/vue/live-pusher-integration.md +2 -8
- package/resource/integration/roomkit/preset/vue/integration.md +0 -11
- package/resource/knowledge/callkit/best-practice/callkit-miniprogram/uniapp-shrink.md +60 -0
- package/resource/knowledge/callkit/best-practice/common/call-autoplay-blocked.md +77 -0
- package/resource/knowledge/callkit/best-practice/common/call-message-in-chat.md +78 -0
- package/resource/knowledge/callkit/best-practice/common/call-vs-calls.md +110 -0
- package/resource/knowledge/callkit/best-practice/common/callengine-call-flow.md +123 -0
- package/resource/knowledge/callkit/best-practice/common/callengine-log-level.md +67 -0
- package/resource/knowledge/callkit/best-practice/common/callkit-get-engine-instance.md +81 -0
- package/resource/knowledge/callkit/best-practice/common/callkit-get-roomid.md +78 -0
- package/resource/knowledge/callkit/best-practice/common/callkit-limitations.md +37 -0
- package/resource/knowledge/callkit/best-practice/common/callkit-user-register-and-kicked.md +98 -0
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +0 -7
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +0 -8
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +1 -9
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +2 -8
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +2 -8
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +1 -16
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +0 -8
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +0 -8
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +0 -11
- package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +178 -200
- package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +195 -217
- package/resource/knowledge/callkit/faq/android.md +4 -14
- package/resource/knowledge/callkit/faq/common.md +0 -2
- package/resource/knowledge/callkit/faq/error-code.md +2 -4
- package/resource/knowledge/callkit/faq/ios.md +1 -4
- package/resource/knowledge/callkit/preset/android/api.md +0 -6
- package/resource/knowledge/callkit/preset/ios/api.md +0 -4
- package/resource/knowledge/callkit/preset/react/api.md +3 -4
- package/resource/knowledge/callkit/preset/vue/api.md +3 -4
- package/resource/knowledge/chat/best-practice/common/avchatroom-message-loss-diagnosis.md +65 -0
- package/resource/knowledge/chat/best-practice/common/group-conversation-cleanup-on-system-notice.md +62 -0
- package/resource/knowledge/chat/best-practice/common/image-message-url-lifecycle.md +59 -0
- package/resource/knowledge/chat/best-practice/common/login-repeat-2025-diagnosis.md +61 -0
- package/resource/knowledge/chat/best-practice/common/message-read-report-and-receipt.md +64 -0
- package/resource/knowledge/chat/best-practice/common/message-receive-event.md +65 -0
- package/resource/knowledge/chat/best-practice/common/message-risk-error-and-render.md +65 -0
- package/resource/knowledge/chat/best-practice/common/message-unread-count.md +71 -0
- package/resource/knowledge/chat/best-practice/miniprogram/audio-message-send.md +113 -0
- package/resource/knowledge/chat/best-practice/miniprogram/login-timeout-2801-diagnosis.md +63 -0
- package/resource/knowledge/chat/best-practice/miniprogram/media-upload-fail-diagnosis.md +64 -0
- package/resource/knowledge/chat/best-practice/web/audio-message-send.md +118 -0
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +0 -5
- package/resource/knowledge/chat/preset/android/features/contact-list.md +0 -7
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +0 -6
- package/resource/knowledge/chat/preset/android/features/language.md +0 -8
- package/resource/knowledge/chat/preset/android/features/message-input.md +0 -6
- package/resource/knowledge/chat/preset/android/features/message-list.md +0 -8
- package/resource/knowledge/chat/preset/android/features/search.md +0 -7
- package/resource/knowledge/chat/preset/android/features/theme.md +0 -4
- package/resource/knowledge/chat/preset/android-view/integration.md +0 -6
- package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +0 -4
- package/resource/knowledge/chat/preset/flutter/features/contact-list.md +0 -9
- package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +0 -7
- package/resource/knowledge/chat/preset/flutter/features/language.md +0 -5
- package/resource/knowledge/chat/preset/flutter/features/message-input.md +0 -6
- package/resource/knowledge/chat/preset/flutter/features/message-list.md +0 -8
- package/resource/knowledge/chat/preset/flutter/features/search.md +0 -5
- package/resource/knowledge/chat/preset/flutter/features/theme.md +0 -4
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +0 -5
- package/resource/knowledge/chat/preset/ios/features/contact-list.md +0 -5
- package/resource/knowledge/chat/preset/ios/features/conversation-list.md +0 -7
- package/resource/knowledge/chat/preset/ios/features/language.md +1 -8
- package/resource/knowledge/chat/preset/ios/features/message-input.md +0 -6
- package/resource/knowledge/chat/preset/ios/features/message-list.md +0 -8
- package/resource/knowledge/chat/preset/ios/features/search.md +0 -5
- package/resource/knowledge/chat/preset/ios/features/theme.md +0 -4
- package/resource/knowledge/chat/preset/ios-uikit/integration.md +0 -6
- package/resource/knowledge/chat/preset/react/features/contact-list.md +0 -23
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +2 -11
- package/resource/knowledge/chat/preset/react/features/conversation-list.md +4 -26
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +0 -6
- package/resource/knowledge/chat/preset/react/features/search.md +0 -1
- package/resource/knowledge/chat/preset/react/features/theme.md +0 -1
- package/resource/knowledge/chat/preset/vue/features/contact-list.md +3 -9
- package/resource/knowledge/chat/preset/vue/features/conversation-actions.md +0 -3
- package/resource/knowledge/chat/preset/vue/features/conversation-list.md +2 -13
- package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +2 -3
- package/resource/knowledge/chat/preset/vue/features/conversation-search.md +1 -0
- package/resource/knowledge/chat/preset/vue/features/search.md +4 -3
- package/resource/knowledge/chat/urls/sdk/web.md +1 -1
- package/resource/knowledge/livekit/best-practice/android/voice-room-anchor-start.md +120 -0
- package/resource/knowledge/livekit/best-practice/common/admin-take-seat.md +73 -0
- package/resource/knowledge/livekit/best-practice/common/audience-leave-live.md +81 -0
- package/resource/knowledge/livekit/best-practice/common/voice-room-no-audio-troubleshoot.md +100 -0
- package/resource/knowledge/livekit/best-practice/common/voice-room-seat-list-change.md +65 -0
- package/resource/knowledge/livekit/best-practice/flutter/voice-room-anchor-start.md +122 -0
- package/resource/knowledge/livekit/best-practice/ios/voice-room-anchor-start.md +126 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +1 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/android/audience-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/android/audio-effect.md +2 -3
- package/resource/knowledge/livekit/core-sdk/features/android/barrage.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/android/base-beauty.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/android/gift.md +2 -7
- package/resource/knowledge/livekit/core-sdk/features/android/live-list.md +3 -4
- package/resource/knowledge/livekit/core-sdk/features/flutter/audience-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/audio-effect.md +2 -4
- package/resource/knowledge/livekit/core-sdk/features/flutter/barrage.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/base-beauty.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/gift.md +2 -7
- package/resource/knowledge/livekit/core-sdk/features/flutter/live-list.md +3 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/audience-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/audio-effect.md +2 -4
- package/resource/knowledge/livekit/core-sdk/features/ios/barrage.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/base-beauty.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/gift.md +2 -7
- package/resource/knowledge/livekit/core-sdk/features/ios/live-list.md +3 -4
- package/resource/knowledge/livekit/core-sdk/live/android/co-guest-interaction.md +0 -3
- package/resource/knowledge/livekit/core-sdk/live/android/host-interaction.md +0 -4
- package/resource/knowledge/livekit/core-sdk/live/android/integration.md +1 -4
- package/resource/knowledge/livekit/core-sdk/live/flutter/co-guest-interaction.md +1 -3
- package/resource/knowledge/livekit/core-sdk/live/flutter/host-interaction.md +0 -1
- package/resource/knowledge/livekit/core-sdk/live/flutter/integration.md +1 -4
- package/resource/knowledge/livekit/core-sdk/live/ios/co-guest-interaction.md +0 -3
- package/resource/knowledge/livekit/core-sdk/live/ios/host-interaction.md +0 -3
- package/resource/knowledge/livekit/core-sdk/live/ios/integration.md +1 -4
- package/resource/knowledge/livekit/core-sdk/voice/android/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/voice/android/host-interaction.md +0 -5
- package/resource/knowledge/livekit/core-sdk/voice/android/integration.md +1 -4
- package/resource/knowledge/livekit/core-sdk/voice/flutter/co-guest-interaction.md +1 -4
- package/resource/knowledge/livekit/core-sdk/voice/flutter/integration.md +3 -6
- package/resource/knowledge/livekit/core-sdk/voice/ios/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/voice/ios/host-interaction.md +0 -4
- package/resource/knowledge/livekit/core-sdk/voice/ios/integration.md +1 -4
- package/resource/knowledge/livekit/faq/error-code.md +0 -1
- package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +2 -3
- package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +3 -3
- package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +3 -3
- package/resource/knowledge/push/api-reference/android.md +0 -1
- package/resource/knowledge/push/api-reference/harmonyos.md +0 -2
- package/resource/knowledge/push/api-reference/react-native.md +3 -5
- package/resource/knowledge/push/api-reference/uni-app.md +3 -5
- package/resource/knowledge/push/api-reference/unity.md +0 -1
- package/resource/knowledge/push/api-reference/unreal-engine.md +0 -1
- package/resource/knowledge/push/config/android.md +0 -24
- package/resource/knowledge/push/config/harmonyos.md +0 -1
- package/resource/knowledge/push/config/ios.md +0 -3
- package/resource/knowledge/push/config/react-native.md +0 -29
- package/resource/knowledge/push/config/unity.md +1 -24
- package/resource/knowledge/push/config/unreal-engine.md +1 -24
- package/resource/knowledge/push/integration/android.md +0 -14
- package/resource/knowledge/push/integration/flutter.md +0 -19
- package/resource/knowledge/push/integration/harmonyos.md +0 -2
- package/resource/knowledge/push/integration/ios.md +0 -3
- package/resource/knowledge/push/integration/react-native.md +0 -24
- package/resource/knowledge/push/integration/uni-app.md +1 -11
- package/resource/knowledge/push/integration/unity.md +0 -9
- package/resource/knowledge/push/integration/unreal-engine.md +1 -17
- package/resource/knowledge/roomkit/best-practice/common/room-ghost-member.md +70 -0
- package/resource/knowledge/roomkit/best-practice/common/room-limit-and-multi.md +83 -0
- package/resource/knowledge/roomkit/best-practice/common/room-screen-share-preview.md +83 -0
- package/resource/knowledge/roomkit/best-practice/common/room-status-after-all-leave.md +69 -0
- package/resource/knowledge/roomkit/best-practice/vue/room-uikit-vs-atomicx.md +111 -0
- package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/android/room-state.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md +1 -5
- package/resource/knowledge/roomkit/core-sdk/ios/call-user-to-room.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/ios/schedule-room.md +1 -5
- package/resource/knowledge/roomkit/core-sdk/vue/call-user-to-room.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +0 -6
- package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +0 -9
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +0 -11
- package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +1 -5
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +1 -8
- package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +0 -3
- package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +0 -3
- package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +0 -5
- package/resource/knowledge/roomkit/preset/android/integration.md +0 -4
- package/resource/knowledge/roomkit/preset/flutter/integration.md +1 -13
- package/resource/knowledge/roomkit/preset/ios/integration.md +0 -6
- package/resource/knowledge/roomkit/preset/react/integration.md +0 -16
- package/resource/knowledge/rtcengine/web/api.md +1 -8
- package/resource/knowledge/rtcengine/web/faq.md +3 -5
- package/resource/knowledge/rtcengine/web/how_to_integrated_web_sdk.md +0 -6
- package/resource/knowledge/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/21-advanced-auto-play-policy.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/27-advanced-small-stream.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/30-advanced-cross-room-link.md +2 -0
- package/resource/knowledge/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -3
- package/resource/knowledge/rtcengine/web/plugin/34-advanced-proxy.md +2 -4
- package/resource/knowledge/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -4
- package/resource/knowledge/rtcengine/web/plugin/39-advanced-video-decoder.md +1 -1
- package/resource/knowledge/trtc/android/TRTCCloud.md +8 -56
- package/resource/knowledge/trtc/android/TRTCCloudDef.md +6 -7
- package/resource/knowledge/trtc/android/TRTCCloudListener.md +1 -18
- package/resource/knowledge/trtc/android/TXAudioEffectManager.md +0 -14
- package/resource/knowledge/trtc/android/TXDeviceManager.md +0 -1
- package/resource/knowledge/trtc/android/TXLiteAVCode.md +1 -1
- package/resource/knowledge/trtc/c++/ITRTCCloud.md +7 -59
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +0 -14
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +0 -4
- package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +1 -19
- package/resource/knowledge/trtc/c++/TRTCTypeDef.md +6 -7
- package/resource/knowledge/trtc/c++/TXLiteAVCode.md +1 -1
- package/resource/knowledge/trtc/ios/TRTCCloud.md +9 -60
- package/resource/knowledge/trtc/ios/TRTCCloudDef.md +6 -7
- package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +1 -19
- package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +0 -13
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +0 -4
- package/resource/knowledge/trtc/ios/TXLiteAVCode.md +1 -1
- package/server.js +27 -22
- package/tools/common/finalize_answer.js +9 -1
- package/tools/common/search_trtc_knowledge.js +3 -1
- package/tools/definitions/finalize_answer_def.js +2 -2
- package/tools/definitions/integration-boundary.js +2 -1
- package/tools/definitions/search_trtc_knowledge_def.js +2 -1
- package/utils/report-cls-client.js +3 -3
- package/utils/report-es-client.js +1 -1
- package/cursor-setting.png +0 -0
- package/mcp-server-prompt.png +0 -0
- package/resource/knowledge/callkit/best-practice/web/callengine-invitation.md +0 -80
- package/resource/knowledge/callkit/best-practice/web/callengine-log-control.md +0 -24
- package/resource/knowledge/callkit/best-practice/web/callkit-call-vs-calls.md +0 -116
- package/resource/knowledge/callkit/preset/react/uikit-api-reference.md +0 -445
- package/resource/knowledge/callkit/preset/vue/uikit-api-reference.md +0 -465
- package/resource/knowledge/chat/best-practice/web/image-message-url-handling.md +0 -16
- package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +0 -230
- package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +0 -797
- package/resource/knowledge/roomkit/core-sdk/flutter/room-state.md +0 -325
- package/resource/knowledge/roomkit/core-sdk/flutter/schedule-room.md +0 -325
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
`LoginStore` provides a complete set of login management APIs, including user login, logout, and personal information settings. Through this class, you can manage user login status and user profiles.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Use **LoginStore.shared** singleton object to access the `LoginStore` instance.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Login status updates are delivered through **loginState** publisher. Subscribe to it to receive real-time updates about login status.
|
|
13
11
|
>
|
|
14
12
|
|
|
@@ -3,17 +3,14 @@
|
|
|
3
3
|
`AudioEffectStore` provides a complete set of audio effect management APIs, including voice changer effects, reverb effects, and ear monitor functionality. Through this class, anchors can adjust their voice effects in real-time during live streaming to enhance the experience.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Use the **shared** singleton to get the `AudioEffectStore` instance. The set effects will automatically become invalid after leaving the room, and need to be set again for the next room entry.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Audio effect state updates are delivered through the **audioEffectState** publisher. Subscribe to it to receive real-time updates about voice changer, reverb, and ear monitor states.
|
|
13
11
|
>
|
|
14
12
|
|
|
15
13
|
> **Warning:**
|
|
16
|
-
>
|
|
17
14
|
> Due to the very high hardware latency of Bluetooth earphones, the ear monitor feature cannot be enabled when the anchor is wearing Bluetooth earphones. Please prompt the anchor to wear wired earphones in the user interface.
|
|
18
15
|
>
|
|
19
16
|
|
|
@@ -78,7 +75,6 @@ Call after entering the room and when voice changer effect is needed.
|
|
|
78
75
|
**Notes**
|
|
79
76
|
|
|
80
77
|
> **Note:**
|
|
81
|
-
>
|
|
82
78
|
> The set effect will automatically become invalid after leaving the room. If you need the corresponding effect for the next room entry, you need to call this interface again to set it.
|
|
83
79
|
>
|
|
84
80
|
|
|
@@ -112,7 +108,6 @@ Call after entering the room and when reverb effect is needed.
|
|
|
112
108
|
**Notes**
|
|
113
109
|
|
|
114
110
|
> **Note:**
|
|
115
|
-
>
|
|
116
111
|
> The set effect will automatically become invalid after leaving the room. If you need the corresponding effect for the next room entry, you need to call this interface again to set it.
|
|
117
112
|
>
|
|
118
113
|
|
|
@@ -148,7 +143,6 @@ Call after entering the room and when the anchor is wearing wired earphones.
|
|
|
148
143
|
**Notes**
|
|
149
144
|
|
|
150
145
|
> **Warning:**
|
|
151
|
-
>
|
|
152
146
|
> Due to the very high hardware latency of Bluetooth earphones, this effect cannot be enabled when the anchor is wearing Bluetooth earphones. Please try to prompt the anchor to wear wired earphones in the user interface.
|
|
153
147
|
>
|
|
154
148
|
|
|
@@ -178,7 +172,6 @@ Call after enabling the ear monitor feature.
|
|
|
178
172
|
**Notes**
|
|
179
173
|
|
|
180
174
|
> **Note:**
|
|
181
|
-
>
|
|
182
175
|
> If the volume is still too low after setting it to 100, you can set the volume to a maximum of 150, but a volume exceeding 100 may cause distortion, please operate with caution.
|
|
183
176
|
>
|
|
184
177
|
|
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
`BarrageStore` provides a complete set of barrage management APIs, including sending text barrages, sending custom barrages, and adding local tip messages. Through this class, you can implement barrage interaction functionality in live rooms.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Use the **create** factory method to create a `BarrageStore` instance, which requires a valid live room ID.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Barrage state updates are delivered through the **barrageState** publisher. Subscribe to it to receive real-time updates of barrage data in the room.
|
|
13
11
|
>
|
|
14
12
|
|
|
@@ -155,7 +153,6 @@ Supported since version 3.5.
|
|
|
155
153
|
**Notes**
|
|
156
154
|
|
|
157
155
|
> **Note:**
|
|
158
|
-
>
|
|
159
156
|
> This message is only displayed locally and will not be sent to other users through the network.
|
|
160
157
|
>
|
|
161
158
|
|
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
Basic beauty functionality achieves real-time beauty effect adjustment through easy-to-use APIs. `BaseBeautyStore` provides a complete set of interfaces to manage beauty effect settings and state subscriptions.
|
|
4
4
|
|
|
5
5
|
> **Note:**
|
|
6
|
-
>
|
|
7
6
|
> Beauty state updates are delivered through the **baseBeautyState** publisher. Subscribe to it to receive real-time updates about beauty effect levels.
|
|
8
7
|
>
|
|
9
8
|
|
|
@@ -3,17 +3,14 @@
|
|
|
3
3
|
PK feature enables real-time interactive battles between hosts. `BattleStore` provides a comprehensive set of APIs to manage the entire PK lifecycle.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Always use the factory method **create(liveID:)** with a valid live room ID to create a `BattleStore` instance. Do not attempt to initialize directly.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> PK state updates are delivered through the **battleState** publisher. Subscribe to it to receive real-time updates about PK information, participating users, and scores.
|
|
13
11
|
>
|
|
14
12
|
|
|
15
13
|
> **Warning:**
|
|
16
|
-
>
|
|
17
14
|
> If a PK request does not receive a response within the specified timeout, a timeout event will be triggered. Always handle timeout scenarios in the UI.
|
|
18
15
|
>
|
|
19
16
|
|
|
@@ -3,17 +3,14 @@
|
|
|
3
3
|
Co-guest feature enables real-time interaction between hosts and audience members through a seat-based system. `CoGuestStore` provides a comprehensive set of APIs to manage the entire co-guest lifecycle.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Always use the factory method **CoGuestStore.create** with a valid live room ID to create a `CoGuestStore` instance. Do not attempt to initialize directly.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Co-guest state updates are delivered through the **coGuestState** publisher. Subscribe to it to receive real-time updates about connected users, invitations and applications.
|
|
13
11
|
>
|
|
14
12
|
|
|
15
13
|
> **Warning:**
|
|
16
|
-
>
|
|
17
14
|
> If a co-guest request does not receive a response within the specified timeout, an event with `NoResponseReason.timeout` will be triggered. Always handle timeout scenarios in your UI.
|
|
18
15
|
>
|
|
19
16
|
|
|
@@ -160,7 +157,6 @@ Supported since version 3.5.
|
|
|
160
157
|
**Notes**
|
|
161
158
|
|
|
162
159
|
> **Note:**
|
|
163
|
-
>
|
|
164
160
|
> If no host responds within the timeout, {ref2} event with **NoResponseReason.timeout** will be triggered.
|
|
165
161
|
>
|
|
166
162
|
|
|
@@ -188,7 +184,6 @@ Supported since version 3.5.
|
|
|
188
184
|
**Notes**
|
|
189
185
|
|
|
190
186
|
> **Note:**
|
|
191
|
-
>
|
|
192
187
|
> If the application has already been processed by a host, the cancellation may have no effect.
|
|
193
188
|
>
|
|
194
189
|
|
|
@@ -3,17 +3,14 @@
|
|
|
3
3
|
Cross-room connection feature allows hosts from different live rooms to interact in real-time. `CoHostStore` provides a comprehensive set of APIs to manage the entire cross-room connection lifecycle.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Always use the factory method **CoHostStore.create** with a valid live room ID to create a `CoHostStore` instance. Do not attempt to initialize directly.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Connection state updates are delivered through the **coHostState** publisher. Subscribe to it to receive real-time updates about connection status, connected hosts, invitations and applications.
|
|
13
11
|
>
|
|
14
12
|
|
|
15
13
|
> **Warning:**
|
|
16
|
-
>
|
|
17
14
|
> If a connection request does not receive a response within the specified timeout, the timeout event will be triggered. Always handle timeout scenarios in your UI.
|
|
18
15
|
>
|
|
19
16
|
|
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
`DeviceStore` provides a comprehensive set of APIs to manage audio and video devices, including microphone, camera and screen sharing features.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Use **shared** singleton to get the `DeviceStore` instance. Do not attempt to initialize directly.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Device state updates are delivered through the **state** publisher. Subscribe to it to receive real-time updates about microphone, camera, network and other states.
|
|
13
11
|
>
|
|
14
12
|
|
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
`GiftStore` provides a complete set of gift management APIs, including sending gifts, refreshing gift lists, setting language, and listening to gift events. Through this class, gift interaction features can be implemented in live rooms.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Use the **GiftStore.create** factory method to create a `GiftStore` instance, passing a valid live room ID.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Gift state updates are delivered through the **giftState** publisher. Subscribe to it to receive real-time updates of gift data in the room.
|
|
13
11
|
>
|
|
14
12
|
|
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
`LikeStore` provides a complete set of like management APIs, including sending likes, listening to like events, and getting like states. Through this class, you can implement like interaction features in live rooms.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Use the **create** factory method to create a `LikeStore` instance, which requires a valid live room ID.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Like state updates are delivered through the **likeState** publisher. Subscribe to it to receive real-time updates of like data in the room.
|
|
13
11
|
>
|
|
14
12
|
|
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
`LiveAudienceStore` provides a complete set of audience management APIs, including fetching audience list, setting administrators, kicking users, muting, etc. Through this class, you can implement audience management functions in live rooms.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Use the **LiveAudienceStore.create** factory method to create a `LiveAudienceStore` instance, which requires a valid live room ID.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Audience state updates are delivered through the **liveAudienceState** publisher. Subscribe to it to receive real-time updates of audience data in the room.
|
|
13
11
|
>
|
|
14
12
|
|
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
`LiveCoreView` provides view container for live streaming push and playback, supporting multi-person co-guest, PK and other features. Through this component, video rendering and interaction in live rooms can be implemented.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Before using, you need to call **LiveCoreController.setLiveID** to set the live room ID first.
|
|
8
7
|
>
|
|
9
8
|
|
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
`LiveSeatStore` provides a complete set of seat management APIs, including taking seat, leaving seat, locking seat, unlocking seat, kicking user off seat, remote device control, etc. Through this class, seat management functionality can be implemented in the live room.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Use the **LiveSeatStore.create** factory method to create a `LiveSeatStore` instance, passing a valid live room ID.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Seat state updates are delivered through the **liveSeatState** publisher. Subscribe to it to receive real-time updates of seat data in the room.
|
|
13
11
|
>
|
|
14
12
|
|
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
`LoginStore` provides a complete set of login management APIs, including user login, logout, and personal information settings. Through this class, you can manage user login status and user profiles.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Use **shared** singleton object to access the `LoginStore` instance.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Login status updates are delivered through **loginState** publisher. Subscribe to it to receive real-time updates about login status.
|
|
13
11
|
>
|
|
14
12
|
|
|
@@ -85,7 +83,7 @@ Supported since version 3.5.
|
|
|
85
83
|
|---------|---------|---------|
|
|
86
84
|
|sdkAppID|int|SDK application ID. Get this from **TRTC console**(https://console.trtc.io/app).|
|
|
87
85
|
|userID|String|User ID. The recommended length limit is 32 bytes, and only uppercase and lowercase English letters (a-zA-Z), digits (0-9), underscores, and hyphens are allowed.|
|
|
88
|
-
|userSig|String|User signature. For the generation of userSig, please
|
|
86
|
+
|userSig|String|User signature. For the generation of userSig, please .io/document/35166).|
|
|
89
87
|
|
|
90
88
|
#### logout
|
|
91
89
|
|
|
@@ -3,17 +3,14 @@
|
|
|
3
3
|
`AudioEffectStore` provides a complete set of audio effect management APIs, including voice changer effects, reverb effects, and ear monitor functionality. Through this class, anchors can adjust their voice effects in real-time during live streaming to enhance the experience.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Use the **shared** singleton to get the `AudioEffectStore` instance. The set effects will automatically become invalid after leaving the room, and need to be set again for the next room entry.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Audio effect state updates are delivered through the **state** publisher. Subscribe to it to receive real-time updates about voice changer, reverb, and ear monitor states.
|
|
13
11
|
>
|
|
14
12
|
|
|
15
13
|
> **Warning:**
|
|
16
|
-
>
|
|
17
14
|
> Due to the very high hardware latency of Bluetooth earphones, the ear monitor feature cannot be enabled when the anchor is wearing Bluetooth earphones. Please prompt the anchor to wear wired earphones in the user interface.
|
|
18
15
|
>
|
|
19
16
|
|
|
@@ -80,7 +77,6 @@ Call after entering the room and when voice changer effect is needed.
|
|
|
80
77
|
**Notes**
|
|
81
78
|
|
|
82
79
|
> **Note:**
|
|
83
|
-
>
|
|
84
80
|
> The set effect will automatically become invalid after leaving the room. If you need the corresponding effect for the next room entry, you need to call this interface again to set it.
|
|
85
81
|
>
|
|
86
82
|
|
|
@@ -116,7 +112,6 @@ Call after entering the room and when reverb effect is needed.
|
|
|
116
112
|
**Notes**
|
|
117
113
|
|
|
118
114
|
> **Note:**
|
|
119
|
-
>
|
|
120
115
|
> The set effect will automatically become invalid after leaving the room. If you need the corresponding effect for the next room entry, you need to call this interface again to set it.
|
|
121
116
|
>
|
|
122
117
|
|
|
@@ -154,7 +149,6 @@ Call after entering the room and when the anchor is wearing wired earphones.
|
|
|
154
149
|
**Notes**
|
|
155
150
|
|
|
156
151
|
> **Warning:**
|
|
157
|
-
>
|
|
158
152
|
> Due to the very high hardware latency of Bluetooth earphones, this effect cannot be enabled when the anchor is wearing Bluetooth earphones. Please try to prompt the anchor to wear wired earphones in the user interface.
|
|
159
153
|
>
|
|
160
154
|
|
|
@@ -186,7 +180,6 @@ Call after enabling the ear monitor feature.
|
|
|
186
180
|
**Notes**
|
|
187
181
|
|
|
188
182
|
> **Note:**
|
|
189
|
-
>
|
|
190
183
|
> If the volume is still too low after setting it to 100, you can set the volume to a maximum of 150, but a volume exceeding 100 may cause distortion, please operate with caution.
|
|
191
184
|
>
|
|
192
185
|
|
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
`BarrageStore` provides a complete set of barrage management APIs, including sending text barrages, sending custom barrages, and adding local tip messages. Through this class, you can implement barrage interaction functionality in live rooms.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Use the **create(liveID:)** factory method to create a `BarrageStore` instance, which requires a valid live room ID.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Barrage state updates are delivered through the **state** publisher. Subscribe to it to receive real-time updates of barrage data in the room.
|
|
13
11
|
>
|
|
14
12
|
|
|
@@ -135,7 +133,6 @@ Supported since version 3.5.
|
|
|
135
133
|
**Notes**
|
|
136
134
|
|
|
137
135
|
> **Note:**
|
|
138
|
-
>
|
|
139
136
|
> This message is only displayed locally and will not be sent to other users through the network.
|
|
140
137
|
>
|
|
141
138
|
|
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
Basic beauty functionality achieves real-time beauty effect adjustment through easy-to-use APIs. `BaseBeautyStore` provides a complete set of interfaces to manage beauty effect settings and state subscriptions.
|
|
4
4
|
|
|
5
5
|
> **Note:**
|
|
6
|
-
>
|
|
7
6
|
> Beauty state updates are delivered through the **state** publisher. Subscribe to it to receive real-time updates about beauty effect levels.
|
|
8
7
|
>
|
|
9
8
|
|
|
@@ -3,17 +3,14 @@
|
|
|
3
3
|
PK feature enables real-time interactive battles between hosts. `BattleStore` provides a comprehensive set of APIs to manage the entire PK lifecycle.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Always use the factory method **create(liveID:)** with a valid live room ID to create a `BattleStore` instance. Do not attempt to initialize directly.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> PK state updates are delivered through the **state** publisher. Subscribe to it to receive real-time updates about PK information, participating users, and scores.
|
|
13
11
|
>
|
|
14
12
|
|
|
15
13
|
> **Warning:**
|
|
16
|
-
>
|
|
17
14
|
> If a PK request does not receive a response within the specified timeout, a timeout event will be triggered. Always handle timeout scenarios in the UI.
|
|
18
15
|
>
|
|
19
16
|
|
|
@@ -3,17 +3,14 @@
|
|
|
3
3
|
Co-guest feature enables real-time interaction between hosts and audience members through a seat-based system. `CoGuestStore` provides a comprehensive set of APIs to manage the entire co-guest lifecycle.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Always use the factory method **create(liveID:)** with a valid live room ID to create a `CoGuestStore` instance. Do not attempt to initialize directly.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Co-guest state updates are delivered through the **state** publisher. Subscribe to it to receive real-time updates about connected users, invitations and applications.
|
|
13
11
|
>
|
|
14
12
|
|
|
15
13
|
> **Warning:**
|
|
16
|
-
>
|
|
17
14
|
> If a co-guest request does not receive a response within the specified timeout, an event with `NoResponseReason.timeout` will be triggered. Always handle timeout scenarios in your UI.
|
|
18
15
|
>
|
|
19
16
|
|
|
@@ -118,7 +115,6 @@ Supported since version 3.5.
|
|
|
118
115
|
**Notes**
|
|
119
116
|
|
|
120
117
|
> **Note:**
|
|
121
|
-
>
|
|
122
118
|
> If no host responds within the timeout, {ref2} event with **NoResponseReason/timeout** will be triggered.
|
|
123
119
|
>
|
|
124
120
|
|
|
@@ -147,7 +143,6 @@ Supported since version 3.5.
|
|
|
147
143
|
**Notes**
|
|
148
144
|
|
|
149
145
|
> **Note:**
|
|
150
|
-
>
|
|
151
146
|
> If the application has already been processed by a host, the cancellation may have no effect.
|
|
152
147
|
>
|
|
153
148
|
|
|
@@ -3,17 +3,14 @@
|
|
|
3
3
|
Cross-room connection feature allows hosts from different live rooms to interact in real-time. `CoHostStore` provides a comprehensive set of APIs to manage the entire cross-room connection lifecycle.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Always use the factory method **create(liveID:)** with a valid live room ID to create a `CoHostStore` instance. Do not attempt to initialize directly.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Connection state updates are delivered through the **state** publisher. Subscribe to it to receive real-time updates about connection status, connected hosts, invitations and applications.
|
|
13
11
|
>
|
|
14
12
|
|
|
15
13
|
> **Warning:**
|
|
16
|
-
>
|
|
17
14
|
> If a connection request does not receive a response within the specified timeout, the timeout event will be triggered. Always handle timeout scenarios in your UI.
|
|
18
15
|
>
|
|
19
16
|
|
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
`DeviceStore` provides a comprehensive set of APIs to manage audio and video devices, including microphone, camera and screen sharing features.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Use **shared** singleton to get the `DeviceStore` instance. Do not attempt to initialize directly.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Device state updates are delivered through the **state** publisher. Subscribe to it to receive real-time updates about microphone, camera, network and other states.
|
|
13
11
|
>
|
|
14
12
|
|
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
`GiftStore` provides a complete set of gift management APIs, including sending gifts, refreshing gift lists, setting language, and listening to gift events. Through this class, gift interaction features can be implemented in live rooms.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Use the **create(liveID:)** factory method to create a `GiftStore` instance, passing a valid live room ID.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Gift state updates are delivered through the **state** publisher. Subscribe to it to receive real-time updates of gift data in the room.
|
|
13
11
|
>
|
|
14
12
|
|
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
`LikeStore` provides a complete set of like management APIs, including sending likes, listening to like events, and getting like states. Through this class, you can implement like interaction features in live rooms.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Use the **create(liveID:)** factory method to create a `LikeStore` instance, which requires a valid live room ID.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Like state updates are delivered through the **state** publisher. Subscribe to it to receive real-time updates of like data in the room.
|
|
13
11
|
>
|
|
14
12
|
|
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
`LiveAudienceStore` provides a complete set of audience management APIs, including fetching audience list, setting administrators, kicking users, muting, etc. Through this class, you can implement audience management functions in live rooms.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Use the **create(liveID:)** factory method to create a `LiveAudienceStore` instance, which requires a valid live room ID.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Audience state updates are delivered through the **state** publisher. Subscribe to it to receive real-time updates of audience data in the room.
|
|
13
11
|
>
|
|
14
12
|
|
|
@@ -3,7 +3,6 @@
|
|
|
3
3
|
`LiveCoreView` provides view container for live streaming push and playback, supporting multi-person co-guest, PK and other features. Through this component, video rendering and interaction in live rooms can be implemented.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Before using, you need to call **setLiveID(_:)** to set the live room ID first.
|
|
8
7
|
>
|
|
9
8
|
|
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
`LiveSeatStore` provides a complete set of seat management APIs, including taking seat, leaving seat, locking seat, unlocking seat, kicking user off seat, remote device control, etc. Through this class, seat management functionality can be implemented in the live room.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Use the **create(liveID:)** factory method to create a `LiveSeatStore` instance, passing a valid live room ID.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Seat state updates are delivered through the **state** publisher. Subscribe to it to receive real-time updates of seat data in the room.
|
|
13
11
|
>
|
|
14
12
|
|
|
@@ -3,12 +3,10 @@
|
|
|
3
3
|
`LoginStore` provides a complete set of login management APIs, including user login, logout, and personal information settings. Through this class, you can manage user login status and user profiles.
|
|
4
4
|
|
|
5
5
|
> **Important:**
|
|
6
|
-
>
|
|
7
6
|
> Use **shared** singleton object to access the `LoginStore` instance.
|
|
8
7
|
>
|
|
9
8
|
|
|
10
9
|
> **Note:**
|
|
11
|
-
>
|
|
12
10
|
> Login status updates are delivered through **state** publisher. Subscribe to it to receive real-time updates about login status.
|
|
13
11
|
>
|
|
14
12
|
|
|
@@ -23,9 +23,9 @@
|
|
|
23
23
|
## Implementation Guide
|
|
24
24
|
|
|
25
25
|
### Step 1: Component Integration
|
|
26
|
-
- **Video Live Streaming**: Please
|
|
26
|
+
- **Video Live Streaming**: Please
|
|
27
27
|
|
|
28
|
-
- **Voice Chat Room**: Please
|
|
28
|
+
- **Voice Chat Room**: Please .
|
|
29
29
|
|
|
30
30
|
### Step 2: Initialize and Retrieve the Audience List
|
|
31
31
|
|
|
@@ -25,9 +25,9 @@ By combining `AudioEffectStore` and DeviceStore, you can implement the following
|
|
|
25
25
|
## Implementation
|
|
26
26
|
|
|
27
27
|
### Step 1: Component Integration
|
|
28
|
-
- **Video Live Streaming**: Please
|
|
28
|
+
- **Video Live Streaming**: Please .**
|
|
29
29
|
|
|
30
|
-
- **Voice Chat Room**: Please
|
|
30
|
+
- **Voice Chat Room**: Please .
|
|
31
31
|
|
|
32
32
|
### Step 2: Obtain Store Instances
|
|
33
33
|
|
|
@@ -167,7 +167,6 @@ audioEffectStore.setAudioReverbType(AudioReverbType.NONE)
|
|
|
167
167
|
### Step 7: Reset Audio Effect Settings
|
|
168
168
|
|
|
169
169
|
> **Note:**
|
|
170
|
-
>
|
|
171
170
|
> `AudioEffectStore` and `DeviceStore` are singletons, so audio effect and device settings are globally applied. To prevent settings from one live room affecting others, reset audio effect and device settings when the current live room ends.
|
|
172
171
|
>
|
|
173
172
|
|
|
@@ -22,9 +22,9 @@ This document provides a comprehensive guide for iOS developers to quickly integ
|
|
|
22
22
|
## Implementation
|
|
23
23
|
|
|
24
24
|
### Step 1: Component Integration
|
|
25
|
-
- **Video Live Streaming**: Please
|
|
25
|
+
- **Video Live Streaming**: Please .
|
|
26
26
|
|
|
27
|
-
- **Voice Chat Room**: Please
|
|
27
|
+
- **Voice Chat Room**: Please .
|
|
28
28
|
|
|
29
29
|
### Step 2: Initialize and Listen to Barrages
|
|
30
30
|
|
|
@@ -20,9 +20,9 @@
|
|
|
20
20
|
## Implementation
|
|
21
21
|
|
|
22
22
|
### Step 1: Component Integration
|
|
23
|
-
- **Video Live Streaming**: Please
|
|
23
|
+
- **Video Live Streaming**: Please ..
|
|
24
24
|
|
|
25
|
-
- **Voice Chat Room**: Please
|
|
25
|
+
- **Voice Chat Room**: Please .
|
|
26
26
|
|
|
27
27
|
### Step 2: Obtain the Instance and Subscribe to State
|
|
28
28
|
|
|
@@ -1,9 +1,5 @@
|
|
|
1
1
|
`GiftStore` is a dedicated module within **AtomicXCore** for managing live room gifting features. It enables you to build a complete gifting system for your live streaming application, supporting robust monetization and interactive experiences.
|
|
2
2
|
|
|
3
|
-
|**Gift Panel**|**Barrage Gift**|**Full-Screen Gift**|
|
|
4
|
-
|---------|---------|---------|
|
|
5
|
-
||||
|
|
6
|
-
|
|
7
3
|
## Core Features
|
|
8
4
|
- **Gift List Retrieval**: Retrieve gift panel data from the server, including gift categories and details.
|
|
9
5
|
|
|
@@ -26,13 +22,12 @@
|
|
|
26
22
|
### Step 1: Component Integration
|
|
27
23
|
|
|
28
24
|
> **Note:**
|
|
29
|
-
>
|
|
30
25
|
> To use the gifting system, activate either the **Free Trial,** or **Pro** edition. The number of configurable gifts depends on the selected package. For details, see the **Gift System** section in Feature and Billing Description and choose the package that fits your needs.
|
|
31
26
|
>
|
|
32
27
|
|
|
33
|
-
- **Video Live Streaming**: Please
|
|
28
|
+
- **Video Live Streaming**: Please .
|
|
34
29
|
|
|
35
|
-
- **Voice Chat Room**: Please
|
|
30
|
+
- **Voice Chat Room**: Please .
|
|
36
31
|
|
|
37
32
|
### Step 2: Initialize and Listen for Gift Events
|
|
38
33
|
|
|
@@ -19,9 +19,9 @@
|
|
|
19
19
|
## Implementation
|
|
20
20
|
|
|
21
21
|
### Step 1: Component Integration
|
|
22
|
-
- **Video Live Streaming
|
|
22
|
+
- **Video Live Streaming**:.
|
|
23
23
|
|
|
24
|
-
- **Voice Chat Room
|
|
24
|
+
- **Voice Chat Room**:.
|
|
25
25
|
|
|
26
26
|
### Step 2: Implement Audience Entry from Live Room List
|
|
27
27
|
|
|
@@ -250,7 +250,6 @@ class LiveListActivity : AppCompatActivity() {
|
|
|
250
250
|
Users can switch between live rooms by swiping up and down. When a new live room is centered on the screen, the video preview automatically starts playing. When it leaves the screen, playback stops automatically to save bandwidth and device resources.
|
|
251
251
|
|
|
252
252
|
> **Note:**
|
|
253
|
-
>
|
|
254
253
|
> **Swipe-to-Play** is currently only supported for Video Live Streaming.
|
|
255
254
|
>
|
|
256
255
|
|
|
@@ -405,7 +404,7 @@ We recommend two approaches:
|
|
|
405
404
|
|
|
406
405
|
**Approach 1 (Recommended): Use seatLayoutTemplateID for differentiation.**
|
|
407
406
|
|
|
408
|
-
This template ID defines the room layout. For supported template IDs and effects
|
|
407
|
+
This template ID defines the room layout. For supported template IDs and effects.
|
|
409
408
|
- **Step 1: Specify ID when creating a room**
|
|
410
409
|
|
|
411
410
|
- When calling `LiveListStore.shared.createLive`, set the `seatLayoutTemplateID` property of `LiveInfo` based on your business scenario:
|
|
@@ -25,9 +25,9 @@ The following table introduces the core concepts of `LiveAudienceStore`:
|
|
|
25
25
|
## Implementation Steps
|
|
26
26
|
|
|
27
27
|
### Step 1: Integrate the Components
|
|
28
|
-
- **Live streaming**:
|
|
28
|
+
- **Live streaming**: .
|
|
29
29
|
|
|
30
|
-
- **Voice chat room**:
|
|
30
|
+
- **Voice chat room**: .
|
|
31
31
|
|
|
32
32
|
### Step 2: Initialize and Obtain Audience List
|
|
33
33
|
|