# 实现语聊房 (/zh-CN/solutions/chatroom/uikit/build/quick-integration)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
<_PlatformTabsGroup>
<_PlatformProcessedMarker groupMode="structured" canonicalPlatform="android" platform="android" />
## 示例项目 [#示例项目]
本文介绍如何集成语聊 UIKit 来实现语聊房间的创建和销毁、用户进房和退房等功能。`API-Examples-AUIKit` 是极简语聊项目。你可以参考该项目了解本文提供的集成步骤和代码逻辑。
## 准备开发环境 [#准备开发环境]
### 前提条件 [#前提条件]
- [Android Studio](https://developer.android.com/studio/) 3.5 及以上。本文以 [Android Studio Giraffe | 2022.3.1](https://developer.android.google.cn/studio/releases?hl=zh-cn) 和 JBR 17.0.6 为例。
- Android 手机,版本 Android 5.0(API Level 21)及以上。
- 可以访问互联网的计算机。确保你的网络环境没有部署防火墙,否则无法正常使用声网服务。
- [开通语聊房 UIKit 相关服务](/zh-CN/solutions/chatroom/uikit/build/enable-service)。
### 创建项目 [#创建项目]
如需创建新项目,在 **Android Studio** 里,依次选择 **Phone and Tablet > Empty Activity**,创建 [Android 项目](https://developer.android.com/studio/projects/create-project)。
:::warning[注意]
创建项目后,**Android Studio** 会自动开始同步 gradle,稍等片刻至同步成功后再进行下一步操作。
:::
### 集成依赖 [#集成依赖]
本节介绍如何集成语聊项目所需的依赖库:
1. 下载声网提供的 [AUIVoiceRoom](https://github.com/AgoraIO-Community/AUIVoiceRoom) 仓库:
```shell
git clone git@github.com:AgoraIO-Community/AUIVoiceRoom.git
```
2. 将 `AUIVoiceRoom/Android/asceneskit` 文件夹复制到与你的 `app` 文件夹同层级的位置。
3. 将 `AUIVoiceRoom/Android/app-voice/src/main/java/io/agora/app/voice/kit/AUIVoiceRoomUIKit.kt` 文件复制到你的 `/app/src/main/java/` 文件夹中
4. 在 `/setting.gradle.kts` 文件中添加如下行:
```kotlin
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
google()
mavenCentral()
// 添加 jitpack 仓库,拉取 auikit 库
maven { url = java.net.URI.create("https://www.jitpack.io") }
}
}
// 项目名需为你的 Android Studio 项目的真实名称
rootProject.name = "VoiceRoomApp"
include(":app")
// 添加 asceneskit 库到项目里
include(":asceneskit")
```
5. 在 `/app/build.gradle.kts` 文件中添加如下行:
```kotlin
dependencies {
...
// 添加 asceneskit 依赖
implementation(project(":asceneskit"))
}
```
6. 点击 **Sync Now** 按钮,等待 gradle 同步完成。

### 配置权限 [#配置权限]
在 `/app/Manifests/AndroidManifest.xml` 文件中添加如下行,以完成如下设置:
- 设置允许 App 访问网络、录音等权限。
- (可选)如果你的后端服务 Host URL 不是 https 开头,设置允许 App 使用非加密的网络通信。
- 声明 `MainActivity` 活动,即 App 的主要活动。
- 声明 `RoomActivity` 活动,即 App 中语聊房房间的详情界面活动。同时,指定语聊房的窗口保持原始大小和布局,不受到软键盘的影响。
```xml
android:screenOrientation="portrait" />
```
### 配置主题 [#配置主题]
在 `/app/src/main/res/values/themes.xml` 文件中添加如下行配置语聊房 UI 主题:
```xml
```
### (可选)防止代码混淆 [#可选防止代码混淆]
在 `/app/proguard-rules.pro` 文件中添加如下行,以防止声网 SDK 的代码被混淆:
```kotlin
-keep class io.agora.**{*;}
-dontwarn javax.**
-dontwarn com.google.devtools.build.android.**
```
## 实现语聊房 [#实现语聊房]
`AUIVoiceRoomUIKit` 基于声网 RTC、RTM 引擎、AUIKit 等模块封装,帮助你轻松管理语聊房。
你可以使用 `AUIVoiceRoomUIKit` 类中的 API 实现语聊房间的创建和销毁、用户进房和退房等功能。
### 1. 初始化 AUIVoiceRoomUIKit [#1-初始化-auivoiceroomuikit]
在 `MainActivity.kt` 文件中添加 `onCreate` 函数。在该函数中调用 `AUIVoiceRoomUIKit` 类的 `init` 方法并传入如下参数,以初始化 `AUIVoiceRoomUIKit`:
- `AUICommonConfig`:基础配置,包含如下参数:
- `context`:应用程序的上下文。
- `owner`:设置你的业务的用户信息。
- 声网项目的 App ID。
- 声网项目的 App 证书。
- 用于 HTTP 基本认证的 `Authorization`。
- 环信 IM 服务的 App Key。
- 环信 IM 服务的 Client ID。
- 环信 IM 服务的 Client Secret。
- 语聊后端服务的 Host URL。
App ID 等参数取值可参考[配置示例项目](/zh-CN/solutions/chatroom/uikit/build/run-github-project#配置示例项目)。
- `AUIAPIConfig`:声网 API 实例结构体,包含 RTC 引擎和 RTM 引擎实例。如需使用其中任一一个实例,请通过该结构体进行传入,如果未传入,系统内部会自动创建。
```kotlin
class MainActivity : ComponentActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// 初始化 AUIVoiceRoomUIKit
AUIVoiceRoomUIKit.init(
// 设置基础配置
AUICommonConfig().apply {
// 设置应用程序的上下文
context = applicationContext
// 设置开通服务后获取到的参数
host =
appId =
appCert =
basicAuth =
imAppKey =
imClientId =
imClientSecret =
// 设置你的业务的用户信息
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"
}
},
AUIAPIConfig()
)
}
}
```
### 2. 房主创建并加入房间 [#2-房主创建并加入房间]
本节展示如何让房主创建并加入语聊房。
#### 2.1 添加按钮:创建房间 [#21-添加按钮创建房间]
:::info[信息]
Android Studio Giraffe 默认使用 Jetpack Compose 构建 UI,但依然兼容 XML 布局。本文以 XML 布局为例进行演示。
:::
参考如下步骤添加**创建房间**按钮:
1. 新建 `/app/src/main/res/layout/main_activity.xml` 文件并在该文件中添加如下行,以增加一个**创建房间**按钮,用于让房主点击创建:
```xml
```
2. 在 `MainActivity.kt` 文件中,添加如下高亮的几行,设置当前 Activity 使用 XML 布局,并为**创建房间**按钮设置点击事件的监听器。
```kotlin
class MainActivity : ComponentActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// highlight-start
// 设置使用 XML 布局
setContentView(R.layout.main_activity)
// highlight-end
// 初始化 AUIVoiceRoomUIKit
AUIVoiceRoomUIKit.init(
...
)
// highlight-start
// 添加点击创建房间按钮的事件
findViewById