API Reference
Class
OtpQrDecoder
Convenience decoder for OTP QR payloads.
Inheritance
- Object
- OtpQrDecoder
Methods
TryDecode 2 overloads
public static Boolean TryDecode(BitMatrix modules, out OtpAuthPayload payload) #Returns:
BooleanAttempts to decode an OTP payload from a module matrix.
Parameters
- modules CodeGlyphX.BitMatrix
- payload CodeGlyphX.OtpAuthPayload@
public static Boolean TryDecode(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out OtpAuthPayload payload) #Returns:
BooleanAttempts to decode an OTP payload from raw pixels.
Parameters
- pixels System.ReadOnlySpan{System.Byte}
- width System.Int32
- height System.Int32
- stride System.Int32
- fmt CodeGlyphX.PixelFormat
- payload CodeGlyphX.OtpAuthPayload@
TryDecodeDetailed 3 overloads
public static Boolean TryDecodeDetailed(BitMatrix modules, out OtpAuthParseResult result, out String error) #Returns:
BooleanAttempts to decode an OTP payload from a module matrix and returns warnings.
Parameters
- modules CodeGlyphX.BitMatrix
- result CodeGlyphX.OtpAuthParseResult@
- error System.String@
public static Boolean TryDecodeDetailed(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out OtpAuthParseResult result, out String error) #Returns:
BooleanAttempts to decode an OTP payload from raw pixels and returns warnings.
Parameters
- pixels System.ReadOnlySpan{System.Byte}
- width System.Int32
- height System.Int32
- stride System.Int32
- fmt CodeGlyphX.PixelFormat
- result CodeGlyphX.OtpAuthParseResult@
- error System.String@
public static Boolean TryDecodeDetailed(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out OtpAuthParseResult result, out String qrDiagnostics, out String error) #Returns:
BooleanAttempts to decode an OTP payload from raw pixels, returning QR diagnostics text and OTP warnings.
Parameters
- pixels System.ReadOnlySpan{System.Byte}
- width System.Int32
- height System.Int32
- stride System.Int32
- fmt CodeGlyphX.PixelFormat
- result CodeGlyphX.OtpAuthParseResult@
- qrDiagnostics System.String@
- error System.String@
TryDecodeStrict 4 overloads
public static Boolean TryDecodeStrict(BitMatrix modules, out OtpAuthPayload payload, out String error) #Returns:
BooleanAttempts to decode and strictly validate an OTP payload from a module matrix.
Parameters
- modules CodeGlyphX.BitMatrix
- payload CodeGlyphX.OtpAuthPayload@
- error System.String@
public static Boolean TryDecodeStrict(BitMatrix modules, OtpAuthValidationOptions options, out OtpAuthPayload payload, out String error) #Returns:
BooleanAttempts to decode and validate an OTP payload from a module matrix.
Parameters
- modules CodeGlyphX.BitMatrix
- options CodeGlyphX.OtpAuthValidationOptions
- payload CodeGlyphX.OtpAuthPayload@
- error System.String@
public static Boolean TryDecodeStrict(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, out OtpAuthPayload payload, out String error) #Returns:
BooleanAttempts to decode and strictly validate an OTP payload from raw pixels.
Parameters
- pixels System.ReadOnlySpan{System.Byte}
- width System.Int32
- height System.Int32
- stride System.Int32
- fmt CodeGlyphX.PixelFormat
- payload CodeGlyphX.OtpAuthPayload@
- error System.String@
public static Boolean TryDecodeStrict(ReadOnlySpan<Byte> pixels, Int32 width, Int32 height, Int32 stride, PixelFormat fmt, OtpAuthValidationOptions options, out OtpAuthPayload payload, out String error) #Returns:
BooleanAttempts to decode and validate an OTP payload from raw pixels.
Parameters
- pixels System.ReadOnlySpan{System.Byte}
- width System.Int32
- height System.Int32
- stride System.Int32
- fmt CodeGlyphX.PixelFormat
- options CodeGlyphX.OtpAuthValidationOptions
- payload CodeGlyphX.OtpAuthPayload@
- error System.String@