Tutorial: Schedule Video Kiosk using an XML File

How to use a Schedule XML file

You can create a Schedule for Video Kiosk – Android using an XML file. Once it’s deployed to your device, you can run Video Kiosk on a schedule without requiring an internet connection. And you can deploy the same Schedule XML file on any number of devices, which is easily done using the built-in Cloud Update Feature.

Click to watch the video

To use a Schedule XML file, follow these steps:

Video Kiosk Schedule XML Example
  1. In Video Kiosk > Settings > File and folder > Sort by, choose Path or first playlist found. The other Sort by settings (Path, File name excluding path, Random shuffle)  take precedence over scheduled playback and so scheduling won’t work with those other settings.
  2. In a Text Editor or XML Editor, create an XML  file, with the extension .xml.
    • To learn how to create an XML file, refer to How to create an XML file.
    • For file content requirements, refer to the Video Kiosk Schedule XML file Syntax Guide, below.
  3. When you have finished editing the file, change the file extension from .xml to .schedule so Video Kiosk will recognize it as a Schedule file.
    • For example, from videokiosk.xml to videokiosk.xml.schedule
  4. Move the Schedule XML file onto the device or synchronize it using a cloud service. (To get more information on how to do this, refer to the Cloud Updating Tutorial.)
  5. Configure Video Kiosk with the location of the playback schedule. You can configure the location of the Schedule that you want in two ways, by putting the schedule file in the default location or by setting the path to the schedule file in the App Settings.
  • Use the Default Location
    • To use the default location, put the schedule file either in the media folder or in the schedule folder.
  • Configure the Path in the App Settings
    • Go to
      Video Kiosk > Settings  >Schedule > Path to schedule folder
      and set the path to the schedule folder.
    • Go to
      Video Kiosk > Settings > Schedule> Use a calendar of schedule
      and select the schedule to use.
  1. Choose the device behavior when no schedule event occurs.
    The default is to display a blank screen.
    In order to display the date and time instead, go to Video Kiosk > Settings > Schedule > Display Clock and set to on. You can change the clock color using the Video Kiosk > Settings > Schedule > Clock Color You can change the clock format (12 hour AM/PM versus 24 hour) in the System Settings for the device.
  2. Choose whether or not the schedule event controls the display.  Go to
 Video Kiosk > Settings > Schedule > Display State and choose the setting
    Always on – the schedule events do not turn the display off
    On for events, otherwise off – the schedule event will turn the display on
    Off for events, otherwise on, the schedule event will turn the display off.
  3. Choose how often Video Kiosk checks for changes to the schedule. The default is every 30 seconds. You can change the clock color using the Video Kiosk Settings > Timers > Schedule Check seconds.
  4. Ensure that the device’s time is set to the correct time and correct time zone. (This may be set automatically, depending on the device. For more information, refer to the Owner’s manual that came with the device.)

Schedule XML File Syntax Guide

<events>
</events>		  A list of all playback eventsRequired
 <event>
</event>		 A single playback eventRequired for event
  <week>
</week>		Events occurs on multiple days of the week. Define days using the string SMTWTFS, using the letter to include the day and a dash character (–) to skip the day. Use all 7 characters or the event will be ignored.Use either <week> or <dayofweek> for each event, not both
  <dayofweek>
</dayofweek>		Event occurs for a single day   Valid Values:
Sun
Mon
Tue
Wed
Thu
Fri
Sat		Use either <week> or <dayofweek> for each event, not both
  <starttime>
</starttime>		The time the event starts (24hour clock, format 99:99)Required for event
  <endtime>
</endtime>		The time the event ends (24hour clock, format 99:99)Required for event
  <playlist>
</playlist>		A playlist to use for this eventOptional
  <path>
</path>		A path to use for this eventOptional

Video Kiosk Schedule XML file examples

Click here to Download the Schedule XML File Sample Kit

NOTE: When you are creating an XML file, please do not copy and paste this example. Many web browsers will insert the wrong characters when you copy and paste; most notably, they get the double quote character wrong.  If you don’t want to type from scratch, download the sample file and step-by-step instructions using this link.

Using the Week Tag

The week tag is used to define the same event occurring on multiple days of the week, using a string of the form SMTWTFS, where each day of the week uses the first letter of the day’s name.  If you want the event to occur on a day, use the letter for the day’s name. If you want to skip a day, use a dash character (–) instead of the first letter of the day’s name. It’s important that the string always contains all 7 characters.  If you use any other number of characters, the event will be ignored.

For example,

  • An event that occurs Monday through Friday would use the string -MTWTF-
  • An event that occurs only on the weekend would use the string S—–S
  • An event that occurs on Monday, Wednesday and Friday would use the string -M-W-F-

Example: Plays morning and afternoon playlists

Here is an example of an XML file that contains two events. It will do the following:

  • It will turn on the display and display the morning playlist weekday mornings from 06:00 to 11:59 and then turn off the display
  • It will turn on the display and display the afternoon playlist every afternoon from 12:00 to 20:59 and then turn off the display
<?xml version=”1.0″ encoding=”UTF-8″?>

<events>
	<event>
		<week>-MTWTF-</week>
		<starttime>06:00</starttime>
		<endtime>11:59</endtime>
		<playlist>morning.m3u8</playlist>
	</event>
	<event>
		<week>SMTWTFS</week>
		<starttime>12:00</starttime>
		<endtime>20:59</endtime>
		<playlist>afternoon.m3u8</playlist>
	</event>
</events>

Using the Week Tag

The dayofweek tag is used to define an event occurring on one day of the week. The values to use for the days of the week are:

Sun
Mon
Tue
Wed
Thu
Fri
Sat

For example, an event that occurs each Monday would use the string Mon

Example: Plays morning playlist on Mondays, Afternoon playlist on Thursdays

Here is an example of an XML file that contains two events. It will do the following:

  • It will turn on the display and display the morning playlist Monday mornings from 06:00 to 11:59 and then turn off the display
  • It will turn on the display and display the afternoon playlist Thursday afternoons from 12:00 to 20:59 and then turn off the display
<?xml version=”1.0″ encoding=”UTF-8″?>
<events>
	<event>
		<dayofweek>Mon</dayofweek>
		<starttime>06:00</starttime>
		<endtime>11:59</endtime>
		<playlist>morning.m3u8</playlist>
	</event>
	<event>
		<dayofweek>Thu</dayofweek>
		<starttime>12:00</starttime>
		<endtime>20:59</endtime>
		<playlist>afternoon.m3u8</playlist>
	</event>
</events>

Resources

Take the Next Step

Get this Now

$15.99 US / device

Volume Licensing

Free Trial

Install the FREE trial

Install Now

Video Kiosk Help

Have you got a moment to answer a couple of questions?