Instruction manual

Developer Information
55
Blackmagic HyperDeck Ethernet Protocol
Version 1.3
The Blackmagic HyperDeck Ethernet Protocol is a text based protocol accessed by connecting to TCP
port 9993 on a HyperDeck Studio or HyperDeck Studio Pro. If you are a software developer you can
use the protocol to construct devices that integrate with our products. Here at Blackmagic Design our
approach is to open up our protocols and we eagerly look forward to seeing what you come up with!
Protocol Commands
Developer Information
Command Command Description
help or ? Provides help text with all commands and parameters.
remote Queries the state of HyperDeck’s remote control mode.
remote: enable: true Enables remote control.
remote: enable: false disables remote control.
remote: override: true Turns remote override on.
remote: override: false Turns remote override off.
quit Disconnects HyperDeck server.
ping Determines HyperDeck server is responding.
preview: enable: true Switches to HyperDeck preview mode.
preview: enable: false Switches to HyperDeck output mode.
play Starts playback all remaining clips on the timeline then stop.
play: speed: {% normal speed} Starts playback at a specified speed in percentage between
-1600 and 1600.
play: loop: true Starts playback in looping fashion.
play: single clip: true Starts playback the remaining of the current clip then stop.
record Starts recording.
record: name: “{clip name}” Starts recording a clip using a specified clip name.
stop Stops playback or recording.
goto: clip id: {clip ID} Goes to start of specific clip.
goto: clip: {“start”, “end”} Goes to start or end of current clip.