Thanks for downloading Dynamsoft Barcode Reader Package!
Your download will start shortly. If your download does not begin, click here to retry.
Region
Region defines a region in where to search barcodes. By default, DBR does not restrict the reading region. It is defined by RegionTop, RegionLeft, RegionRight, RegionBottom, and RegionMeasuredByPercentage:
| Value Type | Value Range | Default Value | Template Structure Type |
|---|---|---|---|
| int | see this section | see this section | RegionDefinition |
Setting Methods
Region is supported to be set through PublicRuntimeSettings or JSON template.
As PublicRuntimeSettings Member
Region can be set dynamically during runtime as a member of PublicRuntimeSettings struct.
Code Snippet in C++
//...other codes
PublicRuntimeSettings* pSettings = new PublicRuntimeSettings;
int errorCode = reader->GetRuntimeSettings(pSettings);
pSettings->region.regionTop = 25;
pSettings->region.regionLeft = 25;
pSettings->region.regionBottom = 75;
pSettings->region.regionRight = 75;
pSettings->region.regionMeasuredByPercentage = 1;
reader->UpdateRuntimeSettings(pSettings);
delete pSettings;
//...other codes
See Also
PublicRuntimeSettings:JavaScript | C | C++ | .NET | Python | Java | Java-Android | Objective-C & Swift
As JSON Parameter
Region as a JSON parameter is a RegionDefinition Object defined as below.
| Key Name | Key Value |
|---|---|
| RegionDefinition | A JSON object defined as below |
| Key Name | Key Value | Description |
|---|---|---|
| Name | A string value representing a unique name | The name of the RegionDefinition object. |
| Top | A number from [0, 0x7fffffff] when MeasuredByPercentage=0 or [0, 100] when MeasuredByPercentage=1 | The top-most coordinate or percentage of the region. |
| RegionLeft | A number from [0, 0x7fffffff] when MeasuredByPercentage=0 or [0, 100] when MeasuredByPercentage=1 | The left-most coordinate or percentage of the region. |
| Right | A number from [0, 0x7fffffff] when MeasuredByPercentage=0 or [0, 100] when MeasuredByPercentage=1 | The right-most coordinate or percentage of the region. |
| Bottom | A number from [0, 0x7fffffff] when MeasuredByPercentage=0 or [0, 100] when MeasuredByPercentage=1 | The bottom-most coordinate or percentage of the region. |
| MeasuredByPercentage | A number from [0, 1] | Sets whether or not to use percentages to measure the Region size. |
JSON Example
{
"RegionDefinition":
{
"Name": "RD1",
"Top": 25,
"Left": 25,
"Right": 75,
"Bottom": 75,
"MeasuredByPercentage": 1
}
}
Yes
No