esphome::camera::Encoder Class Reference

Interface for image encoders used in a camera pipeline. More...

#include <encoder.h>

Inheritance diagram for esphome::camera::Encoder:

Public Member Functions
virtual EncoderError	encode_pixels (CameraImageSpec *spec, Buffer *pixels)=0
	Encodes pixel data from a previous camera pipeline stage.
virtual EncoderBuffer *	get_output_buffer ()=0
	Returns the encoder's output buffer.
virtual void	dump_config ()=0
	Prints the encoder's configuration to the log.
virtual	~Encoder ()=default

Detailed Description

Interface for image encoders used in a camera pipeline.

Definition at line 52 of file encoder.h.

Constructor & Destructor Documentation

~Encoder()

virtual esphome::camera::Encoder::~Encoder ( )

virtualdefault

Member Function Documentation

dump_config()

virtual void esphome::camera::Encoder::dump_config ( )

pure virtual

Prints the encoder's configuration to the log.

Implemented in esphome::camera_encoder::ESP32CameraJPEGEncoder.

encode_pixels()

virtual EncoderError esphome::camera::Encoder::encode_pixels ( CameraImageSpec * spec, Buffer * pixels )

pure virtual

Encodes pixel data from a previous camera pipeline stage.

Parameters

spec	Specification of the input pixel data.
pixels	Image pixels in RGB or grayscale format, as specified in spec.

Returns

EncoderError Indicating the result of the encoding operation.

Implemented in esphome::camera_encoder::ESP32CameraJPEGEncoder.

get_output_buffer()

virtual EncoderBuffer * esphome::camera::Encoder::get_output_buffer ( )

pure virtual

Returns the encoder's output buffer.

Returns

Pointer to an EncoderBuffer containing encoded data.

Implemented in esphome::camera_encoder::ESP32CameraJPEGEncoder.

---

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

• esphome/components/camera/encoder.h