imaqCreateAVI
Usage
AVISession imaqCreateAVI(const char* fileName, const char* compressionFilter, int quality, unsigned int framesPerSecond, unsigned int maxDataSize);
Purpose
This function creates an AVI file so that images and data can be written to it.
Parameters
|
Name
|
Type
|
Description
|
|---|---|---|
| fileName | const char* | The name of the AVI file to create. The file extension must be |
| compressionFilter | const char* | The name of the compression filter to use, if any. Call imaqGetFilterNames() for a list of available compression filters. Set this parameter to NULL to write uncompressed images. |
| quality | int | If compression is being used, the quality of the compression, between 0-1000. Use IMAQ_USE_DEFAULT_QUALITY to use the default for the compression filter. Note that not all compression filters allow you to set the quality. |
| framesPerSecond | unsigned int | The number of frames per second at which to play the AVI. Note that this parameter indicates the desired playback rate for the AVI you create. The AVI may play at a slower rate depending on the performance of the system on which it plays. |
| maxDataSize | unsigned int | The maximum size of the data attached to each frame. Set this parameter to 0 if you do not want to attach data to this AVI. |
Return Value
| Type |
Description |
|---|---|
| AVISession | On success, this function returns a session ID associated with the given AVI file. On failure, this function returns 0. To get extended error information, call imaqGetLastError(). |