实时音视频
  • 平台类型
  • 框架 / 引擎

SDK 集成指引

更新时间:2020-06-08 16:58

1 准备环境

请确保开发环境满足以下技术要求:

  • Android Studio 2.1 或以上版本
  • 已经下载好 Android SDK 25、Android SDK Build-Tools 25.0.2、Android SDK Platform-Tools 25..
  • Android 版本不低于 4.0.3 且支持音视频的 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。

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

  1. 在项目的 app/build.gradle 文件中添加如下行:
...
dependencies {
    ...
    // x.y.z 请填写具体版本号,如:1.3.4
    // 可通过 SDK 发布历史取得最新版本号
    implementation 'im.zego:express-engine-video:x.y.z'
}

请点击查看 SDK发布历史 以获取最新版本号

方式二:手动添加 SDK 到项目中

  1. 下载 SDK

    请从 ZegoExpressEngine Android 下载 SDK。

  2. 解压 SDK 至项目目录,如 app/zego_libs

  3. 添加SDK引用。打开 app/build.gradle 文件,添加如下内容:

    • defaultConfig 节点添加 ndk 节点,指定支持的平台类型

      ndk {
        abiFilters 'armeabi-v7a', 'arm64-v8a', 'x86'
      }
    • android 节点添加 sourceSets 节点,指定 libs 所在目录

      sourceSets {
        main {
            jniLibs.srcDirs = ['zego_libs']
        }
      }
    • dependencies 节点添加

      implementation fileTree(dir: 'zego_libs', include: ['*.jar'])

2.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" />
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

    <!-- App 需要使用的部分权限 -->
    <uses-permission android:name="android.permission.READ_PHONE_STATE" />
    <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);
    }
}

2.4 防止混淆代码

proguard-rules.pro 文件中,为 Zego SDK 添加 -keep 类的配置,这样可以防止混淆 Zego SDK 公共类名称:

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

3 相关文档

集成 SDK 后,可以使用 ZEGO SDK 依次完成如下功能来实现基础的通话或者直播。

快速开始-初始化