API Reference
ScanOptions
Controls unified symbol scanning.
Inheritance
- Object
- ScanOptions
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 ScanOptions.Balanced
- Method ScanOptions.Fast
- Method ScanOptions.Robust
- Method ScanOptions.Screen
Accepted by parameters
- Method SymbolScanner.Scan
- Method SymbolScanner.Scan
- Method SymbolScanner.TryScan
- Method SymbolScanner.TryScan
Constructors
public ScanOptions() #Methods
public static ScanOptions Balanced(Int32 timeoutMilliseconds = 500) #ScanOptionsCreates balanced scan options.
Parameters
- timeoutMilliseconds System.Int32 = 500
public static ScanOptions Fast(Int32 timeoutMilliseconds = 150) #ScanOptionsCreates low-latency scan options.
Parameters
- timeoutMilliseconds System.Int32 = 150
public static ScanOptions Robust(Int32 timeoutMilliseconds = 1500) #ScanOptionsCreates robust scan options.
Parameters
- timeoutMilliseconds System.Int32 = 1500
public static ScanOptions Screen(Int32 timeoutMilliseconds = 300, Int32 maxDimension = 1200) #ScanOptionsCreates bounded options suitable for screenshot and UI scanning.
Parameters
- timeoutMilliseconds System.Int32 = 300
- maxDimension System.Int32 = 1200
Inherited Methods
Properties
public SymbolFormat[] Formats { get; set; } #Gets or sets the formats to scan. A null or empty array selects every image-scannable format. Module-only requested formats are reported through UnsupportedFormats.
public Nullable<ImageRegion> Region { get; set; } #Gets or sets an optional region of interest in source-image coordinates.
public Int32 TimeoutMilliseconds { get; set; } #Gets or sets the total wall-clock deadline in milliseconds for image decoding, conversion, and recognition. Zero disables the deadline. Recognition cancellation is cooperative rather than hard real-time.
public Int32 MaxSymbols { get; set; } #Gets or sets the maximum number of results. Zero means unlimited.
public Boolean Deduplicate { get; set; } #Gets or sets whether equivalent format-and-payload results are deduplicated.
public ScanProfile Profile { get; set; } #Gets or sets the scanner speed and accuracy profile.
public QrPixelDecodeOptions Qr { get; set; } #Gets or sets advanced QR recognition options.
public BarcodeDecodeOptions Barcode { get; set; } #Gets or sets advanced linear-barcode recognition options.
public DirectPartMarkOptions DirectPartMarking { get; set; } #Gets or sets opt-in direct-part-mark preprocessing for Data Matrix images.
public ImageDecodeOptions Image { get; set; } #Gets or sets compressed-image decode limits and codec options.
public CancellationToken CancellationToken { get; set; } #Gets or sets caller cancellation.