View Source Evision.QRCodeEncoder (Evision v0.2.2)

Summary

Types

t()

Type that represents an QRCodeEncoder struct.

Functions

Constructor

Constructor

Generates QR code from input string.

Generates QR code from input string.

Generates QR code from input string in Structured Append mode. The encoded message is splitting over a number of QR codes.

Generates QR code from input string in Structured Append mode. The encoded message is splitting over a number of QR codes.

Types

@type t() :: %Evision.QRCodeEncoder{ref: reference()}

Type that represents an QRCodeEncoder struct.

  • ref. reference()

    The underlying erlang resource variable.

Functions

@spec create() :: t() | {:error, String.t()}

Constructor

Keyword Arguments
  • parameters: Evision.QRCodeEncoder.Params.t().

    QR code encoder parameters QRCodeEncoder::Params

Return
  • retval: Evision.QRCodeEncoder.t()

Python prototype (for reference only):

create([, parameters]) -> retval
@spec create([{:parameters, term()}] | nil) :: t() | {:error, String.t()}

Constructor

Keyword Arguments
  • parameters: Evision.QRCodeEncoder.Params.t().

    QR code encoder parameters QRCodeEncoder::Params

Return
  • retval: Evision.QRCodeEncoder.t()

Python prototype (for reference only):

create([, parameters]) -> retval
Link to this function

encode(self, encoded_info)

View Source
@spec encode(t(), binary()) :: Evision.Mat.t() | {:error, String.t()}

Generates QR code from input string.

Positional Arguments
  • self: Evision.QRCodeEncoder.t()

  • encoded_info: String.

    Input string to encode.

Return
  • qrcode: Evision.Mat.t().

    Generated QR code.

Python prototype (for reference only):

encode(encoded_info[, qrcode]) -> qrcode
Link to this function

encode(self, encoded_info, opts)

View Source
@spec encode(t(), binary(), [{atom(), term()}, ...] | nil) ::
  Evision.Mat.t() | {:error, String.t()}

Generates QR code from input string.

Positional Arguments
  • self: Evision.QRCodeEncoder.t()

  • encoded_info: String.

    Input string to encode.

Return
  • qrcode: Evision.Mat.t().

    Generated QR code.

Python prototype (for reference only):

encode(encoded_info[, qrcode]) -> qrcode
Link to this function

encodeStructuredAppend(self, encoded_info)

View Source
@spec encodeStructuredAppend(t(), binary()) ::
  [Evision.Mat.t()] | {:error, String.t()}

Generates QR code from input string in Structured Append mode. The encoded message is splitting over a number of QR codes.

Positional Arguments
  • self: Evision.QRCodeEncoder.t()

  • encoded_info: String.

    Input string to encode.

Return
  • qrcodes: [Evision.Mat].

    Vector of generated QR codes.

Python prototype (for reference only):

encodeStructuredAppend(encoded_info[, qrcodes]) -> qrcodes
Link to this function

encodeStructuredAppend(self, encoded_info, opts)

View Source
@spec encodeStructuredAppend(t(), binary(), [{atom(), term()}, ...] | nil) ::
  [Evision.Mat.t()] | {:error, String.t()}

Generates QR code from input string in Structured Append mode. The encoded message is splitting over a number of QR codes.

Positional Arguments
  • self: Evision.QRCodeEncoder.t()

  • encoded_info: String.

    Input string to encode.

Return
  • qrcodes: [Evision.Mat].

    Vector of generated QR codes.

Python prototype (for reference only):

encodeStructuredAppend(encoded_info[, qrcodes]) -> qrcodes