diff --git a/programming/android/api-reference/capture-vision-router/auxiliary-classes/image-source-state-listener.md b/programming/android/api-reference/capture-vision-router/auxiliary-classes/image-source-state-listener.md index f69480f..3e8a6f8 100644 --- a/programming/android/api-reference/capture-vision-router/auxiliary-classes/image-source-state-listener.md +++ b/programming/android/api-reference/capture-vision-router/auxiliary-classes/image-source-state-listener.md @@ -38,4 +38,4 @@ void onImageSourceStateReceived(@EnumImageSourceState int status); **Parameters** -`[in] state`: One of the [`EnumImageSourceState`]({{ site.dcv_android_api }}core/enum/image-source-state.html)` that indicates the state of the ImageSourceAdapter. +`[in] state`: One of the [`EnumImageSourceState`]({{ site.dcv_android_api }}core/enum/image-source-state.html) that indicates the state of the ImageSourceAdapter. diff --git a/programming/android/api-reference/utility/multi-frame-result-cross-filter.md b/programming/android/api-reference/utility/multi-frame-result-cross-filter.md index 042da93..aaa6492 100644 --- a/programming/android/api-reference/utility/multi-frame-result-cross-filter.md +++ b/programming/android/api-reference/utility/multi-frame-result-cross-filter.md @@ -96,6 +96,10 @@ void enableResultDeduplication(@EnumCapturedResultItemType int resultItemTypes, `[in] enable`: Boolean to toggle deduplication on or off. +**Remarks** + +Result deduplication is disabled by default. You can enable it and adjust the `DuplicateForgetTime` based on your requirements. + ### isResultDeduplicationEnabled Checks if deduplication is active for a given result item type. @@ -126,6 +130,10 @@ void setDuplicateForgetTime(@EnumCapturedResultItemType int resultItemTypes, int `[in] time`: Time in milliseconds during which duplicates are disregarded. +**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. The maximum allowed value is 180,000 milliseconds. + ### getDuplicateForgetTime Gets the interval during which duplicates are disregarded for a given result item type. @@ -219,6 +227,16 @@ void setResultCrossVerificationCriteria(int resultItemTypes, CrossVerificationCr `[in] criteria`: Specifies the cross-verification criteria with a [`CrossVerificationCriteria`]({{ site.dcv_android_api }}utility/cross-verification-criteria.html) object. +**Remarks** + +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 Gets the cross-verification criteria for a specified result item type. diff --git a/programming/flutter/api-reference/utility/multi-frame-cross-filter.md b/programming/flutter/api-reference/utility/multi-frame-cross-filter.md index e85088c..2d431f3 100644 --- a/programming/flutter/api-reference/utility/multi-frame-cross-filter.md +++ b/programming/flutter/api-reference/utility/multi-frame-cross-filter.md @@ -90,6 +90,8 @@ Future enableResultDeduplication(int resultItemTypes, bool enable) `resultItemTypes` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md). `enable` determines whether to enable or disable the filter process. +Result deduplication is disabled by default. You can enable it and adjust the `DuplicateForgetTime` based on your requirements. + ### getDuplicateForgetTime Returns the amount of time, in *milliseconds*, that the deduplication filter takes effect for the specified result item type(s). @@ -162,6 +164,8 @@ Future setDuplicateForgetTime(int resultItemTypes, int time) `resultItemTypes` is a bitmask representing the result item types to apply the filter to - this value can be a combined value of [`EnumCapturedResultItemType`](../core/enum/captured-result-item-type.md). `time` specifies the target time in *milliseconds*. +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. The maximum allowed value is 180,000 milliseconds. + ### setMaxOverlappingFrames Sets the maximum number of overlapping frames to check when the latest overlap filter is on for the specified result item type(s). @@ -200,6 +204,16 @@ Future setResultCrossVerificationCriteria(int resultItemTypes, CrossVerifi `[in] criteria`: Specifies the cross-verification criteria with a [`CrossVerificationCriteria`]({{ site.dcv_flutter_api }}utility/cross-verification-criteria.html) object. +**Remarks** + +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 Gets the cross-verification criteria for a specified result item type. diff --git a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-receiver.md b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-receiver.md index 7c1b2c5..cb8e490 100644 --- a/programming/ios/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-receiver.md +++ b/programming/ios/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-receiver.md @@ -34,7 +34,7 @@ protocol IntermediateResultReceiver: NSObjectProtocol | Method | Description | | ------ | ----------- | -| [getObservationParameters](#getobservationparameters) | Gets the observed parameters of the intermediate result receiver. | +| [`getObservationParameters`](#getobservationparameters) | Gets the observed parameters of the intermediate result receiver. | | [`onTargetROIResultsReceived`](#ontargetroiresultsreceived) | The callback triggered when the processing of a target-ROI is finished. | | [`onTaskResultsReceived`](#ontaskresultsreceived) | The callback triggered when the processing of a task is finished. | | [`onPredetectedRegionsReceived`](#onpredetectedregionsreceived) | The callback triggered when pre-detected regions are received. | diff --git a/programming/ios/api-reference/utility/multi-frame-result-cross-filter.md b/programming/ios/api-reference/utility/multi-frame-result-cross-filter.md index fdd0333..97c7560 100644 --- a/programming/ios/api-reference/utility/multi-frame-result-cross-filter.md +++ b/programming/ios/api-reference/utility/multi-frame-result-cross-filter.md @@ -123,6 +123,10 @@ func enableResultDeduplication(resultItemType: DSCapturedResultItemType, isEnabl `isEnabled`: A BOOL value that indicates whether to enable the result deduplication feature. +**Remarks** + +Result deduplication is disabled by default. You can enable it and adjust the `duplicateForgetTime` based on your requirements. + ### setDuplicateForgetTime Sets the interval during which duplicates are disregarded for specific result item types. @@ -147,6 +151,10 @@ func setDuplicateForgetTime(resultItemType: DSCapturedResultItemType, duplicateF `duplicateForgetTime`: The duplicate forget time of the specified capture result type. +**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. The maximum allowed value is 180,000 milliseconds. + ### getDuplicateForgetTime Gets the interval during which duplicates are disregarded for a given result item type. @@ -319,6 +327,16 @@ func setResultCrossVerificationCriteria(criteria: CrossVerificationCriteria, res `[in] resultItemTypes`: Specifies the result item types with [`DSCapturedResultItemType`]({{ site.dcv_ios_api }}core/enum/captured-result-item-type.html?lang=objc,swift). +**Remarks** + +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 Gets the cross-verification criteria for a specified result item type. diff --git a/programming/maui/api-reference/utility/multi-frame-result-cross-filter.md b/programming/maui/api-reference/utility/multi-frame-result-cross-filter.md index b9427fe..c7f5176 100644 --- a/programming/maui/api-reference/utility/multi-frame-result-cross-filter.md +++ b/programming/maui/api-reference/utility/multi-frame-result-cross-filter.md @@ -96,6 +96,10 @@ void EnableResultDeduplication(EnumCapturedResultItemType resultItemTypes, bool `enable`: A BOOL value that indicates whether to enable the result deduplication feature. +**Remarks** + +Result deduplication is disabled by default. You can enable it and adjust the `DuplicateForgetTime` based on your requirements. + ### IsResultDeduplicationEnabled Checks if deduplication is active for a given result item type. @@ -126,6 +130,10 @@ void SetDuplicateForgetTime(EnumCapturedResultItemType resultItemTypes, int time `time`: The duplicate forget time of the specified capture result type. +**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. The maximum allowed value is 180,000 milliseconds. + ### GetDuplicateForgetTime Gets the interval during which duplicates are disregarded for specific result item types. @@ -220,6 +228,14 @@ void SetResultCrossVerificationCriteria(int resultItemTypes, CrossVerificationCr - Introduced in Dynamsoft Barcode Reader SDK version 11.4.1200 and Dynamsoft Capture Vision version 3.4.1200. +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 Gets the cross-verification criteria for a specified result item type. diff --git a/programming/react-native/api-reference/utility/multi-frame-cross-filter.md b/programming/react-native/api-reference/utility/multi-frame-cross-filter.md index e5b8e04..796e129 100644 --- a/programming/react-native/api-reference/utility/multi-frame-cross-filter.md +++ b/programming/react-native/api-reference/utility/multi-frame-cross-filter.md @@ -102,6 +102,10 @@ enableResultDeduplication(resultItemTypes: number, enable: boolean): void `enable`: Whether to enable the result deduplication. +**Remarks** + +Result deduplication is disabled by default. You can enable it and adjust the `DuplicateForgetTime` based on your requirements. + ### getDuplicateForgetTime Returns the amount of time, in *milliseconds*, that the deduplication filter takes effect for the specified result item type. @@ -176,6 +180,10 @@ setDuplicateForgetTime(types: number, time: number): void `time`: Time in milliseconds during which duplicates are disregarded. +**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. The maximum allowed value is 180,000 milliseconds. + ### setMaxOverlappingFrames Sets the maximum number of overlapping frames to check when the latest overlap filter is on for the specified result item type(s). @@ -208,6 +216,14 @@ setResultCrossVerificationCriteria(types: EnumCapturedResultItemType | number, c - Introduced in Dynamsoft Barcode Reader SDK version 11.4.1000 and Dynamsoft Capture Vision version 3.4.1000. +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 Gets the cross-verification criteria for a specified result item type.