Checking connection status
The "ping" command has no function other than to determine if the server is responding:
ping↵
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 -5000 and 5000:
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 returns the current playrange setting if any:
playrange↵
To override this behaviour and select a particular clip:
playrange set: clip id: {Clip ID}↵
To only play a certain number of clips starting at a particular clip:
playrange set: clip id: {n} count: {m}↵
To only play a certain timecode range:
playrange set: in: {in timecode} out: {out timecode}↵
To play a certain timeline range:
playrange set: timeline in: {in} timeline out: {out}↵
To clear a set playrange and return to the default value:
playrange clear↵
Developer Information
1042