The Interactive Gifts component is a virtual gift interaction platform designed to enhance the social experience of users. With this component, users can send virtual gifts to their favorite live stream hosts to show their appreciation, favoritism, and support.
The Interactive Gift Component supports setting like, gift sending panel, send gifts, play normal gift animation, play SVGA gift animation, etc.
Flutter
Android
iOS
Web
The interactive gift component provides 2 view components:
GiftSendWidget: send gift message view, clicking it can bring up the gift panel.
GiftDisplayWidget: receive gift message view, it will display gift messages on this view.
The effect is shown below:
Gift Display Panel
Normal Gift Playback Effect
Full-Screen Gift Playback Effect
The gift component mainly provides 2 APIs:
GiftListPanelView: gift panel, presents the gift list, send gifts, and top-up.
GiftPlayView: Panel for playing gifts, automatically listens to gift messages.
The effect is shown below:
Gift Display Panel
Normal Gift Playback Effect
Full-Screen Gift Playback Effect
The gift component mainly provides 2 APIs:
GiftListView: gift panel, presenting the gift list and send gifts.
GiftPlayView: A panel for playing gifts, automatically listens for gift messages.
The effect is shown below:
Gift Display Panel
Normal Gift Playback Effect
Full-Screen Gift Playback Effect
The interactive gift system mainly provides 4 components:
GiftList: The gift panel, which displays the gift list and allows sending gifts. On H5, the top-right corner of the panel also includes a recharge function.
GiftMore : The "More Gifts" button. On PC, it includes a recharge function.
GiftPopupList: On PC, when the GiftList cannot fully display all available gifts, clicking "More Gifts" will trigger this GiftPopupList: component to show the complete gift list.
GiftPlayerCardList: The gift playback panel, which automatically listens for gift messages.
Components are described in the following figure:
The effect is shown below:
Gift Display Panel
Normal Gift Playing Effect
Full-Screen Gift Playing Effect
Quick Connection
Note:
If you have already integrated the LiveKit component, we have by default included the gift component in LiveKit. You can directly experience the interactive gift feature in LiveKit.
Adding the Gift Component To the Project
Flutter
Android
iOS
Web
1. Add gift dependency in the dependencies node of the pubspec.yaml file in the project engineering.
dependencies:
flutter:
sdk: flutter
flutter_localizations:
sdk: flutter
intl: ^0.19.0
# Add gift dependency
live_uikit_gift: ^1.0.0
2. Execute the flutter pub get command.
3. Configure multilingual support. Add multilingual support for the gift component to the localizationsDelegates and supportedLocales attributes of your application's MaterialApp.
Integrate the LiveKit components to enable full functionality. For details, refer to the NPM directory: src/TUILive/components/Gift/.
Integrating the Gift Sending Component
Flutter
Android
iOS
Web
Construct GiftSendController and GiftSendWidget objects where you need to integrate the gift sending message, and add the constructed GiftSendWidget object to your Widget tree. Example code is as follows:
roomId:"liveRoomId",/// liveRoomId Replace with your live room ID
owner: ownerInfo,/// ownerInfo Replace with your live room host information
self: selfInfo,/// selfInfo Replace with your login user information
);
GiftSendWidget(controller: _giftSendController);
Implement the GiftListPanelViewOnSendGiftListener callback onSendGift to get the number of gifts and gift information. After preprocessing, you can call the GiftListPanelView function sendGift for the actual sending of gifts.
//...Here is the pre-processing, such as verifying the current user's balance, etc
GiftUser receiver =newGiftUser();
//...Here set the gift recipient information
giftListView.sendGift(gift, giftCount, receiver);
}
Create a GiftListView object and add it to your view. You also need to implement the GiftListViewDelegate callback method onSendGift.
When you click the send button on the GiftListView panel, you will receive this callback. You can get the number of gifts to be sent and the gift information in this method. After preprocessing, you can call the GiftListView function sendGift for the actual sending of gifts.
In the component where you need to send gifts, import and execute the useGiftList hook. Destructure the handleSendGift method from the execution result. When clicking the send button on the GiftList panel, simply pass the prepared gift data as a parameter to the handleSendGift method to send successfully. Refer to the GiftList component's gift-sending logic for implementation.
// The method is bound to the click event of the send button on the GiftList panel.
consthandleSendSelectedGift=async(gift: Gift)=>{
if(selectedGift.value !== gift)return;
try{
// Call handleSendGift to send the gift.
awaithandleSendGift(gift);
selectedGift.value ={}as Gift;
}catch(error){
selectedGift.value ={}as Gift;
throw error;
}
}
Integrating the Gift Display Component
Flutter
Android
iOS
Web
Construct GiftDisplayController and GiftDisplayWidget objects where you need to integrate the gift display message, and add the constructed GiftDisplayWidget object to your Widget tree. Example code is as follows:
If you need to get callback information for sending and receiving gifts, you can call the GiftDisplayController's setGiftCallback method. Example code is as follows:
_giftDisplayController?.setGiftCallback(
onReceiveGiftCallback: _onReceiveGiftCallback,/// _onReceiveGiftCallback can be replaced with your custom handling method
onSendGiftCallback: _onSendGiftCallback,/// _onSendGiftCallback can be replaced with your custom handling method
);
If you need to receive callback information for receiving gifts, implement the GiftPlayViewTUIGiftPlayViewListener function onReceiveGift.
If you need to get callback information for receiving gifts, you can implement the GiftPlayView's delegate GiftPlayViewDelegate's giftPlayView:onReceiveGift:gift:giftCount:sender:receiver function.
ToastUtil.toastLongMessage("query gift list error, code = "+ error);
}
}));
Note:
Customers implement the logic of the queryGiftInfoList method themselves to obtain a custom gift list List<Gift>, and set the gift list through GiftListView.setGiftList.
The animationUrl of the gift requires an SVGA animation.
If you need to modify the gift list of the gift panel:
Customers implement the logic of the queryGiftInfoList method themselves to obtain a custom gift list List<TUIGift>, and set the gift list through GiftListView.setGiftList.
The animationUrl of the gift requires an SVGA animation.
If you need to modify the gift list in the gift panel:
// Cross-domain issues may prevent the browser from retrieving API data when requesting resources. In such cases, you can use the gift backup data instead.
return giftList || giftListDataBackup;
}
FAQs
Gift Component Initialization Timing
Since the gift component's controller needs to integrate some live room information parameters and user information, it should be loaded after the audience enters the live broadcast room or the anchor creates a live streaming room.