Video Kiosk XML Schedule File Reference Guide


https://youtu.be/Ri6ncQtetpY

Click to watch the video

Video Kiosk: How to Create an XML Schedule File.

This video shows you how to create an XML Schedule file to control the playback on Video Kiosk – Android.

How to use an XML Schedule file

Video Kiosk – Android supports using an XML file to control the playback schedule. To use an XML schedule, follow these steps:

  1. In Video Kiosk > Settings > File and folder > Sort by, choose Path or first playlist found since 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. 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.
    • 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 XML Schedule file Syntax Guide, below.
  3. Move the XML schedule file onto the device or synchronize it using a cloud service. (For an example of how to do this using Dropbox, refer to the Remote Updating Tutorial.)
  4. 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, create a schedule file called VideoKiosk.schedule and put the schedule file in the same folder as your content files. Video Kiosk will automatically use this as the Schedule File.
    • 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. 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.

XML Schedule File Syntax Guide

<events>
</events>
A list of all playback events Required
<event>
</event>
A single playback event Required 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 event Optional
<path>
</path>
A path to use for this event Optional

 

Video Kiosk XML Schedule file examples

Click here to Download the XML Schedule File Sample Kit

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 days 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-

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

NOTE: When 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.

<?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>

 

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

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

NOTE: When 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.

<?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

How to Create an XML File

Click here to Download the XML Schedule File Sample Kit

How to Create a Schedule XML File


More Information

Buy it now
$14.95 US / device

Get it on Google Play

Volume Licensing
Download the
FREE trial

Download Now

For Help with Video Kiosk