Command
iris: {type}
focal length: {length}
distance: {distance}
filter: {filter}
nas add:↵
url: {url}
username: {username}
password: {password}
nas remove:↵
url: {url}
nas select:↵
url: {url}
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 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 Description
camera iris (can be empty, supports UTF-8)
focal length (can be empty, supports UTF-8)
lens distance (can be empty, supports UTF-8)
lens filter (can be empty, supports UTF-8)
add a NAS share, to be selected by the GUI or the nas select
command
URL of the NAS share e.g. smb://server.local/path/to/share
username to connect as (can be empty, defaults to guest)
password to connect with (can be empty)
remove a previously added NAS share
URL of the NAS share e.g. smb://server.local/path/to/share
mount a previously added NAS share asynchronously.
URL of the NAS share e.g. smb://server.local/path/to/share
Use "slot info" or "notify: slot: true" to determine when share is
mounted."
Informacje dla deweloperów
1571