Zoom Web SDK

The Web SDK enables the development of video applications powered by Zoom’s core framework inside an HTML5 web client through a highly optimized WebAssembly module.

As an extension of the Zoom browser client, this SDK is intended for implementations where the end user has a low-bandwidth environment, is behind a network firewall, or has restrictions on their machine which would prevent them from installing the Zoom Desktop or Mobile Clients.

Quick install:

npm i @zoomus/websdk

Prerequisites

To start using the Web SDK, head to the Marketplace and setup a Developer Account. Create a JWT App to get your API Key and Secret.

Install Options

To get started, either import the Web SDK through npm to an existing Node.js project or clone the sample web app (locally, or through CDN).

For direct guides on these options, reference the Integrate SDK guide.

Local Install (Existing Node.js Projects)

Documentation: Integrate SDK
npm: @zoomus/websdk
GitHub: Zoom Web SDK

CDN Install

Documentation: Integrate SDK

Sample Apps

Sample App (Local)

Documentation: Clone Sample App (Local)
GitHub: Sample App (Local)

git clone https://github.com/zoom/sample-app-web.git --branch master --depth 1
cd sample-app-web/Local
npm install
npm run start

Sample App (CDN)

Documentation: Clone Sample App (CDN)
GitHub: Sample App (CDN)

git clone https://github.com/zoom/sample-app-web.git --branch master --depth 1
cd sample-app-web/CDN
npm install
npm run start

Performance Limits

Currently, the Zoom Web SDK encodes at a maximum resolution of 360p. If a user is in a meeting with both native and browser clients, the browser client video displayed within the native client will be of lower quality due to encoding limitations.

Browser Support

The browser support of the Web SDK directly reflects that of the Zoom Web Client.

For a full guide to Zoom Web Client browser support, reference the Zoom Web Client Support page.

Mobile web browsers are not supported.

Features across desktop browsers:

	Chrome	Firefox	Safari	Edge	Internet Explorer
Gallery View	✓	✘	✘	(1)	✘
Pause Recording	✓	✓	✓	✓	✓
Waiting Room	✓	✓	✓	✓	✓
Share Video	✓	✓	✓	✓	✘
Share Screen	✓	✓	✘	✓	✘
Join Computer Audio	✓	✓	(2)	✓	✘
Join Audio by Phone	✓	✓	✓	✓	✓
Meeting Host Controls	✓	✓	✓	✓	✓
View Shared Video	✓	✓	✓	✓	✘
View Shared Screen	✓	✓	✓	✓	✓
Request Remote Control	✓	✓	✓	✓	✓
In-meeting Chat	✓	✓	✓	✓	✓
Closed Captioning	✓	✓	✓	✓	✓
Webinar Q&A	✓	✓	✓	✓	✓

(1) Gallery View is supported on Edge (Chromium Version).

(2) Joining computer audio on Firefox and Safari is only available for webinar attendees. Meeting participants and webinar hosts and panelists can also join computer audio on Firefox if they are using Linux.

Next steps

Build an App