editor/reference/node/capture.md
konstantin-paulus c1bc3f0085 Update package.json and README for consistency and clarity
Modified the "check" script in package.json to reference the correct "examples" directory. Updated the README to replace "video editor" with "media compositor" for improved accuracy and restructured some sentences for better readability. Removed outdated documentation files related to assets, CLI, composition, distribution, and getting started, streamlining the documentation for a more focused user experience.
2026-07-20 15:53:30 +02:00

1.1 KiB

dapi node capture [id] [-t, --time <time...>]

Focuses the node on the canvas and captures it, writing one PNG to the system temp directory per timeline position. Each capture is stamped in the top-left with its HH:MM:SS:FF timestamp. If [id] is omitted, captures the canvas (the active scene). To grab a video asset's own pixels at full resolution instead of the composited canvas, use media grab.

Input

  • [id]: node id (optional; defaults to the canvas)
  • -t, --time <time...>: one or more timeline positions at which to record the node, each a Time value (optional; defaults to the current playhead position)
  • --no-timestamp: don't stamp each capture with its HH:MM:SS:FF timestamp label

Output

One JSON object per line (JSON Lines), in the order the times were given: each has the requested time in seconds (null for the current playhead) and the absolute path to a freshly written PNG in the system temp directory with a uuid filename.

{ time: number | null, path: string }   // e.g. { "time": 1.5, "path": "/tmp/3f2c1a8e-....png" }