io.scanbot.sdk.barcode.entity

Class BarcodeItem

io.scanbot.sdk.barcode.entity.BarcodeItem

public class BarcodeItem

Encapsulates the result of decoding a barcode within an image.

Constructor Detail

BarcodeItem

public BarcodeItem(@NotNull
                   java.lang.String text,
                   @NotNull
                   kotlin.Array[] rawBytes,
                   int numBits,
                   @Nullable
                   ResultPoint[] resultPoints,
                   @NotNull
                   BarcodeFormat barcodeFormat,
                   @Nullable
                   io.scanbot.barcodescanner.model.BarCodeFormattedResult formattedResult,
                   @Nullable
                   BarcodeFormattedData formattedData)

Encapsulates the result of decoding a barcode within an image.

Parameters:

text -

rawBytes -

numBits -

resultPoints -

barcodeFormat - Representing the format of the barcode that was decoded

formattedResult - Formatted result represented by the barcode content

formattedData - Allows to set additional data encoded in barcode such as title and subtitle

BarcodeItem

public BarcodeItem(@NotNull
                   java.lang.String text,
                   @NotNull
                   kotlin.Array[] rawBytes,
                   int numBits,
                   @Nullable
                   ResultPoint[] resultPoints,
                   @NotNull
                   BarcodeFormat barcodeFormat,
                   @Nullable
                   io.scanbot.barcodescanner.model.BarCodeFormattedResult barcodeDocumentFormat,
                   @Nullable
                   BarcodeFormattedData formattedData,
                   @Nullable
                   android.graphics.Bitmap image)

BarcodeItem

@JvmOverloads
public BarcodeItem(@NotNull
                                 java.lang.String text,
                                 @NotNull
                                 kotlin.Array[] rawBytes,
                                 @Nullable
                                 ResultPoint[] resultPoints,
                                 @NotNull
                                 BarcodeFormat format,
                                 @Nullable
                                 io.scanbot.barcodescanner.model.BarCodeFormattedResult documentFormat,
                                 @Nullable
                                 BarcodeFormattedData formattedData,
                                 @Nullable
                                 android.graphics.Bitmap image)

BarcodeItem

@JvmOverloads
public BarcodeItem(@NotNull
                                 java.lang.String text,
                                 @NotNull
                                 kotlin.Array[] rawBytes,
                                 @Nullable
                                 ResultPoint[] resultPoints,
                                 @NotNull
                                 BarcodeFormat format,
                                 @Nullable
                                 io.scanbot.barcodescanner.model.BarCodeFormattedResult documentFormat,
                                 @Nullable
                                 BarcodeFormattedData formattedData)

BarcodeItem

@JvmOverloads
public BarcodeItem(@NotNull
                                 java.lang.String text,
                                 @NotNull
                                 kotlin.Array[] rawBytes,
                                 @Nullable
                                 ResultPoint[] resultPoints,
                                 @NotNull
                                 BarcodeFormat format,
                                 @Nullable
                                 io.scanbot.barcodescanner.model.BarCodeFormattedResult documentFormat)

BarcodeItem

@JvmOverloads
public BarcodeItem(@NotNull
                                 java.lang.String text,
                                 @NotNull
                                 kotlin.Array[] rawBytes,
                                 @Nullable
                                 ResultPoint[] resultPoints,
                                 @NotNull
                                 BarcodeFormat format)

BarcodeItem

public BarcodeItem(@NotNull
                   BarcodeItem item,
                   @Nullable
                   BarcodeFormattedData formattedData)

Method Detail

getImage

@Nullable
public android.graphics.Bitmap getImage()

setImage

public void setImage(@Nullable
                     android.graphics.Bitmap p)

addResultPoints

public void addResultPoints(@Nullable
                            ResultPoint[] newPoints)

getText

@NotNull
public java.lang.String getText()

Returns:

raw text encoded by the barcode

getRawBytes

@NotNull
public kotlin.Array[] getRawBytes()

Returns:

raw bytes encoded by the barcode

getNumBits

public int getNumBits()

Deprecated.

Returns:

how many bits of .getRawBytes are valid; typically 8 times its length

getResultPoints

@Nullable
public ResultPoint[] getResultPoints()

Returns:

points related to the barcode in the image. These are typically points identifying finder patterns or the corners of the barcode. The exact meaning is specific to the type of barcode that was decoded.

setResultPoints

public void setResultPoints(@Nullable
                            ResultPoint[] p)

Parameters:

p -

getBarcodeFormat

@NotNull
public BarcodeFormat getBarcodeFormat()

Representing the format of the barcode that was decoded

getFormattedResult

@Nullable
public io.scanbot.barcodescanner.model.BarCodeFormattedResult getFormattedResult()

Formatted result represented by the barcode content

getFormattedData

@Nullable
public BarcodeFormattedData getFormattedData()

Allows to set additional data encoded in barcode such as title and subtitle