Processing a Single Image

This page introduces the capture APIs of the CaptureVisionRouter that designed for processing a single image (or single page file).

Note:

• Use the DirectoryFetcher to process a set of image files.
• Use the FileFetcher to process the multi-page files such as PDF and TIFF.

capture(filePath,templateName)

Processes a single image or a file containing a single image to derive important information with the file path.

CapturedResult capture(String filePath, String templateName);

Parameters

[in] file: The file path and name that you want to capture data from.

[in] templateName: Specifies a “CaptureVisionTemplate” to use. The following value are available for this parameter:

• One of the EnumPresetTemplate member. This is available only if you have never upload a new template via initSettings or initSettingsFromFile.
• A string that represents one of the template name that you have uploaded via initSettings or initSettingsFromFile.
• ”” (empty string) to use the default template. The first template will be used if you have uploaded a template file via initSettingsFromFile or initSettings.

Return Value

A CapturedResult object which contains the derived information from the image processed.

If an error occurs when processing the image, the CapturedResult object will include error code and error message that describes the reason of the error.

Possible errors:

capture(fileBytes,templateName)

Processes a single image or a file containing a single image to derive important information with the file bytes in the memory.

CapturedResult capture(byte[] fileBytes, String templateName);

Parameters

[in] fileBytes: A byte array that points to a file in memory.

[in] templateName: Specifies a “CaptureVisionTemplate” to use. The following value are available for this parameter:

• One of the EnumPresetTemplate member. This is available only if you have never upload a new template via initSettings or initSettingsFromFile.
• A string that represents one of the template name that you have uploaded via initSettings or initSettingsFromFile.
• ”” (empty string) to use the default template. The first template will be used if you have uploaded a template file via initSettingsFromFile or initSettings.

Return Value

A CapturedResult object which contains the derived information from the image processed.

If an error occurs when processing the image, the CapturedResult object will include error code and error message that describes the reason of the error.

Possible errors:

capture(imageData,templateName)

Processes a single image or a file containing a single image to derive important information with an ImageData object.

CapturedResult capture(ImageData imageData, String templateName);

Parameters

[in] buffer: A ImageData object that contains image info.

[in] templateName: Specifies a “CaptureVisionTemplate” to use. The following value are available for this parameter:

• One of the EnumPresetTemplate member. This is available only if you have never upload a new template via initSettings or initSettingsFromFile.
• A string that represents one of the template name that you have uploaded via initSettings or initSettingsFromFile.
• ”” (empty string) to use the default template. The first template will be used if you have uploaded a template file via initSettingsFromFile or initSettings.

Return Value

A CapturedResult object which contains the derived information from the image processed.

If an error occurs when processing the image, the CapturedResult object will include error code and error message that describes the reason of the error.

Possible errors:

capture(bitmap,templateName)

Processes a single image or a file containing a single image to derive important information with a Bitmap.

CapturedResult capture(Bitmap bitmap, String templateName);

Parameters

[in] bitmap: A android.graphics.Bitmap object.

[in] templateName: Specifies a “CaptureVisionTemplate” to use. The following value are available for this parameter:

• One of the EnumPresetTemplate member. This is available only if you have never upload a new template via initSettings or initSettingsFromFile.
• A string that represents one of the template name that you have uploaded via initSettings or initSettingsFromFile.
• ”” (empty string) to use the default template. The first template will be used if you have uploaded a template file via initSettingsFromFile or initSettings.

Return Value

A CapturedResult object which contains the derived information from the image processed.

If an error occurs when processing the image, the CapturedResult object will include error code and error message that describes the reason of the error.

Possible errors: