cordova-plugin-pdf417
Version:
A small and powerful PDF417 barcode scanning library
559 lines (558 loc) • 21 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>BitmapCameraFrame (LibPdf417Mobi API)</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BitmapCameraFrame (LibPdf417Mobi API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/microblink/directApi/frame/BitmapCameraFrame.html" target="_top">Frames</a></li>
<li><a href="BitmapCameraFrame.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.microblink.directApi.frame</div>
<h2 title="Class BitmapCameraFrame" class="title">Class BitmapCameraFrame</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.microblink.directApi.frame.BitmapCameraFrame</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">BitmapCameraFrame</span>
extends java.lang.Object</pre>
<div class="block">Created by dodo on 29/07/15.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#BitmapCameraFrame-android.graphics.Bitmap-long-">BitmapCameraFrame</a></span>(android.graphics.Bitmap bitmap,
long id)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#finalizePoolObject--">finalizePoolObject</a></span>()</code>
<div class="block">Finalization method.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>CameraDataFormat</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#getFormat--">getFormat</a></span>()</code>
<div class="block">returns the format of the frame</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#getFrameID--">getFrameID</a></span>()</code>
<div class="block">Returns the unique frame identifier</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#getFrameQuality--">getFrameQuality</a></span>()</code>
<div class="block">Returns the quality of the current frame.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#getHeight--">getHeight</a></span>()</code>
<div class="block">returns the height of the frame</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#getNativeCameraFrame--">getNativeCameraFrame</a></span>()</code>
<div class="block">Accessed from native code to obtain pointer to implementation of native camera frame</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../../com/microblink/hardware/orientation/Orientation.html" title="enum in com.microblink.hardware.orientation">Orientation</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#getOrientation--">getOrientation</a></span>()</code>
<div class="block">Returns the orientation of the current frame.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../../com/microblink/geometry/Rectangle.html" title="class in com.microblink.geometry">Rectangle</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#getVisiblePart--">getVisiblePart</a></span>()</code>
<div class="block">returns the region that defines the visible part of frame</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#getWidth--">getWidth</a></span>()</code>
<div class="block">returns the width of the frame</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#initializeNativePart-long-">initializeNativePart</a></span>(long frameAnalyzersPtr)</code>
<div class="block">Initializes native part of camera frame implementation.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#initializePoolObject--">initializePoolObject</a></span>()</code>
<div class="block">Initialization method.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#isDeviceMoving--">isDeviceMoving</a></span>()</code>
<div class="block">returns true if device was moving while frame was created</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#isFocused--">isFocused</a></span>()</code>
<div class="block">returns true if camera thinks this frame is focused</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#isPhoto--">isPhoto</a></span>()</code>
<div class="block">Returns true if frame is photograph</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#recycle--">recycle</a></span>()</code>
<div class="block">Used for recycling frame buffer back into camera so its buffer can be reused for new camera frame.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#setFrameID-long-">setFrameID</a></span>(long id)</code> </td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#setOrientation-com.microblink.hardware.orientation.Orientation-">setOrientation</a></span>(<a href="../../../../com/microblink/hardware/orientation/Orientation.html" title="enum in com.microblink.hardware.orientation">Orientation</a> orientation)</code>
<div class="block">Sets the orientation of the current frame.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/microblink/directApi/frame/BitmapCameraFrame.html#setVisiblePart-com.microblink.geometry.Rectangle-">setVisiblePart</a></span>(<a href="../../../../com/microblink/geometry/Rectangle.html" title="class in com.microblink.geometry">Rectangle</a> visiblePart)</code>
<div class="block">sets the region that defines the visible part of frame</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="BitmapCameraFrame-android.graphics.Bitmap-long-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BitmapCameraFrame</h4>
<pre>public BitmapCameraFrame(android.graphics.Bitmap bitmap,
long id)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getWidth--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWidth</h4>
<pre>public int getWidth()</pre>
<div class="block">returns the width of the frame</div>
</li>
</ul>
<a name="getHeight--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeight</h4>
<pre>public int getHeight()</pre>
<div class="block">returns the height of the frame</div>
</li>
</ul>
<a name="setVisiblePart-com.microblink.geometry.Rectangle-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVisiblePart</h4>
<pre>public void setVisiblePart(<a href="../../../../com/microblink/geometry/Rectangle.html" title="class in com.microblink.geometry">Rectangle</a> visiblePart)</pre>
<div class="block">sets the region that defines the visible part of frame</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>visiblePart</code> - </dd>
</dl>
</li>
</ul>
<a name="getFormat--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFormat</h4>
<pre>public CameraDataFormat getFormat()</pre>
<div class="block">returns the format of the frame</div>
</li>
</ul>
<a name="isFocused--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFocused</h4>
<pre>public boolean isFocused()</pre>
<div class="block">returns true if camera thinks this frame is focused</div>
</li>
</ul>
<a name="isDeviceMoving--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDeviceMoving</h4>
<pre>public boolean isDeviceMoving()</pre>
<div class="block">returns true if device was moving while frame was created</div>
</li>
</ul>
<a name="getVisiblePart--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVisiblePart</h4>
<pre>public <a href="../../../../com/microblink/geometry/Rectangle.html" title="class in com.microblink.geometry">Rectangle</a> getVisiblePart()</pre>
<div class="block">returns the region that defines the visible part of frame</div>
</li>
</ul>
<a name="recycle--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>recycle</h4>
<pre>public void recycle()</pre>
<div class="block">Used for recycling frame buffer back into camera so its buffer can be reused for new camera frame.
Also, releases all native part if required.</div>
</li>
</ul>
<a name="isPhoto--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isPhoto</h4>
<pre>public boolean isPhoto()</pre>
<div class="block">Returns true if frame is photograph</div>
</li>
</ul>
<a name="initializeNativePart-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initializeNativePart</h4>
<pre>public boolean initializeNativePart(long frameAnalyzersPtr)</pre>
<div class="block">Initializes native part of camera frame implementation. This makes getNativeCameraFrame available.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>frameAnalyzersPtr</code> - Native pointer to class containing all native elements frame needs (frame quality estimator, white balance analyzer etc.)</dd>
</dl>
</li>
</ul>
<a name="getNativeCameraFrame--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNativeCameraFrame</h4>
<pre>public long getNativeCameraFrame()</pre>
<div class="block">Accessed from native code to obtain pointer to implementation of native camera frame</div>
</li>
</ul>
<a name="getFrameQuality--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFrameQuality</h4>
<pre>public double getFrameQuality()</pre>
<div class="block">Returns the quality of the current frame. Negative quality indicates that quality is not and cannot be calculated.</div>
</li>
</ul>
<a name="setOrientation-com.microblink.hardware.orientation.Orientation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOrientation</h4>
<pre>public void setOrientation(<a href="../../../../com/microblink/hardware/orientation/Orientation.html" title="enum in com.microblink.hardware.orientation">Orientation</a> orientation)</pre>
<div class="block">Sets the orientation of the current frame.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>orientation</code> - </dd>
</dl>
</li>
</ul>
<a name="getOrientation--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOrientation</h4>
<pre>public <a href="../../../../com/microblink/hardware/orientation/Orientation.html" title="enum in com.microblink.hardware.orientation">Orientation</a> getOrientation()</pre>
<div class="block">Returns the orientation of the current frame.</div>
</li>
</ul>
<a name="getFrameID--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFrameID</h4>
<pre>public long getFrameID()</pre>
<div class="block">Returns the unique frame identifier</div>
</li>
</ul>
<a name="setFrameID-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFrameID</h4>
<pre>public void setFrameID(long id)</pre>
</li>
</ul>
<a name="initializePoolObject--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>initializePoolObject</h4>
<pre>public void initializePoolObject()</pre>
<div class="block">Initialization method. Called when an object is retrieved
from the object pool or has just been created.</div>
</li>
</ul>
<a name="finalizePoolObject--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>finalizePoolObject</h4>
<pre>public void finalizePoolObject()</pre>
<div class="block">Finalization method. Called when an object is stored in
the object pool to mark it as free.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/microblink/directApi/frame/BitmapCameraFrame.html" target="_top">Frames</a></li>
<li><a href="BitmapCameraFrame.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>