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 Kiosk to allow users to click the screen and view the pages associated with the URLs using the integrated kiosk web view.

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 – Android supports an overlay file (.png format), with hotspots defined. A hotspot is a rectangle somewhere on the screen and its associated URL.  When the hot spot is touched, the URL will be displayed in a web view. The Overlay with hotspots feature is used to allow users of an interactive kiosk to touch the screen and view the pages associated with the URLs using the integrated kiosk web view.

To use an Overlay with hotspots, follow these steps:

  1. If you haven’t already done so, create an overlay .png file. (see above)
  2. Create a hotspot overlay file
    Hotspots are defined with an 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
    “overlay.png”
    name your hotspot overlay XML file,
    “overlay.png.xml”
  3. For the XML file syntax, refer to the Hotspot .xml file Syntax Guide, below.
  4. Put the hotspot overlay file in the same folder as the Overlay file so that it can be found automatically by Video Kiosk.
  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 Screen > Overlay > Web Activity timeout
    and change the timeout (in seconds).

 

Hotspot .xml file Syntax Guide

<hotspots></hotspots>A list of hotspots
<hotspot></hotspot>A single hotspot
<url></url>Destination url used for a single hotspot
<rect></rect>The screen rectangle for the hotspot defined using numbers between 0 and 1 as a fraction of the screen
<top></top>Rectangle top
<left></left>Rectangle left
<bottom></bottom>Rectangle bottom
<right></right>Rectangle right

Hotspot .xml file example

Here is an example of what a file that contains 2 hotspots would look like:

<?xml version=”1.0″ encoding=”UTF-8″?>

<hotspots>

<hotspot>

<url>http://burningthumb.com</url>

<rect>

<top>0.55</top>
<left>0.05</left>
<bottom>0.95</bottom>
<right>0.45</right>

</rect>

</hotspot>

<hotspot>

<url>http://www.mireth.com</url>

<rect>

<top>0.55</top>
<left>0.55</left>
<bottom>0.95</bottom>
<right>0.95</right>

</rect>

</hotspot>

</hotspots>

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