Documentation
Table of contents

CLabelRecognizer

class dynamsoft::dlr::CLabelRecognizer

Initialization

Method Description
CLabelRecognizer Initialization of CLabelRecognizer object.
InitLicense Sets the license and activates the SDK.

 

CLabelRecognizer

Initialization of CLabelRecognizer object.

CLabelRecognizer()

Code Snippet

CLabelRecognizer* recognizer = new CLabelRecognizer();
delete recognizer;

 

InitLicense

Sets product key and activate the SDK.

static int InitLicense (const char *license, char errorMsgBuffer[], const int errorMsgBufferLen))

Parameters

[in] license The product key. [in, out] errorMsgBuffer The buffer is allocated by caller and the recommending length is 256. The error message will be copied to the buffer.
[in] errorMsgBufferLen The length of allocated buffer.

Return value

Returns error code. Returns 0 if the function completed successfully, otherwise call GetErrorString to get detailed message.

Possible returns are: DLR_OK;

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

Settings

Method Description
GetRuntimeSettings Gets the current settings and saves it into a struct.
UpdateRuntimeSettings Updates runtime settings with a given struct.
UpdateRuntimeSettingsFromString Updates runtime settings with the settings in a given JSON string.
ResetRuntimeSettings Resets the runtime settings.
AppendSettingsFromString Appends LabelRecognizerParameter settings in a string to the SDK object.
AppendSettingsFromFile Appends LabelRecognizerParameter settings in a file to the SDK object.
OutputSettingsToFile Outputs LabelRecognizerParameter settings into a file (JSON file).
OutputSettingsToString Output runtime settings to a string.
ClearAppendedSettings Clear all appended LabelRecognizerParameter settings in the SDK object.
UpdateReferenceRegionFromBarcodeResults Updates reference region which is defined with source type LST_BARCODE.
GetModeArgument Get argument value for the specified mode parameter.
SetModeArgument Set argument value for the specified mode parameter.

 

GetRuntimeSettings

Get current settings and save them into a DLR_RuntimeSettings struct.

int GetRuntimeSettings (DLR_RuntimeSettings* settings)

Parameters

[in,out] settings The struct of runtime settings.

Return value

Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString to get detailed error message.

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

CLabelRecognizer* recognizer = new CLabelRecognizer();
DLR_RuntimeSettings settings;
int errorCode = recognizer->GetRuntimeSettings(&settings);
delete recognizer;

 

UpdateRuntimeSettings

Update runtime settings with a given DLR_RuntimeSettings struct.

int UpdateRuntimeSettings (DLR_RuntimeSettings* settings, char errorMsgBuffer[] = NULL, const int errorMsgBufferLen = 0)

Parameters

[in] settings The struct of runtime settings.
[in,out] errorMsgBuffer Optional The buffer is allocated by caller and the recommended length is 256.The error message will be copied to the buffer.
[in] errorMsgBufferLen Optional The length of the allocated buffer.

Return value

Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString to get detailed error message.

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

CLabelRecognizer* recognizer = new CLabelRecognizer();
DLR_RuntimeSettings settings;
int errorCode = recognizer->GetRuntimeSettings(&settings);
settings.maxThreadCount = 4;
recognizer->UpdateRuntimeSettings(&settings, errorMessage, 256);
delete recognizer;

 

UpdateRuntimeSettingsFromString

Updates runtime settings with the parameters obtained from a JSON string.

int UpdateRuntimeSettingsFromString (const char* content, char errorMsgBuffer[], const int errorMsgBufferLen)

Parameters [in] content A JSON string that represents the content of the settings.
[in,out] errorMsgBuffer The buffer is allocated by caller and the recommending length is 256. The error message will be copied to the buffer.
[in] errorMsgBufferLen The length of allocated buffer.

Return Value
Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString to get detailed error message.

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

CLabelRecognizer* recognizer = new CLabelRecognizer();

const char* strJson = "{\"LabelRecognizerParameter\":{\"Name\":\"P1\", \"RegionPredetectionModes\":[{\"Mode\":\"RPM_GENERAL_HSV_CONTRAST\"}], \"ReferenceRegionNameArray\": [\"R1\"]},\"ReferenceRegion\":{\"Name\":\"R1\",\"Localization\":{\"SourceType\":\"LST_PREDETECTED_REGION\",\"RegionPredetectionModesIndex\":0},\"TextAreaNameArray\":[\"T1\"]},\"TextArea\":{\"Name\":\"T1\",\"CharacterModelName\":\"Number\"}}";

recognizer->UpdateRuntimeSettingsFromString(strJson, errorMessage, 256);
delete recognizer;

 

ResetRuntimeSettings

Reset all runtime settings to default values.

int ResetRuntimeSettings ()

Return value

Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString to get detailed error message.

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

CLabelRecognizer* recognizer = new CLabelRecognizer();
DLR_RuntimeSettings settings;
int errorCode = recognizer->GetRuntimeSettings(&settings);
settings.maxThreadCount = 4;
recognizer->UpdateRuntimeSettings(&settings);
recognizer->ResetRuntimeSettings();
delete recognizer;

 

AppendSettingsFromString

Append a new template string to the current label recognizer instance.

int AppendSettingsFromString (const char* content, char errorMsgBuffer[] = NULL, const int errorMsgBufferLen = 0)

Parameters

[in] content A JSON string that represents the content of the settings.
[in,out] errorMsgBuffer Optional The buffer is allocated by caller and the recommending length is 256. The error message will be copied to the buffer.
[in] errorMsgBufferLen Optional The length of allocated buffer.

Return value

Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString to get detailed error message.

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

CLabelRecognizer* recognizer = new CLabelRecognizer();
recognizer->AppendSettingsFromString("{\"LabelRecognizerParameter\":{\"Name\":\"P1\", \"RegionPredetectionModes\":[{\"Mode\":\"RPM_GENERAL_HSV_CONTRAST\"}], \"ReferenceRegionNameArray\": [\"R1\"]},\"ReferenceRegion\":{\"Name\":\"R1\",\"Localization\":{\"SourceType\":\"LST_PREDETECTED_REGION\",\"RegionPredetectionModesIndex\":0},\"TextAreaNameArray\":[\"T1\"]},\"TextArea\":{\"Name\":\"T1\",\"CharacterModelName\":\"Number\"}}", errorMessage, 256);
delete recognizer;

 

AppendSettingsFromFile

Appends LabelRecognizerParameter settings in a file to the SDK object.

int AppendSettingsFromFile (const char* filePath, char errorMsgBuffer[] = NULL, const int errorMsgBufferLen = 0)

Parameters

[in] filePath The settings file path.
[in,out] errorMsgBuffer Optional The buffer is allocated by caller and the recommending length is 256. The error message will be copied to the buffer.
[in] errorMsgBufferLen Optional The length of allocated buffer.

Return value

Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString to get detailed error message.

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

CLabelRecognizer* recognizer = new CLabelRecognizer();
recognizer->AppendSettingsFromString("your file path", errorMessage, 256);
delete recognizer;

 

OutputSettingsToFile

Outputs runtime settings and save them into a settings file (JSON file).

int OutputSettingsToFile (const char* filePath, const char* templateName)

Parameters

[in] filePath The path of the output file which stores current settings.
[in] templateName A unique name for declaring current runtime settings.

Return value

Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString to get detailed error message.

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

CLabelRecognizer* recognizer = new CLabelRecognizer();
recognizer->AppendSettingsFromString("{\"LabelRecognizerParameter\":{\"Name\":\"P1\", \"RegionPredetectionModes\":[{\"Mode\":\"RPM_GENERAL_HSV_CONTRAST\"}], \"ReferenceRegionNameArray\": [\"R1\"]},\"ReferenceRegion\":{\"Name\":\"R1\",\"Localization\":{\"SourceType\":\"LST_PREDETECTED_REGION\",\"RegionPredetectionModesIndex\":0},\"TextAreaNameArray\":[\"T1\"]},\"TextArea\":{\"Name\":\"T1\",\"CharacterModelName\":\"Number\"}}", errorMessage, 256);
recognizer->OutputSettingsToFile("C:\\Program Files (x86)\\Dynamsoft\\{Version number}\\Templates\\CurrentRuntimeSettings.json", "currentRuntimeSettings");
delete recognizer;

 

OutputSettingsToString

Outputs runtime settings and save them into a settings file (JSON file).

int OutputSettingsToString (char content[], const int contentLen, const char* pSettingsName)

Parameters [in,out] content The output string which stores the contents of current settings.
[in] contentLen The length of output string.
[in] pSettingsName A unique name for declaring current runtime settings.

Return value

Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString to get detailed error message.

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

CLabelRecognizer* recognizer = new CLabelRecognizer;
char conent[2048] = {0};
recognizer->OutputSettingsToString(content, 2048, "currentRuntimeSettings");
delete recognizer;

 

ClearAppendedSettings

Clear all appended parameter settings of the current label recognizer instance.

void ClearAppendedSettings ()

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

CLabelRecognizer* recognizer = new CLabelRecognizer();
recognizer->ClearAppendedSettings();

 

UpdateReferenceRegionFromBarcodeResults

Updates reference region which is defined with source type LST_BARCODE.

int UpdateReferenceRegionFromBarcodeResults (const BarcodeResultArray* barcodeResults, const char* templateName)

Parameters

[in] barcodeResults The barcode results used to localize reference region. See also BarcodeResultArray. [in] templateName The template name. A template name is the value of key LabelRecognizerParameter.Name defined in JSON formatted settings. If no template name is specified, current runtime settings will be used.

Return value

Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString to get detailed error message.

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

CLabelRecognizer* recognizer = new CLabelRecognizer();
recognizer->AppendSettingsFromString("{\"LabelRecognizerParameter\":{\"Name\":\"P1\", \"RegionPredetectionModes\":[{\"Mode\":\"RPM_GENERAL_HSV_CONTRAST\"}], \"ReferenceRegionNameArray\": [\"R1\"]},\"ReferenceRegion\":{\"Name\":\"R1\",\"Localization\":{\"SourceType\":\"LST_BARCODE\"},\"TextAreaNameArray\":[\"T1\"]},\"TextArea\":{\"Name\":\"T1\",\"CharacterModelName\":\"Number\"}}", errorMessage, 256);
//Get barcodeResults from Dynamsoft Barcode Reader SDK
recognizer->UpdateReferenceRegionFromBarcodeResults(barcodeResults, "P1");
delete recognizer;

 

SetModeArgument

Set argument value for the specified mode parameter.

int SetModeArgument (const char* modesName, const int index, const char* argumentName, const char* argumentValue, char errorMsgBuffer[] = NULL,  const int errorMsgBufferLen = 0)

Parameters

[in] modesName The mode parameter name to set argument.
[in] index The array index of mode parameter to indicate a specific mode.
[in] argumentName The name of the argument to set.
[in] argumentValue The value of the argument to set.
[in,out] errorMsgBufferOptional The buffer is allocated by the caller and the recommended length is 256. The error message will be copied to the buffer.
[in] errorMsgBufferLenOptional The length of the allocated buffer.

Return value

Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString to get detailed error message.

Remark

Check follow link for available modes and arguments:

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

CLabelRecognizer* recognizer = new CLabelRecognizer();
DLR_RuntimeSettings settings;
int errorCode = recognizer->GetRuntimeSettings(&settings);
settings.furtherModes.regionPredetectionModes[0] = RPM_GENERAL_RGB_CONTRAST;
recognizer->UpdateRuntimeSettings(&settings, errorMessage, 256);
recognizer->SetModeArgument("RegionPredetectionModes", 0, "AspectRatioRange", "100", errorMessage, 256);
delete recognizer;

 

GetModeArgument

Get argument value for the specified mode parameter.

int GetModeArgument (const char* modesName, const int index, const char* argumentName, char valueBuffer[], const int valueBufferLen, char errorMsgBuffer[] = NULL, const int errorMsgBufferLen = 0)

Parameters

[in] modesName The mode parameter name to get argument.
[in] index The array index of mode parameter to indicate a specific mode.
[in] argumentName The name of the argument to get.
[in,out] valueBuffer The buffer is allocated by caller and the recommended length is 480. The argument value would be copied to the buffer.
[in] valueBufferLen The length of allocated buffer.
[in,out] errorMsgBufferOptional The buffer is allocated by the caller and the recommended length is 256. The error message will be copied to the buffer.
[in] errorMsgBufferLenOptional The length of the allocated buffer.

Return value

Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString to get detailed error message.

Remark

Check follow link for available modes and arguments:

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

CLabelRecognizer* recognizer = new CLabelRecognizer();
DLR_RuntimeSettings settings;
int errorCode = recognizer->GetRuntimeSettings(&settings);
settings.furtherModes.regionPredetectionModes[0] = RPM_GENERAL_RGB_CONTRAST;
char argumentValue[480];
recognizer->UpdateRuntimeSettings(&settings, errorMessage, 256);
recognizer->SetModeArgument("RegionPredetectionModes", 0, "AspectRatioRange", "100", errorMessage, 256);
recognizer->GetModeArgument("RegionPredetectionModes", 0, "AspectRatioRange", argumentValue, 480, errorMessage, 256);
delete recognizer;

Recognizing

Method Description
RecognizeByBuffer Recognizes text from memory buffer containing image pixels in defined format.
RecognizeByFile Recognizes text from a specified image file.
RecognizeFileInMemory Recognizes text from an image file in memory.

 

RecognizeByBuffer

Recognizes text from the memory buffer containing image pixels in defined format.

int RecognizeByBuffer(const ImageData* imageData, const char* templateName)

Parameters

[in] imageData A struct of ImageData that represents an image.
[in] templateName The template name. A template name is the value of key LabelRecognizerParameter.Name defined in JSON formatted settings. If no template name is specified, current runtime settings will be used.

Return value

Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString to get detailed error message.

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

CLabelRecognizer* recognizer = new CLabelRecognizer();

//Generate imageData from somewhere else
int errorCode = recognizer->RecognizeByBuffer(imageData, "");
delete recognizer;

 

RecognizeByFile

Recognizes text from a specified image file.

int RecognizeByFile (const char* fileName, const char* templateName)

Parameters

[in] fileName A string defining the file name.
[in] templateName The template name. A template name is the value of key LabelRecognizerParameter.Name defined in JSON formatted settings. If no template name is specified, current runtime settings will be used.

Return value

Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString to get detailed error message.

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

CLabelRecognizer* recognizer = new CLabelRecognizer();
int errorCode = recognizer->RecognizeByFile("C:\\Program Files (x86)\\Dynamsoft\\{Version number}\\Images\\AllSupportedBarcodeTypes.tif", "");
delete recognizer;

RecognizeFileInMemory

Recognizes text from a specified image file in memory.

int RecognizeFileInMemory (const unsigned char* pFileBytes, const int fileSize, const char* pTemplateName)

Parameters
[in] pFileBytes The image file bytes in memory.
[in] fileSize The length of the file bytes in memory.
[in] pTemplateName The template name.

Return Value
Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString to get detailed error message.

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

CLabelRecognizer* recognizer = new CLabelRecognizer();

unsigned char* pFileBytes;
int nFileSize = 0;
GetFileStream("C:\\Program Files (x86)\\Dynamsoft\\{Version number}\\Images\\AllSupportedBarcodeTypes.tif", &pFileBytes, &nFileSize);

int errorCode = recognizer->RecognizeFileInMemory(pFileBytes, nFileSize, "");
delete recognizer;

Result

Method Description
GetAllResults Gets all recognized results.
FreeResults Frees memory allocated for recognized results.

 

GetAllResults

Get all recognized results.

int GetAllResults (DLR_ResultArray** results)

Parameters

[out] results Recognized results returned by last calling function RecognizeByBuffer / RecognizeByFile. The results is allocated by SDK and should be freed by calling function FreeResults.

Return value

Returns error code (returns 0 if the function operates successfully).
You can call GetErrorString to get detailed error message.

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

CLabelRecognizer* recognizer = new CLabelRecognizer();
DLR_ResultArray * results;
int errorCode = recognizer->RecognizeByFile("C:\\Program Files (x86)\\Dynamsoft\\{Version number}\\Images\\AllSupportedBarcodeTypes.tif", "");
recognizer->GetAllResults(&results);
CLabelRecognizer::FreeResults(&results);
delete recognizer;

 

FreeResults

Free memory allocated for text results.

static void FreeResults (DLR_ResultArray ** results)

Parameters

[in] results Recognized results.

Code Snippet

char errorMessage[256];
CLabelRecognizer::InitLicense("t0260NwAAAHV***************", errorMessage, 256);

CLabelRecognizer* recognizer = new CLabelRecognizer();
DLR_ResultArray * results;
int errorCode = recognizer->RecognizeByFile("C:\\Program Files (x86)\\Dynamsoft\\{Version number}\\Images\\AllSupportedBarcodeTypes.tif", "");
recognizer->GetAllResults(&results);
CLabelRecognizer::FreeResults(&results);
delete recognizer;

General

Method Description
GetErrorString Returns the error string.
GetVersion Returns the version number string for the SDK.

 

GetErrorString

Get error message by error code.

static const char* GetErrorString (const int errorCode)

Parameters

[in] errorCode The error code.

Return value

The error message.

Code Snippet

const char* errorString = GetErrorString(errorCode);

 

GetVersion

Get version information of SDK.

static const char* GetVersion ()

Return value

The version information string.

Code Snippet

const char* versionInfo = GetVersion();

This page is compatible for:

Is this page helpful?

YesYes NoNo

In this article: