lom_describe
Read-onlyIdempotent
Reflect on any Ableton Live object to discover its class, properties, child collections, and callable methods. Use this to inspect unknown objects and identify available properties to read or modify.
Instructions
Reflect on any LOM object: class, properties, children, callable methods.
The raw reflection, reporting what the object itself declares. Use it to find
the property names on an object the catalog does not cover, then read them with
lom_get and write them with lom_set.
Returns:
Dictionary reporting object class, properties, child collections with their
counts, and the methods the Remote Script allowlist will let you call.
Note:
For a device, prefer ``describe`` with ``with_parameters=True``. This tool
reports a device's ``parameters`` child as a count, and a count is exactly
what a Live ``Vector`` that refuses ``len()`` fails to give, so a plug-in
with parameters can be reported as having none. ``describe`` falls back to
probing indices when that happens and says which answer it is handing back.
The methods listed here are names, not calls: invoke one through lom_call.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | Dotted LOM path to the object to reflect on: 'song', 'song.tracks[0]', 'song.tracks[0].devices[1]'. | |
| depth | No | How many levels of child collection to walk. 1 reports the children of the addressed object only. Raising it multiplies the work and the cost is unmeasured. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||