集成 SDK

1 准备环境

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

• HBuilderX 3.0.0 或以上版本。
• App:
  • 准备 iOS 及 Android 设备，版本要求如下：
    • iOS 12.0 或以上版本且支持音视频的 iOS 设备。
    • Android 4.4 或以上版本且支持音视频的 Android 设备。
  • iOS 及 Android 设备已经连接到 Internet。
• Web:
  • 准备一台可以连接到互联网的 Windows 或 macOS 计算机。
  • 使用最新版本的 Chrome 浏览器。

2 集成 SDK

2.1 创建项目（可选）

2.2 集成 SDK

方式 1：在 ZEGO 官网下载 SDK

1. 下载 Express-Video SDK 到本地，解压缩 “zego-ZegoExpressUniAppSDK” 文件。

2. 将解压缩后的文件夹，直接复制到项目工程根目录下的 “nativeplugins” 文件夹中，如果没有该目录，请手动创建。

   

方式 2：通过 uni-app 插件市场获取 Express-Video SDK。

1. 在 uni-app 插件市场任选一种方式导入：

   • 方式 1：单击 “购买（0元） for 云打包”，选择相应的项目导入。

   • 方式 2：单击 “下载 for 离线打包”，离线导入。

     下载 SDK 到本地，解压缩 “zego-ZegoExpressUniAppSDK” 文件。将解压缩后的文件夹，直接复制到项目工程根目录下的 “nativeplugins” 文件夹中，如果没有该目录，请手动创建。

2.3 在 uni-app 项目中导入插件

1. 单击项目目录的 “manifest.json” 文件后，单击 “App 原生插件配置” 中的“选择本地插件”或“选择云端插件”。

   其他常见问题，请参考 在 Windows 平台上集成 Express uni-app SDK 后，使用 dev 证书云打包运行 iOS 应用时出错，该如何处理？

   

2. 在弹出的选择框中，选择 “ZegoExpress 音视频 SDK” 后，单击“确认”，即添加成功。

   

2.4 自定义调试基座

2.4.1 制作自定义调试基座

1. 选择“运行 > 运行到手机或模拟器 > 制作自定义调试基座”菜单。

   

2. 在弹出的界面中，按照 uni-app 教程，填写相关信息，并单击“打包”进行云打包。

   

   打包成功后，控制台会收到 uni-app 的相关提示。

   

2.4.2 切换运行基座为自定义调试基座

自定义调试基座选择“运行 > 运行到手机或模拟器 > 运行基座选择 > 自定义调试基座”菜单。

3 集成 JS 封装层

1. 导入 JS 封装层。

   在插件市场的 ZegoExpressEngine 音视频插件（JS） 界面，单击右侧的“使用 HBuilderX 导入插件”。

   

   导入的 JS 封装层将存储在 uni_modules 目录中，目录结构如下。

   

2. 导入后，可以在业务代码中引入 JS 封装层，并调用 Express 相关接口，示例如下：

   import ZegoExpressEngine from "@/uni_modules/zego-ZegoExpressUniApp-JS/components/zego-ZegoExpressUniApp-JS/lib/ZegoExpressEngine";

4 设置权限

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

进入 manifest.json 文件，打开 App 权限设置，在 App 云打包权限配置里添加权限。

<!-- 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-feature
    android:glEsVersion="0x00020000"
    android:required="true" />

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

import permision from "@/pages/permission.js";

if (uni.getSystemInfoSync().platform === "android") {
    await permision.requestAndroidPermission(
    "android.permission.RECORD_AUDIO"
    );
    await permision.requestAndroidPermission(
    "android.permission.CAMERA"
    );
}

具体的权限说明如下：