@tencentcloud/sdk-mcp 1.6.7 → 1.6.8
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/knowledge/build-index.js +4 -1
- package/knowledge/content-loader.js +3 -1
- package/knowledge/search/filter-pool.js +12 -4
- package/knowledge/search/query-normalizer.js +76 -0
- package/knowledge/search/search-knowledge.js +104 -5
- package/package.json +1 -1
- package/resource/_schema/feature-aliases.yaml +1 -0
- package/resource/_schema/query-normalization.yaml +9 -0
- package/resource/index/manifest.json +1 -1
- package/resource/integration/callkit/preset/android/integration.md +0 -14
- package/resource/integration/callkit/preset/flutter/integration.md +0 -9
- package/resource/integration/callkit/preset/ios/integration.md +2 -15
- package/resource/integration/callkit/preset/react/integration.md +0 -21
- package/resource/integration/callkit/preset/vue/integration.md +0 -27
- package/resource/integration/chat/preset/android/integration.md +3 -10
- package/resource/integration/chat/preset/flutter/integration.md +11 -13
- package/resource/integration/chat/preset/ios/integration.md +9 -16
- package/resource/integration/chat/preset/react/integration.md +1 -9
- package/resource/integration/chat/preset/uni-app/integration.md +0 -9
- package/resource/integration/chat/preset/vue/integration.md +3 -13
- package/resource/integration/livekit/preset/live/android/live-host-integration.md +0 -4
- package/resource/integration/livekit/preset/live/android/prepare-integration.md +8 -21
- package/resource/integration/livekit/preset/live/ios/live-audience-integration.md +0 -1
- package/resource/integration/livekit/preset/live/ios/live-host-integration.md +0 -5
- package/resource/integration/livekit/preset/live/ios/live-list-integration.md +0 -4
- package/resource/integration/livekit/preset/live/ios/prepare-integration.md +0 -9
- package/resource/integration/livekit/preset/live/vue/live-list-integration.md +1 -5
- package/resource/integration/livekit/preset/live/vue/live-player-desk-integration.md +36 -147
- package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +1 -6
- package/resource/integration/livekit/preset/live/vue/live-pusher-integration.md +432 -286
- package/resource/integration/roomkit/preset/vue/integration.md +11 -24
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +1 -20
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +0 -12
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +1 -12
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +0 -19
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +0 -13
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +1 -17
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +0 -13
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +0 -13
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +0 -12
- package/resource/knowledge/callkit/core-sdk/miniprogram/call-engine.md +0 -1
- package/resource/knowledge/callkit/core-sdk/miniprogram/call-event.md +0 -2
- package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +0 -15
- package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +0 -15
- package/resource/knowledge/callkit/core-sdk/web/call-engine.md +0 -1
- package/resource/knowledge/callkit/core-sdk/web/call-event.md +0 -1
- package/resource/knowledge/callkit/core-sdk/web/callengine-api-overview.md +0 -1
- package/resource/knowledge/callkit/faq/android.md +5 -15
- package/resource/knowledge/callkit/faq/common.md +0 -1
- package/resource/knowledge/callkit/faq/ios.md +1 -4
- package/resource/knowledge/callkit/faq/uniapp-app.md +0 -2
- package/resource/knowledge/callkit/faq/uniapp-miniprogram.md +0 -5
- package/resource/knowledge/callkit/faq/web.md +1 -5
- package/resource/knowledge/callkit/preset/android/api.md +0 -6
- package/resource/knowledge/callkit/preset/ios/api.md +0 -4
- package/resource/knowledge/callkit/preset/miniprogram/api.md +0 -2
- package/resource/knowledge/callkit/preset/react/api.md +2 -4
- package/resource/knowledge/callkit/preset/react/uikit-api-reference.md +2 -8
- package/resource/knowledge/callkit/preset/vue/api.md +2 -4
- package/resource/knowledge/callkit/preset/vue/uikit-api-reference.md +2 -8
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +1 -4
- package/resource/knowledge/chat/preset/android/features/contact-list.md +0 -5
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +1 -10
- package/resource/knowledge/chat/preset/android/features/language.md +1 -12
- package/resource/knowledge/chat/preset/android/features/message-input.md +1 -9
- package/resource/knowledge/chat/preset/android/features/message-list.md +1 -11
- package/resource/knowledge/chat/preset/android/features/search.md +0 -7
- package/resource/knowledge/chat/preset/android/features/theme.md +0 -6
- package/resource/knowledge/chat/preset/android-view/integration.md +3 -5
- package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +1 -4
- package/resource/knowledge/chat/preset/flutter/features/contact-list.md +1 -6
- package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +1 -10
- package/resource/knowledge/chat/preset/flutter/features/language.md +0 -3
- package/resource/knowledge/chat/preset/flutter/features/message-input.md +1 -9
- package/resource/knowledge/chat/preset/flutter/features/message-list.md +1 -11
- package/resource/knowledge/chat/preset/flutter/features/search.md +0 -7
- package/resource/knowledge/chat/preset/flutter/features/theme.md +0 -6
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +1 -4
- package/resource/knowledge/chat/preset/ios/features/contact-list.md +1 -8
- package/resource/knowledge/chat/preset/ios/features/conversation-list.md +1 -10
- package/resource/knowledge/chat/preset/ios/features/language.md +0 -11
- package/resource/knowledge/chat/preset/ios/features/message-input.md +1 -9
- package/resource/knowledge/chat/preset/ios/features/message-list.md +1 -11
- package/resource/knowledge/chat/preset/ios/features/search.md +0 -5
- package/resource/knowledge/chat/preset/ios/features/theme.md +0 -6
- package/resource/knowledge/chat/preset/ios-uikit/integration.md +5 -17
- package/resource/knowledge/chat/preset/react/features/chat-setting.md +0 -2
- package/resource/knowledge/chat/preset/react/features/contact-list.md +0 -23
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +2 -11
- package/resource/knowledge/chat/preset/react/features/conversation-list.md +2 -23
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +0 -6
- package/resource/knowledge/chat/preset/react/features/search.md +0 -1
- package/resource/knowledge/chat/preset/vue/features/chat-header.md +1 -3
- package/resource/knowledge/chat/preset/vue/features/chat-setting.md +3 -5
- package/resource/knowledge/chat/preset/vue/features/contact-list.md +3 -9
- package/resource/knowledge/chat/preset/vue/features/conversation-actions.md +0 -3
- package/resource/knowledge/chat/preset/vue/features/conversation-list.md +2 -13
- package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +2 -5
- package/resource/knowledge/chat/preset/vue/features/conversation-search.md +1 -0
- package/resource/knowledge/chat/preset/vue/features/message-input.md +2 -4
- package/resource/knowledge/chat/preset/vue/features/message-list.md +2 -4
- package/resource/knowledge/chat/preset/vue/features/search.md +4 -1
- package/resource/knowledge/chat/preset/vue/features/theme.md +4 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +1 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +1 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +1 -3
- package/resource/knowledge/livekit/core-sdk/features/android/audience-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/android/audio-effect.md +1 -3
- package/resource/knowledge/livekit/core-sdk/features/android/barrage.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/android/base-beauty.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/android/gift.md +2 -7
- package/resource/knowledge/livekit/core-sdk/features/android/live-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/audience-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/audio-effect.md +0 -4
- package/resource/knowledge/livekit/core-sdk/features/flutter/barrage.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/base-beauty.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/gift.md +3 -7
- package/resource/knowledge/livekit/core-sdk/features/flutter/live-list.md +3 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/audience-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/audio-effect.md +1 -3
- package/resource/knowledge/livekit/core-sdk/features/ios/barrage.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/base-beauty.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/gift.md +2 -7
- package/resource/knowledge/livekit/core-sdk/features/ios/live-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/uni-app/audience-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/uni-app/audio-effect.md +1 -2
- package/resource/knowledge/livekit/core-sdk/features/uni-app/barrage.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/uni-app/base-beauty.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/uni-app/gift.md +4 -8
- package/resource/knowledge/livekit/core-sdk/features/uni-app/live-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/live/android/co-guest-interaction.md +0 -3
- package/resource/knowledge/livekit/core-sdk/live/android/host-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/live/android/integration.md +0 -7
- package/resource/knowledge/livekit/core-sdk/live/flutter/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/live/flutter/host-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/live/flutter/integration.md +1 -7
- package/resource/knowledge/livekit/core-sdk/live/ios/co-guest-interaction.md +0 -3
- package/resource/knowledge/livekit/core-sdk/live/ios/host-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/live/ios/integration.md +0 -7
- package/resource/knowledge/livekit/core-sdk/live/uni-app/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/live/uni-app/host-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/live/uni-app/integration.md +0 -5
- package/resource/knowledge/livekit/core-sdk/voice/android/co-guest-interaction.md +1 -3
- package/resource/knowledge/livekit/core-sdk/voice/android/host-interaction.md +4 -13
- package/resource/knowledge/livekit/core-sdk/voice/android/integration.md +5 -5
- package/resource/knowledge/livekit/core-sdk/voice/flutter/co-guest-interaction.md +0 -3
- package/resource/knowledge/livekit/core-sdk/voice/flutter/integration.md +18 -21
- package/resource/knowledge/livekit/core-sdk/voice/ios/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/voice/ios/host-interaction.md +2 -11
- package/resource/knowledge/livekit/core-sdk/voice/ios/integration.md +8 -8
- package/resource/knowledge/livekit/core-sdk/voice/uni-app/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/voice/uni-app/integration.md +1 -4
- package/resource/knowledge/livekit/faq/error-code.md +1 -1
- package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +0 -5
- package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +1 -1
- package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +0 -3
- package/resource/knowledge/push/api-reference/donut.md +1 -6
- package/resource/knowledge/push/api-reference/harmonyos.md +0 -2
- package/resource/knowledge/push/api-reference/react-native.md +0 -3
- package/resource/knowledge/push/api-reference/uni-app.md +3 -5
- package/resource/knowledge/push/api-reference/unity.md +0 -1
- package/resource/knowledge/push/api-reference/unreal-engine.md +0 -1
- package/resource/knowledge/push/config/android/fcm.md +0 -6
- package/resource/knowledge/push/config/android/honor.md +1 -7
- package/resource/knowledge/push/config/android/huawei.md +1 -9
- package/resource/knowledge/push/config/android/meizu.md +1 -7
- package/resource/knowledge/push/config/android/oppo.md +1 -3
- package/resource/knowledge/push/config/android/vivo.md +1 -12
- package/resource/knowledge/push/config/android/xiaomi.md +0 -5
- package/resource/knowledge/push/config/donut.md +0 -12
- package/resource/knowledge/push/config/harmonyos.md +18 -7
- package/resource/knowledge/push/config/ios.md +26 -33
- package/resource/knowledge/push/config/react-native.md +0 -31
- package/resource/knowledge/push/config/unity.md +0 -31
- package/resource/knowledge/push/config/unreal-engine.md +0 -31
- package/resource/knowledge/push/integration/android.md +137 -46
- package/resource/knowledge/push/integration/donut.md +5 -21
- package/resource/knowledge/push/integration/flutter.md +1 -3
- package/resource/knowledge/push/integration/harmonyos.md +17 -16
- package/resource/knowledge/push/integration/ios.md +27 -15
- package/resource/knowledge/push/integration/react-native.md +9 -59
- package/resource/knowledge/push/integration/uni-app.md +3 -25
- package/resource/knowledge/push/integration/unity.md +8 -77
- package/resource/knowledge/push/integration/unreal-engine.md +37 -96
- package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/android/room-state.md +3 -5
- package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md +4 -6
- package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/flutter/room-state.md +2 -4
- package/resource/knowledge/roomkit/core-sdk/flutter/schedule-room.md +4 -6
- package/resource/knowledge/roomkit/core-sdk/ios/call-user-to-room.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md +0 -2
- package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +3 -5
- package/resource/knowledge/roomkit/core-sdk/ios/schedule-room.md +4 -6
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +0 -5
- package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +0 -3
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +0 -5
- package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +0 -3
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +1 -7
- package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +1 -2
- package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +0 -1
- package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +0 -3
- package/resource/knowledge/roomkit/preset/android/integration.md +202 -6
- package/resource/knowledge/roomkit/preset/flutter/integration.md +1 -16
- package/resource/knowledge/roomkit/preset/ios/integration.md +201 -7
- package/resource/knowledge/roomkit/preset/react/integration.md +205 -4
- package/resource/knowledge/rtcengine/web/api.md +0 -2
- package/resource/knowledge/rtcengine/web/plugin/22-advanced-audio-mixer.md +2 -2
- package/resource/knowledge/rtcengine/web/plugin/23-advanced-support-detection.md +3 -3
- package/resource/knowledge/rtcengine/web/plugin/28-advanced-beauty.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -4
- package/resource/knowledge/share/userSig.md +2 -2
- package/resource/knowledge/trtc/android/TRTCCloud.md +16 -16
- package/resource/knowledge/trtc/android/TRTCCloudDef.md +5 -5
- package/resource/knowledge/trtc/android/TRTCCloudListener.md +3 -3
- package/resource/knowledge/trtc/android/TXAudioEffectManager.md +2 -2
- package/resource/knowledge/trtc/android/TXDeviceManager.md +1 -1
- package/resource/knowledge/trtc/c++/ITRTCCloud.md +14 -14
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +2 -2
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +4 -4
- package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +3 -3
- package/resource/knowledge/trtc/c++/TRTCTypeDef.md +5 -5
- package/resource/knowledge/trtc/ios/TRTCCloud.md +14 -14
- package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +3 -3
- package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +2 -2
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +4 -4
- package/resource/knowledge/trtc/ios/TXLiveSDKTypeDef.md +5 -5
- package/server.js +1 -1
- package/tools/common/search_trtc_knowledge.js +2 -0
- package/tools/definitions/search_trtc_knowledge_def.js +1 -0
- package/utils/report-cls-client.js +3 -3
- package/utils/report-es-client.js +1 -1
|
@@ -24,8 +24,6 @@
|
|
|
24
24
|
|
|
25
25
|
### 步骤1:组件集成
|
|
26
26
|
|
|
27
|
-
请参考 开播与收听 集成 **AtomicXCore**,完成接入。
|
|
28
|
-
|
|
29
27
|
### 步骤2:获取 Store 实例
|
|
30
28
|
|
|
31
29
|
`AudioEffectStore` 和 `DeviceStore` 是单例对象,您可以直接通过 `shared` 属性在项目的任何位置获取实例。您也可以参考 TUILiveKit 开源 UI demo 项目中的 [audio_effect_panel_widget.dart](https://github.com/Tencent-RTC/TUIKit_Flutter/blob/main/live/livekit/lib/component/audio_effect/audio_effect_panel_widget.dart) 文件来了解完整的实现逻辑。
|
|
@@ -44,7 +42,6 @@ class _AudioEffectPanelWidgetState {
|
|
|
44
42
|
耳返功能允许用户实时监听自己的麦克风声音,可以通过调用本节介绍的接口管理耳返功能。
|
|
45
43
|
|
|
46
44
|
> **注意:**
|
|
47
|
-
>
|
|
48
45
|
> 耳返功能通常需要连接耳机才能正常工作。
|
|
49
46
|
>
|
|
50
47
|
|
|
@@ -328,7 +325,6 @@ class ReverbWidget extends StatelessWidget {
|
|
|
328
325
|
### 步骤7:重置音效设置
|
|
329
326
|
|
|
330
327
|
> **重要:**
|
|
331
|
-
>
|
|
332
328
|
> AudioEffectStore 和 DeviceStore 是单例,即音效和设备设置会全局生效,如果您不希望当前直播间的设置影响到之后创建的其他直播间,就需要在当前直播间结束的时候重置音效和设备设置。
|
|
333
329
|
>
|
|
334
330
|
|
|
@@ -1,9 +1,5 @@
|
|
|
1
1
|
`GiftStore` 是 `AtomicXCore` 中专门负责管理直播间礼物功能的模块。通过它,您可以为您的直播应用构建一套完整的礼物系统,实现丰富的营收和互动场景。
|
|
2
2
|
|
|
3
|
-
|**礼物面板**|**弹幕礼物**|**全屏礼物**|
|
|
4
|
-
|---------|---------|---------|
|
|
5
|
-
||||
|
|
6
|
-
|
|
7
3
|
## 核心功能
|
|
8
4
|
- **礼物列表获取**:从服务端拉取礼物面板所需的数据,包括礼物分类和礼物详情。
|
|
9
5
|
|
|
@@ -26,9 +22,9 @@
|
|
|
26
22
|
## 实现步骤
|
|
27
23
|
|
|
28
24
|
### 步骤1:组件集成
|
|
29
|
-
-
|
|
25
|
+
- **视频直播**:。
|
|
30
26
|
|
|
31
|
-
-
|
|
27
|
+
- **语聊房**:。
|
|
32
28
|
|
|
33
29
|
### 步骤2:初始化并监听礼物事件
|
|
34
30
|
|
|
@@ -190,7 +186,7 @@ extension GiftManagerSend on GiftManager {
|
|
|
190
186
|
您需要自定义直播间可用的礼物种类、分类、名称、图标、价格以及动画效果,以满足运营需求和品牌特色。
|
|
191
187
|
|
|
192
188
|
#### **实现方式**
|
|
193
|
-
1. **服务端配置**:使用 LiveKit 服务端 REST API
|
|
189
|
+
1. **服务端配置**:使用 LiveKit 服务端 REST API 管理礼物信息、分类、多语言等。。
|
|
194
190
|
|
|
195
191
|
2. **客户端拉取**:在客户端调用 `refreshUsableGifts` 获取配置数据。
|
|
196
192
|
|
|
@@ -25,9 +25,9 @@
|
|
|
25
25
|
## 实现步骤
|
|
26
26
|
|
|
27
27
|
### 步骤1:组件集成
|
|
28
|
-
-
|
|
28
|
+
- **视频直播**:。
|
|
29
29
|
|
|
30
|
-
-
|
|
30
|
+
- **语聊房**:。
|
|
31
31
|
|
|
32
32
|
### 步骤2:观众进入直播间实现
|
|
33
33
|
|
|
@@ -367,6 +367,7 @@ class LiveListManager extends ChangeNotifier {
|
|
|
367
367
|
}
|
|
368
368
|
}
|
|
369
369
|
```
|
|
370
|
+
|
|
370
371
|
``` java
|
|
371
372
|
/// 带分类筛选的直播列表页面
|
|
372
373
|
class CategoryLiveListPage extends StatefulWidget {
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
|
|
26
26
|
### 步骤1:组件集成
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
。**
|
|
29
29
|
|
|
30
30
|
### 步骤2:获取 Store 实例
|
|
31
31
|
|
|
@@ -44,7 +44,6 @@ let deviceStore = DeviceStore.shared
|
|
|
44
44
|
耳返功能允许用户实时监听自己的麦克风声音,可以通过调用本节介绍的接口管理耳返功能。
|
|
45
45
|
|
|
46
46
|
> **注意:**
|
|
47
|
-
>
|
|
48
47
|
> 耳返功能通常需要连接耳机才能正常工作。
|
|
49
48
|
>
|
|
50
49
|
|
|
@@ -154,7 +153,6 @@ audioEffectStore.setAudioReverbType(type: .none)
|
|
|
154
153
|
### 步骤7:重置音效设置
|
|
155
154
|
|
|
156
155
|
> **重要:**
|
|
157
|
-
>
|
|
158
156
|
> `AudioEffectStore` 和 `DeviceStore` 是单例,这意味着音效和设备设置是全局生效的,如果您在当前直播间的设置不想影响到您创建的其他直播间,就需要在当前直播间结束的时候重置音效和设备设置。
|
|
159
157
|
>
|
|
160
158
|
|
|
@@ -1,9 +1,5 @@
|
|
|
1
1
|
`GiftStore` 是 `AtomicXCore` 中专门负责管理直播间礼物功能的模块。通过它,您可以为您的直播应用构建一套完整的礼物系统,实现丰富的营收和互动场景。
|
|
2
2
|
|
|
3
|
-
|礼物面板|弹幕礼物|全屏礼物|
|
|
4
|
-
|---------|---------|---------|
|
|
5
|
-
||||
|
|
6
|
-
|
|
7
3
|
## 核心功能
|
|
8
4
|
- **礼物列表获取**:从服务端拉取礼物面板所需的数据,包括礼物分类和礼物详情。
|
|
9
5
|
|
|
@@ -28,13 +24,12 @@
|
|
|
28
24
|
### 步骤1:组件集成
|
|
29
25
|
|
|
30
26
|
> **说明:**
|
|
31
|
-
>
|
|
32
27
|
> 使用**礼物系统**要求开通TUILiveKit **多人连麦版**、**大规模直播版**,不同套餐中可配置的礼物数量有所不同,详细参见 功能与计费说明 中的**礼物系统**说明。
|
|
33
28
|
>
|
|
34
29
|
|
|
35
|
-
-
|
|
30
|
+
- **视频直播**:。
|
|
36
31
|
|
|
37
|
-
-
|
|
32
|
+
- **语聊房**:。
|
|
38
33
|
|
|
39
34
|
### 步骤2:初始化并监听礼物事件
|
|
40
35
|
|
|
@@ -1,7 +1,4 @@
|
|
|
1
1
|
`GiftState` 是 `AtomicXCore` 中专门负责管理直播间礼物功能的模块。通过它,您可以为您的直播应用构建一套完整的礼物系统,实现丰富的营收和互动场景。
|
|
2
|
-
| 礼物面板 | 弹幕礼物 | 全屏礼物 |
|
|
3
|
-
| --- | --- | --- |
|
|
4
|
-
| | | |
|
|
5
2
|
|
|
6
3
|
## 核心功能
|
|
7
4
|
- **礼物列表获取**:从服务端拉取礼物面板所需的数据,包括礼物分类和礼物详情。
|
|
@@ -15,13 +12,12 @@
|
|
|
15
12
|
### 步骤1:组件集成
|
|
16
13
|
|
|
17
14
|
> **说明:**
|
|
18
|
-
>
|
|
19
15
|
> 使用**礼物系统**要求开通TUILiveKit **多人连麦版**、**大规模直播版**,不同套餐中可配置的礼物数量有所不同,详细参见 功能与计费说明 中的**礼物系统**说明。
|
|
20
16
|
>
|
|
21
17
|
|
|
22
|
-
-
|
|
18
|
+
- **视频直播**:。
|
|
23
19
|
|
|
24
|
-
-
|
|
20
|
+
- **语聊房**:。
|
|
25
21
|
|
|
26
22
|
### 步骤2:初始化并监听礼物事件
|
|
27
23
|
|
|
@@ -95,10 +91,10 @@ watch(usableGifts, (newVal, oldVal) => {
|
|
|
95
91
|
``` typescript
|
|
96
92
|
import { useGiftState } from "@/uni_modules/tuikit-atomic-x/state/GiftState";
|
|
97
93
|
import { onMounted } from 'vue';
|
|
98
|
-
|
|
94
|
+
|
|
99
95
|
// 通过 liveID 获取 GiftState 的实例
|
|
100
96
|
const { addGiftListener, refreshUsableGifts } = useGiftState(liveID);
|
|
101
|
-
|
|
97
|
+
|
|
102
98
|
onMounted(() => {
|
|
103
99
|
refreshUsableGifts({
|
|
104
100
|
liveID: 'xxx', // 当前直播间的 liveID
|
|
@@ -11,8 +11,6 @@
|
|
|
11
11
|
|
|
12
12
|
### 步骤1:组件集成
|
|
13
13
|
|
|
14
|
-
请参考 开播与观看 集成 **AtomicXCore**,并完成 **LiveCoreView** 的接入。
|
|
15
|
-
|
|
16
14
|
### 步骤2:实现观众申请上麦
|
|
17
15
|
|
|
18
16
|
#### 观众端实现
|
|
@@ -330,7 +328,6 @@
|
|
|
330
328
|
#### **实现方式**
|
|
331
329
|
|
|
332
330
|
> **提示:**
|
|
333
|
-
>
|
|
334
331
|
> 您也可以参考 TUILiveKit 开源项目中的 [widgets](https://github.com/Tencent-RTC/TUIKit_Android/tree/main/live/tuilivekit/src/main/java/com/trtc/uikit/livekit/features/audienceview/view/coguest/widgets) 目录下文件来了解完整的实现逻辑。
|
|
335
332
|
>
|
|
336
333
|
|
|
@@ -8,8 +8,6 @@
|
|
|
8
8
|
|
|
9
9
|
### 步骤1:组件集成
|
|
10
10
|
|
|
11
|
-
请参考 开播与观看 集成 **AtomicXCore**,并完成 **LiveCoreView** 的接入。
|
|
12
|
-
|
|
13
11
|
### 步骤2:实现跨房连线
|
|
14
12
|
|
|
15
13
|
此步骤的目标是让两个主播的画面出现在同一个视图中,我们将使用 [CoHostStore](https://tencent-rtc.github.io/TUIKit_Android/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.live/-co-host-store/index.html) 来完成。
|
|
@@ -4,14 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
**LiveCoreView** 是一个专为直播场景设计的轻量级 `View` 组件,是您构建直播场景的核心,它封装了所有复杂的底层直播技术(例如推拉流、连麦、音视频渲染)。您可以将 LiveCoreView 作为直播画面的"画布",专注于上层 UI 与交互的开发。
|
|
6
6
|
|
|
7
|
-
通过下方的视图层级示意图,您可以直观了解 **LiveCoreView** 在直播界面中的位置和作用:
|
|
8
|
-
|
|
9
7
|
## 准备工作
|
|
10
8
|
|
|
11
9
|
### 步骤1:开通服务
|
|
12
10
|
|
|
13
|
-
请参见 开通服务,获取体验版或付费版 SDK。
|
|
14
|
-
|
|
15
11
|
### 步骤2:在当前项目中导入 AtomicXCore
|
|
16
12
|
|
|
17
13
|
**安装组件**:请在您的 **build.gradle** 文件中添加 `implementation 'com.tencent.atomicx:atomicxcore:latest'` 依赖,然后执行 **Gradle Sync**。
|
|
@@ -33,7 +29,6 @@ api "com.tencent.imsdk:imsdk-plus:8.9.7511"
|
|
|
33
29
|
在您的项目中调用 `LoginStore.shared.login` 完成登录,**这是使用** `AtomicXCore` **所有功能的关键前提**。
|
|
34
30
|
|
|
35
31
|
> **重要:**
|
|
36
|
-
>
|
|
37
32
|
> 推荐在您 App 自身的用户账户登录成功后,再调用 LoginStore.shared.login,以确保登录业务逻辑的清晰和一致。
|
|
38
33
|
>
|
|
39
34
|
|
|
@@ -83,7 +78,6 @@ class MainActivity : AppCompatActivity() {
|
|
|
83
78
|
主播开播流程如下,您只需执行以下几步操作,即可快速搭建主播视频直播。
|
|
84
79
|
|
|
85
80
|
> **提示:**
|
|
86
|
-
>
|
|
87
81
|
> 主播开播推流的业务代码,您也可以参考 TUILiveKit 开源项目中的 [VideoLiveAnchorActivity.kt](https://github.com/Tencent-RTC/TUIKit_Android/blob/main/live/tuilivekit/src/main/java/com/trtc/uikit/livekit/livestream/VideoLiveAnchorActivity.kt) 文件来了解完整的实现逻辑。
|
|
88
82
|
>
|
|
89
83
|
|
|
@@ -264,7 +258,6 @@ class MainActivity : AppCompatActivity() {
|
|
|
264
258
|
观众观看流程如下,通过简单几步操作,即可实现观众观看直播。
|
|
265
259
|
|
|
266
260
|
> **提示:**
|
|
267
|
-
>
|
|
268
261
|
> 观众进房拉流的业务代码,您也可以参考 TUILiveKit 开源项目中的 [VideoLiveAudienceActivity.kt](https://github.com/Tencent-RTC/TUIKit_Android/blob/main/live/tuilivekit/src/main/java/com/trtc/uikit/livekit/livestream/VideoLiveAudienceActivity.kt) 文件来了解完整的实现逻辑。
|
|
269
262
|
>
|
|
270
263
|
|
|
@@ -4,14 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
**LiveCoreWidget** 是一个专为直播场景设计的轻量级 Widget 组件,是您构建直播场景的核心,它封装了所有复杂的底层直播技术(例如推拉流、连麦、音视频渲染)。您可以将 LiveCoreWidget 作为直播画面的"画布",专注于上层 UI 与交互的开发。
|
|
6
6
|
|
|
7
|
-
通过下方的视图层级示意图,您可以直观了解 **LiveCoreWidget** 在直播界面中的位置和作用:
|
|
8
|
-
|
|
9
7
|
## 准备工作
|
|
10
8
|
|
|
11
9
|
### 步骤1:开通服务
|
|
12
10
|
|
|
13
|
-
请参见 开通服务,获取体验版或付费版 SDK。
|
|
14
|
-
|
|
15
11
|
### 步骤2:在当前项目中导入 AtomicXCore
|
|
16
12
|
1. **安装组件**:请在您的 `pubspec.yaml` 文件中添加 `atomic_x_core` 依赖,然后执行 `flutter pub get`。
|
|
17
13
|
|
|
@@ -62,7 +58,6 @@ end
|
|
|
62
58
|
在您的项目中调用 `LoginStore.shared.login` 完成登录,**这是使用 AtomicXCore 所有功能的关键前提**。
|
|
63
59
|
|
|
64
60
|
> **重要:**
|
|
65
|
-
>
|
|
66
61
|
> 推荐在您 App 自身的用户账户登录成功后,再调用 LoginStore.shared.login,以确保登录业务逻辑的清晰和一致。
|
|
67
62
|
>
|
|
68
63
|
|
|
@@ -357,7 +352,6 @@ void main() async {
|
|
|
357
352
|
观众观看流程如下,通过简单几步操作,即可实现观众观看直播。
|
|
358
353
|
|
|
359
354
|
> **提示:**
|
|
360
|
-
>
|
|
361
355
|
> 观众进房拉流的业务代码,您也可以参考 TUILiveKit 开源项目中的 [audience_widget.dart](https://github.com/Tencent-RTC/TUIKit_Flutter/blob/main/live/livekit/lib/live_stream/features/audience/audience_widget.dart) 文件来了解完整的实现逻辑。
|
|
362
356
|
>
|
|
363
357
|
|
|
@@ -653,7 +647,7 @@ class _YourAudiencePageState extends State<YourAudiencePage> {
|
|
|
653
647
|
- **检查网络**:请检查设备网络连接是否正常。
|
|
654
648
|
|
|
655
649
|
### 观众端调用了 joinLive 且返回 Success,但依然没有视频画面?
|
|
656
|
-
- **时序问题:**是否在 `LiveCoreWidget` 挂载前就执行了 `joinLive
|
|
650
|
+
- **时序问题:**是否在 `LiveCoreWidget` 挂载前就执行了 `joinLive`?。
|
|
657
651
|
|
|
658
652
|
- **Controller 类型:**创建时是否正确传入了 `CoreViewType.playView`?
|
|
659
653
|
|
|
@@ -11,8 +11,6 @@
|
|
|
11
11
|
|
|
12
12
|
### 步骤1:组件集成
|
|
13
13
|
|
|
14
|
-
请参考 开播与观看 集成 **AtomicXCore**,并完成 **LiveCoreView** 的接入。
|
|
15
|
-
|
|
16
14
|
### 步骤2:实现观众申请上麦
|
|
17
15
|
|
|
18
16
|
#### 观众端实现
|
|
@@ -251,7 +249,6 @@
|
|
|
251
249
|
#### **实现方式**
|
|
252
250
|
|
|
253
251
|
> **提示:**
|
|
254
|
-
>
|
|
255
252
|
> 您也可以参考 TUILiveKit 开源项目中的 [AnchorCoGuestView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Features/AnchorView/View/VideoWidgets/AnchorCoGuestView.swift) 和 [AnchorEmptySeatView.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/Features/AnchorView/View/VideoWidgets/AnchorEmptySeatView.swift) 文件来了解完整的实现逻辑。
|
|
256
253
|
>
|
|
257
254
|
|
|
@@ -4,14 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
**LiveCoreView** 是一个专为直播场景设计的轻量级 `UIView` 组件,是您构建直播场景的核心,它封装了所有复杂的底层直播技术(例如推拉流、连麦、音视频渲染)。您可以将 LiveCoreView 作为直播画面的“画布”,专注于上层 UI 与交互的开发。
|
|
6
6
|
|
|
7
|
-
通过下方的视图层级示意图,您可以直观了解 **LiveCoreView** 在直播界面中的位置和作用:
|
|
8
|
-
|
|
9
7
|
## 准备工作
|
|
10
8
|
|
|
11
9
|
### 步骤1:开通服务
|
|
12
10
|
|
|
13
|
-
请参见 开通服务,获取体验版或付费版 SDK。
|
|
14
|
-
|
|
15
11
|
### 步骤2:在当前项目中导入 AtomicXCore
|
|
16
12
|
1. **安装组件**:请在您的 **Podfile** 文件中添加 `pod 'AtomicXCore'` 依赖,然后执行 `pod install`。
|
|
17
13
|
|
|
@@ -34,7 +30,6 @@
|
|
|
34
30
|
在您的项目中调用 `LoginStore.shared.login` 完成登录,**这是使用** `AtomicXCore` **所有功能的关键前提**。
|
|
35
31
|
|
|
36
32
|
> **重要:**
|
|
37
|
-
>
|
|
38
33
|
> 推荐在您 App 自身的用户账户登录成功后,再调用 LoginStore.shared.login,以确保登录业务逻辑的清晰和一致。
|
|
39
34
|
>
|
|
40
35
|
|
|
@@ -71,7 +66,6 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau
|
|
|
71
66
|
主播开播流程如下,您只需执行以下几步操作,即可快速搭建主播视频直播。
|
|
72
67
|
|
|
73
68
|
> **提示:**
|
|
74
|
-
>
|
|
75
69
|
> 主播开播推流的业务代码,您也可以参考 TUILiveKit 开源项目中的 [TUILiveRoomAnchorViewController.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/LiveStream/TUILiveRoomAnchorViewController.swift) 文件来了解完整的实现逻辑。
|
|
76
70
|
>
|
|
77
71
|
|
|
@@ -216,7 +210,6 @@ func application(_ application: UIApplication, didFinishLaunchingWithOptions lau
|
|
|
216
210
|
观众观看流程如下,通过简单几步操作,即可实现观众观看直播。
|
|
217
211
|
|
|
218
212
|
> **提示:**
|
|
219
|
-
>
|
|
220
213
|
> 观众进房拉流的业务代码,您也可以参考 TUILiveKit 开源项目中的 [TUILiveRoomAudienceViewController.swift](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/live/Sources/LiveStream/TUILiveRoomAudienceViewController.swift) 文件来了解完整的实现逻辑。
|
|
221
214
|
>
|
|
222
215
|
|
|
@@ -4,14 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
**LiveCoreView** 是一个专为直播场景设计的轻量级 `UI` 组件,是您构建直播场景的核心,它封装了所有复杂的底层直播技术(例如推拉流、连麦、音视频渲染)。您可以将 LiveCoreView 作为直播画面的“画布”,专注于上层 UI 与交互的开发。
|
|
6
6
|
|
|
7
|
-
通过下方的视图层级示意图,您可以直观了解 **LiveCoreView** 在直播界面中的位置和作用:
|
|
8
|
-
|
|
9
7
|
## 准备工作
|
|
10
8
|
|
|
11
9
|
### 步骤1:开通服务
|
|
12
10
|
|
|
13
|
-
请参见 开通服务,获取体验版或付费版 SDK。
|
|
14
|
-
|
|
15
11
|
### 步骤2:在当前项目中导入 AtomicXCore
|
|
16
12
|
1. **安装组件**:打开 [AtomicXCore SDK](https://ext.dcloud.net.cn/plugin) ,单击**下载插件并导入 HBuilderX**,选择需要集成的项目并单击**确定**。
|
|
17
13
|
|
|
@@ -41,7 +37,6 @@
|
|
|
41
37
|
在您的项目中调用 LoginState 中的 login 方法完成登录,**这是使用** `AtomicXCore` **所有功能的关键前提**。
|
|
42
38
|
|
|
43
39
|
> **重要:**
|
|
44
|
-
>
|
|
45
40
|
> 推荐在您 App 自身的用户账户登录成功后,再调用 LoginState 中的 login 方法,以确保登录业务逻辑的清晰和一致。
|
|
46
41
|
>
|
|
47
42
|
|
|
@@ -13,8 +13,6 @@
|
|
|
13
13
|
|
|
14
14
|
### 步骤1:组件集成
|
|
15
15
|
|
|
16
|
-
请参考 开播与收听 集成 **AtomicXCore**。
|
|
17
|
-
|
|
18
16
|
### 步骤2:实现观众申请上麦
|
|
19
17
|
|
|
20
18
|
#### 观众端实现
|
|
@@ -465,7 +463,7 @@ seatStore.unlockSeat(2, object : CompletionHandler {
|
|
|
465
463
|
主播和普通上麦用户可以调用 `moveUserToSeat` 移动麦位。
|
|
466
464
|
|
|
467
465
|
#### 实现方式:
|
|
468
|
-
1. **主播移动麦位**:主播可以调用此接口将任意用户移动到指定麦位。此时 `userID` 传入目标用户的 ID,`targetIndex` 是目标麦位索引,`policy`
|
|
466
|
+
1. **主播移动麦位**:主播可以调用此接口将任意用户移动到指定麦位。此时 `userID` 传入目标用户的 ID,`targetIndex` 是目标麦位索引,`policy` 参数来指定如果目标麦位有人时的移动策略。
|
|
469
467
|
|
|
470
468
|
2. **普通上麦用户移动自己麦位**:普通上麦用户也可以调用此接口来移动自己。此时 `userID` 必须传入用户自己的 ID,`targetIndex` 传入想去的新麦位索引,此时 `policy` 参数无效,如果目标麦位有人时会报错并停止移动。
|
|
471
469
|
|
|
@@ -15,8 +15,6 @@
|
|
|
15
15
|
|
|
16
16
|
## 前提条件
|
|
17
17
|
|
|
18
|
-
请参考 开播与收听 集成 **AtomicXCore SDK**,并完成 **主播开播** 和 **观众观看** 的功能实现。
|
|
19
|
-
|
|
20
18
|
## 主播发起一场连线
|
|
21
19
|
|
|
22
20
|
### 步骤1:查看正在开播中的主播列表
|
|
@@ -26,7 +24,6 @@
|
|
|
26
24
|
**实现方式:** 调用 `LiveListStore.shared().fetchLiveList`。
|
|
27
25
|
|
|
28
26
|
> **注意:**
|
|
29
|
-
>
|
|
30
27
|
> - 如果接口返回的列表中没有找到您想要的直播间,您需要检查开播时设置的 `TUILiveInfo` 的 `isPublicVisible` 字段是否为 `true`;
|
|
31
28
|
> - 该接口支持分页继续拉取,您可以使用接口 `onSuccess` 回调中 `cursor` 作为下一次续拉的游标,如果返回的 `cursor` 为空,则表示直播间列表已全部拉取完;
|
|
32
29
|
> - 为了性能考虑,建议您将 pageCount 设置为 20。
|
|
@@ -57,7 +54,6 @@ fun fetchLiveListForCoHost() {
|
|
|
57
54
|
您可以在主播选中指定的主播连线时,调用 `CoHostStore` 的 `requestHostConnection` 接口发起连线邀请。
|
|
58
55
|
|
|
59
56
|
> **说明:**
|
|
60
|
-
>
|
|
61
57
|
> 1. AtomicXCore 最大支持 **9** 个房间互相连线,每个房间支持 **50** 路用户。
|
|
62
58
|
> 2. 该接口支持批量发起邀请,您可以按需使用;单个直播间是否邀请成功,您需要监听 `onSuccess` 回调并解析 `code` 枚举值是否为 `0`;
|
|
63
59
|
> 3. 该接口支持扩展字段,邀请发送成功后,该字段会随着 `CoHostListener` 的 `onCoHostRequestReceived` 回调通知给对端主播,您可以在这个字段中携带 “**是否立即开始 PK 对战**” 等信息,来实现自己的特殊业务。
|
|
@@ -207,7 +203,6 @@ public void onExitButtonClicked() {
|
|
|
207
203
|
|
|
208
204
|
### 场景一:主播在连线后再发起 PK
|
|
209
205
|
|
|
210
|
-
AtomicXCore 支持您在这些主播中发起限时的对战 PK。交互如下图,主要包含以下 UI 交互:
|
|
211
206
|
1. 发起连线邀请,对端被邀请的主播接受连线邀请。
|
|
212
207
|
|
|
213
208
|
2. 参与连线的主播,点击 PK 按钮发起一场限时的对战,可以通过主播收到的礼物数来判定对战的胜负。
|
|
@@ -225,7 +220,6 @@ AtomicXCore 支持您在这些主播中发起限时的对战 PK。交互如下
|
|
|
225
220
|
当主播已经处于跨房连线时,可以在参与连线的主播之间发起一场限时 PK,`AtomicXCore` 支持您设置 PK 的时长、是否需要对端主播同意才开始 PK 以及发起 PK 时携带扩展信息。您可以调用 `BattleStore` 的 `requestBattle` 接口发起 PK 邀请。
|
|
226
221
|
|
|
227
222
|
> **说明:**
|
|
228
|
-
>
|
|
229
223
|
> 1. 当您不设置 `BattleConfig` 的 `duration` 字段时, PK 默认时长为 5 分钟;
|
|
230
224
|
> 2. 当您不需要对端主播同意时,您可以设置 `TUIBattleConfig` 的 `needResponse` 字段为 `false`,当邀请发出后 PK 会立即开始;
|
|
231
225
|
> 3. 当 `BattleConfig` 的 `needResponse` 字段为 `false` 时,`requestBattle` 接口的 `timeout` 字段必须设置为 0;
|
|
@@ -252,9 +246,9 @@ battleStore.requestBattle(
|
|
|
252
246
|
#### 步骤 2. 对端主播收到 PK 邀请
|
|
253
247
|
|
|
254
248
|
当 PK 请求成功发出后,对端主播会收到 `BattleListener` 的 `onBattleRequestReceived` 回调,您可以在这个回调中给对端主播的 UI 提醒 “有人邀请您 PK”,您也可以通过该回调的 battleInfo 参数的 config 字段中的 needResponse 信息确认是否需要 UI 提醒,例如:
|
|
255
|
-
- 当 needResponse 为 false 时,您无需提醒,直接进入 PK
|
|
249
|
+
- 当 needResponse 为 false 时,您无需提醒,直接进入 PK 状态(。
|
|
256
250
|
|
|
257
|
-
- 当 needResponse 为 true 时,您可以弹框提醒 “有人邀请您 PK”,当对端主播点击同意后进入 PK
|
|
251
|
+
- 当 needResponse 为 true 时,您可以弹框提醒 “有人邀请您 PK”,当对端主播点击同意后进入 PK 状态(。
|
|
258
252
|
|
|
259
253
|
``` java
|
|
260
254
|
private val mBattleListener: BattleListener = object : BattleListener() {
|
|
@@ -275,7 +269,6 @@ battleStore.requestBattle(
|
|
|
275
269
|
|
|
276
270
|
#### 步骤 3. 进入 PK 状态
|
|
277
271
|
|
|
278
|
-
如下图,当主播监听到 `BattleListener` 的 `onBattleStarted` 回调之后,**可以在 UI 上渲染 PK 进度条**。
|
|
279
272
|
- 当 `needResponse` 设置为 `false`, 则当邀请成功发出后,会自动进入 PK 状态。
|
|
280
273
|
|
|
281
274
|
- 当 `needResponse` 设置为 `true`,则当被邀请的所有对端主播都调用 `BattleStore` 的 `acceptBattle` 接口同意后进入 PK 状态。
|
|
@@ -301,17 +294,15 @@ battleID = battleStore.battleState.currentBattleInfo.value?.battleID
|
|
|
301
294
|
battleStore.exitBattle(battleID, null)
|
|
302
295
|
```
|
|
303
296
|
|
|
304
|
-
当 PK 结束之后 (也即 `BattleListener` 的 `onBattleEnded` 回调触发时),您可以通过该回调在 UI 上展示 PK
|
|
297
|
+
当 PK 结束之后 (也即 `BattleListener` 的 `onBattleEnded` 回调触发时),您可以通过该回调在 UI 上展示 PK 结束,并区分出胜负(
|
|
305
298
|
|
|
306
299
|
> **说明:**
|
|
307
|
-
>
|
|
308
300
|
> - 在连线过程中发起的 PK,当 PK 结束后会自动恢复到跨房连线状态。
|
|
309
301
|
> - 如果您想在 PK 结束之后同步结束跨房连线,可以调用 `CoHostStore` 的 `exitHostConnection` 结束连线。
|
|
310
302
|
|
|
311
303
|
### 场景二:主播发起带 PK 模式的连线
|
|
312
304
|
|
|
313
|
-
|
|
314
|
-
1. 主播在个人直播过程中,点击 PK 按钮,打开 UI 面板展示当前正在开播的主播列表(详见《主播发起一场连线》的步骤 1)。
|
|
305
|
+
1. 主播在个人直播过程中,点击 PK 按钮,打开 UI 面板展示当前正在开播的主播列表(。
|
|
315
306
|
|
|
316
307
|
2. 主播选中其中一个主播,发起 PK 邀请。
|
|
317
308
|
|