Drawbox
Video Single output Transform
Draw a colored box on the input video.
FFmpeg filter:
drawbox— 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 Drawbox(…));$result = $node->outputs()[0];Shorthand. Single-output filters can skip the node — apply() returns the result stream directly:
$result = $video->apply(new Drawbox(…));When to use it
Section titled “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
Section titled “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
Section titled “Examples”TODO — runnable PHP, with the equivalent ffmpeg CLI alongside.
Gotchas
Section titled “Gotchas”TODO
See also
Section titled “See also”TODO
Parameters
Section titled “Parameters”| Parameter | Type | Default | Range / values | Description |
|---|---|---|---|---|
x | int|float|string | 0 | expression | set horizontal position of the left box edge |
y | int|float|string | 0 | expression | set vertical position of the top box edge |
width | int|float|string | 0 | expression | set width of the box |
height | int|float|string | 0 | expression | set height of the box |
color | string | black | — | set color of the box |
thickness | string | 3 | — | set the box thickness |
replace | bool | false | — | replace color & alpha |
box_source | string | — | — | use datas from bounding box in side data |
FFmpeg also names these options (use the parameter shown above): w → width, h → height, c → color, t → thickness.
Maps to FFmpeg’s drawbox filter. Verified against ffmpeg n7.1.1.
An Artisan Build project.
Built on FFmpeg — an independent binding, not affiliated with or endorsed by the FFmpeg project. Support FFmpeg.