VideoFile.waitForPreview Method¶

Definition¶

Blocks until a new frame is available or a timeout occurs.

This function is useful for synchronizing with the preview process.

bool waitForPreview(int timeout, bool doEvent)

Parameters

timeout int
in The maximum time (in milliseconds) to wait for a new frame to become available. A value of 0 can be used to wait indefinitely.

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

Returns

bool

Outputs a boolean value indicating whether a new frame is available after the wait period. true if a new frame is available, false otherwise.

Exceptions

DevicesException

An error has occurred during Devices Library execution.