Overlays

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

Extends

Members

allowedFiles :Array.<String>

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

readonly localizedName :String

Gives you the localized name of the page.
Overrides:

readonly name :String

Gives you the name of the page.
Inherited From:

overlayport :Number

The port for the overlay http server.

overlayserver :http.Server

The http server

readonly showInViewsList :Boolean

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:

wsport :Number

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

wsserver :nodejs-websocket.Server

The websocket server

Methods

broadcastWsMessage(message)

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

close()

Is being called when open and is being closed.
Overrides:

disableOverlayHotkeys()

Disable all registered Hotkeys

open()

Is being called when this page is opened.
Overrides: