FrameDecodingParameters

Defines a struct to configure the frame decoding Parameters.

public class FrameDecodingParameters

Attributes

MaxQueueLength

The maximum number of frames waiting for decoding.

int 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 Dynamsoft.DBR.FrameDecodingParameters.MaxResultQueueLength

Value Range
[0,0x7fffffff]

Default Value
10

Width

The width of the frame image in pixels.

int Dynamsoft.DBR.FrameDecodingParameters.Width

Value Range
[0,0x7fffffff]

Default Value
0

Height

The height of the frame image in pixels.

int Dynamsoft.DBR.FrameDecodingParameters.Height

Value Range
[0,0x7fffffff]

Default Value
0

Stride

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

int Dynamsoft.DBR.FrameDecodingParameters.Stride

Value Range
[0,0x7fffffff]

Default Value
0

ImagePixelFormat

The image pixel format used in the image byte array.

EnumImagePixelFormat Dynamsoft.DBR.FrameDecodingParameters.ImagePixelFormat

Value Range
Any one value of ImagePixelFormat Enumeration items.

Default Value
EnumImagePixelFormat.IPF_GRAYSCALED

Region

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

RegionDefinition 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 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 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 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.

EnumClarityCalculationMethod Dynamsoft.DBR.FrameDecodingParameters.ClarityCalculationMethod

Value Range
Any one of the ClarityCalculationMethod Enumeration items.

Default Value
EnumClarityCalculationMethod.ECCM_CONTRAST

ClarityFilterMode

Sets the mode used for filtering frames by calculated clarity.

EnumClarityFilterMode Dynamsoft.DBR.FrameDecodingParameters.ClarityFilterMode

Value Range
Any one of the ClarityFilterMode Enumeration items.

Default Value
EnumClarityFilterMode.CFM_GENERAL