View Source Image.QRcode (image v0.32.0)

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
Note

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

Link to this section Summary

Functions

decode(image)

Detects and decodes a QR code in an image.

encode(string, options \\ [])

Encodes a string as a QRCode.

Link to this section Functions

decode(image)

(since 0.9.0)

Detects and decodes a QR code in an image.

arguments
Arguments

image is any Vix.Vips.Image.t/0 that has three bands (for example, a typical srgb image).

returns
Returns

{:ok, string} or
{:error, reason}

note
Note

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

encode(string, options \\ [])

(since 0.13.0)

Encodes a string as a QRCode.

arguments
Arguments

string is any string to be encoded,
options is a keyword list of options. The default is size: :auto.

options
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
Returns

{:ok, image} or
{:error, reason}