API Reference
CodeGlyphDecodeOptions
Options for unified QR/barcode decoding.
Inheritance
- Object
- CodeGlyphDecodeOptions
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method CodeGlyphDecodeOptions.Balanced
- Method CodeGlyphDecodeOptions.Fast
- Method CodeGlyphDecodeOptions.IncludeBarcodeResults
- Method CodeGlyphDecodeOptions.PreferBarcodeFirst
- Method CodeGlyphDecodeOptions.Robust
- Method CodeGlyphDecodeOptions.Screen
- Method CodeGlyphDecodeOptions.Stylized
- Method CodeGlyphDecodeOptions.WithAggressiveQrSampling
- Method CodeGlyphDecodeOptions.WithBarcode
- Method CodeGlyphDecodeOptions.WithCancellation
- Method CodeGlyphDecodeOptions.WithExpectedBarcode
- Method CodeGlyphDecodeOptions.WithImage
- Method CodeGlyphDecodeOptions.WithImageBudget
- Method CodeGlyphDecodeOptions.WithImageMaxBytes
- Method CodeGlyphDecodeOptions.WithImageMaxPixels
- Method CodeGlyphDecodeOptions.WithJpegOptions
- Method CodeGlyphDecodeOptions.WithJpegOptions
- Method CodeGlyphDecodeOptions.WithQr
- Method CodeGlyphDecodeOptions.WithQrBudget
- Method CodeGlyphDecodeOptions.WithQrMaxScale
- Method CodeGlyphDecodeOptions.WithQrProfile
Accepted by parameters
- Method CodeGlyph.DecodeAllAuto
- Method CodeGlyph.DecodeAuto
- Method CodeGlyph.DecodeImageBatch
- Method CodeGlyph.DecodeImageResult
- Method CodeGlyph.DecodeImageResult
- Method CodeGlyph.TryDecode
- Method CodeGlyph.TryDecode
- Method CodeGlyph.TryDecode
- Method CodeGlyph.TryDecode
- Method CodeGlyph.TryDecodeAll
- Method CodeGlyph.TryDecodeAll
- Method CodeGlyph.TryDecodeAll
- Method CodeGlyph.TryDecodeAll
- Method CodeGlyph.TryDecodeAllAuto
- Method CodeGlyph.TryDecodeAllAuto
- Method CodeGlyph.TryDecodeAllAutoFile
- Method CodeGlyph.TryDecodeAllImage
- Method CodeGlyph.TryDecodeAllImage
- Method CodeGlyph.TryDecodeAllImageAsync
- Method CodeGlyph.TryDecodeAllPng
- Method CodeGlyph.TryDecodeAllPng
- Method CodeGlyph.TryDecodeAllPngFile
- Method CodeGlyph.TryDecodeAuto
- Method CodeGlyph.TryDecodeAuto
- Method CodeGlyph.TryDecodeAutoFile
- Method CodeGlyph.TryDecodeImage
- Method CodeGlyph.TryDecodeImage
- Method CodeGlyph.TryDecodeImage
- Method CodeGlyph.TryDecodeImageAsync
- Method CodeGlyph.TryDecodePng
- Method CodeGlyph.TryDecodePng
- Method CodeGlyph.TryDecodePng
- Method CodeGlyph.TryDecodePngFile
Constructors
public CodeGlyphDecodeOptions() #Methods
public static CodeGlyphDecodeOptions Balanced() #CodeGlyphDecodeOptionsBalanced preset (good default for most images).
public static CodeGlyphDecodeOptions Fast() #CodeGlyphDecodeOptionsFast preset (lower accuracy, fewer transforms).
public CodeGlyphDecodeOptions IncludeBarcodeResults(Boolean enabled = true) #CodeGlyphDecodeOptionsInclude 1D barcode results when decoding multiple symbols.
Parameters
- enabled System.Boolean = true
public CodeGlyphDecodeOptions PreferBarcodeFirst(Boolean enabled = true) #CodeGlyphDecodeOptionsPrefer trying barcodes before 2D codes.
Parameters
- enabled System.Boolean = true
public static CodeGlyphDecodeOptions Robust() #CodeGlyphDecodeOptionsRobust preset (best accuracy, slower).
public static CodeGlyphDecodeOptions Screen(Int32 maxMilliseconds = 300, Int32 maxDimension = 1200) #CodeGlyphDecodeOptionsScreen preset (budgeted decode for UI capture scenarios).
Parameters
- maxMilliseconds System.Int32 = 300
- maxDimension System.Int32 = 1200
public static CodeGlyphDecodeOptions Stylized() #CodeGlyphDecodeOptionsStylized preset (adds aggressive sampling for QR art).
public CodeGlyphDecodeOptions WithAggressiveQrSampling(Boolean enabled = true) #CodeGlyphDecodeOptionsEnables aggressive QR sampling.
Parameters
- enabled System.Boolean = true
public CodeGlyphDecodeOptions WithBarcode(Action<BarcodeDecodeOptions> configure) #CodeGlyphDecodeOptionsConfigures barcode decode options fluently.
Parameters
- configure System.Action{CodeGlyphX.BarcodeDecodeOptions}
public CodeGlyphDecodeOptions WithCancellation(CancellationToken token) #CodeGlyphDecodeOptionsSets a cancellation token for decoding.
Parameters
- token System.Threading.CancellationToken
public CodeGlyphDecodeOptions WithExpectedBarcode(Nullable<BarcodeType> barcodeType) #CodeGlyphDecodeOptionsSets the expected barcode type.
Parameters
- barcodeType System.Nullable{CodeGlyphX.BarcodeType}
public CodeGlyphDecodeOptions WithImage(Action<ImageDecodeOptions> configure) #CodeGlyphDecodeOptionsConfigures image decode options fluently.
Parameters
- configure System.Action{CodeGlyphX.ImageDecodeOptions}
public CodeGlyphDecodeOptions WithImageBudget(Int32 maxMilliseconds, Int32 maxDimension = 0) #CodeGlyphDecodeOptionsApplies a non-QR image decode budget (milliseconds + optional max dimension).
Parameters
- maxMilliseconds System.Int32
- maxDimension System.Int32 = 0
public CodeGlyphDecodeOptions WithImageMaxBytes(Int32 maxBytes) #CodeGlyphDecodeOptionsSets the maximum input size in bytes for non-QR image decoding.
Parameters
- maxBytes System.Int32
public CodeGlyphDecodeOptions WithImageMaxPixels(Int64 maxPixels) #CodeGlyphDecodeOptionsSets the maximum pixel count allowed for non-QR image decoding.
Parameters
- maxPixels System.Int64
public CodeGlyphDecodeOptions WithJpegOptions(JpegDecodeOptions options) #CodeGlyphDecodeOptionsSets JPEG decoding options on the image decode options.
Parameters
- options CodeGlyphX.Rendering.Jpeg.JpegDecodeOptions
Examples
var options = new CodeGlyphDecodeOptions()
.WithJpegOptions(highQualityChroma: true, allowTruncated: true);
public CodeGlyphDecodeOptions WithJpegOptions(Boolean highQualityChroma = false, Boolean allowTruncated = false) #CodeGlyphDecodeOptionsSets JPEG decoding options on the image decode options.
Parameters
- highQualityChroma System.Boolean = false
- allowTruncated System.Boolean = false
Examples
var options = new CodeGlyphDecodeOptions()
.WithJpegOptions(highQualityChroma: true);
public CodeGlyphDecodeOptions WithQr(Action<QrPixelDecodeOptions> configure) #CodeGlyphDecodeOptionsConfigures QR decode options fluently.
Parameters
- configure System.Action{CodeGlyphX.QrPixelDecodeOptions}
public CodeGlyphDecodeOptions WithQrBudget(Int32 maxMilliseconds, Int32 maxDimension = 0) #CodeGlyphDecodeOptionsApplies a QR decode budget (milliseconds + optional max dimension).
Parameters
- maxMilliseconds System.Int32
- maxDimension System.Int32 = 0
public CodeGlyphDecodeOptions WithQrMaxScale(Int32 maxScale) #CodeGlyphDecodeOptionsOverrides maximum QR scale.
Parameters
- maxScale System.Int32
public CodeGlyphDecodeOptions WithQrProfile(QrDecodeProfile profile) #CodeGlyphDecodeOptionsSets the QR profile for this decode.
Parameters
- profile CodeGlyphX.QrDecodeProfile
Inherited Methods
Properties
public Nullable<BarcodeType> ExpectedBarcode { get; set; } #Expected barcode type (optional hint for 1D decoding).
public BarcodeDecodeOptions Barcode { get; set; } #Options for 1D barcode decoding.
public Code39ChecksumPolicy Code39Checksum { get; set; } #Controls how Code39 checksum characters are handled during decode.
public MsiChecksumPolicy MsiChecksum { get; set; } #Controls how MSI checksum digits are handled during decode.
public Code11ChecksumPolicy Code11Checksum { get; set; } #Controls how Code 11 checksum characters are handled during decode.
public PlesseyChecksumPolicy PlesseyChecksum { get; set; } #Controls whether Plessey CRC validation is required during decode.
public Boolean PreferBarcode { get; set; } #Prefer trying barcodes before 2D codes.
public Boolean IncludeBarcode { get; set; } #Include 1D barcode results when decoding multiple symbols.
public QrPixelDecodeOptions Qr { get; set; } #QR decode options (profile, budget, etc.).
public ImageDecodeOptions Image { get; set; } #Image decode options for non-QR symbols.
public QrDecodeProfile Profile { get; set; } #Speed/accuracy profile for QR pixel decoding (default: Robust).
public Int32 MaxDimension { get; set; } #Maximum dimension (pixels) for QR decoding. Larger inputs will be downscaled by sampling. Set to 0 to disable.
public Int32 MaxScale { get; set; } #Maximum scale to try when decoding QR (1..8). Set to 0 to use profile defaults.
public Int32 MaxMilliseconds { get; set; } #Maximum milliseconds to spend decoding QR (best effort). Set to 0 to disable.
public Boolean DisableTransforms { get; set; } #Disable rotation/mirroring attempts for QR decoding, even in robust profiles.
public Boolean AggressiveSampling { get; set; } #Enables extra thresholding/sampling passes for stylized or noisy QR codes (slower).
public Int32 MaxImageDimension { get; set; } #Maximum image dimension (pixels) for non-QR decoding. Larger inputs will be downscaled. Set to 0 to disable.
public Int64 MaxImagePixels { get; set; } #Maximum pixel count allowed for non-QR image decoding (width * height). Set to 0 to disable.
public Int32 MaxImageBytes { get; set; } #Maximum input size in bytes for non-QR image decoding. Set to 0 to disable.
public Int32 MaxImageMilliseconds { get; set; } #Maximum milliseconds to spend decoding non-QR symbols (best effort). Set to 0 to disable.
public CancellationToken CancellationToken { get; set; } #Cancellation token for decoding.