Constructor Detail

• JsonTextDataScannerStep

  JsonTextDataScannerStep(String guidanceText, String pattern, Boolean shouldMatchSubstring, Double preferredZoom, JsonAspectRatio aspectRatio, Double unzoomedFinderHeight, String allowedSymbols, Long significantShakeDelay)

Method Detail

• getGuidanceText

   final String getGuidanceText()

  User guidance hint text.

• setGuidanceText

   final Unit setGuidanceText(String guidanceText)

  User guidance hint text.

• getPattern

   final String getPattern()

  Validation pattern to automatically validate recognized text. '?' = any character, '#' - any digit, all other characters represent themselves. An empty string or nil value will disable the validation pattern.

• setPattern

   final Unit setPattern(String pattern)

  Validation pattern to automatically validate recognized text. '?' = any character, '#' - any digit, all other characters represent themselves. An empty string or nil value will disable the validation pattern.

• getShouldMatchSubstring

   final Boolean getShouldMatchSubstring()

  If set to TRUE pattern validation also validates successfully if only a part of the whole recognized text matches the the validation pattern. If set to FALSE, the whole text must match the validation pattern. Applies to pattern validation only. Defaults to FALSE.

• setShouldMatchSubstring

   final Unit setShouldMatchSubstring(Boolean shouldMatchSubstring)

  If set to TRUE pattern validation also validates successfully if only a part of the whole recognized text matches the the validation pattern. If set to FALSE, the whole text must match the validation pattern. Applies to pattern validation only. Defaults to FALSE.

• getPreferredZoom

   final Double getPreferredZoom()

  The cameras zoom level preferred for this step. The actual zoom might be different from the preferred one to avoid clipping of finder area and maintain its aspect ratio and height

• setPreferredZoom

   final Unit setPreferredZoom(Double preferredZoom)

  The cameras zoom level preferred for this step. The actual zoom might be different from the preferred one to avoid clipping of finder area and maintain its aspect ratio and height

• getAspectRatio

   final JsonAspectRatio getAspectRatio()

  The cameras zoom level preferred for this step. The actual zoom might be different from the preferred one to avoid clipping of finder area and maintain its aspect ratio and height

• setAspectRatio

   final Unit setAspectRatio(JsonAspectRatio aspectRatio)

  The cameras zoom level preferred for this step. The actual zoom might be different from the preferred one to avoid clipping of finder area and maintain its aspect ratio and height

• getUnzoomedFinderHeight

   final Double getUnzoomedFinderHeight()

  The preferred height of the finder for zoom scale 1.0 (unzoomed). The actual finder height might change to maintain aspect ratio and to not clip the screen. Defaults to 40 points.

• setUnzoomedFinderHeight

   final Unit setUnzoomedFinderHeight(Double unzoomedFinderHeight)

  The preferred height of the finder for zoom scale 1.0 (unzoomed). The actual finder height might change to maintain aspect ratio and to not clip the screen. Defaults to 40 points.

• getAllowedSymbols

   final String getAllowedSymbols()

  A string (list) of accepted characters during text recognition. If empty or nil, all characters are accepted. Defaults to nil.

• setAllowedSymbols

   final Unit setAllowedSymbols(String allowedSymbols)

  A string (list) of accepted characters during text recognition. If empty or nil, all characters are accepted. Defaults to nil.

• getSignificantShakeDelay

   final Long getSignificantShakeDelay()

  Threshold used to pause the detection after significant movement occurred. Default = 0

• setSignificantShakeDelay

   final Unit setSignificantShakeDelay(Long significantShakeDelay)

  Threshold used to pause the detection after significant movement occurred. Default = 0