Global

Methods

(async) init() → {Promise}

Initialise the connection to the HDMI Switcher

(async) next() → {Promise}

Switches the HDMI Switch to the next source

(async) off() → {Promise}

Turn off the Display connected to the HDMI Switch

(async) on() → {Promise}

Turn on the the Display connected to the HDMI Switch

(async) previous() → {Promise}

Switches the HDMI Switch to the previous source

(async) switch(source) → {Promise}

Switch the HDMI Switch to the source provided.

Parameters:
Name Type Description
source Number

The source on the HDMI Switcher to switch to

Type Definitions

module:WebviewCloseEventCallback(id)

Fired when a page inside a webview requests to close.

Parameters:
Name Type Description
id UUID

The ID of the Webview this event originated from

UUID :String

WebviewConfiguration :Object

Properties:
Name Type Attributes Default Description
url String

URL to load in the WebView.

zindex String

The z-index of the WebView.

css Object <optional>
{}

An object representing the css properties

top String <optional>
'0px'

The top position of the WebView

left String <optional>
'0px'

The left position of the WebView

name String <optional>
''

An optional name for this WebView

width String <optional>
'100%'

The width of the WebView

height String <optional>
'100%'

The height of the WebView

loadTimeout Boolean <optional>
true

When true detect if the WebView has failed to load / timed out.

backgroundColor String <optional>
'white'

The background color of the WebView

noCookies Boolean <optional>
false

When true do not check for existing cookies in the pool of available WebView paritions

visible Boolean <optional>
false

When true show the WebView regardless of if the content inside the WebView has loaded.

forceParition String <optional>
false

Force the WebView to use a particular partition

manageNewWindow Boolean <optional>
true

When true WebView detects attempts to open web pages in new window and loads in the current WebView.

revealAfterLoad Boolean <optional>
false

When true the WebView will manage revealing the webview after the content has loaded.

slim Boolean <optional>
false

Create a lean WebView do not use any error detection and management. Great for debugging!