Application Property File
The application property file is an XML formatted file structured similarly as the Application Service configuration file. However, the XML elements used are not restricted to the ones mentioned here. Any element can be added to make application specific settings that applications and services can access with the IToiApplicationService interface. No elements may have attributes.
In the following tables the properties used by services in the KreaTV TV Application Platform are described. If any of the required properties are missing, it will not be possible to start the application.
Element | Required? | Default value | Description |
---|---|---|---|
PlatformVersion | Yes | - | This is the platform version that the application was developed for. If the version is not among the compatible versions in the Application Service configuration the application will not be able to register. |
Run | Yes | - | This is a string with the path and all arguments to the application to run. |
IsPopup | Yes | - | Note! Support for popup applications will be removed in TOI 2.1 This element tells whether the application is a pop-up application (like a Navigator). Possible values: true, false. |
IsPlatformApplication | No | true | This element tells whether the application is platform aware or not. If set to false, the platform doesn't require the application to register or implement any TOI interfaces. Possible values: true, false. |
AutoRestart | No | false | AutoRestart is used to tell whether an application should be automatically restarted (move from the stopped state to the starting state) if it fails. Possible values: true, false. |
KillInvisible | No | false | KillInvisible is used to tell whether an application should be automatically killed when it becomes invisible (changing state from visible or active). The AutoRestart option is ignored when this happens. Possible values: true, false. |
StartTimeout | No | 5 s | This is the maximum time that the Application Service will wait for an application that is being started until it should have called the ReportStarted() function in IToiApplicationService interface. |
PingTimeout | No | 1 s | This is the time the Application Service will wait for a ReportPing() message from an application it has called Ping() on. If the application has not called ReportPing() within this time, the Application Service will terminate it and possibly restart it. |
Uninstallable | No | false | Tells the platform if it should be possible to uninstall the application. Application download has to be enabled on the platform for this element to take effect. |
SourceIip | Yes | - | This is the name of the IIP from which the property file originated. This information is used when installing the application at runtime using KreaTV Dynamic Download. |
GfxMemory | Yes | - | This is the amount of graphics memory in KiB an application requires. Keeping this number low, increases available application memory. The value from the application requesting most memory will be allocated. A too small figure results in an unstable configuration which must be avoided. |
Element | Required? | Default value | Description |
---|---|---|---|
BorderLeft | No | 0 | BorderLeft specifies the distance in pixels from the left edge of the screen to the left edge of the application area, i.e., application root window. |
BorderTop | No | 0 | BorderTop specifies the distance in pixels from the top edge of the screen to the top edge of the application area. |
BorderRight | No | 0 | BorderRight specifies the distance in pixels from the right edge of the screen to the right edge of the application area. |
BorderBottom | No | 0 | BorderBottom specifies the distance in pixels from the bottom edge of the screen to the bottom edge of the application area. |
Width | No | Screen width - BorderLeft - BorderRight | Width specifies the width in pixels of the application area. Note: If only Width is specified in the configuration file the application area will be centered horizontally. |
Height | No | Screen height - BorderTop - BorderBottom | Height specifies the width in pixels of the application
area. Note: If only Height is specified in the configuration file the application area will be centered vertically. |
EnableMousePointer | No | false | EnableMousePointer sets the default mouse pointer visibility of the application. The application may override this setting by calling XToiEnablePointer. Possible values: true, false. |
EnableMouseKeys | No | false | EnableMouseKeys sets the default mouse key control mode of the
application. If set to true, a set of keys will be used to control
the mouse pointer on the screen. Note: This setting is ignored if EnableMousePointer is false. Possible values: true, false. |
Element | Required? | Default value | Description |
---|---|---|---|
RegisterUri | No | - | RegisterUri is used to register URI and MIME types or combinations with the URI loader. The value must be on the form "uritype=http", "mimetype=text/html" or "uritype=http;mimetype=text/html". Any number of RegisterUri elements may be added to the property file. |
A typical property file could look like this:
<?xml version="1.0"?>
<ApplicationProperties>
<!-- "Name" is used by the KreaTV Navigator application -->
<Name>WWW</Name>
<PlatformVersion>2.1</PlatformVersion>
<Run>/usr/applications/web/web</Run>
<IsPopup>false</IsPopup>
<Width>612</Width>
<Height>490</Height>
<AutoRestart>true</AutoRestart>
<KillInvisible>false</KillInvisible>
<StartTimeout>10</StartTimeout>
<RegisterUri>uritype=http;mimetype=text/html</RegisterUri>
<RegisterUri>uritype=http</RegisterUri>
<RegisterUri>mimetype=text/html</RegisterUri>
<Uninstallable>true</Uninstallable>
<SourceIip>kreatv-app-web</SourceIip>
<GfxMemory>10000</GfxMemory>
</ApplicationProperties>