DSLocalizedBarcodesUnit Class

DSLocalizedBarcodesUnit extends the DSIntermediateResultUnit class and represents a unit which contains localized barcodes.

Definition

Assembly: DynamsoftCaptureVisionBundle.xcframework

Objective-C
Swift

@interface DSLocalizedBarcodesUnit: DSIntermediateResultUnit

class LocalizedBarcodesUnit : DSIntermediateResultUnit

Methods

Methods	Description
`getLocalizedBarcodes`	Returns an array of `LocalizedBarcodeElement`.
`getCount`	Returns the number of localized barcodes in the unit.
`getLocalizedBarcode`	Returns the `LocalizedBarcodeElement` at the specified index.
`removeAllLocalizedBarcodes`	Removes all the localized barcodes in the unit.
`removeLocalizedBarcode`	Removes the `LocalizedBarcodeElement` at the specified index from the unit.
`addLocalizedBarcode`	Add a new `LocalizedBarcodeElement` to the unit.
`setLocalizedBarcode`	Set a `LocalizedBarcodeElement` at the specified index.

The following methods are inherited from class DSIntermediateResultUnit.

Method	Description
`getHashId`	Gets the hash ID of the unit.
`getOriginalImageHashId`	Gets the hash ID of the original image.
`getOriginalImageTag`	Gets the image tag of the original image.
`getType`	Gets the type of the intermediate result unit.
`getTransformMatrix`	Gets the transformation matrix via `DSTransformMatrixType`.
`clone`	Creates a copy of the intermediate result unit.
`replace`	Replaces the content of the intermediate result unit.

getLocalizedBarcodes

Returns an array of LocalizedBarcodeElement, which contains the detailed information for each localized barcode.

Objective-C
Swift

- (nullable NSArray<DSLocalizedBarcodeElement *> *)getLocalizedBarcodes

func getLocalizedBarcodes() -> [LocalizedBarcodeElement]?

Return value

An array of LocalizedBarcodeElement, which contains the detailed information for each localized barcode.

getCount

Returns the number of localized barcodes (LocalizedBarcodeElement) in the unit.

Objective-C
Swift

```
- (NSInteger)getCount
```
```
func getCount() -> Int
```

Return Value

The number of localized barcodes.

getLocalizedBarcode

Returns the LocalizedBarcodeElement at the specified index.

Objective-C
Swift

- (nullable DSLocalizedBarcodeElement *)getLocalizedBarcode:(NSInteger)index

func getLocalizedBarcode(_ index: Int) -> LocalizedBarcodeElement?

Parameters

[in] index: The index of the localized barcode.

Return value

The LocalizedBarcodeElement at the specified index.

removeAllLocalizedBarcodes

Removes all the localized barcodes in the unit.

Objective-C
Swift

```
- (void)removeAllLocalizedBarcodes
```
```
func removeAllLocalizedBarcodes()
```

removeLocalizedBarcode

Removes the LocalizedBarcodeElement at the specified index from the unit.

Objective-C
Swift

- (NSInteger)removeLocalizedBarcode:(NSInteger)index

func removeLocalizedBarcode(_ index: Int) -> Int

Parameters

[in] index: The index of the localized barcode element.

addLocalizedBarcode

Add a new LocalizedBarcodeElement to the unit.

Objective-C
Swift

-(NSInteger)addLocalizedBarcode:(DSLocalizedBarcodeElement*)element
      matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage;

func addLocalizedBarcode(_ element: LocalizedBarcodeElement, matrixToOriginalImage: CGAffineTransform) -> Int

Parameters

[in] element: The LocalizedBarcodeElement to be added.

[in] matrixToOriginalImage: The CGAffineTransform transformation matrix of the original image.

Return Value

Returns the ErrorCode if it fails. Otherwise, returns 0.

setLocalizedBarcode

Set a LocalizedBarcodeElement at the specified index.

Objective-C
Swift

-(NSInteger)setLocalizedBarcode:(NSInteger)index
                    element:(DSLocalizedBarcodeElement*)element
      matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage;

func setLocalizedBarcode(_ index: Int, element: LocalizedBarcodeElement, matrixToOriginalImage: CGAffineTransform) -> Int

Parameters

[in] index: The index where the localized barcode element will be set.

[in] element: The LocalizedBarcodeElement to be set.

[in] matrixToOriginalImage: The CGAffineTransform transformation matrix of the original image.

Return Value

Returns the ErrorCode if it fails. Otherwise, returns 0.