Package

## Interface DataCaptureScenario.DataCaptureSettings

-     public interface DataCaptureScenario.DataCaptureSettings

  Settings of data capture.

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Class | Description
    --- | --- | ---
    `public final class` | `DataCaptureScenario.DataCaptureSettings.Scheme` | Scheme for custom profile. Currently supports a single data field.

  - ### Method Summary

    Modifier and Type | Method | Description
    --- | --- | ---
    `abstract Unit` | `setProfile(String name)` | Set the data capture profile.
    `abstract Unit` | `setScheme(DataCaptureScenario.DataCaptureSettings.Scheme scheme)` | Set the scheme for custom data capture profile.
    `abstract TextCapture.CaptureSceneType` | `getCaptureSceneType()` | Get the scene type for capture.
    `abstract Unit` | `setCaptureSceneType(TextCapture.CaptureSceneType captureSceneType)` | Set the scene type for optimized capture performance.
    `abstract DataCaptureScenario.AreaOfInterest` | `getAreaOfInterest()` | Get the area of interest for data and image capture.
    `abstract Unit` | `setAreaOfInterest(DataCaptureScenario.AreaOfInterest areaOfInterest)` | Define the area of interest for data and image capture.
    `abstract Unit` | `setRecognitionLanguages(Language languages)` | Set the languages for recognition.
    `abstract Array<Language>` | `getRecognitionLanguages()` | Get the languages currently configured for recognition.
    `abstract Unit` | `setSelectableRecognitionLanguages(Language languages)` | Set the recognition languages for the user to choose from.
    `abstract Array<Language>` | `getSelectableRecognitionLanguages()` | Get the recognition languages available for the user to choose from.
    `abstract Array<Language>` | `getAvailableRecognitionLanguages()` | Get the languages available to be recognized for the current profile.
    `abstract Unit` | `setNamedProperty(String name, Object value)` | Set the named extended property for data capture.
    `abstract Unit` | `checkAndApply()` | Apply the configured settings.

    - ### Methods inherited from class com.abbyy.mobile.uicomponents.scenario.DataCaptureScenario.DataCaptureSettings

      `equals, hashCode, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Method Detail

    - #### setProfile

          @MainThread() abstract Unit setProfile(String name)

      Set the data capture profile.

      Parameters:
        `name` - profile name

    - #### setScheme

          @MainThread() abstract Unit setScheme(DataCaptureScenario.DataCaptureSettings.Scheme scheme)

      Set the scheme for custom data capture profile. Should be called only with "Custom" profile.

      Parameters:
        `scheme` - custom profile scheme

    - #### getCaptureSceneType

          @MainThread() abstract TextCapture.CaptureSceneType getCaptureSceneType()

      Get the scene type for capture.

    - #### setCaptureSceneType

          @MainThread() abstract Unit setCaptureSceneType(TextCapture.CaptureSceneType captureSceneType)

      Set the scene type for optimized capture performance.

      Parameters:
        `captureSceneType` - the type of scene being captured

    - #### getAreaOfInterest

          @MainThread() abstract DataCaptureScenario.AreaOfInterest getAreaOfInterest()

      Get the area of interest for data and image capture.

    - #### setAreaOfInterest

          @MainThread() abstract Unit setAreaOfInterest(DataCaptureScenario.AreaOfInterest areaOfInterest)

      Define the area of interest for data and image capture.

      Parameters:
        `areaOfInterest` - area of interest

    - #### setRecognitionLanguages

          @MainThread() abstract Unit setRecognitionLanguages(Language languages)

      Set the languages for recognition.

      Parameters:
        `languages` - recognition languages

    - #### getRecognitionLanguages

          @MainThread() abstract Array<Language> getRecognitionLanguages()

      Get the languages currently configured for recognition.

    - #### setSelectableRecognitionLanguages

          @MainThread() abstract Unit setSelectableRecognitionLanguages(Language languages)

      Set the recognition languages for the user to choose from.

      Parameters:
        `languages` - languages to select from

    - #### getSelectableRecognitionLanguages

          @MainThread() abstract Array<Language> getSelectableRecognitionLanguages()

      Get the recognition languages available for the user to choose from.

    - #### getAvailableRecognitionLanguages

          @MainThread() abstract Array<Language> getAvailableRecognitionLanguages()

      Get the languages available to be recognized for the current profile.

    - #### setNamedProperty

          @MainThread() abstract Unit setNamedProperty(String name, Object value)

      Set the named extended property for data capture.

      Parameters:
        `name` - the name of the property
        `value` - the value of the property

    - #### checkAndApply

          @MainThread() abstract Unit checkAndApply()

      Apply the configured settings. If the settings cannot be applied, an exception will be thrown.