Instruction manual

Developer Information

Command Combinations

You can combine the parameters into a single command, for example:

play: speed: 200 loop: true single clip: true

Or for configuration:

configuration: video input: SDI audio input: XLR

Or to switch to the second disk, but only play NTSC clips:

slot select: slot id: 2 video format: NTSC

Using XML

While you can use the Terminal to talk to HyperDeck, if you are writing software you can use XML to confirm

the existence of a specific command based on the firmware of the HyperDeck you are communicating

with. This helps your software user interface adjust to the capabilities of the specific HyperDeck model

and software version.

Protocol Details

Connection

The HyperDeck Ethernet server listens on TCP port 9993.

Basic syntax

The HyperDeck protocol is a line oriented text protocol. Lines from the the

server will be separated by an ascii CR LF sequence. Messages from the client

may be separated by LF or CR LF.

New lines are represented in this document as a "↵" symbol.

Command syntax

Command parameters are usually optional. A command with no parameters

is terminated with a new line:

{Command name}↵

If parameters are specified, the command name is followed by a colon, then

pairs of parameter names and values. Each parameter name is terminated

with a colon character:

{Command name}: {Parameter}: {Value} {Parameter}: {Value} ...↵