
Protocol Commands
Command
Command Description
help
Provides help text on all commands and parameters
commands
return commands in XML format
device info
return device information
disk list
query clip list on active disk
disk list: slot id: {n}
query clip list on disk in slot {n}
quit
disconnect ethernet control
ping
check device is responding
preview: enable: {true/false}
switch to preview or output
play
play from current timecode
play: speed: {-5000 to 5000}
play at specific speed
play: loop: {true/false}
play in loops or stop-at-end
play: single clip: {true/false}
play current clip or all clips
playrange
query play range setting
playrange set: clip id: {n}
set play range to play clip {n} only
playrange set: clip id: {n} count: {m}
set play range to {m} clips starting from clip {n}
playrange set: in: {inT} out: {outT}
set play range to play between:
- timecode {inT} and timecode {outT}
playrange set: timeline in:
{in} timeline out: {out}
set play range in units of frames between:
- timeline position {in} and position {out}
playrange clear
clear/reset play range setting
play on startup
query unit play on startup state
play on startup: enable: {true/false}
enable or disable play on startup
play on startup: single clip: {true/false}
play single clip or all clips on startup
play option
query play option
play option: stop mode:
{lastframe/nextclip/black}
set output frame when playback stops
record
record from current input
record: name: {name}
record named clip
record spill
spill current recording to next slot
record spill: slot id: {n}
spill current recording to specified slot use current slot id to spill
to same slot
stop
stop playback or recording
clips count
query number of clips on timeline
clips get
query all timeline clips
clips get: clip id: {n}
query a timeline clip info
clips get: clip id: {n} count: {m}
query m clips starting from n
73