The return value is non-zero if the function failed, zero if it succeeded.
Use these functions to prepare/clean up the acquisition. There should not be any changes in settings between SIDXCameraAcquisitionBegin... and SIDXAcquisitionEnd. The actual acquisition will not start until SIDXAcquisitionStart is called.
SIDXAcquisitionBeginContinuous prepares the continuous acquisition during which SIDX will report every image the camera acquired. During this acquisition mode, the application should use SIDXAcquisitionFramesAvailable to find out the available image count and use SIDXAcquisitionGetFrames function to retreive all images reported available by SIDXAcquisitionFramesAvailable function. If SIDXAcquisitionFramesAvailable function is called again before all the previous available images are retreived by SIDXAcquisitionGetFrames function, the remaining of the previous available images may be lost. The acquisition will not stop until SIDXAcquisitionAbort is called or an error occurs.
SIDXAcquisitionBeginFocus prepares the continuous acquisition during which SIDX will only report the latest acquired image regardless of whether the image has been read out or not. During this acquisition mode, the application should use SIDXAcquisitionFramesAvailable to find out if there is an image available and use SIDXAcquisitionGetFrames function to retrieve the lastest image acquired. This acquisition mode is intended for use during the setup of an experiment when the user only cares about the latest image that results from the latest settings. The acquisition will not stop until SIDXAcquisitionAbort is called or an error occurs.
SIDXAcquisitionBeginScripting prepares the acquisition as described in the script file. Only Roper Scientific Photometrics cameras support the feature.
SIDXAcquisitionBeginSequence prepares to acquire a specified number of frames. The acquisition will stop when the specified number of frames are acquired or when SIDXAcquisitionAbort is called or an error occurs.
SIDXAcquisitionEnd ends the acquisition session. It releases the resources. You cannot retrieve any images from the acquisition session after the call.