User's Manual

Developer Information
Ultimatte sends information in blocks which each have an identifying header in all caps,
followed by a full colon. A block spans multiple lines and is terminated by a blank line. Each line
in the protocol is terminated by a newline character.
Upon connection, Ultimatte sends a complete dump of the state of the device. After the initial
status dump, status updates are sent every time Ultimatte’s status changes.
To be resilient to future protocol changes, clients should ignore blocks they do not recognize,
up to the trailing blank line. Within existing blocks, clients should ignore lines they do not recognize.
Protocol Preamble
The first block sent by Ultimatte is always the protocol preamble:
PROTOCOL PREAMBLE:
↵
Version: 1.2
↵
↵
The version field indicates the protocol version. When the protocol is changed in a compatible
way, the minor version number will be updated. If incompatible changes are made, the major
version number will be updated.
Device Information
The next block contains general information about the connected Ultimatte device.
DEVICE:
↵
Model Name: Blackmagic Ultimatte 12
↵
Friendly Name: Ultimatte 12
↵
Software Version: 1.0
↵
Video Format: 1080p60
↵
Reference Source: Foreground
↵
BG In: Locked
↵
BG MATTE In: Locked
↵
G MATTE In: Locked
↵
FG In: Locked
↵
MONITOR In: Locked
↵
H MATTE In: Locked
↵
LAYER In: Locked
↵
LAYER MATTE In: Locked
↵
REF In: Locked
↵
↵
Network Information
NETWORK:
↵
DHCP: Off
↵
IP Ad d r ess: 10.0.0.2
↵
Su b net M as k: 255.255.255.0
↵
Gateway: 10.0.0.1
↵
↵
Initial Status Dump
The next nine blocks provide the control values, control default values, current file, file list
andthe GPI lists.
CONTROL:
↵
Matte Density: 0
↵
Red Density: 0
↵
Green Density: 0
↵
...(Full list in Controls section)
↵
469