React Api Reference
    Preparing search index...

    React Api Reference


    NPM downloads NPM latest version

    VideoSDK React 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/react/guide/video-and-audio-calling-api-sdk/supported-browser


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


    Get started by installing @videosdk.live/react-sdk in your React application.

    Using npm

    npm install @videosdk.live/react-sdk
    

    Using yarn

    yarn add @videosdk.live/react-sdk
    

    Unlock a suite of powerful features to enhance your meetings:

    Feature Documentation Description
    πŸ“‹ Pre-call Setup Setup Precall Configure audio, video, and device preferences before joining a meeting.
    ⏳ Waiting Lobby Waiting Lobby Hold participants in a virtual lobby until they’re allowed to join.
    🀝 Join Meeting Join Meeting Join a meeting with a single action.
    πŸšͺ Leave Meeting Leave Meeting Exit the meeting safely without disrupting others.
    🎀 Microphone Control Mute / Unmute Mic Toggle your microphone during the meeting.
    πŸ“· Camera Control Camera On / Off Enable or disable your camera stream.
    πŸ–₯️ Screen Sharing Screen Share Share your entire screen or a specific window.
    πŸ“Έ Image Capture Image Capture Capture images from participant video streams, ideal for Video KYC use cases.
    πŸ”Œ Change Input Devices Switch Input Devices Switch between available audio and video input devices.
    πŸ”Š Audio Output Selection Switch Audio Output Select a preferred speaker or output device.
    βš™οΈ Track Optimization Custom Tracks Optimize media tracks for better quality and performance.
    πŸ’¬ In-meeting Chat PubSub Chat Exchange real-time messages using a publish–subscribe model.
    πŸ“ Whiteboard Whiteboard Collaborate visually using a shared whiteboard.
    πŸ“ File Sharing File Sharing Share files securely during the meeting.
    πŸ“Ό Recording Recording Record meetings for later playback and auditing.
    πŸ“‘ RTMP Livestreaming RTMP Livestream Broadcast meetings live to platforms like YouTube or Facebook.
    πŸ“ Real-time Transcription Live Transcription Generate real-time transcripts during meetings.
    πŸ”‡ Remote Media Control Remote Media Control Control the microphone and camera of remote participants.
    🚫 Mute All Participants Mute All Instantly mute all participants in the meeting.
    πŸ—‘οΈ Remove Participant Remove Participant Remove a participant from the meeting.

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

    πŸ‘‰ https://github.com/videosdk-live/videosdk-rtc-react-sdk-example