peak::ipl::container::AVIContainer Class Reference

AVI container specialization of IContainer. Create the container with the according Create function. More...

#include <peak_ipl/io/peak_ipl_video_writer.hpp>

Inheritance diagram for peak::ipl::container::AVIContainer:

Public Member Functions
	AVIContainer (const AVIContainer &)=delete
	AVIContainer (AVIContainer &&)=default
AVIContainer &	operator= (const AVIContainer &)=delete
AVIContainer &	operator= (AVIContainer &&)=default
PEAK_IPL_VIDEO_CONTAINER	Id () override
	Get the current type of the container.
void	SetFramerate (double fps)
	Set the frame rate for the opened video.
double	GetFramerate ()
	Get the frame rate for the opened video.
Public Member Functions inherited from peak::ipl::container::IContainer
	IContainer ()=default
virtual	~IContainer ()=default
void	SetOption (PEAK_IPL_VIDEO_CONTAINER_OPTION option, const void *value, size_t count)
	Sets an option on the container.
void	GetOption (PEAK_IPL_VIDEO_CONTAINER_OPTION option, void *value, size_t count, size_t *outCount)
	Gets an option of the container.
void	OptionRange (PEAK_IPL_VIDEO_CONTAINER_OPTION option, void *min, void *max, void *inc)
	Receive the range for an option of the container.

Friends
std::unique_ptr< IContainer >	Create (PEAK_IPL_VIDEO_CONTAINER container)
	Factory to create an encoder.

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

Detailed Description

AVI container specialization of IContainer. Create the container with the according Create function.

Constructor & Destructor Documentation

AVIContainer() [1/2]

peak::ipl::container::AVIContainer::AVIContainer ( const AVIContainer &  )

delete

AVIContainer() [2/2]

peak::ipl::container::AVIContainer::AVIContainer ( AVIContainer &&  )

default

Member Function Documentation

GetFramerate()

double peak::ipl::container::AVIContainer::GetFramerate ( )

inline

Get the frame rate for the opened video.

Exceptions

Exception

An internal error has occurred

Since

1.5

Id()

PEAK_IPL_VIDEO_CONTAINER peak::ipl::container::AVIContainer::Id ( )

inlineoverridevirtual

Get the current type of the container.

Returns

Container type

Implements peak::ipl::container::IContainer.

operator=() [1/2]

AVIContainer & peak::ipl::container::AVIContainer::operator= ( AVIContainer &&  )

default

operator=() [2/2]

AVIContainer & peak::ipl::container::AVIContainer::operator= ( const AVIContainer &  )

delete

SetFramerate()

void peak::ipl::container::AVIContainer::SetFramerate ( double  fps )

inline

Set the frame rate for the opened video.

Parameters

[in]

fps

The frame rate 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< IContainer > Create ( PEAK_IPL_VIDEO_CONTAINER  container )

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

Factory to create an encoder.

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