Class: Slobs

Slobs(ip, token)

Class that represents Slobs

Constructor

new Slobs(ip, token)

Parameters:
Name Type Description
ip string IP Address where slobs is running. Local: http://127.0.0.1:59650/api
token string Settings->Remote Control and click on the QR-Code and then on show details.
Author:
Source:
Example
slobs = new SlobsJS("127.0.0.1:59650/api", "token2143u323i4oy");

Methods

getConnected()

Source:
Example
var connected = slobs.getConnection();

getRecordingUptime() → {string}

Source:
Returns:
Time formatted (hh:mm:ss) or 'offline'
Type
string
Example
slobs.getRecordingUptime();

getScenes() → {Map}

Source:
Returns:
Map of all scenes & sources.
Type
Map
Example
slobs.getScenes();

getStreamingStatus() → {string}

Source:
Returns:
live / offline
Type
string
Example
slobs.getStreamingStatus();

getStreamUptime() → {string}

Source:
Returns:
Time formatted (hh:mm:ss) or 'offline'
Type
string
Example
slobs.getStreamUptime();

setActiveScene(sceneName)

Parameters:
Name Type Description
sceneName string Case sensitive name of the Scene we wish to set as active.
Source:
Example
slobs.setActiveScene("Game Scene");

toggleRecording()

Source:
Example
slobs.toggleRecording();

toggleSource(sceneName, sourceName)

Parameters:
Name Type Description
sceneName string Case sensitive name of the Scene the source belongs to.
sourceName string Case sensitive name of the Source we wish to toggle.
Source:
Example
slobs.toggleSource("Game Scene", "Webcam")

toggleStreaming()

Source:
Example
slobs.toggleStreaming();