describe
Explore live Ableton objects at runtime by path to reveal class, properties, children, and methods. Survey device parameters when needed to diagnose unconfigured plug-ins.
Instructions
Introspect any live object: class, properties, children, and methods.
This is 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.
Args:
path: a LOM path, e.g. ``song``, ``song.tracks[0]``,
``song.tracks[0].devices[1]``. Look shapes up in ``ableton://catalog``.
depth: how far to descend. Deep describes over a whole set can be slow
and the cost is unmeasured.
with_parameters: for a device path, survey every parameter (name, value,
min/max, quantized steps, display unit) instead of just the child
counts, and diagnose an unconfigured plug-in rather than returning a
useless one-entry list.
Methods are never callable through a path. Use ``lom_call``, and only names on the
script's own allowlist.
Measured caveat (Live 12.4.5): the parameter survey depends on
``lom_describe`` reporting a ``count`` for the ``parameters`` child, and a
Live ``Vector`` that refuses ``len()`` reports none, so the survey comes back
with zero parameters on a device that has them. 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.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | ||
| depth | No | ||
| with_parameters | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||