Single line 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} ...↵
Multiline command syntax
The HyperDeck protocol also supports an equivalent multiline syntax where each parameter-value pair is
entered on a new line. E.g.
{Command name}:↵
{Parameter}: {Value}↵
{Parameter}: {Value}↵
↵
Response syntax
Simple responses from the server consist of a three digit response code and descriptive text terminated by a
new line:
{Response code} {Response text}↵
If a response carries parameters, the response text is terminated with a colon, and parameter name and
value pairs follow on subsequent lines until a blank line is returned:
{Response code} {Response text}:↵
{Parameter}: {Value}↵
{Parameter}: {Value}↵
...
↵
Successful response codes
A simple acknowledgement of a command is indicated with a response code of 200:
200 ok↵
Other successful responses carry parameters and are indicated with response codes in the range of 201
to 299.
Developer Information
467