Overlay Image or Video

overlay

Composite an image or video (logo, watermark, picture-in-picture) onto a video at a pixel position, optionally scaled and time-limited; keeps the base's audio and length.

producewritesdestructivesince v0.3.0

00:00PARAMETERS

Name	Type	Description
`input` required	`string`	Path to the base video.
`overlay` required	`string`	Overlay image or video path.
`x` required	`integer`	Left, px. ≥ 0, ≤ 9007199254740991
`y` required	`integer`	Top, px. ≥ 0, ≤ 9007199254740991
`width`	`integer`	Scale to this width (other side keeps aspect). > 0, ≤ 9007199254740991
`height`	`integer`	Scale to this height. > 0, ≤ 9007199254740991
`start`	`number`	Show from this second. ≥ 0
`end`	`number`	Hide after this second. > 0
`shape`	`"rect" \| "circle"`	circle: centre square masked round (webcam).
`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

overlay { "input": "recording.mp4", "overlay": "…", "x": 0, "y": 0 }

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

00:10WHAT COMES BACK

Structured content (structuredContent), alongside a text summary and any inline images:

Field	Type	Description
`outputPath` always	`string`	Path of the file written.