Download and install


On this page

Prerequisites

To get started, you need:

  • A Zoom Account. If you do not have one, you can sign up at https://zoom.us/signup.
  • A device with the minimum or maximum versions of the macOS or Windows OS as specified in the Zoom Meeting macOS SDK prerequisites or the Zoom Meeting Windows SDK prerequisites. See the links for details.

Dependencies

  • @vue/cli-plugin-babel: ^4.5.15
  • @vue/cli-plugin-router: ^4.5.15
  • @vue/cli-plugin-vuex: ^4.5.15
  • @vue/cli-service: ^4.5.15
  • vue-cli-plugin-electron-builder: ^2.1.1
  • electron: ^17.0.0
  • sass: ~1.32.6
  • @electron/remote: ^2.0.5

Download

To download the Zoom Meeting SDK Electron Wrapper:

  1. Login to the Zoom App Marketplace using your Zoom account, click the Develop option in the dropdown on the top-right corner and select Build App.

  2. Click the Create button and provide the required details if you haven't already created an SDK app.

  3. If you previously created an SDK app on the Marketplace, click the View here option and navigate to the Download page. Click Electron to download the Electron wrapper.

See Create an SDK app for details.

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.

Follow the instructions below to install the sample app on Windows or macOS.

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. You may find the installation packages at https://nodejs.org/en/

  2. Install the build environment. You may install the Windows build tools or Visual Studio 2019 or above. We recommended Visual Studio 2019.

  3. Option 1: Installing Windows build tools:

    • Use the command line to install Windows build tools:

    npm install --global --production windows-build-tools

    • Or download the installer from the Microsoft website:

    https://www.microsoft.com/en-us/download/details.aspx?id=48159

  4. Option 2: Installing Visual Studio:

    • Install Visual Studio from the Microsoft website:

    https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=Community&rel=16

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

    • Python 2.7 works with Electron 2 to Electron 9
    • Python 3 works with Electron 4 and higher versions
  • Download the installation packages from https://www.python.org/downloads/

    • Once you have installed Python, be sure to add it 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 install the required dependencies, including Electron. Once finished, the script launches the sample app.

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

macOS

Prerequisites

  • A device with max OS
  • 580MB of free disk space

Install dependencies

  1. Install node.js.

    • If you use ARM platform, 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

  2. Install Xcode 12 or above from the App Store

    • Or download from https://developer.apple.com/download/more/

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 installs the required dependencies, including Electron. Once finished, the script launches the sample app.

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

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

Generate and use an SDK JWT for authorization

Follow the steps in SDK Authorization to generate an SDK JWT for authorization when starting or joining meetings or webinars.

Create an installer and publish

Follow official documentation for packaging an Electron app and complete the following additional steps if creating an installer for Windows.

  1. Run cptinstall.exe -uninstall with administrator privileges in the final stage of the installation (after all the related files of the wrapper are copied successfully). This is to ensure that some users who have installed the old package can use the share function normally.
  2. When publishing your app to Windows, copy the following Microsoft runtime libraries to the bin and bin/aomhost directories:
concrt140.dll
msvcp140.dll
msvcp140_1.dll
msvcp140_2.dll
msvcp140_codecvt_ids.dll
vccorlib140.dll
vcruntime140.dll
api-ms-win-core-console-l1-1-0.dll
api-ms-win-core-console-l1-2-0.dll
api-ms-win-core-datetime-l1-1-0.dll
api-ms-win-core-debug-l1-1-0.dll
api-ms-win-core-errorhandling-l1-1-0.dll
api-ms-win-core-file-l1-1-0.dll
api-ms-win-core-file-l1-2-0.dll
api-ms-win-core-file-l2-1-0.dll
api-ms-win-core-handle-l1-1-0.dll
api-ms-win-core-heap-l1-1-0.dll
api-ms-win-core-interlocked-l1-1-0.dll
api-ms-win-core-libraryloader-l1-1-0.dll
api-ms-win-core-localization-l1-2-0.dll
api-ms-win-core-memory-l1-1-0.dll
api-ms-win-core-namedpipe-l1-1-0.dll
api-ms-win-core-processenvironment-l1-1-0.dll
api-ms-win-core-processthreads-l1-1-0.dll
api-ms-win-core-processthreads-l1-1-1.dll
api-ms-win-core-profile-l1-1-0.dll
api-ms-win-core-rtlsupport-l1-1-0.dll
api-ms-win-core-string-l1-1-0.dll
api-ms-win-core-synch-l1-1-0.dll
api-ms-win-core-synch-l1-2-0.dll
api-ms-win-core-sysinfo-l1-1-0.dll
api-ms-win-core-timezone-l1-1-0.dll
api-ms-win-core-util-l1-1-0.dll
API-MS-Win-core-xstate-l2-1-0.dll
api-ms-win-crt-conio-l1-1-0.dll
api-ms-win-crt-convert-l1-1-0.dll
api-ms-win-crt-environment-l1-1-0.dll
api-ms-win-crt-filesystem-l1-1-0.dll
api-ms-win-crt-heap-l1-1-0.dll
api-ms-win-crt-locale-l1-1-0.dll
api-ms-win-crt-math-l1-1-0.dll
api-ms-win-crt-multibyte-l1-1-0.dll
api-ms-win-crt-private-l1-1-0.dll
api-ms-win-crt-process-l1-1-0.dll
api-ms-win-crt-runtime-l1-1-0.dll
api-ms-win-crt-stdio-l1-1-0.dll
api-ms-win-crt-string-l1-1-0.dll
api-ms-win-crt-time-l1-1-0.dll
api-ms-win-crt-utility-l1-1-0.dll
ucrtbase.dll

If you are using Custom UI, follow the UI Legal Notices design guidance.

Sign wrapper on macOS

You may need to sign the Meeting SDK Electron Wrapper on macOS. Use the following command to sign your Electron Wrapper app on macOS:

codesign --force --verify --verbose --entitlements runtime.entitlements --options runtime --sign "Developer ID Application: Name (ID)" (App path)

Need help?

If you're looking for help, try Developer Support or our Developer Forum. Priority support is also available with Premier Developer Support plans.