互动视频
  • 平台类型
  • 框架 / 引擎

SDK集成指引

更新时间:2020-05-18 20:50

手动安装

目前 ZegoLiveRoom SDK 仅支持通过拷贝库文件的方式,集成步骤如下。

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

请从 ZegoLiveRoom Android 下载 SDK。

如果要实现播放本地音频、视频文件的功能(可用于播放背景音乐,播放MV,播放直播音效等场景),请下载包含 MediaPlayer 功能的 SDK,请下载 ZegoLiveRoom_MediaPlayer Android

历史版本日志,请查看:ZegoLiveRoom Android 历史版本日志

3 集成 SDK

3.1 新建示例工程

请注意: 此步骤以如何创建新工程为例,如果是集成到已有项目,可忽略此步。

  1. 打开 Android Studio,选择菜单 File-->New-->New Project。
  1. 填写项目名及项目存储路径。

  2. 其它按照默认设置一路 Next,最后点击 "Finish" 完成新工程创建。

3.2 导入 SDK

注意,目前我们仅提供 .jar 和 .so 形式的SDK,暂不支持 .aar 形式的SDK。目前支持的平台架构包括:armeabi-v7a、arm64-v8a、x86。

3.2.1 解压 SDK 至项目目录,如 app/zego_libs。

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

  • 在 defaultConfig 节点添加 ndk 节点,指定支持的平台类型
ndk {
    abiFilters 'armeabi-v7a', 'arm64-v8a', 'x86'
}
  • 在 android 节点添加 sourceSets 节点,指定 zego jni libs 目录
sourceSets {
    main {
        jniLibs.srcDirs = ['zego_libs']
    }
}
  • 在 dependencies 节点添加
implementation fileTree(dir: 'zego_libs', include: ['*.jar'])

3.2.3 添加权限声明。打开 app/AndroidManifest.xml 文件,添加如下内容:

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

    <!-- App 非必要的权限 -->
    <uses-permission android:name="android.permission.READ_PHONE_STATE" />

请注意:因为 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 修改音频配置权限 当SDK需要从蓝牙耳机上发送和接收音频的时候需要使用
WRITE_EXTERNAL_STORAGE 内置SDK写权限 SDK会将日志和相关配置文件保存在内置SDK内。
非必要权限 READ_PHONE_STATE 允许以只读方式访问电话状态,包括当前的呼叫状态 SDK会根据当前的呼叫状态,启停音频设备。如监听到当前为呼叫状态,那么SDK会自动停止使用音频设备,直到通话结束。

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

3.2.4 防止混淆代码

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

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

3.3 使用 SDK

参见 API说明-Android API