Getting Started

Requirements

Video.io JavaScript SDK supports the latest versions of the most popular browsers:

• Chrome
• Firefox
• Safari (including iOS)
• Edge

Setup

There are a few ways to get started using VideoKit, but you should select the one that fits best your particular use case.

CDN

Using SDK files hosted on our global CDN is probably the easiest way to get started using VideoKit. You simply need to include the following link in your page.

<script type="text/javascript" src="https://cdn.video.io/js/1.0.3/videokit.js"></script>

If you're going to use UI components, make sure you also include VideoKit CSS.

<link href="https://cdn.video.io/js/1.0.3/videokit.css" rel="stylesheet" />

If you load VideoKit asynchronously, you can use global function videoKitAsyncInit, that will be called when VideoKit is loaded and ready to use.

window.videoKitAsyncInit = function() {
    // You can use VideoKit here
};

NPM

For more advanced workflows, installing via npm is recommended.

npm install @video-io/videokit --save

Or

yarn add @video-io/videokit

And to include CSS you could do following:

import '@video-io/videokit/videokit.css'