Single-File Processing Methods - CaptureVisionRouter Class

Capture

Process an image or file to derive important information. It can optionally use a specified template for the capture.

CapturedResult Capture(string filePath, string templateName="");
CapturedResult Capture(byte[] fileBytes, string templateName="");
CapturedResult Capture(ImageData imageData, string templateName="");

Parameters

[in] filePath Specifies the path of the file to process.

[in] templateName Specifies a CaptureVisionTemplate to use for capturing.

[in] fileBytes Specifies the image file bytes in memory to be processed.

[in] imageData Specifies the image data to process.

Remarks

• There are two types of CaptureVisionTemplate: the preset ones which come with the SDK and the custom ones that get initialized when the user calls InitSettings / InitSettingsFromFile.
• When using a custom template, the parameter templateName should be the name of the CaptureVisionTemplate object in the JSON template file.
• Please be aware that the preset CaptureVisionTemplates will be overwritten should the user call InitSettings / InitSettingsFromFile and pass his own settings.
• If parameter templateName is not specified, the preset one named ‘Default’ will be used. However, if the preset ones have been overwritten as described above, the first CaptureVisionTemplate from the user’s own settings will be used instead.

Return Value

Returns a CapturedResult object containing the captured items.

See Also

ImageData

CaptureMultiPages

Processes an image or file containing multiple pages to derive important information.

CapturedResult[] CaptureMultiPages(string filePath, string templateName = "");
CapturedResult[] CaptureMultiPages(byte[] fileBytes, string templateName = "")

Parameters

[in] filePath Specifies the path of the file to process.

[in] templateName Specifies a CaptureVisionTemplate to use for capturing.

[in] fileBytes Specifies the memory location containing the image to be processed.

Remarks

• There are two types of CaptureVisionTemplate: the preset ones which come with the SDK and the custom ones that get initialized when the user calls InitSettings / InitSettingsFromFile.
• When using a custom template, the parameter templateName should be the name of the CaptureVisionTemplate object in the JSON template file.
• Please be aware that the preset CaptureVisionTemplates will be overwritten should the user call InitSettings / InitSettingsFromFile and pass his own settings.
• If parameter templateName is not specified, the preset one named ‘Default’ will be used. However, if the preset ones have been overwritten as described above, the first CaptureVisionTemplate from the user’s own settings will be used instead.

Return Value

Returns an array of CapturedResult objects containing the captured items.

See Also

ImageData CapturedResult