DocumentImage.toBufferObject Method

Module: DocumentImage

Definition

Copies the image to a buffer in the specified format.

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_object(self, document_image_format: ImageFormat, compression_level: float, buffer: ImageBuffer) -> None

Parameters

document_image_format ImageFormat
in The output image format.

compression_level float
in The compression level to be applied.

buffer ImageBuffer
in The image buffer that receives the image data.

Exceptions

DocumentException
An error has occurred during Document Library execution.
void toBufferObject(ImageFormat documentImageFormat, double compressionLevel, ImageBuffer buffer)

Parameters

documentImageFormat ImageFormat
in The output image format.

compressionLevel double
in The compression level to be applied.

buffer ImageBuffer
in The image buffer that receives the image data.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public void ToBufferObject(ImageFormat documentImageFormat, float compressionLevel, ImageBuffer buffer)

Parameters

documentImageFormat ImageFormat
in The output image format.

compressionLevel float
in The compression level to be applied.

buffer ImageBuffer
in The image buffer that receives the image data.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public void toBufferObject(ImageFormat documentImageFormat, float compressionLevel, ImageBuffer buffer) throws DocumentException

Parameters

documentImageFormat ImageFormat
in The output image format.

compressionLevel float
in The compression level to be applied.

buffer ImageBuffer
in The image buffer that receives the image data.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public func toBufferObject(documentImageFormat: ImageFormat, compressionLevel: Float, buffer: ImageBuffer) throws

Parameters

documentImageFormat ImageFormat
in The output image format.

compressionLevel Float
in The compression level to be applied.

buffer ImageBuffer
in The image buffer that receives the image data.

Exceptions

DocumentException
An error has occurred during Document Library execution.
int id3DocumentImage_ToBufferObject (
    ID3_DOCUMENT_IMAGE hDocumentImage,
    id3DocumentImageFormat eDocumentImageFormat,
    float compressionLevel,
    ID3_DOCUMENT_IMAGE_BUFFER hBuffer)

Parameters

hDocumentImage ID3_DOCUMENT_IMAGE
in Handle to the DocumentImage object.

eDocumentImageFormat id3DocumentImageFormat
in The output image format.

compressionLevel float
in The compression level to be applied.

hBuffer ID3_DOCUMENT_IMAGE_BUFFER
in The image buffer that receives the image data.

Returns

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