Compress Video

compress

Re-encode a video smaller (H.264 CRF ladder, optional width cap). For a platform target use export_preset.

editwritesdestructivesince v0.3.0

00:00PARAMETERS

Name	Type	Description
`input` required	`string`	Path to the source video.
`level`	`"light" \| "medium" \| "heavy"`	CRF 23 / 28 / 32 (default medium).
`maxWidth`	`integer`	Width cap in px (only downscales). > 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

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