@zoom/videosdk-ui-toolkit NPM

Zoom Video SDK UI toolkit for web

Use of this SDK is subject to our Terms of Use.

The Zoom Video SDK UI toolkit is a prebuilt video chat user interface powered by the Zoom Video SDK.

Zoom Video SDK UI toolkit web

Installation

In your frontend project, install the Video SDK UI toolkit:

$ npm install @zoom/videosdk-ui-toolkit --save

Or, for Vanilla JS applications, download the package and add it to your project. Then, add the following script and CSS style to the HTML page you want the UI toolkit to live on:

<link rel="stylesheet" href="@zoom/videosdk-ui-toolkit/dist/videosdk-ui-toolkit.css">
<script src="@zoom/videosdk-ui-toolkit/index.js" type="module"></script>

Setup

For webpack / single page applications like Angular, Vue, React, etc, import the UI toolkit, package and styles:

import uitoolkit from '@zoom/videosdk-ui-toolkit'
import '@zoom/videosdk-ui-toolkit/dist/videosdk-ui-toolkit.css'

In Angular, CSS can't be imported directly into the component, instead, add the styles to your angular.json file in the styles array:

"styles": [
  "node_modules/@zoom/videosdk-ui-toolkit/dist/videosdk-ui-toolkit.css",
]

Or, for Vanilla JS applications, import the JS file directly:

import uitoolkit from './@zoom/videosdk-ui-toolkit/index.js'

JS imports work if your script tag has the type="module" attribute.
UI toolkit CDN is coming soon to make vanilla JS usage easier.

Usage

Open Preview

To open the preview kit, to preview your camera, microphone, and speaker, create an HTML container that it will be render in:

<div id='previewContainer'></div>

Then, call the uitoolkit.openPreview function, passing in the container reference:

var previewContainer = document.getElementById('previewContainer')

uitoolkit.openPreview(previewContainer)

Close Preview

To close the preview kit, call the uitoolkit.closePreview function:

uitoolkit.closePreview(previewContainer)

Join Session

To join a Video SDK session, create an HTML container that it will be render in:

<div id='sessionContainer'></div>

Create your Video SDK session config object, with your Video SDK JWT, and Video SDK session info, and the features you want to render.

var config = {
  videoSDKJWT: '',
  sessionName: 'SessionA',
  userName: 'UserA',
  sessionPasscode: 'abc123',
  features: ['video', 'audio', 'share', 'chat', 'users', 'settings']
}

Currently, we support the following features:

Feature	Description
`video`	Enable the video layout, and to send and receive video.
`audio`	Show the audio button on the toolbar, and to send and receive audio.
`share`	Show the screen share button on the toolbar, and to send and receive screen share content.
`chat`	Show the chat button on the toolbar, and to send and receive session chats.
`users`	Show the users button on the toolbar, and to see the list of users in the session.
`settings`	Show the settings button on the toolbar, and to configure virtual background, camera, microphone, and speaker devices, and see session quality statistics.

Then, call the uitoolkit.joinSession function, passing in the container reference, and the Video SDK session config object:

var sessionContainer = document.getElementById('sessionContainer')

uitoolkit.joinSession(sessionContainer, config)

Leave Session

To leave a Video SDK session, the user can click the red leave button. The host can also end the session for everyone, by clicking their red end button.

You can also leave a session programmatically by calling the uitoolkit.closeSession function:

uitoolkit.closeSession(sessionContainer)

Event Listeners

To subscribe to event listeners, define a callback function that you want to execute when the respective event is triggered:

var sessionJoined = (() => {
  console.log('session joined')
})

var sessionClosed = (() => {
  console.log('session closed')
})

Then, pass the callback function to the respective on event listener (after calling the uitoolkit.joinSession function).

uitoolkit.onSessionJoined(sessionJoined)

uitoolkit.onSessionClosed(sessionClosed)

To unsubscribe to event listeners, pass the callback function to the respective off event listener.

uitoolkit.offSessionJoined(sessionJoined)

uitoolkit.offSessionClosed(sessionClosed)

Currently, we support the following event listeners:

Event Listener	Description
`onSessionJoined`	Fires when the user joins the session successfully.
`onSessionClosed`	Fires when the session is left or ended.
`offSessionJoined`	Unsubscribes to the `onSessionJoined` event.
`offSessionClosed`	Unsubscribes to the `onSessionClosed` event.