Namespace hcap.system

hcap.system

Defined in: hcap-1.24.6.5901.js

Namespace Summary
Constructor Attributes	Constructor Name and Description
	hcap.system

Method Summary

Method Attributes	Method Name and Description
<static>	hcap.system.beginDestroy(param) Informs TV of that the application will start cleaning up its resource.
<static>	hcap.system.cancelUpdate(param) Update can be canceled in case of manual download.
<static>	hcap.system.endDestroy(param) Informs TV of that the application finishes its cleanup job.
<static>	hcap.system.expireProxyServer(param) Expires the current configuration of proxy server.
<static>	hcap.system.getAudioPtsOffset(param) Gets the current audio pts offset.
<static>	hcap.system.getBrowserDebugMode(param) Gets the current remote object inspector mode of the HCAP browser.
<static>	hcap.system.getCpuUsage(param) Gets the percentage of the used CPU resource.
<static>	hcap.system.getDefaultSoundOutput(param) Gets the default sound output.
<static>	hcap.system.getFocused(param) Gets whether HCAP application gets focused or not.
<static>	hcap.system.getLocale(param) Gets the locale specifier of the current locale.
<static>	hcap.system.getLocaleList(param) Gets the supported locale item list with an item (specifier, language name, country name).
<static>	hcap.system.getMemoryUsage(param) Gets the percentage of the used memory.
<static>	hcap.system.getNoSignalImage(param) Gets the current configuration of no signal image.
<static>	hcap.system.getProcentricServer(param) Gets the current configuration of Pro:Centric server.
<static>	hcap.system.getProxyServer(param) Gets the current configuration of proxy server.
<static>	hcap.system.getScreenCaptureImage(param) Gets the screen capture image.
<static>	hcap.system.getScreenKeyboardLanguageList(param) Gets the list of supported screen keyboard languages.
<static>	hcap.system.getSoundOutput(param) Gets the current sound output.
<static>	hcap.system.getUpdateProgress(param) It informs you of the progress of the software update.
<static>	hcap.system.getUsbPowerControl(param) Gets the status of usb power control.
<static>	hcap.system.getVideoPtsOffset(param) Gets the current video pts offset.
<static>	hcap.system.launchHcapHtmlApplication(param) Loads HCAP HTML application.
<static>	hcap.system.requestCloning(param) Requests XML cloning to TV.
<static>	hcap.system.requestFocus(param) Requests to make HCAP application get focused.
<static>	hcap.system.requestLocaleChange(param) Requests the system locale change to TV.
<static>	hcap.system.requestScreenCaptureImage(param) Requests screen capture.
<static>	hcap.system.setAudioPtsOffset(param) sets the audio pts offset.
<static>	hcap.system.setBrowserDebugMode(param) Turns on or off the remote object inspector of the HCAP browser.
<static>	hcap.system.setDefaultSoundOutput(param) Sets the default sound output.
<static>	hcap.system.setNoSignalImage(param) Turns on or off no signal image.
<static>	hcap.system.setProcentricServer(param) Sets the configuration of Pro:Centric server.
<static>	hcap.system.setProxyServer(param) Sets the configuration of proxy server.
<static>	hcap.system.setScreenKeyboardLanguage(param) Sets the screen keyboard language.
<static>	hcap.system.setSoundOutput(param) Sets the sound output.
<static>	hcap.system.setUsbPowerControl(param) Sets the status of usb power control.
<static>	hcap.system.setVideoPtsOffset(param) sets the video pts offset.
<static>	hcap.system.showToastMessage(param) show toast message on the TV screen.
<static>	hcap.system.startManualUpdate(param) manually start the software update.

Namespace Detail

hcap.system

Method Detail

<static> hcap.system.beginDestroy(param)

Informs TV of that the application will start cleaning up its resource.
This should be called within 1 second in the event "on_destroy" listener, or it will be failed.
If this is not called or is called after 1 second, TV will not wait for hcap.system.endDestroy and go turn off.

document.addEventListener(
     "on_destroy",
     function() {
         console.log("Event 'on_destroy' is received");
         hcap.system.beginDestroy({
             "onSuccess" : function() {
                 console.log("beginDestroy onSuccess");

                 // clean up resources

                 hcap.system.endDestroy({
                     "onSuccess" : function() {
                         console.log("endDestroy onSuccess");
                     },
                     "onFailure" : function(e) {
                         console.log("endDestroy onFailure : errorMessage = " + e.errorMessage);
                     }
                 });
             },
             "onFailure" : function(f) {
                 console.log("beginDestroy onFailure : errorMessage = " + f.errorMessage);
             }
         });
     },
     false
);

Parameters:

{Object} param

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

  param.onSuccess = function (param) {
      // 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:: {Event} on_destroy
hcap.system.endDestroy()

<static> hcap.system.cancelUpdate(param)

Update can be canceled in case of manual download.

hcap.system.cancelUpdate({
     "onSuccess" : function() {
         console.log("onSuccess");
     }, 
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

{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.24.2

See:: {Event} software_update_event_received
hcap.system.startManualUpdate()
hcap.system.getUpdateProgress()

<static> hcap.system.endDestroy(param)

Informs TV of that the application finishes its cleanup job.
TV waits for hcap.system.endDestroy up to 10 minutes after hcap.system.beginDestroy is called.

document.addEventListener(
     "on_destroy",
     function() {
         console.log("Event 'on_destroy' is received");
         hcap.system.beginDestroy({
             "onSuccess" : function() {
                 console.log("beginDestroy onSuccess");

                 // clean up resources

                 hcap.system.endDestroy({
                     "onSuccess" : function() {
                         console.log("endDestroy onSuccess");
                     },
                     "onFailure" : function(e) {
                         console.log("endDestroy onFailure : errorMessage = " + e.errorMessage);
                     }
                 });
             },
             "onFailure" : function(f) {
                 console.log("beginDestroy onFailure : errorMessage = " + f.errorMessage);
             }
         });
     },
     false
);

Parameters:

{Object} param

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

  param.onSuccess = function (param) {
      // 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:: {Event} on_destroy
hcap.system.beginDestroy()

<static> hcap.system.expireProxyServer(param)

Expires the current configuration of proxy server.

hcap.system.expireProxyServer({
     "onSuccess" : function() {
         console.log("onSuccess");
     },
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

{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.21.0

See:: hcap.system.getProxyServer()
hcap.system.setProxyServer()

<static> hcap.system.getAudioPtsOffset(param)

Gets the current audio pts offset.

hcap.system.getAudioPtsOffset({
     "onSuccess" : function(p) {
         console.log("onSuccess : audio pts offset = " + p.audioPtsOffset);
     },
     "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.audioPtsOffset - audio pts offset.
  }

{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.21.0

See:: hcap.system.setAudioPtsOffset()
hcap.system.getVideoPtsOffset()
hcap.system.setVideoPtsOffset()

<static> hcap.system.getBrowserDebugMode(param)

Gets the current remote object inspector mode of the HCAP browser.

hcap.system.getBrowserDebugMode({
     "onSuccess" : function(p) {
         console.log("onSuccess : debugMode = " + p.debugMode);
     },
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

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

  param.onSuccess = function (param) {
      // {Boolean} param.debugMode - true if the debug mode of HCAP browser is on. false if the debug mode of HCAP browser is off.
  }

{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.21.0

See:: hcap.system.setBrowserDebugMode()

<static> hcap.system.getCpuUsage(param)

Gets the percentage of the used CPU resource.

hcap.system.getCpuUsage({
     "onSuccess" : function (param) {
         console.log("onSuccess : percentage of used CPU resource = " + param.percentage);
     }, 
     "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.percentage - percentage of used CPU resource.
  }

{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.19.0

See:: hcap.system.getMemoryUsage()

<static> hcap.system.getDefaultSoundOutput(param)

Gets the default sound output.

hcap.system.getDefaultSoundOutput({
     "onSuccess" : function(p) {
         console.log("onSuccess : sound output = " + p.defaultSoundOutput);
     },
     "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.defaultSoundOutput - default sound output. Please refer to hcap.system.SoundOutputType.
  }

{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.23.0

See:: hcap.system.setDefaultSoundOutput()

<static> hcap.system.getFocused(param)

Gets whether HCAP application gets focused or not.
This is worked only when the property "block_hotkey" is "1".

hcap.system.getFocused({
     "onSuccess" : function (param) {
         console.log("onSuccess : focused = " + param.focused);
     }, 
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

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

  param.onSuccess = function (param) {
      // {Boolean} param.focused - true if the HCAP application gets focused, else false.
  }

{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.19.0

See:: hcap.property.getProperty()

<static> hcap.system.getLocale(param)

Gets the locale specifier of the current locale.

hcap.system.getLocale({
     "onSuccess" : function (param) {
         console.log("onSuccess : specifier = " + param.specifier + ", language = " + param.language + ", country = " + param.country);
     }, 
     "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.specifier - locale specifier of the current locale.
      // {String} param.language - language name of the current locale.
      // {String} param.country - country name of the current locale.
  }

{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.19.0

See:: {Event} locale_changed
hcap.system.getLocaleList()
hcap.system.requestLocaleChange()

<static> hcap.system.getLocaleList(param)

Gets the supported locale item list with an item (specifier, language name, country name).
Locale specifier is composed of {language code}-{country code} and it is worked as the identifier when setting system locale.

hcap.system.getLocaleList({
     "onSuccess" : function(s) {
         console.log("onSuccess : list length = " + s.list.length);
         for (var i = 0; i < s.list.length; i++) {
             console.log(
                 "list[" + i + "].specifier = " + s.list[i].specifier +
                 "list[" + i + "].language = " + s.list[i].language +
                 "list[" + i + "].country = " + s.list[i].country
             );
         }
     },
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

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

  param.onSuccess = function (param) {
      // {Array} param.list - locale list supported by TV.
      //         {String} param.list[].specifier - locale specifier ({language code}-{country code} such as "en-GB" and "ko-KR")
      //         {String} param.list[].language - language name
      //         {String} param.list[].country - country name
      //                 param.list example - 
      //                     "list" :  [
      //                     { "specifier" : "en-GB", "language" : "English", "country" : "United Kingdom" },
      //                     { "specifier" : "ko-KR", "language" : "�븳援��뼱", "country" : "�븳援�" },
      //                     ]
  }

{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.19.0

See:: {Event} locale_changed
hcap.system.getLocaleList()
hcap.system.requestLocaleChange()

<static> hcap.system.getMemoryUsage(param)

Gets the percentage of the used memory.

hcap.system.getMemoryUsage({
     "onSuccess" : function (param) {
         console.log("onSuccess : percentage of used memory = " + param.percentage + "free memory = " + param.freememory + "total memory = " + param.totalmemory  );
     }, 
     "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.percentage - percentage of used memory.
      // {Number} param.totalmemory - percentage of used memory.
      // {Number} param.freememory - percentage of used memory.
  }

{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.19.0

See:: hcap.system.getCpuUsage()

<static> hcap.system.getNoSignalImage(param)

Gets the current configuration of no signal image.

hcap.system.getNoSignalImage({
     "onSuccess" : function(p) {
         console.log("onSuccess : noSignalImage = " + p.noSignalImage);
     },
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

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

  param.onSuccess = function (param) {
      // {Boolean} param.noSignalImage - true if no signal image is on. false if no signal image is off.
  }

{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.21.0

See:: hcap.system.setNoSignalImage()

<static> hcap.system.getProcentricServer(param)

Gets the current configuration of Pro:Centric server.

hcap.system.getProcentricServer({
     "onSuccess" : function(p) {
         console.log("onSuccess : Pro:Centric server mode = " + p.mode + ", media = " + p.media);
         if (p.media === "rf") {
             console.log("RF server type = " + p.rfServer.type + ", data channel number = " + p.rfServer.dataChannelNumber); // US
             console.log("RF server type = " + p.rfServer.type + ", frequency = " + p.rfServer.freqeuncy); // EU
         } else if (p.media === "ip") {
             if (p.ipServer.type === "ip") {
                 console.log("IP server : type = ip, ip address = " + p.ipServer.ip + ", port = " + p.ipServer.port);
             } else if (p.ipServer.type === "domain_name") {
                 console.log("IP server : type = domain_name, domain name = " + p.ipServer.domainName + ", port = " + p.ipServer.port);
             }
         }
     },
     "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.mode - Pro:Centric mode. ([US] "configuration_only"/"gem"/"flash"/"html", [EU] "off"/"configuration_only"/"gem"/"flash"/"html")
      // {String} param.media - media type ("rf"/"ip")
      // {Object} param.rfServer - data for param.media = "rf"
      //      {
      //          {String} type - RF data channel type ([US] "auto"/ "manual", [EU] "dvb-t"/"dvb-c")
      //          {Number} dataChannelNumber - [US] data channel number of RF server
      //          {Number} frequency - [EU] frequency of RF server (Hz, and MHz for satellite)
      //      }
      // {Object} param.ipServer - data for param.media = "ip"
      //      {
      //          {String} type - [US/EU] IP address type ("ip" : IPv4 or IPv6 type / "domain_name" : domain name)
      //          {String} ip - [US/EU] IPv4 or IPv6 address taken affect only when type is "ip"
      //          {String} domainName - [US/EU] domain name taken affect only when type is "domain_name"
      //          {Number} port - [US/EU] IP port number
      //      }
  }

{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.19.0

See:: hcap.system.setProcentricServer()

<static> hcap.system.getProxyServer(param)

Gets the current configuration of proxy server.

hcap.system.getProxyServer({
     "onSuccess" : function(p) {
         console.log("onSuccess : proxy server ip address= " + p.ip + ", port = " + p.port);
     },
     "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.ip - IPv4 or IPv6 address
      // {Number} param.port - IP port number
  }

{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.21.0

See:: hcap.system.setProxyServer()
hcap.system.expireProxyServer()

<static> hcap.system.getScreenCaptureImage(param)

Gets the screen capture image.

hcap.system.getScreenCaptureImage({
     "onSuccess" : function(s) {
         console.log("onSuccess : uri = " + s.uri);
     }, 
     "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.uri - URI for the screen capture image.
  }

{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.23.0

See:: hcap.system.requestScreenCaptureImage()

<static> hcap.system.getScreenKeyboardLanguageList(param)

Gets the list of supported screen keyboard languages.
Screen keyboard language list is composed of language codes and delimiter comma(',').

hcap.system.getScreenKeyboardLanguageList({
     "onSuccess" : function(s) {
         console.log("onSuccess : list = " + s.list);
     }, 
     "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.list - screen keyboard language list string. 
      //     which is composed of language codes separated by delimiter comma(',').
  }

{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.system.setScreenKeyboardLanguage()

<static> hcap.system.getSoundOutput(param)

Gets the current sound output.

hcap.system.getSoundOutput({
     "onSuccess" : function(p) {
         console.log("onSuccess : sound output = " + p.soundOutput);
     },
     "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.soundOutput - sound output. Please refer to hcap.system.SoundOutputType.
  }

{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.system.setSoundOutput()

<static> hcap.system.getUpdateProgress(param)

It informs you of the progress of the software update.

hcap.system.getUpdateProgress({
     "onSuccess" : function() {
         console.log("onSuccess : progress = " + s.progress + ", totalPackage = " + s.totalPackage + ", installedPackage = " + s.installedPackage);
     }, 
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

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

  param.onSuccess = function() {
      // {Number} param.progress - software update progress
      // {Number} param.totalPackage - total package capacity
      // {Number} param.installedPackage - installed package capacity		
  }

{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.24.2

See:: {Event} software_update_event_received
hcap.system.startManualUpdate()
hcap.system.cancelUpdate()

<static> hcap.system.getUsbPowerControl(param)

Gets the status of usb power control.

hcap.system.getUsbPowerControl({
     "portNumber" : 2,
     "onSuccess" : function(s) {
         console.log("onSuccess : status = " + s.status);
     }, 
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

{Number} param.portNumber [Required] - port number to be get the status of usb power control.

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

  param.onSuccess = function (param) {
      // {Boolean} param.status - the status of usb power control.
  }

{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.23.0

See:: hcap.system.setUsbPowerControl()

<static> hcap.system.getVideoPtsOffset(param)

Gets the current video pts offset.

hcap.system.getVideoPtsOffset({
     "onSuccess" : function(p) {
         console.log("onSuccess : video pts offset = " + p.videoPtsOffset);
     },
     "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.videoPtsOffset - video pts offset.
  }

{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.21.0

See:: hcap.system.setVideoPtsOffset()
hcap.system.getAudioPtsOffset()
hcap.system.setAudioPtsOffset()

<static> hcap.system.launchHcapHtmlApplication(param)

Loads HCAP HTML application.
When a HCAP HTML application has already been loaded, the HCAP HTML application is reloaded according to the "alternative_url" policy.
That is, if the property "alternative_url" exists and it is not empty string, load "alternative_url". Otherwise, the application specified in XAIT.xml is loaded.
```
hcap.system.launchHcapHtmlApplication({
     "onSuccess" : function() {
         console.log("onSuccess");
     }, 
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});
```
Parameters:

{Object} param
- {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.19.0

See:

hcap.property.getProperty()
<static> hcap.system.requestCloning(param)

Requests XML cloning to TV.
This acts exactly same as USB cloning.
When the cloning is done, HCAP Application will get the notification {Event} cloning_done_received.
We strongly recommend reboot after xml cloning.
```
hcap.system.requestCloning({
     "xml" : "....",
     "onSuccess" : function() {
         console.log("onSuccess");
     },
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});
```
Parameters:

{Object} param
- {String} param.xml - XML string for cloning.
- {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.19.0

See:

{Event} cloning_done_received
<static> hcap.system.requestFocus(param)

Requests to make HCAP application get focused.
If this request is successful and the focus is changed from a Preloaded Application to HCAP Application, HCAP Application will get the notification {Event} hcap_application_focus_changed

. If HCAP Application gets focused already, there will be no notification regarding focus change. This is worked only when the property "block_hotkey" is "1".
```
hcap.system.requestFocus({
     "onSuccess" : function() {
         console.log("onSuccess");
     }, 
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});
```
Parameters:

{Object} param
- {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.19.0

See:

hcap.property.getProperty()
<static> hcap.system.requestLocaleChange(param)

Requests the system locale change to TV.
It will return soon after the request is done.
If the request is successful, the menu language will be changed and the locale change result will be notified through {Event} locale_changed.
```
hcap.system.requestLocaleChange({
     "specifier" : "ko-KR",
     "onSuccess" : function() {
         console.log("onSuccess");
     },
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});
```
Parameters:

{Object} param
- {String} param.specifier - locale specifier to set.
- {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.19.0

See:

{Event} locale_changed
hcap.system.getLocaleList()
hcap.system.getLocale()

<static> hcap.system.requestScreenCaptureImage(param)

Requests screen capture.

hcap.system.requestScreenCaptureImage({
     "onSuccess" : function() {
         console.log("onSuccess");
     }, 
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

{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.23.0

See:: hcap.system.getScreenCaptureImage()

<static> hcap.system.setAudioPtsOffset(param)

sets the audio pts offset.

hcap.system.setAudioPtsOffset({
     "audioPtsOffset" : 10,
     "onSuccess" : function(p) {
         console.log("onSuccess : audio pts offset = " + p.audioPtsOffset);
     },
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

{Number} param.audioPtsOffset [Required] - audio pts offset. The value must be multiples of 10 (-500 ~ 500).

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

  param.onSuccess = function (param) {
      // 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.21.0

See:: hcap.system.getAudioPtsOffset()
hcap.system.getVideoPtsOffset()
hcap.system.setVideoPtsOffset()
{Event} ui_value_changed

<static> hcap.system.setBrowserDebugMode(param)

Turns on or off the remote object inspector of the HCAP browser.
Changed setting will take affect after a reboot.
After a reboot, open the http://TV_IP:2345 on TV remote client (Chrome on PC).
```
hcap.system.setBrowserDebugMode({
     "debugMode" : true,
     "onSuccess" : function() {
         console.log("onSuccess");
     },
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});
```
Parameters:

{Object} param
- {Boolean} param.debugMode [Required] - true to turn on debug mode, else 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.21.0

See:

hcap.system.getBrowserDebugMode()

<static> hcap.system.setDefaultSoundOutput(param)

Sets the default sound output.

hcap.system.setDefaultSoundOutput({
     "defaultSoundOutput" : hcap.system.SoundOutputType.OPTICAL,
     "onSuccess" : function(p) {
         console.log("onSuccess : sound output = " + p.soundOutput);
     },
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

{Number} param.defaultSoundOutput [Required] - default sound output. Please refer to hcap.system.SoundOutputType.

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

  param.onSuccess = function (param) {
      // 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.23.0

See:: hcap.system.getDefaultSoundOutput()

<static> hcap.system.setNoSignalImage(param)

Turns on or off no signal image.

hcap.system.setNoSignalImage({
     "noSignalImage" : true,
     "onSuccess" : function() {
         console.log("onSuccess");
     },
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

{Boolean} param.noSignalImage [Required] - true to turn on no signal image, else 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.21.0

See:: hcap.system.getNoSignalImage()

<static> hcap.system.setProcentricServer(param)

Sets the configuration of Pro:Centric server.
```
hcap.system.setProcentricServer({
     "mode" : "gem",
     "media" : "ip",
     "ipServer" :  {
         "type" : "domain_name",
         "domainName" : "lge.com",
         "port" : 3876
     },
     "onSuccess" : function() {
         console.log("onSuccess");
     },
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});
```
Parameters:

{Object} param
- {String} param.mode [Required] - Pro:Centric mode. ([US] "configuration_only"/"gem"/"flash"/"html", [EU] "off"/"configuration_only"/"gem"/"flash"/"html")
- {String} param.media [Required] - media type ("rf"/"ip")
- {Object} param.rfServer [Required] - data for param.media = "rf"
      {
          {String} type - RF data channel type ([US] "auto"/ "manual", [EU] "dvb-t"/"dvb-c")
          {Number} dataChannelNumber - [US] data channel number of RF server
          {Number} frequency - [EU] frequency of RF server (Hz, and MHz for satellite)
      }
- {Object} param.ipServer [Required] - data for param.media = "ip"
      {
          {String} type - [US/EU] IP address type ("ip" : IPv4 or IPv6 type / "domain_name" : domain name)
          {String} ip - [US/EU] IPv4 or IPv6 address taken affect only when type is "ip"
          {String} domainName - [US/EU] domain name taken affect only when type is "domain_name"
          {Number} port - IP port number
      }
- {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.19.0

See:

hcap.system.getProcentricServer()

<static> hcap.system.setProxyServer(param)

Sets the configuration of proxy server.

hcap.system.setProxyServer({
     "ip" : "1.2.3.4",
     "port" : 3876,
     "onSuccess" : function() {
         console.log("onSuccess");
     },
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

{String} param.ip [Required] - ip - IPv4 or IPv6 address
{Number} param.port [Required] - port - IP port number
{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.21.0

See:: hcap.system.getProxyServer()
hcap.system.expireProxyServer()

<static> hcap.system.setScreenKeyboardLanguage(param)

Sets the screen keyboard language.

hcap.system.setScreenKeyboardLanguage({
     "keyboardLanguage" : "en", 
     "onSuccess" : function() {
         console.log("onSuccess");
     }, 
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

{String} param.keyboardLanguage [Required] - screen keyboard language to be set.
{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.system.getScreenKeyboardLanguageList()

<static> hcap.system.setSoundOutput(param)

Sets the sound output.

hcap.system.setSoundOutput({
     "soundOutput" : hcap.system.SoundOutputType.WIRED_HEADPHONES,
     "onSuccess" : function(p) {
         console.log("onSuccess : sound output = " + p.soundOutput);
     },
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

{Number} param.soundOutput [Required] - sound output. Please refer to hcap.system.SoundOutputType.

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

  param.onSuccess = function (param) {
      // 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.system.getSoundOutput()

<static> hcap.system.setUsbPowerControl(param)

Sets the status of usb power control.

hcap.system.setUsbPowerControl({
     "portNumber" : 2,
     "status" : true,
     "onSuccess" : function() {
         console.log("onSuccess");
     }, 
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

{Number} param.portNumber [Required] - port number to be set the status of usb power control.
{Boolean} param.status [Required] - the status of usb power control.
{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.23.0

See:: hcap.system.getUsbPowerControl()

<static> hcap.system.setVideoPtsOffset(param)

sets the video pts offset.

hcap.system.setVideoPtsOffset({
     "videoPtsOffset" : 10,
     "onSuccess" : function(p) {
         console.log("onSuccess : video pts offset = " + p.videoPtsOffset);
     },
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

{Number} param.videoPtsOffset [Required] - video pts offset. The value must be multiples of 10 (-500 ~ 500).

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

  param.onSuccess = function (param) {
      // 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.21.0

See:: hcap.system.getVideoPtsOffset()
hcap.system.getAudioPtsOffset()
hcap.system.setAudioPtsOffset()
{Event} ui_value_changed

<static> hcap.system.showToastMessage(param)

show toast message on the TV screen. The message will be displayed on the upper right corner for a short time. The message can not be exceed 162 bytes.

hcap.system.showToastMessage({
     "message" : "hello world", 
     "onSuccess" : function() {
         console.log("onSuccess");
     }, 
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

{String} param.message [Required] - the message body
{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.23.2

<static> hcap.system.startManualUpdate(param)

manually start the software update.

hcap.system.startManualUpdate({
     "onSuccess" : function() {
         console.log("onSuccess");
     }, 
     "onFailure" : function(f) {
         console.log("onFailure : errorMessage = " + f.errorMessage);
     }
});

Parameters:

{Object} param

{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.24.2

See:: {Event} software_update_event_received
hcap.system.cancelUpdate()
hcap.system.getUpdateProgress()

Library

Classes

Namespace hcap.system

Method Summary

Namespace Detail

Method Detail