ID Capture Settings#

Defined in library scandit_datacapture_id

IdCaptureSettings#
class IdCaptureSettings

Added in version 6.11.0

Settings to configure an IdCapture instance.

getShouldPassImageTypeToResult(type)#
bool getShouldPassImageTypeToResult(IdImageType type)

Added in version 6.11.0

Gets whether an IdCapture created with these settings should extract an image (specified by the given type) from recognized documents and return it as part of CapturedId. Note that the image may still not be returned, for example, if it’s not present in a document or if it’s not recognized. Default is false.

setShouldPassImageTypeToResult(type, shouldPass)#
void setShouldPassImageTypeToResult(IdImageType type,
        bool shouldPass)

Added in version 6.11.0

Sets whether an IdCapture created with these settings should extract an image (specified by the given type) from recognized documents and return it as part of CapturedId. Note that the image may still not be returned, for example, if it’s not present in a document or if it’s not recognized. Default is false.

supportedDocuments#
Set<IdDocumentType> get supportedDocuments

Added in version 6.11.0

The types of personal identification documents that IdCapture configured with these settings is able to scan.

setProperty(name, value)#
void setProperty<T>(String name,
        T value)

Added in version 6.11.0

Sets a property to the provided value. Use this method to set properties that are not yet part of a stable API. Properties set through this method may change in a future release.

getProperty(name)#
T getProperty<T>(String name)

Added in version 6.11.0

Retrieves the value of a previously set property. In case the property does not exist, an ArgumentException is thrown.

supportedSides#
SupportedSides supportedSides

Added in version 6.11.0

The sides of personal identification documents that IdCapture configured with these settings is able to scan. This setting is relevant only for supportedDocuments of type IdDocumentType.dlViz and IdDocumentType.idCardViz, otherwise it is ignored. The default is SupportedSides.frontOnly.