Zoom Video SDK UI Toolkit JavaScript sample

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

This repo is an HTML / CSS / JavaScript website that uses the Zoom Video SDK UI toolkit to start and joins sessions.

Installation

To get started, clone the repo:

$ git clone https://github.com/zoom/videosdk-ui-toolkit-javascript-sample.git

Setup

Once cloned, navigate to the videosdk-ui-toolkit-javascript-sample directory:

$ cd videosdk-ui-toolkit-javascript-sample
Open the videosdk-ui-toolkit-javascript-sample directory in your code editor.

Open the scripts.js file, and enter values for the variables:

Variable	Description
authEndpoint	Required, your Video SDK auth endpoint that securely generates a Video SDK JWT. Get a Video SDK auth endpoint here.
config	Your Video SDK session details and enabled features. The `videoSDKJWT` will be set from the response of your `authEndpoint`.
role	Required, `0` to specify participant, `1` to specify host.

Example:

var authEndpoint = 'http://localhost:4000'
var config = {
   videoSDKJWT: '',
   sessionName: 'test',
   userName: 'ZoomDev',
   sessionPasscode: '123',
   features: ['preview', 'video', 'audio', 'settings', 'users', 'chat', 'share'],
   options: { init: {}, audio: {}, video: {}, share: {}},
   virtualBackground: {
      allowVirtualBackground: true,
      allowVirtualBackgroundUpload: true,
      virtualBackgrounds: ['https://images.unsplash.com/photo-1715490187538-30a365fa05bd?q=80&w=1945&auto=format&fit=crop']
   }
};
var role = 1

Save scripts.js.

Usage

Navigate to index.html in your browser (or serve over localhost) and click "Join Session".

Deployment

The JavaScript Sample App can be easily deployed to GitHub Pages, or another static web hosting service, like an AWS S3 bucket.

GitHub Pages

Create a repo on GitHub.
Add the remote to your project:

$ git remote add origin GITHUB_URL/GITHUB_USERNAME/GITHUB_REPO_NAME.git
Git add, commit, and push your project:

$ git add -A

$ git commit -m "deploying to github"

$ git push origin master
On GitHub, in your repo, navigate to the "settings" page, scroll down to the "GitHub Pages" section, and choose the "master branch folder" for the source.
Now your project will be deployed to https://GITHUB_USERNAME.github.io/GITHUB_REPO_NAME.

Other Static Web Hosting

Deploy the directory to a static web hosting service, like an AWS S3 bucket.

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.

ercaronte/videosdk-ui-toolkit-javascript-sample

ErrorLooks like something went wrong!

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages