View Source Image.QRcode (image v0.48.1)

Detects and decodes QRcodes.

Note that the implementation, which is based upon eVision requires that the image be a 3-channel image in order to support detection.

Images that are in different formats must be converted first.

Note

This module is only available if the optional dependency eVision is configured in mix.exs.

Summary

Functions

Detects and decodes a QR code in an image.

Encodes a string as a QRCode.

Functions

Link to this function

decode(image)

View Source (since 0.9.0)

Detects and decodes a QR code in an image.

Arguments

Returns

  • {:ok, string} or

  • {:error, reason}

Note

Only images with three bands (channels) are supported. This restriction may be lifted in a future release.

Link to this function

encode(string, options \\ [])

View Source (since 0.13.0)

Encodes a string as a QRCode.

Arguments

  • string is any string to be encoded,

  • options is a keyword list of options. The default is size: :auto.

Options

  • :size is the size in pixels of the QRcode dimensions. The default is :auto in which the generated QRcode will be the minimum dimensions necessary to encode the string.

Returns

  • {:ok, image} or

  • {:error, reason}