Back to Aurora Vision Library website

You are here: Start » Function Reference » Image » Image IO » ReadVideoStream

ReadVideoStream


Header: AVL.h
Namespace: avl
Module: FoundationLite

Acquires a frame from a previously opened video stream.

Syntax

C++
C#
 
bool avl::ReadVideoStream
(
	const avl::InputVideoStream& inInputVideoStream,
	bool inRepeat,
	int& outFrameNum,
	avl::Image& outImage
)

Parameters

Name Type Default Description
Input value inInputVideoStream const InputVideoStream& Previously opened input video stream
Input value inRepeat bool Determines whether to repeat video playback
Output value outFrameNum int& Current frame number
Output value outImage Image& Current frame

Errors

List of possible exceptions:

Error type Description
DomainError Incorrectly initialized InputVideoStream object passed to ReadVideoStream