# 快速集成 UIKit 开源方案 (/zh-CN/solutions/online-ktv/auikaraoke/get-started/integrate/android)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
AUIKaraoke 是一个基于 [AUIKit](https://github.com/AgoraIO-Community/AUIKit/blob/main/Android) 搭建的、针对 K 歌场景的开源 UI 组件,提供 K 歌房间相关功能。`asceneskit` 是 K 歌房的容器组件,你可以通过 `asceneskit` 自定义 K 歌房间的用户界面逻辑并实现房间管理等功能。
本文介绍如何通过 [AUIKaraoke](/zh-CN/solutions/online-ktv/auikaraoke/build/manage-karaoke/uikitkaraoke) 快速搭建一个含 UI 界面的在线 K 歌房。
## 示例项目 [#示例项目]
声网在 GitHub 上提供一个开源的[示例项目](https://github.com/AgoraIO-Community/API-Examples-AUIKit/tree/main/Android/KaraokeApp) 供你参考。
## 准备开发环境 [#准备开发环境]
本节介绍集成 AUIKaraoke 的前提条件和项目相关配置。
### 前提条件 [#前提条件]
- [Git](https://git-scm.com/downloads)
- Android API Level 24 及以上
- Android Studio 3.5 及以上
- Android 设备,版本 Android 7.0 及以上
:::warning[注意]
声网推荐使用真机运行项目。部分模拟机可能存在功能缺失或者性能问题。
:::
- [Java Development Kit](https://www.oracle.com/java/technologies/javase-downloads.html) 17 及以上
- 你的声网项目的 App ID、证书,以及环信项目的 APPKEY、Client ID 以及 Client Secret,如何获取请参考[开通 UIKit 开源方案相关服务](/zh-CN/solutions/online-ktv/auikaraoke/build/setup-and-access/enable-service)
### 创建项目并配置权限 [#创建项目并配置权限]
本节介绍如何创建项目并为项目添加体验实时互动所需的权限。
1. 如需创建新项目,在 **Android Studio** 里,依次选择 **Phone and Tablet > Empty Activity**,创建 [Android 项目](https://developer.android.com/studio/projects/create-project),如果你已有 Android 项目,可跳过这一步骤。
:::info[信息]
创建项目后,**Android Studio** 会自动开始同步 Gradle,稍等片刻,待同步成功后再进行下一步操作。
:::
2. 配置项目权限。在 `app/src/main/AndroidManifest.xml` 文件中添加下列内容:
```xml
...
```
如果你使用的不是 https 的业务服务器域名,还需要在 `app/src/main/AndroidManifest.xml` 文件中将 `usersCleartextTraffic` 属性设为 `true` 以允许所有明文请求:
```xml
...
...
```
3. 防止代码混淆。打开 `app/proguard-rules.pro` 文件,添加如下行以防止代码混淆:
```java
-keep class io.agora.**{*;}
-dontwarn javax.**
-dontwarn com.google.devtools.build.android.**
```
### 添加依赖库 [#添加依赖库]
1. 下载声网提供的 [AUIKaraoke](https://github.com/AgoraIO-Community/AUIKaraoke) 源码。运行以下命令克隆项目到本地:
```shell
git clone git@github.com:AgoraIO-Community/AUIKaraoke.git
```
2. 将 AUIKaraoke 源码目录下 `Android/asceneskit` 文件夹复制到与你的 App 文件夹所在的同一级目录下。
3. 将 AUIKaraoke 源码目录下 `Android/app/src/main/java/io/agora/app/karaoke/KaraokeUIKit.kt` 类复制到你的项目的 `app/src/main/java/` 目录下。
4. 添加 `asceneskit` 库到你的项目中。在 `settings.gradle.kts` 文件中,将 `dependencyResolutionManagement` 替换为下列代码:
```kotlin
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
google()
mavenCentral()
// 添加 jitpack 仓库
maven { url = java.net.URI.create("https://www.jitpack.io") }
}
}
rootProject.name = "KaraokeApp"
include(":app")
// 添加 asceneskit 库到项目里
include(":asceneskit")
```
5. 添加 namespace。(可选)
:::info[信息]
如果你使用的 Android Gradle Plugin 版本为 8.0,则需要添加 namespace,否则可跳过该步骤。
:::
在 `asceneskit/build.gradle` 文件中添加 namespace。
```java
android {
// Android Gradle Plugin 8.0 要求添加 namespace
namespace = "io.agora.asceneskit"
compileSdkVersion 30
...
}
```
6. 修改 Java 版本号。(可选)
:::info[信息]
如果你使用的 Java Development Kit 版本为 17,则需要修改版本号,否则可跳过该步骤。
:::
在 `asceneskit/build.gradle` 文件中修改 Java 版本号。
```java
android {
...
compileOptions {
sourceCompatibility JavaVersion.VERSION_17
targetCompatibility JavaVersion.VERSION_17
}
kotlinOptions {
jvmTarget = '17'
}
...
}
```
7. 设置主题样式。
1. 在 `app/src/main/res/values/themes.xml` 文件中修改主题(Theme)为 K 歌房主题:
```xml
```
2. 在 `app/src/main/AndroidManifest.xml` 文件中添加主题:
```xml
···
```
8. 添加 asceneskit 依赖。
在 `app/build.gradle.kts` 文件中添加 asceneskit 依赖。
```kotlin
dependencies {
...
// asceneskit依赖
implementation(project(":asceneskit"))
}
```
9. 点击 **Sync Project with Gradle Files** 来同步项目。
## 创建在线 K 歌房 [#创建在线-k-歌房]
本节介绍如何以房主身份快速搭建一个在线 K 歌房来体验 K 歌场景。
### 1. 初始化 AUIKaraoke [#1-初始化-auikaraoke]
调用 `setup` 初始化 KaraokeUIKit。打开 `app/src/main/java/MainActivity.kt` 文件,在 `onCreate` 方法里调用 `setup` 进行初始化。
```kotlin
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
...
// 初始化 KaraokeUiKit
val config = AUICommonConfig()
config.context = this
// 你的业务服务器域名
config.host = ""
// 你的声网 AppID
config.appId = ""
// 你的声网 App 证书
config.appCert = ""
// 你的 IM AppKey
config.imAppKey = ""
// 你的 IM Client ID
config.imClientId = ""
// 你的 IM Client Secret
config.imClientSecret = ""
config.owner = AUIUserThumbnailInfo().apply {
// 用户 ID
userId = (Random().nextInt(1000) + 10000).toString()
// 用户名
userName = "User-$userId"
// 用户头像
userAvatar = "https://accktvpic.oss-cn-beijing.aliyuncs.com/pic/sample_avatar/sample_avatar_1.png"
}
// Setup KaraokeUIKit
KaraokeUIKit.setup(
commonConfig = config, // must
apiConfig = AUIAPIConfig(
ktvApi = null,
rtcEngineEx = null,
rtmClient = null
)
)
}
```
### 2. 创建并进入房间 [#2-创建并进入房间]
1. 添加**创建房间**按钮。
1. 在 `app/src/main/res` 路径下新建一个名为 **layout** 的文件夹,在该文件夹下创建一个 `.xml` 文件,文件名为 **main_activity.xml**,然后将下列代码复制到该文件中:
```kotlin
```
2. 设置 UI 布局。打开 `app/src/main/java/MainActivity.kt` 文件,设置 xml 布局并设置按钮点击事件。
```kotlin
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// 将 jectpack compose 布局改成 xml 布局
setContentView(R.layout.main_activity)
// 设置点击事件并弹窗
findViewById