文档中心
实时音视频
快速开始
集成 SDK

集成 SDK

更新时间：2023-10-19 21:29

1 准备环境

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

准备一台可以连接到互联网的 Windows 或 macOS 计算机。
使用最新版本的 Google Chrome 浏览器。

浏览器的兼容性，请参考浏览器兼容性和已知问题。

2 集成 SDK

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

方式 1：从官网下载 SDK，手动集成

下载最新版本的 SDK 并解压。
解压 SDK 压缩包，我们可以在 “dist_js/” 下找到 “ZegoExpressWebRTC-x.x.x.js” 文件。
推荐下载 VSCode，在 VSCode 中找到项目文件目录并打开。
安装 VSCode 扩展插件 Live Server。
新建 “index.html” 文件，并放置于和 “ZegoExpressWebRTC-x.x.x.js” 相同的目录下。

在 “index.html” 文件中编写界面代码，并在文件的 head 中引入 “ZegoExpressWebRTC-x.x.x.js”。其中，“x.x.x” 为 SDK 的版本号，请参考第 2 步压缩包解压后的文件名修改。

“index.html” 代码示例如下：

<html>

<head>
    <meta charset="UTF-8">
    <title>Zego Express Video Call</title>
    <style type="text/css">
        * {
            font-family: sans-serif;
        }

        h1,
        h4 {
            text-align: center;
        }

        #local-video, #remote-video {
            width: 400px;
            height: 300px;
            border: 1px solid #dfdfdf;
        }

        #local-video {
            position: relative;
            margin: 0 auto;
            display: block;
        }

        #remote-video {
            display: flex;
            margin: auto;
            position: relative !important;
        }
    </style>

    <script src="./ZegoExpressWebRTC-x.x.x.js"></script>
</head>

<body>
    <h1>
        Zego RTC Video Call
    </h1>
    <h4>Local video</h4>
    <div id="local-video"></div>
    <h4>Remote video</h4>
    <div id="remote-video"></div>
    <script> // 教程中的 js 代码可粘贴至此标签内

    // const zg = new ZegoExpressEngine(appID, server);
    </script>
</body>

</html>

在 “index.html” 文件的编辑面板，单击鼠标右键，弹出菜单，选择“Open with Live Server”，即可看到基本界面，此时表示 SDK 已集成。

方式 2：使用 npm 方式集成

1. 新建项目

创建一个文件夹作为基础音视频通话的项目文件夹，结构类似如下：
```
├── index.html
├── index.js
```

将以下代码拷贝到 “index.html” 文件中。

<html>

<head>
    <meta charset="UTF-8">
    <title>Zego Express Video Call</title>
    <style type="text/css">
        * {
            font-family: sans-serif;
        }

        h1,
        h4 {
            text-align: center;
        }

        #local-video, #remote-video {
            width: 400px;
            height: 300px;
            border: 1px solid #dfdfdf;
        }

        #local-video {
            position: relative;
            margin: 0 auto;
            display: block;
        }

        #remote-video {
            display: flex;
            margin: auto;
            position: relative !important;
        }
    </style>
</head>

<body>
    <h1>
        Zego RTC Video Call
    </h1>
    <h4>Local video</h4>
    <div id="local-video"></div>
    <h4>Remote video</h4>
    <div id="remote-video"></div>
    <script src="index.js"></script>
</body>

</html>

通过 npm 安装 SDK。

在终端中，cd 到 ”index.js“ 文件所在的文件夹，执行 npm i zego-express-engine-webrtc 命令安装依赖。
- npm 下载包支持 typescript 语言（推荐）。
- 如果在 macOS 或 Linux 系统中执行 npm 命令失败，提示 “permission denied”，请在 npm 命令前加上 sudo 重新执行即可。

在 “index.js” 文件中引入 SDK。

方式 1:

import {ZegoExpressEngine} from 'zego-express-engine-webrtc'

方式 2:

var ZegoExpressEngine = require('zego-express-engine-webrtc').ZegoExpressEngine

在本地 Web 服务器上运行和测试项目。

本地服务器（localhost 或 127.0.0.1）运行 Web 应用仅作为测试，生产环境必须使用 HTTPS 协议。
1. 在命令行中执行 npm i live-server -g 命令，安装 live-server。
2. 进入项目所在的根目录。
3. 执行 live-server . 命令运行该项目，浏览器会自动打开 “index.html” 页面。

云通讯产品

AIGC

扩展服务

低代码互动产品

标准 AI 产品

AIGC

社交娱乐

电商直播

在线教育

医疗健康

互动游戏

协同办公