player.stats.javascript

Interface SignStixStats

SignStixStats

Javascript-to-Player interface for querying playback statistics.

Function Summary

Modifier and Type	Function and Description
String	getCurrentPlaylistInfo() Find information about the currently playing playlist which might be through the manifest or assigned remotely from JSApi.
String	getCurrentSignInfo() Find information about the currently playing sign.
String	getDefaultPlaylistInfo() Find information about the default playing playlist which we received through the manifest.
String	getLastVideoInfo() Find information about the last video played.
String	getVideosByKeywordFromDefaultPlaylist(String keyword) Retrieves videos from the default playlist that match a given keyword.
String	getVideosWithoutKeywordFromDefaultPlaylist(String keyword) Retrieves videos from the default playlist that do not match the given keyword.
String	getWallTime() Retrieves video wall time

Function Detail

getCurrentSignInfo

String getCurrentSignInfo()

Find information about the currently playing sign.

Returns:

a JSON-formatted string containing the attributes:

• signName (string) - the name of the current sign as seen in Director.
• signId (string) - the invariant ID of the current sign.
• startTime (long) - the UTC milliseconds time when the current iteration of the current sign was started.

Since:

Player 2.10.2

getLastVideoInfo

String getLastVideoInfo()

Find information about the last video played. This means either the currently playing video, or the video which most recently stopped playing.

Returns:

a JSON-formatted string containing the attributes:

• started (boolean) - true if at least one video has been started (and therefore this object contains valid data).
• videoName (string) - the name of the last video, or the empty string if no videos have been played.
• videoId (string) - the invariant ID of the last video, or the empty string if no videos have been played.
• startTime (long) - the UTC milliseconds time when the last video started playing, or 0 if no videos have been played.
• endTime (long) - the UTC milliseconds time when the last video stopped playing, or 0 if no videos have been played or the last video is still playing.
• playedDuration (long) - the duration in milliseconds that the last video was playing, or 0 if no videos have been played or the last video is still playing.
• duration (long) - the actual duration of the video from metadata
• isPresentingVideo (boolean) - tells if any video is actually playing, this is sensitive to transitioning between videos
• paused (boolean) - status of the video if it's paused or not

Since:

Player 2.10.2, 3.3.6 adds (duration, isPresentingVideo, paused) renamed (duration to playedDuration)

getCurrentPlaylistInfo

String getCurrentPlaylistInfo()

Find information about the currently playing playlist which might be through the manifest or assigned remotely from JSApi.

Returns:

a JSON-formatted string containing the attributes:

• fileName (string) - the name of the video.
• fileId (string) - the invariant ID of the video without extension.
• friendlyName (string) - the name of the video as seen in Director
• duration (string) - the duration of the video.
• path (string) - the path of the video.
• height (string) - the height of the video.
• width (string) - the width the video.

Since:

Player 3.3.5

getDefaultPlaylistInfo

String getDefaultPlaylistInfo()

Find information about the default playing playlist which we received through the manifest.

Returns:

a JSON-formatted string containing the attributes:

• fileName (string) - the name of the video.
• fileId (string) - the invariant ID of the video without extension.
• friendlyName (string) - the name of the video as seen in Director
• duration (string) - the duration of the video.
• path (string) - the path of the video.
• height (string) - the height of the video.
• width (string) - the width the video.

Since:

Player 3.3.6

getVideosByKeywordFromDefaultPlaylist

String getVideosByKeywordFromDefaultPlaylist(String keyword)

Retrieves videos from the default playlist that match a given keyword. The function searches through the assigned playlist for videos, filtering based on the provided keyword. The resulting videos will be formatted as a JSON string containing relevant attributes such as file details, dimensions, and metadata.

Parameters:

keyword - the text used to filter videos. Videos containing this keyword will be returned.

Returns:

a JSON-formatted string containing the following video attributes:

• fileName (string) - the name of the video file.
• fileId (string) - the unique ID of the video, excluding the extension.
• friendlyName (string) - the display name of the video as seen in the Director interface.
• duration (string) - the total duration of the video.
• path (string) - the file path where the video is stored.
• height (string) - the height of the video in pixels.
• width (string) - the width of the video in pixels.

Since:

Player 3.3.18

getVideosWithoutKeywordFromDefaultPlaylist

String getVideosWithoutKeywordFromDefaultPlaylist(String keyword)

Retrieves videos from the default playlist that do not match the given keyword. The function searches through the assigned playlist for videos, excluding any that contain the provided keyword. The resulting videos will be formatted as a JSON string containing relevant attributes such as file details, dimensions, and metadata.

Parameters:

keyword - keyword the text used to exclude videos. Videos that do not contain this keyword will be returned.

Returns:

a JSON-formatted string containing the following video attributes:

• fileName (string) - the name of the video file.
• fileId (string) - the unique ID of the video, excluding the extension.
• friendlyName (string) - the display name of the video as seen in the Director interface.
• duration (string) - the total duration of the video.
• path (string) - the file path where the video is stored.
• height (string) - the height of the video in pixels.
• width (string) - the width of the video in pixels.

Since:

Player 3.3.18

getWallTime

String getWallTime()

Retrieves video wall time

Returns:

a clock time

Since:

Player 3.3.18