SignStixNotify (SignStix JS API)

```
SignStixNotify
```
Javascript-to-Player interface for registering Javascript functions to be called when certain things happen e.g. a sign starts, a layer is touched.

Function Summary

Functions
Modifier and Type	Function and Description
`void`	`notifyOnCarouselSelection(String jsFunctionName)` Set the Javascript function to be called when a carousel has had a specific image selected.
`void`	`notifyOnCustomCommand(String jsFunctionName)` Set the Javascript function to be called when a custom command is received from an external source.
`void`	`notifyOnLayerTouched(String jsFunctionName)` Set the Javascript function to be called when a layer is touched and activated i.e.
`void`	`notifyOnSignEnd(String jsFunctionName)` Set the Javascript function to be called when a sign iteration ends.
`void`	`notifyOnSignStart(String jsFunctionName)` Set the Javascript function to be called when a sign iteration starts.
`void`	`notifyOnTimeout(String jsFunctionName)` Set the Javascript function to be called when the sign's interactivity timeout (if any) has been triggered.
`void`	`notifyOnVideoEnd(String jsFunctionName)` Set the Javascript function to be called when a video ends.
`void`	`notifyOnVideoStart(String jsFunctionName)` Set the Javascript function to be called when a video starts.

- Function Detail
  - notifyOnSignStart
```
void notifyOnSignStart(String jsFunctionName)
```
    Set the Javascript function to be called when a sign iteration starts.
    Parameters:
    jsFunctionName - - may be null (to prevent further notifications) or the name of a Javascript function that takes parameters as follows:
    
    String signName - the name of the sign which is starting.
    
    int iteration - the number of the sign iteration which is starting.
    
    String signId - the ID of the sign which is starting.
  - notifyOnSignEnd
```
void notifyOnSignEnd(String jsFunctionName)
```
    Set the Javascript function to be called when a sign iteration ends.
    Parameters:
    jsFunctionName - - may be null (to prevent further notifications) or the name of a Javascript function that takes parameters as follows:
    
    String signName - the name of the sign which is ending.
    
    int iteration - the number of the sign iteration which is ending.
    
    String signId - the ID of the sign which is ending.
  - notifyOnVideoStart
```
void notifyOnVideoStart(String jsFunctionName)
```
    Set the Javascript function to be called when a video starts.
    Parameters:
    jsFunctionName - - may be null (to prevent further notifications) or the name of a Javascript function that takes parameters as follows:
    
    String videoName - the name of the video which is starting.
    
    int index - the index within the playlist of this video (starting at 0).
    
    String videoId - the ID of the video which is starting.
  - notifyOnVideoEnd
```
void notifyOnVideoEnd(String jsFunctionName)
```
    Set the Javascript function to be called when a video ends.
    Parameters:
    jsFunctionName - - may be null (to prevent further notifications) or the name of a Javascript function that takes parameters as follows:
    
    String videoName - the name of the video which is ending.
    
    int index - the index within the playlist of this video (starting at 0).
    
    String videoId - the ID of the video which is ending.
  - notifyOnLayerTouched
```
void notifyOnLayerTouched(String jsFunctionName)
```
    Set the Javascript function to be called when a layer is touched and activated i.e. touched and released within the bounds of the layer.
    Parameters:
    jsFunctionName - - may be null (to prevent further notifications) or the name of a Javascript function that takes parameters as follows:
    
    String layerName - the name of the layer which was touched.
    
    int layerId - the ID of the layer which was touched.
    
    String signName - the name of the sign to which the layer belongs.
    
    String signId - the ID of the sign to which the layer belongs.
  - notifyOnTimeout
```
void notifyOnTimeout(String jsFunctionName)
```
    Set the Javascript function to be called when the sign's interactivity timeout (if any) has been triggered.
    Parameters:
    jsFunctionName - - may be null (to prevent further notifications) or the name of a Javascript function that takes parameters as follows:
    
    String signName - the name of the sign on which the interactivity timeout was triggered.
    
    String signId - the ID of the sign on which the interactivity timeout was triggered.
  - notifyOnCarouselSelection
```
void notifyOnCarouselSelection(String jsFunctionName)
```
    Set the Javascript function to be called when a carousel has had a specific image selected.
    Parameters:
    jsFunctionName - - may be null (to prevent further notifications) or the name of a Javascript function that takes parameters as follows:
    
    String signName - the name of the sign containing the carousel.
    
    String layerName - the name of the carousel layer which configuration changed.
    
    int layerId - the ID of the carousel layer.
    
    int selectionIndex - the index (from 0) within the carousel of the image that was selected.
    
    int imageLayerName - the name of the image layer within the carousel that is now selected.
    
    int imageLayerId - the ID of the image layer within the carousel that is now selected.
    
    int signId - the ID of the sign containing the carousel.
  - notifyOnCustomCommand
```
void notifyOnCustomCommand(String jsFunctionName)
```
    Set the Javascript function to be called when a custom command is received from an external source.
    Parameters:
    jsFunctionName - - may be null (to prevent further notifications) or the name of a Javascript function that takes parameters as follows:
    
    String customData - the customData for the command e.g. a JSON-encoded String.

Interface SignStixNotify

Function Summary

Function Detail

notifyOnSignStart

notifyOnSignEnd

notifyOnVideoStart

notifyOnVideoEnd

notifyOnLayerTouched

notifyOnTimeout

notifyOnCarouselSelection

notifyOnCustomCommand