VideoFile.getCurrentFrame Method

Module: VideoFile

Definition

Fetches the most recent frame from the live feed.

This function can be used to display the current state of the video as it is being captured.

get_current_frame(self, frame: CaptureImage) -> bool

Parameters

frame CaptureImage
in An object to store the current frame data from the live feed.

Returns

bool
Indicates if the frame is currently available. true if the frame data is successfully retrieved, false otherwise.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
bool getCurrentFrame(CaptureImage frame)

Parameters

frame CaptureImage
in An object to store the current frame data from the live feed.

Returns

bool
Indicates if the frame is currently available. true if the frame data is successfully retrieved, false otherwise.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
public bool GetCurrentFrame(CaptureImage frame)

Parameters

frame CaptureImage
in An object to store the current frame data from the live feed.

Returns

bool
Indicates if the frame is currently available. true if the frame data is successfully retrieved, false otherwise.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
public boolean getCurrentFrame(CaptureImage frame) throws DevicesException

Parameters

frame CaptureImage
in An object to store the current frame data from the live feed.

Returns

boolean
Indicates if the frame is currently available. true if the frame data is successfully retrieved, false otherwise.

Exceptions

DevicesException
An error has occurred during Devices Library execution.
int id3DevicesVideoFile_GetCurrentFrame (
    ID3_DEVICES_VIDEO_FILE hVideoFile,
    ID3_DEVICES_CAPTURE_IMAGE hFrame,
    bool * available)

Parameters

hVideoFile ID3_DEVICES_VIDEO_FILE
in Handle to the VideoFile object.

hFrame ID3_DEVICES_CAPTURE_IMAGE
in An object to store the current frame data from the live feed.

available bool *
out Indicates if the frame is currently available. true if the frame data is successfully retrieved, false otherwise.

Returns

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