即时通信 IM 礼物组件

一、组件概述

TUILiveKit 的礼物功能主要由以下三个核心视图组件构成:

二、效果演示

三、步骤1：开通服务

请参考 开通服务，领取 TUILiveKit 体验版或者开通付费版。

注意：说明：

注意：使用礼物系统要求开通 TUILiveKit 体验版、多人连麦版或大规模直播版，不同套餐中可配置的礼物数量有所不同，详细参见 功能与计费说明 中的礼物系统说明，你可按需选购。

四、步骤2：代码集成

·工程配置：请参考 准备工作 完成 TUILiveKit 接入。

·版本限制：TUILiveKit >= 3.2.0。

五、步骤3：接入礼物列表

GiftListView 通常以弹窗或底部面板的形式展示。你也可以将其添加到 Activity 或 Fragment 的布局中。

import android.os.Bundleimport android.widget.FrameLayoutimport androidx.appcompat.app.AppCompatActivityimport com.trtc.uikit.livekit.Rimport com.trtc.uikit.livekit.component.gift.GiftListViewclass YourLiveActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_live_room) // 获取页面的根布局容器 val rootView = findViewById<FrameLayout>(R.id.root_view) // 1. 创建礼物列表组件实例 val giftListView = GiftListView(this) // 2. 初始化组件，传入当前的房间 ID (RoomId) // 注意：请确保此时已获取到有效的 roomId giftListView.init("your_room_id") // 3. 将组件添加到视图层级中 rootView.addView(giftListView) }}

六、步骤4：接入礼物特效播放组件

GiftPlayView 是一个透明的覆盖层，用于播放礼物动画。它通常覆盖在视频画面的上方，但位于交互按钮的下方。

import android.os.Bundleimport android.widget.FrameLayoutimport androidx.appcompat.app.AppCompatActivityimport com.trtc.uikit.livekit.Rimport com.trtc.uikit.livekit.component.gift.GiftPlayViewclass YourLiveActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.activity_live_room) val rootView = findViewById<FrameLayout>(R.id.root_view) // 1. 创建礼物播放组件实例 val giftPlayView = GiftPlayView(this) // 2. 初始化组件，传入当前的房间 ID // 组件内部会自动监听该房间的礼物消息并触发播放 giftPlayView.init("your_room_id") // 3. 将组件添加到视图层级中 // 建议将此 View 添加到视频层之上，UI 控件层之下 rootView.addView(giftPlayView) }}

七、步骤 5：导入默认礼物

你新申请的应用在礼物后台默认是没有配置任何礼物的，所以集成后你的礼物发送面板默认是空的，为了你能快速体验我们的礼物收发效果，你可以使用 服务端 API 一键导入我们为你预置的礼物素材。

八、下一步

完成上述 UI 集成后，你已经实现了客户端的礼物展示能力。为了构建一个完整的商业化礼物功能，你还需要参考 礼物系统后端对接与进阶功能 文档，完成以下核心业务逻辑的对接：

·自定义礼物配置：通过服务端 API 上传你自己的礼物图标、动画文件，并设置价格。

·礼物扣费回调：配置回调地址，将送礼请求转发至你的计费后台，实现“余额校验”与“扣费”闭环。

·PK 分数联动：在主播 PK 场景下，将礼物价值实时转换为 PK 分数。

·数据统计：获取礼物发送记录、总价值等运营数据。

·升级礼物动画特效 SDK：如果 SVGA 无法满足需求，可集成高级播放器支持 MP4/PAG 等高清透明动画。