BarcodeReader Class

Namespace: id3.Devices

Definition

Augments DeviceChannel with functionalities for capturing data from devices, including state monitoring and data retrieval mechanisms.

Python

class BarcodeReader

Dart

class BarcodeReader implements Finalizable

C#

public partial class BarcodeReader

Java

public class BarcodeReader implements AutoCloseable, Serializable

C

typedef struct id3DevicesBarcodeReader *ID3_DEVICES_BARCODE_READER;

Usage

Python

barcodeReaderInstance = BarcodeReader()
# ...

Explicit destruction

# ...
del barcodeReaderInstance

Dart

final barcodeReaderInstance = sdk.BarcodeReader();
// ...

Explicit destruction

// ...
barcodeReaderInstance.dispose()

C#

using (var barcodeReaderInstance = new BarcodeReader())
{
   // ...
}

Explicit destruction

var barcodeReaderInstance = new BarcodeReader()
// ...
barcodeReaderInstance.Dispose()

Java

try (BarcodeReader barcodeReaderInstance = new BarcodeReader()) {
// ...
}

Explicit destruction

BarcodeReader barcodeReaderInstance = new BarcodeReader();
// ...
barcodeReaderInstance.close();

C

ID3_DEVICES_BARCODE_READER hBarcodeReader{};
int err = id3DevicesBarcodeReader_Initialize(&hBarcodeReader);
if (err == ID3_SUCCESS) {
    // ...
    id3DevicesBarcodeReader_Dispose(&hBarcodeReader);
}

Properties

Name	Type	Description
captureCallback	CaptureCallback	Callback function triggered when new capture data becomes available from the device.
deviceAddedCallback	PlugAndPlayCallback	Callback invoked when a device is added to the channel.
deviceClosedCallback	DeviceSelectedCallback	Callback function for when a device is closed on this channel.
deviceEventCallback	DeviceEventCallback	(C++): Callback for generic device events.
deviceFilterList	DeviceTypeList	A list filtering the types of devices this channel will interact with.
deviceId	int	Identifier for the device associated with this channel, intended for internal or plugin use.
deviceInfo	DeviceInfo	Fetches the device object.
deviceOpenedCallback	DeviceSelectedCallback	Callback that is called when a device is opened on this channel.
deviceRemovedCallback	PlugAndPlayCallback	Callback function triggered upon the removal of a device from the channel.
deviceState	DeviceState	Reflects the current state of the device, such as connected, disconnected, etc.
deviceStatusChangedCallback	DeviceCaptureStatusChangedCallback	Callback invoked when the device’s status changes, such as opening, closing, or starting live capture.
isCapturing	bool	Indicates whether the device is currently capturing data.
parameterCategoryList	StringList	Lists categories of parameters relevant to the device.

Methods

Name	Description
addDeviceFilter	Adds a filter to specify the types of devices this channel should handle.
applyParameters	Applies a set of parameters to the device.
checkCommand	(C++/dotnet): Checks if a specific command is available on the device.
checkParameter	Confirms if a parameter exists on the device.
clearDeviceFilter	Clears all set device filters, removing any type restrictions.
closeDevice	Controls closing the associated device.
getCurrentData	Retrieves the most recent data captured by the device.
getParameter	Retrieves a device parameter’s value.
getParameterDescriptor	Fetches the descriptor of a device parameter.
getParameterList	Obtains all supported parameters, optionally filtered by category.
getParameterNameList	Retrieves names of all supported parameters, optionally filtered by category.
getParameterValueInt	Gets the integer value of a device parameter.
isPreviouslyDisconnectedDevice	Checks if the specified device was previously disconnected.
openDevice	Controls opening the associated device.
sendCommand	(C++/dotnet): Issues a command to the device.
sendCommandBoolean	(C++/dotnet): Issues a command with a boolean as result to the device.
sendModelCommand	(C++/dotnet): Dispatches a command to the device model.
setParameter	Sets a device parameter’s value.
setParameterValueInt	Assigns an integer value to a device parameter.
startCapture	Initiates the data capture process, optionally taking a string parameter for configuration.
stopCapture	Terminates the data acquisition process, halting data capture.
waitForCapture	Blocks until new capture data is available or a timeout occurs.