BarcodeObservation

bottomLeft

get bottomLeft(): NormalizedPoint

let bottomLeft: NormalizedPoint

The coordinates of the lower-left corner of the quadrilateral.

confidence

get confidence(): number

let confidence: Float

The level of confidence normalized to `[0, 1]` where `1` is most confident. The only exception is results coming from `CoreMLRequest`, where confidence values are forwarded as is from relevant CoreML models

bottomRight

get bottomRight(): NormalizedPoint

let bottomRight: NormalizedPoint

The coordinates of the lower-right corner of the quadrilateral.

description

get description(): string

var description: String { get }

A textual representation of this instance. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(describing:)` initializer. This initializer works with any type, and uses the custom `description` property for types that conform to `CustomStringConvertible`: struct Point: CustomStringConvertible { let x: Int, y: Int var description: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(describing: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `description` property.

payloadData

get payloadData(): (ArrayBuffer) | null

let payloadData: Data?

The raw data representation of the barcode’s payload.

payloadString

get payloadString(): (string) | null

let payloadString: String?

A string value that represents the barcode payload. Depending on the symbology or the payload data itself, a string representation of the payload may not be available.

boundingRegion

get boundingRegion(): ContoursObservation_Contour

var boundingRegion: NormalizedRegion { get }

The bounding region of the barcode.

isColorInverted

get isColorInverted(): boolean

let isColorInverted: Bool

A Boolean value that indicates whether the barcode is color inverted.

isGS1DataCarrier

get isGS1DataCarrier(): boolean

let isGS1DataCarrier: Bool

A Boolean value that indicates whether the barcode carries any global standards data.

supplementalPayloadData

get supplementalPayloadData(): (ArrayBuffer) | null

let supplementalPayloadData: Data?

The raw data representation of the barcode’s supplemental payload.

supplementalCompositeType

get supplementalCompositeType(): (BarcodeObservation_CompositeType) | null

let supplementalCompositeType: BarcodeObservation.CompositeType?

The supplemental composite type. Currently, this can only refer to the composite flag of the 2D symbology as part of a GS1 composite symbology. This attribute only exists when the primary descriptor is the 1D symbology of a GS1 composite symbology, and of which a valid 2D counterpart has been coalesced into.

supplementalPayloadString

get supplementalPayloadString(): (string) | null

let supplementalPayloadString: String?

The supplemental code decoded as a string value.

originatingRequestDescriptor

get originatingRequestDescriptor(): (RequestDescriptor) | null

let originatingRequestDescriptor: RequestDescriptor?

The descriptor of the request that produced the observation.

uuid

get uuid(): string

let uuid: UUID

The unique identifier for the observation.

topLeft

get topLeft(): NormalizedPoint

let topLeft: NormalizedPoint

The coordinates of the upper-left corner of the quadrilateral.

topRight

get topRight(): NormalizedPoint

let topRight: NormalizedPoint

The coordinates of the upper-right corner of the quadrilateral.

symbology

get symbology(): BarcodeSymbology

let symbology: BarcodeSymbology

The symbology of the observed barcode.

timeRange

get timeRange(): (_CoreMedia_CMTimeRange) | null

let timeRange: CMTimeRange?

The time range of the reported observation. When evaluating a sequence of image buffers, use this property to determine each observation’s start time and duration.

init

static init(observation: VNBarcodeObservation): BarcodeObservation

init(_ observation: VNBarcodeObservation)