iFrameDecodingParameters
Defines a struct to configure the frame decoding Parameters.
Typedefs
@interface iFrameDecodingParameters
Attributes
| Attribute | Type |
|---|---|
maxQueueLength |
NSInteger |
maxResultQueueLength |
NSInteger |
width |
NSInteger |
height |
NSInteger |
stride |
NSInteger |
imagePixelFormat |
EnumImagePixelFormat |
region |
iRegionDefinition |
threshold |
float |
fps |
NSInteger |
autoFilter |
NSInteger |
clarityCalculationMethod |
EnumClarityCalculationMethod |
clarityFilterMode |
EnumClarityFilterMode |
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
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
threshold
The threshold used for filtering frames.
float threshold
Value range
[0, 1]
Default value
0.1
Remark
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
Remark
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
Remark
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
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
Yes
No