begin_edit
Initiate an incremental editing session for control surface layouts. Seed from a sample, device file, or live device layout to begin precise modifications.
Instructions
Start (or restart) the working layout buffer for incremental editing.
Then use add_control / insert_example / update_control / move_control / etc. to edit surgically, preview_buffer to see it, and push_buffer to send it live — without ever re-emitting the whole layout.
The app-authored wiring flow: the user arranges controls in the phone's Layout
Editor and saves; begin_edit(from_device_file="my-layout.json") pulls that
file here (list_device_layouts shows the filenames), then probe_service +
autowire_buffer bind its values, you wire the remaining actions/triggers it
reports, lint_against_traffic checks reality, and save_buffer puts the wired
layout back on the phone.
Args: name: Layout name (blank-buffer mode). columns, rows: Grid of the first tab (blank-buffer mode). accent: Accent color hex (blank-buffer mode). mode, row_height: First tab's grid mode ("grid" default 2-D / "flow") and 2-D row-unit height in points (blank-buffer mode). from_sample: Seed from a sample layout filename (e.g. 'demo-offline.json'). from_device: Seed from the layout currently live on the paired device (read-modify-write). from_device_file: Seed from a SAVED layout on the device by filename or display name (the phone-editor handoff), whether or not it's active.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | ||
| name | No | Untitled | |
| rows | No | ||
| accent | No | #667eea | |
| columns | No | ||
| row_height | No | ||
| from_device | No | ||
| from_sample | No | ||
| from_device_file | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |