cordova-plugin-pdf417

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  <html lang="en"> <head>  <title>Recognizer (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"> var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10}; var tabs = {65535:["t0","All Methods"],1:["t1","Static 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>  <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/directApi/DirectApiErrorListener.html" title="interface in com.microblink.directApi"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../com/microblink/directApi/Recognizer.State.html" title="enum in com.microblink.directApi"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?com/microblink/directApi/Recognizer.html" target="_top">Frames</a></li> <li><a href="Recognizer.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested.class.summary">Nested</a> | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.top">  </a></div>   <div class="header"> <div class="subTitle">com.microblink.directApi</div> <h2 title="Class Recognizer" class="title">Class Recognizer</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>com.microblink.directApi.Recognizer</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public class <span class="typeNameLabel">Recognizer</span> extends java.lang.Object</pre> <div class="block">DirectAPI Recognizer singleton that can be used to perform recognition of Bitmaps and Images.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList">  <ul class="blockList"> <li class="blockList"><a name="nested.class.summary">  </a> <h3>Nested Class Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Class and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static class </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/directApi/Recognizer.State.html" title="enum in com.microblink.directApi">Recognizer.State</a></span></code> </td> </tr> </table> </li> </ul>  <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="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/Recognizer.html#cancel--">cancel</a></span>()</code> <div class="block">If there is ongoing recognition process, this method will request cancellation of it and wait for recognition process to complete.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="../../../com/microblink/directApi/Recognizer.State.html" title="enum in com.microblink.directApi">Recognizer.State</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/directApi/Recognizer.html#getCurrentState--">getCurrentState</a></span>()</code> <div class="block">Returns the current state of the recognizer.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>static <a href="../../../com/microblink/directApi/Recognizer.html" title="class in com.microblink.directApi">Recognizer</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/directApi/Recognizer.html#getSingletonInstance--">getSingletonInstance</a></span>()</code> <div class="block">Returns the recognizer singleton.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/directApi/Recognizer.html#initialize-android.content.Context-com.microblink.recognizers.settings.RecognitionSettings-com.microblink.directApi.DirectApiErrorListener-">initialize</a></span>(android.content.Context context, <a href="../../../com/microblink/recognizers/settings/RecognitionSettings.html" title="class in com.microblink.recognizers.settings">RecognitionSettings</a> recognitionSettings, <a href="../../../com/microblink/directApi/DirectApiErrorListener.html" title="interface in com.microblink.directApi">DirectApiErrorListener</a> errorListener)</code> <div class="block">Initialize native library for recognition and returns true if initialization has been performed.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/directApi/Recognizer.html#recognizeBitmap-android.graphics.Bitmap-com.microblink.hardware.orientation.Orientation-com.microblink.geometry.Rectangle-com.microblink.view.recognition.ScanResultListener-">recognizeBitmap</a></span>(android.graphics.Bitmap 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> scanRegion, <a href="../../../com/microblink/view/recognition/ScanResultListener.html" title="interface in com.microblink.view.recognition">ScanResultListener</a> resultListener)</code> <div class="block">Perform recognition of image represented as Android Bitmap.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/directApi/Recognizer.html#recognizeBitmap-android.graphics.Bitmap-com.microblink.hardware.orientation.Orientation-com.microblink.view.recognition.ScanResultListener-">recognizeBitmap</a></span>(android.graphics.Bitmap image, <a href="../../../com/microblink/hardware/orientation/Orientation.html" title="enum in com.microblink.hardware.orientation">Orientation</a> imageOrientation, <a href="../../../com/microblink/view/recognition/ScanResultListener.html" title="interface in com.microblink.view.recognition">ScanResultListener</a> resultListener)</code> <div class="block">Perform recognition of image represented as Android Bitmap.</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/directApi/Recognizer.html#recognizeBitmapWithSettings-android.graphics.Bitmap-com.microblink.hardware.orientation.Orientation-com.microblink.geometry.Rectangle-com.microblink.view.recognition.ScanResultListener-com.microblink.recognizers.settings.RecognitionSettings-">recognizeBitmapWithSettings</a></span>(android.graphics.Bitmap 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> scanRegion, <a href="../../../com/microblink/view/recognition/ScanResultListener.html" title="interface in com.microblink.view.recognition">ScanResultListener</a> resultListener, <a href="../../../com/microblink/recognizers/settings/RecognitionSettings.html" title="class in com.microblink.recognizers.settings">RecognitionSettings</a> recognitionSettings)</code> <div class="block">Perform recognition of image represented as Android Bitmap.</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/directApi/Recognizer.html#recognizeBitmapWithSettings-android.graphics.Bitmap-com.microblink.hardware.orientation.Orientation-com.microblink.view.recognition.ScanResultListener-com.microblink.recognizers.settings.RecognitionSettings-">recognizeBitmapWithSettings</a></span>(android.graphics.Bitmap image, <a href="../../../com/microblink/hardware/orientation/Orientation.html" title="enum in com.microblink.hardware.orientation">Orientation</a> imageOrientation, <a href="../../../com/microblink/view/recognition/ScanResultListener.html" title="interface in com.microblink.view.recognition">ScanResultListener</a> resultListener, <a href="../../../com/microblink/recognizers/settings/RecognitionSettings.html" title="class in com.microblink.recognizers.settings">RecognitionSettings</a> recognitionSettings)</code> <div class="block">Perform recognition of image represented as Android Bitmap.</div> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/directApi/Recognizer.html#recognizeImage-com.microblink.image.Image-com.microblink.view.recognition.ScanResultListener-">recognizeImage</a></span>(<a href="../../../com/microblink/image/Image.html" title="class in com.microblink.image">Image</a> image, <a href="../../../com/microblink/view/recognition/ScanResultListener.html" title="interface in com.microblink.view.recognition">ScanResultListener</a> resultListener)</code> <div class="block">Use this method to directly recognize Image object obtained via MetadataListener while recognizer is active.</div> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/directApi/Recognizer.html#recognizeImageWithSettings-com.microblink.image.Image-com.microblink.view.recognition.ScanResultListener-com.microblink.recognizers.settings.RecognitionSettings-">recognizeImageWithSettings</a></span>(<a href="../../../com/microblink/image/Image.html" title="class in com.microblink.image">Image</a> image, <a href="../../../com/microblink/view/recognition/ScanResultListener.html" title="interface in com.microblink.view.recognition">ScanResultListener</a> resultListener, <a href="../../../com/microblink/recognizers/settings/RecognitionSettings.html" title="class in com.microblink.recognizers.settings">RecognitionSettings</a> recognitionSettings)</code> <div class="block">Use this method to directly recognize Image object obtained via MetadataListener while recognizer is active.</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/Recognizer.html#setLicenseKey-android.content.Context-java.lang.String-">setLicenseKey</a></span>(android.content.Context context, java.lang.String licenseKey)</code> <div class="block">Sets the license key required for unlocking the library.</div> </td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/directApi/Recognizer.html#setLicenseKey-java.lang.String-java.lang.String-">setLicenseKey</a></span>(java.lang.String licenseKey, java.lang.String licensee)</code> <div class="block">Sets the license key required for unlocking the library.</div> </td> </tr> <tr id="i12" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/directApi/Recognizer.html#setMetadataListener-com.microblink.metadata.MetadataListener-com.microblink.metadata.MetadataSettings-">setMetadataListener</a></span>(<a href="../../../com/microblink/metadata/MetadataListener.html" title="interface in com.microblink.metadata">MetadataListener</a> metadataListener, <a href="../../../com/microblink/metadata/MetadataSettings.html" title="class in com.microblink.metadata">MetadataSettings</a> metadataSettings)</code> <div class="block">Sets the listener that will obtain metadata that is being processed.</div> </td> </tr> <tr id="i13" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/microblink/directApi/Recognizer.html#terminate--">terminate</a></span>()</code> <div class="block">Terminates the native library.</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">  <ul class="blockList"> <li class="blockList"><a name="method.detail">  </a> <h3>Method Detail</h3> <a name="getSingletonInstance--">  </a> <ul class="blockList"> <li class="blockList"> <h4>getSingletonInstance</h4> <pre>public static <a href="../../../com/microblink/directApi/Recognizer.html" title="class in com.microblink.directApi">Recognizer</a> getSingletonInstance() throws FeatureNotSupportedException</pre> <div class="block">Returns the recognizer singleton.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the recognizer singleton.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>FeatureNotSupportedException</code></dd> </dl> </li> </ul> <a name="getCurrentState--">  </a> <ul class="blockList"> <li class="blockList"> <h4>getCurrentState</h4> <pre>public final <a href="../../../com/microblink/directApi/Recognizer.State.html" title="enum in com.microblink.directApi">Recognizer.State</a> getCurrentState()</pre> <div class="block">Returns the current state of the recognizer.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the current state of the recognizer.</dd> </dl> </li> </ul> <a name="setLicenseKey-android.content.Context-java.lang.String-">  </a> <ul class="blockList"> <li class="blockList"> <h4>setLicenseKey</h4> <pre>public final void setLicenseKey(@NonNull android.content.Context context, @NonNull java.lang.String licenseKey) throws <a href="../../../com/microblink/recognition/InvalidLicenceKeyException.html" title="class in com.microblink.recognition">InvalidLicenceKeyException</a></pre> <div class="block">Sets the license key required for unlocking the library.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>context</code> - Application context used for license checking.</dd> <dd><code>licenseKey</code> - License key.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.IllegalStateException</code> - if recognizer is not in offline state (use getCurrentState method to obtain the state)</dd> <dd><code><a href="../../../com/microblink/recognition/InvalidLicenceKeyException.html" title="class in com.microblink.recognition">InvalidLicenceKeyException</a></code> - if licence key is invalid</dd> </dl> </li> </ul> <a name="setLicenseKey-java.lang.String-java.lang.String-">  </a> <ul class="blockList"> <li class="blockList"> <h4>setLicenseKey</h4> <pre>public final void setLicenseKey(@NonNull java.lang.String licenseKey, @NonNull java.lang.String licensee) throws <a href="../../../com/microblink/recognition/InvalidLicenceKeyException.html" title="class in com.microblink.recognition">InvalidLicenceKeyException</a></pre> <div class="block">Sets the license key required for unlocking the library. Use this method when having license key that allows usage of library in multiple different applications (i.e. license key not bound to application's package name).</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>licenseKey</code> - License key.</dd> <dd><code>licensee</code> - Licensee to which license key is bound.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.IllegalStateException</code> - if recognizer is not in offline state (use getCurrentState method to obtain the state)</dd> <dd><code><a href="../../../com/microblink/recognition/InvalidLicenceKeyException.html" title="class in com.microblink.recognition">InvalidLicenceKeyException</a></code> - if licence key is invalid</dd> </dl> </li> </ul> <a name="initialize-android.content.Context-com.microblink.recognizers.settings.RecognitionSettings-com.microblink.directApi.DirectApiErrorListener-">  </a> <ul class="blockList"> <li class="blockList"> <h4>initialize</h4> <pre>public final void initialize(@NonNull android.content.Context context, @NonNull <a href="../../../com/microblink/recognizers/settings/RecognitionSettings.html" title="class in com.microblink.recognizers.settings">RecognitionSettings</a> recognitionSettings, @NonNull <a href="../../../com/microblink/directApi/DirectApiErrorListener.html" title="interface in com.microblink.directApi">DirectApiErrorListener</a> errorListener)</pre> <div class="block">Initialize native library for recognition and returns true if initialization has been performed. <p/> Please note that native library is singleton, i.e. it is used from both this DirectAPI recognizer and RecognizerView. So if both RecognizerView and DirectAPI try to initialize the native library at the same time, the following will happen: - if first initialized from RecognizerView, this method will return false, indicating failure to initialize DirectAPI - if first initialized from here, method will return true, HOWEVER if after that native library is initialized again from RecognizerView, **RecognizerView's settings will be applied**, in that case calling recognize method will use RecognizerView's settings - to prevent that, you must use recognizeWithSettings method All in all, RecognizerView's settings always have priority over DirectAPI's settings.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>context</code> - Application context used for loading required resources.</dd> <dd><code>recognitionSettings</code> - Recognition settings defining a recognition process.</dd> <dd><code>errorListener</code> - Listener that will be notified of any error in native library in background thread.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.IllegalStateException</code> - if recognizer is already initialized</dd> <dd><code>java.lang.NullPointerException</code> - if context, settings array or errorListener is null</dd> </dl> </li> </ul> <a name="recognizeBitmap-android.graphics.Bitmap-com.microblink.hardware.orientation.Orientation-com.microblink.view.recognition.ScanResultListener-">  </a> <ul class="blockList"> <li class="blockList"> <h4>recognizeBitmap</h4> <pre>public final void recognizeBitmap(@NonNull android.graphics.Bitmap image, @NonNull <a href="../../../com/microblink/hardware/orientation/Orientation.html" title="enum in com.microblink.hardware.orientation">Orientation</a> imageOrientation, @NonNull <a href="../../../com/microblink/view/recognition/ScanResultListener.html" title="interface in com.microblink.view.recognition">ScanResultListener</a> resultListener)</pre> <div class="block">Perform recognition of image represented as Android Bitmap.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>image</code> - Image that needs to be recognized.</dd> <dd><code>imageOrientation</code> - Orientation of the bitmap image.</dd> <dd><code>resultListener</code> - Result listener that will handle recognition done event.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.IllegalStateException</code> - if recognizer is not initialized or is currently working</dd> <dd><code>java.lang.NullPointerException</code> - if given null scan result listener</dd> </dl> </li> </ul> <a name="recognizeBitmap-android.graphics.Bitmap-com.microblink.hardware.orientation.Orientation-com.microblink.geometry.Rectangle-com.microblink.view.recognition.ScanResultListener-">  </a> <ul class="blockList"> <li class="blockList"> <h4>recognizeBitmap</h4> <pre>public final void recognizeBitmap(@NonNull android.graphics.Bitmap image, @NonNull <a href="../../../com/microblink/hardware/orientation/Orientation.html" title="enum in com.microblink.hardware.orientation">Orientation</a> imageOrientation, @NonNull <a href="../../../com/microblink/geometry/Rectangle.html" title="class in com.microblink.geometry">Rectangle</a> scanRegion, @NonNull <a href="../../../com/microblink/view/recognition/ScanResultListener.html" title="interface in com.microblink.view.recognition">ScanResultListener</a> resultListener)</pre> <div class="block">Perform recognition of image represented as Android Bitmap.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>image</code> - Image that needs to be recognized.</dd> <dd><code>imageOrientation</code> - Orientation of the bitmap image.</dd> <dd><code>scanRegion</code> - Region of image that needs to be recognized. Rectangle is given as percentages of image size - x coordinate and width are percentages of image width and y coordinate and height are percentages of image height. Therefore, rectangle(0.f, 0.f, 1.f, 1.f) represents the whole image, whilst rectangle(0.5f, 0.f, 0.5f, 1.f) represents the right half of the image.</dd> <dd><code>resultListener</code> - Result listener that will handle recognition done event.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.IllegalStateException</code> - if recognizer is not initialized or is currently working</dd> <dd><code>java.lang.NullPointerException</code> - if given null scan result listener</dd> </dl> </li> </ul> <a name="recognizeBitmapWithSettings-android.graphics.Bitmap-com.microblink.hardware.orientation.Orientation-com.microblink.view.recognition.ScanResultListener-com.microblink.recognizers.settings.RecognitionSettings-">  </a> <ul class="blockList"> <li class="blockList"> <h4>recognizeBitmapWithSettings</h4> <pre>public final void recognizeBitmapWithSettings(@NonNull android.graphics.Bitmap image, @NonNull <a href="../../../com/microblink/hardware/orientation/Orientation.html" title="enum in com.microblink.hardware.orientation">Orientation</a> imageOrientation, @NonNull <a href="../../../com/microblink/view/recognition/ScanResultListener.html" title="interface in com.microblink.view.recognition">ScanResultListener</a> resultListener, <a href="../../../com/microblink/recognizers/settings/RecognitionSettings.html" title="class in com.microblink.recognizers.settings">RecognitionSettings</a> recognitionSettings)</pre> <div class="block">Perform recognition of image represented as Android Bitmap. <p/> Unlike method recognize, this method will apply given settings for recognition of current image. This may be much slower than using method recognize, but it is the only option if RecognizerView was initialized after this Recognizer.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>image</code> - Image that needs to be recognized.</dd> <dd><code>imageOrientation</code> - Orientation of the bitmap image.</dd> <dd><code>resultListener</code> - Result listener that will handle recognition done event.</dd> <dd><code>recognitionSettings</code> - Recognition settings that will be used to perform this recognition.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.IllegalStateException</code> - if recognizer is not initialized or is currently working</dd> <dd><code>java.lang.NullPointerException</code> - if given null scan result listener</dd> </dl> </li> </ul> <a name="recognizeBitmapWithSettings-android.graphics.Bitmap-com.microblink.hardware.orientation.Orientation-com.microblink.geometry.Rectangle-com.microblink.view.recognition.ScanResultListener-com.microblink.recognizers.settings.RecognitionSettings-">  </a> <ul class="blockList"> <li class="blockList"> <h4>recognizeBitmapWithSettings</h4> <pre>public final void recognizeBitmapWithSettings(@NonNull android.graphics.Bitmap image, @NonNull <a href="../../../com/microblink/hardware/orientation/Orientation.html" title="enum in com.microblink.hardware.orientation">Orientation</a> imageOrientation, @NonNull <a href="../../../com/microblink/geometry/Rectangle.html" title="class in com.microblink.geometry">Rectangle</a> scanRegion, @NonNull <a href="../../../com/microblink/view/recognition/ScanResultListener.html" title="interface in com.microblink.view.recognition">ScanResultListener</a> resultListener, <a href="../../../com/microblink/recognizers/settings/RecognitionSettings.html" title="class in com.microblink.recognizers.settings">RecognitionSettings</a> recognitionSettings)</pre> <div class="block">Perform recognition of image represented as Android Bitmap. <p/> Unlike method recognize, this method will apply given settings for recognition of current image. This may be much slower than using method recognize, but it is the only option if RecognizerView was initialized after this Recognizer.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>image</code> - Image that needs to be recognized.</dd> <dd><code>imageOrientation</code> - Orientation of the bitmap image.</dd> <dd><code>scanRegion</code> - Region of image that needs to be recognized. Rectangle is given as percentages of image size - x coordinate and width are percentages of image width and y coordinate and height are percentages of image height. Therefore, rectangle(0.f, 0.f, 1.f, 1.f) represents the whole image, whilst rectangle(0.5f, 0.f, 0.5f, 1.f) represents the right half of the image.</dd> <dd><code>resultListener</code> - Result listener that will handle recognition done event.</dd> <dd><code>recognitionSettings</code> - Recognition settings that will be used to perform this recognition.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.IllegalStateException</code> - if recognizer is not initialized or is currently working</dd> <dd><code>java.lang.NullPointerException</code> - if given null scan result listener</dd> </dl> </li> </ul> <a name="recognizeImage-com.microblink.image.Image-com.microblink.view.recognition.ScanResultListener-">  </a> <ul class="blockList"> <li class="blockList"> <h4>recognizeImage</h4> <pre>@UiThread public final void recognizeImage(@NonNull <a href="../../../com/microblink/image/Image.html" title="class in com.microblink.image">Image</a> image, @NonNull <a href="../../../com/microblink/view/recognition/ScanResultListener.html" title="interface in com.microblink.view.recognition">ScanResultListener</a> resultListener)</pre> <div class="block">Use this method to directly recognize Image object obtained via MetadataListener while recognizer is active. Recognition will be performed with same settings that were used for initialization of recognizer singleton. Please note that Image object will be disposed as soon as onMetadataAvailable method ends. You must clone the Image object by calling its clone() method to ensure Image lives long enough to be processed.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>image</code> - Image to be processed (usually obtained from ImageListener)</dd> <dd><code>resultListener</code> - Listener that will be invoked with recognition result.</dd> </dl> </li> </ul> <a name="recognizeImageWithSettings-com.microblink.image.Image-com.microblink.view.recognition.ScanResultListener-com.microblink.recognizers.settings.RecognitionSettings-">  </a> <ul class="blockList"> <li class="blockList"> <h4>recognizeImageWithSettings</h4> <pre>@UiThread public final void recognizeImageWithSettings(@NonNull <a href="../../../com/microblink/image/Image.html" title="class in com.microblink.image">Image</a> image, @NonNull <a href="../../../com/microblink/view/recognition/ScanResultListener.html" title="interface in com.microblink.view.recognition">ScanResultListener</a> resultListener, <a href="../../../com/microblink/recognizers/settings/RecognitionSettings.html" title="class in com.microblink.recognizers.settings">RecognitionSettings</a> recognitionSettings)</pre> <div class="block">Use this method to directly recognize Image object obtained via MetadataListener while recognizer is active. Please note that Image object will be disposed as soon as onMetadataAvailable method ends. You must clone the Image object by calling its clone() method to ensure Image lives long enough to be processed. Recognition will be performed with given recognition settings. If error happens due to illegal settings, onError will be invoked of the DirectApiErrorListener that was set in initialize method.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>image</code> - Image to be processed (usually obtained from MetadataListener).</dd> <dd><code>resultListener</code> - Listener that will be invoked with recognition result.</dd> <dd><code>recognitionSettings</code> - Recognition settings that will be used to perform this recognition.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.IllegalStateException</code> - if recognizer is not initialized or is currently working or Image object is already disposed</dd> <dd><code>java.lang.NullPointerException</code> - if given null scan result listener</dd> </dl> </li> </ul> <a name="cancel--">  </a> <ul class="blockList"> <li class="blockList"> <h4>cancel</h4> <pre>public void cancel()</pre> <div class="block">If there is ongoing recognition process, this method will request cancellation of it and wait for recognition process to complete. It is not defined whether <a href="../../../com/microblink/view/recognition/ScanResultListener.html" title="interface in com.microblink.view.recognition"><code>ScanResultListener</code></a> given to last recognition requiest will be called with result or not - in some cases it could happen, in some it would not.</div> </li> </ul> <a name="terminate--">  </a> <ul class="blockList"> <li class="blockList"> <h4>terminate</h4> <pre>public void terminate()</pre> <div class="block">Terminates the native library.</div> </li> </ul> <a name="setMetadataListener-com.microblink.metadata.MetadataListener-com.microblink.metadata.MetadataSettings-">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>setMetadataListener</h4> <pre>public void setMetadataListener(<a href="../../../com/microblink/metadata/MetadataListener.html" title="interface in com.microblink.metadata">MetadataListener</a> metadataListener, <a href="../../../com/microblink/metadata/MetadataSettings.html" title="class in com.microblink.metadata">MetadataSettings</a> metadataSettings)</pre> <div class="block">Sets the listener that will obtain metadata that is being processed.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>metadataListener</code> - metadata listener that will be notified about available metadata</dd> <dd><code>metadataSettings</code> - settings defining which metadata should be reported to metadata listener</dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div>   <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/directApi/DirectApiErrorListener.html" title="interface in com.microblink.directApi"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../com/microblink/directApi/Recognizer.State.html" title="enum in com.microblink.directApi"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?com/microblink/directApi/Recognizer.html" target="_top">Frames</a></li> <li><a href="Recognizer.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"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested.class.summary">Nested</a> | </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li>Constr | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom">  </a></div>  </body> </html>