https://github.com/zoom/videosdk-web-sample
Zoom Video SDK web sample
https://github.com/zoom/videosdk-web-sample
sample-app
Last synced: 11 months ago
JSON representation
Zoom Video SDK web sample
- Host: GitHub
- URL: https://github.com/zoom/videosdk-web-sample
- Owner: zoom
- License: other
- Created: 2021-06-15T01:31:50.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-09T18:50:17.000Z (over 1 year ago)
- Last Synced: 2024-09-10T22:44:14.249Z (over 1 year ago)
- Topics: sample-app
- Language: TypeScript
- Homepage: https://developers.zoom.us/docs/video-sdk/web/
- Size: 6.15 MB
- Stars: 124
- Watchers: 9
- Forks: 85
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Zoom Video SDK web sample
Use of this sample app is subject to our [Terms of Use](https://explore.zoom.us/en/video-sdk-terms/).
The [Zoom Video SDK for web](https://developers.zoom.us/docs/video-sdk/web/) enables you to build custom video experiences on a webpage with Zoom's core technology through a highly optimized WebAssembly module.
## Installation
To get started, clone the repo:
`$ git clone https://github.com/zoom/videosdk-web-sample.git`
## Setup
1. Once cloned, navigate to the `videosdk-web-sample` directory:
`$ cd videosdk-web-sample`
1. Then install the dependencies:
`$ npm install`
1. Open the directory in your code editor.
1. Open the `src/config/dev.ts` file and enter required session values for the variables:
| Key | Value Description |
| -----------------------|-------------|
| `sdkKey` | Your Video SDK Key. Required. |
| `sdkSecret` | Your Video SDK Secret. Required. |
| `topic` | Required, a session name of your choice or the name of the session you are joining. |
| `name` | Required, a name for the participant. |
| `password` | Optional, a session passcode of your choice or the passcode of the session you are joining. |
Example:
```js
{
// ...
sdkKey: 'YOUR_VIDEO_SDK_KEY',
sdkSecret: 'YOUR_VIDEO_SDK_SECRET',
topic: 'Cool Cars',
name: 'user123',
password: 'abc123'
// ...
}
```
> Reminder to not publish this sample app as is. Replace the Video SDK JWT generator with a [backend Video SDK JWT generator](https://developers.zoom.us/docs/video-sdk/auth/#generate-a-video-sdk-jwt) to keep your SDK Secret safe.
1. Save `dev.ts`.
1. Run the app:
`$ npm start`
## Usage
1. Navigate to http://localhost:3000 and click one of the feature boxes.
> Learn more about [rendering multiple video streams](https://developers.zoom.us/docs/video-sdk/web/gallery-view/).
For the full list of features and event listeners, as well as additional guides, see our [Video SDK docs](https://developers.zoom.us/docs/video-sdk/web/).
## Use ZFG(Zoom For Government). You need apply new sdk key for [ZFG](https://marketplace.zoomgov.com/).
### option1 change package.json and use zfg specific version
```
"@zoom/videosdk": "1.11.0-zfg",
zmClient.init('en-US', 'Global');
```
### option2 change dev.conf and use ZFG [init](https://marketplacefront.zoom.us/sdk/custom/web/modules/VideoClient.html#init) option [webEndpoint](https://marketplacefront.zoom.us/sdk/custom/web/interfaces/InitOptions.html)
```
zmClient.init('en-US', `https://source.zoomgov.com/videosdk/1.11.0/lib`, {
webEndpoint: "www.zoomgov.com",
});
```
## Need help?
If you're looking for help, try [Developer Support](https://devsupport.zoom.us) or our [Developer Forum](https://devforum.zoom.us). Priority support is also available with [Premier Developer Support](https://explore.zoom.us/docs/en-us/developer-support-plans.html) plans.