文档中心
AI 美颜
快速开始
集成 SDK

集成 SDK

更新时间：2024-12-02 18:54

1 准备环境

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

Android Studio 2.1 或以上版本。
Android SDK 25、Android SDK Build-Tools 25.0.2、Android SDK Platform-Tools 25.x.x 或以上版本。
Android 8.0 或以上版本，且支持音视频的 Android 设备或模拟器（推荐使用真机）。

2 集成 SDK

2.1 （可选）新建项目

此步骤以如何创建新项目为例，如果是集成到已有项目，可忽略此步。

打开 Android Studio，选择 “File > New > New Project” 菜单。
填写项目名及项目存储路径。
其它按照默认设置，单击 “Next”，最后单击 “Finish” 完成新工程创建。

2.2 导入 SDK

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

请在下载页面，获取最新版本的 SDK。
解压 SDK 至项目目录，如 “app/libs”。
添加 SDK 引用，进入到 “app” 目录，打开 “build.gradle” 文件。
- 在 “defaultConfig” 节点添加 “ndk” 节点，指定支持的平台类型。
```
ndk {
  abiFilters 'armeabi-v7a', 'arm64-v8a', 'x86_64' 
}
```
- 在 “android” 节点添加 “sourceSets” 节点，指定 “libs” 所在目录。
  
  示例代码中 “libs” 目录仅为举例，开发者可根据实际路径填写。
```
sourceSets {
  main {
      jniLibs.srcDirs = ['libs']
  }
}
```
- 在 “dependencies” 节点引入 “libs” 下所有的 jar。
```
implementation fileTree(dir: 'libs', include: ['*.jar'])
```

3 设置权限

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

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

Android SDK 版本在 33 及以上，默认不开启 OpenCL，如需使用，开发者需要主动开启 OpenCL。

<!-- SDK 必须使用的权限 -->
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

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


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

<!-- Android SDK 33 或以上，需要执行该语句开启 OpenCL-->
<uses-library android:name="libOpenCL.so" android:required="false"/>

因为 Android 6.0 在一些比较重要的权限上要求必须申请动态权限，不能只通过 “AndroidMainfest.xml” 文件申请静态权限。因此还需要参考执行如下代码，其中 “requestPermissions” 是 “Activity” 的方法。

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

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

4 防止混淆代码

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

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

5 导入资源和模型

请根据导入资源和模型文档，导入 SDK 内的 AI 模型和资源。