NI Vision for LabVIEW

IMAQ AVI2 Write Frame VI

  • Updated2023-02-21
  • 4 minute(s) read
Owning Palette: AVI
Requires: NI Vision Development Module

Writes an image to the AVI file specified by AVI Refnum. Use the IMAQ AVI2 Get Codec Names VI to find the compatible AVI compression codecs currently installed on the computer.

Note  This VI is not supported on NI CVS-1450 Series devices (NI 1454, NI 1455, NI 1456) or NI 17xx Smart Cameras (NI 1722, NI 1742, NI 1744, NI 1762, NI 1764).

The following table lists the image types supported by the codecs installed with the Vision Development Module.

Codec Supported Image Types
FFV1 U8, U16, I16, RGBU32, HSLU32, RGBU64
MJPEG U8, U16, I16, RGBU32, HSLU32, RGBU64
Y800 U8, U16, I16
I420 RGBU32, HSLU32, RGBU64
VP8 U8, U16, I16, RGBU32, HSLU32, RGBU64
VP9 U8, U16, I16, RGBU32, HSLU32, RGBU64
Note  For U16 images, the bit depth must be set manually. Use the IMAQ Image Bit Depth VI to set the bit depth.

Examples

IMAQ AVI2 Write Frame

crn.gif

AVI Refnum is a reference to the AVI file output from the IMAQ AVI2 Create VI or the IMAQ AVI2 Open VI.

cgenclasstagrefflat.gif

Image is a reference to the image that you want to write to an AVI file. This image must be U8, RGBU32, I16, U16, HSLU32, or RGBU64. I16, U16, and RGBU64 images are only supported if the bit depth of the image is set. In this case, the VI will downcast the image to U8 or RGBU32, shifting the data to keep the 8 most significant bits.

cerrcodeclst.gif

error in (no error) describes the error status before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.

cbool.gif

status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.

ci32.gif

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

cstr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

irn.gif

AVI Refnum (duplicate) is a reference to the AVI file output from the IMAQ AVI2 Create VI or the IMAQ AVI2 Open VI.

igenclasstagrefflat.gif

Image Out (duplicate) is a duplicate of the image passed in.

ierrcodeclst.gif

error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.

ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

ii32.gif

code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.

istr.gif

source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

Examples

Refer to the following for an example that uses this VI.

  • LabVIEW\examples\Vision\Files\AVI Codec Comparison.vi

Log in to get a better experience