@tencentcloud/sdk-mcp 1.3.9 → 1.4.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/index.js +1 -1
- package/index.js.map +1 -1
- package/package.json +2 -2
- package/resource/doc/{tuicallkit/android/faq.md → callkit/faq/android-faq.md} +75 -308
- package/resource/doc/{tuicallkit/faq/common/error_code.md → callkit/faq/common/error-code.md} +2 -2
- package/resource/doc/{tuicallkit/flutter/faq.md → callkit/faq/flutter-faq.md} +83 -315
- package/resource/doc/{tuicallkit/iOS/faq.md → callkit/faq/ios-faq.md} +76 -313
- package/resource/doc/{tuicallkit/vue/faq.md → callkit/faq/web-faq.md} +78 -311
- package/resource/doc/callkit/preset/android/api.md +330 -0
- package/resource/doc/{tuicallkit → callkit/preset}/android/integration.md +63 -420
- package/resource/doc/callkit/preset/flutter/api.md +401 -0
- package/resource/doc/{tuicallkit → callkit/preset}/flutter/integration.md +53 -273
- package/resource/doc/callkit/preset/ios/api.md +282 -0
- package/resource/doc/{tuicallkit/iOS → callkit/preset/ios}/integration.md +39 -120
- package/resource/doc/callkit/preset/react/api.md +600 -0
- package/resource/doc/{tuicallkit → callkit/preset}/react/integration.md +6 -6
- package/resource/doc/callkit/preset/vue/api.md +600 -0
- package/resource/doc/{tuicallkit → callkit/preset}/vue/integration.md +5 -5
- package/resource/doc/{chatuikit → chatkit}/android/faq.md +29 -37
- package/resource/doc/{chatuikit → chatkit}/android/features/theme.md +22 -166
- package/resource/doc/{chatuikit → chatkit}/android/integration.md +30 -126
- package/resource/doc/chatkit/faq/android_sdk/client-api.md +280 -0
- package/resource/doc/{chatuikit → chatkit}/faq/common/product.md +4 -17
- package/resource/doc/{chatuikit → chatkit}/faq/common/server.md +1 -2
- package/resource/doc/chatkit/faq/flutter_sdk/client-api.md +183 -0
- package/resource/doc/{chatuikit → chatkit}/faq/flutter_sdk/faq.md +3 -3
- package/resource/doc/chatkit/faq/ios_sdk/client-api.md +279 -0
- package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/error_code.md +1 -1
- package/resource/doc/{chatuikit → chatkit}/faq/web_sdk/faq.md +4 -4
- package/resource/doc/{chatuikit → chatkit}/flutter/features/theme.md +22 -166
- package/resource/doc/{chatuikit → chatkit}/flutter/integration.md +20 -95
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/faq.md +29 -37
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/features/theme.md +27 -176
- package/resource/doc/{chatuikit/iOS → chatkit/ios}/integration.md +78 -280
- package/resource/doc/{chatuikit/vue → chatkit/react}/components/avatar.md +0 -1
- package/resource/doc/{chatuikit → chatkit}/react/components/chat-header.md +7 -12
- package/resource/doc/{chatuikit → chatkit}/react/components/chat-setting.md +10 -17
- package/resource/doc/{chatuikit → chatkit}/react/components/chat.md +1 -1
- package/resource/doc/{chatuikit → chatkit}/react/components/component-list.md +0 -1
- package/resource/doc/{chatuikit → chatkit}/react/components/contact-list.md +122 -703
- package/resource/doc/chatkit/react/components/conversation-actions.md +174 -0
- package/resource/doc/chatkit/react/components/conversation-list.md +333 -0
- package/resource/doc/chatkit/react/components/conversation-preview.md +116 -0
- package/resource/doc/chatkit/react/components/conversation-search.md +57 -0
- package/resource/doc/{chatuikit → chatkit}/react/components/message-input.md +36 -186
- package/resource/doc/{chatuikit → chatkit}/react/components/message-list.md +21 -113
- package/resource/doc/chatkit/react/components/search.md +282 -0
- package/resource/doc/{chatuikit → chatkit}/react/components/tuikit.md +5 -26
- package/resource/doc/{chatuikit → chatkit}/react/integration.md +37 -104
- package/resource/doc/{chatuikit/react → chatkit/vue}/components/avatar.md +0 -1
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat-header.md +7 -13
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat-setting.md +13 -18
- package/resource/doc/{chatuikit → chatkit}/vue/components/chat.md +1 -2
- package/resource/doc/{chatuikit → chatkit}/vue/components/component-list.md +0 -1
- package/resource/doc/chatkit/vue/components/contact-list.md +271 -0
- package/resource/doc/chatkit/vue/components/conversation-actions.md +228 -0
- package/resource/doc/{chatuikit → chatkit}/vue/components/conversation-list.md +42 -316
- package/resource/doc/chatkit/vue/components/conversation-preview.md +213 -0
- package/resource/doc/chatkit/vue/components/conversation-search.md +50 -0
- package/resource/doc/{chatuikit → chatkit}/vue/components/message-input.md +1 -23
- package/resource/doc/{chatuikit → chatkit}/vue/components/message-list.md +23 -134
- package/resource/doc/{chatuikit → chatkit}/vue/components/search.md +73 -640
- package/resource/doc/chatkit/vue/components/tuikit.md +45 -0
- package/resource/doc/{chatuikit → chatkit}/vue/components/userpicker.md +4 -4
- package/resource/doc/{chatuikit → chatkit}/vue/faq.md +1 -1
- package/resource/doc/{chatuikit → chatkit}/vue/integration.md +53 -121
- package/resource/doc/livekit/core-sdk/live/android/api-reference/AudioEffectStore.md +283 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BarrageStore.md +148 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/BattleStore.md +316 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CameraView.md +57 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoGuestStore.md +419 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/CoHostStore.md +325 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/DeviceStore.md +436 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/GiftStore.md +165 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LikeStore.md +49 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveAudienceStore.md +239 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveCoreView.md +74 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LiveSeatStore.md +417 -0
- package/resource/doc/livekit/core-sdk/live/android/api-reference/LoginStore.md +207 -0
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-audience-list.md +17 -88
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-audio-effect.md +34 -192
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-barrage.md +26 -139
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-base-beauty.md +16 -99
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-co-guest-interaction.md +54 -161
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-gift.md +75 -455
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-host-interaction.md +91 -338
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-integration.md +108 -492
- package/resource/doc/livekit/{live → core-sdk/live}/android/live-live-list.md +27 -165
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/AudioEffectStore.md +279 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BarrageStore.md +158 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BaseBeautyStore.md +155 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/BattleStore.md +304 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoGuestStore.md +394 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/CoHostStore.md +303 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/DeviceStore.md +410 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/GiftStore.md +160 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LikeStore.md +51 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveAudienceStore.md +231 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveCoreView.md +143 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LiveSeatStore.md +375 -0
- package/resource/doc/livekit/core-sdk/live/flutter/api-reference/LoginStore.md +170 -0
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audience-list.md +13 -91
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-audio-effect.md +34 -177
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-barrage.md +18 -102
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-base-beauty.md +24 -164
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-co-guest-interaction.md +56 -161
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-gift.md +66 -460
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-host-interaction.md +117 -364
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-integration.md +160 -543
- package/resource/doc/livekit/{live → core-sdk/live}/flutter/live-live-list.md +22 -161
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/AudioEffectStore.md +287 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BarrageStore.md +165 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BaseBeautyStore.md +143 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/BattleStore.md +298 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoGuestStore.md +349 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/CoHostStore.md +297 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/DeviceStore.md +471 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/GiftStore.md +179 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LikeStore.md +49 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveAudienceStore.md +238 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveCoreView.md +74 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LiveSeatStore.md +412 -0
- package/resource/doc/livekit/core-sdk/live/ios/api-reference/LoginStore.md +173 -0
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audience-list.md +23 -96
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-audio-effect.md +33 -195
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-barrage.md +35 -150
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-base-beauty.md +20 -105
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-co-guest-interaction.md +35 -140
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-gift.md +77 -457
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-host-interaction.md +70 -317
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-integration.md +90 -473
- package/resource/doc/livekit/{live → core-sdk/live}/ios/live-live-list.md +28 -163
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audience-list.md +17 -88
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-audio-effect.md +34 -192
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-barrage.md +26 -139
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-co-guest-interaction.md +53 -262
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-gift.md +75 -455
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-host-interaction.md +60 -272
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-integration.md +63 -440
- package/resource/doc/livekit/{voice → core-sdk/voice}/android/voice-room-list.md +23 -151
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-audience-list.md +13 -91
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-audio-effect.md +34 -177
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-barrage.md +18 -102
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-co-guest-interaction.md +44 -201
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-gift.md +66 -460
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-integration.md +57 -419
- package/resource/doc/livekit/{voice → core-sdk/voice}/flutter/voice-room-list.md +24 -157
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audience-list.md +23 -96
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-audio-effect.md +33 -195
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-barrage.md +35 -150
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-co-guest-interaction.md +45 -254
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-gift.md +77 -457
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-host-interaction.md +52 -261
- package/resource/doc/livekit/core-sdk/voice/ios/voice-integration.md +478 -0
- package/resource/doc/livekit/{voice → core-sdk/voice}/ios/voice-room-list.md +36 -167
- package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-audience-list.md +15 -45
- package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-audio-effect.md +23 -137
- package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-barrage.md +25 -131
- package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-co-guest-interaction.md +70 -366
- package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-gift.md +70 -424
- package/resource/doc/livekit/core-sdk/voice/uni-app/voice-integration.md +323 -0
- package/resource/doc/livekit/{voice → core-sdk/voice}/uni-app/voice-room-list.md +24 -116
- package/resource/doc/livekit/faq/common/{error_code.md → error-code.md} +2 -3
- package/resource/doc/livekit/preset/live/vue/api-reference/index.md +780 -0
- package/resource/doc/livekit/preset/live/vue/components/barrage.md +291 -0
- package/resource/doc/livekit/{live → preset/live}/vue/components/co-guest-panel.md +9 -48
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-audience-list.md +27 -145
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-scene-panel.md +13 -76
- package/resource/doc/livekit/{live → preset/live}/vue/components/live-view.md +33 -224
- package/resource/doc/livekit/preset/live/vue/components/stream-mixer.md +211 -0
- package/resource/doc/livekit/preset/live/vue/faq.md +1 -0
- package/resource/doc/livekit/preset/live/vue/live-list-integration.md +244 -0
- package/resource/doc/livekit/preset/live/vue/live-player-desk-integration.md +301 -0
- package/resource/doc/livekit/preset/live/vue/live-player-h5-integration.md +307 -0
- package/resource/doc/livekit/preset/live/vue/live-pusher-integration.md +754 -0
- package/resource/doc/roomkit/android/features/call-user-to-room.md +234 -0
- package/resource/doc/roomkit/android/features/room-participant-state.md +850 -0
- package/resource/doc/roomkit/android/features/room-state.md +358 -0
- package/resource/doc/roomkit/android/features/schedule-room.md +336 -0
- package/resource/doc/roomkit/android/integration.md +433 -0
- package/resource/doc/roomkit/{common/error_code.md → faq/common/error-code.md} +1 -1
- package/resource/doc/roomkit/flutter/features/call-user-to-room.md +228 -0
- package/resource/doc/roomkit/flutter/features/room-participant-state.md +796 -0
- package/resource/doc/roomkit/flutter/features/room-state.md +324 -0
- package/resource/doc/roomkit/flutter/features/schedule-room.md +324 -0
- package/resource/doc/roomkit/flutter/integration.md +405 -0
- package/resource/doc/roomkit/ios/features/call-user-to-room.md +226 -0
- package/resource/doc/roomkit/ios/features/room-participant-state.md +821 -0
- package/resource/doc/roomkit/ios/features/room-state.md +320 -0
- package/resource/doc/roomkit/ios/features/schedule-room.md +318 -0
- package/resource/doc/roomkit/ios/integration.md +384 -0
- package/resource/doc/roomkit/vue/faq.md +1 -0
- package/resource/doc/roomkit/vue/features/call-user-to-room.md +17 -53
- package/resource/doc/roomkit/vue/features/device-detection.md +30 -48
- package/resource/doc/roomkit/vue/features/device-state.md +24 -44
- package/resource/doc/roomkit/vue/features/free-beauty-panel.md +13 -36
- package/resource/doc/roomkit/vue/features/room-chat.md +31 -89
- package/resource/doc/roomkit/vue/features/room-participant-state.md +28 -50
- package/resource/doc/roomkit/vue/features/room-state.md +25 -36
- package/resource/doc/roomkit/vue/features/room-view.md +30 -127
- package/resource/doc/roomkit/vue/features/schedule-room.md +9 -40
- package/resource/doc/roomkit/vue/features/screen-share.md +22 -90
- package/resource/doc/roomkit/vue/features/virtual-background.md +13 -34
- package/resource/doc/roomkit/vue/integration.md +21 -80
- package/resource/doc/rtcengine/faq/common/userSig.md +17 -141
- package/resource/doc/rtcengine/faq/web/web.md +15 -22
- package/resource/doc/rtcengine/web/api.md +17 -21
- package/resource/doc/rtcengine/web/how_to_integrated_web_sdk.md +4 -10
- package/resource/doc/rtcengine/web/how_to_run_web_sdk_demo.md +4 -8
- package/resource/doc/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +3 -3
- package/resource/doc/rtcengine/web/plugin/21-advanced-auto-play-policy.md +2 -3
- package/resource/doc/rtcengine/web/plugin/22-advanced-audio-mixer.md +6 -6
- package/resource/doc/rtcengine/web/plugin/23-advanced-support-detection.md +2 -2
- package/resource/doc/rtcengine/web/plugin/24-advanced-network-quality.md +2 -4
- package/resource/doc/rtcengine/web/plugin/25-advanced-device-change.md +1 -2
- package/resource/doc/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +2 -6
- package/resource/doc/rtcengine/web/plugin/27-advanced-small-stream.md +13 -14
- package/resource/doc/rtcengine/web/plugin/28-advanced-beauty.md +10 -90
- package/resource/doc/rtcengine/web/plugin/31-advanced-plugins-overview.md +5 -8
- package/resource/doc/rtcengine/web/plugin/34-advanced-proxy.md +31 -35
- package/resource/doc/rtcengine/web/plugin/35-advanced-ai-denoiser.md +0 -2
- package/resource/doc/rtcengine/web/plugin/36-advanced-virtual-background.md +7 -49
- package/resource/doc/rtcengine/web/plugin/37-advanced-voice-changer.md +1 -1
- package/resource/doc/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -3
- package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md +20 -20
- package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md +1 -1
- package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md +4 -4
- package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md +3 -3
- package/resource/doc/trtc/C++/ITRTCCloud.md +718 -2847
- package/resource/doc/trtc/C++/ITRTCStatistics.md +53 -308
- package/resource/doc/trtc/C++/ITXAudioEffectManager.md +207 -1041
- package/resource/doc/trtc/C++/ITXDeviceManager.md +127 -768
- package/resource/doc/trtc/C++/TRTCCloudCallback.md +634 -2259
- package/resource/doc/trtc/C++/TRTCTypeDef.md +726 -3465
- package/resource/doc/trtc/C++/TXLiteAVCode.md +117 -916
- package/resource/doc/trtc/android/TRTCCloud.md +638 -2612
- package/resource/doc/trtc/android/TRTCCloudDef.md +769 -3697
- package/resource/doc/trtc/android/TRTCCloudListener.md +609 -2070
- package/resource/doc/trtc/android/TRTCStatistics.md +48 -278
- package/resource/doc/trtc/android/TXAudioEffectManager.md +207 -1049
- package/resource/doc/trtc/android/TXBeautyManager.md +127 -704
- package/resource/doc/trtc/android/TXDeviceManager.md +51 -318
- package/resource/doc/trtc/android/TXLiteAVCode.md +115 -900
- package/resource/doc/trtc/iOS/TRTCCloud.md +726 -2930
- package/resource/doc/trtc/iOS/TRTCCloudDelegate.md +580 -2099
- package/resource/doc/trtc/iOS/TRTCStatistics.md +48 -278
- package/resource/doc/trtc/iOS/TXAudioEffectManager.md +179 -896
- package/resource/doc/trtc/iOS/TXBeautyManager.md +128 -710
- package/resource/doc/trtc/iOS/TXDeviceManager.md +129 -772
- package/resource/doc/trtc/iOS/TXLiteAVCode.md +117 -915
- package/resource/doc/trtc/iOS/TXLiveSDKTypeDef.md +747 -3559
- package/server.js +1 -5
- package/server.js.map +1 -1
- package/tools/call/get_callkit_api.js +32 -0
- package/tools/call/get_callkit_api.js.map +1 -0
- package/tools/call/get_native_call_uikit_integration.js +34 -0
- package/tools/call/get_native_call_uikit_integration.js.map +1 -0
- package/tools/call/{get-web-call-integration.js → get_web_call_uikit_integration.js} +13 -8
- package/tools/call/get_web_call_uikit_integration.js.map +1 -0
- package/tools/chat/get_native_chat_uikit_feature_detail.js +34 -0
- package/tools/chat/get_native_chat_uikit_feature_detail.js.map +1 -0
- package/tools/chat/get_native_chat_uikit_integration.js +45 -0
- package/tools/chat/get_native_chat_uikit_integration.js.map +1 -0
- package/tools/chat/get_web_chat_uikit_component_detail.js +34 -0
- package/tools/chat/get_web_chat_uikit_component_detail.js.map +1 -0
- package/tools/chat/get_web_chat_uikit_integration.js +45 -0
- package/tools/chat/get_web_chat_uikit_integration.js.map +1 -0
- package/tools/common/get_faq.js +265 -0
- package/tools/common/get_faq.js.map +1 -0
- package/tools/common/{get-usersig.js → get_usersig.js} +6 -3
- package/tools/common/get_usersig.js.map +1 -0
- package/tools/common/present_framework_choice.js +63 -0
- package/tools/common/present_framework_choice.js.map +1 -0
- package/tools/definitions/get_callkit_api_def.js +28 -0
- package/tools/definitions/get_callkit_api_def.js.map +1 -0
- package/tools/definitions/get_faq_def.js +18 -19
- package/tools/definitions/get_faq_def.js.map +1 -1
- package/tools/definitions/get_native_call_uikit_integration_def.js +15 -34
- package/tools/definitions/get_native_call_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js +31 -0
- package/tools/definitions/get_native_chat_uikit_feature_detail_def.js.map +1 -0
- package/tools/definitions/get_native_chat_uikit_integration_def.js +16 -41
- package/tools/definitions/get_native_chat_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_native_livekit_core_features_def.js +33 -0
- package/tools/definitions/get_native_livekit_core_features_def.js.map +1 -0
- package/tools/definitions/get_native_livekit_core_integration_def.js +33 -0
- package/tools/definitions/get_native_livekit_core_integration_def.js.map +1 -0
- package/tools/definitions/get_native_trtc_sdk_docs_def.js +32 -0
- package/tools/definitions/get_native_trtc_sdk_docs_def.js.map +1 -0
- package/tools/definitions/get_usersig_def.js +17 -24
- package/tools/definitions/get_usersig_def.js.map +1 -1
- package/tools/definitions/get_web_call_uikit_integration_def.js +15 -7
- package/tools/definitions/get_web_call_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js +17 -49
- package/tools/definitions/get_web_chat_uikit_component_detail_def.js.map +1 -1
- package/tools/definitions/get_web_chat_uikit_integration_def.js +16 -19
- package/tools/definitions/get_web_chat_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_live_uikit_integration_def.js +13 -18
- package/tools/definitions/get_web_live_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_livekit_api_def.js +27 -0
- package/tools/definitions/get_web_livekit_api_def.js.map +1 -0
- package/tools/definitions/get_web_livekit_component_detail_def.js +29 -0
- package/tools/definitions/get_web_livekit_component_detail_def.js.map +1 -0
- package/tools/definitions/get_web_room_uikit_integration_def.js +13 -46
- package/tools/definitions/get_web_room_uikit_integration_def.js.map +1 -1
- package/tools/definitions/get_web_roomkit_feature_detail_def.js +30 -0
- package/tools/definitions/get_web_roomkit_feature_detail_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_api_def.js +25 -0
- package/tools/definitions/get_web_trtc_sdk_api_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_integration_def.js +25 -0
- package/tools/definitions/get_web_trtc_sdk_integration_def.js.map +1 -0
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js +25 -0
- package/tools/definitions/get_web_trtc_sdk_plugin_def.js.map +1 -0
- package/tools/definitions/present_framework_choice_def.js +23 -12
- package/tools/definitions/present_framework_choice_def.js.map +1 -1
- package/tools/index.js +47 -61
- package/tools/index.js.map +1 -1
- package/tools/live/get_native_livekit_core_features.js +65 -0
- package/tools/live/get_native_livekit_core_features.js.map +1 -0
- package/tools/live/get_native_livekit_core_integration.js +59 -0
- package/tools/live/get_native_livekit_core_integration.js.map +1 -0
- package/tools/live/get_web_live_uikit_integration.js +48 -0
- package/tools/live/get_web_live_uikit_integration.js.map +1 -0
- package/tools/live/get_web_livekit_api.js +32 -0
- package/tools/live/get_web_livekit_api.js.map +1 -0
- package/tools/live/get_web_livekit_component_detail.js +34 -0
- package/tools/live/get_web_livekit_component_detail.js.map +1 -0
- package/tools/room/{get-web-room-integration.js → get_web_room_uikit_integration.js} +13 -14
- package/tools/room/get_web_room_uikit_integration.js.map +1 -0
- package/tools/room/{get-web-room-feature-detail.js → get_web_roomkit_feature_detail.js} +30 -31
- package/tools/room/get_web_roomkit_feature_detail.js.map +1 -0
- package/tools/rtcengine/get_web_trtc_sdk_api.js +31 -0
- package/tools/rtcengine/get_web_trtc_sdk_api.js.map +1 -0
- package/tools/rtcengine/get_web_trtc_sdk_integration.js +31 -0
- package/tools/rtcengine/get_web_trtc_sdk_integration.js.map +1 -0
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js +31 -0
- package/tools/rtcengine/get_web_trtc_sdk_plugin.js.map +1 -0
- package/tools/trtc/get_native_trtc_sdk_docs.js +73 -0
- package/tools/trtc/get_native_trtc_sdk_docs.js.map +1 -0
- package/utils/generate-structured-result.js +61 -17
- package/utils/generate-structured-result.js.map +1 -1
- package/utils/report-cls-client.js +12 -1
- package/utils/report-cls-client.js.map +1 -1
- package/utils/report-es-client.js +1 -1
- package/resource/doc/chatuikit/android/workflow.md +0 -713
- package/resource/doc/chatuikit/faq/android_sdk/client-api.md +0 -1376
- package/resource/doc/chatuikit/faq/flutter_sdk/client-api.md +0 -860
- package/resource/doc/chatuikit/faq/ios_sdk/client-api.md +0 -1371
- package/resource/doc/chatuikit/flutter/workflow.md +0 -816
- package/resource/doc/chatuikit/iOS/workflow.md +0 -0
- package/resource/doc/chatuikit/react/components/conversation-list.md +0 -765
- package/resource/doc/chatuikit/react/components/search.md +0 -885
- package/resource/doc/chatuikit/react/create-group.md +0 -22
- package/resource/doc/chatuikit/react/init.md +0 -25
- package/resource/doc/chatuikit/react/workflow.md +0 -254
- package/resource/doc/chatuikit/uniapp-app/faq.md +0 -0
- package/resource/doc/chatuikit/uniapp-app/integration.md +0 -619
- package/resource/doc/chatuikit/uniapp-app/workflow.md +0 -576
- package/resource/doc/chatuikit/vue/components/contact-list.md +0 -679
- package/resource/doc/chatuikit/vue/components/tuikit.md +0 -110
- package/resource/doc/chatuikit/vue/create-group.md +0 -26
- package/resource/doc/chatuikit/vue/init.md +0 -35
- package/resource/doc/chatuikit/vue/workflow.md +0 -395
- package/resource/doc/livekit/live/android/workflow.md +0 -322
- package/resource/doc/livekit/live/flutter/workflow.md +0 -353
- package/resource/doc/livekit/live/ios/workflow.md +0 -352
- package/resource/doc/livekit/live/vue/components/barrage.md +0 -615
- package/resource/doc/livekit/live/vue/components/stream-mixer.md +0 -442
- package/resource/doc/livekit/live/vue/faq.md +0 -0
- package/resource/doc/livekit/live/vue/live-list-integration.md +0 -195
- package/resource/doc/livekit/live/vue/live-player-desk-integration.md +0 -293
- package/resource/doc/livekit/live/vue/live-player-h5-integration.md +0 -381
- package/resource/doc/livekit/live/vue/live-pusher-integration.md +0 -598
- package/resource/doc/livekit/live/vue/states/live-state.md +0 -2656
- package/resource/doc/livekit/live/vue/workflow.md +0 -219
- package/resource/doc/livekit/voice/android/workflow.md +0 -333
- package/resource/doc/livekit/voice/flutter/workflow.md +0 -359
- package/resource/doc/livekit/voice/ios/voice-integration.md +0 -853
- package/resource/doc/livekit/voice/ios/workflow.md +0 -358
- package/resource/doc/livekit/voice/uni-app/voice-integration.md +0 -613
- package/resource/doc/livekit/voice/uni-app/workflow.md +0 -369
- package/resource/doc/native_live/android/V2TXLiveCode_api_android.md +0 -334
- package/resource/doc/native_live/android/V2TXLiveDef_api_android.md +0 -434
- package/resource/doc/native_live/android/V2TXLivePlayerObserver_api_android.md +0 -685
- package/resource/doc/native_live/android/V2TXLivePlayer_api_android.md +0 -712
- package/resource/doc/native_live/android/V2TXLivePremier_api_android.md +0 -284
- package/resource/doc/native_live/android/V2TXLivePusherObserver_api_android.md +0 -849
- package/resource/doc/native_live/android/V2TXLivePusher_api_android.md +0 -1046
- package/resource/doc/native_live/flutter/V2TXLiveCode_api_flutter.md +0 -460
- package/resource/doc/native_live/flutter/V2TXLiveDef_api_flutter.md +0 -558
- package/resource/doc/native_live/flutter/V2TXLivePlayerObserver_api_flutter.md +0 -879
- package/resource/doc/native_live/flutter/V2TXLivePlayer_api_flutter.md +0 -668
- package/resource/doc/native_live/flutter/V2TXLivePremier_api_flutter.md +0 -456
- package/resource/doc/native_live/flutter/V2TXLivePusherObserver_api_flutter.md +0 -332
- package/resource/doc/native_live/flutter/V2TXLivePusher_api_flutter.md +0 -748
- package/resource/doc/native_live/iOS/V2TXLiveCode_api_iOS.md +0 -328
- package/resource/doc/native_live/iOS/V2TXLiveDef_api_iOS.md +0 -505
- package/resource/doc/native_live/iOS/V2TXLivePlayerObserver_api_iOS.md +0 -507
- package/resource/doc/native_live/iOS/V2TXLivePlayer_api_iOS.md +0 -676
- package/resource/doc/native_live/iOS/V2TXLivePremier_api_iOS.md +0 -284
- package/resource/doc/native_live/iOS/V2TXLivePusherObserver_api_iOS.md +0 -820
- package/resource/doc/native_live/iOS/V2TXLivePusher_api_iOS.md +0 -1065
- package/resource/doc/roomkit/vue/features/workflow.md +0 -553
- package/resource/doc/roomkit/vue/workflow.md +0 -733
- package/resource/doc/tuicallkit/android/workflow.md +0 -432
- package/resource/doc/tuicallkit/faq/android_sdk/call-observer-api.md +0 -786
- package/resource/doc/tuicallkit/faq/android_sdk/callkit-api.md +0 -663
- package/resource/doc/tuicallkit/faq/flutter_sdk/call-define-api.md +0 -932
- package/resource/doc/tuicallkit/faq/flutter_sdk/call-observer-api.md +0 -926
- package/resource/doc/tuicallkit/faq/flutter_sdk/callkit-api.md +0 -452
- package/resource/doc/tuicallkit/faq/ios_sdk/call-observer-api.md +0 -779
- package/resource/doc/tuicallkit/faq/ios_sdk/callkit-api.md +0 -635
- package/resource/doc/tuicallkit/flutter/workflow.md +0 -331
- package/resource/doc/tuicallkit/react/api.md +0 -1512
- package/resource/doc/tuicallkit/react/faq.md +0 -986
- package/resource/doc/tuicallkit/vue/api.md +0 -1512
- package/tools/call/get-native-call-integration.js +0 -43
- package/tools/call/get-native-call-integration.js.map +0 -1
- package/tools/call/get-web-call-api.js +0 -27
- package/tools/call/get-web-call-api.js.map +0 -1
- package/tools/call/get-web-call-integration.js.map +0 -1
- package/tools/chat/get-native-chat-feature-detail.js +0 -30
- package/tools/chat/get-native-chat-feature-detail.js.map +0 -1
- package/tools/chat/get-native-chat-integration.js +0 -45
- package/tools/chat/get-native-chat-integration.js.map +0 -1
- package/tools/chat/get-web-chat-component-detail.js +0 -31
- package/tools/chat/get-web-chat-component-detail.js.map +0 -1
- package/tools/chat/get-web-chat-integration.js +0 -45
- package/tools/chat/get-web-chat-integration.js.map +0 -1
- package/tools/chat/get-web-chat-uikit-init.js +0 -28
- package/tools/chat/get-web-chat-uikit-init.js.map +0 -1
- package/tools/chat/get-web-create-group-doc.js +0 -28
- package/tools/chat/get-web-create-group-doc.js.map +0 -1
- package/tools/common/get-faq.js +0 -91
- 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 +0 -16
- package/tools/common/present-framework-choice.js.map +0 -1
- package/tools/common/present-scenario-choice.js +0 -16
- package/tools/common/present-scenario-choice.js.map +0 -1
- package/tools/common/record-prompt.js +0 -55
- package/tools/common/record-prompt.js.map +0 -1
- package/tools/common/record-result.js +0 -60
- package/tools/common/record-result.js.map +0 -1
- package/tools/definitions/get_native_chat_feature_detail_def.js +0 -32
- package/tools/definitions/get_native_chat_feature_detail_def.js.map +0 -1
- package/tools/definitions/get_native_live_api_def.js +0 -22
- package/tools/definitions/get_native_live_api_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_extra_features_def.js +0 -109
- package/tools/definitions/get_native_live_uikit_extra_features_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_integration_def.js +0 -75
- package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -63
- package/tools/definitions/get_native_live_uikit_interaction_def.js.map +0 -1
- package/tools/definitions/get_trtc_native_api_def.js +0 -17
- package/tools/definitions/get_trtc_native_api_def.js.map +0 -1
- package/tools/definitions/get_web_call_uikit_api_def.js +0 -23
- package/tools/definitions/get_web_call_uikit_api_def.js.map +0 -1
- package/tools/definitions/get_web_chat_uikit_init_def.js +0 -23
- package/tools/definitions/get_web_chat_uikit_init_def.js.map +0 -1
- package/tools/definitions/get_web_create_group_doc_def.js +0 -18
- package/tools/definitions/get_web_create_group_doc_def.js.map +0 -1
- package/tools/definitions/get_web_live_state_detail_def.js +0 -19
- package/tools/definitions/get_web_live_state_detail_def.js.map +0 -1
- package/tools/definitions/get_web_live_uikit_component_detail_def.js +0 -27
- package/tools/definitions/get_web_live_uikit_component_detail_def.js.map +0 -1
- package/tools/definitions/get_web_room_feature_detail_def.js +0 -92
- package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
- package/tools/definitions/present_scenario_choice_def.js +0 -53
- package/tools/definitions/present_scenario_choice_def.js.map +0 -1
- package/tools/definitions/record_prompt_def.js +0 -58
- package/tools/definitions/record_prompt_def.js.map +0 -1
- package/tools/definitions/record_result_def.js +0 -46
- package/tools/definitions/record_result_def.js.map +0 -1
- package/tools/live/get-native-live-uikit-integration.js +0 -177
- package/tools/live/get-native-live-uikit-integration.js.map +0 -1
- package/tools/live/get-web-live-component-detail.js +0 -31
- package/tools/live/get-web-live-component-detail.js.map +0 -1
- package/tools/live/get-web-live-state-detail.js +0 -31
- package/tools/live/get-web-live-state-detail.js.map +0 -1
- package/tools/live/get-web-live-uikit-integration.js +0 -52
- package/tools/live/get-web-live-uikit-integration.js.map +0 -1
- package/tools/live/get_native_live_uikit_extra_features.js +0 -105
- package/tools/live/get_native_live_uikit_extra_features.js.map +0 -1
- package/tools/live/get_native_live_uikit_interaction.js +0 -194
- package/tools/live/get_native_live_uikit_interaction.js.map +0 -1
- package/tools/native_live/get-native-live-api.js +0 -31
- package/tools/native_live/get-native-live-api.js.map +0 -1
- package/tools/room/get-web-room-feature-detail.js.map +0 -1
- package/tools/room/get-web-room-integration.js.map +0 -1
- package/tools/rtcengine/get-rtcengine-web-sdk-integration.js +0 -28
- package/tools/rtcengine/get-rtcengine-web-sdk-integration.js.map +0 -1
- package/tools/rtcengine/get-trtc-sdk-faq.js +0 -32
- package/tools/rtcengine/get-trtc-sdk-faq.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-api.js +0 -28
- package/tools/rtcengine/get-trtc-web-sdk-api.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-faq.js +0 -30
- package/tools/rtcengine/get-trtc-web-sdk-faq.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-integration.js +0 -29
- package/tools/rtcengine/get-trtc-web-sdk-integration.js.map +0 -1
- package/tools/rtcengine/get-trtc-web-sdk-plugin.js +0 -45
- package/tools/rtcengine/get-trtc-web-sdk-plugin.js.map +0 -1
- package/tools/trtc/get-trtc-native-api.js +0 -31
- package/tools/trtc/get-trtc-native-api.js.map +0 -1
- package/utils/handle-component-name.js +0 -33
- package/utils/handle-component-name.js.map +0 -1
- /package/resource/doc/{rtcengine/web → callkit/core-sdk}/.gitkeep +0 -0
- /package/resource/doc/{chatuikit → chatkit}/faq/common/server_error_code.md +0 -0
- /package/resource/doc/{chatuikit → chatkit}/flutter/faq.md +0 -0
- /package/resource/doc/{chatuikit → chatkit}/react/faq.md +0 -0
|
@@ -1,8 +1,5 @@
|
|
|
1
1
|
**AtomicXCore** 提供了 [CoGuestState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-CoGuestState) 和 [LiveSeatState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-LiveSeatState) 模块,用于管理观众连麦的完整业务流程。您无需关心复杂的状态同步和信令交互,只需调用几个简单的方法,即可为您的直播添加强大的观众与主播音视频互动功能。本文档将指导您如何使用 `CoGuestState `和 `LiveSeatState`在您的应用中快速实现语音连麦功能。
|
|
2
2
|
|
|
3
|
-

|
|
4
|
-
|
|
5
|
-
|
|
6
3
|
## 核心场景
|
|
7
4
|
|
|
8
5
|
`CoGuestState`和 `LiveSeatState`支持以下几个主流的场景:
|
|
@@ -12,12 +9,11 @@
|
|
|
12
9
|
|
|
13
10
|
- **主播管理麦位**:主播可以对麦位上的用户进行踢人、闭麦、锁麦等操作。
|
|
14
11
|
|
|
15
|
-
|
|
16
12
|
## 实现步骤
|
|
17
13
|
|
|
18
14
|
### 步骤1:组件集成
|
|
19
15
|
|
|
20
|
-
请参考
|
|
16
|
+
请参考 快速接入 集成 **AtomicXCore**。
|
|
21
17
|
|
|
22
18
|
### 步骤2:实现观众申请上麦
|
|
23
19
|
|
|
@@ -26,32 +22,30 @@
|
|
|
26
22
|
作为观众,您的核心任务是**发起申请、接收结果**和**主动下麦**。
|
|
27
23
|
1. **发起连麦申请**
|
|
28
24
|
|
|
29
|
-
|
|
30
25
|
当用户点击界面上的“申请连麦”按钮时,调用 `applyForSeat` 方法。
|
|
31
26
|
|
|
32
27
|
``` typescript
|
|
33
28
|
import { useCoGuestState } from "@/uni_modules/tuikit-atomic-x/state/CoGuestState";
|
|
34
|
-
|
|
29
|
+
|
|
35
30
|
// 先获取要加入的语聊房 ID(liveID)。通常有以下几种方式:
|
|
36
31
|
// 通过房间列表选择(可从 LiveListState 的 liveList 数据中获取)
|
|
37
|
-
|
|
32
|
+
|
|
38
33
|
const liveID = "xxx" // 您当前加入语聊房的 liveID
|
|
39
|
-
|
|
34
|
+
|
|
40
35
|
//通过 liveID 获取 CoGuestState 的实例
|
|
41
36
|
const { applyForSeat } = useCoGuestState(liveID);
|
|
42
|
-
|
|
37
|
+
|
|
43
38
|
// 用户点击“申请连麦”
|
|
44
39
|
const handleRequestToConnect = () => {
|
|
45
|
-
applyForSeat({
|
|
40
|
+
applyForSeat({
|
|
46
41
|
liveID,
|
|
47
42
|
seatIndex: -1, // 申请的麦位,申请上麦传 -1, 随机分配麦位
|
|
48
43
|
timeout: 30, // 请求超时时间,例如 30s
|
|
49
44
|
})
|
|
50
|
-
}
|
|
45
|
+
}
|
|
51
46
|
```
|
|
52
47
|
2. **监听主播的处理结果**
|
|
53
48
|
|
|
54
|
-
|
|
55
49
|
通过 `addCoGuestGuestListener` 订阅`'onGuestApplicationResponded'` 事件,您可以接收到主播的处理结果。
|
|
56
50
|
|
|
57
51
|
``` typescript
|
|
@@ -61,12 +55,12 @@
|
|
|
61
55
|
const liveID = "xxx" // 您当前加入语聊房的 liveID
|
|
62
56
|
const { addCoGuestGuestListener } = useCoGuestState(liveID);
|
|
63
57
|
const { openLocalMicrophone } = useDeviceState(liveID);
|
|
64
|
-
|
|
58
|
+
|
|
65
59
|
// 在页面初始化时订阅事件
|
|
66
60
|
onMounted(() => {
|
|
67
61
|
addCoGuestGuestListener(liveID, 'onGuestApplicationResponded', handleGuestApplicationResponded)
|
|
68
62
|
})
|
|
69
|
-
|
|
63
|
+
|
|
70
64
|
const handleGuestApplicationResponded = {
|
|
71
65
|
callback: (event) => {
|
|
72
66
|
const res = JSON.parse(event)
|
|
@@ -84,14 +78,13 @@
|
|
|
84
78
|
```
|
|
85
79
|
3. **主动下麦**
|
|
86
80
|
|
|
87
|
-
|
|
88
81
|
当连麦观众想结束互动时,调用 `disConnect` 方法即可返回普通观众状态。
|
|
89
82
|
|
|
90
83
|
``` typescript
|
|
91
84
|
import { useCoGuestState } from "@/uni_modules/tuikit-atomic-x/state/CoGuestState";
|
|
92
85
|
const liveID = "xxx" // 您当前加入语聊房的 liveID
|
|
93
86
|
const { disconnect } = useCoGuestState(liveID);
|
|
94
|
-
|
|
87
|
+
|
|
95
88
|
// 用户点击“下麦”按钮
|
|
96
89
|
const leaveSeat = () => {
|
|
97
90
|
disconnect({
|
|
@@ -107,14 +100,13 @@
|
|
|
107
100
|
```
|
|
108
101
|
4. **(可选) 取消申请**
|
|
109
102
|
|
|
110
|
-
|
|
111
103
|
如果观众在主播处理前想撤回申请,可以调用 `cancelApplication` 。
|
|
112
104
|
|
|
113
105
|
``` typescript
|
|
114
106
|
import { useCoGuestState } from "@/uni_modules/tuikit-atomic-x/state/CoGuestState";
|
|
115
107
|
const liveID = "xxx" // 您当前加入的语聊房的 liveID
|
|
116
108
|
const { cancelApplication } = useCoGuestState(liveID);
|
|
117
|
-
|
|
109
|
+
|
|
118
110
|
// 用户在等待时,点击“取消申请”
|
|
119
111
|
const handelCancelRequest = () => {
|
|
120
112
|
cancelApplication({
|
|
@@ -134,7 +126,6 @@
|
|
|
134
126
|
作为主播,您的核心任务是**接收申请、展示申请列表**和**处理申请**。
|
|
135
127
|
1. **监听新的连麦申请**
|
|
136
128
|
|
|
137
|
-
|
|
138
129
|
通过 `CoGuestHostListener` 订阅 `'onGuestApplicationReceived'` 事件您可以在有新观众申请时立即收到通知,并给出提示。
|
|
139
130
|
|
|
140
131
|
``` typescript
|
|
@@ -142,12 +133,12 @@
|
|
|
142
133
|
import { useCoGuestState } from "@/uni_modules/tuikit-atomic-x/state/CoGuestState";
|
|
143
134
|
const liveID = "xxx" // 您当前语聊房的 liveID
|
|
144
135
|
const { addCoGuestHostListener } = useCoGuestState(liveID);
|
|
145
|
-
|
|
136
|
+
|
|
146
137
|
// 在页面初始化时订阅事件
|
|
147
138
|
onMounted(() => {
|
|
148
139
|
addCoGuestHostListener(liveID, 'onGuestApplicationReceived', handleGuestApplicationReceived)
|
|
149
140
|
})
|
|
150
|
-
|
|
141
|
+
|
|
151
142
|
const handleGuestApplicationReceived = {
|
|
152
143
|
callback: (event) => {
|
|
153
144
|
const res = JSON.parse(event)
|
|
@@ -158,7 +149,6 @@
|
|
|
158
149
|
```
|
|
159
150
|
2. **展示申请列表**
|
|
160
151
|
|
|
161
|
-
|
|
162
152
|
`CoGuestState` 会实时维护当前的申请者列表,数据本身是响应式数据,您可以直接在 UI 上使用。
|
|
163
153
|
|
|
164
154
|
``` typescript
|
|
@@ -177,14 +167,13 @@
|
|
|
177
167
|
```
|
|
178
168
|
3. **处理连麦申请**
|
|
179
169
|
|
|
180
|
-
|
|
181
170
|
当您在列表中选择一位观众并点击“同意”或“拒绝”时,调用相应的方法。
|
|
182
171
|
|
|
183
172
|
``` typescript
|
|
184
173
|
import { useCoGuestState } from "@/uni_modules/tuikit-atomic-x/state/CoGuestState";
|
|
185
174
|
const liveID = "xxx" // 您当前语聊房的 liveID
|
|
186
175
|
const { acceptApplication, rejectApplication } = useCoGuestState(liveID);
|
|
187
|
-
|
|
176
|
+
|
|
188
177
|
// 主播点击“同意”按钮,传入申请者的 userID
|
|
189
178
|
const handleAccept = (userID: string) => {
|
|
190
179
|
acceptApplication({
|
|
@@ -196,10 +185,10 @@
|
|
|
196
185
|
fail: (error) => {
|
|
197
186
|
console.log('同意${userID}的上麦申请失败', error)
|
|
198
187
|
}
|
|
199
|
-
|
|
188
|
+
|
|
200
189
|
})
|
|
201
190
|
}
|
|
202
|
-
|
|
191
|
+
|
|
203
192
|
// 主播点击“拒绝”按钮,传入申请者的 userID
|
|
204
193
|
const handleReject = (userID: string) => {
|
|
205
194
|
rejectApplication({
|
|
@@ -220,14 +209,13 @@
|
|
|
220
209
|
#### 主播端实现
|
|
221
210
|
1. **向观众发起邀请**
|
|
222
211
|
|
|
223
|
-
|
|
224
212
|
当主播在观众列表中选择某人并点击“邀请连麦”时,调用 `inviteToSeat` 方法。
|
|
225
213
|
|
|
226
214
|
``` typescript
|
|
227
215
|
import { useCoGuestState } from "@/uni_modules/tuikit-atomic-x/state/CoGuestState";
|
|
228
216
|
const liveID = "xxx" // 您当前语聊房的 liveID
|
|
229
217
|
const { inviteToSeat } = useCoGuestState(liveID);
|
|
230
|
-
|
|
218
|
+
|
|
231
219
|
// 主播选择观众并发起邀请
|
|
232
220
|
const handleInviteToSeat = (userID: string) => {
|
|
233
221
|
inviteToSeat({
|
|
@@ -246,7 +234,6 @@
|
|
|
246
234
|
```
|
|
247
235
|
2. **监听观众的回应**
|
|
248
236
|
|
|
249
|
-
|
|
250
237
|
通过 `CoGuestHostListener` 订阅 `'onHostInvitationResponded'` 事件。
|
|
251
238
|
|
|
252
239
|
``` typescript
|
|
@@ -254,12 +241,12 @@
|
|
|
254
241
|
import { useCoGuestState } from "@/uni_modules/tuikit-atomic-x/state/CoGuestState";
|
|
255
242
|
const liveID = "xxx" // 您当前语聊房的 liveID
|
|
256
243
|
const { addCoGuestHostListener } = useCoGuestState(liveID);
|
|
257
|
-
|
|
258
|
-
// 在页面初始化时订阅事件
|
|
244
|
+
|
|
245
|
+
// 在页面初始化时订阅事件
|
|
259
246
|
onMounted(() => {
|
|
260
247
|
addCoGuestHostListener(liveID, 'onHostInvitationResponded', handleHostInvitationResponded)
|
|
261
248
|
})
|
|
262
|
-
|
|
249
|
+
|
|
263
250
|
const handleHostInvitationResponded = {
|
|
264
251
|
callback: (event) => {
|
|
265
252
|
const res = JSON.parse(event)
|
|
@@ -275,7 +262,6 @@
|
|
|
275
262
|
#### 观众端实现
|
|
276
263
|
1. **接收主播的邀请**
|
|
277
264
|
|
|
278
|
-
|
|
279
265
|
通过 `addCoGuestGuestListener` 订阅 `'onHostInvitationReceived'` 事件。
|
|
280
266
|
|
|
281
267
|
``` typescript
|
|
@@ -283,12 +269,12 @@
|
|
|
283
269
|
import { useCoGuestState } from "@/uni_modules/tuikit-atomic-x/state/CoGuestState";
|
|
284
270
|
const liveID = "xxx" // 您当前加入语聊房的 liveID
|
|
285
271
|
const { addCoGuestGuestListener } = useCoGuestState(liveID);
|
|
286
|
-
|
|
272
|
+
|
|
287
273
|
// 在页面初始化时订阅事件
|
|
288
274
|
onMounted(() => {
|
|
289
275
|
addCoGuestGuestListener(liveID, 'onHostInvitationReceived', handleHostInvitationReceived)
|
|
290
276
|
})
|
|
291
|
-
|
|
277
|
+
|
|
292
278
|
const handleHostInvitationReceived = {
|
|
293
279
|
callback: (event) => {
|
|
294
280
|
// 在此弹出一个对话框,让用户选择“接受”或“拒绝”
|
|
@@ -297,7 +283,6 @@
|
|
|
297
283
|
```
|
|
298
284
|
2. **响应邀请**
|
|
299
285
|
|
|
300
|
-
|
|
301
286
|
当用户在弹出的对话框中做出选择后,调用相应的方法。
|
|
302
287
|
|
|
303
288
|
``` typescript
|
|
@@ -306,9 +291,9 @@
|
|
|
306
291
|
const liveID = "xxx" // 您当前加入的语聊房的 liveID
|
|
307
292
|
const { acceptInvitation, rejectInvitation } = useCoGuestState(liveID);
|
|
308
293
|
const { openLocalMicrophone, openLocalCamera } = useDeviceState(liveID);
|
|
309
|
-
|
|
294
|
+
|
|
310
295
|
const inviterID = "发起邀请的主播ID" // 从 onHostInvitationReceived 事件中获取
|
|
311
|
-
|
|
296
|
+
|
|
312
297
|
// 用户点击“接受”,
|
|
313
298
|
const handleAccept = () => {
|
|
314
299
|
acceptInvitation({
|
|
@@ -338,7 +323,6 @@
|
|
|
338
323
|
|
|
339
324
|
2. **解除静音**:调用 `unmuteMicrophone(success: fail:) `方法。
|
|
340
325
|
|
|
341
|
-
|
|
342
326
|
#### 示例代码:
|
|
343
327
|
``` typescript
|
|
344
328
|
import { useLiveSeatState } from "@/uni_modules/tuikit-atomic-x/state/LiveSeatState";
|
|
@@ -365,32 +349,10 @@ const unmuteMic = () => {
|
|
|
365
349
|
```
|
|
366
350
|
|
|
367
351
|
#### unmuteMicrophone 接口参数:
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
<td rowspan="1" colSpan="1" >**类型**</td>
|
|
373
|
-
|
|
374
|
-
<td rowspan="1" colSpan="1" >**描述**</td>
|
|
375
|
-
</tr>
|
|
376
|
-
|
|
377
|
-
<tr>
|
|
378
|
-
<td rowspan="1" colSpan="1" >`success`</td>
|
|
379
|
-
|
|
380
|
-
<td rowspan="1" colSpan="1" >`Function`</td>
|
|
381
|
-
|
|
382
|
-
<td rowspan="1" colSpan="1" >解除静音的回调</td>
|
|
383
|
-
</tr>
|
|
384
|
-
|
|
385
|
-
<tr>
|
|
386
|
-
<td rowspan="1" colSpan="1" >`fail`</td>
|
|
387
|
-
|
|
388
|
-
<td rowspan="1" colSpan="1" >`Function`</td>
|
|
389
|
-
|
|
390
|
-
<td rowspan="1" colSpan="1" >解除静音失败的回调。</td>
|
|
391
|
-
</tr>
|
|
392
|
-
</table>
|
|
393
|
-
|
|
352
|
+
| **参数** | **类型** | **描述** |
|
|
353
|
+
| --- | --- | --- |
|
|
354
|
+
| `success` | `Function` | 解除静音的回调 |
|
|
355
|
+
| `fail` | `Function` | 解除静音失败的回调。 |
|
|
394
356
|
|
|
395
357
|
### 主播远程控制麦上用户开麦或关麦
|
|
396
358
|
|
|
@@ -403,7 +365,6 @@ const unmuteMic = () => {
|
|
|
403
365
|
|
|
404
366
|
3. **用户自行开麦**:用户在收到“解除锁定”的通知后,必须主动调用 `LiveSeatState` 的 `unmuteMicrophone()`方法解除静音,才能让房间内其他人听到自己的声音。
|
|
405
367
|
|
|
406
|
-
|
|
407
368
|
#### 示例代码:
|
|
408
369
|
|
|
409
370
|
##### 主播端:
|
|
@@ -470,92 +431,20 @@ onMounted(() => {
|
|
|
470
431
|
```
|
|
471
432
|
|
|
472
433
|
#### closeRemoteMicrophone 接口参数:
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
<td rowspan="1" colSpan="1" >**描述**</td>
|
|
480
|
-
</tr>
|
|
481
|
-
|
|
482
|
-
<tr>
|
|
483
|
-
<td rowspan="1" colSpan="1" >`liveID`</td>
|
|
484
|
-
|
|
485
|
-
<td rowspan="1" colSpan="1" >`string`</td>
|
|
486
|
-
|
|
487
|
-
<td rowspan="1" colSpan="1" >当前语聊房的`liveID`。</td>
|
|
488
|
-
</tr>
|
|
489
|
-
|
|
490
|
-
<tr>
|
|
491
|
-
<td rowspan="1" colSpan="1" >`userID`</td>
|
|
492
|
-
|
|
493
|
-
<td rowspan="1" colSpan="1" >`string`</td>
|
|
494
|
-
|
|
495
|
-
<td rowspan="1" colSpan="1" >被操作的用户`userID`。</td>
|
|
496
|
-
</tr>
|
|
497
|
-
|
|
498
|
-
<tr>
|
|
499
|
-
<td rowspan="1" colSpan="1" >`success`</td>
|
|
500
|
-
|
|
501
|
-
<td rowspan="1" colSpan="1" >`Function`</td>
|
|
502
|
-
|
|
503
|
-
<td rowspan="1" colSpan="1" >静音成功的回调。</td>
|
|
504
|
-
</tr>
|
|
505
|
-
|
|
506
|
-
<tr>
|
|
507
|
-
<td rowspan="1" colSpan="1" >`fail`</td>
|
|
508
|
-
|
|
509
|
-
<td rowspan="1" colSpan="1" >`Function`</td>
|
|
510
|
-
|
|
511
|
-
<td rowspan="1" colSpan="1" >静音失败的回调。</td>
|
|
512
|
-
</tr>
|
|
513
|
-
</table>
|
|
514
|
-
|
|
434
|
+
| **参数** | **类型** | **描述** |
|
|
435
|
+
| --- | --- | --- |
|
|
436
|
+
| `liveID` | `string` | 当前语聊房的`liveID`。 |
|
|
437
|
+
| `userID` | `string` | 被操作的用户`userID`。 |
|
|
438
|
+
| `success` | `Function` | 静音成功的回调。 |
|
|
439
|
+
| `fail` | `Function` | 静音失败的回调。 |
|
|
515
440
|
|
|
516
441
|
#### openRemoteMicrophone 接口参数:
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
<td rowspan="1" colSpan="1" >**描述**</td>
|
|
524
|
-
</tr>
|
|
525
|
-
|
|
526
|
-
<tr>
|
|
527
|
-
<td rowspan="1" colSpan="1" >`liveID`</td>
|
|
528
|
-
|
|
529
|
-
<td rowspan="1" colSpan="1" >`string`</td>
|
|
530
|
-
|
|
531
|
-
<td rowspan="1" colSpan="1" >当前语聊房的`liveID`。</td>
|
|
532
|
-
</tr>
|
|
533
|
-
|
|
534
|
-
<tr>
|
|
535
|
-
<td rowspan="1" colSpan="1" >`userID`</td>
|
|
536
|
-
|
|
537
|
-
<td rowspan="1" colSpan="1" >`string`</td>
|
|
538
|
-
|
|
539
|
-
<td rowspan="1" colSpan="1" >被操作的用户`userID`。</td>
|
|
540
|
-
</tr>
|
|
541
|
-
|
|
542
|
-
<tr>
|
|
543
|
-
<td rowspan="1" colSpan="1" >`success`</td>
|
|
544
|
-
|
|
545
|
-
<td rowspan="1" colSpan="1" >`Function`</td>
|
|
546
|
-
|
|
547
|
-
<td rowspan="1" colSpan="1" >解除静音成功的回调。</td>
|
|
548
|
-
</tr>
|
|
549
|
-
|
|
550
|
-
<tr>
|
|
551
|
-
<td rowspan="1" colSpan="1" >`fail`</td>
|
|
552
|
-
|
|
553
|
-
<td rowspan="1" colSpan="1" >`Function`</td>
|
|
554
|
-
|
|
555
|
-
<td rowspan="1" colSpan="1" >解除静音失败的回调。</td>
|
|
556
|
-
</tr>
|
|
557
|
-
</table>
|
|
558
|
-
|
|
442
|
+
| **参数** | **类型** | **描述** |
|
|
443
|
+
| --- | --- | --- |
|
|
444
|
+
| `liveID` | `string` | 当前语聊房的`liveID`。 |
|
|
445
|
+
| `userID` | `string` | 被操作的用户`userID`。 |
|
|
446
|
+
| `success` | `Function` | 解除静音成功的回调。 |
|
|
447
|
+
| `fail` | `Function` | 解除静音失败的回调。 |
|
|
559
448
|
|
|
560
449
|
### 主播将麦上用户踢下麦位
|
|
561
450
|
|
|
@@ -564,7 +453,6 @@ onMounted(() => {
|
|
|
564
453
|
|
|
565
454
|
2. **监听事件通知**:被踢下麦的用户会收到 `'onKickedOffSeat'` 事件通知。
|
|
566
455
|
|
|
567
|
-
|
|
568
456
|
#### 示例代码:
|
|
569
457
|
``` typescript
|
|
570
458
|
import { onMounted } from 'vue';
|
|
@@ -601,48 +489,12 @@ onMounted(() => {
|
|
|
601
489
|
```
|
|
602
490
|
|
|
603
491
|
#### kickUserOutOfSeat 接口参数:
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
<td rowspan="1" colSpan="1" >**描述**</td>
|
|
611
|
-
</tr>
|
|
612
|
-
|
|
613
|
-
<tr>
|
|
614
|
-
<td rowspan="1" colSpan="1" >`liveID`</td>
|
|
615
|
-
|
|
616
|
-
<td rowspan="1" colSpan="1" >`string`</td>
|
|
617
|
-
|
|
618
|
-
<td rowspan="1" colSpan="1" >当前语聊房的`liveID`。</td>
|
|
619
|
-
</tr>
|
|
620
|
-
|
|
621
|
-
<tr>
|
|
622
|
-
<td rowspan="1" colSpan="1" >`userID`</td>
|
|
623
|
-
|
|
624
|
-
<td rowspan="1" colSpan="1" >`String`</td>
|
|
625
|
-
|
|
626
|
-
<td rowspan="1" colSpan="1" >被踢下麦的用户`userID`。</td>
|
|
627
|
-
</tr>
|
|
628
|
-
|
|
629
|
-
<tr>
|
|
630
|
-
<td rowspan="1" colSpan="1" >`success`</td>
|
|
631
|
-
|
|
632
|
-
<td rowspan="1" colSpan="1" >`Function`</td>
|
|
633
|
-
|
|
634
|
-
<td rowspan="1" colSpan="1" >踢下麦成功的回调。</td>
|
|
635
|
-
</tr>
|
|
636
|
-
|
|
637
|
-
<tr>
|
|
638
|
-
<td rowspan="1" colSpan="1" >`fail`</td>
|
|
639
|
-
|
|
640
|
-
<td rowspan="1" colSpan="1" >`Function`</td>
|
|
641
|
-
|
|
642
|
-
<td rowspan="1" colSpan="1" >踢下麦失败的回调。</td>
|
|
643
|
-
</tr>
|
|
644
|
-
</table>
|
|
645
|
-
|
|
492
|
+
| **参数** | **类型** | **描述** |
|
|
493
|
+
| --- | --- | --- |
|
|
494
|
+
| `liveID` | `string` | 当前语聊房的`liveID`。 |
|
|
495
|
+
| `userID` | `String` | 被踢下麦的用户`userID`。 |
|
|
496
|
+
| `success` | `Function` | 踢下麦成功的回调。 |
|
|
497
|
+
| `fail` | `Function` | 踢下麦失败的回调。 |
|
|
646
498
|
|
|
647
499
|
### 主播锁定和解锁麦位
|
|
648
500
|
|
|
@@ -653,7 +505,6 @@ onMounted(() => {
|
|
|
653
505
|
|
|
654
506
|
2. **解锁麦位**:调用 `unlockSeat` 可以解锁麦位,解锁后该麦位可以再次被占用。
|
|
655
507
|
|
|
656
|
-
|
|
657
508
|
#### 示例代码:
|
|
658
509
|
``` typescript
|
|
659
510
|
import { useLiveSeatState } from "@/uni_modules/tuikit-atomic-x/state/LiveSeatState";
|
|
@@ -661,7 +512,6 @@ import { useLiveSeatState } from "@/uni_modules/tuikit-atomic-x/state/LiveSeatSt
|
|
|
661
512
|
//通过 liveID 获取 LiveSeatState 的实例
|
|
662
513
|
const { lockSeat, unlockSeat } = useLiveSeatState(liveID);
|
|
663
514
|
|
|
664
|
-
|
|
665
515
|
// 锁定2号麦位
|
|
666
516
|
const lock = () => {
|
|
667
517
|
lockSeat({
|
|
@@ -692,92 +542,20 @@ const unlock = () => {
|
|
|
692
542
|
```
|
|
693
543
|
|
|
694
544
|
#### lockSeat 接口参数:
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
<td rowspan="1" colSpan="1" >**描述**</td>
|
|
702
|
-
</tr>
|
|
703
|
-
|
|
704
|
-
<tr>
|
|
705
|
-
<td rowspan="1" colSpan="1" >`liveID`</td>
|
|
706
|
-
|
|
707
|
-
<td rowspan="1" colSpan="1" >`string`</td>
|
|
708
|
-
|
|
709
|
-
<td rowspan="1" colSpan="1" >当前语聊房的`liveID`。</td>
|
|
710
|
-
</tr>
|
|
711
|
-
|
|
712
|
-
<tr>
|
|
713
|
-
<td rowspan="1" colSpan="1" >`seatIndex`</td>
|
|
714
|
-
|
|
715
|
-
<td rowspan="1" colSpan="1" >`number`</td>
|
|
716
|
-
|
|
717
|
-
<td rowspan="1" colSpan="1" >需要锁定的麦位索引。</td>
|
|
718
|
-
</tr>
|
|
719
|
-
|
|
720
|
-
<tr>
|
|
721
|
-
<td rowspan="1" colSpan="1" >`success`</td>
|
|
722
|
-
|
|
723
|
-
<td rowspan="1" colSpan="1" >`Function`</td>
|
|
724
|
-
|
|
725
|
-
<td rowspan="1" colSpan="1" >锁麦成功的回调。</td>
|
|
726
|
-
</tr>
|
|
727
|
-
|
|
728
|
-
<tr>
|
|
729
|
-
<td rowspan="1" colSpan="1" >`fail`</td>
|
|
730
|
-
|
|
731
|
-
<td rowspan="1" colSpan="1" >`Function`</td>
|
|
732
|
-
|
|
733
|
-
<td rowspan="1" colSpan="1" >锁麦失败的回调。</td>
|
|
734
|
-
</tr>
|
|
735
|
-
</table>
|
|
736
|
-
|
|
545
|
+
| **参数** | **类型** | **描述** |
|
|
546
|
+
| --- | --- | --- |
|
|
547
|
+
| `liveID` | `string` | 当前语聊房的`liveID`。 |
|
|
548
|
+
| `seatIndex` | `number` | 需要锁定的麦位索引。 |
|
|
549
|
+
| `success` | `Function` | 锁麦成功的回调。 |
|
|
550
|
+
| `fail` | `Function` | 锁麦失败的回调。 |
|
|
737
551
|
|
|
738
552
|
#### unlockSeat 接口参数:
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
<td rowspan="1" colSpan="1" >**描述**</td>
|
|
746
|
-
</tr>
|
|
747
|
-
|
|
748
|
-
<tr>
|
|
749
|
-
<td rowspan="1" colSpan="1" >`liveID`</td>
|
|
750
|
-
|
|
751
|
-
<td rowspan="1" colSpan="1" >`string`</td>
|
|
752
|
-
|
|
753
|
-
<td rowspan="1" colSpan="1" >当前语聊房的`liveID`。</td>
|
|
754
|
-
</tr>
|
|
755
|
-
|
|
756
|
-
<tr>
|
|
757
|
-
<td rowspan="1" colSpan="1" >`seatIndex`</td>
|
|
758
|
-
|
|
759
|
-
<td rowspan="1" colSpan="1" >`number`</td>
|
|
760
|
-
|
|
761
|
-
<td rowspan="1" colSpan="1" >需要解锁的麦位索引。</td>
|
|
762
|
-
</tr>
|
|
763
|
-
|
|
764
|
-
<tr>
|
|
765
|
-
<td rowspan="1" colSpan="1" >`success`</td>
|
|
766
|
-
|
|
767
|
-
<td rowspan="1" colSpan="1" >`Function`</td>
|
|
768
|
-
|
|
769
|
-
<td rowspan="1" colSpan="1" >解锁麦位成功的回调。</td>
|
|
770
|
-
</tr>
|
|
771
|
-
|
|
772
|
-
<tr>
|
|
773
|
-
<td rowspan="1" colSpan="1" >`fail`</td>
|
|
774
|
-
|
|
775
|
-
<td rowspan="1" colSpan="1" >`Function`</td>
|
|
776
|
-
|
|
777
|
-
<td rowspan="1" colSpan="1" >解锁麦位失败的回调。</td>
|
|
778
|
-
</tr>
|
|
779
|
-
</table>
|
|
780
|
-
|
|
553
|
+
| **参数** | **类型** | **描述** |
|
|
554
|
+
| --- | --- | --- |
|
|
555
|
+
| `liveID` | `string` | 当前语聊房的`liveID`。 |
|
|
556
|
+
| `seatIndex` | `number` | 需要解锁的麦位索引。 |
|
|
557
|
+
| `success` | `Function` | 解锁麦位成功的回调。 |
|
|
558
|
+
| `fail` | `Function` | 解锁麦位失败的回调。 |
|
|
781
559
|
|
|
782
560
|
### 移动麦位
|
|
783
561
|
|
|
@@ -788,7 +566,6 @@ const unlock = () => {
|
|
|
788
566
|
|
|
789
567
|
2. **普通上麦用户移动自己麦位**:普通上麦用户也可以调用此接口来移动自己。此时 `userID` 必须传入用户自己的 ID,`targetIndex` 传入想去的新麦位索引,此时`policy` 参数无效,如果目标麦位有人时会报错并停止移动。
|
|
790
568
|
|
|
791
|
-
|
|
792
569
|
#### 示例代码:
|
|
793
570
|
``` typescript
|
|
794
571
|
import { useLiveSeatState } from "@/uni_modules/tuikit-atomic-x/state/LiveSeatState";
|
|
@@ -813,86 +590,21 @@ const moveSeat = () => {
|
|
|
813
590
|
```
|
|
814
591
|
|
|
815
592
|
#### moveUserToSeat 接口参数:
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
821
|
-
|
|
822
|
-
|
|
823
|
-
</tr>
|
|
824
|
-
|
|
825
|
-
<tr>
|
|
826
|
-
<td rowspan="1" colSpan="1" >`userID`</td>
|
|
827
|
-
|
|
828
|
-
<td rowspan="1" colSpan="1" >`string`</td>
|
|
829
|
-
|
|
830
|
-
<td rowspan="1" colSpan="1" >需要移麦的用户`userID`。</td>
|
|
831
|
-
</tr>
|
|
832
|
-
|
|
833
|
-
<tr>
|
|
834
|
-
<td rowspan="1" colSpan="1" >`targetIndex`</td>
|
|
835
|
-
|
|
836
|
-
<td rowspan="1" colSpan="1" >`number`</td>
|
|
837
|
-
|
|
838
|
-
<td rowspan="1" colSpan="1" >目标麦位索引。</td>
|
|
839
|
-
</tr>
|
|
840
|
-
|
|
841
|
-
<tr>
|
|
842
|
-
<td rowspan="1" colSpan="1" >`policy`</td>
|
|
843
|
-
|
|
844
|
-
<td rowspan="1" colSpan="1" >`string`</td>
|
|
845
|
-
|
|
846
|
-
<td rowspan="1" colSpan="1" >目标麦位有人时的移动策略枚举:<br>- `'ABORT_WHEN_OCCUPIED'`:目标麦位有人时放弃移动(默认策略)<br>- `'FORCE_REPLACE'`:强制替换目标麦位上的用户,被替换的用户将会被踢下麦<br>- `'SWAP_POSITION'`:与目标麦位用户交换位置。</td>
|
|
847
|
-
</tr>
|
|
848
|
-
|
|
849
|
-
<tr>
|
|
850
|
-
<td rowspan="1" colSpan="1" >`success`</td>
|
|
851
|
-
|
|
852
|
-
<td rowspan="1" colSpan="1" >`Function`</td>
|
|
853
|
-
|
|
854
|
-
<td rowspan="1" colSpan="1" >移动麦位成功的回调。</td>
|
|
855
|
-
</tr>
|
|
856
|
-
|
|
857
|
-
<tr>
|
|
858
|
-
<td rowspan="1" colSpan="1" >`fail`</td>
|
|
859
|
-
|
|
860
|
-
<td rowspan="1" colSpan="1" >`Function`</td>
|
|
861
|
-
|
|
862
|
-
<td rowspan="1" colSpan="1" >移动麦位失败的回调。</td>
|
|
863
|
-
</tr>
|
|
864
|
-
</table>
|
|
865
|
-
|
|
593
|
+
| **参数** | **类型** | **描述** |
|
|
594
|
+
| --- | --- | --- |
|
|
595
|
+
| `userID` | `string` | 需要移麦的用户`userID`。 |
|
|
596
|
+
| `targetIndex` | `number` | 目标麦位索引。 |
|
|
597
|
+
| `policy` | `string` | 目标麦位有人时的移动策略枚举:<br>- `'ABORT_WHEN_OCCUPIED'`:目标麦位有人时放弃移动(默认策略)<br>- `'FORCE_REPLACE'`:强制替换目标麦位上的用户,被替换的用户将会被踢下麦<br>- `'SWAP_POSITION'`:与目标麦位用户交换位置。 |
|
|
598
|
+
| `success` | `Function` | 移动麦位成功的回调。 |
|
|
599
|
+
| `fail` | `Function` | 移动麦位失败的回调。 |
|
|
866
600
|
|
|
867
601
|
## API 文档
|
|
868
602
|
|
|
869
|
-
关于 [CoGuestState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-CoGuestState) 和 [LiveSeatState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-LiveSeatState) 及其相关类的所有公开接口、属性和方法的详细信息,请参阅
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
<td rowspan="1" colSpan="1" >**功能描述**</td>
|
|
875
|
-
|
|
876
|
-
<td rowspan="1" colSpan="1" >**API 文档**</td>
|
|
877
|
-
</tr>
|
|
878
|
-
|
|
879
|
-
<tr>
|
|
880
|
-
<td rowspan="1" colSpan="1" >CoGuestState</td>
|
|
881
|
-
|
|
882
|
-
<td rowspan="1" colSpan="1" >观众连麦管理:连麦申请 / 邀请 / 同意 / 拒绝,连麦成员权限控制(麦克风 / 摄像头),状态同步。</td>
|
|
883
|
-
|
|
884
|
-
<td rowspan="1" colSpan="1" >[API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-CoGuestState)</td>
|
|
885
|
-
</tr>
|
|
886
|
-
|
|
887
|
-
<tr>
|
|
888
|
-
<td rowspan="1" colSpan="1" >LiveSeatState</td>
|
|
889
|
-
|
|
890
|
-
<td rowspan="1" colSpan="1" >麦位管理:静音/解除静音,锁定/解锁麦位,踢人下麦、远程控制麦上用户麦克风,麦列表状态监听</td>
|
|
891
|
-
|
|
892
|
-
<td rowspan="1" colSpan="1" >[API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-LiveSeatState)</td>
|
|
893
|
-
</tr>
|
|
894
|
-
</table>
|
|
895
|
-
|
|
603
|
+
关于 [CoGuestState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-CoGuestState) 和 [LiveSeatState](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-LiveSeatState) 及其相关类的所有公开接口、属性和方法的详细信息,请参阅 AtomicXCore 框架的官方 API 文档。本指南使用到的相关 Store 如下:
|
|
604
|
+
| **State** | **功能描述** | **API 文档** |
|
|
605
|
+
| --- | --- | --- |
|
|
606
|
+
| CoGuestState | 观众连麦管理:连麦申请 / 邀请 / 同意 / 拒绝,连麦成员权限控制(麦克风 / 摄像头),状态同步。 | [API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-CoGuestState) |
|
|
607
|
+
| LiveSeatState | 麦位管理:静音/解除静音,锁定/解锁麦位,踢人下麦、远程控制麦上用户麦克风,麦列表状态监听 | [API 文档](https://liteav.sdk.qcloud.com/doc/product/tuikit/atomic-x/uni-app/zh/v1.0/api/index.html#module-LiveSeatState) |
|
|
896
608
|
|
|
897
609
|
## 常见问题
|
|
898
610
|
|
|
@@ -903,7 +615,6 @@ const moveSeat = () => {
|
|
|
903
615
|
|
|
904
616
|
- 语音房(语聊房):核心是麦位网格。您不会使用 `LiveCoreView`,而是会基于 `LiveSeatState` 的数据(特别是 `seatList`)来构建一个网格 UI 。UI 的重点是实时显示每个麦位 `SeatInfo` 的状态:是否有人、是否静音、是否被锁定 ,以及是否正在说话。您只需要打开麦克风。
|
|
905
617
|
|
|
906
|
-
|
|
907
618
|
### 如何在 UI 上实时刷新麦位信息(如是否有人、是否静音)?
|
|
908
619
|
|
|
909
620
|
您应该订阅 `LiveSeatState` 中的 `seatList` 属性,它是一个`[SeatInfo]` 数组类型的响应式数据,每当数组变化时都会通知您重新渲染麦位列表。遍历此数组,您可以:
|
|
@@ -913,7 +624,6 @@ const moveSeat = () => {
|
|
|
913
624
|
|
|
914
625
|
- 通过 `seatInfo.userInfo.microphoneStatus` 判断麦上用户的麦克风状态。
|
|
915
626
|
|
|
916
|
-
|
|
917
627
|
### LiveSeatState 和 DeviceState 都有麦克风接口,它们有何区别?
|
|
918
628
|
|
|
919
629
|
这是一个非常重要的问题。`DeviceState` 管理的是物理设备,而 `LiveSeatState` 管理的是麦位业务(即音频流)。
|
|
@@ -923,14 +633,12 @@ const moveSeat = () => {
|
|
|
923
633
|
|
|
924
634
|
- `closeLocalMicrophone`:停止音频采集并释放麦克风设备。
|
|
925
635
|
|
|
926
|
-
|
|
927
636
|
`LiveSeatState`:
|
|
928
637
|
|
|
929
638
|
- `muteMicrophone`:静音。停止向远端发送本地的音频流,但麦克风设备本身仍在运行。
|
|
930
639
|
|
|
931
640
|
- `unmuteMicrophone`:解除静音。恢复向远端发送音频流。
|
|
932
641
|
|
|
933
|
-
|
|
934
642
|
推荐的工作流程:您应该遵循“设备只开一次,麦上只用静音切换”的原则
|
|
935
643
|
|
|
936
644
|
1. **上麦时**:当观众成功上麦,调用一次 `openLocalMicrophone` 来启动设备。
|
|
@@ -938,7 +646,3 @@ const moveSeat = () => {
|
|
|
938
646
|
2. **在麦上时**:用户在麦位上所有的“开麦”和“闭麦”操作,都应该调用 `unmuteMicrophone` 和 `muteMicrophone` 来控制上行音频流的通断。
|
|
939
647
|
|
|
940
648
|
3. **下麦时**:当用户下麦(例如调用 `disconnect` ),调用 `closeLocalMicrophone` 来释放设备。
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
|
|
944
|
-
|