Ultimatte

Ultimatte is a composed action that sends Blackmagic Design Ultimatte commands over Ethernet via TCP, helping you control live keyer parameters, triggers, file operations, GPI events, frame buffer settings, and camera-control settings from a single action configuration. Designed for Pro access-level users, it builds either catalog-backed Ultimatte control commands or a raw protocol block, then sends them with LF line endings and a terminating blank line.

Required Parameters

• Host (required): device hostname or IP address.
• Port (required): TCP port, constrained to 1...65535.
• Use Raw Command (boolean): toggles raw block mode.
• Raw Command (required only when raw mode is enabled): free-form multiline protocol text.
• Command (required only when raw mode is disabled): selects a catalog command.
• Command-specific parameters from the selected catalog command:
  • Number/offset controls require a Value integer within that control’s constraint.
  • Toggles require a boolean Value (on/off, true/false, 1/0, yes/no, etc.).
  • Text/choice controls require the chosen text value.
  • Function commands have no extra payload value.
  • File/GPI/Frame Buffer/Camera commands expose their specific fields below.

Commands

control.number.<identifier>

• Sends a numeric control set command (CONTROL: <Control Name>: <value>).
• Required input: value integer, with per-control constraints (commonly 0...10000, with exceptions such as 0...3, 0...6, -1500...1500, 1...120, etc.).
• Unsupported combinations: use raw mode instead to bypass catalog restrictions for unsupported or custom protocol lines.
• Optional notes: some controls carry device/model availability notes (for example not available on HD or HD Mini variants).

control.offset.<identifier>

• Sends an offset variant of a numeric control (CONTROL: Offset <Control Name>: <value>).
• Required input: same value schema and constraints as above.
• Optional notes: constraint behavior mirrors the matching numeric control’s definition.

control.toggle.<identifier>

• Sends boolean toggles using protocol values on / off (CONTROL: <Control Name>: on|off).
• Required input: value boolean.
• Optional notes: many toggles are device-dependent; some are flagged for HD/HD Mini compatibility in the catalog.

control.choice.<identifier>

• Sends picker-based control commands (CONTROL: <Control Name>: <value>).
• Required input: value from the control’s allowed options.
• Optional notes: examples include mix mode, backing color, monitor/video/source settings, and filter mode.

control.text.<identifier>

• Sends text-based control commands (CONTROL: <Control Name>: <value>).
• Required input: free text value.

control.function.<identifier>

• Executes function-style control commands (CONTROL: <Control Name>: Yes).
• No per-command value field.

file.load

• Loads a file by filename.
• Required input: name (text).

file.save

• Saves a file by filename.
• Required input: name (text).

file.delete

• Deletes a file by filename.
• Required input: name (text).

file.rename

• Renames a file.
• Required input: name (current filename), newName (new filename).

gpi.insert

• Inserts a GPI event.
• Required input: gpiID (integer, typically min 1), filename (text), atIndex (integer, min -1).
• Optional usage notes: atIndex = -1 appends to end.
• Optional constraints: uses stepper-style integer input.

gpi.remove

• Removes a GPI event.
• Required input: gpiID (integer, min 1), eventIndex (integer, min 0).
• Notes: eventIndex = 0 deletes all events.

gpi.index

• Sets the current GPI event index.
• Required input: gpiID (integer, min 1), eventIndex (integer, min 0).

frameBuffer.assignEnable

• Assigns and enables a frame buffer in one command.
• Required input: frameBuffer (picker: BG 1, BG 2, Layer 1, Layer 2, Garbage Matte, Holdout Matte) and imageIndex (integer, min 1, stepper input).

frameBuffer.enable

• Enables/disables a frame buffer.
• Required input: frameBuffer (picker values above), enabled (on/off boolean).
• Notes: disable example caveat appears in action notes in code.

cameraControl.ids

• Sets camera-control IDs.
• Required input: ccuCameraID (integer, min 0), cecCameraID (integer, min 0).
• Notes: command is catalog-noted as only available on Ultimatte 12 HD Mini.