DSIntermediateResultReceiver

The IntermediateResultReceiver class is designed as a standardized way for retrieving intermediate results in image processing workflows in the Dynamsoft Capture Vision architecture.

Definition

Assembly: DynamsoftCaptureVisionBundle.xcframework

Objective-C
Swift

@protocol DSIntermediateResultReceiver <NSObject>

protocol IntermediateResultReceiver: NSObjectProtocol

Methods

Method	Description
getObservationParameters	Gets the observed parameters of the intermediate result receiver.
`onTargetROIResultsReceived`	The callback triggered when the processing of a target-ROI is finished.
`onTaskResultsReceived`	The callback triggered when the processing of a task is finished.
`onPredetectedRegionsReceived`	The callback triggered when pre-detected regions are received.
`onLocalizedBarcodesReceived`	The callback triggered when localized barcodes are received.
`onDecodedBarcodesReceived`	The callback triggered when decoded barcodes are received.
`onLocalizedTextLinesReceived`	The callback triggered when localized text lines are received.
`onRecognizedTextLinesReceived`	The callback triggered when recognized text lines are received.
`onDetectedQuadsReceived`	The callback triggered when detected quads are received.
`onDeskewedImagesReceived`	The callback triggered when deskewed images are received.
`onEnhancedImageReceived`	The callback triggered when enhanced images are received.
`onColourImageUnitReceived`	The callback triggered when a colour image unit is received.
`onScaledColourImageUnitReceived`	The callback triggered when a scaled-down colour image unit is received.
`onGrayscaleImageUnitReceived`	The callback triggered when a grayscale image unit is received.
`onTransformedGrayscaleImageUnitReceived`	The callback triggered when a transformed grayscale image unit is received.
`onEnhancedGrayscaleImageUnitReceived`	The callback triggered when an enhanced grayscale image unit is received.
`onBinaryImageUnitReceived`	The callback triggered when a binary image unit is received.
`onTextureDetectionResultUnitReceived`	The callback triggered when a texture detection result unit is received.
`onTextureRemovedGrayscaleImageUnitReceived`	The callback triggered when a texture-removed grayscale image unit is received.
`onTextureRemovedBinaryImageUnitReceived`	The callback triggered when a texture-removed binary image unit is received.
`onContoursUnitReceived`	The callback triggered when a contours unit is received.
`onLineSegmentsUnitReceived`	The callback triggered when a line segments unit is received.
`onTextZonesUnitReceived`	The callback triggered when a text zones unit is received.
`onTextRemovedBinaryImageUnitReceived`	The callback triggered when a text-removed binary image unit is received.
`onShortLinesUnitReceived`	The callback triggered when a short lines unit is received.
`onLogicLinesUnitReceived`	The callback triggered when a logic lines unit is received.
`onLongLinesUnitReceived`	The callback triggered when a long lines unit is received.
`onCornersUnitReceived`	The callback triggered when a corners unit is received.
`onCandidateQuadEdgesUnitReceived`	The callback triggered when a candidate quad edges unit are detected.
`onCandidateBarcodeZonesUnitReceived`	The callback triggered when a candidate barcode zones unit are detected.
`onScaledBarcodeImageUnitReceived`	The callback triggered when a scaled-up barcode image unit is received.
`onDeformationResistedBarcodeImageUnitReceived`	The callback triggered when a deformation-resisted barcode image unit is received.
`onComplementedBarcodeImageUnitReceived`	The callback triggered when a complemented barcode image unit is received.
`onRawTextLinesUnitReceived`	The callback triggered when a raw text lines unit is received.

getObservationParameters

Get the observed parameters of the intermediate result receiver.

Objective-C
Swift

-(ObservationParameters *)getObservationParameters;

func getObservationParameters() -> ObservationParameters

Return Value

An ObservationParameters object.

onTargetROIResultsReceived

The callback triggered when the processing of a target ROI is finished.

Objective-C
Swift

-(void)onTargetROIResultsReceived:(IntermediateResult *)unit
                         info:(DSIntermediateResultExtraInfo *)info

func onTargetROIResultsReceived(_ unit: IntermediateResult, info: IntermediateResultExtraInfo)

onTaskResultsReceived

The callback triggered when the processing of a task is finished.

Objective-C
Swift

-(void)onTaskResultsReceived:(IntermediateResult *)unit
                    info:(DSIntermediateResultExtraInfo *)info

func onTaskResultsReceived(_ unit: IntermediateResult, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result from the task, of type IntermediateResult.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onPredetectedRegionsReceived

The callback triggered when pre-detected regions are received.

Objective-C
Swift

-(void)onPredetectedRegionsReceived:(PredetectedRegionsUnit *)unit
                           info:(IntermediateResultExtraInfo *)info

func onPredetectedRegionsReceived(_ unit: PredetectedRegionsUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the pre-detected regions, of type PredetectedRegionsUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onLocalizedBarcodesReceived

The callback triggered when localized barcodes are received.

Objective-C
Swift

-(void)onLocalizedBarcodesReceived:(LocalizedBarcodesUnit *)unit
                          info:(IntermediateResultExtraInfo *)info

func onLocalizedBarcodesReceived(_ unit: LocalizedBarcodesUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the localized barcodes, of type LocalizedBarcodesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onDecodedBarcodesReceived

The callback triggered when decoded barcodes are received.

Objective-C
Swift

-(void)onDecodedBarcodesReceived:(DecodedBarcodesUnit *)unit
                        info:(IntermediateResultExtraInfo *)info

func onDecodedBarcodesReceived(_ unit: DecodedBarcodesUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the decoded barcodes, of type DecodedBarcodesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onLocalizedTextLinesReceived

The callback triggered when localized text lines are received.

Objective-C
Swift

-(void)onLocalizedTextLinesReceived:(LocalizedTextLinesUnit *)unit
                           info:(IntermediateResultExtraInfo *)info

func onLocalizedTextLinesReceived(_ unit: LocalizedTextLinesUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the localized text lines, of type LocalizedTextLinesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onRecognizedTextLinesReceived

The callback triggered when recognized text lines are received.

Objective-C
Swift

-(void)onRecognizedTextLinesReceived:(RecognizedTextLinesUnit *)unit
                            info:(IntermediateResultExtraInfo *)info

func onRecognizedTextLinesReceived(_ unit: RecognizedTextLinesUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the recognized text lines, of type RecognizedTextLinesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onDetectedQuadsReceived

The callback triggered when detected quads are received.

Objective-C
Swift

-(void)onDetectedQuadsReceived:(DetectedQuadsUnit *)unit
                      info:(IntermediateResultExtraInfo *)info

func onDetectedQuadsReceived(_ unit: DetectedQuadsUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the detected quads, of type DetectedQuadsUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onDeskewedImagesReceived

The callback triggered when deskewed images are received.

Objective-C
Swift

-(void)onDeskewedImagesReceived:(DeskewedImagesUnit *)unit
                       info:(IntermediateResultExtraInfo *)info

func onDeskewedImagesReceived(_ unit: DeskewedImagesUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the deskewed images, of type DeskewedImagesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onEnhancedImagesReceived

The callback triggered when enhanced images are received.

Objective-C
Swift

-(void)onEnhancedImagesReceived:(EnhancedImagesUnit *)unit
                         info:(IntermediateResultExtraInfo *)info

func onEnhancedImagesReceived(_ unit: EnhancedImagesUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the enhanced images, of type EnhancedImagesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onColourImageUnitReceived

The callback triggered when colour images are received.

Objective-C
Swift

-(void)onColourImageUnitReceived:(ColourImageUnit *)unit
                        info:(IntermediateResultExtraInfo *)info

func onColourImageUnitReceived(_ unit: ColourImageUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the colour images, of type ColourImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onScaledColourImageUnitReceived

The callback triggered when up or down scaled colour images are received.

Objective-C
Swift

-(void)onScaledColourImageUnitReceived:(ScaledColourImageUnit *)unit
                                  info:(IntermediateResultExtraInfo *)info

func onScaledColourImageUnitReceived(_ unit: ScaledColourImageUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the up or down scaled colour images, of type ScaledColourImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onGrayscaleImageUnitReceived

The callback triggered when grayscale images are received.

Objective-C
Swift

-(void)onGrayscaleImageUnitReceived:(GrayscaleImageUnit *)unit
                           info:(IntermediateResultExtraInfo *)info

func onGrayscaleImageUnitReceived(_ unit: GrayscaleImageUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the grayscale images, of type GrayscaleImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onTransformedGrayscaleImageUnitReceived

The callback triggered when transformed grayscale images are received.

Objective-C
Swift

-(void)onTransformedGrayscaleImageUnitReceived:(TransformedGrayscaleImageUnit *)unit
                                      info:(IntermediateResultExtraInfo *)info

func onTransformedGrayscaleImageUnitReceived(_ unit: TransformedGrayscaleImageUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the transformed grayscale images, of type TransformedGrayscaleImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onEnhancedGrayscaleImageUnitReceived

The callback triggered when enhanced grayscale images are received.

Objective-C
Swift

-(void)onEnhancedGrayscaleImageUnitReceived:(EnhancedGrayscaleImageUnit *)unit
                                   info:(IntermediateResultExtraInfo *)info

func onEnhancedGrayscaleImageUnitReceived(_ unit: EnhancedGrayscaleImageUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the enhanced grayscale images, of type EnhancedGrayscaleImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onBinaryImageUnitReceived

The callback triggered when binary images are received.

Objective-C
Swift

-(void)onBinaryImageUnitReceived:(BinaryImageUnit *)unit
                        info:(IntermediateResultExtraInfo *)info

func onBinaryImageUnitReceived(_ unit: BinaryImageUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the binary images, of type BinaryImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onTextureDetectionResultUnitReceived

The callback triggered when texture detection results are received.

Objective-C
Swift

-(void)onTextureDetectionResultUnitReceived:(TextureDetectionResultUnit *)unit
                                   info:(IntermediateResultExtraInfo *)info

func onTextureDetectionResultUnitReceived(_ unit: TextureDetectionResultUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the texture detection results, of type TextureDetectionResultUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onTextureRemovedGrayscaleImageUnitReceived

The callback triggered when texture removed grayscale images are received.

Objective-C
Swift

-(void)onTextureRemovedGrayscaleImageUnitReceived:(TextureRemovedGrayscaleImageUnit *)unit
                                         info:(IntermediateResultExtraInfo *)info

func onTextureRemovedGrayscaleImageUnitReceived(_ unit: TextureRemovedGrayscaleImageUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the texture removed grayscale images, of type TextureRemovedGrayscaleImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onTextureRemovedBinaryImageUnitReceived

The callback triggered when texture removed binary images are received.

Objective-C
Swift

-(void)onTextureRemovedBinaryImageUnitReceived:(TextureRemovedBinaryImageUnit *)unit
                                      info:(IntermediateResultExtraInfo *)info

func onTextureRemovedBinaryImageUnitReceived(_ unit: TextureRemovedBinaryImageUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the texture removed binary images, of type TextureRemovedBinaryImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onContoursUnitReceived

The callback triggered when contours are received.

Objective-C
Swift

-(void)onContoursUnitReceived:(ContoursUnit *)unit
                     info:(DSIntermediateResultExtraInfo *)info

func onContoursUnitReceived(_ unit: ContoursUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the contours, of type ContoursUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onShortLinesUnitReceived

The callback triggered when short lines are received.

Objective-C
Swift

- (void)onShortLinesUnitReceived:(DSShortLinesUnit*) unit
                        info:(DSIntermediateResultExtraInfo *)info;

func onShortLinesUnitReceived(_ unit: ShortLinesUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the short lines, of type DSShortLinesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onLineSegmentsUnitReceived

The callback triggered when line segments are received.

Objective-C
Swift

-(void)onLineSegmentsUnitReceived:(LineSegmentsUnit *)unit
                         info:(DSIntermediateResultExtraInfo *)info

func onLineSegmentsUnitReceived(_ unit: LineSegmentsUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the line segments, of type LineSegmentsUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onTextZonesUnitReceived

The callback triggered when text zones are received.

Objective-C
Swift

-(void)onTextZonesUnitReceived:(TextZonesUnit *)unit
                      info:(DSIntermediateResultExtraInfo *)info

func onTextZonesUnitReceived(_ unit: TextZonesUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the text zones, of type TextZonesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onTextRemovedBinaryImageUnitReceived

The callback triggered when text removed binary images are received.

Objective-C
Swift

-(void)onTextRemovedBinaryImageUnitReceived:(TextRemovedBinaryImageUnit *)unit
                                   info:(DSIntermediateResultExtraInfo *)info

func onTextRemovedBinaryImageUnitReceived(_ unit: TextRemovedBinaryImageUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the text removed binary images, of type TextRemovedBinaryImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onLogicLinesUnitReceived

The callback triggered when logic lines are received.

Objective-C
Swift

-(void)onLogicLinesUnitReceived:(LogicLinesUnit *)unit
                      info:(DSIntermediateResultExtraInfo *)info

func onLogicLinesUnitReceived(_ unit: LogicLinesUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the logic lines, of type LogicLinesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onLongLinesUnitReceived

The callback triggered when long lines are received.

Objective-C
Swift

-(void)onLongLinesUnitReceived:(LongLinesUnit *)unit
                      info:(DSIntermediateResultExtraInfo *)info

func onLongLinesUnitReceived(_ unit: LongLinesUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the long lines, of type LongLinesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onCornersUnitReceived

The callback triggered when corners are received.

Objective-C
Swift

-(void)onCornersUnitReceived:(CornersUnit *)unit
                    info:(DSIntermediateResultExtraInfo *)info

func onCornersUnitReceived(_ unit: CornersUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the corners, of type CornersUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onCandidateQuadEdgesUnitReceived

The callback triggered when candidate quad edges are received.

Objective-C
Swift

-(void)onCandidateQuadEdgesUnitReceived:(CandidateQuadEdgesUnit *)unit
                               info:(DSIntermediateResultExtraInfo *)info

func onCandidateQuadEdgesUnitReceived(_ unit: CandidateQuadEdgesUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the candidate quad edges, of type CandidateQuadEdgesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onCandidateBarcodeZonesUnitReceived

The callback triggered when candidate barcode zones are received.

Objective-C
Swift

-(void)onCandidateBarcodeZonesUnitReceived:(CandidateBarcodeZonesUnit *)unit
                                  info:(DSIntermediateResultExtraInfo *)info

func onCandidateBarcodeZonesUnitReceived(_ unit: CandidateBarcodeZonesUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the candidate barcode zones, of type CandidateBarcodeZonesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onScaledBarcodeImageUnitReceived

The callback triggered when scaled up barcode images are received.

Objective-C
Swift

-(void)onScaledBarcodeImageUnitReceived:(ScaledBarcodeImageUnit *)unit
                                 info:(DSIntermediateResultExtraInfo *)info

func onScaledBarcodeImageUnitReceived(_ unit: ScaledBarcodeImageUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the scaled up barcode images, of type ScaledBarcodeImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onDeformationResistedBarcodeImageUnitReceived

The callback triggered when deformation resisted barcode images are received.

Objective-C
Swift

-(void)onDeformationResistedBarcodeImageUnitReceived:(DeformationResistedBarcodeImageUnit *)unit
                                            info:(DSIntermediateResultExtraInfo *)info

func onDeformationResistedBarcodeImageUnitReceived(_ unit: DeformationResistedBarcodeImageUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the deformation resisted barcode images, of type DeformationResistedBarcodeImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onComplementedBarcodeImageUnitReceived

The callback triggered when complemented barcode images are received.

Objective-C
Swift

-(void)onComplementedBarcodeImageUnitReceived:(ComplementedBarcodeImageUnit *)unit
                                     info:(DSIntermediateResultExtraInfo *)info

func onComplementedBarcodeImageUnitReceived(_ unit: ComplementedBarcodeImageUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the complemented barcode images, of type ComplementedBarcodeImageUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.

onRawTextLinesUnitReceived

The callback triggered when a raw text lines unit is received.

Objective-C
Swift

-(void)onRawTextLinesUnitReceived:(RawTextLinesUnit *)unit
                         info:(DSIntermediateResultExtraInfo *)info

func onRawTextLinesUnitReceived(_ unit: RawTextLinesUnit, info: IntermediateResultExtraInfo)

Parameters

unit: The intermediate result that contains the raw text lines, of type RawTextLinesUnit.

info: Additional information about the result, of type IntermediateResultExtraInfo.