Single-File Processing

Capture

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

CCapturedResult* Capture(const char* filePath, const char* templateName="");
CCapturedResult* Capture(const unsigned char *fileBytes, int fileSize, const char* templateName="");
CCapturedResult* Capture(const CImageData* pImageData, const char* 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.

[in] fileSize Specifies the size of the image in bytes.

[in] pImageData 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 pointer to a CCapturedResult object containing the captured items.

Code Snippet

int errorCode = 0;
char szErrorMsg[256];
errorCode = CLicenseManager::InitLicense("YOUR-LICENSE-KEY", szErrorMsg, 256);
if (errorCode != ErrorCode::EC_OK && errorCode != ErrorCode::EC_LICENSE_CACHE_USED)
{
    cout << "License initialization failed: ErrorCode: " << errorCode << ", ErrorString: " << szErrorMsg << endl;
}
else
{
    CCaptureVisionRouter* router = new CCaptureVisionRouter();
    CCapturedResult* result = router->Capture("path/to/file.png", "myTemplate");
    // other codes...
    result->Release();
    delete router;
}

See Also

CImageData CCapturedResult

CaptureMultiPages

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

CCapturedResultArray* CaptureMultiPages(const char* filePath, const char* templateName="");
CCapturedResultArray* CaptureMultiPages(const unsigned char *fileBytes, int fileSize, const char* 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.

[in] fileSize Specifies the size of the image in bytes.

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 pointer to a CCapturedResultArray object containing the captured items.

Code Snippet

int errorCode = 0;
char szErrorMsg[256];
errorCode = CLicenseManager::InitLicense("YOUR-LICENSE-KEY", szErrorMsg, 256);
if (errorCode != ErrorCode::EC_OK && errorCode != ErrorCode::EC_LICENSE_CACHE_USED)
{
    cout << "License initialization failed: ErrorCode: " << errorCode << ", ErrorString: " << szErrorMsg << endl;
}
else
{
    CCaptureVisionRouter* router = new CCaptureVisionRouter();
    CCapturedResultArray* resultArray = router->CaptureMultiPages("path/to/file.pdf", "myTemplate");
    for (int i = 0; i < resultArray->GetResultsCount(); i++)
    {
        const CCapturedResult* result = resultArray->GetResult(i);
        // other codes...
    }
    resultArray->Release();
    delete router;
}

See Also

CImageData CCapturedResultArray CCapturedResult