VC_Frame

BOOL
VC_Frame(
VCUSER_HANDLE vh,
LPVIDEOHDR lpvh
);

The VC_Frame function requests a kernel-mode video capture driver to capture and return a single frame from the VIDEO_IN channel.

Parameters

vh

Handle to the kernel-mode driver, obtained from VC_OpenDevice.

lpvh

Pointer to a VIDEOHDR structure.

Return Value

Returns TRUE if the operation succeeds. Otherwise returns FALSE.

Comments

The VC_Frame function returns a single frame by opening a capture stream and supplying only a single data buffer, thereby stopping the stream after one transfer. The stream is then closed. The client is not aware of this stream and, from the client’s point of view, the operation appears to behave synchronously.

The driver supplies a VIDEOHDR structure describing an empty buffer. The kernel-mode driver fills the buffer with the contents of the frame buffer.

For more information about video capture data transfers, see Transferring Video Capture Data.