MultiFrameResultCrossFilter

The MultiFrameResultCrossFilter class is an officially implemented CapturedResultFilter that provides:

• Overlapping: Improves the read rate of multi-barcode scanning.
• Cross Verification: Improves the accuracy.
• Deduplication: Removes the duplicated results.

Definition

Assembly: dynamsoft-capture-vision-react-native

class MultiFrameResultCrossFilter implements CapturedResultFilter

Constructor

new MultiFrameResultCrossFilter(): MultiFrameResultCrossFilter

Methods

destroy

Destroys the MultiFrameResultCrossFilter instance and releases the related resources on the native side.

destroy(): void

enableLatestOverlapping

Enables or disables the latest overlap result filtering. Latest overlap filtering helps in managing results that overlap in the most recent frames.

enableLatestOverlapping(resultItemTypes: number, enable: boolean): any

Parameters

resultItemTypes: EnumCapturedResultItemType value that specifies one or multiple specific result item types.

enable: Whether to enable the overlapping feature.

enableResultCrossVerification

Enables or disables result cross verification for the specified result item types (represented as a combination of EnumCapturedResultItemType). Cross verification helps in validating results across multiple frames, improving accuracy as a result.

enableResultCrossVerification(resultItemTypes: number, enable: boolean): void

Parameters

resultItemTypes: EnumCapturedResultItemType value that specifies one or multiple specific result item types.

enable: Whether to enable the result cross verification.

The verification is enabled by default for CRIT_TEXT_LINE & CRIT_DETECTED_QUAD type result items.

enableResultDeduplication

Enables or disables result deduplication for the specified result item types (represented as a combination of EnumCapturedResultItemType). If this filter is activated, the library will not scan a barcode for an amount of time again after it is scanned successfully for the first time. In order to set the amount of time that the barcode is remembered, please refer to setDuplicateForgetTime.

enableResultDeduplication(resultItemTypes: number, enable: boolean): void

Parameters

resultItemTypes: EnumCapturedResultItemType value that specifies one or multiple specific result item types.

enable: Whether to enable the result deduplication.

getDuplicateForgetTime

Returns the amount of time, in milliseconds, that the deduplication filter takes effect for the specified result item type.

getMaxOverlappingFrames(type: number): Promise<number>

Parameters

type: EnumCapturedResultItemType value that specifies a target result item type.

getMaxOverlappingFrames

Returns the maximum number of overlapping frames to check for the specified result item type.

getMaxOverlappingFrames(type: number): Promise<number>

Parameters

type: EnumCapturedResultItemType value that specifies a target result item type.

isLatestOverlappingEnabled

Checks if the latest overlapping filter is on for the specified result item type.

isLatestOverlappingEnabled(type: number): Promise<boolean>

Parameters

type: EnumCapturedResultItemType value that specifies a target result item type.

isResultCrossVerificationEnabled

Checks if the cross verification filter is on for the specified result item type.

isResultCrossVerificationEnabled(type: number): Promise<boolean>

Parameters

type: EnumCapturedResultItemType value that specifies a target result item type.

isResultDeduplicationEnabled

Checks if the deduplication filter is on for the specified result item type(s).

isResultDeduplicationEnabled(type: number): Promise<boolean>

Parameters

type: EnumCapturedResultItemType value that specifies a target result item type.

setDuplicateForgetTime

Defines the amount of time, in milliseconds, that the deduplication filter takes effect for the specified result item type(s). During this time, the library will not scan a certain barcode for the specified time after it has been scanned successfully for the first time.

setDuplicateForgetTime(types: number, time: number): void

Parameters

resultItemTypes: EnumCapturedResultItemType value that specifies one or multiple specific result item types.

time: Time in milliseconds during which duplicates are disregarded.

setMaxOverlappingFrames

Sets the maximum number of overlapping frames to check when the latest overlap filter is on for the specified result item type(s).

setMaxOverlappingFrames(types: number, maxOverlappingFrames: number): void

Parameters

resultItemTypes: EnumCapturedResultItemType value that specifies one or multiple specific result item types.

maxOverlappingFrames: The maximum overlapping frame count for the overlapping.

setResultCrossVerificationCriteria

Sets the cross-verification criteria for specified result item types. This function allows customization of the multi-frame verification parameters, controlling how many frames are analyzed and how many consistent results are required.

setResultCrossVerificationCriteria(types: EnumCapturedResultItemType | number, criteria: CrossVerificationCriteria)

Parameters

[in] resultItemTypes: Specifies the result item types with CapturedResultItemType.

[in] criteria: Specifies the cross-verification criteria with a CrossVerificationCriteria object.

Remarks

• Introduced in Dynamsoft Barcode Reader SDK version 11.4.1000 and Dynamsoft Capture Vision version 3.4.1000.

getResultCrossVerificationCriteria

Gets the cross-verification criteria for a specified result item type.

getResultCrossVerificationCriteria(type: EnumCapturedResultItemType | number): Promise<CrossVerificationCriteria>

Parameters

[in] resultItemType: Specifies the result item type with CapturedResultItemType.

Return Value

The cross-verification criteria for the specified result item type, of type CrossVerificationCriteria.

Remarks

• Introduced in Dynamsoft Barcode Reader SDK version 11.4.1000 and Dynamsoft Capture Vision version 3.4.1000.