peak::ipl::VideoWriter Class Reference

Writes images to a file in the form of a video. More...

#include <peak_ipl/io/peak_ipl_video_writer.hpp>

Public Member Functions
	VideoWriter ()=default
	~VideoWriter ()
	VideoWriter (const VideoWriter &)=delete
	VideoWriter (VideoWriter &&other) noexcept
VideoWriter &	operator= (const VideoWriter &)=delete
VideoWriter &	operator= (VideoWriter &&other) noexcept
void	Open (const std::string &fileName, std::shared_ptr< container::IContainer > container, std::shared_ptr< encoder::IEncoder > encoder)
	Open the VideoWriter and sets up a container and an encoder. The file is created upon receiving the first image with Append. More...
void	Open (const std::string &fileName)
	Open the VideoWriter with AVI container and mjpeg encoder. The file is created upon receiving the first image with Append. More...

Public Attributes
	PEAK_IPL_MAYBE_UNUSED
std::shared_ptr< encoder::IEncoder >	m_encoder {}
std::shared_ptr< container::IContainer >	m_container {}

Detailed Description

Writes images to a file in the form of a video.

Constructor & Destructor Documentation

VideoWriter() [1/3]

peak::ipl::VideoWriter::VideoWriter ( )

default

~VideoWriter()

peak::ipl::VideoWriter::~VideoWriter ( )

inline

VideoWriter() [2/3]

peak::ipl::VideoWriter::VideoWriter ( const VideoWriter &  )

delete

VideoWriter() [3/3]

peak::ipl::VideoWriter::VideoWriter ( VideoWriter &&  other )

inlinenoexcept

Member Function Documentation

Open() [1/2]

void peak::ipl::VideoWriter::Open ( const std::string &  fileName, std::shared_ptr< container::IContainer >  container, std::shared_ptr< encoder::IEncoder >  encoder  )

inline

Open the VideoWriter and sets up a container and an encoder. The file is created upon receiving the first image with Append.

Parameters

[in]	fileName	The filename of the video as an utf-8 encoded string (u8string)
[in]	container	The container of the video.
[in]	encoder	The encoder of the video.

Exceptions

InvalidArgumentException	Arguments passed are invalid
Exception	An internal error has occurred

Since

1.5

Open() [2/2]

void peak::ipl::VideoWriter::Open ( const std::string &  fileName )

inline

Open the VideoWriter with AVI container and mjpeg encoder. The file is created upon receiving the first image with Append.

Parameters

[in]

fileName

The filename of the video as an utf-8 encoded string (u8string)

Exceptions

InvalidArgumentException	Arguments passed are invalid
Exception	An internal error has occurred

Since

1.5

operator=() [1/2]

VideoWriter& peak::ipl::VideoWriter::operator= ( const VideoWriter &  )

delete

operator=() [2/2]

VideoWriter& peak::ipl::VideoWriter::operator= ( VideoWriter &&  other )

inlinenoexcept

Member Data Documentation

m_container

std::shared_ptr<container::IContainer> peak::ipl::VideoWriter::m_container {}

m_encoder

std::shared_ptr<encoder::IEncoder> peak::ipl::VideoWriter::m_encoder {}

PEAK_IPL_MAYBE_UNUSED

peak::ipl::VideoWriter::PEAK_IPL_MAYBE_UNUSED

---

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

• peak_ipl/io/peak_ipl_video_writer.hpp