/
FA
falconchristmas
/
FPP API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 1h ago · Updated 15h ago
View markdown
falconchristmas
FPP API
get
overlays/model/{model}/clear
2d744b175449
latest
OpenAPI 3.0.3
raw.githubusercontent.com
2026-08-13
259
0
241.8 KB
aes67
1
backups
11
cape
11
channel
6
command
3
commandPresets
2
commands
2
configfile
4
dir
2
effects
2
email
2
events
3
file
10
files
3
fppd
37
geoip
1
git
7
gpio
3
help
1
media
3
models
4
network
14
options
1
opusrtp
1
overlays
19
get
overlays/effects
get
overlays/effects/{effect}
get
overlays/fonts
get
overlays/model/{model}
get
overlays/model/{model}/clear
get
overlays/model/{model}/data
put
Write bulk pixel data to an overlay model in a single request, as an alternative to one round trip per pixel via `.../pixel`.
get
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
overlays/model/{model}/fill
put
overlays/model/{model}/mmap
put
overlays/model/{model}/pixel
get
overlays/model/{model}/preview
put
overlays/model/{model}/save
put
overlays/model/{model}/state
put
overlays/model/{model}/text
get
overlays/models
put
overlays/range/{ranges}
get
overlays/running
get
overlays/settings
pipewire
17
player
3
playlist
7
playlists
9
plugin
15
proxies
5
proxy
1
recurringtasks
2
remoteAction
1
remotes
1
schedule
3
scripts
4
sequence
9
settings
5
statistics
3
system
14
testmode
2
time
1
variables
4
overlays
overlays/model/{model}/clear
Clear (blank) an overlay model's pixel buffer.
get
/api/overlays/model/{model}/clear
Response
Model cleared.