com.ingenico.sdk.barcodereader

Class BarcodeReader

java.lang.Object

com.ingenico.sdk.ServiceConnector

com.ingenico.sdk.barcodereader.BarcodeReader

All Implemented Interfaces:

IBarcodeReader, IIngenicoApi

public final class BarcodeReader
extends ServiceConnector
implements IBarcodeReader

Barcode Reader Service.

Since:

2.10.0

Nested Class Summary

Nested classes/interfaces inherited from class com.ingenico.sdk.ServiceConnector

ServiceConnector.InternalServiceConnection

Field Summary

Fields inherited from class com.ingenico.sdk.ServiceConnector

ACTION_BIND_V2, SERVICES_PACKAGE

Method Summary

Modifier and Type	Method and Description
protected android.content.Intent	getBindIntent() Can be overrided to connect to other services
static IBarcodeReader	getInstance(android.content.Context context) Return a global instance of Barcode Reader, which is the default implementation of IBarcodeReader, and instantiate it if needed.
java.util.List<PreviewSize>	getPreviewSizes(int cameraType) Get the list of preview sizes supported by the service according the camera type selected on the current device or payment terminal.
protected java.lang.String	getServiceName() Must be overrided to provide service class name used for binding.
java.util.List<java.lang.Integer>	getSymbols() Get the list of symbols supported by the service according the barcode decoding library selected on the current device or payment terminal.
protected void	onServiceReady(android.os.IBinder service) Internal callback when service is connected.
protected void	onServiceUnbinded() Internal callback when service is disconnected.
void	registerBarcodeReaderListener(IBarcodeReaderResultListener listener) Register a new listener for BarcodeReader event sent during the process.
void	start(BarcodeReaderInputData inputData) Start a barcode reader according to the parameters filled in inputData field.
void	start(BarcodeReaderInputData inputData, android.view.Surface inputPreview) Start a barcode reader according to the parameters filled in inputData field.
void	stop() Stop the barcode reader process.
void	unregisterBarcodeReaderListener(IBarcodeReaderResultListener listener) Unregister an existing barcode reader listener.

Methods inherited from class com.ingenico.sdk.ServiceConnector

connect, connectSync, disconnect, ensureServiceIsReady, getContext, isConnected

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static IBarcodeReader getInstance(android.content.Context context)

Return a global instance of Barcode Reader, which is the default implementation of IBarcodeReader, and instantiate it if needed.

Be aware that only one instance will be created for the whole application, so the associated context should not be a component which could be destroyed at some point, ie. an Activity. Passing the Application to this method is preferred over other context types.

Parameters:

context - A valid context to initialize the instance.

Returns:

getBindIntent

protected android.content.Intent getBindIntent()

Description copied from class: ServiceConnector

Can be overrided to connect to other services

Overrides:

getBindIntent in class ServiceConnector

Returns:

getPreviewSizes

public java.util.List<PreviewSize> getPreviewSizes(int cameraType)
                                            throws IngenicoException

Get the list of preview sizes supported by the service according the camera type selected on the current device or payment terminal.

Usage example:

IBarcodeReader barcodeReader = BarcodeReader.getInstance(context);

// Check that 640x480 preview size is available on the front camera
boolean expectedSizeIsAvailable = false;

List<PreviewSize> previewSizes = barcodeReader.getPreviewSizes(CameraTypes.FRONT);
for (PreviewSize size : previewSizes) {
    if ((size.getWidth() == 640) && (size.getHeight() == 480)) {
        expectedSizeIsAvailable = true;
        break;
    }
}
if (expectedSizeIsAvailable) {
    // Start barcode reader with a 640x480 preview size
}

Specified by:

getPreviewSizes in interface IBarcodeReader

Returns:

camera preview sizes

Throws:

IngenicoException - when could not retrieve the preview sizes

getSymbols

public java.util.List<java.lang.Integer> getSymbols()

Get the list of symbols supported by the service according the barcode decoding library selected on the current device or payment terminal.

Specified by:

getSymbols in interface IBarcodeReader

Returns:

symbols

start

public void start(@NonNull
                  BarcodeReaderInputData inputData)
           throws IngenicoException

Start a barcode reader according to the parameters filled in inputData field.

Specified by:

start in interface IBarcodeReader

Parameters:

inputData - barcode reader parameters

Throws:

IngenicoException - when the start barcode reader call fails

start

public void start(@NonNull
                  BarcodeReaderInputData inputData,
                  @NonNull
                  android.view.Surface inputPreview)
           throws IngenicoException

Start a barcode reader according to the parameters filled in inputData field.

Specified by:

start in interface IBarcodeReader

Parameters:

inputData - barcode reader parameters

inputPreview - use TextureView to display a content stream come from camera preview

Throws:

IngenicoException - when the start barcode reader call fails

stop

public void stop()
          throws IngenicoException

Stop the barcode reader process.

Specified by:

stop in interface IBarcodeReader

Throws:

IngenicoException - when the stop barcode reader call fails (not started)

registerBarcodeReaderListener

public void registerBarcodeReaderListener(@NonNull
                                          IBarcodeReaderResultListener listener)

Description copied from interface: IBarcodeReader

Register a new listener for BarcodeReader event sent during the process.

Specified by:

registerBarcodeReaderListener in interface IBarcodeReader

Parameters:

listener - barcode reader listener

unregisterBarcodeReaderListener

public void unregisterBarcodeReaderListener(@NonNull
                                            IBarcodeReaderResultListener listener)

Description copied from interface: IBarcodeReader

Unregister an existing barcode reader listener.

Specified by:

unregisterBarcodeReaderListener in interface IBarcodeReader

Parameters:

listener - barcode reader listener

getServiceName

protected java.lang.String getServiceName()

Description copied from class: ServiceConnector

Must be overrided to provide service class name used for binding.

Specified by:

getServiceName in class ServiceConnector

Returns:

onServiceReady

protected void onServiceReady(android.os.IBinder service)

Description copied from class: ServiceConnector

Internal callback when service is connected. This is where we should retrieve the aidl interface.

Specified by:

onServiceReady in class ServiceConnector

onServiceUnbinded

protected void onServiceUnbinded()

Description copied from class: ServiceConnector

Internal callback when service is disconnected.

Specified by:

onServiceUnbinded in class ServiceConnector