Data Structures
class	Buffer
	Interface for a generic buffer that stores image data. More...

class	BufferImpl
	Default implementation of Buffer Interface. More...

class	Camera
	Abstract camera base class. More...

class	CameraImage
	Abstract camera image base class. More...

class	CameraImageReader
	Abstract image reader base class. More...

struct	CameraImageSpec
	Specification of a caputured camera image. More...

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

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

Enumerations
enum	CameraRequester : uint8_t { IDLE , API_REQUESTER , WEB_REQUESTER }
	Different sources for filtering. More...

enum	PixelFormat : uint8_t { PIXEL_FORMAT_GRAYSCALE = 0 , PIXEL_FORMAT_RGB565 , PIXEL_FORMAT_BGR888 }
	Enumeration of different pixel formats. More...

enum	EncoderError : uint8_t { ENCODER_ERROR_SUCCESS = 0 , ENCODER_ERROR_SKIP_FRAME , ENCODER_ERROR_RETRY_FRAME , ENCODER_ERROR_CONFIGURATION }
	Result codes from the encoder used to control camera pipeline flow. More...

Functions
const char *	to_string (PixelFormat format)
	Returns string name for a given PixelFormat.

const char *	to_string (EncoderError error)
	Converts EncoderError to string.

Enumeration Type Documentation

◆ CameraRequester

enum esphome::camera::CameraRequester : uint8_t

Different sources for filtering.

IDLE: Camera requests to send an image to the API. API_REQUESTER: API requests a new image. WEB_REQUESTER: ESP32 web server request an image. Ignored by API.

Enumerator
IDLE
API_REQUESTER
WEB_REQUESTER

Definition at line 16 of file camera.h.

◆ EncoderError

enum esphome::camera::EncoderError : uint8_t

Result codes from the encoder used to control camera pipeline flow.

Enumerator
ENCODER_ERROR_SUCCESS	Encoding succeeded, continue pipeline normally.
ENCODER_ERROR_SKIP_FRAME	Skip current frame, try again on next frame.
ENCODER_ERROR_RETRY_FRAME	Retry current frame, after buffer growth or for incremental encoding.
ENCODER_ERROR_CONFIGURATION	Fatal config error, shut down pipeline.

Definition at line 9 of file encoder.h.

◆ PixelFormat

enum esphome::camera::PixelFormat : uint8_t

Enumeration of different pixel formats.

Enumerator
PIXEL_FORMAT_GRAYSCALE	8-bit grayscale.
PIXEL_FORMAT_RGB565	16-bit RGB (5-6-5).
PIXEL_FORMAT_BGR888	RGB pixel data in 8-bit format, stored as B, G, R (1 byte each).

Definition at line 19 of file camera.h.

Function Documentation

◆ to_string() [1/2]

const char * esphome::camera::to_string ( EncoderError error )

inline

Converts EncoderError to string.

Definition at line 17 of file encoder.h.

◆ to_string() [2/2]

const char * esphome::camera::to_string ( PixelFormat format )

inline

Returns string name for a given PixelFormat.

Definition at line 26 of file camera.h.

Data Structures

Enumerations