Javascript API Reference
    Preparing search index...

    Javascript API Reference


    NPM downloads NPM latest version

    VideoSDK JavaScript SDK 🚀

    Build fast, scalable, and customizable real-time video applications for the web using VideoSDK.
    Whether you’re creating a video conferencing app, virtual classroom, or live streaming platform, VideoSDK provides a robust foundation with minimal setup.

    VideoSDK enables developers to ship production-grade real-time communication features quickly.

    • Supports 5,000+ participants
    • Low-latency audio, video, and data streams
    • Fully customizable UI and workflows
    • Works across modern browsers
    • Designed for scale and reliability

    VideoSDK supports all major modern browsers.

    📖 Full compatibility guide:
    https://docs.videosdk.live/docs/realtime-communication/see-also/device-browser-support

    Try the live demo to see VideoSDK in action:
    https://demo.videosdk.live/

    You can integrate the VideoSDK JavaScript SDK using either a CDN or a package manager.

    <html>
      <head></head>
      <body>
        <script src="https://sdk.videosdk.live/js-sdk/0.1.4/videosdk.js"></script>
      </body>
    </html>

    npm install @videosdk.live/js-sdk

    yarn add @videosdk.live/js-sdk

    Unlock a suite of powerful features to enhance your meetings:

    Feature Documentation Description
    📋 Precall Setup Setup Precall Configure audio, video devices and other settings before joining the meeting.
    ⏳ Waiting Lobby Waiting Lobby Virtual space for participants to wait before joining the meeting.
    🤝 Join Meeting Join Meeting Allows participants to join a meeting.
    🎤 Toggle Mic Mic Control Toggle the microphone on or off during a meeting.
    📷 Toggle Camera Camera Control Turn the video camera on or off during a meeting.
    🖥️ Screen Share Screen Share Share your screen with other participants during the call.
    📸 Image Capture Image Capturer Capture images of other participant from their video stream, handy for Video KYC and identity verification scenarios.
    🔌 Change Input Device Switch Input Devices Switch between different audio and video input devices.
    🔊 Change Audio Output Switch Audio Output Select an output device for audio during a meeting.
    ⚙️ Optimize Video Track Video Track Optimization Enhance the quality and performance of media tracks.
    ⚙️ Optimize Audio Track Audio Track Optimization Enhance the quality and performance of media tracks.
    💬 Chat In-Meeting Chat Exchange messages with participants through a Publish-Subscribe mechanism.
    📝 Whiteboard Whiteboard Collaborate visually by drawing and annotating on a shared whiteboard.
    📁 File Sharing File Sharing Share files with participants during the meeting.
    📼 Recording Recording Record the meeting for future reference.
    📡 RTMP Livestream RTMP Livestream Stream the meeting live to platforms like YouTube or Facebook.
    📝 Real-time Transcription Real-time Transcription Generate real-time transcriptions of the meeting.
    🔇 Toggle Remote Media Remote Media Control Control the microphone or camera of remote participants.
    🚫 Mute All Participants Mute All Mute all participants simultaneously during the call.
    🗑️ Remove Participant Remove Participant Eject a participant from the meeting.

    Explore a fully functional JavaScript example that demonstrates real-world implementation of the VideoSDK:

    👉 https://github.com/videosdk-live/videosdk-rtc-javascript-sdk-example

    Settings

    Member Visibility

    On This Page

    VideoSDK JavaScript SDK 🚀