Configuring Interrupts

Splash Player can be queried by external processes in order to obtain its status, perform diagnostics or alter its playback. This communication occurs via TCP over the port specified in the Player.exe.config file.

  • Windows (x86) – C:\Program Files\Ayuda Media Systems\Splash Player
  • Windows (x64) – C:\Program Files (x86)\Ayuda Media Systems\Splash Player
  • Linux – /opt/ayuda/splashplayer/lib

The messages are not case sensitive.

Query Description
Shutdown Forces the player to shut down immediately.
PlayerInfo

Retrieves general information about the player.

Note: See also Player and Cloud Extender APIs.
Uptime Returns how long the player has been running.
LastPlayTime Returns the time when the last Design finished playing.
Interrupt

Allows the immediate interrupting of the normal playback, replacing the currently playing Design with something else. The result depends on which interrupt code is sent:

  • 0: Regular playback
  • 1: Play a file from the Interrupt bundle set in the Player configuration
  • 2: Play an empty black screen
  • 112: Display diagnostics information
  • A semicolon “;” is required between the command and code: for example, interrupt;1

Note: See also Player and Cloud Extender APIs.

These queries can be tested with software that can send TCP messages like Packet Sender. If Packet Sender is installed on the player, the host is localhost and the port is by default 7185 unless it has been modified in the player.exe.config.

See Also: