FfmpegWriter Class Reference

ffmpeg_writer: Uses ffmpeg to write images/sounds to movie files (AVI, MOV, ...). More...

#include <ffmpeg/FfmpegWriter.h>

Inheritance diagram for FfmpegWriter:

Public Member Functions
	FfmpegWriter ()
bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver. More...
bool	close () override
	Close the DeviceDriver. More...
bool	putImage (yarp::sig::ImageOf< yarp::sig::PixelRgb > &image) override
	Write an image to the device. More...
virtual bool	putAudioVisual (yarp::sig::ImageOf< yarp::sig::PixelRgb > &image, yarp::sig::Sound &sound) override
	Write an image and sound. More...
bool	hasAudio () override
bool	hasVideo () override
Public Member Functions inherited from yarp::dev::IFrameWriterImage
virtual	~IFrameWriterImage ()
	Destructor. More...
virtual bool	putImage (yarp::sig::ImageOf< yarp::sig::PixelRgb > &image)=0
	Write an image to the device. More...
Public Member Functions inherited from yarp::dev::IFrameWriterAudioVisual
virtual	~IFrameWriterAudioVisual ()
	Destructor. More...
virtual bool	putAudioVisual (yarp::sig::ImageOf< yarp::sig::PixelRgb > &image, yarp::sig::Sound &sound)=0
	Write an image and sound. More...
Public Member Functions inherited from yarp::dev::DeviceDriver
	DeviceDriver ()
	DeviceDriver (const DeviceDriver &other)=delete
	DeviceDriver (DeviceDriver &&other) noexcept=delete
DeviceDriver &	operator= (const DeviceDriver &other)=delete
DeviceDriver &	operator= (DeviceDriver &&other) noexcept=delete
	~DeviceDriver () override
bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver. More...
bool	close () override
	Close the DeviceDriver. More...
virtual std::string	id () const
	Return the id assigned to the PolyDriver. More...
virtual void	setId (const std::string &id)
	Set the id for this device. More...
template<class T >
bool	view (T *&x)
	Get an interface to the device driver. More...
virtual DeviceDriver *	getImplementation ()
	Some drivers are bureaucrats, pointing at others. More...
Public Member Functions inherited from yarp::os::IConfig
virtual	~IConfig ()
	Destructor. More...
virtual bool	open (Searchable &config)
	Initialize the object. More...
virtual bool	close ()
	Shut the object down. More...
virtual bool	configure (Searchable &config)
	Change online parameters. More...
Public Member Functions inherited from yarp::dev::IAudioVisualStream
virtual	~IAudioVisualStream ()
	Destructor. More...
virtual bool	hasAudio ()=0
virtual bool	hasVideo ()=0
virtual bool	hasRawVideo ()

Detailed Description

ffmpeg_writer: Uses ffmpeg to write images/sounds to movie files (AVI, MOV, ...).

Definition at line 30 of file FfmpegWriter.h.

Constructor & Destructor Documentation

FfmpegWriter()

FfmpegWriter::FfmpegWriter ( )

inline

Definition at line 38 of file FfmpegWriter.h.

Member Function Documentation

close()

bool FfmpegWriter::close ( )

overridevirtual

Close the DeviceDriver.

Returns

true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 672 of file FfmpegWriter.cpp.

hasAudio()

bool FfmpegWriter::hasAudio ( )

inlineoverridevirtual

Implements yarp::dev::IAudioVisualStream.

Definition at line 66 of file FfmpegWriter.h.

hasVideo()

bool FfmpegWriter::hasVideo ( )

inlineoverridevirtual

Implements yarp::dev::IAudioVisualStream.

Definition at line 68 of file FfmpegWriter.h.

open()

bool FfmpegWriter::open ( yarp::os::Searchable &  config )

overridevirtual

Open the DeviceDriver.

Parameters

config

is a list of parameters for the device. Which parameters are effective for your device can vary. See device invocation examples. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).

Returns

true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 555 of file FfmpegWriter.cpp.

putAudioVisual()

bool FfmpegWriter::putAudioVisual ( yarp::sig::ImageOf< yarp::sig::PixelRgb > &  image, yarp::sig::Sound &  sound  )

overridevirtual

Write an image and sound.

Parameters

image	the image to be written
sound	the sound to be written

Returns

true/false upon success/failure

Implements yarp::dev::IFrameWriterAudioVisual.

Definition at line 741 of file FfmpegWriter.cpp.

putImage()

bool FfmpegWriter::putImage ( yarp::sig::ImageOf< yarp::sig::PixelRgb > &  image )

overridevirtual

Write an image to the device.

Parameters

image

the image to write

Returns

true/false upon success/failure

Implements yarp::dev::IFrameWriterImage.

Definition at line 705 of file FfmpegWriter.cpp.

---

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

• src/devices/ffmpeg/FfmpegWriter.h
• src/devices/ffmpeg/FfmpegWriter.cpp