2d744b175449

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-132590241.8 KB
overlays

Write bulk pixel data to an overlay model in a single request, as an alternative to one round trip per pixel via `.../pixel`.

The body may be any of three things, and FPP works out which: - Raw pixel bytes (application/octet-stream) laid out row-major from the top-left of the region, w * h * fmt bytes exactly. A wrong length is an error, never a partial write. - An encoded image (PNG, JPEG, GIF, BMP, TIFF, WebP), by Content-Type: image/* or fmt=image. Decoded and scaled server-side, so a 32x32 PNG costs a few hundred bytes instead of 3KB and no file has to exist on the player first. - JSON with the payload base64 in a Data member: {"X":0,"Y":0,"W":32,"H":32,"Format":"rgb","Data":"..."}. Members given here override the equivalent query arguments. A region that hangs off an edge is clipped to what is visible rather than rejected, so a caller can slide an image across a model (and off it) by reposting at moving offsets.

put/api/overlays/model/{model}/data

Query parameters

xinteger

Left edge of the region. Default 0; may be negative.

yinteger

Top edge of the region. Default 0; may be negative.

winteger

Region width. Defaults to the model width less x. For an image, the box it is scaled into.

hinteger

Region height. Defaults to the model height less y. For an image, the box it is scaled into.

fmtstring

Raw pixel layout: rgb (default), rgbw, mono, or image to force image decoding.

blendstring

How this write combines with what is there: opaque (default), transparent, transparentrgb.

scalestring

Image scaling: fit (default), fill, stretch, none.

targetstring

channel (default) writes the output channel data; overlay composites into the mmapped overlay buffer shared with external clients.

autoEnablestring

Enable the model if it is currently Disabled: true, Enabled, Transparent, or TransparentRGB.

stopEffectboolean

Evict a running effect on the model first. Default true.

Response

Pixel data written; body reports the region and whether it was clipped.