ToiInformationService
The Information Service is a responsible for collecting and
storing information objects, i.e. simple string key/value
pairs. The data is retrieved from different adapters,
e.g. infocast, flash file system and firmware. Each adapter is a
source and possibly a destination where the information object can
be set.
Some of the adapters are editable through the set and unset methods. The
editable adapters are divided into volatile and permanent, where the
volatile data is lost at reboot and platform restart (caused by standby or
other reason) while the permanent data is stored permanently.
If an object is available in more than one adapter, the service
will use the value in the highest priority adapter. There is a
strict priority order, which means that setting a value may not
have any effect if a higher priority adapter has a value for the
object.
Service:
This is a service and can be accessed through toi.informationService
Method Summary
|
get
(
names
)
→ Array.<ToiInformationService.ToiObjectInfo>
|
This method returns information about multiple objects. In case a requested
object does not exist, the status in the corresponding object information
will be ToiInformationService.STATUS_NO_OBJECT.
|
|
isObjectDefined
(
objectName
)
→ exists
|
This method is used to test if an object exists, i.e. if the
object has a value in any adapter.
|
|
set
(
objects
,
type
)
|
This method sets multiple objects at once. All objects are set for the
given storage type. In case there is a failure, no values will be set
for any of the objects. If successful, all objects have been set.
|
|
subscribeObject
(
eventListener
,
objectExpression
,
callbackFlag
)
|
Subscribes to value changes for objects. Listener
is called when the object value changes. Expression can include
wildcards.
|
|
unset
(
names
,
type
)
|
Removes the values of objects from adapters of the specified
storage type (values for objects may still exist in other adapters).
|
|
unsubscribeObject
(
eventListener
,
objectExpression
)
|
This method is used to remove a subscription. If the expression
contains a wildcard, only the exact expression is removed, e.g. if you
have subscribed to cfg. and cfg.ipaddress and then unsubscribe
cfg., only the cfg.* subscription will be removed. No exception is
thrown if the subscription does not exist.
|
Inherited Methods
|
addEventListener
(
type
,
listener
)
|
This method registers an event listener for a specific event.
Multiple listeners can be added for the same event. Events are
broadcast to all registered listeners.
|
|
removeEventListener
(
type
,
listener
)
|
This method removes an event listener for a specific event.
|
Type Definitions
ToiObjectName
(Type:
string)
|
|
|
|
|
ToiStorageType
(Type:
enum)
|
The TStorageType datatype enumerates the different ways to store objects
in the Information Service.
|
|
|
Methods
This method registers an event listener for a specific event.
Multiple listeners can be added for the same event. Events are
broadcast to all registered listeners.
Inherited From:
Parameters:
-
| Name |
Type |
Description |
type
|
number
|
The event type of the event to subscribe to. |
listener
|
ToiEventListener
|
The JavaScript function that will receive
events. |
Throws:
-
|
ToiInvalidArgumentException Raised if the event type is not supported by
this object or if the listener is not a valid
JavaScript function. This exception is also
raised if the application calls
addEventListener with the same combination of
type and listener twice. |
This method is used to test if an object exists, i.e. if the
object has a value in any adapter.
Parameters:
-
| Name |
Type |
Description |
objectName
|
string
|
The name of the object. |
Returns:
-
Whether the object exists or not.
Type:
boolean
This method removes an event listener for a specific event.
Inherited From:
Parameters:
-
| Name |
Type |
Description |
type
|
number
|
The event type of the event to remove the listener from. |
listener
|
ToiEventListener
|
The JavaScript function that was previously
added as an event listener. |
Throws:
-
|
ToiInvalidArgumentException
Raised if the event type is not supported by
this object or if the listener is not a valid
JavaScript function. This exception is also
raised if the listener has not previously been
added. |
This method sets multiple objects at once. All objects are set for the
given storage type. In case there is a failure, no values will be set
for any of the objects. If successful, all objects have been set.
Parameters:
-
Throws:
-
This method is used to subscribe to value changes for an
object. The subscriber is notified on the
ToiInformationObjectsChangedEvent. If the object exists
when the subscription is made, a callback will be triggered
as soon as possible if the
callbackFlag is set, otherwise the object is requested from the
adapters and a notification is made when the object becomes
available.
The expression used can be a name of an object or an expression with a
wildcard (). The wildcard may only be used at the end of an expression
and immediately after a dot (.), e.g. cfg., otherwise it is treated
as an ordinary character.
See also:
-
Parameters:
-
| Name |
Type |
Description |
eventListener
|
ToiEventListener
|
The eventListener that has been registered. |
objectExpression
|
string
|
An object name or an expression with wildcard |
callbackFlag
|
boolean
|
If true, an immediate callback is invoked if
the object exists. |
Throws:
-
This method is used to remove the values of multiple objects at once.
Object values can be removed from either volatile or permanent storage.
If an object has no value it is silently ignored. It should be noted that
even if this method removes a value from given storage type, it may still
exist for the other type. For instance, an object may have been set through
infocast, but this method can only remove a value from either a permanent
storage like the flash file system, or a volatile storage like RAM.
In case there is a failure, no objects will be unset. If successful,
all objects have been unset.
Parameters:
-
Throws:
-
This method is used to remove a subscription. If the expression
contains a wildcard, only the exact expression is removed, e.g. if you
have subscribed to cfg. and cfg.ipaddress and then unsubscribe
cfg., only the cfg.* subscription will be removed. No exception is
thrown if the subscription does not exist.
See also:
-
Parameters:
-
| Name |
Type |
Description |
eventListener
|
ToiEventListener
|
The eventListener that has been registered. |
objectExpression
|
string
|
An object name or an expression with wildcard. |
Throws:
-
Members
This constant can be also be accessed from toi.consts.ToiInformationService.ON_OBJECTS_CHANGED.
This constant can be also be accessed from toi.consts.ToiInformationService.ON_OBJECTS_REMOVED.
CFG_AUDIOOUTPUT_DOLBYDIGITAL_DOWNMIX
(Type:
string)
(value = 'cfg.audiooutput.dolbydigital.downmix')
(static, constant)
List of Downmixing options applicable for Dolby Digital audio output
format.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_AUDIOOUTPUT_DOLBYDIGITAL_DOWNMIX.
CFG_AUDIOOUTPUT_DOLBYDIGITAL_DRC
(Type:
string)
(value = 'cfg.audiooutput.dolbydigital.drc')
(static, constant)
Dynamic Range Control list of options applicable for Dolby Digital
audio output format.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_AUDIOOUTPUT_DOLBYDIGITAL_DRC.
CFG_AUDIOOUTPUT_DOLBYDIGITAL_LFE
(Type:
string)
(value = 'cfg.audiooutput.dolbydigital.lfe')
(static, constant)
List of options applicable for Dolby Digital Low Frequence Effects
audio output format.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_AUDIOOUTPUT_DOLBYDIGITAL_LFE.
CFG_AUDIOOUTPUT_DOLBYVOLUME_ENABLED
(Type:
string)
(value = 'cfg.audiooutput.dolbyvolume.enabled')
(static, constant)
Enable/Disable Dolby Volume.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_AUDIOOUTPUT_DOLBYVOLUME_ENABLED.
CFG_CA_EMM_SERVER
(Type:
string)
(value = 'cfg.ca.emm.server')
(static, constant)
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_CA_EMM_SERVER.
CFG_CEC_OSD_NAME
(Type:
string)
(value = 'cfg.cec.osd.name')
(static, constant)
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_CEC_OSD_NAME.
CFG_CONTENT_AGGREGATION_ENABLED
(Type:
string)
(value = 'cfg.content.aggregation.enabled')
(static, constant)
Enables/disables discovery of shared assets on the local network.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_CONTENT_AGGREGATION_ENABLED.
CFG_CONTENT_DISTRIBUTION_ENABLED
(Type:
string)
(value = 'cfg.content.distribution.enabled')
(static, constant)
Enables/disables sharing of assets.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_CONTENT_DISTRIBUTION_ENABLED.
CFG_DLNA_DMR_ENABLED
(Type:
string)
(value = 'cfg.dlna.dmr.enabled')
(static, constant)
Starts/stops the local DLNA DMR (Digital Media Renderer).
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_DLNA_DMR_ENABLED.
CFG_DLNA_DMR_FRIENDLYNAME
(Type:
string)
(value = 'cfg.dlna.dmr.friendlyname')
(static, constant)
- Deprecated:
-
The friendly name of the local DLNA DMR (Digital Media Renderer)
that is presented to the DLNA network.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_DLNA_DMR_FRIENDLYNAME.
CFG_DLNA_DMS_ENABLED
(Type:
string)
(value = 'cfg.dlna.dms.enabled')
(static, constant)
Starts/stops the local DLNA DMS (Digital Media Server).
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_DLNA_DMS_ENABLED.
CFG_DLNA_DMS_FRIENDLYNAME
(Type:
string)
(value = 'cfg.dlna.dms.friendlyname')
(static, constant)
- Deprecated:
-
The friendly name of the local DLNA DMS (Digital Media Server)
that is presented to the DLNA network.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_DLNA_DMS_FRIENDLYNAME.
CFG_EITCACHE_LANGUAGES
(Type:
string)
(value = 'cfg.eitcache.languages')
(static, constant)
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.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_EITCACHE_LANGUAGES.
CFG_EITCACHE_NVOD_IGNORERUNNINGSTATUS
(Type:
string)
(value = 'cfg.eitcache.nvod.ignorerunningstatus')
(static, constant)
Turns on or off running_status detection when trying to obtain NVOD
information.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_EITCACHE_NVOD_IGNORERUNNINGSTATUS.
CFG_FCC_CHANNELS
(Type:
string)
(value = 'cfg.fcc.channels')
(static, constant)
Specifies FCC channels info with XML format.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_FCC_CHANNELS.
CFG_FRONTPANEL_INTENSITY
(Type:
string)
(value = 'cfg.frontpanel.intensity')
(static, constant)
The intensity of the display, given in percent, i.e. a value between
0 and 100.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_FRONTPANEL_INTENSITY.
CFG_INFOCAST
(Type:
string)
(value = 'cfg.infocast')
(static, constant)
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.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_INFOCAST.
CFG_INPUT_KEYMAP
(Type:
string)
(value = 'cfg.input.keymap')
(static, constant)
The name of the keymap file to use for all user input.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_INPUT_KEYMAP.
CFG_IP_DHCP_USERCLASS
(Type:
string)
(value = 'cfg.ip.dhcp.userclass')
(static, constant)
This object specifies which user class the DHCP client shall use.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_IP_DHCP_USERCLASS.
CFG_LOCALE_TIMEZONE
(Type:
string)
(value = 'cfg.locale.timezone')
(static, constant)
Selects the time zone to use on VIP19xx. The time zone configuration
controls both the difference in time from UTC (Coordinated Universal
Time) and daylight saving time.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_LOCALE_TIMEZONE.
CFG_LOCALE_UI
(Type:
string)
(value = 'cfg.locale.ui')
(static, constant)
The language used for text strings in applications and by the EIT cache
to decide which data to store.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_LOCALE_UI.
CFG_LOG_UPLOAD_ADDRESS
(Type:
string)
(value = 'cfg.log.upload.address')
(static, constant)
The address of the server that shall receive the logging.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_LOG_UPLOAD_ADDRESS.
CFG_LOG_UPLOAD_ENDTIME
(Type:
string)
(value = 'cfg.log.upload.endtime')
(static, constant)
The time when the logging shall stop.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_LOG_UPLOAD_ENDTIME.
CFG_MEDIA_AUDIO_AUTOSELECTION
(Type:
string)
(value = 'cfg.media.audio.autoselection')
(static, constant)
Turns on and off automatic selection of audio track.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_AUDIO_AUTOSELECTION.
CFG_MEDIA_AUDIO_FORMATPRIORITY
(Type:
string)
(value = 'cfg.media.audio.formatpriority')
(static, constant)
A prioritized case insensitive list of audio formats that is used for
automatic audio selection.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_AUDIO_FORMATPRIORITY.
CFG_MEDIA_AUDIO_LANGUAGEPRIORITY
(Type:
string)
(value = 'cfg.media.audio.languagepriority')
(static, constant)
A prioritized case insensitive list of audio languages that is used for
automatic audio selection.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_AUDIO_LANGUAGEPRIORITY.
CFG_MEDIA_AUDIO_PRIORITYORDER
(Type:
string)
(value = 'cfg.media.audio.priorityorder')
(static, constant)
A prioritized, case insensitive list that is used for assigning weights
for automatic audio selection.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_AUDIO_PRIORITYORDER.
CFG_MEDIA_AUDIO_TYPEPRIORITY
(Type:
string)
(value = 'cfg.media.audio.typepriority')
(static, constant)
A prioritized case insensitive list of audio type that is used for
automatic audio selection. Example of property: "normal" and
"hearing_impaired".
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_AUDIO_TYPEPRIORITY.
CFG_MEDIA_CHANNELTABLE
(Type:
string)
(value = 'cfg.media.channeltable')
(static, constant)
- Deprecated:
-
The channel table.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_CHANNELTABLE.
CFG_MEDIA_DRM_CGMSA
(Type:
string)
(value = 'cfg.media.drm.cgmsa')
(static, constant)
The minimum CGMS-A level that the application desires to be used
on the analog video outputs. Minimum is in this case on a
per-bit level. Note that this variable is available only if
KreaTV is configured for it.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_DRM_CGMSA.
CFG_MEDIA_DRM_MACROVISION
(Type:
string)
(value = 'cfg.media.drm.macrovision')
(static, constant)
The minimum Macrovision level that the application desires to be
used on the analog video outputs. Minimum in this case is based
on that a higher APS value is more restrictive.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_DRM_MACROVISION.
CFG_MEDIA_STREAMER
(Type:
string)
(value = 'cfg.media.streamer')
(static, constant)
Contain parameters for the streamer.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_STREAMER.
CFG_MEDIA_SUBTITLING_AUTOSELECTION
(Type:
string)
(value = 'cfg.media.subtitling.autoselection')
(static, constant)
Turns on and off automatic selection of subtitle stream.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_SUBTITLING_AUTOSELECTION.
CFG_MEDIA_SUBTITLING_ENABLED
(Type:
string)
(value = 'cfg.media.subtitling.enabled')
(static, constant)
Specifies whether to show subtitles or not.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_SUBTITLING_ENABLED.
CFG_MEDIA_SUBTITLING_LANGUAGEPRIORITY
(Type:
string)
(value = 'cfg.media.subtitling.languagepriority')
(static, constant)
A prioritized case insensitive list of subtitle languages that is used
for automatic subtitling selection.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_SUBTITLING_LANGUAGEPRIORITY.
CFG_MEDIA_SUBTITLING_MODEPRIORITY
(Type:
string)
(value = 'cfg.media.subtitling.modepriority')
(static, constant)
A prioritized case insensitive list of subtitle modes that is used for
automatic subtitling selection.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_SUBTITLING_MODEPRIORITY.
CFG_MEDIA_SUBTITLING_TYPEPRIORITY
(Type:
string)
(value = 'cfg.media.subtitling.typepriority')
(static, constant)
A prioritized case insensitive list of subtitle types that is used for
automatic subtitling selection.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_SUBTITLING_TYPEPRIORITY.
CFG_MEDIA_TELETEXTSUBTITLING_TRANSPARENCY
(Type:
string)
(value = 'cfg.media.teletextsubtitling.transparency')
(static, constant)
Specifies the teletext subtitles background transparency percentage.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_TELETEXTSUBTITLING_TRANSPARENCY.
CFG_MEDIA_TELETEXTSUBTITLING_VERTICALADJUSTMENT
(Type:
string)
(value = 'cfg.media.teletextsubtitling.verticaladjustment')
(static, constant)
Used to adjust the teletext subtitles position in vertical direction.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_TELETEXTSUBTITLING_VERTICALADJUSTMENT.
CFG_MEDIA_TIMESHIFT_PLAYBACKPOLICY
(Type:
string)
(value = 'cfg.media.timeshift.playbackpolicy')
(static, constant)
Specifies the behavior of timeshift functionality when record operation
is about to overwrite the current play location in circular buffer.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_TIMESHIFT_PLAYBACKPOLICY.
CFG_MEDIA_TIMESHIFT_RECORDINGPOLICY
(Type:
string)
(value = 'cfg.media.timeshift.recordingpolicy')
(static, constant)
Specifies the behavior of timeshift functionality when starting the
timeshift buffering.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_MEDIA_TIMESHIFT_RECORDINGPOLICY.
CFG_NTP_MAXPOLL
(Type:
string)
(value = 'cfg.ntp.maxpoll')
(static, constant)
Specifies the max poll value to the NTP servers.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_NTP_MAXPOLL.
CFG_NTP_MINPOLL
(Type:
string)
(value = 'cfg.ntp.minpoll')
(static, constant)
Specifies the min poll value to the NTP servers.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_NTP_MINPOLL.
CFG_NTP_RETRY_ATTEMPTS
(Type:
string)
(value = 'cfg.ntp.retry.attempts')
(static, constant)
Specifies the attempt times against to one ntp server if ntpdate query
fails.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_NTP_RETRY_ATTEMPTS.
CFG_NTP_RETRY_INTERVAL
(Type:
string)
(value = 'cfg.ntp.retry.interval')
(static, constant)
Specifies the ntp retry interval, which is used to try next ntpdate
query after a query fails.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_NTP_RETRY_INTERVAL.
CFG_NTP_SERVERS
(Type:
string)
(value = 'cfg.ntp.servers')
(static, constant)
Specifies a proritized list of NTP servers in order, which is delimited
by comma.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_NTP_SERVERS.
CFG_PORTAL_MASTERAUDIO
(Type:
string)
(value = 'cfg.portal.masteraudio')
(static, constant)
- Deprecated:
-
The master audio used for application/portal to specify which volume
should be considered as the global volume.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_PORTAL_MASTERAUDIO.
CFG_PORTAL_PROXYLIST
(Type:
string)
(value = 'cfg.portal.proxylist')
(static, constant)
Configuration of external HTTP/HTTPS proxies.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_PORTAL_PROXYLIST.
CFG_PORTAL_RENDERINGBUFFER_HEIGHT
(Type:
string)
(value = 'cfg.portal.renderingbuffer.height')
(static, constant)
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.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_PORTAL_RENDERINGBUFFER_HEIGHT.
CFG_PORTAL_RENDERINGBUFFER_WIDTH
(Type:
string)
(value = 'cfg.portal.renderingbuffer.width')
(static, constant)
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.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_PORTAL_RENDERINGBUFFER_WIDTH.
CFG_PORTAL_SPATIALNAVIGATION_ENABLED
(Type:
string)
(value = 'cfg.portal.spatialnavigation.enabled')
(static, constant)
Enable/disable spatial navigation in the browser.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_PORTAL_SPATIALNAVIGATION_ENABLED.
CFG_PORTAL_STARTURL
(Type:
string)
(value = 'cfg.portal.starturl')
(static, constant)
Controls which initial URL to load.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_PORTAL_STARTURL.
CFG_PORTAL_SUBTITLES_ENABLED
(Type:
string)
(value = 'cfg.portal.subtitles.enabled')
(static, constant)
Specifies whether to show subtitles or not. Use
CFG_MEDIA_SUBTITLING_ENABLED instead.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_PORTAL_SUBTITLES_ENABLED.
CFG_PORTAL_TIMELIMIT
(Type:
string)
(value = 'cfg.portal.timelimit')
(static, constant)
Controls how long (in seconds) to wait for time synchronization before
loading the initial URL.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_PORTAL_TIMELIMIT.
CFG_PORTAL_WHITELISTURLS
(Type:
string)
(value = 'cfg.portal.whitelisturls')
(static, constant)
The URL of the portals used by the portal application.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_PORTAL_WHITELISTURLS.
CFG_POWER_APD_TIMEOUT
(Type:
string)
(value = 'cfg.power.apd.timeout')
(static, constant)
Automatic power down timeout in seconds.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_POWER_APD_TIMEOUT.
CFG_STANDBY_ALLOWREBOOT
(Type:
string)
(value = 'cfg.standby.allowreboot')
(static, constant)
This object controls if the STB will be allowed to reboot when
entering standby.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_STANDBY_ALLOWREBOOT.
CFG_STANDBY_BOOTPOLICY
(Type:
string)
(value = 'cfg.standby.bootpolicy')
(static, constant)
Specify the standby state of the STB after booting up.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_STANDBY_BOOTPOLICY.
CFG_STORAGE_AUTOMOUNT
(Type:
string)
(value = 'cfg.storage.automount')
(static, constant)
Turns on and off automatic mounting of externally connected storage
devices.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_STORAGE_AUTOMOUNT.
CFG_SYSTEM_FRIENDLYNAME
(Type:
string)
(value = 'cfg.system.friendlyname')
(static, constant)
The name of the system suitable for display to the end user.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_SYSTEM_FRIENDLYNAME.
CFG_WEBKIT_USERAGENT
(Type:
string)
(value = 'cfg.webkit.useragent')
(static, constant)
If set to a non-empty value, webkit will use the value as the user-agent
string in the HTTP request.
This constant can be also be accessed from toi.consts.ToiInformationService.CFG_WEBKIT_USERAGENT.
CMD_REBOOT
(Type:
string)
(value = 'cmd.reboot')
(static, constant)
A request for Reboot. Used by the KreaTV Platform and the Remote
Reboot application if included.
This constant can be also be accessed from toi.consts.ToiInformationService.CMD_REBOOT.
CMD_REBOOTQUERY_MESSAGE
(Type:
string)
(value = 'cmd.rebootquery.message')
(static, constant)
A request for IP-STB Reboot.
This constant can be also be accessed from toi.consts.ToiInformationService.CMD_REBOOTQUERY_MESSAGE.
CMD_REBOOTQUERY_RESPONSE
(Type:
string)
(value = 'cmd.rebootquery.response')
(static, constant)
Response for IP-STB reboot request.
This constant can be also be accessed from toi.consts.ToiInformationService.CMD_REBOOTQUERY_RESPONSE.
CONST_ARCHITECTURE_DEVICE
(Type:
string)
(value = 'const.architecture.device')
(static, constant)
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_ARCHITECTURE_DEVICE.
CONST_ARCHITECTURE_TOOLCHAIN
(Type:
string)
(value = 'const.architecture.toolchain')
(static, constant)
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_ARCHITECTURE_TOOLCHAIN.
CONST_CAPABILITIES_ASSETSHARING
(Type:
string)
(value = 'const.capabilities.assetsharing')
(static, constant)
Indicates that asset sharing is available in the boot image.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_CAPABILITIES_ASSETSHARING.
CONST_CAPABILITIES_MACROVISION
(Type:
string)
(value = 'const.capabilities.macrovision')
(static, constant)
Indicates if macrovision copy protection is supported by the hardware.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_CAPABILITIES_MACROVISION.
CONST_CAPABILITIES_PIP
(Type:
string)
(value = 'const.capabilities.pip')
(static, constant)
Indicates the Picture in Picture (PiP) capability of the device.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_CAPABILITIES_PIP.
CONST_DTCP_DEVICEID
(Type:
string)
(value = 'const.dtcp.deviceid')
(static, constant)
The 5-bytes Device's ID number assigned by the DTLA and stored in PFD.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_DTCP_DEVICEID.
CONST_FW_VERSION
(Type:
string)
(value = 'const._fw.version')
(static, constant)
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_FW_VERSION.
CONST_GOLDENIMAGE_VERSION
(Type:
string)
(value = 'const.goldenimage.version')
(static, constant)
The golden image version. The value will be N/A if the product doesn't
using the concept of a golden image.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_GOLDENIMAGE_VERSION.
CONST_HW_MANUFACTURER
(Type:
string)
(value = 'const.hw.manufacturer')
(static, constant)
Manufacturer of the device.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_HW_MANUFACTURER.
CONST_HW_OUI
(Type:
string)
(value = 'const.hw.oui')
(static, constant)
Organizationally Unique Identifier of the STB manufacturer.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_HW_OUI.
CONST_HW_PRODUCTNAME
(Type:
string)
(value = 'const.hw.productname')
(static, constant)
Model name of the device.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_HW_PRODUCTNAME.
CONST_HW_SERIALNUMBER
(Type:
string)
(value = 'const.hw.serialnumber')
(static, constant)
Serial number of the device.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_HW_SERIALNUMBER.
CONST_IP_ETH0_MAC
(Type:
string)
(value = 'const.ip.eth0.mac')
(static, constant)
- Deprecated:
-
MAC address of the device. The object is deprecated, use
IToiNetIpDevice::GetMacAddress() instead.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_IP_ETH0_MAC.
CONST_MEDIA_TIMESHIFTBUFFER_CONFIGSIZE
(Type:
string)
(value = 'const.media.timeshiftbuffer.configsize')
(static, constant)
The amount of disk space, in bytes, the time-shift buffer needs to
allocate to be able to store maximum time-shifted content at maximum
configured bitrate.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_MEDIA_TIMESHIFTBUFFER_CONFIGSIZE.
CONST_MEDIA_TIMESHIFTBUFFER_CONFIGTIME
(Type:
string)
(value = 'const.media.timeshiftbuffer.configtime')
(static, constant)
The time-shift buffer's configured capacity in seconds.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_MEDIA_TIMESHIFTBUFFER_CONFIGTIME.
CONST_POWER_APD_DEFAULT
(Type:
string)
(value = 'const.power.apd.default')
(static, constant)
The default timeout in seconds for automatic power down as
specified by the current power management scheme.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_POWER_APD_DEFAULT.
CONST_POWER_APD_MAX
(Type:
string)
(value = 'const.power.apd.max')
(static, constant)
The maximum allowed timeout in seconds for automatic power down as
specified by the current power management scheme.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_POWER_APD_MAX.
CONST_POWER_LOWEST_PROFILE
(Type:
string)
(value = 'const.power.lowest.profile')
(static, constant)
The lowest allowed power profile.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_POWER_LOWEST_PROFILE.
CONST_SW_BRANCH
(Type:
string)
(value = 'const.sw.branch')
(static, constant)
The branch which the software was built from.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_SW_BRANCH.
CONST_SW_DATE
(Type:
string)
(value = 'const.sw.date')
(static, constant)
The date the software was built.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_SW_DATE.
CONST_SW_HOST
(Type:
string)
(value = 'const.sw.host')
(static, constant)
The host on which the software was built.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_SW_HOST.
CONST_SW_TIME
(Type:
string)
(value = 'const.sw.time')
(static, constant)
The time the software was built.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_SW_TIME.
CONST_SW_USER
(Type:
string)
(value = 'const.sw.user')
(static, constant)
The user name of the user that built the software.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_SW_USER.
CONST_SW_VERSION
(Type:
string)
(value = 'const.sw.version')
(static, constant)
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_SW_VERSION.
CONST_WIFI_WPS_ENABLED
(Type:
string)
(value = 'const.wifi.wps.enabled')
(static, constant)
When enabled it is possible to setup a WiFi connection using WPS.
This constant can be also be accessed from toi.consts.ToiInformationService.CONST_WIFI_WPS_ENABLED.
This constant can be also be accessed from toi.consts.ToiInformationService.STATUS_NO_OBJECT.
Object exists but value is not provided.
This constant can be also be accessed from toi.consts.ToiInformationService.STATUS_NO_VALUE.
Object exists and has value.
This constant can be also be accessed from toi.consts.ToiInformationService.STATUS_OK.
Permanent data is permanently stored and is not lost at standby, but
might be lost at reboot since the data is not permanently written every
time something changes (to avoid destroying the Flash memory if the
data is stored there).
This constant can be also be accessed from toi.consts.ToiInformationService.STORAGE_PERMANENT.
Volatile data is always lost at reboot and platform restart (caused by
standby or other reason).
This constant can be also be accessed from toi.consts.ToiInformationService.STORAGE_VOLATILE.
VALUE_FALSE
(Type:
string)
(value = 'FALSE')
(static, constant)
String representation for boolean false.
This constant can be also be accessed from toi.consts.ToiInformationService.VALUE_FALSE.
VALUE_TRUE
(Type:
string)
(value = 'TRUE')
(static, constant)
String representation for boolean true.
This constant can be also be accessed from toi.consts.ToiInformationService.VALUE_TRUE.
VAR_CAPABILITIES_DVR
(Type:
string)
(value = 'var.capabilities.dvr')
(static, constant)
Indicates whether or not DVR is supported at the moment.
This capability may change at runtime.
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_CAPABILITIES_DVR.
VAR_CAPABILITIES_TIMESHIFT
(Type:
string)
(value = 'var.capabilities.timeshift')
(static, constant)
Indicates whether or not timeshift is supported at the moment.
This capability may change at runtime.
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_CAPABILITIES_TIMESHIFT.
VAR_GATEWAY_MANUFACTUREROUI
(Type:
string)
(value = 'var.gateway.manufactureroui')
(static, constant)
Manufacturer OUI of the gateway retrieved through DHCP.
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_GATEWAY_MANUFACTUREROUI.
VAR_GATEWAY_PRODUCTCLASS
(Type:
string)
(value = 'var.gateway.productclass')
(static, constant)
Product class of the gateway retrieved through DHCP.
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_GATEWAY_PRODUCTCLASS.
VAR_GATEWAY_SERIALNUMBER
(Type:
string)
(value = 'var.gateway.serialnumber')
(static, constant)
Serial number of the gateway retrieved through DHCP.
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_GATEWAY_SERIALNUMBER.
VAR_IO_STATE
(Type:
string)
(value = 'var.io.state')
(static, constant)
Indicates the general state of operation.
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_IO_STATE.
VAR_IP_DHCP_240
(Type:
string)
(value = 'var.ip._dhcp.240')
(static, constant)
Contains the value of option-240, set in the DHCP server.
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_IP_DHCP_240.
VAR_IP_DHCP_241
(Type:
string)
(value = 'var.ip._dhcp.241')
(static, constant)
Contains the value of option-241, set in the DHCP server.
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_IP_DHCP_241.
VAR_IP_DHCP_242
(Type:
string)
(value = 'var.ip._dhcp.242')
(static, constant)
Contains the value of option-242, set in the DHCP server.
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_IP_DHCP_242.
VAR_IP_DHCP_243
(Type:
string)
(value = 'var.ip._dhcp.243')
(static, constant)
Contains the value of option-243, set in the DHCP server.
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_IP_DHCP_243.
VAR_IP_ETH0_ADDR
(Type:
string)
(value = 'var.ip.eth0.addr')
(static, constant)
- Deprecated:
-
IP address retrieved through DHCP or static. Now instead use
IToiNetIpDevice::GetInterfaceInfo(). Now the IP address change is
notified via IToiNetObserver::OnDeviceInterfaceChanged().
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_IP_ETH0_ADDR.
VAR_IP_METACHANNEL
(Type:
string)
(value = 'var.ip.metachannel')
(static, constant)
The IP address and port of the Infocast Meta data channel.
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_IP_METACHANNEL.
VAR_LOG_UPLOAD_STATUS
(Type:
string)
(value = 'var.log.upload.status')
(static, constant)
Indicates the log upload status (if any).
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_LOG_UPLOAD_STATUS.
VAR_MEDIA_TIMESHIFTBUFFER_AVAILABILITY
(Type:
string)
(value = 'var.media.timeshiftbuffer.availability')
(static, constant)
- Deprecated:
-
Indicates the availability of timeshift buffer.
The recording is disabled until the timeshift is ready.
Use IToiInformationService::VAR_CAPABILITIES_TIMESHIFT
instead.
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_MEDIA_TIMESHIFTBUFFER_AVAILABILITY.
VAR_MEDIA_TIMESHIFTBUFFER_SPACEREQUIRED
(Type:
string)
(value = 'var.media.timeshiftbuffer.spacerequired')
(static, constant)
Indicates the amount of disk space, in bytes, the time-shift buffer lacks
to reach full capacity.
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_MEDIA_TIMESHIFTBUFFER_SPACEREQUIRED.
VAR_RCU_LOWBATTERY
(Type:
string)
(value = 'var.rcu.low_battery')
(static, constant)
Indicates that the battery level in the Remote Control Unit is running
low. Applications should subscribe to this object to receive a callback
every time the RCU signals low battery level.
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_RCU_LOWBATTERY.
VAR_SW_UPDATE
(Type:
string)
(value = 'var.sw.update')
(static, constant)
This object is set to "TRUE" when there is a new software version available
in the Infocast or HTTP server.
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_SW_UPDATE.
VAR_TIME_VALID
(Type:
string)
(value = 'var.time.valid')
(static, constant)
This object indicates if the system time can be trusted or not.
This constant can be also be accessed from toi.consts.ToiInformationService.VAR_TIME_VALID.
ToiObject
(Type:
struct)
(static)
The structure defining an object.
Struct fields
| Name |
Description |
| name
|
The object name.
Type: string
|
| value
|
The object value.
Type: string
|
ToiObjectInfo
(Type:
struct)
(static)
The structure about object information.
Struct fields
|