Release Notes for iOS SDK - v2.x

2.2.11 (04/17/2024)

• Updated the privacy list of DynamsoftDocumentNormalizer.xcframework and other related libraries.

2.2.10.1 (03/11/2024)

Fixed

• Fixed a bug where license error is misreported when method getIntermediateResultManager is triggered.

2.2.10 (03/07/2024)

New

• Updated the template system
  • Added ReferenceTaskNameArray under Location.ReferenceObjectFilter to filter the reference objects generated by the task name.
  • Added the support of the OutputTaskSetting definition. The following subparameters are available in OutputTaskSetting object:
    • OutputCondition
      • TaskResultArray
      • TargetROIDefName
      • TaskSettingNameArray
      • BackwardReferenceOutput
        • ReferenceTaskNameArray
        • ReferenceResultTypeArray
      • Operator
    • Name
  • Offset parameter is optimized.
    • Added ReferenceObjectType to specify whether the reference object is an atomic object or the whole image.
    • Added ReferenceXAxis & ReferenceYAxis to define the X & Y axis.
    • Modified FirstPoint, SecondPoint, ThirdPoint & FourthPoint. You can specify whether the X or Y coordinate of the point is measured by percentage.
    • Deprecated ReferenceObjectSize Type.
• The following classes are migrated from DynamsoftCore.xcframework into DynamsoftCaptureVision.xcframework:
  • DSCapturedResult
  • DSIntermediateResultReceiver
  • DSCapturedResultReceiver
  • DSCapturedResultFilter
  • DSIntermediateResultManager
• Added a new call back method onShortLinesUnitReceived to the DSIntermediateResultReceiver class.
• Added methods pauseCapturing and resumeCapturing. Two new enumeration members, CapturedStatePaused and CapturedStateResumed, are added to DSCapturedState as well.
• Added a new property documentSettings to class DSSimplifiedCaptureVisionSettings. The corresponding class DSSimplifiedDocumentNormalizerSettings is added to the DynamsoftDocumentNormalizer.xcframework to store the documentSettings.
• Added a new property resultUnitTypesOnlyForInput to the ObservationParameters class to specify the input only result unit.
• Added the following methods to the RegionObjectElement class to support the intermediate result modification.
  • setLocation
  • clone
  • retain
  • release
• Added a new method replace to the DSIntermediateResultUnit class to support the replacement of intermediate result units.
• Added setImageData methods to the following classes:
  • DSColourImageUnit
  • DSScaledDownColourImageUnit
  • DSGrayscaleImageUnit
  • DSTransformedGrayscaleImageUnit
  • DSEnhancedGrayscaleImageUnit
  • DSBinaryImageUnit
  • DSTextureRemovedGrayscaleImageUnit
  • DSTextureRemovedBinaryImageUnit
  • DSTextRemovedBinaryImageUnit
• Added new methods to the DSPredetectedRegionsUnit class to add, remove or set the predetected regions.
• Added new methods to the DSLineSegmentsUnit class to add, remove or set the line segments.
• Added new methods to the DSTextZonesUnit class to add, remove or set the text zones. Added a new class CTextZone to store the information of a single text zone.
• Added a new method setContours to the DSContourUnit class.
• Added new methods to the DSTextureDetectionResultUnit class to set the X & Y spacing.
• Added a new intermediate result unit, DSShortLinesUnit, to output the detected short lines. The corresponding enumeration member DSIntermediateResultUnitTypeShortLines is added to the DSIntermediateResultUnitType.
• Added the following methods to the DSCapturedResultItem class
  • getTargetROIDefName
  • getTaskName
  • retain
  • release
• Added the following new error codes
  • DSErrorImageSizeNotMatch
  • DSErrorImagePixelFormatNotMatch
  • DSErrorSectionLevelResultIrreplaceable
  • DSErrorAxisDefinitionIncorrect
  • DSErrorTextLineGroupLayoutConflict
  • DSErrorTextLineGroupRegexConflict
• Added the following methods to the DSCapturedResult class.
  • retain
  • release
• Added a new supported image pixel format, binary 8 inverted. The corresponding enumeration member is added to the DSImagePixelFormat.
• Added return value for the retain method of the DSIntermediateResultUnit class. The method will return the pointer of the current DSIntermediateResultUnit.

Breaking Changes

• Changed the logic of the stopCapturing method.
  • DSCaptureResultReceiver will not receive results after stopCapturing is triggered with waitForRemainingTasks false.
  • Support stop capturing after the pauseCapturing method is triggered.
• Changed the logic of the capturedResultItemTypes setting of DSSimplifiedCaptureVisionSettings:
  • If the result item types don’t match the specified template, the method updateSettings will return the error code DSErrorParameterValueInvalid with the message “The captured result item types do not match the task configurations in the template”.
  • Based on the capturedResultItemTypes setting, the irrelevant tasks will be removed from the template.
  • The capturedResultItemTypes should include at least one of the DSCapturedResultItemTypeBarcode, DSCapturedResultItemTypeTextLine, DSCapturedResultItemTypeDetectedQuad, DSCapturedResultItemTypeNormalizedImage. Otherwise, the method updateSettings will return the error code DSErrorParameterValueInvalid with the message “The captured result item types should contain at least one task result type”.
• Refactored the DSContour class. Please view API reference - DSContour class for more information.

Fixed

• Fixed a crash bug that might happen when triggering the setNextImageToReturn method of the DSImageSourceAdapter class.

2.0.20 (12/12/2023)

New

• Added parameter Page to ImageSource object.
• Added a new method setPages to the class DirectoryFetcher and class FileFetcher.
• Added ImageSourceErrorListener to receive the errors from an image source.
• Added method setErrorListener to class ImageSourceAdapter to add the ImageSourceErrorListener.
• Added a new parameter minImageCaptureInterval which can be set via the class SimplifiedCaptureVisionSettings or the CaptureVisionTemplate object of a JSON template file.
• Added “UNKNOWN” as a supported value of the TextDetectionMode.direction parameter. Changed the default value of direction to “UNKNOWN”.
• Added the following error codes:
  • EC_FILE_ALREADY_EXISTS
  • EC_CREATE_FILE_FAILED
  • EC_IMGAE_DATA_INVALID

Improved

• The class DirectoryFetcher and FileFetcher will be able to return error codes via ImageSourceErrorListener
• Updated the error codes of the method saveToFile of the class ImageManager.
• Optimize the logic to support calling IntermediateResultManager.addResultReceiver and IntermediateResultManager.removeResultReceiver after startCapturing.
• Added ability to output all templates via methods outputSettings and outputSettingsToFile by specifying “*” for the parameter templateName.

Fixed

• Small fixes and tweaks.

Changed

• Updated the internal package dependencies rules.
• Changed the upper limit to the duplicateForgetTime, which is 3 minutes.
• Changed the timing of onOriginalImageResultReceived so that it is triggered immediately after receiving the image.

2.0.10 (08/10/2023)

DynamsoftDocumentNormalizer SDK has been revamped to integrate with DynamsoftCaptureVision (DCV) architecture, which is newly established to aggregate the features of functional products powered by Dynamsoft. The features are designed to be pluggable, customizable and interactable. In addition, the functional products share the computation so that their processing speed is much higher than working individually.

• DynamsoftCaptureVision architecture consists of:
  • ImageSourceAdapter(ISA), the standard input interface for you to convert image data from different sources into the standard input image data. In addition, ISA incorporates an image buffer management system that allows instant access to the buffered image data.
  • CaptureVisionRouter (CVR), an engine for you to update templates, retrieve images from ISA, coordinate corresponding functional products and dispatch the results to the receivers.
  • Functional products that perform image processing, content understanding and semantic processing. The functional products are pluggable and passively called by CVR when they are required.
  • Result receiver interfaces. You can implement CapturedResultReceiver (CRR) to receive the CapturedResults that output when the processing on an image is finalized. You can also implement IntermediateResultReceiver (IRR) to get timely results from different stages of the workflow.
• The parameter template system has been comprehensively upgraded.
  • Multiple algorithm task settings are available. You can define barcode decoding, label recognizing, document scanning and semantic processing tasks in one template file.
  • Extended the feature of the ROI system. By configuring the target ROI parameters, you can not only specify an ROI on the original image but also define the dependencies of the algorithm tasks. This feature enables you to customize the workflow when processing complex scenarios.
  • The image processing parameters are separated from the task parameters so that the template settings become more clear and concise.
• The intermediate result system has been improved.
  • Achieved the intermediate result sharing between different functional products. The results that have the same image source and processing parameters are directly reused, which speeds up the image processing workflow. You don’t need to add any additional code to enable the intermediate result sharing. The library can recognize all the reusable results automatically based on the template file you uploaded.
  • The readability and interactivity of the intermediate results are enhanced. IntermediateResultReceiver allows you to receive up to 27 different types of Intermediate results. You can clearly read which stage of the algorithm each result is output from. In addition, IntermediateResultManager allows you to intervene in the workflows by modifying the intermediate results.