Zoom Meeting SDK Sample App - Web

Use of this sample app is subject to our Terms of Use.

The Zoom Meeting SDK embeds the Zoom Meeting and Webinar experience in a website through a highly optimized WebAssembly module.

Installation

To get started, clone the repo:

$ git clone https://github.com/zoom/sample-app-web.git

Setup

1. Once cloned, navigate to the sample-app-web/CDN directory for the Client View CDN sample, or sample-app-web/Local for the Client View NPM sample, or sample-app-web/Components for the Component View NPM sample:

   $ cd sample-app-web/CDN or $ cd sample-app-web/Local or $ cd sample-app-web/Components

2. Then install the dependencies:

   $ npm install

3. Open the directory in your code editor.

4. Open the sample-app-web/CDN/js/index.js or sample-app-web/Local/js/index.js or sample-app-web/Components/tools/nav.js file respectively, and enter required values for the variables:

   Key	Value Description
   SDK_KEY	Your SDK Key. Required.
   SDK_SECRET	Your SDK Secret. Required.

   Example:

   var SDK_KEY = "YOUR_SDK_KEY"
   var SDK_SECRET = "YOUR_SDK_SECRET"

   Reminder to not publish this sample app as is. Replace the frontend signature generator with a backend signature generator to keep your SDK Secret safe.

5. Save index.js or nav.js respectively.

6. Run the app:

   $ npm start

Usage

1. Navigate to http://localhost:9999 for the CDN or Local sample, or http://localhost:3000 for the Components sample. Then, enter in a Meeting or Webinar number and passcode, choose host or attendee (participant), and, click "join".

   Client View

   

   The Client View provides the option to display the Meeting SDK as a full page. This allows for a familiar Zoom Meeting experience because the Client View is the same as the Zoom Web Client, except it lives inside your own web page.

   Component View

   

   The Component View provides the option to display the Meeting SDK in components on your page. This allows for a more flexible design.

Learn more about Gallery View requirements and see more product screenshots.

For the full list of features and event listeners, as well as additional guides, see our Meeting SDK docs.

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.