Dev Center
Swift
Objective-C
Table of contents

FrameDecodingParameters

Note:

  • This class is removed in 9.0 version. Please use the video methods for video barcode scanning if you are using the latest version.

Defines a struct to configure the frame decoding Parameters.

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

maxQueueLength

The maximum number of frames waiting for decoding.

int 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 maxResultQueueLength

Value Range

[0,0x7fffffff]

Default Value

10

width

The width of the frame image in pixels.

int width

Value Range

[0,0x7fffffff]

Default Value

0

height

The height of the frame image in pixels.

int height

Value Range

[0,0x7fffffff]

Default Value

0

stride

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

int stride

Value Range

[0,0x7fffffff]

Default Value

0

imagePixelFormat

The image pixel format used in the image byte array.

int 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 region

Default Value

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

See Also

RegionDefinition

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.

int 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 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 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 clarityFilterMode

Value Range

Any one of the EnumClarityFilterMode Enumeration items.

Default Value

CFM_GENERAL

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 (10.2.10)
  • Version 10.x
    • Version 10.0.21
    • Version 10.0.20
  • Version 9.x
    • Version 9.6.40
    • Version 9.6.20
    • Version 9.6.11
    • Version 9.6.10
    • Version 9.6.0
    • Version 9.4.0
    • Version 9.2.13
    • Version 9.2.11
    • Version 9.2.10
    • Version 9.0.2
    • Version 9.0.1
    • Version 9.0.0
  • Version 8.x
    • Version 8.9.3
    • Version 8.9.1
    • Version 8.9.0
    • Version 8.8.0
    • Version 8.6.0
    • Version 8.4.0
    • Version 8.2.1
    • Version 8.2.0
    • Version 8.1.2
    • Version 8.1.0
    • Version 8.0.0
  • Version 7.x
    • Version 7.6.0
    • Version 7.5.0
Change +