sysadmin/ct-dtv-hx0100-002kwos
1
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases Wiki Activity
Files
d7ef293d55bcd0c19f5e06197448817f69d1b8b5
ct-dtv-hx0100-002kwos/procentric/application/referece/hcap_js_extension-1.24.6.5901/doc/symbols/hcap.channel.html
sysadmin ff2a3c305b issue #1 
Add 1st PTC Hotel APP codes
2022-04-21 10:46:16 +09:00

2953 lines
109 KiB
HTML
Executable File
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="generator" content="JsDoc Toolkit" />
<title>hcap.channel | 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.channel</span>
</h1>
<div class="intro">
<p class="description summary">
hcap.channel
</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.channel.">
<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.channel.html#constructor">hcap.channel</a></b>
</div>
<div class="description"></div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
<section>
<nav>
<div class="props">
<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class hcap.channel.">
<caption class="sectionTitle">Field Summary</caption>
<thead>
<tr>
<th scope="col">Field Attributes</th>
<th scope="col">Field Name and Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="attributes">&lt;static&gt; &lt;constant&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">
hcap.channel.<b><a href="../symbols/hcap.channel.html#.NO_STREAM_PID">NO_STREAM_PID</a></b>
</div>
<div class="description">No stream PID.</div>
</td>
</tr>
</tbody>
</table>
</div>
</nav>
</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.channel.">
<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.channel.<b><a href="../symbols/hcap.channel.html#.getChannelMap">getChannelMap</a></b>(param)
</div>
<div class="description">Gets information of the channel
which is registered in the shortcut.</div>
</td>
</tr>
<tr
class='item1'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.channel.<b><a href="../symbols/hcap.channel.html#.getChannelSignalStatus">getChannelSignalStatus</a></b>(param)
</div>
<div class="description">Gets the channel signal status.</div>
</td>
</tr>
<tr
class='item2'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.channel.<b><a href="../symbols/hcap.channel.html#.getCurrentChannel">getCurrentChannel</a></b>(param)
</div>
<div class="description">Gets the current channel information.</div>
</td>
</tr>
<tr
class='item3'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.channel.<b><a href="../symbols/hcap.channel.html#.getCurrentChannelAudioLanguageIndex">getCurrentChannelAudioLanguageIndex</a></b>(param)
</div>
<div class="description">Gets the audio language index of the current channel.</div>
</td>
</tr>
<tr
class='item4'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.channel.<b><a href="../symbols/hcap.channel.html#.getCurrentChannelAudioLanguageList">getCurrentChannelAudioLanguageList</a></b>(param)
</div>
<div class="description">Gets the list of supported audio languages in the current channel.</div>
</td>
</tr>
<tr
class='item5'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.channel.<b><a href="../symbols/hcap.channel.html#.getCurrentChannelSubtitleIndex">getCurrentChannelSubtitleIndex</a></b>(param)
</div>
<div class="description">Gets the subtitle index of the current channel.</div>
</td>
</tr>
<tr
class='item6'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.channel.<b><a href="../symbols/hcap.channel.html#.getCurrentChannelSubtitleList">getCurrentChannelSubtitleList</a></b>(param)
</div>
<div class="description">Gets supported subtitle list of the current channel.</div>
</td>
</tr>
<tr
class='item7'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.channel.<b><a href="../symbols/hcap.channel.html#.getDataChannel">getDataChannel</a></b>(param)
</div>
<div class="description">Gets information about the Pro:Centric data channel(RF Channel or IP Channel),
which is the channel used to download applications.</div>
</td>
</tr>
<tr
class='item8'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.channel.<b><a href="../symbols/hcap.channel.html#.getProgramInfo">getProgramInfo</a></b>(param)
</div>
<div class="description">Gets the information about the current program and the next program in the current channel.</div>
</td>
</tr>
<tr
class='item9'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.channel.<b><a href="../symbols/hcap.channel.html#.getReadyInbandDataService">getReadyInbandDataService</a></b>(param)
</div>
<div class="description">Get the available inband data service in the current channel.</div>
</td>
</tr>
<tr
class='item10'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.channel.<b><a href="../symbols/hcap.channel.html#.getStartChannel">getStartChannel</a></b>(param)
</div>
<div class="description">Gets the start channel information which is the channel displayed
at first when TV is turned on.</div>
</td>
</tr>
<tr
class='item11'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.channel.<b><a href="../symbols/hcap.channel.html#.launchInbandDataService">launchInbandDataService</a></b>(param)
</div>
<div class="description">Launch the application of the inband data service type in the current channel.</div>
</td>
</tr>
<tr
class='item12'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.channel.<b><a href="../symbols/hcap.channel.html#.replayCurrentChannel">replayCurrentChannel</a></b>(param)
</div>
<div class="description">Replays the current stopped channel.</div>
</td>
</tr>
<tr
class='item13'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.channel.<b><a href="../symbols/hcap.channel.html#.requestChangeCurrentChannel">requestChangeCurrentChannel</a></b>(param)
</div>
<div class="description">Requests to change the current channel.</div>
</td>
</tr>
<tr
class='item14'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.channel.<b><a href="../symbols/hcap.channel.html#.setCurrentChannelAudioLanguageIndex">setCurrentChannelAudioLanguageIndex</a></b>(param)
</div>
<div class="description">Sets the audio language of the current channel.</div>
</td>
</tr>
<tr
class='item15'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.channel.<b><a href="../symbols/hcap.channel.html#.setCurrentChannelSubtitleIndex">setCurrentChannelSubtitleIndex</a></b>(param)
</div>
<div class="description">Sets the subtitle index of the current channel.</div>
</td>
</tr>
<tr
class='item16'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.channel.<b><a href="../symbols/hcap.channel.html#.setStartChannel">setStartChannel</a></b>(param)
</div>
<div class="description">Sets the start channel which is displayed at first when TV is turned on.</div>
</td>
</tr>
<tr
class='item17'
>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">hcap.channel.<b><a href="../symbols/hcap.channel.html#.stopCurrentChannel">stopCurrentChannel</a></b>(param)
</div>
<div class="description">Stops AV play of the current channel.</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.channel</b>
</div>
<div class="description">
</div>
</div>
</div>
</section>
<!--
#### FIELD DETAILS
-->
<section>
<div class="details props">
<div class="innerProps">
<h2 class="sectionTitle">
Field Detail
</h2>
<div class="fixedFont heading" id=".NO_STREAM_PID">
<span class='lighter'>
&lt;static&gt; &lt;constant&gt;
</span>
<span class="light">hcap.channel.</span><b>NO_STREAM_PID</b>
</div>
<div class="description">
No stream PID.
</div>
<dl class="detailList nomargin">
<dl class="detailList params">
<dt class="heading">Since:</dt>
<dd>1.3.1</dd>
</dl>
</dl>
</div>
</div>
</section>
<!--
#### 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=".getChannelMap">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>getChannelMap</b>(param)
</div>
<div class="description">
Gets information of the channel
which is registered in the shortcut.
</div>
<pre class="code prettyprint">hcap.channel.getChannelMap({
"onSuccess" : function(s) {
console.log("onSuccess : list length = " + s.list.length);
for (var i = 0; i < s.list.length; i++) {
console.log(
"[" + i + "].img_url2 = " + s.list[i].img_url2 +
"[" + i + "].img_url = " + s.list[i].img_url +
"[" + i + "].short_cut = " + s.list[i].short_cut +
"[" + i + "].channel_type = " + s.list[i].channel_type +
"[" + i + "].channel_mode_id = " + s.list[i].channel_mode_id +
"[" + i + "].channel_number = " + s.list[i].channel_number +
"[" + i + "].channel_name = " + s.list[i].channel_name
);
}
},
"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 - list for the channel information registered in the shortcut.
// {String} param.list[].img_url2 - logo image url2 of the channel
// {String} param.list[].img_url - logo image url of the channel
// {String} param.list[].short_cut - shortcut number (1~12)
// {String} param.list[].channel_type - name of the channel type ex) atellite BS
// {String} param.list[].channel_mode_id - channel mode id which is number 0~6
// {String} param.list[].channel_number - number of the channel ex)101
// {String} param.list[].channel_name - channel type and number ex) BS 101
}</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.2</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.channel.html#.requestChangeCurrentChannel">hcap.channel.requestChangeCurrentChannel()</a><br>
<a href="hcap.channel.html#.getCurrentChannel">hcap.channel.getCurrentChannel()</a><br>
<a href="hcap.channel.html#.replayCurrentChannel">hcap.channel.replayCurrentChannel()</a><br>
<a href="hcap.channel.html#.stopCurrentChannel">hcap.channel.stopCurrentChannel()</a><br>
<a href="hcap.channel.html#.getDataChannel">hcap.channel.getDataChannel()</a><br>
<a href="hcap.channel.html#.getChannelMap">hcap.channel.getChannelMap()</a><br>
<a href="hcap.channel.html#.getStartChannel">hcap.channel.getStartChannel()</a><br>
<a href="hcap.channel.html#.setStartChannel">hcap.channel.setStartChannel()</a><br>
<a href="_global_.html#event:channel_changed">{Event} channel_changed</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item1'
>
<div class="fixedFont heading" id=".getChannelSignalStatus">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>getChannelSignalStatus</b>(param)
</div>
<div class="description">
Gets the channel signal status.
</div>
<pre class="code prettyprint">hcap.channel.getChannelSignalStatus({
"onSuccess" : function(s) {
console.log("onSuccess :" +
"\n snr value : " + s.snrValue +
"\n frequency : " + s.frequency +
"\n signal level : " + s.signalLevel +
"\n modulation mode : " + s.modulationMode +
"\n lock status : " + s.lockStatus);
},
"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.snrValue - snr value(dB).
// {Number} param.frequency - current frequency(KHz).
// {Number} param.signalLevel - signal level(%).
// {String} param.modulationMode - modulation mode.
// {Boolean} param.lockStatus - lock status.
}</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.2</dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item2'
>
<div class="fixedFont heading" id=".getCurrentChannel">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>getCurrentChannel</b>(param)
</div>
<div class="description">
Gets the current channel information.<br>
For detailed information, such as, example and related information,
please refer to <a href="hcap.channel.html#.requestChangeCurrentChannel">hcap.channel.requestChangeCurrentChannel()</a><br>
</div>
<pre class="code prettyprint">hcap.channel.getCurrentChannel({
"onSuccess" : function(s) {
console.log("onSuccess :" +
"\n channel status : " + s.channelStatus +
"\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} [since 1.12.0] param.channelStatus - current channel status in <a href="hcap.channel.ChannelStatus.html">hcap.channel.ChannelStatus</a>.
// see the <a href="../symbols/hcap.channel.html#.CHANNEL_PROPERTY">{ Channel Properties }</a> in <a href="hcap.channel.html#.requestChangeCurrentChannel">hcap.channel.requestChangeCurrentChannel()</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.3.1</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.channel.html#.requestChangeCurrentChannel">hcap.channel.requestChangeCurrentChannel()</a><br>
<a href="hcap.channel.html#.getCurrentChannel">hcap.channel.getCurrentChannel()</a><br>
<a href="hcap.channel.html#.replayCurrentChannel">hcap.channel.replayCurrentChannel()</a><br>
<a href="hcap.channel.html#.stopCurrentChannel">hcap.channel.stopCurrentChannel()</a><br>
<a href="hcap.channel.html#.getDataChannel">hcap.channel.getDataChannel()</a><br>
<a href="hcap.channel.html#.getChannelMap">hcap.channel.getChannelMap()</a><br>
<a href="hcap.channel.html#.getStartChannel">hcap.channel.getStartChannel()</a><br>
<a href="hcap.channel.html#.setStartChannel">hcap.channel.setStartChannel()</a><br>
<a href="_global_.html#event:channel_changed">{Event} channel_changed</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item3'
>
<div class="fixedFont heading" id=".getCurrentChannelAudioLanguageIndex">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>getCurrentChannelAudioLanguageIndex</b>(param)
</div>
<div class="description">
Gets the audio language index of the current channel.<br>
If application wants to map the index to audio language code, then it can get the audio language list of the current channel by
<a href="hcap.channel.html#.getCurrentChannelAudioLanguageList">hcap.channel.getCurrentChannelAudioLanguageList()</a>.
<div align=center>
<table class="hcap_spec" width=400>
<thead>
<tr><th>Item</th><th>Value</th></tr>
</thead>
<tbody>
<tr class="odd"><th>audio language list</th><td>en,ko,fr,en,xx</td></tr>
<tr><th>index</th><td>0, 1, 2, 3, 4</td></tr>
</tbody>
<tfoot>
<tr><th colspan="2">Audio Language List & Index Example</th></tr>
</tfoot>
</table>
</div>
</div>
<pre class="code prettyprint">hcap.channel.getCurrentChannelAudioLanguageIndex({
"onSuccess" : function(s) {
console.log("onSuccess : index = " + s.index);
},
"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.index - audio language index of the current channel.
}</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.channel.html#.getCurrentChannelAudioLanguageList">hcap.channel.getCurrentChannelAudioLanguageList()</a><br>
<a href="hcap.channel.html#.setCurrentChannelAudioLanguageIndex">hcap.channel.setCurrentChannelAudioLanguageIndex()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item4'
>
<div class="fixedFont heading" id=".getCurrentChannelAudioLanguageList">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>getCurrentChannelAudioLanguageList</b>(param)
</div>
<div class="description">
Gets the list of supported audio languages in the current channel.<br>
Audio language list is composed of language codes and delimiter comma(',').<br>
Application can get/set audio language of the current channel by index of the audio language list.<br><br>
If there is no audio language list of the current channel, only "xx" is returned as the audio language list.<br>
And "xx" could be returned as an audio language if the audio language is not mapped to an audio language code.<br>
Since version 1.24.2, audio languages with "_AD" appended to the original value(ex: pt_AD) are provided for the visually impaired. [EU Only]<br>
<div align=center>
<table class="hcap_spec" width=400>
<thead>
<tr><th>Item</th><th>Value</th></tr>
</thead>
<tbody>
<tr class="odd"><th>audio language list</th><td>en,ko,fr,en,xx</td></tr>
<tr><th>index</th><td>0, 1, 2, 3, 4</td></tr>
</tbody>
<tfoot>
<tr><th colspan="2">Audio Language List & Index Example</th></tr>
</tfoot>
</table>
</div>
If the application wants to set the audio language to French ('fr'), use the index '2'.<br>
</div>
<pre class="code prettyprint">hcap.channel.getCurrentChannelAudioLanguageList({
"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 - audio 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.3.1</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.channel.html#.getCurrentChannelAudioLanguageIndex">hcap.channel.getCurrentChannelAudioLanguageIndex()</a><br>
<a href="hcap.channel.html#.setCurrentChannelAudioLanguageIndex">hcap.channel.setCurrentChannelAudioLanguageIndex()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item5'
>
<div class="fixedFont heading" id=".getCurrentChannelSubtitleIndex">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>getCurrentChannelSubtitleIndex</b>(param)
</div>
<div class="description">
Gets the subtitle index of the current channel.
If application wants to map the index to subtitle setting value, get subtitle list of the current channel by
<a href="hcap.channel.html#.getCurrentChannelSubtitleList">hcap.channel.getCurrentChannelSubtitleList()</a>.
<div align=center>
<table class="hcap_spec" width=400>
<thead>
<tr><th>Item</th><th>Value</th></tr>
</thead>
<tbody>
<tr class="odd"><th>Subtitle List</th><td>off,en,ko,fr,en,xx,eng</td></tr>
<tr><th>index</th><td>0, 1, 2, 3, 4, 5, 6</td></tr>
</tbody>
<tfoot>
<tr><th colspan="2">Subtitle List & Index Example</td></tr>
</tfoot>
</table>
</div>
</div>
<pre class="code prettyprint">hcap.channel.getCurrentChannelSubtitleIndex({
"onSuccess" : function(s) {
console.log("onSuccess : index = " + s.index);
},
"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.index - subtitle setting index of the current channel.
}</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.channel.html#.getCurrentChannelSubtitleList">hcap.channel.getCurrentChannelSubtitleList()</a><br>
<a href="hcap.channel.html#.setCurrentChannelSubtitleIndex">hcap.channel.setCurrentChannelSubtitleIndex()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item6'
>
<div class="fixedFont heading" id=".getCurrentChannelSubtitleList">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>getCurrentChannelSubtitleList</b>(param)
</div>
<div class="description">
Gets supported subtitle list of the current channel. <br>
Subtitle list is composed of subtitle setting values and delimiter comma(','). <br>
Application can get/set subtitle setting of the current channel by index of the subtitle list.<br>
"xx" for which no subtitle is displayed, can be returned as a subtitle setting if the subtitle is not mapped to an available system subtitle.<br>
And "off" can be returned as a subtitle setting to turn off the subtitle.<br>
If there is no subtitle list of the current channel, only "off" is returned as the subtitle list.<br>
Since version 1.24.2, subtitles with "_HOH" appended to the original value(ex: sq_HOH) are provided for the hearing impaired. [EU Only]<br>
<div align=center>
<table class="hcap_spec" width=400>
<thead>
<tr><th>Item</th><th>Value</th></tr>
</thead>
<tbody>
<tr class="odd"><th>Subtitle List</th><td>off,en,ko,fr,en,xx,eng</td></tr>
<tr><th>index</th><td>0, 1, 2, 3, 4, 5, 6</td></tr>
</tbody>
<tfoot>
<tr><th colspan="2">Subtitle List & Index Example</td></tr>
</tfoot>
</table>
</div>
If the application wants to set the subtitle to French ('fr'), use the index value '3'.</a>
</div>
<pre class="code prettyprint">hcap.channel.getCurrentChannelSubtitleList({
"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 - subtitle list string
// which is composed of subtitle setting values and 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.3.1</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.channel.html#.getCurrentChannelSubtitleIndex">hcap.channel.getCurrentChannelSubtitleIndex()</a><br>
<a href="hcap.channel.html#.setCurrentChannelSubtitleIndex">hcap.channel.setCurrentChannelSubtitleIndex()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item7'
>
<div class="fixedFont heading" id=".getDataChannel">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>getDataChannel</b>(param)
</div>
<div class="description">
Gets information about the Pro:Centric data channel(RF Channel or IP Channel),
which is the channel used to download applications.
In case of RF Data Channel, only frequency and program number are valid in channel information.
</div>
<pre class="code prettyprint">hcap.channel.getDataChannel({
"onSuccess" : function(s) {
if (s.channelType === hcap.channel.ChannelType.RF_DATA) {
console.log("onSuccess :" +
"\n frequency " + s.frequency +
"\n program number " + s.programNumber);
} else if (s.channelType === hcap.channel.ChannelType.IP_DATA) {
console.log("onSuccess :" +
"\n ip " + s.ip +
"\n port " + s.port);
} else {
console.log("unknown channel type");
}
},
"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) {
// see the <a href="../symbols/hcap.channel.html#.CHANNEL_PROPERTY">{ Channel Properties }</a> in <a href="hcap.channel.html#.requestChangeCurrentChannel">hcap.channel.requestChangeCurrentChannel()</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.3.1</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.channel.html#.requestChangeCurrentChannel">hcap.channel.requestChangeCurrentChannel()</a><br>
<a href="hcap.channel.html#.getCurrentChannel">hcap.channel.getCurrentChannel()</a><br>
<a href="hcap.channel.html#.replayCurrentChannel">hcap.channel.replayCurrentChannel()</a><br>
<a href="hcap.channel.html#.stopCurrentChannel">hcap.channel.stopCurrentChannel()</a><br>
<a href="hcap.channel.html#.getDataChannel">hcap.channel.getDataChannel()</a><br>
<a href="hcap.channel.html#.getChannelMap">hcap.channel.getChannelMap()</a><br>
<a href="hcap.channel.html#.getStartChannel">hcap.channel.getStartChannel()</a><br>
<a href="hcap.channel.html#.setStartChannel">hcap.channel.setStartChannel()</a><br>
<a href="_global_.html#event:channel_changed">{Event} channel_changed</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item8'
>
<div class="fixedFont heading" id=".getProgramInfo">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>getProgramInfo</b>(param)
</div>
<div class="description">
Gets the information about the current program and the next program in the current channel.
</div>
<pre class="code prettyprint">hcap.channel.getProgramInfo({
"onSuccess" : function(s) {
console.log("onSuccess :" +
"\n currentProgram title = " + s.currentProgram.title +
"\n currentProgram startTime = " + s.currentProgram.startTime.year +
"-" + s.currentProgram.startTime.month +
"-" + s.currentProgram.startTime.day +
" " + s.currentProgram.startTime.hour +
" : " + s.currentProgram.startTime.minute +
" : " + s.currentProgram.startTime.second +
"\n currentProgram length = " + s.currentProgram.lengthInSeconds + "second(s)" +
"\n nextProgram title = " + s.nextProgram.title +
"\n nextProgram startTime = " + s.nextProgram.startTime.year +
"-" + s.nextProgram.startTime.month +
"-" + s.nextProgram.startTime.day +
" " + s.nextProgram.startTime.hour +
" : " + s.nextProgram.startTime.minute +
" : " + s.nextProgram.startTime.second +
"\n nextProgram length = " + s.nextProgram.lengthInSeconds + "second(s)");
},
"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.currentProgram.title - title of the current program.
// {Number} param.currentProgram.startTime.year - year of the start time of the current program.
// {Number} param.currentProgram.startTime.month - month of the start time of the current program.
// {Number} param.currentProgram.startTime.day - day of the start time of the current program.
// {Number} param.currentProgram.startTime.hour - hour of the start time of the current program.
// {Number} param.currentProgram.startTime.minute - minute of the start time of the current program.
// {Number} param.currentProgram.startTime.second - second of the start time of the current program.
// {String} param.currentProgram.lengthInSeconds - length of the current program in seconds. (0 ~ 2^32 - 1)
// {String} param.nextProgram.title - title of the next program.
// {Number} param.nextProgram.startTime.year - year of the start time of the next program.
// {Number} param.nextProgram.startTime.month - month of the start time of the next program.
// {Number} param.nextProgram.startTime.day - day of the start time of the next program.
// {Number} param.nextProgram.startTime.hour - hour of the start time of the next program.
// {Number} param.nextProgram.startTime.minute - minute of the start time of the next program.
// {Number} param.nextProgram.startTime.second - second of the start time of the next program.
// {String} param.nextProgram.lengthInSeconds - length of the next program in seconds. (0 ~ 2^32 - 1)
}</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>
<div class="hr"></div>
</li>
<li
class='item9'
>
<div class="fixedFont heading" id=".getReadyInbandDataService">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>getReadyInbandDataService</b>(param)
</div>
<div class="description">
Get the available inband data service in the current channel.
</div>
<pre class="code prettyprint">hcap.channel.getReadyInbandDataService({
"onSuccess" : function(s) {
var serviceType = "UNKNOWN";
switch(s.availableDataServiceType) {
case hcap.channel.InbandDataServiceType.MHP: serviceType = "MHP"; break;
case hcap.channel.InbandDataServiceType.MHEG: serviceType = "MHEG"; break;
case hcap.channel.InbandDataServiceType.HBBTV: serviceType = "HBBTV"; break;
case hcap.channel.InbandDataServiceType.NONE: serviceType = "NONE"; break;
default: serviceType = "UNKNOWN"; break;
}
console.log("onSuccess : available data service type = " + serviceType);
},
"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.availableDataServiceType - available data service type in the current channel. If there is no available data service, hcap.channel.InbandDataServiceType.NONE will be returned.
}</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.8.0</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="_global_.html#event:inband_data_service_ready">{Event} inband_data_service_ready</a><br>
<a href="hcap.channel.InbandDataServiceType.html#.MHP">hcap.channel.InbandDataServiceType.MHP</a><br>
<a href="hcap.channel.InbandDataServiceType.html#.MHEG">hcap.channel.InbandDataServiceType.MHEG</a><br>
<a href="hcap.channel.InbandDataServiceType.html#.HBBTV">hcap.channel.InbandDataServiceType.HBBTV</a><br>
<a href="hcap.channel.InbandDataServiceType.html#.NONE">hcap.channel.InbandDataServiceType.NONE</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item10'
>
<div class="fixedFont heading" id=".getStartChannel">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>getStartChannel</b>(param)
</div>
<div class="description">
Gets the start channel information which is the channel displayed
at first when TV is turned on.<br>
This API is very similar to <a href="hcap.channel.html#.getCurrentChannel">hcap.channel.getCurrentChannel()</a>.
For detailed information, such as example and related information, please refer to
<a href="hcap.channel.html#.requestChangeCurrentChannel">hcap.channel.requestChangeCurrentChannel()</a>.
</div>
<pre class="code prettyprint">hcap.channel.getStartChannel({
"onSuccess" : function(s) {
console.log("onSuccess :" +
"\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) {
// see the <a href="../symbols/hcap.channel.html#.CHANNEL_PROPERTY">{ Channel Properties }</a> in <a href="hcap.channel.html#.requestChangeCurrentChannel">hcap.channel.requestChangeCurrentChannel()</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.3.1</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.channel.html#.requestChangeCurrentChannel">hcap.channel.requestChangeCurrentChannel()</a><br>
<a href="hcap.channel.html#.getCurrentChannel">hcap.channel.getCurrentChannel()</a><br>
<a href="hcap.channel.html#.replayCurrentChannel">hcap.channel.replayCurrentChannel()</a><br>
<a href="hcap.channel.html#.stopCurrentChannel">hcap.channel.stopCurrentChannel()</a><br>
<a href="hcap.channel.html#.getDataChannel">hcap.channel.getDataChannel()</a><br>
<a href="hcap.channel.html#.getChannelMap">hcap.channel.getChannelMap()</a><br>
<a href="hcap.channel.html#.getStartChannel">hcap.channel.getStartChannel()</a><br>
<a href="hcap.channel.html#.setStartChannel">hcap.channel.setStartChannel()</a><br>
<a href="_global_.html#event:channel_changed">{Event} channel_changed</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item11'
>
<div class="fixedFont heading" id=".launchInbandDataService">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>launchInbandDataService</b>(param)
</div>
<div class="description">
Launch the application of the inband data service type in the current channel.
</div>
<pre class="code prettyprint">hcap.channel.launchInbandDataService({
"inband_data_service_type" : hcap.channel.InbandDataServiceType.HBBTV,
"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.inband_data_service_type [Required] - inband data service type to launch at the current channel.</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.6.0</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="_global_.html#event:inband_data_service_ready">{Event} inband_data_service_ready</a><br>
<a href="hcap.channel.InbandDataServiceType.html#.MHP">hcap.channel.InbandDataServiceType.MHP</a><br>
<a href="hcap.channel.InbandDataServiceType.html#.MHEG">hcap.channel.InbandDataServiceType.MHEG</a><br>
<a href="hcap.channel.InbandDataServiceType.html#.HBBTV">hcap.channel.InbandDataServiceType.HBBTV</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item12'
>
<div class="fixedFont heading" id=".replayCurrentChannel">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>replayCurrentChannel</b>(param)
</div>
<div class="description">
Replays the current stopped channel.
<ul>
<li>RF channel : restart channel tuning and replays AV.</li>
<li>IP channel : join IP multicast group and replays AV.</li>
</ul>
</div>
<pre class="code prettyprint">hcap.channel.replayCurrentChannel({
"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.
Replaying already playing channel, or for operation failure
<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.channel.html#.requestChangeCurrentChannel">hcap.channel.requestChangeCurrentChannel()</a><br>
<a href="hcap.channel.html#.getCurrentChannel">hcap.channel.getCurrentChannel()</a><br>
<a href="hcap.channel.html#.replayCurrentChannel">hcap.channel.replayCurrentChannel()</a><br>
<a href="hcap.channel.html#.stopCurrentChannel">hcap.channel.stopCurrentChannel()</a><br>
<a href="hcap.channel.html#.getDataChannel">hcap.channel.getDataChannel()</a><br>
<a href="hcap.channel.html#.getChannelMap">hcap.channel.getChannelMap()</a><br>
<a href="hcap.channel.html#.getStartChannel">hcap.channel.getStartChannel()</a><br>
<a href="hcap.channel.html#.setStartChannel">hcap.channel.setStartChannel()</a><br>
<a href="_global_.html#event:channel_changed">{Event} channel_changed</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item13'
>
<div class="fixedFont heading" id=".requestChangeCurrentChannel">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>requestChangeCurrentChannel</b>(param)
</div>
<div class="description">
Requests to change the current channel.<br>
The result for the channel change operation can be obtained by registering the
<a href="_global_.html#event:channel_changed">{Event} channel_changed</a><br><br>
For channel parameters, TV will support only one channel class.<br><br>
<div align=center>
<table class="hcap_spec" width=850>
<thead>
<tr><th colspan="3">Channel Class & Parameters</th></tr>
</thead>
<tbody>
<tr class="odd"><th rowspan="8">AV Channel</th>
<th class="left">RF channel class 1 (supported in only US model)</th><td class="left">logicalNumber</td></tr>
<tr ><th class="left">RF channel class 2 (supported in only EU model)</th><td class="left">frequency + programNumber. (for analog channel, programNumber = 0)</td></tr>
<tr class="odd"><th class="left">RF channel class 3 (supported in only US model)</th><td class="left">majorNumber + minorNumber. (for analog channel, minorNumber = 0)</td></tr>
<tr ><th class="left">RF channel class 4 (supported in only EU model)</th><td class="left">frequency + programNumber + satelliteId + polarization</td></tr>
<tr class="odd"><th class="left">RF channel class 5 (supported in only EU model)</th><td class="left">frequency + programNumber + plpId. (rfBroadcastType = hcap.channel.RfBroadcastType.TERRESTRIAL_2)</td></tr>
<tr ><th class="left">RF channel class 6 (supported in only US model)</th><td class="left">majorNumber + minorNumber + plpId. (rfBroadcastType = hcap.channel.RfBroadcastType.TERRESTRIAL_ATSC3, hcap.channel.RfBroadcastType.CABLE_ATSC3)</td></tr>
<tr class="odd"><th class="left">IP channel class 1 (supported in only US model)</th><td class="left">logicalNumber</td></tr>
<tr ><th class="left">IP channel class 2 (supported in both EU model and US model)</th><td class="left">ip + port</td></tr>
<tr class="odd"><th rowspan="4">Data Channel</th>
<th class="left">RF channel class 1 (not supported)</th><td class="left"> </td></tr>
<tr ><th class="left">RF channel class 2 (supported in both EU model and US model)</th><td class="left">frequency + programNumber (required)</td></tr>
<tr class="odd"><th class="left">IP channel class 1 (not supported)</th><td class="left"> </td></tr>
<tr ><th class="left">IP channel class 2 (supported in both EU model and US model)</th><td class="left">ip + port (required)</td></tr>
</tbody>
</table>
</div>
<br>
If a channel with more than one Channel Class is requested to change, then next priority table will be applied.<br>
RF channel class 1 is 'X' when logicalNumber is 0.<br>
RF channel class 2 is 'X' when frequency is 0.<br>
RF channel class 3 is 'X' when majorNumber is 0.<br>
RF channel class 4 is 'X' when satelliteId is 0.<br>
IP channel class 1 is 'X' when logicalNumber is 0.<br>
IP channel class 2 is 'X' when ip is "0" and port is 0.<br>
RF channel class 5 is only when the channel type is hcap.channel.RfBroadcastType.TERRESTRIAL_2 and only frequency + programNumber + plpId take affect.<br>
RF channel class 6 is only when the channel type is hcap.channel.RfBroadcastType.TERRESTRIAL_ATSC3 or hcap.channel.RfBroadcastType.CABLE_ATSC3 and only majorNumber + minorNumber + plpId take affect.<br>
Other cases than following table will be treated as invalid channel combinations.<br>
<div align=center>
<table class="hcap_spec" width=850>
<thead>
<tr>
<th>RF channel class 1<br> (logicalNumber)</th>
<th>RF channel class 2<br> (frequency + programNumber)</th>
<th>RF channel class 3<br> (majorNumber + minorNumber)</th>
<th>RF channel class 4<br> (frequency + programNumber + satelliteId + polarization)</th>
<th>Effective Channel Class</th>
</tr>
</thead>
<tbody>
<tr class="odd"><td>X</td><td>X</td><td>X</td><td>X</td><td>RF channel class 1</td></tr>
<tr ><td>O</td><td>X</td><td>X</td><td>X</td><td>RF channel class 1</td></tr>
<tr class="odd"><td>X</td><td>O</td><td>X</td><td>X</td><td>RF channel class 2</td></tr>
<tr ><td>X</td><td>X</td><td>O</td><td>X</td><td>RF channel class 3</td></tr>
<tr class="odd"><td>X</td><td>-</td><td>X</td><td>O</td><td>RF channel class 4</td></tr>
<tr ><td>O</td><td>O</td><td>X</td><td>X</td><td>RF channel class 2</td></tr>
<tr class="odd"><td>O</td><td>X</td><td>O</td><td>X</td><td>RF channel class 3</td></tr>
<tr ><td>O</td><td>-</td><td>X</td><td>O</td><td>RF channel class 4</td></tr>
</tbody>
<tfoot>
<tr><th colspan="5">RF Channel</th></tr>
</tfoot>
</table>
</div>
<br>
<div align=center>
<table class="hcap_spec" width=850>
<thead>
<tr>
<th>IP channel class 1<br> (logicalNumber)</th>
<th>IP channel class 2<br> (ip + port)</th>
<th>Effective Channel Class</th>
</tr>
</thead>
<tbody>
<tr class="odd"><td>X</td><td>X</td><td>IP channel class 1</td></tr>
<tr ><td>O</td><td>X</td><td>IP channel class 1</td></tr>
<tr class="odd"><td>X</td><td>O</td><td>IP channel class 2</td></tr>
<tr ><td>O</td><td>O</td><td>IP channel class 2</td></tr>
</tbody>
<tfoot>
<tr><th colspan="3">IP Channel</th></tr>
</tfoot>
</table>
</div>
<br>
<a href="hcap.channel.html#.getCurrentChannel">hcap.channel.getCurrentChannel()</a> gets the AV (RF/IP) channel information which
includes supported channel class information and optional parameters,
but unsupported channel classes are filled with 0.<br>
<br>
<a href="hcap.channel.html#.getDataChannel">hcap.channel.getDataChannel()</a> gets the DATA (RF/IP) channel information which
includes supported channel class information, but other channel classes
and optional parameters are filled with 0.<br>
<br>
Result objects for <a href="hcap.channel.html#.getCurrentChannel">hcap.channel.getCurrentChannel()</a> and <a href="hcap.channel.html#.getDataChannel">hcap.channel.getDataChannel()</a>
have following information.<br>
<br>
<div align=center id=".CHANNEL_TYPE">
<table class="hcap_spec" width=850>
<thead>
<tr><th>Channel Type</th><th>Description</th></tr>
</thead>
<tbody>
<tr class="odd">
<th class="left"><a href="hcap.channel.ChannelType.html#.RF">hcap.channel.ChannelType.RF</a></th>
<td class="left">Defines AV channel via RF signal.</td>
</tr>
<tr>
<th class="left"><a href="hcap.channel.ChannelType.html#.IP">hcap.channel.ChannelType.IP</a></th>
<td class="left">Defines AV channel via IP network to support IPTV.</td>
</tr>
<tr class="odd">
<th class="left"><a href="hcap.channel.ChannelType.html#.RF_DATA">hcap.channel.ChannelType.RF_DATA</a></th>
<td class="left">Defines data channel via RF signal. Applications can download some carousel data.</td>
</tr>
<tr>
<th class="left"><a href="hcap.channel.ChannelType.html#.IP_DATA">hcap.channel.ChannelType.IP_DATA</a></th>
<td class="left">Defines data channel via IP network.
<table class="hcap_spec">
<thead>
<tr><th colspan=2>Data channel operation in IP address range</th></tr>
</thead>
<tbody>
<tr class="odd">
<th class="left">Unicast IP Address</th>
<td class="left">Applications can download some data from Pro:Centric server using HTTP protocol.</td>
</tr>
<tr>
<th class="left">Multicast IP Address<br>(224.0.0.0 ~<br> 239.255.255.255)</th>
<td class="left">RF broadcast data will be sent via IP multicast [TS(Transport Stream) over IP multicast].<br>
In this mode, carousel download operation is same as <a href="hcap.channel.ChannelType.html#.RF_DATA">hcap.channel.ChannelType.RF_DATA</a><br>
In this case, HCAP URL can use the special frequency# '1' for this virtual RF channel.<br>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
<tfoot>
<tr><th colspan="2">Channel Type</td></tr>
</tfoot>
</table>
</div>
hcap.channel.requestChangeCurrentChannel() for IP DATA channel returns false because it has no effect.<br>
<br>
If following option fields are filled correctly in the input object,
AV channel change performance will be improved.
<ul>
<li>symbolRate</li>
<li>pcrPid, videoPid</li>
<li>videoStreamType</li>
<li>audioPid</li>
<li>audioStreamType</li>
<ul>
<br>
<div align=center id=".CHANNEL_PROPERTY">
<table class="hcap_spec" width=850>
<thead>
<tr> <th>Property Name </th><th>Type </th><th>Req<br>uired</th><th>RF</th><th>IP</th><th>RF<br>DATA</th><th>IP<br>DATA</th><th>Value </th><th>Description</th></tr>
</thead>
<tbody>
<tr class="odd"><td>channelType </td><td>Number </td><td>O </td><td>O </td><td>O </td><td>O </td><td>O </td><td class="left"><a href="hcap.channel.ChannelType.html">hcap.channel.ChannelType</a><br> </td><td class="left">Channel type indicator</td></tr>
<tr ><td>logicalNumber </td><td>Number </td><td>O </td><td>O </td><td>O </td><td>O </td><td>X </td><td class="left">0 ~ 2^16 - 1 </td><td class="left">Logical channel number</td></tr>
<tr class="odd"><td>frequency </td><td>Number </td><td>O </td><td>O </td><td>X </td><td>O </td><td>X </td><td class="left">0 ~ 2^32 - 1 </td><td class="left">Frequency (Hz, and MHz for satellite)</td></tr>
<tr ><td>programNumber </td><td>Number </td><td>O </td><td>O </td><td>X </td><td>O </td><td>X </td><td class="left">0 ~ 2^16 - 1 </td><td class="left">Program number (0 for analog channel)</td></tr>
<tr class="odd"><td>programNumber </td><td>Number </td><td>X </td><td>X </td><td>O </td><td>X </td><td>X </td><td class="left">0 ~ 2^16 - 1 </td><td class="left">Specific program number in IP Stream</td></tr>
<tr ><td>majorNumber </td><td>Number </td><td>O </td><td>O </td><td>X </td><td>O </td><td>X </td><td class="left">0 ~ 2^16 - 1 </td><td class="left">Major channel number</td></tr>
<tr class="odd"><td>minorNumber </td><td>Number </td><td>O </td><td>O </td><td>X </td><td>O </td><td>X </td><td class="left">0 ~ 2^16 - 1 </td><td class="left">Minor channel number</td></tr>
<tr ><td>satelliteId </td><td>Number </td><td>O </td><td>O </td><td>X </td><td>X </td><td>X </td><td class="left">0 ~ 2^16 - 1 </td><td class="left">Satellite setting ID</td></tr>
<tr class="odd"><td>polarization </td><td>Number </td><td>O </td><td>O </td><td>X </td><td>X </td><td>X </td><td class="left"><a href="hcap.channel.Polarization.html">hcap.channel.Polarization</a> </td><td class="left">Polarization mode</td></tr>
<tr ><td>plpId </td><td>Number </td><td>O </td><td>O </td><td>X </td><td>X </td><td>X </td><td class="left">0 ~ 0xFF </td><td class="left">PLP (Physical Layer Pipe) ID</td></tr>
<tr class="odd"><td>rfBroadcastType </td><td>Number </td><td>O </td><td>O </td><td>X </td><td>O </td><td>X </td><td class="left"><a href="hcap.channel.RfBroadcastType.html">hcap.channel.RfBroadcastType</a></td><td class="left">RF broadcast type</td></tr>
<tr ><td>ip </td><td>String </td><td>O </td><td>X </td><td>O </td><td>X </td><td>O </td><td class="left">[0~255].[0~255].[0~255].[0~255] </td><td class="left">IP address value</td></tr>
<tr class="odd"><td>port </td><td>Number </td><td>O </td><td>X </td><td>O </td><td>X </td><td>O </td><td class="left">0 ~ 2^16 - 1 </td><td class="left">Port number</td></tr>
<tr ><td>ipBroadcastType </td><td>Number </td><td>O </td><td>X </td><td>O </td><td>X </td><td>X </td><td class="left"><a href="hcap.channel.IpBroadcastType.html">hcap.channel.IpBroadcastType</a></td><td class="left">IP broadcast type (default is UDP)</td></tr>
<tr class="odd"><td>symbolRate </td><td>Number </td><td>X </td><td>O </td><td>X </td><td>X </td><td>X </td><td class="left">0 ~ 2^32 - 1 </td><td class="left">Symbol rate (Bd)</td></tr>
<tr ><td>pcrPid </td><td>Number </td><td>X </td><td>O </td><td>O </td><td>X </td><td>X </td><td class="left">0 ~ 2^13 - 1 </td><td class="left">PCR(Program Clock Reference)Packet ID</td></tr>
<tr class="odd"><td>videoPid </td><td>Number </td><td>X </td><td>O </td><td>O </td><td>X </td><td>X </td><td class="left">0 ~ 2^13 - 1 </td><td class="left">Video packet ID (<a href="hcap.channel.html">hcap.channel.NO_STREAM_PID</a> for audio only channel)</td></tr>
<tr ><td>videoStreamType </td><td>Number </td><td>X </td><td>O </td><td>O </td><td>X </td><td>X </td><td class="left"><a href="hcap.channel.VideoStreamType.html">hcap.channel.VideoStreamType</a></td><td class="left">Video stream type</td></tr>
<tr class="odd"><td>audioPid </td><td>Number </td><td>X </td><td>O </td><td>O </td><td>X </td><td>X </td><td class="left">0 ~ 2^13 - 1 </td><td class="left">Audio packet ID</td></tr>
<tr ><td>audioStreamType </td><td>Number </td><td>X </td><td>O </td><td>O </td><td>X </td><td>X </td><td class="left"><a href="hcap.channel.AudioStreamType.html">hcap.channel.AudioStreamType</a></td><td class="left">Audio stream type</td></tr>
<tr class="odd"><td>signalStrength<br>(read only)</td><td>Number </td><td>X </td><td>O </td><td>X </td><td>O </td><td>X </td><td class="left">0 ~ 255 </td><td class="left">Channel signal strength</td></tr>
<tr ><td>sourceAddress </td><td>String </td><td>X </td><td>X </td><td>O </td><td>X </td><td>X </td><td class="left">[0~255].[0~255].[0~255].[0~255] </td><td class="left">Source IP address for IGMPv3</td></tr>
</tbody>
<tfoot>
<tr><th colspan="9">Channel Property</td></tr>
</tfoot>
</table>
</div>
Below are a few examples for channel change request for different channel classes
</div>
<pre class="code prettyprint">// RF channel class 1 change request
hcap.channel.requestChangeCurrentChannel({
"channelType" : hcap.channel.ChannelType.RF,
"logicalNumber" : 7,
"rfBroadcastType" : hcap.channel.RfBroadcastType.TERRESTRIAL,
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<pre class="code prettyprint">// RF channel class 2 change request
hcap.channel.requestChangeCurrentChannel({
"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>
<pre class="code prettyprint">// RF channel class 3 change request
hcap.channel.requestChangeCurrentChannel({
"channelType" : hcap.channel.ChannelType.RF,
"majorNumber" : 9,
"minorNumber" : 1,
"rfBroadcastType" : hcap.channel.RfBroadcastType.TERRESTRIAL,
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<pre class="code prettyprint">// RF channel class 4 change request
hcap.channel.requestChangeCurrentChannel({
"channelType" : hcap.channel.ChannelType.RF,
"frequency" : 63000000,
"programNumber" : 1,
"satelliteId" : 1,
"polarization" : hcap.channel.Polarization.VERTICAL,
"rfBroadcastType" : hcap.channel.RfBroadcastType.SATELLITE_2,
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<pre class="code prettyprint">// RF channel class 5 change request
hcap.channel.requestChangeCurrentChannel({
"channelType" : hcap.channel.ChannelType.RF,
"frequency" : 63000000,
"programNumber" : 1,
"plpId" : 3,
"rfBroadcastType" : hcap.channel.RfBroadcastType.TERRESTRIAL_2,
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<pre class="code prettyprint">// RF channel class 6 change request
hcap.channel.requestChangeCurrentChannel({
"channelType" : hcap.channel.ChannelType.RF,
"majorNumber" : 9,
"minorNumber" : 1,
"plpId" : 3,
"rfBroadcastType" : hcap.channel.RfBroadcastType.TERRESTRIAL_ATSC3,
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<pre class="code prettyprint">// IP channel class 1 change request
hcap.channel.requestChangeCurrentChannel({
"channelType" : hcap.channel.ChannelType.IP,
"logicalNumber" : 9,
"ipBroadcastType" : hcap.channel.IpBroadcastType.UDP,
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<pre class="code prettyprint">// IP channel class 2 change request
hcap.channel.requestChangeCurrentChannel({
"channelType" : hcap.channel.ChannelType.IP,
"ip" : "1.2.3.4",
"port" : 3333,
"ipBroadcastType" : hcap.channel.IpBroadcastType.UDP,
"onSuccess" : function() {
console.log("onSuccess");
},
"onFailure" : function(f) {
console.log("onFailure : errorMessage = " + f.errorMessage);
}
});</pre>
<pre class="code prettyprint">// IP channel class 2 change request with optional property
hcap.channel.requestChangeCurrentChannel({
"channelType" : hcap.channel.ChannelType.IP,
"ip" : "1.2.3.4",
"port" : 3333,
"symbolRate" : 6758,
"prcPid" : 100,
"videoPid" : 200,
"videoStreamType" : hcap.channel.VideoStreamType.MPEG2,
"audioPid" : 400,
"audioStreamType" : hcap.channel.AudioStreamType.MPEG2,
"ipBroadcastType" : hcap.channel.IpBroadcastType.UDP,
"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><a href="../symbols/hcap.channel.html#.CHANNEL_PROPERTY">{ Channel Properties } [Required] - Channel Information</a></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.3.1</dd>
</dl>
<dl class="detailList params">
<dt class="heading">See:</dt>
<dd><a href="hcap.channel.html#.requestChangeCurrentChannel">hcap.channel.requestChangeCurrentChannel()</a><br>
<a href="hcap.channel.html#.getCurrentChannel">hcap.channel.getCurrentChannel()</a><br>
<a href="hcap.channel.html#.replayCurrentChannel">hcap.channel.replayCurrentChannel()</a><br>
<a href="hcap.channel.html#.stopCurrentChannel">hcap.channel.stopCurrentChannel()</a><br>
<a href="hcap.channel.html#.getDataChannel">hcap.channel.getDataChannel()</a><br>
<a href="hcap.channel.html#.getChannelMap">hcap.channel.getChannelMap()</a><br>
<a href="hcap.channel.html#.getStartChannel">hcap.channel.getStartChannel()</a><br>
<a href="hcap.channel.html#.setStartChannel">hcap.channel.setStartChannel()</a><br>
<a href="_global_.html#event:channel_changed">{Event} channel_changed</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item14'
>
<div class="fixedFont heading" id=".setCurrentChannelAudioLanguageIndex">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>setCurrentChannelAudioLanguageIndex</b>(param)
</div>
<div class="description">
Sets the audio language of the current channel.<br>
<div align=center>
<table class="hcap_spec" width=400>
<thead>
<tr><th>Item</th><th>Value</th></tr>
</thead>
<tbody>
<tr class="odd"><th>audio language list</th><td>en,ko,fr,en,xx</td></tr>
<tr><th>index</th><td>0, 1, 2, 3, 4</td></tr>
</tbody>
<tfoot>
<tr><th colspan="2">Audio Language List & Index Example</th></tr>
</tfoot>
</table>
</div>
</div>
<pre class="code prettyprint">hcap.channel.setCurrentChannelAudioLanguageIndex({
"index" : 1,
"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.index [Required] - audio language index to be set. Index starts with 0.</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>
Setting to the same audio language index as before will invoke this 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.channel.html#.getCurrentChannelAudioLanguageList">hcap.channel.getCurrentChannelAudioLanguageList()</a><br>
<a href="hcap.channel.html#.getCurrentChannelAudioLanguageIndex">hcap.channel.getCurrentChannelAudioLanguageIndex()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item15'
>
<div class="fixedFont heading" id=".setCurrentChannelSubtitleIndex">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>setCurrentChannelSubtitleIndex</b>(param)
</div>
<div class="description">
Sets the subtitle index of the current channel.<br>
<div align=center>
<table class="hcap_spec" width=400>
<thead>
<tr><th>Item</th><th>Value</th></tr>
</thead>
<tbody>
<tr class="odd"><th>Subtitle List</th><td>off,en,ko,fr,en,xx,eng</td></tr>
<tr><th>index</th><td>0, 1, 2, 3, 4, 5, 6</td></tr>
</tbody>
<tfoot>
<tr><th colspan="2">Subtitle List & Index Example</td></tr>
</tfoot>
</table>
</div>
If the application wants to set the subtitle to French ('fr'), use the index value '3'</a>.
</div>
<pre class="code prettyprint">hcap.channel.setCurrentChannelSubtitleIndex({
"index" : 1,
"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.index [Required] - subtitle setting index to be set. Index starts with 0.</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>
Setting to the same subtitle index as before will invoke this 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.channel.html#.getCurrentChannelSubtitleList">hcap.channel.getCurrentChannelSubtitleList()</a><br>
<a href="hcap.channel.html#.getCurrentChannelSubtitleIndex">hcap.channel.getCurrentChannelSubtitleIndex()</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item16'
>
<div class="fixedFont heading" id=".setStartChannel">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>setStartChannel</b>(param)
</div>
<div class="description">
Sets the start channel which is displayed at first when TV is turned on.
This API is very
similar to <a href="hcap.channel.html#.requestChangeCurrentChannel">hcap.channel.requestChangeCurrentChannel()</a>,
but in this case, just update the start channel setting without channel change.
For detailed information, such as example and related information, please refer to
<a href="hcap.channel.html#.requestChangeCurrentChannel">hcap.channel.requestChangeCurrentChannel()</a>.
</div>
<pre class="code prettyprint">// set start channel with RF channel class 2
hcap.channel.setStartChannel({
"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><a href="../symbols/hcap.channel.html#.CHANNEL_PROPERTY">{ Channel Properties } [Required] - Channel Information</a></li>
<br>If you want to set off start channel, set param.channelType to hcap.channel.ChannelType.UNKNOWN.
</li>
<li>{Function} param.onSuccess [Optional] - success callback function.<br>
Setting to the same channel 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.channel.html#.requestChangeCurrentChannel">hcap.channel.requestChangeCurrentChannel()</a><br>
<a href="hcap.channel.html#.getCurrentChannel">hcap.channel.getCurrentChannel()</a><br>
<a href="hcap.channel.html#.replayCurrentChannel">hcap.channel.replayCurrentChannel()</a><br>
<a href="hcap.channel.html#.stopCurrentChannel">hcap.channel.stopCurrentChannel()</a><br>
<a href="hcap.channel.html#.getDataChannel">hcap.channel.getDataChannel()</a><br>
<a href="hcap.channel.html#.getChannelMap">hcap.channel.getChannelMap()</a><br>
<a href="hcap.channel.html#.getStartChannel">hcap.channel.getStartChannel()</a><br>
<a href="hcap.channel.html#.setStartChannel">hcap.channel.setStartChannel()</a><br>
<a href="_global_.html#event:channel_changed">{Event} channel_changed</a><br></dd>
</dl>
</dl>
<div class="hr"></div>
</li>
<li
class='item17'
>
<div class="fixedFont heading" id=".stopCurrentChannel">
<span class='lighter'>
&lt;static&gt;
</span>
<span class="light">hcap.channel.</span><b>stopCurrentChannel</b>(param)
</div>
<div class="description">
Stops AV play of the current channel.
<ul>
<li>RF channel : Stops RF tuning and stops playing AV.</li>
<li>IP channel : Leaves IP multicast group and stops playing AV.</li>
</ul>
<br>
This API has only an effect on the current channel.<br>
When the channel is changed, new channel will be played.<br>
To replay the current channel, use <a href="hcap.channel.html#.replayCurrentChannel">hcap.channel.replayCurrentChannel()</a>.
</div>
<pre class="code prettyprint">hcap.channel.stopCurrentChannel({
"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>
Stopping already stopped channel will invoke this 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.channel.html#.requestChangeCurrentChannel">hcap.channel.requestChangeCurrentChannel()</a><br>
<a href="hcap.channel.html#.getCurrentChannel">hcap.channel.getCurrentChannel()</a><br>
<a href="hcap.channel.html#.replayCurrentChannel">hcap.channel.replayCurrentChannel()</a><br>
<a href="hcap.channel.html#.stopCurrentChannel">hcap.channel.stopCurrentChannel()</a><br>
<a href="hcap.channel.html#.getDataChannel">hcap.channel.getDataChannel()</a><br>
<a href="hcap.channel.html#.getChannelMap">hcap.channel.getChannelMap()</a><br>
<a href="hcap.channel.html#.getStartChannel">hcap.channel.getStartChannel()</a><br>
<a href="hcap.channel.html#.setStartChannel">hcap.channel.setStartChannel()</a><br>
<a href="_global_.html#event:channel_changed">{Event} channel_changed</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>
Reference in New Issue View Git Blame Copy Permalink