furioos-sdk-js/README.md

1.1 KiB

Furioos SDK

Requirements

You'll need a pro version subscription on your Furioos interface in order to use the SDK. Then choose the app you want to use with the SDK and share it as SDK link.

Installation

npm install --save furioos-sdk

Exemple

You should copy past your link previously you got in your Furioos interface.

import { Player } from 'furioos-sdk';

const player = new Player({sdkShareLink}, {containerDivId});

player.onLoad(function() {
  // Here you know when the player is ready.
  player.startSession();
})

Methods

Instanciate the player for a given app.

onLoad(callback)

Bind a callback that will be called when the player is ready.

  • callback: Function: You own code to do what you want when it's ready (ex: start the stream.);

startSession()

Launch the stream of the app.

stopSession()

Stop the stream of the app.