Protocol Details - Blackmagicdesign HyperDeck Installation And Operation Manual

Command
notify: slot: true
notify: slot: false
notify: remote: true
notify: remote: false
notify: configuration: true
notify: configuration: false
device info
slot info
slot info: slot id: {slot ID}
clips get
transport info
configuration
configuration: video input:
{"SDI", "HDMI", "component"}
configuration: audio input:
{"embedded", "XLR", "RCA"}
configuration: file format:
{File format}
slot select: video format:
{Video format}
slot select: slot id: {slot ID}
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
Enables slot notifications.
Disables slot notifications.
Enables remote notifications.
Disables remote notifications.
Enables configuration notifications.
Disables configuration notifications.
Provides information about the connected device.
Provides information about the current active slot.
Provides information about a specified slot.
Provides information for each available clip.
Provides information for the state of the transport.
Queries the current configuration.
Configures video input.
Configures audio input.
Configures current file format.
Reloads timeline with all clips of the specified video format.
Switches to the specified slot.
Developer Information 45 45