peak::ipl::encoder::IEncoder Class Reference

Encoder Interface Class. More...

#include <peak_ipl/io/peak_ipl_video_writer.hpp>

Inheritance diagram for peak::ipl::encoder::IEncoder:

Public Member Functions
	IEncoder ()=default
virtual	~IEncoder ()=default
virtual PEAK_IPL_VIDEO_ENCODER	Id ()=0
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.

Protected Member Functions
void	SetHandle (PEAK_IPL_VIDEO_HANDLE handle)

Protected Attributes
PEAK_IPL_VIDEO_HANDLE	m_handle {nullptr}

Friends
class	peak::ipl::VideoWriter

Detailed Description

Encoder Interface Class.

Constructor & Destructor Documentation

IEncoder()

peak::ipl::encoder::IEncoder::IEncoder ( )

default

~IEncoder()

virtual peak::ipl::encoder::IEncoder::~IEncoder ( )

virtualdefault

Member Function Documentation

GetOption()

void peak::ipl::encoder::IEncoder::GetOption ( PEAK_IPL_VIDEO_ENCODER_OPTION  option, void *  value, size_t  count, size_t *  outCount  )

inline

Gets an option of the encoder.

Parameters

[in]	option	The encoder option to get.
[out]	value	The value for the encoder option.
[in]	count	The size of the value.
[out]	outCount	The resulting size of the value.

Exceptions

InvalidArgumentException	Arguments passed are invalid
Exception	An internal error has occurred

Since

1.5

Id()

virtual PEAK_IPL_VIDEO_ENCODER peak::ipl::encoder::IEncoder::Id ( )

pure virtual

Implemented in peak::ipl::encoder::MJPEGEncoder.

OptionRange()

void peak::ipl::encoder::IEncoder::OptionRange ( PEAK_IPL_VIDEO_ENCODER_OPTION  option, void *  min, void *  max, void *  inc  )

inline

Receive the range for an option of the encoder.

Parameters

[in]	option	The encoder option to receive the range from.
[out]	min	The minimum value for the encoder option.
[out]	max	The maximum value for the encoder option.
[out]	inc	The increment value for the encoder option.

Exceptions

InvalidArgumentException	Arguments passed are invalid
Exception	An internal error has occurred

Since

1.5

SetHandle()

void peak::ipl::encoder::IEncoder::SetHandle ( PEAK_IPL_VIDEO_HANDLE  handle )

inlineprotected

SetOption()

void peak::ipl::encoder::IEncoder::SetOption ( PEAK_IPL_VIDEO_ENCODER_OPTION  option, const void *  value, size_t  count  )

inline

Sets an option on the encoder.

Parameters

[in]	option	The encoder option to set.
[in]	value	The value for the encoder option.
[in]	count	The size of the value.

Exceptions

InvalidArgumentException	Arguments passed are invalid
Exception	An internal error has occurred

Since

1.5

Friends And Related Symbol Documentation

peak::ipl::VideoWriter

friend class peak::ipl::VideoWriter

friend

Field Documentation

m_handle

PEAK_IPL_VIDEO_HANDLE peak::ipl::encoder::IEncoder::m_handle {nullptr}

protected

---

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

• peak_ipl/io/peak_ipl_video_writer.hpp