文档

Android端快速集成

更新时间:

本文为您介绍Android端接入K歌房的操作指引。

源码说明

源码地址

源码地址请参见Android源码

源码结构

需要用到3个组件库,AUIBaseKits、AUIVoiceRoomEngine和AUIKaraokeRoomEngine,结构如下:

├── Android       //Android平台工程结构跟目录
│   ├── AUIBaseKits    //AUI基础组件
│   ├── AUIKaraokeRoomEngine //场景接口与实现
│   ├── AUIVoiceRoomEngine // 语聊场景接口与实现
│   ├── README.md
│   ├── app           //Demo
│   ├── build.gradle  
│   └── settings.gradle

环境要求

  • Android Studio插件版本4.1.3

  • Gradle 7.0.2

  • Android Studio自带JDK 11

前提条件

需要开通应用,并且在你的服务端上开发相关接口或直接部署提供的Server源码,请参见前置准备

快速集成

在已有的工程上接入K歌房场景化能力,只需要AUIKaraokeRoomEngine模块。

工程配置

  1. 导入AUIKaraokeRoomEngine。

仓库代码下载后,Android Studio菜单选择:File > New > Import Module,导入选择文件夹。

  1. 修改文件夹下的build.gradle的第三方库依赖项。

dependencies {

    implementation 'androidx.appcompat:appcompat:x.x.x'                     //修改x.x.x为你工程适配的版本
    implementation 'com.google.android.material:material:x.x.x'             //修改x.x.x为你工程适配的版本
    androidTestImplementation 'androidx.test.espresso:espresso-core:x.x.x'  //修改x.x.x为你工程适配的版本
    implementation 'com.aliyun.aio:AliVCSDK_Standard:x.x.x'                  //修改x.x.x为你工程适配的版本
}
  1. 等待gradle同步完成,完成源码集成。

源码配置

  1. 完成前提条件后,进入文件KTVServerConstant.java,修改服务端域名。

//  KTVServerConstant.java
public static final String HOST = "你的应用服务器域名";
  1. 完成前提条件后,进入文件KTVServerConstant.java,修改实时音视频应用ID。

//  KTVServerConstant.java
public static final String APP_ID = "你的实时音视频应用appID";

调用API示例

上述步骤完成后,您可以根据自身的业务场景和交互,在您App的其他模块或主页上通过组件接口快速实现K歌房功能,也可以根据自身的需求修改源码,具体可以参考AUIKaraokeRoom模块中ARTCKaraokeRoomEngine接口被调用处的代码。