API Reference
DetectedSymbol
Unified result returned by SymbolScanner.
Inheritance
- Object
- DetectedSymbol
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
- Property ScanResult.Symbols
Accepted by parameters
- Method SymbolScanner.TryScan
- Method SymbolScanner.TryScan
Inherited Methods
Properties
public SymbolFormat Format { get; } #Gets the physical symbol format.
public String Text { get; } #Gets the decoded text.
public ReadOnlyMemory<Byte> RawBytes { get; } #Gets exact payload bytes when the underlying decoder exposes them.
public Boolean HasRawBytes { get; } #Gets whether RawBytes came from the underlying decoder.
public SymbolPayloadProfile PayloadProfile { get; } #Gets a recognized payload profile.
public SymbolGeometry Geometry { get; } #Gets the detected symbol geometry, or null when the decoder does not report location.
public ImageRegion SearchRegion { get; } #Gets the image region searched for this result.
public Nullable<Double> Confidence { get; } #Gets decoder confidence in the range [0, 1], or null when unavailable.
public Nullable<Boolean> IsInverted { get; } #Gets whether an inverted image was used, or null when unavailable.
public Nullable<Boolean> IsMirrored { get; } #Gets whether a mirrored image was used, or null when unavailable.
public Nullable<Int32> FrameIndex { get; } #Gets the animation frame index, or null for a single raw frame.
public Nullable<Int32> PageIndex { get; } #Gets the document page index, or null for a single raw frame.
public String SymbologyIdentifier { get; } #Gets the AIM symbology identifier when known.
public Nullable<DirectPartMarkProfile> DirectPartMarkProfile { get; } #Gets the direct-part-mark preprocessing profile used for this result, or null for ordinary image decoding.
public Boolean WasDirectPartMarkPreprocessed { get; } #Gets whether direct-part-mark preprocessing was required.
public CodeGlyphDecoded LegacyResult { get; } #Gets the compatibility result produced by the existing decoding facade.