Single-File Processing Methods - CaptureVisionRouter Class
Method | Description |
---|---|
Capture |
Process an image or file to derive important information. |
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. - Please be aware that the preset
CaptureVisionTemplates
will be overwritten should the user callInitSettings
/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 firstCaptureVisionTemplate
from the user’s own settings will be used instead.
Return Value
Returns a CapturedResult
object containing the captured items.
Error Code | Value | Description |
---|---|---|
EC_NULL_POINTER | -10002 | The ImageData object is null. |
EC_FILE_NOT_FOUND | -10005 | The file is not found. |
EC_FILE_TYPE_NOT_SUPPORTED | -10006 | The file type is not supported. |
EC_TEMPLATE_NAME_INVALID | -10036 | The target template name is invalid. |
EC_CALL_REJECTED_WHEN_CAPTURING | -10062 | Function call is rejected when capturing in progress. |
EC_MULTI_PAGES_NOT_SUPPORTED | -10066 | The api does not support multi-page files. Please use FileFetcher instead. |
See Also