Screensaver External Monitor Mode

Supported In:

Kiosk Pro Enterprise

Determine how a video Screensaver should behave when connected to an external screen. You can connect an iPad to an external screen through one of Apple’s Digital AV Adapters or wirelessly over AirPlay.

Default Value:
  • Interactive
Other Possible Values:
  • Digital Signage
  • Hybrid
  • Standard Mirroring

Interactive

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.

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.

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.

Values for Remote Settings Control & Managed App Configuration

Key kp_screenSaverExternalMonitorMode
Key Type integer
Default Value 1
Examples
  • 0 = Digital Signage
  • 1 = Interactive
  • 2 = Hybrid
  • 2 = Standard Mirroring

Change Log

  • Added in version 6.4

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