Skip to content

MediaPlayerInterfaceShowImagesMessage

HTTP API schema

← HTTP API reference

Show base64 encoded images as a slideshow on the endpoint's screen, replacing what the endpoint's own player plays. Each image shows for secondsPerImage, in order; next and previous move between images and pause holds the current one. Without loop the slideshow stops paused on the last image; with loop it starts over. Requires a supportedImageMimeTypes entry for every image's mimeType. A SUCCEEDED result means the command was delivered, not that the images show; confirm with endpoint_query expand media-player and forceDeviceAttributeQuery true, where now-playing reports name, queuePosition and queueLength once every image has loaded.

MediaPlayerInterfaceShowImagesMessage fields

imagesarray<PlayableImage>Required

The images in the order they show.

titlestring

Optional name shown as now-playing name, so a state read can tell which slideshow shows.

minLength: 1

maxLength: 200

secondsPerImageinteger

How long each image shows before the next.

minimum: 2

maximum: 60

Default: 8

loopboolean

Start over after the last image. False stops paused on the last image.

Default: false

View source specification ↗