DSSimplifiedCaptureVisionSettings

The DSSimplifiedCaptureVisionSettings class contains settings for capturing and recognizing images with the DSCaptureVisionRouter class.

Definition

Assembly: DynamsoftCore.xcframework

Objective-C
Swift

@interface DSSimplifiedCaptureVisionSettings : NSObject

class SimplifiedCaptureVisionSettings : NSObject

Attributes

Attributes	Type	Description
`capturedResultItemTypes`	NSInteger	Specifies the types of result items that are expected to be returned.
`roi`	DSQuadrilateral *	Designates the region of interest (ROI) within an image, limiting the image processing activities exclusively to this specified area.
`roiMeasuredInPercentage`	BOOL	Determines if the coordinates for the region of interest (ROI) are expressed in percentage terms (true) or as exact pixel measurements (false).
`maxParallelTasks`	NSInteger	Specifies the maximum number of parallel tasks that can be used for image capture and recognition.
`timeout`	NSInteger	Specifies the maximum time (in milliseconds) allowed for image capture and recognition.
`barcodeSettings`	DSSimplifiedBarcodeReaderSettings *	Specifies the basic settings for the barcode reader module.
`labelSettings`	DSSimplifiedLabelRecognizerSettings *	Specifies the basic settings for the label recognizer module.
`documentSettings`	DSSimplifiedDocumentNormalizerSettings *	Specifies the basic settings for document normalizer module.
`minImageCaptureInterval`	NSInteger	Set the minimum capture interval. It is measured in millisecond.

capturedResultItemTypes

Specifies the types of result items that are expected to be returned.

Objective-C
Swift

@property (nonatomic, assign) NSInteger capturedResultItemTypes;

var capturedResultItemTypes: Int { get set }

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 about all supported result item types.

roi

Specifies the region of interest (ROI) where the image 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 or as a percentage of the image size.

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 }
```

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 basic settings for the barcode reader module.

Objective-C
Swift

@property (nonatomic, strong, nullable) DSSimplifiedBarcodeReaderSettings *barcodeSettings;

var barcodeSettings: DSSimplifiedBarcodeReaderSettings? { get set }

labelSettings

Specifies the basic settings for the label recognizer module.

Objective-C
Swift

@property (nonatomic, strong, nullable) DSSimplifiedLabelRecognizerSettings *labelSettings;

var labelSettings: DSSimplifiedLabelRecognizerSettings? { get set }

documentSettings

Specifies the basic settings for document normalizer module.

Objective-C
Swift

@property (nonatomic, strong, nullable) DSSimplifiedDocumentNormalizerSettings *documentSettings;

var documentSettings: DSSimplifiedDocumentNormalizerSettings? { get set }

minImageCaptureInterval

Specifies the minimum image capture interval.

Objective-C
Swift

@property (nonatomic, assign) NSInteger minImageCaptureInterval;

var minImageCaptureInterval: Int { get set }