@tencent-rtc/mcp 1.4.7 → 1.6.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/cursor-setting.png +0 -0
- package/index.js +0 -1
- package/knowledge/bm25-cache.js +73 -0
- package/knowledge/bm25.js +147 -0
- package/knowledge/build-index.js +69 -0
- package/knowledge/chunker.js +167 -0
- package/knowledge/content-loader.js +39 -0
- package/knowledge/doc-url-resolver.js +142 -0
- package/knowledge/extractors.js +25 -0
- package/knowledge/path-meta.js +184 -0
- package/knowledge/search/exact-lookup.js +497 -0
- package/knowledge/search/filter-pool.js +104 -0
- package/knowledge/search/product-scope-intent.js +40 -0
- package/knowledge/search/requires-framework.js +81 -0
- package/knowledge/search/search-knowledge.js +229 -0
- package/mcp-server-prompt.png +0 -0
- package/package.json +1 -1
- package/resource/_schema/feature-aliases.yaml +10 -0
- package/resource/_schema/goal-tags.yaml +72 -0
- package/resource/_schema/products.yaml +19 -0
- package/resource/_schema/trtc-intents.yaml +27 -0
- package/resource/_schema/types.yaml +43 -0
- package/resource/index/component-slugs.json +1 -0
- package/resource/index/doc-source-urls.json +1 -0
- package/resource/index/manifest.json +1 -0
- package/resource/{doc → integration}/callkit/preset/android/integration.md +34 -28
- package/resource/integration/callkit/preset/flutter/integration.md +346 -0
- package/resource/integration/callkit/preset/ios/integration.md +408 -0
- package/resource/integration/callkit/preset/react/integration.md +362 -0
- package/resource/integration/callkit/preset/vue/integration.md +356 -0
- package/resource/integration/chat/preset/android/integration.md +500 -0
- package/resource/integration/chat/preset/flutter/integration.md +370 -0
- package/resource/integration/chat/preset/ios/integration.md +566 -0
- package/resource/integration/chat/preset/react/integration.md +490 -0
- package/resource/integration/chat/preset/vue/integration.md +504 -0
- package/resource/{doc → integration}/livekit/preset/live/vue/live-list-integration.md +26 -22
- package/resource/{doc → integration}/livekit/preset/live/vue/live-player-desk-integration.md +22 -18
- package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +309 -0
- package/resource/{doc → integration}/livekit/preset/live/vue/live-pusher-integration.md +47 -39
- package/resource/integration/roomkit/preset/vue/integration.md +562 -0
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +828 -0
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +897 -0
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +363 -0
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +1111 -0
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +1132 -0
- package/resource/{doc → knowledge}/callkit/core-sdk/flutter/offline-push.md +174 -151
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1084 -0
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +1252 -0
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +534 -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 +92 -0
- package/resource/{doc/callkit/faq/android-faq.md → knowledge/callkit/faq/common.md} +11 -12
- package/resource/knowledge/callkit/faq/error-code.md +67 -0
- package/resource/knowledge/callkit/faq/flutter.md +52 -0
- package/resource/knowledge/callkit/faq/ios.md +104 -0
- package/resource/knowledge/callkit/faq/web.md +74 -0
- package/resource/knowledge/callkit/preset/android/api.md +412 -0
- package/resource/knowledge/callkit/preset/flutter/api.md +22 -0
- package/resource/knowledge/callkit/preset/ios/api.md +234 -0
- package/resource/knowledge/callkit/preset/web/api.md +83 -0
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +74 -0
- package/resource/knowledge/chat/preset/android/features/contact-list.md +43 -0
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +117 -0
- package/resource/knowledge/chat/preset/android/features/language.md +136 -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/knowledge/chat/preset/android/features/theme.md +222 -0
- package/resource/knowledge/chat/preset/android-view/integration.md +300 -0
- package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +64 -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 +158 -0
- package/resource/knowledge/chat/preset/flutter/features/search.md +59 -0
- package/resource/knowledge/chat/preset/flutter/features/theme.md +261 -0
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +94 -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 +125 -0
- package/resource/knowledge/chat/preset/ios/features/message-input.md +69 -0
- package/resource/knowledge/chat/preset/ios/features/message-list.md +162 -0
- package/resource/knowledge/chat/preset/ios/features/search.md +93 -0
- package/resource/knowledge/chat/preset/ios/features/theme.md +270 -0
- package/resource/{doc/chatkit/ios → knowledge/chat/preset/ios-uikit}/integration.md +160 -158
- package/resource/knowledge/chat/preset/react/features/chat-setting.md +101 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/contact-list.md +43 -41
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +215 -0
- package/resource/knowledge/chat/preset/react/features/conversation-list.md +339 -0
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +101 -0
- package/resource/knowledge/chat/preset/react/features/conversation-search.md +61 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/message-input.md +117 -156
- package/resource/knowledge/chat/preset/react/features/message-list.md +297 -0
- package/resource/{doc/chatkit/react/components → knowledge/chat/preset/react/features}/search.md +65 -59
- package/resource/knowledge/chat/preset/react/features/theme.md +93 -0
- package/resource/knowledge/chat/preset/vue/features/chat-header.md +331 -0
- package/resource/knowledge/chat/preset/vue/features/chat-setting.md +79 -0
- package/resource/knowledge/chat/preset/vue/features/contact-list.md +277 -0
- package/resource/knowledge/chat/preset/vue/features/conversation-actions.md +234 -0
- package/resource/knowledge/chat/preset/vue/features/conversation-list.md +331 -0
- package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +216 -0
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/conversation-search.md +13 -13
- package/resource/knowledge/chat/preset/vue/features/message-input.md +551 -0
- package/resource/knowledge/chat/preset/vue/features/message-list.md +350 -0
- package/resource/{doc/chatkit/vue/components → knowledge/chat/preset/vue/features}/search.md +79 -73
- package/resource/knowledge/chat/preset/vue/features/theme.md +136 -0
- package/resource/knowledge/chat/urls/error-code.md +17 -0
- package/resource/knowledge/chat/urls/product.md +43 -0
- package/resource/knowledge/chat/urls/restapi.md +204 -0
- package/resource/knowledge/chat/urls/sdk/android.md +80 -0
- package/resource/knowledge/chat/urls/sdk/flutter.md +71 -0
- package/resource/knowledge/chat/urls/sdk/ios.md +80 -0
- package/resource/knowledge/chat/urls/sdk/web.md +80 -0
- package/resource/knowledge/chat/urls/webhook.md +68 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +286 -0
- 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/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +55 -0
- 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/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +51 -0
- 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 +488 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +219 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +282 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +212 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +153 -0
- 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 +426 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +166 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +52 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +281 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +150 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +438 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +190 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +291 -0
- 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/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +51 -0
- 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 +487 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +183 -0
- package/resource/knowledge/livekit/core-sdk/api-reference/web/index.md +736 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audience-list.md +53 -47
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-barrage.md +22 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-base-beauty.md +17 -15
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-co-guest-interaction.md +19 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-gift.md +102 -89
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-host-interaction.md +41 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-integration.md +45 -43
- package/resource/{doc → knowledge}/livekit/core-sdk/live/android/live-live-list.md +23 -20
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audience-list.md +41 -41
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-audio-effect.md +70 -69
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-barrage.md +68 -71
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-base-beauty.md +43 -47
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-co-guest-interaction.md +59 -56
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-gift.md +103 -105
- package/resource/knowledge/livekit/core-sdk/live/flutter/live-host-interaction.md +869 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-integration.md +84 -87
- package/resource/{doc → knowledge}/livekit/core-sdk/live/flutter/live-live-list.md +43 -40
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audience-list.md +11 -10
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-barrage.md +22 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-base-beauty.md +15 -14
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-co-guest-interaction.md +19 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-gift.md +54 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-host-interaction.md +41 -37
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-integration.md +40 -40
- package/resource/{doc → knowledge}/livekit/core-sdk/live/ios/live-live-list.md +19 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audience-list.md +53 -47
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-barrage.md +22 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +41 -33
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-gift.md +94 -81
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-host-interaction.md +35 -30
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-integration.md +45 -42
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/android/voice-room-list.md +23 -20
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audience-list.md +260 -0
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audio-effect.md +598 -0
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-barrage.md +490 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +65 -59
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-gift.md +424 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/flutter/voice-integration.md +69 -76
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-room-list.md +726 -0
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audience-list.md +11 -10
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-audio-effect.md +28 -24
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-barrage.md +22 -18
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +41 -33
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-gift.md +54 -50
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-host-interaction.md +35 -30
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-integration.md +49 -46
- package/resource/{doc → knowledge}/livekit/core-sdk/voice/ios/voice-room-list.md +19 -18
- package/resource/knowledge/livekit/faq/error-code.md +193 -0
- package/resource/{doc/livekit/preset/live/vue/components → knowledge/livekit/preset/live/vue/features}/barrage.md +56 -53
- package/resource/{doc/livekit/preset/live/vue/components → knowledge/livekit/preset/live/vue/features}/live-audience-list.md +22 -21
- package/resource/{doc/livekit/preset/live/vue/components → knowledge/livekit/preset/live/vue/features}/live-view.md +34 -32
- package/resource/knowledge/push/config/android.md +92 -0
- package/resource/knowledge/push/config/harmonyos.md +83 -0
- package/resource/knowledge/push/config/ios.md +254 -0
- package/resource/knowledge/push/config/react-native.md +254 -0
- package/resource/knowledge/push/config/unity.md +209 -0
- package/resource/knowledge/push/config/unreal-engine.md +194 -0
- package/resource/knowledge/push/integration/android.md +404 -0
- package/resource/knowledge/push/integration/flutter.md +465 -0
- package/resource/knowledge/push/integration/harmonyos.md +63 -0
- package/resource/knowledge/push/integration/ios.md +246 -0
- package/resource/knowledge/push/integration/react-native.md +366 -0
- package/resource/knowledge/push/integration/uni-app.md +208 -0
- package/resource/knowledge/push/integration/unity.md +389 -0
- package/resource/knowledge/push/integration/unreal-engine.md +390 -0
- package/resource/knowledge/push/overview/prepare.md +60 -0
- package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md +241 -0
- package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md +588 -0
- package/resource/knowledge/roomkit/core-sdk/android/room-state.md +364 -0
- package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md +340 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +230 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +797 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/room-state.md +325 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/schedule-room.md +325 -0
- package/resource/knowledge/roomkit/core-sdk/ios/call-user-to-room.md +233 -0
- package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md +569 -0
- package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +325 -0
- package/resource/knowledge/roomkit/core-sdk/ios/schedule-room.md +322 -0
- package/resource/knowledge/roomkit/core-sdk/vue/call-user-to-room.md +221 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/device-detection.md +49 -48
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +461 -0
- package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +216 -0
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +370 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/room-participant-state.md +61 -60
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +280 -0
- package/resource/{doc/roomkit/vue/features → knowledge/roomkit/core-sdk/vue}/room-view.md +57 -56
- package/resource/knowledge/roomkit/core-sdk/vue/schedule-room.md +319 -0
- package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +267 -0
- package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +261 -0
- package/resource/knowledge/roomkit/preset/android/integration.md +396 -0
- package/resource/knowledge/roomkit/preset/flutter/integration.md +404 -0
- package/resource/knowledge/roomkit/preset/ios/integration.md +369 -0
- package/resource/knowledge/roomkit/preset/react/integration.md +576 -0
- package/resource/knowledge/rtcengine/web/how_to_run_web_sdk_demo.md +44 -0
- package/resource/{doc → knowledge}/rtcengine/web/plugin/21-advanced-auto-play-policy.md +8 -2
- package/resource/{doc → knowledge}/rtcengine/web/plugin/22-advanced-audio-mixer.md +19 -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 +8 -8
- 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 +6 -6
- package/resource/{doc → knowledge}/rtcengine/web/plugin/27-advanced-small-stream.md +3 -3
- package/resource/{doc → knowledge}/rtcengine/web/plugin/29-advanced-water-mark.md +18 -0
- package/resource/{doc → knowledge}/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -1
- package/resource/{doc → knowledge}/rtcengine/web/plugin/34-advanced-proxy.md +2 -2
- package/resource/{doc → knowledge}/rtcengine/web/plugin/35-advanced-ai-denoiser.md +1 -1
- package/resource/knowledge/trtc/android/TRTCCloud.md +1915 -0
- package/resource/knowledge/trtc/android/TRTCCloudDef.md +1029 -0
- package/resource/knowledge/trtc/android/TRTCCloudListener.md +1095 -0
- package/resource/knowledge/trtc/android/TRTCStatistics.md +68 -0
- package/resource/knowledge/trtc/android/TXAudioEffectManager.md +502 -0
- package/resource/knowledge/trtc/android/TXBeautyManager.md +415 -0
- package/resource/knowledge/trtc/android/TXDeviceManager.md +169 -0
- package/resource/knowledge/trtc/android/TXLiteAVCode.md +125 -0
- package/resource/knowledge/trtc/c++/ITRTCCloud.md +2069 -0
- package/resource/knowledge/trtc/c++/ITRTCStatistics.md +73 -0
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +502 -0
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +391 -0
- package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +1191 -0
- package/resource/knowledge/trtc/c++/TRTCTypeDef.md +931 -0
- package/resource/knowledge/trtc/c++/TXLiteAVCode.md +127 -0
- package/resource/knowledge/trtc/ios/TRTCCloud.md +2118 -0
- package/resource/knowledge/trtc/ios/TRTCCloudDef.md +975 -0
- package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +1131 -0
- package/resource/knowledge/trtc/ios/TRTCStatistics.md +68 -0
- package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +423 -0
- package/resource/knowledge/trtc/ios/TXBeautyManager.md +416 -0
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +387 -0
- package/resource/knowledge/trtc/ios/TXLiteAVCode.md +127 -0
- package/server-config.js +0 -1
- package/server.js +35 -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 +19 -14
- 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 +3 -2
- package/tools/definitions/get_native_callkit_core_integration_def.js +5 -4
- package/tools/definitions/get_native_chat_uikit_integration_def.js +5 -3
- package/tools/definitions/get_native_livekit_core_integration_def.js +6 -6
- package/tools/definitions/get_usersig_def.js +0 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js +4 -3
- package/tools/definitions/get_web_chat_uikit_integration_def.js +2 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js +5 -6
- package/tools/definitions/get_web_room_core_integration_def.js +49 -0
- package/tools/definitions/get_web_room_uikit_integration_def.js +5 -5
- package/tools/definitions/integration-boundary.js +5 -0
- package/tools/definitions/present_framework_choice_def.js +12 -11
- package/tools/definitions/record_answer_def.js +19 -18
- package/tools/definitions/record_feedback_def.js +14 -14
- package/tools/definitions/search_trtc_knowledge_def.js +39 -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 +24 -31
- 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 +18 -21
- package/utils/report-es-client.js +1 -2
- 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 -852
- package/resource/doc/callkit/core-sdk/android/make-call.md +0 -954
- package/resource/doc/callkit/core-sdk/android/offline-push.md +0 -361
- package/resource/doc/callkit/core-sdk/flutter/answer-call.md +0 -1160
- package/resource/doc/callkit/core-sdk/flutter/make-call.md +0 -1205
- package/resource/doc/callkit/core-sdk/ios/answer-call.md +0 -1090
- package/resource/doc/callkit/core-sdk/ios/make-call.md +0 -1248
- package/resource/doc/callkit/core-sdk/ios/offline-push.md +0 -485
- package/resource/doc/callkit/core-sdk/uni-app/answer-call.md +0 -950
- package/resource/doc/callkit/core-sdk/uni-app/make-call.md +0 -1052
- package/resource/doc/callkit/faq/common/error-code.md +0 -47
- package/resource/doc/callkit/faq/flutter-faq.md +0 -115
- package/resource/doc/callkit/faq/ios-faq.md +0 -115
- package/resource/doc/callkit/faq/web-faq.md +0 -36
- package/resource/doc/callkit/preset/android/api.md +0 -296
- package/resource/doc/callkit/preset/flutter/api.md +0 -410
- package/resource/doc/callkit/preset/flutter/integration.md +0 -164
- package/resource/doc/callkit/preset/ios/api.md +0 -80
- package/resource/doc/callkit/preset/ios/integration.md +0 -187
- package/resource/doc/callkit/preset/react/api.md +0 -501
- package/resource/doc/callkit/preset/react/integration.md +0 -86
- package/resource/doc/callkit/preset/vue/api.md +0 -501
- package/resource/doc/callkit/preset/vue/integration.md +0 -83
- package/resource/doc/chatkit/android/faq.md +0 -111
- package/resource/doc/chatkit/android/features/theme.md +0 -219
- package/resource/doc/chatkit/android/integration.md +0 -490
- package/resource/doc/chatkit/faq/android_sdk/client-api.md +0 -281
- package/resource/doc/chatkit/faq/common/product.md +0 -7
- package/resource/doc/chatkit/faq/common/server.md +0 -44
- package/resource/doc/chatkit/faq/common/server_error_code.md +0 -74
- package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +0 -199
- package/resource/doc/chatkit/faq/flutter_sdk/faq.md +0 -53
- package/resource/doc/chatkit/faq/ios_sdk/client-api.md +0 -235
- package/resource/doc/chatkit/faq/web_sdk/error_code.md +0 -47
- package/resource/doc/chatkit/faq/web_sdk/faq.md +0 -287
- package/resource/doc/chatkit/flutter/faq.md +0 -23
- package/resource/doc/chatkit/flutter/features/theme.md +0 -235
- package/resource/doc/chatkit/flutter/integration.md +0 -344
- package/resource/doc/chatkit/ios/faq.md +0 -111
- package/resource/doc/chatkit/ios/features/theme.md +0 -267
- 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 -57
- package/resource/doc/chatkit/react/components/chat.md +0 -38
- package/resource/doc/chatkit/react/components/component-list.md +0 -37
- package/resource/doc/chatkit/react/components/conversation-actions.md +0 -174
- package/resource/doc/chatkit/react/components/conversation-list.md +0 -333
- package/resource/doc/chatkit/react/components/conversation-preview.md +0 -118
- package/resource/doc/chatkit/react/components/conversation-search.md +0 -60
- package/resource/doc/chatkit/react/components/message-list.md +0 -293
- package/resource/doc/chatkit/react/components/tuikit.md +0 -34
- package/resource/doc/chatkit/react/faq.md +0 -26
- package/resource/doc/chatkit/react/integration.md +0 -416
- package/resource/doc/chatkit/vue/components/avatar.md +0 -104
- package/resource/doc/chatkit/vue/components/chat-header.md +0 -148
- package/resource/doc/chatkit/vue/components/chat-setting.md +0 -62
- package/resource/doc/chatkit/vue/components/chat.md +0 -45
- package/resource/doc/chatkit/vue/components/component-list.md +0 -87
- package/resource/doc/chatkit/vue/components/contact-list.md +0 -271
- package/resource/doc/chatkit/vue/components/conversation-actions.md +0 -228
- package/resource/doc/chatkit/vue/components/conversation-list.md +0 -320
- package/resource/doc/chatkit/vue/components/conversation-preview.md +0 -213
- package/resource/doc/chatkit/vue/components/message-input.md +0 -1054
- package/resource/doc/chatkit/vue/components/message-list.md +0 -433
- package/resource/doc/chatkit/vue/components/tuikit.md +0 -31
- package/resource/doc/chatkit/vue/components/userpicker.md +0 -256
- package/resource/doc/chatkit/vue/faq.md +0 -36
- package/resource/doc/chatkit/vue/integration.md +0 -428
- package/resource/doc/livekit/core-sdk/live/flutter/live-host-interaction.md +0 -866
- package/resource/doc/livekit/faq/common/error-code.md +0 -88
- package/resource/doc/livekit/preset/live/vue/api-reference/index.md +0 -780
- package/resource/doc/livekit/preset/live/vue/components/co-guest-panel.md +0 -91
- package/resource/doc/livekit/preset/live/vue/components/live-scene-panel.md +0 -112
- package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +0 -215
- package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +0 -300
- package/resource/doc/roomkit/faq/common/error-code.md +0 -67
- package/resource/doc/roomkit/vue/features/call-user-to-room.md +0 -220
- package/resource/doc/roomkit/vue/features/device-state.md +0 -460
- package/resource/doc/roomkit/vue/features/free-beauty-panel.md +0 -215
- package/resource/doc/roomkit/vue/features/room-chat.md +0 -369
- package/resource/doc/roomkit/vue/features/room-state.md +0 -282
- package/resource/doc/roomkit/vue/features/schedule-room.md +0 -318
- package/resource/doc/roomkit/vue/features/screen-share.md +0 -265
- package/resource/doc/roomkit/vue/features/virtual-background.md +0 -271
- package/resource/doc/roomkit/vue/integration.md +0 -315
- package/resource/doc/rtcengine/faq/common/error_code.md +0 -1
- package/resource/doc/rtcengine/faq/web_sdk/.gitkeep +0 -0
- package/resource/doc/rtcengine/web/.gitkeep +0 -0
- package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +0 -59
- package/resource/doc/trtc/C++/ITRTCCloud.md +0 -1970
- package/resource/doc/trtc/C++/ITRTCStatistics.md +0 -70
- package/resource/doc/trtc/C++/ITXAudioEffectManager.md +0 -469
- package/resource/doc/trtc/C++/ITXDeviceManager.md +0 -387
- package/resource/doc/trtc/C++/TRTCCloudCallback.md +0 -1082
- package/resource/doc/trtc/C++/TRTCTypeDef.md +0 -925
- package/resource/doc/trtc/C++/TXLiteAVCode.md +0 -129
- package/resource/doc/trtc/android/TRTCCloud.md +0 -1815
- package/resource/doc/trtc/android/TRTCCloudDef.md +0 -992
- package/resource/doc/trtc/android/TRTCCloudListener.md +0 -1004
- package/resource/doc/trtc/android/TRTCStatistics.md +0 -65
- package/resource/doc/trtc/android/TXAudioEffectManager.md +0 -469
- package/resource/doc/trtc/android/TXBeautyManager.md +0 -402
- package/resource/doc/trtc/android/TXDeviceManager.md +0 -173
- package/resource/doc/trtc/android/TXLiteAVCode.md +0 -127
- package/resource/doc/trtc/iOS/TRTCCloud.md +0 -2028
- package/resource/doc/trtc/iOS/TRTCCloudDef.md +0 -958
- package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +0 -1046
- package/resource/doc/trtc/iOS/TRTCStatistics.md +0 -65
- package/resource/doc/trtc/iOS/TXAudioEffectManager.md +0 -397
- package/resource/doc/trtc/iOS/TXBeautyManager.md +0 -403
- package/resource/doc/trtc/iOS/TXDeviceManager.md +0 -381
- package/resource/doc/trtc/iOS/TXLiteAVCode.md +0 -130
- 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 -29
- package/tools/definitions/get_callkit_api_def.js.map +0 -1
- package/tools/definitions/get_faq_def.js +0 -47
- 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 -34
- 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 -30
- package/tools/definitions/get_web_livekit_api_def.js.map +0 -1
- package/tools/definitions/get_web_livekit_component_detail_def.js +0 -32
- 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 -31
- package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_api_def.js +0 -27
- package/tools/definitions/get_web_trtc_sdk_api_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_integration_def.js +0 -27
- package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +0 -1
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js +0 -27
- 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 -120
- 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 +0 -91
- package/utils/report-runtime-error-cls-client.js.map +0 -1
- /package/resource/{doc/livekit/preset/live/vue/faq.md → knowledge/push/config/donut.md} +0 -0
- /package/resource/{doc/roomkit/vue/faq.md → knowledge/push/integration/donut.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/30-advanced-cross-room-link.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/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
|
@@ -281,7 +281,7 @@ Use the slot capability in the `LiveCoreView.VideoViewDelegate` interface to ove
|
|
|
281
281
|
> **Note:**
|
|
282
282
|
>
|
|
283
283
|
|
|
284
|
-
> You can also refer to the open-source TUILiveKit files [AnchorCoHostView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Features/
|
|
284
|
+
> You can also refer to the open-source TUILiveKit files [AnchorCoHostView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Features/AnchorView/View/VideoWidgets/AnchorCoHostView.swift) and [AnchorEmptySeatView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Features/AnchorView/View/VideoWidgets/AnchorEmptySeatView.swift) for complete implementation logic.
|
|
285
285
|
>
|
|
286
286
|
|
|
287
287
|
``` swift
|
|
@@ -364,15 +364,15 @@ Use the slot capability in the `LiveCoreView.VideoViewDelegate` interface to ove
|
|
|
364
364
|
```
|
|
365
365
|
|
|
366
366
|
#### Parameter Description:
|
|
367
|
-
|
|
|
367
|
+
| <strong>Parameter</strong> | <strong>Type</strong> | <strong>Description</strong> |
|
|
368
368
|
| --- | --- | --- |
|
|
369
|
-
|
|
|
370
|
-
|
|
|
371
|
-
|
|
|
372
|
-
|
|
|
373
|
-
|
|
|
374
|
-
|
|
|
375
|
-
|
|
|
369
|
+
| <code>seatInfo</code> | <code>TUISeatFullInfo</code> | Seat information object containing user details |
|
|
370
|
+
| <code>seatInfo.userId</code> | <code>String?</code> | User ID on the seat |
|
|
371
|
+
| <code>seatInfo.userName</code> | <code>String?</code> | User nickname on the seat |
|
|
372
|
+
| <code>seatInfo.userAvatar</code> | <code>String?</code> | User avatar URL |
|
|
373
|
+
| <code>seatInfo.userMicrophoneStatus</code> | <code>TUIDeviceStatus</code> | User microphone status |
|
|
374
|
+
| <code>seatInfo.userCameraStatus</code> | <code>TUIDeviceStatus</code> | User camera status |
|
|
375
|
+
| <code>viewLayer</code> | <code>ViewLayer</code> | View layer enum<br>- <code>.foreground</code>: Foreground widget view, always displayed on top of the video<br>- <code>.background</code>: Background widget view, under the foreground view, displayed only when the user has no video stream (e.g., camera off), typically used for the user's default avatar or a placeholder image |
|
|
376
376
|
|
|
377
377
|
### Displaying PK User Score on Video View
|
|
378
378
|
|
|
@@ -381,7 +381,7 @@ When the host starts a PK, you can attach a custom view to the opponent's video
|
|
|
381
381
|
#### Implementation Example
|
|
382
382
|
|
|
383
383
|
#### Implementation
|
|
384
|
-
- **Step 1**: Create a custom PK user view. For a complete implementation, refer to [AnchorBattleMemberInfoView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Features/
|
|
384
|
+
- **Step 1**: Create a custom PK user view. For a complete implementation, refer to [AnchorBattleMemberInfoView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Features/AnchorView/View/HostBattle/AnchorBattleMemberInfoView.swift).
|
|
385
385
|
|
|
386
386
|
``` swift
|
|
387
387
|
import AtomicXCore
|
|
@@ -461,21 +461,22 @@ When the host starts a PK, you can attach a custom view to the opponent's video
|
|
|
461
461
|
```
|
|
462
462
|
|
|
463
463
|
#### Parameter Description:
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
464
|
+
|
|
465
|
+
|**Parameter**|**Type**|**Description**|
|
|
466
|
+
|---------|---------|---------|
|
|
467
|
+
|`battleUser`|`TUIBattleUser`|PK user info object|
|
|
468
|
+
|`battleUser.roomId`|`String`|PK room ID|
|
|
469
|
+
|`battleUser.userId`|`String`|PK user ID|
|
|
470
|
+
|`battleUser.userName`|`String`|PK user nickname|
|
|
471
|
+
|`battleUser.avatarUrl`|`String`|PK user avatar URL|
|
|
472
|
+
|`battleUser.score`|`UInt`|PK score|
|
|
472
473
|
|
|
473
474
|
### Displaying PK Status on Video Stream
|
|
474
475
|
|
|
475
476
|
#### Implementation Example
|
|
476
477
|
|
|
477
478
|
#### Implementation
|
|
478
|
-
- **Step 1**: Create a custom PK global view (CustomBattleContainerView). For a complete implementation, refer to [AnchorBattleInfoView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Features/
|
|
479
|
+
- **Step 1**: Create a custom PK global view (CustomBattleContainerView). For a complete implementation, refer to [AnchorBattleInfoView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Features/AnchorView/View/HostBattle/AnchorBattleInfoView.swift).
|
|
479
480
|
|
|
480
481
|
- **Step 2**: Implement the `VideoViewDelegate.createBattleContainerView` protocol.
|
|
481
482
|
|
|
@@ -499,12 +500,13 @@ In typical** live host PK scenarios,** the value of gifts received by the host i
|
|
|
499
500
|
|
|
500
501
|
> The PK score system in the LiveKit backend uses pure numeric calculation and accumulation. You must calculate the PK score according to your own business logic before calling the update API. See the following PK score calculation examples:
|
|
501
502
|
>
|
|
502
|
-
|
|
503
|
-
|
|
|
504
|
-
|
|
505
|
-
|
|
|
506
|
-
|
|
|
507
|
-
|
|
|
503
|
+
|
|
504
|
+
|Gift Type|Score Calculation Rule|Example|
|
|
505
|
+
|---------|---------|---------|
|
|
506
|
+
|Basic Gift|Gift value × 5|10 RMB gift → 50 points|
|
|
507
|
+
|Intermediate Gift|Gift value × 8|50 RMB gift → 400 points|
|
|
508
|
+
|Advanced Gift|Gift value × 12|100 RMB gift → 1200 points|
|
|
509
|
+
|Special Effect Gift|Fixed high score|520 RMB gift → 1314 points|
|
|
508
510
|
|
|
509
511
|
#### REST API Call Flow
|
|
510
512
|
|
|
@@ -522,22 +524,24 @@ In typical** live host PK scenarios,** the value of gifts received by the host i
|
|
|
522
524
|
4. **LiveKit Backend Syncs to Client**: The backend automatically synchronizes the updated PK score to all clients.
|
|
523
525
|
|
|
524
526
|
#### Involved REST API Endpoints
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
|
529
|
-
|
|
|
530
|
-
|
|
|
527
|
+
|
|
528
|
+
|**API**|**Function Description**|**Request Example**|
|
|
529
|
+
|---------|---------|---------|
|
|
530
|
+
|Active API - Query PK Status|Check whether the current room is in PK|Example|
|
|
531
|
+
|Active API - Update PK Score|Update the calculated PK score|Example|
|
|
532
|
+
|Callback Configuration - PK Start Callback|Receive real-time notification when PK starts|Example|
|
|
533
|
+
|Callback Configuration - PK End Callback|Receive real-time notification when PK ends|Example|
|
|
531
534
|
|
|
532
535
|
## API Documentation
|
|
533
536
|
|
|
534
537
|
For detailed information on all public interfaces, properties, and methods of [CoHostStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore) and related classes, refer to the official API documentation included with the [AtomicXCore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore) framework. The relevant stores used in this guide are as follows:
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
538
|
+
|
|
539
|
+
|**Store/Component**|**Description**|**API Reference**|
|
|
540
|
+
|---------|---------|---------|
|
|
541
|
+
|`LiveCoreView`|Core view component for displaying and interacting with live video streams. Handles video rendering and view widgets, supports host streaming, audience co-hosting, host connections, and more.|[API Documentation](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.view/-live-core-view/index.html)|
|
|
542
|
+
|`DeviceStore`|Controls audio/video devices: microphone (on/off, volume), camera (on/off, switch, quality), screen sharing, and real-time device status monitoring.|[API Documentation](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)|
|
|
543
|
+
|`CoHostStore`|Handles host cross-room connections: supports multiple layout templates (dynamic grid, etc.), initiates/accepts/rejects connections, and manages co-host interactions.|[API Documentation](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)|
|
|
544
|
+
|`BattleStore`|Manages host PK battles: initiate PK (set duration/opponent), manage PK status (start/end), synchronize scores, and listen for battle results.|[API Documentation](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)|
|
|
541
545
|
|
|
542
546
|
## FAQs
|
|
543
547
|
|
|
@@ -7,11 +7,11 @@ This document guides you through building a basic live streaming app with host b
|
|
|
7
7
|
The following view hierarchy diagram illustrates the position and role of **LiveCoreView** within the live streaming interface:
|
|
8
8
|
|
|
9
9
|
## Core Concepts
|
|
10
|
-
|
|
|
10
|
+
| <strong>Core Concept</strong> | <strong>Core Responsibility</strong> | <strong>Key API / Property</strong> |
|
|
11
11
|
| --- | --- | --- |
|
|
12
|
-
| LiveCoreView | Handles publishing, playing, and rendering audio/video streams. Provides adapter interfaces for integrating custom UI components (e.g., user info, PK progress bar). | -
|
|
13
|
-
| LiveListStore | Manages the complete live room lifecycle (create, join, leave), synchronizes state, and listens for passive events (e.g., live ended, kicked out). | -
|
|
14
|
-
| LiveInfo | Defines room parameters before going live, such as room ID, seat layout mode, max co-hosts, etc. | -
|
|
12
|
+
| LiveCoreView | Handles publishing, playing, and rendering audio/video streams. Provides adapter interfaces for integrating custom UI components (e.g., user info, PK progress bar). | - <code>viewType</code>:<br>- <code>.pushView</code> (host publishing view)<br>- <code>.playView</code> (audience playback view)<br>- <code>setLiveId()</code>: Binds the live room ID for this view.<br>- <code>videoViewDelegate</code>: Adapter for custom video display UI slots. |
|
|
13
|
+
| LiveListStore | Manages the complete live room lifecycle (create, join, leave), synchronizes state, and listens for passive events (e.g., live ended, kicked out). | - <code>createLive()</code>: Start live stream as host.<br>- <code>endLive()</code>: End live stream as host.<br>- <code>joinLive()</code>: Audience joins live room.<br>- <code>leaveLive()</code>: Leave live room. |
|
|
14
|
+
| LiveInfo | Defines room parameters before going live, such as room ID, seat layout mode, max co-hosts, etc. | - <code>liveID</code>: Unique room identifier.<br>- seatTemplate: Layout template. |
|
|
15
15
|
|
|
16
16
|
## Preparation
|
|
17
17
|
|
|
@@ -69,11 +69,11 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau
|
|
|
69
69
|
```
|
|
70
70
|
|
|
71
71
|
**Login API Parameter Description**
|
|
72
|
-
|
|
|
72
|
+
| <strong>Parameter</strong> | <strong>Type</strong> | <strong>Description</strong> |
|
|
73
73
|
| --- | --- | --- |
|
|
74
|
-
|
|
|
75
|
-
|
|
|
76
|
-
|
|
|
74
|
+
| <code>SDKAppID</code> | <code>Int</code> | Get this from <a href="https://console.trtc.io/app">TRTC console</a>. |
|
|
75
|
+
| <code>UserID</code> | <code>String</code> | The unique ID for the current user. Must contain only English letters, numbers, hyphens, and underscores. |
|
|
76
|
+
| <code>userSig</code> | <code>String</code> | A ticket for Tencent Cloud authentication. Please note:<br>- Development Environment: You can use the local <code>GenerateTestUserSig.genTestSig</code> function to generate a <code>UserSig</code> or generate a temporary UserSig via the <a href="https://console.trtc.io/usersig">UserSig Generation Tool</a>.<br>- Production Environment: To prevent key leakage, you must use a server-side method to generate <code>UserSig</code>. For details, see Generating UserSig on the Server. |
|
|
77
77
|
|
|
78
78
|
## Building a Basic Live Room
|
|
79
79
|
|
|
@@ -179,20 +179,20 @@ Follow these steps to quickly set up broadcaster video streaming:
|
|
|
179
179
|
|
|
180
180
|
`LiveInfo` Parameter Descriptions:
|
|
181
181
|
|
|
182
|
-
|
|
|
182
|
+
| <strong>Parameter Name</strong> | <strong>Type</strong> | <strong>Attribute</strong> | <strong>Description</strong> |
|
|
183
183
|
| --- | --- | --- | --- |
|
|
184
|
-
|
|
|
185
|
-
|
|
|
186
|
-
|
|
|
187
|
-
|
|
|
188
|
-
|
|
|
189
|
-
|
|
|
190
|
-
|
|
|
191
|
-
|
|
|
192
|
-
|
|
|
193
|
-
|
|
|
194
|
-
|
|
|
195
|
-
|
|
|
184
|
+
| <code>liveID</code> | <code>String</code> | Required | Unique identifier for the live room. |
|
|
185
|
+
| <code>liveName</code> | <code>String</code> | Optional | Title of the live room. |
|
|
186
|
+
| <code>notice</code> | <code>String</code> | Optional | Announcement for the live room. |
|
|
187
|
+
| <code>isMessageDisable</code> | <code>Bool</code> | Optional | Whether to mute chat (true: yes, false: no). |
|
|
188
|
+
| <code>isPublicVisible</code> | <code>Bool</code> | Optional | Whether the room is publicly visible (true: yes, false: no). |
|
|
189
|
+
| <code>seatMode</code> | <code>TakeSeatMode</code> | Optional | Seat mode (.free: free to take seat, .apply: apply to take seat). |
|
|
190
|
+
| <code>seatTemplate</code> | SeatLayoutTemplate | Required | Seat layout template. |
|
|
191
|
+
| <code>coverURL</code> | <code>String</code> | Optional | Cover image URL for the live room. |
|
|
192
|
+
| <code>backgroundURL</code> | <code>String</code> | Optional | Background image URL for the live room. |
|
|
193
|
+
| <code>categoryList</code> | <code>NSNumber</code> | Optional | Category tag list for the live room. |
|
|
194
|
+
| <code>activityStatus</code> | <code>Int</code> | Optional | Live activity status. |
|
|
195
|
+
| <code>isGiftEnabled</code> | <code>Bool</code> | Optional | Whether to enable gift functionality (true: yes, false: no). |
|
|
196
196
|
|
|
197
197
|
4. **End Live Streaming**
|
|
198
198
|
|
|
@@ -375,7 +375,7 @@ class YourAudienceViewController: UIViewController {
|
|
|
375
375
|
### Run and Test
|
|
376
376
|
|
|
377
377
|
After integrating `LiveCoreView`, you will have a pure video rendering view with full live streaming capabilities, but without any interactive UI. To add interactive features, see Enriching the Live Streaming Scene.
|
|
378
|
-
| |
|
|
378
|
+
| | <strong>Dynamic Grid Layout</strong> | <strong>Floating Window Layout</strong> | <strong>Fixed Grid Layout</strong> | <strong>Fixed Window Layout</strong> |
|
|
379
379
|
| --- | --- | --- | --- | --- |
|
|
380
380
|
| Template ID | .videoDynamicGrid9Seats | .videoDynamicFloat7Seats | .videoFixedGrid9Seats | .videoFixedFloat7Seats |
|
|
381
381
|
| Description | Default layout; grid size adjusts dynamically based on number of co-hosts. | Co-hosts are displayed as floating windows. | Fixed number of co-hosts; each occupies a fixed grid. | Fixed number of co-hosts; guests are displayed as fixed windows. |
|
|
@@ -443,28 +443,28 @@ private func subscribeToDataUpdates() {
|
|
|
443
443
|
## Enriching the Live Streaming Scene
|
|
444
444
|
|
|
445
445
|
Once the basic live streaming functionality is in place, refer to the following guides to add interactive features to your live stream:
|
|
446
|
-
|
|
|
446
|
+
| <strong>Feature</strong> | <strong>Description</strong> | <strong>Store</strong> | <strong>Implementation Guide</strong> |
|
|
447
447
|
| --- | --- | --- | --- |
|
|
448
|
-
| Enable Audience Audio/Video Co-hosting | Audience can apply to join the host and interact via real-time video. |
|
|
449
|
-
| Enable Host Cross-room PK | Hosts from different rooms can connect for interaction or PK. |
|
|
450
|
-
| Add Bullet Chat Feature | Audience can send and receive real-time text messages in the live room. |
|
|
451
|
-
| Build a Gift Giving System | Audience can send virtual gifts to the host, increasing engagement and fun. |
|
|
448
|
+
| Enable Audience Audio/Video Co-hosting | Audience can apply to join the host and interact via real-time video. | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore">CoGuestStore</a> | Implementation Guide |
|
|
449
|
+
| Enable Host Cross-room PK | Hosts from different rooms can connect for interaction or PK. | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore">CoHostStore</a> | Implementation Guide |
|
|
450
|
+
| Add Bullet Chat Feature | Audience can send and receive real-time text messages in the live room. | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore">BarrageStore</a> | Implementation Guide |
|
|
451
|
+
| Build a Gift Giving System | Audience can send virtual gifts to the host, increasing engagement and fun. | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/giftstore">GiftStore</a> | Implementation Guide |
|
|
452
452
|
|
|
453
453
|
## API Documentation
|
|
454
|
-
|
|
|
454
|
+
| <strong>Store/Component</strong> | <strong>Description</strong> | <strong>API Reference</strong> |
|
|
455
455
|
| --- | --- | --- |
|
|
456
|
-
| LiveCoreView | Core view component for displaying and interacting with live video streams. Handles video rendering and view widgets, supports host streaming, audience co-hosting, host connections, and more. |
|
|
457
|
-
| LiveListStore | Manages the full lifecycle of live rooms: create/join/leave/destroy rooms, query room list, modify live info (name, announcement, etc.), and listen to live status events (e.g., kicked out, ended). |
|
|
458
|
-
| DeviceStore | Controls audio/video devices: microphone (on/off, volume), camera (on/off, switch, quality), screen sharing, and real-time device status monitoring. |
|
|
459
|
-
| CoGuestStore | Manages audience co-hosting: apply/invite/accept/reject co-host requests, member permission control (microphone/camera), and status synchronization. |
|
|
460
|
-
| CoHostStore | Handles host cross-room connections: supports multiple layout templates (dynamic grid, etc.), initiates/accepts/rejects connections, and manages co-host interactions. |
|
|
461
|
-
| BattleStore | Manages host PK battles: initiate PK (set duration/opponent), manage PK status (start/end), synchronize scores, and listen for battle results. |
|
|
462
|
-
| GiftStore | Handles gift interactions: get gift list, send/receive gifts, and listen for gift events (including sender and gift details). |
|
|
463
|
-
| BarrageStore | Supports live chat: send text/custom danmaku, maintain danmaku list, and monitor danmaku status in real time. |
|
|
464
|
-
| LikeStore | Handles like interactions: send likes, listen for like events, and synchronize total like count. |
|
|
465
|
-
| LiveAudienceStore | Manages audience: get real-time audience list (ID/name/avatar), count audience, and listen for join/leave events. |
|
|
466
|
-
| AudioEffectStore | Audio effects: voice change (child/male), reverb (KTV, etc.), ear return adjustment, and real-time effect switching. |
|
|
467
|
-
| BaseBeautyStore | Basic beauty filters: adjust smoothing/whitening/rosiness (0-9), reset beauty status, and synchronize effect parameters. |
|
|
456
|
+
| LiveCoreView | Core view component for displaying and interacting with live video streams. Handles video rendering and view widgets, supports host streaming, audience co-hosting, host connections, and more. | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/livecoreview/">LiveCoreView</a> |
|
|
457
|
+
| LiveListStore | Manages the full lifecycle of live rooms: create/join/leave/destroy rooms, query room list, modify live info (name, announcement, etc.), and listen to live status events (e.g., kicked out, ended). | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveliststore">LiveListStore</a> |
|
|
458
|
+
| DeviceStore | Controls audio/video devices: microphone (on/off, volume), camera (on/off, switch, quality), screen sharing, and real-time device status monitoring. | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/devicestore">DeviceStore</a> |
|
|
459
|
+
| CoGuestStore | Manages audience co-hosting: apply/invite/accept/reject co-host requests, member permission control (microphone/camera), and status synchronization. | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cogueststore">CoGuestStore</a> |
|
|
460
|
+
| CoHostStore | Handles host cross-room connections: supports multiple layout templates (dynamic grid, etc.), initiates/accepts/rejects connections, and manages co-host interactions. | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/cohoststore">CoHostStore</a> |
|
|
461
|
+
| BattleStore | Manages host PK battles: initiate PK (set duration/opponent), manage PK status (start/end), synchronize scores, and listen for battle results. | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/battlestore">BattleStore</a> |
|
|
462
|
+
| GiftStore | Handles gift interactions: get gift list, send/receive gifts, and listen for gift events (including sender and gift details). | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/giftstore">GiftStore</a> |
|
|
463
|
+
| BarrageStore | Supports live chat: send text/custom danmaku, maintain danmaku list, and monitor danmaku status in real time. | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/barragestore">BarrageStore</a> |
|
|
464
|
+
| LikeStore | Handles like interactions: send likes, listen for like events, and synchronize total like count. | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/likestore">LikeStore</a> |
|
|
465
|
+
| LiveAudienceStore | Manages audience: get real-time audience list (ID/name/avatar), count audience, and listen for join/leave events. | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveaudiencestore">LiveAudienceStore</a> |
|
|
466
|
+
| AudioEffectStore | Audio effects: voice change (child/male), reverb (KTV, etc.), ear return adjustment, and real-time effect switching. | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/audioeffectstore">AudioEffectStore</a> |
|
|
467
|
+
| BaseBeautyStore | Basic beauty filters: adjust smoothing/whitening/rosiness (0-9), reset beauty status, and synchronize effect parameters. | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/basebeautystore">BaseBeautyStore</a> |
|
|
468
468
|
|
|
469
469
|
## FAQs
|
|
470
470
|
|
|
@@ -8,12 +8,12 @@
|
|
|
8
8
|
- **Real-Time Event Listening**: Listen for key events such as live session end or users being removed from a room.
|
|
9
9
|
|
|
10
10
|
## Core Concepts
|
|
11
|
-
|
|
|
11
|
+
| <strong>Core Concept</strong> | <strong>Type</strong> | <strong>Core Responsibility & Description</strong> |
|
|
12
12
|
| --- | --- | --- |
|
|
13
|
-
|
|
|
14
|
-
|
|
|
15
|
-
|
|
|
16
|
-
|
|
|
13
|
+
| <code>LiveInfo</code> | <code>struct</code> | - Represents the complete information model of a live room.<br>- Includes the live room ID (<code>liveID</code>), name (<code>liveName</code>), owner information (<code>liveOwner</code>), and custom metadata (<code>metaData</code>), among other properties. |
|
|
14
|
+
| <code>LiveListState</code> | <code>struct</code> | - Represents the current state of the live list module.<br>- The core property <code>liveList</code> is a StateFlow containing the fetched live room list;<br>- <code>currentLive</code> represents the information of the live room the user is currently in. |
|
|
15
|
+
| <code>LiveListEvent</code> | <code>enum</code> | Handles global live room events, including <code>.onLiveEnded</code> (live ended) and <code>.onKickedOutOfLive</code> (user removed from live), for responding to key room state changes. |
|
|
16
|
+
| <code>LiveListStore</code> | <code>class</code> | - The core management class for interacting with the live room list and room lifecycle.<br>- It is a global singleton responsible for all operations such as creating, joining, and updating live room information. |
|
|
17
17
|
|
|
18
18
|
## Implementation
|
|
19
19
|
|
|
@@ -106,16 +106,17 @@ class LiveListViewController: UIViewController, UICollectionViewDataSource, UICo
|
|
|
106
106
|
```
|
|
107
107
|
|
|
108
108
|
#### LiveInfo Parameter Reference
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
109
|
+
|
|
110
|
+
|**Parameter Name**|**Type**|**Description**|
|
|
111
|
+
|---------|---------|---------|
|
|
112
|
+
|`liveID`|`String`|Unique identifier for the live room|
|
|
113
|
+
|`liveName`|`String`|Title of the live room|
|
|
114
|
+
|`coverURL`|`String`|URL of the live room cover image|
|
|
115
|
+
|`liveOwner`|[LiveUserInfo](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveuserinfo)|Personal information of the room owner|
|
|
116
|
+
|`totalViewerCount`|`Int`|Total number of viewers in the live room|
|
|
117
|
+
|`categoryList`|`[NSNumber]`|List of category tags for the live room|
|
|
118
|
+
|`notice`|`String`|Announcement information for the live room|
|
|
119
|
+
|`metaData`|`[String: String]`|Developer-defined metadata for implementing complex business scenarios|
|
|
119
120
|
|
|
120
121
|
## Advanced Features
|
|
121
122
|
|
|
@@ -297,10 +298,10 @@ class LiveFeedViewController: UIViewController, UICollectionViewDataSource, UICo
|
|
|
297
298
|
## **API Documentation**
|
|
298
299
|
|
|
299
300
|
For detailed information on all public interfaces, properties, and methods of [LiveListStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveliststore) and related classes, refer to the official API documentation included with the [AtomicXCore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore) framework. The relevant Stores used in this document are as follows:
|
|
300
|
-
|
|
|
301
|
+
| <strong>Store/Component</strong> | <strong>Feature Description</strong> | <strong>API Documentation</strong> |
|
|
301
302
|
| --- | --- | --- |
|
|
302
|
-
| LiveCoreView | - Core view component for live video stream display and interaction.<br>- Responsible for video stream rendering and view widget handling, supporting scenarios such as host streaming, audience co-hosting, and host linking. |
|
|
303
|
-
| LiveListStore | Full lifecycle management of live rooms: create, join, leave, destroy rooms; query room list; modify live information (name, announcement, etc.); listen to live status (such as being removed or ended). |
|
|
303
|
+
| LiveCoreView | - Core view component for live video stream display and interaction.<br>- Responsible for video stream rendering and view widget handling, supporting scenarios such as host streaming, audience co-hosting, and host linking. | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/livecoreview">API Documentation</a> |
|
|
304
|
+
| LiveListStore | Full lifecycle management of live rooms: create, join, leave, destroy rooms; query room list; modify live information (name, announcement, etc.); listen to live status (such as being removed or ended). | <a href="https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/liveliststore">API Documentation</a> |
|
|
304
305
|
|
|
305
306
|
## FAQs
|
|
306
307
|
|
|
@@ -12,12 +12,13 @@
|
|
|
12
12
|
- **Room Management**: The host or administrator can remove (kick out) any regular viewer from the live room.
|
|
13
13
|
|
|
14
14
|
## Core Concepts
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
15
|
+
|
|
16
|
+
|**Core Concept**|**Type**|**Core Responsibilities & Description**|
|
|
17
|
+
|---------|---------|---------|
|
|
18
|
+
|`LiveUserInfo`|data class|Represents the basic information model of an audience member (user). It contains the user's unique identifier (`userID`), nickname (`userName`), and avatar URL (`avatarURL`).|
|
|
19
|
+
|`LiveAudienceState`|data class|Represents the current state of the audience module. Its core property `audienceList` is a StateFlow that stores the real-time state of the audience list; `audienceCount` represents the real-time state of the current total number of viewers.|
|
|
20
|
+
|`LiveAudienceListener`|abstract class|Represents real-time audience activity events. It includes `onAudienceJoined` (audience joins) and `onAudienceLeft` (audience leaves), used for incremental updates to the audience list.|
|
|
21
|
+
|`LiveAudienceStore`|abstract class|This is the core management class for interacting with audience list functionality. Through it, you can obtain audience list snapshots, perform management operations, and subscribe to its `LiveAudienceListener` for real-time updates.|
|
|
21
22
|
|
|
22
23
|
## Implementation Guide
|
|
23
24
|
|
|
@@ -99,27 +100,29 @@ class AudienceManager {
|
|
|
99
100
|
}
|
|
100
101
|
}
|
|
101
102
|
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
if (!currentList.any { it.userID == newAudience.userID }) {
|
|
110
|
-
currentList.add(newAudience)
|
|
111
|
-
_audienceList.value = currentList
|
|
112
|
-
}
|
|
113
|
-
}
|
|
114
|
-
|
|
115
|
-
override fun onAudienceLeft(departedAudience: LiveUserInfo) {
|
|
116
|
-
println("Audience ${departedAudience.userName} left the live room")
|
|
117
|
-
// Incremental update: remove the departed audience member from the current list
|
|
118
|
-
val currentList = _audienceList.value.toMutableList()
|
|
119
|
-
currentList.removeAll { it.userID == departedAudience.userID }
|
|
103
|
+
private val liveAudienceListener = object : LiveAudienceListener() {
|
|
104
|
+
override fun onAudienceJoined(newAudience: LiveUserInfo) {
|
|
105
|
+
println("Audience ${newAudience.userName} joined the live room")
|
|
106
|
+
// Incremental update: add the new audience member to the end of the current list
|
|
107
|
+
val currentList = _audienceList.value.toMutableList()
|
|
108
|
+
if (!currentList.any { it.userID == newAudience.userID }) {
|
|
109
|
+
currentList.add(newAudience)
|
|
120
110
|
_audienceList.value = currentList
|
|
121
111
|
}
|
|
122
|
-
}
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
override fun onAudienceLeft(departedAudience: LiveUserInfo) {
|
|
115
|
+
println("Audience ${departedAudience.userName} left the live room")
|
|
116
|
+
// Incremental update: remove the departed audience member from the current list
|
|
117
|
+
val currentList = _audienceList.value.toMutableList()
|
|
118
|
+
currentList.removeAll { it.userID == departedAudience.userID }
|
|
119
|
+
_audienceList.value = currentList
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
/// Subscribe to events to handle real-time audience join/leave
|
|
124
|
+
private fun subscribeToAudienceEvents() {
|
|
125
|
+
audienceStore.addLiveAudienceListener(liveAudienceListener)
|
|
123
126
|
}
|
|
124
127
|
}
|
|
125
128
|
```
|
|
@@ -207,27 +210,29 @@ class LiveRoomManager(
|
|
|
207
210
|
setupWelcomeMessageFlow()
|
|
208
211
|
}
|
|
209
212
|
|
|
213
|
+
private val liveAudienceListener = object : LiveAudienceListener() {
|
|
214
|
+
override fun onAudienceJoined(audience: LiveUserInfo) {
|
|
215
|
+
// 3. Create a local tip message
|
|
216
|
+
val welcomeTip = Barrage().apply {
|
|
217
|
+
liveID = liveId
|
|
218
|
+
messageType = BarrageType.TEXT
|
|
219
|
+
textContent = "Welcome ${audience.userName} to the live room."
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
// 4. Get an instance of BarrageStore (this will be the same instance due to internal mechanisms)
|
|
223
|
+
val barrageStore = BarrageStore.create(liveId)
|
|
224
|
+
|
|
225
|
+
// 5. Use BarrageStore's method to insert it into the barrage list
|
|
226
|
+
barrageStore.appendLocalTip(welcomeTip)
|
|
227
|
+
}
|
|
228
|
+
}
|
|
229
|
+
|
|
210
230
|
private fun setupWelcomeMessageFlow() {
|
|
211
231
|
// 1. Get an instance of LiveAudienceStore
|
|
212
232
|
val audienceStore = LiveAudienceStore.create(liveId)
|
|
213
233
|
|
|
214
|
-
// 2.
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
// 3. Subscribe to audience events
|
|
218
|
-
audienceStore.addLiveAudienceListener(object : LiveAudienceListener() {
|
|
219
|
-
override fun onAudienceJoined(audience: LiveUserInfo) {
|
|
220
|
-
// 4. Create a local tip message
|
|
221
|
-
val welcomeTip = Barrage().apply {
|
|
222
|
-
liveID = liveId
|
|
223
|
-
messageType = BarrageType.TEXT
|
|
224
|
-
textContent = "Welcome ${audience.userName} to the live room!"
|
|
225
|
-
}
|
|
226
|
-
|
|
227
|
-
// 5. Use BarrageStore's method to insert it into the barrage list
|
|
228
|
-
barrageStore.appendLocalTip(welcomeTip)
|
|
229
|
-
}
|
|
230
|
-
})
|
|
234
|
+
// 2. Subscribe to audience events
|
|
235
|
+
audienceStore.addLiveAudienceListener(liveAudienceListener)
|
|
231
236
|
}
|
|
232
237
|
}
|
|
233
238
|
```
|
|
@@ -235,11 +240,12 @@ class LiveRoomManager(
|
|
|
235
240
|
## API Documentation
|
|
236
241
|
|
|
237
242
|
For detailed information on all public interfaces, properties, and methods of [LiveAudienceStore](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) and its related classes, refer to the official API documentation included with the [AtomicX Core](https://tencent-rtc.github.io/TUIKit_Android/index.html) framework. The relevant Stores used in this document are as follows:
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
|
242
|
-
|
|
|
243
|
+
|
|
244
|
+
|**Store/Component**|**Feature Description**|**API Documentation**|
|
|
245
|
+
|---------|---------|---------|
|
|
246
|
+
|LiveCoreView|Core view component for live video stream display and interaction: responsible for video stream rendering and view widget handling, supporting scenarios such as host streaming, audience co-hosting, and host-to-host connection.|[API Documentation](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.view/-live-core-view/index.html)|
|
|
247
|
+
|LiveAudienceStore|Audience management: obtain real-time audience list (ID / name / avatar), count audience numbers, and listen for audience join/leave events.|[API Documentation](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.view/-live-core-view/index.html)|
|
|
248
|
+
|BarrageStore|Barrage feature: send text/custom barrage, maintain barrage list, and listen to barrage status in real time.|[API Documentation](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)|
|
|
243
249
|
|
|
244
250
|
## FAQs
|
|
245
251
|
|
|
@@ -12,14 +12,15 @@ By combining `AudioEffectStore` and DeviceStore, you can implement the following
|
|
|
12
12
|
- **Reverb Effects**: Simulate different acoustic environments, such as KTV, metallic, deep, bright, and others.
|
|
13
13
|
|
|
14
14
|
## Core Concepts
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
15
|
+
|
|
16
|
+
|**Core Concept**|**Type**|**Core Responsibility & Description**|
|
|
17
|
+
|---------|---------|---------|
|
|
18
|
+
|`AudioChangerType`|`enum`|Enumerates available voice effects, such as "child", "man", etc.|
|
|
19
|
+
|`AudioReverbType`|`enum`|Enumerates available reverb effects, such as "ktv", "hall", etc.|
|
|
20
|
+
|`AudioEffectState`|`data`|Represents the current state of the audio effect module, typically used for UI rendering. Includes voice effect state, reverb state, ear monitoring enabled state, and ear monitor volume.|
|
|
21
|
+
|`AudioEffectStore`|`abstract`|Singleton data management class for audio effects. Use it to invoke audio effect APIs. After calling an API, the corresponding state property is automatically updated. Subscribe to this reactive state to receive and monitor updates.|
|
|
22
|
+
|`DeviceState`|`data`|Represents the current state of the device module, typically used for UI rendering. Core properties include camera and microphone status.|
|
|
23
|
+
|`DeviceStore`|`abstract`|Singleton data management class for device operations. Use it to control the camera and microphone. After calling an API, the corresponding state property is automatically updated. Subscribe to this reactive state to receive and monitor updates.|
|
|
23
24
|
|
|
24
25
|
## Implementation
|
|
25
26
|
|
|
@@ -79,14 +80,14 @@ CoroutineScope(Dispatchers.Main).launch {
|
|
|
79
80
|
```
|
|
80
81
|
|
|
81
82
|
#### setVoiceEarMonitorEnable Parameters
|
|
82
|
-
|
|
|
83
|
+
| <strong>Parameter Name</strong> | <strong>Type</strong> | <strong>Description</strong> |
|
|
83
84
|
| --- | --- | --- |
|
|
84
|
-
|
|
|
85
|
+
| <code>enable</code> | <code>Boolean</code> | Whether to enable ear monitoring.<br>- true: Enable<br>- false: Disable |
|
|
85
86
|
|
|
86
87
|
#### setVoiceEarMonitorVolume Parameters
|
|
87
|
-
|
|
|
88
|
+
| <strong>Parameter Name</strong> | <strong>Type</strong> | <strong>Description</strong> |
|
|
88
89
|
| --- | --- | --- |
|
|
89
|
-
|
|
|
90
|
+
| <code>volume</code> | <code>Int</code> | Ear monitor volume.<br>- Range: [0, 150]<br>- Default: 100 |
|
|
90
91
|
|
|
91
92
|
### Step 4: Implement Microphone Volume Adjustment
|
|
92
93
|
|
|
@@ -117,9 +118,9 @@ CoroutineScope(Dispatchers.Main).launch {
|
|
|
117
118
|
```
|
|
118
119
|
|
|
119
120
|
#### setCaptureVolume Parameters
|
|
120
|
-
|
|
|
121
|
+
| <strong>Parameter Name</strong> | <strong>Type</strong> | <strong>Description</strong> |
|
|
121
122
|
| --- | --- | --- |
|
|
122
|
-
|
|
|
123
|
+
| <code>volume</code> | <code>Int</code> | Microphone (capture) volume.<br>- Range: [0, 150]<br>- Default: 100 |
|
|
123
124
|
|
|
124
125
|
### Step 5: Implement Voice Effects
|
|
125
126
|
|
|
@@ -138,9 +139,10 @@ audioEffectStore.setAudioChangerType(AudioChangerType.NONE)
|
|
|
138
139
|
```
|
|
139
140
|
|
|
140
141
|
#### setAudioChangerType Parameters
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
142
|
+
|
|
143
|
+
|**Parameter Name**|**Type**|**Description**|
|
|
144
|
+
|---------|---------|---------|
|
|
145
|
+
|`type`|`AudioChangerType`|Voice effect enum value.|
|
|
144
146
|
|
|
145
147
|
### Step 6: Implement Reverb Effects
|
|
146
148
|
|
|
@@ -157,9 +159,10 @@ audioEffectStore.setAudioReverbType(AudioReverbType.NONE)
|
|
|
157
159
|
```
|
|
158
160
|
|
|
159
161
|
#### setAudioReverbType Parameters
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
162
|
+
|
|
163
|
+
|**Parameter Name**|**Type**|**Description**|
|
|
164
|
+
|---------|---------|---------|
|
|
165
|
+
|`type`|`AudioReverbType`|Reverb effect enum value.|
|
|
163
166
|
|
|
164
167
|
### Step 7: Reset Audio Effect Settings
|
|
165
168
|
|
|
@@ -186,10 +189,11 @@ Reset audio effect settings in the following scenarios:
|
|
|
186
189
|
## API Documentation
|
|
187
190
|
|
|
188
191
|
For detailed information on all public interfaces and properties of [AudioEffectStore](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), [DeviceStore](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), and their related classes, refer to the official API documentation for the [AtomicXCore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore) framework.
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
|
192
|
+
|
|
193
|
+
|**Store/Component**|**Feature Description**|**API Documentation**|
|
|
194
|
+
|---------|---------|---------|
|
|
195
|
+
|AudioEffectStore|Manage audio effects: configure and retrieve real-time audio effect status.|[API Documentation](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)|
|
|
196
|
+
|DeviceStore|Manage devices: control camera and microphone, and retrieve real-time device status.|[API Documentation](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)|
|
|
193
197
|
|
|
194
198
|
## FAQs
|
|
195
199
|
|