FingerImageRecord.toBuffer Method¶
Module: FingerImageRecord
Definition¶
Exports the FingerImageRecord to a buffer.
Important
For ANSI/NIST-ITL 1-2011 (AN2K) transaction export, all images will be exported in WSQ in type 14 records, NIEM-XML encoding mode is not supported.
to_buffer(self, format: FingerImageRecordFormat, compression_algorithm: FingerImageCompressionAlgorithm, compression_level: float) -> bytearray
Parameters
format
FingerImageRecordFormatin Finger image record format to export the finger image object to.compression_algorithm
FingerImageCompressionAlgorithmin Compression algorithm used to compress the images in a record. Note: this value is not prioritary versus the value in an image object, but if the image does not have a compression algorithm, then the one passed here is used.compression_level
floatin Compression level. Range and default value depends on the compression algorithm, see CompressionAlgorithm enumeration for more details.
Returns
bytearray
Buffer to export the finger image object to.
Exceptions
An error has occurred during Finger Library execution.
Uint8List toBuffer(FingerImageRecordFormat format, FingerImageCompressionAlgorithm compressionAlgorithm, double compressionLevel)
Parameters
format
FingerImageRecordFormatin Finger image record format to export the finger image object to.compressionAlgorithm
FingerImageCompressionAlgorithmin Compression algorithm used to compress the images in a record. Note: this value is not prioritary versus the value in an image object, but if the image does not have a compression algorithm, then the one passed here is used.compressionLevel
doublein Compression level. Range and default value depends on the compression algorithm, see CompressionAlgorithm enumeration for more details.
Returns
Uint8List
Buffer to export the finger image object to.
Exceptions
An error has occurred during Finger Library execution.
public byte[] ToBuffer(FingerImageRecordFormat format, FingerImageCompressionAlgorithm compressionAlgorithm, float compressionLevel)
Parameters
format
FingerImageRecordFormatin Finger image record format to export the finger image object to.compressionAlgorithm
FingerImageCompressionAlgorithmin Compression algorithm used to compress the images in a record. Note: this value is not prioritary versus the value in an image object, but if the image does not have a compression algorithm, then the one passed here is used.compressionLevel
floatin Compression level. Range and default value depends on the compression algorithm, see CompressionAlgorithm enumeration for more details.
Returns
byte[]
Buffer to export the finger image object to.
Exceptions
An error has occurred during Finger Library execution.
public byte[] toBuffer(FingerImageRecordFormat format, FingerImageCompressionAlgorithm compressionAlgorithm, float compressionLevel) throws FingerException
Parameters
format
FingerImageRecordFormatin Finger image record format to export the finger image object to.compressionAlgorithm
FingerImageCompressionAlgorithmin Compression algorithm used to compress the images in a record. Note: this value is not prioritary versus the value in an image object, but if the image does not have a compression algorithm, then the one passed here is used.compressionLevel
floatin Compression level. Range and default value depends on the compression algorithm, see CompressionAlgorithm enumeration for more details.
Returns
byte[]
Buffer to export the finger image object to.
Exceptions
An error has occurred during Finger Library execution.
public func toBuffer(format: FingerImageRecordFormat, compressionAlgorithm: FingerImageCompressionAlgorithm, compressionLevel: Float) throws -> [UInt8]
Parameters
format
FingerImageRecordFormatin Finger image record format to export the finger image object to.compressionAlgorithm
FingerImageCompressionAlgorithmin Compression algorithm used to compress the images in a record. Note: this value is not prioritary versus the value in an image object, but if the image does not have a compression algorithm, then the one passed here is used.compressionLevel
Floatin Compression level. Range and default value depends on the compression algorithm, see CompressionAlgorithm enumeration for more details.
Returns
[UInt8]
Buffer to export the finger image object to.
Exceptions
An error has occurred during Finger Library execution.
int id3FingerImageRecord_ToBuffer (
ID3_FINGER_IMAGE_RECORD hFingerImageRecord,
id3FingerImageRecordFormat eFormat,
id3FingerImageCompressionAlgorithm eCompressionAlgorithm,
float compressionLevel,
unsigned char * data,
int * dataSize)
Parameters
hFingerImageRecord
ID3_FINGER_IMAGE_RECORDin Handle to the FingerImageRecord object.eFormat
id3FingerImageRecordFormatin Finger image record format to export the finger image object to.eCompressionAlgorithm
id3FingerImageCompressionAlgorithmin Compression algorithm used to compress the images in a record. Note: this value is not prioritary versus the value in an image object, but if the image does not have a compression algorithm, then the one passed here is used.compressionLevel
floatin Compression level. Range and default value depends on the compression algorithm, see CompressionAlgorithm enumeration for more details.data
unsigned char *out Buffer to export the finger image object to.dataSize
int *in Size of the ‘data’ buffer. Receives the number of elements in the ‘data’ array.
Returns