Crop Video

crop

Crop a video to a pixel rectangle; one running off the frame is rejected.

editwritesdestructivesince v0.3.0

00:00PARAMETERS

Name	Type	Description
`input` required	`string`	Path to the source video.
`x` required	`integer`	≥ 0, ≤ 9007199254740991
`y` required	`integer`	≥ 0, ≤ 9007199254740991
`width` required	`integer`	> 0, ≤ 9007199254740991
`height` required	`integer`	> 0, ≤ 9007199254740991
`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

crop { "input": "recording.mp4", "x": 0, "y": 0, "width": 1, "height": 1 }

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	Description
`outputPath` always	`string`	Path of the file written.