@radicalbit/golive-sdk
v2.0.27
Published
[![NPM](https://img.shields.io/npm/v/@radicalbit/golive-sdk.svg)](https://www.npmjs.com/package/@radicalbit/golive-sdk)
Downloads
5
Maintainers
Readme
Live Streaming SDK
Install
npm install @radicalbit/golive-sdk
or
yarn add @radicalbit/golive-sdk
Usage
Start by importing your library via
const { initLsPlayer } = require('golive-sdk');
or using ES6
import { initLsPlayer } from 'golive-sdk';
You should run the initLsPlayer
function as soon as your page loads. This is an example of doing it in React. Then it's just a matter of pressing a button and the player will spawn.
useEffect(() => {
// Get config, origin, path, isLandscape, targetBlank and customParams from BackOffice
initLsPlayer({
config,
nodeId: 'golive', // This must match the id of the CTA that is responsible of triggering the player
origin,
path,
isLandscape,
targetBlank,
customParams,
});
}, [initLsPlayer]);
return <button id="golive">Join Show Now</button>;
If your Website / CMS / Provider blocks the loading of externally added scripts, you will also need to manually include a copy of the golive-dvlt.js
library into your page.
<script src="https://golive.cloud.radicalbit.io/divolte/golive-dvlt.js"></script>
and then pass an extra boolean parameter to false to initLsPlayer
useEffect(() => {
// Get config, origin, path, isLandscape, targetBlank and customParams from BackOffice
initLsPlayer({
config,
nodeId: 'golive', // This must match the id of the CTA that is responsible of triggering the player
origin,
path,
isLandscape,
targetBlank,
customParams,
}, false);
}, [initLsPlayer]);
return <button id="golive">Join Show Now</button>;
License
MIT ©