Barcode Tracking Settings

Defined in framework ScanditBarcodeCapture

SDCBarcodeTrackingSettings

@interface SDCBarcodeTrackingSettings : NSObject <NSCopying>

Added in version 6.0.0

+ settingsWithScenario:

+ (instancetype)settingsWithScenario:(SDCBarcodeTrackingScenario)scenario

Added in version 6.5.0

Creates a new barcode tracking settings instance with the provided scenario.

Check Barcode Tracking Scenarios to know which scenario is best for a given use case.

+ settings

+ (instancetype)settings

Added in version 6.0.0

Creates a new barcode tracking settings instance. All symbologies are disabled. Make sure to enable the symbologies required by your app before applying the settings to SDCBarcodeTracking with

SDCBarcodeTracking.applySettings:completionHandler:.

- initWithScenario:

- (instancetype)initWithScenario:(SDCBarcodeTrackingScenario)scenario

Added in version 6.13.0

Creates a new barcode tracking settings instance with the provided scenario. Check Barcode Tracking Scenarios to know which scenario is best for a given use case.

- settingsForSymbology:

- (nonnull SDCSymbologySettings *)settingsForSymbology:(SDCSymbology)symbology

Added in version 6.0.0

Get SDCSymbologySettings specific for the given SDCSymbology.

Note that modifying the returned object doesn’t automatically apply the changes to SDCBarcodeTracking. After you made changes to the symbology settings,

call SDCBarcodeTracking.applySettings:completionHandler:

with these SDCBarcodeTrackingSettings to apply them.

enabledSymbologies

@property (nonatomic, nonnull, readonly) NSSet<NSNumber *> *enabledSymbologies

Added in version 6.0.0

Returns the set of enabled symbologies.

- enableSymbologies:

- (void)enableSymbologies:(nonnull NSSet<NSNumber *> *)symbologies

Added in version 6.0.0

This function provides a convenient shortcut to enabling decoding of particular symbologies without having to go through SDCSymbologySettings. By default, all symbologies are turned off and symbologies need to be explicitly enabled.

- setSymbology:enabled:

- (void)setSymbology:(SDCSymbology)symbology
             enabled:(BOOL)enabled

Added in version 6.0.0

This function provides a convenient shortcut to enabling/disabling decoding of a particular symbology without having to go through SDCSymbologySettings.

Note

Some 1d barcode symbologies allow you to encode variable-length data. By default, the Scandit Data Capture SDK only scans barcodes in a certain length range.

If your application requires scanning of one of these symbologies, and the length is falling outside the default range, you may need to adjust the active symbol counts for the symbology in addition to enabling it.

- setValue:forProperty:

- (void)setValue:(id)value
     forProperty:(NSString *)property

Added in version 6.0.0

Sets property to the provided value. Use this method to set properties that are not yet part of a stable API. Properties set through this method may or may not be used or change in a future release.

- valueForProperty:

- (nullable id)valueForProperty:(NSString *)property

Added in version 6.0.0

Retrieves the value of a previously set property. In case the property does not exist, -1 is returned.

- setArucoDictionary:

- (void)setArucoDictionary:(SDCArucoDictionary *)dictionary

Added in version 6.19.0

Sets the SDCArucoDictionary to be used while scanning ArUco codes. When the symbology is enabled the dictionary SDCArucoDictionaryPreset_5X5_1000 is loaded as default.