Developer Information; Blackmagic Hyperdeck Ethernet Protocol; Protocol Commands - Blackmagic Design HyperDeck Manuel D'utilisation Et D'installation

Developer Information

Blackmagic HyperDeck Ethernet Protocol

Version 1.8
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 ?
commands
device info
disk list
disk list: slot id: n
quit
ping
preview: enable: true/false
play
play: speed: -1600 to 1600
play: loop: true/false
play: single clip: true/false
playrange set: clip id: n
playrange set: in: inT out: outT
playrange clear
record
record: name: name
stop
clips count
clips get
clips get: clip id: n
clips get: clip id: n count: m
clips add: name: name
clips clear
transport info
slot info
Command Description
Provides help text on all commands and parameters
return commands in XML format
return device information
query clip list on active disk
query clip list on disk in slot n
disconnect ethernet control
check device is responding
switch to preview or output
play from current timecode
play at specific speed
play in loops or stop-at-end
play current clip or all clips
set play range to play clip n only
set play range to play between:
- timecode inT and timecode outT
clear/reset play range setting
record from current input
record named clip
stop playback or recording
query number of clips on timeline
query all timeline clips
query a timeline clip info
query m clips starting from n
append a clip to timeline
empty timeline clip list
query current activity
query active slot
Developer Information 196