集成 SDK
准备环境
在开始集成 ZEGO MiniGameEngine SDK 前,请确保开发环境满足以下要求:
- Android Studio 2021.2.1 或以上版本。
- Android SDK 29、Android SDK Build-Tools 29.0.2、Android SDK Platform-Tools 29.x.x 或以上版本。
- Android 5.0 或以上版本且支持音视频的 Android 设备。
- Android 设备已经连接到 Internet。
集成 SDK
(可选)新建项目
导入 ZEGO Express SDK
ZEGO MiniGameEngine SDK 需要与 ZEGO Express SDK 3.1.1 或以上版本 搭配使用。如果您的项目已集成相关 SDK,可忽略此步骤,否则,请根据您的项目需求,参考以下任一文完成集成:
导入 ZEGO MiniGameEngine SDK
开发者可通过以下任意一种方式实现集成 SDK。
方式一:自动集成
-
在项目的 “setting.gradle” 或 “build.gradle” 文件中的 ·repositories” 节点加上 ZEGO 的私有 maven 仓库地址。
Untitledrepositories { ... maven { url "https://storage.zego.im/maven" } ... }
1 -
打开 “app/build.gradle” 文件,在
dependencies
节点下添加以下依赖项:
以下代码中的 x.y.z
应替换为为小游戏平台 SDK 的版本号,请参考 小游戏平台 - 发布日志
dependencies {
...
implementation "im.zego:minigameengine:x.y.z"
...
implementation "com.tencent.tcr:tcrsdk-full:3.19.1" // 弹幕游戏必须依赖此项
implementation "com.google.code.gson:gson:2.8.8"
}
方式二:手动集成
-
请参考 SDK 下载 文档,下载最新版本的 SDK 并解压。
-
打开已解压文件夹,将 zegoaminigame.aar 文件,拷贝到您的项目的 “app/libs” 目录下。
-
打开 “app/build.gradle” 文件,在 dependencies 节点下添加以下依赖项:
Untitled... dependencies { ... implementation fileTree(dir:'libs', include: ['.jar', '.aar']) ... ... implementation "com.tencent.tcr:tcrsdk-full:3.19.1" // 弹幕游戏必须依赖此项 implementation "com.google.code.gson:gson:2.8.8" ... }
1
设置权限
必需权限
打开 “/app/src/main/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" />
具体的权限说明如下:
必要性 | 权限 | 权限说明 | 申请原因 |
---|---|---|---|
必要权限 | INTERNET | 访问网络权限。 | SDK 基本功能都需要在联网的情况下才可以使用。 |
ACCESS_WIFI_STATE | 获取当前 Wi-Fi 状态权限。 | SDK 会根据网络状态的改变执行不同的操作。例如,当网络重连时,SDK 内部会将网络断开时的状态都恢复,用户不需做额外的操作。 | |
ACCESS_NETWORK_STATE | 获取当前网络状态权限。 |
可选权限
如果您需要在项目中实现直播、语聊房等场景,请设置摄像头和麦克风相关权限。
打开 “/app/src/main/AndroidManifest.xml” 文件,添加如下权限:
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
具体的权限说明如下:
必要性 | 权限 | 权限说明 | 申请原因 |
---|---|---|---|
非必要权限 | CAMERA | 访问相机权限。 | 预览和发送视频时需要使用该权限。 |
RECORD_AUDIO | 录制音频权限。 | 发送音频时需要使用该权限。 | |
BLUETOOTH | 连接蓝牙设备权限。 | 连接蓝牙设备时需要使用该权限。 注意 仅 Android 6.0 以下版本需要声明,Android 6.0 及以上版本无需声明。 | |
MODIFY_AUDIO_SETTINGS | 修改音频配置权限。 | 修改音频设备配置时需要使用该权限。 |
5 设置混淆规则
ZEGO MiniGameEngine SDK 内部已经做了混淆处理,您的项目无需再针对集成 ZEGO MiniGameEngine SDK 增加混淆规则。
下一步
到此为止,您已成功向您的项目集成了相关 SDK。接下来,您可参考下列文档,了解如何开播弹幕游戏: