Overlay

Video Single output Transform

Overlay a video source on top of the input.

FFmpeg filter: overlay — the official reference.

Add it to a graph. The explicit form works for every filter — bind it to its inputs and read the result from outputs():

$node   = $video->addFilter(new Overlay(…), [$other]);
$result = $node->outputs()[0];

Shorthand. Single-output filters can skip the node — apply() returns the result stream directly:

$result = $video->apply(new Overlay(…), $other);

When to use it

TODO — when this filter shines: what it’s the right tool for, what to reach for instead when it isn’t, and how it composes with neighbouring filters.

How to use it

TODO — prose: how the filter actually works and what its key parameters mean (the explanation FFmpeg’s terse option help omits).

Examples

TODO — runnable PHP, with the equivalent ffmpeg CLI alongside.

Gotchas

TODO

See also

TODO

Parameters

Parameter	Type	Default	Range / values	Description
x	int|float|string	0	expression	set the x expression
y	int|float|string	0	expression	set the y expression
eof_action	OverlayEofAction	repeat	repeat, endall, pass	Action to take when encountering EOF from secondary input
eval	OverlayEval	frame	init, frame	specify when to evaluate expressions
shortest	bool	false	—	force termination when the shortest input terminates
format	OverlayFormat	yuv420	yuv420, yuv420p10, yuv422, yuv422p10, yuv444, yuv444p10, rgb, gbrp, …	set output format
repeatlast	bool	true	—	repeat overlay of the last overlay frame
alpha	OverlayAlphaFormat	straight	straight, premultiplied	alpha format

---

Maps to FFmpeg’s overlay filter. Verified against ffmpeg n7.1.1.