Giter VIP home page Giter VIP logo

zoom-video-sdk-sample's Introduction

Zoom Video SDK Sample App - Web

Use of this sample app is subject to our Terms of Use.

The Zoom Video SDK enables you to build custom video experiences with Zoom's core technology through a highly optimized WebAssembly module.

Installation

To get started, clone the repo:

$ git clone https://github.com/zoom/sample-app-videosdk.git

Setup

  1. Once cloned, navigate to the sample-app-videosdk/react-demo directory for the React sample or sample-app-videosdk/purejs-demo for the Vanilla JavaScript sample:

    $ cd sample-app-videosdk/react-demo or $ cd sample-app-videosdk/purejs-demo

    Primary differences are that the former is built in React and is a much more comprehensive overview of the Video SDK, while the latter showcases a very simple use-case for those uncomfortable with React

  2. Then install the dependencies:

    $ npm install

  3. Open the directory in your code editor.

  4. Open the react-demo/src/config/dev.ts or purejs-demo/src/js/config.js file respectively, 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 Required, a session passcode of your choice or the passcode of the session you are joining.

    Example:

    {
      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 frontend signature generator with a backend signature generator to keep your SDK Secret safe.

  5. Save config.js or dev.ts respectively.

  6. Run the app:

    $ npm start

Usage

  1. Navigate to http://localhost:3000. For the purejs-demo click "Join" or for the react-demo click one of the feature boxes.

Learn more about rendering multiple video streams.

For the full list of features and event listeners, as well as additional guides, see our Video SDK docs.

Need help?

If you're looking for help, try Developer Support or our Developer Forum. Priority support is also available with Premier Developer Support plans.

zoom-video-sdk-sample's People

Contributors

ylkjick532428 avatar mayk-zoom avatar tommygaessler avatar endazoom avatar dotorl avatar dependabot[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.