/
FA
falconchristmas
Search skmtc
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
aes67
1
backups
11
cape
14
channel
7
command
3
commandPresets
2
commands
2
configfile
4
crashes
4
dir
2
effects
2
email
2
errorReport
1
events
4
file
12
files
3
fppd
39
geoip
1
git
10
gpio
3
help
1
media
3
models
4
network
16
options
1
opusrtp
1
overlays
19
get
/api/overlays/effects
overlays/effects
get
/api/overlays/effects/{effect}
overlays/effects/{effect}
get
/api/overlays/fonts
overlays/fonts
get
/api/overlays/model/{model}
overlays/model/{model}
get
/api/overlays/model/{model}/clear
overlays/model/{model}/clear
get
/api/overlays/model/{model}/data
overlays/model/{model}/data
put
/api/overlays/model/{model}/data
Write bulk pixel data to an overlay model in a single request, as an alternative to one round trip per pixel via `.../pixel`.
get
/api/overlays/model/{model}/data/raw
Get 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.
put
/api/overlays/model/{model}/fill
overlays/model/{model}/fill
put
/api/overlays/model/{model}/mmap
overlays/model/{model}/mmap
put
/api/overlays/model/{model}/pixel
overlays/model/{model}/pixel
get
/api/overlays/model/{model}/preview
overlays/model/{model}/preview
put
/api/overlays/model/{model}/save
overlays/model/{model}/save
put
/api/overlays/model/{model}/state
overlays/model/{model}/state
put
/api/overlays/model/{model}/text
overlays/model/{model}/text
get
/api/overlays/models
overlays/models
put
/api/overlays/range/{ranges}
overlays/range/{ranges}
get
/api/overlays/running
overlays/running
get
/api/overlays/settings
overlays/settings
pipewire
19
player
3
playlist
12
playlists
14
plugin
21
privacy
2
proxies
5
proxy
1
remoteAction
2
remotes
1
rtspoutput
1
schedule
3
scripts
5
sequence
12
settings
5
statistics
3
system
21
testmode
2
time
1
validate
1
variables
4
videoinput
1
overlays
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to overlays/effects/{effect}
get
/api/overlays/effects/{effect}
May 30, 2026
76b02501e0ae
Revision changes
info
endpoint added
May 13, 2026
34a577bdabff
Revision changes
breaking
api path removed without deprecation