Documentation menu
On this page

The bridge exposes a semantic catalog of modulation-capable Grid packages through search_grid_modulators. The catalog is built from Bitwig's current package registry at request time; unavailable packages are never advertised or inserted. Any persisted or decoded inventory is a historical reference snapshot, not current live acceptance. The response from the running selected Bitwig installation is authoritative.

Workflow

  1. Call get_grid_capabilities and confirm the selected runtime reports graph_available: true and the required catalog/insertion/parameter/ connection/revision capabilities.
  2. Call search_grid_modulators with an empty query or a category/name query.
  3. Read get_grid_graph immediately before each mutation and retain its graph ID and exact 64-hex native revision.
  4. Insert a returned package_id with grid_insert_modulator, carrying that expected_revision and confirm: true (or explicitly cooperative authorization).
  5. Re-read get_grid_graph and use its exact native instance_id values.
  6. Tune the inserted module with grid_set_modulator_parameter, using the native range or options returned by the live graph and the fresh graph revision.
  7. Connect its exact output port to a Grid input with grid_connect_modulator, again guarding the current revision.
  8. Re-read get_grid_graph and verify the connection and parameter values.

Insertion does not auto-connect a module: leaving a new modulator unconnected preserves existing routing. Coordinates are bounded to -4096..4096. Match exact parameter IDs and enum backing values, not display-label indexes.

The repaired private bindings target Bitwig 6.1.1 with public API 25. A graph revision is checked at native submission; a stale revision rejects the edit. The MCP grid_resolve_parameter_value read resolves an exact display value through the current parameter definition before a separate guarded set. It requires the current graph revision and does not mutate the parameter.

Catalog roles

Category Use Representative packages
envelope Gate- or phase-driven amplitude/control motion AD, AR, ADSR, Segments
lfo Periodic or sample-and-hold motion LFO, S/H LFO, Wavetable LFO
periodic Clocked curve sources Curves, Slopes
follower Audio-derived control signals Follower, Follower RF
sequencer Stepped and register-based motion Steps, Scale Steps, Step Access, Shift Register
random Random or sampled control signals Chance, Dice, Probabilities, Sample / Hold, Noise
timing Clock, gate, and transport synchronization Clock, Clock Divide, Gate Length, Gate Repeat, Transport
note Note, key, velocity, and expression sources Key On, Note In, Pressure In, Timbre In, Velocity In
external Audio, CV, MIDI, hardware, and host inputs Audio In, Audio Sidechain, CC In, CV In, HW In
utility Stable values and modulation range helpers Constant, Value, Value Scaler
output Expose a Grid signal as a Poly Grid modulation source Modulator Out

A historical decoded reference contained 50 semantic modulation-capable entries. That count is not a current capability assertion and can vary by Bitwig installation/version. Use search_grid_modulators for the live catalog.

Parameter writes use Bitwig's native base-value channel, not the transient modulation/gesture channel. Numeric values may be signed when the live range allows them; integer controls require whole-number option values.

Tuning patterns

  • LFO: choose TIMEBASE, WAVE, BIPOLAR, and RETRIGGER; use RATE_IN when another clock should control phase.
  • ADSR / AR / AD: connect a gate to GATE_IN, then use ATTACK, DECAY, SUSTAIN, and RELEASE from the live parameter metadata.
  • Steps: set STEPS, choose BIPOLAR, and use INTERPOLATION or DEVICE_PHASE only when the graph needs those behaviors.
  • Follower: connect audio to IN, then tune attack/decay or response time before routing OUT into a control input.
  • Modulator Out: connect a control signal to IN; this is a sink and has no output port to route onward.

These names are tuning examples, not substitutes for the live parameter record. Use its native range or actual enum backing value, resolve a display label with grid_resolve_parameter_value when useful, then perform a separate revision-guarded write and read back the value/display.

Use native Grid module connections for module-to-module modulation. The semantic modulator connection command only accepts a source whose package is in the live modulator catalog; generic grid_connect_modules remains available for other graph topology work. A topology read-back does not prove audible sound quality.

Search docs

All words must match. Enter opens the first result.

Type a tool, argument, or guard to begin.