Notorious Party Muppets

    @zoom/videosdk
    TypeScript icon, indicating that this package has built-in type declarations

    1.3.0 • Public • Published

    Zoom Video SDK for Web

    Use of this SDK 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

    In your frontend project, install the Video SDK:

    $ npm install @zoom/videosdk --save

    Usage

    Zoom Video SDK

    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 and Webhooks.

    In the component file where you want to use the Video SDK, import ZoomVideo and create the client.

    import ZoomVideo from '@zoom/videosdk'
    
    const client = ZoomVideo.createClient()

    Then init the SDK and declare the stream which we will define later:

    client.init('en-US', `CDN`)
    
    let stream

    Now we will start or join the session. Here are the required parameters for the client.join() function.

    Parameter Parameter Description
    topic Required, a session name of your choice or the name of the session you are joining.
    token Required, your Video SDK JWT.
    userName Required, a name for the participant.
    password Required, a session passcode of your choice or the passcode of the session you are joining.

    Then start or join the session and define the stream, which will be used for core features.

    client.join(topic, token, userName, password).then(() => {
      stream = client.getMediaStream()
    }).catch((error) => {
      console.log(error)
    })

    Now that we are in a session, we can start using core features like stream.startVideo().

    Core Features:

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

    Sample Apps

    Checkout the Video SDK sample apps:

    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.

    Install

    npm i @zoom/videosdk

    DownloadsWeekly Downloads

    564

    Version

    1.3.0

    License

    SEE LICENSE IN LICENSE.md

    Unpacked Size

    23.3 MB

    Total Files

    40

    Last publish

    Collaborators

    • danieljf
    • carsonzoom
    • tommygaessler
    • mete.a.zoom
    • zoomwebteam