Zoom and Pan

zoom

Smooth animated zoom-and-pan into the action and back out, from keyframes or planned from logged clicks or screen changes.

producewritesdestructivesince v0.27.0

00:00PARAMETERS

Name	Type	Description
`input` required	`string`	Path to the source video.
`keyframes`	`object[]`	Views reached by time t: a source rectangle (x, y, width, height), or { t, full: true } to zoom out. Omit to plan them (see follow). at most 100 items
`keyframes[].t` required	`number`	≥ 0
`keyframes[].x`	`number`
`keyframes[].y`	`number`
`keyframes[].width`	`number`	> 0
`keyframes[].height`	`number`	> 0
`keyframes[].full`	`boolean`
`follow`	`"auto" \| "clicks" \| "changes"`	Without keyframes: clicks (from the events log of start_recording events: true) or changes (where the screen changed). auto (default): clicks if logged, else changes.
`events`	`string`	Events log (default: the input's .events.jsonl); must match the input's timing and size, so use the original recording.
`highlightClicks`	`boolean`	Ring each logged click (default false).
`highlightColor`	`string`	Ring color (default #FF4545).
`transitionSec`	`number`	How long each zoom/pan eases (default 0.6). > 0, ≤ 5
`maxZoom`	`number`	Auto mode: the furthest it zooms in (default 2.5). ≥ 1, ≤ 6
`holdSec`	`number`	Auto mode: stay zoomed this long after activity (default 2). > 0, ≤ 30
`dryRun`	`boolean`	Return the planned keyframes only (editable, pass back).
`output`	`string`	Optional output path. Defaults under SCREENCAST_HOME/edits.
`overwrite`	`boolean`	Allow replacing an existing file at the output path (default false).

00:05A MINIMAL CALL

zoom { "input": "recording.mp4" }

The required arguments only, with placeholder values. Everything else takes its default.

00:10WHAT COMES BACK

Structured content (structuredContent), alongside a text summary:

Field	Type
`keyframes` always	`any[]`

00:15SEEN IN