{"id":21319461,"url":"https://github.com/zoom/videosdk-web","last_synced_at":"2025-04-13T02:18:52.378Z","repository":{"id":40461425,"uuid":"364688487","full_name":"zoom/videosdk-web","owner":"zoom","description":"Power custom video experiences with Zoom's core technology","archived":false,"fork":false,"pushed_at":"2025-03-12T18:06:10.000Z","size":82891,"stargazers_count":51,"open_issues_count":10,"forks_count":26,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-04-04T05:02:58.791Z","etag":null,"topics":["npm-package"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@zoom/videosdk","language":null,"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":"CHANGELOG.md","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-05-05T19:44:15.000Z","updated_at":"2025-03-18T09:46:36.000Z","dependencies_parsed_at":"2023-12-12T01:27:26.258Z","dependency_job_id":"c7c97a88-978c-431d-87fd-7eb3c329483a","html_url":"https://github.com/zoom/videosdk-web","commit_stats":{"total_commits":79,"total_committers":6,"mean_commits":"13.166666666666666","dds":0.379746835443038,"last_synced_commit":"fe61dff336df0655217b04f7dc90a2ee57c8fd45"},"previous_names":[],"tags_count":46,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoom%2Fvideosdk-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoom%2Fvideosdk-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoom%2Fvideosdk-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zoom%2Fvideosdk-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zoom","download_url":"https://codeload.github.com/zoom/videosdk-web/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248654251,"owners_count":21140268,"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":["npm-package"],"created_at":"2024-11-21T19:41:59.921Z","updated_at":"2025-04-13T02:18:52.345Z","avatar_url":"https://github.com/zoom.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zoom Video SDK for Web\n\nUse of this SDK is subject to our [Terms of Use](https://explore.zoom.us/en/video-sdk-terms/).\n\nThe [Zoom Video SDK](https://developers.zoom.us/docs/video-sdk/web/) enables you to build custom video experiences with Zoom's core technology through a highly optimized WebAssembly module.\n\n## Installation\n\nIn your frontend project, install the Video SDK:\n\n```bash\n$ npm install @zoom/videosdk --save\n```\n\n## Usage\n\n![Zoom Video SDK](https://raw.githubusercontent.com/zoom/videosdk-web-sample/master/public/images/videosdk.gif)\n\n\u003e The Video SDK provides video, audio, screen sharing, chat, data streams, and more, as a service. You can build with all of these features, or pick and choose. The Video SDK also comes with a full set of server side [APIs](https://developers.zoom.us/docs/api/rest/reference/video-sdk/methods/#overview) and [Webhooks](https://developers.zoom.us/docs/api/rest/reference/video-sdk/events/#overview).\n\nIn the component file where you want to use the Video SDK, import `ZoomVideo` and create the client.\n\n```js\nimport ZoomVideo from '@zoom/videosdk'\n\nconst client = ZoomVideo.createClient()\n```\n\nThen init the SDK and declare the `stream` which we will define later:\n\n```js\nclient.init('en-US', 'Global', { patchJsMedia: true })\n\nlet stream\n```\n\nNow we will start or join the session.  Here are the required parameters for the `client.join()` function.\n\n| Parameter              | Parameter Description |\n| -----------------------|-------------|\n| topic  | Required, a session name of your choice or the name of the session you are joining. |\n| token  | Required, your [Video SDK JWT](https://developers.zoom.us/docs/video-sdk/auth/). |\n| userName | 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\nThen start or join the session and define the stream, which will be used for [core features](#core-features).\n\n```js\nclient.join(topic, token, userName, password).then(() =\u003e {\n  stream = client.getMediaStream()\n}).catch((error) =\u003e {\n  console.log(error)\n})\n```\n\nNow that we are in a session, we can start using core features like `stream.startVideo()`.\n\n### Core Features:\n\n- [Video](https://developers.zoom.us/docs/video-sdk/web/video/)\n- [Audio](https://developers.zoom.us/docs/video-sdk/web/audio/)\n- [Chat](https://developers.zoom.us/docs/video-sdk/web/chat/)\n- [PSTN](https://developers.zoom.us/docs/video-sdk/web/pstn/)\n- [Screen Share](https://developers.zoom.us/docs/video-sdk/web/share/)\n- [Cloud Recording](https://developers.zoom.us/docs/video-sdk/web/recording/)\n- [Command Channel](https://developers.zoom.us/docs/video-sdk/web/command-channel/)\n- [Audio Video Preview](https://developers.zoom.us/docs/video-sdk/web/preview/)\n- [Subsessions](https://developers.zoom.us/docs/video-sdk/web/subsessions/)\n- [Transcription/Translation](https://developers.zoom.us/docs/video-sdk/web/transcription-translation/)\n- [Virtual Background](https://developers.zoom.us/docs/video-sdk/web/video/#use-virtual-background)\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## Sample Apps\n\n- [Video SDK web Sample](https://github.com/zoom/videosdk-web-sample)\n- [Video SDK Auth Endpoint](https://github.com/zoom/videosdk-auth-endpoint-sample)\n- [Webhook Sample](https://github.com/zoom/webhook-sample)\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://zoom.us/docs/en-us/developer-support-plans.html) plans.\n\n[Open Source Software attribution](https://github.com/zoom/videosdk-web/blob/main/oss_attribution.txt)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzoom%2Fvideosdk-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzoom%2Fvideosdk-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzoom%2Fvideosdk-web/lists"}