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

All Functions Instance Functions Abstract 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`	`notifyOnPlaylistEnd(String jsFunctionName)` Set the Javascript function to be called when a playlist ends.
`void`	`notifyOnPlaylistStart(String jsFunctionName)` Set the Javascript function to be called when a playlist starts.
`void`	`notifyOnSignAppeared(String jsFunctionName)` Set the Javascript function to be called when a newly-started sign actually appears on the screen.
`void`	`notifyOnSignDisappearing(String jsFunctionName)` Set the Javascript function to be called when a sign which had previously appeared on the screen is just about to disappear from the screen.
`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`	`notifyOnTextInput(String terminators, String jsFunctionName)` Set the Javascript function to be called when text input is received from an external source, such as a keyboard or barcode scanner.
`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.
    Since:
    
    Player 3.0.1
  - 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.
    Since:
    
    Player 3.0.1
  - notifyOnSignAppeared
```
void notifyOnSignAppeared(String jsFunctionName)
```
    Set the Javascript function to be called when a newly-started sign actually appears on the screen. The timing of a sign-appeared notification will lag the corresponding sign-start notification slightly, with the amount of lag depending on the complexity of the sign. Note that:
    1. If the current sign has already appeared at the point when this function is called, an initial sign-appeared notification will be triggered immediately. (This avoids the issue of having Layer-dependent code waiting indefinitely for an event that has already occurred.)
    2. The notification does not get triggered again when the current sign loops round for another iteration. It is only triggered when a sign changes state from 'disappeared' to 'appeared'.
    3. It is only safe to access the Layers of the corresponding sign during the period between this notification and its partner (sign-disappearing). Outside that period, null may be returned instead of the expected Layer.
    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 has appeared.
    
    String signId - the ID of the sign which has appeared.
    Since:
    
    Player 3.3.0
  - notifyOnSignDisappearing
```
void notifyOnSignDisappearing(String jsFunctionName)
```
    Set the Javascript function to be called when a sign which had previously appeared on the screen is just about to disappear from the screen. The timing of this notification will precede the final sign-end notification slightly.
    Note that it is only safe to access the Layers of the corresponding sign during the period between the partner notification (sign-appeared) and this one.
    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 disappearing.
    
    String signId - the ID of the sign which is disappearing.
    Since:
    
    Player 3.3.0
  - notifyOnPlaylistStart
```
void notifyOnPlaylistStart(String jsFunctionName)
```
    Set the Javascript function to be called when a playlist starts.
    Parameters:
    jsFunctionName - may be null (to prevent further notifications) or the name of a Javascript function that takes parameters as follows:
    
    String playlistName - the name of the playlist which is starting.
    
    String playlistID - the ID of the playlist which is starting.
    Since:
    
    Player 3.3.6
  - notifyOnPlaylistEnd
```
void notifyOnPlaylistEnd(String jsFunctionName)
```
    Set the Javascript function to be called when a playlist ends.
    Parameters:
    jsFunctionName - may be null (to prevent further notifications) or the name of a Javascript function that takes parameters as follows:
    
    String playlistName - the name of the playlist which is ending.
    
    String playlistID - the ID of the playlist which is ending.
    Since:
    
    Player 3.3.6
  - 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.
    Since:
    
    Player 3.0.1
  - 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.
    Since:
    
    Player 3.0.1
  - 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.
    Since:
    
    Player 3.0.1
  - 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.
    Since:
    
    Player 3.0.1
  - 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.
    Since:
    
    Player 3.2.1
  - 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.
    Since:
    
    Player 3.2.1
  - notifyOnTextInput
```
void notifyOnTextInput(String terminators,
                       String jsFunctionName)
```
    Set the Javascript function to be called when text input is received from an external source, such as a keyboard or barcode scanner. The incoming text will be split into 'phrases' according to the termination characters specified, and the Javascript function will be called for each phrase detected (i.e. each time a terminator character is received).
    Parameters:
    
    terminators - a string where each character can mark the end of a phrase in the incoming text. For example, if a bar code scanner sends a newline at the end of each code, pass in "\n".
    jsFunctionName - may be null (to prevent further notifications) or the name of a Javascript function that takes parameters as follows:
    
    String phrase - a piece of incoming text (including the terminator).
    Since:
    
    Player 3.3.0

Interface SignStixNotify

Function Summary

Function Detail

notifyOnSignStart

notifyOnSignEnd

notifyOnSignAppeared

notifyOnSignDisappearing

notifyOnPlaylistStart

notifyOnPlaylistEnd

notifyOnVideoStart

notifyOnVideoEnd

notifyOnLayerTouched

notifyOnTimeout

notifyOnCarouselSelection

notifyOnCustomCommand

notifyOnTextInput