817 lines
30 KiB
HTML
Executable File
817 lines
30 KiB
HTML
Executable File
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<meta name="generator" content="JsDoc Toolkit" />
|
|
<title>hcap.file | JsDoc Reference</title>
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
|
|
<meta name="mobileoptimized" content="0" />
|
|
|
|
<link rel="stylesheet" href="../css/all.css" media="all" />
|
|
<link rel="stylesheet" href="../css/handheld.css" media="only screen and (max-width: 660px)" />
|
|
<link rel="stylesheet" href="../css/handheld.css" media="handheld" />
|
|
<link rel="stylesheet" href="../css/screen.css" media="screen and (min-width: 661px)" />
|
|
|
|
<link rel="stylesheet" href="../javascript/highlighter/dessert.css" />
|
|
|
|
<script src="../javascript/all.js"></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="../javascript/html5.js"></script>
|
|
<![endif]-->
|
|
|
|
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div class="index">
|
|
<div class="menu">
|
|
<div class="indexLinks">
|
|
<a href="../index.html">Classes</a>
|
|
<a href="../files.html">Files</a>
|
|
</div>
|
|
<table width=100% class=confidential><tr><td><b>LGE Confidential</b></td></tr></table>
|
|
<h2 class="heading1">Library</h2>
|
|
<table>
|
|
<tr>
|
|
<td align=left class=confidential><a href="../../js/hcap.js">·hcap.js (1.24.6.5901)</li></a></td>
|
|
</tr>
|
|
</table>
|
|
<h2 class="heading1">Classes</h2>
|
|
|
|
<input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input>
|
|
|
|
<nav>
|
|
<ul class="classList" id="ClassList">
|
|
|
|
<li><a href="../symbols/_global_.html">_global_</a></li>
|
|
|
|
<li><a href="../symbols/hcap.html">hcap</a></li>
|
|
|
|
<li><a href="../symbols/hcap.application.html">hcap<span class='break'> </span>.<span class='break'> </span>application</a></li>
|
|
|
|
<li><a href="../symbols/hcap.beacon.html">hcap<span class='break'> </span>.<span class='break'> </span>beacon</a></li>
|
|
|
|
<li><a href="../symbols/hcap.bluetooth.html">hcap<span class='break'> </span>.<span class='break'> </span>bluetooth</a></li>
|
|
|
|
<li><a href="../symbols/hcap.bluetooth.audio.html">hcap<span class='break'> </span>.<span class='break'> </span>bluetooth<span class='break'> </span>.<span class='break'> </span>audio</a></li>
|
|
|
|
<li><a href="../symbols/hcap.camera.html">hcap<span class='break'> </span>.<span class='break'> </span>camera</a></li>
|
|
|
|
<li><a href="../symbols/hcap.carousel.html">hcap<span class='break'> </span>.<span class='break'> </span>carousel</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.html">hcap<span class='break'> </span>.<span class='break'> </span>channel</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.AudioStreamType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>AudioStreamType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.ChannelStatus.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>ChannelStatus</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.ChannelType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>ChannelType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.InbandDataServiceType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>InbandDataServiceType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.IpBroadcastType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>IpBroadcastType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.Polarization.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>Polarization</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.RfBroadcastType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>RfBroadcastType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.channel.VideoStreamType.html">hcap<span class='break'> </span>.<span class='break'> </span>channel<span class='break'> </span>.<span class='break'> </span>VideoStreamType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.checkout.html">hcap<span class='break'> </span>.<span class='break'> </span>checkout</a></li>
|
|
|
|
<li><a href="../symbols/hcap.externalinput.html">hcap<span class='break'> </span>.<span class='break'> </span>externalinput</a></li>
|
|
|
|
<li><a href="../symbols/hcap.externalinput.ExternalInputType.html">hcap<span class='break'> </span>.<span class='break'> </span>externalinput<span class='break'> </span>.<span class='break'> </span>ExternalInputType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.file.html">hcap<span class='break'> </span>.<span class='break'> </span>file</a></li>
|
|
|
|
<li><a href="../symbols/hcap.iot.html">hcap<span class='break'> </span>.<span class='break'> </span>iot</a></li>
|
|
|
|
<li><a href="../symbols/hcap.key.html">hcap<span class='break'> </span>.<span class='break'> </span>key</a></li>
|
|
|
|
<li><a href="../symbols/hcap.key.Code.html">hcap<span class='break'> </span>.<span class='break'> </span>key<span class='break'> </span>.<span class='break'> </span>Code</a></li>
|
|
|
|
<li><a href="../symbols/hcap.Media.html">hcap<span class='break'> </span>.<span class='break'> </span>Media</a></li>
|
|
|
|
<li><a href="../symbols/hcap.Media.SubtitleType.html">hcap<span class='break'> </span>.<span class='break'> </span>Media<span class='break'> </span>.<span class='break'> </span>SubtitleType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.mode.html">hcap<span class='break'> </span>.<span class='break'> </span>mode</a></li>
|
|
|
|
<li><a href="../symbols/hcap.mouse.html">hcap<span class='break'> </span>.<span class='break'> </span>mouse</a></li>
|
|
|
|
<li><a href="../symbols/hcap.mpi.html">hcap<span class='break'> </span>.<span class='break'> </span>mpi</a></li>
|
|
|
|
<li><a href="../symbols/hcap.network.html">hcap<span class='break'> </span>.<span class='break'> </span>network</a></li>
|
|
|
|
<li><a href="../symbols/hcap.network.DhcpState.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>DhcpState</a></li>
|
|
|
|
<li><a href="../symbols/hcap.network.NetworkEventType.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>NetworkEventType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.network.NetworkMode.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>NetworkMode</a></li>
|
|
|
|
<li><a href="../symbols/hcap.network.WifiSecurityType.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>WifiSecurityType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.network.WirelessMode.html">hcap<span class='break'> </span>.<span class='break'> </span>network<span class='break'> </span>.<span class='break'> </span>WirelessMode</a></li>
|
|
|
|
<li><a href="../symbols/hcap.power.html">hcap<span class='break'> </span>.<span class='break'> </span>power</a></li>
|
|
|
|
<li><a href="../symbols/hcap.power.PowerMode.html">hcap<span class='break'> </span>.<span class='break'> </span>power<span class='break'> </span>.<span class='break'> </span>PowerMode</a></li>
|
|
|
|
<li><a href="../symbols/hcap.preloadedApplication.html">hcap<span class='break'> </span>.<span class='break'> </span>preloadedApplication</a></li>
|
|
|
|
<li><a href="../symbols/hcap.property.html">hcap<span class='break'> </span>.<span class='break'> </span>property</a></li>
|
|
|
|
<li><a href="../symbols/hcap.property.InstallerMenuItem.html">hcap<span class='break'> </span>.<span class='break'> </span>property<span class='break'> </span>.<span class='break'> </span>InstallerMenuItem</a></li>
|
|
|
|
<li><a href="../symbols/hcap.property.PictureMode.html">hcap<span class='break'> </span>.<span class='break'> </span>property<span class='break'> </span>.<span class='break'> </span>PictureMode</a></li>
|
|
|
|
<li><a href="../symbols/hcap.property.PicturePropertyKey.html">hcap<span class='break'> </span>.<span class='break'> </span>property<span class='break'> </span>.<span class='break'> </span>PicturePropertyKey</a></li>
|
|
|
|
<li><a href="../symbols/hcap.rms.html">hcap<span class='break'> </span>.<span class='break'> </span>rms</a></li>
|
|
|
|
<li><a href="../symbols/hcap.rs232c.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c</a></li>
|
|
|
|
<li><a href="../symbols/hcap.rs232c.BaudRate.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>BaudRate</a></li>
|
|
|
|
<li><a href="../symbols/hcap.rs232c.DataBit.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>DataBit</a></li>
|
|
|
|
<li><a href="../symbols/hcap.rs232c.FlowControl.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>FlowControl</a></li>
|
|
|
|
<li><a href="../symbols/hcap.rs232c.Parity.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>Parity</a></li>
|
|
|
|
<li><a href="../symbols/hcap.rs232c.StopBit.html">hcap<span class='break'> </span>.<span class='break'> </span>rs232c<span class='break'> </span>.<span class='break'> </span>StopBit</a></li>
|
|
|
|
<li><a href="../symbols/hcap.security.html">hcap<span class='break'> </span>.<span class='break'> </span>security</a></li>
|
|
|
|
<li><a href="../symbols/hcap.socket.html">hcap<span class='break'> </span>.<span class='break'> </span>socket</a></li>
|
|
|
|
<li><a href="../symbols/hcap.speech.html">hcap<span class='break'> </span>.<span class='break'> </span>speech</a></li>
|
|
|
|
<li><a href="../symbols/hcap.speech.HostType.html">hcap<span class='break'> </span>.<span class='break'> </span>speech<span class='break'> </span>.<span class='break'> </span>HostType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.system.html">hcap<span class='break'> </span>.<span class='break'> </span>system</a></li>
|
|
|
|
<li><a href="../symbols/hcap.system.SoundOutputType.html">hcap<span class='break'> </span>.<span class='break'> </span>system<span class='break'> </span>.<span class='break'> </span>SoundOutputType</a></li>
|
|
|
|
<li><a href="../symbols/hcap.time.html">hcap<span class='break'> </span>.<span class='break'> </span>time</a></li>
|
|
|
|
<li><a href="../symbols/hcap.video.html">hcap<span class='break'> </span>.<span class='break'> </span>video</a></li>
|
|
|
|
<li><a href="../symbols/hcap.volume.html">hcap<span class='break'> </span>.<span class='break'> </span>volume</a></li>
|
|
|
|
<li><a href="../symbols/hcap.webrtc.html">hcap<span class='break'> </span>.<span class='break'> </span>webrtc</a></li>
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
<div class="fineprint" style="clear:both">
|
|
<footer>
|
|
|
|
Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
|
|
Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br />
|
|
Generated on:
|
|
<time datetime='2021-8-13' pubdate>2021-8-13 18:29</time>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="index indexStatic"></div>
|
|
|
|
<div class="content">
|
|
<div class="innerContent">
|
|
<article>
|
|
<header>
|
|
<h1 class="classTitle">
|
|
|
|
Namespace <span>hcap.file</span>
|
|
</h1>
|
|
|
|
<div class="intro">
|
|
<p class="description summary">
|
|
hcap.file
|
|
</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.file.">
|
|
<caption class="sectionTitle">Namespace Summary</caption>
|
|
<thead>
|
|
<tr>
|
|
<th scope="col">Constructor Attributes</th>
|
|
<th scope="col">Constructor Name and Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class="attributes"> </td>
|
|
<td class="nameDescription" >
|
|
<div class="fixedFont">
|
|
<b><a href="../symbols/hcap.file.html#constructor">hcap.file</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.file.">
|
|
<thead>
|
|
<tr>
|
|
<th scope="col">Method Attributes</th>
|
|
<th scope="col">Method Name and Description</th>
|
|
</tr>
|
|
</thead>
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr
|
|
class='item0'
|
|
>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">hcap.file.<b><a href="../symbols/hcap.file.html#.deleteUsbFile">deleteUsbFile</a></b>(param)
|
|
</div>
|
|
<div class="description">Deletes the file or directory given by the path in the USB storage.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr
|
|
class='item1'
|
|
>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">hcap.file.<b><a href="../symbols/hcap.file.html#.downloadFileToUsb">downloadFileToUsb</a></b>(param)
|
|
</div>
|
|
<div class="description">Downloads the file given by uri to the path in the USB storage.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr
|
|
class='item2'
|
|
>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">hcap.file.<b><a href="../symbols/hcap.file.html#.getUsbStorageFileList">getUsbStorageFileList</a></b>(param)
|
|
</div>
|
|
<div class="description">Gets the file list for the given path in a USB storage.</div>
|
|
</td>
|
|
</tr>
|
|
|
|
<tr
|
|
class='item3'
|
|
>
|
|
<td class="attributes"><static> </td>
|
|
<td class="nameDescription">
|
|
<div class="fixedFont">hcap.file.<b><a href="../symbols/hcap.file.html#.getUsbStorageList">getUsbStorageList</a></b>(param)
|
|
</div>
|
|
<div class="description">Gets the USB storage list.</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.file</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=".deleteUsbFile">
|
|
<span class='lighter'>
|
|
<static>
|
|
</span>
|
|
|
|
|
|
|
|
<span class="light">hcap.file.</span><b>deleteUsbFile</b>(param)
|
|
</div>
|
|
|
|
<div class="description">
|
|
Deletes the file or directory given by the path in the USB storage.<br>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<pre class="code prettyprint">hcap.file.deleteUsbFile({
|
|
"path" : "/tmp/usb/sda/sda1/download/a.mp4", // or a directory "/tmp/usb/sda/sda1/download"
|
|
"onSuccess" : function() {
|
|
console.log("onSuccess");
|
|
},
|
|
"onFailure" : function(f) {
|
|
console.log("onFailure : errorMessage = " + f.errorMessage);
|
|
}
|
|
});</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>param</b>
|
|
|
|
</dt>
|
|
<dd><ul>
|
|
<li>{String} param.path [Required] - file path or directory path to delete in the USB storage. Only the file path or the directory path under a USB mount point path (except the root directory of a USB mount point path as a directory path) are allowed. The designated path will be deleted without any warning. (It is same as "rm -rf") And if the path doesn't exist, the success callback will be returned.</li>
|
|
<li>{Function} param.onSuccess [Optional] - success callback function.
|
|
<pre class="code prettyprint">
|
|
param.onSuccess = function (param) {
|
|
// No Parameter.
|
|
}</pre>
|
|
</li>
|
|
<li>{Function} param.onFailure [Optional] - failure callback function.
|
|
<pre class="code prettyprint">
|
|
param.onFailure = function (param) {
|
|
// {String} param.errorMessage - in case of failure, this message provides the details.
|
|
}</pre>
|
|
</li>
|
|
</ul></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
<dl class="detailList nomargin">
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Since:</dt>
|
|
<dd>1.18.3</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">See:</dt>
|
|
|
|
<dd><a href="hcap.file.html#.getUsbStorageList">hcap.file.getUsbStorageList()</a><br>
|
|
<a href="hcap.file.html#.getUsbStorageFileList">hcap.file.getUsbStorageFileList()</a><br>
|
|
<a href="hcap.file.html#.downloadFileToUsb">hcap.file.downloadFileToUsb()</a><br>
|
|
<a href="_global_.html#event:usb_file_downloaded">{Event} usb_file_downloaded</a><br></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dl>
|
|
|
|
<div class="hr"></div>
|
|
</li>
|
|
|
|
<li
|
|
class='item1'
|
|
>
|
|
<div class="fixedFont heading" id=".downloadFileToUsb">
|
|
<span class='lighter'>
|
|
<static>
|
|
</span>
|
|
|
|
|
|
|
|
<span class="light">hcap.file.</span><b>downloadFileToUsb</b>(param)
|
|
</div>
|
|
|
|
<div class="description">
|
|
Downloads the file given by uri to the path in the USB storage.<br>
|
|
|
|
The result for the download can be obtained by registering the
|
|
<a href="_global_.html#event:usb_file_downloaded">{Event} usb_file_downloaded</a><br><br>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<pre class="code prettyprint">hcap.file.downloadFileToUsb({
|
|
"uri" : "http://mycompany.com/resource/a.mp3",
|
|
"path" : "/tmp/usb/sda/sda1/download/b.mp3",
|
|
"onSuccess" : function() {
|
|
console.log("onSuccess");
|
|
},
|
|
"onFailure" : function(f) {
|
|
console.log("onFailure : errorMessage = " + f.errorMessage);
|
|
}
|
|
});</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>param</b>
|
|
|
|
</dt>
|
|
<dd><ul>
|
|
<li>{String} param.uri [Required] - URI for the file to download to the USB storage. Only "http" and "https" are allowed.</li>
|
|
<li>{String} param.path [Required] - file path to download the file of uri. The file path should be equal to or lower than a USB mount point path. And if the directory doesn't exist, it will be created automatically.</li>
|
|
<li>{Function} param.onSuccess [Optional] - success callback function.
|
|
<pre class="code prettyprint">
|
|
param.onSuccess = function (param) {
|
|
// No Parameter.
|
|
}</pre>
|
|
</li>
|
|
<li>{Function} param.onFailure [Optional] - failure callback function.
|
|
<pre class="code prettyprint">
|
|
param.onFailure = function (param) {
|
|
// {String} param.errorMessage - in case of failure, this message provides the details.
|
|
}</pre>
|
|
</li>
|
|
</ul></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
<dl class="detailList nomargin">
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Since:</dt>
|
|
<dd>1.18.3</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">See:</dt>
|
|
|
|
<dd><a href="hcap.file.html#.getUsbStorageList">hcap.file.getUsbStorageList()</a><br>
|
|
<a href="hcap.file.html#.getUsbStorageFileList">hcap.file.getUsbStorageFileList()</a><br>
|
|
<a href="hcap.file.html#.deleteUsbFile">hcap.file.deleteUsbFile()</a><br>
|
|
<a href="_global_.html#event:usb_file_downloaded">{Event} usb_file_downloaded</a><br></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dl>
|
|
|
|
<div class="hr"></div>
|
|
</li>
|
|
|
|
<li
|
|
class='item2'
|
|
>
|
|
<div class="fixedFont heading" id=".getUsbStorageFileList">
|
|
<span class='lighter'>
|
|
<static>
|
|
</span>
|
|
|
|
|
|
|
|
<span class="light">hcap.file.</span><b>getUsbStorageFileList</b>(param)
|
|
</div>
|
|
|
|
<div class="description">
|
|
Gets the file list for the given path in a USB storage.<br>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<pre class="code prettyprint">hcap.file.getUsbStorageList({
|
|
"onSuccess" : function(s) {
|
|
hcap.file.getUsbStorageFileList({
|
|
"path" : s[0].mountPoint,
|
|
"onSuccess" : function (param) {
|
|
console.log("file list length = " + param.list.length);
|
|
for (var i = 0; i < param.list.length; i++) {
|
|
console.log(
|
|
"[" + i + "].name = " + param.list[i].name +
|
|
"[" + i + "].type = " + param.list[i].type +
|
|
"[" + i + "].length = " + param.list[i].length
|
|
);
|
|
}
|
|
},
|
|
"onFailure" : function(ff) {
|
|
console.log("onFailure : errorMessage = " + ff.errorMessage);
|
|
}
|
|
});
|
|
},
|
|
"onFailure" : function(f) {
|
|
console.log("onFailure : errorMessage = " + f.errorMessage);
|
|
}
|
|
});</pre>
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">Parameters:</dt>
|
|
|
|
<dt>
|
|
<span class="light fixedFont">{Object}</span> <b>param</b>
|
|
|
|
</dt>
|
|
<dd><ul>
|
|
<li>{String} param.path [Required] - directory path to get file list. Only the directory equal to or lower than a USB mount point path is allowed.</li>
|
|
<li>{Number} param.position [Optional] - start position (starts with 0) where starts to make file list in the directory. Default <em>position</em> is 0.</li>
|
|
<li>{Number} param.length [Optional] - at most the <em>length</em> number of files from the <em>position</em> will be listed up. Default <em>length</em> is 100.</li>
|
|
<li>{Function} param.onSuccess [Optional] - success callback function.
|
|
<pre class="code prettyprint">
|
|
param.onSuccess = function (param) {
|
|
// {Array} param.list - file list
|
|
// {String} param.list[].name - file name
|
|
// {String} param.list[].type - file type among "BLK"(block device), "CHR"(character device), "DIR"(directory), "FIFO"(named pipe), "LNK"(symbolic link), "REG"(regular file), "SOCK"(UNIX domain socket) and "UNKNOWN"(unknown)
|
|
// {String} param.list[].length - file length
|
|
}</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.18.1</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">See:</dt>
|
|
|
|
<dd><a href="hcap.file.html#.getUsbStorageList">hcap.file.getUsbStorageList()</a><br>
|
|
<a href="hcap.file.html#.downloadFileToUsb">hcap.file.downloadFileToUsb()</a><br>
|
|
<a href="hcap.file.html#.deleteUsbFile">hcap.file.deleteUsbFile()</a><br>
|
|
<a href="_global_.html#event:usb_file_downloaded">{Event} usb_file_downloaded</a><br></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
</dl>
|
|
|
|
<div class="hr"></div>
|
|
</li>
|
|
|
|
<li
|
|
class='item3'
|
|
>
|
|
<div class="fixedFont heading" id=".getUsbStorageList">
|
|
<span class='lighter'>
|
|
<static>
|
|
</span>
|
|
|
|
|
|
|
|
<span class="light">hcap.file.</span><b>getUsbStorageList</b>(param)
|
|
</div>
|
|
|
|
<div class="description">
|
|
Gets the USB storage list.<br>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<pre class="code prettyprint">hcap.file.getUsbStorageList({
|
|
"onSuccess" : function(s) {
|
|
console.log("onSuccess : list length = " + s.list.length);
|
|
for (var i = 0; i < s.list.length; i++) {
|
|
console.log(
|
|
"[" + i + "].name = " + s.list[i].name +
|
|
"[" + i + "].displayName = " + s.list[i].displayName +
|
|
"[" + i + "].mountPoint = " + s.list[i].mountPoint +
|
|
"[" + i + "].status = " + s.list[i].status +
|
|
"[" + i + "].filesystemStatus = " + s.list[i].filesystemStatus +
|
|
"[" + i + "].totalSize = " + s.list[i].totalSize +
|
|
"[" + i + "].freeSize = " + s.list[i].freeSize
|
|
);
|
|
}
|
|
},
|
|
"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 USB storage devices connected to TV.
|
|
// {String} param.list[].name - unique device name within the system
|
|
// {String} param.list[].displayName - display name
|
|
// {String} param.list[].mountPoint - mount point path
|
|
// {String} param.list[].status - status among "INIT"(device is initializing), "AVAILABLE"(device is available), "BUSY"(device is unavailable for a while because device is busy in the other work) and "OFFLINE"(device is physically connected but is unavailable)
|
|
// {String} param.list[].filesystemStatus - filesystem status among "READ_ONLY" and "READ_WRITE"
|
|
// {String} param.list[].totalSize - total size in bytes
|
|
// {String} param.list[].freeSize - free size in bytes
|
|
}</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.18.1</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl class="detailList params">
|
|
<dt class="heading">See:</dt>
|
|
|
|
<dd><a href="hcap.file.html#.getUsbStorageFileList">hcap.file.getUsbStorageFileList()</a><br>
|
|
<a href="hcap.file.html#.downloadFileToUsb">hcap.file.downloadFileToUsb()</a><br>
|
|
<a href="hcap.file.html#.deleteUsbFile">hcap.file.deleteUsbFile()</a><br>
|
|
<a href="_global_.html#event:usb_file_downloaded">{Event} usb_file_downloaded</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>
|
|
|