@tencent-rtc/mcp 1.6.6 → 1.6.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/knowledge/build-index.js +3 -0
- package/knowledge/content-loader.js +3 -1
- package/knowledge/search/filter-pool.js +12 -4
- package/knowledge/search/query-normalizer.js +76 -0
- package/knowledge/search/search-knowledge.js +104 -5
- package/package.json +1 -1
- package/resource/_schema/feature-aliases.yaml +1 -0
- package/resource/_schema/query-normalization.yaml +9 -0
- package/resource/index/manifest.json +1 -1
- package/resource/integration/callkit/preset/android/integration.md +3 -14
- package/resource/integration/callkit/preset/flutter/integration.md +1 -12
- package/resource/integration/callkit/preset/ios/integration.md +2 -12
- package/resource/integration/callkit/preset/react/integration.md +1 -14
- package/resource/integration/callkit/preset/vue/integration.md +1 -14
- package/resource/integration/chat/preset/android/integration.md +6 -13
- package/resource/integration/chat/preset/flutter/integration.md +1 -8
- package/resource/integration/chat/preset/ios/integration.md +4 -12
- package/resource/integration/chat/preset/react/integration.md +6 -16
- package/resource/integration/chat/preset/vue/integration.md +0 -9
- package/resource/integration/livekit/preset/live/android/live-audience-integration.md +2 -6
- package/resource/integration/livekit/preset/live/android/live-host-integration.md +1 -11
- package/resource/integration/livekit/preset/live/android/live-list-integration.md +2 -6
- package/resource/integration/livekit/preset/live/android/prepare-integration.md +2 -7
- package/resource/integration/livekit/preset/live/ios/live-audience-integration.md +2 -7
- package/resource/integration/livekit/preset/live/ios/live-host-integration.md +1 -13
- package/resource/integration/livekit/preset/live/ios/live-list-integration.md +2 -10
- package/resource/integration/livekit/preset/live/ios/prepare-integration.md +3 -8
- package/resource/integration/livekit/preset/live/vue/live-list-integration.md +0 -4
- package/resource/integration/livekit/preset/live/vue/live-player-desk-integration.md +1 -5
- package/resource/integration/livekit/preset/live/vue/live-player-h5-integration.md +2 -7
- package/resource/integration/livekit/preset/live/vue/live-pusher-integration.md +2 -8
- package/resource/integration/roomkit/preset/vue/integration.md +0 -11
- package/resource/knowledge/callkit/core-sdk/android/answer-call.md +0 -7
- package/resource/knowledge/callkit/core-sdk/android/make-call.md +0 -8
- package/resource/knowledge/callkit/core-sdk/android/offline-push.md +1 -9
- package/resource/knowledge/callkit/core-sdk/flutter/answer-call.md +2 -8
- package/resource/knowledge/callkit/core-sdk/flutter/make-call.md +2 -8
- package/resource/knowledge/callkit/core-sdk/flutter/offline-push.md +1 -16
- package/resource/knowledge/callkit/core-sdk/ios/answer-call.md +0 -8
- package/resource/knowledge/callkit/core-sdk/ios/make-call.md +0 -8
- package/resource/knowledge/callkit/core-sdk/ios/offline-push.md +0 -11
- package/resource/knowledge/callkit/core-sdk/uni-app/answer-call.md +178 -200
- package/resource/knowledge/callkit/core-sdk/uni-app/make-call.md +195 -217
- package/resource/knowledge/callkit/faq/android.md +4 -14
- package/resource/knowledge/callkit/faq/common.md +0 -2
- package/resource/knowledge/callkit/faq/error-code.md +2 -4
- package/resource/knowledge/callkit/faq/ios.md +1 -4
- package/resource/knowledge/callkit/preset/android/api.md +0 -6
- package/resource/knowledge/callkit/preset/ios/api.md +0 -4
- package/resource/knowledge/callkit/preset/react/api.md +3 -4
- package/resource/knowledge/callkit/preset/react/uikit-api-reference.md +3 -4
- package/resource/knowledge/callkit/preset/vue/api.md +3 -4
- package/resource/knowledge/callkit/preset/vue/uikit-api-reference.md +3 -4
- package/resource/knowledge/chat/preset/android/features/chat-setting.md +0 -5
- package/resource/knowledge/chat/preset/android/features/contact-list.md +0 -7
- package/resource/knowledge/chat/preset/android/features/conversation-list.md +0 -6
- package/resource/knowledge/chat/preset/android/features/language.md +0 -8
- package/resource/knowledge/chat/preset/android/features/message-input.md +0 -6
- package/resource/knowledge/chat/preset/android/features/message-list.md +0 -8
- package/resource/knowledge/chat/preset/android/features/search.md +0 -7
- package/resource/knowledge/chat/preset/android/features/theme.md +0 -4
- package/resource/knowledge/chat/preset/android-view/integration.md +0 -6
- package/resource/knowledge/chat/preset/flutter/features/chat-setting.md +0 -4
- package/resource/knowledge/chat/preset/flutter/features/contact-list.md +0 -9
- package/resource/knowledge/chat/preset/flutter/features/conversation-list.md +0 -7
- package/resource/knowledge/chat/preset/flutter/features/language.md +0 -5
- package/resource/knowledge/chat/preset/flutter/features/message-input.md +0 -6
- package/resource/knowledge/chat/preset/flutter/features/message-list.md +0 -8
- package/resource/knowledge/chat/preset/flutter/features/search.md +0 -5
- package/resource/knowledge/chat/preset/flutter/features/theme.md +0 -4
- package/resource/knowledge/chat/preset/ios/features/chat-setting.md +0 -5
- package/resource/knowledge/chat/preset/ios/features/contact-list.md +0 -5
- package/resource/knowledge/chat/preset/ios/features/conversation-list.md +0 -7
- package/resource/knowledge/chat/preset/ios/features/language.md +1 -8
- package/resource/knowledge/chat/preset/ios/features/message-input.md +0 -6
- package/resource/knowledge/chat/preset/ios/features/message-list.md +0 -8
- package/resource/knowledge/chat/preset/ios/features/search.md +0 -5
- package/resource/knowledge/chat/preset/ios/features/theme.md +0 -4
- package/resource/knowledge/chat/preset/ios-uikit/integration.md +0 -6
- package/resource/knowledge/chat/preset/react/features/contact-list.md +0 -23
- package/resource/knowledge/chat/preset/react/features/conversation-actions.md +2 -11
- package/resource/knowledge/chat/preset/react/features/conversation-list.md +4 -26
- package/resource/knowledge/chat/preset/react/features/conversation-preview.md +0 -6
- package/resource/knowledge/chat/preset/react/features/search.md +0 -1
- package/resource/knowledge/chat/preset/react/features/theme.md +0 -1
- package/resource/knowledge/chat/preset/vue/features/contact-list.md +3 -9
- package/resource/knowledge/chat/preset/vue/features/conversation-actions.md +0 -3
- package/resource/knowledge/chat/preset/vue/features/conversation-list.md +2 -13
- package/resource/knowledge/chat/preset/vue/features/conversation-preview.md +2 -3
- package/resource/knowledge/chat/preset/vue/features/conversation-search.md +1 -0
- package/resource/knowledge/chat/preset/vue/features/search.md +4 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BarrageStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/BattleStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CameraView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/android/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/android/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/GiftStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LiveSeatStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/android/LoginStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BarrageStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BaseBeautyStore.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/BattleStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/GiftStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LiveSeatStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/flutter/LoginStore.md +1 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/AudioEffectStore.md +0 -7
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BarrageStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BaseBeautyStore.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/BattleStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoGuestStore.md +0 -5
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/CoHostStore.md +0 -3
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/DeviceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/GiftStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LikeStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveAudienceStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveCoreView.md +0 -1
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LiveSeatStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/api-reference/ios/LoginStore.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/android/audience-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/android/audio-effect.md +2 -3
- package/resource/knowledge/livekit/core-sdk/features/android/barrage.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/android/base-beauty.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/android/gift.md +2 -7
- package/resource/knowledge/livekit/core-sdk/features/android/live-list.md +3 -4
- package/resource/knowledge/livekit/core-sdk/features/flutter/audience-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/audio-effect.md +2 -4
- package/resource/knowledge/livekit/core-sdk/features/flutter/barrage.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/base-beauty.md +0 -2
- package/resource/knowledge/livekit/core-sdk/features/flutter/gift.md +2 -7
- package/resource/knowledge/livekit/core-sdk/features/flutter/live-list.md +3 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/audience-list.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/audio-effect.md +2 -4
- package/resource/knowledge/livekit/core-sdk/features/ios/barrage.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/base-beauty.md +2 -2
- package/resource/knowledge/livekit/core-sdk/features/ios/gift.md +2 -7
- package/resource/knowledge/livekit/core-sdk/features/ios/live-list.md +3 -4
- package/resource/knowledge/livekit/core-sdk/live/android/co-guest-interaction.md +0 -3
- package/resource/knowledge/livekit/core-sdk/live/android/host-interaction.md +0 -4
- package/resource/knowledge/livekit/core-sdk/live/android/integration.md +1 -4
- package/resource/knowledge/livekit/core-sdk/live/flutter/co-guest-interaction.md +1 -3
- package/resource/knowledge/livekit/core-sdk/live/flutter/host-interaction.md +0 -1
- package/resource/knowledge/livekit/core-sdk/live/flutter/integration.md +1 -4
- package/resource/knowledge/livekit/core-sdk/live/ios/co-guest-interaction.md +0 -3
- package/resource/knowledge/livekit/core-sdk/live/ios/host-interaction.md +0 -3
- package/resource/knowledge/livekit/core-sdk/live/ios/integration.md +1 -4
- package/resource/knowledge/livekit/core-sdk/voice/android/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/voice/android/host-interaction.md +0 -5
- package/resource/knowledge/livekit/core-sdk/voice/android/integration.md +1 -4
- package/resource/knowledge/livekit/core-sdk/voice/flutter/co-guest-interaction.md +1 -4
- package/resource/knowledge/livekit/core-sdk/voice/flutter/integration.md +3 -6
- package/resource/knowledge/livekit/core-sdk/voice/ios/co-guest-interaction.md +0 -2
- package/resource/knowledge/livekit/core-sdk/voice/ios/host-interaction.md +0 -4
- package/resource/knowledge/livekit/core-sdk/voice/ios/integration.md +1 -4
- package/resource/knowledge/livekit/faq/error-code.md +0 -1
- package/resource/knowledge/livekit/preset/live/vue/features/barrage.md +2 -3
- package/resource/knowledge/livekit/preset/live/vue/features/live-audience-list.md +3 -3
- package/resource/knowledge/livekit/preset/live/vue/features/live-view.md +3 -3
- package/resource/knowledge/push/api-reference/android.md +0 -1
- package/resource/knowledge/push/api-reference/harmonyos.md +0 -2
- package/resource/knowledge/push/api-reference/react-native.md +3 -5
- package/resource/knowledge/push/api-reference/uni-app.md +3 -5
- package/resource/knowledge/push/api-reference/unity.md +0 -1
- package/resource/knowledge/push/api-reference/unreal-engine.md +0 -1
- package/resource/knowledge/push/config/android.md +0 -24
- package/resource/knowledge/push/config/harmonyos.md +0 -1
- package/resource/knowledge/push/config/ios.md +0 -3
- package/resource/knowledge/push/config/react-native.md +0 -29
- package/resource/knowledge/push/config/unity.md +1 -24
- package/resource/knowledge/push/config/unreal-engine.md +1 -24
- package/resource/knowledge/push/integration/android.md +0 -14
- package/resource/knowledge/push/integration/flutter.md +0 -19
- package/resource/knowledge/push/integration/harmonyos.md +0 -2
- package/resource/knowledge/push/integration/ios.md +0 -3
- package/resource/knowledge/push/integration/react-native.md +0 -24
- package/resource/knowledge/push/integration/uni-app.md +1 -11
- package/resource/knowledge/push/integration/unity.md +0 -9
- package/resource/knowledge/push/integration/unreal-engine.md +1 -17
- package/resource/knowledge/roomkit/core-sdk/android/call-user-to-room.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/android/room-participant-state.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/android/room-state.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/android/schedule-room.md +1 -5
- package/resource/knowledge/roomkit/core-sdk/ios/call-user-to-room.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/ios/room-participant-state.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/ios/room-state.md +0 -4
- package/resource/knowledge/roomkit/core-sdk/ios/schedule-room.md +1 -5
- package/resource/knowledge/roomkit/core-sdk/vue/call-user-to-room.md +1 -1
- package/resource/knowledge/roomkit/core-sdk/vue/device-state.md +0 -6
- package/resource/knowledge/roomkit/core-sdk/vue/free-beauty-panel.md +0 -9
- package/resource/knowledge/roomkit/core-sdk/vue/room-chat.md +0 -11
- package/resource/knowledge/roomkit/core-sdk/vue/room-participant-state.md +1 -5
- package/resource/knowledge/roomkit/core-sdk/vue/room-state.md +1 -8
- package/resource/knowledge/roomkit/core-sdk/vue/room-view.md +0 -3
- package/resource/knowledge/roomkit/core-sdk/vue/screen-share.md +0 -3
- package/resource/knowledge/roomkit/core-sdk/vue/virtual-background.md +0 -5
- package/resource/knowledge/roomkit/preset/android/integration.md +0 -4
- package/resource/knowledge/roomkit/preset/flutter/integration.md +1 -13
- package/resource/knowledge/roomkit/preset/ios/integration.md +0 -6
- package/resource/knowledge/roomkit/preset/react/integration.md +0 -16
- package/resource/knowledge/rtcengine/web/api.md +1 -8
- package/resource/knowledge/rtcengine/web/faq.md +3 -5
- package/resource/knowledge/rtcengine/web/how_to_integrated_web_sdk.md +0 -6
- package/resource/knowledge/rtcengine/web/plugin/20-advanced-customized-capture-rendering.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/21-advanced-auto-play-policy.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/26-advanced-publish-cdn-stream.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/27-advanced-small-stream.md +1 -1
- package/resource/knowledge/rtcengine/web/plugin/31-advanced-plugins-overview.md +1 -3
- package/resource/knowledge/rtcengine/web/plugin/34-advanced-proxy.md +2 -4
- package/resource/knowledge/rtcengine/web/plugin/36-advanced-virtual-background.md +0 -4
- package/resource/knowledge/rtcengine/web/plugin/39-advanced-video-decoder.md +0 -2
- package/resource/knowledge/trtc/android/TRTCCloud.md +8 -56
- package/resource/knowledge/trtc/android/TRTCCloudDef.md +6 -7
- package/resource/knowledge/trtc/android/TRTCCloudListener.md +1 -18
- package/resource/knowledge/trtc/android/TXAudioEffectManager.md +0 -14
- package/resource/knowledge/trtc/android/TXDeviceManager.md +0 -1
- package/resource/knowledge/trtc/android/TXLiteAVCode.md +1 -1
- package/resource/knowledge/trtc/c++/ITRTCCloud.md +7 -59
- package/resource/knowledge/trtc/c++/ITXAudioEffectManager.md +0 -14
- package/resource/knowledge/trtc/c++/ITXDeviceManager.md +0 -4
- package/resource/knowledge/trtc/c++/TRTCCloudCallback.md +1 -19
- package/resource/knowledge/trtc/c++/TRTCTypeDef.md +6 -7
- package/resource/knowledge/trtc/c++/TXLiteAVCode.md +1 -1
- package/resource/knowledge/trtc/ios/TRTCCloud.md +9 -60
- package/resource/knowledge/trtc/ios/TRTCCloudDef.md +6 -7
- package/resource/knowledge/trtc/ios/TRTCCloudDelegate.md +1 -19
- package/resource/knowledge/trtc/ios/TXAudioEffectManager.md +0 -13
- package/resource/knowledge/trtc/ios/TXDeviceManager.md +0 -4
- package/resource/knowledge/trtc/ios/TXLiteAVCode.md +1 -1
- package/server.js +1 -1
- package/tools/common/search_trtc_knowledge.js +2 -0
- package/tools/definitions/search_trtc_knowledge_def.js +1 -0
- package/utils/report-cls-client.js +3 -3
- package/utils/report-es-client.js +1 -1
- package/resource/knowledge/roomkit/core-sdk/flutter/call-user-to-room.md +0 -230
- package/resource/knowledge/roomkit/core-sdk/flutter/room-participant-state.md +0 -797
- package/resource/knowledge/roomkit/core-sdk/flutter/room-state.md +0 -325
- package/resource/knowledge/roomkit/core-sdk/flutter/schedule-room.md +0 -325
|
@@ -17,16 +17,10 @@ TUILiveKit’s host go-live page delivers a **fully featured, ready-to-use inter
|
|
|
17
17
|
|
|
18
18
|
### Step 1. Activate the Service
|
|
19
19
|
|
|
20
|
-
Refer to the Activate Service document to get the `TUILiveKit` trial version or activate the paid version.
|
|
21
|
-
|
|
22
20
|
### Step 2. Integrate the SDK
|
|
23
21
|
|
|
24
|
-
Refer to Preparations guide to integrate the `TUILiveKit` SDK.
|
|
25
|
-
|
|
26
22
|
### Step 3. Add the Pre-Live Preparation Page
|
|
27
23
|
|
|
28
|
-
The `AnchorPrepareView` component provides built-in camera preview, audio and layout settings, and other configuration options. Instantiate and display `AnchorPrepareView` as shown below:
|
|
29
|
-
|
|
30
24
|
【Kotlin】
|
|
31
25
|
``` java
|
|
32
26
|
import android.os.Bundle
|
|
@@ -63,8 +57,6 @@ class AnchorActivity : AppCompatActivity() {
|
|
|
63
57
|
|
|
64
58
|
### Step 4. Add the Host Streaming Page
|
|
65
59
|
|
|
66
|
-
The `AnchorView` component includes audio/video streaming, audience co-hosting, live interaction, and live room management. Instantiate and display `AnchorView` as shown below:
|
|
67
|
-
|
|
68
60
|
【Kotlin】
|
|
69
61
|
``` java
|
|
70
62
|
|
|
@@ -200,7 +192,7 @@ TUILiveKit manages UI image assets in the Android `drawable` resource folder. To
|
|
|
200
192
|
|
|
201
193
|
## Next Steps
|
|
202
194
|
|
|
203
|
-
Once you’ve integrated the **host go-live** feature, you can add additional capabilities such as **audience viewing**, **live stream list**, and **gift system**.
|
|
195
|
+
Once you’ve integrated the **host go-live** feature, you can add additional capabilities such as **audience viewing**, **live stream list**, and **gift system**.
|
|
204
196
|
|
|
205
197
|
|**Feature**|**Description**|**Integration Guide**|
|
|
206
198
|
|---------|---------|---------|
|
|
@@ -212,8 +204,6 @@ Once you’ve integrated the **host go-live** feature, you can add additional ca
|
|
|
212
204
|
|
|
213
205
|
### No video after going live?
|
|
214
206
|
|
|
215
|
-
Navigate to **App Info > Permissions > Camera** and ensure camera access is enabled. See the screenshot below:
|
|
216
|
-
|
|
217
207
|
### Unable to go live after clicking the go-live button and seeing a "Not Logged In" prompt?
|
|
218
208
|
|
|
219
209
|
See the Login Guide and confirm your login functionality is integrated.
|
|
@@ -18,12 +18,8 @@ This document provides a detailed introduction to the **Live Stream List Page**
|
|
|
18
18
|
|
|
19
19
|
### Step 1. Activate the Service
|
|
20
20
|
|
|
21
|
-
Refer to the Activate Service document to enable the Free trial or official package.
|
|
22
|
-
|
|
23
21
|
### Step 2. Code Integration
|
|
24
22
|
|
|
25
|
-
Refer to Preparations guide to integrate the TUILiveKit SDK.
|
|
26
|
-
|
|
27
23
|
### Step 3. Add the Live Stream List Page
|
|
28
24
|
|
|
29
25
|
The **LiveListView** component is a dedicated view for displaying the live stream list. It automatically pulls the live room list, supports different display styles (**single-column** and **double-column**).
|
|
@@ -238,7 +234,7 @@ liveListView.init(this, Style.DOUBLE_COLUMN, liveListViewAdapter, null);
|
|
|
238
234
|
|
|
239
235
|
## Next Steps
|
|
240
236
|
|
|
241
|
-
Congratulations! You have successfully integrated the **Live Stream List** feature. Next, you can implement features such as **Host Live Streaming** and **Audience Viewing**. Please
|
|
237
|
+
Congratulations! You have successfully integrated the **Live Stream List** feature. Next, you can implement features such as **Host Live Streaming** and **Audience Viewing**. Please
|
|
242
238
|
| <strong>Feature</strong> | <strong>Description</strong> | <strong>Integration Guide</strong> |
|
|
243
239
|
| --- | --- | --- |
|
|
244
240
|
| <strong>Host Streaming</strong> | The complete workflow for a host to start a stream, including pre-stream setup and various in-stream interactions. | Host Streaming |
|
|
@@ -258,4 +254,4 @@ A single-column waterfall flow previews one live room at a time, while a double-
|
|
|
258
254
|
|
|
259
255
|
Yes, the duration of previewing a live room is counted towards the audience's audio/video duration, which is a paid service. For detailed
|
|
260
256
|
|
|
261
|
-
Pricing, you can
|
|
257
|
+
Pricing, you can .
|
|
@@ -2,15 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
**TUILiveKit** is a comprehensive live-streaming component. Once integrated, it allows you to quickly implement the following key functional modules for your Android application:
|
|
4
4
|
|
|
5
|
-
|**Host Prepare Page**|**Host Streaming Page**|**Live Stream List**|**Audience Viewing Page**|
|
|
6
|
-
|---------|---------|---------|---------|
|
|
7
|
-
|||||
|
|
8
|
-
|
|
9
5
|
## **Preparations**
|
|
10
6
|
|
|
11
7
|
### Activate Service
|
|
12
8
|
|
|
13
|
-
Before using **TUILiveKit**, please
|
|
9
|
+
Before using **TUILiveKit**, please .
|
|
14
10
|
|
|
15
11
|
### Environment Requirements
|
|
16
12
|
- **Android** **Studio Arctic Fox (2020.3.1)** or a later version.
|
|
@@ -153,7 +149,6 @@ After completing the steps above, Android Studio will typically prompt you with
|
|
|
153
149
|
After code integration, the next step is to complete the login. All **TUILiveKit** features require a successful login to function properly, so ensure your parameters are configured correctly.
|
|
154
150
|
|
|
155
151
|
> **Note:**
|
|
156
|
-
>
|
|
157
152
|
> In the example code, the login API is called directly. However, in a real-world application, it is highly recommended that you call the **TUILiveKit** login service only after your own user authentication and other internal login processes are complete. This prevents potential business logic confusion or data inconsistency caused by calling the login service too early, and it better aligns with your existing user management system.
|
|
158
153
|
>
|
|
159
154
|
|
|
@@ -230,7 +225,7 @@ class YourLoginService {
|
|
|
230
225
|
|
|
231
226
|
## Next Steps
|
|
232
227
|
|
|
233
|
-
Congratulations! You have successfully integrated the **TUILiveKit** component and completed the login. You can now implement features such as host streaming, viewer watching, and the live stream list. Please
|
|
228
|
+
Congratulations! You have successfully integrated the **TUILiveKit** component and completed the login. You can now implement features such as host streaming, viewer watching, and the live stream list. Please
|
|
234
229
|
| <strong>Feature</strong> | <strong>Description</strong> | <strong>Integration Guide</strong> |
|
|
235
230
|
| --- | --- | --- |
|
|
236
231
|
| <strong>Video Live Streaming</strong> | Includes a full suite of features such as host broadcasting, audience viewing, interactive co-hosting, beauty filters, gifts, and bullet chat. | - Host Broadcasting<br>- Audience Viewing |
|
|
@@ -17,12 +17,8 @@
|
|
|
17
17
|
|
|
18
18
|
### Step 1. Activate the Service
|
|
19
19
|
|
|
20
|
-
Refer to the Activate Service document to get the `TUILiveKit` trial version or activate the paid version.
|
|
21
|
-
|
|
22
20
|
### Step 2. Code Integration
|
|
23
21
|
|
|
24
|
-
Refer to Preparations guide to integrate the TUILiveKit SDK.
|
|
25
|
-
|
|
26
22
|
### Step 3. Add an Audience Viewing view
|
|
27
23
|
|
|
28
24
|
In your audience view controller `YourAudienceViewController`, initialize and add `AudienceView` for audience streaming:
|
|
@@ -171,7 +167,6 @@ present(audienceVC, animated: false)
|
|
|
171
167
|
TUILiveKit uses the [Apple Strings Catalog](https://developer.apple.com/documentation/xcode/localizing-and-varying-text-with-a-string-catalog)(`.xcstrings`) format, introduced in **Xcode 15**, to manage the text displayed in the UI. You can modify the string resources using Xcode's graphical interface:
|
|
172
168
|
|
|
173
169
|
> **Note:**
|
|
174
|
-
>
|
|
175
170
|
> [Apple Strings Catalog](https://developer.apple.com/documentation/xcode/localizing-and-varying-text-with-a-string-catalog) (.xcstrings) is a localization format introduced in Xcode 15. It enhances how developers manage localized strings, supporting a structured format to handle plurals, device-specific variants, etc. This format is becoming the recommended way to manage localization for iOS and macOS applications.
|
|
176
171
|
>
|
|
177
172
|
|
|
@@ -181,7 +176,7 @@ TUILiveKit uses `TUILiveKit.xcassets` to manage the image resources for the UI.
|
|
|
181
176
|
|
|
182
177
|
## Next Steps
|
|
183
178
|
|
|
184
|
-
Congratulations! You have successfully integrated **Audience Viewing**. Next, you can implement features such as **host streaming**, **live stream list** and **gift system**. Please
|
|
179
|
+
Congratulations! You have successfully integrated **Audience Viewing**. Next, you can implement features such as **host streaming**, **live stream list** and **gift system**. Please
|
|
185
180
|
| <strong>Feature</strong> | <strong>Description</strong> | <strong>Integration Guide</strong> |
|
|
186
181
|
| --- | --- | --- |
|
|
187
182
|
| <strong>Host Streaming</strong> | The complete workflow for a host to start a stream, including pre-stream setup and various in-stream interactions. | Host Streaming |
|
|
@@ -192,7 +187,7 @@ Congratulations! You have successfully integrated **Audience Viewing**. Next, yo
|
|
|
192
187
|
|
|
193
188
|
### Why is the video screen black when a viewer selects video co-hosting?
|
|
194
189
|
|
|
195
|
-
Please go to **Phone Settings** > **App >** **Camera**, check whether camera permission is enabled,
|
|
190
|
+
Please go to **Phone Settings** > **App >** **Camera**, check whether camera permission is enabled,
|
|
196
191
|
|
|
197
192
|
### Why can't other viewers in the live room see the barrage content sent by a viewer?
|
|
198
193
|
- **Reason 1**: First check the network connection to ensure the viewer's device network is normal.
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
UILiveKit's host streaming page offers a comprehensive, ready-to-use interface for live streaming scenarios. It enables rapid integration of essential features for hosts to start streaming, allowing you to efficiently build your live streaming workflow without the complexity of custom UI or business logic.
|
|
2
2
|
|
|
3
3
|
> **Note:**
|
|
4
|
-
>
|
|
5
4
|
> This guide covers the host start process using UI components (including a complete interactive UI). If you prefer to build your own host interface with the Core SDK, see Host Start (Core SDK).
|
|
6
5
|
>
|
|
7
6
|
|
|
@@ -22,16 +21,10 @@ UILiveKit's host streaming page offers a comprehensive, ready-to-use interface f
|
|
|
22
21
|
|
|
23
22
|
### Step 1. Activate the Service
|
|
24
23
|
|
|
25
|
-
Refer to the Activate Service document to enable the **trial version** or activate the **Pro Edition** package.
|
|
26
|
-
|
|
27
24
|
### Step 2. Integrate the SDK
|
|
28
25
|
|
|
29
|
-
Refer to Preparations guide to integrate the `TUILiveKit` SDK.
|
|
30
|
-
|
|
31
26
|
### Step 3. Add the Pre-stream Preparation Page
|
|
32
27
|
|
|
33
|
-
The `AnchorPrepareView` component includes camera preview, audio effect settings, layout configuration, and other built-in features. Create and load the host streaming preparation view as shown below:
|
|
34
|
-
|
|
35
28
|
【Swift】
|
|
36
29
|
``` swift
|
|
37
30
|
import UIKit
|
|
@@ -63,8 +56,6 @@ class YourAnchorPrepareViewController: UIViewController {
|
|
|
63
56
|
|
|
64
57
|
### Step 4. Add the Host Streaming Page
|
|
65
58
|
|
|
66
|
-
The `AnchorView` component brings together audio/video streaming, audience co-hosting, interactive features, and live room management. Simply create and load `AnchorView` as shown below:
|
|
67
|
-
|
|
68
59
|
【Swift】
|
|
69
60
|
``` swift
|
|
70
61
|
import UIKit
|
|
@@ -331,7 +322,7 @@ class YourAnchorPrepareViewController: UIViewController {
|
|
|
331
322
|
|`disableMenuSwitchCamera(true)`|Hide the camera switch button|
|
|
332
323
|
|
|
333
324
|
### Customize Host Streaming Page UI
|
|
334
|
-
- For host UI customization
|
|
325
|
+
- For host UI customization. Modify styles and add custom business components in `AnchorView`.
|
|
335
326
|
|
|
336
327
|
- To adjust video stream widgets, see Adjust Video Stream Widgets. Update display elements such as names and avatars on video slots within `AnchorView`.
|
|
337
328
|
|
|
@@ -340,7 +331,6 @@ class YourAnchorPrepareViewController: UIViewController {
|
|
|
340
331
|
TUILiveKit manages UI text through the [Apple Strings Catalog](https://developer.apple.com/documentation/xcode/localizing-and-varying-text-with-a-string-catalog), allowing you to visually edit copywriting with Xcode's graphical tools.
|
|
341
332
|
|
|
342
333
|
> **Note:**
|
|
343
|
-
>
|
|
344
334
|
> [Apple Strings Catalog](https://developer.apple.com/documentation/xcode/localizing-and-varying-text-with-a-string-catalog) (.xcstrings) is a localization format introduced in Xcode 15. It supports structured formats for plurals, device-specific variants, and more. This is now the recommended approach for managing localization in iOS and macOS apps.
|
|
345
335
|
>
|
|
346
336
|
|
|
@@ -362,8 +352,6 @@ Congratulations! You have successfully integrated the **host streaming** feature
|
|
|
362
352
|
|
|
363
353
|
### No video after starting the stream?
|
|
364
354
|
|
|
365
|
-
Open your phone's **Settings** > **App** > **Camera** and verify that camera permissions are enabled. See the image below:
|
|
366
|
-
|
|
367
355
|
### Unable to start streaming after clicking the start button, showing "Not logged in"?
|
|
368
356
|
|
|
369
357
|
Review the Login Guide and confirm that the login feature has been integrated.
|
|
@@ -18,12 +18,8 @@ This document provides a detailed introduction to the **Live Stream List Page**
|
|
|
18
18
|
|
|
19
19
|
### Step 1. Activate the Service
|
|
20
20
|
|
|
21
|
-
Refer to the Activate Service document to enable the Free trial or official package.
|
|
22
|
-
|
|
23
21
|
### Step 2. Code Integration
|
|
24
22
|
|
|
25
|
-
Refer to Preparations guide to integrate the TUILiveKit SDK.
|
|
26
|
-
|
|
27
23
|
### Step 3. Add the Live Stream List Page
|
|
28
24
|
|
|
29
25
|
The **LiveListView** component is a dedicated view for displaying the live stream list. It automatically pulls the live room list, supports different display styles (**single-column** and **double-column**).
|
|
@@ -200,13 +196,9 @@ extension YourLiveListViewController: OnItemClickDelegate {
|
|
|
200
196
|
}
|
|
201
197
|
```
|
|
202
198
|
|
|
203
|
-
|**Double-Column Waterfall Transition Animation**|**Single-Column Waterfall Transition Animation**|
|
|
204
|
-
|---------|---------|
|
|
205
|
-
|||
|
|
206
|
-
|
|
207
199
|
## Next Steps
|
|
208
200
|
|
|
209
|
-
Congratulations! You have successfully integrated the **Live Stream List** feature. Next, you can implement features such as **Host Live Streaming** and **Audience Viewing**. Please
|
|
201
|
+
Congratulations! You have successfully integrated the **Live Stream List** feature. Next, you can implement features such as **Host Live Streaming** and **Audience Viewing**. Please
|
|
210
202
|
| <strong>Feature</strong> | <strong>Description</strong> | <strong>Integration Guide</strong> |
|
|
211
203
|
| --- | --- | --- |
|
|
212
204
|
| <strong>Host Streaming</strong> | The complete workflow for a host to start a stream, including pre-stream setup and various in-stream interactions. | Host Streaming |
|
|
@@ -226,4 +218,4 @@ A single-column waterfall flow previews one live room at a time, while a double-
|
|
|
226
218
|
|
|
227
219
|
Yes, the duration of previewing a live room is counted towards the audience's audio/video duration, which is a paid service. For detailed
|
|
228
220
|
|
|
229
|
-
Pricing, you can
|
|
221
|
+
Pricing, you can .
|
|
@@ -2,15 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
**TUILiveKit** is a comprehensive live-streaming component. Once integrated, it allows you to quickly implement the following key functional modules for your Android application:
|
|
4
4
|
|
|
5
|
-
|**Host Prepare Page**|**Host Streaming Page**|**Live Stream List**|**Audience Viewing Page**|
|
|
6
|
-
|---------|---------|---------|---------|
|
|
7
|
-
|||||
|
|
8
|
-
|
|
9
5
|
## **Preparations**
|
|
10
6
|
|
|
11
7
|
### Activate Service
|
|
12
8
|
|
|
13
|
-
Before using **TUILiveKit**, please
|
|
9
|
+
Before using **TUILiveKit**, please .
|
|
14
10
|
|
|
15
11
|
### Environment Requirements
|
|
16
12
|
- **Xcode**: Requires **Xcode 15** or a later version.
|
|
@@ -86,7 +82,6 @@ To use the audio/video features, your application needs to obtain permissions fo
|
|
|
86
82
|
After code integration, the next step is to complete the login. All **TUILiveKit** features require a successful login to function properly, so ensure your parameters are configured correctly.
|
|
87
83
|
|
|
88
84
|
> **Note:**
|
|
89
|
-
>
|
|
90
85
|
> In the example code, the login API is called directly. However, in a real-world application, it is highly recommended that you call the **TUILiveKit** login service only after your own user authentication and other internal login processes are complete. This prevents potential business logic confusion or data inconsistency caused by calling the login service too early, and it better aligns with your existing user management system.
|
|
91
86
|
>
|
|
92
87
|
|
|
@@ -167,7 +162,7 @@ class YourLoginService: NSObject {
|
|
|
167
162
|
|
|
168
163
|
## Next Steps
|
|
169
164
|
|
|
170
|
-
Congratulations! You have successfully integrated the **TUILiveKit** component and completed the login. You can now implement features such as host streaming, viewer watching, and the live stream list. Please
|
|
165
|
+
Congratulations! You have successfully integrated the **TUILiveKit** component and completed the login. You can now implement features such as host streaming, viewer watching, and the live stream list. Please
|
|
171
166
|
| <strong>Feature</strong> | <strong>Description</strong> | <strong>Integration Guide</strong> |
|
|
172
167
|
| --- | --- | --- |
|
|
173
168
|
| <strong>Video Live Streaming</strong> | Includes a full suite of features such as host broadcasting, audience viewing, interactive co-hosting, beauty filters, gifts, and bullet chat. | - Host Broadcasting<br>- Audience Viewing |
|
|
@@ -199,6 +194,6 @@ If you are unable to install the latest version of TUILiveKit, please follow the
|
|
|
199
194
|
|
|
200
195
|
No. You usually only need to complete one `TUILogin.login` call. We recommend associating `TUILogin.login` and `TUILogin.logout` with your own application's login business logic.
|
|
201
196
|
|
|
202
|
-
### Is there a sample configuration for the Podfile that I can
|
|
197
|
+
### Is there a sample configuration for the Podfile that I can
|
|
203
198
|
|
|
204
199
|
You can refer to the [GitHub TUILiveKit Example](https://github.com/Tencent-RTC/TUIKit_iOS/blob/main/application/Podfile) project `Podfile` sample file.
|
|
@@ -36,7 +36,6 @@ yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
|
|
|
36
36
|
Create a **live-list.vue** file in your project and add the following code to embed the **Live Stream List page**.
|
|
37
37
|
|
|
38
38
|
> **Note:**
|
|
39
|
-
>
|
|
40
39
|
> You can copy the code below directly into your project, or check the [Live Stream List](https://github.com/Tencent-RTC/TUILiveKit/blob/main/Web/web-vite-vue3/src/TUILiveKit/LiveListView.vue) for the full source code.
|
|
41
40
|
>
|
|
42
41
|
|
|
@@ -82,7 +81,6 @@ onMounted(async () => {
|
|
|
82
81
|
```
|
|
83
82
|
|
|
84
83
|
> **Note:**
|
|
85
|
-
>
|
|
86
84
|
> To enable navigation from the Live Stream List to a specific live room, see the Specify Live Room section below.
|
|
87
85
|
>
|
|
88
86
|
|
|
@@ -93,7 +91,6 @@ onMounted(async () => {
|
|
|
93
91
|
After running the following command, open your browser and visit your local address to access the Live Stream List page.
|
|
94
92
|
|
|
95
93
|
> **Tip:**
|
|
96
|
-
>
|
|
97
94
|
> Once the command completes, enter your local address in the browser (for example, `http://localhost:5173/live-list`; your port number may differ based on your project setup) to view the Live Stream List page.
|
|
98
95
|
>
|
|
99
96
|
|
|
@@ -110,7 +107,6 @@ To enable navigation from the Live Stream List (or homepage) to the viewing page
|
|
|
110
107
|
Set up Vue Router to map `live-list.vue` to the Live Stream List page.
|
|
111
108
|
|
|
112
109
|
> **Note:**
|
|
113
|
-
>
|
|
114
110
|
> - If your project already has a `src/router/index.ts` file, merge the following code into your existing file.
|
|
115
111
|
> - If you haven't set up routing, create a new `src/router/index.ts` file and add the configuration below.
|
|
116
112
|
|
|
@@ -43,7 +43,6 @@ yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue3
|
|
|
43
43
|
Create a `live-player.vue` file in your project. Copy and paste the following code to add the **viewer page**.
|
|
44
44
|
|
|
45
45
|
> **Note:**
|
|
46
|
-
>
|
|
47
46
|
> You can use the code below directly, or refer to [Audience Viewing](https://github.com/Tencent-RTC/TUILiveKit/blob/main/Web/web-vite-vue3/src/TUILiveKit/component/LivePlayer/LivePlayerPC.vue) for the full source.
|
|
48
47
|
>
|
|
49
48
|
|
|
@@ -135,7 +134,6 @@ Configure user information.
|
|
|
135
134
|
Open your terminal, navigate to your project directory, and run the following command to launch the project. You’ll then be able to view the live stream.
|
|
136
135
|
|
|
137
136
|
> **Note:**
|
|
138
|
-
>
|
|
139
137
|
> After the command runs successfully, enter your local access URL in your browser (for example, `http://localhost:5173/live-player`; the port may vary based on your setup) to access the viewer page.
|
|
140
138
|
>
|
|
141
139
|
|
|
@@ -161,14 +159,13 @@ npm run dev
|
|
|
161
159
|
|
|
162
160
|
### Step 2: Watch the Live Stream
|
|
163
161
|
|
|
164
|
-
|
|
162
|
+
. Enter the corresponding `liveId` to join the live room and view the stream.
|
|
165
163
|
|
|
166
164
|
### Step 3: Router Configuration
|
|
167
165
|
|
|
168
166
|
To enable navigation from the Live Stream List or homepage to the live room, configure Vue Router. In your project’s **src** directory, create a **router** folder and an **index.ts** file. Import and use the router in your main entry file (such as **main.ts** or **index.ts**). For reference, see the [GitHub code example](https://github.com/Tencent-RTC/TUILiveKit/blob/main/Web/web-vite-vue3/src/main.ts). If you need the Live Stream List feature, check the Live Stream List documentation.
|
|
169
167
|
|
|
170
168
|
> **Note:**
|
|
171
|
-
>
|
|
172
169
|
> In the code below, `live-player.vue` refers to the sample file created in Step 3.
|
|
173
170
|
>
|
|
174
171
|
|
|
@@ -284,7 +281,6 @@ export { useCustomizedAutoPlayDialog };
|
|
|
284
281
|
```
|
|
285
282
|
|
|
286
283
|
> **Note:**
|
|
287
|
-
>
|
|
288
284
|
> Make sure to install the required `@tencentcloud/tuiroom-engine-js` package.
|
|
289
285
|
>
|
|
290
286
|
|
|
@@ -43,7 +43,6 @@ yarn add tuikit-atomicx-vue3 @tencentcloud/uikit-base-component-vue
|
|
|
43
43
|
Create a **live-player.vue** file in your project. Copy the following code to integrate the **viewer page**.
|
|
44
44
|
|
|
45
45
|
> **Note:**
|
|
46
|
-
>
|
|
47
46
|
> You can copy the code below directly into your project, or visit [Audience Viewing](https://github.com/Tencent-RTC/TUILiveKit/blob/main/Web/web-vite-vue3/src/TUILiveKit/component/LivePlayer/LivePlayerH5.vue) for more detailed source code.
|
|
48
47
|
>
|
|
49
48
|
|
|
@@ -136,7 +135,6 @@ Set user information.
|
|
|
136
135
|
Open your terminal, navigate to your project directory, and run the following command to start the project. You can then watch the live stream.
|
|
137
136
|
|
|
138
137
|
> **Note:**
|
|
139
|
-
>
|
|
140
138
|
> After running the command, enter the local access address in your browser’s address bar (refer to your project configuration, for example `http://localhost:5173/live-player`; the actual port may vary) to view the viewer page.
|
|
141
139
|
>
|
|
142
140
|
|
|
@@ -162,10 +160,9 @@ npm run dev
|
|
|
162
160
|
|
|
163
161
|
### Step 2: Watch Live Stream
|
|
164
162
|
|
|
165
|
-
|
|
163
|
+
. Enter the corresponding `liveId` to join the live room and watch the stream:
|
|
166
164
|
|
|
167
165
|
> **Note:**
|
|
168
|
-
>
|
|
169
166
|
> To update your personal information, use the `setSelfInfo` method in the sample code from Step 3.
|
|
170
167
|
>
|
|
171
168
|
|
|
@@ -174,7 +171,6 @@ Refer to Step 3 in the quick integration above. Enter the corresponding `liveId`
|
|
|
174
171
|
To enable navigation from the live stream list (or homepage) to the live room, configure Vue Router. Create a **router** folder in your project's **src** directory and add an **index.ts** file. Import and use the router in your main file (such as **main.ts** or **index.ts**). See the [GitHub code sample](https://github.com/Tencent-RTC/TUILiveKit/blob/main/Web/web-vite-vue3/src/main.ts). For the live stream list, refer to Live Stream List.
|
|
175
172
|
|
|
176
173
|
> **Note:**
|
|
177
|
-
>
|
|
178
174
|
> The `live-player.vue` file in the following code sample corresponds to the sample file created in Step 3.
|
|
179
175
|
>
|
|
180
176
|
|
|
@@ -232,7 +228,7 @@ import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
|
|
|
232
228
|
|
|
233
229
|
### Button and Icon Customization
|
|
234
230
|
|
|
235
|
-
To customize buttons, icons, or other controls, modify the relevant code in `live-player.vue`.
|
|
231
|
+
To customize buttons, icons, or other controls, modify the relevant code in `live-player.vue`. .
|
|
236
232
|
|
|
237
233
|
You can also customize the **audience viewer page** to match your project requirements. In addition to layout adjustments, you can modify the **color theme, font, border radius, buttons, icons, input boxes, dialogs**, and more. Add, delete, or update these elements to achieve your desired UI.
|
|
238
234
|
| <strong>Category</strong> | <strong>Feature</strong> | <strong>Description</strong> |
|
|
@@ -289,7 +285,6 @@ export { useCustomizedAutoPlayDialog };
|
|
|
289
285
|
```
|
|
290
286
|
|
|
291
287
|
> **Note:**
|
|
292
|
-
>
|
|
293
288
|
> Install the required `@tencentcloud/tuiroom-engine-js` package.
|
|
294
289
|
>
|
|
295
290
|
|
|
@@ -46,7 +46,6 @@ yarn add tuikit-atomicx-vue3 @tencentcloud/livekit-web-vue3 @tencentcloud/uikit-
|
|
|
46
46
|
Create a `live-pusher.vue` file in your project. Copy the code below into your new `live-pusher.vue` file to integrate the full **Host Live Start Page**.
|
|
47
47
|
|
|
48
48
|
> **Note:**
|
|
49
|
-
>
|
|
50
49
|
> You can copy the code below directly into your project, or visit the [Live Start Page](https://github.com/Tencent-RTC/TUILiveKit/blob/main/Web/web-vite-vue3/src/TUILiveKit/LivePusherView.vue) for the full source code.
|
|
51
50
|
>
|
|
52
51
|
|
|
@@ -169,7 +168,7 @@ Creates a new live room and sets its basic information.
|
|
|
169
168
|
|liveName|String|Yes|Live Room Name, displayed on the UI.|
|
|
170
169
|
|coverUrl|String|No|Live Room cover image URL.|
|
|
171
170
|
|isPublicVisible|Boolean|No|Whether the room is publicly visible. Defaults to true.|
|
|
172
|
-
|seatLayoutTemplateId|Number|No|Seat layout template ID. 600 represents portrait dynamic grid layout. For more template IDs
|
|
171
|
+
|seatLayoutTemplateId|Number|No|Seat layout template ID. 600 represents portrait dynamic grid layout. For more template IDs.|
|
|
173
172
|
|
|
174
173
|
##### setSelfInfo
|
|
175
174
|
|
|
@@ -188,7 +187,6 @@ Start your first live stream.
|
|
|
188
187
|
```
|
|
189
188
|
|
|
190
189
|
> **Note:**
|
|
191
|
-
>
|
|
192
190
|
> After running the above command, open your browser and enter the local address (for example, `http://localhost:5173/live-pusher`; the port may vary by project) to view the live start page.
|
|
193
191
|
>
|
|
194
192
|
|
|
@@ -209,7 +207,6 @@ Start your first live stream.
|
|
|
209
207
|
## Advanced Feature Integration
|
|
210
208
|
|
|
211
209
|
> **Note:**
|
|
212
|
-
>
|
|
213
210
|
> All advanced features below are extensions based on the `live-pusher.vue` sample file created in Step 3.
|
|
214
211
|
>
|
|
215
212
|
> Depending on your requirements, add the following code snippets to the appropriate sections of `live-pusher.vue` (either in the template or script) to enable each feature.
|
|
@@ -619,7 +616,6 @@ function handleCancel() {
|
|
|
619
616
|
|**Landscape Streaming**|Game Streaming, Online Education, Conference Streaming|Optimized for desktop viewing, aspect ratio 16:9.|
|
|
620
617
|
|
|
621
618
|
> **Note:**
|
|
622
|
-
>
|
|
623
619
|
> You must set the streaming direction **before starting the live stream**; you cannot switch directions during a live session.
|
|
624
620
|
>
|
|
625
621
|
|
|
@@ -646,7 +642,6 @@ updateLiveInfo({ layoutTemplate: 600 });
|
|
|
646
642
|
```
|
|
647
643
|
|
|
648
644
|
> **Note:**
|
|
649
|
-
>
|
|
650
645
|
> - Landscape mode uses template IDs 200-599, with 200 (landscape floating layout) as the default.
|
|
651
646
|
> - Portrait mode uses template IDs 600-899, with 600 (dynamic grid layout) as the default.
|
|
652
647
|
> - When switching between landscape and portrait, the system automatically applies the default template for that direction.
|
|
@@ -700,7 +695,6 @@ updateLiveInfo({ layoutTemplate: 200 });
|
|
|
700
695
|
```
|
|
701
696
|
|
|
702
697
|
> **Note:**
|
|
703
|
-
>
|
|
704
698
|
> - You can switch layout templates **before** starting the live stream and **during** the session.
|
|
705
699
|
> - During host PK, **layout templates cannot be switched**.
|
|
706
700
|
> - When switching streaming direction, the layout template automatically changes to the default for that direction.
|
|
@@ -727,7 +721,7 @@ import { UIKitProvider } from '@tencentcloud/uikit-base-component-vue3';
|
|
|
727
721
|
|
|
728
722
|
### Buttons and Icons
|
|
729
723
|
|
|
730
|
-
To add or replace Button or Icon controls for further UI customization, follow the example below. In the `live-player.vue` file, you can
|
|
724
|
+
To add or replace Button or Icon controls for further UI customization, follow the example below. In the `live-player.vue` file, you can .
|
|
731
725
|
|
|
732
726
|
You can also customize the **audience viewing page** UI as needed. In addition to layout adjustments, you can freely **add, remove, or modify** color themes, fonts, border radius, buttons, icons, input boxes, dialogs, and more to meet your UI requirements.
|
|
733
727
|
|
|
@@ -66,7 +66,6 @@ const isPC = ref(getPlatform() === 'pc');
|
|
|
66
66
|
Authentication is required to access all TUIRoomKit features. Call conference.login as soon as your user is authenticated—for example, right after a user logs into your web page. After calling `conference.login`, we recommend calling `conference.setSelfInfo` to set the user’s display name and avatar, which are shown in the participant video area and the member list.
|
|
67
67
|
|
|
68
68
|
> **Note:**
|
|
69
|
-
>
|
|
70
69
|
> Make sure to use the generated UserSig in your configuration. In production, generate UserSig on your server and have the client request a dynamic UserSig from your business server for authentication as needed. See [How to calculate UserSig for production](https://trtc.io/document/35166).
|
|
71
70
|
>
|
|
72
71
|
|
|
@@ -297,7 +296,6 @@ const enterDualMeeting = async (bizOrderId: string) => {
|
|
|
297
296
|
```
|
|
298
297
|
|
|
299
298
|
> **Note:**
|
|
300
|
-
>
|
|
301
299
|
> The `conference.createAndJoinRoom` API handles: "If the room does not exist, create it (become host); if it exists, join it (become participant)", resolving state conflicts under high concurrency.
|
|
302
300
|
>
|
|
303
301
|
|
|
@@ -317,7 +315,6 @@ await conference.leaveRoom();
|
|
|
317
315
|
```
|
|
318
316
|
|
|
319
317
|
> **Note:**
|
|
320
|
-
>
|
|
321
318
|
> When the host leaves the room or closes the web page, the room is not automatically ended. Other participants can continue using TUIRoomKit features. The system will automatically reclaim room resources 6 hours after the scheduled end time, provided the room is empty.
|
|
322
319
|
>
|
|
323
320
|
|
|
@@ -331,7 +328,6 @@ await conference.endRoom();
|
|
|
331
328
|
```
|
|
332
329
|
|
|
333
330
|
> **Note:**
|
|
334
|
-
>
|
|
335
331
|
> `endRoom()` must be called by the host after successfully Entered Room. Calling as a non-host or before Enter Room will result in an error.
|
|
336
332
|
>
|
|
337
333
|
|
|
@@ -496,7 +492,6 @@ Yes. To integrate TUIRoomKit via iframe, configure the allow attribute to grant
|
|
|
496
492
|
|
|
497
493
|
### Is intranet proxy supported?
|
|
498
494
|
|
|
499
|
-
Yes. Set intranet proxy parameters as shown below. For more information, see [Firewall Restrictions](https://trtc.io/document/59667).
|
|
500
495
|
``` typescript
|
|
501
496
|
// Set intranet proxy parameters before Enter Room
|
|
502
497
|
import TUIRoomEngine from '@tencentcloud/tuiroom-engine-js';
|
|
@@ -526,8 +521,6 @@ TUIRoomKit offers rich customization out of the box—custom themes and language
|
|
|
526
521
|
|
|
527
522
|
For maintainability, we recommend using the built-in customization options whenever possible, rather than exporting the source. Once exported, you’re no longer on TUIRoomKit’s standard npm upgrade path, which usually means higher long-term maintenance and fewer benefits from future releases (new features, bug fixes, and performance improvements).
|
|
528
523
|
|
|
529
|
-
**Recommended**: Start with the options in the UI customization documentation. If the current APIs don’t cover your use case, [contact us](https://trtc.io/contact).
|
|
530
|
-
|
|
531
524
|
If you’ve assessed the trade-offs and still need deep customization that changes the underlying architecture, you can export the source code as follows:
|
|
532
525
|
|
|
533
526
|
【Vue3】
|
|
@@ -552,7 +545,3 @@ If you encounter ESLint errors after exporting TUIRoomKit source, add the RoomKi
|
|
|
552
545
|
// Replace with actual TUIRoomKit source path
|
|
553
546
|
src/components/RoomKit
|
|
554
547
|
```
|
|
555
|
-
|
|
556
|
-
## Contact Us
|
|
557
|
-
|
|
558
|
-
If you have any questions or suggestions during integration or usage, [contact us](https://trtc.io/contact) for support.
|
|
@@ -616,9 +616,6 @@ Before starting a call, use [setSelfInfo](https://liteav.sdk.cloudcachetci.com/d
|
|
|
616
616
|
### Switch Layout Modes
|
|
617
617
|
|
|
618
618
|
Use [setLayoutTemplate](https://liteav.sdk.cloudcachetci.com/doc/product/tuikit/atomic-x/android/en/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.view/-call-core-view/set-layout-template.html) to switch layout modes. If not set, CallCoreView adapts automatically: **Float** mode for 1v1 calls, **Grid** mode for multi-party calls.
|
|
619
|
-
| <strong>Float Mode</strong> | <strong>Grid Mode</strong> | <strong>PIP Mode</strong> |
|
|
620
|
-
| --- | --- | --- |
|
|
621
|
-
| | | |
|
|
622
619
|
| - <strong>Layout Logic:</strong> Full screen shows own video while waiting; after answering, full screen shows the other party's video, own video floats as a small window.<br>- <strong>Interaction:</strong> Supports dragging and swapping windows. | - <strong>Layout Logic:</strong> All participant videos are tiled in a grid. Suitable for 2+ participants; supports click-to-enlarge.<br>- <strong>Interaction:</strong> Click to enlarge a participant's video. | - <strong>Layout Logic:</strong> In 1v1, always shows the other party's video; in multi-party, uses active speaker strategy.<br>- <strong>Interaction:</strong> Shows own video while waiting, displays call timer after answering. |
|
|
623
620
|
|
|
624
621
|
- **setLayoutTemplate Sample Code:**
|
|
@@ -821,7 +818,3 @@ Congratulations! You have implemented the answer call feature. Next, see Make Yo
|
|
|
821
818
|
### Can an invitee receive a call event if they go offline and then come back online within the call timeout period?
|
|
822
819
|
|
|
823
820
|
For one-on-one calls, if the callee comes online within the timeout, they will receive the incoming call invitation. For group calls, if the callee comes online within the timeout, up to 20 unprocessed group messages will be retrieved, and if there is a call invitation, the incoming call event will be triggered.
|
|
824
|
-
|
|
825
|
-
## Contact Us
|
|
826
|
-
|
|
827
|
-
If you have any questions or suggestions during the integration or usage process, feel free to join our [Telegram technical group](https://t.me/+EPk6TMZEZMM5OGY1) or [contact us](https://trtc.io/contact) for support.
|
|
@@ -70,7 +70,6 @@ class MainActivity : ComponentActivity() {
|
|
|
70
70
|
## Implementation
|
|
71
71
|
|
|
72
72
|
> **Note:**
|
|
73
|
-
>
|
|
74
73
|
> You must log in before making a call. The following steps show how to make a call.
|
|
75
74
|
>
|
|
76
75
|
|
|
@@ -661,9 +660,6 @@ Before a call starts, use [setSelfInfo](https://liteav.sdk.cloudcachetci.com/doc
|
|
|
661
660
|
### Switch Layout Mode
|
|
662
661
|
|
|
663
662
|
Use [setLayoutTemplate](https://liteav.sdk.cloudcachetci.com/doc/product/tuikit/atomic-x/android/en/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.view/-call-core-view/set-layout-template.html) to switch between layout modes. If not set, **CallCoreView** adapts automatically: 1v1 calls use `Float` mode by default, while multi-party calls use `Grid` mode. Layout mode descriptions:
|
|
664
|
-
| <strong>Float Mode</strong> | <strong>Grid Mode</strong> | <strong>PIP Mode</strong> |
|
|
665
|
-
| --- | --- | --- |
|
|
666
|
-
| | | |
|
|
667
663
|
| - <strong>Layout:</strong> Full screen self-view while waiting; after connecting, full screen remote view with self-view as a floating window.<br>- <strong>Interaction:</strong> Floating window supports drag and click-to-swap with the main view. | - <strong>Layout:</strong> Grid layout for all participants, suitable for 2+ users. Supports click-to-enlarge.<br>- <strong>Interaction:</strong> Click any participant's view to enlarge. | - <strong>Layout:</strong> 1v1 shows fixed remote view; multi-party uses active speaker strategy with full screen for the current speaker.<br>- <strong>Interaction:</strong> Waiting state shows self-view; after connecting, call duration is displayed. |
|
|
668
664
|
|
|
669
665
|
- **setLayoutTemplate Example:**
|
|
@@ -889,7 +885,3 @@ Congratulations! You've completed the "Make a Call" feature. Next, you can imple
|
|
|
889
885
|
### If the callee comes online before the call invitation times out, do they get the incoming call?
|
|
890
886
|
|
|
891
887
|
For single calls, if the callee comes online within the timeout, they will receive an incoming call invitation. For group calls, up to 20 unhandled group messages are pulled when coming online within the timeout; if a call invitation exists, the incoming call event is triggered.
|
|
892
|
-
|
|
893
|
-
## Contact Us
|
|
894
|
-
|
|
895
|
-
If you have any questions or suggestions during the integration or usage process, feel free to join our [Telegram technical group](https://t.me/+EPk6TMZEZMM5OGY1) or [contact us](https://trtc.io/contact) for support.
|
|
@@ -3,7 +3,6 @@ On Android, incoming audio/video call invitations won't trigger notifications wh
|
|
|
3
3
|
To solve this, you need to integrate offline push notifications using FCM Data Messages. This allows critical signaling—like call invitations—to reach the device and wake up your app, even when it's completely closed, launching the call interface so users can answer incoming calls.
|
|
4
4
|
|
|
5
5
|
> **Note:**
|
|
6
|
-
>
|
|
7
6
|
> Offline push is not required if users are only calling always-online web agents.
|
|
8
7
|
>
|
|
9
8
|
|
|
@@ -14,7 +13,6 @@ This guide shows you how to integrate FCM Data Message push for audio/video call
|
|
|
14
13
|
Go to the [Chat Console > App Push > Access settings](https://console.trtc.io/chat/push-plugin-push-identifier) , and click **Purchase Now** or **Free Trial** (each app is eligible for one free trial, valid for 7 days).
|
|
15
14
|
|
|
16
15
|
> **Note:**
|
|
17
|
-
>
|
|
18
16
|
> When your push plugin trial or subscription expires, all push services (including offline push for regular messages, broadcast/tag push, etc.) will be automatically suspended. To ensure uninterrupted service, please [purchase](https://buy.intl.cloud.tencent.com/avc) or [renew](https://console.tencentcloud.com/expense/renewal) your subscription in advance.
|
|
19
17
|
>
|
|
20
18
|
|
|
@@ -336,12 +334,10 @@ Listen for incoming call events. After a successful login (Step 1), if there are
|
|
|
336
334
|
|
|
337
335
|
### Demo Effect
|
|
338
336
|
|
|
339
|
-
After completing all three steps above, the incoming call notification will appear as shown below:
|
|
340
|
-
|
|
341
337
|
## FAQs
|
|
342
338
|
|
|
343
339
|
### Unable to Display Incoming Call Interface After App Is Killed?
|
|
344
|
-
- Check if push notifications are being received. If not, verify that the IM Console certificate was uploaded correctly.
|
|
340
|
+
- Check if push notifications are being received. If not, verify that the IM Console certificate was uploaded correctly. .
|
|
345
341
|
|
|
346
342
|
- Ensure that FCM Data Message is selected in the console, as described in Step 2 of **Prerequisites** above.
|
|
347
343
|
|
|
@@ -355,7 +351,3 @@ To force your app to always use the FCM channel, call the following method:
|
|
|
355
351
|
``` java
|
|
356
352
|
TIMPushManager.getInstance().forceUseFCMPushChannel(true);
|
|
357
353
|
```
|
|
358
|
-
|
|
359
|
-
## Contact Us
|
|
360
|
-
|
|
361
|
-
If you have any questions or suggestions during integration or use, join the [Telegram](https://t.me/+EPk6TMZEZMM5OGY1) technical group or [Contact Us](https://trtc.io/contact) for support.
|