Documentation – Read barcodes

V4: Set Barcode Source

Mon, 01 Jan 0001 00:00:00 +0000

To perform barcode recognition using the Aspose.BarCode.Cloud SDK for Swift, you need to set the source of the barcode image. Methods of this SDK support loading barcode images from multiple sources, such as file URL, Data, and base64 encoded data. This guide provides detailed examples on how to set barcode image source through different API methods.

Supported Barcode Image Formats

JPEG
TIFF
PNG
BMP
GIF

Supported Barcode Source Formats

File URL: Link directly to an image URL.
Data: The image file bytes for processing.
Base64 Encoded Image: Convert the image to a base64 encoded string for secure transfer.

Examples for ScanAPI

Using GET Request with File URL

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)
let barcodeImageURL =
    ProcessInfo.processInfo.environment["TEST_CONFIGURATION_BARCODE_IMAGE_URL"]
        ?? "https://raw.githubusercontent.com/aspose-barcode-cloud/Aspose.BarCode-Cloud-SDK-for-Swift/main/testdata/QR_and_Code128.png"

let response = try await ScanAPI.scan(
    fileUrl: barcodeImageURL,
    apiConfiguration: client.apiConfiguration
)

print(response.barcodes?.first?.barcodeValue ?? "No barcode found")

Using POST Request with Base64 Encoded Image

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try Data(contentsOf: URL(fileURLWithPath: "qr.png"))
let request = ScanBase64Request(fileBase64: imageData.base64EncodedString())

let response = try await ScanAPI.scanBase64(
    scanBase64Request: request,
    apiConfiguration: client.apiConfiguration
)

print(response.barcodes?.first?.barcodeValue ?? "No barcode found")

Using POST Request with File Stream

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try Data(contentsOf: URL(fileURLWithPath: "qr.png"))
let response = try await ScanAPI.scanMultipart(
    file: imageData,
    apiConfiguration: client.apiConfiguration
)

print(response.barcodes?.first?.barcodeValue ?? "No barcode found")

Examples for RecognizeAPI

Using GET Request with File URL

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)
let barcodeImageURL =
    ProcessInfo.processInfo.environment["TEST_CONFIGURATION_BARCODE_IMAGE_URL"]
        ?? "https://raw.githubusercontent.com/aspose-barcode-cloud/Aspose.BarCode-Cloud-SDK-for-Swift/main/testdata/QR_and_Code128.png"

let response = try await RecognizeAPI.recognize(
    barcodeType: .qr,
    fileUrl: barcodeImageURL,
    apiConfiguration: client.apiConfiguration
)

print(response.barcodes?.first?.barcodeValue ?? "No barcode found")

Using POST Request with Base64 Encoded Image

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try Data(contentsOf: URL(fileURLWithPath: "qr.png"))
let request = RecognizeBase64Request(
    barcodeTypes: [.qr],
    fileBase64: imageData.base64EncodedString()
)

let response = try await RecognizeAPI.recognizeBase64(
    recognizeBase64Request: request,
    apiConfiguration: client.apiConfiguration
)

print(response.barcodes?.first?.barcodeValue ?? "No barcode found")

Using POST Request with File Stream

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try Data(contentsOf: URL(fileURLWithPath: "qr.png"))
let response = try await RecognizeAPI.recognizeMultipart(
    barcodeType: .qr,
    file: imageData,
    apiConfiguration: client.apiConfiguration
)

print(response.barcodes?.first?.barcodeValue ?? "No barcode found")

Conclusion

Using the Aspose.BarCode.Cloud SDK for Swift, you can easily load and recognize barcode images in file URL, Data, and base64 encoded formats.

Optimize your barcode recognition workflows by selecting the most appropriate method based on your specific image format and application requirements.

V4: Set Target Barcode Types

Mon, 01 Jan 0001 00:00:00 +0000

This guide provides an overview of setting target barcode types using the Aspose.BarCode.Cloud SDK for Swift. Using this SDK, you can specify the barcode types you want to recognize when sending requests, including formats like Aztec, QR, Pdf417, and many others.

Overview of `RecognizeAPI`

The RecognizeAPI provides methods for recognizing barcodes from various data inputs. You can choose to send barcode recognition requests using either a file URL, a base64 encoded image, or a multipart form request. By specifying the barcode type and recognition settings, you can optimize the API to target the specific barcode formats your application needs.

Supported Barcode Types

The DecodeBarcodeType enum allows for a variety of barcode types, including:

Aztec
QR
Code128
DataMatrix
Pdf417
EAN13
…and many more.

For full supported barcode list see the decode type github page

Example: Specifying Target Barcode Types

Using `recognize`

This method sends a GET request with the file URL and barcode type in the query parameters.

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)
let barcodeImageURL =
    ProcessInfo.processInfo.environment["TEST_CONFIGURATION_BARCODE_IMAGE_URL"]
        ?? "https://raw.githubusercontent.com/aspose-barcode-cloud/Aspose.BarCode-Cloud-SDK-for-Swift/main/testdata/QR_and_Code128.png"

let response = try await RecognizeAPI.recognize(
    barcodeType: .mostCommonlyUsed,
    fileUrl: barcodeImageURL,
    apiConfiguration: client.apiConfiguration
)

print(response.barcodes?.first?.barcodeValue ?? "No barcode found")

In this example, most commonly used barcode symbologies will be recognized from the provided image URL.

Using `recognizeBase64` with multiple Barcode Types

For base64-encoded images, use the recognizeBase64 method, which allows for flexible recognition across multiple barcode types.

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try Data(contentsOf: URL(fileURLWithPath: "barcode.png"))
let request = RecognizeBase64Request(
    barcodeTypes: [.qr, .pdf417],
    fileBase64: imageData.base64EncodedString()
)

let response = try await RecognizeAPI.recognizeBase64(
    recognizeBase64Request: request,
    apiConfiguration: client.apiConfiguration
)

print(response.barcodes?.first?.barcodeValue ?? "No barcode found")

In this example, the API will target both QR and Pdf417 barcode types in the base64 image string.

Using `recognizeMultipart`

For recognizing barcodes from files in a form upload, use recognizeMultipart. This method supports setting a single barcode type.

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try Data(contentsOf: URL(fileURLWithPath: "pdf417.png"))
let response = try await RecognizeAPI.recognizeMultipart(
    barcodeType: .pdf417,
    file: imageData,
    apiConfiguration: client.apiConfiguration
)

print(response.barcodes?.first?.barcodeValue ?? "No barcode found")

This example sets the target type to Pdf417, recognizing only this type in the uploaded image file.

Conclusion

By specifying target barcode types in your RecognizeAPI requests, you can optimize performance and precision based on your application’s needs. Setting a DecodeBarcodeType for your recognition tasks ensures that only specific barcode formats are detected, improving accuracy and efficiency.

V4: Set Barcode Image Kind

Mon, 01 Jan 0001 00:00:00 +0000

This documentation provides an overview of how to use the Aspose.BarCode.Cloud SDK for Swift to set the type of barcode image for recognition. Setting the correct RecognitionImageKind is essential for optimizing the recognition process and ensuring high accuracy, particularly when dealing with diverse barcode types or varying image qualities.

Introduction

The Aspose.BarCode.Cloud SDK for Swift allows for flexible barcode scanning and recognition from different image sources. One of the features in this API is the ability to specify the RecognitionImageKind based on the source of the barcode image. This improves accuracy by guiding the recognition engine with additional context about the image.

Usage in API Requests

The RecognitionImageKind parameter is optional and can be set in several requests within the API. It is available in the following request classes:

recognize
recognizeBase64
recognizeMultipart

Image Kind Options

The RecognitionImageKind enum provides three options:

Photo: Use this option when recognizing barcodes from smartphone cameras. High resolution. Barcode is a large part of the image.
ScannedDocument: Select this for scanned documents pages. Medium resolution. Barcode is a small part of the image.
ClearImage: Ideal for clean, digitally-rendered barcode images with minimal background noise or preprocessed photos. Low resolution. The barcode is almost the entire image.

Examples

Below are examples of using the RecognitionImageKind setting with various API methods.

Using `recognize`

The recognize method allows for barcode recognition using a GET request.

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)
let barcodeImageURL =
    ProcessInfo.processInfo.environment["TEST_CONFIGURATION_BARCODE_IMAGE_URL"]
        ?? "https://raw.githubusercontent.com/aspose-barcode-cloud/Aspose.BarCode-Cloud-SDK-for-Swift/main/testdata/QR_and_Code128.png"

let response = try await RecognizeAPI.recognize(
    barcodeType: .qr,
    fileUrl: barcodeImageURL,
    recognitionImageKind: .clearImage,
    apiConfiguration: client.apiConfiguration
)

print(response.barcodes?.first?.barcodeValue ?? "No barcode found")

Using `recognizeBase64`

For recognition using a POST request with JSON or XML, use recognizeBase64:

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try Data(contentsOf: URL(fileURLWithPath: "barcode.png"))
let request = RecognizeBase64Request(
    barcodeTypes: [.qr],
    fileBase64: imageData.base64EncodedString(),
    recognitionImageKind: .clearImage
)

let response = try await RecognizeAPI.recognizeBase64(
    recognizeBase64Request: request,
    apiConfiguration: client.apiConfiguration
)

print(response.barcodes?.first?.barcodeValue ?? "No barcode found")

Using `recognizeMultipart`

For file uploads with multipart form data, recognizeMultipart is used:

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try Data(contentsOf: URL(fileURLWithPath: "qr.png"))
let response = try await RecognizeAPI.recognizeMultipart(
    barcodeType: .qr,
    file: imageData,
    recognitionImageKind: .clearImage,
    apiConfiguration: client.apiConfiguration
)

print(response.barcodes?.first?.barcodeValue ?? "No barcode found")

Conclusion

The Barcode Recognition API provides flexible options to recognize barcodes in various formats including photos, scanned documents, and clear images. By setting the RecognitionImageKind, developers can enhance recognition accuracy, particularly when working with diverse image sources. Supported barcode types include popular formats like QR Code, Aztec, Pdf417, and many more. The API allows integration with GET and POST methods, supporting JSON, XML, and multipart form data formats.

For high accuracy, configure the RecognitionImageKind parameter based on your image source. This small adjustment can lead to faster processing times and better recognition results across all supported barcode types.

V4: Set Recognition Quality and Speed

Mon, 01 Jan 0001 00:00:00 +0000

When working with barcodes in applications, optimizing recognition quality and speed is essential. The RecognitionMode setting in the Aspose.BarCode.Cloud SDK for Swift offers a way to adjust these parameters, making it possible to prioritize either quality or speed during barcode recognition.

Recognition Mode Options

The RecognitionMode parameter can be set to the following values to control the recognition process:

Fast: Optimizes for speed but may lower the accuracy slightly. Minimal recognition timeout.
Normal: Balances speed and quality, suitable for most cases. Medium recognition timeout.
Excellent: Prioritizes accuracy over speed, ideal for challenging barcode images. Maximum recognition timeout.

Usage in API Requests

The RecognizeAPI interface provides methods to recognize barcodes from files using different HTTP request types. Below are the available methods:

recognize: Recognizes barcode from a file on the server using a GET request.
recognizeBase64: Recognizes barcode from a file provided in the request body using a POST request with JSON or XML format.
recognizeMultipart: Recognizes barcode from a file provided in the request body using a POST request with multipart/form-data.

Example Implementations

Example 1: Using `recognize`

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)
let barcodeImageURL =
    ProcessInfo.processInfo.environment["TEST_CONFIGURATION_BARCODE_IMAGE_URL"]
        ?? "https://raw.githubusercontent.com/aspose-barcode-cloud/Aspose.BarCode-Cloud-SDK-for-Swift/main/testdata/QR_and_Code128.png"

let response = try await RecognizeAPI.recognize(
    barcodeType: .qr,
    fileUrl: barcodeImageURL,
    recognitionMode: .excellent,
    apiConfiguration: client.apiConfiguration
)

print(response.barcodes?.first?.barcodeValue ?? "No barcode found")

Example 2: Using `recognizeBase64`

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try Data(contentsOf: URL(fileURLWithPath: "barcode.png"))
let request = RecognizeBase64Request(
    barcodeTypes: [.qr],
    fileBase64: imageData.base64EncodedString(),
    recognitionMode: .excellent
)

let response = try await RecognizeAPI.recognizeBase64(
    recognizeBase64Request: request,
    apiConfiguration: client.apiConfiguration
)

print(response.barcodes?.first?.barcodeValue ?? "No barcode found")

Example 3: Using `recognizeMultipart`

import AsposeBarcodeCloud
import Foundation

let client = AsposeBarcodeCloudClient(
    clientId: "Client Id from https://dashboard.aspose.cloud/applications",
    clientSecret: "Client Secret from https://dashboard.aspose.cloud/applications"
)

let imageData = try Data(contentsOf: URL(fileURLWithPath: "qr.png"))
let response = try await RecognizeAPI.recognizeMultipart(
    barcodeType: .qr,
    file: imageData,
    recognitionMode: .excellent,
    apiConfiguration: client.apiConfiguration
)

print(response.barcodes?.first?.barcodeValue ?? "No barcode found")

Conclusion

Choosing the appropriate RecognitionMode is essential in tailoring barcode recognition to the specific needs of your application. Whether prioritizing speed or accuracy, the examples provided demonstrate how to use the RecognizeAPI interface to adjust settings for optimal performance. By fine-tuning RecognitionMode and RecognitionImageKind, you can enhance both efficiency and accuracy, making your barcode processing solution robust across various use cases.

Documentation – Read barcodes

V4: Set Barcode Source

Supported Barcode Image Formats

Supported Barcode Source Formats

Examples for ScanAPI

Examples for RecognizeAPI

Conclusion

V4: Set Target Barcode Types

Overview of RecognizeAPI

Supported Barcode Types

Example: Specifying Target Barcode Types

Using recognize

Using recognizeBase64 with multiple Barcode Types

Using recognizeMultipart

Conclusion

V4: Set Barcode Image Kind

Introduction

Usage in API Requests

Image Kind Options

Examples

Using recognize

Using recognizeBase64

Using recognizeMultipart

Conclusion

V4: Set Recognition Quality and Speed

Recognition Mode Options

Usage in API Requests

Example Implementations

Example 1: Using recognize

Example 2: Using recognizeBase64

Example 3: Using recognizeMultipart

Conclusion

Overview of `RecognizeAPI`

Using `recognize`

Using `recognizeBase64` with multiple Barcode Types

Using `recognizeMultipart`

Using `recognize`

Using `recognizeBase64`

Using `recognizeMultipart`

Example 1: Using `recognize`

Example 2: Using `recognizeBase64`

Example 3: Using `recognizeMultipart`