Skip to content

Commit 17062cb

Browse files
committed
updating to v2.3.0
1 parent 028294a commit 17062cb

File tree

6 files changed

+292
-48
lines changed

6 files changed

+292
-48
lines changed

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,16 @@
22

33
Use of this sample app is subject to our [Terms of Use](https://zoom.us/docs/en-us/zoom_api_license_and_tou.html).
44

5+
---
6+
7+
**NOTE:** This Sample App has been updated to use [SDK App](https://marketplace.zoom.us/docs/guides/build/sdk-app) type credentials instead of [JWT App](https://marketplace.zoom.us/docs/guides/build/jwt-app) type credentials.
8+
9+
---
10+
511
This repo is a [React](https://reactjs.org/) app generated via [Create React App](https://github.com/facebook/create-react-app) that uses the [Zoom Meeting SDK](https://marketplace.zoom.us/docs/sdk/native-sdks/web) to start and join Zoom meetings and webinars.
612

13+
![Zoom Meeting SDK Client View](https://marketplace.zoom.us/docs/images/sdk/msdk-web-client-sab-gallery.png)
14+
715
## Installation
816

917
To get started, clone the repo:
@@ -24,14 +32,14 @@ To get started, clone the repo:
2432

2533
1. Open the `src/App.js` file, and enter values for the variables:
2634

27-
**NEW:** To use the [Component View](https://marketplace.zoom.us/docs/sdk/native-sdks/web/component-view), replace `App.js` with `App-New.js`. (The `leaveUrl` is not needed).
35+
**NEW:** To use the [Component View](https://marketplace.zoom.us/docs/sdk/native-sdks/web/component-view), replace `App.js` with `App-New.js`. (The `leaveUrl` is not needed). Also, uncomment the Component View CSS tags and comment out the Client View CSS in `public/index.html`.
2836

2937
| Variable | Description |
3038
| -----------------------|-------------|
3139
| signatureEndpoint | Required, the endpoint url that returns a signature. [Get a signature endpoint here.](https://github.com/zoom/meetingsdk-sample-signature-node.js) |
32-
| apiKey | Required, your Zoom JWT App API Key. [You can get yours here](https://marketplace.zoom.us/develop/create). |
33-
| meetingNumber | The Zoom Meeting / webinar number. |
34-
| role | Required, 0 to join the meeting / webinar, 1 to start the meeting. |
40+
| sdkKey | Required, your Zoom SDK App Key. [You can get yours here](https://marketplace.zoom.us/develop/create). |
41+
| meetingNumber | Required, the Zoom Meeting or webinar number. |
42+
| role | Required, `0` to specify participant, `1` to specify host. |
3543
| leaveUrl | Required, the url the user is taken to once the meeting is over. |
3644
| userName | Required, a name for the user joining / starting the meeting / webinar. |
3745
| userEmail | Required for Webinar, optional for Meeting, required for meeting and webinar if [registration is required]([registration](https://support.zoom.us/hc/en-us/articles/360054446052-Managing-meeting-and-webinar-registration)). The email of the user starting or joining the meeting / webinar. |
@@ -42,7 +50,7 @@ To get started, clone the repo:
4250

4351
```js
4452
signatureEndpoint = 'http://localhost:4000'
45-
apiKey = 'xu3asdfaJPaA_RJW2-9l5_HAaLA'
53+
sdkKey = 'abc123'
4654
meetingNumber = '123456789'
4755
role = 0
4856
leaveUrl = 'http://localhost:3000'
@@ -60,13 +68,17 @@ To get started, clone the repo:
6068

6169
## Usage
6270

63-
1. Navigate to http://localhost:3000.
71+
1. Navigate to http://localhost:3000 and click "Join Meeting".
72+
73+
### Client View
74+
75+
![Zoom Meeting SDK Client View](https://marketplace.zoom.us/docs/images/sdk/msdk-web-client-sab-gallery.png)
6476

65-
![Zoom React Meeting SDK](https://s3.amazonaws.com/user-content.stoplight.io/19808/1607987466824)
77+
### Component View
6678

67-
1. Click "Join Meeting" to join the meeting number specified in `src/app.js`.
79+
![Zoom Meeting SDK Component View](https://marketplace.zoom.us/docs/images/sdk/msdk-web-component-sab-gallery.png)
6880

69-
![Zoom React Meeting SDK](https://s3.amazonaws.com/user-content.stoplight.io/19808/1607987479967)
81+
Learn more about [Gallery View requirements](https://marketplace.zoom.us/docs/sdk/overview/improve-performance) and [see more product screenshots](https://marketplace.zoom.us/docs/sdk/overview/improve-performance#sharedarraybuffer-ui-differences).
7082

7183
## Deployment
7284

0 commit comments

Comments
 (0)