Thanks for downloading Dynamsoft Barcode Reader Package!
Your download will start shortly. If your download does not begin, click here to retry.
BarcodeColourModes
BarcodeColourModes
defines the barcode colour modes. It consists of one or more modes, with each representing a different colour environment.
Value Type | Value Range | Default Value | Template Structure Type |
---|---|---|---|
int / EnumBarcodeColourMode | N/A | BICM_DARK_ON_LIGHT |
ImageParameter |
Candidate Mode List
- BICM_DARK_ON_LIGHT
- BICM_LIGHT_ON_DARK
- BICM_DARK_ON_DARK
- BICM_LIGHT_ON_LIGHT
- BICM_DARK_LIGHT_MIXED
- BICM_DARK_ON_LIGHT_DARK_SURROUNDING
BICM_DARK_ON_LIGHT
The target barcode is a dark item on a light background. This mode has the following arguments for further customizing.
BICM_DARK_ON_LIGHT_DARK_SURROUNDING
The target barcode is a dark item on a light background surrounded by dark. This mode has the following arguments for further customizing.
BICM_LIGHT_ON_DARK
The target barcode is a light item on a dark background. Not supported yet.
BICM_DARK_ON_DARK
The target barcode is a dark item on a dark background. Not supported yet.
BICM_LIGHT_ON_LIGHT
The target barcode is a light item on a light background. Not supported yet.
BICM_DARK_LIGHT_MIXED
The target barcode is on background which is mixed by dark and light. Not supported yet.
Setting Methods
As PublicRuntimeSettings
Member
BarcodeColourModes
can be set dynamically during runtime as a member of FurtherModes
, which is a member of PublicRuntimeSettings
struct, it is an array with 8 BarcodeColourMode
Enumeration items.
Code Snippet in C++
//...other codes
PublicRuntimeSettings* pSettings = new PublicRuntimeSettings;
int errorCode = reader->GetRuntimeSettings(pSettings);
pSettings->barcodeColourModes[0] = BICM_DARK_ON_LIGHT;
reader->UpdateRuntimeSettings(pSettings);
reader->SetModeArgument("BarcodeColourModes", 0, "LightReflection", "1");
delete pSettings;
//...other codes
Remarks
GetModeArgument
and SetModeArgument
need to be called for getting and setting Arguments
.
See Also
FurtherModes:
C | C++ | .NET | Java | Java-Android | Objective-C & SwiftPublicRuntimeSettings:
JavaScript | C | C++ | .NET | Python | Java | Java-Android | Objective-C & SwiftBarcodeColourMode:
JavaScript | C | C++ | .NET | Python | Java | Java-Android | Objective-C & SwiftGetModeArgument:
JavaScript | C | C++ | .NET | Python | Java | Java-Android | Objective-C & SwiftSetModeArgument:
JavaScript | C | C++ | .NET | Python | Java | Java-Android | Objective-C & Swift
As JSON Parameter
BarcodeColourModes
as a JSON parameter is a JSON Object array. Each JSON object is defined as below.
Key Name | Key Value | Description |
---|---|---|
Mode | Any one in Candidate Mode List as string | (Required) Specifies a target barcode colour mode. |
LightReflection | A number from value range of LightReflection | (Optional) Sets the Argument LightReflection. |
LibraryFileName | A string from value range of LibraryFileName | (Optional) Sets the Argument LibraryFileName. |
LibraryParameters | A string from value range of LibraryParameters | (Optional) Sets the Argument LibraryParameters. |
JSON Parameter Example
{
"BarcodeColourModes": [
{
"Mode": "BICM_DARK_ON_LIGHT",
"LightReflection": 1
},
{
"Mode": "BICM_DARK_ON_LIGHT",
"LightReflection": 0
}
]
}
Candidate Argument List
LightReflection
Sets if there is light reflection on the barcode zone.
Value Type | Value Range | Default Value | Valid For |
---|---|---|---|
int | [0, 1] | 1 | BICM_DARK_ON_LIGHT BICM_DARK_ON_LIGHT_DARK_SURROUNDING |
Remarks
- 0: no light reflection.
- 1: has light reflection.
LibraryFileName
Sets the file name of the library to load dynamically.
Value Type | Value Range | Default Value | Valid For |
---|---|---|---|
string | A string value representing file name. | ”” | All modes |
Remarks
The library must be in the same place with Dynamsoft Barcode Reader Library.
LibraryParameters
Sets the parameters passed to the library to load dynamically.
Value Type | Value Range | Default Value | Valid For |
---|---|---|---|
string | A string value representing parameters. | ”” | All modes |