Constructors

Properties

storage: SBStorage
Config: Config

Accessors

  • get version(): string
  • Returns string

Methods

  • This method will destroy all web workers and free the memory held by the SDK (after the next run of the garbage collector).

    This function should not be called while a scanner is open or an API call is pending. If you do call this function while a scanner is open, the scanner will stop detecting anything, but the video will keep running. If you call this function while an API call is pending, that pending API call might never finish.

    After calling this function, no further calls to this object are allowed. To further use the SDK, it needs to be initialized again.

    Returns void

  • Parameters

    • image: string | Image

      An image URL (e.g. Data URL or HTTP URL) or an Image object

    • Optional partialDetectionParameters: {
          barcodeFormatConfigurations?: (({ readonly _type?: "BarcodeFormatCodabarConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; minimumTextLength?: number; maximumTextLength?: number; returnStartEnd?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCode11Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; minimumTextLength?: number; maximumTextLength?: number; checksum?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCode39Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 8 more ...; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCode93Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; minimumTextLength?: number; maximumTextLength?: number; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCode128Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; minimumTextLength?: number; maximumTextLength?: number; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCode2Of5Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 6 more ...; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatDataBarConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatDataBarExpandedConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatDataBarLimitedConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatITFConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; minimumTextLength?: number; maximumTextLength?: number; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatMSIPlesseyConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; minimumTextLength?: number; maximumTextLength?: number; checksumAlgorithms?: MsiPlesseyChecksumAlgorithm[]; _marke...) | ({ readonly _type?: "BarcodeFormatUpcEanConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 5 more ...; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatPharmaCodeConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; minimumValue?: number; allowNarrowBarsOnly?: boolean; allowWideBarsOnly?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatAztecConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatQRCodeConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; strictMode?: boolean; qr?: boolean; microQr?: boolean; rmqr?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatPDF417Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; strictMode?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatMicroPDF417Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; strictMode?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatDataMatrixConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatMaxiCodeConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatAustraliaPostConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; australiaPostCustomerFormat?: AustraliaPostCustomerFormat; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatJapanPostConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatRoyalMailConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; stripCheckDigits?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatRoyalTNTPostConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatUSPSIntelligentMailConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatPharmaCodeTwoTrackConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimumValue?: number; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatGS1CompositeConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; strictMode?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCommonOneDConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 4 more ...; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCommonTwoDConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; strictMode?: boolean; formats?: BarcodeFormat[]; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCommonFourStateConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; formats?: BarcodeFormat[]; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCommonConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 5 more ...; _marker?: () => void; }))[];
          engineMode?: BarcodeScannerEngineMode;
          extractedDocumentFormats?: BarcodeDocumentFormat[];
          onlyAcceptDocuments?: boolean;
          returnBarcodeImage?: boolean;
      }
      • Optional barcodeFormatConfigurations?: (({ readonly _type?: "BarcodeFormatCodabarConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; minimumTextLength?: number; maximumTextLength?: number; returnStartEnd?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCode11Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; minimumTextLength?: number; maximumTextLength?: number; checksum?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCode39Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 8 more ...; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCode93Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; minimumTextLength?: number; maximumTextLength?: number; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCode128Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; minimumTextLength?: number; maximumTextLength?: number; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCode2Of5Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 6 more ...; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatDataBarConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatDataBarExpandedConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatDataBarLimitedConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatITFConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; minimumTextLength?: number; maximumTextLength?: number; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatMSIPlesseyConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; minimumTextLength?: number; maximumTextLength?: number; checksumAlgorithms?: MsiPlesseyChecksumAlgorithm[]; _marke...) | ({ readonly _type?: "BarcodeFormatUpcEanConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 5 more ...; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatPharmaCodeConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; minimumValue?: number; allowNarrowBarsOnly?: boolean; allowWideBarsOnly?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatAztecConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatQRCodeConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; strictMode?: boolean; qr?: boolean; microQr?: boolean; rmqr?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatPDF417Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; strictMode?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatMicroPDF417Configuration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; strictMode?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatDataMatrixConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatMaxiCodeConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatAustraliaPostConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; australiaPostCustomerFormat?: AustraliaPostCustomerFormat; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatJapanPostConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatRoyalMailConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; stripCheckDigits?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatRoyalTNTPostConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatUSPSIntelligentMailConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatPharmaCodeTwoTrackConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimumValue?: number; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatGS1CompositeConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; gs1Handling?: Gs1Handling; strictMode?: boolean; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCommonOneDConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 4 more ...; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCommonTwoDConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; gs1Handling?: Gs1Handling; strictMode?: boolean; formats?: BarcodeFormat[]; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCommonFourStateConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; formats?: BarcodeFormat[]; _marker?: () => void; }) | ({ readonly _type?: "BarcodeFormatCommonConfiguration"; regexFilter?: string; minimumSizeScore?: number; addAdditionalQuietZone?: boolean; minimum1DQuietZoneSize?: number; stripCheckDigits?: boolean; ... 5 more ...; _marker?: () => void; }))[]

        Options for barcode decoding.

        Default Value

        [new BarcodeFormatCommonConfiguration({})];
        
      • Optional engineMode?: BarcodeScannerEngineMode

        The engine mode for barcode scanning.

        Default Value

        "NEXT_GEN_LOW_POWER";
        
      • Optional extractedDocumentFormats?: BarcodeDocumentFormat[]

        List of document formats to be extracted. Barcodes that decode to one of the extracted document formats will have extractedDocument field in BarcodeItem populated with the parsed document. By default all supported barcode document formats are accepted. If empty, no barcodes will be parsed into documents. To only accept the document formats listed in extractedDocumentFormats, the property onlyAcceptDocuments must be true.

        Default Value

        ["AAMVA", "BOARDING_PASS", "DE_MEDICAL_PLAN", "MEDICAL_CERTIFICATE", "ID_CARD_PDF_417", "SEPA", "SWISS_QR", "VCARD", "GS1", "HIBC"];
        
      • Optional onlyAcceptDocuments?: boolean

        If true and extractedDocumentFormats is not empty, then barcodes that don't decode to one of the extracted document formats will be ignored.

        Default Value

        false;
        
      • Optional returnBarcodeImage?: boolean

        If true, the barcode image will be returned in the BarcodeItem.

        Default Value

        false;
        
    • Optional consumeImage: ConsumeType

    Returns Promise<BarcodeScannerResult & {
        originalImage: Image;
    }>

  • Crops and stretches the image to the convex hull of the supplied points. All points should have relative coordinates between 0 and 1.

    Parameters

    Returns Promise<RawImage>

  • Parameters

    Returns Promise<RawImage>

  • Parameters

    Returns Promise<Uint8Array>

  • Parameters

    • object: ObjectId<any>
    • Optional source: string

    Returns Promise<void>

  • Image Operations

    Parameters

    • imageBuffer: ArrayBuffer

    Returns Promise<string>

Generated using TypeDoc