Hsvkey

Video Single output Transform

Turns a certain HSV range into transparency. Operates on YUV colors.

FFmpeg filter: hsvkey — 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 Hsvkey(…));
$result = $node->outputs()[0];

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

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

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
hue	float	0	-360–360	set the hue value
sat	float	0	-1–1	set the saturation value
val	float	0	-1–1	set the value value
similarity	float	0.01	1.0E-5–1	set the hsvkey similarity value
blend	float	0	0–1	set the hsvkey blend value

---

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