Back to FabImage Library website

You are here: Start » Function Reference » All Functions » Image IO » FisFilter_ReadVideo

FisFilter_ReadVideo


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code. OpenInputVideoStream and ReadVideoStream should be used instead.

Header: FIL.h
Namespace: fis
Module: FoundationLite

Reads a frame sequence from a video file.

Syntax

bool fis::FisFilter_ReadVideo
(
	fis::InputVideoStream& ioState,
	const ftl::File& inFile,
	int inStartFrame,
	bool inRepeat,
	fil::Image& outImage,
	float& outFPS,
	int& outFrameNum,
	int& outMaxFrame
)

Parameters

Name Type Range Default Description
Input will be modified ioState InputVideoStream& Object used to maintain state of the function.
Input value inFile const File& Video file
Input value inStartFrame int 0 - + Number of first frame to fetch.
Input value inRepeat bool Determines whether to repeat video playback
Output value outImage Image& Output image
Output value outFPS float& FPS
Output value outFrameNum int& Current frame number
Output value outMaxFrame int& Last frame number

Description

FisFilter_ReadVideo filter is based on DirectShow and supports all video formats available using this technology. List of the most popular supported file types and compression formats is shown below.

  • MPEG-2 video
  • Digital Video
  • AVI
  • WMV

For complete list of supported formats, please follow the link below:
https://docs.microsoft.com/windows/desktop/DirectShow/supported-formats-in-directshow

Remarks

This filter uses external components, which can open additional windows or require initial configuration. Please, consult your codecs vendor in case of any troubles.

Errors

List of possible exceptions:

Error type Description
DomainError Filter not available under the Linux.

See Also