player.engine.javascript

Interface SignStixEngine

SignStixEngine

Javascript-to-Player interface with functions for controlling the play engine.

Function Summary

Modifier and Type	Function and Description
void	jumpToFrame(int frameNumber) Jump the signage animation timeline to the argument frame number.
void	jumpToSignInSequence(String signName) Jump to the first sign with the argument name (as seen in Director) in the currently playing sequence.
void	jumpToSignInSequenceById(String signId) Jump to the first with with the argument ID in the currently playing sequence.
void	jumpToVideoAt(int index) Jump the video playback to the start of the video found at the argument index within the current playlist.
void	overlaySignInSequence(String signName, int startDelayMs, boolean useVW) Display the sign identified by the argument signName as an overlay.
void	pauseSignage() Pause the signage timeline.
void	pauseVideo() Pause the video playback.
void	playSound(String url) Play the argument sound to completion, starting as soon as possible.
void	resumeSignage() Resume the signage timeline.
void	resumeVideo() Resume the video.
void	seekVideo(String index, long timeInMs) Seek the given index video to the given time in milli seconds
void	setInteractionOccurred() Inform the engine that some user interaction has occurred.
void	setPlaylistFromVideoFile(String fileRef) Replace the video playlist associated with the current sign with a new playlist containing the argument video file only.
void	setPlaylistFromVideoFiles(String files) Replace the video playlist associated with the current sign with a new playlist containing the argument video files from the actual playlist or the video ID from associated folder.

Function Detail

jumpToSignInSequence

void jumpToSignInSequence(String signName)

Jump to the first sign with the argument name (as seen in Director) in the currently playing sequence.

Note that this function will first cancel any signage or video pause that may be in effect. This is to avoid situations where a new sign appears to be frozen because a pause had happened on the previous sign.

Parameters:

signName - name of the sign to jump to. If no such sign exists in the current sequence, an error will occur.

Since:

Player 2.10.2

jumpToSignInSequenceById

void jumpToSignInSequenceById(String signId)

Jump to the first with with the argument ID in the currently playing sequence.

The ID is an invariant identifier so code which uses it will continue to work even if the name of the target sign is changed. To find the ID of a sign, go to edit the sign in Director, and the ID is shown as part of the URL in the address bar.

Note that this function will first cancel any signage or video pause that may be in effect. This is to avoid situations where a new sign appears to be frozen because a pause had happened on the previous sign.

Parameters:

signId - the ID of the sign to jump to. If no such sign exists in the current sequence, an error will occur.

Since:

Player 3.2.1

jumpToFrame

void jumpToFrame(int frameNumber)

Jump the signage animation timeline to the argument frame number.

Parameters:

frameNumber - starts at 1. An error will occur if the frameNumber is less than 1. If this frame is beyond the final frame of the sign, it will automatically be 'wrapped round' so that it is in the legal range.

Since:

Player 2.10.2

jumpToVideoAt

void jumpToVideoAt(int index)

Jump the video playback to the start of the video found at the argument index within the current playlist. The video will play in the current sign's video box (if any).

Parameters:

index - the index of the desired video within the current playlist, starting at 0. An error will occur if the index is less than 0, or greater-than-or-equal-to the number of videos in the current playlist.

Since:

Player 3.0.0

pauseSignage

void pauseSignage()

Pause the signage timeline. This stops the animations in their current positions. Has no effect if the signage is already paused.

Since:

Player 2.10.2

resumeSignage

void resumeSignage()

Resume the signage timeline. This resumes the animations from their current positions. Has no effect if the signage timeline is not currently paused.

Since:

Player 2.10.2

seekVideo

void seekVideo(String index,
               long timeInMs)

Seek the given index video to the given time in milli seconds

Parameters:

index - empty string can be given if we need to seek to the currently playing video

timeInMs - time in milliseconds to seek to

Since:

Player 3.3.6

pauseVideo

void pauseVideo()

Pause the video playback. Has no effect if the video is already paused.

Since:

Player 2.10.2

resumeVideo

void resumeVideo()

Resume the video. Has no effect if the video is not currently paused.

Since:

Player 2.10.2

playSound

void playSound(String url)

Play the argument sound to completion, starting as soon as possible. Note that if another sound (possibly from a video soundtrack) is already playing, both sounds will be played simultaneously. So this function is best suited to short sounds.

Parameters:

url - a URL where the sound file can be found. Typically MP3.

Since:

Player 2.10.4

setInteractionOccurred

void setInteractionOccurred()

Inform the engine that some user interaction has occurred. For example, if the current sign has an interactivity timeout running, this will cause the timer to restart, as if someone had touched a layer in the sign.

This is intended for use in scenarios where a user is interacting with a connected external device, and the player is required to behave as if it's being interacted with directly.

Since:

Player 3.0.0

setPlaylistFromVideoFile

void setPlaylistFromVideoFile(String fileRef)

Replace the video playlist associated with the current sign with a new playlist containing the argument video file only. The new playlist will start playing from its beginning, as soon as the video has been cued-up.

Parameters:

fileRef - reference to a video file within the associated folder structure.

Since:

Player 3.2.1

setPlaylistFromVideoFiles

void setPlaylistFromVideoFiles(String files)

Replace the video playlist associated with the current sign with a new playlist containing the argument video files from the actual playlist or the video ID from associated folder. The videos from associated folder will only be useful if the screen is not using a cropped slices, but it can be used if the video wall is enabled but using it as a single screen for a seamless behaviour. The new playlist will start playing from its beginning, as soon as the videos has been cued-up.

Parameters:

files - JSON-formatted string containing the attributes:

• fileId - the invariant ID of the video from assigned playlist.
• fileRef - the invariant ID of the video from associated folder.

Since:

Player 3.3.6

overlaySignInSequence

void overlaySignInSequence(String signName,
                           int startDelayMs,
                           boolean useVW)

Display the sign identified by the argument signName as an overlay. The sign will play once to completion, or until it is replaced by another overlay. The sign is assumed to be part of the currently playing sequence.

Parameters:

signName - the name of a sign within the current sequence.

startDelayMs - the number of milliseconds from now when the overlay should start.

useVW - true to use video-wall geometry for the overlay sign, false to use standard single-panel geometry. When this is true and this device is in a master/slave synchronisation group, the other devices in the group will be notified of the overlay and will endeavour to display it as well (using video-wall geometry), providing they also have the same sign in their currently playing sequence.

Since:

Player 3.2.1