实时音视频
  • iOS
  • Android : Java
  • macOS
  • Windows
  • HarmonyOS
  • Linux
  • Web
  • 小程序
  • Flutter
  • Electron
  • Unity3D
  • uni-app
  • React Native
  • Cocos2D
  • 产品简介
  • 下载
  • 体验 App
  • 快速开始
    • 跑通示例源码
    • 集成 SDK
    • 实现视频通话
    • 实时音视频 SDK 与实时语音 SDK 差异
  • 基础功能
  • 进阶功能
  • 最佳实践
  • 常见错误码
  • 服务端 API
  • 客户端 API
  • 常见问题

集成 SDK

更新时间:2022-09-16 17:11

1 准备环境

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

  • Android Studio 2020.3.1 或以上版本。

Android Studio 版本编号系统的变更请参考 Android Studio 版本说明

  • 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 (可选)新建项目

此步骤以如何创建新项目为例,如果是集成到已有项目,可忽略此步。
  1. 打开 Android Studio,选择 “File > New > New Project” 菜单。

  2. 填写项目名及项目存储路径。

  3. 其它按照默认设置,单击 “Next”,最后单击 “Finish” 完成新工程创建。

2.2 导入 SDK

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

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

方式一:使用 JitPack 自动集成 SDK

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

    ...
    dependencyResolutionManagement {
        repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
        repositories {
            maven { url 'https://jitpack.io' }
            google()
            mavenCentral()
        }
    }

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

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

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

    ...
    allprojects {
        repositories {
            maven { url 'https://www.jitpack.io' }
            google()
            mavenCentral()
        }
    }

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

  2. 进入 “app” 目录,打开 “build.gradle” 文件,在 “dependencies” 中添加 implementation 'com.github.zegolibrary:express-video:2.+',这样能获取到最新的版本,如果需要下载指定版本,请从 https://jitpack.io/#zegolibrary/express-video 查询具体版本号,并将 2.+ 修改为指定的版本号。

    ...
    dependencies {
        ...
        implementation 'com.github.zegolibrary:express-video:2.+'
    }
    • 2.7.0 版本开始,Zego 将使用 JitPack 代替 JCenter 作为 SDK 托管服务器,因此开发者需手动将 build.gradle 里的配置变更为 'com.github.zegolibrary:express-video:2.+'

    • JCenter 2021-03-31 之后停止上传新版本 SDK,该服务于 2021-05-01 停用,详情请参考 Service End for JCenter

方式二:复制 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.CAMERA" />
<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-permission android:name="android.permission.WAKE_LOCK" />

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

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

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

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

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

具体的权限说明如下:

必要性 权限 权限说明 申请原因
必要权限
INTERNET
访问网络权限。
SDK 基本功能都需要在联网的情况下才可以使用。
ACCESS_WIFI_STATE
获取当前 WiFi 状态权限。
SDK 会根据网络状态的改变执行不同的操作。例如当网络重连的时候,SDK 内部会将网络断开时的状态都恢复,用户不需做额外的操作。
ACCESS_NETWORK_STATE
获取当前网络状态权限。
CAMERA
访问相机权限。
预览和发送视频的时候需要使用该权限。
RECORD_AUDIO
录制音频权限。
发送音频的时候需要使用该权限。
BLUETOOTH
连接蓝牙设备权限。
连接蓝牙设备时需要使用该权限。
MODIFY_AUDIO_SETTINGS
修改音频配置权限。
修改音频设备配置时需要使用该权限。
非必要权限
READ_PHONE_STATE
允许以只读方式访问电话状态,包括当前的呼叫状态。
SDK 会根据当前的呼叫状态,启停音频设备。如监听到当前为呼叫状态,则 SDK 会自动停止使用音频设备,直到通话结束。
WRITE_EXTERNAL_STORAGE
内置 SDK 写权限。
若需要使用媒体播放器或音效播放器加载 Android 外部存储内的媒体资源文件,则需要申请此权限,否则 SDK 无法加载资源。

其中非必要权限 “android.permission.READ_PHONE_STATE” 仅用于实现 SDK 的打断事件处理,因此只需在 AndroidMainfest.xml 文件中进行声明即可,不需要动态申请(业务方有需求则另外处理)。

4 防止混淆代码

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

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

相关文档

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