VinScanner

java.lang.Object

io.scanbot.sdk.vin.VinScanner

All Implemented Interfaces:: AutoCloseable

public class VinScanner extends Object implements AutoCloseable

API for VIN scanning.

Constructor Summary

Constructors

Constructor

Description

VinScanner(VinScannerConfiguration configuration)

Constructs VinScanner with the given params.
Method Summary

Modifier and Type

Method

Description

void

cleanRecognitionQueue()

Clean the queue of recognized VIN.

void

close()

Closes native resources held by the object.

protected void

finalize()

VinScannerResult

run(ImageRef image)

Recognize VIN in the given image.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- VinScanner
  
  public VinScanner(VinScannerConfiguration configuration) throws LicenseException
  
  Constructs VinScanner with the given params.
  
  Parameters:
  
  configuration - The configuration to use for the VIN scanner.
  
  Throws:
  
  LicenseException - If license requirements for the API are not met
Method Details
- run
  
  public VinScannerResult run(ImageRef image) throws InvalidImageRefException, LicenseException
  
  Recognize VIN in the given image.
  
  Parameters:
  
  image - The image to recognize VIN in.
  
  Returns:
  
  The recognized text line.
  
  Throws:
  
  InvalidImageRefException - If an invalid image reference is used
  
  LicenseException - If license requirements for the API are not met
- cleanRecognitionQueue
  
  public void cleanRecognitionQueue()
  
  Clean the queue of recognized VIN.
- close
  
  public void close()
  
  Closes native resources held by the object.
  
  Specified by:
  
  close in interface AutoCloseable
- finalize
  
  protected void finalize() throws Throwable
  
  Overrides:
  
  finalize in class Object
  
  Throws:
  
  Throwable