Convert Format

convert

Convert media to mp4, webm, or gif. For a size-bounded GIF/WebP prefer export_gif; for a smaller mp4, compress or export_preset.

editwritesdestructivesince v0.2.0

00:00PARAMETERS

Name	Type	Description
`input` required	`string`	Path to the source media.
`format` required	`"mp4" \| "gif" \| "webm"`	mp4 (H.264), webm (VP9), or gif (palette).
`fps`	`number`	gif only: fps (default 12). > 0
`width`	`number`	gif only: width in px (default 720). > 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

convert { "input": "recording.mp4", "format": "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.