Platform configuration items and variables

The KreaTV Platform has a set of configuration items which are used for configuring it and which can also be used by applications running on the platform. There are also a number of variables which are set by the KreaTV platform and can be read by applications running on the platform.

At runtime, configuration items in the VIP are handled by the mechanism provided by the Information Service. Each configuration item or variable is represented by a specific information object and all objects managed by the Information Service are organized in the common Information Service storage structure.

Platform configuration items
Object Name Object Comment Values Sources
CFG_EITCACHE_NVOD
_IGNORERUNNINGSTATUS
cfg.eitcache.nvod
.ignorerunningstatus
Turns on or off running_status detection when trying to obtain NVOD information. Type:
String

Value set:
TRUE | FALSE

Default:
TRUE

  1. Volatile
  2. Infocast
  3. Default
CFG_IIPDISTRIBUTION cfg.iipdistribution Information about the dynamically downloadable IIPs. Type:
XML file, see notes

Value set:
See IIP distribution DTD.

Example:
See IIP distribution example.

  1. Infocast
CFG_INFOCAST cfg.infocast An XML file that describes which channels and objects the Information Service in the platform should listen to. Only objects that are listed in this file will be downloaded.

See more information in the Infocast client configuration page.

Type:
XML file
  1. Infocast
CFG_LOCALE_TIMEZONE cfg.locale.timezone Selects the time zone to use. The time zone configuration controls both the difference in time from UTC (Coordinated Universal Time) and daylight saving time.

See Time Service documentation for more a complete description of the format of the timezone string.

Type:
String

Default:
UTC

Example:
CET-1CEST-2,M3.5.0/02:00:00,M10.5.0/03:00:00 (Central European Time)

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_MEDIA_AUDIO
_AUTOSELECTION
cfg.media.audio
.autoselection
Turns on and off automatic selection of audio track. Type:
String

Value set:
TRUE | FALSE

Default:
TRUE

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_MEDIA_AUDIO
_FORMATPRIORITY
cfg.media.audio
.formatpriority
A prioritized case insensitive list of audio formats that is used for automatic audio selection. Type:
String

Value set:
Comma separated list with one or more of the following strings:

  • mpeg_stereo (Stereo versions of MPEG-1 Audio, MPEG-2 Audio (Not AAC), MPEG-4 Audio (Not AAC or HE-AAC))
  • mpeg_multichannel (Multichannel versions of MPEG-1 Audio, MPEG-2 Audio (Not AAC), MPEG-4 Audio (Not AAC or HE-AAC))
  • mpeg (Macro for mpeg_multichannel, mpeg_stereo)
  • ac3_stereo (All AC-3 stereo audio stream types)
  • ac3_multichannel (All AC-3 multichannel audio stream types)
  • ac3 (Macro for ac3_multichannel, ac3_stereo)
  • enhanced_ac3_stereo (All enhanced AC-3 stereo audio stream types)
  • enhanced_ac3_multichannel (All enhanced AC-3 multichannel audio stream types)
  • enhanced_ac3 (Macro for enhanced_ac3_multichannel, enhanced_ac3_stereo)
  • aac_stereo (All AAC stereo audio stream types)
  • aac_multichannel (All AAC multichannel audio stream types)
  • aac (Macro for aac_multichannel, aac_stereo)
  • he_aac_stereo (All HE AAC v1 stereo stream types)
  • he_aac_multichannel (All HE AAC v1 multichannel stream types)
  • he_aac (Macro for he_aac_multichannel, he_aac_stereo)
  • he_aac_v2_stereo (Stereo versions of MPEG-4 HE-AAC v2)
  • he_aac_v2_multichannel (Multichannel versions of MPEG-4 HE-AAC v2)
  • he_aac_v2 (Macro for he_aac_v2_multichannel, he_aac_v2_stereo)
  • dts_stereo (All DTS stream types)
  • dts_mutlichannel (All DTS stream types)
  • dts (Macro for dts_multichannel, dts_stereo)

Default:
ac3,mpeg

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_MEDIA_AUDIO
_LANGUAGEPRIORITY
cfg.media.audio
.languagepriority
A prioritized case insensitive list of audio languages that is used for automatic audio selection. This list is agnostic to B/T codes, i.e. if FRE or FRA is give, both FRE and FRA will match. Type:
String

Value set:
Comma separated list with values from ISO 639-2 B/T and ISO 639-3, E.g. "fra, eng". This list can have up to 255 entries.

Default:
"eng, swe"

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_AUDIOOUTPUT
_DOLBYDIGITAL_DRC
cfg.audiooutput
.dolbydigital.drc
List of Dynamic Range Control values for Dolby Digital audio format Type:
String

Value set:
line | rf | off (the later means that there is no dynamic range control).
(line and rf modes cause changes in the output volume level. With the compression mode set to rf, input PCM samples are scaled up by 12 dB. In line mode, input PCM samples are not scaled up at all).

Default:
rf

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_AUDIOOUTPUT
_DOLBYDIGITAL_DOWNMIX
cfg.audiooutput
.dolbydigital.downmix
List of Downmixing options for Dolby Digital audio format Type:
String

Value set:
ltrt | loro | auto
(loro is the standard stereo downmixformula.
ltrt is a Dolby Surround compatible stereo downmix formula.
auto means that which stereo downmix formula chosen is determined by parameters in the stream (as specified by Annex D of the AC-3 specification)).

Default:
auto

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_AUDIOOUTPUT
_DOLBYDIGITAL_LFE
cfg.audiooutput
.dolbydigital.lfe
List of Low Frequency Effects options for Dolby Digital audio format Type:
String

Value set:
TRUE | FALSE
(TRUE means that LFE is on, LFE downmixing disabled,
FALSE means that LFE is off, LFE downmixing enabled).

Default:
FALSE

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_MEDIA_AUDIO
_TYPEPRIORITY
cfg.media.audio
.typepriority
A prioritized case insensitive list of audio types that is used for automatic audio selection. Type:
String

Value set:
A prioritized case list between normal, hearing/visually impaired audio types that is used for automatic audio selection.

Default:
normal, hearing_impaired, visually_impaired

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_MEDIA_DRM_CGMSA cfg.media.drm.cgmsa The minimum CGMS-A level to use on the analog video outputs. Minimum is in this case on a per-bit level. This means that if this variable is configured to be e.g. 2, copyright asserted will always be signaled. However other CGMS-A source might according to the policy decide that copying should also be restricted and hence the level on the outputs will in such cases be 3.

The mapping from CGMS-A level to wide screen signaling output bits is done according to ETSI TS 102 825-10 V1.1.1 section 6.3.7.

Note that this variable is available only if KreaTV is configured for it.

Type:
Integer

Value set:
0 - (00) Copy freely (Copyright not asserted/Copying not restricted)
1 - (01) Copy no more (Copyright not asserted/Copying restricted)
2 - (10) Copy once (Copyright asserted/Copying not restricted)
3 - (11) Copy never (Copyright asserted/Copying restricted)

Default:
0

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_MEDIA_DRM_MACROVISION cfg.media.drm.macrovision The minimum Macrovision level to use on the analog video outputs. Minimum in this case is based on that a higher APS value is more restrictive

Note that if the use if this variable is depending on which DRM policy that KreaTV is configured to use.

Type:
Integer

Value set:
0 - No Macrovision protection
1 - AGC (Automatic Gain Control)
2 - 2-line Color Stripe
3 - 4-line Color Stripe

Default:
0

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_MEDIA_STREAMER cfg.media.streamer Contain parameters for the streamer

Parameters are buftime and startmode

Type:
XML file, see notes

Value set:
See streamer config DTD.

Example:
See streamer config example.

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_MEDIA_SUBTITLING
_AUTOSELECTION
cfg.media.subtitling
.autoselection
Turns on automatic selection of subtitle stream when it is TRUE and disable subtitle display otherwise. Type:
String

Value set:
TRUE | FALSE

Default:
TRUE

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_MEDIA_SUBTITLING
_LANGUAGEPRIORITY
cfg.media.subtitling
.languagepriority
A prioritized case insensitive list of subtitle languages that is used for automatic subtitling selection. This list is agnostic to B/T codes, i.e. if FRE or FRA is give, both FRE and FRA will match. Type:
String

Value set:
Comma separated list with values from ISO 639-2 B/T and ISO 639-3, E.g. "fra, eng". This list can have up to 255 entries.

Default:
"eng, swe"

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_MEDIA_SUBTITLING
_MODEPRIORITY
cfg.media.subtitling
.modepriority
A prioritized case insensitive list of subtitle modes that is used for automatic subtitling selection. Type:
String

Value set:
A prioritized case list between DVB and Teletext subtitling mode that is used for automatic subtitling selection.

Default:
"DVB, Teletext"

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_MEDIA_SUBTITLING
_TYPEPRIORITY
cfg.media.subtitling
.typepriority
A prioritized case insensitive list of subtitle types that is used for automatic subtitling selection. Type:
String

Value set:
A prioritized case list between normal and hearing impaired subtitle types that is used for automatic subtitling selection.

Default:
normal, hearing_impaired

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_MEDIA_TIMESHIFT
_PLAYBACKPOLICY
cfg.media.timeshift
.playbackpolicy
Specifies the behavior of time shift functionality when record operation is about to overwrite the current play location in circular buffer. Type:
String

Value set:
respect_pause | force_play

Default:
respect_pause

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_NTP_MAXPOLL cfg.ntp.maxpoll If kreatv-option-ntp is included in the boot image and cfg.ntp.server is set, the value of this variable, if set, will be used as the maxpoll value by the NTP client. Type:
Integer

Value set:
[minpoll - 17]

Default:
10

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_NTP_MINPOLL cfg.ntp.minpoll If kreatv-option-ntp is included in the boot image and cfg.ntp.server is set, the value of this variable, if set, will be used as the minpoll value by the NTP client. Type:
Integer

Value set:
[4 - maxpoll]

Default:
6

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_NTP_SERVER cfg.ntp.server If kreatv-option-ntp is included in the boot image, it will by default use the value of this object as the NTP server. Type:
String
  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_STANDBY_ALLOWUPDATE cfg.standby.allowupdate If new software is detected in the bootcast channel, this object controls if the STB will reboot and load the new software when entering standby.

If set to TRUE the STB will force reboot on standby.
If set to FALSE there is no forced reboot on standby.

Note!
The new configuration object only affects STBs with big flash for local bootimage storage. STBs with small flash always behave as before, i.e. no forced reboot.
Notification of new software is triggered by changing the bc_kernel_version in the bootcast information. See Operation & Maintenance Guide.

Type:
String, see notes

Value set:
TRUE | FALSE

Default:
TRUE

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_STANDBY_BOOTPOLICY cfg.standby.bootpolicy This object controls the state of the STB after powering on. The STB may stay in standby mode after start up if necessary.

If set to forced_standby the STB will always enter standby mode.
If set to forced_on the STB will always enter normal mode.
If set to last_state the STB will enter the same state as before power down.

If the value of the object is omitted the last_state is assumed and the STB will restore previous state on start up.
Type:
String

Value set:
forced_on | forced_standby | last_state

Default:
last_state

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CFG_STORAGE_AUTOMOUNT cfg.storage.automount Turns on and off automatic mounting of externally connected storage devices. Type:
String

Value set:
TRUE | FALSE

Default:
TRUE

  1. Volatile
  2. Flash File System
  3. Infocast
  4. Default
CMD_REBOOT cmd.reboot A request for IP-STB Reboot.

Used by the KreaTV Platform and the Remote Reboot application if included.

Type:
XML file, see notes

Value set:
See remote reboot DTD.

Example:
See remote reboot example.

  1. Infocast
VAR_IP_DHCP_240 var.ip._dhcp.240 Contains the value of option-240, set in the DHCP server. Type:
String
  1. DHCP server
VAR_IP_DHCP_241 var.ip._dhcp.241 Contains the value of option-241, set in the DHCP server. Type:
String
  1. DHCP server
VAR_IP_DHCP_242 var.ip._dhcp.242 Contains the value of option-242, set in the DHCP server. Type:
String
  1. DHCP server
VAR_IP_DHCP_243 var.ip._dhcp.243 Contains the value of option-243, set in the DHCP server. Type:
String
  1. DHCP server
VAR_TIME_VALID var.time.valid This object is set to "TRUE" when the Time Service has set a valid time. After that the clock will never suddenly change, only slowly be adjusted to be in sync with the time source. Type:
String

Value set:
TRUE | FALSE

Default:
FALSE

  1. Time Service
VAR_UTCTIME var.utctime This object is sent from the Infocast server and contains the current time in UTC format. During boot the IP-STB clock is set according to this if the time source is timeacast, later on it is used to keep the IP-STB in sync with the server clock.

This should never be used by applications to get the current time, use ordinary system functions like gettimeofday().

Type:
utctime
  1. Infocast