@tencentcloud/sdk-mcp 1.3.8 → 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/react/faq.md → callkit/faq/web-faq.md} +78 -311
- package/resource/doc/callkit/preset/android/api.md +330 -0
- package/resource/doc/callkit/preset/android/integration.md +530 -0
- 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/chatkit/android/integration.md +498 -0
- 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/core-sdk/live/flutter/live-integration.md +687 -0
- 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/core-sdk/voice/android/voice-audience-list.md +264 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-audio-effect.md +226 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-barrage.md +456 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-co-guest-interaction.md +539 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-gift.md +453 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-host-interaction.md +516 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-integration.md +509 -0
- package/resource/doc/livekit/core-sdk/voice/android/voice-room-list.md +365 -0
- package/resource/doc/livekit/core-sdk/voice/flutter/voice-audience-list.md +259 -0
- package/resource/doc/livekit/core-sdk/voice/flutter/voice-audio-effect.md +596 -0
- package/resource/doc/livekit/core-sdk/voice/flutter/voice-barrage.md +494 -0
- package/resource/doc/livekit/core-sdk/voice/flutter/voice-co-guest-interaction.md +516 -0
- package/resource/doc/livekit/core-sdk/voice/flutter/voice-gift.md +418 -0
- package/resource/doc/livekit/core-sdk/voice/flutter/voice-integration.md +563 -0
- package/resource/doc/livekit/core-sdk/voice/flutter/voice-room-list.md +709 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-audience-list.md +262 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-audio-effect.md +211 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-barrage.md +414 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-co-guest-interaction.md +492 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-gift.md +405 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-host-interaction.md +611 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-integration.md +478 -0
- package/resource/doc/livekit/core-sdk/voice/ios/voice-room-list.md +336 -0
- package/resource/doc/livekit/core-sdk/voice/uni-app/voice-audience-list.md +234 -0
- package/resource/doc/livekit/core-sdk/voice/uni-app/voice-audio-effect.md +218 -0
- package/resource/doc/livekit/core-sdk/voice/uni-app/voice-barrage.md +376 -0
- package/resource/doc/livekit/core-sdk/voice/uni-app/voice-co-guest-interaction.md +648 -0
- package/resource/doc/livekit/core-sdk/voice/uni-app/voice-gift.md +362 -0
- package/resource/doc/livekit/core-sdk/voice/uni-app/voice-integration.md +323 -0
- package/resource/doc/livekit/core-sdk/voice/uni-app/voice-room-list.md +470 -0
- 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 +118 -282
- 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 -18
- 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 -19
- 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 -30
- 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 -59
- 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/integration.md +0 -612
- package/resource/doc/chatuikit/android/workflow.md +0 -0
- 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/live-integration.md +0 -1029
- 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/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 -487
- package/resource/doc/tuicallkit/android/integration.md +0 -302
- package/resource/doc/tuicallkit/android/workflow.md +0 -0
- 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/vue/api.md +0 -1512
- package/resource/doc/tuicallkit/vue/faq.md +0 -986
- 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/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 -50
- package/tools/definitions/get_native_live_uikit_integration_def.js.map +0 -1
- package/tools/definitions/get_native_live_uikit_interaction_def.js +0 -115
- 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 -95
- package/tools/definitions/get_web_room_feature_detail_def.js.map +0 -1
- package/tools/definitions/record_prompt_def.js +0 -53
- package/tools/definitions/record_prompt_def.js.map +0 -1
- package/tools/definitions/record_result_def.js +0 -30
- package/tools/definitions/record_result_def.js.map +0 -1
- package/tools/live/get-native-live-uikit-integration.js +0 -101
- 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 -101
- 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
|
@@ -0,0 +1,405 @@
|
|
|
1
|
+
TUIRoomKit 是腾讯云提供的一站式多人音视频房间解决方案,集成了完整的 UI 组件和核心功能。通过本文档,开发者可以快速了解如何将 TUIRoomKit 集成到项目中,实现多人音视频房间功能。本文还将详细介绍如何快速替换图片资源、本地化文案等个性化配置,帮助开发者打造符合品牌特色的音视频应用。
|
|
2
|
+
| 房间准备页 | 标准房间主页 | 大型研讨会房间主页 | 成员管理 |
|
|
3
|
+
| --- | --- | --- | --- |
|
|
4
|
+
| | | | |
|
|
5
|
+
|
|
6
|
+
## 前提条件
|
|
7
|
+
|
|
8
|
+
### 开通服务
|
|
9
|
+
|
|
10
|
+
请参考 开通服务 领取 TUIRoomKit 体验版,并在 [应用管理](https://console.cloud.tencent.com/trtc) 页面获取以下信息:
|
|
11
|
+
- **SDKAppID**:应用标识(必填),腾讯云基于 SDKAppID 完成计费统计。
|
|
12
|
+
|
|
13
|
+
- **SDKSecretKey**:应用密钥,用于初始化配置文件的密钥信息。
|
|
14
|
+
|
|
15
|
+
### 环境准备
|
|
16
|
+
| 平台 | 版本 |
|
|
17
|
+
| --- | --- |
|
|
18
|
+
| Flutter | 3.29.3 及以上版本。 |
|
|
19
|
+
| Android | 最低兼容 Android 5.0 (SDK API Level 21)及以上版本。 |
|
|
20
|
+
| iOS | iOS 14.0 及更高。 |
|
|
21
|
+
|
|
22
|
+
## 快速接入
|
|
23
|
+
|
|
24
|
+
### 步骤1:集成 TUIRoomKit 组件
|
|
25
|
+
|
|
26
|
+
在您的工程 `pubspec.yaml` 文件中,添加 [tencent_conference_uikit](https://pub.dev/packages/tencent_conference_uikit)插件依赖。
|
|
27
|
+
``` yaml
|
|
28
|
+
dependencies:
|
|
29
|
+
tencent_conference_uikit: 最新版本
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
执行以下命令安装组件:
|
|
33
|
+
``` plaintext
|
|
34
|
+
flutter pub get
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### 步骤2:工程配置
|
|
38
|
+
- 使用 **Xcode **打开您的工程,选择**项目 **> **Build Settings **> **Deployment**,将其下的 **Strip Style** 设置为 `Non-Global Symbols`,以保留所需要的全局符号信息。
|
|
39
|
+
|
|
40
|
+
- 若您需要在 **iOS **端使用音视频功能,需要授权麦克风和摄像头的使用权限(`Android`端已在 SDK 中声明相关权限,您无需手动进行相关配置)。
|
|
41
|
+
|
|
42
|
+
在您 App 的`Info.plist`(路径:`ios/Runner/Info.plist`)中添加以下两项,分别对应麦克风和摄像头在系统弹出授权对话框时的提示信息。
|
|
43
|
+
|
|
44
|
+
``` xml
|
|
45
|
+
<key>NSCameraUsageDescription</key>
|
|
46
|
+
<string>TUIRoomKit 需要访问您的相机权限</string>
|
|
47
|
+
<key>NSMicrophoneUsageDescription</key>
|
|
48
|
+
<string>TUIRoomKit 需要访问您的麦克风权限</string>
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
完成以上添加后,在您的 **ios/Podfile **中添加以下预处理器定义,用于启用相机与麦克风权限。
|
|
52
|
+
|
|
53
|
+
``` ruby
|
|
54
|
+
post_install do |installer|
|
|
55
|
+
installer.pods_project.targets.each do |target|
|
|
56
|
+
flutter_additional_ios_build_settings(target)
|
|
57
|
+
target.build_configurations.each do |config|
|
|
58
|
+
config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= [
|
|
59
|
+
'$(inherited)',
|
|
60
|
+
'PERMISSION_MICROPHONE=1',
|
|
61
|
+
'PERMISSION_CAMERA=1',
|
|
62
|
+
]
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### 步骤3:配置页面导航和多语言功能
|
|
69
|
+
|
|
70
|
+
为了确保 TUIRoomKit 能够正常管理页面导航和显示多语言界面,需要在 Flutter 应用框架中进行以下配置:
|
|
71
|
+
- 在 `navigatorObservers` 中添加 `RoomNavigatorObserver.instance`,用于监听页面路由变化和管理组件生命周期。
|
|
72
|
+
|
|
73
|
+
- 在 `localizationsDelegates` 中添加相关本地化代理,确保界面文案能够根据系统语言正确显示。
|
|
74
|
+
|
|
75
|
+
- 使用 `ComponentTheme` 包裹在 `MaterialApp` 外层,确保所有 RoomKit 组件都能访问主题配置。
|
|
76
|
+
|
|
77
|
+
以 MaterialApp 框架为例,示例代码如下:
|
|
78
|
+
|
|
79
|
+
``` java
|
|
80
|
+
import 'package:tencent_conference_uikit/tencent_conference_uikit.dart';
|
|
81
|
+
|
|
82
|
+
// 您自己的APP主类
|
|
83
|
+
class XXX extends StatelessWidget {
|
|
84
|
+
const XXX({super.key});
|
|
85
|
+
|
|
86
|
+
@override
|
|
87
|
+
Widget build(BuildContext context) {
|
|
88
|
+
return ComponentTheme( // 使用 ComponentTheme 包裹在 MaterialApp 外层,确保所有 RoomKit 组件都能访问主题配置。
|
|
89
|
+
child: MaterialApp(
|
|
90
|
+
// 添加 RoomKit 导航观察者,用于监听页面路由变化和生命周期管理
|
|
91
|
+
navigatorObservers: [RoomNavigatorObserver.instance],
|
|
92
|
+
// 添加本地化代理,支持多语言文案显示
|
|
93
|
+
localizationsDelegates: [
|
|
94
|
+
...RoomLocalizations.localizationsDelegates,
|
|
95
|
+
...BarrageLocalizations.localizationsDelegates,
|
|
96
|
+
],
|
|
97
|
+
supportedLocales: const [Locale('en'), Locale('zh')],
|
|
98
|
+
// 您APP的其他配置
|
|
99
|
+
......
|
|
100
|
+
),
|
|
101
|
+
);
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
配置后,组件将支持多语言并能正确处理页面跳转。
|
|
107
|
+
|
|
108
|
+
### 步骤4:登录
|
|
109
|
+
|
|
110
|
+
代码集成完成后,需要完成登录操作,这是**使用 TUIRoomKit 的关键步骤**。只有在登录成功后,才能正常使用 TUIRoomKit 的各项功能,因此请仔细检查相关参数配置是否正确:
|
|
111
|
+
|
|
112
|
+
> **说明:**
|
|
113
|
+
>
|
|
114
|
+
|
|
115
|
+
> 在示例代码中,直接进行了登录接口的调用。但在实际项目场景下,强烈推荐**您在完成自己的用户身份验证等相关登录操作后,再调用 TUIRoomKit 的登录服务**。这样可以避免因过早调用登录服务,导致业务逻辑混乱或数据不一致的问题,同时也能更好地适配您项目中现有的用户管理和权限控制体系。
|
|
116
|
+
>
|
|
117
|
+
|
|
118
|
+
【Dart】
|
|
119
|
+
``` java
|
|
120
|
+
import 'package:atomic_x_core/atomicxcore.dart'; // TUIRoomKit内部有对atomic_x_core的依赖,这里直接import即可。
|
|
121
|
+
|
|
122
|
+
var loginResult = await LoginStore.shared.login(
|
|
123
|
+
sdkAppID: 1400000001, // 替换为您的 SDKAPPID
|
|
124
|
+
userID: 'userID', // 替换为您的 UserID
|
|
125
|
+
userSig: 'userSig', // 替换为您的 UserSig
|
|
126
|
+
);
|
|
127
|
+
|
|
128
|
+
if (loginResult.isSuccess) {
|
|
129
|
+
// login success
|
|
130
|
+
} else {
|
|
131
|
+
// login error
|
|
132
|
+
}
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
**登录接口参数说明:**
|
|
136
|
+
| 参数 | 类型 | 说明 |
|
|
137
|
+
| --- | --- | --- |
|
|
138
|
+
| `sdkAppID` | `int` | 从 [控制台](https://console.cloud.tencent.com/trtc) 获取,通常是以 `140` 或 `160` 开头的 10 位整数。 |
|
|
139
|
+
| `userID` | `String` | 当前用户的唯一 ID,仅包含英文字母、数字、连字符和下划线。为避免多端登录冲突,**请勿使用**`1`、`123`**等简单 ID**。 |
|
|
140
|
+
| `userSig` | `String` | 用于腾讯云鉴权的票据。更多信息请参见 如何计算及使用 UserSig。<br>【注意事项】<br>- 开发环境:可以采用本地 `GenerateTestUserSig.genTestSig` 函数生成 userSig 或者通过 [UserSig 辅助工具](https://console.cloud.tencent.com/im/tool-usersig) 生成临时的 userSig。<br>- 生产环境:为了防止密钥泄露,请务必采用服务端生成 userSig 的方式。详细信息请参考 服务端生成 UserSig。 |
|
|
141
|
+
|
|
142
|
+
### 步骤5:设置头像和昵称
|
|
143
|
+
|
|
144
|
+
首次登录的用户没有头像和昵称信息,需要通过 `LoginStore` 的 `setSelfInfo` 接口设置个人信息:
|
|
145
|
+
``` java
|
|
146
|
+
import 'package:atomic_x_core/atomicxcore.dart';
|
|
147
|
+
|
|
148
|
+
final result = await LoginStore.shared.setSelfInfo(
|
|
149
|
+
userInfo: UserProfile(userID: 'userID', nickname: 'userName', avatarURL: 'avatarURL'),
|
|
150
|
+
);
|
|
151
|
+
|
|
152
|
+
if (result.isSuccess) {
|
|
153
|
+
debugPrint("setSelfInfo success");
|
|
154
|
+
} else {
|
|
155
|
+
debugPrint("setSelfInfo failed code:${result.errorCode}, message:${result.errorMessage}");
|
|
156
|
+
}
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
**setSelfInfo接口参数/返回值说明:**
|
|
160
|
+
| 参数/返回值 | 类型 | 说明 |
|
|
161
|
+
| --- | --- | --- |
|
|
162
|
+
| `userProfile` | `UserProfile` | 个人用户信息核心模型,包含:<br>- userID:要设置用户信息的用户 ID。<br>- nickname:昵称信息。<br>- avatarURL:头像链接。 |
|
|
163
|
+
| 返回值 | `Future<CompletionHandler>` | 设置个人信息接口的结果回调。若失败会返回错误码和错误信息。 |
|
|
164
|
+
|
|
165
|
+
### 步骤6:创建房间
|
|
166
|
+
|
|
167
|
+
在 `TUIRoomKit` 组件中,`RoomMainWidget` 是集成了完整的多人音视频房间功能的核心界面,以下将向开发者演示如何以房主身份将 `RoomMainWidget` 嵌入到应用中。
|
|
168
|
+
|
|
169
|
+
#### **实现方式:**
|
|
170
|
+
1. **构造进房的配置项**:进入房间后是否需要自动打开音视频设备的配置项。
|
|
171
|
+
|
|
172
|
+
2. **配置房间创建选项**:配置房间名称等信息。
|
|
173
|
+
|
|
174
|
+
3. **初始化房间主页面**:通过房主身份初始化房间主页面。
|
|
175
|
+
|
|
176
|
+
4. **导航到房间页面**:将 `RoomMainWidget` 推入导航栈。
|
|
177
|
+
|
|
178
|
+
> **说明:**
|
|
179
|
+
>
|
|
180
|
+
|
|
181
|
+
> 移动端仅支持创建标准房间,如您需要创建大型研讨会房间,请参考 Web 快速接入 使用Web端创建。
|
|
182
|
+
>
|
|
183
|
+
|
|
184
|
+
#### **示例代码:**
|
|
185
|
+
``` java
|
|
186
|
+
import 'package:tencent_conference_uikit/tencent_conference_uikit.dart';
|
|
187
|
+
|
|
188
|
+
// YourMainPage 代表您加载房间主页面的页面
|
|
189
|
+
class YourMainPage extends StatelessWidget {
|
|
190
|
+
const YourMainPage({super.key});
|
|
191
|
+
|
|
192
|
+
@override
|
|
193
|
+
Widget build(BuildContext context) {
|
|
194
|
+
return Scaffold(
|
|
195
|
+
body: Center(
|
|
196
|
+
child: ElevatedButton(
|
|
197
|
+
onPressed: () => _createRoom(context),
|
|
198
|
+
child: const Text('创建房间'),
|
|
199
|
+
),
|
|
200
|
+
),
|
|
201
|
+
);
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
void _createRoom(BuildContext context) {
|
|
205
|
+
// 1. 构造进房的配置项
|
|
206
|
+
const config = ConnectConfig(
|
|
207
|
+
autoEnableCamera: true, // 进房后是否自动开启摄像头
|
|
208
|
+
autoEnableMicrophone: true, // 进房后是否自动开启麦克风
|
|
209
|
+
autoEnableSpeaker: true, // 进房后是否自动开启扬声器
|
|
210
|
+
);
|
|
211
|
+
|
|
212
|
+
// 2. 配置房间创建选项
|
|
213
|
+
final options = CreateRoomOptions(
|
|
214
|
+
roomName: 'roomName', // 房间名称
|
|
215
|
+
);
|
|
216
|
+
|
|
217
|
+
// 3. 初始化房间主页面
|
|
218
|
+
final behavior = RoomBehavior.create(options);
|
|
219
|
+
|
|
220
|
+
// 4. 导航到房间页面
|
|
221
|
+
Navigator.of(context).push(
|
|
222
|
+
MaterialPageRoute(
|
|
223
|
+
builder: (context) => RoomMainWidget(
|
|
224
|
+
roomID: 'roomID',
|
|
225
|
+
behavior: behavior,
|
|
226
|
+
config: config,
|
|
227
|
+
),
|
|
228
|
+
),
|
|
229
|
+
);
|
|
230
|
+
}
|
|
231
|
+
}
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
**RoomMainWidget 构造函数参数详细说明:**
|
|
235
|
+
| 参数 | 类型 | 说明 |
|
|
236
|
+
| --- | --- | --- |
|
|
237
|
+
| `roomID` | `String` | - 字符串类型的房间唯一标识符。<br>- 限制长度为 0-48 字节。<br>- 建议仅包含数字、英文字母(区分大小写)、下划线(_)和连字符(-)。避免使用空格和中文字符。 |
|
|
238
|
+
| `behavior` | `RoomBehavior` | - 房间主页面初始化来源。<br>- 参数含义:<br>- create: 房主身份创建房间,此方式需要构造创建房间配置项,关于CreateRoomOptions的详细用法请参考:CreateRoomOptions 结构体详细说明。<br>- enter:参与者身份加入房间。 |
|
|
239
|
+
| `config` | `ConnectConfig` | 进房后音视频设备控制的配置项。 |
|
|
240
|
+
|
|
241
|
+
**ConnectConfig 参数详细说明****:**
|
|
242
|
+
| 参数 | 类型 | 说明 |
|
|
243
|
+
| --- | --- | --- |
|
|
244
|
+
| autoEnableMicrophone | `bool` | - 进房后是否自动开启麦克风。<br>- 参数含义:<br>- true: 自动开启 (默认值)。<br>- false: 不自动开启。 |
|
|
245
|
+
| autoEnableCamera | `bool` | - 进房后是否自动开启摄像头。<br>- 参数含义:<br>- true: 自动开启 (默认值)。<br>- false: 不自动开启。 |
|
|
246
|
+
| autoEnableSpeaker | `bool` | - 进房后是否自动开启扬声器。<br>- 参数含义:<br>- true: 自动开启 (默认值)。<br>- false: 不自动开启。 |
|
|
247
|
+
|
|
248
|
+
### 步骤7:加入房间
|
|
249
|
+
|
|
250
|
+
以下示例将向开发者演示如何以参与者身份将`RoomMainWidget`嵌入到应用中。
|
|
251
|
+
|
|
252
|
+
#### **实现方式:**
|
|
253
|
+
1. **构造进房的配置项**:进入房间后是否需要自动打开音视频设备的配置项。
|
|
254
|
+
|
|
255
|
+
2. **初始化房间主页面**:通过参与者身份初始化房间主页面。
|
|
256
|
+
|
|
257
|
+
3. **导航到房间页面**:将 `RoomMainWidget` 推入导航栈。
|
|
258
|
+
|
|
259
|
+
#### 代码示例:
|
|
260
|
+
``` java
|
|
261
|
+
import 'package:tencent_conference_uikit/tencent_conference_uikit.dart';
|
|
262
|
+
|
|
263
|
+
// YourMainPage 代表您加载房间主页面的页面
|
|
264
|
+
class YourMainPage extends StatelessWidget {
|
|
265
|
+
const YourMainPage({super.key});
|
|
266
|
+
|
|
267
|
+
@override
|
|
268
|
+
Widget build(BuildContext context) {
|
|
269
|
+
return Scaffold(
|
|
270
|
+
body: Center(
|
|
271
|
+
child: ElevatedButton(
|
|
272
|
+
onPressed: () => _enterRoom(context),
|
|
273
|
+
child: const Text('加入房间'),
|
|
274
|
+
),
|
|
275
|
+
),
|
|
276
|
+
);
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
void _enterRoom(BuildContext context) {
|
|
280
|
+
// 1. 构造进房的配置项
|
|
281
|
+
const config = ConnectConfig(
|
|
282
|
+
autoEnableCamera: true, // 进房后是否自动开启摄像头
|
|
283
|
+
autoEnableMicrophone: true, // 进房后是否自动开启麦克风
|
|
284
|
+
autoEnableSpeaker: true, // 进房后是否自动开启扬声器
|
|
285
|
+
);
|
|
286
|
+
|
|
287
|
+
// 2. 初始化房间主页面
|
|
288
|
+
const behavior = RoomBehavior.enter();
|
|
289
|
+
|
|
290
|
+
// 3. 导航到房间页面
|
|
291
|
+
Navigator.of(context).push(
|
|
292
|
+
MaterialPageRoute(
|
|
293
|
+
builder: (context) => RoomMainWidget(
|
|
294
|
+
roomID: 'roomID',
|
|
295
|
+
behavior: behavior,
|
|
296
|
+
config: config,
|
|
297
|
+
),
|
|
298
|
+
),
|
|
299
|
+
);
|
|
300
|
+
}
|
|
301
|
+
}
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
**参数详细说明请参考:**
|
|
305
|
+
|
|
306
|
+
[RoomMainWidget 构造函数参数详细说明]( 构造函数参数详细说明)和 [ConnectConfig 参数详细说明]( 参数详细说明)
|
|
307
|
+
|
|
308
|
+
> **说明:**
|
|
309
|
+
>
|
|
310
|
+
|
|
311
|
+
> 使用TUIRoomKit组件进入大型研讨会房间时,需确保Web端创建的研讨会房间的房间ID以 `webinar_` 开头。
|
|
312
|
+
>
|
|
313
|
+
|
|
314
|
+
## 核心功能
|
|
315
|
+
|
|
316
|
+
接入`RoomMainWidget`代码后,开发者将得到一个完整的多人音视频页面,内部包含成员管理,音视频设备控制,房间信息展示等功能,这是 `TUIRoomKit` 组件的核心。
|
|
317
|
+
| 标准房间 | 大型研讨会房间 |
|
|
318
|
+
| --- | --- |
|
|
319
|
+
| | |
|
|
320
|
+
|
|
321
|
+
## 界面定制
|
|
322
|
+
|
|
323
|
+
> **注意:**
|
|
324
|
+
>
|
|
325
|
+
|
|
326
|
+
> 界面定制、图标定制、文案定制这部分章节内容,涉及到需要修改 TUIRoomKit 组件源码,通过 pub 依赖管理器集成 TUIRoomKit 为"不可变"的依赖项。每次执行 flutter pub get 时,Flutter 会:
|
|
327
|
+
>
|
|
328
|
+
> 1. 检查 pubspec.lock 中记录的版本号。
|
|
329
|
+
> 2. 从远程仓库重新下载对应版本的源码。
|
|
330
|
+
> 3. 用下载的原始代码覆盖 .pub-cache/ 目录下的现有文件。
|
|
331
|
+
|
|
332
|
+
> **因此,任何对缓存目录的手动修改都只是临时性的,下次执行安装命令时即被还原。**
|
|
333
|
+
>
|
|
334
|
+
|
|
335
|
+
>
|
|
336
|
+
>
|
|
337
|
+
|
|
338
|
+
> **推荐解决方案:**
|
|
339
|
+
>
|
|
340
|
+
> 1. Fork [TUIKit_Flutter](https://github.com/Tencent-RTC/TUIKit_Flutter/tree/main) 的官方仓库。
|
|
341
|
+
> 2. 在 fork 的仓库中修改并提交。
|
|
342
|
+
> 3. 修改 pubspec.yaml ,指向**自定义仓库和分支。**
|
|
343
|
+
> `dependencies:`
|
|
344
|
+
> ` tencent_conference_uikit:`
|
|
345
|
+
> ` git:`
|
|
346
|
+
> ` url: https://github.com/your-username/TUIKit_Flutter.git`
|
|
347
|
+
> ` ref: your-branch`
|
|
348
|
+
> ` path: room`
|
|
349
|
+
|
|
350
|
+
`RoomMainWidget`房间主页面内功能丰富,可定制化度高,开发者可以根据实际产品需求,对 UI 进行定制化修改,以适配业务交互场景。以下将详细为开发者展示`RoomMainWidget`页面中视图组件,便于开发者快速修改。
|
|
351
|
+
| 标准房间 | 大型研讨会房间 |
|
|
352
|
+
| --- | --- |
|
|
353
|
+
| | |
|
|
354
|
+
|
|
355
|
+
`RoomMainWidget`**中组件详细说明**
|
|
356
|
+
| 组件 | 功能描述 | 定制化建议 |
|
|
357
|
+
| --- | --- | --- |
|
|
358
|
+
| [RoomMainWidget](https://github.com/Tencent-RTC/TUIKit_Flutter/blob/main/room/lib/widget/room_main_widget.dart) | 房间主视图容器,负责协调各子组件的布局与数据流转。 | 可调整整体背景、安全区域适配、组件显隐逻辑。 |
|
|
359
|
+
| [RoomTopBarWidget](https://github.com/Tencent-RTC/TUIKit_Flutter/blob/main/room/lib/widget/main/room_top_bar_widget.dart) | 顶部导航栏,包含房间信息、摄像头和声音控制、退出房间功能入口。 | 可替换图标、调整背景透明度、添加自定义按钮(如录制、 窗口化)。 |
|
|
360
|
+
| [RoomWidget](https://github.com/Tencent-RTC/TUIKit_Flutter/blob/main/room/lib/widget/main/room_widget.dart) | 视频流展示区域,采用瀑布流布局管理多个用户视频画面。 | 可修改布局算法(行列数、间距)、分页指示器样式、空状态视图。 |
|
|
361
|
+
| [ParticipantVideoItemWidget](https://github.com/Tencent-RTC/TUIKit_Flutter/blob/main/room/lib/widget/main/room_widget/participant_video_item_widget.dart) | 单个视频流单元格,承载用户视频画面与基本信息。 | 可自定义视频渲染层、用户信息面板(头像、徽章)、互动控件(语音波形)。 |
|
|
362
|
+
| [RoomBottomBarWidget](https://github.com/Tencent-RTC/TUIKit_Flutter/blob/main/room/lib/widget/main/room_bottom_bar_widget.dart) | 底部工具栏,集成麦克风、摄像头、成员管理操作按钮。 | 可重新排列按钮顺序、修改按钮样式(颜色、尺寸)、添加业务相关功能(如屏幕分享、会中呼叫、美颜)。 |
|
|
363
|
+
|
|
364
|
+
## 图标定制
|
|
365
|
+
|
|
366
|
+
接入 TUIRoomKit 组件后,开发者可以根据实际 UI 交互需求直接替换组件下的图标资源,以适配开发者的业务场景。
|
|
367
|
+
|
|
368
|
+
TUIRoomKit 使用 `assets/images/` 目录管理 UI 所需的图片资源,您可以直接替换该目录下的图片文件来自定义界面所需的图标。
|
|
369
|
+
|
|
370
|
+
**常用的图片文件列表**
|
|
371
|
+
| 图标 | 文件名 | 说明 |
|
|
372
|
+
| --- | --- | --- |
|
|
373
|
+
| | room_camera_off.png | 摄像头关闭图标 |
|
|
374
|
+
| | room_camera_on.png | 摄像头开启图标 |
|
|
375
|
+
| | room_mic_off.png | 麦克风关闭图标 |
|
|
376
|
+
| | room_mic_on_empty.png | 麦克风开启图标 |
|
|
377
|
+
| | room_administrator_icon.png | 管理员身份标识图标 |
|
|
378
|
+
| | room_owner_icon.png | 房主身份标识图标 |
|
|
379
|
+
|
|
380
|
+
## 文案定制
|
|
381
|
+
|
|
382
|
+
TUIRoomKit 使用 Flutter 标准的 ARB 文件来管理 UI 所需的文案显示,您可以直接修改 `lib/base/language/i10n/` 目录下的语言文件来调整需要的文案:
|
|
383
|
+
|
|
384
|
+
## 常见问题
|
|
385
|
+
|
|
386
|
+
### 每次进房都需要调用登录吗?
|
|
387
|
+
|
|
388
|
+
不需要。通常您只需要完成一次 `LoginStore.shared.login` 调用即可,我们建议您将 `LoginStore.shared.login` 和
|
|
389
|
+
|
|
390
|
+
`LoginStore.shared.logout` 与自己的登录业务关联。
|
|
391
|
+
|
|
392
|
+
### iOS在release下运行/打包后无法进房?
|
|
393
|
+
|
|
394
|
+
使用 Xcode 打开您的工程,选择项目 > Build Settings > Deployment,将其下的 Strip Style 设置为 `Non-Global Symbols`,以保留所需要的全局符号信息。
|
|
395
|
+
|
|
396
|
+
### pubspec.yaml文件有没有示例配置可以参考?
|
|
397
|
+
|
|
398
|
+
您可以参考 [GitHub TUIKit_Flutter Example](https://github.com/Tencent-RTC/TUIKit_Flutter/tree/main/application) 工程 `pubspec.yaml` 示例文件。
|
|
399
|
+
|
|
400
|
+
### 进房后无画面?
|
|
401
|
+
|
|
402
|
+
请前往**手机设置** > **App >****相机**,检查摄像头权限是否开启,可参考如下示例:
|
|
403
|
+
| iOS | Android |
|
|
404
|
+
| --- | --- |
|
|
405
|
+
| | |
|
|
@@ -0,0 +1,226 @@
|
|
|
1
|
+
`RoomStore` 是 `AtomicXCore` 中专职房间事务管理的模块,深度集成了会中呼叫能力。本章节旨在指导如何利用 `RoomStore` 高效完成会中呼叫相关功能的开发与接入。
|
|
2
|
+
|
|
3
|
+
## 核心功能
|
|
4
|
+
- **会中呼叫**:房间内任意参与者均可呼叫房间外任意成员加入房间。
|
|
5
|
+
|
|
6
|
+
- **获取会中呼叫用户列表**:可以获取指定房间的会中呼叫的用户列表。
|
|
7
|
+
|
|
8
|
+
## 核心概念
|
|
9
|
+
|
|
10
|
+
在开始集成之前,需要通过下表了解一下`RoomStore`中与会中呼叫相关的几个核心概念:
|
|
11
|
+
| **核心概念** | **类型** | **核心职责与描述** |
|
|
12
|
+
| --- | --- | --- |
|
|
13
|
+
| [RoomCallStatus](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomcallstatus) | `enum` | 代表会中呼叫的状态,包含:<br>- `none`(默认态)。<br>- `calling`(呼叫中)。<br>- `timeout`(呼叫超时)。<br>- `rejected`(呼叫被拒绝)。 |
|
|
14
|
+
| [RoomCallResult](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomcallresult) | `enum` | 代表会中呼叫的结果,包含:<br>- `success`(呼叫成功)。<br>- `alreadyInCalling`(已在呼叫中)。<br>- `alreadyInRoom`(已在房间中)。 |
|
|
15
|
+
| [CallRejectionReason](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/callrejectionreason) | `enum` | 代表呼叫被拒绝的原因,目前仅支持:<br>- `rejected`(主动拒绝)。<br>- `inOtherRoom`(在其他房间中)。 |
|
|
16
|
+
| [RoomCall](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomcall) | `struct` | 代表会中呼叫业务的核心数据结构。负责存储呼叫者信息、被呼叫者信息、以及当前呼叫状态。 |
|
|
17
|
+
| [RoomEvent](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent) | `enum` | 代表房间动态的实时事件。其中包含会中呼叫相关的事件。 |
|
|
18
|
+
| [RoomStore](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomstore) | `class` | 这是与房间全生命周期相关的核心类。功能包含:发起会中呼叫,响应会中呼叫,获取房间的会中呼叫列表,并通过订阅其 `roomEventPublisher` 来接收与会中呼叫相关的实时动态事件。 |
|
|
19
|
+
|
|
20
|
+
## 实现步骤
|
|
21
|
+
|
|
22
|
+
### 步骤1:组件集成
|
|
23
|
+
|
|
24
|
+
请参考 接入概览 集成 **AtomicXCore SDK**,并已完成 实现登录逻辑 部分接入。
|
|
25
|
+
|
|
26
|
+
### 步骤2:呼叫方功能
|
|
27
|
+
|
|
28
|
+
#### **1. 发起呼叫**
|
|
29
|
+
|
|
30
|
+
作为呼叫方调用`RoomStore`的`callUserToRoom`接口,可以批量呼叫用户进房。
|
|
31
|
+
``` swift
|
|
32
|
+
import Foundation
|
|
33
|
+
import AtomicXCore
|
|
34
|
+
|
|
35
|
+
// 发起呼叫
|
|
36
|
+
func callUserToRoom(userIDList: [String], timeout: Int = 30, extensionInfo: String? = nil) {
|
|
37
|
+
RoomStore.shared.callUserToRoom(roomID: "roomID", userIDList: userIDList, timeout: timeout, extensionInfo: extensionInfo) { result in
|
|
38
|
+
switch result {
|
|
39
|
+
case .success(let callResults):
|
|
40
|
+
print("呼叫用户请求发送成功")
|
|
41
|
+
case .failure(let error):
|
|
42
|
+
print("呼叫用户失败: [错误码: \(error.code)]: \(error.message)")
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
#### **2. 取消呼叫**
|
|
49
|
+
|
|
50
|
+
作为呼叫方调用`RoomStore`的`cancelCall`接口,可以批量取消正在呼叫申请。
|
|
51
|
+
``` swift
|
|
52
|
+
import Foundation
|
|
53
|
+
import AtomicXCore
|
|
54
|
+
|
|
55
|
+
// 取消呼叫
|
|
56
|
+
func cancelCall(userIDList: [String]) {
|
|
57
|
+
RoomStore.shared.cancelCall(roomID: "roomID", userIDList: userIDList) { result in
|
|
58
|
+
switch result {
|
|
59
|
+
case .success():
|
|
60
|
+
print("取消呼叫成功")
|
|
61
|
+
case .failure(let error):
|
|
62
|
+
print("取消呼叫失败: [错误码: \(error.code)]: \(error.message)")
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
#### **3. 获取呼叫列表信息**
|
|
69
|
+
|
|
70
|
+
进入房间后,调用`RoomStore`的`getPendingCalls`接口,可以分页查询当前房间正在呼叫的用户列表信息。
|
|
71
|
+
``` swift
|
|
72
|
+
import Foundation
|
|
73
|
+
import AtomicXCore
|
|
74
|
+
|
|
75
|
+
// 获取待处理的呼叫列表
|
|
76
|
+
func getPendingCalls(roomID: String, cursor: String?) {
|
|
77
|
+
// cursor 为分页游标,首次调用时传入 null,获取第一页数据, 后续调用时传入上次返回的 nextCursor 值。
|
|
78
|
+
RoomStore.shared.getPendingCalls(roomID: roomID, cursor: cursor) { result in
|
|
79
|
+
switch result {
|
|
80
|
+
case .success(let callInfo):
|
|
81
|
+
print("获取呼叫列表成功,列表信息: \(callInfo.0), 分页游标: \(callInfo.1)")
|
|
82
|
+
case .failure(let error):
|
|
83
|
+
print("获取呼叫列表失败: [错误码: \(error.code)]: \(error.message)")
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
#### **4. 订阅会中呼叫事件**
|
|
90
|
+
|
|
91
|
+
作为呼叫方订阅 `RoomStore` 的 `roomEventPublisher` 能够实时获取呼叫的生命周期事件。通过监听以下回调,可以精准捕捉呼叫的最终结果并据此更新 UI 状态或执行后续业务逻辑。
|
|
92
|
+
``` swift
|
|
93
|
+
import Combine
|
|
94
|
+
import AtomicXCore
|
|
95
|
+
import Foundation
|
|
96
|
+
|
|
97
|
+
private var cancellableSet = Set<AnyCancellable>()
|
|
98
|
+
|
|
99
|
+
/// 订阅会中呼叫相关事件
|
|
100
|
+
private func subscribeRoomCallEvents() {
|
|
101
|
+
RoomStore.shared.roomEventPublisher
|
|
102
|
+
.receive(on: DispatchQueue.main)
|
|
103
|
+
.sink { event in
|
|
104
|
+
switch event {
|
|
105
|
+
case .onCallTimeout(let roomInfo, let call):
|
|
106
|
+
print("呼叫超时 房间信息: \(roomInfo), 呼叫者: \(call.caller)")
|
|
107
|
+
case .onCallAccepted(let roomInfo, let call):
|
|
108
|
+
print("呼叫已被接受 房间信息: \(roomInfo), 被呼叫者: \(call.callee)")
|
|
109
|
+
case .onCallRejected(let roomInfo, let call, let reason):
|
|
110
|
+
print("呼叫被拒绝 房间信息: \(roomInfo), 被呼叫者: \(call.callee), 拒绝原因: \(reason)")
|
|
111
|
+
case .onCallHandledByOtherDevice(let roomInfo, let isAccepted):
|
|
112
|
+
print("呼叫已被其他设备处理 房间信息: \(roomInfo) 处理结果: \(isAccepted)")
|
|
113
|
+
default:
|
|
114
|
+
// 处理其他非呼叫相关事件
|
|
115
|
+
break
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
.store(in: &cancellableSet)
|
|
119
|
+
}
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
**呼叫事件函数详细说明**
|
|
123
|
+
| 事件函数 | 触发时机与说明 |
|
|
124
|
+
| --- | --- |
|
|
125
|
+
| [onCallTimeout](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncalltimeout(roominfo:call:)) | 呼叫超时。当呼叫请求在预设的时间内(由调用 callUserToRoom 时指定)未得到被呼叫方的响应时触发。此时,呼叫自动结束,呼叫方通常需要提示“对方无人接听”。 |
|
|
126
|
+
| [onCallAccepted](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallaccepted(roominfo:call:)) | 呼叫被接受。被呼叫方主动点击了“接听”或“接受”按钮。收到此回调后,表示双方已达成呼叫意图,呼叫方通常应立即执行进入房间或开始推流的操作。 |
|
|
127
|
+
| [onCallRejected](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallrejected(roominfo:call:reason:)) | 呼叫被拒绝。被呼叫方主动拒绝了通话请求,或者因为被呼叫方当前正处于其他房间中而自动拒绝。回调中通常包含拒绝原因(如主动拒绝或在其他房间中)。 |
|
|
128
|
+
| [onCallHandledByOtherDevice](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallhandledbyotherdevice(roominfo:isaccepted:)) | 呼叫已在其他设备处理。当用户在多个设备(例如手机和 iPad)同时登录时,如果呼叫已在其中一台设备上被处理(接受或拒绝),当前设备会收到此通知,用于同步 UI 状态并自动消除呼叫界面。 |
|
|
129
|
+
|
|
130
|
+
### 步骤3:被呼叫方功能
|
|
131
|
+
|
|
132
|
+
#### **1. 订阅会中呼叫事件**
|
|
133
|
+
|
|
134
|
+
作为被呼叫方订阅 `RoomStore` 的 `roomEventPublisher` 可以实时监听并响应来自呼叫方的呼叫行为。以下是构建呼叫提醒界面以及维护呼叫链路状态的关键事件。
|
|
135
|
+
``` swift
|
|
136
|
+
import Combine
|
|
137
|
+
import AtomicXCore
|
|
138
|
+
import Foundation
|
|
139
|
+
|
|
140
|
+
private var cancellableSet = Set<AnyCancellable>()
|
|
141
|
+
|
|
142
|
+
/// 订阅会中呼叫相关事件
|
|
143
|
+
private func subscribeRoomCallEvents() {
|
|
144
|
+
RoomStore.shared.roomEventPublisher
|
|
145
|
+
.receive(on: DispatchQueue.main)
|
|
146
|
+
.sink { [weak self] event in
|
|
147
|
+
guard let self = self else { return }
|
|
148
|
+
switch event {
|
|
149
|
+
case .onCallReceived(let roomInfo, let call, let extensionInfo):
|
|
150
|
+
print("收到房间呼叫 房间信息: \(roomInfo), 呼叫者: \(call.caller), 扩展信息: \(extensionInfo)")
|
|
151
|
+
case .onCallCancelled(let roomInfo, let call):
|
|
152
|
+
print("呼叫被取消 房间信息: \(roomInfo), 呼叫者: \(call.caller)")
|
|
153
|
+
case .onCallRevokedByAdmin(let roomInfo, let call, let operatorUser):
|
|
154
|
+
print("呼叫被管理员移除 房间信息: \(roomInfo), 呼叫者: \(call.caller), 移除操作者: \(operatorUser)")
|
|
155
|
+
default:
|
|
156
|
+
// 处理其他非呼叫相关事件
|
|
157
|
+
break
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
.store(in: &cancellableSet)
|
|
161
|
+
}
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
**事件函数详细说明**
|
|
165
|
+
| 事件函数 | 触发时机与说明 |
|
|
166
|
+
| --- | --- |
|
|
167
|
+
| [onCallReceived](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallreceived(roominfo:call:extensioninfo:)) | 收到呼叫邀请。当有其他用户向您发起入会邀请时触发。收到此回调后,被呼叫方通常应立即弹出“呼叫提醒”界面,展示呼叫者信息、房间信息,并提供“接听”和“拒绝”按钮。 |
|
|
168
|
+
| [onCallCancelled](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallcancelled(roominfo:call:)) | 呼叫被发起方取消。呼叫方在您未做出响应前,主动撤回了呼叫请求。收到此回调后,被呼叫方应立即关闭当前的来电界面,并提示“对方已取消呼叫”,以恢复应用正常操作流程。 |
|
|
169
|
+
| [onCallRevokedByAdmin](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomevent/oncallrevokedbyadmin(roominfo:call:operator:)) | 呼叫被管理员撤销。房间管理员或后台系统因权限变更、房间解散等原因强行终止了该笔呼叫邀请。收到此通知后,被呼叫方需立即停止呼叫流程并隐藏相关 UI,处理逻辑通常类似于呼叫被取消。 |
|
|
170
|
+
|
|
171
|
+
#### **2. 接受呼叫、拒绝呼叫**
|
|
172
|
+
|
|
173
|
+
作为被呼叫方调用`RoomStore`的`acceptCall`或者`rejectCall`接口,处理接受或者拒绝呼叫邀请。
|
|
174
|
+
``` swift
|
|
175
|
+
import Combine
|
|
176
|
+
import AtomicXCore
|
|
177
|
+
import Foundation
|
|
178
|
+
|
|
179
|
+
private var cancellableSet = Set<AnyCancellable>()
|
|
180
|
+
|
|
181
|
+
/// 订阅会中呼叫相关事件
|
|
182
|
+
private func subscribeRoomCallEvents() {
|
|
183
|
+
RoomStore.shared.roomEventPublisher
|
|
184
|
+
.receive(on: DispatchQueue.main)
|
|
185
|
+
.sink { event in
|
|
186
|
+
switch event {
|
|
187
|
+
case .onCallReceived(let roomInfo, let call, let extensionInfo):
|
|
188
|
+
print("收到房间呼叫 房间信息: \(roomInfo), 呼叫者: \(call.caller), 扩展信息: \(extensionInfo)")
|
|
189
|
+
// 接受、拒绝呼叫邀请操作
|
|
190
|
+
default:
|
|
191
|
+
// 处理其他非呼叫相关事件
|
|
192
|
+
break
|
|
193
|
+
}
|
|
194
|
+
}
|
|
195
|
+
.store(in: &cancellableSet)
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
// 接受呼叫邀请
|
|
199
|
+
func acceptCall(roomID: String) {
|
|
200
|
+
RoomStore.shared.acceptCall(roomID: roomID) { result in
|
|
201
|
+
switch result {
|
|
202
|
+
case .success:
|
|
203
|
+
print("接受呼叫成功,房间ID: \(roomID)")
|
|
204
|
+
case .failure(let error):
|
|
205
|
+
print("接受呼叫失败: [错误码: \(error.code)] \(error.message)")
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
// 拒绝呼叫邀请
|
|
211
|
+
func rejectCall(roomID: String, reason: CallRejectionReason = .rejected) {
|
|
212
|
+
RoomStore.shared.rejectCall(roomID: roomID, reason: reason) { result in
|
|
213
|
+
switch result {
|
|
214
|
+
case .success:
|
|
215
|
+
print("拒绝呼叫成功,房间ID: \(roomID)")
|
|
216
|
+
case .failure(let error):
|
|
217
|
+
print("拒绝呼叫失败: [错误码: \(error.code)] \(error.message)")
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
}
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
## API 文档
|
|
224
|
+
| **Store/Component** | **功能描述** | **API文档** |
|
|
225
|
+
| --- | --- | --- |
|
|
226
|
+
| **RoomStore** | 房间全生命周期管理:创建并加入 / 加入 / 离开 / 结束房间 / 更新、获取房间信息 / 预定房间 / 呼叫房间外成员 / 监听房间内被动事件(例如房间解散,房间信息更新等)。 | [API 文档](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/roomstore) |
|