@tencent-rtc/mcp 1.6.4 → 1.6.6
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 +168 -10
- 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 +247 -61
- 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/chat/urls/sdk/android.md +3 -3
- package/resource/knowledge/chat/urls/sdk/flutter.md +3 -3
- package/resource/knowledge/chat/urls/sdk/ios.md +3 -3
- package/resource/knowledge/chat/urls/sdk/web.md +3 -3
- 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,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
|
|
|
@@ -2,15 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
`LiveAudienceStore` provides a complete set of audience management APIs, including fetching audience list, setting administrators, kicking users, muting, etc. Through this class, you can implement audience management functions in live rooms.
|
|
4
4
|
|
|
5
|
-
> **Important
|
|
5
|
+
> **Important:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> Use the **LiveAudienceStore.create** factory method to create a `LiveAudienceStore` instance, which requires a valid live room ID.
|
|
9
8
|
>
|
|
10
9
|
|
|
11
|
-
> **Note
|
|
10
|
+
> **Note:**
|
|
12
11
|
>
|
|
13
|
-
|
|
14
12
|
> Audience state updates are delivered through the **liveAudienceState** publisher. Subscribe to it to receive real-time updates of audience data in the room.
|
|
15
13
|
>
|
|
16
14
|
|
|
@@ -2,9 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
`LiveCoreView` provides view container for live streaming push and playback, supporting multi-person co-guest, PK and other features. Through this component, video rendering and interaction in live rooms can be implemented.
|
|
4
4
|
|
|
5
|
-
> **Important
|
|
5
|
+
> **Important:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> Before using, you need to call **setLiveID** to set the live room ID first.
|
|
9
8
|
>
|
|
10
9
|
|
|
@@ -2,15 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
`LiveSeatStore` provides a complete set of seat management APIs, including taking seat, leaving seat, locking seat, unlocking seat, kicking user off seat, remote device control, etc. Through this class, seat management functionality can be implemented in the live room.
|
|
4
4
|
|
|
5
|
-
> **Important
|
|
5
|
+
> **Important:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> Use the **LiveSeatStore.create** factory method to create a `LiveSeatStore` instance, passing a valid live room ID.
|
|
9
8
|
>
|
|
10
9
|
|
|
11
|
-
> **Note
|
|
10
|
+
> **Note:**
|
|
12
11
|
>
|
|
13
|
-
|
|
14
12
|
> Seat state updates are delivered through the **liveSeatState** publisher. Subscribe to it to receive real-time updates of seat data in the room.
|
|
15
13
|
>
|
|
16
14
|
|
|
@@ -33,7 +31,7 @@
|
|
|
33
31
|
|---------|---------|---------|
|
|
34
32
|
|seatList|StateFlow<List<SeatInfo>>|Seat list.|
|
|
35
33
|
|canvas|StateFlow<LiveCanvas>|Canvas information.|
|
|
36
|
-
|speakingUsers|StateFlow<MutableMap<String,Int>>|Speaking users.|
|
|
34
|
+
|speakingUsers|StateFlow<MutableMap<String, Int>>|Speaking users.|
|
|
37
35
|
|avStatistics|StateFlow<List<AVStatistics>>|Audio and video statistics.|
|
|
38
36
|
|
|
39
37
|
## API List
|
|
@@ -406,10 +404,10 @@ Seat related callback events.
|
|
|
406
404
|
|
|
407
405
|
|**Method**|**Description**|
|
|
408
406
|
|---------|---------|
|
|
409
|
-
|onLocalCameraOpenedByAdmin|
|
|
410
|
-
|onLocalCameraClosedByAdmin|
|
|
411
|
-
|onLocalMicrophoneOpenedByAdmin|
|
|
412
|
-
|onLocalMicrophoneClosedByAdmin|
|
|
407
|
+
|onLocalCameraOpenedByAdmin|Triggered when the local camera is opened by an admin.|
|
|
408
|
+
|onLocalCameraClosedByAdmin|Triggered when the local camera is closed by an admin.|
|
|
409
|
+
|onLocalMicrophoneOpenedByAdmin|Triggered when the local microphone is opened by an admin.|
|
|
410
|
+
|onLocalMicrophoneClosedByAdmin|Triggered when the local microphone is closed by an admin.|
|
|
413
411
|
|
|
414
412
|
### SeatUserInfo
|
|
415
413
|
|
|
@@ -484,5 +482,5 @@ Seat state data provided by LiveSeatStore.
|
|
|
484
482
|
|---------|---------|---------|
|
|
485
483
|
|seatList|StateFlow<List<SeatInfo>>|Seat list.|
|
|
486
484
|
|canvas|StateFlow<LiveCanvas>|Canvas information.|
|
|
487
|
-
|speakingUsers|StateFlow<MutableMap<String,Int>>|Speaking users.|
|
|
485
|
+
|speakingUsers|StateFlow<MutableMap<String, Int>>|Speaking users.|
|
|
488
486
|
|avStatistics|StateFlow<List<AVStatistics>>|Audio and video statistics.|
|
|
@@ -2,15 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
`LoginStore` provides a complete set of login management APIs, including user login, logout, and personal information settings. Through this class, you can manage user login status and user profiles.
|
|
4
4
|
|
|
5
|
-
> **Important
|
|
5
|
+
> **Important:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> Use **LoginStore.shared** singleton object to access the `LoginStore` instance.
|
|
9
8
|
>
|
|
10
9
|
|
|
11
|
-
> **Note
|
|
10
|
+
> **Note:**
|
|
12
11
|
>
|
|
13
|
-
|
|
14
12
|
> Login status updates are delivered through **loginState** publisher. Subscribe to it to receive real-time updates about login status.
|
|
15
13
|
>
|
|
16
14
|
|
|
@@ -189,8 +187,8 @@ Login event.
|
|
|
189
187
|
|
|
190
188
|
|**Method**|**Description**|
|
|
191
189
|
|---------|---------|
|
|
192
|
-
|onKickedOffline|
|
|
193
|
-
|onLoginExpired|
|
|
190
|
+
|onKickedOffline|Current user kicked offline.|
|
|
191
|
+
|onLoginExpired|Login ticket expired.|
|
|
194
192
|
|
|
195
193
|
### UserProfile
|
|
196
194
|
|
|
@@ -207,7 +205,7 @@ User profile
|
|
|
207
205
|
|level|Int?|Level.|
|
|
208
206
|
|birthday|Long?|Birthday.|
|
|
209
207
|
|allowType|AllowType?|Friend verification type.|
|
|
210
|
-
|customInfo|Map<String,ByteArray>?|Custom information.|
|
|
208
|
+
|customInfo|Map<String, ByteArray>?|Custom information.|
|
|
211
209
|
|
|
212
210
|
### LoginState
|
|
213
211
|
|
|
@@ -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 **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 **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
|
|
|
@@ -118,7 +116,7 @@ Supported since version 3.5.
|
|
|
118
116
|
|**Parameter**|**Type**|**Description**|
|
|
119
117
|
|---------|---------|---------|
|
|
120
118
|
|text|String|Text barrage content.|
|
|
121
|
-
|extensionInfo|Map<String,String>?|Extension information, can contain custom fields (such as specifying barrage color, font size, etc.).|
|
|
119
|
+
|extensionInfo|Map<String, String>?|Extension information, can contain custom fields (such as specifying barrage color, font size, etc.).|
|
|
122
120
|
|
|
123
121
|
#### sendCustomMessage
|
|
124
122
|
|
|
@@ -156,9 +154,8 @@ Supported since version 3.5.
|
|
|
156
154
|
|
|
157
155
|
**Notes**
|
|
158
156
|
|
|
159
|
-
> **Note
|
|
157
|
+
> **Note:**
|
|
160
158
|
>
|
|
161
|
-
|
|
162
159
|
> This message is only displayed locally and will not be sent to other users through the network.
|
|
163
160
|
>
|
|
164
161
|
|
|
@@ -191,7 +188,7 @@ Barrage data model, containing complete attribute information of a single barrag
|
|
|
191
188
|
|timestampInSecond|int|Barrage sending timestamp (unit: seconds), used to display sending time order.|
|
|
192
189
|
|messageType|BarrageType|Barrage message type (text or custom).|
|
|
193
190
|
|textContent|String|Message content of text type barrage, i.e., the text content of the barrage.|
|
|
194
|
-
|extensionInfo|Map<String,String>|Barrage extension information, customizable fields (such as display style, priority, etc.). Valid when messageType is TEXT.|
|
|
191
|
+
|extensionInfo|Map<String, String>|Barrage extension information, customizable fields (such as display style, priority, etc.). Valid when messageType is TEXT.|
|
|
195
192
|
|businessID|String|Business identifier ID of custom type barrage, used to distinguish custom barrages from different business scenarios.|
|
|
196
193
|
|data|String|Specific data content of custom type barrage (usually JSON format string), valid when messageType is CUSTOM.|
|
|
197
194
|
|
|
@@ -209,4 +206,4 @@ Barrage event listener.
|
|
|
209
206
|
|
|
210
207
|
|**Property**|**Type**|**Description**|
|
|
211
208
|
|---------|---------|---------|
|
|
212
|
-
|onCustomMessageReceived|
|
|
209
|
+
|onCustomMessageReceived|void Function(Barrage)?|Callback triggered when a custom barrage message is received.|
|
|
@@ -2,9 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
Basic beauty functionality achieves real-time beauty effect adjustment through easy-to-use APIs. `BaseBeautyStore` provides a complete set of interfaces to manage beauty effect settings and state subscriptions.
|
|
4
4
|
|
|
5
|
-
> **Note
|
|
5
|
+
> **Note:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> Beauty state updates are delivered through the **baseBeautyState** publisher. Subscribe to it to receive real-time updates about beauty effect levels.
|
|
9
8
|
>
|
|
10
9
|
|
|
@@ -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 **create(liveID:)** 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|ValueListenable<BattleInfo?>|Current PK information.|
|
|
39
36
|
|battleUsers|ValueListenable<List<SeatUserInfo>>|PK user list.|
|
|
40
|
-
|battleScore|ValueListenable<Map<String,int>>|PK score mapping.|
|
|
37
|
+
|battleScore|ValueListenable<Map<String, int>>|PK score mapping.|
|
|
41
38
|
|
|
42
39
|
## API List
|
|
43
40
|
|
|
@@ -210,15 +207,15 @@ PK-related callback events received.
|
|
|
210
207
|
|
|
211
208
|
|**Method**|**Description**|
|
|
212
209
|
|---------|---------|
|
|
213
|
-
|onBattleStarted|
|
|
214
|
-
|onBattleEnded|
|
|
215
|
-
|onUserJoinBattle|
|
|
216
|
-
|onUserExitBattle|
|
|
217
|
-
|onBattleRequestReceived|
|
|
218
|
-
|onBattleRequestCancelled|
|
|
219
|
-
|onBattleRequestTimeout|
|
|
220
|
-
|onBattleRequestAccept|
|
|
221
|
-
|onBattleRequestReject|
|
|
210
|
+
|onBattleStarted|This callback is triggered when PK officially starts, notifying all participants that PK has begun.|
|
|
211
|
+
|onBattleEnded|This callback is triggered when PK ends.|
|
|
212
|
+
|onUserJoinBattle|This callback is triggered when a user joins PK.|
|
|
213
|
+
|onUserExitBattle|This callback is triggered when a user exits PK.|
|
|
214
|
+
|onBattleRequestReceived|This callback is triggered when a PK request is received.|
|
|
215
|
+
|onBattleRequestCancelled|This callback is triggered when a PK request is cancelled.|
|
|
216
|
+
|onBattleRequestTimeout|This callback is triggered when a PK request times out.|
|
|
217
|
+
|onBattleRequestAccept|This callback is triggered when a PK request is accepted.|
|
|
218
|
+
|onBattleRequestReject|This callback is triggered when a PK request is rejected.|
|
|
222
219
|
|
|
223
220
|
### BattleConfig
|
|
224
221
|
|
|
@@ -249,7 +246,7 @@ PK-related state data provided by BattleStore.
|
|
|
249
246
|
|---------|---------|---------|
|
|
250
247
|
|currentBattleInfo|ValueListenable<BattleInfo?>|Current PK information.|
|
|
251
248
|
|battleUsers|ValueListenable<List<SeatUserInfo>>|PK user list.|
|
|
252
|
-
|battleScore|ValueListenable<Map<String,int>>|PK score mapping.|
|
|
249
|
+
|battleScore|ValueListenable<Map<String, int>>|PK score mapping.|
|
|
253
250
|
|
|
254
251
|
### BattleRequestCompletionHandler
|
|
255
252
|
|
|
@@ -262,7 +259,7 @@ Completion handler for PK requests in Dart, containing the result of the PK requ
|
|
|
262
259
|
|**Property**|**Type**|**Description**|
|
|
263
260
|
|---------|---------|---------|
|
|
264
261
|
|battleInfo|BattleInfo?|PK information returned on success.|
|
|
265
|
-
|resultMap|Map<String,int>?|Response result mapping for PK request.|
|
|
262
|
+
|resultMap|Map<String, int>?|Response result mapping for PK request.|
|
|
266
263
|
|
|
267
264
|
## Usage Example
|
|
268
265
|
``` dart
|
|
@@ -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
|
|
|
@@ -162,9 +159,8 @@ Supported since version 3.5.
|
|
|
162
159
|
|
|
163
160
|
**Notes**
|
|
164
161
|
|
|
165
|
-
> **Note
|
|
162
|
+
> **Note:**
|
|
166
163
|
>
|
|
167
|
-
|
|
168
164
|
> If no host responds within the timeout, {ref2} event with **NoResponseReason.timeout** will be triggered.
|
|
169
165
|
>
|
|
170
166
|
|
|
@@ -191,9 +187,8 @@ Supported since version 3.5.
|
|
|
191
187
|
|
|
192
188
|
**Notes**
|
|
193
189
|
|
|
194
|
-
> **Note
|
|
190
|
+
> **Note:**
|
|
195
191
|
>
|
|
196
|
-
|
|
197
192
|
> If the application has already been processed by a host, the cancellation may have no effect.
|
|
198
193
|
>
|
|
199
194
|
|
|
@@ -334,11 +329,11 @@ Callback events received on host side.
|
|
|
334
329
|
|
|
335
330
|
|**Method**|**Description**|
|
|
336
331
|
|---------|---------|
|
|
337
|
-
|onGuestApplicationReceived|
|
|
338
|
-
|onGuestApplicationCancelled|
|
|
339
|
-
|onGuestApplicationProcessedByOtherHost|
|
|
340
|
-
|onHostInvitationResponded|
|
|
341
|
-
|onHostInvitationNoResponse|
|
|
332
|
+
|onGuestApplicationReceived|This callback is triggered when an audience applies for co-guest.|
|
|
333
|
+
|onGuestApplicationCancelled|This callback is triggered when an audience cancels co-guest application.|
|
|
334
|
+
|onGuestApplicationProcessedByOtherHost|This callback is triggered when an audience's co-guest application is processed by another host.|
|
|
335
|
+
|onHostInvitationResponded|This callback is triggered when a co-guest invitation sent by host receives a response from audience.|
|
|
336
|
+
|onHostInvitationNoResponse|This callback is triggered when a co-guest invitation sent by host receives no response.|
|
|
342
337
|
|
|
343
338
|
### GuestListener
|
|
344
339
|
|
|
@@ -348,11 +343,11 @@ Callback events received on guest side.
|
|
|
348
343
|
|
|
349
344
|
|**Method**|**Description**|
|
|
350
345
|
|---------|---------|
|
|
351
|
-
|onHostInvitationReceived|
|
|
352
|
-
|onHostInvitationCancelled|
|
|
353
|
-
|onGuestApplicationResponded|
|
|
354
|
-
|onGuestApplicationNoResponse|
|
|
355
|
-
|onKickedOffSeat|
|
|
346
|
+
|onHostInvitationReceived|This callback is triggered when receiving a co-guest invitation from host.|
|
|
347
|
+
|onHostInvitationCancelled|This callback is triggered when host cancels co-guest invitation.|
|
|
348
|
+
|onGuestApplicationResponded|This callback is triggered when audience's co-guest application receives a response from host.|
|
|
349
|
+
|onGuestApplicationNoResponse|This callback is triggered when audience's co-guest application receives no response.|
|
|
350
|
+
|onKickedOffSeat|This callback is triggered when audience is kicked off seat by host.|
|
|
356
351
|
|
|
357
352
|
### CoGuestState
|
|
358
353
|
|
|
@@ -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
|
|
|
@@ -266,13 +263,13 @@ Connection request callback events.
|
|
|
266
263
|
|
|
267
264
|
|**Method**|**Description**|
|
|
268
265
|
|---------|---------|
|
|
269
|
-
|onCoHostRequestReceived|
|
|
270
|
-
|onCoHostRequestCancelled|
|
|
271
|
-
|onCoHostRequestAccepted|
|
|
272
|
-
|onCoHostRequestRejected|
|
|
273
|
-
|onCoHostRequestTimeout|
|
|
274
|
-
|onCoHostUserJoined|
|
|
275
|
-
|onCoHostUserLeft|
|
|
266
|
+
|onCoHostRequestReceived|This callback is triggered when a connection request is received.|
|
|
267
|
+
|onCoHostRequestCancelled|This callback is triggered when a connection request is cancelled.|
|
|
268
|
+
|onCoHostRequestAccepted|This callback is triggered when a connection request is accepted.|
|
|
269
|
+
|onCoHostRequestRejected|This callback is triggered when a connection request is rejected.|
|
|
270
|
+
|onCoHostRequestTimeout|This callback is triggered when a connection request times out.|
|
|
271
|
+
|onCoHostUserJoined|This callback is triggered when a user joins the connection.|
|
|
272
|
+
|onCoHostUserLeft|This callback is triggered when a user leaves the connection.|
|
|
276
273
|
|
|
277
274
|
### CoHostState
|
|
278
275
|
|
|
@@ -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 **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 **state** 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
|
|
|
@@ -124,7 +122,7 @@ Gift data model, containing complete attribute information of a single gift.
|
|
|
124
122
|
|resourceURL|String|Network URL of the gift animation resource file, used to load gift display animations.|
|
|
125
123
|
|level|int|Gift level, used to distinguish gift rarity or value tier.|
|
|
126
124
|
|coins|int|Gift price (coins).|
|
|
127
|
-
|extensionInfo|Map<String,String>|Gift extension information, customizable fields (such as effect type, sending restrictions, etc.).|
|
|
125
|
+
|extensionInfo|Map<String, String>|Gift extension information, customizable fields (such as effect type, sending restrictions, etc.).|
|
|
128
126
|
|
|
129
127
|
### GiftCategory
|
|
130
128
|
|
|
@@ -135,7 +133,7 @@ Gift category.
|
|
|
135
133
|
|categoryID|String|Category unique identifier ID, used to distinguish different gift categories.|
|
|
136
134
|
|name|String|Category display name, used for UI category display (such as "Popular Gifts", "Premium Gifts").|
|
|
137
135
|
|desc|String|Category description information, used to explain the characteristics of this category.|
|
|
138
|
-
|extensionInfo|Map<String,String>|Category extension information, containing custom fields (such as sorting weight, display style, etc.).|
|
|
136
|
+
|extensionInfo|Map<String, String>|Category extension information, containing custom fields (such as sorting weight, display style, etc.).|
|
|
139
137
|
|giftList|List<Gift>|All gifts under the current category.|
|
|
140
138
|
|
|
141
139
|
### 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 **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
|
|
|
@@ -2,15 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
`LiveAudienceStore` provides a complete set of audience management APIs, including fetching audience list, setting administrators, kicking users, muting, etc. Through this class, you can implement audience management functions in live rooms.
|
|
4
4
|
|
|
5
|
-
> **Important
|
|
5
|
+
> **Important:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> Use the **LiveAudienceStore.create** factory method to create a `LiveAudienceStore` instance, which requires a valid live room ID.
|
|
9
8
|
>
|
|
10
9
|
|
|
11
|
-
> **Note
|
|
10
|
+
> **Note:**
|
|
12
11
|
>
|
|
13
|
-
|
|
14
12
|
> Audience state updates are delivered through the **liveAudienceState** publisher. Subscribe to it to receive real-time updates of audience data in the room.
|
|
15
13
|
>
|
|
16
14
|
|
|
@@ -2,9 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
`LiveCoreView` provides view container for live streaming push and playback, supporting multi-person co-guest, PK and other features. Through this component, video rendering and interaction in live rooms can be implemented.
|
|
4
4
|
|
|
5
|
-
> **Important
|
|
5
|
+
> **Important:**
|
|
6
6
|
>
|
|
7
|
-
|
|
8
7
|
> Before using, you need to call **LiveCoreController.setLiveID** to set the live room ID first.
|
|
9
8
|
>
|
|
10
9
|
|