# Namespace hcap.property

hcap.property

- Defined in: hcap-1.24.6.5901.js

Namespace Summary
Constructor Attributes | Constructor Name and Description
--- | ---
| hcap.property

## Method Summary

## Namespace Detail

hcap.property

## Method Detail

- <static> hcap.property.getHotelMode(param)
  Gets the current hotel mode settings.

      hcap.property.getHotelMode({
           "onSuccess" : function(s) {
               console.log("onSuccess : hotel mode settings = " + s.hotelMode);
           },
           "onFailure" : function(f) {
               console.log("onFailure : errorMessage = " + f.errorMessage);
           }
      });

  Parameters:
  {Object} param
    - {Function} param.onSuccess [Optional] - success callback function.

            param.onSuccess = function (param) {
                // {String} param.hotelMode - current hotel mode settings in JSON type.
                // '{
                //     "enable":{String}, // Whether to enable LG Hotel Mode operation or not. Default is "off" or not.
                //                        // If "enable" is "on",
                //                        // 1) Menu - General - "Reset to Initial Settings" and "Home/Store Mode"
                //                        //    cannot be changed.
                //                        // 2) Scheduled recording is disabled. Guide menu - "Information",
                //                        //    "Manual Timer" and "Play Key" are disappeared and are not worked.
                //                        //    DVR-related progress bar, REC key and Play key are not worked.
                //                        // 3) External devices connected to TV (ex. Simplink) are worked according
                //                        //    to the settings of "Hotel Mode Operation" - "Aux Source Settings" and
                //                        //    "Input Source Change".
                //                        // 4) Web browser is started in privacy mode. (Web history is not stored)
                //                        // 5) The functionality of LG Connect Apps is terminated.
                //                        // 6) Voice Recognition (Speak to TV) and Motion Gesture are not worked.
                //                        // 7) ECO (Energy Saving), 15 Min Auto Off and 2 Hour Off (On Timer) are
                //                        //    deactivated.
                //                        // 8) When Hote Mode is On in DC On, the settings of ECO, 15 Min Auto Off
                //                        //    and 2 Hour Off (On Timer) are restored. Then if Hotel Mode is Off
                //                        //    after DC Off and DC On, previous settings are removed and default
                //                        //    values are restored.
                //                        // 9) User Guide key is not worked.
                //         "on" // enable hotel mode.
                //         "off" // disable hotel mode.
                //     "settings":{Object} { // Setting values to be applied when "enable" is "on".
                //         "powerOnStatus":{String}, // Determine the TV status when main power (AC) is on. Default is
                //                                   // "std".
                //             "pwr" // make TV power-on status when AC is on. To make sure TV is able to be turned on,
                //                   // if both "irOperation" and "localKeyOperation" are "blockAll",
                //                   // settings.powerOnStatus will be changed to "pwr" automatically.
                //             "std" // make TV stand-by status when AC is on. If "enable" is changed to "on",
                //                   // settings.powerOnStatus will be changed to "std" automatically.
                //             "lst" // make TV last power status when AC is on. AC is off in power-on status, AC is on,
                //                   // and then TV will go back to power-on status. AC is off in stand-by status, AC
                //                   // is on, and then TV will be in stand-by status.
                //         "volume":{Object}, { // Volume settings.
                //             "enable":{String}, // Whether to enable volume settings such as "Start Volume",
                //                                // "Maximum Volume" and "Minimum Volume" or not. Default is "off".
                //                 "on" // enable volume settings.
                //                 "off" // disable volume settings.
                //             "settings":{Object}, { // Setting values to be applied when settings.volume.enable is "on".
                //                 "startVolume":{Object}, { // Start volume when TV is turned on.
                //                     "enable":{String}, // Whether to enable start volume or not. Default is "off".
                //                         "on" // enable start volume.
                //                         "off" // disable start volume.
                //                     "level":{Number} // start volume level (0 <= Min <= Start <= Max <= 100).
                //                                      // Default is 0. This is worked when
                //                                      // settings.volume.settings.startVolume.enable is "on". If "level"
                //                                      // is smaller than "minimumVolume", "minimumVolume" will be the
                //                                      // start volume level. If "level" is bigger than "maximumVolume",
                //                                      // "maximumVolume" will be the start volume level.
                //                                      // 'On Timer'-related volume level is fixed with "level" when
                //                                      // 'Public Display Mode'/'Hotel Mode Operation' are enabled.
                //                 }
                //                 "minimumVolume":{Number}, // Minimum volume level (0 <= Min <= Start <= Max <= 100).
                //                                           // Default is 0. Setting a volume level smaller than
                //                                           // "minimumVolume" will be ignored. If "minimumVolume" is
                //                                           // set to bigger than the current volume level in the mute
                //                                           // state, mute will be disabled.
                //                 "maximumVolume":{Number} // Maximum volume level (0 <= Min <= Start <= Max <= 100).
                //                                          // Default is 100. Setting a volume level bigger than
                //                                          // "maximumVolume" will be ignored. If "maximumVolume" is
                //                                          // set to smaller than the current volume level in the mute
                //                                          // state, mute will be disabled.
                //             }
                //         }
                //         "keyManagement":{Object}, { // Settings for the management of Local/Front key and Remote
                //                                     // Control key.
                //             "enable":{String}, // Whether to enable IR Operation and Local Key Operation, or not.
                //                                // Default is "off".
                //                 "on" // enable the key management.
                //                 "off" // disable the key management.
                //             "settings":{Object} { // Setting values to be applied when settings.keyManagement.enable
                //                                   // is "on".
                //                 "irOperation":{String}, // IR (Remote Control) key management. Default is "normal".
                //                     "normal" // block no IR key.
                //                     "usePwrOnly" // block all IR keys except the power key and service mode keys
                //                                  // (In-Start, In-Stop, Power-Only, ADJ, Hotel-Mode, Hotel-Mode-Ready,
                //                                  // p-Check, S-Check, In-Time, FMode-Init, FMode-Start, FMode-AV,
                //                                  // FMode-F1). And IR key combinations to enter Installation Menu and
                //                                  // Special Menu (In-Start, EZ-Adjust, etc) are possible in
                //                                  // "usePwrOnly" status.
                //                     "blockAll" // block all IR keys except service mode keys (In-Start, In-Stop,
                //                                // Power-Only, ADJ, Hotel-Mode, Hotel-Mode-Ready, p-Check, S-Check,
                //                                // In-Time, FMode-Init, FMode-Start, FMode-AV, FMode-F1). And IR key
                //                                // combinations to enter Installation Menu and Special Menu (In-Start,
                //                                // EZ-Adjust, etc) are possible in "blockAll" status.
                //                 "localKeyOperation":{String} // Local/Front key management. Default is "normal".
                //                     "normal" // block no Local/Front key.
                //                     "usePwrOnly" // block all Local/Front keys except the power key. Long press (3 secs)
                //                                  // of the Local/Front cross key is worked as the power key.
                //                     "blockAll" // block all Local/Front keys.
                //             }
                //         }
                //         "limitedMode":{Object}, { // Settings to limit TV functionalities.
                //             "enable":{String}, // Whether to enable settings.limitedMode.settings items or not. Default
                //                                // is "off". If settings.limitedMode.enable is "on", Screen Remote App
                //                                // (123/Input key in MRCU) is not worked.
                //                 "on" // enable "limitedMode"
                //                 "off" // disable "limitedMode"
                //             "settings":{Object} { // Setting values to be applied when settings.limitedMode.enable is
                //                                   // "on".
                //                 "setupMenu":{String}, // Whether to permit to enter Setup (Channel) Menu or not.
                //                                       // Default is "on".
                //                     "on" // permit to enter Setup Menu.
                //                     "off" // prohibit from entering Setup Menu. Auto Tuning is not displayed in the
                //                           // channel change when the channel map is empty.
                //                 "programmeChange":{String}, // Whether to permit to change the channel or not. Default
                //                                             // is "on".
                //                     "on" // permit to change the channel and enter the channel menu.
                //                     "off" // prohibit from changing the channel. Channel-related keys (channel up/down,
                //                           // number, guide, etc) channel menus (Setup Menu, etc) are disabled.
                //                           // Setting values in the menu 'On Time'-'Programme' are fixed.
                //                 "menuDisplay":{String}, // Whether to permit to enter the menu or not. Default is "on".
                //                     "on" // permit to enter the menu.
                //                     "off" // prohibit from entering the menu. But it is possible to enter Installation
                //                           // Menu with press-and-hold of Menu key longer than 5 seconds. It is not
                //                           // permitted MRCU (Magic Remote Control Unit) via Bluetooth to control TV.
                //                 "osdDisplay":{String}, // Whether to display OSDs or not. Default is "on".
                //                     "on" // display OSDs.
                //                     "off" // All OSDs except Installation Menu, In Start Menu, Adjust and Power Only OSD
                //                           // are not displayed. Although Volume OSD is not displayed in "osdDisplay"
                //                           // "off", Volume OSD can be displayed with the property "volume_ui"-"1" by HCAP.
                //                           // MRCU cannot control TV. OSD is not displayed and settings cannot be changed
                //                           // for Ratio and Energysaving Hotkey.
                //                 "systemProviderMode":{String} // Whether to enable System Provider Mode or not. Default
                //                                               // is "off".
                //                     "on" // enable System Provider Mode in which Sound (Smart Sound Mode, Sound Mode,
                //                          // Sound Effect, Volume Mode, Sound Out, DTV Audio Setting, AV Sync Adjustment,
                //                          // Sound Optimizer, Sound Test), Picture (Smart Picture Mode, Picture Mode
                //                          // Settings, Energy Saving, Picture Test, 3D Picture Test, HDMI Ultra HD Deep
                //                          // Color), Accessibility (Pointer Options, Video Description, Audio Description,
                //                          // Audio Description Volume, Audio Guidance, Enlarge Focused Image, Hard of
                //                          // Hearing, Teletext), General (Language, Location, Time & Date, Timers/Auto
                //                          // Power Off, Alarm/Timer Power On/Off, Standby Light, Home/Store Mode, Set ID,
                //                          // SIMPLINK, Reset to Initial Settings), Programmes (Programme Tuning,
                //                          // Programme Manager, Copy Programmes, Channel Plus, My Channels) are blocked.
                //                     "off" // disable System Provider Mode.
                //             }
                //         }
                //         "dtvProgrammeUpdate":{String}, { // Whether to update DTV channels automatically or not. Default
                //                                          // is "manual".
                //             "auto" // update the channel map according to the DTV channel stream.
                //             "manual" // maintain the channel map even though DTV channel information in the channel
                //                      // stream is changed.
                //         }
                //         "powerOnDefault":{Object}, { // Settings for power-on.
                //             "enable":{String}, // Whether to enable settings for the input, programme and AV settings
                //                                // when TV is turned on (DC On) from AC On or stand-by, or not. Default
                //                                // is "off". If HCAP start channel is set, settings.powerOnDefault.enable
                //                                // will be "off" automatically, and then even though
                //                                // settings.powerOnDefault.enable is set to "on" again, HCAP start
                //                                // channel has higher priority than "powerOnDefault" settings.
                //                 "on" // enable power-on settings.
                //                 "off" // disable power-on settings.
                //             "settings":{Object} { // Setting values to be applied when settings.powerOnDefault.enable
                //                                   // is "on".
                //                 "input":{String}, // Change to the specified input source in the power-on. Default
                //                                   // is "off".
                //                     "off" // "input" is disabled.
                //                     "dtv" // Digital TV
                //                     "atv" // Analog TV
                //                     "catv" // Cable TV
                //                     "cadtv" // Cable DTV
                //                     "ca-radio" // Cable Radio
                //                     "sdtv" // Satellite DTV
                //                     "s-radio" // Satellite Radio
                //                     "scart" // SCART
                //                     "av1" // AV 1
                //                     "av2" // AV 2
                //                     "av3" // AV 3
                //                     "rgb" // RGB
                //                     "comp1" // Component 1
                //                     "comp2" // Component 2
                //                     "comp3" // Component 3
                //                     "hdmi1" // HDMI 1
                //                     "hdmi2" // HDMI 2
                //                     "hdmi3" // HDMI 3
                //                     "hdmi4" // HDMI 4
                //                 "programme":{String}, // If the external input in the power-on is TV, specify the
                //                                       // programme in the power-on.
                //                 "avSetting":{String}, // Audio/Video setting. Default is "off".
                //                     "on" // restore internal Audio/Video setting values. The internal setting
                //                          // values are not exposed.
                //                     "off" // disable internal Audio/Video settings in the power-on.
                //                 "aspectRatio":{String} // Aspect Ratio setting. Default is "disable".
                //                     "disable" // The last aspect ratio setting.
                //                     "original" // Automatic aspect ratio.
                //                     "4:3" // 4:3 aspect ratio.
                //                     "16:9" // 16:9 aspect ratio.
                //             }
                //         }
                //         "auxSourceSetting":{Object}, { // Auxiliary source settings
                //             "enable":{String}, Whether to enable aux source settings or not. Default is "off".
                //                 "on" // enable aux source settings. Only selected aux sources are enabled.
                //                 "off" // disable aux source setting. All available aux sources are enabled.
                //             "settings":{Array} [ // Setting values to be applied when settings.auxSourceSetting.enable
                //                                  // is "on".
                //                 "av1" // AV 1
                //                 "av2" // AV 2
                //                 "av3" // AV 3
                //                 "rgb" // RGB
                //                 "comp1" // Component 1
                //                 "comp2" // Component 2
                //                 "comp3" // Component 3
                //                 "hdmi1" // HDMI 1
                //                 "hdmi2" // HDMI 2
                //                 "hdmi3" // HDMI 3
                //                 "hdmi4" // HDMI 4
                //             ]
                //         }
                //         "powerManagement":{String}, // TV is turned off if there is no key input from the local,
                //                                     // front or remote for the designated time since the last key
                //                                     // input. Default is "off".
                //             "off" // disable "powerManagement".
                //             "1hour" // TV is turned off after 1 hour.
                //             "2hours" // TV is turned off after 2 hours.
                //             "3hours" // TV is turned off after 3 hours.
                //             "4hours" // TV is turned off after 4 hours.
                //             "5hours" // TV is turned off after 5 hours.
                //             "6hours" // TV is turned off after 6 hours.
                //             "7hours" // TV is turned off after 7 hours.
                //         "radioVideoBlank":{Object} // Settings for the video of DVB analog radio channels.
                //             "enable":{String}, // Whether to enable settings for the mute of the radio programme video.
                //                                // Default is "off".
                //                 "on" // enable the radio video mute setting.
                //                 "off" // disable the radio video mute setting.
                //             "settings":{Object} { // Setting values to be applied when settings.radioVideoBlank.enable
                //                                   // is "on".
                //                 "startOfRadioProgramme":{Number}, // 1 ~ 199. Default is 1. Make the
                //                                                   // "countOfRadioProgramme" radio videos blank from
                //                                                   // the channel of "startOfProgramme".
                //                 "countOfRadioProgramme":{Number} // 0 ~ 10. Default is 1. "startOfRadioProgramme" +
                //                                                  // "countOfRadioProgramme" <= Max of the programme
                //                                                  // number + 1. 0 means that none of radio programmes
                //                                                  // will not be video-mute.
                //     }
                // }'
            }

    - {Function} param.onFailure [Optional] - failure callback function.

            param.onFailure = function (param) {
                // {String} param.errorMessage - in case of failure, this message provides the details.
            }

  Since:
    1.20.0
  See:
    hcap.property.setHotelMode()
- Gets the current value of installer menu item.

      hcap.property.getInstallerMenuItem({
           "key" : hcap.property.InstallerMenuItem.INSTALLER_SEQ,
           "onSuccess" : function(s) {
               console.log("onSuccess : property value = " + s.value);
           },
           "onFailure" : function(f) {
               console.log("onFailure : errorMessage = " + f.errorMessage);
           }
      });

  Parameters:
  {Object} param
    - {Number} param.key [Required] - installer menu item type. Please refer to hcap.property.InstallerMenuItem.
    - {Function} param.onSuccess [Optional] - success callback function.

            param.onSuccess = function (param) {
                // {Number} param.value - installer menu item value of the requested type. Please refer to hcap.property.InstallerMenuItem.
            }

    - {Function} param.onFailure [Optional] - failure callback function.

            param.onFailure = function (param) {
                // {String} param.errorMessage - in case of failure, this message provides the details.
            }

  Since:
    1.22.0
  See:
    hcap.property.InstallerMenuItem
    hcap.property.setInstallerMenuItem()
- <static> hcap.property.getPictureMode(param)
  Gets the current picture mode.

      hcap.property.getPictureMode({
           "onSuccess" : function(s) {
               console.log("onSuccess : picture mode = " + s.mode + ", is user = " + s.isUser);
           },
           "onFailure" : function(f) {
               console.log("onFailure : errorMessage = " + f.errorMessage);
           }
      });

  Parameters:
  {Object} param
    - {Function} param.onSuccess [Optional] - success callback function.

            param.onSuccess = function (param) {
                // {Number} param.mode - picture mode. Please refer to hcap.property.PictureMode.
                // {Boolean} param.isUser - false when all picture property values are default in the picture mode, otherwise true.
            }

    - {Function} param.onFailure [Optional] - failure callback function.

            param.onFailure = function (param) {
                // {String} param.errorMessage - in case of failure, this message provides the details.
            }

  Since:
    1.20.0
  See:
    hcap.property.PictureMode.VIVID
    hcap.property.PictureMode.STANDARD
    hcap.property.PictureMode.ECO
    hcap.property.PictureMode.CINEMA
    hcap.property.PictureMode.SPORTS
    hcap.property.PictureMode.GAME
    hcap.property.PictureMode.PHOTO
    hcap.property.PictureMode.EXPERT_BRIGHT_ROOM
    hcap.property.PictureMode.EXPERT_DARK_ROOM
    hcap.property.setPictureMode()
- <static> hcap.property.getPictureProperty(param)
  Gets the picture property value for the current media input source.

      hcap.property.getPictureProperty({
           "key" : hcap.property.PicturePropertyKey.COLOR_TEMPERATURE,
           "onSuccess" : function(s) {
               console.log("onSuccess : property value = " + s.value);
           },
           "onFailure" : function(f) {
               console.log("onFailure : errorMessage = " + f.errorMessage);
           }
      });

  Parameters:
  {Object} param
    - {Number} param.key [Required] - picture property key type. Please refer to hcap.property.PicturePropertyKey.
    - {Function} param.onSuccess [Optional] - success callback function.

            param.onSuccess = function (param) {
                // {Number} param.value - picture property value of the requested property key. Please refer to hcap.property.PicturePropertyKey.
            }

    - {Function} param.onFailure [Optional] - failure callback function.

            param.onFailure = function (param) {
                // {String} param.errorMessage - in case of failure, this message provides the details.
            }

  Since:
    1.6.0
  See:
    hcap.property.PicturePropertyKey.BACKLIGHT
    hcap.property.PicturePropertyKey.CONTRAST
    hcap.property.PicturePropertyKey.BRIGHTNESS
    hcap.property.PicturePropertyKey.SHARPNESS
    hcap.property.PicturePropertyKey.COLOR
    hcap.property.PicturePropertyKey.TINT
    hcap.property.PicturePropertyKey.COLOR_TEMPERATURE
    hcap.property.PicturePropertyKey.ASPECT_RATIO
    hcap.property.setPictureProperty()
- <static> hcap.property.getProperty(param)
  Gets the value of platform property. The property can be the TV specification values or user setting values.

      hcap.property.getProperty({
           "key" : "model_name",
           "onSuccess" : function(s) {
               console.log("onSuccess : property value = " + s.value);
           },
           "onFailure" : function(f) {
               console.log("onFailure : errorMessage = " + f.errorMessage);
           }
      });

  Parameters:
  {Object} param
    - {String} param.key [Required] - property key string.

      Key | Description | Read/Write | Value Format | Value example (default value for the predefined value set)
      --- | --- | --- | --- | ---
      hcap_js_extension_version | Hcap js extension version of middleware | Read | [version string] free format string | 1.2.4.5
      hcap_middleware_version | Version of middleware | Read | [version string] free format string | 1.2.4.5.4417
      model_name | Product model name (IN START:Model Name) | Read | [model name] free format string | GLOBAL-PLAT2
      platform_version | Platform management version (IN START:S/W Version) | Read | [version string] free format string | 03.00.06.01
      micom_version | Platform micom management version (IN START:MICOM Version) | Read | [version string] free format string | 2.12
      boot_version | Bootloader management version (IN START:BOOT Version) | Read | [version string] free format string | 2.00.02
      platform_src_revision | Platform source revision (IN START:APP History Ver) | Read | [version string] free format string | APP History Ver.: 3018
      ptc_version | (UA Model Only) PTC management version | Read | [version string] free format string | 1.1.8
      serial_number | Product serial number (IN START:Serial Number) | Read | [serial number] free format string | SKJY1107
      display_resolution | Graphics display resolution. Only 1280x720 and 1920x1080 are supported (since HCAP HTML 1.20.0). Just after changing the resolution, reboot is needed. | Read/Write | [width]x[height] | 1280x720
      ip_support | Whether IP network is supported, or not | Read | [0|1] 0 : IP feature is disabled 1 : IP feature is enabled | 1
      number_of_tuner | The number of tuner | Read | [0|1|2|3|4|5|6|7|8|9] | 1
      support_language_list | Language list supported by platform | Read | [language_code][,[language_code]] [language_code] : ISO 639-1, alpha-2 language code | bs,cs,da,de,et,en,es
      default_audio_language_list | Available audio languages to set as default | Read | [language_code][,[language_code]] [language_code] : ISO 639-1, alpha-2 language code | bs,cs,da,de,et,en,es
      language | Platform menu language setting | Read | [language_code] ISO 639-1, alpha-2 language code | en
      default_audio_language | Default audio language for current channel | Read/Write | [language_code] ISO 639-1, alpha-2 language code | en
      country | Platform country setting | Read | [country_code] ISO 3166-1, alpha-2 country code | gb
      default_subtitle_language_list | Subtitle list which can be set as the default subtitle in TV | Read | [subtitle setting][,[subtitle setting]]* | off,bs,cs,da,de,et,en,es
      default_subtitle_language | the default subtitle. In "off" case, default_subtitle_language_us_analog will be set to off also. In "xx" case when there is no mapped system subtitle, no subtitle is displayed | Read/Write | [subtitle setting] | en
      default_subtitle_language_list_us_analog | Subtitle list which can be set as the default subtitle in TV for US analog channel | Read | [subtitle setting][,[subtitle setting]]* | off,cc1,tx2
      default_subtitle_language_us_analog | The default subtitle for US analog channel | Read/Write | [subtitle setting] | cc1
      gmt_offset_in_minute | deprecated since 1.6.0 |  |  |
      daylight_saving | deprecated since 1.6.0 |  |  |
      boot_sequence_option | Pro:Centric Boot Sequence Option | Read/Write | [0|1] 0 : AV Show + P:C App Show 1 : Pro:Centric App Show Only | 0
      tv_channel_control | deprecated since 1.19.0. |  |  |
      application_channel_control | Whether TV can control channel, or not. | Read/Write | [0|1] 0 : Both TV and HCAP Application can change the channel. TV changes the channel for channel-related keys (Channel Up/Down, Numeric, TV/RAD, etc). HCAP Application changes the channel by channel.requestChangeCurrentChannel(). 1 : TV channel can be changed only by channel.requestChangeCurrentChannel(). | 0
      tv_channel_ui | Whether the TV channel UI is displayed, or not | Read/Write | [0|1] 0 : TV Channel UI is disabled 1 : TV Channel UI is enabled (TV channel UI is not displayed when the channel is changed by channel.requestChangeCurrentChannel().) | 1
      tv_volume_ui | Whether the TV volume UI is displayed, or not | Read/Write | [0|1] 0 : TV Volume UI is disabled 1 : TV Volume UI is enabled | 1
      tv_caption_ui | Whether the TV caption is displayed, or not | Read/Write | [0|1] 0 : TV Caption is disabled 1 : TV Caption is enabled | 1
      tv_mheg_ui | deprecated since 1.6.0 |  |  |
      tv_channel_attribute_floating_ui | Whether the floating UI like no signal, parental lock, audio only and etc, is displayed, or not | Read/Write | [0|1] 0 : TV Channel Status UI is disabled 1 : TV Channel Status UI is enabled | 1
      channel_lock | (UA Model Only) Whether the channel change is locked, or not. Channel lock is used to prohibit the channel change in public area. | Read/Write | [0|1] 0 : Channel change is unlocked(can be changed) 1 : Channel change is locked | 0
      application_update_on_startup | Whether application will be updated or not when the middleware starts up | Read | [0|1] 0 : application will not be updated 1 : application will be updated | 0
      application_update_in_shutdown | Whether application will be updated or not when the middleware shutdowns | Read | [0|1] 0 : application will not be updated 1 : application will be updated | 0
      pcr_offset_in_ms | deprecated since 1.22.0 |  |  |
      platform_manufacturer | Platform Manufacturer Name | Read | [name string] free format string | LGE
      hardware_version | Hardware Version | Read | [version string] free format string | 1.0.0
      max_application_size | specifies the max storage size in byte for Pro:Centric applications. | Read | [max application storage size] Byte(s) | 10485760
      max_content_cache_size | specifies the max cache storage size in byte for carousel content. | Read | [max content cache storage size] Byte(s) | 10485760
      osd_layer_id | ID of HCAP OSD layer | Read | [number string] | 4
      key_delivery_to_simplink | determine whether key input is delivered to Simplink or key input is processed accroding to HCAP key attribute. This property is effective only when Simplink device is connected to TV. | Read/Write | [0|1] 0 : key input is processed according to HCAP key attribute. 1 : key input is delivered to Simplink. Therefore HCAP application gets no key input. | 0
      room_number | [since 1.5.0] room number which TV is located in. When room number is changed, property 'tv_name' will be changed to the same value as 'room_number'. | Read/Write | [string] free format string. Max length is 21. (Factory initial value is '[TV]serial_number'.) | [TV]204

      instant_power

      [since 1.6.0] specify the mode of instant power on.

      Read/Write

      [0|10|1|2]
      0 : disable TV instant power on.
      At power off by hcap.power.powerOff() and power key in RCU[Remote Control Unit] : NORMAL -> WARM(UPDATE) -> STANDBY.
      At power on by power key in RCU : STANDBY -> NORMAL.
      At reboot by hcap.power.reboot() : NORMAL -> WARM(UPDATE) -> STANDBY -> NORMAL.
      Power mode change NORMAL->WARM(WAIT) by hcap.power.setPowerMode() is not supported.
      Power mode change WARM(WAIT)->NORMAL by hcap.power.setPowerMode() is supported.
      [since 1.19.0] 10 : keep TV turned on while AC power is applied.
      At power off by hcap.power.powerOff() : NORMAL -> WARM(UPDATE) -> STANDBY -> NORMAL.
      At power off by power key in RCU : No effect.
      At power on by power key in RCU : No effect.
      [since 1.18.4] At reboot by hcap.power.reboot() : NORMAL -> WARM(UPDATE) -> STANDBY -> NORMAL.
      Power mode change NORMAL<->WARM(WAIT) by hcap.power.setPowerMode() is not supported.
      1 : enable TV instant power on.
      At power off by hcap.power.powerOff() and power key in RCU : [NORMAL|WARM(WAIT)] -> WARM(UPDATE) -> STANDBY -> WARM(WAIT).
      At power on by power key in RCU : WARM(WAIT) -> NORMAL.
      [since 1.18.4] At reboot by hcap.power.reboot() : NORMAL -> WARM(UPDATE) -> STANDBY -> NORMAL. WARM(WAIT) -> WARM(UPDATE) -> STANDBY -> WARM(WAIT).
      Power mode change NORMAL<->WARM(WAIT) by hcap.power.setPowerMode() is supported.
      [since 1.9.0] 2 : enable TV instant power on.
      At power off by hcap.power.powerOff() : [NORMAL|WARM(WAIT)] -> WARM(UPDATE) -> STANDBY -> WARM(WAIT).
      At power off by power key in RCU : NORMAL -> WARM(WAIT).
      At power on by power key in RCU : WARM(WAIT) -> NORMAL.
      [since 1.18.4] At reboot by hcap.power.reboot() : NORMAL -> WARM(UPDATE) -> STANDBY -> NORMAL. WARM(WAIT) -> WARM(UPDATE) -> STANDBY -> WARM(WAIT).
      Power mode change NORMAL<->WARM(WAIT) by hcap.power.setPowerMode() is supported.

      0

      wol_w | [since 1.5.1] specifies TV power status when turning TV on from standby state by Wakeup Frame. Whether to support "wol_w" or not depends on TV models. | Read/Write | [normal|warm|off] | off
      wol_m | [since 1.5.1] specifies TV power status when turning TV on from standby state by Magic Packet. Whether to support "wol_m" or not depends on TV models. | Read/Write | [normal|warm|off] | off
      inband_data_service_mhp | [since 1.6.0] determine whether to enable MHP service. | Read/Write | [0|1] 0 : disable MHP service. 1 : enable MHP service. | 0
      inband_data_service_mheg | [since 1.6.0] determine whether to enable MHEG service. | Read/Write | [0|1] 0 : disable MHEG service. 1 : enable MHEG service. | 0
      inband_data_service_hbbtv | [since 1.6.0] determine whether to enable HBBTV service. | Read/Write | [0|1] 0 : disable HBBTV service. 1 : enable HBBTV service. | 0
      security_level | [since 1.7.0] set security level for whether deleting personal information in TV or not. | Read/Write | [1|2] 1 : security level 1. delete personal information in TV when turning TV off. 2 : security level 2. maintain personal information in TV when turning TV off. | 1
      tv_name | [since 1.8.0] TV name to be displayed at the remote (SSID of TV). When 'tv_name' is changed, property 'room_number' is not changed. 'tv_name' is also the SSID of soft AP, which will be valid after rebooting TV. | Read/Write | [string] free format string. Max length is 30. (Factory initial value is '[TV]serial_number'.) | [TV]xxx
      wifi_screen_share | [since 1.10.0] determine whether to enable WiDi and Wi-Fi Direct, or not. | Read/Write | [0|1] 0 : disable WiDi and Wi-Fi Direct. 1 : enable WiDi and Wi-Fi Direct. | 0
      smart_share | [since 1.10.0] determine whether to enable DLNA, or not. | Read/Write | [0|1] 0 : disable DLNA. 1 : enable DLNA. | 0
      smart_pairing | [since 1.10.0] determine whether to enable QR code and broadcast SSID, or not. | Read/Write | [0|1] 0 : disable QR code and hide SSID. 1 : enable QR code and broadcast SSID. | 0
      dmr | [since 1.10.0] determine whether to enable DMR (Digital Media Renderer), or not. | Read/Write | [0|1] 0 : disable DMR. 1 : enable DMR. | 0
      single_decoding | [since 1.13.0] determine whether the system is able to decode MPEG streams simultaneously, or not. | Read | [0|1] 0 : decode MPEG streams simultaneously. 1 : decode only one MPEG stream at a time. | 0

      browser_network_error_handling

      [since 1.19.0] deprecate the behavior of "1". TV doesn't support "1" anymore.
      [since 1.14.0] determine whether the browser handles network error, or not.

      Read/Write

      [0|1]
      0 : when network error is occurred, notify network status change to the application and the browser has no action.
      1 : when network error is occurred, the browser loads an error page for a while and tries to load the previous page. If the previous page can be loaded in off-line, the page will be loaded, or the browser will be destroyed. When pressing PORTAL key in the browser termination, TV tries to load initial page designated in xait.xml.

      1

      browser_https_security_level | [since 1.14.0] determine the https security level in browser. | Read/Write | [0|1] 0 : use server authentication and session data encryption. 1 : only use session data encryption. | 1
      full_browser_start_page_url | [since 1.15.0] set the start page for the full browser. | Read/Write | [url string] page url. | http://lge.com/index.html
      maximum_volume_level | [since 1.15.0] set the maximum volume level. EU model only. | Read/Write | [number string] 0 ~ 100. | 100
      pcr_recovery | [since 1.15.0] determine whether to enable PCR recovery or not. | Read/Write | [0|1] 0 : disable PCR recovery. 1 : enable PCR recovery. | 1
      mute_on_tv_input | [since 1.15.0] determine whether TV AV is mute or not, when selecting TV from another external input source. | Read/Write | [0|1] 0 : TV AV is played. 1 : TV AV is mute. | 0
      soft_ap_ui | [since 1.16.0] determine whether to enable soft access point or not. "soft_ap" is working only when "soft_ap_ui" is enabled. "soft_ap" is reset to "0" whenever TV is rebooted or the power mode is changed from non-normal mode to normal mode if instant_power is enabled (1 or 2). | Read/Write | [0|1] 0 : disable soft AP UI. 1 : enable soft AP UI. | 0

      soft_ap

      [since 1.16.0] determine whether to enable soft access point or not. "soft_ap" is working only when "soft_ap_ui" is enabled. "soft_ap" is reset to "0" in the power off sequence (NORMAL -> WARM -> OFF). Soft AP configuration is stored even for "soft_ap" "0", and when "soft_ap" is "1", soft AP and VLAN is initialized with the stored configuration.

      Read/Write

      [0|1]
      0 : disable soft AP.
      1 : enable soft AP.

      0

      soft_ap_password | [since 1.16.0] set the password of soft access point. Max length is 64. | Write | [password string] password. | lge12345
      rs232c | [since 1.18.4] determine whether to enable RS232C (serial) communication by HCAP or not. Only when "rs232c" is "1", hcap.rs232c commands will be worked. | Read/Write | [0|1] 0 : disable RS232C by HCAP. 1 : enable RS232C by HCAP. | 0
      https_xait_xml | [since 1.19.0] determine whether to get remote xait.xml and remote zone.conf via http or https. | Read/Write | [0|1] 0 : access to http://[P:C Server IP]:[P:C Server Port]/procentric/application/xait.xml 1 : access to https://[P:C Server IP]:[P:C Server Port]/procentric/application/xait.xml | 0

      alternative_lg_service_xml

      [since 1.19.0] specify LGService.xml dynamically in EZ Installation.
      If "alternative_lg_service_xml" doesn't exist or is empty string, download http://[Pro:Centric Server IP]:[Pro:Centric Server Port]/procentric/system/LGService.xml as it was.
      If "alternative_lg_service_xml" exists and it starts with "http://" or "https://", download the value of "alternative_lg_service_xml".
      If "alternative_lg_service_xml" exists and it doesn't start with "http://" and "https://", download http://[Pro:Centric Server IP]:[Pro:Centric Server Port]/procentric/system/["alternative_lg_service_xml" value].

      Read/Write

      [string]
      file name or URL.

      ""(empty string)

      alternative_url | [since 1.19.0] specify an alternative url for HCAP HTML application. If "alternative_url" doesn't exist or is empty string, HCAP HTML application designated in XAIT.xml will be launched. Otherwise, HCAP HTML application specified in "alternative_url" will be launched. | Read/Write | [url string] URL for HCAP HTML application. | ""(empty string)
      block_external_input | [since 1.19.0] determine whether to block the external input port or not. | Read/Write | [0|1] 0 : allow all external input port. 1 : block all external input port. | 0
      block_ir | [since 1.19.0] determine whether to block the IR key (except exclusive factory RCU keys) input or not. If "block_local_key" is "2", setting "block_ir" to "2" will be failed. That is, at least one of IR power key or local power key should be worked. | Read/Write | [0|1|2] 0 : allow all IR input. 1 : block all IR input except Power key. 2 : block all IR input. | 0
      block_local_key | [since 1.19.0] determine whether to block the local key or not. If "block_ir" is "2", setting "block_local_key" to "2" will be failed. That is, at least one of IR power key or local power key should be worked. | Read/Write | [0|1|2] 0 : allow all local keys. 1 : block all local keys except power key. 2 : block all local keys. | 0
      block_usb | [since 1.19.0] determine whether to block the USB port or not. Changed setting will take affect after a reboot. | Read/Write | [0|1] 0 : allow all USB port. 1 : block all USB port. | 0
      installation_menu_password | [since 1.19.0] password to enter the installation menu. | Write | [password string] 4 digits string | 1234
      block_hidden_menu | [since 1.19.0] determine whether to block hidden menus to be able to enter with guest remote RCU like installation menu and PTC menu, or not. | Read/Write | [0|1] 0 : allow to enter hidden menus. 1 : block to enter hidden menus. | 0
      block_launcher | [since 1.19.0] determine whether to block the webOS launcher or not. | Read/Write | [0|1] 0 : allow the launcher. 1 : block the launcher. | 0

      block_hotkey

      [since 1.19.0] determine whether to make PORTAL/GUIDE/INFO keys hot keys in webOS TV or not. If they are hot keys, HCAP application will always get focused automatically by TV and hot keys will be delivered to HCAP application. If they are not hot keys, focus will not be changed and the keys will be delivered to HCAP application.

      Read/Write

      [0|1]
      0 : PORTAL/GUIDE/INFO keys are hot keys.
      1 : PORTAL/GUIDE/INFO keys are not hot keys.

      0

      clock_display | [since 1.19.0] determine whether to display the external clock or not. | Read/Write | [0|1] 0 : the external clock is not displayed. 1 : the external clock is displayed. | 1
      teletext | [since 1.19.0] determine whether to enable the teletext or not. | Read/Write | [0|1] 0 : disable the teletext. 1 : enable the teletext. | 1
      secure_mmr_pairing | [since 1.19.0] determine whether TV to permit pairing with MMR (Magic Motion RCU). | Read/Write | [0|1] 0 : TV permits pairing with MMR anytime as before. 1 : TV permits pairing with MMR only when installation menu is focused. | 0
      dial | [since 1.19.0] determine whether to enable DIAL or not. | Read/Write | [0|1] 0 : disable DIAL. 1 : enable DIAL. | 0
      alljoyn | [since 1.19.0] determine whether to enable AllJoyn or not. | Read/Write | [0|1] 0 : disable AllJoyn. 1 : enable AllJoyn. | 0

      clock_source

      [since 1.19.0] set the clock source.

      Read/Write

      [off|pro:centric|tv|ntp|admin]
      off : update the clock time for all clock sources.
      pro:centric : update the clock time only for the Pro:Centric data channel time.
      tv : update the clock time only for the TV channel time.
      ntp : update the clock time only for the NTP (Network Time Protocol) server time.
      admin : update the clock time only for the time requested by hcap.time.setLocalTime(). If hcap.time.setLocalTime() is called in the other clock source than "admin", "clock_source" will be changed to "admin" automatically.

      off : when Pro:Centric is OFF.
      pro:centric : when Pro:Centric is enabled.

      xait_version | [since 1.20.0] xait version in the local xait.xml | Read | [number string] number format string |
      asl_mode | [since 1.20.1] Whether ASL(Application Side Loading) mode is supported, or not. | Read | [0|1] 0 : ASL mode is disabled. 1 : ASL mode is enabled. | 0
      screensaver_control | [since 1.20.1] Indicates who is in charge of handling the screensaver. | Read/Write | [0|1] 0 : The Pro:Centric platform is in charge of starting and ending a screensaver. 1 : HCAP Application is in charge of starting and ending a screensaver. screensaver_event_received() is provided for implementing screensaver by HCAP Application. | 0
      rms_trusted_ip | [since 1.20.3] Set the ip address that can execute all commands of RMS(Remote Manager Service) include Security APIs | Read/Write | [string] ip address | 10.186.122.21
      lg_service_xml_version | [since 1.21.0] lg service xml version in the local lgservice.xml | Read | [number string] number format string |
      input_splash_image | [since 1.23.0] determine whether to enable splash image or not. | Read/Write | [0|1] 0 : disable splash image. 1 : enable splash image. | 1
      tv_zone / stb_zone | [since 1.20.8][UA Only] Set the tv_zone / stb_zone that used for cloning | Read/Write | [0-8] number format string | "1"
      wifi_zone | [since 1.20.8][UA Only] Set the wifi_zone that used for cloning | Read/Write | [0-99] number format string | "5"
      cec_device_control | [since 1.24.0] determine whether to control CEC device or not | Read/Write | [0|1] 0 : disable cec_device control (default) 1 : enable cec_device control (handle in SI app) | "0"
      automatic_update | [since 1.24.2] determine whether to enable automatic software update. | Read/Write | [off|on|once] off : disable automatic software updates. on : enable automatic software updates. once : Use automatic software updates once and change to "off". | "off"
      HCAP Property

    - {Function} param.onSuccess [Optional] - success callback function.

            param.onSuccess = function (param) {
                // {String} param.value - property value.
            }

    - {Function} param.onFailure [Optional] - failure callback function.

            param.onFailure = function (param) {
                // {String} param.errorMessage - in case of failure, this message provides the details.
            }

  Since:
    1.3.1
  See:
    hcap.property.setProperty()
    {Event} property_changed
- <static> hcap.property.setHotelMode(param)
  Sets the hotel mode.
  If this is called while Installation Menu is being shown, Installation Menu will be destroyed automatically.
  Reboot is strongly recommended after this call is succeeded because some changes in hotel mode requires reboot to be applied.

      hcap.property.setHotelMode({
           "hotelMode" : "{ \
               'enable':'off', \
               'settings':{ \
                   'powerOnStatus':'std', \
                   'volume':{ \
                       'enable':'off', \
                       'settings':{ \
                           'startVolume':{ \
                               'enable':'off', \
                               'level':0 \
                           }, \
                           'minimumVolume':0, \
                           'maximumVolume':100 \
                       } \
                   }, \
                   'keyManagement':{ \
                       'enable':'off', \
                       'settings':{ \
                           'irOperation':'normal', \
                           'localKeyOperation':'normal' \
                       } \
                   }, \
                   'limitedMode':{ \
                       'enable':'off', \
                       'settings':{ \
                           'setupMenu':'on', \
                           'programmeChange':'on', \
                           'menuDisplay':'on', \
                           'osdDisplay':'on', \
                           'systemProviderMode':'off' \
                       } \
                   }, \
                   'dtvProgrammeUpdate':'manual', \
                   'powerOnDefault': { \
                       'enable':'off', \
                       'settings':{ \
                           'input':'off', \
                           'programme':'2', \
                           'avSetting':'off', \
                           'aspectRatio':'disable' \
                       } \
                   }, \
                   'auxSourceSetting':{ \
                       'enable':'off', \
                       'settings':[ \
                           'av1', \
                           'comp1', \
                           'hdmi1', \
                           'hdmi2' \
                       ] \
                   }, \
                   'powerManagement':'off', \
                   'radioVideoBlank':{ \
                       'enable':'off', \
                       'startOfRadioProgramme':1, \
                       'countOfRadioProgramme':1 \
                   } \
               } \
           }",
           "onSuccess" : function() {
               console.log("onSuccess");
           },
           "onFailure" : function(f) {
               console.log("onFailure : errorMessage = " + f.errorMessage);
           }
      });

  Parameters:
  {Object} param
    - {Number} param.hotelMode [Required] - hotel mode settings to set. Now that hotelMode must have all items in the success callback parameter hotelMode of hcap.property.getHotelMode(), we're strongly recommend to change the setting values based on the result of hcap.property.getHotelMode(). If it misses some items, it'll be failed to set the hotel mode.
    - {Function} param.onSuccess [Optional] - success callback function.

            param.onSuccess = function() {
                // No Parameter.
            }

    - {Function} param.onFailure [Optional] - failure callback function.

            param.onFailure = function (param) {
                // {String} param.errorMessage - in case of failure, this message provides the details.
            }

  Since:
    1.20.0
  See:
    hcap.property.getHotelMode()
- Sets the installer menu item value.

      hcap.property.setInstallerMenuItem({
           "key" : hcap.property.InstallerMenuItem.INSTALLER_SEQ,
           "value" : 1,
           "onSuccess" : function() {
               console.log("onSuccess");
           },
           "onFailure" : function(f) {
               console.log("onFailure : errorMessage = " + f.errorMessage);
           }
      });

  Parameters:
  {Object} param
    - {Number} param.key [Required] - installer menu item type. Please refer to hcap.property.InstallerMenuItem.
    - {Number} param.value [Required] - picture property value of the requested type. Please refer to hcap.property.InstallerMenuItem.
    - {Function} param.onSuccess [Optional] - success callback function.

            param.onSuccess = function() {
                // No Parameter.
            }

    - {Function} param.onFailure [Optional] - failure callback function.

            param.onFailure = function (param) {
                // {String} param.errorMessage - in case of failure, this message provides the details.
            }

  Since:
    1.22.0
  See:
    hcap.property.InstallerMenuItem
    hcap.property.getInstallerMenuItem()
- <static> hcap.property.setPictureMode(param)
  Sets the picture mode.

      hcap.property.setPictureMode({
           "mode" : hcap.property.PictureMode.VIVID,
           "reset" : true,
           "onSuccess" : function() {
               console.log("onSuccess");
           },
           "onFailure" : function(f) {
               console.log("onFailure : errorMessage = " + f.errorMessage);
           }
      });

  Parameters:
  {Object} param
    - {Number} param.mode [Required] - picture mode. Please refer to hcap.property.PictureMode.
    - {Boolean} param.reset [Required] - true to reset all picture property values to default in the picture mode, otherwise false.
    - {Function} param.onSuccess [Optional] - success callback function.

            param.onSuccess = function() {
                // No Parameter.
            }

    - {Function} param.onFailure [Optional] - failure callback function.

            param.onFailure = function (param) {
                // {String} param.errorMessage - in case of failure, this message provides the details.
            }

  Since:
    1.20.0
  See:
    hcap.property.PictureMode.VIVID
    hcap.property.PictureMode.STANDARD
    hcap.property.PictureMode.ECO
    hcap.property.PictureMode.CINEMA
    hcap.property.PictureMode.SPORTS
    hcap.property.PictureMode.GAME
    hcap.property.PictureMode.PHOTO
    hcap.property.PictureMode.EXPERT_BRIGHT_ROOM
    hcap.property.PictureMode.EXPERT_DARK_ROOM
    hcap.property.getPictureMode()
- <static> hcap.property.setPictureProperty(param)
  Sets the picture property value for the current media input source.

      hcap.property.setPictureProperty({
           "key" : hcap.property.PicturePropertyKey.COLOR_TEMPERATURE,
           "value" : 10,
           "onSuccess" : function() {
               console.log("onSuccess");
           },
           "onFailure" : function(f) {
               console.log("onFailure : errorMessage = " + f.errorMessage);
           }
      });

  Parameters:
  {Object} param
    - {Number} param.key [Required] - picture property key type. Please refer to hcap.property.PicturePropertyKey.
    - {Number} param.value [Required] - picture property value of the requested property key. Please refer to hcap.property.PicturePropertyKey.
    - {Function} param.onSuccess [Optional] - success callback function.

            param.onSuccess = function() {
                // No Parameter.
            }

    - {Function} param.onFailure [Optional] - failure callback function.

            param.onFailure = function (param) {
                // {String} param.errorMessage - in case of failure, this message provides the details.
            }

  Since:
    1.6.0
  See:
    hcap.property.PicturePropertyKey.BACKLIGHT
    hcap.property.PicturePropertyKey.CONTRAST
    hcap.property.PicturePropertyKey.BRIGHTNESS
    hcap.property.PicturePropertyKey.SHARPNESS
    hcap.property.PicturePropertyKey.COLOR
    hcap.property.PicturePropertyKey.TINT
    hcap.property.PicturePropertyKey.COLOR_TEMPERATURE
    hcap.property.PicturePropertyKey.ASPECT_RATIO
    hcap.property.getPictureProperty()
- <static> hcap.property.setProperty(param)
  Sets a platform property. Please refer to writable property key and value in hcap.property.getProperty().

      hcap.property.setProperty({
           "key" : "tv_volume_ui",
           "value" : "0",
           "onSuccess" : function() {
               console.log("onSuccess");
           },
           "onFailure" : function(f) {
               console.log("onFailure : errorMessage = " + f.errorMessage);
           }
      });

  Parameters:
  {Object} param
    - {String} param.key [Required] - property key to be set.
    - {String} param.value [Required] - property value to be set.
    - {Function} param.onSuccess [Optional] - success callback function.
      Setting to the same value for the key as before will invoke this callback function.

            param.onSuccess = function() {
                // No parameter.
            }

    - {Function} param.onFailure [Optional] - failure callback function.

            param.onFailure = function (param) {
                // {String} param.errorMessage - in case of failure, this message provides the details.
            }

  Since:
    1.3.1
  See:
    hcap.property.getProperty()
    {Event} property_changed