Files
sysadmin ff2a3c305b issue #1
Add 1st PTC Hotel APP codes
2022-04-21 10:46:16 +09:00

1361 lines
46 KiB
HTML
Executable File

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="generator" content="JsDoc Toolkit" />
<title>hcap.time | 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">&middot;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.time</span>
</h1>
<div class="intro">
<p class="description summary">
hcap.time
</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.time.">
<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">&nbsp;</td>
<td class="nameDescription" >
<div class="fixedFont">
<b><a href="../symbols/hcap.time.html#constructor">hcap.time</a></b>
</div>
<div class="description"></div>
</td>
</tr>
</tbody>
</table>
</div>
</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.time.">
<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">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.time.<b><a href="../symbols/hcap.time.html#.getAlarmInformation">getAlarmInformation</a></b>(param)
</div>
<div class="description">Gets the alarm time, alarm channel and alarm volume level of TV.</div>
</td>
</tr>
<tr
class='item1'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.time.<b><a href="../symbols/hcap.time.html#.getCpuTime">getCpuTime</a></b>(param)
</div>
<div class="description">Gets the CPU time.</div>
</td>
</tr>
<tr
class='item2'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.time.<b><a href="../symbols/hcap.time.html#.getLocalTime">getLocalTime</a></b>(param)
</div>
<div class="description">Gets the TV time.</div>
</td>
</tr>
<tr
class='item3'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.time.<b><a href="../symbols/hcap.time.html#.getPowerOffTimer">getPowerOffTimer</a></b>(param)
</div>
<div class="description">Gets the sleep time to power off.</div>
</td>
</tr>
<tr
class='item4'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.time.<b><a href="../symbols/hcap.time.html#.getPowerOnTime">getPowerOnTime</a></b>(param)
</div>
<div class="description">Gets the wake-up time of TV.</div>
</td>
</tr>
<tr
class='item5'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.time.<b><a href="../symbols/hcap.time.html#.setAlarmInformation">setAlarmInformation</a></b>(param)
</div>
<div class="description">Sets the alarm time, alarm channel and alarm volume level of TV.</div>
</td>
</tr>
<tr
class='item6'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.time.<b><a href="../symbols/hcap.time.html#.setLocalTime">setLocalTime</a></b>(param)
</div>
<div class="description">Sets the TV time.</div>
</td>
</tr>
<tr
class='item7'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.time.<b><a href="../symbols/hcap.time.html#.setPowerOffTimer">setPowerOffTimer</a></b>(param)
</div>
<div class="description">Sets the power-off timer of TV.</div>
</td>
</tr>
<tr
class='item8'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.time.<b><a href="../symbols/hcap.time.html#.setPowerOnTime">setPowerOnTime</a></b>(param)
</div>
<div class="description">Sets the wake-up time of TV.</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.time</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=".getAlarmInformation">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.time.</span><b>getAlarmInformation</b>(param)
</div>
<div class="description">
Gets the alarm time, alarm channel and alarm volume level of TV. These settings are applied only once at the alarm time and will be disabled.<br>
At the alarm time, if TV is off, TV will be turned on automatically with the alarm volume level and tune to the alarm channel.
And if TV is on at the alarm time, nothing will happen.
If the alarm time is disabled, param.hour = -1 and param.minute = -1 will be returned.
And if the alarm channel is disabled, param.channelType = <a href="../symbols/hcap.channel.ChannelType.html#constructor">hcap.channel.ChannelType.UNKNOWN</a> will be returned.
If the alarm volume is disabled, param.volumeLevel = -1 will be returned.
</div>
<pre class="code prettyprint">hcap.time.getAlarmInformation({
"onSuccess" : function(s) {
console.log("onSuccess :" +
"\n alarm time = " + s.hour = " : " + s.minute +
"\n alarm volume level = " + s.volumeLevel +
"\n ========= alarm channel information =========" +
"\n channel type : " + s.channelType +
"\n logical number : " + s.logicalNumber +
"\n frequency : " + s.frequency +
"\n program number : " + s.programNumber +
"\n major number : " + s.majorNumber +
"\n minor number : " + s.minorNumber +
"\n satellite ID : " + s.satelliteId +
"\n polarization : " + s.polarization +
"\n rf broadcast type : " + s.rfBroadcastType +
"\n ip : " + s.ip +
"\n port : " + s.port +
"\n ip broadcast type : " + s.ipBroadcastType +
"\n symbol rate : " + s.symbolRate +
"\n pcr pid : " + s.pcrPid +
"\n video pid : " + s.videoPid +
"\n video stream type : " + s.videoStreamType +
"\n audio pid : " + s.audioPid +
"\n audio stream type : " + s.audioStreamType +
"\n signal strength : " + s.signalStrength +
"\n source address : " + s.sourceAddress);
},
"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.hour - hour of alarm time (-1 ~ 23), -1 if the setting is disabled.
// {Number} param.minute - minute of alarm time (-1 ~ 59), -1 if the setting is disabled.
// {Number} param.volumeLevel - alarm volume level (-1 ~ 100) which is applied only once for the first alarm booting. -1 if setting is disabled.
// For the alarm channel, see the <a href="../symbols/hcap.channel.html#.CHANNEL_PROPERTY">{ Channel Properties }</a> in <a href="hcap.channel.html#.requestChangeCurrentChannel">hcap.channel.requestChangeCurrentChannel()</a>. The alarm channel is applied only once for the first alarm booting.
}</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.5.0</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.time.html#.setAlarmInformation">hcap.time.setAlarmInformation()</a></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item1'
>
<div class="fixedFont heading" id=".getCpuTime">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.time.</span><b>getCpuTime</b>(param)
</div>
<div class="description">
Gets the CPU time.
It means that the monotonic time after TV is turned on.<br>
</div>
<pre class="code prettyprint">hcap.time.getCpuTime({
"onSuccess" : function (param) {
console.log("onSuccess : cpu time(milliseconds) = " + param.cpuTime);
},
"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.cpuTime - cpu time(milliseconds) of the platform.
}</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>
<div class="hr"></div>
</li>
<li
class='item2'
>
<div class="fixedFont heading" id=".getLocalTime">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.time.</span><b>getLocalTime</b>(param)
</div>
<div class="description">
Gets the TV time.<br>
TV time is the local time which is the time after applying GMT offset for time zone and daylight saving time.<br>
In this error case, failure callback function will be invoked.
</div>
<pre class="code prettyprint">hcap.time.getLocalTime({
"onSuccess" : function(s) {
console.log("onSuccess : \n" +
"TV localtime = " + s.year + "-" + s.month + "-" + s.day + " " + s.hour + " : " + s.minute + " : " + s.second + "\n" +
"GMT offset = " + s.gmtOffsetInMinute + "\n" +
"daylight saving = " + s.isDaylightSaving);
},
"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.year - year (2000 ~ 2029).
// {Number} param.month - month (1 ~ 12).
// {Number} param.day - day (1 ~ 31).
// {Number} param.hour - hour (0 ~ 23).
// {Number} param.minute - minute (0 ~ 59).
// {Number} param.second - second (0 ~ 59).
// {Number} param.gmtOffsetInMinute - GMT offset in minute for time zone (-660 ~ 720).
// {Number} param.isDaylightSaving - false : not applying daylight saving time to local time, true : applying daylight saving time to local time.
}</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.6.0</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.time.html#.setLocalTime">hcap.time.setLocalTime()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item3'
>
<div class="fixedFont heading" id=".getPowerOffTimer">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.time.</span><b>getPowerOffTimer</b>(param)
</div>
<div class="description">
Gets the sleep time to power off.
</div>
<pre class="code prettyprint">hcap.time.getPowerOffTimer({
"onSuccess" : function(s) {
console.log("onSuccess : remaining time (min) = " + s.minute);
},
"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.minute - remaining time(minutes: 0 ~ 240, -1:off) of the sleep timer.
}</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.3.1</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.time.html#.setPowerOffTimer">hcap.time.setPowerOffTimer()</a></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item4'
>
<div class="fixedFont heading" id=".getPowerOnTime">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.time.</span><b>getPowerOnTime</b>(param)
</div>
<div class="description">
Gets the wake-up time of TV. This setting is applied only once at the wake-up time and will be disabled.<br>
If the setting is disabled, returns -1 for hour and -1 for minute.
</div>
<pre class="code prettyprint">hcap.time.getPowerOnTime({
"onSuccess" : function(s) {
console.log("onSuccess : wake-up time = " + s.hour + " : " + s.minute);
},
"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.hour - hour of wake-up time (0~23), -1 if the setting is disabled.
// {Number} param.minute - minute of wake-up time (0~59), -1 if the setting is disabled.
}</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.3.1</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.time.html#.setPowerOnTime">hcap.time.setPowerOnTime()</a></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item5'
>
<div class="fixedFont heading" id=".setAlarmInformation">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.time.</span><b>setAlarmInformation</b>(param)
</div>
<div class="description">
Sets the alarm time, alarm channel and alarm volume level of TV. These settings are applied only once at the alarm time and will be disabled.<br>
At the alarm time, if TV is off, TV will be turned on automatically with the alarm volume level and tune to the alarm channel.
And if TV is on at the alarm time, nothing will happen.
To disable the alarm time, param.hour = -1 and param.minute = -1 should be set.
When the alarm time is disabled, the alarm channel and the alarm volume level will be disabled together.
</div>
<pre class="code prettyprint">hcap.time.setAlarmInformation({
"hour" : 9,
"minute" : 30,
"volumeLevel" : 30,
"channelType" : hcap.channel.ChannelType.RF,
"frequency" : 63000000,
"programNumber" : 1,
"rfBroadcastType" : hcap.channel.RfBroadcastType.TERRESTRIAL,
"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.hour [Required] - hour of alarm time. The range is -1 ~ 23.</li>
<li>{Number} param.minute [Required] - minute of alarm time. The range is -1 ~ 59.</li>
<li>{Number} param.volumeLevel [Required] - alarm volume level (-1 ~ 100). -1 to disable the alarm volume.</li>
<li><a href="../symbols/hcap.channel.html#.CHANNEL_PROPERTY">{ Channel Properties } [Required] - Alarm Channel Information.</a></li>
<br>The alarm channel is taken affect prior to the start channel. If you want to disable the alarm channel, set param.channelType to <a href="../symbols/hcap.channel.ChannelType.html#constructor">hcap.channel.ChannelType.UNKNOWN</a>.
</li>
<li>{Function} param.onSuccess [Optional] - success callback function.<br>
Setting to the same hour/minute/alarm channel/alarm volume level as before will invoke this 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.5.0</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.time.html#.getAlarmInformation">hcap.time.getAlarmInformation()</a></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item6'
>
<div class="fixedFont heading" id=".setLocalTime">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.time.</span><b>setLocalTime</b>(param)
</div>
<div class="description">
Sets the TV time.<br>
Input time is the local time which is the time after applying GMT offset for time zone and daylight saving time.<br>
GMT offset for time zone and daylight saving time are required to set the TV localtime.<br>
Current GMT offset and daylight saving time can be got from <a href="hcap.time.html#.getLocalTime">hcap.time.getLocalTime()</a>.
GMT offset must be standard GMT offset of the city.<br>
Some of the standard GMT offset values and illegal GMT offset like -110 could not be set to TV.<br>
In this error case, failure callback function will be invoked.
</div>
<pre class="code prettyprint">hcap.time.setLocalTime({
"year" : 2010,
"month" : 8,
"day" : 31,
"hour" : 1,
"minute" : 0,
"second" : 0,
"gmtOffsetInMinute" : 180,
"isDaylightSaving" : false,
"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.year [REQUIRED] - year (2000 ~ 2029).</li>
<li>{Number} param.month [REQUIRED] - month (1 ~ 12).</li>
<li>{Number} param.day [REQUIRED] - day (1 ~ 31).</li>
<li>{Number} param.hour [REQUIRED] - hour (0 ~ 23).</li>
<li>{Number} param.minute [REQUIRED] - minute (0 ~ 59).</li>
<li>{Number} param.second [REQUIRED] - second (0 ~ 59).</li>
<li>{Number} param.gmtOffsetInMinute [REQUIRED] - GMT offset in minute for time zone (-660 ~ 720).</li>
<li>{Boolean} param.isDaylightSaving [REQUIRED] - false : not applying daylight saving time to local time, true : applying daylight saving time to local time.</li>
<li>{Function} param.onSuccess [Optional] - success callback function.<br>
Setting to the same year/month/day/hour/minute/second/gmt_offset_in_minute/daylight_saving as before will invoke this 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.3.1</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.time.html#.getLocalTime">hcap.time.getLocalTime()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item7'
>
<div class="fixedFont heading" id=".setPowerOffTimer">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.time.</span><b>setPowerOffTimer</b>(param)
</div>
<div class="description">
Sets the power-off timer of TV.
</div>
<pre class="code prettyprint">hcap.time.setPowerOffTimer({
"minute" : 60,
"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.minute [Required] - preset time(in minutes) of power-off timer. The range is 0~240 minutes(4 hours) or -1(off).</li>
<li>{Function} param.onSuccess [Optional] - success callback function.<br>
Setting to the same minutes of sleep timer as before will invoke this 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.3.1</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.time.html#.getPowerOffTimer">hcap.time.getPowerOffTimer()</a></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item8'
>
<div class="fixedFont heading" id=".setPowerOnTime">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.time.</span><b>setPowerOnTime</b>(param)
</div>
<div class="description">
Sets the wake-up time of TV. This setting is applied only once at the wake-up time and will be disabled.<br>
Set parm.hour -1 and param.minute -1 to disable the wake-up time.
</div>
<pre class="code prettyprint">hcap.time.setPowerOnTime({
"hour" : 9,
"minute" : 30,
"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.hour [Required] - hour of wake-up time. The range is 0~23 or -1 if the setting is disabled.</li>
<li>{Number} param.minute [Required] - minute of wake-up time. The range is 0~59 or -1 if the setting is disabled.</li>
<li>{Function} param.onSuccess [Optional] - success callback function.<br>
Setting to the same hour/minute as before will invoke this 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.3.1</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.time.html#.getPowerOnTime">hcap.time.getPowerOnTime()</a></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>