CaptureImage.toBuffer Method

Module: CaptureImage

Definition

Exports the image to a buffer.

The compression level meaning depends on the algorithm used:

  • For JPEG compression, the value is the expected quality and may vary from 1 to 100.

  • For JPEG2000 compression, the value is the compression rate and may vary from 1 to 512.

  • For PNG compression, the value is the compression rate and may vary from 1 to 10.

  • For all other formats, the value is ignored.

to_buffer(self, capture_image_format: ImageFormat, compression_level: float) -> bytearray

Parameters

capture_image_format ImageFormat
in The image format to export the image to.

compression_level float
in The compression level to be applied.

Returns

bytearray
Buffer that receives the image data.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
Uint8List toBuffer(ImageFormat captureImageFormat, double compressionLevel)

Parameters

captureImageFormat ImageFormat
in The image format to export the image to.

compressionLevel double
in The compression level to be applied.

Returns

Uint8List
Buffer that receives the image data.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
public byte[] ToBuffer(ImageFormat captureImageFormat, float compressionLevel)

Parameters

captureImageFormat ImageFormat
in The image format to export the image to.

compressionLevel float
in The compression level to be applied.

Returns

byte[]
Buffer that receives the image data.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
public byte[] toBuffer(ImageFormat captureImageFormat, float compressionLevel) throws DevicesException

Parameters

captureImageFormat ImageFormat
in The image format to export the image to.

compressionLevel float
in The compression level to be applied.

Returns

byte[]
Buffer that receives the image data.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
int id3DevicesCaptureImage_ToBuffer (
    ID3_DEVICES_CAPTURE_IMAGE hCaptureImage,
    id3DevicesImageFormat eCaptureImageFormat,
    float compressionLevel,
    unsigned char * data,
    int * dataSize)

Parameters

hCaptureImage ID3_DEVICES_CAPTURE_IMAGE
in Handle to the CaptureImage object.

eCaptureImageFormat id3DevicesImageFormat
in The image format to export the image to.

compressionLevel float
in The compression level to be applied.

data unsigned char *
out Buffer that receives the image data.

dataSize int *
in Size of the ‘data’ buffer. Receives the number of elements in the ‘data’ array.

Returns

int
An error code.
See id3DevicesError file for the list of possible error codes.