Resource Base
Table of contents

Thanks for downloading Dynamsoft Barcode Reader Package!

Your download will start shortly. If your download does not begin, click here to retry.

Class iFrameDecodingParameters

Defines a struct to configure the frame decoding Parameters.

@interface iFrameDecodingParameters
Attribute Type Descriptions
maxQueueLength NSInteger The maximum number of frames waiting for decoding.
maxResultQueueLength NSInteger The maximum number of frames waiting results (text result/localization result) will be kept for further reference.
width NSInteger The width of the frame image in pixels.
height NSInteger The height of the frame image in pixels.
stride NSInteger The stride (or scan width) of the frame image.
imagePixelFormat EnumImagePixelFormat The image pixel format used in the image byte array.
region iRegionDefinition The region definition of the frame to calculate the internal indicator.
threshold float The threshold used for filtering frames.
fps NSInteger The frequency of calling appendFrame per second.
autoFilter NSInteger Sets whether to filter frames automatically.
clarityCalculationMethod EnumClarityCalculationMethod Sets the method used for calculating the clarity of the frames.
clarityFilterMode EnumClarityFilterMode Sets the mode used for filtering frames by calculated clarity.

maxQueueLength

The maximum number of frames waiting for decoding.

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

NSInteger maxResultQueueLength

Value Range

[0,0x7fffffff]

Default Value

10

width

The width of the frame image in pixels.

NSInteger width

Value Range

[0,0x7fffffff]

Default Value

0

height

The height of the frame image in pixels.

NSInteger height

Value Range

[0,0x7fffffff]

Default Value

0

stride

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

NSInteger stride

Value Range

[0,0x7fffffff]

Default Value

0

imagePixelFormat

The image pixel format used in the image byte array.

EnumImagePixelFormat imagePixelFormat

Value Range

A value of EnumImagePixelFormat Enumeration items.

Default Value

EnumImagePixelFormatGrayScaled

See Also

EnumImagePixelFormat

region

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

iRegionDefinition region

Default Value

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

See Also

iRegionDefinition

threshold

The threshold used for filtering frames.

float threshold

Value Range

[0, 1]

Default Value

0.1

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.

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

NSInteger 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 clarityCalculationMethod

Value Range

Any one of the EnumClarityCalculationMethod Enumeration items.

Default Value

EnumClarityCalculationMethodContrast

See Also

EnumClarityCalculationMethod

clarityFilterMode

Sets the mode used for filtering frames by calculated clarity.

EnumClarityFilterMode clarityFilterMode

Value Range

Any one of the EnumClarityFilterMode Enumeration items.

Default Value

EnumClarityFilterModeGeneral

See Also

EnumClarityFilterMode

This page is compatible for:

Version 7.5.0

Is this page helpful?

YesYes NoNo

In this article:

latest version

  • Latest version
  • Version 8.6.0
  • Version 8.4.0
  • Version 8.2.5
  • Version 8.2.3
  • Version 8.2.1
  • Version 8.2.0
  • Version 8.1.3
  • Version 8.1.2
  • Version 8.1.0
  • Version 8.0.0
  • Version 7.6.0
  • Version 7.5.0
Change +
© 2003–2021 Dynamsoft. All rights reserved.
Privacy Statement / Site Map / Home / Purchase / Support