CaptureImage.toFile Method¶
Module: CaptureImage
Definition¶
Saves the image to the specified file.
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_file(self, filepath: str, compression_level: float) -> None
Parameters
filepath
strin A string that contains the name of the file to which to save the image.compression_level
floatin The compression level to be applied.
Exceptions
An error has occurred during Devices Library execution.
void toFile(String? filepath, double compressionLevel)
Parameters
filepath
Stringin A string that contains the name of the file to which to save the image.compressionLevel
doublein The compression level to be applied.
Exceptions
An error has occurred during Devices Library execution.
public void ToFile(string filepath, float compressionLevel)
Parameters
filepath
stringin A string that contains the name of the file to which to save the image.compressionLevel
floatin The compression level to be applied.
Exceptions
An error has occurred during Devices Library execution.
public void toFile(String filepath, float compressionLevel) throws DevicesException
Parameters
filepath
Stringin A string that contains the name of the file to which to save the image.compressionLevel
floatin The compression level to be applied.
Exceptions
An error has occurred during Devices Library execution.
int id3DevicesCaptureImage_ToFile (
ID3_DEVICES_CAPTURE_IMAGE hCaptureImage,
const char * filepath,
float compressionLevel)
Parameters
hCaptureImage
ID3_DEVICES_CAPTURE_IMAGEin Handle to the CaptureImage object.filepath
const char *in A string that contains the name of the file to which to save the image.compressionLevel
floatin The compression level to be applied.
Returns