IO

Classes for reading, writing, and encoding images and videos. More...

Classes
class	peak::ipl::ImageReader
	Reads an image from a file. More...
class	peak::ipl::ImageWriter
	Writes an image to a file. More...
class	peak::ipl::encoder::IEncoder
	Encoder Interface Class. More...
class	peak::ipl::encoder::MJPEGEncoder
	JPEG encoder specialization of IEncoder. Create the encoder with the according Create function. More...
class	peak::ipl::container::IContainer
	Container Interface Class. More...
class	peak::ipl::container::AVIContainer
	AVI container specialization of IContainer. Create the container with the according Create function. More...
class	peak::ipl::VideoWriter
	Writes images to a file in the form of a video. More...

Functions
static std::vector< PEAK_IPL_VIDEO_ENCODER >	peak::ipl::encoder::GetSupportedEncodersForAContainer (PEAK_IPL_VIDEO_CONTAINER container)
	Get the supported encoders.
static std::vector< PixelFormatName >	peak::ipl::encoder::GetSupportedPixelFormats (PEAK_IPL_VIDEO_ENCODER encoder)
	Get the supported pixel formats for an encoder.
static std::unique_ptr< IEncoder >	peak::ipl::encoder::Create (PEAK_IPL_VIDEO_ENCODER encoder)
	Factory to create an encoder.
static std::vector< PEAK_IPL_VIDEO_CONTAINER >	peak::ipl::container::GetSupportedContainersForAnEncoder (PEAK_IPL_VIDEO_ENCODER encoder)
	Get the supported containers.
static std::unique_ptr< IContainer >	peak::ipl::container::Create (PEAK_IPL_VIDEO_CONTAINER container)
	Factory to create a container.

Detailed Description

Classes for reading, writing, and encoding images and videos.

Includes tools for file-based image I/O, video creation, and media encoding and container management.

Function Documentation

Create() [1/2]

std::unique_ptr< IContainer > peak::ipl::container::Create ( PEAK_IPL_VIDEO_CONTAINER container )

static

Factory to create a container.

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

Create() [2/2]

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

inlinestatic

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

GetSupportedContainersForAnEncoder()

std::vector< PEAK_IPL_VIDEO_CONTAINER > peak::ipl::container::GetSupportedContainersForAnEncoder ( PEAK_IPL_VIDEO_ENCODER encoder )

inlinestatic

Get the supported containers.

Returns

List of the supported containers.

GetSupportedEncodersForAContainer()

std::vector< PEAK_IPL_VIDEO_ENCODER > peak::ipl::encoder::GetSupportedEncodersForAContainer ( PEAK_IPL_VIDEO_CONTAINER container )

inlinestatic

Get the supported encoders.

Returns

List of supported encoders

Exceptions

Exception

An internal error has occurred

Since

1.5

GetSupportedPixelFormats()

std::vector< PixelFormatName > peak::ipl::encoder::GetSupportedPixelFormats ( PEAK_IPL_VIDEO_ENCODER encoder )

inlinestatic

Get the supported pixel formats for an encoder.

Returns

List of supported pixel formats

Exceptions

Exception

An internal error has occurred

Since

1.5