Gift Panel Component displays our default built-in gifts. Clicking on these gifts allows you to send them to the live streaming room. The anchor and users in the live streaming room can play these gifts through the Gift Player component.
effect display
Component Integration
Android
iOS
Flutter
step 1:Download the TUILiveKit component
Clone/download the code from GitHub, then copy the tuilivekit subdirectory under the Android directory to the same-level directory as your app in the current project, as shown in the figure below:
step 2:Project Configuration
1. Add the jitpack repository address in the settings.gradle.kts (or settings.gradle) file in the project root directory: add the jitpack repository dependency (to download the SVGAPlayer third-party library for playing gift svg animations).
2. Add the following code in the settings.gradle.kts (or settings.gradle) file in the project root directory. It enables importing the downloaded tuilivekit component into your current project:
settings.gradle.kts
settings.gradle
include(":tuilivekit")
include ':tuilivekit'
3. Locate the build.gradle.kts (or build.gradle) file under the app directory and add the following code in it. It enables declaring the current app's dependency on the newly joined tuilivekit component:
build.gradle.kts
build.gradle
api(project(":tuilivekit"))
api project(':tuilivekit')
Note:
Note: The TUILiveKit project internally depends on TRTC SDK, IM SDK, tuiroomengine, and the public library tuicore by default. Developers do not need to separately configure them. If needed, just modify the tuilivekit/build.gradle file to upgrade.
4. Since we use Java reflection features internally in the SDK, some classes in the SDK need to be added to the non-obfuscation list. Therefore, you need to add the following code in the proguard-rules.pro file:
-keep class com.tencent.**{*;}
-keep class com.trtc.uikit.livekit.livestreamcore.**{*;}
-keep class com.trtc.uikit.livekit.component.gift.store.model.**{*;}
-keep class com.squareup.wire.**{*;}
-keep class com.opensource.svgaplayer.proto.**{*;}
-keep class com.tcmediax.**{*;}
-keep class com.tencent.**{*;}
-keep class com.tencent.xmagic.**{*;}
-keep class androidx.exifinterface.**{*;}
-keep class com.google.gson.**{*;}
# TencentEffect SDK - beauty
-keep class com.tencent.xmagic.**{*;}
-keep class org.light.**{*;}
-keep class org.libpag.**{*;}
-keep class org.extra.**{*;}
-keep class com.gyailib.**{*;}
-keep class com.tencent.cloud.iai.lib.**{*;}
-keep class com.tencent.beacon.**{*;}
-keep class com.tencent.qimei.**{*;}
-keep class androidx.exifinterface.**{*;}
5. Find the AndroidManifest.xml file under the app directory, add tools:replace="android:allowBackup" and android:allowBackup="false" in the application node, overwrite the setting within component, and use your own setting.
// app/src/main/AndroidManifest.xml
<application
...
// add the following configuration to overwrite the configuration in the dependent sdk
android:allowBackup="false"
tools:replace="android:allowBackup">
Import components using CocoaPods. The specific steps for importing components are as follows:
1. You need to download the Gift and Common folders on GitHub to your local system.
2. Add pod 'TUIGift' and pod 'TUILiveResources' dependencies in your Podfile.
Swift
target 'xxxx'do
...
...
pod 'TUILiveResources', :path =>'../Component/Common/TUILiveResources.podspec'
// The path is the relative path between your Podfile file and TUILiveResources.Podspec file.
pod 'TUIGift', :path =>'../Component/Gift/TUIGift.podspec'
// The path is the relative path between your Podfile file and TUIGift.Podspec file.
end
If you don't have a Podfile file, first use the terminal to cd into the xxxx.xcodeproj directory, then create it with the following command:
pod init
3. In the terminal, first cd to the Podfile directory, then execute the following commands to install components.
pod install
4. Any issues you encounter during integration and use, feel free to give feedback.
1. In the dependencies node of the pubspec.yaml file in the project engineering, add a dependency on gift.
dependencies:
flutter:
sdk: flutter
flutter_localizations:
sdk: flutter
intl: ^0.19.0
# Add gift dependency
live_uikit_gift: ^1.0.0
1. Execute the
2. flutter pub get command.
3. Configure multilingual support. Add the multilingual support of the gift component to the localizationsDelegates and supportedLocales properties of your application's MaterialApp.
MaterialApp(localizationsDelegates: const [
...GiftLocalizations.localizationsDelegates,
], supportedLocales: const [
...GiftLocalizations.supportedLocales,
],
// ...
);
Component Usage
Notes:
Since the gift component requires live room information parameters, it is necessary to load the gift component after Audience Entering the Live Room or Anchor Create Live Room.
Integrating the Gift Panel Component
Android
iOS
Flutter
Create a GiftListPanelView object and add it to your view. Also need to implement the onSendGiftcallback in OnSendGiftListener of GiftListPanelView, retrieve the gift count and gift information. After pre-processing, you can call the sendGiftfunction of GiftListPanelViewfor the actual sending of gifts.
Create a GiftListView object and add it to your view. At the same time, you also need to implement the onSendGift callback method in GiftListViewDelegate.
When you click the send button on the GiftListView panel, you will receive this callback approach. You may obtain the gift count and gift information for the gifts prepared for sending in this method. After pre-processing, you can call the sendGiftfunction of GiftListViewfor the actual sending of gifts.
importTUIGift
privatelet giftList:[TUIGift]=[]//...Replace this with your gift list
lazyvar giftListView:GiftListView={
let view =GiftListView(roomId: roomId, delegate:self)
view.setGiftList(giftList)
return view
}()
// ...Add giftListView to your parent view here and adjust the layout
After you successfully enter the room, you can then successfully call the sendGift function.
Build GiftSendController and GiftSendWidget objects where you need to integrate the send gift message feature, and add the constructed GiftSendWidget object to your Widget tree. Sample code is as follows: