Video Kiosk Schedule XML File Reference Guide



Video Kiosk – Android supports a local schedule in XML format

File Naming Guide

The schedule file needs to have the .schedule file extension to be recognized by Video Kiosk.

The easiest way to use a schedule is to create a file named VideoKiosk.schedule (no spaces in the name) and put it in the same folder as your media files.  If you do that, Video Kiosk will recognize and use the schedule automatically.

Alternatively you can have one or more schedule files with different names and you can pick the schedule you want to use in the Video Kiosk Settings > FILE AND FOLDER > Sort by setting (all the schedules found by Video Kiosk will be listed under that setting).

If, for organizational purposes you want to put your schedule file(s) in a different folder than the media folder you must also set the path to that folder in the Video Kiosk Settings > SCHEDULE > Path to schedule folder.

So be they very simple and automatic or more complex and flexible, Video Kiosk satisfies all your scheduling needs.

Syntax Guide

Schedule .xml files use the following  xml keys:

<events>
</events>
A list of all playback events required
<event>
</event>
A single playback event required for each 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 “-“ 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 each event
<endtime>
</endtime>
The time the event ends (24hour clock, format “99:99”) required for each event
<playlist>
</playlist>
A playlist to use for this event optional
<path></path> A path to use for this event optional

 

 VideoKiosk schedule XML file examples

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 “-“ 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, the first displaying the morning playlist weekday mornings from 0600 to 1159 and the second displaying the afternoon playlist every afternoon from 1200 to 2059:

<?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, the first displaying the morning playlist on Monday mornings from 0600 to 1159 and the second displaying the afternoon playlist Thursday afternoons from 1200 to 2059:

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

Click here to Download a sample Schedule XML File
How to Create a Schedule XML File


More Information

Buy it now
$14.95 / device

Get it on Google Play

Download the
FREE trial

Download Now