CodeGlyphX logo
CodeGlyphX

API Reference

Class

BarcodeDecoder

Namespace CodeGlyphX
Assembly CodeGlyphX
Modifiers static

Best-effort 1D barcode decoder (scanline-based).

Inheritance

  • Object
  • BarcodeDecoder

Methods

TryDecode 17 overloads
public static Boolean TryDecode(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat format, out BarcodeDecoded decoded) #
Returns: Boolean

Attempts to decode a 1D barcode from a raw pixel buffer.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
format CodeGlyphX.PixelFormat requiredposition: 4
decoded CodeGlyphX.BarcodeDecoded@ requiredposition: 5
public static Boolean TryDecode(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat format, BarcodeDecodeOptions options, out BarcodeDecoded decoded) #
Returns: Boolean

Attempts to decode a 1D barcode from a raw pixel buffer.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
format CodeGlyphX.PixelFormat requiredposition: 4
expectedType System.Nullable{CodeGlyphX.BarcodeType} requiredposition: 5
decoded CodeGlyphX.BarcodeDecoded@ requiredposition: 6
TryDecode(System.Byte[] pixels, System.Int32 width, System.Int32 height, System.Int32 stride, CodeGlyphX.PixelFormat format, CodeGlyphX.BarcodeDecodeOptions options, CodeGlyphX.BarcodeDecoded@ decoded) #

Attempts to decode a 1D barcode from a raw pixel buffer with custom decoding options.

Parameters

pixels System.Byte[] required
width System.Int32 required
height System.Int32 required
stride System.Int32 required
format CodeGlyphX.PixelFormat required
options CodeGlyphX.BarcodeDecodeOptions required
decoded CodeGlyphX.BarcodeDecoded@ required
public static Boolean TryDecode(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat format, Nullable<BarcodeType> expectedType, BarcodeDecodeOptions options, out BarcodeDecoded decoded) #
Returns: Boolean

Attempts to decode a 1D barcode from a raw pixel buffer with an optional type hint and custom decoding options.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
format CodeGlyphX.PixelFormat requiredposition: 4
expectedType System.Nullable{CodeGlyphX.BarcodeType} requiredposition: 5
options CodeGlyphX.BarcodeDecodeOptions requiredposition: 6
decoded CodeGlyphX.BarcodeDecoded@ requiredposition: 7
public static Boolean TryDecode(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat format, Nullable<BarcodeType> expectedType, BarcodeDecodeOptions options, CancellationToken cancellationToken, out BarcodeDecoded decoded) #
Returns: Boolean

Attempts to decode a 1D barcode from a raw pixel buffer with an optional type hint, custom options, and cancellation.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
format CodeGlyphX.PixelFormat requiredposition: 4
expectedType System.Nullable{CodeGlyphX.BarcodeType} requiredposition: 5
options CodeGlyphX.BarcodeDecodeOptions requiredposition: 6
cancellationToken System.Threading.CancellationToken requiredposition: 7
decoded CodeGlyphX.BarcodeDecoded@ requiredposition: 8
public static Boolean TryDecode(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat format, Nullable<BarcodeType> expectedType, BarcodeDecodeOptions options, CancellationToken cancellationToken, out BarcodeDecoded decoded, out BarcodeDecodeDiagnostics diagnostics) #
Returns: Boolean

Attempts to decode a 1D barcode from a raw pixel buffer with diagnostics.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
format CodeGlyphX.PixelFormat requiredposition: 4
expectedType System.Nullable{CodeGlyphX.BarcodeType} requiredposition: 5
options CodeGlyphX.BarcodeDecodeOptions requiredposition: 6
cancellationToken System.Threading.CancellationToken requiredposition: 7
decoded CodeGlyphX.BarcodeDecoded@ requiredposition: 8
diagnostics CodeGlyphX.BarcodeDecodeDiagnostics@ requiredposition: 9
TryDecode(System.ReadOnlySpan{System.Byte} pixels, System.Int32 width, System.Int32 height, System.Int32 stride, CodeGlyphX.PixelFormat format, CodeGlyphX.BarcodeDecoded@ decoded) #

Attempts to decode a 1D barcode from a raw pixel buffer.

Parameters

pixels System.ReadOnlySpan{System.Byte} required
width System.Int32 required
height System.Int32 required
stride System.Int32 required
format CodeGlyphX.PixelFormat required
decoded CodeGlyphX.BarcodeDecoded@ required
TryDecode(System.ReadOnlySpan{System.Byte} pixels, System.Int32 width, System.Int32 height, System.Int32 stride, CodeGlyphX.PixelFormat format, System.Nullable{CodeGlyphX.BarcodeType} expectedType, CodeGlyphX.BarcodeDecoded@ decoded) #

Attempts to decode a 1D barcode from a raw pixel buffer.

Parameters

pixels System.ReadOnlySpan{System.Byte} required
width System.Int32 required
height System.Int32 required
stride System.Int32 required
format CodeGlyphX.PixelFormat required
expectedType System.Nullable{CodeGlyphX.BarcodeType} required
decoded CodeGlyphX.BarcodeDecoded@ required
TryDecode(System.ReadOnlySpan{System.Byte} pixels, System.Int32 width, System.Int32 height, System.Int32 stride, CodeGlyphX.PixelFormat format, CodeGlyphX.BarcodeDecodeOptions options, CodeGlyphX.BarcodeDecoded@ decoded) #

Attempts to decode a 1D barcode from a raw pixel buffer with custom decoding options.

Parameters

pixels System.ReadOnlySpan{System.Byte} required
width System.Int32 required
height System.Int32 required
stride System.Int32 required
format CodeGlyphX.PixelFormat required
options CodeGlyphX.BarcodeDecodeOptions required
decoded CodeGlyphX.BarcodeDecoded@ required
TryDecode(System.ReadOnlySpan{System.Byte} pixels, System.Int32 width, System.Int32 height, System.Int32 stride, CodeGlyphX.PixelFormat format, System.Nullable{CodeGlyphX.BarcodeType} expectedType, CodeGlyphX.BarcodeDecodeOptions options, CodeGlyphX.BarcodeDecoded@ decoded) #

Attempts to decode a 1D barcode from a raw pixel buffer with an optional type hint and custom decoding options.

Parameters

pixels System.ReadOnlySpan{System.Byte} required
width System.Int32 required
height System.Int32 required
stride System.Int32 required
format CodeGlyphX.PixelFormat required
expectedType System.Nullable{CodeGlyphX.BarcodeType} required
options CodeGlyphX.BarcodeDecodeOptions required
decoded CodeGlyphX.BarcodeDecoded@ required
TryDecode(System.ReadOnlySpan{System.Byte} pixels, System.Int32 width, System.Int32 height, System.Int32 stride, CodeGlyphX.PixelFormat format, System.Nullable{CodeGlyphX.BarcodeType} expectedType, CodeGlyphX.BarcodeDecodeOptions options, System.Threading.CancellationToken cancellationToken, CodeGlyphX.BarcodeDecoded@ decoded) #

Attempts to decode a 1D barcode from a raw pixel buffer with an optional type hint, custom options, and cancellation.

Parameters

pixels System.ReadOnlySpan{System.Byte} required
width System.Int32 required
height System.Int32 required
stride System.Int32 required
format CodeGlyphX.PixelFormat required
expectedType System.Nullable{CodeGlyphX.BarcodeType} required
options CodeGlyphX.BarcodeDecodeOptions required
cancellationToken System.Threading.CancellationToken required
decoded CodeGlyphX.BarcodeDecoded@ required
TryDecode(System.ReadOnlySpan{System.Byte} pixels, System.Int32 width, System.Int32 height, System.Int32 stride, CodeGlyphX.PixelFormat format, System.Nullable{CodeGlyphX.BarcodeType} expectedType, CodeGlyphX.BarcodeDecodeOptions options, System.Threading.CancellationToken cancellationToken, CodeGlyphX.BarcodeDecoded@ decoded, CodeGlyphX.BarcodeDecodeDiagnostics@ diagnostics) #

Attempts to decode a 1D barcode from a raw pixel buffer with diagnostics.

Parameters

pixels System.ReadOnlySpan{System.Byte} required
width System.Int32 required
height System.Int32 required
stride System.Int32 required
format CodeGlyphX.PixelFormat required
expectedType System.Nullable{CodeGlyphX.BarcodeType} required
options CodeGlyphX.BarcodeDecodeOptions required
cancellationToken System.Threading.CancellationToken required
decoded CodeGlyphX.BarcodeDecoded@ required
diagnostics CodeGlyphX.BarcodeDecodeDiagnostics@ required
public static Boolean TryDecode(Boolean[] modules, out BarcodeDecoded decoded) #
Returns: Boolean

Attempts to decode a 1D barcode from a module sequence.

Parameters

modules System.Boolean[] requiredposition: 0
decoded CodeGlyphX.BarcodeDecoded@ requiredposition: 1
public static Boolean TryDecode(Boolean[] modules, BarcodeDecodeOptions options, out BarcodeDecoded decoded) #
Returns: Boolean

Attempts to decode a 1D barcode from a module sequence.

Parameters

modules System.Boolean[] requiredposition: 0
expectedType System.Nullable{CodeGlyphX.BarcodeType} requiredposition: 1
decoded CodeGlyphX.BarcodeDecoded@ requiredposition: 2
TryDecode(System.Boolean[] modules, CodeGlyphX.BarcodeDecodeOptions options, CodeGlyphX.BarcodeDecoded@ decoded) #

Attempts to decode a 1D barcode from a module sequence with custom decoding options.

Parameters

modules System.Boolean[] required
options CodeGlyphX.BarcodeDecodeOptions required
decoded CodeGlyphX.BarcodeDecoded@ required
public static Boolean TryDecode(Boolean[] modules, Nullable<BarcodeType> expectedType, BarcodeDecodeOptions options, out BarcodeDecoded decoded) #
Returns: Boolean

Attempts to decode a 1D barcode from a module sequence with an optional type hint and custom decoding options.

Parameters

modules System.Boolean[] requiredposition: 0
expectedType System.Nullable{CodeGlyphX.BarcodeType} requiredposition: 1
options CodeGlyphX.BarcodeDecodeOptions requiredposition: 2
decoded CodeGlyphX.BarcodeDecoded@ requiredposition: 3
public static Boolean TryDecode(Boolean[] modules, Nullable<BarcodeType> expectedType, BarcodeDecodeOptions options, CancellationToken cancellationToken, out BarcodeDecoded decoded) #
Returns: Boolean

Attempts to decode a 1D barcode from a module sequence with an optional type hint, custom decoding options, and cancellation.

Parameters

modules System.Boolean[] requiredposition: 0
expectedType System.Nullable{CodeGlyphX.BarcodeType} requiredposition: 1
options CodeGlyphX.BarcodeDecodeOptions requiredposition: 2
cancellationToken System.Threading.CancellationToken requiredposition: 3
decoded CodeGlyphX.BarcodeDecoded@ requiredposition: 4
TryDecodeAll 2 overloads
public static Boolean TryDecodeAll(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat format, out BarcodeDecoded[] decoded, Nullable<BarcodeType> expectedType = null, BarcodeDecodeOptions options = null, CancellationToken cancellationToken = null) #
Returns: Boolean

Attempts to decode all 1D barcodes from a raw pixel buffer.

Parameters

pixels System.Byte[] requiredposition: 0
width System.Int32 requiredposition: 1
height System.Int32 requiredposition: 2
stride System.Int32 requiredposition: 3
format CodeGlyphX.PixelFormat requiredposition: 4
decoded CodeGlyphX.BarcodeDecoded[]@ requiredposition: 5
expectedType System.Nullable{CodeGlyphX.BarcodeType} = null optionalposition: 6
options CodeGlyphX.BarcodeDecodeOptions = null optionalposition: 7
cancellationToken System.Threading.CancellationToken = null optionalposition: 8
TryDecodeAll(System.ReadOnlySpan{System.Byte} pixels, System.Int32 width, System.Int32 height, System.Int32 stride, CodeGlyphX.PixelFormat format, CodeGlyphX.BarcodeDecoded[]@ decoded, System.Nullable{CodeGlyphX.BarcodeType} expectedType, CodeGlyphX.BarcodeDecodeOptions options, System.Threading.CancellationToken cancellationToken) #

Attempts to decode all 1D barcodes from a raw pixel buffer.

Parameters

pixels System.ReadOnlySpan{System.Byte} required
width System.Int32 required
height System.Int32 required
stride System.Int32 required
format CodeGlyphX.PixelFormat required
decoded CodeGlyphX.BarcodeDecoded[]@ required
expectedType System.Nullable{CodeGlyphX.BarcodeType} required
options CodeGlyphX.BarcodeDecodeOptions required
cancellationToken System.Threading.CancellationToken required