Breaking change

  • Refactored demo with Vue 3. The steps to run the sample app have changed. See below for details.

Updated

  • Removed ZN prefix from ZoomAPPLocale, ZoomSDKUserType, LeaveMeetingCmd, SDKViewType, VideoStatus, ShareStatus, SettingTabPage, SDKMinimizeUIMode, SMSVerificationCodeErr, SettingsNetWorkType, SettingConnectionType, SDKCustomizedURLType, RequiredInfoType, WebinarNeedRegisterType, AudioCallbackActionInfo, RecordingStatus, SDKUserInfoType, CustomizedLanguageType, ZoomSDKEchoCancelLationLevel enums in lib/settings.js

Tip

  • The default version of Electron is 17.0.0. Modify package.json to use other versions of Electron.

Updated installation instructions

Follow these updated installation instructions. These instructions replace the Meeting SDK Electron wrapper installation documentation, which will be updated soon.

Structure of Zoom Electron SDK Sample App

├── [sdk]
├── [mac] <-- Node file built by Zoom for mac
├── [win32] <-- Node file built by Zoom for win 32-bit
├── [win64] <-- Node file built by Zoom for win 64-bit
├── binding.gyp 
├── package.json
├── tsconfig.json
├── vue.config.js <-- use to config webpack and electon-builder
├── readme.txt / readme.md
├── [scripts] <-- use to build node, run demo and build install package
├── [src] <-- demo app
├── [public] <-- html file
└── [lib] <-- js files and source code of Zoom Electron SDK

Install & Run the Sample App

In the light of the rapid version iteration of the Electron framework, the requirements for building and running an Electron application keep changing, as a result, manual installation of the dependencies based on the Electron version is required to build and to run the sample app. The following instruction will show you the basic steps to do so:

**Note**: If you have already installed the required environment and dependencies, you may skip the steps in**Install dependencies**.

Windows

Prerequisites

  • A device with Windows OS

  • 650MB of free disk space

Install dependencies

  1. Install node.js. Instructions here: https://nodejs.org/en/.

  2. Install build environment. You may install

    • The Windows build tools, or

    • Visual Studio 2019 or above.

    • It is recommended to install**Visual Studio 2019** as the best practice.

  3. Option 1: Installing Windows build tools:

  4. Option 2: Installing Visual Studio:

  5. Install Python. Based on the Electron version that you are using, you might install a different python version. 

    • Python 2.7 works with Electron 2 to Electron 9 and

    • Python 3 works with Electron 4 and higher versions.

    • Download the installation packages from":

    • https://www.python.org/downloads/

    • Once you have installed Python, please make sure python is added to the system PATH.

Build & Run

After successfully installed the above dependencies, build and run the sample app with the following command:

npm run electron:serve

This runs electron_sdk_install.js, configures the project based on package.json, and installs the required dependencies (including Electron). When the script finishes the configuration, it launches the sample app.

If you would like to install other versions of the Electron framework, you may edit the corresponding version number in package.json. Please note that the sample app currently does not support Electron 13 or below.

macOS

Prerequisites

  • A device with macOS

  • 580MB of free disk space

Install dependencies

  1. Install node.js.

    • If you use arm platform, please use node with version 16 or above.

    • Find the installation packages at:
      https://nodejs.org/en/

    • Or use the following command lines:

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)
sudo brew install node
  1. Install Xcode 12 or above from the App Store.

Build & Run

After successfully installing the above dependencies, build and run the sample app with the following command:

npm run electron:serve

This runs electron_sdk_install.js, configures the project based on package.json, and install the required dependencies (including Electron). Once finished, the sample app will be launched.

If you get an error when running npm install, check the read-write permission of the node_modules.

If you would like to install other versions of the Electron framework, you may edit the corresponding version number in package.json. Please note that the sample app currently does not support Electron 13 or below.