Bruxton Logo

SIDXAcquisitionGetFrames

Syntax

C/C++

int SIDXAcquisitionGetFrames(void* camera, int frames, int roi_index, void* image, unsigned int* time, int* frames_returned);

Visual Basic

Function SIDXAcquisitionGetFrames (ByVal camera As Long, ByVal frames As Long, ByVal roi_index As Long, ByVal image() As Byte, ByRef time As Long, ByRef frames_returned As Long) As Long

IGOR Pro

SIDXAcquisitionGetFrames camera, frames, roi_index, wave_name, time, status

ITT IDL

status SIDXAcquisitionGetFrames(camera, frames, roi_index, wave_name, time)

Parameters

camera
The open camera handle created by either SIDXSettingsOpenCamera or SIDXCameraOpen or SIDXDialogCameraSelector or SIDXSettingsRestoreCamera.
frames
The number of frames to retrieve.
roi_index
The index of ROI to retrieve.
image
The memory location where the retrieved images will be stored. The caller is responsible for allocating sufficient amount of memory for the images.
wave_name
The name of the IGOR wave for storing the acquired images.
time
The nominal time when the frame is retrieved from the acquisition buffer in milliseconds relative to the start of the acquisition.
frames_returned
The actual number of images retrieved.
The return value is non-zero if the function failed, zero if it succeeded.

Discussion

Use this function to retrieve the frames from the acquisition buffer into the application buffer. The frames are returned concatenated if multiple frames are requested. That is, one frame after the other. At most, the function can retrieve the number of frames reported available by the last call to SIDXAcquisitionFramesAvailable function. If the function is called to retrieve one frame at a time, the function will retrieve a later frame every time the function is called. For example, the function will return the first frame acquired when the function is called the first time for one frame and the function will return the second frame acquired when the function is called the second time for one frame, and so on.