Class CameraConfig

  • All Implemented Interfaces:
    java.io.Serializable

    
    public class CameraConfig
     implements Serializable
                        

    Schema for SDK Camera Configuration

    • Constructor Detail

      • CameraConfig

        CameraConfig()
    • Method Detail

      • getCaptureResolution

         String getCaptureResolution()

        The preferred resolution for video capture (720p, 1080p, 4K). This resolution is used to process images for scanning. 4K resolution is only supported for barcode scanning. (Required)

      • setCaptureResolution

         void setCaptureResolution(String captureResolution)

        The preferred resolution for video capture (720p, 1080p, 4K). This resolution is used to process images for scanning. 4K resolution is only supported for barcode scanning. (Required)

      • getPictureResolution

         String getPictureResolution()

        Deprecated - do not use! The preferred resolution for taking images (720, 720p, 1080, 1080p).

      • setPictureResolution

         void setPictureResolution(String pictureResolution)

        Deprecated - do not use! The preferred resolution for taking images (720, 720p, 1080, 1080p).

      • getDefaultCamera

         String getDefaultCamera()

        Preferred camera to open: FRONT (front-facing), BACK (rear-facing), EXTERNAL (external rear), EXTERNAL_FRONT (external front), TELE (iOS-only; requests the telephoto lens and is honored only on devices that have one; on Android or on iOS devices without a tele lens BACK will be used).

      • setDefaultCamera

         void setDefaultCamera(String defaultCamera)

        Preferred camera to open: FRONT (front-facing), BACK (rear-facing), EXTERNAL (external rear), EXTERNAL_FRONT (external front), TELE (iOS-only; requests the telephoto lens and is honored only on devices that have one; on Android or on iOS devices without a tele lens BACK will be used).

      • setZoomGesture

         void setZoomGesture(Boolean zoomGesture)

        This flag enables or disables the zoom gesture if supported.

      • setFallbackCameras

         void setFallbackCameras(List<String> fallbackCameras)

        Optional cameras to fall back if the defaultCamera is not found.

      • getEnableTapToFocus

         Boolean getEnableTapToFocus()

        Allow user to tap on the preview to focus the camera on a specific area of the screen (also known as tap-to-focus). Enabled by default.

      • setEnableTapToFocus

         void setEnableTapToFocus(Boolean enableTapToFocus)

        Allow user to tap on the preview to focus the camera on a specific area of the screen (also known as tap-to-focus). Enabled by default.

      • getTapToFocusTimeoutMs

         Integer getTapToFocusTimeoutMs()

        (Note: this functionality is experimental - use at your own risk.) Duration in milliseconds after which tap-to-focus automatically returns to continuous autofocus mode. Range: 1000-60000ms.

      • setTapToFocusTimeoutMs

         void setTapToFocusTimeoutMs(Integer tapToFocusTimeoutMs)

        (Note: this functionality is experimental - use at your own risk.) Duration in milliseconds after which tap-to-focus automatically returns to continuous autofocus mode. Range: 1000-60000ms.