react-native-scanbot-sdk
    Preparing search index...

    Class CameraConfiguration

    Configuration of the camera settings to be used while scanning.

    Index
    constructor
    cameraLiveScannerResolution cameraModule cameraPreviewAspectRatio cameraPreviewMode defaultZoomFactor flashEnabled fpsLimit hardwareButtonsEnabled minFocusDistanceLock orientationLockMode pinchToZoomEnabled touchToFocusEnabled zoomSteps
    cameraLiveScannerResolution: CameraLiveScannerResolution

    The size of the image from camera which would be sent to the scanner for live scanning.

    Default is FULL_HD.

    cameraModule: CameraModule

    Determines which camera module to use on start-up.

    Default is BACK.

    cameraPreviewAspectRatio: CameraPreviewAspectRatio | null

    Tries to select the camera preview aspect ratio that best matches the given aspect ratio. If no exact match is found, it selects the closest one available. Android only.

    cameraPreviewMode: CameraPreviewMode

    Determines which camera preview mode to use.

    Default is FILL_IN.

    defaultZoomFactor: number

    The default zoom factor on start-up.

    Default is 1.0.

    flashEnabled: boolean

    Determines whether the flash is enabled on start-up.

    Default is false.

    fpsLimit: number

    The rate of detections/recognitions per second in normal performance mode. If the number is equal or greater than the video frame rate, no frames will be skipped.

    Default is 20.

    hardwareButtonsEnabled: boolean

    When enabled it allows zooming using camera control button (iPhone 16 series). iOS only.

    Default is true.

    minFocusDistanceLock: boolean

    Determines whether to lock the focus at the minimum possible distance (device-specific).

    Default is false.

    orientationLockMode: OrientationLockMode

    Determines which mode to use when orientation should be locked to landscape or portrait.

    Default is NONE.

    pinchToZoomEnabled: boolean

    Determines whether pinch-to-zoom is enabled or not.

    Default is true.

    touchToFocusEnabled: boolean

    Determines whether touch-to-focus is enabled or not.

    Default is false.

    zoomSteps: number[]

    The zoom steps available to the user.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties