signage.elements.javascript

Interface SignStixGraphics

SignStixGraphics

Javascript-to-Player interface with functions for querying and modifying graphics layers while a sign is playing.

Function Summary

Modifier and Type	Function and Description
Layer	getLayerAt(int index) Find the layer at the argument index.
Layer	getLayerContaining(String layerNamePart) Find the first layer in the sign which has a name containing the argument partial name.
int	getLayerCount() Find the number of layers in the current sign.
Layer	getLayerNamed(String layerName) Find the layer in the currently playing sign that has the argument name.
void	takeFaces(String jsFunctionName) Attempt to take a photo and extract the faces from it using a camera connected to the Player.
void	takeFacesAdvanced(String jsFunctionName, float confidenceThreshold, float proximityThreshold) Attempt to take a photo and extract the faces from it using a camera connected to the Player.
void	takePhoto(String jsFunctionName) Attempt to take a photo using a camera connected to the Player.
void	updateDisplay() Instruct the player to update its display to reflect any layer changes involving the creation of new graphics (e.g.

Function Detail

getLayerNamed

Layer getLayerNamed(String layerName)

Find the layer in the currently playing sign that has the argument name.

Parameters:

layerName - the name of the layer as defined in Creator.

Returns:

the corresponding layer, or null if there is no such layer.

Since:

Player 2.10.2

getLayerContaining

Layer getLayerContaining(String layerNamePart)

Find the first layer in the sign which has a name containing the argument partial name.

Parameters:

layerNamePart - part of a layer name.

Returns:

the matching layer, or null if there is no such layer.

Since:

Player 2.10.5

getLayerCount

int getLayerCount()

Find the number of layers in the current sign.

Returns:

the number of layers.

Since:

Player 2.10.5

getLayerAt

Layer getLayerAt(int index)

Find the layer at the argument index.

Parameters:

index - from 0 to (getLayoutCount()-1).

Returns:

the corresponding layer, or null if there is no such layer.

Since:

Player 2.10.5

updateDisplay

void updateDisplay()

Instruct the player to update its display to reflect any layer changes involving the creation of new graphics (e.g. changing the text on a layer). Such changes are batched-up until this function is called. Other changes are visible immediately without needing to call this function.

Since:

Player 2.10.2

takePhoto

void takePhoto(String jsFunctionName)

Attempt to take a photo using a camera connected to the Player.

Parameters:

jsFunctionName - the name of a Javascript function that takes parameters as follows:

1. imageData - base64-encoding of a JPEG image, or null if unsuccessful.

Since:

Player 3.2.1

takeFaces

void takeFaces(String jsFunctionName)

Attempt to take a photo and extract the faces from it using a camera connected to the Player. The JS function with the argument name will be called for each face extracted. If no faces are found, it will be called once with a null argument.

Parameters:

jsFunctionName - the name of a Javascript function that takes parameters as follows:

1. imageData - base64-encoding of a JPEG face image, or null if unsuccessful.

Since:

Player 3.2.1

takeFacesAdvanced

void takeFacesAdvanced(String jsFunctionName,
                       float confidenceThreshold,
                       float proximityThreshold)

Attempt to take a photo and extract the faces from it using a camera connected to the Player. The JS function with the argument name will be called for each face extracted. If no faces are found, it will be called once with a null argument. The threshold parameters of this advanced variant of the function allows greater control over what images are interpreted as faces.

Parameters:

jsFunctionName - the name of a Javascript function that takes parameters as follows:

1. imageData - base64-encoding of a JPEG face image, or null if unsuccessful.

confidenceThreshold - a number between 0.0 (lenient) and 1.0 (strict). If set too low it may detect other patterns as well as faces. If set too high it may fail to detect any faces.

proximityThreshold - a number between 0.0 (lenient) and 1.0 (strict). If set low, it will attempt to detect faces regardless of how far they are from the camera. If set high, only faces very close to the camera will be considered.

Since:

Player 3.3.0