esphome::camera::CameraImageReader Class Reference

Abstract image reader base class. More...

#include <camera.h>

Inheritance diagram for esphome::camera::CameraImageReader:

Public Member Functions
virtual void	set_image (std::shared_ptr< CameraImage > image)=0
virtual size_t	available () const =0
virtual uint8_t *	peek_data_buffer ()=0
virtual void	consume_data (size_t consumed)=0
virtual void	return_image ()=0
virtual	~CameraImageReader ()

Detailed Description

Abstract image reader base class.

Keeps track of the data offset of the camera image and how many bytes are remaining to read. When the image is returned, the shared_ptr is reset and the camera can reuse the memory of the camera image.

Definition at line 36 of file camera.h.

Constructor & Destructor Documentation

~CameraImageReader()

virtual esphome::camera::CameraImageReader::~CameraImageReader ( )

inlinevirtual

Definition at line 43 of file camera.h.

Member Function Documentation

available()

virtual size_t esphome::camera::CameraImageReader::available ( ) const

pure virtual

Implemented in esphome::esp32_camera::ESP32CameraImageReader.

consume_data()

virtual void esphome::camera::CameraImageReader::consume_data ( size_t consumed )

pure virtual

Implemented in esphome::esp32_camera::ESP32CameraImageReader.

peek_data_buffer()

virtual uint8_t * esphome::camera::CameraImageReader::peek_data_buffer ( )

pure virtual

Implemented in esphome::esp32_camera::ESP32CameraImageReader.

return_image()

virtual void esphome::camera::CameraImageReader::return_image ( )

pure virtual

Implemented in esphome::esp32_camera::ESP32CameraImageReader.

set_image()

virtual void esphome::camera::CameraImageReader::set_image ( std::shared_ptr< CameraImage > image )

pure virtual

Implemented in esphome::esp32_camera::ESP32CameraImageReader.

---

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

• esphome/components/camera/camera.h