ExtendedCamera.waitForCapture Method

Module: ExtendedCamera

Definition

Waits for new capture data within a specified timeout period.

wait_for_capture(self, timeout: int, do_event: bool) -> bool

Parameters

timeout int
in Time to wait for new data before timing out.

do_event bool
in Call doEvent() in the wait loop.

Returns

bool
Outputs whether new capture data is available.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
bool waitForCapture(int timeout, bool doEvent)

Parameters

timeout int
in Time to wait for new data before timing out.

doEvent bool
in Call doEvent() in the wait loop.

Returns

bool
Outputs whether new capture data is available.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
public bool WaitForCapture(int timeout, bool doEvent)

Parameters

timeout int
in Time to wait for new data before timing out.

doEvent bool
in Call doEvent() in the wait loop.

Returns

bool
Outputs whether new capture data is available.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
public boolean waitForCapture(int timeout, boolean doEvent) throws DevicesException

Parameters

timeout int
in Time to wait for new data before timing out.

doEvent boolean
in Call doEvent() in the wait loop.

Returns

boolean
Outputs whether new capture data is available.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
int id3DevicesExtendedCamera_WaitForCapture (
    ID3_DEVICES_EXTENDED_CAMERA hExtendedCamera,
    int timeout,
    bool doEvent,
    bool * available)

Parameters

hExtendedCamera ID3_DEVICES_EXTENDED_CAMERA
in Handle to the ExtendedCamera object.

timeout int
in Time to wait for new data before timing out.

doEvent bool
in Call doEvent() in the wait loop.

available bool *
out Outputs whether new capture data is available.

Returns

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