Tutorial: Configure Video Kiosk with a Settings XML File


If you need to configure many devices, you may prefer to create a videokiosk.settings XML file which you can copy to each device rather than having to manually configure the settings on every device. Using the same Settings XML file on every device is not only a much faster way to configure the Video Kiosk settings, but if you use the Cloud Update feature, you can update the Settings XML file on your computer, and then Video Kiosk will propagate the modified settings out to all the devices remotely.

Some Important Notes before you get Started

Note 1: Use the Standard Folder Layout

When using a Settings XML file, make sure to use Video Kiosk’s Standard Folder Layout since Video Kiosk will only automatically find the Settings XML file if you place it at the following path:

       /sdcard/videokiosk/settings/videokiosk.settings.xml

Note 2: Use just one method for modifying the Settings  

Your Android device settings can be changed either using the XML or by changing the settings manually on the device. We recommend that you use one method or the other, but not a hybrid of both. If you use a hybrid of both, you run the risk of overwriting your manual changes with the values in you Setting XML file

Note 3: Use the Sample Kit to help you get started  

There is a Video Kiosk Settings XML File Sample Kit available for download. In it are some sample Settings XML project. You can use it both to see what a project might look like and then you can just modify one of the settings files to make a Settings XML File for your own project.

Instructions: How to Use a Settings XML File

Time needed: 1 hour and 15 minutes

To use an Settings XML file to control the device settings, follow these steps::

  1. Create an XML Settings File. 


    In a Text Editor, create a file, or edit one of the sample XML settings file in the Sample Kit (see below for details).

    – The XML Schema is documented in the Video Kiosk Users Manual – Appendix C Video Kiosk XML Settings.
    – The XML Tags correspond to Video Kiosk’s settings. For more information about each setting, refer to the Video Kiosk Users Manual – Configuring the Settings
    – For more information about editing an XML File, refer to the How to Create or Edit an XML file

  2. Save and Name the File XML.

    Name the file “videokiosk.settings.xml”.

  3. Move the File to the Device


    Move the file onto the Android Device and put it in the “videokiosk/settings/” folder. You can move the file either using a USB cable or over the cloud using the Cloud Update feature.
    [For more information, refer to “How to use the Cloud Update Feature” ]
    or
    [“How to move files unto an Android Device using a USB cable and AFT“]

  4. Launch Video Kiosk

How to Use the Settings XML File Sample Kit

There is a Video Kiosk Settings XML File Sample Kit available for download. In it are some sample Settings XML project. You can use it to see what a project might look like and then use the Settings XML File in the project to make one of your own.
Download the sample kit  from:

https://burningthumb.com/wp-content/uploads/video-kiosk-settings-xml-file-sample-kit.zip

Each of the sample Settings XML File contains both a Settings XML File and the media files to display the sample. The easiest way to implement a Settings XML File is to do the following:

  • Use the example on your Android device and get it running with the sample media.
  • Then, Modify the sample Settings XML file to create your own Settings file.

Using the Settings XML File Sample File as a demo

Now that you’ve downloaded the Seetings XML File Sample Kit, choose one of the sample files to use as a demo. Here’s what you do:

  1. Download the Video Kiosk Settings XML File Sample Kit
  2. From the kit, choose a sample xml file to use.
  3. Ensure that the file is named “videokiosk.settings.xml”.
  4. Move the File. Move the file onto the device either using a USB cable or over the cloud using the Cloud Update feature.
    [For more information, refer to “How to use the Cloud Update Feature” ]
    or
    [“How to move files unto an Android Device using a USB cable and AFT“]
  5. Launch Video Kiosk.

Running this pre-configured sample file will give you an idea of how to set up a display similar to the one you want to create.

Customizing the Settings XML File Sample File

Once you accomplish this, you can make a copy of the file and customize the settings. Just follow the instructions in the “How to Use a Settings XML File” above.

Instructions: How to modify the Device Settings

To modify your settings:

  1. Modify the Settings XML File and download to your devices. The device’s settings will update automatically – no re-start required.

Resources

Take the Next Step

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