FrameDecodingParameters

Defines a struct to configure the frame decoding Parameters.

Typedefs

typedef struct tagFrameDecodingParameters  FrameDecodingParameters

Attributes

maxQueueLength

The maximum number of frames waiting for decoding.

int tagFrameDecodingParameters::maxQueueLength

• Value range
  [0,0x7fffffff]

• Default value
  3

maxResultQueueLength

The maximum number of frames waiting results (text result/localization result) will be kept for further reference.

int tagFrameDecodingParameters::maxResultQueueLength

• Value range
  [0,0x7fffffff]

• Default value
  10

width

The width of the frame image in pixels.

int tagFrameDecodingParameters::width

• Value range
  [0,0x7fffffff]

• Default value
  0

height

The height of the frame image in pixels.

int tagFrameDecodingParameters::height

• Value range
  [0,0x7fffffff]

• Default value
  0

stride

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

int tagFrameDecodingParameters::stride

• Value range
  [0,0x7fffffff]

• Default value
  0

imagePixelFormat

The image pixel format used in the image byte array.

ImagePixelFormat tagFrameDecodingParameters::imagePixelFormat

• Value range
  A value of ImagePixelFormat Enumeration items.

• Default value
  IPF_GRAYSCALED

• See also
  ImagePixelFormat

region

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

RegionDefinition tagFrameDecodingParameters::region

• Default value
  { regionLeft = 0, regionRight = 100, regionTop = 0, regionBottom = 100, regionMeasuredByPercentage = 1 }

• See also
  RegionDefinition

threshold

The threshold used for filtering frames.

float tagFrameDecodingParameters::threshold

• Value range
  [0, 1]

• Default value
  0.01

• Remark
  The SDK will calculate an inner indicator for each frame from AppendFrame or DBR_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 or DBR_AppendFrame per second.

int tagFrameDecodingParameters::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 tagFrameDecodingParameters::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.

ClarityCalculationMethod tagFrameDecodingParameters::clarityCalculationMethod

• Value range
  Any one of the ClarityCalculationMethod Enumeration items.

• Default value
  ECCM_CONTRAST

• See also
  ClarityCalculationMethod

clarityFilterMode

Sets the mode used for filtering frames by calculated clarity.

ClarityFilterMode tagFrameDecodingParameters::clarityFilterMode

• Value range
  Any one of the ClarityFilterMode Enumeration items.

• Default value
  CFM_GENERAL

• See also
  ClarityFilterMode

reserved

Reserved memory for the struct. The length of this array indicates the size of the memory reserved for this struct.

char tagFrameDecodingParameters::reserved[28]