Class BarcodeScannerViewConfiguration

Hierarchy

Constructors

constructor

Properties

backgroundColor? captureDelay? container? containerId? desiredRecognitionResolution? enable4kStream? finder? mirrored? onBarcodesDetected? onError? overlay? preferredCamera? scannerConfiguration? spinnerColor? userGuidance? videoConstraints? zoom? DEFAULT_ACCEPTED_ANGLE_SCORE DEFAULT_ACCEPTED_BRIGHTNESS_SCORE DEFAULT_ACCEPTED_SIZE_SCORE DEFAULT_VIDEO_RESOLUTION_4K DEFAULT_VIDEO_RESOLUTION_HD

Methods

fromJson mapFinderConfiguration mapValues mapValuesDeep

Constructors

constructor

Properties

Optional backgroundColor

backgroundColor?: string

Optional captureDelay

captureDelay?: number

Capture delay in milliseconds after detecting barcodes. Defaults to 1000

Optional container

container?: HTMLElement

The container HTML element of Scanbot Web SDK camera. Required when 'containerId' property is left undefined when calling any ScanbotSDK createScanner function. If both are provided, 'container' property takes precedence.

Optional containerId

containerId?: string

The container HTML element id of Scanbot Web SDK camera. Required when 'container' property is left undefined when calling any ScanbotSDK createScanner function If both are provided, 'container' property takes precedence.

Optional desiredRecognitionResolution

desiredRecognitionResolution?: number

If set, limit the resolution of the image that is used for barcode recognition. A lower value will result in faster processing times but may reduce recognition quality.

Optional enable4kStream

enable4kStream?: boolean

Determines whether the scanner should use the 4K video stream. This will enhance the recognition quality, but will also increase the CPU load and memory consumption.Should be enabled on devices that can handle the increased load. If the device does not support 4K, it will fall back to the highest available resolution. This setting overrides videoConstraints width and height settings. Defaults to false

Optional finder

finder?: {
    aspectRatio?: {
        height?: number;
        width?: number;
    };
    minimumInsets?: {
        bottom?: number;
        left?: number;
        right?: number;
        top?: number;
    };
    overlayColor?: string;
    preferredHeight?: number;
    style?: ({ strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) & {
        _type: "FinderCorneredStyle";
    } | ({ strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) & {
        _type: "FinderStrokedStyle";
    };
    visible?: boolean;
} & {
    _type: "ViewFinderConfiguration";
} | {
    aspectRatio?: {
        height?: number;
        width?: number;
    };
    minimumInsets?: {
        bottom?: number;
        left?: number;
        right?: number;
        top?: number;
    };
    overlayColor?: string;
    preferredHeight?: number;
    style?: ({ strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) & {
        _type: "FinderCorneredStyle";
    } | ({ strokeColor?: string; strokeWidth?: number; cornerRadius?: number; }) & {
        _type: "FinderStrokedStyle";
    };
} & {
    _type: "PermanentViewFinderConfiguration";
}

Optional mirrored

mirrored?: boolean

Optional onBarcodesDetected

onBarcodesDetected?: ((e) => void)

Type declaration

Optional onError

onError?: ((e) => void)

Type declaration

    • (e): void

    • Error callback of the SDK. If any error was reported, your scanner might not be scanning anymore, e.g. due to an out-of-memory error.

      Parameters

      • e: any

      Returns void

Optional overlay

overlay?: SelectionOverlayConfiguration

Optional preferredCamera

preferredCamera?: string

Camera id or camera label. A list of available cameras can be obtained from ScanbotSDK.cameras.

Optional scannerConfiguration

scannerConfiguration?: Omit<DeepPartial<BarcodeScannerConfiguration>, "live">

BarcodeScannerConfiguration

Optional spinnerColor

spinnerColor?: string

Optional userGuidance

userGuidance?: {
    background?: { strokeColor?: string; fillColor?: string; strokeWidth?: number; };
    title?: { visible?: boolean; text?: string; color?: string; useShadow?: boolean; };
    visible?: boolean;
}

Type declaration

  • Optional background?: { strokeColor?: string; fillColor?: string; strokeWidth?: number; }

    The background style used for the user guidance.

    Default Value

    new BackgroundStyle({
        "strokeColor": "#00000000",
        "fillColor": "?sbColorSurfaceLow"
    });
  • Optional title?: { visible?: boolean; text?: string; color?: string; useShadow?: boolean; }

    The title of the user guidance.

    Default Value

    new StyledText({
        "color": "?sbColorOnPrimary"
    });
  • Optional visible?: boolean

    Determines whether the user guidance is visible or not.

    Default Value

    true;

Optional videoConstraints

videoConstraints?: any

ScanbotCameraView video constraints

Optional zoom

zoom?: number

Digital zoom level of the video stream. Defaults to 1.0. Please note that this is not the same as the optical zoom of the camera.

Static DEFAULT_ACCEPTED_ANGLE_SCORE

DEFAULT_ACCEPTED_ANGLE_SCORE: number

Static DEFAULT_ACCEPTED_BRIGHTNESS_SCORE

DEFAULT_ACCEPTED_BRIGHTNESS_SCORE: number

Static DEFAULT_ACCEPTED_SIZE_SCORE

DEFAULT_ACCEPTED_SIZE_SCORE: number

Static DEFAULT_VIDEO_RESOLUTION_4K

DEFAULT_VIDEO_RESOLUTION_4K: {
    height: number;
    width: number;
}

Type declaration

  • height: number
  • width: number

Static DEFAULT_VIDEO_RESOLUTION_HD

DEFAULT_VIDEO_RESOLUTION_HD: {
    height: number;
    width: number;
}

Type declaration

  • height: number
  • width: number

Methods

Static fromJson

Static mapFinderConfiguration

Static mapValues

  • mapValues(source, destination, ignore?): void

  • Parameters

    • source: any
    • destination: {
          [key: string]: any;
      }
      • [key: string]: any
    • Optional ignore: string[]

    Returns void

Static mapValuesDeep

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc