ImFusion::KinectAzureStreamRecordingAlgorithm::FrameEncoder Class Reference

#include <RGBD/Include/ImFusion/RGBD/Hardware/KinectAzureStreamRecordingAlgorithm.h>

Encoder for video frames in Kinect Azure recordings. More...

Detailed Description

Encoder for video frames in Kinect Azure recordings.

This class wraps FFMPEG-based encoding and supports on-the-fly compression of image frames.

Typical usage:

FrameEncoder encoder(desc, fps, encoderParams);
encoder.encodeFrame(file, imagePointer, imageWidth, imageHeight);

Note

• Supports various encoder parameters for customization.
• Not thread-safe.

See also

Image

Public Member Functions
	FrameEncoder (const ImageDescriptor &desc, int fps, const std::vector< std::pair< std::string, std::string > > &encoderParams)
	Constructs a frame encoder for the given image descriptor, frame rate, and encoder parameters.
bool	encodeFrame (std::ostream &file, unsigned char *imagePointer, int imageWidth, int imageHeight)
	Encodes a single image frame and writes it to the output stream.

Public Attributes
std::unique_ptr< Impl >	m_pimpl
	Pointer to internal implementation.
Image	m_desc
	Image descriptor.

Constructor & Destructor Documentation

FrameEncoder()

ImFusion::KinectAzureStreamRecordingAlgorithm::FrameEncoder::FrameEncoder	(	const ImageDescriptor &	desc,
		int	fps,
		const std::vector< std::pair< std::string, std::string > > &	encoderParams )

Constructs a frame encoder for the given image descriptor, frame rate, and encoder parameters.

Parameters

desc	Image descriptor specifying format and properties.
fps	Target frame rate.
encoderParams	List of encoder parameter key-value pairs.

Member Function Documentation

encodeFrame()

bool ImFusion::KinectAzureStreamRecordingAlgorithm::FrameEncoder::encodeFrame	(	std::ostream &	file,
		unsigned char *	imagePointer,
		int	imageWidth,
		int	imageHeight )

Encodes a single image frame and writes it to the output stream.

Parameters

file	Output stream to write encoded data.
imagePointer	Pointer to image data.
imageWidth	Image width.
imageHeight	Image height.

Returns

true if encoding succeeded.

---

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

• RGBD/Include/ImFusion/RGBD/Hardware/KinectAzureStreamRecordingAlgorithm.h