VideoFile.waitForPreview Method

Module: VideoFile

Definition

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

This function is useful for synchronizing with the preview process.

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

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.

do_event 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.
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.
public 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.
public boolean waitForPreview(int timeout, boolean doEvent) throws DevicesException

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 boolean
in Call doEvent() in the wait loop.

Returns

boolean
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.
int id3DevicesVideoFile_WaitForPreview (
    ID3_DEVICES_VIDEO_FILE hVideoFile,
    int timeout,
    bool doEvent,
    bool * available)

Parameters

hVideoFile ID3_DEVICES_VIDEO_FILE
in Handle to the VideoFile object.

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.

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

Returns

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