Merge pull request #18 from BlinkID/release/v3.3.0

Release/v3.3.0

BlinkIDDemo/build.gradle

@@ -19,7 +19,7 @@ allprojects {
 // versions of libraries that all modules require
 
 project.ext {
-    blinkIdVersion = '3.2.0'
+    blinkIdVersion = '3.3.0'
     compileSdkVersion = 24
     targetSdkVersion = 23
     buildToolsVersion = '25.0.0'

README.md

@@ -146,7 +146,7 @@ After that, you just need to add _BlinkID_ as a dependency to your application (
 
 ```
 dependencies {
-    compile('com.microblink:blinkid:3.2.0@aar') {
+    compile('com.microblink:blinkid:3.3.0@aar') {
     	transitive = true
     }
 }
@@ -167,7 +167,7 @@ Current version of Android Studio will not automatically import javadoc from mav
 
 1. In Android Studio project sidebar, ensure [project view is enabled](https://developer.android.com/sdk/installing/studio-androidview.html)
 2. Expand `External Libraries` entry (usually this is the last entry in project view)
-3. Locate `blinkid-3.2.0` entry, right click on it and select `Library Properties...`
+3. Locate `blinkid-3.3.0` entry, right click on it and select `Library Properties...`
 4. A `Library Properties` pop-up window will appear
 5. Click the second `+` button in bottom left corner of the window (the one that contains `+` with little globe)
 6. Window for definining documentation URL will appear
@@ -192,7 +192,7 @@ Open your `pom.xml` file and add these directives as appropriate:
 	<dependency>
 		  <groupId>com.microblink</groupId>
 		  <artifactId>blinkid</artifactId>
-		  <version>3.2.0</version>
+		  <version>3.3.0</version>
 		  <type>aar</type>
   	</dependency>
 </dependencies>
@@ -208,7 +208,7 @@ Open your `pom.xml` file and add these directives as appropriate:
 	```
 	dependencies {
    		compile project(':LibRecognizer')
- 		compile "com.android.support:appcompat-v7:25.0.0"
+ 		compile "com.android.support:appcompat-v7:25.0.1"
 	}
 	```
 5. If you plan to use ProGuard, add following lines to your `proguard-rules.pro`:
@@ -924,10 +924,6 @@ This method pauses the scanning loop, but keeps both camera and native library i
 ##### <a name="recognizerView_resumeScanning"></a> [`resumeScanning(boolean)`](https://blinkid.github.io/blinkid-android/com/microblink/view/recognition/RecognizerView.html#resumeScanning-boolean-)
 With this method you can resume the paused scanning loop. If called with `true` parameter, implicitly calls `resetRecognitionState()`. If called with `false`, old recognition state will not be reset, so it could be reused for boosting recognition result. This may not be always a desired behaviour.  Pause and resume scanning methods count the number of calls, so if you called `pauseScanning()` twice, you will have to call `resumeScanning` twice to actually resume scanning loop.
 
-
-##### <a name="recognizerView_setInitialScanningPaused"></a> [`setInitialScanningPaused()`](https://blinkid.github.io/blinkid-android/com/microblink/view/recognition/RecognizerView.html#setInitialScanningPaused-boolean-)
-This method lets you set up RecognizerView to not automatically resume scanning first time [resume](#recognizerView_resume) is called. An example use case of when you might want this is if you want to display onboarding help when opening camera first time and want to prevent scanning in background while onboarding is displayed over camera preview.
-
 ##### <a name="recognizerView_resetRecognitionState"></a> [`resetRecognitionState()`](https://blinkid.github.io/blinkid-android/com/microblink/view/recognition/RecognizerView.html#resetRecognitionState--)
 With this method you can reset internal recognition state. State is usually kept to improve recognition quality over time, but without resetting recognition state sometimes you might get poorer results (for example if you scan one object and then another without resetting state you might end up with result that contains properties from both scanned objects).
 

Release notes.md

@@ -1,5 +1,11 @@
 # Release notes
 
+## 3.3.0
+
+- removed `RecognizerView` method `setInitialScanningPaused`. For achieving the same functionality, method `pauseScanning` should be used.
+- added support for scanning IBANs that contain spaces and dashes
+- improved `MRTDRecognizer`: when obtaining of full document images is enabled with `setShowFullDocument` method, recognizer returns result only after the document image has been returned.
+
 ## 3.2.0
 
 - fixed camera management on LG X Cam

builtFromCommit.txt

@@ -1 +1 @@
-Built from commit 87673e92f9a90aff3029bf6e45781fd04c0ba288
+Built from commit efdaa9ba758f7441a069086a46346b357e38c1e8

docs/com/microblink/hardware/camera/package-tree.html

@@ -85,8 +85,8 @@ <h2 title="Enum Hierarchy">Enum Hierarchy</h2>
 <ul>
 <li type="circle">java.lang.Enum&lt;E&gt; (implements java.lang.Comparable&lt;T&gt;, java.io.Serializable)
 <ul>
-<li type="circle">com.microblink.hardware.camera.<a href="../../../../com/microblink/hardware/camera/CameraType.html" title="enum in com.microblink.hardware.camera"><span class="typeNameLink">CameraType</span></a> (implements android.os.Parcelable)</li>
 <li type="circle">com.microblink.hardware.camera.<a href="../../../../com/microblink/hardware/camera/VideoResolutionPreset.html" title="enum in com.microblink.hardware.camera"><span class="typeNameLink">VideoResolutionPreset</span></a> (implements android.os.Parcelable)</li>
+<li type="circle">com.microblink.hardware.camera.<a href="../../../../com/microblink/hardware/camera/CameraType.html" title="enum in com.microblink.hardware.camera"><span class="typeNameLink">CameraType</span></a> (implements android.os.Parcelable)</li>
 </ul>
 </li>
 </ul>

docs/com/microblink/image/package-tree.html

@@ -99,8 +99,8 @@ <h2 title="Enum Hierarchy">Enum Hierarchy</h2>
 <ul>
 <li type="circle">java.lang.Enum&lt;E&gt; (implements java.lang.Comparable&lt;T&gt;, java.io.Serializable)
 <ul>
-<li type="circle">com.microblink.image.<a href="../../../com/microblink/image/ImageType.html" title="enum in com.microblink.image"><span class="typeNameLink">ImageType</span></a></li>
 <li type="circle">com.microblink.image.<a href="../../../com/microblink/image/ImageFormat.html" title="enum in com.microblink.image"><span class="typeNameLink">ImageFormat</span></a></li>
+<li type="circle">com.microblink.image.<a href="../../../com/microblink/image/ImageType.html" title="enum in com.microblink.image"><span class="typeNameLink">ImageType</span></a></li>
 </ul>
 </li>
 </ul>

docs/com/microblink/recognizers/blinkid/documentface/DocumentFaceRecognizerSettings.html

@@ -17,7 +17,7 @@
     catch(err) {
     }
 //-->
-var methods = {"i0":10,"i1":10,"i2":10};
+var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
 var altColor = "altColor";
 var rowColor = "rowColor";
@@ -156,6 +156,18 @@ <h3>Field Summary</h3>
 <td class="colFirst"><code>static android.os.Parcelable.Creator&lt;<a href="../../../../../com/microblink/recognizers/blinkid/documentface/DocumentFaceRecognizerSettings.html" title="class in com.microblink.recognizers.blinkid.documentface">DocumentFaceRecognizerSettings</a>&gt;</code></td>
 <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/microblink/recognizers/blinkid/documentface/DocumentFaceRecognizerSettings.html#CREATOR">CREATOR</a></span></code>&nbsp;</td>
 </tr>
+<tr class="rowColor">
+<td class="colFirst"><code>static java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/microblink/recognizers/blinkid/documentface/DocumentFaceRecognizerSettings.html#FACE_IMAGE_NAME">FACE_IMAGE_NAME</a></span></code>
+<div class="block">Name of the image sent to <a href="../../../../../com/microblink/metadata/MetadataListener.html" title="interface in com.microblink.metadata"><code>MetadataListener</code></a> that contains face.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>static java.lang.String</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/microblink/recognizers/blinkid/documentface/DocumentFaceRecognizerSettings.html#FULL_DOCUMENT_IMAGE">FULL_DOCUMENT_IMAGE</a></span></code>
+<div class="block">Name of the image sent to <a href="../../../../../com/microblink/metadata/MetadataListener.html" title="interface in com.microblink.metadata"><code>MetadataListener</code></a> that contains full document.</div>
+</td>
+</tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a name="fields.inherited.from.class.com.microblink.recognizers.settings.RecognizerSettings">
@@ -216,6 +228,18 @@ <h3>Method Summary</h3>
 </tr>
 <tr id="i2" class="altColor">
 <td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/microblink/recognizers/blinkid/documentface/DocumentFaceRecognizerSettings.html#setShowFullDocument-boolean-">setShowFullDocument</a></span>(boolean&nbsp;showFullDocumentImage)</code>
+<div class="block">Sets whether full document image should be sent to <a href="../../../../../com/microblink/metadata/MetadataListener.html" title="interface in com.microblink.metadata"><code>MetadataListener</code></a>.</div>
+</td>
+</tr>
+<tr id="i3" class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/microblink/recognizers/blinkid/documentface/DocumentFaceRecognizerSettings.html#shouldShowFullDocument--">shouldShowFullDocument</a></span>()</code>
+<div class="block">Returns whether sending of full document image to <a href="../../../../../com/microblink/metadata/MetadataListener.html" title="interface in com.microblink.metadata"><code>MetadataListener</code></a> is enabled.</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/recognizers/blinkid/documentface/DocumentFaceRecognizerSettings.html#writeToParcel-android.os.Parcel-int-">writeToParcel</a></span>(android.os.Parcel&nbsp;dest,
              int&nbsp;flags)</code>&nbsp;</td>
 </tr>
@@ -248,6 +272,41 @@ <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 <!--   -->
 </a>
 <h3>Field Detail</h3>
+<a name="FACE_IMAGE_NAME">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>FACE_IMAGE_NAME</h4>
+<pre>public static final&nbsp;java.lang.String FACE_IMAGE_NAME</pre>
+<div class="block">Name of the image sent to <a href="../../../../../com/microblink/metadata/MetadataListener.html" title="interface in com.microblink.metadata"><code>MetadataListener</code></a> that contains face.
+ This image will be sent to <a href="../../../../../com/microblink/metadata/MetadataListener.html" title="interface in com.microblink.metadata"><code>MetadataListener</code></a> during recognition
+ process if receiving of <a href="../../../../../com/microblink/image/ImageType.html#DEWARPED"><code>ImageType.DEWARPED</code></a> image is enabled with
+ <a href="../../../../../com/microblink/metadata/MetadataSettings.ImageMetadataSettings.html#setDewarpedImageEnabled-boolean-"><code>MetadataSettings.ImageMetadataSettings.setDewarpedImageEnabled(boolean)</code></a></div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../../constant-values.html#com.microblink.recognizers.blinkid.documentface.DocumentFaceRecognizerSettings.FACE_IMAGE_NAME">Constant Field Values</a></dd>
+</dl>
+</li>
+</ul>
+<a name="FULL_DOCUMENT_IMAGE">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>FULL_DOCUMENT_IMAGE</h4>
+<pre>public static final&nbsp;java.lang.String FULL_DOCUMENT_IMAGE</pre>
+<div class="block">Name of the image sent to <a href="../../../../../com/microblink/metadata/MetadataListener.html" title="interface in com.microblink.metadata"><code>MetadataListener</code></a> that contains full document.
+ This image will be sent to <a href="../../../../../com/microblink/metadata/MetadataListener.html" title="interface in com.microblink.metadata"><code>MetadataListener</code></a> during recognition process
+ if displaying of full document image is enabled (see <a href="../../../../../com/microblink/recognizers/blinkid/documentface/DocumentFaceRecognizerSettings.html#setShowFullDocument-boolean-"><code>setShowFullDocument(boolean)</code></a>,
+ and receiving of <a href="../../../../../com/microblink/image/ImageType.html#DEWARPED"><code>ImageType.DEWARPED</code></a> image is enabled with
+ <a href="../../../../../com/microblink/metadata/MetadataSettings.ImageMetadataSettings.html#setDewarpedImageEnabled-boolean-"><code>MetadataSettings.ImageMetadataSettings.setDewarpedImageEnabled(boolean)</code></a></div>
+<dl>
+<dt><span class="seeLabel">See Also:</span></dt>
+<dd><a href="../../../../../constant-values.html#com.microblink.recognizers.blinkid.documentface.DocumentFaceRecognizerSettings.FULL_DOCUMENT_IMAGE">Constant Field Values</a></dd>
+</dl>
+</li>
+</ul>
 <a name="CREATOR">
 <!--   -->
 </a>
@@ -311,6 +370,38 @@ <h4>setDetectorType</h4>
 </dl>
 </li>
 </ul>
+<a name="setShowFullDocument-boolean-">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>setShowFullDocument</h4>
+<pre>public&nbsp;void&nbsp;setShowFullDocument(boolean&nbsp;showFullDocumentImage)</pre>
+<div class="block">Sets whether full document image should be sent to <a href="../../../../../com/microblink/metadata/MetadataListener.html" title="interface in com.microblink.metadata"><code>MetadataListener</code></a>.
+ If enabled, image will be of type <a href="../../../../../com/microblink/image/ImageType.html#DEWARPED"><code>ImageType.DEWARPED</code></a>, and the name of the
+ image (see <a href="../../../../../com/microblink/image/Image.html#getImageName--"><code>Image.getImageName()</code></a>) will be equal to <a href="../../../../../com/microblink/recognizers/blinkid/documentface/DocumentFaceRecognizerSettings.html#FULL_DOCUMENT_IMAGE"><code>FULL_DOCUMENT_IMAGE</code></a>, so make sure
+ you subscribe to receiving of <a href="../../../../../com/microblink/image/ImageType.html#DEWARPED"><code>ImageType.DEWARPED</code></a> images with
+ <a href="../../../../../com/microblink/metadata/MetadataSettings.ImageMetadataSettings.html#setDewarpedImageEnabled-boolean-"><code>MetadataSettings.ImageMetadataSettings.setDewarpedImageEnabled(boolean)</code></a></div>
+<dl>
+<dt><span class="paramLabel">Parameters:</span></dt>
+<dd><code>showFullDocumentImage</code> - whether full document image should be sent to <a href="../../../../../com/microblink/metadata/MetadataListener.html" title="interface in com.microblink.metadata"><code>MetadataListener</code></a>.</dd>
+</dl>
+</li>
+</ul>
+<a name="shouldShowFullDocument--">
+<!--   -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>shouldShowFullDocument</h4>
+<pre>public&nbsp;boolean&nbsp;shouldShowFullDocument()</pre>
+<div class="block">Returns whether sending of full document image to <a href="../../../../../com/microblink/metadata/MetadataListener.html" title="interface in com.microblink.metadata"><code>MetadataListener</code></a> is enabled.</div>
+<dl>
+<dt><span class="returnLabel">Returns:</span></dt>
+<dd>whether sending of full document image to <a href="../../../../../com/microblink/metadata/MetadataListener.html" title="interface in com.microblink.metadata"><code>MetadataListener</code></a> is enabled.</dd>
+</dl>
+</li>
+</ul>
 <a name="writeToParcel-android.os.Parcel-int-">
 <!--   -->
 </a>