CVD::ReadAheadVideoBuffer< T > Class Template Reference

#include <readaheadvideobuffer.h>

Inheritance diagram for CVD::ReadAheadVideoBuffer< T >:

[legend]

List of all members.

Public Member Functions
bool	frame_pending ()
	Is there a frame waiting in the buffer? This function does not block.
double	frame_rate ()
	What is the (expected) frame rate of this video buffer, in frames per second?
VideoFrame< T > *	get_frame ()
	Returns the next frame from the buffer. This function blocks until a frame is ready.
void	put_frame (VideoFrame< T > *f)
	ReadAheadVideoBuffer (VideoBuffer< T > &vb, size_t maxReadAhead=10)
void	seek_to (double t)
ImageRef	size ()
	The size of the VideoFrames returned by this buffer.
virtual	~ReadAheadVideoBuffer ()
Private Attributes
VideoBuffer< T > &	vbuffer

---

Detailed Description

template<class T>
class CVD::ReadAheadVideoBuffer< T >

Definition at line 39 of file readaheadvideobuffer.h.

---

Constructor & Destructor Documentation

template<class T>

virtual CVD::ReadAheadVideoBuffer< T >::~ReadAheadVideoBuffer

(

)

[inline, virtual]

Definition at line 44 of file readaheadvideobuffer.h.

template<class T>

CVD::ReadAheadVideoBuffer< T >::ReadAheadVideoBuffer	(	VideoBuffer< T > &	vb,
		size_t	maxReadAhead = 10
	)			[inline]

Definition at line 45 of file readaheadvideobuffer.h.

---

Member Function Documentation

template<class T>

bool CVD::ReadAheadVideoBuffer< T >::frame_pending

(

)

[inline, virtual]

Is there a frame waiting in the buffer? This function does not block.

Implements CVD::RawVideoBuffer.

Definition at line 55 of file readaheadvideobuffer.h.

template<class T>

double CVD::ReadAheadVideoBuffer< T >::frame_rate

(

)

[inline, virtual]

What is the (expected) frame rate of this video buffer, in frames per second?

Implements CVD::RawVideoBuffer.

Definition at line 57 of file readaheadvideobuffer.h.

template<class T>

VideoFrame<T>* CVD::ReadAheadVideoBuffer< T >::get_frame

(

)

[inline, virtual]

Returns the next frame from the buffer. This function blocks until a frame is ready.

Implements CVD::VideoBuffer< T >.

Definition at line 50 of file readaheadvideobuffer.h.

template<class T>

void CVD::ReadAheadVideoBuffer< T >::put_frame

(

VideoFrame< T > *

f

)

[inline, virtual]

Tell the buffer that you are finished with this frame. Typically the VideoBuffer then destroys the frame.

Parameters:

f

The frame that you are finished with.

Implements CVD::VideoBuffer< T >.

Definition at line 53 of file readaheadvideobuffer.h.

template<class T>

void CVD::ReadAheadVideoBuffer< T >::seek_to

(

double

t

)

[inline, virtual]

Go to a particular point in the video buffer (only implemented in buffers of recorded video)

Parameters:

t

The frame time in seconds

Reimplemented from CVD::RawVideoBuffer.

Definition at line 60 of file readaheadvideobuffer.h.

template<class T>

ImageRef CVD::ReadAheadVideoBuffer< T >::size

(

)

[inline, virtual]

The size of the VideoFrames returned by this buffer.

Implements CVD::RawVideoBuffer.

Definition at line 48 of file readaheadvideobuffer.h.

---

Member Data Documentation

template<class T>

VideoBuffer<T>& CVD::ReadAheadVideoBuffer< T >::vbuffer [private]

Definition at line 42 of file readaheadvideobuffer.h.

---

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

• readaheadvideobuffer.h