IDS Software Suite 4.96.1
 |
 |
|---|---|
USB 2.0 USB 3.x GigE |
- |
Syntax
INT isavi_SetImageSize (INT nAviID, INT cMode, INT Width, INT Height, INT PosX, INT PosY, INT LineOffset)
Description
isavi_SetImageSize() sets the size and position of the area of interest which will be saved to the AVI file. Only the defined area of interest of each frame will be saved. In addition, this function specifies the input color format of the frames. You define these settings only once for the entire video.
|
The supported input color formats are RGB32, RGB24, Y8 and raw Bayer. The output file will always be in RGB24 format, regardless of the input data format. For further information on the structure of the different color formats, see the Appendix: Color and memory formats section. |
|
When an area of interest is used, the width (Width) and height (Height) of the AOI must be at least 16 pixel. The AOI width must be a multiple of 8. |
Input parameters
nAviID |
Instance ID set by the isavi_InitAVI() function. |
cMode |
Color format of the input frames captured by the uEye camera |
Width |
Width of the entire frame or of the area of interest |
Height |
Height of the entire frame or of the area of interest |
PosX |
X position (offset) of the area of interest |
PosY |
Y position (offset) of the area of interest |
LineOffset |
Line increment The line increment is the difference between the width of the entire frame (in pixel) and the area of interest (in pixel). |
Return values
IS_AVI_NO_ERR |
No error, function executed successfully. |
IS_AVI_ERR_INVALID_ID |
The indicated AVI instance could not be found. Either the AVI ID is invalid or the instance has already been deleted using isavi_ExitAVI(). |
IS_AVI_ERR_INVALID_FILE |
The file has no valid AVI format. |
IS_AVI_ERR_CAPTURE_RUNNING |
Another capturing operation is in progress or an AVI file is still open. |
IS_AVI_ERR_ALLOC_MEMORY |
No memory could be allocated. |
IS_AVI_ERR_INVALID_CM |
The submitted color mode is not supported for AVI capturing. |
IS_AVI_ERR_INVALID_SIZE |
The submitted size is invalid. |
IS_AVI_ERR_INVALID_POSITION |
The submitted position is invalid. |
Related functions
Example
// Query image buffer geometry
int nWidth, nHeight, nBits, nPitch;
is_InquireImageMem (hCam, pLast, nImageID, &nWidth, &nHeight, &nBits, &nPitch);
IS_POINT_2D nOffset;
is_AOI (hCam, IS_AOI_IMAGE_GET_POS, nOffset, sizeof(nOffset));
// Derive pixel pitch from buffer byte pitch
INT nPitchPx = 0;
nPitchPx = (nPitch * 8 ) / nBits;
INT nAviWidth = nWidth /8 * 8; // Width must be multiple of 8
INT LineOffsetPx = nPitchPx - nAviWidth ;
isavi_SetImageSize(nAviId, m_cMode, nAviWidth, nHeight, nOffset.s32X, nOffset.s32Y, LineOffsetPx);
