Table of contents

MultiFrameResultCrossFilter

The MultiFrameResultCrossFilter class offers a set of API functions designed for managing and filtering results from multiple image frames, typically used in consecutive frames of a streaming video.

Name Description
enableResultCrossVerification() Enables or disables the verification of specific result item types.
isResultCrossVerificationEnabled() Checks if verification is active for a given result item type.
enableResultDeduplication() Enables or disables the deduplication process for specific result item types.
isResultDeduplicationEnabled() Checks if deduplication is active for a given result item type.
setDuplicateForgetTime() Sets the interval during which duplicates are disregarded for specific result item types.
getDuplicateForgetTime() Retrieves the interval during which duplicates are disregarded for a given result item type.
onOriginalImageResultReceived() Event triggered when the original images are received.
onDecodedBarcodesReceived() Event triggered when the decoded barcodes are received.
onRecognizedTextLinesReceived() Event triggered when the recognized text lines are received.
onDetectedQuadsReceived() Event triggered when the detected quadrilaterals are received.
onNormalizedImagesReceived() Event triggered when the normalized images are received.

enableResultCrossVerification

Enables or disables the verification of specific result item types.

enableResultCrossVerification(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image", enabled: boolean): void;

Parameters

resultItemTypes: Specifies the result item types.

enabled: Boolean to toggle verification on or off.

Return Value

None.

See Also

EnumCapturedResultItemType

isResultCrossVerificationEnabled

Checks if verification is active for a given result item type.

isResultCrossVerificationEnabled(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image"): boolean;

Parameters

resultItemType: Specifies the result item type in question.

Return Value

Boolean indicating the status of verification for the specified type.

See Also

EnumCapturedResultItemType

enableResultDeduplication

Enables or disables the deduplication process for specific result item types.

enableResultDeduplication(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image", enabled: boolean): void;

Parameters

resultItemTypes: Specifies the result item types.

enabled: Boolean to toggle deduplication on or off.

Return Value

None.

See Also

EnumCapturedResultItemType

isResultDeduplicationEnabled

Checks if deduplication is active for a given result item type.

isResultDeduplicationEnabled(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image"): boolean;

Parameters

resultItemType: Specifies the result item type in question.

Return Value

Boolean indicating the deduplication status for the specified type.

See Also

EnumCapturedResultItemType

setDuplicateForgetTime

Sets the interval during which duplicates are disregarded for specific result item types.

setDuplicateForgetTime(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image", time: number): void;

Parameters

resultItemTypes: Specifies the result item types.

time: Time in milliseconds during which duplicates are disregarded. The maximum time allowed is 10,000 milliseconds or 10 seconds.

Return Value

None.

See Also

EnumCapturedResultItemType

getDuplicateForgetTime

Retrieves the interval during which duplicates are disregarded for a given result item type.

getDuplicateForgetTime(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image"): number;

Parameters

resultItemType: Specifies the result item type in question.

Return Value

The set interval for the specified item type.

See Also

EnumCapturedResultItemType

onOriginalImageResultReceived

Event triggered when the original images are received.

onOriginalImageResultReceived?: (result: Core.OriginalImageResultItem) => void;

Parameters

result: The result item that contains the original image, of type OriginalImageResultItem.

Return Value

None.

onDecodedBarcodesReceived

Event triggered when the decoded barcodes are received.

onDecodedBarcodesReceived?: (result: any) => void;

Parameters

result: The result item that contains the decoded barcodes, of type any.

Return Value

None.

onRecognizedTextLinesReceived

Event triggered when the recognized text lines are received.

onRecognizedTextLinesReceived?: (result: any) => void;

Parameters

result: The result item that contains the recognized text lines, of type any.

Return Value

None.

onDetectedQuadsReceived

Event triggered when the detected quadrilaterals are received.

onDetectedQuadsReceived?: (result: any) => void;

Parameters

result: The result item that contains the detected quadrilaterals, of type any.

Return Value

None.

onNormalizedImagesReceived

Event triggered when the normalized images are received.

onNormalizedImagesReceived?: (result: any) => void;

Parameters

result: The result item that contains the normalized images, of type any.

Return Value

None.

This page is compatible for:

Is this page helpful?

YesYes NoNo

In this article: