config.javascript

Interface SignStixConfig

SignStixConfig

Javascript-to-Player interface with functions for querying the device's configuration.

Function Summary

Modifier and Type	Function and Description
String	getDescription() Find the device description set in Director.
String	getDeviceId() Find the human-readable form of the device's ID.
String	getIpAddress() Find the device's IP address.
String	getLocation() Find the full path of the location that this device lives in.
String	getSiteName() Find the name of the site that this device lives in.
String	getSyncFunction() Find the device's synchronisation Function.
String	getSyncTag() Find the device's synchronisation tag.
String	getZoneName() Find the name of the zone that this device lives in.

Function Detail

getSiteName

String getSiteName()

Find the name of the site that this device lives in.

Returns:

the name of the site, or null if this device isn't currently within a site.

Since:

Player 2.10.2

getZoneName

String getZoneName()

Find the name of the zone that this device lives in.

Returns:

the name of the zone, or null if this device isn't currently within a zone.

Since:

Player 2.10.2

getLocation

String getLocation()

Find the full path of the location that this device lives in.

Returns:

the full location path e.g. "/UK/Manchester";

Since:

Player 3.2.1

getDeviceId

String getDeviceId()

Find the human-readable form of the device's ID.

Returns:

the device ID. This is a unique string in Base36 encoding.

Since:

Player 2.10.2

getDescription

String getDescription()

Find the device description set in Director.

Returns:

the device description, or the empty string if not set.

Since:

Player 3.2.1

getIpAddress

String getIpAddress()

Find the device's IP address.

Returns:

the device's IP address if connected, or null if disconnected.

Since:

Player 3.2.1

getSyncFunction

String getSyncFunction()

Find the device's synchronisation Function.

Returns:

one of "master", "slave", "ntp" or "none".

Since:

Player 3.2.1

getSyncTag

String getSyncTag()

Find the device's synchronisation tag.

Returns:

the synchronisation tag, or the empty string if not set.

Since:

Player 3.2.1