cordova-plugin-pdf417
Version:
A small and powerful PDF417 barcode scanning library
336 lines (335 loc) • 15.4 kB
HTML
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ImageBuilder (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="ImageBuilder (LibPdf417Mobi API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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><a href="../../../com/microblink/image/Image.html" title="class in com.microblink.image"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../com/microblink/image/ImageFormat.html" title="enum in com.microblink.image"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/microblink/image/ImageBuilder.html" target="_top">Frames</a></li>
<li><a href="ImageBuilder.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.image</div>
<h2 title="Class ImageBuilder" class="title">Class ImageBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.microblink.image.ImageBuilder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">ImageBuilder</span>
extends java.lang.Object</pre>
<div class="block">Created by dodo on 10/02/16.</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/image/ImageBuilder.html#ImageBuilder--">ImageBuilder</a></span>()</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static <a href="../../../com/microblink/image/Image.html" title="class in com.microblink.image">Image</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/image/ImageBuilder.html#buildImageFromCamera1NV21Frame-byte:A-int-int-com.microblink.hardware.orientation.Orientation-com.microblink.geometry.Rectangle-">buildImageFromCamera1NV21Frame</a></span>(byte[] imageBuffer,
int imageWidth,
int imageHeight,
<a href="../../../com/microblink/hardware/orientation/Orientation.html" title="enum in com.microblink.hardware.orientation">Orientation</a> imageOrientation,
<a href="../../../com/microblink/geometry/Rectangle.html" title="class in com.microblink.geometry">Rectangle</a> scanningRegion)</code> </td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../com/microblink/image/Image.html" title="class in com.microblink.image">Image</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/image/ImageBuilder.html#buildImageFromCamera2Image-android.media.Image-com.microblink.hardware.orientation.Orientation-com.microblink.geometry.Rectangle-">buildImageFromCamera2Image</a></span>(android.media.Image image,
<a href="../../../com/microblink/hardware/orientation/Orientation.html" title="enum in com.microblink.hardware.orientation">Orientation</a> imageOrientation,
<a href="../../../com/microblink/geometry/Rectangle.html" title="class in com.microblink.geometry">Rectangle</a> scanningRegion)</code>
<div class="block">Builds image object from Camera2 frame in YUV_420_888 format.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../com/microblink/image/Image.html" title="class in com.microblink.image">Image</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/image/ImageBuilder.html#buildImageFromNativeContext-long-">buildImageFromNativeContext</a></span>(long nativeContext)</code>
<div class="block">Builds image object from native context.</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="ImageBuilder--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ImageBuilder</h4>
<pre>public ImageBuilder()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="buildImageFromNativeContext-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildImageFromNativeContext</h4>
<pre>public static <a href="../../../com/microblink/image/Image.html" title="class in com.microblink.image">Image</a> buildImageFromNativeContext(long nativeContext)</pre>
<div class="block">Builds image object from native context. This method is called from native code. Calling it
directly from Java with invalid native context will crash the app.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>nativeContext</code> - Native pointer containing native image object.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../com/microblink/image/Image.html" title="class in com.microblink.image"><code>Image</code></a> object for usage via DirectAPI's <a href="../../../com/microblink/directApi/Recognizer.html" title="class in com.microblink.directApi"><code>Recognizer</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="buildImageFromCamera2Image-android.media.Image-com.microblink.hardware.orientation.Orientation-com.microblink.geometry.Rectangle-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildImageFromCamera2Image</h4>
<pre>public static <a href="../../../com/microblink/image/Image.html" title="class in com.microblink.image">Image</a> buildImageFromCamera2Image(@NonNull
android.media.Image image,
@NonNull
<a href="../../../com/microblink/hardware/orientation/Orientation.html" title="enum in com.microblink.hardware.orientation">Orientation</a> imageOrientation,
@Nullable
<a href="../../../com/microblink/geometry/Rectangle.html" title="class in com.microblink.geometry">Rectangle</a> scanningRegion)</pre>
<div class="block">Builds image object from Camera2 frame in YUV_420_888 format.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>image</code> - <code>Image</code> object that contains image from which MicroBlink <a href="../../../com/microblink/image/Image.html" title="class in com.microblink.image"><code>Image</code></a> will be built. You must ensure that this object is not closed
while returned <a href="../../../com/microblink/image/Image.html" title="class in com.microblink.image"><code>Image</code></a> is in use. Doing so will lead to undefined behaviour.</dd>
<dd><code>imageOrientation</code> - Orientation of the device at the time <code>Image</code> was created. Cannot be null nor <a href="../../../com/microblink/hardware/orientation/Orientation.html#ORIENTATION_UNKNOWN"><code>Orientation.ORIENTATION_UNKNOWN</code></a>.</dd>
<dd><code>scanningRegion</code> - Region of image that will be used for recognition. If null, entire image will be used.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../com/microblink/image/Image.html" title="class in com.microblink.image"><code>Image</code></a> object for usage via DirectAPI's <a href="../../../com/microblink/directApi/Recognizer.html" title="class in com.microblink.directApi"><code>Recognizer</code></a> object.</dd>
</dl>
</li>
</ul>
<a name="buildImageFromCamera1NV21Frame-byte:A-int-int-com.microblink.hardware.orientation.Orientation-com.microblink.geometry.Rectangle-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>buildImageFromCamera1NV21Frame</h4>
<pre>public static <a href="../../../com/microblink/image/Image.html" title="class in com.microblink.image">Image</a> buildImageFromCamera1NV21Frame(@NonNull
byte[] imageBuffer,
int imageWidth,
int imageHeight,
@NonNull
<a href="../../../com/microblink/hardware/orientation/Orientation.html" title="enum in com.microblink.hardware.orientation">Orientation</a> imageOrientation,
@Nullable
<a href="../../../com/microblink/geometry/Rectangle.html" title="class in com.microblink.geometry">Rectangle</a> scanningRegion)</pre>
</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><a href="../../../com/microblink/image/Image.html" title="class in com.microblink.image"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../com/microblink/image/ImageFormat.html" title="enum in com.microblink.image"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/microblink/image/ImageBuilder.html" target="_top">Frames</a></li>
<li><a href="ImageBuilder.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>