Developer Information; Blackmagic Hyperdeck Ethernet Protocol; Protocol Commands - Blackmagicdesign HyperDeck Installation And Operation Manual

Developer Information

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 HyperDeck Studio models that have a built in Ethernet connection. 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

Command
help or ?
remote
remote: enable: true
remote: enable: false
remote: override: true
remote: override: false
quit
ping
preview: enable: true
preview: enable: false
play
play: speed: {% normal speed}
play: loop: true
play: single clip: true
record
record: name: "{clip name}"
stop
goto: clip id: {clip ID}
goto: clip: {"start", "end"}
goto: timeline: {"start", "end"}
goto: timecode: {timecode}
goto: timecode: {"+", "-"}
{duration in timecode}
commands
notify
notify: transport: true
notify: transport: false
Command Description
Provides help text with all commands and parameters.
Queries the state of HyperDeck's remote control mode.
Enables remote control.
disables remote control.
Turns remote override on.
Turns remote override off.
Disconnects HyperDeck server.
Determines HyperDeck server is responding.
Switches to HyperDeck preview mode.
Switches to HyperDeck output mode.
Starts playback all remaining clips on the timeline then stop.
Starts playback at a specified speed in percentage between
-1600 and 1600.
Starts playback in looping fashion.
Starts playback the remaining of the current clip then stop.
Starts recording.
Starts recording a clip using a specified clip name.
Stops playback or recording.
Goes to start of specific clip.
Goes to start or end of current clip.
Goes to start of first clip or end of last clip.
Goes to specified timecode
Moves forward or back a duration in timecode
Lists all supported commands in an XML format.
Queries the current state of all notifications.
Enables transport notifications.
Disables transport notifications.
Developer Information 44 44