Class

Overlays

Overlays(toolui)

Constructor

new Overlays(toolui)

This module creates a http host for OBS/Xsplit overlays. Has an UI for setting hotkeys and controling
Parameters:
Name Type Description
toolui ToolUI

View Source mod/overlay.js, line 10

Extends

Members

Array.<String>

allowedFiles

Array of file endings that are being served. You can add your own, if you want.

View Source mod/overlay.js, line 47

String

readonly icon

A single character; use UTF-8 emojis or something
Overrides:

View Source mod/uipage.js, line 45

String

readonly localizedName

Gives you the localized name of the page
Overrides:

View Source mod/overlay.js, line 160

String

readonly name

Gives you the name of the page.
Inherited From:

View Source mod/uipage.js, line 25

Number

overlayport

The port for the overlay http server.

View Source mod/overlay.js, line 39

http.Server

overlayserver

The http server

View Source mod/overlay.js, line 72

Boolean

readonly showInViewsList

Wether or not to show this page in the views list; If false you have to make sure yourself that the user can access this page
Inherited From:

View Source mod/uipage.js, line 55

Number

wsport

The port for the WebSocket server. Connect to this port to listen for events.

View Source mod/overlay.js, line 34

nodejs-websocket.Server

wsserver

The websocket server

View Source mod/overlay.js, line 65

Methods

appendSetting(setting, label, type, options)

Parameters:
Name Type Description
setting String
label String
type String
options Object

View Source mod/overlay.js, line 466

broadcastWsMessage(message)

Broadcasts a message to all WebSocket connections
Parameters:
Name Type Description
message String Message you want to send

View Source mod/overlay.js, line 231

close()

Closes the cockpit page
Overrides:

View Source mod/overlay.js, line 453

disableOverlayHotkeys()

Disable all registered Hotkeys

View Source mod/overlay.js, line 404

open()

Open the cockpit page
Overrides:

View Source mod/overlay.js, line 443

Events

command

Fires when a command is fired (wether or not a overlay has received it)
Parameters:
Name Type Description
command String The command or message string that was sent

View Source mod/overlay.js, line 245

hotkeys-unregistered

Fires when hotkeys were unregistered

View Source mod/overlay.js, line 406