Create companion surface
create_companion_surfaceAutomatically create a companion control surface for a TouchDesigner node: infer usable parameters, bind custom controls, and add faders, cue buttons, and a preflight report.
Instructions
Build a companion performance surface for an existing node/COMP: infer useful primitive parameters, add bound custom parameters, create a playable fader/cue panel, and optionally append a read-only preflight report. Use after generating a component that needs a human-facing control surface without hand-wiring every parameter.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"source_path": "<source_path>"
},
"name": "create_companion_surface"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bind | No | Bind generated custom parameters back to source_path parameters. | |
| name | No | Name of the playable panel container to build. | companion_surface |
| page | No | Custom-parameter page added by the auto UI pass. | Companion |
| exclude | No | Source parameter names to skip. | |
| comp_path | No | COMP that receives the custom parameters and panel. Defaults to source_path. | |
| parameters | No | Only expose these source parameter names. Omit to infer primitive controls. | |
| target_fps | No | Frame-rate target for preflight. | |
| cue_buttons | No | Optional cue buttons to add to the playable surface. | |
| source_path | Yes | Node or COMP whose useful parameters should be surfaced. | |
| max_controls | No | Maximum inferred controls when parameters is omitted. | |
| include_faders | No | Build a playable fader/toggle surface for numeric inferred controls. | |
| include_preflight | No | Append a read-only show_preflight_report result for the companion COMP. |