Global

Methods

SaveConfigToServer()

Sends our config to the server to be saved for next time we run

Source:

extensions/multistream/multistream.js, line 851

SendSettingsWidgetLarge()

Source:

extensions/multistream/multistream.js, line 774

SendSettingsWidgetSmall()

update and send out our small settings widget

Source:

extensions/multistream/multistream.js, line 714

SetupWebpageServer()

Start the webserver. Mostly used to download encoders list to save on websocket bandwidth

Source:

extensions/multistream/multistream.js, line 282

UpdateEncodersAvailable()

Query the Computer for ffmpeg encoders

Source:

extensions/multistream/ffmpeg.js, line 317

Returns:

Promise with encoders object when resolved or null

buildFFMPEGArgs(hideStreamKey)

Builds the argument string for ffmpeg

Parameters:

Name	Type	Default	Description
`hideStreamKey`	boolean	true	//if true replaces keys with placeholders

Source:

extensions/multistream/multistream.js, line 947

Returns:

ffmpeg args for the given stream

checkFFMPEGAvailabilities()

Checks and updates availabilities of FFMPEG with current settings and builds the encoders lists

Source:

extensions/multistream/multistream.js, line 1389

checkFFMPEGInstall()

checks what ffmpeg is installed and sets local variables (userFfmpegInstalled, streamRollerFfmpegInstalled) to true or false based on availability

Source:

extensions/multistream/ffmpeg.js, line 622

createCheckBox(description, name, checked)

Parameters:

Name	Type	Description
`description`	string
`name`	string
`checked`	boolean

Source:

extensions/multistream/multistream.js, line 1367

Returns:

html code of the checkbox

(async) downloadFFMPEG()

download and install ffmpeg

Source:

extensions/multistream/ffmpeg.js, line 688

ffmpegBusyFlags()

checks if ffmpegBusyFlags processing is still happening, ie encoder queries etc

Source:

extensions/multistream/ffmpeg.js, line 136

Returns:

boolean

findTriggerByMessageType(messagetype)

Finds the trigger using the passed messagetype

Parameters:

Name	Type	Description
`messagetype`	string

Source:

extensions/multistream/multistream.js, line 1295

Returns:

trigger

getDebug()

Source:

extensions/multistream/ffmpeg.js, line 295

Returns:

object

(async) getEncoderOptions(ffmpegExe, encoder)

Parameters:

Name	Type	Description
`ffmpegExe`	string
`encoder`	string

Source:

extensions/multistream/ffmpeg.js, line 538

Returns:

array of options for the given encoder

getEncoders()

Source:

extensions/multistream/ffmpeg.js, line 306

Returns:

object

getFFMPEGCommand()

returns the cmd to run for the current ffmpeg setup

Source:

extensions/multistream/ffmpeg.js, line 656

Returns:

ffmpeg exe command

getInstalledFFMPEGs()

Returns the types of FFMPEG we have installed (ie user or StreamRoller) {streamRollerFfmpegInstalled,userFfmpegInstalled}

Source:

extensions/multistream/ffmpeg.js, line 122

handleExit(err, endCB)

Parameters:

Name	Type	Description
`err`	error
`endCB`	callback

Source:

extensions/multistream/ffmpeg.js, line 262

heartBeatCallback()

Provides a heartbeat message to inform other extensions of our status

Source:

extensions/multistream/multistream.js, line 1417

init()

Source:

extensions/multistream/ffmpeg.js, line 85

initialise(app, host, port, heartbeat)

Parameters:

Name	Type	Description
`app`	string
`host`	string
`port`	string
`heartbeat`	number

Source:

extensions/multistream/multistream.js, line 245

killProcess()

kills the current ffmpeg process

Source:

extensions/multistream/multistream.js, line 1159

onDataCenterConnect(socket)

Connection message handler

Parameters:

Name	Type	Description
`socket`	*

Source:

extensions/multistream/multistream.js, line 320

onDataCenterDisconnect(reason)

Disconnection message sent from the server

Parameters:

Name	Type	Description
`reason`	String

Source:

extensions/multistream/multistream.js, line 309

onDataCenterMessage(server_packet)

receives message from the socket

Parameters:

Name	Type	Description
`server_packet`	data

Source:

extensions/multistream/multistream.js, line 344

(async) parseEncodersString(ffmpegExe)

creates video and audio encoder lists from the ffmpeg output string

Parameters:

Name	Type	Description
`ffmpegExe`	string

Source:

extensions/multistream/ffmpeg.js, line 445

Returns:

Promise (true) or error

parseSettingsWidgetLarge(extension_data)

Our large settings widget was submitted

Parameters:

Name	Type	Description
`extension_data`	object

Source:

extensions/multistream/multistream.js, line 585

parseSettingsWidgetSmall(extension_data)

Our small settings widget was submitted

Parameters:

Name	Type	Description
`extension_data`	object

Source:

extensions/multistream/multistream.js, line 490

printProgress(progress)

overwrites a string on the cmd line, mostly useful for progress etc

Parameters:

Name	Type	Description
`progress`	string

Source:

extensions/multistream/ffmpeg.js, line 837

runFFMPEG(command, args, options, processCB, streamStarted, streamFinished)

Parameters:

Name	Type	Default
`command`	string
`args`	array
`options`	object
`processCB`	callback	null
`streamStarted`	callback	null
`streamFinished`	callback	null

Source:

extensions/multistream/ffmpeg.js, line 158

Returns:

handle to process or null

saveCredentialsToServer()

Sends our credentials to the server to be saved for next time we run

Source:

extensions/multistream/multistream.js, line 864

sendAction(action)

sends an action out.

Parameters:

Name	Type	Description
`action`	object	{messagetype:..', to:..., data: {<< action params >>}}

Source:

extensions/multistream/multistream.js, line 1313

sendOBSStartRecordingAction(triggerActionRef)

tells OBS to start Recording

Parameters:

Name	Type	Default	Description
`triggerActionRef`	string	multistream	pass through reference from action or "multistream"

Source:

extensions/multistream/multistream.js, line 1224

sendOBSStartStreamingAction(triggerActionRef)

tells OBS to start streaming

Parameters:

Name	Type	Default	Description
`triggerActionRef`	string	multistream	pass through reference from action or "multistream"

Source:

extensions/multistream/multistream.js, line 1188

sendOBSStopRecordingAction(triggerActionRef)

Parameters:

Name	Type	Default	Description
`triggerActionRef`	string	multistream	pass through reference from action or "multistream"

Source:

extensions/multistream/multistream.js, line 1242

sendOBSStopStreamingAction(triggerActionRef)

Parameters:

Name	Type	Default	Description
`triggerActionRef`	string	multistream	pass through reference from action or "multistream"

Source:

extensions/multistream/multistream.js, line 1206

sendStreamStartedTrigger(triggerActionRef)

Parameters:

Name	Type	Default	Description
`triggerActionRef`	string	multistream	pass through reference from action or "multistream"

Source:

extensions/multistream/multistream.js, line 1260

sendStreamStoppedTrigger(triggerActionRef)

Parameters:

Name	Type	Description
`triggerActionRef`	string	pass through reference from action or "multistream"

Source:

extensions/multistream/multistream.js, line 1277

sendTrigger(data)

Sends the given trigger or action out on our channel if to is "" or sends to the extension as an extension message if to specifies extension name

Parameters:

Name	Type	Description
`data`	object

Source:

extensions/multistream/multistream.js, line 1338

setDebug(debugOptions)

Parameters:

Name	Type	Description
`debugOptions`	object

Source:

extensions/multistream/ffmpeg.js, line 284

startStream(ref)

Parameters:

Name	Type	Default	Description
`ref`	string	multistream	identifier that is carried over from an action or defaulted

Source:

extensions/multistream/multistream.js, line 891

stopStream()

Stop streaming

Source:

extensions/multistream/multistream.js, line 1143

unzipfile(file, to)

Parameters:

Name	Type	Description
`file`	string	filename
`to`	to	destination directory

Source:

extensions/multistream/ffmpeg.js, line 824

updateEncoderWebJSONFile()

Updates the encoders file for the settings page

Source:

extensions/multistream/ffmpeg.js, line 585

useStreamRollerFfmpeg(useStreamRoller)

Should we use StreamRoller FFMPEG or the PC Installed one (if available)

Parameters:

Name	Type	Description
`useStreamRoller`	boolean

Source:

extensions/multistream/ffmpeg.js, line 111

Methods

SaveConfigToServer()

Sends our config to the server to be saved for next time we run

Source:

extensions/multistream/multistream.js, line 851

SendSettingsWidgetLarge()

Source:

extensions/multistream/multistream.js, line 774

SendSettingsWidgetSmall()

update and send out our small settings widget

Source:

extensions/multistream/multistream.js, line 714

SetupWebpageServer()

Start the webserver. Mostly used to download encoders list to save on websocket bandwidth

Source:

extensions/multistream/multistream.js, line 282

UpdateEncodersAvailable()

Query the Computer for ffmpeg encoders

Source:

extensions/multistream/ffmpeg.js, line 317

Returns:

Promise with encoders object when resolved or null

buildFFMPEGArgs(hideStreamKey)

Builds the argument string for ffmpeg

Parameters:

Name	Type	Default	Description
`hideStreamKey`	boolean	true	//if true replaces keys with placeholders

Source:

extensions/multistream/multistream.js, line 947

Returns:

ffmpeg args for the given stream

checkFFMPEGAvailabilities()

Checks and updates availabilities of FFMPEG with current settings and builds the encoders lists

Source:

extensions/multistream/multistream.js, line 1389

checkFFMPEGInstall()

checks what ffmpeg is installed and sets local variables (userFfmpegInstalled, streamRollerFfmpegInstalled) to true or false based on availability

Source:

extensions/multistream/ffmpeg.js, line 622

createCheckBox(description, name, checked)

Parameters:

Name	Type	Description
`description`	string
`name`	string
`checked`	boolean

Source:

extensions/multistream/multistream.js, line 1367

Returns:

html code of the checkbox

(async) downloadFFMPEG()

download and install ffmpeg

Source:

extensions/multistream/ffmpeg.js, line 688

ffmpegBusyFlags()

checks if ffmpegBusyFlags processing is still happening, ie encoder queries etc

Source:

extensions/multistream/ffmpeg.js, line 136

Returns:

boolean

findTriggerByMessageType(messagetype)

Finds the trigger using the passed messagetype

Parameters:

Name	Type	Description
`messagetype`	string

Source:

extensions/multistream/multistream.js, line 1295

Returns:

trigger

getDebug()

Source:

extensions/multistream/ffmpeg.js, line 295

Returns:

object

(async) getEncoderOptions(ffmpegExe, encoder)

Parameters:

Name	Type	Description
`ffmpegExe`	string
`encoder`	string

Source:

extensions/multistream/ffmpeg.js, line 538

Returns:

array of options for the given encoder

getEncoders()

Source:

extensions/multistream/ffmpeg.js, line 306

Returns:

object

getFFMPEGCommand()

returns the cmd to run for the current ffmpeg setup

Source:

extensions/multistream/ffmpeg.js, line 656

Returns:

ffmpeg exe command

getInstalledFFMPEGs()

Returns the types of FFMPEG we have installed (ie user or StreamRoller) {streamRollerFfmpegInstalled,userFfmpegInstalled}

Source:

extensions/multistream/ffmpeg.js, line 122

handleExit(err, endCB)

Parameters:

Name	Type	Description
`err`	error
`endCB`	callback

Source:

extensions/multistream/ffmpeg.js, line 262

heartBeatCallback()

Provides a heartbeat message to inform other extensions of our status

Source:

extensions/multistream/multistream.js, line 1417

init()

Source:

extensions/multistream/ffmpeg.js, line 85

initialise(app, host, port, heartbeat)

Parameters:

Name	Type	Description
`app`	string
`host`	string
`port`	string
`heartbeat`	number

Source:

extensions/multistream/multistream.js, line 245

killProcess()

kills the current ffmpeg process

Source:

extensions/multistream/multistream.js, line 1159

onDataCenterConnect(socket)

Connection message handler

Parameters:

Name	Type	Description
`socket`	*

Source:

extensions/multistream/multistream.js, line 320

onDataCenterDisconnect(reason)

Disconnection message sent from the server

Parameters:

Name	Type	Description
`reason`	String

Source:

extensions/multistream/multistream.js, line 309

onDataCenterMessage(server_packet)

receives message from the socket

Parameters:

Name	Type	Description
`server_packet`	data

Source:

extensions/multistream/multistream.js, line 344

(async) parseEncodersString(ffmpegExe)

creates video and audio encoder lists from the ffmpeg output string

Parameters:

Name	Type	Description
`ffmpegExe`	string

Source:

extensions/multistream/ffmpeg.js, line 445

Returns:

Promise (true) or error

parseSettingsWidgetLarge(extension_data)

Our large settings widget was submitted

Parameters:

Name	Type	Description
`extension_data`	object

Source:

extensions/multistream/multistream.js, line 585

parseSettingsWidgetSmall(extension_data)

Our small settings widget was submitted

Parameters:

Name	Type	Description
`extension_data`	object

Source:

extensions/multistream/multistream.js, line 490

printProgress(progress)

overwrites a string on the cmd line, mostly useful for progress etc

Parameters:

Name	Type	Description
`progress`	string

Source:

extensions/multistream/ffmpeg.js, line 837

runFFMPEG(command, args, options, processCB, streamStarted, streamFinished)

Parameters:

Name	Type	Default
`command`	string
`args`	array
`options`	object
`processCB`	callback	null
`streamStarted`	callback	null
`streamFinished`	callback	null

Source:

extensions/multistream/ffmpeg.js, line 158

Returns:

handle to process or null

saveCredentialsToServer()

Sends our credentials to the server to be saved for next time we run

Source:

extensions/multistream/multistream.js, line 864

sendAction(action)

sends an action out.

Parameters:

Name	Type	Description
`action`	object	{messagetype:..', to:..., data: {<< action params >>}}

Source:

extensions/multistream/multistream.js, line 1313

sendOBSStartRecordingAction(triggerActionRef)

tells OBS to start Recording

Parameters:

Name	Type	Default	Description
`triggerActionRef`	string	multistream	pass through reference from action or "multistream"

Source:

extensions/multistream/multistream.js, line 1224

sendOBSStartStreamingAction(triggerActionRef)

tells OBS to start streaming

Parameters:

Name	Type	Default	Description
`triggerActionRef`	string	multistream	pass through reference from action or "multistream"

Source:

extensions/multistream/multistream.js, line 1188

sendOBSStopRecordingAction(triggerActionRef)

Parameters:

Name	Type	Default	Description
`triggerActionRef`	string	multistream	pass through reference from action or "multistream"

Source:

extensions/multistream/multistream.js, line 1242

sendOBSStopStreamingAction(triggerActionRef)

Parameters:

Name	Type	Default	Description
`triggerActionRef`	string	multistream	pass through reference from action or "multistream"

Source:

extensions/multistream/multistream.js, line 1206

sendStreamStartedTrigger(triggerActionRef)

Parameters:

Name	Type	Default	Description
`triggerActionRef`	string	multistream	pass through reference from action or "multistream"

Source:

extensions/multistream/multistream.js, line 1260

sendStreamStoppedTrigger(triggerActionRef)

Parameters:

Name	Type	Description
`triggerActionRef`	string	pass through reference from action or "multistream"

Source:

extensions/multistream/multistream.js, line 1277

sendTrigger(data)

Sends the given trigger or action out on our channel if to is "" or sends to the extension as an extension message if to specifies extension name

Parameters:

Name	Type	Description
`data`	object

Source:

extensions/multistream/multistream.js, line 1338

setDebug(debugOptions)

Parameters:

Name	Type	Description
`debugOptions`	object

Source:

extensions/multistream/ffmpeg.js, line 284

startStream(ref)

Parameters:

Name	Type	Default	Description
`ref`	string	multistream	identifier that is carried over from an action or defaulted

Source:

extensions/multistream/multistream.js, line 891

stopStream()

Stop streaming

Source:

extensions/multistream/multistream.js, line 1143

unzipfile(file, to)

Parameters:

Name	Type	Description
`file`	string	filename
`to`	to	destination directory

Source:

extensions/multistream/ffmpeg.js, line 824

updateEncoderWebJSONFile()

Updates the encoders file for the settings page

Source:

extensions/multistream/ffmpeg.js, line 585

useStreamRollerFfmpeg(useStreamRoller)

Should we use StreamRoller FFMPEG or the PC Installed one (if available)

Parameters:

Name	Type	Description
`useStreamRoller`	boolean

Source:

extensions/multistream/ffmpeg.js, line 111