External TCP/UDP Control Specifications

Implementation: Photon v 11

UDP/TCP Default Port

Unless overridden, Photon’s and Xenon’s default TCP and UDP control port is: 55503

The TCP server will reply with the received commands to each connected client.

UDP commands will be replied to as broadcasts on the main network interface using the same UDP port as configured for the reception.

UDP/TCP Network Syntax

<vyv> [OpCode] [parameters] </vyv>

Network Control

Command	Opcode	Parameters	Types	Ranges
TimeLine Speed	SET_TIME_SPEED	Speed	[float32]	[-5 ; 5]
TimeLine Seek	SET_TIME_SEEK	Frame #	[unsigned int32]	[0 ; N]
TimeLine FreeRun	SET_TIME_FR	FreeRun on/off	[unsigned int32]	[0 ; 1]
TimeLine LTC	SET_TIME_LTC	Time-Code on/off	[unsigned int32]	[0 ; 1]
Special Codes	90BC9E48_6D84_4F8C_AA23_72E3379AC71C	special_code	[unsigned int]	[0 ; N]
Execute Cue ID	CUE_EXEC_ID	Cue # by ID	[unsigned int32]	[0 ; N]
Query system state	GET_SYSTEM_STATE	No parameters
Delete Media	REMOVE_MEDIA	"media_name.extension"

Special Codes

Code Control	ID
Normal Mode	0
Sleep Mode	1
Fire Alarm	2
Fire Alarm 2	3
Reboot Photon	4
Reboot Server	5
Quit Photon	6
Shutdown Server	7
Enable Offline Mode	8
Disable Offline Mode	9
Show/Hide UI	10

Syntax Rules

• Capitalization must be respected.

• Spaces between Tag, Opcode and Parameters are mandatory.

Examples

Cue trigger via ID number

<vyv> CUE_EXEC_ID 0 </vyv>

Set Photon in Sleep Mode

<vyv> 90BC9E48_6D84_4F8C_AA23_72E3379AC71C 1 </vyv>

Get Server State

<vyv> GET_SYSTEM_STATE </vyv>

When querying the system state using the above command, Photon will reply using its internal XML-like syntax. Below is an example of the system-state reply syntax:

<computer_data> <host_name> Photon-01 </host_name> <cpu_usage> 9.30233 </cpu_usage> <memory_usage> 23 </memory_usage> <process_memory_usage> 900344 </process_memory_usage> <vram_usage> 19.7842 </vram_usage> <vrec_usage> 0.772476 </vrec_usage> <disk_usage> 0.950111 </disk_usage> <disk_bw> 0.08192 </disk_bw> <gpu_usage> 11 </gpu_usage> <gpu_temperature> 77 </gpu_temperature> <gsync> 0 0 </gsync> <net> 0 </net> <fps> 60.0375 </fps> <task> -1 </task> <status> 3 </status> <version> 11.1.10532 </version> </computer_data>

• Hostname: name of the server

• CPU usage: total percentage of CPU being used

• Memory usage: total percentage of the system memory currently in use

• Process Memory Usage: Memory in use by active process

• VRAM usage: total percentage of GPU memory currently in use

• VRec Usage: Video recycler usage

• Disk usage: Total ratio of disk usage currently in use (1 means 100%)

• Disk Bw: Disk reading speed in megabytes per second

• GPU Usage: GPU usage in %

• GPU Temperature: The current temperature of the GPU is expressed in Celsius

• GSync: G Sync active/G Sync External refresh rate

• Net: Photon Network usage in %

• FPS: System’s Current frame rate

• Task: Current task progress in % (import and conversion)

  • -1: Inactive

• Status: User Interface and openGL context status (Status can be combined ex: 3 is UI(1) + NFS(2))

  • 0 - OK: Everything is fine and no UI is shown

  • 1- UI: The user interface is displayed

  • 2- NFS: Not full screen, Photon GL Context is not covering the entire span of the outputs

  • 4- NVS: Not Vertical Sync

  • 8- RAID: Raid Problem

  • 16- Triple Buffering: Restart Required due to Triple Buffering Off

• Version: Current running system version

Remove Media

Original File

<vyv> REMOVE_MEDIA "test_video.mp4" </vyv>

VCI

<vyv> REMOVE_MEDIA "test_video.vci" </vyv>

REMOVE_MEDIA command allows to delete medias from the Media Library (including medias in playlist and actual files in content folder)

Please note the double-quotes (") in the command are required.

NB: it implements explicit removal with a complete filename. For example if you remove "file.vci" it will remove all related vci/vcd/aci/acd files but not the original media, you will need to explicitly call the REMOVE_MEDIA command with "file.mp4" to get rid of the original.