Class Result

Encapsulates the result of decoding a barcode within an image.

author: Sean Owen

Hierarchy

Result

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Result(text: string, rawBytes: Uint8Array, numBits?: number, resultPoints: ResultPoint[], format: BarcodeFormat, timestamp?: number): Result

- Defined in src/core/Result.ts:33
Parameters
- text: string
- rawBytes: Uint8Array
- Default value numBits: number = rawBytes == null ? 0 : 8 * rawBytes.length
- resultPoints: ResultPoint[]
- format: BarcodeFormat
- Default value timestamp: number = System.currentTimeMillis()
Returns Result

Properties

Private format

format: BarcodeFormat

Private numBits

numBits: number

Private rawBytes

rawBytes: Uint8Array

Private resultMetadata

resultMetadata: Map<ResultMetadataType, Object>

Private resultPoints

resultPoints: ResultPoint[]

Private text

text: string

Private timestamp

timestamp: number

Methods

addResultPoints

addResultPoints(newPoints: Array<ResultPoint>): void

- Defined in src/core/Result.ts:138
Parameters
- newPoints: Array<ResultPoint>
Returns void

getBarcodeFormat

getBarcodeFormat(): BarcodeFormat

- Defined in src/core/Result.ts:108
Returns BarcodeFormat

BarcodeFormat representing the format of the barcode that was decoded

getNumBits

getNumBits(): number

- Defined in src/core/Result.ts:92
since

3.3.0

Returns number

how many bits of {@link #getRawBytes()} are valid; typically 8 times its length

getRawBytes

getRawBytes(): Uint8Array

- Defined in src/core/Result.ts:84
Returns Uint8Array

raw bytes encoded by the barcode, if applicable, otherwise {@code null}

getResultMetadata

getResultMetadata(): Map<ResultMetadataType, Object>

- Defined in src/core/Result.ts:117
Returns Map<ResultMetadataType, Object>

{@link Map} mapping ResultMetadataType keys to values. May be {@code null}. This contains optional metadata about what was detected about the barcode, like orientation.

getResultPoints

getResultPoints(): Array<ResultPoint>

- Defined in src/core/Result.ts:101
Returns Array<ResultPoint>

points related to the barcode in the image. These are typically points identifying finder patterns or the corners of the barcode. The exact meaning is specific to the type of barcode that was decoded.

getText

getText(): string

- Defined in src/core/Result.ts:77
Returns string

raw text encoded by the barcode

getTimestamp

getTimestamp(): number

- Defined in src/core/Result.ts:150
Returns number

putAllMetadata

putAllMetadata(metadata: Map<ResultMetadataType, Object>): void

- Defined in src/core/Result.ts:128
Parameters
- metadata: Map<ResultMetadataType, Object>
Returns void

putMetadata

putMetadata(type: ResultMetadataType, value: Object): void

- Defined in src/core/Result.ts:121
Parameters
- type: ResultMetadataType
- value: Object
Returns void

toString

toString(): string

- Defined in src/core/Result.ts:155
Returns string

Generated using TypeDoc