BlackMagic Design are an established brand and have been around for many years, mainly producing high end broadcast equipment, from vision mixers, recorders, converters etc. This post explains how to get a Blackmagic HyperDeck recorder to accept remote control commands over TCP/IP or Telnet from a control system such as Q-SYS, and lists the HyperDeck commands we use most on real projects.
With more and more corporate clients wanting a more professional result during video conferencing and video production, we have found ourselves supplying more and more ‘BMD’ equipment. Especially with the advent of live streaming during the Covid19 pandemic.
One cause of confusion, is often how you integrate this sort of technology with a control system, such as Crestron, Aten, Q-SYS or Control4.
On a recent project integrating a BlackMagic Design Hyperdeck HD, we ran into such confusion, with the unit just not accepting control commands from a Q-SYS Core Nano.
It turns out the solution wasn’t quite as difficult as it could have been.
Running the following command instructed the unit to accept other remote commands (bearing in mind it’s port 9993 this needs to be ran on):
- remote: enable: true\x0D\x0A\x0D
Once this command has been accepted, the full suite of commands from the API can be ran, such as:
- Play – play\x0D\x0A\x0D
- Stop – stop\x0D\x0A\x0D
- Record – record\x0D\x0A\x0D
So that’s it, quite simple really, but this may end up helping others with the same issues.
HyperDeck Telnet Commands for Control Systems
Once remote control is enabled, these are the HyperDeck Ethernet Protocol commands we use most when programming a Q-SYS core or similar control processor. Every command is sent as plain text over TCP port 9993 and must end with a carriage return and line feed (\r\n).
- remote: enable: true – lets the HyperDeck accept transport commands over the network
- play – starts playback of the current clip
- stop – stops playback or recording
- record – starts recording to the active media
- goto: clip id: 1 – jumps to a specific clip, useful for preset buttons on a touch panel
- transport info – returns the current transport status for button feedback
- notify: transport: true – asks the HyperDeck to push status changes to the control system
Test the HyperDeck from a laptop first
Before writing any control code, open a Telnet session from a laptop on the same network with telnet [HyperDeck IP address] 9993. A healthy unit replies straight away with a 500 connection info banner showing the protocol version and model. If nothing comes back, check the IP address in the front panel menu and make sure nothing between the laptop and the HyperDeck is blocking TCP port 9993. Once you can play and stop the deck by hand from Telnet, the same strings will work from the control system.
Why a HyperDeck ignores control commands
The two causes we see most often are exactly what caught us out on this project. First, remote control is disabled on the unit, so it reports status but will not act on transport commands until it receives remote: enable: true or remote is switched on in the setup menu. Second, the control system sends the command without the \r\n line ending, so the HyperDeck sits waiting for the rest of the line. Checking both of these will fix the large majority of HyperDeck integration problems.
Blackmagic Design publishes the full HyperDeck Ethernet Protocol in the manual for each model on the Blackmagic Design support site.
Need a HyperDeck, playback system or room control system integrated into a meeting room, auditorium or production space? Talk to Sysflex AV – our CTS-certified engineers design, install and program AV control systems for businesses across the UK.
Reach Us
Here are our contact details, we would be happy to hear from you.
Sysflex Ltd,
The Nexus,
Darby Close
Cheney Manor
Swindon
SN2 2PN
