Export GIF or WebP

export_gif

Export an animated GIF or WebP that fits a size budget (for PRs, issues, READMEs), stepping fps, width, and quality down until it fits.

editwritesdestructivesince v0.17.0

00:00PARAMETERS

Name	Type	Description
`input` required	`string`	Path to the source video.
`format`	`"gif" \| "webp"`	gif (default) or webp (usually much smaller).
`maxBytes`	`integer`	Size budget in bytes (default 10000000, under GitHub's 10 MB image limit). ≥ 10000, ≤ 9007199254740991
`fps`	`number`	Starting frame rate (default 12). > 0, ≤ 30
`width`	`integer`	Starting width in px (default 960). ≥ 64, ≤ 1920
`start`	`number`	Start second. ≥ 0
`duration`	`number`	Seconds to export (default: to the end). > 0
`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

export_gif { "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.

00:15SEEN IN