Addroi

Video Single output Transform

Add region of interest to frame.

FFmpeg filter: addroi — the official reference.

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

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

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

$result = $video->apply(new Addroi(…));

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	string	0	—	Region distance from left edge of frame.
y	string	0	—	Region distance from top edge of frame.
w	string	0	—	Region width.
h	string	0	—	Region height.
qoffset	string	—	—	Quantisation offset to apply in the region.
clear	bool	false	—	Remove any existing regions of interest before adding the new one.

---

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