Dev Center
Swift
Objective-C
Table of contents

DSCandidateBarcodeZonesUnit Class

DSCandidateBarcodeZonesUnit extends the DSIntermediateResultUnit class and represents a unit which contains a candidate barcode zone.

Definition

Assembly: DynamsoftBarcodeReader.xcframework

  • Objective-C
  • Swift
  1. @interface DSCandidateBarcodeZonesUnit : DSIntermediateResultUnit
    
  2. class CandidateBarcodeZonesUnit : IntermediateResultUnit
    

Methods

Method Description
getCandidateBarcodeZones Returns the candidate barcode zones.
getCount Returns the number of candidate barcode zones.
getCandidateBarcodeZone Returns a candidate barcode zone.
removeAllCandidateBarcodeZones Removes all candidate barcode zones.
removeCandidateBarcodeZone Removes a candidate barcode zone.
addCandidateBarcodeZone Adds a candidate barcode zone.
setCandidateBarcodeZone Sets a candidate barcode zone.

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.

getCandidateBarcodeZones

Returns the candidate barcode zones as an array of DSCandidateBarcodeZone items.

  • Objective-C
  • Swift
  1. -(nullable NSArray< DSCandidateBarcodeZone* >*)getCandidateBarcodeZones;
    
  2. func getCandidateBarcodeZones() -> [CandidateBarcodeZone]?
    

Return Value

An array of DSCandidateBarcodeZone items.

getCount

Returns the number of candidate barcode zones.

  • Objective-C
  • Swift
  1. -(NSInteger)getCount;
    
  2. func getCount() -> Int
    

Return Value

The number of candidate barcode zones.

getCandidateBarcodeZone

Returns the DSCandidateBarcodeZone from the full array of candidate barcode zone(s) as specified by the index.

  • Objective-C
  • Swift
  1. -(DSCandidateBarcodeZone *)getCandidateBarcodeZone:(NSInteger)index;
    
  2. func getCandidateBarcodeZone(index: Int) -> CandidateBarcodeZone?
    

Parameters

index: The index of the candidate barcode zone.

Return Value

A DSCandidateBarcodeZone object.

removeAllCandidateBarcodeZones

Removes all of the candidate barcode zones.

  • Objective-C
  • Swift
  1. -(void)removeAllCandidateBarcodeZones;
    
  2. func removeAllCandidateBarcodeZones()
    

removeCandidateBarcodeZone

Removes the DSCandidateBarcodeZone at the specified index.

  • Objective-C
  • Swift
  1. -(NSInteger)removeCandidateBarcodeZone:(NSInteger)index;
    
  2. func removeCandidateBarcodeZone(index: Int) -> Int
    

Parameters

index: The index of the candidate barcode zone.

Return Value

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

addCandidateBarcodeZone

Adds a CandidateBarcodeZone to the candidate barcode zones array.

  • Objective-C
  • Swift
  1. -(NSInteger)addCandidateBarcodeZone:(DSCandidateBarcodeZone*)barcodeZone
    matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage;
    
  2. func addCandidateBarcodeZone(barcodeZone: CandidateBarcodeZone, matrixToOriginalImage: CGAffineTransform) -> Int
    

Parameters

barcodeZone: The candidate barcode zone to be added.

matrixToOriginalImage: The CGAffineTransform transformation matrix of the original image.

Return Value

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

setCandidateBarcodeZone

Sets the CandidateBarcodeZone at the specified index.

  • Objective-C
  • Swift
  1. -(NSInteger)setCandidateBarcodeZone:(NSInteger)index
                        barcodeZone:(DSCandidateBarcodeZone*)barcodeZone
              matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage;
    
  2. func setCandidateBarcodeZone(index: Int, barcodeZone: CandidateBarcodeZone, matrixToOriginalImage: CGAffineTransform) -> Int
    

Parameters

index: The index of the candidate barcode zone.

barcodeZone: The candidate barcode zone to be set.

matrixToOriginalImage: The CGAffineTransfrom transformation matrix of the original image.

Return Value

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

This page is compatible for:

Version 7.5.0

Is this page helpful?

YesYes NoNo

In this article:

latest version

  • Latest version
  • Version 10.x
    • Version 10.2.10
    • Version 10.0.21
    • Version 10.0.20
    • Version 10.2.10
    • Version 10.0.21
    • Version 10.0.20
  • Version 9.x
    • Version 9.6.40
    • Version 9.6.20
    • Version 9.6.11
    • Version 9.6.10
    • Version 9.6.0
    • Version 9.4.0
    • Version 9.2.11
    • Version 9.2.10
    • Version 9.0.2
    • Version 9.0.1
    • Version 9.0.0
    • Version 9.6.40
    • Version 9.6.20
    • Version 9.6.10
    • Version 9.6.0
    • Version 9.4.0
    • Version 9.2.13
    • Version 9.2.10
    • Version 9.0.2
    • Version 9.0.1
    • Version 9.0.0
  • Version 8.x
    • Version 8.9.3
    • Version 8.9.1
    • Version 8.9.0
    • Version 8.8.0
    • Version 8.6.0
    • Version 8.4.0
    • Version 8.2.1
    • Version 8.2.0
    • Version 8.1.2
    • Version 8.1.0
    • Version 8.0.0
    • Version 8.9.3
    • Version 8.9.1
    • Version 8.9.0
    • Version 8.8.0
    • Version 8.6.0
    • Version 8.4.0
    • Version 8.2.1
    • Version 8.2.0
    • Version 8.1.2
    • Version 8.1.0
    • Version 8.0.0
  • Version 7.x
    • Version 7.6.0
    • Version 7.5.0
    • Version 7.6.0
    • Version 7.5.0
Change +