FrameDecodingParameters

Defines a struct to configure the frame decoding Parameters.

class FrameDecodingParameters

Attributes

max_queue_length

The maximum number of frames waiting for decoding.

FrameDecodingParameters.max_queue_length

Value Range
[0,0x7fffffff]

Default Value
3

max_result_queue_length

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

FrameDecodingParameters.max_result_queue_length

Value Range
[0,0x7fffffff]

Default Value
10

width

The width of the frame image in pixels.

FrameDecodingParameters.width

Value Range
[0,0x7fffffff]

Default Value
0

height

The height of the frame image in pixels.

FrameDecodingParameters.height

Value Range
[0,0x7fffffff]

Default Value
0

stride

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

FrameDecodingParameters.stride

Value Range
[0,0x7fffffff]

Default Value
0

image_pixel_format

The image pixel format used in the image byte array.

FrameDecodingParameters.image_pixel_format

Value Range
A value of ImagePixelFormat Enumeration items.

Default Value
IPF_GRAYSCALED

See Also
ImagePixelFormat

region_top

The region definition of the frame to calculate the internal indicator.The top-most coordinate or percentage of the region.

FrameDecodingParameters.region_top

• Default Value
  0

Value Range
- if region_measured_by_percentage = 0, [0,0x7fffffff] - if region_measured_by_percentage = 1, [0,100]

region_left

The region definition of the frame to calculate the internal indicator.The left-most coordinate or percentage of the region.

FrameDecodingParameters.region_left

• Default Value
  0

Value Range
- if region_measured_by_percentage = 0, [0,0x7fffffff] - if region_measured_by_percentage = 1, [0,100]

region_right

The region definition of the frame to calculate the internal indicator.The right-most coordinate or percentage of the region.

FrameDecodingParameters.region_right

• Default Value
  0

Value Range
- if region_measured_by_percentage = 0, [0,0x7fffffff] - if region_measured_by_percentage = 1, [0,100]

region_bottom

The region definition of the frame to calculate the internal indicator.The bottom-most coordinate or percentage of the region.

FrameDecodingParameters.region_bottom

• Default Value
  0

Value Range
- if region_measured_by_percentage = 0, [0,0x7fffffff] - if region_measured_by_percentage = 1, [0,100]

region_measured_by_percentage

Sets whether or not to use percentage to measure the region size.

FrameDecodingParameters.region_measured_by_percentage

• Default Value
  0

Value Range
[0,1]

region_top

The region definition of the frame to calculate the internal indicator.The top-most coordinate or percentage of the region.

FrameDecodingParameters.region_top

• Default Value
  0

Value Range
- if region_measured_by_percentage = 0, [0,0x7fffffff] - if region_measured_by_percentage = 1, [0,100]

threshold

The threshold used for filtering frames.

FrameDecodingParameters.threshold

Value Range
[0, 1]

Default Value
0.01

Remarks
The SDK will calculate an inner indicator for each frame from append_video_frame, 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 append_video_frame per second.

FrameDecodingParameters.fps

Value Range
[0,0x7fffffff]

Default Value
0

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

auto_filter

Sets whether to filter frames automatically.

FrameDecodingParameters.auto_filter

Value Range
[0,1]

Default Value
1

Remarks
0: Diable filtering frames automatically.
1: Enable filtering frames automatically.

clarity_calculation_method

Sets the method used for calculating the clarity of the frames.

FrameDecodingParameters.clarity_calculation_method

Value Range
Any one of the ClarityCalculationMethod Enumeration items.

Default Value
ECCM_CONTRAST

See Also
ClarityCalculationMethod

clarity_filter_mode

Sets the mode used for filtering frames by calculated clarity.

FrameDecodingParameters.clarity_filter_mode

Value Range
Any one of the ClarityFilterMode Enumeration items.

Default Value
CFM_GENERAL

See Also
ClarityFilterMode

duplicate_forget_time

Set the time period used to ignore duplicate results found in frames. Measured in ms.

FrameDecodingParameters.duplicate_forget_time

Value Range

[0, 600000]

Default Value

3000

Remarks

The library keeps each barcode result (type and value) in the buffer for a period of time (set with duplicate_forget_time) during which if a new result is an exact match, it’s seen as a duplicate and will again be kept for that period of time while the old result is removed and so on.

orientation

Set the orientation of the frame image data. The value is the angle that the image needs to be rotated clockwise so it shows correctly on the display in its natural orientation. It can be 0, 90, 180, or 270.

FrameDecodingParameters.orientation

Value Range

0, 90, 180, or 270

Default Value

0