Loading ...
Loading ...
Loading ...
Developer Information
Blackmagic HyperDeck Ethernet Protocol
The Blackmagic HyperDeck Ethernet Protocol is a text based protocol accessed by connecting
to TCP port 9993 on HyperDeck 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 Command Description
help or ? Provides help text on all commands and parameters
commands return commands in XML format
device info return device information
disk list query clip list on active disk
disk list: slot id: {n} query clip list on disk in slot {n}
quit disconnect ethernet control
ping check device is responding
preview: enable: {true/false} switch to preview or output
play play from current timecode
play: speed: {-5000 to 5000} play at specific speed
play: loop: {true/false} play in loops or stop-at-end
play: single clip: {true/false} play current clip or all clips
playrange query playrange setting
playrange set: clip id: {n} set play range to play clip {n} only
playrange set: clip id: {n} count: {m} set play range to {m} clips starting from clip {n}
playrange set: in: {inT} out: {outT}
set play range to play between:
- timecode {inT} andtimecode {outT}
playrange set: timeline in: {in} timeline out:
{out}
set play range in units of frames between:
- timeline position {in} and position {out} clear/reset play
rangesetting
playrange clear clear/reset play range setting
play on startup query unit play on startup state
play on startup: enable: {true/false} enable or disable play on startup
play on startup: single clip: {true/false} play single clip or all clips on startup
play option query play options
play option: stop mode:
{lastframe/nextframe/black}
set output frame when playback stops
record record from current input
record: name: {name} record named clip
174Developer Information
Loading ...
Loading ...
Loading ...