Image Effects

Image Effect

Add an effect to images.

Settings

Key	Value
CONFIG	image_effect
ENV	KIOSK_IMAGE_EFFECT
URL	image_effect
VALUE	none | zoom | smart-zoom
DEFAULT	none

Using with config.yaml file

image_effect: none

Using with ENV in your docker-compose file

environment:
  KIOSK_IMAGE_EFFECT: none

Using with url queries

http://{URL}?image_effect=none

Image Effect Amount

Set the intensity of the image effect. Use a number between 100 (minimum) and higher, without the % symbol.

Settings

Key	Value
CONFIG	image_effect_amount
ENV	KIOSK_IMAGE_EFFECT_AMOUNT
URL	image_effect_amount
VALUE	int
DEFAULT	120

Using with config.yaml file

image_effect_amount: 120

Using with ENV in your docker-compose file

environment:
  KIOSK_IMAGE_EFFECT_AMOUNT: 120

Using with url queries

http://{URL}?image_effect_amount=120

Options

zoom

Note

Image fit is set to cover automatically when this effect is used, unless layout is set to single.

This effect zooms in or out to add movement to your images, with the center of the image as the focal point.

smart-zoom

Note

Image fit is set to cover automatically when this effect is used. If the image has multiple faces, Kiosk calculates the center of all faces to use as the focal point.

Smart zoom works like the regular zoom but focuses on faces and includes both zooming and panning.

Tip

To achieve a “Ken Burns” style effect change the image_effect_amount to somewhere between 200-400.