Screensaver Settings

Settings

Common Questions


Enable

Kiosk Pro’s Screensaver makes it simple to display images and video, either as a screensaver that will redirect to your regular homepage when a visitor touches the screen or as a standalone digital signage presentation.

Default: Off

Images and video will be shown full-screen when possible, depending on the aspect ratio of the file provided. To be presented in true full-screen, your video must have a 4:3 aspect ratio (which matches the screen ratio of the iPad).

Both images and video are shown without any visitor controls and will continuously loop. Any normal screen chrome (like the status, address or navigation bars) will be hidden while the screensaver is playing.

If you use this loop as a screensaver, when a visitor touches the screen, the app will display the Homepage you have configured in settings. When they walk away from the kiosk, the Idle Time Limit will return the kiosk to the screensaver.

If you prefer to just use the app to continuously display a loop for digital signage, you can turn the 'Disable Touch' setting On so that touching the screen (with the exception of the four corner touch gesture to show app settings, if configured) will not have an effect.

Alternately, if the Screensaver is enabled with no Homepage set and touch enabled, the loop will be restarted at the beginning each time a visitor touches the screen.


Screensaver Type

This setting defines what type of Screensaver you want to use.

Standard Image and/or Video - Set your Screensaver to loop multiple images/videos.

Single Video Sync - Loop a single video file that syncs with multiple kiosks.

Options:

  • Standard Image and/or Video (default)
  • Single Video Sync

Path to Local File or Folder

The screensaver feature can display video, image files, or a combination of the two. 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 somewhere inside Kiosk Pro’s documents folder. For instructions on how to transfer files to the iPad, please see Storing Content Locally on the iPad, Remote Update of Local Files, or our Dropbox integration.

To show a single video, the file can be stored locally in the root of the Kiosk Pro Documents folder. In this case, the file path will simply be 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 will be the folder name or the path to that folder.

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

Kiosk Pro will look inside the folder defined and create a loop using any video and/or image files found inside.

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.).

You can also use an .xml file stored in the same folder to define the order:

<xml>
<slide_show_settings>
    <slides>
        <slide path='slide10.jpg'/>
        <slide path='slide38.mp4'/>
        <slide path='slide7.png'/>
        <slide path='slide14.mp4'/>
        <slide path='slide1.jpg'/>
    </slides>
    <order_type>0</order_type>
</slide_show_settings>
</xml>

Using the .xml file makes it easier to add or reorder pieces of content as it does not require that you rename a large number of files when a change is needed. You can choose to order the files by the order they are listed in the .xml using  <order_type>0</order_type>, randomly using <order_type>1</order_type>, or alphabetically/numerically using <order_type>2</order_type>.  

A template for the .xml file can be found here.

The file must be named ‘slide_show_settings.xml’ and be placed in the same folder on the device as the content files defined in ‘Path to Local File or Folder’. Additional images and/or videos can be defined by adding additional <slide path='content.ext'/> entries.


Background Color or Image

This setting allows you to define the background color or image shown between images during the fade animation and is also shown if the image or video currently showing in the screensaver loop does not fill the screen completely.

Default: 0,0,0

If set as a color, this setting must be filled out in R,G,B decimal format, separated by commas, and will not accept hexadecimal format.

The background setting can also be set as a locally-stored image path and supports .jpg and .png formats. If using an image file smaller than the screen, the image will be automatically tiled horizontally and vertically to fill the screen.


External Monitor Mode

Related JavaScript API Documentation

Added in version 6.4

Specific to our Enterprise version, this setting determines how Kiosk Pro displays a video screensaver when connected to an external monitor, either directly through one of Apple’s Digital AV Adapters or wirelessly over AirPlay.

Options:

  • Digital Signage
  • Interactive (default)
  • Hybrid
  • Standard Mirroring

Digital Signage

Screensaver video plays in a full screen loop on the external monitor, uninterrupted by any visitor action. Screensaver video is not shown on the iPad, which displays the homepage and acts independently from the external screen.

If the external monitor is disconnected from the iPad, the screensaver video is stopped; when reconnected, video is started from beginning.

In this mode, any External Screen API request sent by your content will be ignored.

Interactive (default)

Screensaver video plays full screen on the external monitor and the iPad. When the visitor taps the iPad’s screen, the app switches to mirroring mode, showing the homepage on both the iPad and the monitor.

When the visitor walks away and app idle times out, the app triggers the screensaver video full-screen on both screens.

If the external monitor is disconnected from the iPad, the screensaver video continues on iPad and is stopped on the external monitor; when reconnected, video is started on both from the beginning.

In this mode, any External Screen API request sent by your content will be honored only while the video screensaver is not playing. When the idle timer triggers, anything currently being shown by the External Screen API will be cancelled and the screensaver video loop will start running full-screen on both screens.

If you need to prevent the idle timer from triggering at a certain point to prevent an interruption to what is being shown on the external screen, you can temporarily pause it using calls included in our JavaScript API.

Hybrid

Screensaver video plays full screen on the external monitor and the iPad. When the visitor taps the iPad’s screen, the iPad screen shows the homepage while the monitor continues to loop the video screensaver, uninterrupted by any visitor action.

When the visitor walks away and the app idle times out, video continues to play on the external monitor and begins to play on the iPad, syncing to the same point as the external screen.

Please note that as we are starting the video on the iPad ‘on the fly’ without pausing the video on the external monitor, there may be a slight offset between the two videos. If this is problematic for your use case, we recommend using a different external monitor mode.

If the external monitor is disconnected from the iPad, screensaver video continues on the iPad and is stopped on the external monitor; when reconnected, video is started on both from beginning (regardless of the current idle timer state).

In this mode, any External Screen API request sent by your content will be ignored.

Standard Mirroring

The external monitor mirrors the iPad’s screen using the native mirroring capability of the iOS operating system - both screens show the video screensaver (although it will not be shown in full-screen on the monitor). When the visitor taps the iPad’s screen, both screens show the homepage.

If the external monitor is disconnected from the iPad, the screensaver video continues on the iPad; when reconnected, the app automatically re-enters mirroring, displaying whatever is currently showing on the iPad's screen on the external monitor.

In this mode, any External Screen API request sent by your content will be honored. For example, if you send a call to loop a video on the external screen using the API, the external screen would go into 'full-screen mode' and continue to loop the video until it received a call to return to mirroring mode.

In this example, when the idle timer triggers, the iPad screen will begin to loop the video screensaver, but the external screen will continue to loop the full-screen video until it receives another command from the API, the external monitor is disconnected and reconnected, or the app is exited and relaunched.


Image Duration

This setting allows you to define how long each image will be shown on screen when using the Screensaver feature.

Default: 5

Fade Duration

This setting allows you to define the duration of the fade animation shown between images and/or video when using the Screensaver feature in seconds, which must be defined as a whole number.

Default: 1

If you prefer no fade animation between slides, you can empty this setting or set it to ‘0’.


Path to Overlay Image

Added in version 7.4

This setting allows you to display a locally stored image in front of the Screensaver. The image will appear consistently through the entire loop, and is not affected by fade transitions. Overlaying an image lets you add a call to action without needed to edit every image or video (for example, "Touch to start").

We recommend creating a transparent PNG that is  the same resolution as the iPad, as smaller images will be scaled to fit the screen.


Overlay Transparency

Added in version 7.4

This setting allows you to change the transparency of the Overlay Image.

Default: 1

The transparency can be set from 0 (completely transparent, or invisible) to 1 (no transparency) and decimals can be set for partial transparency (for example, '0.75').


Single Video Sync Overview

Added in version 7.8

This feature allows you to sync the Screensaver across multiple kiosks when using a single video. Single Video Sync can only support one video file.

A sync timer is determined by the video length. Every time the sync timer triggers while the Screensaver is playing, the video is restarted to sync the Screensavers. The sync schedule is based on the device time settings, and initiates at midnight every day.

Note: The first cycle may not sync perfectly as a video can require different processing time depending on the device.

Previous to version 7.9, when used with External Monitor Mode, the video will be displayed in Standard Mirroring mode, regardless of External Monitor Mode settings.


Idle Time Behavior

Added in version 7.8

This setting allows you to choose how the Idle Time Limit should behave with the Single Video Sync feature.

Options:

  • Refresh homepage, start screensaver at next sync cycle (default)
  • Start unsynced screensaver, refreshing to sync at next cycle

Refresh homepage, start screensaver at next sync cycle - When the Idle Time Limit triggers, the app refreshes the Homepage and waits for the next sync timer to start the Screensaver.

Start unsynced screensaver, refreshing to sync at next cycle - When the Idle Time Limit triggers, the app starts the Screensaver. When the next sync timer triggers, the video gets restarted in order to sync the videos.


Home icon doesn't redirect to screensaver?

The Home icon in the Navigation Bar is not designed to relaunch the screensaver, but instead to return the visitor to the homepage you've defined in Kiosk Pro settings.

The Screensaver requires that an Idle Time Limit be set to restart the loop; once that time has expired without detecting a touch gesture to the screen (whether you are on the homepage or not), the screensaver will be restarted.

If you need the screensaver to play when the Home icon is touched, you could skip using the Screensaver settings and embed the video into an .html page, then set it as your Homepage in Kiosk Pro. The screensaver page would need to be designed to autoplay/loop the content, and redirect the visitor to the ‘true’ homepage when the the page is touched. Then, when the visitor touched the Home icon or the idle timer triggered, the screen would return to the screensaver page.

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