Blackmagicdesign HyperDeck Installation And Operation Manual page 72

Getting help
The "help" or "?" commands return human readable help text describing all available commands and
parameters:
help↵
Or:
?↵
The server will respond with a list of all supported commands:
201 help:↵
{Help Text}↵
{Help Text}↵
↵
Switching to preview mode
The "preview" command instructs the deck to switch between preview mode and output mode:
preview: enable: {"true", "false"}↵
Playback will be stopped when the deck is switched to preview mode. Capturing will be stopped when the
deck is switched to output mode.
Controlling device playback
The "play" command instructs the deck to start playing:
play↵
The play command accepts a number of parameters which may be used together in most combinations.
By default, the deck will play all remaining clips on the timeline then stop.
The "single clip" parameter may be used to override this behaviour:
play: single clip: {"true", "false"}↵
By default, the deck will play at normal (100%) speed. An alternate speed may be specified in percentage
between -1600 and 1600:
play: speed: {% normal speed}↵
By default, the deck will stop playing when it reaches to the end of the timeline. The "loop" parameter may
be used to override this behaviour:
play: loop: {"true", "false"}↵
The "playrange" command instructs the deck to play all the clips. To override this behaviour and select a
particular clip:
playrange set: clip id: {Clip ID}↵
To only play a certain timecode range:
playrange set: in: {in timecode} out: {out timecode}↵
To clear a set playrange and return to the default value:
playrange clear↵
The "play on startup command" instructs the deck on what action to take on startup. By default, the deck
will not play. Use the "enable" command to start playback after each power up.
play on startup: enable {"true", "false"}↵
By default, the unit will play back all clips on startup. Use the "single clip" command to override.
play on startup: single clip: {"true", "false"}↵
Stopping deck operation
The "stop" command instructs the deck to stop the current playback or capture:
stop↵
Developer Information 72