SignaturePad Class

Namespace: id3.Devices

Definition

Extends ‘DeviceChannel’ to to provide specialized functionalities for handling signature pads.

This class manages the state and operations specific to signature capture devices, enabling the initiation and termination of capture processes, handling callbacks for various events, and retrieving capture data.

Python

class SignaturePad

Dart

class SignaturePad implements Finalizable

C#

public partial class SignaturePad

Java

public class SignaturePad implements AutoCloseable, Serializable

C

typedef struct id3DevicesSignaturePad *ID3_DEVICES_SIGNATURE_PAD;

Usage

Python

signaturePadInstance = SignaturePad()
# ...

Explicit destruction

# ...
del signaturePadInstance

Dart

final signaturePadInstance = sdk.SignaturePad();
// ...

Explicit destruction

// ...
signaturePadInstance.dispose()

C#

using (var signaturePadInstance = new SignaturePad())
{
   // ...
}

Explicit destruction

var signaturePadInstance = new SignaturePad()
// ...
signaturePadInstance.Dispose()

Java

try (SignaturePad signaturePadInstance = new SignaturePad()) {
// ...
}

Explicit destruction

SignaturePad signaturePadInstance = new SignaturePad();
// ...
signaturePadInstance.close();

C

ID3_DEVICES_SIGNATURE_PAD hSignaturePad{};
int err = id3DevicesSignaturePad_Initialize(&hSignaturePad);
if (err == ID3_SUCCESS) {
    // ...
    id3DevicesSignaturePad_Dispose(&hSignaturePad);
}

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 when the device is opened, closed, or starts live capture.
isCapturing	bool	Indicates whether the device is currently in the process of capturing data.
parameterCategoryList	StringList	Lists categories of parameters relevant to the device.
takeSnapshotCallback	CaptureCallback	Callback triggered when a snapshot capture is completed.

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.
getCurrentFrame	Retrieves the most recent frame from the device’s live feed.
getLastSnapshot	Fetches the most recent snapshot taken 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.
showDisclaimer	Displays a disclaimer to the user. Result can be found in DeviceCaptureStatus.Specific event.
startCapture	Initiates the data capture process on the signature pad.
stopCapture	Terminates the ongoing data capture process, halting any data acquisition from the device.
waitForCapture	Blocks the calling thread until new capture data is available or the specified timeout period elapses.