{"id":21319483,"url":"https://github.com/zoom/videosdk-web-sample","last_synced_at":"2025-04-09T13:09:40.143Z","repository":{"id":39580506,"uuid":"377002015","full_name":"zoom/videosdk-web-sample","owner":"zoom","description":"Zoom Video SDK web sample","archived":false,"fork":false,"pushed_at":"2024-09-09T18:50:17.000Z","size":6449,"stargazers_count":124,"open_issues_count":4,"forks_count":85,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-09-10T22:44:14.249Z","etag":null,"topics":["sample-app"],"latest_commit_sha":null,"homepage":"https://developers.zoom.us/docs/video-sdk/web/","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zoom.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-15T01:31:50.000Z","updated_at":"2024-09-09T17:45:06.000Z","dependencies_parsed_at":"2023-11-20T22:26:16.702Z","dependency_job_id":"56821e66-ad6a-45b9-8194-6c643c6adffe","html_url":"https://github.com/zoom/videosdk-web-sample","commit_stats":null,"previous_names":[],"tags_count":43,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoom%2Fvideosdk-web-sample","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoom%2Fvideosdk-web-sample/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoom%2Fvideosdk-web-sample/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoom%2Fvideosdk-web-sample/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zoom","download_url":"https://codeload.github.com/zoom/videosdk-web-sample/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248045245,"owners_count":21038554,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["sample-app"],"created_at":"2024-11-21T19:42:20.971Z","updated_at":"2025-04-09T13:09:40.123Z","avatar_url":"https://github.com/zoom.png","language":"TypeScript","readme":"# Zoom Video SDK web sample\n\nUse of this sample app is subject to our [Terms of Use](https://explore.zoom.us/en/video-sdk-terms/).\n\nThe [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.\n\n![Zoom Video SDK](./public/images/videosdk.gif)\n\n## Installation\n\nTo get started, clone the repo:\n\n`$ git clone https://github.com/zoom/videosdk-web-sample.git`\n\n## Setup\n\n1. Once cloned, navigate to the `videosdk-web-sample` directory:\n\n   `$ cd videosdk-web-sample`\n\n1. Then install the dependencies:\n\n   `$ npm install`\n\n1. Open the directory in your code editor.\n\n1. Open the `src/config/dev.ts` file and enter required session values for the variables:\n\n   | Key                   | Value Description |\n   | -----------------------|-------------|\n   | `sdkKey`     | Your Video SDK Key. Required. |\n   | `sdkSecret`  | Your Video SDK Secret. Required. |\n   | `topic`      | Required, a session name of your choice or the name of the session you are joining. |\n   | `name`       | Required, a name for the participant. |\n   | `password`   | Optional, a session passcode of your choice or the passcode of the session you are joining. |\n\n   Example:\n\n   ```js\n   {\n     // ...\n     sdkKey: 'YOUR_VIDEO_SDK_KEY',\n     sdkSecret: 'YOUR_VIDEO_SDK_SECRET',\n     topic: 'Cool Cars',\n     name: 'user123',\n     password: 'abc123'\n     // ...\n   }\n   ```\n\n   \u003e 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.\n\n1. Save `dev.ts`.\n\n1. Run the app:\n\n   `$ npm start`\n\n## Usage\n\n1. Navigate to http://localhost:3000 and click one of the feature boxes.\n\n   \u003e Learn more about [rendering multiple video streams](https://developers.zoom.us/docs/video-sdk/web/gallery-view/).\n\nFor 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/).\n\n## Use ZFG(Zoom For Government). You need apply new sdk key for [ZFG](https://marketplace.zoomgov.com/).\n### option1 change package.json and use zfg specific version\n```\n\"@zoom/videosdk\": \"1.11.0-zfg\",\nzmClient.init('en-US', 'Global');\n```\n\n### 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) \n```\nzmClient.init('en-US', `https://source.zoomgov.com/videosdk/1.11.0/lib`, {\n   webEndpoint: \"www.zoomgov.com\",\n});\n```\n\n## Need help?\n\nIf 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.\n\n\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzoom%2Fvideosdk-web-sample","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzoom%2Fvideosdk-web-sample","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzoom%2Fvideosdk-web-sample/lists"}