Skip to content

inlivedev/inlive-js-sdk

Repository files navigation

InLive JavaScript SDK

InLive JavaScript SDK provides functionalities to develop and interact with InLive API. Learn more about InLive API.

Available packages

Package Description
Live stream Package to work with inLive live stream API
Room Package to work with inLive hub and room API.
Player Inlive player as a web component to play the media streaming formats such as DASH and HLS.

Installation

You have two installation options in order to use the InLive JavaScript SDK. You can either use a package manager to install the SDK or use the CDN links available.

Option 1: Install with package managers (recommended)

You can install the InLive JavaScript SDK using package managers such as npm, yarn, or pnpm. For most users, this is the recommended choice.

Install with npm

$ npm install @inlivedev/inlive-js-sdk

The SDK package will be downloaded and installed. Then, you're ready to import it into your code.

Option 2: Use CDN links available

The InLive JavaScript SDK is also available via CDN links.

Access via jsdelivr

Access the latest version.

https://cdn.jsdelivr.net/npm/@inlivedev/inlive-js-sdk/dist/inlive-js-sdk.js

Access the specific version. You may change the version based on the release version number on NPM.

https://cdn.jsdelivr.net/npm/@inlivedev/inlive-js-sdk@0.4.3/dist/inlive-js-sdk.js

The above links use jsdelivr. But you can also use any CDN that serves npm packages. Other alternatives are unpkg, and jspm. You can also download the file and serve it yourself.

Contributing

Please read our contributing guide for more information.

Help

If you're looking for help, you can contact us or use our Github discussion