Skip to content

PlayableImage

HTTP API schema

← HTTP API reference

An image to show on an endpoint with a screen.

PlayableImage fields

datastringRequired

Base64 encoded image, at most 5 MiB decoded. A whole request is at most 16 MiB, so a slideshow of 30 sends screen-sized images (about 300 KB each), not camera originals.

format: "byte"

minLength: 4

maxLength: 6990508

pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"

mimeTypestringRequired

The image MIME type. The endpoint's supportedImageMimeTypes lists the ones it shows.

pattern: "^image/[a-zA-Z0-9.+-]+$"

View source specification ↗