Video Kiosk Overlay Reference Guide




Video Kiosk – Android supports an overlay file (.png format), with or without hotspots.

  • The Overlay without hotspots feature is often used to overlay video with a company logo in the corner of the screen.
  • The Overlay with hotspots feature is used in Interactive Touchscreen Kiosks to allow users to activate the hotspot and view the  pages associated with the URLs using the integrated kiosk web view or to play an APP. Hotspots can be activated either by touching the screen or by touching a key.

Overlays

Overlays are used to overlay a graphic over part of the display, often a company logo in the corner of the screen.

To use an Overlay, follow these steps:

  1. Create an overlay file
    Create a PNG file with the same frame size as your display. For example, if you are using a 720p display, you would create a PNG file that is 1280×720 in size. Somewhere in the PNG file put your logo, or whatever content you want to use to overlay the video.
  2. Configure Video Kiosk with the location of the overlay file
    Go to
    Video Kiosk Settings Screen > Overlay > Path to Overlay folder
    and set the path to the overlay folder.
  3. Go to
    Video Kiosk Settings Screen > Overlay > Overlay file
    and select the overlay to use.

Video Kiosk will overlay your video with the content of the overlay file.

Resources:

 

Overlay Hotspots

Video Kiosk supports a hotspot file (.xml format with a file name that ends in .overlay.png.xml), with hotspots and/or key codes defined.

A hotspot is a rectangle somewhere on the screen and its associated URL | App. When the hotspot is touched, the URL will be displayed using the integrated kiosk web view or the App will be launched as a new activity on top of Video Kiosk. (The URL can point to a file on the device or a file on the Internet.)

A key code is the Android key code that corresponds with an individual key on an input device. When the key on the device that corresponds to the Android key code is touched, the URL will be displayed using the integrated kiosk web view or the App will be launched as a new activity on top of Video Kiosk.

To use hotspots, follow these steps:

  1. If you haven’t already done so, create an .overlay.png file. (see above)
  2. Create a hotspot XML file. Using a Text Editor, create an XML file with the same name as your overlay file with .xml appended to the name. For example, if your overlay file is called
“videokiosk.overlay.png”
name your hotspot overlay XML file,
“videokiosk.overlay.png.xml”
  3. For the XML file syntax, refer to the Hotspot .xml file Syntax Guide, below.
  4. Put the hotspot file in the same folder as the Overlay file so that Video Kiosk will find it automatically.
  5. Optionally, configure the timeout for the WebView in Video Kiosk. If a user of an interactive device leaves while the device is still displaying web content, Video Kiosk will return to your content after 30 seconds.
To increase or decrease this wait time, go to
Video Kiosk Settings > Overlay > Web Activity timeout
and change the timeout (in seconds).
    Note: If you plan to use a hotspot associated with an App package name, there is no automatic mechanism that ensures a device abandoned by a user will return to the loop and the user must take specific action to return to Video Kiosk so that the loop continues to play.

 

Hotspot .xml file Syntax Guide

 

Hotspot .xml file example

Here is an example of what a file that contains 2 hotspots could look like.

  • The first hotspot’s destination is the URL “http://burningthumb.com”. It can be triggered by touching the hotspot rectangle or by pressing the key corresponding to key code 51. The interactions to this hotspot are counted and reported in the Management Report with the Identifying string of “burningthumb”.
  • The second hotspot’s destination is the App “Calculator2”. It can be triggered by touching the hotspot rectangle or by pressing the key corresponding to key code 29. The interactions to this hotspot are neither counted nor reported in the Management Report.

Hotspot .xml file Verification help

To help test and debug your .xml file, Video Kiosk has an optional setting you can use to highlight your hotspots on your screen so that you can ensure they are in the correct place and functioning as expected. Remember to turn this feature off before releasing the device to users.

To turn verification mode on

  1. Go to
    Video Kiosk Settings Screen > Overlay > Highlight hotspots
    and check the checkbox.

To turn verification mode off

  1. Go to
    Video Kiosk Settings Screen > Overlay > Highlight hotspots
    and uncheck the checkbox

Resources:


More Information

Buy it now
$14.95 / device

Get it on Google Play

Download the
FREE trial

Download Now