• Quick Start
  • Booting
  • Platform
  • Portals
  • References
    • API Reference TOI3
    • IIP Reference
  • Resources
ARRIS Enterprises, Inc. Confidential Information

Application configuration objects

The KreaTV Application Suite has a number of configuration items used by one or more of the applications. It is recommended by application developers to use the same configuration items when possible.

In run-time, configuration items in the IP-STB are handled by the mechanism provided by the Information Service. Each configuration item is represented by a specific information object and all objects managed by the Information Service are organized in the common Information Service storage structure. The information objects representing application configuration items are no exceptions to this rule.

CFG_LOCALE_UI (cfg.locale.ui)

The language used for text strings in applications and by the EIT cache to decide which data to store. The language code can either be on the form "xx-YY" or "zzz".

  1. "xx" is defined by ISO 639-1
  2. "YY" is defined by ISO 3166-1 alpha-2 code
  3. "zzz" is defined by ISO 639-2

Deprecated alias: config.uilanguage

Type:
String

Value set:
See ISO documents.

Default:
en-US

Example:
en-US: English language, US.
swe: Swedish language.

Sources: Volatile, Flash File System, Infocast, Default

CFG_MEDIA_CHANNELTABLE (cfg.media.channeltable)

The channel table.

An empty string represents an empty channel table.

Type:
Text file

Value set:
A table of channels.
The format of each channel is like: channel_number;channel_name;url;
The channel_number is mapped to the number keys of the remote control.
Fields may be left empty, but the correct number of semicolons must be present.

Default:
[empty string]

Example:
1;Channel1;224.5.7.10:5000;
2;Test channel;224.5.7.11:10000;

Sources: Infocast, Default

CFG_PORTAL_MASTERAUDIO (cfg.portal.masteraudio)

The master audio used for application/portal to specify which volume should be considered as the global volume when controlled from the video tag in HTML/SVG.

Setting analog as master audio will impact the analog audio output, while setting decoder as master audio will impact all of the audio outputs including HDMI, SPDIF, ANALOG and VCR outputs, and any pass-through audio will not be affected by volume adjustments.

If nothing is set or an invalid value is set, it will default to analog.

Type:
String

Value set:

  • analog
  • decoder

Default:
analog

Sources: Volatile, Flash File System, Default

CFG_PORTAL_PROXYLIST (cfg.portal.proxylist)

Configuration of external HTTP/HTTPS proxies. Used by the web and portal applications.

See the proxy list definition for further description.

Deprecated alias: config.proxylist

Type:
XML formatted string

Value set:
See proxy list DTD

Default:
<?xml version="1.0"?><!DOCTYPE ProxyList SYSTEM "proxylist.dtd"><ProxyList></ProxyList>

Example:
See proxy list example.

Sources: Volatile, Flash File System, Infocast

CFG_PORTAL_RENDERINGBUFFER_HEIGHT (cfg.portal.renderingbuffer.height)

The actual height of the rendering buffer. If the height is larger than the maximum value defined in the application property file, the maximum value will be used instead.

Type:
Integer

Value set:
See portal application graphics configuration

Default:
followhd

Sources: Volatile, Flash File System, Infocast, Default

CFG_PORTAL_RENDERINGBUFFER_WIDTH (cfg.portal.renderingbuffer.width)

The actual width of the rendering buffer. If the width is larger than the maximum value defined in the application property file, the maximum value will be used instead.

Type:
Integer

Value set:
See portal application graphics configuration

Default:
followhd

Sources: Volatile, Flash File System, Infocast, Default

CFG_PORTAL_SPATIALNAVIGATION_ENABLED (cfg.portal.spatialnavigation.enabled)

Spatial navigation is needed when browsing ordinary web pages, but can disturb portals and leanback sites which usually relies on their own navigation mechanism.

Support for this option differs between portal implementations.

Type:
String

Value set:

  • TRUE
    spatial navigation enabled
  • FALSE
    spatial navigation disabled

Default:
FALSE

Sources: Volatile, Flash File System, Default

CFG_PORTAL_STARTURL (cfg.portal.starturl)

The initial URL used by the portal application. This has precedence over other mechanisms for defining a start URL, such as a white list. It also overrides white list sandbox mechanism.

If not set, the first URL specified in CFG_PORTAL_WHITELISTURLS will be used as the start URL.

Type:
String

Sources: Volatile, Flash File System, Default

CFG_PORTAL_SUBTITLES_ENABLED (cfg.portal.subtitles.enabled)

Specifies whether to show subtitles or not. Currently, it's available for SVG and Webkit browser. Note that subtitles are also controlled via the CFG_MEDIA_SUBTITLING_AUTOSELECTION object.

This object is deprecated, please use CFG_MEDIA_SUBTITLING_ENABLED instead.

Type:
String

Value set:

  • TRUE
  • FALSE

Default:
TRUE

Sources: Volatile, Flash File System, Infocast, Default

CFG_PORTAL_TIMELIMIT (cfg.portal.timelimit)

Controls how long (in seconds) to wait for time synchronization before loading the initial URL.

Type:
Integer

Value set:

  • 0
    do not wait at all
  • -1
    wait forever

Default:
0

Sources: Volatile, Flash File System, Default

CFG_PORTAL_WHITELISTURLS (cfg.portal.whitelisturls)

The URL of the portals. Used by the portal application.

See the portal URL definition for further description.

Deprecated alias: config.portalurls

Type:
XML formatted string

Value set:
See portal URLs DTD

Default:
<?xml version="1.0"?><!DOCTYPE PortalURLs SYSTEM "whitelisturls.dtd"><PortalURLs></PortalURLs>

Example:
See portal URLs example.

Sources: Volatile, Flash File System, Infocast

CFG_WEBKIT_USERAGENT (cfg.webkit.useragent)

If set to a non-empty value, webkit will use the value as the user-agent string in the HTTP request. The current user-agent string can be obtained through javascipt, e.g. 'navigator.userAgent'.

Type:
String

Default:
[empty string]

Sources: Volatile, Flash File System, Infocast

CMD_REBOOTQUERY_MESSAGE (cmd.rebootquery.message)

A request for IP-STB reboot.

This message is set by the platform if a user dialog should be shown.

Type:
XML formatted string

Value set:
See remote reboot DTD

Example:
See remote reboot example.

Sources: Volatile

CMD_REBOOTQUERY_RESPONSE (cmd.rebootquery.response)

Response for IP-STB reboot request.

The object should be set after a remote reboot query.

Type:
String

Value set:

  • Yes
    The STB reboots immediately
  • No
    The STB will be rebooted during next standby

Sources: Volatile

5.0.1

Copyright (c) 2016 ARRIS Enterprises, LLC. All Rights Reserved. ARRIS Enterprises, LLC. Confidential Information.