start_recording
Capture simulation frames to disk from the active viewport and optionally log tracked prim state, so you can review motion and scene changes after stopping.
Instructions
Start recording simulation frames to disk.
Records the active viewport, from its camera at its own size: aim it with set_camera or look_at_prim first.
camera_path, width and height are ignored for now (#25); the answer warns when given a camera_path, or a size
other than 640x480.
Captures a frame every few app updates, about 1/fps seconds, whether or not the simulation plays: play it to
record motion. Frames are saved as PNGs in mcp_output/recordings/. Use stop_recording when done,
then get_recording_frame to review any frame.
Optionally tracks prim state (transforms, properties) alongside video frames.
State is written to a grep-friendly state.txt in prim-block format.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fps | No | Frames a second: 5 captures one every 0.2 s | |
| width | No | Ignored for now: frames come at the active viewport's size (#25) | |
| height | No | Ignored for now: frames come at the active viewport's size (#25) | |
| camera_path | No | Ignored for now: frames come from the active viewport's camera (#25) | |
| track_prims | No | Prims whose state to record, descendants included, e.g. ["/World/G1"] | |
| property_filter | No | Only properties whose names contain one of these, e.g. ["joint", "pos", "vel"] |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |