start_recording
Record simulation frames as PNGs to disk from a camera or active viewport, optionally logging prim transforms and properties, so you can review motion and state later.
Instructions
Start recording simulation frames to disk.
Records camera_path, or the active viewport's camera when empty, at width x height (up to 4096 a side), through the render capture_viewport and inspect_prim keep when it is that size, else one of its own: the viewport, its camera and its size stay as they are. The render runs while the recording does and up to 30 s after, kept for the next capture or recording unless a capture's render is still kept at the stop, and slows the app's updates, the more the larger the frames.
Takes a frame every 1/fps seconds of the recording's own clock, at most one an app update. The clock runs with the simulation while it plays, so a simulation faster than real time gives more than fps frames a wall second, and with the wall clock while it is stopped or paused. Play it to record motion. Frames taken while it is stopped or paused show Kit's grid, as the viewport does; Isaac Sim 6.2 hides the grid while it plays. Frames stop if the stage changes or the camera is deleted; stop_recording says so. Frames are saved as PNGs in mcp_output/recordings/, by Kit itself. One recording runs at a time: another start is refused until stop_recording. Use stop_recording when done, then get_recording_frame to review any frame. Frames go on while the simulation is stopped, and a stop puts the scene back: pause it, or call stop_recording, before stopping it to end on the run's last state.
Optionally tracks prim state (transforms, properties) alongside video frames, in state.txt.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "start_recording"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fps | No | Frames a second: 5 takes one every 0.2 s, of simulation while it plays and by the clock while not | |
| width | No | Frame width in pixels, up to 4096 | |
| height | No | Frame height in pixels, up to 4096 | |
| camera_path | No | The camera to record, e.g. /World/RecCam; the active viewport's camera when empty | |
| 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 |