SignaturePad.getCurrentFrame Method¶

Definition¶

Retrieves the most recent frame from the device’s live feed.

This function can be used to display the current state of the signature as it is being captured.

bool getCurrentFrame(CaptureImage frame)

Parameters

frame CaptureImage

in An object to store the current frame data from the live feed.

Returns

bool

Indicates if the frame is currently available. true if the frame data is successfully retrieved, false otherwise.

Exceptions

DevicesException

An error has occurred during Devices Library execution.