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.
After setting parameters using any of the APIs below, you must call
addResultFilter()for the changes to take effect.
| Name | Description |
|---|---|
| enableLatestOverlapping() | Enables or disables the to-the-latest overlapping feature of one or multiple specific result item types. This feature can increase the read-rate performance when decoding multiple barcodes under the video streaming. |
| isLatestOverlappingEnabled() | Checks if to-the-latest overlapping is active for a given result item type. |
| enableResultCrossVerification() | Enables or disables the verification of specific result item types. |
| isResultCrossVerificationEnabled() | Checks if verification is active for a given result item type. |
| setResultCrossVerificationCriteria() | Sets the cross-verification criteria (frame window and minimum consistent frames) for one or more result item types. |
| getResultCrossVerificationCriteria() | Retrieves the cross-verification criteria for a specified 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. |
| setMaxOverlappingFrames() | Set the maximum overlapping frames count for a given result item type. |
| getMaxOverlappingFrames() | Get the maximum overlapping frames count 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. |
| onProcessedDocumentResultReceived() | Event triggered when the processed documents are received. |
enableLatestOverlapping
Enables or disables the latest overlapping of specific result item types.
Please note that this feature is currently only available for barcodes reading.
enableLatestOverlapping(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image", enabled: boolean): void;
Parameters
resultItemTypes: Specifies the result item types.
enabled: Boolean to toggle the latest overlapping on or off.
Return Value
None.
See Also
isLatestOverlappingEnabled
Checks if latest overlapping is active for a given result item type.
isLatestOverlappingEnabled(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image"): boolean;
Parameters
resultItemType: Specifies the result item type in question.
Return Value
Boolean indicating the status of the latest overlapping for the specified type.
See Also
enableResultCrossVerification
Enables or disables the verification of specific result item types.
enableResultCrossVerification(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image", enabled: boolean): void;
Parameters
resultItemTypes: Specifies the result item types.
enabled: Boolean to toggle verification on or off.
Return Value
None.
See Also
isResultCrossVerificationEnabled
Checks if verification is active for a given result item type.
isResultCrossVerificationEnabled(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_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
setResultCrossVerificationCriteria
Sets the cross-verification criteria for one or more result item types. This configuration determines how many frames are considered and the minimum number of consistent frames required before a result is accepted.
setResultCrossVerificationCriteria(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image", frameWindow: number, minConsistentFrames: number): void;
Parameters
resultItemTypes: Specifies one or multiple result item types. It can be defined using EnumCapturedResultItemType or a string. Valid string values are "barcode", "text_line", "detected_quad", and "deskewed_image".
frameWindow: The number of consecutive frames considered for verification.
minConsistentFrames: The minimum number of consistent frames required for a result to be considered valid.
Return Value
None.
See Also
Remarks
Added in CaptureVisionBundle version 3.4.2000 & BarcodeReaderBundle version 11.4.2000.
The default criteria per result type are:
| Result Type | frameWindow |
minConsistentFrames |
|---|---|---|
"barcode" (DBR) |
5 | 2 |
"text_line" (DLR) |
5 | 2 |
"detected_quad" / "deskewed_image" (DDN) |
6 | 4 |
getResultCrossVerificationCriteria
Retrieves the cross-verification criteria for a specified result item type, including the configured frame window and minimum consistency requirement.
getResultCrossVerificationCriteria(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image"): { frameWindow: number; minConsistentFrames: number };
Parameters
resultItemType: Specifies the result item type in question. It can be defined using EnumCapturedResultItemType or a string. Valid string values are "barcode", "text_line", "detected_quad", and "deskewed_image".
Return Value
An object containing:
frameWindow:number— the number of consecutive frames considered for verification.minConsistentFrames:number— the minimum number of consistent frames required for a result to be accepted.
See Also
Remarks
Added in CaptureVisionBundle version 3.4.2000 & BarcodeReaderBundle version 11.4.2000.
enableResultDeduplication
Enables or disables the deduplication process for specific result item types.
enableResultDeduplication(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image", enabled: boolean): void;
Parameters
resultItemTypes: Specifies the result item types.
enabled: Boolean to toggle deduplication on or off.
Return Value
None.
See Also
isResultDeduplicationEnabled
Checks if deduplication is active for a given result item type.
isResultDeduplicationEnabled(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image"): boolean;
Parameters
resultItemType: Specifies the result item type in question.
Return Value
Boolean indicating the deduplication status for the specified type.
See Also
setDuplicateForgetTime
Sets the interval during which duplicates are disregarded for specific result item types.
setDuplicateForgetTime(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_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
Remarks
The default value is 3,000 milliseconds. This means that when result deduplication is enabled, identical results appearing within 3 seconds of each other will be filtered out by default.
getDuplicateForgetTime
Retrieves the interval during which duplicates are disregarded for a given result item type.
getDuplicateForgetTime(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image"): number;
Parameters
resultItemType: Specifies the result item type in question.
Return Value
The set interval for the specified item type.
See Also
setMaxOverlappingFrames
Set the maximum overlapping frames count for a given result item type.
setMaxOverlappingFrames(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image", maxOverlappingFrames: number): void;
Parameters
resultItemTypes: Specifies the result item types.
maxOverlappingFrames: The maximum overlapping frame count for the overlapping.
Return Value
None.
See Also
getMaxOverlappingFrames
Get the maximum overlapping frames count for a given result item type.
getMaxOverlappingFrames(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "deskewed_image"): number;
Parameters
resultItemType: Specifies the result item type in question.
Return Value
The maximum overlapping frame count for the overlapping.
See Also
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.
onProcessedDocumentResultReceived
Event triggered when the processed documents are received.
onProcessedDocumentResultReceived?: (result: any) => void;
Parameters
result: The result item that contains the processed documents, of type any.
Return Value
None.
Yes
No