@videosdk.live/js-sdk
Version:
<h1 align="center"> <img src="https://static.videosdk.live/videosdk_logo_website_black.png"/><br/> <p align="center"> Video SDK for JavaScript<br/> <a href="https://videosdk.live/">videosdk.live</a> </p> </h1>
108 lines (77 loc) • 3.67 kB
Markdown
<h1 align="center">
<img src="https://static.videosdk.live/videosdk_logo_website_black.png"/><br/>
<p align="center">
Video SDK for JavaScript<br/>
<a href="https://videosdk.live/">videosdk.live</a>
</p>
</h1>
<p align="center">
<a href="https://www.npmjs.com/package/@videosdk.live/js-sdk"><img src="https://img.shields.io/npm/dw/@videosdk.live/js-sdk.svg?style=for-the-badge" alt="NPM downloads"></a>
<a href="https://www.npmjs.com/package/@videosdk.live/js-sdk"><img src="https://img.shields.io/npm/v/@videosdk.live/js-sdk/latest.svg?style=for-the-badge" alt="NPM latest version"></a>
<a href="https://discord.gg/kgAvyxtTxv">
<img src="https://img.shields.io/discord/734858252939952248?logo=discord&style=for-the-badge" />
</a>
<a href="https://twitter.com/intent/follow?original_referer=https%3A%2F%2Fpublish.twitter.com%2F&ref_src=twsrc%5Etfw%7Ctwcamp%5Ebuttonembed%7Ctwterm%5Efollow%7Ctwgr%5Evideo_sdk&screen_name=video_sdk">
<img src="https://img.shields.io/twitter/follow/video_sdk?label=Twitter&logo=twitter&style=for-the-badge" />
</a>
<a href="http://youtube.com/videosdk?sub_confirmation=1">
<img src="https://img.shields.io/youtube/channel/subscribers/UCuY7JzXnpp874oa7uQbUwsA?logo=Youtube&style=for-the-badge" />
</a>
</p>
- 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](https://docs.videosdk.live/docs/realtime-communication/see-also/device-browser-support)
## Demo App
Check out demo [here](https://demo.videosdk.live/)
# Setup
With javascript SDK, you can
- Customise call layout and interface
- Manage all the events related to meetings and partcipants
- Call routines on particular event.
To use `javascript-sdk`, you have two choices to make either use `npm` module or `<script>` tag in your bundler or direct in HTML.
## Loading the library using `<script>` tag
You can import this library using `<script>` tag. The easiest way to get started is to load this library from CDN, and add a couple of lines of code to your web page or app.
```js {5} title="Load JS SDK in your app"
<html>
<head>....</head>
<body>
.....
<script src="https://sdk.videosdk.live/js-sdk/0.1.4/videosdk.js"></script>
</body>
</html>
```
Another interesting option is to install library in your app and bundle it using webpack or rollup.
**From npm package**:
```js
npm install @videosdk.live/js-sdk
```
**From yarn package**:
```js
yarn add @videosdk.live/js-sdk
```
Then in your application code:
```js title="Webpack/node-style require"
const VideoSDK = require("@videosdk.live/js");
VideoSDK.initMeeting({...})
```
Or
```js title="ES6 import"
import VideoSDK from "@videosdk.live/js";
VideoSDK.initMeeting({...})
```
Check the components and their usage in our [documentation](https://docs.videosdk.live/javascript/guide/video-and-audio-calling-api-sdk/javascript-sdk).
Check the Quick Start guide to our [documentation](https://docs.videosdk.live/javascript/guide/video-and-audio-calling-api-sdk/quick-start).
Run the [Code sample](https://github.com/videosdk-live/videosdk-rtc-javascript-sdk-example) to see it in action.