CameraConfiguration

io.scanbot.sdk.ui.view.camera.configuration.CameraConfiguration

```
public class CameraConfiguration
```
Class which is used to configure io.scanbot.ui.view.camera.CameraActivity Contains settings indicating views Behaviour, Texts and Appearance

See Also:

io.scanbot.ui.view.camera.CameraActivity

Constructor Summary

Constructors
Constructor and Description
`CameraConfiguration()` Class which is used to configure io.scanbot.ui.view.camera.CameraActivity Contains settings indicating views Behaviour, Texts and Appearance

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Map<java.lang.String,java.io.Serializable>`	`getCameraConfiguration()`
`void`	`setAutoSnappingButtonHidden(boolean autoSnappingButtonHidden)` Camera appearance param. Defines auto snapping button visibility.
`void`	`setAutoSnappingButtonTitle(java.lang.String autoSnappingButtonTitle)` Camera texts param Sets text for topBar action AutoSnap
`void`	`setAutoSnappingEnabled(boolean autoSnappingEnabled)` Camera behaviour param. Set autoSnapping mode for camera active by default if autoSnappingEnabled true, inactive otherwise Optional, default value is TRUE.
`void`	`setAutoSnappingSensitivity(float autoSnappingSensitivity)` Camera behaviour param. Auto snapping sensitivity. Range (0-1). A value of 1.0 triggers automatic capturing immediately, a value of 0.0 delays the automatic by 3 seconds. Optional, default value is 0.66 (defined by SDK)
`void`	`setBottomBarBackgroundColor(int bottomBarBackgroundColor)` Camera appearance param Background color of the bottom shutter-bar
`void`	`setBottomBarButtonsColor(int bottomBarButtonsColor)` Camera appearance param Color of all text buttons in the bottom shutter-bar (Cancel button, etc). Also used for camera permission screen colors.
`void`	`setCameraBackgroundColor(int cameraBackgroundColor)` Camera appearance param Color of the camera background (e.g. visible in Fit-In camera mode)
`void`	`setCameraPreviewMode(net.doo.snap.camera.CameraPreviewMode cameraPreviewMode)` Camera behaviour param. Preview mode of the camera: Fit-In or Fill-In. Optional, default is Fit-In.
`void`	`setCancelButtonTitle(java.lang.String cancelButtonTitle)` Camera texts param. Cancel button text.
`void`	`setEnableCameraButtonTitle(java.lang.String enableCameraButtonTitle)` Camera texts param Sets camera permission button text
`void`	`setEnableCameraExplanationText(java.lang.String enableCameraExplanationText)` Camera texts param Sets camera permission description text
`void`	`setFlashButtonHidden(boolean flashButtonHidden)` Camera appearance param. Defines flash button visibility.
`void`	`setFlashButtonTitle(java.lang.String flashButtonTitle)` Camera texts param Sets text for topBar action Flash
`void`	`setFlashEnabled(boolean flashEnabled)` Camera behaviour param. Set flash mode for camera active by default if flashEnabled true, inactive otherwise Optional, default value is FALSE.
`void`	`setIgnoreBadAspectRatio(boolean ignoreBadAspectRatio)` Camera behaviour param. Sets flag that enables or disables BadAspectRatio event. Optional, by default BadAspectRatio is not ignored.
`void`	`setImageFormat(io.scanbot.sdk.persistence.CameraImageFormat imageFormat)` Camera behaviour param. CameraImageFormat, which will be used to save images on disk
`void`	`setImageScale(float imageScale)` Camera behaviour param. Image scale. Range 0-1. Optional, default value is 1.0 which means no downscaling of original images. Optional, default value is 1 - means no scaling
`void`	`setJpegImageCompressionRate(int jpegImageCompressionRate)` Camera behaviour param. Jpeg compression rate in interval (0-100). This param will be used only if CameraImageFormat.JPG was used in `CameraConfiguration.setImageFormat` Since PNG is lossless the value will be ignored. Optional, default is 80 for JPG.
`void`	`setMultiPageButtonHidden(boolean multiPageButtonHidden)` Camera appearance param. Defines multi page button visibility.
`void`	`setMultiPageButtonTitle(java.lang.String multiPageButtonTitle)` Camera texts param Sets text for topBar action MultiPage
`void`	`setMultiPageEnabled(boolean multiPageEnabled)` Camera behaviour param. Set multiPage mode for camera active by default if multiPageEnabled true, inactive otherwise Optional, default value is TRUE.
`void`	`setOrientationMode(CameraOrientationMode cameraOrientationMode)` Camera behaviour param. Orientation lock mode of the camera: PORTRAIT or LANDSCAPE. Optional, by default camera orientation is not locked.
`void`	`setPageCounterButtonTitle(java.lang.String pageCounterButtonTitle)` Camera texts param Sets texts for Button indicating how many pages was captured (N pageCounterButtonTitle) - N Pages
`void`	`setPolygonBackgroundColor(int polygonBackgroundColor)` Camera appearance param Default background Color of the Polygon view while trying to improve the distance/angle (All net.doo.snap.lib.detector.DetectionResult with OK_BUT_XXX).
`void`	`setPolygonBackgroundColorOK(int polygonBackgroundColorOK)` Camera appearance param Backgroud Color of the Polygon view when we are ready to snap net.doo.snap.lib.detector.DetectionResult.OK.
`void`	`setPolygonColor(int polygonColor)` Camera appearance param. Default Color of the Polygon view while trying to improve the distance/angle (All net.doo.snap.lib.detector.DetectionResult with OK_BUT_XXX).
`void`	`setPolygonColorOK(int polygonColorOK)` Camera appearance param Color of the Polygon view when we are ready to snap net.doo.snap.lib.detector.DetectionResult.OK.
`void`	`setPolygonLineWidth(int polygonLineWidth)` Camera appearance param Width of the polygon lines.
`void`	`setShutterButtonAutoInnerColor(int shutterButtonAutoInnerColor)` Camera appearance param Inner elements color of the Shutter Button in Autosnapping mode
`void`	`setShutterButtonAutoOuterColor(int shutterButtonAutoOuterColor)` Camera appearance param Background of the Shutter Button in Autosnapping mode
`void`	`setShutterButtonManualInnerColor(int shutterButtonManualInnerColor)` Camera appearance param Inner elements color of the Shutter Button in Manual mode
`void`	`setShutterButtonManualOuterColor(int shutterButtonManualOuterColor)` Camera appearance param Background of the Shutter Button in Manual mode
`void`	`setTextHintBadAngles(java.lang.String textBadAngles)` Camera texts param Sets hint for net.doo.snap.lib.detector.DetectionResult.OK_BUT_BAD_ANGLES
`void`	`setTextHintBadAspectRatio(java.lang.String textHintBadAspectRatio)` Camera texts param Sets hint for net.doo.snap.lib.detector.DetectionResult.OK_BUT_BAD_ASPECT_RATIO
`void`	`setTextHintNothingDetected(java.lang.String textHintNothingDetected)` Camera texts param Sets hint for net.doo.snap.lib.detector.DetectionResult.ERROR_NOTHING_DETECTED
`void`	`setTextHintOK(java.lang.String textHintDontMove)` Camera texts param Sets hint for net.doo.snap.lib.detector.DetectionResult.OK
`void`	`setTextHintTooDark(java.lang.String textHintTooDark)` Camera texts param Sets hint for net.doo.snap.lib.detector.DetectionResult.ERROR_TOO_DARK
`void`	`setTextHintTooNoisy(java.lang.String textHintTooNoisy)` Camera texts param Sets hint for net.doo.snap.lib.detector.DetectionResult.ERROR_TOO_NOISY
`void`	`setTextHintTooSmall(java.lang.String textHintTooSmall)` Camera texts param Sets hint for net.doo.snap.lib.detector.DetectionResult.OK_BUT_TOO_SMALL
`void`	`setTopBarBackgroundColor(int topBarBackgroundColor)` Camera appearance param Background color of the top toolbar.
`void`	`setTopBarButtonsActiveColor(int topBarButtonsActiveColor)` Camera appearance param Color of all active toggle buttons in the toolbar.
`void`	`setTopBarButtonsInactiveColor(int topBarButtonsInactiveColor)` Camera appearance param Color of all in-active toggle buttons in the toolbar.
`void`	`setUserGuidanceBackgroundColor(int userGuidanceBackgroundColor)` Camera appearance param Background color of the user guidance labels.
`void`	`setUserGuidanceTextColor(int userGuidanceTextColor)` Camera appearance param Text color of the user guidance labels.

- Constructor Detail
  - CameraConfiguration
```
public CameraConfiguration()
```
    Class which is used to configure io.scanbot.ui.view.camera.CameraActivity Contains settings indicating views Behaviour, Texts and Appearance
    
    See Also:
    
    io.scanbot.ui.view.camera.CameraActivity
- Method Detail
  - getCameraConfiguration
```
public java.util.Map<java.lang.String,java.io.Serializable> getCameraConfiguration()
```
  - setImageFormat
```
public void setImageFormat(io.scanbot.sdk.persistence.CameraImageFormat imageFormat)
```
    Camera behaviour param. CameraImageFormat, which will be used to save images on disk
  - setJpegImageCompressionRate
```
public void setJpegImageCompressionRate(int jpegImageCompressionRate)
```
    Camera behaviour param. Jpeg compression rate in interval (0-100). This param will be used only if CameraImageFormat.JPG was used in CameraConfiguration.setImageFormat Since PNG is lossless the value will be ignored. Optional, default is 80 for JPG.
    
    See Also:
    
    CameraConfiguration.setImageFormat
  - setAutoSnappingEnabled
```
public void setAutoSnappingEnabled(boolean autoSnappingEnabled)
```
    Camera behaviour param. Set autoSnapping mode for camera active by default if autoSnappingEnabled true, inactive otherwise Optional, default value is TRUE.
  - setFlashEnabled
```
public void setFlashEnabled(boolean flashEnabled)
```
    Camera behaviour param. Set flash mode for camera active by default if flashEnabled true, inactive otherwise Optional, default value is FALSE.
  - setMultiPageEnabled
```
public void setMultiPageEnabled(boolean multiPageEnabled)
```
    Camera behaviour param. Set multiPage mode for camera active by default if multiPageEnabled true, inactive otherwise Optional, default value is TRUE.
  - setAutoSnappingSensitivity
```
public void setAutoSnappingSensitivity(float autoSnappingSensitivity)
```
    Camera behaviour param. Auto snapping sensitivity. Range (0-1). A value of 1.0 triggers automatic capturing immediately, a value of 0.0 delays the automatic by 3 seconds. Optional, default value is 0.66 (defined by SDK)
  - setImageScale
```
public void setImageScale(float imageScale)
```
    Camera behaviour param. Image scale. Range 0-1. Optional, default value is 1.0 which means no downscaling of original images. Optional, default value is 1 - means no scaling
  - setCameraPreviewMode
```
public void setCameraPreviewMode(net.doo.snap.camera.CameraPreviewMode cameraPreviewMode)
```
    Camera behaviour param. Preview mode of the camera: Fit-In or Fill-In. Optional, default is Fit-In.
  - setOrientationMode
```
public void setOrientationMode(CameraOrientationMode cameraOrientationMode)
```
    Camera behaviour param. Orientation lock mode of the camera: PORTRAIT or LANDSCAPE. Optional, by default camera orientation is not locked.
  - setIgnoreBadAspectRatio
```
public void setIgnoreBadAspectRatio(boolean ignoreBadAspectRatio)
```
    Camera behaviour param. Sets flag that enables or disables BadAspectRatio event. Optional, by default BadAspectRatio is not ignored.
  - setPolygonColor
```
public void setPolygonColor(int polygonColor)
```
    Camera appearance param. Default Color of the Polygon view while trying to improve the distance/angle (All net.doo.snap.lib.detector.DetectionResult with OK_BUT_XXX).
  - setPolygonColorOK
```
public void setPolygonColorOK(int polygonColorOK)
```
    Camera appearance param Color of the Polygon view when we are ready to snap net.doo.snap.lib.detector.DetectionResult.OK.
  - setPolygonLineWidth
```
public void setPolygonLineWidth(int polygonLineWidth)
```
    Camera appearance param Width of the polygon lines.
  - setPolygonBackgroundColor
```
public void setPolygonBackgroundColor(int polygonBackgroundColor)
```
    Camera appearance param Default background Color of the Polygon view while trying to improve the distance/angle (All net.doo.snap.lib.detector.DetectionResult with OK_BUT_XXX).
  - setPolygonBackgroundColorOK
```
public void setPolygonBackgroundColorOK(int polygonBackgroundColorOK)
```
    Camera appearance param Backgroud Color of the Polygon view when we are ready to snap net.doo.snap.lib.detector.DetectionResult.OK.
  - setShutterButtonAutoOuterColor
```
public void setShutterButtonAutoOuterColor(int shutterButtonAutoOuterColor)
```
    Camera appearance param Background of the Shutter Button in Autosnapping mode
  - setShutterButtonAutoInnerColor
```
public void setShutterButtonAutoInnerColor(int shutterButtonAutoInnerColor)
```
    Camera appearance param Inner elements color of the Shutter Button in Autosnapping mode
  - setShutterButtonManualOuterColor
```
public void setShutterButtonManualOuterColor(int shutterButtonManualOuterColor)
```
    Camera appearance param Background of the Shutter Button in Manual mode
  - setShutterButtonManualInnerColor
```
public void setShutterButtonManualInnerColor(int shutterButtonManualInnerColor)
```
    Camera appearance param Inner elements color of the Shutter Button in Manual mode
  - setUserGuidanceBackgroundColor
```
public void setUserGuidanceBackgroundColor(int userGuidanceBackgroundColor)
```
    Camera appearance param Background color of the user guidance labels.
  - setUserGuidanceTextColor
```
public void setUserGuidanceTextColor(int userGuidanceTextColor)
```
    Camera appearance param Text color of the user guidance labels.
  - setTopBarBackgroundColor
```
public void setTopBarBackgroundColor(int topBarBackgroundColor)
```
    Camera appearance param Background color of the top toolbar.
  - setTopBarButtonsActiveColor
```
public void setTopBarButtonsActiveColor(int topBarButtonsActiveColor)
```
    Camera appearance param Color of all active toggle buttons in the toolbar.
  - setTopBarButtonsInactiveColor
```
public void setTopBarButtonsInactiveColor(int topBarButtonsInactiveColor)
```
    Camera appearance param Color of all in-active toggle buttons in the toolbar.
  - setBottomBarBackgroundColor
```
public void setBottomBarBackgroundColor(int bottomBarBackgroundColor)
```
    Camera appearance param Background color of the bottom shutter-bar
  - setBottomBarButtonsColor
```
public void setBottomBarButtonsColor(int bottomBarButtonsColor)
```
    Camera appearance param Color of all text buttons in the bottom shutter-bar (Cancel button, etc). Also used for camera permission screen colors.
  - setCameraBackgroundColor
```
public void setCameraBackgroundColor(int cameraBackgroundColor)
```
    Camera appearance param Color of the camera background (e.g. visible in Fit-In camera mode)
  - setMultiPageButtonHidden
```
public void setMultiPageButtonHidden(boolean multiPageButtonHidden)
```
    Camera appearance param. Defines multi page button visibility.
  - setFlashButtonHidden
```
public void setFlashButtonHidden(boolean flashButtonHidden)
```
    Camera appearance param. Defines flash button visibility.
  - setAutoSnappingButtonHidden
```
public void setAutoSnappingButtonHidden(boolean autoSnappingButtonHidden)
```
    Camera appearance param. Defines auto snapping button visibility.
  - setCancelButtonTitle
```
public void setCancelButtonTitle(java.lang.String cancelButtonTitle)
```
    Camera texts param. Cancel button text.
  - setPageCounterButtonTitle
```
public void setPageCounterButtonTitle(java.lang.String pageCounterButtonTitle)
```
    Camera texts param Sets texts for Button indicating how many pages was captured (N pageCounterButtonTitle) - N Pages
  - setTextHintOK
```
public void setTextHintOK(java.lang.String textHintDontMove)
```
    Camera texts param Sets hint for net.doo.snap.lib.detector.DetectionResult.OK
  - setTextHintTooSmall
```
public void setTextHintTooSmall(java.lang.String textHintTooSmall)
```
    Camera texts param Sets hint for net.doo.snap.lib.detector.DetectionResult.OK_BUT_TOO_SMALL
  - setTextHintBadAngles
```
public void setTextHintBadAngles(java.lang.String textBadAngles)
```
    Camera texts param Sets hint for net.doo.snap.lib.detector.DetectionResult.OK_BUT_BAD_ANGLES
  - setTextHintBadAspectRatio
```
public void setTextHintBadAspectRatio(java.lang.String textHintBadAspectRatio)
```
    Camera texts param Sets hint for net.doo.snap.lib.detector.DetectionResult.OK_BUT_BAD_ASPECT_RATIO
  - setTextHintNothingDetected
```
public void setTextHintNothingDetected(java.lang.String textHintNothingDetected)
```
    Camera texts param Sets hint for net.doo.snap.lib.detector.DetectionResult.ERROR_NOTHING_DETECTED
  - setTextHintTooNoisy
```
public void setTextHintTooNoisy(java.lang.String textHintTooNoisy)
```
    Camera texts param Sets hint for net.doo.snap.lib.detector.DetectionResult.ERROR_TOO_NOISY
  - setTextHintTooDark
```
public void setTextHintTooDark(java.lang.String textHintTooDark)
```
    Camera texts param Sets hint for net.doo.snap.lib.detector.DetectionResult.ERROR_TOO_DARK
  - setMultiPageButtonTitle
```
public void setMultiPageButtonTitle(java.lang.String multiPageButtonTitle)
```
    Camera texts param Sets text for topBar action MultiPage
  - setFlashButtonTitle
```
public void setFlashButtonTitle(java.lang.String flashButtonTitle)
```
    Camera texts param Sets text for topBar action Flash
  - setAutoSnappingButtonTitle
```
public void setAutoSnappingButtonTitle(java.lang.String autoSnappingButtonTitle)
```
    Camera texts param Sets text for topBar action AutoSnap
  - setEnableCameraExplanationText
```
public void setEnableCameraExplanationText(java.lang.String enableCameraExplanationText)
```
    Camera texts param Sets camera permission description text
  - setEnableCameraButtonTitle
```
public void setEnableCameraButtonTitle(java.lang.String enableCameraButtonTitle)
```
    Camera texts param Sets camera permission button text

Class CameraConfiguration

Constructor Summary

Method Summary

Constructor Detail

CameraConfiguration

Method Detail

getCameraConfiguration

setImageFormat

setJpegImageCompressionRate

setAutoSnappingEnabled

setFlashEnabled

setMultiPageEnabled

setAutoSnappingSensitivity

setImageScale

setCameraPreviewMode

setOrientationMode

setIgnoreBadAspectRatio

setPolygonColor

setPolygonColorOK

setPolygonLineWidth

setPolygonBackgroundColor

setPolygonBackgroundColorOK

setShutterButtonAutoOuterColor

setShutterButtonAutoInnerColor

setShutterButtonManualOuterColor

setShutterButtonManualInnerColor

setUserGuidanceBackgroundColor

setUserGuidanceTextColor

setTopBarBackgroundColor

setTopBarButtonsActiveColor

setTopBarButtonsInactiveColor

setBottomBarBackgroundColor

setBottomBarButtonsColor

setCameraBackgroundColor

setMultiPageButtonHidden

setFlashButtonHidden

setAutoSnappingButtonHidden

setCancelButtonTitle

setPageCounterButtonTitle

setTextHintOK

setTextHintTooSmall

setTextHintBadAngles

setTextHintBadAspectRatio

setTextHintNothingDetected

setTextHintTooNoisy

setTextHintTooDark

setMultiPageButtonTitle

setFlashButtonTitle

setAutoSnappingButtonTitle

setEnableCameraExplanationText

setEnableCameraButtonTitle