ExtendedCamera.getCurrentFrame Method

Module: ExtendedCamera

Definition

Fetches the most recent frame from the live feed.

Python

get_current_frame(self, frame: CaptureImage) -> bool

Parameters

frame CaptureImage

in The current live frame data.

Returns

bool

Indicates if the frame is currently available.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Dart

bool getCurrentFrame(CaptureImage frame)

Parameters

frame CaptureImage

in The current live frame data.

Returns

bool

Indicates if the frame is currently available.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C#

public bool GetCurrentFrame(CaptureImage frame)

Parameters

frame CaptureImage

in The current live frame data.

Returns

bool

Indicates if the frame is currently available.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

Java

public boolean getCurrentFrame(CaptureImage frame) throws DevicesException

Parameters

frame CaptureImage

in The current live frame data.

Returns

boolean

Indicates if the frame is currently available.

Exceptions

DevicesException

An error has occurred during Devices Library execution.

C

int id3DevicesExtendedCamera_GetCurrentFrame (
    ID3_DEVICES_EXTENDED_CAMERA hExtendedCamera,
    ID3_DEVICES_CAPTURE_IMAGE hFrame,
    bool * available)

Parameters

hExtendedCamera ID3_DEVICES_EXTENDED_CAMERA

in Handle to the ExtendedCamera object.

hFrame ID3_DEVICES_CAPTURE_IMAGE

in The current live frame data.

available bool *

out Indicates if the frame is currently available.

Returns

int

An error code.

See id3DevicesError file for the list of possible error codes.