Blackmagicdesign HyperDeck Installation And Operation Manual page 74

Retrieving device information
The "device info" command returns information about the connected deck device:
device info↵
The server will respond with:
204 device info:↵
protocol version: {Version}↵
model: {Model Name}↵
unique id: {unique alphanumeric identifier}↵
↵
Retrieving slot information
The "slot info" command returns information about a slot. Without parameters, the command returns
information for the currently selected slot:
slot info↵
If a slot id is specified, that slot will be queried:
slot info: slot id: {Slot ID}↵
The server will respond with slot specific information:
202 slot info:↵
slot id: {Slot ID}↵
status: {"empty", "mounting", "error", "mounted"}↵
volume name: {Volume name}↵
recording time: {recording time available in seconds}↵
video format: {disk's default video format}↵
↵
Asynchronous slot information change notification is disabled by default and may be configured with
the "notify" command. When enabled, changes in slot state will generate a "502 slot info:" asynchronous
message with the same parameters as the "202 slot info:" message.
Retrieving clip information
The "disk list" command returns the information for each playable clip on a given disk. Without parameters,
the command returns information for the current active disk:
disk list↵
If a slot id is specified, the disk in that slot will be queried:
disk list: slot id: {Slot ID}↵
The server responds with the list of all playable clips on the disk in the format of: Index, name, formats, and
duration in timecode:
206 disk list:↵
slot id: {Slot ID}↵
{clip index}: {name} {file format} {video format} {Duration
timecode}↵
{clip index}: {name} {file format} {video format} {Duration
timecode}↵
...
↵
Note that the clip index starts from 1.
Retrieving clip count
The "clips count" command returns the number of clips on the current timeline:
clips count ↵
The server responds with the number of clips:
214 clips count: ↵
clip count: {Count}↵
Developer Information 74