@tencent-rtc/mcp 1.6.4 → 1.6.5
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/chunker.js +83 -54
- package/knowledge/path-meta.js +179 -26
- package/knowledge/search/exact-lookup.js +153 -0
- package/knowledge/search/filter-pool.js +73 -19
- package/knowledge/search/product-scope-intent.js +2 -2
- package/knowledge/search/requires-framework.js +2 -2
- package/knowledge/search/search-knowledge.js +235 -58
- package/package.json +1 -1
- package/resource/index/manifest.json +1 -1
- package/resource/integration/callkit/preset/android/integration.md +2 -4
- package/resource/integration/callkit/preset/flutter/integration.md +4 -5
- package/resource/integration/callkit/preset/ios/integration.md +1 -4
- package/resource/integration/callkit/preset/react/integration.md +13 -20
- package/resource/integration/callkit/preset/vue/integration.md +14 -21
- package/resource/integration/chat/preset/android/integration.md +6 -9
- package/resource/integration/chat/preset/flutter/integration.md +9 -12
- package/resource/integration/chat/preset/ios/integration.md +2 -4
- package/resource/integration/chat/preset/react/integration.md +0 -10
- package/resource/integration/livekit/preset/live/android/live-audience-integration.md +129 -0
- package/resource/integration/livekit/preset/live/android/live-host-integration.md +219 -0
- package/resource/integration/livekit/preset/live/android/live-list-integration.md +261 -0
- package/resource/integration/livekit/preset/live/android/prepare-integration.md +254 -0
- package/resource/integration/livekit/preset/live/ios/live-audience-integration.md +202 -0
- package/resource/integration/livekit/preset/live/ios/live-host-integration.md +369 -0
- package/resource/integration/livekit/preset/live/ios/live-list-integration.md +229 -0
- package/resource/integration/livekit/preset/live/ios/prepare-integration.md +204 -0
- package/resource/integration/livekit/preset/live/vue/live-list-integration.md +0 -3
- package/resource/integration/livekit/preset/live/vue/live-player-desk-integration.md +0 -5
- package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +0 -6
- package/resource/integration/livekit/preset/live/vue/live-pusher-integration.md +5 -10
- package/resource/integration/roomkit/preset/vue/integration.md +0 -4
- package/resource/knowledge/callkit/best-practice/web/callengine-invitation.md +80 -0
- package/resource/knowledge/callkit/best-practice/web/callengine-log-control.md +24 -0
- package/resource/knowledge/callkit/best-practice/web/callkit-call-vs-calls.md +116 -0
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +7 -8
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +5 -7
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +3 -5
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +2 -6
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +2 -6
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +4 -9
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +1 -4
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +8 -11
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +17 -23
- package/resource/knowledge/callkit/core-sdk/web/call-engine.md +33 -0
- package/resource/knowledge/callkit/core-sdk/web/call-event.md +327 -0
- package/resource/knowledge/callkit/core-sdk/web/callengine-api-overview.md +33 -0
- package/resource/knowledge/callkit/faq/android.md +0 -2
- package/resource/knowledge/callkit/faq/error-code.md +0 -2
- package/resource/knowledge/callkit/faq/flutter.md +2 -2
- package/resource/knowledge/callkit/faq/ios.md +3 -5
- package/resource/knowledge/callkit/faq/web.md +2 -3
- package/resource/knowledge/callkit/preset/android/api.md +2 -5
- package/resource/knowledge/callkit/preset/ios/api.md +0 -2
- package/resource/knowledge/callkit/preset/react/api.md +445 -0
- package/resource/knowledge/callkit/preset/react/uikit-api-reference.md +445 -0
- package/resource/knowledge/callkit/preset/vue/api.md +465 -0
- package/resource/knowledge/callkit/preset/vue/uikit-api-reference.md +465 -0
- package/resource/knowledge/chat/best-practice/web/image-message-url-handling.md +16 -0
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +1 -1
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +1 -1
- package/resource/knowledge/chat/preset/android/features/language.md +0 -1
- package/resource/knowledge/chat/preset/android/features/message-input.md +1 -1
- package/resource/knowledge/chat/preset/android/features/message-list.md +2 -3
- package/resource/knowledge/chat/preset/android/features/search.md +0 -1
- package/resource/knowledge/chat/preset/android/features/theme.md +1 -1
- package/resource/knowledge/chat/preset/android-view/integration.md +3 -11
- package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +0 -1
- package/resource/knowledge/chat/preset/flutter/features/message-list.md +1 -2
- package/resource/knowledge/chat/preset/flutter/features/search.md +5 -6
- package/resource/knowledge/chat/preset/flutter/features/theme.md +2 -2
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +1 -1
- package/resource/knowledge/chat/preset/ios/features/conversation-list.md +1 -2
- package/resource/knowledge/chat/preset/ios/features/message-list.md +1 -2
- package/resource/knowledge/chat/preset/ios/features/search.md +0 -1
- package/resource/knowledge/chat/preset/ios-uikit/integration.md +13 -15
- package/resource/knowledge/chat/preset/react/features/conversation-list.md +5 -5
- package/resource/knowledge/chat/preset/react/features/message-input.md +2 -3
- package/resource/knowledge/chat/preset/react/features/search.md +0 -1
- package/resource/knowledge/chat/preset/react/features/theme.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +7 -14
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +5 -8
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +15 -18
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +1 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +15 -20
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +10 -13
- package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +4 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +1 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +8 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +5 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +7 -14
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +6 -9
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +1 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +15 -18
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +15 -20
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +10 -13
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +4 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +1 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +8 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +3 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +7 -14
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +5 -8
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +1 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +6 -9
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +5 -10
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +3 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +4 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +2 -4
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +1 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +4 -6
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +3 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/{web → vue}/index.md +24 -24
- package/resource/knowledge/livekit/core-sdk/{voice/android/voice-audio-effect.md → features/android/audio-effect.md} +1 -2
- package/resource/knowledge/livekit/core-sdk/{live/android/live-gift.md → features/android/gift.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/{voice/android/voice-room-list.md → features/android/live-list.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/{live/flutter/live-audio-effect.md → features/flutter/audio-effect.md} +0 -2
- package/resource/knowledge/livekit/core-sdk/{voice/flutter/voice-barrage.md → features/flutter/barrage.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/{live/flutter/live-gift.md → features/flutter/gift.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/{voice/flutter/voice-room-list.md → features/flutter/live-list.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-audience-list.md → features/ios/audience-list.md} +1 -2
- package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-audio-effect.md → features/ios/audio-effect.md} +1 -3
- package/resource/knowledge/livekit/core-sdk/{live/ios/live-base-beauty.md → features/ios/base-beauty.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-gift.md → features/ios/gift.md} +2 -3
- package/resource/knowledge/livekit/core-sdk/{voice/ios/voice-room-list.md → features/ios/live-list.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/live/android/{live-co-guest-interaction.md → co-guest-interaction.md} +0 -1
- package/resource/knowledge/livekit/core-sdk/live/android/{live-host-interaction.md → host-interaction.md} +5 -7
- package/resource/knowledge/livekit/core-sdk/live/android/{live-integration.md → integration.md} +3 -6
- package/resource/knowledge/livekit/core-sdk/live/flutter/{live-co-guest-interaction.md → co-guest-interaction.md} +1 -1
- package/resource/knowledge/livekit/core-sdk/live/flutter/{live-host-interaction.md → host-interaction.md} +0 -2
- package/resource/knowledge/livekit/core-sdk/live/flutter/{live-integration.md → integration.md} +1 -4
- package/resource/knowledge/livekit/core-sdk/live/ios/{live-co-guest-interaction.md → co-guest-interaction.md} +0 -1
- package/resource/knowledge/livekit/core-sdk/live/ios/{live-host-interaction.md → host-interaction.md} +2 -4
- package/resource/knowledge/livekit/core-sdk/live/ios/{live-integration.md → integration.md} +2 -5
- package/resource/knowledge/livekit/core-sdk/voice/android/{voice-host-interaction.md → host-interaction.md} +3 -5
- package/resource/knowledge/livekit/core-sdk/voice/android/{voice-integration.md → integration.md} +3 -6
- package/resource/knowledge/livekit/core-sdk/voice/flutter/{voice-co-guest-interaction.md → co-guest-interaction.md} +1 -2
- package/resource/knowledge/livekit/core-sdk/voice/flutter/{voice-integration.md → integration.md} +6 -9
- package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-co-guest-interaction.md → co-guest-interaction.md} +2 -2
- package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-host-interaction.md → host-interaction.md} +4 -6
- package/resource/knowledge/livekit/core-sdk/voice/ios/{voice-integration.md → integration.md} +1 -4
- package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +0 -2
- package/resource/knowledge/push/api-reference/android.md +123 -0
- package/resource/knowledge/push/api-reference/flutter.md +176 -0
- package/resource/knowledge/push/api-reference/harmonyos.md +138 -0
- package/resource/knowledge/push/api-reference/ios.md +176 -0
- package/resource/knowledge/push/api-reference/react-native.md +147 -0
- package/resource/knowledge/push/api-reference/uni-app.md +147 -0
- package/resource/knowledge/push/api-reference/unity.md +119 -0
- package/resource/knowledge/push/api-reference/unreal-engine.md +123 -0
- package/resource/knowledge/push/config/android.md +4 -7
- package/resource/knowledge/push/config/harmonyos.md +0 -3
- package/resource/knowledge/push/config/ios.md +12 -20
- package/resource/knowledge/push/config/react-native.md +18 -26
- package/resource/knowledge/push/config/unity.md +20 -28
- package/resource/knowledge/push/config/unreal-engine.md +21 -29
- package/resource/knowledge/push/integration/android.md +6 -8
- package/resource/knowledge/push/integration/flutter.md +6 -9
- package/resource/knowledge/push/integration/harmonyos.md +1 -0
- package/resource/knowledge/push/integration/ios.md +7 -9
- package/resource/knowledge/push/integration/react-native.md +9 -13
- package/resource/knowledge/push/integration/uni-app.md +7 -7
- package/resource/knowledge/push/integration/unity.md +10 -13
- package/resource/knowledge/push/integration/unreal-engine.md +6 -9
- package/resource/knowledge/push/overview/prepare.md +2 -2
- package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md +3 -3
- package/resource/knowledge/roomkit/core-sdk/android/capability-matrix.md +46 -0
- package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/android/room-state.md +2 -2
- package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md +6 -6
- package/resource/knowledge/roomkit/core-sdk/android/unsupported-features.md +79 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/capability-matrix.md +46 -0
- package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/flutter/unsupported-features.md +79 -0
- package/resource/knowledge/roomkit/core-sdk/ios/capability-matrix.md +46 -0
- package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/ios/unsupported-features.md +79 -0
- package/resource/knowledge/roomkit/preset/android/integration.md +5 -7
- package/resource/knowledge/roomkit/preset/flutter/integration.md +2 -7
- package/resource/knowledge/roomkit/preset/ios/integration.md +3 -9
- package/resource/knowledge/roomkit/preset/react/integration.md +12 -16
- package/resource/knowledge/trtc/android/TRTCCloud.md +154 -238
- package/resource/knowledge/trtc/android/TRTCCloudDef.md +133 -134
- package/resource/knowledge/trtc/android/TRTCCloudListener.md +86 -120
- package/resource/knowledge/trtc/android/TRTCStatistics.md +10 -10
- package/resource/knowledge/trtc/android/TXAudioEffectManager.md +10 -30
- package/resource/knowledge/trtc/android/TXBeautyManager.md +25 -25
- package/resource/knowledge/trtc/android/TXDeviceManager.md +2 -2
- package/resource/knowledge/trtc/android/TXLiteAVCode.md +12 -12
- package/resource/knowledge/trtc/c++/ITRTCCloud.md +166 -261
- package/resource/knowledge/trtc/c++/ITRTCStatistics.md +12 -12
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +10 -30
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +9 -11
- package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +96 -130
- package/resource/knowledge/trtc/c++/TRTCTypeDef.md +122 -123
- package/resource/knowledge/trtc/c++/TXLiteAVCode.md +12 -12
- package/resource/knowledge/trtc/ios/TRTCCloud.md +168 -255
- package/resource/knowledge/trtc/ios/TRTCCloudDef.md +124 -125
- package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +89 -124
- package/resource/knowledge/trtc/ios/TRTCStatistics.md +10 -10
- package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +9 -28
- package/resource/knowledge/trtc/ios/TXBeautyManager.md +25 -25
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +9 -11
- package/resource/knowledge/trtc/ios/TXLiteAVCode.md +12 -12
- package/server.js +21 -21
- package/tools/common/finalize_answer.js +1 -1
- package/tools/common/present_framework_choice.js +2 -2
- package/tools/common/search_trtc_knowledge.js +3 -3
- package/tools/common/submit_feedback.js +1 -1
- package/tools/definitions/get_native_live_uikit_integration_def.js +61 -0
- package/tools/definitions/get_native_livekit_core_integration_def.js +3 -3
- package/tools/definitions/present_framework_choice_def.js +2 -2
- package/tools/definitions/search_trtc_knowledge_def.js +5 -5
- package/tools/index.js +2 -0
- package/tools/live/get_native_live_uikit_integration.js +69 -0
- package/tools/live/get_native_livekit_core_integration.js +6 -6
- package/utils/report-cls-client.js +1 -1
- package/utils/report-es-client.js +1 -1
- package/resource/knowledge/callkit/preset/web/api.md +0 -83
- package/resource/knowledge/livekit/core-sdk/live/android/live-audio-effect.md +0 -226
- package/resource/knowledge/livekit/core-sdk/live/android/live-live-list.md +0 -438
- package/resource/knowledge/livekit/core-sdk/live/flutter/live-barrage.md +0 -490
- package/resource/knowledge/livekit/core-sdk/live/flutter/live-live-list.md +0 -726
- package/resource/knowledge/livekit/core-sdk/live/ios/live-audience-list.md +0 -264
- package/resource/knowledge/livekit/core-sdk/live/ios/live-audio-effect.md +0 -216
- package/resource/knowledge/livekit/core-sdk/live/ios/live-gift.md +0 -407
- package/resource/knowledge/livekit/core-sdk/live/ios/live-live-list.md +0 -349
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-audience-list.md +0 -269
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-barrage.md +0 -456
- package/resource/knowledge/livekit/core-sdk/voice/android/voice-gift.md +0 -455
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audience-list.md +0 -260
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-audio-effect.md +0 -598
- package/resource/knowledge/livekit/core-sdk/voice/flutter/voice-gift.md +0 -424
- package/resource/knowledge/livekit/core-sdk/voice/ios/voice-barrage.md +0 -408
- /package/resource/knowledge/livekit/core-sdk/{live/android/live-audience-list.md → features/android/audience-list.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/android/live-barrage.md → features/android/barrage.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/android/live-base-beauty.md → features/android/base-beauty.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/flutter/live-audience-list.md → features/flutter/audience-list.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/flutter/live-base-beauty.md → features/flutter/base-beauty.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/{live/ios/live-barrage.md → features/ios/barrage.md} +0 -0
- /package/resource/knowledge/livekit/core-sdk/voice/android/{voice-co-guest-interaction.md → co-guest-interaction.md} +0 -0
|
@@ -2,9 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
The Search component provides a full-featured search experience, including a search bar, results display, and seamless page navigation. It supports searching for users, groups, and messages, and offers extensive interactive Webhook integration for custom workflows.
|
|
4
4
|
|
|
5
|
-
> **Note
|
|
5
|
+
> **Note:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> Search is available in the Pro edition and Enterprise edition. To use Search function, you need to purchase either the Pro or Enterprise package. For details, see [Billing Information](https://trtc.io/document/67650).
|
|
9
8
|
>
|
|
10
9
|
|
|
@@ -22,10 +21,10 @@ Search is included in TUIKit Flutter. To use the Search component, integrate TUI
|
|
|
22
21
|
|
|
23
22
|
|Method|Parameter|Description|
|
|
24
23
|
|---------|---------|---------|
|
|
25
|
-
|SearchBar|`onContactSelect: (`[FriendSearchInfo](https://pub.dev/documentation/atomic_x_core/latest/api_search_search_store/FriendSearchInfo-class.html)`
|
|
26
|
-
|SearchBar|`onGroupSelect: (`[GroupSearchInfo](https://pub.dev/documentation/atomic_x_core/latest/api_search_search_store/GroupSearchInfo-class.html)`
|
|
27
|
-
|SearchBar|`onConversationSelect: (`[MessageSearchResultItem](https://pub.dev/documentation/atomic_x_core/latest/api_search_search_store/MessageSearchResultItem-class.html)`
|
|
28
|
-
|SearchBar|`onMessageSelect: (`[MessageInfo](https://pub.dev/documentation/atomic_x_core/latest/api_message_message_list_store/MessageInfo-class.html)`
|
|
24
|
+
|SearchBar|`onContactSelect: (`[FriendSearchInfo](https://pub.dev/documentation/atomic_x_core/latest/api_search_search_store/FriendSearchInfo-class.html) `selectedContact) {}`|Webhook triggered when a contact result is clicked; optional parameter.|
|
|
25
|
+
|SearchBar|`onGroupSelect: (`[GroupSearchInfo](https://pub.dev/documentation/atomic_x_core/latest/api_search_search_store/GroupSearchInfo-class.html) `selectedGroup) {}`|Webhook triggered when a group result is clicked; optional parameter.|
|
|
26
|
+
|SearchBar|`onConversationSelect: (`[MessageSearchResultItem](https://pub.dev/documentation/atomic_x_core/latest/api_search_search_store/MessageSearchResultItem-class.html) `selectedConversation) {}`|Webhook triggered when a conversation result is clicked; optional parameter.|
|
|
27
|
+
|SearchBar|`onMessageSelect: (`[MessageInfo](https://pub.dev/documentation/atomic_x_core/latest/api_message_message_list_store/MessageInfo-class.html) `selectedMessage) {}`|Webhook triggered when a message result is clicked; optional parameter.|
|
|
29
28
|
|
|
30
29
|
## Basic Usage
|
|
31
30
|
|
|
@@ -39,7 +39,7 @@ All theme configuration and queries are managed through the `ThemeState` API.
|
|
|
39
39
|
|`setPrimaryColor`|`String`|`Unit`|Sets the primary theme color using a Hex string (e.g., "#1C66E5").|
|
|
40
40
|
|`clearPrimaryColor`|None|`Unit`|Removes the custom theme color and resets to the default blue.|
|
|
41
41
|
|
|
42
|
-
> **Notes
|
|
42
|
+
> **Notes:**
|
|
43
43
|
>
|
|
44
44
|
> - Both `setThemeMode` and `setPrimaryColor` automatically persist the configuration. No manual save is required. Settings are restored on app startup.
|
|
45
45
|
> - Changing theme configuration automatically clears the cache to ensure real-time updates. Manual cache management is not needed.
|
|
@@ -214,7 +214,7 @@ final themeState = BaseThemeProvider.of(context);
|
|
|
214
214
|
themeState.setPrimaryColor('#1C66E5');
|
|
215
215
|
```
|
|
216
216
|
|
|
217
|
-
> **Recommendations
|
|
217
|
+
> **Recommendations:**
|
|
218
218
|
>
|
|
219
219
|
> - For most use cases, we recommend managing appearance via a JSON configuration file for simplicity, reliability, and cross-platform consistency.
|
|
220
220
|
> - Always use colors from `themeState.colors` throughout your app to maintain a consistent look when switching themes.
|
|
@@ -23,7 +23,7 @@ ChatSetting contains two main components: C2CChatSetting (C2C Chat Settings) and
|
|
|
23
23
|
|---------|---------|---------|
|
|
24
24
|
|`userID`|`String`|The user ID of the chat partner.|
|
|
25
25
|
|`onSendMessageClick`|`(() -> Void)?`|The webhook triggered when the Send Message button is clicked (optional).|
|
|
26
|
-
|`onContactDelete`|`(() -> Void)
|
|
26
|
+
|`onContactDelete`|`(() -> Void)?` |The webhook triggered when the Delete Contact button is clicked (optional).|
|
|
27
27
|
|
|
28
28
|
#### Initialization Interface
|
|
29
29
|
|
|
@@ -124,11 +124,10 @@ ConversationList(
|
|
|
124
124
|
|
|
125
125
|
> **Note:**
|
|
126
126
|
>
|
|
127
|
-
|
|
128
127
|
> Local configuration takes precedence over global configuration.
|
|
129
128
|
>
|
|
130
129
|
|
|
131
130
|
The following images show the customization effects:
|
|
132
|
-
| <strong>Conversation Actions</strong><br><strong>
|
|
131
|
+
| <strong>Conversation Actions</strong><br><strong>(Default Options)</strong> | <strong>Conversation Actions</strong><br><strong>(Delete Option Hidden)</strong> | <strong>Conversation Actions</strong><br><strong>(Share Option Added)</strong> |
|
|
133
132
|
| --- | --- | --- |
|
|
134
133
|
| | | |
|
|
@@ -152,11 +152,10 @@ MessageList(
|
|
|
152
152
|
|
|
153
153
|
> **Note:**
|
|
154
154
|
>
|
|
155
|
-
|
|
156
155
|
> Local configuration overrides global configuration.
|
|
157
156
|
>
|
|
158
157
|
|
|
159
158
|
The following images show the customization effects:
|
|
160
|
-
| <strong>Message List Actions</strong><br><strong>
|
|
159
|
+
| <strong>Message List Actions</strong><br><strong>(Default Options)</strong> | <strong>Message List Actions</strong><br><strong>(Hide Copy Option)</strong> | <strong>Message List Actions</strong><br><strong>(Add Share Option)</strong> |
|
|
161
160
|
| --- | --- | --- |
|
|
162
161
|
| | | |
|
|
@@ -4,7 +4,6 @@ Search is a search component that provides users with a complete set of features
|
|
|
4
4
|
|
|
5
5
|
> **Note:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> Search function is available only in the Pro Edition or Enterprise Edition. You can use this feature after purchasing the Pro Edition or Enterprise Edition package. For details, see [Pricing Information](https://trtc.io/document/67650).
|
|
9
8
|
>
|
|
10
9
|
|
|
@@ -45,10 +45,10 @@ TUIKit is a UI component library built on the Chat SDK. It enables rapid impleme
|
|
|
45
45
|
|
|
46
46
|
> **Note:**
|
|
47
47
|
>
|
|
48
|
-
>
|
|
49
|
-
>
|
|
50
|
-
>
|
|
51
|
-
>
|
|
48
|
+
> 1. Starting from version 8.5.6870, TUIKit supports Swift components.
|
|
49
|
+
> 2. If you add only `pod 'TUIChat'` in your Podfile without specifying Classic or Minimalist UI, both UI component versions will be integrated by default.
|
|
50
|
+
> 3. **Classic and Minimalist UI cannot be mixed.** When integrating multiple components, select either all Classic UI or all Minimalist UI components. For example, the Classic `TUIChat` component must be used with Classic `TUIConversation` and `TUIContact` components. Similarly, the Minimalist `TUIChat` component must be used with Minimalist `TUIConversation` and `TUIContact` components.
|
|
51
|
+
> 4. If you use Swift, enable `use_modular_headers!` and use the @import module format for header imports.
|
|
52
52
|
|
|
53
53
|
Add the required component libraries to your Podfile as needed:
|
|
54
54
|
|
|
@@ -348,8 +348,8 @@ pod install
|
|
|
348
348
|
|
|
349
349
|
> **Note:**
|
|
350
350
|
>
|
|
351
|
-
>
|
|
352
|
-
>
|
|
351
|
+
> 1. If you cannot install the latest version of TUIKit, run `pod repo update` to update your local CocoaPods repository, then run `pod update` to update the component library version.
|
|
352
|
+
> 2. If you encounter third-party library version conflicts, see CocoaPods FAQs - Dependency Version Conflicts.
|
|
353
353
|
|
|
354
354
|
After successfully integrating all TUIKit components, your project directory should resemble the following:
|
|
355
355
|
|
|
@@ -533,10 +533,10 @@ pod install
|
|
|
533
533
|
|
|
534
534
|
> **Notes:**
|
|
535
535
|
>
|
|
536
|
-
>
|
|
537
|
-
>
|
|
538
|
-
>
|
|
539
|
-
>
|
|
536
|
+
> 1. When using local integration, you must obtain the latest component code from GitHub and overwrite your local TUIKit directory when upgrading.
|
|
537
|
+
> 2. If you have private modifications that conflict with the remote repository, manually merge and resolve conflicts.
|
|
538
|
+
> 3. TUIKit plugins depend on the TUICore version. Ensure the plugin version matches the `spec.version` in `../TUIKit/TUICore/TUICore.spec`.
|
|
539
|
+
> 4. If you encounter third-party library version conflicts, see CocoaPods FAQs - Dependency Version Conflicts.
|
|
540
540
|
|
|
541
541
|
Now you have successfully integrated TUIKit into your project. To continue building basic interfaces such as chat and conversation, see [Build Chat Interface](https://www.tencentcloud.com/zh/document/product/1047/61215) and [Build Conversation List.](https://www.tencentcloud.com/zh/document/product/1047/61217)
|
|
542
542
|
|
|
@@ -549,13 +549,13 @@ pod install
|
|
|
549
549
|
|
|
550
550
|
**Solution 1**: Change your Xcode project’s `Project Format` version to Xcode 13.0.
|
|
551
551
|
|
|
552
|
-
|
|
552
|
+
**Solution 2**: Upgrade your local version of CocoaPods. (Upgrade steps not detailed here.)
|
|
553
553
|
|
|
554
554
|
- **Assertion failed: (false && "compact unwind compressed function offset doesn't fit in 24 bits"), function operator(), file Layout.cpp.**
|
|
555
555
|
|
|
556
556
|
Alternatively, when integrating TUIRoom with Xcode 15, you may encounter symbol conflicts in TUIRoomEngine caused by the latest linker. Both issues have the same root cause.
|
|
557
557
|
|
|
558
|
-
|
|
558
|
+
**Solution**: Update the linker configuration. Add `-ld64` to `Other Linker Flags` in Build Settings.
|
|
559
559
|
|
|
560
560
|
Official document: [https://developer.apple.com/forums/thread/735426](https://links.jianshu.com/go)
|
|
561
561
|
|
|
@@ -620,9 +620,7 @@ pod install
|
|
|
620
620
|
|
|
621
621
|
2. In the [TUICore.podspec](https://github.com/TencentCloud/chat-uikit-ios/blob/main/TUIKit/TUICore/TUICore.podspec) file, set the version number to the same remote version (for example, 7.5.4852).By ensuring all components use a consistent version, you can avoid dependency conflicts during integration.
|
|
622
622
|
|
|
623
|
-
-
|
|
624
|
-
|
|
625
|
-
**Which third-party libraries does TUIKit depend on? What should I do if there are version conflicts?**
|
|
623
|
+
- **Which third-party libraries does TUIKit depend on? What should I do if there are version conflicts?**
|
|
626
624
|
|
|
627
625
|
TUIKit manages dependencies automatically via CocoaPods, so manual intervention is typically unnecessary. If you encounter version conflicts, ensure your third-party library versions meet the following minimum requirements:
|
|
628
626
|
|
|
@@ -147,7 +147,7 @@ import { ConversationList } from '@tencentcloud/chat-uikit-react';
|
|
|
147
147
|
|
|
148
148
|
|**Prop Name**|**Type**|**Default**|**Description**|
|
|
149
149
|
|---------|---------|---------|---------|
|
|
150
|
-
|children|`ReactNode`|-|Custom center component for the conversation list header. When used in ``, and
|
|
150
|
+
|children|`ReactNode`|-|Custom center component for the conversation list header. When used in ``, and` ` are passed in by default.|
|
|
151
151
|
|left|`ReactElement`|-|Custom component for the left side of the conversation list header.|
|
|
152
152
|
|right|`ReactElement`|-|Custom component for the right side of the conversation list header.|
|
|
153
153
|
|className|`String`|-|Custom CSS class name for the root element.|
|
|
@@ -252,10 +252,10 @@ By default, it displays the current conversation list data (`filteredAndSortedCo
|
|
|
252
252
|
|
|
253
253
|
|**Prop Name**|**Type**|**Default**|**Description**|
|
|
254
254
|
|---------|---------|---------|---------|
|
|
255
|
-
|children|`ReactNode`|-|Custom component for the conversation list content area. When used in
|
|
256
|
-
|empty|`Boolean`|`false`|Flag for empty conversation list. When used in ``, it checks if
|
|
257
|
-
|loading|`Boolean`|`false`|Flag for conversation list loading state. When used in ``, it uses
|
|
258
|
-
|error|`Boolean`|`false`|Flag for conversation list load error. When used in ``, it uses
|
|
255
|
+
|children|`ReactNode`|-|Custom component for the conversation list content area. When used in , the `filteredAndSortedConversationList` is passed in and iterated as a list of `` components.|
|
|
256
|
+
|empty|`Boolean`|`false`|Flag for empty conversation list. When used in ``, it checks if` filteredAndSortedConversationList.length === 0` and passes this in.|
|
|
257
|
+
|loading|`Boolean`|`false`|Flag for conversation list loading state. When used in ``, it uses` useConversationList() `to get` isLoading` and passes it in.|
|
|
258
|
+
|error|`Boolean`|`false`|Flag for conversation list load error. When used in ``, it uses` useConversationList() `to get` isLoadError` and passes it in.|
|
|
259
259
|
|PlaceholderEmptyList|`ReactNode`|``|Custom placeholder element when the conversation list is empty.|
|
|
260
260
|
|PlaceholderLoading|`ReactNode`|``|Custom placeholder element when the conversation list is loading.|
|
|
261
261
|
|PlaceholderLoadError|`ReactNode`|``|Custom placeholder element when the conversation list fails to load.|
|
|
@@ -71,11 +71,10 @@ Sets the display mode for the attachment picker. Default: `'collapsed'`.
|
|
|
71
71
|
|
|
72
72
|
> **Note:**
|
|
73
73
|
>
|
|
74
|
-
|
|
75
74
|
> The default AttachmentPicker includes file, image, and video selection.
|
|
76
75
|
>
|
|
77
|
-
>
|
|
78
|
-
>
|
|
76
|
+
> 1. When `attachmentPickerMode` is `"collapsed"`, clicking the attachment picker opens a popup menu with file, image, and video options.
|
|
77
|
+
> 2. When `attachmentPickerMode` is `"expanded"`, the picker displays file, image, and video options inline by default.
|
|
79
78
|
|
|
80
79
|
### actions
|
|
81
80
|
|
|
@@ -2,21 +2,18 @@
|
|
|
2
2
|
|
|
3
3
|
`AudioEffectStore` provides a complete set of audio effect management APIs, including voice changer effects, reverb effects, and ear monitor functionality. Through this class, anchors can adjust their voice effects in real-time during live streaming to enhance the experience.
|
|
4
4
|
|
|
5
|
-
> **Important
|
|
5
|
+
> **Important:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> Use the **AudioEffectStore.shared** singleton to get the `AudioEffectStore` instance. The set effects will automatically become invalid after leaving the room, and need to be set again for the next room entry.
|
|
9
8
|
>
|
|
10
9
|
|
|
11
|
-
> **Note
|
|
10
|
+
> **Note:**
|
|
12
11
|
>
|
|
13
|
-
|
|
14
12
|
> Audio effect state updates are delivered through the **audioEffectState** publisher. Subscribe to it to receive real-time updates about voice changer, reverb, and ear monitor states.
|
|
15
13
|
>
|
|
16
14
|
|
|
17
|
-
> **Warning
|
|
15
|
+
> **Warning:**
|
|
18
16
|
>
|
|
19
|
-
|
|
20
17
|
> Due to the very high hardware latency of Bluetooth earphones, the ear monitor feature cannot be enabled when the anchor is wearing Bluetooth earphones. Please prompt the anchor to wear wired earphones in the user interface.
|
|
21
18
|
>
|
|
22
19
|
|
|
@@ -80,9 +77,8 @@ Call after entering the room and when voice changer effect is needed.
|
|
|
80
77
|
|
|
81
78
|
**Notes**
|
|
82
79
|
|
|
83
|
-
> **Note
|
|
80
|
+
> **Note:**
|
|
84
81
|
>
|
|
85
|
-
|
|
86
82
|
> The set effect will automatically become invalid after leaving the room. If you need the corresponding effect for the next room entry, you need to call this interface again to set it.
|
|
87
83
|
>
|
|
88
84
|
|
|
@@ -115,9 +111,8 @@ Call after entering the room and when reverb effect is needed.
|
|
|
115
111
|
|
|
116
112
|
**Notes**
|
|
117
113
|
|
|
118
|
-
> **Note
|
|
114
|
+
> **Note:**
|
|
119
115
|
>
|
|
120
|
-
|
|
121
116
|
> The set effect will automatically become invalid after leaving the room. If you need the corresponding effect for the next room entry, you need to call this interface again to set it.
|
|
122
117
|
>
|
|
123
118
|
|
|
@@ -152,9 +147,8 @@ Call after entering the room and when the anchor is wearing wired earphones.
|
|
|
152
147
|
|
|
153
148
|
**Notes**
|
|
154
149
|
|
|
155
|
-
> **Warning
|
|
150
|
+
> **Warning:**
|
|
156
151
|
>
|
|
157
|
-
|
|
158
152
|
> Due to the very high hardware latency of Bluetooth earphones, this effect cannot be enabled when the anchor is wearing Bluetooth earphones. Please try to prompt the anchor to wear wired earphones in the user interface.
|
|
159
153
|
>
|
|
160
154
|
|
|
@@ -183,9 +177,8 @@ Call after enabling the ear monitor feature.
|
|
|
183
177
|
|
|
184
178
|
**Notes**
|
|
185
179
|
|
|
186
|
-
> **Note
|
|
180
|
+
> **Note:**
|
|
187
181
|
>
|
|
188
|
-
|
|
189
182
|
> If the volume is still too low after setting it to 100, you can set the volume to a maximum of 150, but a volume exceeding 100 may cause distortion, please operate with caution.
|
|
190
183
|
>
|
|
191
184
|
|
|
@@ -2,15 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
`BarrageStore` provides a complete set of barrage management APIs, including sending text barrages, sending custom barrages, and adding local tip messages. Through this class, you can implement barrage interaction functionality in live rooms.
|
|
4
4
|
|
|
5
|
-
> **Important
|
|
5
|
+
> **Important:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> Use the **BarrageStore.create** factory method to create a `BarrageStore` instance, which requires a valid live room ID.
|
|
9
8
|
>
|
|
10
9
|
|
|
11
|
-
> **Note
|
|
10
|
+
> **Note:**
|
|
12
11
|
>
|
|
13
|
-
|
|
14
12
|
> Barrage state updates are delivered through the **barrageState** publisher. Subscribe to it to receive real-time updates of barrage data in the room.
|
|
15
13
|
>
|
|
16
14
|
|
|
@@ -77,7 +75,7 @@ Supported since version 3.5.
|
|
|
77
75
|
|**Parameter**|**Type**|**Description**|
|
|
78
76
|
|---------|---------|---------|
|
|
79
77
|
|text|String?|Text barrage content.|
|
|
80
|
-
|extensionInfo|Map<String,String>?|Extension information, can contain custom fields (such as specifying barrage color, font size, etc.).|
|
|
78
|
+
|extensionInfo|Map<String, String>?|Extension information, can contain custom fields (such as specifying barrage color, font size, etc.).|
|
|
81
79
|
|completion|CompletionHandler?|Completion callback (success/failure status).|
|
|
82
80
|
|
|
83
81
|
#### sendCustomMessage
|
|
@@ -118,9 +116,8 @@ Supported since version 3.5.
|
|
|
118
116
|
|
|
119
117
|
**Notes**
|
|
120
118
|
|
|
121
|
-
> **Note
|
|
119
|
+
> **Note:**
|
|
122
120
|
>
|
|
123
|
-
|
|
124
121
|
> This message is only displayed locally and will not be sent to other users through the network.
|
|
125
122
|
>
|
|
126
123
|
|
|
@@ -153,7 +150,7 @@ Barrage data model, containing complete attribute information of a single barrag
|
|
|
153
150
|
|timestampInSecond|Long|Barrage sending timestamp (unit: seconds), used to display sending time order.|
|
|
154
151
|
|messageType|BarrageType|Barrage message type (text or custom).|
|
|
155
152
|
|textContent|String|Message content of text type barrage, i.e., the text content of the barrage.|
|
|
156
|
-
|extensionInfo|Map<String,String>|Barrage extension information, customizable fields (such as display style, priority, etc.). Valid when messageType is TEXT.|
|
|
153
|
+
|extensionInfo|Map<String, String>|Barrage extension information, customizable fields (such as display style, priority, etc.). Valid when messageType is TEXT.|
|
|
157
154
|
|businessID|String|Business identifier ID of custom type barrage, used to distinguish custom barrages from different business scenarios.|
|
|
158
155
|
|data|String|Specific data content of custom type barrage (usually JSON format string), valid when messageType is CUSTOM.|
|
|
159
156
|
|
|
@@ -2,21 +2,18 @@
|
|
|
2
2
|
|
|
3
3
|
PK feature enables real-time interactive battles between hosts. `BattleStore` provides a comprehensive set of APIs to manage the entire PK lifecycle.
|
|
4
4
|
|
|
5
|
-
> **Important
|
|
5
|
+
> **Important:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> Always use the factory method **BattleStore.create** with a valid live room ID to create a `BattleStore` instance. Do not attempt to initialize directly.
|
|
9
8
|
>
|
|
10
9
|
|
|
11
|
-
> **Note
|
|
10
|
+
> **Note:**
|
|
12
11
|
>
|
|
13
|
-
|
|
14
12
|
> PK state updates are delivered through the **battleState** publisher. Subscribe to it to receive real-time updates about PK information, participating users, and scores.
|
|
15
13
|
>
|
|
16
14
|
|
|
17
|
-
> **Warning
|
|
15
|
+
> **Warning:**
|
|
18
16
|
>
|
|
19
|
-
|
|
20
17
|
> If a PK request does not receive a response within the specified timeout, a timeout event will be triggered. Always handle timeout scenarios in the UI.
|
|
21
18
|
>
|
|
22
19
|
|
|
@@ -37,7 +34,7 @@ PK feature enables real-time interactive battles between hosts. `BattleStore` pr
|
|
|
37
34
|
|---------|---------|---------|
|
|
38
35
|
|currentBattleInfo|StateFlow<BattleInfo?>|Current PK information.|
|
|
39
36
|
|battleUsers|StateFlow<List<SeatUserInfo>>|PK user list.|
|
|
40
|
-
|battleScore|StateFlow<Map<String,Int>>|PK score mapping.|
|
|
37
|
+
|battleScore|StateFlow<Map<String, Int>>|PK score mapping.|
|
|
41
38
|
|
|
42
39
|
## API List
|
|
43
40
|
|
|
@@ -226,15 +223,15 @@ PK-related callback events received.
|
|
|
226
223
|
|
|
227
224
|
|**Method**|**Description**|
|
|
228
225
|
|---------|---------|
|
|
229
|
-
|onBattleStarted|
|
|
230
|
-
|onBattleEnded|
|
|
231
|
-
|onUserJoinBattle|
|
|
232
|
-
|onUserExitBattle|
|
|
233
|
-
|onBattleRequestReceived|
|
|
234
|
-
|onBattleRequestCancelled|
|
|
235
|
-
|onBattleRequestTimeout|
|
|
236
|
-
|onBattleRequestAccept|
|
|
237
|
-
|onBattleRequestReject|
|
|
226
|
+
|onBattleStarted|This callback is triggered when PK officially starts, notifying all participants that PK has begun.|
|
|
227
|
+
|onBattleEnded|This callback is triggered when PK ends.|
|
|
228
|
+
|onUserJoinBattle|This callback is triggered when a user joins PK.|
|
|
229
|
+
|onUserExitBattle|This callback is triggered when a user exits PK.|
|
|
230
|
+
|onBattleRequestReceived|This callback is triggered when a PK request is received.|
|
|
231
|
+
|onBattleRequestCancelled|This callback is triggered when a PK request is cancelled.|
|
|
232
|
+
|onBattleRequestTimeout|This callback is triggered when a PK request times out.|
|
|
233
|
+
|onBattleRequestAccept|This callback is triggered when a PK request is accepted.|
|
|
234
|
+
|onBattleRequestReject|This callback is triggered when a PK request is rejected.|
|
|
238
235
|
|
|
239
236
|
### BattleConfig
|
|
240
237
|
|
|
@@ -265,7 +262,7 @@ PK-related state data provided by BattleStore.
|
|
|
265
262
|
|---------|---------|---------|
|
|
266
263
|
|currentBattleInfo|StateFlow<BattleInfo?>|Current PK information.|
|
|
267
264
|
|battleUsers|StateFlow<List<SeatUserInfo>>|PK user list.|
|
|
268
|
-
|battleScore|StateFlow<Map<String,Int>>|PK score mapping.|
|
|
265
|
+
|battleScore|StateFlow<Map<String, Int>>|PK score mapping.|
|
|
269
266
|
|
|
270
267
|
### BattleRequestCallback
|
|
271
268
|
|
|
@@ -283,7 +280,7 @@ fun onSuccess(battleInfo: BattleInfo, resultMap: Map<String, Int>)
|
|
|
283
280
|
|**Parameter**|**Type**|**Description**|
|
|
284
281
|
|---------|---------|---------|
|
|
285
282
|
|battleInfo|BattleInfo|PK information, containing detailed configuration and status of the PK.|
|
|
286
|
-
|resultMap|Map<String,Int>|Response result callback for PK request.|
|
|
283
|
+
|resultMap|Map<String, Int>|Response result callback for PK request.|
|
|
287
284
|
|
|
288
285
|
**onError**: Failure callback.
|
|
289
286
|
``` kotlin
|
|
@@ -2,9 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
`CameraView` is a view component specifically designed to display camera preview. When starting camera test, the camera rendering view will be displayed on this view.
|
|
4
4
|
|
|
5
|
-
> **Note
|
|
5
|
+
> **Note:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> This class is only available on Android platform.
|
|
9
8
|
>
|
|
10
9
|
|
|
@@ -2,21 +2,18 @@
|
|
|
2
2
|
|
|
3
3
|
Co-guest feature enables real-time interaction between hosts and audience members through a seat-based system. `CoGuestStore` provides a comprehensive set of APIs to manage the entire co-guest lifecycle.
|
|
4
4
|
|
|
5
|
-
> **Important
|
|
5
|
+
> **Important:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> Always use the factory method **CoGuestStore.create** with a valid live room ID to create a `CoGuestStore` instance. Do not attempt to initialize directly.
|
|
9
8
|
>
|
|
10
9
|
|
|
11
|
-
> **Note
|
|
10
|
+
> **Note:**
|
|
12
11
|
>
|
|
13
|
-
|
|
14
12
|
> Co-guest state updates are delivered through the **coGuestState** publisher. Subscribe to it to receive real-time updates about connected users, invitations and applications.
|
|
15
13
|
>
|
|
16
14
|
|
|
17
|
-
> **Warning
|
|
15
|
+
> **Warning:**
|
|
18
16
|
>
|
|
19
|
-
|
|
20
17
|
> If a co-guest request does not receive a response within the specified timeout, an event with `NoResponseReason.timeout` will be triggered. Always handle timeout scenarios in your UI.
|
|
21
18
|
>
|
|
22
19
|
|
|
@@ -171,9 +168,8 @@ Supported since version 3.5.
|
|
|
171
168
|
|
|
172
169
|
**Notes**
|
|
173
170
|
|
|
174
|
-
> **Note
|
|
171
|
+
> **Note:**
|
|
175
172
|
>
|
|
176
|
-
|
|
177
173
|
> If no host responds within the timeout, {ref2} event with **NoResponseReason.TIMEOUT** will be triggered.
|
|
178
174
|
>
|
|
179
175
|
|
|
@@ -203,9 +199,8 @@ Supported since version 3.5.
|
|
|
203
199
|
|
|
204
200
|
**Notes**
|
|
205
201
|
|
|
206
|
-
> **Note
|
|
202
|
+
> **Note:**
|
|
207
203
|
>
|
|
208
|
-
|
|
209
204
|
> If the application has already been processed by a host, the cancellation may have no effect.
|
|
210
205
|
>
|
|
211
206
|
|
|
@@ -374,11 +369,11 @@ Callback events received on host side.
|
|
|
374
369
|
|
|
375
370
|
|**Method**|**Description**|
|
|
376
371
|
|---------|---------|
|
|
377
|
-
|onGuestApplicationReceived|
|
|
378
|
-
|onGuestApplicationCancelled|
|
|
379
|
-
|onGuestApplicationProcessedByOtherHost|
|
|
380
|
-
|onHostInvitationResponded|
|
|
381
|
-
|onHostInvitationNoResponse|
|
|
372
|
+
|onGuestApplicationReceived|This callback is triggered when an audience applies for co-guest.|
|
|
373
|
+
|onGuestApplicationCancelled|This callback is triggered when an audience cancels co-guest application.|
|
|
374
|
+
|onGuestApplicationProcessedByOtherHost|This callback is triggered when an audience's co-guest application is processed by another host.|
|
|
375
|
+
|onHostInvitationResponded|This callback is triggered when a co-guest invitation sent by host receives a response from audience.|
|
|
376
|
+
|onHostInvitationNoResponse|This callback is triggered when a co-guest invitation sent by host receives no response.|
|
|
382
377
|
|
|
383
378
|
### GuestListener
|
|
384
379
|
|
|
@@ -388,11 +383,11 @@ Callback events received on guest side.
|
|
|
388
383
|
|
|
389
384
|
|**Method**|**Description**|
|
|
390
385
|
|---------|---------|
|
|
391
|
-
|onHostInvitationReceived|
|
|
392
|
-
|onHostInvitationCancelled|
|
|
393
|
-
|onGuestApplicationResponded|
|
|
394
|
-
|onGuestApplicationNoResponse|
|
|
395
|
-
|onKickedOffSeat|
|
|
386
|
+
|onHostInvitationReceived|This callback is triggered when receiving a co-guest invitation from host.|
|
|
387
|
+
|onHostInvitationCancelled|This callback is triggered when host cancels co-guest invitation.|
|
|
388
|
+
|onGuestApplicationResponded|This callback is triggered when audience's co-guest application receives a response from host.|
|
|
389
|
+
|onGuestApplicationNoResponse|This callback is triggered when audience's co-guest application receives no response.|
|
|
390
|
+
|onKickedOffSeat|This callback is triggered when audience is kicked off seat by host.|
|
|
396
391
|
|
|
397
392
|
### CoGuestState
|
|
398
393
|
|
|
@@ -2,21 +2,18 @@
|
|
|
2
2
|
|
|
3
3
|
Cross-room connection feature allows hosts from different live rooms to interact in real-time. `CoHostStore` provides a comprehensive set of APIs to manage the entire cross-room connection lifecycle.
|
|
4
4
|
|
|
5
|
-
> **Important
|
|
5
|
+
> **Important:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> Always use the factory method **CoHostStore.create** with a valid live room ID to create a `CoHostStore` instance. Do not attempt to initialize directly.
|
|
9
8
|
>
|
|
10
9
|
|
|
11
|
-
> **Note
|
|
10
|
+
> **Note:**
|
|
12
11
|
>
|
|
13
|
-
|
|
14
12
|
> Connection state updates are delivered through the **coHostState** publisher. Subscribe to it to receive real-time updates about connection status, connected hosts, invitations and applications.
|
|
15
13
|
>
|
|
16
14
|
|
|
17
|
-
> **Warning
|
|
15
|
+
> **Warning:**
|
|
18
16
|
>
|
|
19
|
-
|
|
20
17
|
> If a connection request does not receive a response within the specified timeout, the timeout event will be triggered. Always handle timeout scenarios in your UI.
|
|
21
18
|
>
|
|
22
19
|
|
|
@@ -298,13 +295,13 @@ Connection request callback events.
|
|
|
298
295
|
|
|
299
296
|
|**Method**|**Description**|
|
|
300
297
|
|---------|---------|
|
|
301
|
-
|onCoHostRequestReceived|
|
|
302
|
-
|onCoHostRequestCancelled|
|
|
303
|
-
|onCoHostRequestAccepted|
|
|
304
|
-
|onCoHostRequestRejected|
|
|
305
|
-
|onCoHostRequestTimeout|
|
|
306
|
-
|onCoHostUserJoined|
|
|
307
|
-
|onCoHostUserLeft|
|
|
298
|
+
|onCoHostRequestReceived|This callback is triggered when a connection request is received.|
|
|
299
|
+
|onCoHostRequestCancelled|This callback is triggered when a connection request is cancelled.|
|
|
300
|
+
|onCoHostRequestAccepted|This callback is triggered when a connection request is accepted.|
|
|
301
|
+
|onCoHostRequestRejected|This callback is triggered when a connection request is rejected.|
|
|
302
|
+
|onCoHostRequestTimeout|This callback is triggered when a connection request times out.|
|
|
303
|
+
|onCoHostUserJoined|This callback is triggered when a user joins the connection.|
|
|
304
|
+
|onCoHostUserLeft|This callback is triggered when a user leaves the connection.|
|
|
308
305
|
|
|
309
306
|
### CoHostState
|
|
310
307
|
|
|
@@ -2,15 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
`DeviceStore` provides a comprehensive set of APIs to manage audio and video devices, including microphone, camera and screen sharing features.
|
|
4
4
|
|
|
5
|
-
> **Important
|
|
5
|
+
> **Important:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> Use **DeviceStore.shared** singleton to get the `DeviceStore` instance. Do not attempt to initialize directly.
|
|
9
8
|
>
|
|
10
9
|
|
|
11
|
-
> **Note
|
|
10
|
+
> **Note:**
|
|
12
11
|
>
|
|
13
|
-
|
|
14
12
|
> Device state updates are delivered through the **deviceState** publisher. Subscribe to it to receive real-time updates about microphone, camera, network and other states.
|
|
15
13
|
>
|
|
16
14
|
|
|
@@ -2,15 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
`GiftStore` provides a complete set of gift management APIs, including sending gifts, refreshing gift lists, setting language, and listening to gift events. Through this class, gift interaction features can be implemented in live rooms.
|
|
4
4
|
|
|
5
|
-
> **Important
|
|
5
|
+
> **Important:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> Use the **GiftStore.create** factory method to create a `GiftStore` instance, passing a valid live room ID.
|
|
9
8
|
>
|
|
10
9
|
|
|
11
|
-
> **Note
|
|
10
|
+
> **Note:**
|
|
12
11
|
>
|
|
13
|
-
|
|
14
12
|
> Gift state updates are delivered through the **giftState** publisher. Subscribe to it to receive real-time updates of gift data in the room.
|
|
15
13
|
>
|
|
16
14
|
|
|
@@ -132,7 +130,7 @@ Gift data model, containing complete attribute information of a single gift.
|
|
|
132
130
|
|resourceURL|String|Network URL of the gift animation resource file, used to load gift display animations.|
|
|
133
131
|
|level|Long|Gift level, used to distinguish gift rarity or value tier.|
|
|
134
132
|
|coins|Long|Gift price (coins).|
|
|
135
|
-
|extensionInfo|Map<String,String>|Gift extension information, customizable fields (such as effect type, sending restrictions, etc.).|
|
|
133
|
+
|extensionInfo|Map<String, String>|Gift extension information, customizable fields (such as effect type, sending restrictions, etc.).|
|
|
136
134
|
|
|
137
135
|
### GiftCategory
|
|
138
136
|
|
|
@@ -143,7 +141,7 @@ Gift category.
|
|
|
143
141
|
|categoryID|String|Category unique identifier ID, used to distinguish different gift categories.|
|
|
144
142
|
|name|String|Category display name, used for UI category display (such as "Popular Gifts", "Premium Gifts").|
|
|
145
143
|
|desc|String|Category description information, used to explain the characteristics of this category.|
|
|
146
|
-
|extensionInfo|Map<String,String>|Category extension information, containing custom fields (such as sorting weight, display style, etc.).|
|
|
144
|
+
|extensionInfo|Map<String, String>|Category extension information, containing custom fields (such as sorting weight, display style, etc.).|
|
|
147
145
|
|giftList|List<Gift>|All gifts under the current category.|
|
|
148
146
|
|
|
149
147
|
### GiftState
|
|
@@ -2,15 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
`LikeStore` provides a complete set of like management APIs, including sending likes, listening to like events, and getting like states. Through this class, you can implement like interaction features in live rooms.
|
|
4
4
|
|
|
5
|
-
> **Important
|
|
5
|
+
> **Important:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> Use the **LikeStore.create** factory method to create a `LikeStore` instance, which requires a valid live room ID.
|
|
9
8
|
>
|
|
10
9
|
|
|
11
|
-
> **Note
|
|
10
|
+
> **Note:**
|
|
12
11
|
>
|
|
13
|
-
|
|
14
12
|
> Like state updates are delivered through the **likeState** publisher. Subscribe to it to receive real-time updates of like data in the room.
|
|
15
13
|
>
|
|
16
14
|
|