iLab Neuromorphic Robotics Toolkit  0.1
nrt::VideoSource Class Reference

#include <VideoSource.H>


A SeekableImageSourceType for streaming video files.

The VideoSource is used to read images from VideoFiles using the ImageSource framework. Upon setting the --video Parameter, this class will query the nrt::VideoReaderFactory to determine if any VideoReaderBase classes have been registered (see the NRT_REGISTER_VIDEO_READER(CLASSNAME) macro) to parse the given extension. Available video readers can be found in nrt/ImageProc/IO/ImageSource/VideoReaders

Definition at line 50 of file VideoSource.H.

Inheritance diagram for nrt::VideoSource:
nrt::SeekableImageSourceType

List of all members.

Public Member Functions

 VideoSource (std::string const &instanceID="video")
bool const seek (size_t const framenumber)
 Attempts to seek to the given framenumber.
GenericImage const in ()
 Returns a GenericImage from its VideoReader::in()
bool const ok () const
nrt::FrameRange const frameRange () const
size_t const nextFrameNumber () const
 Get the next frame number (e.g. the frame that will be returned by the next call to in())

Static Public Member Functions

static std::string const id ()
 Get the name associated with our --in type.
static std::string const description ()
 Get a description to show for --help.

Member Function Documentation

bool const nrt::VideoSource::seek ( size_t const  framenumber) [virtual]

Attempts to seek to the given framenumber.

Returns:
Whether or not the seek was succesful

Implements nrt::SeekableImageSourceType.

bool const nrt::VideoSource::ok ( ) const

Returns whether or not the next call to in() will return a valid GenericImage by checking the underlying VideoReader::ok()

nrt::FrameRange const nrt::VideoSource::frameRange ( ) const [virtual]

Get the intersection of the video's physical FrameRange, and the requested FrameRange set by the SeekableImageSourceType's parameter

Implements nrt::SeekableImageSourceType.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines