Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@videosdk.live/react-sdk

_chintan_22.3kISC0.3.11TypeScript support: included


Video SDK React App
videosdk.live

react, video-sdk, javascript, realtime, webrtc, live-streaming, communication

readme


Video SDK React App
videosdk.live

NPM downloads NPM latest version

Features

  • Video API with real-time audio, video and data streams
  • 5,000+ participants support
  • Chat support with rich media.
  • Screen sharing with HD and Full HD.
  • Play realtime video in meeting
  • Connect it with social media such as Facebook, Youtube etc (RTMP out support).
  • Intelligent speaker switch
  • Record your meetings on cloud
  • Customise UI and built other rich features with our new data streams such as whiteboard, poll, Q & A etc.

Browser Support

Visit our official guide for Browser Support

Demo App

Check out demo here

Prerequisites

You must have the following installed:

  • Node.js v12+
  • NPM v6+ (comes installed with newer Node versions)

Setup

`@videosdk.live/react-sdkwraps up our [@videosdk.live/js-sdk`](https://www.npmjs.com/package/@videosdk.live/js-sdk) into usable hooks APIs. It simplifies code and concept for react-js

Install the library in React

The easiest way to get started is by installing `@videosdk.live/react-sdk` in your app.

From npm package:

npm install @videosdk.live/react-sdk

From yarn package:

yarn add @videosdk.live/react-sdk

Import the library in your app

react-sdk provides two most important hook useMeeting and useParticipant. it also provides MeetingProvider and MeetingConsumer to listen changes in meeting state and events.

javascript title="Import the library" import { MeetingProvider, useMeeting, useParticipant, MeetingConsumer, } from "@videosdk.live/react-sdk";

Documentation

Check the components and their usage in our documentation.

Quick Start

Check the Quick Start guide to our documentation.

Try it out

Run the Code sample to see it in action.