Screensaver General Settings

Display local images and videos as a looping screensaver or digital signage presentation.

Enable Screensaver

Supported in:

Kiosk Pro Plus and Enterprise

Default Value: Off

When used as a screensaver, if a visitor touches the screen, the app will display the Homepage. When they walk away from the kiosk, the Idle Time Limit will return the app to the screensaver.

To use this feature for digital signage, you can turn on Disable Touch so that touching the screen will not have an effect. If no Homepage is set and Disable Touch is Off, the Screensaver will be restarted each time a visitor touches the screen.

If using a remote update feature to remotely update the screensaver, the new content will appear the next time the screensaver starts it's loop, or when the screen is touched if no Homepage is set.

Values for Remote Settings Control & Managed App Configuration

Key sv_screenVideoEnabled
Key Type boolean
Default Value false


Screensaver Type

Supported in:

Kiosk Pro Enterprise

Default Value:
  • Standard Display
Other Possible Values:
  • Single Video Sync

In Plus

As Single Video Sync is not supported in Plus, this setting is hardcoded to the Standard Display option.

In Enterprise

This setting allows you to select between a Standard Display screensaver consisting of one or more images and/or videos or a Single Video Sync screensaver that allows you to synchronize video across multiple devices. Sync is based on video length and can be used to display a single video or multiple videos with an identical length to create large-scale displays made up of multiple iPads.

Values for Remote Settings Control & Managed App Configuration

Key kp_screenSaverType
Key Type integer
Default Value 0
Possible Values
  • 0 = Standard Display
  • 1 = Single Video Sync


Path to Local File or Folder

Supported in:

Kiosk Pro Plus and Enterprise

Defines which file(s) to use to create the screensaver loop. When using multiple files, the order can be determined by configuring an XML file.

Default: [empty]

The following formats are supported:

  • .mp4 video
  • .m4v video
  • .mov video, encoded with H264 codec
  • .jpg image
  • .png image

Files must be stored locally on the device in Kiosk Pro’s documents folder. For instructions on how to transfer files to the iPad, please click here.

The file path is relative to Kiosk Pro's documents folder. For example, if you want to display a single video located directly in Kiosk Pro's documents folder, the file path is the name of the file.

To show multiple videos, images, or a combination of the two, you would place all files in a single folder and transfer that folder to Kiosk Pro’s documents folder. In this case, the file path is the folder name, or the path to that folder.

To show multiple files that are stored directly in the Kiosk Pro documents folder, you can set your path to "./" (a period, followed by a forward slash).

Using multiple folders and determining the loop order

You can define the order in which files are played by naming the files alphabetically, or serially using numbers (for example, ‘1.jpg’, ‘2.jpg’, ‘3.mp4’, etc.).

For more specific configuration, or for using files stored in multiple folders, you can use an XML file. Using the XML file makes it easier to add or reorder pieces of content without renaming a large number of files when a change is needed.

A template for the XML file is available here. The file must be named ‘slide_show_settings.xml’ and stored in the root Kiosk Pro documents folder. To edit this file, open it in a plain-text editor like Notepad or TextEdit. Do NOT use a rich-text editor, like Word.

A sample of the code:

<xml>
<slide_show_settings>
	<slides>
		<slide path='folder1'/>
		<slide path='folder3/video.mp4'/>
		<slide path='folder2/*.png'/>
	</slides>
	<order_type>0</order_type>
</slide_show_settings>
</xml>

You can set the slide path to an individual file, or a folder name to show all files inside of that folder. Masking using asterisks (*) is also supported, which means you can show multiple, specific files without listing every single one. For example, if you want to use only the .png files in a folder, you can set the path to foldername/*.png.

Using the order_type allows you to determine an order for the files. Options include:

  • <order_type>0</order_type> - displayed in listed order
  • <order_type>2</order_type> - displayed in alphabetical/numerical order
  • <order_type>1</order_type> - displayed in a random order

Using the code example above, the Screensaver will be configured:

  • with all files in 'folder1'
  • with the 'video.mp4' file in 'folder3'
  • with all .png files in 'folder2'
  • and files will be shown in the listed order

Additional images and/or videos can be defined by adding <slide path=''/> entries.

Values for Remote Settings Control & Managed App Configuration

Key sv_url2MovieFile
Key Type string
Default Value [empty]


Background Color (RGB) or Image

Supported in:

Kiosk Pro Plus and Enterprise

Defines the background color or image shown between images during the Screensaver fade animation. This color/image is also shown if the image or video currently showing in the screensaver loop does not fill the screen completely.

Default Value:
  • 0,0,0 [black]
Other Possible Values:
  • any color defined in RGB format
  • a filepath to a locally stored image file

Color

The color must be set in R,G,B decimal format, separated by commas. This setting will not accept hexadecimal format. An extensive list of colors in RGB decimal format is available here.

Image

Images must be locally stored in JPG or PNG format. If you are using a single image file as a background across multiple pages, you can also use the same image file for a loading background, which should significantly decrease (or possibly eliminate) any loading flicker you might otherwise see.

If the image file is smaller than the screen, the image will automatically repeat horizontally and vertically to fill the screen.

Values for Remote Settings Control & Managed App Configuration

Key kp_backgroundColorOfScreenSaverSlideShow
Key Type String
Default Value 0,0,0 [black]
Examples
  • 255,255,255 = white
  • photo.jpg = path to a local image file

Change Log

  • Added in version 1.4. Ability to loop multiple files and define a background added in version 6.5.1. Single Video Sync option added in version 7.8. Multiple folder support added in version 10.4.

Still stuck? How can we help? How can we help?