RouteEffect

RouteEffect is a Pro-level action that gives you direct, command-level control of Blackmagic Design VideoHub routers over OSC, letting you connect, disconnect, route signals, set presets, manage locks, and control simulator sessions from a single action entry point in your workflows.

Required Parameters

  • host: OSC destination host/address.
  • port: UDP port (number input, constrained to 0–65535).
  • deviceId: target router/device identifier, inserted into each command path.
  • message: selected RouteEffect command to run.

Commands

Connect

  • Sends routeeffect_connect to the selected device.
  • No per-command arguments are used.
  • Use when you need to establish a device/session connection only.

Disconnect

  • Sends routeeffect_disconnect to the selected device.
  • No per-command arguments are used.
  • For pure session teardown with no payload extras.

Route

  • Sends an indexed route command using output and input values.
  • Supports integer values for both fields; empty/blank values resolve to 0.
  • Uses 0-based indexing for VideoHub output/input parameters.

Preset

  • Sends routeeffect_preset with presetName.
  • Supports string preset names; blank preset names are sent as empty text.
  • Route/lock index fields are not applicable.

Model Preset

  • Sends routeeffect_model_preset with presetName.
  • Supports string preset names; blank preset names are sent as empty text.
  • Route/lock index fields are not applicable.

Global Preset

  • Sends routeeffect_global_preset with presetName.
  • Supports string preset names; blank preset names are sent as empty text.
  • Route/lock index fields are not applicable.

Virtual Output

  • Sends routeeffect_virtual_output using virtualOutputName and sourceIndex.
  • Supports string output name plus integer source index; empty index resolves to 0.
  • sourceIndex is 0-based; non-index fields like lock/output-index are not used here.

Lock

  • Sends routeeffect_lock with outputIndex.
  • Supports integer output index; empty index resolves to 0.
  • Uses 0-based index semantics; preset and route fields are not used.

Unlock

  • Sends routeeffect_unlock with outputIndex.
  • Supports integer output index; empty index resolves to 0.
  • Uses 0-based index semantics; preset and route fields are not used.

Force Unlock

  • Sends routeeffect_force_unlock with outputIndex.
  • Supports integer output index; empty index resolves to 0.
  • Uses 0-based index semantics; preset and route fields are not used.

Simulator Connect

  • Sends routeeffect_simulator_connect.
  • No per-command arguments are used.
  • Intended for simulator namespace connectivity, not live routing commands.

Simulator Disconnect

  • Sends routeeffect_simulator_disconnect.
  • No per-command arguments are used.
  • Intended for simulator namespace teardown, not live routing commands.

results matching ""

    No results matching ""