Note
This API is still in beta and may change in future versions of Scandit Data Capture SDK.
Scanned Barcode
Defined under the namespace Scandit.Datacapture.Barcode
- ScannedBarcode
class ScannedBarcode : ScannedComponent<BarcodeIdentifier>
Added in version 8.1.0
A scanned barcode component in the item-based scanning APIs. This class represents a detected and decoded barcode with all its associated data and metadata.
ScannedBarcode implements the ScannedComponent protocol, providing a unique identifier and location information, along with barcode-specific properties such as symbology, payload data, and decoding metadata.
- definitionIdentifier
get definitionIdentifier(): BarcodeIdentifier
Added in version 8.1.0
The unique identifier for the definition of this barcode component.
- identifier
get identifier(): ScannedComponentIdentifier
Added in version 8.1.0
The unique identifier for this instance of the barcode component.
- location
get location(): Quadrilateral
Added in version 8.1.0
The location of the barcode as a quadrilateral.
- payloadString
get payloadString(): string | null
Added in version 8.1.0
The data of this barcode as a unicode string. May be null for barcodes containing non-printable characters, or characters that cannot be represented as unicode code points, or nul-bytes in the middle of the string
- addOnPayloadString
get addOnPayloadString(): string | null
Added in version 8.1.0
The add-on payload string if the barcode has an add-on. null if the barcode does not have an add-on.
- compositePayloadString
get compositePayloadString(): string | null
Added in version 8.1.0
The composite payload string if the barcode is part of a composite barcode. null if the barcode is not composite.
- isGS1DataCarrier
get isGS1DataCarrier(): boolean
Added in version 8.1.0
True for codes that carry GS1 data.
- compositeFlag
get compositeFlag(): CompositeFlag
Added in version 8.1.0
Flag to hint whether the barcode is part of a composite code.
- isColorInverted
get isColorInverted(): boolean
Added in version 8.1.0
Whether the recognized code is color inverted (printed bright on dark background).