https://github.com/git-ced/zoomers
A sample application integrated with Zoom client
https://github.com/git-ced/zoomers
Last synced: 11 months ago
JSON representation
A sample application integrated with Zoom client
- Host: GitHub
- URL: https://github.com/git-ced/zoomers
- Owner: git-ced
- License: other
- Created: 2020-10-07T21:53:40.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-11T10:02:30.000Z (over 5 years ago)
- Last Synced: 2025-03-28T19:32:34.193Z (about 1 year ago)
- Language: JavaScript
- Size: 350 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Web Client SDK
Zoom offers a web based HTML5 client that is used in environments where the end users cannot download zoom desktop clients due to internal IT restrictions or in very low bandwidth environments.
The web client lets end users join a meeting, receive screen share from other attendees, join the meeting through the phone and leave the meeting. Zoom has added a Web SDK as part of our developer platform to enable developers to embed this into their web apps. Key functions that are exposed include: init meeting config, join meeting, show/hide invite function, show/hide meeting header, get attendees list, call out, invite by phone, mute, unmute, mute all, unmute all, rename, expel, record, lock meeting, leave meeting, end meeting.
Supported Browsers: Google Chrome, Safari, and Mozilla Firefox with their latest version
### Getting Started with Meetings
[Web-Client-SDK Overview](https://marketplace.zoom.us/docs/sdk/native-sdks/Web-Client-SDK/overview)
### Using the SDK
Refer to the [Web SDK Documentation](https://marketplace.zoom.us/docs/sdk/native-sdks/Web-Client-SDK/api-reference)
[Upcoming changes](https://marketplace.zoom.us/docs/guides/getting-started/stay-up-to-date/upcoming-changes/web-sdk)
### Dependencies
```package.json
"dependencies": {
"react": "16.8.6",
"react-dom": "16.8.6",
"redux": "3.7.2",
"react-redux": "7.1.0",
"jquery": "^3.4.1",
"lodash": "^4.17.14",
"redux-thunk": "2.2.0"
}
```
### CDN Accelerated
Global CDN ```source.zoom.us```
China CDN ```jssdk.zoomus.cn```
### Include the source
```
```
### or
```
npm install @zoomus/websdk@1.8.1
```
### zoomus-jssdk move to @zoomus/websdk
```
import { ZoomMtg } from 'zoomus-jssdk';
change to
import { ZoomMtg } from '@zoomus/websdk';
```
Please notice, 1.8.1 release with two ways, the normal way and npm way(need babel and webpack).
At first, you invoke those three API to init jssdk.
```
console.log('checkSystemRequirements');
console.log(JSON.stringify(ZoomMtg.checkSystemRequirements()));
// it's option if you want to change the WebSDK dependency link resources. setZoomJSLib must be run at first
// if (!china) ZoomMtg.setZoomJSLib('https://source.zoom.us/1.8.1/lib', '/av'); // CDN version default
// else ZoomMtg.setZoomJSLib('https://jssdk.zoomus.cn/1.8.1/lib', '/av'); // china cdn option
// ZoomMtg.setZoomJSLib('http://localhost:9999/node_modules/@zoomus/websdk/dist/lib', '/av'); // Local version default, Angular Project change to use cdn version
ZoomMtg.preLoadWasm();
ZoomMtg.prepareJssdk();
```
Go to see sample web app (CDN version) how to update 1.8.1
[]()
## Screen share
```
ZoomMtg.init({
...
screenShare: true, // default, and it also require account's sharing setting enabled.
...
})
```
## Chat
```
ZoomMtg.init({
...
isSupportChat: true, // default, and it also require account's sharing setting enabled.
...
})
```
## Webinar notice
If you want to join webinar you will need to add your email to the userEmail property within the join method and set the role to 0 within the meetingConfig function.
```
ZoomMtg.join({
...
userEmail: "hello@zoom.us",
...
})
```
```
role: 0
```
### Video, Computer Audio and Sharing Supported browser
Feature | Chrome | firefox | Safari | Edge | IE >=11 | Opera | Vivaldi | Edge(Chromium)
------------ | ------------- | ------------ | ------------- | ------------ | ------------- | ------------ | ------------ | ------------
Video | yes| yes | yes | NULL | no | yes | yes | yes
Computer Audio | yes | only linux | no | NULL | no | no | yes | yes
View Sharing | yes | yes | yes | NULL | yes| yes | yes | yes
Screen Sharing | >=72 | >=66 | no | NULL | no | no | yes | yes
Chat | yes | yes | yes | NULL | yes | yes | yes | yes | yes
Notice: WebSDK doesn't support IE10 and Edge currently.
### Support
For any issues regarding our Web Client SDK, please visit our new Community Support Forum at
[https://devforum.zoom.us/](https://devforum.zoom.us/)
[Register your API Key/Secret](https://marketplace.zoom.us/docs/sdk/native-sdks/Web-Client-SDK/getting-started/prerequisites)
[Transitioning-your-developer-apps-to-zooms-marketplace](https://medium.com/zoom-developer-blog/transitioning-your-developer-apps-to-zooms-marketplace-6a8de3386716)
## Quick start
### More detail
[https://marketplace.zoom.us/docs/sdk/native-sdks/Web-Client-SDK/getting-started/integrate-the-sdk](https://marketplace.zoom.us/docs/sdk/native-sdks/Web-Client-SDK/getting-started/integrate-the-sdk)
### sample web app (local version)
```javascript
cd src
npm install
npm run start
```
open browser http://localhost:9999
### run demo with https
we provide a https option, other machines can join the demo and test audio and video feature.
notice: the certification signed by localhost. don't use in your production.
```
npm run https
```
open browser https://localhost:9999
## License
Use of this software is subject to important terms and conditions as set forth in the License file
Please refer to [LICENSE.md](LICENSE.md) file for details