FrameDecodingParameters
Defines a struct to configure the frame decoding Parameters.
Attributes
Attribute | Type |
---|---|
maxQueueLength |
int |
maxResultQueueLength |
int |
width |
int |
height |
int |
stride |
int |
imagePixelFormat |
int |
region |
RegionDefinition |
threshold |
float |
fps |
int |
autoFilter |
int |
clarityCalculationMethod |
int |
clarityFilterMode |
int |
maxQueueLength
The maximum number of frames waiting for decoding.
int com.dynamsoft.barcode.FrameDecodingParameters.maxQueueLength
-
Value range
[0,0x7fffffff] -
Default value
3
maxResultQueueLength
The maximum number of frames whose results (text result/localization result) will be kept for further reference.
int com.dynamsoft.barcode.FrameDecodingParameters.maxResultQueueLength
-
Value range
[0,0x7fffffff] -
Default value
10
width
The width of the frame image in pixels.
int com.dynamsoft.barcode.FrameDecodingParameters.width
-
Value range
[0,0x7fffffff] -
Default value
0
height
The height of the frame image in pixels.
int com.dynamsoft.barcode.FrameDecodingParameters.height
-
Value range
[0,0x7fffffff] -
Default value
0
stride
The stride (or scan width) of the frame image.
int com.dynamsoft.barcode.FrameDecodingParameters.stride
-
Value range
[0,0x7fffffff] -
Default value
0
imagePixelFormat
The image pixel format used in the image byte array.
int com.dynamsoft.barcode.FrameDecodingParameters.imagePixelFormat
-
Value range
A value ofEnumImagePixelFormat
Enumeration items. -
Default value
IPF_GRAYSCALED
-
See also
EnumImagePixelFormat
region
The region definition of the frame to calculate the internal indicator.
RegionDefinition com.dynamsoft.barcode.FrameDecodingParameters.region
-
Default value
{ regionLeft = 0, regionRight = 100, regionTop = 0, regionBottom = 100, regionMeasuredByPercentage = 1 }
-
See also
RegionDefinition
threshold
The threshold used for filtering frames.
float com.dynamsoft.barcode.FrameDecodingParameters.threshold
-
Value range
[0, 1] -
Default value
0.01 -
Remark
The SDK will calculate an inner indicator for each frame fromappendFrame
, if the change rate of the indicators between the current frame and the history frames is larger than the given threshold, the current frame will not be added to the inner frame queue waiting for decoding.
fps
The frequency of calling appendFrame
per second.
int com.dynamsoft.barcode.FrameDecodingParameters.fps
-
Value range
[0,0x7fffffff] -
Default value
0 -
Remark
0 means the frequency will be calculated automatically by the SDK.
autoFilter
Sets whether to filter frames automatically.
int com.dynamsoft.barcode.FrameDecodingParameters.autoFilter
-
Value range
[0,1] -
Default value
1 -
Remark
0: Diable filtering frames automatically. 1: Enable filtering frames automatically.
clarityCalculationMethod
Sets the method used for calculating the clarity of the frames.
int com.dynamsoft.barcode.FrameDecodingParameters.clarityCalculationMethod
-
Value range
Any one of theEnumClarityCalculationMethod
Enumeration items. -
Default value
ECCM_CONTRAST -
See also
EnumClarityCalculationMethod
clarityFilterMode
Sets the mode used for filtering frames by calculated clarity.
int com.dynamsoft.barcode.FrameDecodingParameters.clarityFilterMode
-
Value range
Any one of theEnumClarityFilterMode
Enumeration items. -
Default value
CFM_GENERAL -
See also
EnumClarityFilterMode