peak::ipl::encoder::MJPEGEncoder Class Reference

JPEG encoder specialization of IEncoder. Create the encoder with the according Create function. More...

#include <peak_ipl/io/peak_ipl_video_writer.hpp>

Inheritance diagram for peak::ipl::encoder::MJPEGEncoder:

Public Member Functions
	MJPEGEncoder (const MJPEGEncoder &)=delete
	MJPEGEncoder (MJPEGEncoder &&)=default
MJPEGEncoder &	operator= (const MJPEGEncoder &)=delete
MJPEGEncoder &	operator= (MJPEGEncoder &&)=default
PEAK_IPL_VIDEO_ENCODER	Id () override
	Get the current type of the encoder.
void	SetQuality (uint32_t quality)
	Sets the quality for the jpeg encoder.
uint32_t	GetQuality ()
	Gets the quality for the jpeg encoder.
Range< double >	QualityRange ()
	Gets the quality range for the jpeg encoder.
Public Member Functions inherited from peak::ipl::encoder::IEncoder
	IEncoder ()=default
virtual	~IEncoder ()=default
void	SetOption (PEAK_IPL_VIDEO_ENCODER_OPTION option, const void *value, size_t count)
	Sets an option on the encoder.
void	GetOption (PEAK_IPL_VIDEO_ENCODER_OPTION option, void *value, size_t count, size_t *outCount)
	Gets an option of the encoder.
void	OptionRange (PEAK_IPL_VIDEO_ENCODER_OPTION option, void *min, void *max, void *inc)
	Receive the range for an option of the encoder.

Friends
std::unique_ptr< IEncoder >	Create (PEAK_IPL_VIDEO_ENCODER encoder)
	Factory to create an encoder.

Additional Inherited Members
Protected Member Functions inherited from peak::ipl::encoder::IEncoder
void	SetHandle (PEAK_IPL_VIDEO_HANDLE handle)
Protected Attributes inherited from peak::ipl::encoder::IEncoder
PEAK_IPL_VIDEO_HANDLE	m_handle {nullptr}

Detailed Description

JPEG encoder specialization of IEncoder. Create the encoder with the according Create function.

Constructor & Destructor Documentation

MJPEGEncoder() [1/2]

peak::ipl::encoder::MJPEGEncoder::MJPEGEncoder ( const MJPEGEncoder & )

delete

MJPEGEncoder() [2/2]

peak::ipl::encoder::MJPEGEncoder::MJPEGEncoder ( MJPEGEncoder && )

default

Member Function Documentation

GetQuality()

uint32_t peak::ipl::encoder::MJPEGEncoder::GetQuality ( )

inline

Gets the quality for the jpeg encoder.

Exceptions

Exception

An internal error has occurred

Since

1.5

Id()

PEAK_IPL_VIDEO_ENCODER peak::ipl::encoder::MJPEGEncoder::Id ( )

inlineoverridevirtual

Get the current type of the encoder.

Returns

Encoder type

Implements peak::ipl::encoder::IEncoder.

operator=() [1/2]

MJPEGEncoder & peak::ipl::encoder::MJPEGEncoder::operator= ( const MJPEGEncoder & )

delete

operator=() [2/2]

MJPEGEncoder & peak::ipl::encoder::MJPEGEncoder::operator= ( MJPEGEncoder && )

default

QualityRange()

Range< double > peak::ipl::encoder::MJPEGEncoder::QualityRange ( )

inline

Gets the quality range for the jpeg encoder.

Exceptions

Exception

An internal error has occurred

Since

1.5

SetQuality()

void peak::ipl::encoder::MJPEGEncoder::SetQuality ( uint32_t quality )

inline

Sets the quality for the jpeg encoder.

Parameters

[in]

quality

Quality to set.

Exceptions

InvalidArgumentException	Arguments passed are invalid
Exception	An internal error has occurred

Since

1.5

Friends And Related Symbol Documentation

Create

std::unique_ptr< IEncoder > Create ( PEAK_IPL_VIDEO_ENCODER encoder )

friend

Factory to create an encoder.

Parameters

[in]

encoder

Create an encoder of this type.

Returns

Unique instance of the created encoder.

Exceptions

InvalidArgumentException

Arguments passed are invalid

Since

1.5

Parameters

[in]

container

Create a container of this type.

Returns

Unique instance of the created container.

Exceptions

InvalidArgumentException

Arguments passed are invalid

Since

1.5

---

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

• peak_ipl/io/peak_ipl_video_writer.hpp