Package com.geniusscansdk.core

Class DocumentDetector

java.lang.Object

com.geniusscansdk.core.DocumentDetector

public abstract class DocumentDetector
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentDetector.Mode

Field Summary

Fields

Modifier and Type	Field	Description
protected long	nativeHandle

Constructor Summary

Constructors

Constructor	Description
DocumentDetector()

Method Summary

Modifier and Type	Method	Description
static DocumentDetector	create(android.content.Context context)
static DocumentDetector	create(android.content.Context context, DocumentDetector.Mode mode)
Quadrangle	detectDocument(byte[] imageBuffer, int previewWidth, int previewHeight, int previewStride)	Detect document on a YUV buffer.
Quadrangle	detectDocument(android.graphics.Bitmap bitmap)	Detect document in an image bitmap.
Quadrangle	detectDocument(java.io.File image)	Detect document in an image file.
protected void	finalize()

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nativeHandle

protected long nativeHandle

Constructor Detail

DocumentDetector

public DocumentDetector()

Method Detail

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

create

public static DocumentDetector create(android.content.Context context,
                                      DocumentDetector.Mode mode)

create

public static DocumentDetector create(android.content.Context context)

detectDocument

@NonNull
public Quadrangle detectDocument(java.io.File image)
                          throws ProcessingException,
                                 LicenseException

Detect document in an image file.

Parameters:

image - the image file

Returns:

the quadrangle if a document is detected, an empty quadrangle otherwise.

Throws:

ProcessingException - if something wrong happened during detection

LicenseException - if the license is not valid or has expired

detectDocument

@NonNull
public Quadrangle detectDocument(android.graphics.Bitmap bitmap)
                          throws ProcessingException,
                                 LicenseException

Detect document in an image bitmap.

Parameters:

bitmap - the image bitmap

Returns:

the quadrangle if a document is detected, an empty quadrangle otherwise.

Throws:

ProcessingException

LicenseException

See Also:

detectDocument(File)

detectDocument

@NonNull
public Quadrangle detectDocument(byte[] imageBuffer,
                                 int previewWidth,
                                 int previewHeight,
                                 int previewStride)
                          throws ProcessingException,
                                 LicenseException

Detect document on a YUV buffer.

Parameters:

imageBuffer - an image buffer with format YUV420

previewWidth - the width of the image

previewHeight - the height of the image

Returns:

the quadrangle if a document is detected, an empty quadrangle otherwise.

Throws:

ProcessingException

LicenseException

See Also:

detectDocument(File)