/
/FPP API
DocsSign in
Sign in
  • APIs
  • Generators
  • Stacks
  • Projects
  • Docs
  • History
  • Schema
Checked 1h ago · Updated 2w ago
aes671
backups11
cape11
channel6
command3
commandPresets2
commands2
configfile4
dir2
effects2
email2
events3
file10
files3
fppd37
geoip1
git7
gpio3
help1
media3
models4
network14
options1
opusrtp1
overlays19
  • getoverlays/effects
  • getoverlays/effects/{effect}
  • getoverlays/fonts
  • getoverlays/model/{model}
  • getoverlays/model/{model}/clear
  • getoverlays/model/{model}/data
  • putWrite bulk pixel data to an overlay model in a single request, as an alternative to one round trip per pixel via `.../pixel`.
  • getGet the current pixel buffer of an overlay model as raw binary: width * height * bytesPerPixel bytes, row-major from the top-left, which is the exact layout `PUT /api/overlays/model/{model}/data` accepts. The model geometry is repeated in the `X-FPP-Model-Width`, `X-FPP-Model-Height` and `X-FPP-Model-BytesPerPixel` response headers.
  • putoverlays/model/{model}/fill
  • putoverlays/model/{model}/mmap
  • putoverlays/model/{model}/pixel
  • getoverlays/model/{model}/preview
  • putoverlays/model/{model}/save
  • putoverlays/model/{model}/state
  • putoverlays/model/{model}/text
  • getoverlays/models
  • putoverlays/range/{ranges}
  • getoverlays/running
  • getoverlays/settings
pipewire17
player3
playlist7
playlists9
plugin15
proxies5
proxy1
recurringtasks2
remoteAction1
remotes1
schedule3
scripts4
sequence9
settings5
statistics3
system14
testmode2
time1
variables4
    overlays

    overlays/model/{model}/fill

    Fill an overlay model with a solid color. Body: {"RGB":[r,g,b]} or {"Value":v}.

    put/api/overlays/model/{model}/fill

    Response

    Model filled.

    Changes