-
public interface DataCaptureScenario.DataCaptureSettingsSettings of data capture.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classDataCaptureScenario.DataCaptureSettings.SchemeScheme for custom profile. Currently supports a single data field.
-
Method Summary
Modifier and Type Method Description abstract UnitsetProfile(String name)Set the data capture profile. abstract UnitsetScheme(DataCaptureScenario.DataCaptureSettings.Scheme scheme)Set the scheme for custom data capture profile. abstract TextCapture.CaptureSceneTypegetCaptureSceneType()Get the scene type for capture. abstract UnitsetCaptureSceneType(TextCapture.CaptureSceneType captureSceneType)Set the scene type for optimized capture performance. abstract DataCaptureScenario.AreaOfInterestgetAreaOfInterest()Get the area of interest for data and image capture. abstract UnitsetAreaOfInterest(DataCaptureScenario.AreaOfInterest areaOfInterest)Define the area of interest for data and image capture. abstract UnitsetRecognitionLanguages(Language languages)Set the languages for recognition. abstract Array<Language>getRecognitionLanguages()Get the languages currently configured for recognition. abstract UnitsetSelectableRecognitionLanguages(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 UnitsetNamedProperty(String name, Object value)Set the named extended property for data capture. abstract UnitcheckAndApply()Apply the configured settings. -
-
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 propertyvalue- 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.
-
-
-
-