FrameDecodingParameters

Defines a struct to configure the frame decoding Parameters.

Attributes

maxQueueLength

The maximum number of frames waiting for decoding.

int com.dynamsoft.dbr.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.dbr.FrameDecodingParameters.maxResultQueueLength

Value Range
[0,0x7fffffff]

Default Value
10

width

The width of the frame image in pixels.

int com.dynamsoft.dbr.FrameDecodingParameters.width

Value Range
[0,0x7fffffff]

Default Value
0

height

The height of the frame image in pixels.

int com.dynamsoft.dbr.FrameDecodingParameters.height

Value Range
[0,0x7fffffff]

Default Value
0

stride

The stride (or scan width) of the frame image.

int com.dynamsoft.dbr.FrameDecodingParameters.stride

Value Range
[0,0x7fffffff]

Default Value
0

imagePixelFormat

The image pixel format used in the image byte array.

int com.dynamsoft.dbr.FrameDecodingParameters.imagePixelFormat

Value Range
A value of EnumImagePixelFormat Enumeration items.

Default Value
IPF_GRAYSCALED

See Also
EnumImagePixelFormat

region

The region definition of the frame to calculate the internal indicator.

RegionDefinition com.dynamsoft.dbr.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.dbr.FrameDecodingParameters.threshold

Value Range
[0, 1]

Default Value
0.01

Remarks
The SDK will calculate an inner indicator for each frame from appendFrame, 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.dbr.FrameDecodingParameters.fps

Value Range
[0,0x7fffffff]

Default Value
0

Remarks
0 means the frequency will be calculated automatically by the SDK.

autoFilter

Sets whether to filter frames automatically.

int com.dynamsoft.dbr.FrameDecodingParameters.autoFilter

Value Range
[0,1]

Default Value
1

Remarks
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.dbr.FrameDecodingParameters.clarityCalculationMethod

Value Range
Any one of the EnumClarityCalculationMethod Enumeration items.

Default Value
ECCM_CONTRAST

See Also
EnumClarityCalculationMethod

clarityFilterMode

Sets the mode used for filtering frames by calculated clarity.

int com.dynamsoft.dbr.FrameDecodingParameters.clarityFilterMode

Value Range
Any one of the EnumClarityFilterMode Enumeration items.

Default Value
CFM_GENERAL

See Also
EnumClarityFilterMode