Multiline commands:
slate clips↵
reel: {n}
scene id: {id}
shot type: {WS/MS/BCU/MCU/ECU/none}
take: {n}
take scenario: {PU/VFX/SER/none}
take auto inc: {true/false}
good take: {true/false}
environment: {interior/exterior}
day night: {day/night}
slate project:↵
project name: {name}
camera: {index}
director: {name}
camera operator: {name}
slate lens:↵
lens type: {type}
iris: {type}
focal length: {length}
distance: {distance}
filter: {filter}
Command Combinations
You can combine the parameters into a single command, for example:
play: speed: 200 loop: true single clip: true
Or for configuration:
configuration: video input: SDI audio input: XLR
Or to switch to the second disk, but only play NTSC clips:
slot select: slot id: 2 video format: NTSC
Protocol Details
Connection
The HyperDeck Ethernet server listens on TCP port 9993.
Basic syntax
The HyperDeck protocol is a line oriented text protocol. Lines from the server will be separated by an ascii
CR LF sequence. Messages from the client may be separated by LF or CR LF.
New lines are represented in this document as a "↵" symbol.
Command Description
set slate clips information:
slate reel number, where {n} is in [1, 999]
slate scene id value, where {id} is a string
slate shot type
slate take number, where {n} is in [1, 99]
slate take scenario
slate take auto increment
slate good take
slate environment
slate day or night
set slate project information:
project name (can be empty, supports UTF-8)
set camera index e.g. A
director (can be empty, supports UTF-8)
camera operator (can be empty, supports UTF-8)
set lens information:
lens type (can be empty, supports UTF-8)
camera iris (can be empty, supports UTF-8)
focal length (can be empty, supports UTF-8)
lens distance (can be empty, supports UTF-8)
lens filter (can be empty, supports UTF-8)
Developer Information
466