Class iFrameDecodingParameters
Note:
- This class is removed in 9.0 version. Please use the video methods for video barcode scanning.
Defines a struct to configure the frame decoding Parameters.
- Objective-C
- Swift
@interface iFrameDecodingParameters : NSObject
class iFrameDecodingParameters : NSObject
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.
- Objective-C
- Swift
@property (nonatomic, assign) NSInteger maxQueueLength
var maxQueueLength: Int { get set }
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.
- Objective-C
- Swift
@property (nonatomic, assign) NSInteger maxResultQueueLength
var maxResultQueueLength: Int { get set }
Value Range
[0,0x7fffffff]
Default Value
10
width
The width of the frame image in pixels.
- Objective-C
- Swift
@property (nonatomic, assign) NSInteger width
var width: Int { get set }
Value Range
[0,0x7fffffff]
Default Value
0
height
The height of the frame image in pixels.
- Objective-C
- Swift
@property (nonatomic, assign) NSInteger height
var height: Int { get set }
Value Range
[0,0x7fffffff]
Default Value
0
stride
The stride (or scan width) of the frame image.
- Objective-C
- Swift
@property (nonatomic, assign) NSInteger stride
var stride: Int { get set }
Value Range
[0,0x7fffffff]
Default Value
0
imagePixelFormat
The image pixel format used in the image byte array.
- Objective-C
- Swift
@property (nonatomic, assign) EnumImagePixelFormat imagePixelFormat
var imagePixelFormat: EnumImagePixelFormat { get set }
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.
- Objective-C
- Swift
@property (nonatomic, assign) iRegionDefinition region
var region: iRegionDefinition { get set }
Default Value
{ regionLeft = 0, regionRight = 100, regionTop = 0, regionBottom = 100, regionMeasuredByPercentage = 1 }
See Also
iRegionDefinition
threshold
The threshold used for filtering frames.
- Objective-C
- Swift
@property (nonatomic, assign) float threshold
var threshold: float { get set }
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.
- Objective-C
- Swift
@property (nonatomic, assign) NSInteger fps
var fps: Int { get set }
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.
- Objective-C
- Swift
@property (nonatomic, assign) NSInteger autoFilter
var autoFilter: Int { get set }
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.
- Objective-C
- Swift
@property (nonatomic, assign) EnumClarityCalculationMethod clarityCalculationMethod
var clarityCalculationMethod: EnumClarityCalculationMethod { get set }
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.
- Objective-C
- Swift
@property (nonatomic, assign) EnumClarityFilterMode clarityFilterMode
var clarityFilterMode: EnumClarityFilterMode { get set }
Value Range
Any one of the EnumClarityFilterMode
Enumeration items.
Default Value
EnumClarityFilterModeGeneral
See Also
EnumClarityFilterMode