Platform configuration objects
The KreaTV Platform has a set of configuration objects which are
used for configuring it and which can also be used by applications
running on the platform.
At runtime, configuration objects in the STB are handled by the
mechanism provided by the Information Service. All objects that are
managed by the Information Service are organized in the common
Information Service storage structure.
CFG_AUDIOOUTPUT_DOLBYDIGITAL_DOWNMIX (cfg.audiooutput.dolbydigital.downmix)
|
List of Downmixing options for Dolby Digital audio format
|
Type: String
Value set:
ltrt
Dolby Surround compatible stereo downmix formula
loro The standard stereo downmixformula
auto
The stereo downmix formula chosen is determined by parameters
in the stream (as specified by Annex D of the AC-3 specification).
Default: auto
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_AUDIOOUTPUT_DOLBYDIGITAL_DRC (cfg.audiooutput.dolbydigital.drc)
|
List of Dynamic Range Control values for Dolby Digital audio
format
|
Type: String
Value set:
rf
This mode cause changes in the output volume level. Input PCM
samples are scaled up by 12 dB.
line
This mode cause changes in the output volume level. Input PCM
samples are not scaled up at all.
off No dynamic range control
Default: rf
|
|
Sources: Volatile, Flash File System, Infocast, 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 LFE is on, LFE downmixing is disabled.
FALSE LFE is off, LFE downmixing is enabled.
Default: FALSE
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_AUDIOOUTPUT_DOLBYVOLUME_ENABLED (cfg.audiooutput.dolbyvolume.enabled)
|
This object is set to enable/disable Dolby Volume.
|
Type: String
Value set:
Default: FALSE
|
|
Sources: Volatile, Flash File System
|
CFG_AUDIOOUTPUT_EBU_HDMIMODE (cfg.audiooutput.ebu.hdmimode)
|
According to EBU document TECH 3344 HDMI devices can
operate in two different modes:
- TV mode
- Home Theatre mode
Devices in "TV mode" expect input loudness of -23 LUFS
while devices in "Home Theatre mode" expect input loudness
of -31 LUFS.
Use this object to configure which mode the connected
HDMI device is in and thus also which audio loudness level
to use.
This setting only affects audio that is decoded by the
STB.
|
Type: String
Value set:
tv TV mode
hometheatre Home Theatre mode
Default: tv
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_CA_EMM_SERVER (cfg.ca.emm.server)
|
The CA EMM server address. Format is IP:port.
|
Type: String
Example: 144.187.154.9:80
|
|
Sources: Volatile, Flash File System, Infocast
|
CFG_CEC_OSD_NAME (cfg.cec.osd.name)
|
Information about the OSD name of STB.
|
Type: String
Example: VIP1963
|
|
Sources: Volatile, Flash File System
|
CFG_CONTENT_AGGREGATION_ENABLED (cfg.content.aggregation.enabled)
|
If asset sharing is enabled in the boot image config this object
controls if the client part should be active or not. If enabled, assets
available on STBs on the local network are aggregated and made
available to the application using the same interfaces as for local
assets.
|
Type: String
Value set:
TRUE
The platform will automatically discover other STBs in the network
that have asset sharing enabled and give the local application
access to assets on these STBs.
FALSE
The platform will not try to discover any STBs in the network with
asset sharing enabled.
Default: TRUE
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_CONTENT_DISTRIBUTION_ENABLED (cfg.content.distribution.enabled)
|
If asset sharing is enabled in the boot image config this object
controls if the server part should be active or not. If enabled, local
assets are made available for distribution to other STBs on the local
network.
|
Type: String
Value set:
TRUE
This STB can be discovered by other STBs in the network and they
will have access to all assets.
FALSE
Assets on this STB are not shared with any remote STB.
Default: FALSE
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_DLNA_DMR_ENABLED (cfg.dlna.dmr.enabled)
|
Starts/stops the local DLNA DMR (Digital Media Renderer)
|
Type: String
Value set:
TRUE
The local DLNA DMR is running, discoverable and its services are
fully operational; setting the value in run-time starts DMR and its
UPnP AV MediaRenderer device.
FALSE
The local DMR is shut down, undiscoverable and its services are
stopped; setting the value in run-time gracefully stops the DMR and
its UPnP AV MediaRenderer device.
Default: FALSE
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_DLNA_DMR_FRIENDLYNAME (cfg.dlna.dmr.friendlyname)
|
The friendly name of the DLNA DMR that is presented to the DLNA
network.
Changing of the friendly name in run-time gracefully restarts the
UPnP AV MediaRenderer device so that changes are visible to the DLNA
network immediately.
Replaced by CFG_SYSTEM_FRIENDLYNAME.
|
|
|
Sources: Volatile, Flash File System, Default
|
CFG_DLNA_DMS_ENABLED (cfg.dlna.dms.enabled)
|
Starts/stops the local DLNA DMS (Digital Media Server).
|
Type: String
Value set:
TRUE
The local DLNA DMS is running, discoverable and its services are
fully operational; setting the value in run-time starts DMS and its
UPnP AV MediaServer device.
FALSE
The local DMS is shut down, undiscoverable and its services are
stopped; setting the value in run-time gracefully stops the DMS and
its UPnP AV MediaServer device.
Default: FALSE
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_DLNA_DMS_FRIENDLYNAME (cfg.dlna.dms.friendlyname)
|
The friendly name of the local DLNA DMS that is presented to the
DLNA network.
Changing of the friendly name in run-time gracefully restarts
the UPnP AV MediaServer device so that changes are visible to the
DLNA network immediately.
Replaced by CFG_SYSTEM_FRIENDLYNAME.
|
|
|
Sources: Volatile, Flash File System, Default
|
CFG_EITCACHE_LANGUAGES (cfg.eitcache.languages)
|
A priority list of which languages in EIT data that shall be
cached and provided to the application for display. The language set
by
CFG_LOCALE_UI will always have the highest priority for being
displayed.
Asterisk (*) can be used in the list of languages to store all
languages of the EIT data. It shall be noted that this may consume
significant amount of memory depending on what information that is
provided in the network.
For example, when using "eng,*" any occurrence of English will
have priority, but all available languages will be cached. The
language code can either be on the form "xx-YY" or "zzz".
- "xx" is defined by ISO 639-1
- "YY" is defined by ISO 3166-1 alpha-2 code
- "zzz" is defined by ISO 639-2
|
Type: String
Value set: See ISO documents.
Example:
en-US: English language, US.
swe: Swedish language.
|
|
Sources: Volatile, Flash File System, Infocast
|
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:
Default: TRUE
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_FCC_CHANNELS (cfg.fcc.channels)
|
Specifies FCC channels info with XML format, including some basic
parameters of FCC feature.
|
Type: String
Value set:
Example:
|
|
Sources: Volatile, Flash File System, Default
|
CFG_FRONTPANEL_INTENSITY (cfg.frontpanel.intensity)
|
Set front panel intensity level given in percent, i.e. a value
between 0 and 100.
|
Type: Integer
Value set: 0-100
Default: 20
|
|
Sources: Volatile, Flash File System, Default
|
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 formatted string
|
|
Sources: Infocast
|
CFG_INPUT_KEYMAP (cfg.input.keymap)
|
The name of the keymap file to use for all user input. The keymap
decides which key events will be delivered to the applications.
|
Type: String
Value set:
Any value set from
kreatv-option-input-keymaps.
Default: pc-en
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_IP_DHCP_USERCLASS (cfg.ip.dhcp.userclass)
|
If set, DHCP client will use this object value as user class
option to DHCP server.
|
Type: String
|
|
Sources: Flash File System, Default
|
CFG_LOCALE_TIMEZONE (cfg.locale.timezone)
|
Selects the time zone to use. The time zone configuration can be
in one of three formats according to system ability: the difference
in time from UTC (Coordinated Universal Time), daylight saving time
and time zone information database.
See
Time Service documentation for a more 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)
Europe/Berlin (Berlin Time)
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_LOG_UPLOAD_ADDRESS (cfg.log.upload.address)
|
The remote address which the log will be sent to when logging is enabled.
It should be an https address. For example, https://www.example.com:3000,
or https://10.202.6.188:3002.
|
Type: String
|
|
Sources: Volatile, Flash File System, Infocast
|
CFG_LOG_UPLOAD_ENDTIME (cfg.log.upload.endtime)
|
This object controls when log uploading shall be active. As long as the end
time has not been reached the log uploading will be active. During this active
period any valid new time that is set will be respected. The uploading will
however stop immediately if an invalid time is set or the object is removed.
The time format used is UTC format '2015-06-18T16:32:59Z' and is a subset of
the ISO 8601 date-time format.
The valid range is between '1970-01-01T00:00:00Z' and '2099-12-31T23:59:59Z'.
|
Type: String
|
|
Sources: Volatile, Flash File System, Infocast
|
CFG_MEDIA_AUDIO_AUTOSELECTION (cfg.media.audio.autoselection)
|
Turns on and off automatic selection of audio track.
|
Type: String
Value set:
Default: TRUE
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_MEDIA_AUDIO_FORMATPRIORITY (cfg.media.audio.formatpriority)
|
A prioritized case-insensitive list of audio formats that is used
for automatic audio selection. Selection of audio streams based on
codec is generally supported but selection based on codec and variant
(stereo, multichannel) is only supported for specific TV systems
where the variant can be extracted without decoding the stream.
|
Type: String
Value set:
A comma-separated list containing one or more values. The
following set of values are always available.
mpeg
Stereo or multichannel versions of MPEG-1 Audio, MPEG-2 Audio
(Not AAC), MPEG-4 Audio (Not AAC or HE-AAC)
ac3 All AC-3 audio stream types
enhanced_ac3
All enhanced AC-3 audio stream types
aac All AAC audio stream types
he_aac All HE AAC v1 stream types
he_aac_v2 All versions of MPEG-4 HE-AAC v2
dts All DTS stream types
A comma-separated list containing one or more values. The
following set of values are available pending TV system support.
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)
ac3_stereo
All AC-3 stereo audio stream types
ac3_multichannel
All AC-3 multichannel audio stream types
enhanced_ac3_stereo
All enhanced AC-3 stereo audio stream types
enhanced_ac3_multichannel
All enhanced AC-3 multichannel audio stream types
aac_stereo All AAC stereo audio stream types
aac_multichannel
All AAC multichannel audio stream types
he_aac_stereo
All HE AAC v1 stereo stream types
he_aac_multichannel
All HE AAC v1 multichannel stream types
he_aac_v2_stereo
Stereo versions of MPEG-4 HE-AAC v2
he_aac_v2_multichannel
Multichannel versions of MPEG-4 HE-AAC v2
dts_stereo All stereo DTS stream types
dts_multichannel
All multichannel DTS stream types
Default: ac3,mpeg
|
|
Sources: Volatile, Flash File System, Infocast, 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 one of FRE or FRA is given, both FRE and FRA will
match.
This object supports the "any" wildcard which matches any language.
Using this wildcard avoids audio tracks from being penalized during
auto selection just because their language is not included
in this object. Languages matching the "any" wildcard are given a
lower priority compared to languages that are listed explicitly.
See
CFG_MEDIA_AUDIO_PRIORITYORDER
for additional details.
|
Type: String
Value set:
Comma separated list with values from ISO 639-2 B/T and ISO 639-3,
e.g. "fra,eng", or "any". This list can have up to 255
entries.
Default: "eng,swe"
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_MEDIA_AUDIO_PRIORITYORDER (cfg.media.audio.priorityorder)
|
The KreaTV platform can automatically select the audio track
based on several selection strategies. One strategy is to prioritize
tracks based on language. Other strategies prioritize them based on
the encoding or based on the track type, like normal versus
visually impaired.
This object is a prioritized case-insensitive list defining
the relative priority of the different auto selection strategies.
The first entry in the list has a greater weight and the following
entries have lower weights each.
Regardless of the order in which the strategies are provided, the
default behavior is to penalize audio tracks in languages that are
not listed in
CFG_MEDIA_AUDIO_LANGUAGEPRIORITY.
This may lead to situations where a preferred format, like AC3, is
available but not chosen because it comes in a language that is not
listed in CFG_MEDIA_AUDIO_LANGUAGEPRIORITY. To override this behavior
and make KreaTV consider all tracks irrespective of their language,
you can add the "any" wildcard to the language priority list.
If the priority order is 'type, format, language', for example,
then any matching type and format have a higher weight than language,
as long as the track matches a language specified in
CFG_MEDIA_AUDIO_LANGUAGEPRIORITY.
|
Type: String
Value set:
Comma separated list with one or more of the following.
Default: "language,type,format"
|
|
Sources: Volatile, Flash File System, Infocast, 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 list of normal, hearing_impaired and visually_impaired.
Default: normal,hearing_impaired,visually_impaired
|
|
Sources: Volatile, Flash File System, Infocast, 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 object 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 object 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
|
|
Sources: Volatile, Flash File System, Infocast, 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 the use of this object 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
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_MEDIA_STREAMER (cfg.media.streamer)
CFG_MEDIA_SUBTITLING_AUTOSELECTION (cfg.media.subtitling.autoselection)
|
Turns on automatic selection of subtitle stream when it is TRUE
and disable subtitle display otherwise. Note that subtitles for
portals are also controlled via the
CFG_MEDIA_SUBTITLING_ENABLED object.
|
Type: String
Value set:
Default: TRUE
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_MEDIA_SUBTITLING_ENABLED (cfg.media.subtitling.enabled)
|
Specifies whether to show subtitles or not. Note that subtitles are also
controlled via the
CFG_MEDIA_SUBTITLING_AUTOSELECTION object.
|
Type: String
Value set:
Default: TRUE
|
|
Sources: Volatile, Flash File System, Infocast, 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"
|
|
Sources: Volatile, Flash File System, Infocast, 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 WebVTT, DVB and Teletext subtitling
mode that is used for automatic subtitling selection.
Default: "WebVTT,DVB,Teletext"
|
|
Sources: Volatile, Flash File System, Infocast, 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
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_MEDIA_TELETEXTSUBTITLING_TRANSPARENCY (cfg.media.teletextsubtitling.transparency)
|
Specifies the teletext subtitles background transparency
percentage.
|
Type: Integer
Value set: The value shall be in the range [0, 100].
0 Opacity
100 Full transparency
Default: 0
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_MEDIA_TELETEXTSUBTITLING_VERTICALADJUSTMENT (cfg.media.teletextsubtitling.verticaladjustment)
|
Used to adjust the teletext subtitles position in vertical
direction. The value shall be an integer (in pixels) to tune the
relevant vertical position. Negative value means up and positive
value means down.
|
Type: Integer
Default: 0
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_MEDIA_TIMESHIFT_PLAYBACKPOLICY (cfg.media.timeshift.playbackpolicy)
|
Specifies the behavior of timeshift functionality when record
operation is about to overwrite the current play location in
circular buffer.
|
Type: String
Value set:
Default: respect_pause
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_MEDIA_TIMESHIFT_RECORDINGPOLICY (cfg.media.timeshift.recordingpolicy)
|
Specifies the behavior of timeshift functionality when the
timeshift buffering is started. In normal mode the timeshift buffer
is required to be discarded before starting the buffering. In
continuous mode it is accepted to start the buffering with content
in the buffer. The buffering will continue at the end of the
buffer.
|
Type: String
Value set:
Default: normal
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_NTP_MAXPOLL (cfg.ntp.maxpoll)
|
Maximum interval between server polls used by the NTP client.
|
Type: Integer
Value set: A value between minpoll and 17.
Default: 10
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_NTP_MINPOLL (cfg.ntp.minpoll)
|
Minimum interval between server polls used by the NTP client.
|
Type: Integer
Value set: A value between 4 and maxpoll.
Default: 6
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_NTP_RETRY_ATTEMPTS (cfg.ntp.retry.attempts)
|
Specifies a number of re-tries to connect to each NTP server.
|
Type: Integer
|
|
Sources: Volatile, Flash File System, Default
|
CFG_NTP_RETRY_INTERVAL (cfg.ntp.retry.interval)
|
Specifies a retry interval after unsuccessful connection attempt
to an NTP server.
|
Type: Integer
|
|
Sources: Volatile, Flash File System, Default
|
CFG_NTP_SERVERS (cfg.ntp.servers)
|
Specifies comma separated list of NTP server addresses in
descending priority order.
|
Type: String
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_STANDBY_ALLOWREBOOT (cfg.standby.allowreboot)
|
This object controls if the STB is allowed to reboot when entering
standby.
|
Type: String
Value set:
TRUE
The STB will be allowed to reboot on standby.
FALSE
The STB will not be allowed to reboot on standby.
Default: TRUE
|
|
Sources: Volatile, Flash File System, Infocast, 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.
|
Type: String
Value set:
forced_standby Always enter standby mode
forced_on Always enter normal mode
last_state Enter the same state as before power down
Default: last_state
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_STORAGE_AUTOMOUNT (cfg.storage.automount)
|
Turns on and off automatic mounting of externally connected
storage devices.
|
Type: String
Value set:
Default: TRUE
|
|
Sources: Volatile, Flash File System, Infocast, Default
|
CFG_SYSTEM_FRIENDLYNAME (cfg.system.friendlyname)
|
The system's friendly name is used when there is a need to give the
system a name that an end user can use to identify the box (e.g. DLNA
DMR/DMS, asset sharing, etc.). If not set, the system will use a
default value to indicate that it is an ARRIS STB (ARRIS + the value of
CONST_HW_PRODUCTNAME).
|
Type: String
Value set: Should be less than 64 characters.
Example: Bedroom STB
|
|
Sources: Volatile, Flash File System, Default
|
CFG_VERIMATRIX_HLS_ENABLED (cfg.verimatrix.hls.enabled)
|
This object can enable/disable to playback Verimatrix encrypted
HLS stream and it's only valid when Verimatrix HLS IIP is configured.
|
Type: String
Value set:
TRUE
The Verimatrix HLS service will be enabled.
FALSE
The Verimatrix HLS service will be disabled.
Default: TRUE
|
|
Sources: Volatile, Infocast, Flash File System, Default
|
VAR_LOG_UPLOAD_STATUS (var.log.upload.status)
|
Indicates the log upload status (if any).
|
Type: String
Value set:
Enabled Remote logging is working
Disabled Remote logging is stopped
CertificateError Certificate error when uploading log
ConnectionError Connection error when uploading log
Default: Disabled
|
|
Sources: Volatile, Flash File System, Default
|
|