4442 lines
131 KiB
HTML
Executable File
4442 lines
131 KiB
HTML
Executable File
|
||
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="generator" content="JsDoc Toolkit" />
|
||
<title>hcap.system | JsDoc Reference</title>
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
|
||
<meta name="mobileoptimized" content="0" />
|
||
|
||
<link rel="stylesheet" href="../css/all.css" media="all" />
|
||
<link rel="stylesheet" href="../css/handheld.css" media="only screen and (max-width: 660px)" />
|
||
<link rel="stylesheet" href="../css/handheld.css" media="handheld" />
|
||
<link rel="stylesheet" href="../css/screen.css" media="screen and (min-width: 661px)" />
|
||
|
||
<link rel="stylesheet" href="../javascript/highlighter/dessert.css" />
|
||
|
||
<script src="../javascript/all.js"></script>
|
||
<!--[if lt IE 9]>
|
||
<script src="../javascript/html5.js"></script>
|
||
<![endif]-->
|
||
|
||
|
||
</head>
|
||
|
||
<body>
|
||
|
||
<div class="index">
|
||
<div class="menu">
|
||
<div class="indexLinks">
|
||
<a href="../index.html">Classes</a>
|
||
<a href="../files.html">Files</a>
|
||
</div>
|
||
<table width=100% class=confidential><tr><td><b>LGE Confidential</b></td></tr></table>
|
||
<h2 class="heading1">Library</h2>
|
||
<table>
|
||
<tr>
|
||
<td align=left class=confidential><a href="../../js/hcap.js">·hcap.js (1.24.6.5901)</li></a></td>
|
||
</tr>
|
||
</table>
|
||
<h2 class="heading1">Classes</h2>
|
||
|
||
<input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input>
|
||
|
||
<nav>
|
||
<ul class="classList" id="ClassList">
|
||
|
||
<li><a href="../symbols/_global_.html">_global_</a></li>
|
||
|
||
<li><a href="../symbols/hcap.html">hcap</a></li>
|
||
|
||
<li><a href="../symbols/hcap.application.html">hcap<span class='break'> </span>.<span class='break'> </span>application</a></li>
|
||
|
||
<li><a href="../symbols/hcap.beacon.html">hcap<span class='break'> </span>.<span class='break'> </span>beacon</a></li>
|
||
|
||
<li><a href="../symbols/hcap.bluetooth.html">hcap<span class='break'> </span>.<span class='break'> </span>bluetooth</a></li>
|
||
|
||
<li><a href="../symbols/hcap.bluetooth.audio.html">hcap<span class='break'> </span>.<span class='break'> </span>bluetooth<span class='break'> </span>.<span class='break'> </span>audio</a></li>
|
||
|
||
<li><a href="../symbols/hcap.camera.html">hcap<span class='break'> </span>.<span class='break'> </span>camera</a></li>
|
||
|
||
<li><a href="../symbols/hcap.carousel.html">hcap<span class='break'> </span>.<span class='break'> </span>carousel</a></li>
|
||
|
||
<li><a href="../symbols/hcap.channel.html">hcap<span class='break'> </span>.<span class='break'> </span>channel</a></li>
|
||
|
||
<li><a href="../symbols/hcap.channel.AudioStreamType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>AudioStreamType</a></li>
|
||
|
||
<li><a href="../symbols/hcap.channel.ChannelStatus.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>ChannelStatus</a></li>
|
||
|
||
<li><a href="../symbols/hcap.channel.ChannelType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>ChannelType</a></li>
|
||
|
||
<li><a href="../symbols/hcap.channel.InbandDataServiceType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>InbandDataServiceType</a></li>
|
||
|
||
<li><a href="../symbols/hcap.channel.IpBroadcastType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>IpBroadcastType</a></li>
|
||
|
||
<li><a href="../symbols/hcap.channel.Polarization.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>Polarization</a></li>
|
||
|
||
<li><a href="../symbols/hcap.channel.RfBroadcastType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>RfBroadcastType</a></li>
|
||
|
||
<li><a href="../symbols/hcap.channel.VideoStreamType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>VideoStreamType</a></li>
|
||
|
||
<li><a href="../symbols/hcap.checkout.html">hcap<span class='break'> </span>.<span class='break'> </span>checkout</a></li>
|
||
|
||
<li><a href="../symbols/hcap.externalinput.html">hcap<span class='break'> </span>.<span class='break'> </span>externalinput</a></li>
|
||
|
||
<li><a href="../symbols/hcap.externalinput.ExternalInputType.html">hcap<span class='break'> </span>.<span class='break'> </span>externalinput<span class='break'> </span>.<span class='break'> </span>ExternalInputType</a></li>
|
||
|
||
<li><a href="../symbols/hcap.file.html">hcap<span class='break'> </span>.<span class='break'> </span>file</a></li>
|
||
|
||
<li><a href="../symbols/hcap.iot.html">hcap<span class='break'> </span>.<span class='break'> </span>iot</a></li>
|
||
|
||
<li><a href="../symbols/hcap.key.html">hcap<span class='break'> </span>.<span class='break'> </span>key</a></li>
|
||
|
||
<li><a href="../symbols/hcap.key.Code.html">hcap<span class='break'> </span>.<span class='break'> </span>key<span class='break'> </span>.<span class='break'> </span>Code</a></li>
|
||
|
||
<li><a href="../symbols/hcap.Media.html">hcap<span class='break'> </span>.<span class='break'> </span>Media</a></li>
|
||
|
||
<li><a href="../symbols/hcap.Media.SubtitleType.html">hcap<span class='break'> </span>.<span class='break'> </span>Media<span class='break'> </span>.<span class='break'> </span>SubtitleType</a></li>
|
||
|
||
<li><a href="../symbols/hcap.mode.html">hcap<span class='break'> </span>.<span class='break'> </span>mode</a></li>
|
||
|
||
<li><a href="../symbols/hcap.mouse.html">hcap<span class='break'> </span>.<span class='break'> </span>mouse</a></li>
|
||
|
||
<li><a href="../symbols/hcap.mpi.html">hcap<span class='break'> </span>.<span class='break'> </span>mpi</a></li>
|
||
|
||
<li><a href="../symbols/hcap.network.html">hcap<span class='break'> </span>.<span class='break'> </span>network</a></li>
|
||
|
||
<li><a href="../symbols/hcap.network.DhcpState.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>DhcpState</a></li>
|
||
|
||
<li><a href="../symbols/hcap.network.NetworkEventType.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>NetworkEventType</a></li>
|
||
|
||
<li><a href="../symbols/hcap.network.NetworkMode.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>NetworkMode</a></li>
|
||
|
||
<li><a href="../symbols/hcap.network.WifiSecurityType.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>WifiSecurityType</a></li>
|
||
|
||
<li><a href="../symbols/hcap.network.WirelessMode.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>WirelessMode</a></li>
|
||
|
||
<li><a href="../symbols/hcap.power.html">hcap<span class='break'> </span>.<span class='break'> </span>power</a></li>
|
||
|
||
<li><a href="../symbols/hcap.power.PowerMode.html">hcap<span class='break'> </span>.<span class='break'> </span>power<span class='break'> </span>.<span class='break'> </span>PowerMode</a></li>
|
||
|
||
<li><a href="../symbols/hcap.preloadedApplication.html">hcap<span class='break'> </span>.<span class='break'> </span>preloadedApplication</a></li>
|
||
|
||
<li><a href="../symbols/hcap.property.html">hcap<span class='break'> </span>.<span class='break'> </span>property</a></li>
|
||
|
||
<li><a href="../symbols/hcap.property.InstallerMenuItem.html">hcap<span class='break'> </span>.<span class='break'> </span>property<span class='break'> </span>.<span class='break'> </span>InstallerMenuItem</a></li>
|
||
|
||
<li><a href="../symbols/hcap.property.PictureMode.html">hcap<span class='break'> </span>.<span class='break'> </span>property<span class='break'> </span>.<span class='break'> </span>PictureMode</a></li>
|
||
|
||
<li><a href="../symbols/hcap.property.PicturePropertyKey.html">hcap<span class='break'> </span>.<span class='break'> </span>property<span class='break'> </span>.<span class='break'> </span>PicturePropertyKey</a></li>
|
||
|
||
<li><a href="../symbols/hcap.rms.html">hcap<span class='break'> </span>.<span class='break'> </span>rms</a></li>
|
||
|
||
<li><a href="../symbols/hcap.rs232c.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c</a></li>
|
||
|
||
<li><a href="../symbols/hcap.rs232c.BaudRate.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>BaudRate</a></li>
|
||
|
||
<li><a href="../symbols/hcap.rs232c.DataBit.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>DataBit</a></li>
|
||
|
||
<li><a href="../symbols/hcap.rs232c.FlowControl.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>FlowControl</a></li>
|
||
|
||
<li><a href="../symbols/hcap.rs232c.Parity.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>Parity</a></li>
|
||
|
||
<li><a href="../symbols/hcap.rs232c.StopBit.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>StopBit</a></li>
|
||
|
||
<li><a href="../symbols/hcap.security.html">hcap<span class='break'> </span>.<span class='break'> </span>security</a></li>
|
||
|
||
<li><a href="../symbols/hcap.socket.html">hcap<span class='break'> </span>.<span class='break'> </span>socket</a></li>
|
||
|
||
<li><a href="../symbols/hcap.speech.html">hcap<span class='break'> </span>.<span class='break'> </span>speech</a></li>
|
||
|
||
<li><a href="../symbols/hcap.speech.HostType.html">hcap<span class='break'> </span>.<span class='break'> </span>speech<span class='break'> </span>.<span class='break'> </span>HostType</a></li>
|
||
|
||
<li><a href="../symbols/hcap.system.html">hcap<span class='break'> </span>.<span class='break'> </span>system</a></li>
|
||
|
||
<li><a href="../symbols/hcap.system.SoundOutputType.html">hcap<span class='break'> </span>.<span class='break'> </span>system<span class='break'> </span>.<span class='break'> </span>SoundOutputType</a></li>
|
||
|
||
<li><a href="../symbols/hcap.time.html">hcap<span class='break'> </span>.<span class='break'> </span>time</a></li>
|
||
|
||
<li><a href="../symbols/hcap.video.html">hcap<span class='break'> </span>.<span class='break'> </span>video</a></li>
|
||
|
||
<li><a href="../symbols/hcap.volume.html">hcap<span class='break'> </span>.<span class='break'> </span>volume</a></li>
|
||
|
||
<li><a href="../symbols/hcap.webrtc.html">hcap<span class='break'> </span>.<span class='break'> </span>webrtc</a></li>
|
||
|
||
</ul>
|
||
</nav>
|
||
</div>
|
||
<div class="fineprint" style="clear:both">
|
||
<footer>
|
||
|
||
Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
|
||
Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br />
|
||
Generated on:
|
||
<time datetime='2021-8-13' pubdate>2021-8-13 18:29</time>
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="index indexStatic"></div>
|
||
|
||
<div class="content">
|
||
<div class="innerContent">
|
||
<article>
|
||
<header>
|
||
<h1 class="classTitle">
|
||
|
||
Namespace <span>hcap.system</span>
|
||
</h1>
|
||
|
||
<div class="intro">
|
||
<p class="description summary">
|
||
hcap.system
|
||
</p>
|
||
|
||
|
||
<ul class="summary">
|
||
|
||
|
||
|
||
<li>Defined in: <a href="../symbols/src/js_hcap-1.24.6.5901.js.html">hcap-1.24.6.5901.js</a></li>
|
||
|
||
|
||
</ul>
|
||
|
||
</div>
|
||
</header>
|
||
|
||
|
||
<section>
|
||
<div class="props">
|
||
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class hcap.system.">
|
||
<caption class="sectionTitle">Namespace Summary</caption>
|
||
<thead>
|
||
<tr>
|
||
<th scope="col">Constructor Attributes</th>
|
||
<th scope="col">Constructor Name and Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="attributes"> </td>
|
||
<td class="nameDescription" >
|
||
<div class="fixedFont">
|
||
<b><a href="../symbols/hcap.system.html#constructor">hcap.system</a></b>
|
||
</div>
|
||
<div class="description"></div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
|
||
|
||
<section>
|
||
|
||
|
||
|
||
</section>
|
||
|
||
<!--
|
||
#### METHODS SUMMARY
|
||
-->
|
||
|
||
<section>
|
||
|
||
|
||
<div class="props">
|
||
<h2 class="sectionTitle">Method Summary</h2>
|
||
|
||
|
||
<nav>
|
||
<table class="summaryTable" id="MethodsList" cellspacing="0" summary="A summary of the methods documented in the class hcap.system.">
|
||
<thead>
|
||
<tr>
|
||
<th scope="col">Method Attributes</th>
|
||
<th scope="col">Method Name and Description</th>
|
||
</tr>
|
||
</thead>
|
||
|
||
<tbody>
|
||
|
||
|
||
<tr
|
||
class='item0'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.beginDestroy">beginDestroy</a></b>(param)
|
||
</div>
|
||
<div class="description">Informs TV of that the application will start cleaning up its resource.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item1'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.cancelUpdate">cancelUpdate</a></b>(param)
|
||
</div>
|
||
<div class="description">Update can be canceled in case of manual download.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item2'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.endDestroy">endDestroy</a></b>(param)
|
||
</div>
|
||
<div class="description">Informs TV of that the application finishes its cleanup job.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item3'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.expireProxyServer">expireProxyServer</a></b>(param)
|
||
</div>
|
||
<div class="description">Expires the current configuration of proxy server.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item4'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.getAudioPtsOffset">getAudioPtsOffset</a></b>(param)
|
||
</div>
|
||
<div class="description">Gets the current audio pts offset.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item5'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.getBrowserDebugMode">getBrowserDebugMode</a></b>(param)
|
||
</div>
|
||
<div class="description">Gets the current remote object inspector mode of the HCAP browser.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item6'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.getCpuUsage">getCpuUsage</a></b>(param)
|
||
</div>
|
||
<div class="description">Gets the percentage of the used CPU resource.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item7'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.getDefaultSoundOutput">getDefaultSoundOutput</a></b>(param)
|
||
</div>
|
||
<div class="description">Gets the default sound output.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item8'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.getFocused">getFocused</a></b>(param)
|
||
</div>
|
||
<div class="description">Gets whether HCAP application gets focused or not.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item9'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.getLocale">getLocale</a></b>(param)
|
||
</div>
|
||
<div class="description">Gets the locale specifier of the current locale.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item10'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.getLocaleList">getLocaleList</a></b>(param)
|
||
</div>
|
||
<div class="description">Gets the supported locale item list with an item (specifier, language name, country name).</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item11'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.getMemoryUsage">getMemoryUsage</a></b>(param)
|
||
</div>
|
||
<div class="description">Gets the percentage of the used memory.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item12'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.getNoSignalImage">getNoSignalImage</a></b>(param)
|
||
</div>
|
||
<div class="description">Gets the current configuration of no signal image.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item13'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.getProcentricServer">getProcentricServer</a></b>(param)
|
||
</div>
|
||
<div class="description">Gets the current configuration of Pro:Centric server.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item14'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.getProxyServer">getProxyServer</a></b>(param)
|
||
</div>
|
||
<div class="description">Gets the current configuration of proxy server.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item15'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.getScreenCaptureImage">getScreenCaptureImage</a></b>(param)
|
||
</div>
|
||
<div class="description">Gets the screen capture image.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item16'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.getScreenKeyboardLanguageList">getScreenKeyboardLanguageList</a></b>(param)
|
||
</div>
|
||
<div class="description">Gets the list of supported screen keyboard languages.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item17'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.getSoundOutput">getSoundOutput</a></b>(param)
|
||
</div>
|
||
<div class="description">Gets the current sound output.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item18'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.getUpdateProgress">getUpdateProgress</a></b>(param)
|
||
</div>
|
||
<div class="description">It informs you of the progress of the software update.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item19'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.getUsbPowerControl">getUsbPowerControl</a></b>(param)
|
||
</div>
|
||
<div class="description">Gets the status of usb power control.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item20'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.getVideoPtsOffset">getVideoPtsOffset</a></b>(param)
|
||
</div>
|
||
<div class="description">Gets the current video pts offset.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item21'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.launchHcapHtmlApplication">launchHcapHtmlApplication</a></b>(param)
|
||
</div>
|
||
<div class="description">Loads HCAP HTML application.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item22'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.requestCloning">requestCloning</a></b>(param)
|
||
</div>
|
||
<div class="description">Requests XML cloning to TV.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item23'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.requestFocus">requestFocus</a></b>(param)
|
||
</div>
|
||
<div class="description">Requests to make HCAP application get focused.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item24'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.requestLocaleChange">requestLocaleChange</a></b>(param)
|
||
</div>
|
||
<div class="description">Requests the system locale change to TV.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item25'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.requestScreenCaptureImage">requestScreenCaptureImage</a></b>(param)
|
||
</div>
|
||
<div class="description">Requests screen capture.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item26'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.setAudioPtsOffset">setAudioPtsOffset</a></b>(param)
|
||
</div>
|
||
<div class="description">sets the audio pts offset.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item27'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.setBrowserDebugMode">setBrowserDebugMode</a></b>(param)
|
||
</div>
|
||
<div class="description">Turns on or off the remote object inspector of the HCAP browser.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item28'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.setDefaultSoundOutput">setDefaultSoundOutput</a></b>(param)
|
||
</div>
|
||
<div class="description">Sets the default sound output.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item29'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.setNoSignalImage">setNoSignalImage</a></b>(param)
|
||
</div>
|
||
<div class="description">Turns on or off no signal image.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item30'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.setProcentricServer">setProcentricServer</a></b>(param)
|
||
</div>
|
||
<div class="description">Sets the configuration of Pro:Centric server.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item31'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.setProxyServer">setProxyServer</a></b>(param)
|
||
</div>
|
||
<div class="description">Sets the configuration of proxy server.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item32'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.setScreenKeyboardLanguage">setScreenKeyboardLanguage</a></b>(param)
|
||
</div>
|
||
<div class="description">Sets the screen keyboard language.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item33'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.setSoundOutput">setSoundOutput</a></b>(param)
|
||
</div>
|
||
<div class="description">Sets the sound output.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item34'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.setUsbPowerControl">setUsbPowerControl</a></b>(param)
|
||
</div>
|
||
<div class="description">Sets the status of usb power control.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item35'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.setVideoPtsOffset">setVideoPtsOffset</a></b>(param)
|
||
</div>
|
||
<div class="description">sets the video pts offset.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item36'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.showToastMessage">showToastMessage</a></b>(param)
|
||
</div>
|
||
<div class="description">show toast message on the TV screen.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr
|
||
class='item37'
|
||
>
|
||
<td class="attributes"><static> </td>
|
||
<td class="nameDescription">
|
||
<div class="fixedFont">hcap.system.<b><a href="../symbols/hcap.system.html#.startManualUpdate">startManualUpdate</a></b>(param)
|
||
</div>
|
||
<div class="description">manually start the software update.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
</tbody>
|
||
</table>
|
||
</nav>
|
||
|
||
|
||
|
||
</div>
|
||
</section>
|
||
|
||
|
||
<!--
|
||
#### EVENTS SUMMARY
|
||
-->
|
||
|
||
<!--
|
||
#### CONSTRUCTOR DETAILS
|
||
-->
|
||
|
||
<section>
|
||
<div class="details props">
|
||
<div class="innerProps">
|
||
<h2 class="sectionTitle" id="constructor">
|
||
Namespace Detail
|
||
</h2>
|
||
|
||
<div class="fixedFont">
|
||
<b>hcap.system</b>
|
||
</div>
|
||
|
||
<div class="description">
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
<!--
|
||
#### FIELD DETAILS
|
||
-->
|
||
|
||
<!--
|
||
#### METHOD DETAILS
|
||
-->
|
||
|
||
<section>
|
||
<div class="details props">
|
||
<div class="innerProps">
|
||
<h2 class="sectionTitle">
|
||
Method Detail
|
||
</h2>
|
||
|
||
<ul class="methodDetail" id="MethodDetail">
|
||
|
||
|
||
<li
|
||
class='item0'
|
||
>
|
||
<div class="fixedFont heading" id=".beginDestroy">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>beginDestroy</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Informs TV of that the application will start cleaning up its resource.<br>
|
||
This should be called within 1 second in the event "on_destroy" listener, or it will be failed.<br>
|
||
If this is not called or is called after 1 second, TV will not wait for hcap.system.endDestroy and go turn off.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">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
|
||
);</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function (param) {
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.20.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="_global_.html#event:on_destroy">{Event} on_destroy</a><br>
|
||
<a href="hcap.system.html#.endDestroy">hcap.system.endDestroy()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item1'
|
||
>
|
||
<div class="fixedFont heading" id=".cancelUpdate">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>cancelUpdate</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Update can be canceled in case of manual download.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.cancelUpdate({
|
||
"onSuccess" : function() {
|
||
console.log("onSuccess");
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function() {
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.<br>
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.24.2</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="_global_.html#event:software_update_event_received">{Event} software_update_event_received</a><br>
|
||
<a href="hcap.system.html#.startManualUpdate">hcap.system.startManualUpdate()</a><br>
|
||
<a href="hcap.system.html#.getUpdateProgress">hcap.system.getUpdateProgress()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item2'
|
||
>
|
||
<div class="fixedFont heading" id=".endDestroy">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>endDestroy</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Informs TV of that the application finishes its cleanup job.<br>
|
||
TV waits for hcap.system.endDestroy up to 10 minutes after hcap.system.beginDestroy is called.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">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
|
||
);</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function (param) {
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.20.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="_global_.html#event:on_destroy">{Event} on_destroy</a><br>
|
||
<a href="hcap.system.html#.beginDestroy">hcap.system.beginDestroy()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item3'
|
||
>
|
||
<div class="fixedFont heading" id=".expireProxyServer">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>expireProxyServer</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Expires the current configuration of proxy server.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.expireProxyServer({
|
||
"onSuccess" : function() {
|
||
console.log("onSuccess");
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function()
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.21.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.getProxyServer">hcap.system.getProxyServer()</a><br>
|
||
<a href="hcap.system.html#.getProxyServer">hcap.system.setProxyServer()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item4'
|
||
>
|
||
<div class="fixedFont heading" id=".getAudioPtsOffset">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>getAudioPtsOffset</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Gets the current audio pts offset.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.getAudioPtsOffset({
|
||
"onSuccess" : function(p) {
|
||
console.log("onSuccess : audio pts offset = " + p.audioPtsOffset);
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function (param) {
|
||
// {Number} param.audioPtsOffset - audio pts offset.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.21.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.setAudioPtsOffset">hcap.system.setAudioPtsOffset()</a><br>
|
||
<a href="hcap.system.html#.getVideoPtsOffset">hcap.system.getVideoPtsOffset()</a><br>
|
||
<a href="hcap.system.html#.setVideoPtsOffset">hcap.system.setVideoPtsOffset()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item5'
|
||
>
|
||
<div class="fixedFont heading" id=".getBrowserDebugMode">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>getBrowserDebugMode</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Gets the current remote object inspector mode of the HCAP browser.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.getBrowserDebugMode({
|
||
"onSuccess" : function(p) {
|
||
console.log("onSuccess : debugMode = " + p.debugMode);
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
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.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.21.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.setBrowserDebugMode">hcap.system.setBrowserDebugMode()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item6'
|
||
>
|
||
<div class="fixedFont heading" id=".getCpuUsage">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>getCpuUsage</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Gets the percentage of the used CPU resource.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">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);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function (param) {
|
||
// {Number} param.percentage - percentage of used CPU resource.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.19.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.getMemoryUsage">hcap.system.getMemoryUsage()</a></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item7'
|
||
>
|
||
<div class="fixedFont heading" id=".getDefaultSoundOutput">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>getDefaultSoundOutput</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Gets the default sound output.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.getDefaultSoundOutput({
|
||
"onSuccess" : function(p) {
|
||
console.log("onSuccess : sound output = " + p.defaultSoundOutput);
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function (param) {
|
||
// {Number} param.defaultSoundOutput - default sound output. Please refer to <a href="hcap.system.SoundOutputType.html">hcap.system.SoundOutputType</a>.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.23.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.setDefaultSoundOutput">hcap.system.setDefaultSoundOutput()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item8'
|
||
>
|
||
<div class="fixedFont heading" id=".getFocused">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>getFocused</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Gets whether HCAP application gets focused or not.<br>
|
||
This is worked only when the property "block_hotkey" is "1".
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.getFocused({
|
||
"onSuccess" : function (param) {
|
||
console.log("onSuccess : focused = " + param.focused);
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function (param) {
|
||
// {Boolean} param.focused - true if the HCAP application gets focused, else false.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.19.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.property.html#.getProperty">hcap.property.getProperty()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item9'
|
||
>
|
||
<div class="fixedFont heading" id=".getLocale">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>getLocale</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Gets the locale specifier of the current locale.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">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);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
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.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.19.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="_global_.html#event:locale_changed">{Event} locale_changed</a><br>
|
||
<a href="hcap.system.html#.getLocaleList">hcap.system.getLocaleList()</a><br>
|
||
<a href="hcap.system.html#.requestLocaleChange">hcap.system.requestLocaleChange()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item10'
|
||
>
|
||
<div class="fixedFont heading" id=".getLocaleList">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>getLocaleList</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Gets the supported locale item list with an item (specifier, language name, country name).<br>
|
||
Locale specifier is composed of {language code}-{country code} and it is worked as the identifier when setting system locale.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">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);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
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" : "<22>븳援<EBB8B3><E68FB4>뼱", "country" : "<22>븳援<EBB8B3>" },
|
||
// ]
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.19.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="_global_.html#event:locale_changed">{Event} locale_changed</a><br>
|
||
<a href="hcap.system.html#.getLocaleList">hcap.system.getLocaleList()</a><br>
|
||
<a href="hcap.system.html#.requestLocaleChange">hcap.system.requestLocaleChange()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item11'
|
||
>
|
||
<div class="fixedFont heading" id=".getMemoryUsage">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>getMemoryUsage</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Gets the percentage of the used memory.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">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);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
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.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.19.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.getCpuUsage">hcap.system.getCpuUsage()</a></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item12'
|
||
>
|
||
<div class="fixedFont heading" id=".getNoSignalImage">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>getNoSignalImage</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Gets the current configuration of no signal image.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.getNoSignalImage({
|
||
"onSuccess" : function(p) {
|
||
console.log("onSuccess : noSignalImage = " + p.noSignalImage);
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function (param) {
|
||
// {Boolean} param.noSignalImage - true if no signal image is on. false if no signal image is off.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.21.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.setNoSignalImage">hcap.system.setNoSignalImage()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item13'
|
||
>
|
||
<div class="fixedFont heading" id=".getProcentricServer">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>getProcentricServer</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Gets the current configuration of Pro:Centric server.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">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);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
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
|
||
// }
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.19.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.setProcentricServer">hcap.system.setProcentricServer()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item14'
|
||
>
|
||
<div class="fixedFont heading" id=".getProxyServer">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>getProxyServer</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Gets the current configuration of proxy server.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">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);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function (param) {
|
||
// {String} param.ip - IPv4 or IPv6 address
|
||
// {Number} param.port - IP port number
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.21.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.setProxyServer">hcap.system.setProxyServer()</a><br>
|
||
<a href="hcap.system.html#.expireProxyServer">hcap.system.expireProxyServer()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item15'
|
||
>
|
||
<div class="fixedFont heading" id=".getScreenCaptureImage">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>getScreenCaptureImage</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Gets the screen capture image.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.getScreenCaptureImage({
|
||
"onSuccess" : function(s) {
|
||
console.log("onSuccess : uri = " + s.uri);
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function(param) {
|
||
// {String} param.uri - URI for the screen capture image.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.23.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.requestScreenCaptureImage">hcap.system.requestScreenCaptureImage()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item16'
|
||
>
|
||
<div class="fixedFont heading" id=".getScreenKeyboardLanguageList">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>getScreenKeyboardLanguageList</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Gets the list of supported screen keyboard languages.<br>
|
||
Screen keyboard language list is composed of language codes and delimiter comma(',').<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.getScreenKeyboardLanguageList({
|
||
"onSuccess" : function(s) {
|
||
console.log("onSuccess : list = " + s.list);
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function (param) {
|
||
// {String} param.list - screen keyboard language list string.
|
||
// which is composed of language codes separated by delimiter comma(',').
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.22.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.setScreenKeyboardLanguage">hcap.system.setScreenKeyboardLanguage()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item17'
|
||
>
|
||
<div class="fixedFont heading" id=".getSoundOutput">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>getSoundOutput</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Gets the current sound output.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.getSoundOutput({
|
||
"onSuccess" : function(p) {
|
||
console.log("onSuccess : sound output = " + p.soundOutput);
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function (param) {
|
||
// {Number} param.soundOutput - sound output. Please refer to <a href="hcap.system.SoundOutputType.html">hcap.system.SoundOutputType</a>.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.20.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.setSoundOutput">hcap.system.setSoundOutput()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item18'
|
||
>
|
||
<div class="fixedFont heading" id=".getUpdateProgress">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>getUpdateProgress</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
It informs you of the progress of the software update.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">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);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function() {
|
||
// {Number} param.progress - software update progress
|
||
// {Number} param.totalPackage - total package capacity
|
||
// {Number} param.installedPackage - installed package capacity
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.<br>
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.24.2</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="_global_.html#event:software_update_event_received">{Event} software_update_event_received</a><br>
|
||
<a href="hcap.system.html#.startManualUpdate">hcap.system.startManualUpdate()</a><br>
|
||
<a href="hcap.system.html#.cancelUpdate">hcap.system.cancelUpdate()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item19'
|
||
>
|
||
<div class="fixedFont heading" id=".getUsbPowerControl">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>getUsbPowerControl</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Gets the status of usb power control.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.getUsbPowerControl({
|
||
"portNumber" : 2,
|
||
"onSuccess" : function(s) {
|
||
console.log("onSuccess : status = " + s.status);
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Number} param.portNumber [Required] - port number to be get the status of usb power control.</li>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function (param) {
|
||
// {Boolean} param.status - the status of usb power control.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.23.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.setUsbPowerControl">hcap.system.setUsbPowerControl()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item20'
|
||
>
|
||
<div class="fixedFont heading" id=".getVideoPtsOffset">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>getVideoPtsOffset</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Gets the current video pts offset.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.getVideoPtsOffset({
|
||
"onSuccess" : function(p) {
|
||
console.log("onSuccess : video pts offset = " + p.videoPtsOffset);
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function (param) {
|
||
// {Number} param.videoPtsOffset - video pts offset.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.21.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.setVideoPtsOffset">hcap.system.setVideoPtsOffset()</a><br>
|
||
<a href="hcap.system.html#.getAudioPtsOffset">hcap.system.getAudioPtsOffset()</a><br>
|
||
<a href="hcap.system.html#.setAudioPtsOffset">hcap.system.setAudioPtsOffset()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item21'
|
||
>
|
||
<div class="fixedFont heading" id=".launchHcapHtmlApplication">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>launchHcapHtmlApplication</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Loads HCAP HTML application.<br>
|
||
When a HCAP HTML application has already been loaded, the HCAP HTML application is reloaded according to the "alternative_url" policy.<br>
|
||
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.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.launchHcapHtmlApplication({
|
||
"onSuccess" : function() {
|
||
console.log("onSuccess");
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function() {
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.19.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.property.html#.getProperty">hcap.property.getProperty()</a></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item22'
|
||
>
|
||
<div class="fixedFont heading" id=".requestCloning">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>requestCloning</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Requests XML cloning to TV.<br>
|
||
This acts exactly same as USB cloning.<br>
|
||
When the cloning is done, HCAP Application will get the notification <a href="_global_.html#event:cloning_done_received">{Event} cloning_done_received</a>.<br>
|
||
<strong>We strongly recommend reboot after xml cloning.</strong><br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.requestCloning({
|
||
"xml" : "<xml>....</xml>",
|
||
"onSuccess" : function() {
|
||
console.log("onSuccess");
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{String} param.xml - XML string for cloning.</li>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function()
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.19.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="_global_.html#event:cloning_done_received">{Event} cloning_done_received</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item23'
|
||
>
|
||
<div class="fixedFont heading" id=".requestFocus">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>requestFocus</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Requests to make HCAP application get focused.<br>
|
||
If this request is successful and the focus is changed from a Preloaded Application to HCAP Application,
|
||
HCAP Application will get the notification <a href="_global_.html#event:hcap_application_focus_changed">{Event} hcap_application_focus_changed</a><br><br>.
|
||
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".
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.requestFocus({
|
||
"onSuccess" : function() {
|
||
console.log("onSuccess");
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function() {
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.19.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.property.html#.getProperty">hcap.property.getProperty()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item24'
|
||
>
|
||
<div class="fixedFont heading" id=".requestLocaleChange">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>requestLocaleChange</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Requests the system locale change to TV.<br>
|
||
It will return soon after the request is done.<br>
|
||
If the request is successful, the menu language will be changed and the locale change result will be notified through <a href="_global_.html#event:locale_changed">{Event} locale_changed</a>.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.requestLocaleChange({
|
||
"specifier" : "ko-KR",
|
||
"onSuccess" : function() {
|
||
console.log("onSuccess");
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{String} param.specifier - locale specifier to set.</li>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function()
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.19.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="_global_.html#event:locale_changed">{Event} locale_changed</a><br>
|
||
<a href="hcap.system.html#.getLocaleList">hcap.system.getLocaleList()</a><br>
|
||
<a href="hcap.system.html#.getLocale">hcap.system.getLocale()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item25'
|
||
>
|
||
<div class="fixedFont heading" id=".requestScreenCaptureImage">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>requestScreenCaptureImage</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Requests screen capture.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.requestScreenCaptureImage({
|
||
"onSuccess" : function() {
|
||
console.log("onSuccess");
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function() {
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.23.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.getScreenCaptureImage">hcap.system.getScreenCaptureImage()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item26'
|
||
>
|
||
<div class="fixedFont heading" id=".setAudioPtsOffset">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>setAudioPtsOffset</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
sets the audio pts offset.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">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);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Number} param.audioPtsOffset [Required] - audio pts offset. The value must be multiples of 10 (-500 ~ 500).</li>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function (param) {
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.21.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.getAudioPtsOffset">hcap.system.getAudioPtsOffset()</a><br>
|
||
<a href="hcap.system.html#.getVideoPtsOffset">hcap.system.getVideoPtsOffset()</a><br>
|
||
<a href="hcap.system.html#.setVideoPtsOffset">hcap.system.setVideoPtsOffset()</a><br>
|
||
<a href="_global_.html#event:ui_value_changed">{Event} ui_value_changed</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item27'
|
||
>
|
||
<div class="fixedFont heading" id=".setBrowserDebugMode">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>setBrowserDebugMode</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Turns on or off the remote object inspector of the HCAP browser.<br>
|
||
Changed setting will take affect after a reboot.<br>
|
||
After a reboot, open the http://TV_IP:2345 on TV remote client (Chrome on PC).<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.setBrowserDebugMode({
|
||
"debugMode" : true,
|
||
"onSuccess" : function() {
|
||
console.log("onSuccess");
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Boolean} param.debugMode [Required] - true to turn on debug mode, else false.</li>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function()
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.21.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.getBrowserDebugMode">hcap.system.getBrowserDebugMode()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item28'
|
||
>
|
||
<div class="fixedFont heading" id=".setDefaultSoundOutput">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>setDefaultSoundOutput</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Sets the default sound output.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">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);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Number} param.defaultSoundOutput [Required] - default sound output. Please refer to <a href="hcap.system.SoundOutputType.html">hcap.system.SoundOutputType</a>.</li>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function (param) {
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.23.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.getDefaultSoundOutput">hcap.system.getDefaultSoundOutput()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item29'
|
||
>
|
||
<div class="fixedFont heading" id=".setNoSignalImage">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>setNoSignalImage</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Turns on or off no signal image.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.setNoSignalImage({
|
||
"noSignalImage" : true,
|
||
"onSuccess" : function() {
|
||
console.log("onSuccess");
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Boolean} param.noSignalImage [Required] - true to turn on no signal image, else false.</li>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function()
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.21.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.getNoSignalImage">hcap.system.getNoSignalImage()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item30'
|
||
>
|
||
<div class="fixedFont heading" id=".setProcentricServer">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>setProcentricServer</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Sets the configuration of Pro:Centric server.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">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);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{String} param.mode [Required] - Pro:Centric mode. ([US] "configuration_only"/"gem"/"flash"/"html", [EU] "off"/"configuration_only"/"gem"/"flash"/"html")</li>
|
||
<li>{String} param.media [Required] - media type ("rf"/"ip")</li>
|
||
<li>{Object} param.rfServer [Required] - data for param.media = "rf"<br>
|
||
{<br>
|
||
{String} type - RF data channel type ([US] "auto"/ "manual", [EU] "dvb-t"/"dvb-c")<br>
|
||
{Number} dataChannelNumber - [US] data channel number of RF server<br>
|
||
{Number} frequency - [EU] frequency of RF server (Hz, and MHz for satellite)<br>
|
||
}
|
||
</li>
|
||
<li>{Object} param.ipServer [Required] - data for param.media = "ip"<br>
|
||
{<br>
|
||
{String} type - [US/EU] IP address type ("ip" : IPv4 or IPv6 type / "domain_name" : domain name)<br>
|
||
{String} ip - [US/EU] IPv4 or IPv6 address taken affect only when type is "ip"<br>
|
||
{String} domainName - [US/EU] domain name taken affect only when type is "domain_name"<br>
|
||
{Number} port - IP port number<br>
|
||
}
|
||
</li>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function()
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.19.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.getProcentricServer">hcap.system.getProcentricServer()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item31'
|
||
>
|
||
<div class="fixedFont heading" id=".setProxyServer">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>setProxyServer</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Sets the configuration of proxy server.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.setProxyServer({
|
||
"ip" : "1.2.3.4",
|
||
"port" : 3876,
|
||
"onSuccess" : function() {
|
||
console.log("onSuccess");
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{String} param.ip [Required] - ip - IPv4 or IPv6 address</li>
|
||
<li>{Number} param.port [Required] - port - IP port number</li>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function()
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.21.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.getProxyServer">hcap.system.getProxyServer()</a><br>
|
||
<a href="hcap.system.html#.expireProxyServer">hcap.system.expireProxyServer()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item32'
|
||
>
|
||
<div class="fixedFont heading" id=".setScreenKeyboardLanguage">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>setScreenKeyboardLanguage</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Sets the screen keyboard language.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.setScreenKeyboardLanguage({
|
||
"keyboardLanguage" : "en",
|
||
"onSuccess" : function() {
|
||
console.log("onSuccess");
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{String} param.keyboardLanguage [Required] - screen keyboard language to be set.</li>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function() {
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.<br>
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.22.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.getScreenKeyboardLanguageList">hcap.system.getScreenKeyboardLanguageList()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item33'
|
||
>
|
||
<div class="fixedFont heading" id=".setSoundOutput">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>setSoundOutput</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Sets the sound output.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">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);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Number} param.soundOutput [Required] - sound output. Please refer to <a href="hcap.system.SoundOutputType.html">hcap.system.SoundOutputType</a>.</li>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function (param) {
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.20.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.getSoundOutput">hcap.system.getSoundOutput()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item34'
|
||
>
|
||
<div class="fixedFont heading" id=".setUsbPowerControl">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>setUsbPowerControl</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
Sets the status of usb power control.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.setUsbPowerControl({
|
||
"portNumber" : 2,
|
||
"status" : true,
|
||
"onSuccess" : function() {
|
||
console.log("onSuccess");
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Number} param.portNumber [Required] - port number to be set the status of usb power control.</li>
|
||
<li>{Boolean} param.status [Required] - the status of usb power control.</li>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function() {
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.<br>
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.23.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.getUsbPowerControl">hcap.system.getUsbPowerControl()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item35'
|
||
>
|
||
<div class="fixedFont heading" id=".setVideoPtsOffset">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>setVideoPtsOffset</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
sets the video pts offset.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">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);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Number} param.videoPtsOffset [Required] - video pts offset. The value must be multiples of 10 (-500 ~ 500).</li>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function (param) {
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.21.0</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="hcap.system.html#.getVideoPtsOffset">hcap.system.getVideoPtsOffset()</a><br>
|
||
<a href="hcap.system.html#.getAudioPtsOffset">hcap.system.getAudioPtsOffset()</a><br>
|
||
<a href="hcap.system.html#.setAudioPtsOffset">hcap.system.setAudioPtsOffset()</a><br>
|
||
<a href="_global_.html#event:ui_value_changed">{Event} ui_value_changed</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item36'
|
||
>
|
||
<div class="fixedFont heading" id=".showToastMessage">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>showToastMessage</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
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.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.showToastMessage({
|
||
"message" : "hello world",
|
||
"onSuccess" : function() {
|
||
console.log("onSuccess");
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{String} param.message [Required] - the message body</li>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function() {
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.<br>
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.23.2</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</dl>
|
||
|
||
<div class="hr"></div>
|
||
</li>
|
||
|
||
<li
|
||
class='item37'
|
||
>
|
||
<div class="fixedFont heading" id=".startManualUpdate">
|
||
<span class='lighter'>
|
||
<static>
|
||
</span>
|
||
|
||
|
||
|
||
<span class="light">hcap.system.</span><b>startManualUpdate</b>(param)
|
||
</div>
|
||
|
||
<div class="description">
|
||
manually start the software update.<br>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<pre class="code prettyprint">hcap.system.startManualUpdate({
|
||
"onSuccess" : function() {
|
||
console.log("onSuccess");
|
||
},
|
||
"onFailure" : function(f) {
|
||
console.log("onFailure : errorMessage = " + f.errorMessage);
|
||
}
|
||
});</pre>
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Parameters:</dt>
|
||
|
||
<dt>
|
||
<span class="light fixedFont">{Object}</span> <b>param</b>
|
||
|
||
</dt>
|
||
<dd><ul>
|
||
<li>{Function} param.onSuccess [Optional] - success callback function.
|
||
<pre class="code prettyprint">
|
||
param.onSuccess = function() {
|
||
// No Parameter.
|
||
}</pre>
|
||
</li>
|
||
<li>{Function} param.onFailure [Optional] - failure callback function.<br>
|
||
<pre class="code prettyprint">
|
||
param.onFailure = function (param) {
|
||
// {String} param.errorMessage - in case of failure, this message provides the details.
|
||
}</pre>
|
||
</li>
|
||
</ul></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
|
||
<dl class="detailList nomargin">
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">Since:</dt>
|
||
<dd>1.24.2</dd>
|
||
</dl>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<dl class="detailList params">
|
||
<dt class="heading">See:</dt>
|
||
|
||
<dd><a href="_global_.html#event:software_update_event_received">{Event} software_update_event_received</a><br>
|
||
<a href="hcap.system.html#.cancelUpdate">hcap.system.cancelUpdate()</a><br>
|
||
<a href="hcap.system.html#.getUpdateProgress">hcap.system.getUpdateProgress()</a><br></dd>
|
||
|
||
</dl>
|
||
|
||
|
||
</dl>
|
||
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
|
||
|
||
<!--
|
||
#### EVENT DETAILS
|
||
-->
|
||
|
||
</article>
|
||
</div>
|
||
</div>
|
||
|
||
<script type="text/javascript">
|
||
wbos.CssTools.MediaQueryFallBack.LoadCss('../css/screen.css', '../css/handheld.css', 660)
|
||
codeview.classFilter.Init()
|
||
</script>
|
||
<script src="../javascript/highlighter/prettify.js"></script>
|
||
<script>prettyPrint();</script>
|
||
</body>
|
||
</html>
|
||
|