DSSimplifiedCaptureVisionSettings
The DSSimplifiedCaptureVisionSettings
class contains settings for capturing and recognizing images with the DSCaptureVisionRouter
class.
Definition
Assembly: DynamsoftCaptureVisionRouter.xcframework
- Objective-C
- Swift
@interface DSSimplifiedCaptureVisionSettings : NSObject
class SimplifiedCaptureVisionSettings : NSObject
Attributes
Attributes | Type | Description |
---|---|---|
capturedResultItemTypes |
NSInteger | Specifies the type(s) of CapturedItem(s) that will be captured. |
roi |
DSQuadrilateral | Specifies the region of interest (ROI) of the image or frame where the capture and recognition will take place. |
roiMeasuredInPercentage |
BOOL | Specifies whether the ROI is measured in pixels (false) or as a percentage of the image dimensions (true). |
maxParallelTasks |
NSInteger | Specifies the maximum number of parallel tasks that can be used for image capture and recognition. |
minImageCaptureInterval |
NSInteger | Set the minimum capture interval, measured in milliseconds. |
timeout |
NSInteger | Specifies the maximum time (in milliseconds) allowed for image capture and recognition. |
barcodeSettings |
DSSimplifiedBarcodeReaderSettings | Specifies the settings for the DynamsoftBarcodeReader task. |
labelSettings |
DSSimplifiedLabelRecognizerSettings | Specifies the settings for the DynamsoftLabelRecognizer task. |
documentSettings |
SimplifiedDocumentNormalizerSettings | Specifies the settings for the DynamsoftDocumentNormalizer task. |
capturedResultItemTypes
Specifies the type(s) of CapturedItem(s) that will be returned by the Capture Vision Router.
- Objective-C
- Swift
@property (nonatomic, assign) NSInteger capturedResultItemTypes;
var capturedResultItemTypes: Int { get set }
Remarks
You can specify multiple types. For example, you can use the following code to add CRIT_ORIGINAL_IMAGE
to the captured results of PT_READ_BARCODES
template.
- Objective-C
- Swift
DSSimplifiedCaptureVisionSettings *settings = [self.cvr getSimplifiedSettings:DSPresetTemplateReadBarcodes error:nil]; settings.capturedResultItemTypes = DSCapturedResultItemTypeBarcode | DSCapturedResultItemTypeOriginalImage; [self.cvr updateSettings:DSPresetTemplateDefault settings:settings error:nil];
simplifiedSettings.barcodeSettings?.barcodeFormatIds = [BarcodeFormat.all] simplifiedSettings.capturedResultItemTypes = [.barcode, .originalImage] try! cvr.updateSettings(PresetTemplate.readBarcodes.rawValue, settings: simplifiedSettings)
View
EnumCapturedResultItemType
to learn of all supported result item types.
roi
Specifies the region of interest (ROI) of the image or frame where the capture and recognition will take place.
- Objective-C
- Swift
@property (nonatomic, strong, nullable) DSQuadrilateral *roi;
var roi: DSQuadrilateral? { get set }
roiMeasuredInPercentage
Specifies whether the ROI is measured in pixels (false) or as a percentage of the image dimensions (true).
- Objective-C
- Swift
@property (nonatomic, assign) BOOL roiMeasuredInPercentage;
var roiMeasuredInPercentage: Bool { get set }
maxParallelTasks
Specifies the maximum number of parallel tasks that can be used for image capture and recognition.
- Objective-C
- Swift
@property (nonatomic, assign) NSInteger maxParallelTasks;
var maxParallelTasks: Int { get set }
minImageCaptureInterval
Set the minimum capture interval (in milliseconds) between consecutive frames when capturing via video. In other words, it is a measure of the frequency in which frames are fetched.
- Objective-C
- Swift
@property (nonatomic, assign) NSInteger minImageCaptureInterval;
var minImageCaptureInterval: Int { get set }
Remarks
If you find that the battery consumption when using any of the Dynamsoft Capture Vision products, we recommend setting this parameter to a higher value. Please see this article for more info on how to reduce battery consumption.
timeout
Specifies the maximum time (in milliseconds) allowed for image capture and recognition.
- Objective-C
- Swift
@property (nonatomic, assign) NSInteger timeout;
var timeout: Int { get set }
barcodeSettings
Specifies the settings for the DynamsoftBarcodeReader
task with a SimplifiedBarcodeReaderSettings
object.
- Objective-C
- Swift
@property (nonatomic, strong, nullable) DSSimplifiedBarcodeReaderSettings *barcodeSettings;
var barcodeSettings: DSSimplifiedBarcodeReaderSettings? { get set }
labelSettings
Specifies the settings for the DynamsoftLabelRecognizer
task with a SimplifiedLabelRecognizerSettings
object.
- Objective-C
- Swift
@property (nonatomic, strong, nullable) DSSimplifiedLabelRecognizerSettings *labelSettings;
var labelSettings: DSSimplifiedLabelRecognizerSettings? { get set }
documentSettings
Specifies the settings for the DynamsoftDocumentNormalizer
task with a SimplifiedDocumentNormalizerSettings
object.
- Objective-C
- Swift
@property (nonatomic, strong, nullable) DSSimplifiedDocumentNormalizerSettings *documentSettings;
var documentSettings: DSSimplifiedDocumentNormalizerSettings? { get set }