describe
Read-onlyIdempotent
Inspect any Ableton Live object to reveal its class, properties, children, and permitted methods. For devices, optionally get full parameter details.
Instructions
Introspect any Live object: class, properties, children, and methods.
The route to the dynamic surface: what a loaded plug-in actually exposes, which
no catalog can know in advance because it is decided at runtime and, for
third-party plug-ins, by what the user picked up in Configure mode.
Returns:
Dictionary with the object class, its properties, its child collections, the
methods the allowlist permits, and the parameter survey where asked for.
Note:
Prefer this over lom_describe for a device, and prefer lom_describe for
anything else. The difference is ``with_parameters``: lom_describe reports a
device's parameters as a count, and a count is what a Live ``Vector`` that
refuses ``len()`` fails to give, so a plug-in with parameters can be reported
as having none. Measured against Live 12.4.5. When that happens this tool
falls back to probing parameter indices, reports the names it found, and says
which of the two answers you are looking at.
Methods are never callable through a path. Take the name from here and invoke
it through lom_call, which accepts only names on the Remote Script's own
allowlist. For a device parameter, set it with set_parameter rather than
writing the path by hand.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | LOM path to the object to inspect, e.g. 'song', 'song.tracks[0]', 'song.tracks[0].devices[1]'. Path shapes are listed in the live://catalog resource. | |
| depth | No | How far to descend into child collections. Deep descents over a whole set can be slow and the cost is unmeasured, so raise this deliberately rather than by default. | |
| with_parameters | No | For a device path, survey every parameter with its name, value, min, max, quantized steps and display unit, instead of reporting the parameters child as a bare count. This is also what diagnoses an unconfigured third-party plug-in. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||