imaqReadAVIFrame

NI Vision for LabWindows/CVI Function

imaqReadAVIFrame

Usage

int imaqReadAVIFrame(Image* image, AVISession session, unsigned int frameNum, void* data, unsigned int* dataSize);

Purpose

This function reads the image and any attached data from an AVI file.

Image Types Supported

IMAQ_IMAGE_U8, IMAQ_IMAGE_RGB

Parameters

Name

Type

Description

image Image* The image in which the frame is stored.
session AVISession The session to use.
frameNum unsigned int The frame number to read.
data void* If the AVI contains data attached to this frame, the data will be stored here.
dataSize unsigned int* The size of the data buffer passed in. On return, the size of the data. If NULL is passed in, no data will be returned.

Return Value

Type

Description

int On success, this function returns a non-zero value. On failure, this function returns 0. To get extended error information, call imaqGetLastError().