ESPHome 2025.9.1
Loading...
Searching...
No Matches
esphome::camera::EncoderBuffer Class Referenceabstract

Interface for an encoder buffer supporting resizing and variable-length data. More...

#include <encoder.h>

Inheritance diagram for esphome::camera::EncoderBuffer:
esphome::camera_encoder::EncoderBufferImpl

Public Member Functions

virtual bool set_buffer_size (size_t size)=0
 Sets logical buffer size, reallocates if needed.
 
virtual uint8_t * get_data () const =0
 Returns a pointer to the buffer data.
 
virtual size_t get_size () const =0
 Returns number of bytes currently used.
 
virtual size_t get_max_size () const =0
 Returns total allocated buffer size.
 
virtual ~EncoderBuffer ()=default
 

Detailed Description

Interface for an encoder buffer supporting resizing and variable-length data.

Definition at line 32 of file encoder.h.

Constructor & Destructor Documentation

◆ ~EncoderBuffer()

virtual esphome::camera::EncoderBuffer::~EncoderBuffer ( )
virtualdefault

Member Function Documentation

◆ get_data()

virtual uint8_t * esphome::camera::EncoderBuffer::get_data ( ) const
pure virtual

Returns a pointer to the buffer data.

Implemented in esphome::camera_encoder::EncoderBufferImpl.

◆ get_max_size()

virtual size_t esphome::camera::EncoderBuffer::get_max_size ( ) const
pure virtual

Returns total allocated buffer size.

Implemented in esphome::camera_encoder::EncoderBufferImpl.

◆ get_size()

virtual size_t esphome::camera::EncoderBuffer::get_size ( ) const
pure virtual

Returns number of bytes currently used.

Implemented in esphome::camera_encoder::EncoderBufferImpl.

◆ set_buffer_size()

virtual bool esphome::camera::EncoderBuffer::set_buffer_size ( size_t size)
pure virtual

Sets logical buffer size, reallocates if needed.

Parameters
sizeRequired size in bytes.
Returns
true on success, false on allocation failure.

Implemented in esphome::camera_encoder::EncoderBufferImpl.


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