BiometricEvaluation::Video::Stream Class Reference

#include <be_video_stream.h>

Public Member Functions
virtual float	getFPS ()=0
	Obtain the average frame rate of the video stream. More...
virtual uint64_t	getFrameCount ()=0
	Obtain the number of frames in the video stream. More...
virtual Video::Frame	getFrame (uint32_t frameNum)=0
	Obtain a frame from the video stream. More...
virtual std::vector< Video::Frame >	getFrameSequence (int64_t startTime, int64_t endTime)=0
	Obtain a sequence of frames from the video stream. More...
virtual void	setFrameScale (float xScale, float yScale)=0
	Set the scaling factors for returned video frames. More...
virtual void	setFramePixelFormat (const Image::PixelFormat pixelFormat)=0
	Set the pixel format for returned video frames. More...
virtual	~Stream ()

Detailed Description

Definition at line 25 of file be_video_stream.h.

Constructor & Destructor Documentation

~Stream()

virtual BiometricEvaluation::Video::Stream::~Stream ( )

virtual

Member Function Documentation

getFPS()

virtual float BiometricEvaluation::Video::Stream::getFPS ( )

pure virtual

Obtain the average frame rate of the video stream.

Returns

The average frame rate. A value of 0 means the frame rate cannot be determined.

getFrameCount()

virtual uint64_t BiometricEvaluation::Video::Stream::getFrameCount ( )

pure virtual

Obtain the number of frames in the video stream.

Returns

The number of frames in the stream; will be 0 if unknown.

getFrame()

virtual Video::Frame BiometricEvaluation::Video::Stream::getFrame ( uint32_t  frameNum )

pure virtual

Obtain a frame from the video stream.

Parameters

frameNum

Frame number, >= 1

Exceptions

Error::ParameterError	frameNum is too large.
Error::StrategyError	No codec available for the video stream or other failure to read the stream.

getFrameSequence()

virtual std::vector< Video::Frame > BiometricEvaluation::Video::Stream::getFrameSequence ( int64_t  startTime, int64_t  endTime  )

pure virtual

Obtain a sequence of frames from the video stream.

The end time can be greater than the length of the stream, and is not considered an error. Frames up to and including the last will be returned.

Parameters

startTime	Approximate time of the starting frame, milliseconds.
endTime	Approximate time of the ending frame, milliseconds

Exceptions

Error::StrategyError

No codec available for the video stream or other failure to read the stream.

setFrameScale()

virtual void BiometricEvaluation::Video::Stream::setFrameScale ( float  xScale, float  yScale  )

pure virtual

Set the scaling factors for returned video frames.

Parameters

xScale	The scaling factor for frame width.
yScale	The scaling factor for frame height.

setFramePixelFormat()

virtual void BiometricEvaluation::Video::Stream::setFramePixelFormat ( const Image::PixelFormat  pixelFormat )

pure virtual

Set the pixel format for returned video frames.

Parameters

pixelFormat

The pixel format of all returned frames.

---

The documentation for this class was generated from the following file:

• be_video_stream.h