Configuration
Your custom app only needs a config.xml to work on Fusion Signage devices. Let's review the format.
The config.xml file
The config file format is based on the W3C Packaged Web Apps format, although only certain elements are currently supported.
An example config.xml file will look like this:
<?xml version="1.0"?>
<widget xmlns="http://www.w3.org/ns/widgets"
xmlns:fs="http://www.fusionsignage.com.au/widgets"
id="your_unique_id"
version="0.0.1"
fs:duration="30"
width="1920"
height="1080">
<!-- The name of your custom app -->
<name>My Custom Application</name>
<!-- The start page for the application -->
<content src="index.html" />
</widget>
Config elements and attributes
| XPath | Required | Description |
|---|---|---|
/widget[@id] | Yes | The unique identifier of your content in Fusion Signage. Custom applications with the same unique identifier will be overridden in the future, but for now this value is ignored. |
/widget[@version] | Yes | The version of your content. This is currently ignored by Fusion Signage but may be used in future. |
/widget[@fs:duration] | No | The duration in seconds of your content. This will be the amount of time your content will display on a screen. If not provided this will default to 10 seconds. |
/widget[@width] | No | The width in pixels of your content - e.g. 1920. This should match your screen dimensions. If not provided this will default to 1920. |
/widget[@height] | No | The height in pixels of your content - e.g. 1080. This should match your screen dimensions. If not provided this will default to 1080. |
/widget[@viewmodes] | No | An optional attribute that provides custom rendering behaviours. If a view mode of fs:interactive is provided, the custom application will be able to be deployed as interactive media. You should use this setting for kiosks or touch screen applications. If a view mode of fs:overlay is provided, the custom application can be deployed as a persistent playlist overlay. You should ensure your custom application has a transparent background when using this option. If omitted, your custom application will behave like all other media and will not be interactive. |
/widget/name | Yes | The name of your content. This will be displayed in the Fusion Signage content management system. |
/widget/content | Yes | The root file of your HTML content. Fusion Signage currently only supports a <content> element whose src attribute is set to index.html, with index.html located in the root of your zip file. |