CaptureImage.fromFile Method

Module: CaptureImage

Definition

Creates an Image from the specified file.

@staticmethod
from_file(filepath: str, pixel_format: PixelFormat) -> CaptureImage

Parameters

filepath str
in A string that contains the name of the file from which to create the Image.

pixel_format PixelFormat
in The pixel format into which to convert the input image.

Returns

The newly created capture image.

Exceptions

An error has occurred during Devices Library execution.
static CaptureImage fromFile(String? filepath, PixelFormat pixelFormat)

Parameters

filepath String
in A string that contains the name of the file from which to create the Image.

pixelFormat PixelFormat
in The pixel format into which to convert the input image.

Returns

The newly created capture image.

Exceptions

An error has occurred during Devices Library execution.
public static CaptureImage FromFile(string filepath, PixelFormat pixelFormat)

Parameters

filepath string
in A string that contains the name of the file from which to create the Image.

pixelFormat PixelFormat
in The pixel format into which to convert the input image.

Returns

The newly created capture image.

Exceptions

An error has occurred during Devices Library execution.
public static CaptureImage fromFile(String filepath, PixelFormat pixelFormat) throws DevicesException

Parameters

filepath String
in A string that contains the name of the file from which to create the Image.

pixelFormat PixelFormat
in The pixel format into which to convert the input image.

Returns

The newly created capture image.

Exceptions

An error has occurred during Devices Library execution.
int id3DevicesCaptureImage_FromFile (
    ID3_DEVICES_CAPTURE_IMAGE hCaptureImage,
    const char * filepath,
    id3DevicesPixelFormat ePixelFormat)

Parameters

in Handle to the CaptureImage object.

filepath const char *
in A string that contains the name of the file from which to create the Image.

in The pixel format into which to convert the input image.

Returns

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