vidl_ostream Class Reference

#include <vidl_ostream.h>

Inheritance diagram for vidl_ostream:

List of all members.

---

Detailed Description

A base class for output video streams.

Definition at line 18 of file vidl_ostream.h.

Public Member Functions
	vidl_ostream ()
	Constructor.
virtual	~vidl_ostream ()
	Destructor.
virtual void	close ()=0
	Close the stream.
virtual bool	is_open () const=0
	Return true if the stream is open for writing.
virtual bool	write_frame (const vidl_frame_sptr &frame)=0
	Write and image to the stream.
void	ref ()
	Increment reference count.
void	unref ()
	Decrement reference count.
int	ref_count () const
	Number of objects referring to this data.
Private Member Functions
	vidl_ostream (const vidl_ostream &)
	prevent deep copying a stream.
Private Attributes
int	ref_count_

---

Constructor & Destructor Documentation

vidl_ostream::vidl_ostream

(

)

[inline]

Constructor.

Definition at line 22 of file vidl_ostream.h.

virtual vidl_ostream::~vidl_ostream

(

)

[inline, virtual]

Destructor.

Definition at line 24 of file vidl_ostream.h.

vidl_ostream::vidl_ostream

(

const vidl_ostream &

)

[inline, private]

prevent deep copying a stream.

Definition at line 38 of file vidl_ostream.h.

---

Member Function Documentation

virtual void vidl_ostream::close

(

)

[pure virtual]

Close the stream.

Implemented in vidl_ffmpeg_ostream, and vidl_image_list_ostream.

virtual bool vidl_ostream::is_open

(

)

const [pure virtual]

Return true if the stream is open for writing.

Implemented in vidl_ffmpeg_ostream, and vidl_image_list_ostream.

virtual bool vidl_ostream::write_frame

(

const vidl_frame_sptr &

frame

)

[pure virtual]

Write and image to the stream.

Return values:

false

if the image could not be written

Implemented in vidl_ffmpeg_ostream, and vidl_image_list_ostream.

void vidl_ostream::ref

(

)

[inline]

Increment reference count.

Definition at line 45 of file vidl_ostream.h.

void vidl_ostream::unref

(

)

[inline]

Decrement reference count.

Definition at line 48 of file vidl_ostream.h.

int vidl_ostream::ref_count

(

)

const [inline]

Number of objects referring to this data.

Definition at line 51 of file vidl_ostream.h.

---

Member Data Documentation

int vidl_ostream::ref_count_ [private]

Definition at line 54 of file vidl_ostream.h.

---

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

• core/vidl/vidl_ostream.h

---