集成 SDK

1 准备环境

在开始集成 ZEGO Express SDK 前，请确保开发环境满足以下要求：

• Android Studio 2020.3.1 或以上版本。

• Android SDK 25、Android SDK Build-Tools 25.0.2、Android SDK Platform-Tools 25.x.x 或以上版本。
• Android 4.4 或以上版本，且支持音视频的 Android 设备。
• Android 设备已经连接到 Internet。

2 集成 SDK

2.1 （可选）新建项目

2.2 导入 SDK

目前支持的平台架构包括：armeabi-v7a、arm64-v8a、x86、x86_64。

开发者可通过以下任意一种方式实现集成 SDK。

方式一：自动集成 SDK

1. 进入项目根目录，打开 “settings.gradle” 文件，在 “dependencyResolutionManagement” 中加入如下代码。

   ...
   dependencyResolutionManagement {
       repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
       repositories {
           maven { url 'https://storage.zego.im/maven' }
           google()
           mavenCentral()
       }
   }

   如果您在 “settings.gradle” 中找不到上述字段，可能是因为您的 Android Gradle Plugin 版本低于 v7.1.0。

   相关信息请参考 Android Gradle Plugin Release Note v7.1.0。

   若您的 Android Gradle Plugin 版本低于 v7.1.0，请按照如下方式操作：

   进入项目根目录，打开 “build.gradle” 文件，在 “allprojects” 中加入如下代码。

   ...
   allprojects {
       repositories {
           maven { url 'https://storage.zego.im/maven' }
           google()
           mavenCentral()
       }
   }

2. 进入 “app” 目录，打开 “build.gradle” 文件，在 “dependencies” 中添加 implementation 'im.zego:express-audio:x.y.z'，请从 发布日志 查询 SDK 最新版本，并将 x.y.z 修改为具体的版本号。

   ...
   dependencies {
       ...
       implementation 'im.zego:express-audio:x.y.z'
   }

方式二：复制 SDK 文件手动集成

1. 请参考 下载 SDK 包 ，下载最新版本的 SDK。

2. 解压 SDK 至项目目录，如 “app/libs”。

   

   "ZegoExpressEngine-sources.jar" 是源码包，可在 Android Studio 导入以获得更好的开发体验。

   具体可参考 Express Android SDK 如何查看 API 注释和文档？

3. 添加 SDK 引用，进入 “app” 目录，打开 “build.gradle” 文件。

   1. 在 “defaultConfig” 节点添加 “ndk” 节点，指定支持的架构。

      

      ndk {
          abiFilters 'armeabi-v7a', 'arm64-v8a', 'x86', 'x86_64'
      }

      根据实际情况决定要支持的架构。通常在发布 App 时只需要保留 "armeabi-v7a" 和 "arm64-v8a" 即可，可以减少 APK 包大小。

   2. 在 “android” 节点添加 “sourceSets” 节点，指定 “libs” 所在目录。

      示例代码中 “libs” 目录仅为举例，开发者可根据实际路径填写。
      

      sourceSets {
          main {
              jniLibs.srcDirs = ['libs']
          }
      }

   3. 在 “dependencies” 节点引入 “libs” 下所有的 jar。

      dependencies {
          implementation fileTree(dir: 'libs', include: ['*.jar'])
          ......
      }

3 设置权限

根据实际应用需要，设置应用所需权限。

进入 “app/src/main” 目录，打开 “AndroidManifest.xml” 文件，添加权限。

<!-- SDK 必须使用的权限 -->
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />

<!-- App 需要使用的部分权限 -->
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

<uses-feature
    android:glEsVersion="0x00020000"
    android:required="true" />

<uses-feature android:name="android.hardware.camera" />
<uses-feature android:name="android.hardware.camera.autofocus" />

String[] permissionNeeded = {
    "android.permission.RECORD_AUDIO"};

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
    if (ContextCompat.checkSelfPermission(this, "android.permission.RECORD_AUDIO") != PackageManager.PERMISSION_GRANTED) {
        requestPermissions(permissionNeeded, 101);
    }
}

具体的权限说明如下：

4 防止混淆代码

在 “proguard-rules.pro” 文件中，为 SDK 添加 -keep 类的配置，防止混淆 SDK 公共类名称。

-keep class **.zego.**{*;}

相关文档

如何减少集成 Native SDK 的 App 体积？