AUIDataCaptureSettings interface

Provides access to the settings of a data capture scenario.

Properties

Name Type Description
areaOfInterest AUIAreaOfInterest* An area of interest. The document will be expected inside this area.
captureSceneType RTRCaptureSceneType Surroundings type of the recognized document. The text for recognition can be captured from a simple sheet of paper or from a part of environment, i.e. from a street banner. Set the capture scene type to improve the recognition results.
extendedSettings NSDictionary* Extended settings of the scenario. Reserved for a future usage.
profile NSString*

Recognition profile. Use the following values:

  • "Text" to perform a text capture scenario
  • "Custom" to create a new profile. To perform a scenario with a custom profile, create a AUICustomDataCaptureScheme object and set it as a value of the scheme property.

 Important!  If the profile is set to "Custom" but no scheme is passed as a scheme property value, an error occurs.

  • one of the predefined profiles' name, i.e. BusinessCards.

 Note: The property is case sensitive.

scheme AUICustomDataCaptureScheme* A custom data scheme, required if the profile property is set to "Custom" value. Otherwise should not be set.
recognitionLanguages NSSet<RTRLanguageName>*

Languages, that will be used for recognition.

The maximum size of this array is 3. If more than 3 languages are denoted, an error occurs.

These languages are displayed in the language button. In a list of languages provided for recognition, that should be represented by the selectableRecognitionLanguages property, these items will be tagged as chosen.

selectableRecognitionLanguages NSSet<RTRLanguageName>*

Languages, that will be shown to the end-user as provided for recognition. This array will be displayed as a dropdown list.

If this array does not include the values, defined in the recognitionLanguages property, the languages from the recognitionLanguages property will not be shown in the dropdown list, though they will be used in recognition.

Set this property to an empty set to hide languages button. In this case only languages specified in the recognitionLanguages property will be used for recognition.

When this array consists of a single value, the language button is disabled.

 Note: Specify the values of the profile and recognitionLanguages properties first.

Methods

Name Description
- checkAndApply: Checks if the settings are consistent and applies the settings to a capture profile.

02.03.2022 12:59:15

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.