vidyoclient-nativewebrtc-sdk
Version:
Native WebRTC SDK for building a full featured video chat app running in the browser
60 lines (48 loc) • 1.89 kB
Markdown
# VidyoClient WebRTC Javascript Library
Native WebRTC SDK for building a full featured video chat app running in the browser
## Installation
### CDN
Via `<script type="module">` tag:
```html
<script type="module">
import { VC } from 'https://cdn.jsdelivr.net/npm/vidyoclient-nativewebrtc-sdk/dist/VidyoClient.js';
const vidyoConnector = await VC.CreateVidyoConnector({
viewId: "renderer", // Div ID where the composited video will be rendered, see VidyoConnector.html;
viewStyle: "VIDYO_CONNECTORVIEWSTYLE_Default", // Visual style of the composited renderer
remoteParticipants: 8, // Maximum number of participants to render
logFileFilter: "debug@VidyoClient debug@VidyoSDP debug@VidyoResourceManager",
logFileName: "",
userData: 0,
constraints: {}
});
</script>
```
### NPM
```bash
npm i --save vidyoclient-nativewebrtc-sdk
```
#### JS
```js
import { VC } from "vidyoclient-nativewebrtc-sdk";
const vidyoConnector = await VC.CreateVidyoConnector({
viewId: "renderer", // Div ID where the composited video will be rendered, see VidyoConnector.html;
viewStyle: "VIDYO_CONNECTORVIEWSTYLE_Default", // Visual style of the composited renderer
remoteParticipants: 8, // Maximum number of participants to render
logFileFilter: "debug@VidyoClient debug@VidyoSDP debug@VidyoResourceManager",
logFileName: "",
userData: 0,
constraints: {}
});
```
#### Styles
```css
import "vidyoclient-nativewebrtc-sdk/dist/VidyoClient.css"
```
or via CDN
```html
<link href="https://cdn.jsdelivr.net/npm/vidyoclient-nativewebrtc-sdk/dist/VidyoClient.css" rel="stylesheet" crossorigin="anonymous">
```
## Getting Started
[Sample code](https://github.com/VidyoAPI-SDK/nativeWebRTC-getting-started-sample)
## Examples
[Full featured Video Conferencing Application](https://static.platform.vidyodev.io/vidyoconnect/sample/index.html)