即时通信 IM Android（快速接入 含 UI ）

二、开通服务

请参考 开通服务 领取 TUIRoomKit 体验版，并在 应用管理 页面获取以下信息：

·SDKAppID：应用标识（必填），腾讯云基于 SDKAppID 完成计费统计。

·SDKSecretKey：应用密钥，用于初始化配置文件的密钥信息。

三、环境准备

·Android 5.0 (SDK API level 21)及以上。

·Gradle 8.0 及以上。

·Android 5.0 以上的设备。

·需使用 JDK 17、18 或 19 版本。

五、步骤1：下载 TUIRoomKit 组件

在 GitHub 或者 CNB 中克隆/下载代码，然后将 room 子目录和 atomic_x 子目录拷贝到你当前 Android 项目的 app 文件夹同级目录中。

七、1. 导入 TUIRoomKit 组件

在工程根目录下的 settings.gradle.kts 或 settings.gradle 文件中，增加以下代码以导入 tuiroomkit 组件。

settings.gradle.ktssettings.gradleinclude(":tuiroomkit")project(":tuiroomkit").projectDir = File(settingsDir, "room/tuiroomkit")include(":atomic_x")project(":atomic_x").projectDir = File(settingsDir, "atomic_x")include ':tuiroomkit'project(':tuiroomkit').projectDir = new File(settingsDir, "room/tuiroomkit")include(":atomic_x")project(':atomic_x').projectDir = new File(settingsDir, "atomic_x")

八、2. 添加组件依赖

在 app 目录下找到 build.gradle.kts（或 build.gradle）文件，并在文件中增加以下代码，该步骤的作用是声明当前 App 对新加入的 tuiroomkit 组件的依赖。

build.gradle.ktsbuild.gradledependencies { // 添加 tuiroomkit 依赖 api(project(":tuiroomkit"))}dependencies { // 添加 tuiroomkit 依赖 api project(':tuiroomkit')}

注意：说明：

注意：TUIRoomKit 内部已默认依赖 TRTC SDK、IM SDK 等公共库，你无需单独配置。

九、3. 配置混淆规则

由于 SDK 内部使用了 Java 反射，请在 proguard-rules.pro 文件中添加以下代码，将相关类加入不混淆名单，以确保功能正常运行。

-keep class com.tencent.** { *; }-keep class com.tencent.beacon.** { *; }-keep class com.tencent.cloud.iai.lib.** { *; }-keep class com.tencent.qimei.** { *; }-keep class com.tencent.xmagic.** { *; }-keep class com.tcmediax.** { *; }# Google 序列化/反序列化框架 Gson 库相关混淆-keep class com.google.gson.** { *; }

十、4. 修改 AndroidManifest.xml

为了防止编译时 AndroidManifest 合并过程中产生属性冲突，你需要在 app/src/main/AndroidManifest.xml 文件的 <application> 节点中，添加 tools:replace="android:allowBackup" 和 android:allowBackup="false"，用以覆盖组件内的设置。

<manifest xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools"> <!– 添加如下配置覆盖 依赖的 sdk 中的配置 –> <application android:allowBackup="false" tools:replace="android:allowBackup" /></manifest>

十一、5. 完成项目同步

在你完成上述步骤后，通常情况下 Android Studio 会自动为你弹出 Sync Now 按钮，你需要点击该同步按钮完成项目的同步，若 IDE 没有自动弹出同步按钮，请你手动点击工具栏中的同步按钮进行项目的同步，同步后 IDE 会完成项目的构建配置和索引等工作，你就可以在你的项目中正常使用 TUIRoomKit 组件了。

十二、步骤3：登录

代码集成完成后，你需要完成登录。这是使用 TUIRoomKit 的关键步骤，因为只有在登录成功后才能正常使用 TUIRoomKit 的各项功能，故请你耐心检查相关参数是否配置正确：

注意：说明：

注意：在示例代码中，直接进行了登录接口的调用。但在实际项目场景下，强烈推荐你在完成自己的用户身份验证等相关登录操作后，再调用 AtomicXCore 的登录服务。这样可以避免因过早调用登录服务，导致业务逻辑混乱或数据不一致的问题，同时也能更好地适配你项目中现有的用户管理和权限控制体系。

import android.os.Bundleimport androidx.appcompat.app.AppCompatActivityimport io.trtc.tuikit.atomicxcore.api.login.LoginStoreimport io.trtc.tuikit.atomicxcore.api.CompletionHandlerimport android.util.Logclass MainActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) LoginStore.shared.login( this, // context 1400000001, // 替换为项目的 sdkAppID "test_001", // 替换为项目的 userID "xxxxxxxxxxx", // 替换为项目的 userSig object : CompletionHandler { override fun onSuccess() { // 登录成功处理 Log.d("Login", "login success"); } override fun onFailure(code: Int, desc: String) { // 登录失败处理 Log.e("Login", "login failed, code: $code, error: $desc"); } } ) }}

登录接口参数说明：

十三、步骤4：设置头像和昵称

首次登录的用户没有头像和昵称信息，需要通过 LoginStore 的 setSelfInfo 接口设置个人信息：

import android.util.Logimport io.trtc.tuikit.atomicxcore.api.CompletionHandlerimport io.trtc.tuikit.atomicxcore.api.login.LoginStoreimport io.trtc.tuikit.atomicxcore.api.login.UserProfileprivate val TAG = "Test"fun setSelfInfo() { val userProfile = UserProfile( userID = "test_001", // 你已经登录的userID nickname = "tom", // 设置昵称 avatarURL = "http://xxx.png" // 设置头像URL ) LoginStore.shared.setSelfInfo(userProfile, object : CompletionHandler { override fun onSuccess() { Log.d(TAG, "setSelfInfo success") } override fun onFailure(code: Int, desc: String) { Log.e(TAG, "setSelfInfo failed code:$code, message:$desc") } })}

setSelfInfo 接口参数说明：

十四、步骤5：创建房间

在 TUIRoomKit 组件中，RoomMainView 是集成了完整的多人音视频房间功能的核心界面，以下将对开发者演示如何以房主身份将 RoomMainView 嵌入到应用中。

十五、实现方式：

1. 加载创建视图页面：懒加载方式实例化 RoomMainView 。

2. 构造进房的配置项：进入房间后是否需要自动打开音视频设备的配置项。

3. 初始化房间主页面：通过房主身份初始化房间主页面。

4. 将视图添加到视图 Activity：在 Activity 的 onCreate 方法中，将 RoomMainView 添加到 Activity 中，并使用布局使其充满整个视图区域。

十六、示例代码：

import android.os.Bundleimport androidx.appcompat.app.AppCompatActivityimport com.trtc.uikit.roomkit.view.RoomMainViewimport io.trtc.tuikit.atomicxcore.api.room.CreateRoomOptions// MainActivity 代表你加载房间主页面的 Activityclass MainActivity : AppCompatActivity() { // 1 加载创建视图页面 private val roomView: RoomMainView by lazy { RoomMainView(this).apply { // 2 构造进房的配置项 val config = RoomMainView.ConnectConfig( autoEnableMicrophone = true, // 进房后是否自动开启麦克风 autoEnableCamera = true, // 进房后是否自动开启摄像头 autoEnableSpeaker = true // 进房后是否自动开启扬声器 ) val options = CreateRoomOptions(roomName = "roomName") // 房间名称 val behavior = RoomMainView.RoomBehavior.Create(options) // 3 初始化房间主页面 init("roomID", behavior, config) } } override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) // 4. 将视图添加到视图Activity setContentView(roomView) }}

RoomMainView init 函数参数详细说明：

ConnectConfig 参数详细说明：

CreateRoomOptions 结构体详细说明

十七、步骤6：加入房间

以下示例将向开发者演示如何以参与者身份将 RoomMainView 嵌入到应用中。

十八、实现方式：

1. 加载创建视图页面：懒加载方式实例化 RoomMainView 。

2. 构造进房的配置项：进入房间后是否需要自动打开音视频设备的配置项。

3. 初始化房间主页面：通过参与者身份初始化房间主页面。

4. 将视图添加到视图 Activity：在 Activity 的 onCreate 方法中，将 RoomMainView 添加到 Activity 中，并使用布局使其充满整个视图区域。

十九、代码示例：

import android.os.Bundleimport androidx.appcompat.app.AppCompatActivityimport com.trtc.uikit.roomkit.view.RoomMainView// MainActivity 代表你加载房间主页面的 Activityclass MainActivity : AppCompatActivity() { // 1 加载创建视图页面 private val roomView: RoomMainView by lazy { RoomMainView(this).apply { // 2 构造进房的配置项 val config = RoomMainView.ConnectConfig( autoEnableMicrophone = true, // 进房后是否自动开启麦克风 autoEnableCamera = true, // 进房后是否自动开启摄像头 autoEnableSpeaker = true // 进房后是否自动开启扬声器 ) val behavior = RoomMainView.RoomBehavior.Join // 3 初始化房间主页面 init("roomID", behavior, config) } } override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) // 4. 将视图添加到视图Activity setContentView(roomView) }}

参数详细说明请参考：RoomMainView init 函数参数详细说明 和 ConnectConfig 参数详细说明。

20、AI 助手：知识咨询与代码集成

你在接入视频会议 SDK 过程中，可以通过 MCP 使用 AI 助手，快速完成知识咨询、报错排查和集成代码生成。支持 Web/Android/iOS/Flutter/uni-app/HarmonyOS 等平台，答案基于产品文档。适用于查询 Room 组件和 AtomicXCore SDK 用法以及集成文档等场景，立即体验，提出你的第一个问题。

21、核心功能

接入 RoomMainView 代码后，开发者将得到一个完整的多人音视频页面，内部包含成员管理，音视频设备控制，房间信息展示等功能，这是 TUIRoomKit 组件的核心。

22、界面定制

RoomMainView 房间主页面内功能丰富，可定制化度高，开发者可以根据实际产品需求，对 UI 进行定制化修改，以适配业务交互场景。以下将详细为开发者展示 RoomMainView 页面中视图组件，便于开发者快速修改。

RoomMainView 中组件详细说明

23、图标定制

接入 TUIRoomKit 组件后，开发者可以根据实际 UI 交互需求直接替换组件下的图标资源， 以适配开发者的业务场景。

常用的图片文件列表

24、文案定制

TUIRoomKit 使用 Android 通用的 XML 资源文件来管理 UI 所需的文案显示，你可以直接通过 XML 文件修改需要调整的文案：

26、每次进房都需要调用登录吗？

不需要。通常你只需要完成一次 LoginStore.shared.login 调用即可，我们建议你将 LoginStore.shared.login 和

LoginStore.shared.logout 与自己的登录业务关联。

27、Android 14 以上机型切到后台后， 采集音视频无画面/无声音？

Android 14 及以上版本，应用在后台采集摄像头或麦克风数据时，必须启动前台服务并声明对应的服务类型，否则无法正常采集，解决方案可按照下面步骤：

1. AndroidManifest.xml 声明 FOREGROUND_SERVICE 、 FOREGROUND_SERVICE_CAMERA 、 FOREGROUND_SERVICE_MICROPHONE 权限和 service 声明。

<uses-permission android:name="android.permission.FOREGROUND_SERVICE" /><uses-permission android:name="android.permission.FOREGROUND_SERVICE_CAMERA" /><uses-permission android:name="android.permission.FOREGROUND_SERVICE_MICROPHONE" /><service android:name=".MediaCaptureService" android:foregroundServiceType="camera|microphone" />

2. 在界面启动后开启后台采集服务。

import android.app.NotificationChannelimport android.app.NotificationManagerimport android.app.Serviceimport android.content.Intentimport android.content.pm.ServiceInfoimport android.os.Bundleimport android.os.IBinderimport androidx.appcompat.app.AppCompatActivityimport androidx.core.app.NotificationCompatclass MainActivity : AppCompatActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) startForegroundService(Intent(this, MediaCaptureService::class.java)) }}class MediaCaptureService : Service() { override fun onCreate() { super.onCreate() // 1. 创建通知渠道 val channel = NotificationChannel("media", "媒体采集", NotificationManager.IMPORTANCE_LOW) getSystemService(NotificationManager::class.java).createNotificationChannel(channel) // 2. 构建通知 val notification = NotificationCompat.Builder(this, "media") .setContentTitle("音视频通话中") .setSmallIcon(android.R.drawable.ic_menu_call) .build() // 3. 启动前台服务，指定 camera 和 microphone 类型（Android 14+ 必须） startForeground(1, notification, ServiceInfo.FOREGROUND_SERVICE_TYPE_CAMERA or ServiceInfo.FOREGROUND_SERVICE_TYPE_MICROPHONE) } override fun onBind(intent: Intent?): IBinder? = null}